1 | /* |
2 | * Copyright (c) 2000-2016 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 | #ifdef PRIVATE |
53 | #define FSOPT_EXCHANGE_DATA_ONLY 0x0000010 |
54 | #endif |
55 | |
56 | #define FSOPT_ATTR_CMN_EXTENDED 0x00000020 |
57 | #ifdef PRIVATE |
58 | #define FSOPT_LIST_SNAPSHOT 0x00000040 |
59 | #endif /* PRIVATE */ |
60 | |
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 | |
68 | typedef u_int32_t text_encoding_t; |
69 | |
70 | typedef u_int32_t fsobj_type_t; |
71 | |
72 | typedef u_int32_t fsobj_tag_t; |
73 | |
74 | typedef u_int32_t fsfile_type_t; |
75 | |
76 | typedef u_int32_t fsvolid_t; |
77 | |
78 | #include <sys/_types/_fsobj_id_t.h> /* file object id type */ |
79 | |
80 | typedef u_int32_t attrgroup_t; |
81 | |
82 | struct attrlist { |
83 | u_short bitmapcount; /* number of attr. bit sets in list (should be 5) */ |
84 | u_int16_t reserved; /* (to maintain 4-byte alignment) */ |
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 | |
93 | typedef 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 | |
101 | typedef struct attrreference { |
102 | int32_t attr_dataoffset; |
103 | u_int32_t attr_length; |
104 | } attrreference_t; |
105 | |
106 | /* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */ |
107 | |
108 | struct diskextent { |
109 | u_int32_t startblock; /* first block allocated */ |
110 | u_int32_t blockcount; /* number of blocks allocated */ |
111 | }; |
112 | |
113 | typedef struct diskextent extentrecord[8]; |
114 | |
115 | typedef 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 | |
122 | typedef struct vol_capabilities_attr { |
123 | vol_capabilities_set_t capabilities; |
124 | vol_capabilities_set_t valid; |
125 | } vol_capabilities_attr_t; |
126 | |
127 | /* |
128 | * XXX this value needs to be raised - 3893388 |
129 | */ |
130 | #define ATTR_MAX_BUFFER 8192 |
131 | |
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. |
189 | * |
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. |
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 | * |
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. |
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. |
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) |
232 | * |
233 | * VOL_CAP_FMT_NO_IMMUTABLE_FILES: When set, the volume does not support |
234 | * setting the UF_IMMUTABLE flag. |
235 | * |
236 | * VOL_CAP_FMT_NO_PERMISSIONS: When set, the volume does not support setting |
237 | * permissions. |
238 | */ |
239 | #define VOL_CAP_FMT_PERSISTENTOBJECTIDS 0x00000001 |
240 | #define VOL_CAP_FMT_SYMBOLICLINKS 0x00000002 |
241 | #define VOL_CAP_FMT_HARDLINKS 0x00000004 |
242 | #define VOL_CAP_FMT_JOURNAL 0x00000008 |
243 | #define VOL_CAP_FMT_JOURNAL_ACTIVE 0x00000010 |
244 | #define VOL_CAP_FMT_NO_ROOT_TIMES 0x00000020 |
245 | #define VOL_CAP_FMT_SPARSE_FILES 0x00000040 |
246 | #define VOL_CAP_FMT_ZERO_RUNS 0x00000080 |
247 | #define VOL_CAP_FMT_CASE_SENSITIVE 0x00000100 |
248 | #define VOL_CAP_FMT_CASE_PRESERVING 0x00000200 |
249 | #define VOL_CAP_FMT_FAST_STATFS 0x00000400 |
250 | #define VOL_CAP_FMT_2TB_FILESIZE 0x00000800 |
251 | #define VOL_CAP_FMT_OPENDENYMODES 0x00001000 |
252 | #define VOL_CAP_FMT_HIDDEN_FILES 0x00002000 |
253 | #define VOL_CAP_FMT_PATH_FROM_ID 0x00004000 |
254 | #define VOL_CAP_FMT_NO_VOLUME_SIZES 0x00008000 |
255 | #define VOL_CAP_FMT_DECMPFS_COMPRESSION 0x00010000 |
256 | #define VOL_CAP_FMT_64BIT_OBJECT_IDS 0x00020000 |
257 | #define VOL_CAP_FMT_DIR_HARDLINKS 0x00040000 |
258 | #define VOL_CAP_FMT_DOCUMENT_ID 0x00080000 |
259 | #define VOL_CAP_FMT_WRITE_GENERATION_COUNT 0x00100000 |
260 | #define VOL_CAP_FMT_NO_IMMUTABLE_FILES 0x00200000 |
261 | #define VOL_CAP_FMT_NO_PERMISSIONS 0x00400000 |
262 | |
263 | |
264 | /* |
265 | * VOL_CAP_INT_SEARCHFS: When set, the volume implements the |
266 | * searchfs() system call (the vnop_searchfs vnode operation). |
267 | * |
268 | * VOL_CAP_INT_ATTRLIST: When set, the volume implements the |
269 | * getattrlist() and setattrlist() system calls (vnop_getattrlist |
270 | * and vnop_setattrlist vnode operations) for the volume, files, |
271 | * and directories. The volume may or may not implement the |
272 | * readdirattr() system call. XXX Is there any minimum set |
273 | * of attributes that should be supported? To determine the |
274 | * set of supported attributes, get the ATTR_VOL_ATTRIBUTES |
275 | * attribute of the volume. |
276 | * |
277 | * VOL_CAP_INT_NFSEXPORT: When set, the volume implements exporting |
278 | * of NFS volumes. |
279 | * |
280 | * VOL_CAP_INT_READDIRATTR: When set, the volume implements the |
281 | * readdirattr() system call (vnop_readdirattr vnode operation). |
282 | * |
283 | * VOL_CAP_INT_EXCHANGEDATA: When set, the volume implements the |
284 | * exchangedata() system call (VNOP_EXCHANGE vnode operation). |
285 | * |
286 | * VOL_CAP_INT_COPYFILE: When set, the volume implements the |
287 | * VOP_COPYFILE vnode operation. (XXX There should be a copyfile() |
288 | * system call in <unistd.h>.) |
289 | * |
290 | * VOL_CAP_INT_ALLOCATE: When set, the volume implements the |
291 | * VNOP_ALLOCATE vnode operation, which means it implements the |
292 | * F_PREALLOCATE selector of fcntl(2). |
293 | * |
294 | * VOL_CAP_INT_VOL_RENAME: When set, the volume implements the |
295 | * ATTR_VOL_NAME attribute for both getattrlist() and setattrlist(). |
296 | * The volume can be renamed by setting ATTR_VOL_NAME with setattrlist(). |
297 | * |
298 | * VOL_CAP_INT_ADVLOCK: When set, the volume implements POSIX style |
299 | * byte range locks via vnop_advlock (accessible from fcntl(2)). |
300 | * |
301 | * VOL_CAP_INT_FLOCK: When set, the volume implements whole-file flock(2) |
302 | * style locks via vnop_advlock. This includes the O_EXLOCK and O_SHLOCK |
303 | * flags of the open(2) call. |
304 | * |
305 | * VOL_CAP_INT_EXTENDED_SECURITY: When set, the volume implements |
306 | * extended security (ACLs). |
307 | * |
308 | * VOL_CAP_INT_USERACCESS: When set, the volume supports the |
309 | * ATTR_CMN_USERACCESS attribute (used to get the user's access |
310 | * mode to the file). |
311 | * |
312 | * VOL_CAP_INT_MANLOCK: When set, the volume supports AFP-style |
313 | * mandatory byte range locks via an ioctl(). |
314 | * |
315 | * VOL_CAP_INT_EXTENDED_ATTR: When set, the volume implements |
316 | * native extended attribues. |
317 | * |
318 | * VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports |
319 | * native named streams. |
320 | * |
321 | * VOL_CAP_INT_CLONE: When set, the volume supports clones. |
322 | * |
323 | * VOL_CAP_INT_SNAPSHOT: When set, the volume supports snapshots. |
324 | * |
325 | * VOL_CAP_INT_RENAME_SWAP: When set, the volume supports swapping |
326 | * file system objects. |
327 | * |
328 | * VOL_CAP_INT_RENAME_EXCL: When set, the volume supports an |
329 | * exclusive rename operation. |
330 | * |
331 | */ |
332 | #define VOL_CAP_INT_SEARCHFS 0x00000001 |
333 | #define VOL_CAP_INT_ATTRLIST 0x00000002 |
334 | #define VOL_CAP_INT_NFSEXPORT 0x00000004 |
335 | #define VOL_CAP_INT_READDIRATTR 0x00000008 |
336 | #define VOL_CAP_INT_EXCHANGEDATA 0x00000010 |
337 | #define VOL_CAP_INT_COPYFILE 0x00000020 |
338 | #define VOL_CAP_INT_ALLOCATE 0x00000040 |
339 | #define VOL_CAP_INT_VOL_RENAME 0x00000080 |
340 | #define VOL_CAP_INT_ADVLOCK 0x00000100 |
341 | #define VOL_CAP_INT_FLOCK 0x00000200 |
342 | #define VOL_CAP_INT_EXTENDED_SECURITY 0x00000400 |
343 | #define VOL_CAP_INT_USERACCESS 0x00000800 |
344 | #define VOL_CAP_INT_MANLOCK 0x00001000 |
345 | #define VOL_CAP_INT_NAMEDSTREAMS 0x00002000 |
346 | #define VOL_CAP_INT_EXTENDED_ATTR 0x00004000 |
347 | #ifdef PRIVATE |
348 | /* Volume supports kqueue notifications for remote events */ |
349 | #define VOL_CAP_INT_REMOTE_EVENT 0x00008000 |
350 | #endif /* PRIVATE */ |
351 | #define VOL_CAP_INT_CLONE 0x00010000 |
352 | #define VOL_CAP_INT_SNAPSHOT 0x00020000 |
353 | #define VOL_CAP_INT_RENAME_SWAP 0x00040000 |
354 | #define VOL_CAP_INT_RENAME_EXCL 0x00080000 |
355 | |
356 | typedef struct vol_attributes_attr { |
357 | attribute_set_t validattr; |
358 | attribute_set_t nativeattr; |
359 | } vol_attributes_attr_t; |
360 | |
361 | #define ATTR_CMN_NAME 0x00000001 |
362 | #define ATTR_CMN_DEVID 0x00000002 |
363 | #define ATTR_CMN_FSID 0x00000004 |
364 | #define ATTR_CMN_OBJTYPE 0x00000008 |
365 | #define ATTR_CMN_OBJTAG 0x00000010 |
366 | #define ATTR_CMN_OBJID 0x00000020 |
367 | #define ATTR_CMN_OBJPERMANENTID 0x00000040 |
368 | #define ATTR_CMN_PAROBJID 0x00000080 |
369 | #define ATTR_CMN_SCRIPT 0x00000100 |
370 | #define ATTR_CMN_CRTIME 0x00000200 |
371 | #define ATTR_CMN_MODTIME 0x00000400 |
372 | #define ATTR_CMN_CHGTIME 0x00000800 |
373 | #define ATTR_CMN_ACCTIME 0x00001000 |
374 | #define ATTR_CMN_BKUPTIME 0x00002000 |
375 | #define ATTR_CMN_FNDRINFO 0x00004000 |
376 | #define ATTR_CMN_OWNERID 0x00008000 |
377 | #define ATTR_CMN_GRPID 0x00010000 |
378 | #define ATTR_CMN_ACCESSMASK 0x00020000 |
379 | #define ATTR_CMN_FLAGS 0x00040000 |
380 | |
381 | /* The following were defined as: */ |
382 | /* #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 */ |
383 | /* #define ATTR_CMN_NAMEDATTRLIST 0x00100000 */ |
384 | /* These bits have been salvaged for use as: */ |
385 | /* #define ATTR_CMN_GEN_COUNT 0x00080000 */ |
386 | /* #define ATTR_CMN_DOCUMENT_ID 0x00100000 */ |
387 | /* They can only be used with the FSOPT_ATTR_CMN_EXTENDED */ |
388 | /* option flag. */ |
389 | |
390 | #define ATTR_CMN_GEN_COUNT 0x00080000 |
391 | #define ATTR_CMN_DOCUMENT_ID 0x00100000 |
392 | |
393 | #define ATTR_CMN_USERACCESS 0x00200000 |
394 | #define ATTR_CMN_EXTENDED_SECURITY 0x00400000 |
395 | #define ATTR_CMN_UUID 0x00800000 |
396 | #define ATTR_CMN_GRPUUID 0x01000000 |
397 | #define ATTR_CMN_FILEID 0x02000000 |
398 | #define ATTR_CMN_PARENTID 0x04000000 |
399 | #define ATTR_CMN_FULLPATH 0x08000000 |
400 | #define ATTR_CMN_ADDEDTIME 0x10000000 |
401 | #define ATTR_CMN_ERROR 0x20000000 |
402 | #define ATTR_CMN_DATA_PROTECT_FLAGS 0x40000000 |
403 | |
404 | /* |
405 | * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2) and |
406 | * getattrlistbulk(2). It is always the first attribute in the return buffer. |
407 | */ |
408 | #define ATTR_CMN_RETURNED_ATTRS 0x80000000 |
409 | |
410 | #define ATTR_CMN_VALIDMASK 0xFFFFFFFF |
411 | /* |
412 | * The settable ATTR_CMN_* attributes include the following: |
413 | * ATTR_CMN_SCRIPT |
414 | * ATTR_CMN_CRTIME |
415 | * ATTR_CMN_MODTIME |
416 | * ATTR_CMN_CHGTIME |
417 | * |
418 | * ATTR_CMN_ACCTIME |
419 | * ATTR_CMN_BKUPTIME |
420 | * ATTR_CMN_FNDRINFO |
421 | * ATTR_CMN_OWNERID |
422 | * |
423 | * ATTR_CMN_GRPID |
424 | * ATTR_CMN_ACCESSMASK |
425 | * ATTR_CMN_FLAGS |
426 | * |
427 | * ATTR_CMN_EXTENDED_SECURITY |
428 | * ATTR_CMN_UUID |
429 | * |
430 | * ATTR_CMN_GRPUUID |
431 | * |
432 | * ATTR_CMN_DATA_PROTECT_FLAGS |
433 | */ |
434 | #define ATTR_CMN_SETMASK 0x51C7FF00 |
435 | #define ATTR_CMN_VOLSETMASK 0x00006700 |
436 | |
437 | #define ATTR_VOL_FSTYPE 0x00000001 |
438 | #define ATTR_VOL_SIGNATURE 0x00000002 |
439 | #define ATTR_VOL_SIZE 0x00000004 |
440 | #define ATTR_VOL_SPACEFREE 0x00000008 |
441 | #define ATTR_VOL_SPACEAVAIL 0x00000010 |
442 | #define ATTR_VOL_MINALLOCATION 0x00000020 |
443 | #define ATTR_VOL_ALLOCATIONCLUMP 0x00000040 |
444 | #define ATTR_VOL_IOBLOCKSIZE 0x00000080 |
445 | #define ATTR_VOL_OBJCOUNT 0x00000100 |
446 | #define ATTR_VOL_FILECOUNT 0x00000200 |
447 | #define ATTR_VOL_DIRCOUNT 0x00000400 |
448 | #define ATTR_VOL_MAXOBJCOUNT 0x00000800 |
449 | #define ATTR_VOL_MOUNTPOINT 0x00001000 |
450 | #define ATTR_VOL_NAME 0x00002000 |
451 | #define ATTR_VOL_MOUNTFLAGS 0x00004000 |
452 | #define ATTR_VOL_MOUNTEDDEVICE 0x00008000 |
453 | #define ATTR_VOL_ENCODINGSUSED 0x00010000 |
454 | #define ATTR_VOL_CAPABILITIES 0x00020000 |
455 | #define ATTR_VOL_UUID 0x00040000 |
456 | #define ATTR_VOL_QUOTA_SIZE 0x10000000 |
457 | #define ATTR_VOL_RESERVED_SIZE 0x20000000 |
458 | #define ATTR_VOL_ATTRIBUTES 0x40000000 |
459 | #define ATTR_VOL_INFO 0x80000000 |
460 | |
461 | #define ATTR_VOL_VALIDMASK 0xF007FFFF |
462 | |
463 | /* |
464 | * The list of settable ATTR_VOL_* attributes include the following: |
465 | * ATTR_VOL_NAME |
466 | * ATTR_VOL_INFO |
467 | */ |
468 | #define ATTR_VOL_SETMASK 0x80002000 |
469 | |
470 | |
471 | /* File/directory attributes: */ |
472 | #define ATTR_DIR_LINKCOUNT 0x00000001 |
473 | #define ATTR_DIR_ENTRYCOUNT 0x00000002 |
474 | #define ATTR_DIR_MOUNTSTATUS 0x00000004 |
475 | #define ATTR_DIR_ALLOCSIZE 0x00000008 |
476 | #define ATTR_DIR_IOBLOCKSIZE 0x00000010 |
477 | #define ATTR_DIR_DATALENGTH 0x00000020 |
478 | |
479 | /* ATTR_DIR_MOUNTSTATUS Flags: */ |
480 | #define DIR_MNTSTATUS_MNTPOINT 0x00000001 |
481 | #define DIR_MNTSTATUS_TRIGGER 0x00000002 |
482 | |
483 | #define ATTR_DIR_VALIDMASK 0x0000003f |
484 | #define ATTR_DIR_SETMASK 0x00000000 |
485 | |
486 | #define ATTR_FILE_LINKCOUNT 0x00000001 |
487 | #define ATTR_FILE_TOTALSIZE 0x00000002 |
488 | #define ATTR_FILE_ALLOCSIZE 0x00000004 |
489 | #define ATTR_FILE_IOBLOCKSIZE 0x00000008 |
490 | #define ATTR_FILE_DEVTYPE 0x00000020 |
491 | #define ATTR_FILE_FORKCOUNT 0x00000080 |
492 | #define ATTR_FILE_FORKLIST 0x00000100 |
493 | #define ATTR_FILE_DATALENGTH 0x00000200 |
494 | #define ATTR_FILE_DATAALLOCSIZE 0x00000400 |
495 | #define ATTR_FILE_RSRCLENGTH 0x00001000 |
496 | #define ATTR_FILE_RSRCALLOCSIZE 0x00002000 |
497 | |
498 | #define ATTR_FILE_VALIDMASK 0x000037FF |
499 | /* |
500 | * Settable ATTR_FILE_* attributes include: |
501 | * ATTR_FILE_DEVTYPE |
502 | */ |
503 | #define ATTR_FILE_SETMASK 0x00000020 |
504 | |
505 | /* CMNEXT attributes extend the common attributes, but in the forkattr field */ |
506 | #define ATTR_CMNEXT_RELPATH 0x00000004 |
507 | #define ATTR_CMNEXT_PRIVATESIZE 0x00000008 |
508 | #define ATTR_CMNEXT_LINKID 0x00000010 |
509 | |
510 | #define ATTR_CMNEXT_VALIDMASK 0x0000001c |
511 | #define ATTR_CMNEXT_SETMASK 0x00000000 |
512 | |
513 | /* Deprecated fork attributes */ |
514 | #define ATTR_FORK_TOTALSIZE 0x00000001 |
515 | #define ATTR_FORK_ALLOCSIZE 0x00000002 |
516 | #define ATTR_FORK_RESERVED 0xffffffff |
517 | |
518 | #define ATTR_FORK_VALIDMASK 0x00000003 |
519 | #define ATTR_FORK_SETMASK 0x00000000 |
520 | |
521 | /* Obsolete, implemented, not supported */ |
522 | #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 |
523 | #define ATTR_CMN_NAMEDATTRLIST 0x00100000 |
524 | #define ATTR_FILE_CLUMPSIZE 0x00000010 /* obsolete */ |
525 | #define ATTR_FILE_FILETYPE 0x00000040 /* always zero */ |
526 | #define ATTR_FILE_DATAEXTENTS 0x00000800 /* obsolete, HFS-specific */ |
527 | #define ATTR_FILE_RSRCEXTENTS 0x00004000 /* obsolete, HFS-specific */ |
528 | |
529 | /* Required attributes for getattrlistbulk(2) */ |
530 | #define ATTR_BULK_REQUIRED (ATTR_CMN_NAME | ATTR_CMN_RETURNED_ATTRS) |
531 | |
532 | /* |
533 | * Searchfs |
534 | */ |
535 | #define SRCHFS_START 0x00000001 |
536 | #define SRCHFS_MATCHPARTIALNAMES 0x00000002 |
537 | #define SRCHFS_MATCHDIRS 0x00000004 |
538 | #define SRCHFS_MATCHFILES 0x00000008 |
539 | #define SRCHFS_SKIPLINKS 0x00000010 |
540 | #define SRCHFS_SKIPINVISIBLE 0x00000020 |
541 | #define SRCHFS_SKIPPACKAGES 0x00000040 |
542 | #define SRCHFS_SKIPINAPPROPRIATE 0x00000080 |
543 | |
544 | #define SRCHFS_NEGATEPARAMS 0x80000000 |
545 | #define SRCHFS_VALIDOPTIONSMASK 0x800000FF |
546 | |
547 | struct fssearchblock { |
548 | struct attrlist *returnattrs; |
549 | void *returnbuffer; |
550 | size_t returnbuffersize; |
551 | u_long maxmatches; |
552 | struct timeval timelimit; |
553 | void *searchparams1; |
554 | size_t sizeofsearchparams1; |
555 | void *searchparams2; |
556 | size_t sizeofsearchparams2; |
557 | struct attrlist searchattrs; |
558 | }; |
559 | |
560 | #ifdef KERNEL |
561 | /* LP64 version of fssearchblock. all pointers and longs |
562 | * grow when we're dealing with a 64-bit process. |
563 | * WARNING - keep in sync with fssearchblock |
564 | */ |
565 | |
566 | struct user64_fssearchblock { |
567 | user64_addr_t returnattrs; |
568 | user64_addr_t returnbuffer; |
569 | user64_size_t returnbuffersize; |
570 | user64_ulong_t maxmatches; |
571 | struct user64_timeval timelimit; |
572 | user64_addr_t searchparams1; |
573 | user64_size_t sizeofsearchparams1; |
574 | user64_addr_t searchparams2; |
575 | user64_size_t sizeofsearchparams2; |
576 | struct attrlist searchattrs; |
577 | }; |
578 | |
579 | struct user32_fssearchblock { |
580 | user32_addr_t returnattrs; |
581 | user32_addr_t returnbuffer; |
582 | user32_size_t returnbuffersize; |
583 | user32_ulong_t maxmatches; |
584 | struct user32_timeval timelimit; |
585 | user32_addr_t searchparams1; |
586 | user32_size_t sizeofsearchparams1; |
587 | user32_addr_t searchparams2; |
588 | user32_size_t sizeofsearchparams2; |
589 | struct attrlist searchattrs; |
590 | }; |
591 | |
592 | #endif /* KERNEL */ |
593 | |
594 | struct searchstate { |
595 | uint32_t ss_union_flags; // for SRCHFS_START |
596 | uint32_t ss_union_layer; // 0 = top |
597 | u_char ss_fsstate[548]; // fs private |
598 | } __attribute__((packed)); |
599 | |
600 | #define FST_EOF (-1) /* end-of-file offset */ |
601 | |
602 | #endif /* __APPLE_API_UNSTABLE */ |
603 | #endif /* !_SYS_ATTR_H_ */ |
604 | |