]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/attr.h
xnu-3789.41.3.tar.gz
[apple/xnu.git] / bsd / sys / attr.h
CommitLineData
1c79356b 1/*
39037602 2 * Copyright (c) 2000-2016 Apple Computer, Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28
29/*
30 * attr.h - attribute data structures and interfaces
31 *
32 * Copyright (c) 1998, Apple Computer, Inc. All Rights Reserved.
33 */
34
35#ifndef _SYS_ATTR_H_
36#define _SYS_ATTR_H_
37
9bccf70c
A
38#include <sys/appleapiopts.h>
39
40#ifdef __APPLE_API_UNSTABLE
1c79356b 41#include <sys/types.h>
1c79356b 42#include <sys/ucred.h>
1c79356b 43#include <sys/time.h>
91447636 44#include <sys/cdefs.h>
1c79356b
A
45
46#define FSOPT_NOFOLLOW 0x00000001
91447636
A
47#define FSOPT_NOINMEMUPDATE 0x00000002
48#define FSOPT_REPORT_FULLSIZE 0x00000004
b0d623f7
A
49/* The following option only valid when requesting ATTR_CMN_RETURNED_ATTRS */
50#define FSOPT_PACK_INVAL_ATTRS 0x00000008
1c79356b 51
6d2010ae
A
52#ifdef PRIVATE
53#define FSOPT_EXCHANGE_DATA_ONLY 0x0000010
54#endif
55
fe8ab488 56#define FSOPT_ATTR_CMN_EXTENDED 0x00000020
39037602
A
57#ifdef PRIVATE
58#define FSOPT_LIST_SNAPSHOT 0x00000040
59#endif /* PRIVATE */
fe8ab488 60
a3d08fcd
A
61/* we currently aren't anywhere near this amount for a valid
62 * fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
63 * but we put a sanity check in to avoid abuse of the value passed in from
64 * user land.
65 */
66#define SEARCHFS_MAX_SEARCHPARMS 4096
67
1c79356b
A
68typedef u_int32_t text_encoding_t;
69
70typedef u_int32_t fsobj_type_t;
71
72typedef u_int32_t fsobj_tag_t;
73
74typedef u_int32_t fsfile_type_t;
75
76typedef u_int32_t fsvolid_t;
77
39037602 78#include <sys/_types/_fsobj_id_t.h> /* file object id type */
1c79356b
A
79
80typedef u_int32_t attrgroup_t;
81
82struct attrlist {
83 u_short bitmapcount; /* number of attr. bit sets in list (should be 5) */
fe8ab488 84 u_int16_t reserved; /* (to maintain 4-byte alignment) */
1c79356b
A
85 attrgroup_t commonattr; /* common attribute group */
86 attrgroup_t volattr; /* Volume attribute group */
87 attrgroup_t dirattr; /* directory attribute group */
88 attrgroup_t fileattr; /* file attribute group */
89 attrgroup_t forkattr; /* fork attribute group */
90};
91#define ATTR_BIT_MAP_COUNT 5
92
93typedef struct attribute_set {
94 attrgroup_t commonattr; /* common attribute group */
95 attrgroup_t volattr; /* Volume attribute group */
96 attrgroup_t dirattr; /* directory attribute group */
97 attrgroup_t fileattr; /* file attribute group */
98 attrgroup_t forkattr; /* fork attribute group */
99} attribute_set_t;
100
101typedef struct attrreference {
91447636
A
102 int32_t attr_dataoffset;
103 u_int32_t attr_length;
1c79356b
A
104} attrreference_t;
105
106/* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */
107
108struct diskextent {
109 u_int32_t startblock; /* first block allocated */
110 u_int32_t blockcount; /* number of blocks allocated */
111};
112
113typedef struct diskextent extentrecord[8];
114
115typedef u_int32_t vol_capabilities_set_t[4];
116
117#define VOL_CAPABILITIES_FORMAT 0
118#define VOL_CAPABILITIES_INTERFACES 1
119#define VOL_CAPABILITIES_RESERVED1 2
120#define VOL_CAPABILITIES_RESERVED2 3
121
122typedef struct vol_capabilities_attr {
123 vol_capabilities_set_t capabilities;
124 vol_capabilities_set_t valid;
125} vol_capabilities_attr_t;
126
91447636
A
127/*
128 * XXX this value needs to be raised - 3893388
129 */
130#define ATTR_MAX_BUFFER 8192
131
55e303ae
A
132/*
133 * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs
134 * that are persistent (retain their values even when the volume is
135 * unmounted and remounted), and a file or directory can be looked up
136 * by ID. Volumes that support VolFS and can support Carbon File ID
137 * references should set this bit.
138 *
139 * VOL_CAP_FMT_SYMBOLICLINKS: When set, the volume supports symbolic
140 * links. The symlink(), readlink(), and lstat() calls all use this
141 * symbolic link.
142 *
143 * VOL_CAP_FMT_HARDLINKS: When set, the volume supports hard links.
144 * The link() call creates hard links.
145 *
146 * VOL_CAP_FMT_JOURNAL: When set, the volume is capable of supporting
147 * a journal used to speed recovery in case of unplanned shutdown
148 * (such as a power outage or crash). This bit does not necessarily
149 * mean the volume is actively using a journal for recovery.
150 *
151 * VOL_CAP_FMT_JOURNAL_ACTIVE: When set, the volume is currently using
152 * a journal for use in speeding recovery after an unplanned shutdown.
153 * This bit can be set only if VOL_CAP_FMT_JOURNAL is also set.
154 *
155 * VOL_CAP_FMT_NO_ROOT_TIMES: When set, the volume format does not
156 * store reliable times for the root directory, so you should not
157 * depend on them to detect changes, etc.
158 *
159 * VOL_CAP_FMT_SPARSE_FILES: When set, the volume supports sparse files.
160 * That is, files which can have "holes" that have never been written
161 * to, and are not allocated on disk. Sparse files may have an
162 * allocated size that is less than the file's logical length.
163 *
164 * VOL_CAP_FMT_ZERO_RUNS: For security reasons, parts of a file (runs)
165 * that have never been written to must appear to contain zeroes. When
166 * this bit is set, the volume keeps track of allocated but unwritten
167 * runs of a file so that it can substitute zeroes without actually
168 * writing zeroes to the media. This provides performance similar to
169 * sparse files, but not the space savings.
170 *
171 * VOL_CAP_FMT_CASE_SENSITIVE: When set, file and directory names are
172 * case sensitive (upper and lower case are different). When clear,
173 * an upper case character is equivalent to a lower case character,
174 * and you can't have two names that differ solely in the case of
175 * the characters.
176 *
177 * VOL_CAP_FMT_CASE_PRESERVING: When set, file and directory names
178 * preserve the difference between upper and lower case. If clear,
179 * the volume may change the case of some characters (typically
180 * making them all upper or all lower case). A volume that sets
181 * VOL_CAP_FMT_CASE_SENSITIVE should also set VOL_CAP_FMT_CASE_PRESERVING.
182 *
183 * VOL_CAP_FMT_FAST_STATFS: This bit is used as a hint to upper layers
184 * (especially Carbon) that statfs() is fast enough that its results
185 * need not be cached by those upper layers. A volume that caches
186 * the statfs information in its in-memory structures should set this bit.
187 * A volume that must always read from disk or always perform a network
188 * transaction should not set this bit.
91447636 189 *
b0d623f7
A
190 * VOL_CAP_FMT_2TB_FILESIZE: If this bit is set the volume format supports
191 * file sizes larger than 4GB, and potentially up to 2TB; it does not
192 * indicate whether the filesystem supports files larger than that.
2d21ac55
A
193 *
194 * VOL_CAP_FMT_OPENDENYMODES: When set, the volume supports open deny
195 * modes (e.g. "open for read write, deny write"; effectively, mandatory
196 * file locking based on open modes).
197 *
198 * VOL_CAP_FMT_HIDDEN_FILES: When set, the volume supports the UF_HIDDEN
199 * file flag, and the UF_HIDDEN flag is mapped to that volume's native
200 * "hidden" or "invisible" bit (which may be the invisible bit from the
201 * Finder Info extended attribute).
202 *
203 * VOL_CAP_FMT_PATH_FROM_ID: When set, the volume supports the ability
204 * to derive a pathname to the root of the file system given only the
205 * id of an object. This also implies that object ids on this file
206 * system are persistent and not recycled. This is a very specialized
207 * capability and it is assumed that most file systems will not support
208 * it. Its use is for legacy non-posix APIs like ResolveFileIDRef.
209 *
b0d623f7
A
210 * VOL_CAP_FMT_NO_VOLUME_SIZES: When set, the volume does not support
211 * returning values for total data blocks, available blocks, or free blocks
212 * (as in f_blocks, f_bavail, or f_bfree in "struct statfs"). Historically,
213 * those values were set to 0xFFFFFFFF for volumes that did not support them.
214 *
215 * VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent
216 * decompression of compressed files using decmpfs.
6d2010ae
A
217 *
218 * VOL_CAP_FMT_64BIT_OBJECT_IDS: When set, the volume uses object IDs that
219 * are 64-bit. This means that ATTR_CMN_FILEID and ATTR_CMN_PARENTID are the
220 * only legitimate attributes for obtaining object IDs from this volume and the
221 * 32-bit fid_objno fields of the fsobj_id_t returned by ATTR_CMN_OBJID,
222 * ATTR_CMN_OBJPERMID, and ATTR_CMN_PAROBJID are undefined.
39037602
A
223 *
224 * VOL_CAP_FMT_DIR_HARDLINKS: When set, the volume supports directory
225 * hard links.
226 *
227 * VOL_CAP_FMT_DOCUMENT_ID: When set, the volume supports document IDs
228 * (an ID which persists across object ID changes) for document revisions.
229 *
230 * VOL_CAP_FMT_WRITE_GENERATION_COUNT: When set, the volume supports write
231 * generation counts (a count of how many times an object has been modified)
55e303ae 232 */
91447636
A
233#define VOL_CAP_FMT_PERSISTENTOBJECTIDS 0x00000001
234#define VOL_CAP_FMT_SYMBOLICLINKS 0x00000002
235#define VOL_CAP_FMT_HARDLINKS 0x00000004
236#define VOL_CAP_FMT_JOURNAL 0x00000008
237#define VOL_CAP_FMT_JOURNAL_ACTIVE 0x00000010
238#define VOL_CAP_FMT_NO_ROOT_TIMES 0x00000020
239#define VOL_CAP_FMT_SPARSE_FILES 0x00000040
240#define VOL_CAP_FMT_ZERO_RUNS 0x00000080
241#define VOL_CAP_FMT_CASE_SENSITIVE 0x00000100
242#define VOL_CAP_FMT_CASE_PRESERVING 0x00000200
243#define VOL_CAP_FMT_FAST_STATFS 0x00000400
244#define VOL_CAP_FMT_2TB_FILESIZE 0x00000800
2d21ac55
A
245#define VOL_CAP_FMT_OPENDENYMODES 0x00001000
246#define VOL_CAP_FMT_HIDDEN_FILES 0x00002000
247#define VOL_CAP_FMT_PATH_FROM_ID 0x00004000
b0d623f7 248#define VOL_CAP_FMT_NO_VOLUME_SIZES 0x00008000
6d2010ae
A
249#define VOL_CAP_FMT_DECMPFS_COMPRESSION 0x00010000
250#define VOL_CAP_FMT_64BIT_OBJECT_IDS 0x00020000
39037602
A
251#define VOL_CAP_FMT_DIR_HARDLINKS 0x00040000
252#define VOL_CAP_FMT_DOCUMENT_ID 0x00080000
253#define VOL_CAP_FMT_WRITE_GENERATION_COUNT 0x00100000
55e303ae 254
1c79356b 255
55e303ae
A
256/*
257 * VOL_CAP_INT_SEARCHFS: When set, the volume implements the
91447636 258 * searchfs() system call (the vnop_searchfs vnode operation).
55e303ae
A
259 *
260 * VOL_CAP_INT_ATTRLIST: When set, the volume implements the
91447636
A
261 * getattrlist() and setattrlist() system calls (vnop_getattrlist
262 * and vnop_setattrlist vnode operations) for the volume, files,
55e303ae
A
263 * and directories. The volume may or may not implement the
264 * readdirattr() system call. XXX Is there any minimum set
265 * of attributes that should be supported? To determine the
266 * set of supported attributes, get the ATTR_VOL_ATTRIBUTES
267 * attribute of the volume.
268 *
269 * VOL_CAP_INT_NFSEXPORT: When set, the volume implements exporting
270 * of NFS volumes.
271 *
272 * VOL_CAP_INT_READDIRATTR: When set, the volume implements the
91447636 273 * readdirattr() system call (vnop_readdirattr vnode operation).
55e303ae
A
274 *
275 * VOL_CAP_INT_EXCHANGEDATA: When set, the volume implements the
91447636 276 * exchangedata() system call (VNOP_EXCHANGE vnode operation).
55e303ae
A
277 *
278 * VOL_CAP_INT_COPYFILE: When set, the volume implements the
279 * VOP_COPYFILE vnode operation. (XXX There should be a copyfile()
280 * system call in <unistd.h>.)
281 *
282 * VOL_CAP_INT_ALLOCATE: When set, the volume implements the
91447636 283 * VNOP_ALLOCATE vnode operation, which means it implements the
55e303ae
A
284 * F_PREALLOCATE selector of fcntl(2).
285 *
286 * VOL_CAP_INT_VOL_RENAME: When set, the volume implements the
287 * ATTR_VOL_NAME attribute for both getattrlist() and setattrlist().
288 * The volume can be renamed by setting ATTR_VOL_NAME with setattrlist().
289 *
290 * VOL_CAP_INT_ADVLOCK: When set, the volume implements POSIX style
91447636 291 * byte range locks via vnop_advlock (accessible from fcntl(2)).
55e303ae
A
292 *
293 * VOL_CAP_INT_FLOCK: When set, the volume implements whole-file flock(2)
91447636 294 * style locks via vnop_advlock. This includes the O_EXLOCK and O_SHLOCK
55e303ae
A
295 * flags of the open(2) call.
296 *
2d21ac55
A
297 * VOL_CAP_INT_EXTENDED_SECURITY: When set, the volume implements
298 * extended security (ACLs).
299 *
300 * VOL_CAP_INT_USERACCESS: When set, the volume supports the
301 * ATTR_CMN_USERACCESS attribute (used to get the user's access
302 * mode to the file).
303 *
304 * VOL_CAP_INT_MANLOCK: When set, the volume supports AFP-style
305 * mandatory byte range locks via an ioctl().
306 *
307 * VOL_CAP_INT_EXTENDED_ATTR: When set, the volume implements
308 * native extended attribues.
309 *
310 * VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports
311 * native named streams.
39037602
A
312 *
313 * VOL_CAP_INT_CLONE: When set, the volume supports clones.
314 *
315 * VOL_CAP_INT_RENAME_SWAP: When set, the volume supports swapping
316 * file system objects.
317 *
318 * VOL_CAP_INT_RENAME_EXCL: When set, the volume supports an
319 * exclusive rename operation.
320 *
55e303ae 321 */
91447636
A
322#define VOL_CAP_INT_SEARCHFS 0x00000001
323#define VOL_CAP_INT_ATTRLIST 0x00000002
324#define VOL_CAP_INT_NFSEXPORT 0x00000004
325#define VOL_CAP_INT_READDIRATTR 0x00000008
326#define VOL_CAP_INT_EXCHANGEDATA 0x00000010
327#define VOL_CAP_INT_COPYFILE 0x00000020
328#define VOL_CAP_INT_ALLOCATE 0x00000040
329#define VOL_CAP_INT_VOL_RENAME 0x00000080
330#define VOL_CAP_INT_ADVLOCK 0x00000100
331#define VOL_CAP_INT_FLOCK 0x00000200
332#define VOL_CAP_INT_EXTENDED_SECURITY 0x00000400
333#define VOL_CAP_INT_USERACCESS 0x00000800
2d21ac55
A
334#define VOL_CAP_INT_MANLOCK 0x00001000
335#define VOL_CAP_INT_NAMEDSTREAMS 0x00002000
336#define VOL_CAP_INT_EXTENDED_ATTR 0x00004000
b0d623f7
A
337#ifdef PRIVATE
338/* Volume supports kqueue notifications for remote events */
339#define VOL_CAP_INT_REMOTE_EVENT 0x00008000
340#endif /* PRIVATE */
39037602
A
341#define VOL_CAP_INT_CLONE 0x00010000
342#ifdef PRIVATE
343/* Volume supports snapshots */
344#define VOL_CAP_INT_SNAPSHOT 0x00020000
345#endif /* PRIVATE */
346#define VOL_CAP_INT_RENAME_SWAP 0x00040000
347#define VOL_CAP_INT_RENAME_EXCL 0x00080000
1c79356b
A
348
349typedef struct vol_attributes_attr {
350 attribute_set_t validattr;
351 attribute_set_t nativeattr;
352} vol_attributes_attr_t;
353
1c79356b
A
354#define ATTR_CMN_NAME 0x00000001
355#define ATTR_CMN_DEVID 0x00000002
356#define ATTR_CMN_FSID 0x00000004
357#define ATTR_CMN_OBJTYPE 0x00000008
358#define ATTR_CMN_OBJTAG 0x00000010
359#define ATTR_CMN_OBJID 0x00000020
91447636 360#define ATTR_CMN_OBJPERMANENTID 0x00000040
1c79356b
A
361#define ATTR_CMN_PAROBJID 0x00000080
362#define ATTR_CMN_SCRIPT 0x00000100
363#define ATTR_CMN_CRTIME 0x00000200
364#define ATTR_CMN_MODTIME 0x00000400
365#define ATTR_CMN_CHGTIME 0x00000800
366#define ATTR_CMN_ACCTIME 0x00001000
367#define ATTR_CMN_BKUPTIME 0x00002000
368#define ATTR_CMN_FNDRINFO 0x00004000
369#define ATTR_CMN_OWNERID 0x00008000
370#define ATTR_CMN_GRPID 0x00010000
371#define ATTR_CMN_ACCESSMASK 0x00020000
372#define ATTR_CMN_FLAGS 0x00040000
fe8ab488
A
373
374/* The following were defined as: */
375/* #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 */
376/* #define ATTR_CMN_NAMEDATTRLIST 0x00100000 */
377/* These bits have been salvaged for use as: */
378/* #define ATTR_CMN_GEN_COUNT 0x00080000 */
379/* #define ATTR_CMN_DOCUMENT_ID 0x00100000 */
380/* They can only be used with the FSOPT_ATTR_CMN_EXTENDED */
381/* option flag. */
382
383#define ATTR_CMN_GEN_COUNT 0x00080000
384#define ATTR_CMN_DOCUMENT_ID 0x00100000
385
1c79356b 386#define ATTR_CMN_USERACCESS 0x00200000
91447636
A
387#define ATTR_CMN_EXTENDED_SECURITY 0x00400000
388#define ATTR_CMN_UUID 0x00800000
389#define ATTR_CMN_GRPUUID 0x01000000
2d21ac55
A
390#define ATTR_CMN_FILEID 0x02000000
391#define ATTR_CMN_PARENTID 0x04000000
b0d623f7 392#define ATTR_CMN_FULLPATH 0x08000000
6d2010ae 393#define ATTR_CMN_ADDEDTIME 0x10000000
fe8ab488
A
394#define ATTR_CMN_ERROR 0x20000000
395#define ATTR_CMN_DATA_PROTECT_FLAGS 0x40000000
6d2010ae 396
b0d623f7 397/*
fe8ab488
A
398 * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2) and
399 * getattrlistbulk(2). It is always the first attribute in the return buffer.
b0d623f7 400 */
fe8ab488 401#define ATTR_CMN_RETURNED_ATTRS 0x80000000
1c79356b 402
fe8ab488 403#define ATTR_CMN_VALIDMASK 0xFFFFFFFF
3e170ce0
A
404/*
405 * The settable ATTR_CMN_* attributes include the following:
406 * ATTR_CMN_SCRIPT
407 * ATTR_CMN_CRTIME
408 * ATTR_CMN_MODTIME
409 * ATTR_CMN_CHGTIME
410 *
411 * ATTR_CMN_ACCTIME
412 * ATTR_CMN_BKUPTIME
413 * ATTR_CMN_FNDRINFO
414 * ATTR_CMN_OWNERID
415 *
416 * ATTR_CMN_GRPID
417 * ATTR_CMN_ACCESSMASK
418 * ATTR_CMN_FLAGS
419 *
420 * ATTR_CMN_EXTENDED_SECURITY
421 * ATTR_CMN_UUID
422 *
423 * ATTR_CMN_GRPUUID
424 */
91447636 425#define ATTR_CMN_SETMASK 0x01C7FF00
1c79356b
A
426#define ATTR_CMN_VOLSETMASK 0x00006700
427
428#define ATTR_VOL_FSTYPE 0x00000001
429#define ATTR_VOL_SIGNATURE 0x00000002
430#define ATTR_VOL_SIZE 0x00000004
431#define ATTR_VOL_SPACEFREE 0x00000008
432#define ATTR_VOL_SPACEAVAIL 0x00000010
91447636
A
433#define ATTR_VOL_MINALLOCATION 0x00000020
434#define ATTR_VOL_ALLOCATIONCLUMP 0x00000040
435#define ATTR_VOL_IOBLOCKSIZE 0x00000080
1c79356b
A
436#define ATTR_VOL_OBJCOUNT 0x00000100
437#define ATTR_VOL_FILECOUNT 0x00000200
438#define ATTR_VOL_DIRCOUNT 0x00000400
91447636 439#define ATTR_VOL_MAXOBJCOUNT 0x00000800
1c79356b
A
440#define ATTR_VOL_MOUNTPOINT 0x00001000
441#define ATTR_VOL_NAME 0x00002000
442#define ATTR_VOL_MOUNTFLAGS 0x00004000
91447636
A
443#define ATTR_VOL_MOUNTEDDEVICE 0x00008000
444#define ATTR_VOL_ENCODINGSUSED 0x00010000
445#define ATTR_VOL_CAPABILITIES 0x00020000
b0d623f7 446#define ATTR_VOL_UUID 0x00040000
1c79356b
A
447#define ATTR_VOL_ATTRIBUTES 0x40000000
448#define ATTR_VOL_INFO 0x80000000
449
b0d623f7 450#define ATTR_VOL_VALIDMASK 0xC007FFFF
3e170ce0
A
451
452/*
453 * The list of settable ATTR_VOL_* attributes include the following:
454 * ATTR_VOL_NAME
455 * ATTR_VOL_INFO
456 */
1c79356b
A
457#define ATTR_VOL_SETMASK 0x80002000
458
459
460/* File/directory attributes: */
461#define ATTR_DIR_LINKCOUNT 0x00000001
462#define ATTR_DIR_ENTRYCOUNT 0x00000002
91447636 463#define ATTR_DIR_MOUNTSTATUS 0x00000004
6d2010ae
A
464/* ATTR_DIR_MOUNTSTATUS Flags: */
465#define DIR_MNTSTATUS_MNTPOINT 0x00000001
466#define DIR_MNTSTATUS_TRIGGER 0x00000002
1c79356b
A
467
468#define ATTR_DIR_VALIDMASK 0x00000007
469#define ATTR_DIR_SETMASK 0x00000000
470
471#define ATTR_FILE_LINKCOUNT 0x00000001
472#define ATTR_FILE_TOTALSIZE 0x00000002
473#define ATTR_FILE_ALLOCSIZE 0x00000004
91447636 474#define ATTR_FILE_IOBLOCKSIZE 0x00000008
1c79356b 475#define ATTR_FILE_DEVTYPE 0x00000020
1c79356b
A
476#define ATTR_FILE_FORKCOUNT 0x00000080
477#define ATTR_FILE_FORKLIST 0x00000100
91447636
A
478#define ATTR_FILE_DATALENGTH 0x00000200
479#define ATTR_FILE_DATAALLOCSIZE 0x00000400
480#define ATTR_FILE_RSRCLENGTH 0x00001000
481#define ATTR_FILE_RSRCALLOCSIZE 0x00002000
1c79356b 482
6d2010ae 483#define ATTR_FILE_VALIDMASK 0x000037FF
3e170ce0
A
484/*
485 * Settable ATTR_FILE_* attributes include:
486 * ATTR_FILE_DEVTYPE
487 */
6d2010ae 488#define ATTR_FILE_SETMASK 0x00000020
1c79356b
A
489
490#define ATTR_FORK_TOTALSIZE 0x00000001
491#define ATTR_FORK_ALLOCSIZE 0x00000002
492
493#define ATTR_FORK_VALIDMASK 0x00000003
494#define ATTR_FORK_SETMASK 0x00000000
495
91447636 496/* Obsolete, implemented, not supported */
fe8ab488
A
497#define ATTR_CMN_NAMEDATTRCOUNT 0x00080000
498#define ATTR_CMN_NAMEDATTRLIST 0x00100000
91447636
A
499#define ATTR_FILE_CLUMPSIZE 0x00000010 /* obsolete */
500#define ATTR_FILE_FILETYPE 0x00000040 /* always zero */
501#define ATTR_FILE_DATAEXTENTS 0x00000800 /* obsolete, HFS-specific */
502#define ATTR_FILE_RSRCEXTENTS 0x00004000 /* obsolete, HFS-specific */
503
fe8ab488
A
504/* Required attributes for getattrlistbulk(2) */
505#define ATTR_BULK_REQUIRED (ATTR_CMN_NAME | ATTR_CMN_RETURNED_ATTRS)
506
91447636
A
507/*
508 * Searchfs
509 */
510#define SRCHFS_START 0x00000001
1c79356b 511#define SRCHFS_MATCHPARTIALNAMES 0x00000002
91447636
A
512#define SRCHFS_MATCHDIRS 0x00000004
513#define SRCHFS_MATCHFILES 0x00000008
514#define SRCHFS_SKIPLINKS 0x00000010
515#define SRCHFS_SKIPINVISIBLE 0x00000020
516#define SRCHFS_SKIPPACKAGES 0x00000040
517#define SRCHFS_SKIPINAPPROPRIATE 0x00000080
55e303ae 518
1c79356b 519#define SRCHFS_NEGATEPARAMS 0x80000000
55e303ae 520#define SRCHFS_VALIDOPTIONSMASK 0x800000FF
1c79356b
A
521
522struct fssearchblock {
523 struct attrlist *returnattrs;
524 void *returnbuffer;
525 size_t returnbuffersize;
526 u_long maxmatches;
527 struct timeval timelimit;
528 void *searchparams1;
529 size_t sizeofsearchparams1;
530 void *searchparams2;
531 size_t sizeofsearchparams2;
532 struct attrlist searchattrs;
533};
534
91447636
A
535#ifdef KERNEL
536/* LP64 version of fssearchblock. all pointers and longs
537 * grow when we're dealing with a 64-bit process.
538 * WARNING - keep in sync with fssearchblock
539 */
91447636 540
b0d623f7
A
541struct user64_fssearchblock {
542 user64_addr_t returnattrs;
543 user64_addr_t returnbuffer;
544 user64_size_t returnbuffersize;
545 user64_ulong_t maxmatches;
546 struct user64_timeval timelimit;
547 user64_addr_t searchparams1;
548 user64_size_t sizeofsearchparams1;
549 user64_addr_t searchparams2;
550 user64_size_t sizeofsearchparams2;
91447636
A
551 struct attrlist searchattrs;
552};
553
b0d623f7
A
554struct user32_fssearchblock {
555 user32_addr_t returnattrs;
556 user32_addr_t returnbuffer;
557 user32_size_t returnbuffersize;
558 user32_ulong_t maxmatches;
559 struct user32_timeval timelimit;
560 user32_addr_t searchparams1;
561 user32_size_t sizeofsearchparams1;
562 user32_addr_t searchparams2;
563 user32_size_t sizeofsearchparams2;
564 struct attrlist searchattrs;
565};
91447636 566
b0d623f7 567#endif /* KERNEL */
91447636 568
1c79356b 569struct searchstate {
39236c6e
A
570 uint32_t ss_union_flags; // for SRCHFS_START
571 uint32_t ss_union_layer; // 0 = top
572 u_char ss_fsstate[548]; // fs private
573} __attribute__((packed));
1c79356b 574
1c79356b
A
575#define FST_EOF (-1) /* end-of-file offset */
576
9bccf70c 577#endif /* __APPLE_API_UNSTABLE */
1c79356b 578#endif /* !_SYS_ATTR_H_ */