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