2 * Copyright (c) 2000-2010 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
30 * attr.h - attribute data structures and interfaces
32 * Copyright (c) 1998, Apple Computer, Inc. All Rights Reserved.
38 #include <sys/appleapiopts.h>
40 #ifdef __APPLE_API_UNSTABLE
41 #include <sys/types.h>
42 #include <sys/ucred.h>
44 #include <sys/cdefs.h>
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
53 #define FSOPT_EXCHANGE_DATA_ONLY 0x0000010
56 /* we currently aren't anywhere near this amount for a valid
57 * fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
58 * but we put a sanity check in to avoid abuse of the value passed in from
61 #define SEARCHFS_MAX_SEARCHPARMS 4096
63 typedef u_int32_t text_encoding_t
;
65 typedef u_int32_t fsobj_type_t
;
67 typedef u_int32_t fsobj_tag_t
;
69 typedef u_int32_t fsfile_type_t
;
71 typedef u_int32_t fsvolid_t
;
73 typedef struct fsobj_id
{
75 u_int32_t fid_generation
;
78 typedef u_int32_t attrgroup_t
;
81 u_short bitmapcount
; /* number of attr. bit sets in list (should be 5) */
82 u_int16_t reserved
; /* (to maintain 4-byte alignment) */
83 attrgroup_t commonattr
; /* common attribute group */
84 attrgroup_t volattr
; /* Volume attribute group */
85 attrgroup_t dirattr
; /* directory attribute group */
86 attrgroup_t fileattr
; /* file attribute group */
87 attrgroup_t forkattr
; /* fork attribute group */
89 #define ATTR_BIT_MAP_COUNT 5
91 typedef 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 */
99 typedef struct attrreference
{
100 int32_t attr_dataoffset
;
101 u_int32_t attr_length
;
104 /* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */
107 u_int32_t startblock
; /* first block allocated */
108 u_int32_t blockcount
; /* number of blocks allocated */
111 typedef struct diskextent extentrecord
[8];
113 typedef u_int32_t vol_capabilities_set_t
[4];
115 #define VOL_CAPABILITIES_FORMAT 0
116 #define VOL_CAPABILITIES_INTERFACES 1
117 #define VOL_CAPABILITIES_RESERVED1 2
118 #define VOL_CAPABILITIES_RESERVED2 3
120 typedef struct vol_capabilities_attr
{
121 vol_capabilities_set_t capabilities
;
122 vol_capabilities_set_t valid
;
123 } vol_capabilities_attr_t
;
126 * XXX this value needs to be raised - 3893388
128 #define ATTR_MAX_BUFFER 8192
131 * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs
132 * that are persistent (retain their values even when the volume is
133 * unmounted and remounted), and a file or directory can be looked up
134 * by ID. Volumes that support VolFS and can support Carbon File ID
135 * references should set this bit.
137 * VOL_CAP_FMT_SYMBOLICLINKS: When set, the volume supports symbolic
138 * links. The symlink(), readlink(), and lstat() calls all use this
141 * VOL_CAP_FMT_HARDLINKS: When set, the volume supports hard links.
142 * The link() call creates hard links.
144 * VOL_CAP_FMT_JOURNAL: When set, the volume is capable of supporting
145 * a journal used to speed recovery in case of unplanned shutdown
146 * (such as a power outage or crash). This bit does not necessarily
147 * mean the volume is actively using a journal for recovery.
149 * VOL_CAP_FMT_JOURNAL_ACTIVE: When set, the volume is currently using
150 * a journal for use in speeding recovery after an unplanned shutdown.
151 * This bit can be set only if VOL_CAP_FMT_JOURNAL is also set.
153 * VOL_CAP_FMT_NO_ROOT_TIMES: When set, the volume format does not
154 * store reliable times for the root directory, so you should not
155 * depend on them to detect changes, etc.
157 * VOL_CAP_FMT_SPARSE_FILES: When set, the volume supports sparse files.
158 * That is, files which can have "holes" that have never been written
159 * to, and are not allocated on disk. Sparse files may have an
160 * allocated size that is less than the file's logical length.
162 * VOL_CAP_FMT_ZERO_RUNS: For security reasons, parts of a file (runs)
163 * that have never been written to must appear to contain zeroes. When
164 * this bit is set, the volume keeps track of allocated but unwritten
165 * runs of a file so that it can substitute zeroes without actually
166 * writing zeroes to the media. This provides performance similar to
167 * sparse files, but not the space savings.
169 * VOL_CAP_FMT_CASE_SENSITIVE: When set, file and directory names are
170 * case sensitive (upper and lower case are different). When clear,
171 * an upper case character is equivalent to a lower case character,
172 * and you can't have two names that differ solely in the case of
175 * VOL_CAP_FMT_CASE_PRESERVING: When set, file and directory names
176 * preserve the difference between upper and lower case. If clear,
177 * the volume may change the case of some characters (typically
178 * making them all upper or all lower case). A volume that sets
179 * VOL_CAP_FMT_CASE_SENSITIVE should also set VOL_CAP_FMT_CASE_PRESERVING.
181 * VOL_CAP_FMT_FAST_STATFS: This bit is used as a hint to upper layers
182 * (especially Carbon) that statfs() is fast enough that its results
183 * need not be cached by those upper layers. A volume that caches
184 * the statfs information in its in-memory structures should set this bit.
185 * A volume that must always read from disk or always perform a network
186 * transaction should not set this bit.
188 * VOL_CAP_FMT_2TB_FILESIZE: If this bit is set the volume format supports
189 * file sizes larger than 4GB, and potentially up to 2TB; it does not
190 * indicate whether the filesystem supports files larger than that.
192 * VOL_CAP_FMT_OPENDENYMODES: When set, the volume supports open deny
193 * modes (e.g. "open for read write, deny write"; effectively, mandatory
194 * file locking based on open modes).
196 * VOL_CAP_FMT_HIDDEN_FILES: When set, the volume supports the UF_HIDDEN
197 * file flag, and the UF_HIDDEN flag is mapped to that volume's native
198 * "hidden" or "invisible" bit (which may be the invisible bit from the
199 * Finder Info extended attribute).
201 * VOL_CAP_FMT_PATH_FROM_ID: When set, the volume supports the ability
202 * to derive a pathname to the root of the file system given only the
203 * id of an object. This also implies that object ids on this file
204 * system are persistent and not recycled. This is a very specialized
205 * capability and it is assumed that most file systems will not support
206 * it. Its use is for legacy non-posix APIs like ResolveFileIDRef.
208 * VOL_CAP_FMT_NO_VOLUME_SIZES: When set, the volume does not support
209 * returning values for total data blocks, available blocks, or free blocks
210 * (as in f_blocks, f_bavail, or f_bfree in "struct statfs"). Historically,
211 * those values were set to 0xFFFFFFFF for volumes that did not support them.
213 * VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent
214 * decompression of compressed files using decmpfs.
216 * VOL_CAP_FMT_64BIT_OBJECT_IDS: When set, the volume uses object IDs that
217 * are 64-bit. This means that ATTR_CMN_FILEID and ATTR_CMN_PARENTID are the
218 * only legitimate attributes for obtaining object IDs from this volume and the
219 * 32-bit fid_objno fields of the fsobj_id_t returned by ATTR_CMN_OBJID,
220 * ATTR_CMN_OBJPERMID, and ATTR_CMN_PAROBJID are undefined.
222 #define VOL_CAP_FMT_PERSISTENTOBJECTIDS 0x00000001
223 #define VOL_CAP_FMT_SYMBOLICLINKS 0x00000002
224 #define VOL_CAP_FMT_HARDLINKS 0x00000004
225 #define VOL_CAP_FMT_JOURNAL 0x00000008
226 #define VOL_CAP_FMT_JOURNAL_ACTIVE 0x00000010
227 #define VOL_CAP_FMT_NO_ROOT_TIMES 0x00000020
228 #define VOL_CAP_FMT_SPARSE_FILES 0x00000040
229 #define VOL_CAP_FMT_ZERO_RUNS 0x00000080
230 #define VOL_CAP_FMT_CASE_SENSITIVE 0x00000100
231 #define VOL_CAP_FMT_CASE_PRESERVING 0x00000200
232 #define VOL_CAP_FMT_FAST_STATFS 0x00000400
233 #define VOL_CAP_FMT_2TB_FILESIZE 0x00000800
234 #define VOL_CAP_FMT_OPENDENYMODES 0x00001000
235 #define VOL_CAP_FMT_HIDDEN_FILES 0x00002000
236 #define VOL_CAP_FMT_PATH_FROM_ID 0x00004000
237 #define VOL_CAP_FMT_NO_VOLUME_SIZES 0x00008000
238 #define VOL_CAP_FMT_DECMPFS_COMPRESSION 0x00010000
239 #define VOL_CAP_FMT_64BIT_OBJECT_IDS 0x00020000
243 * VOL_CAP_INT_SEARCHFS: When set, the volume implements the
244 * searchfs() system call (the vnop_searchfs vnode operation).
246 * VOL_CAP_INT_ATTRLIST: When set, the volume implements the
247 * getattrlist() and setattrlist() system calls (vnop_getattrlist
248 * and vnop_setattrlist vnode operations) for the volume, files,
249 * and directories. The volume may or may not implement the
250 * readdirattr() system call. XXX Is there any minimum set
251 * of attributes that should be supported? To determine the
252 * set of supported attributes, get the ATTR_VOL_ATTRIBUTES
253 * attribute of the volume.
255 * VOL_CAP_INT_NFSEXPORT: When set, the volume implements exporting
258 * VOL_CAP_INT_READDIRATTR: When set, the volume implements the
259 * readdirattr() system call (vnop_readdirattr vnode operation).
261 * VOL_CAP_INT_EXCHANGEDATA: When set, the volume implements the
262 * exchangedata() system call (VNOP_EXCHANGE vnode operation).
264 * VOL_CAP_INT_COPYFILE: When set, the volume implements the
265 * VOP_COPYFILE vnode operation. (XXX There should be a copyfile()
266 * system call in <unistd.h>.)
268 * VOL_CAP_INT_ALLOCATE: When set, the volume implements the
269 * VNOP_ALLOCATE vnode operation, which means it implements the
270 * F_PREALLOCATE selector of fcntl(2).
272 * VOL_CAP_INT_VOL_RENAME: When set, the volume implements the
273 * ATTR_VOL_NAME attribute for both getattrlist() and setattrlist().
274 * The volume can be renamed by setting ATTR_VOL_NAME with setattrlist().
276 * VOL_CAP_INT_ADVLOCK: When set, the volume implements POSIX style
277 * byte range locks via vnop_advlock (accessible from fcntl(2)).
279 * VOL_CAP_INT_FLOCK: When set, the volume implements whole-file flock(2)
280 * style locks via vnop_advlock. This includes the O_EXLOCK and O_SHLOCK
281 * flags of the open(2) call.
283 * VOL_CAP_INT_EXTENDED_SECURITY: When set, the volume implements
284 * extended security (ACLs).
286 * VOL_CAP_INT_USERACCESS: When set, the volume supports the
287 * ATTR_CMN_USERACCESS attribute (used to get the user's access
290 * VOL_CAP_INT_MANLOCK: When set, the volume supports AFP-style
291 * mandatory byte range locks via an ioctl().
293 * VOL_CAP_INT_EXTENDED_ATTR: When set, the volume implements
294 * native extended attribues.
296 * VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports
297 * native named streams.
299 #define VOL_CAP_INT_SEARCHFS 0x00000001
300 #define VOL_CAP_INT_ATTRLIST 0x00000002
301 #define VOL_CAP_INT_NFSEXPORT 0x00000004
302 #define VOL_CAP_INT_READDIRATTR 0x00000008
303 #define VOL_CAP_INT_EXCHANGEDATA 0x00000010
304 #define VOL_CAP_INT_COPYFILE 0x00000020
305 #define VOL_CAP_INT_ALLOCATE 0x00000040
306 #define VOL_CAP_INT_VOL_RENAME 0x00000080
307 #define VOL_CAP_INT_ADVLOCK 0x00000100
308 #define VOL_CAP_INT_FLOCK 0x00000200
309 #define VOL_CAP_INT_EXTENDED_SECURITY 0x00000400
310 #define VOL_CAP_INT_USERACCESS 0x00000800
311 #define VOL_CAP_INT_MANLOCK 0x00001000
312 #define VOL_CAP_INT_NAMEDSTREAMS 0x00002000
313 #define VOL_CAP_INT_EXTENDED_ATTR 0x00004000
315 /* Volume supports kqueue notifications for remote events */
316 #define VOL_CAP_INT_REMOTE_EVENT 0x00008000
319 typedef struct vol_attributes_attr
{
320 attribute_set_t validattr
;
321 attribute_set_t nativeattr
;
322 } vol_attributes_attr_t
;
324 #define ATTR_CMN_NAME 0x00000001
325 #define ATTR_CMN_DEVID 0x00000002
326 #define ATTR_CMN_FSID 0x00000004
327 #define ATTR_CMN_OBJTYPE 0x00000008
328 #define ATTR_CMN_OBJTAG 0x00000010
329 #define ATTR_CMN_OBJID 0x00000020
330 #define ATTR_CMN_OBJPERMANENTID 0x00000040
331 #define ATTR_CMN_PAROBJID 0x00000080
332 #define ATTR_CMN_SCRIPT 0x00000100
333 #define ATTR_CMN_CRTIME 0x00000200
334 #define ATTR_CMN_MODTIME 0x00000400
335 #define ATTR_CMN_CHGTIME 0x00000800
336 #define ATTR_CMN_ACCTIME 0x00001000
337 #define ATTR_CMN_BKUPTIME 0x00002000
338 #define ATTR_CMN_FNDRINFO 0x00004000
339 #define ATTR_CMN_OWNERID 0x00008000
340 #define ATTR_CMN_GRPID 0x00010000
341 #define ATTR_CMN_ACCESSMASK 0x00020000
342 #define ATTR_CMN_FLAGS 0x00040000
343 /* #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 not implemented */
344 /* #define ATTR_CMN_NAMEDATTRLIST 0x00100000 not implemented */
345 #define ATTR_CMN_USERACCESS 0x00200000
346 #define ATTR_CMN_EXTENDED_SECURITY 0x00400000
347 #define ATTR_CMN_UUID 0x00800000
348 #define ATTR_CMN_GRPUUID 0x01000000
349 #define ATTR_CMN_FILEID 0x02000000
350 #define ATTR_CMN_PARENTID 0x04000000
351 #define ATTR_CMN_FULLPATH 0x08000000
352 #define ATTR_CMN_ADDEDTIME 0x10000000
355 * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2).
356 * It is always the first attribute in the return buffer.
358 #define ATTR_CMN_RETURNED_ATTRS 0x80000000
360 #define ATTR_CMN_VALIDMASK 0x9FE7FFFF
361 #define ATTR_CMN_SETMASK 0x01C7FF00
362 #define ATTR_CMN_VOLSETMASK 0x00006700
364 #define ATTR_VOL_FSTYPE 0x00000001
365 #define ATTR_VOL_SIGNATURE 0x00000002
366 #define ATTR_VOL_SIZE 0x00000004
367 #define ATTR_VOL_SPACEFREE 0x00000008
368 #define ATTR_VOL_SPACEAVAIL 0x00000010
369 #define ATTR_VOL_MINALLOCATION 0x00000020
370 #define ATTR_VOL_ALLOCATIONCLUMP 0x00000040
371 #define ATTR_VOL_IOBLOCKSIZE 0x00000080
372 #define ATTR_VOL_OBJCOUNT 0x00000100
373 #define ATTR_VOL_FILECOUNT 0x00000200
374 #define ATTR_VOL_DIRCOUNT 0x00000400
375 #define ATTR_VOL_MAXOBJCOUNT 0x00000800
376 #define ATTR_VOL_MOUNTPOINT 0x00001000
377 #define ATTR_VOL_NAME 0x00002000
378 #define ATTR_VOL_MOUNTFLAGS 0x00004000
379 #define ATTR_VOL_MOUNTEDDEVICE 0x00008000
380 #define ATTR_VOL_ENCODINGSUSED 0x00010000
381 #define ATTR_VOL_CAPABILITIES 0x00020000
382 #define ATTR_VOL_UUID 0x00040000
383 #define ATTR_VOL_ATTRIBUTES 0x40000000
384 #define ATTR_VOL_INFO 0x80000000
386 #define ATTR_VOL_VALIDMASK 0xC007FFFF
387 #define ATTR_VOL_SETMASK 0x80002000
390 /* File/directory attributes: */
391 #define ATTR_DIR_LINKCOUNT 0x00000001
392 #define ATTR_DIR_ENTRYCOUNT 0x00000002
393 #define ATTR_DIR_MOUNTSTATUS 0x00000004
394 /* ATTR_DIR_MOUNTSTATUS Flags: */
395 #define DIR_MNTSTATUS_MNTPOINT 0x00000001
396 #define DIR_MNTSTATUS_TRIGGER 0x00000002
398 #define ATTR_DIR_VALIDMASK 0x00000007
399 #define ATTR_DIR_SETMASK 0x00000000
401 #define ATTR_FILE_LINKCOUNT 0x00000001
402 #define ATTR_FILE_TOTALSIZE 0x00000002
403 #define ATTR_FILE_ALLOCSIZE 0x00000004
404 #define ATTR_FILE_IOBLOCKSIZE 0x00000008
405 #define ATTR_FILE_DEVTYPE 0x00000020
406 #define ATTR_FILE_FORKCOUNT 0x00000080
407 #define ATTR_FILE_FORKLIST 0x00000100
408 #define ATTR_FILE_DATALENGTH 0x00000200
409 #define ATTR_FILE_DATAALLOCSIZE 0x00000400
410 #define ATTR_FILE_RSRCLENGTH 0x00001000
411 #define ATTR_FILE_RSRCALLOCSIZE 0x00002000
413 #define ATTR_FILE_VALIDMASK 0x000037FF
414 #define ATTR_FILE_SETMASK 0x00000020
416 #define ATTR_FORK_TOTALSIZE 0x00000001
417 #define ATTR_FORK_ALLOCSIZE 0x00000002
419 #define ATTR_FORK_VALIDMASK 0x00000003
420 #define ATTR_FORK_SETMASK 0x00000000
422 /* Obsolete, implemented, not supported */
423 #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 /* not implemented */
424 #define ATTR_CMN_NAMEDATTRLIST 0x00100000 /* not implemented */
425 #define ATTR_FILE_CLUMPSIZE 0x00000010 /* obsolete */
426 #define ATTR_FILE_FILETYPE 0x00000040 /* always zero */
427 #define ATTR_FILE_DATAEXTENTS 0x00000800 /* obsolete, HFS-specific */
428 #define ATTR_FILE_RSRCEXTENTS 0x00004000 /* obsolete, HFS-specific */
433 #define SRCHFS_START 0x00000001
434 #define SRCHFS_MATCHPARTIALNAMES 0x00000002
435 #define SRCHFS_MATCHDIRS 0x00000004
436 #define SRCHFS_MATCHFILES 0x00000008
437 #define SRCHFS_SKIPLINKS 0x00000010
438 #define SRCHFS_SKIPINVISIBLE 0x00000020
439 #define SRCHFS_SKIPPACKAGES 0x00000040
440 #define SRCHFS_SKIPINAPPROPRIATE 0x00000080
442 #define SRCHFS_NEGATEPARAMS 0x80000000
443 #define SRCHFS_VALIDOPTIONSMASK 0x800000FF
445 struct fssearchblock
{
446 struct attrlist
*returnattrs
;
448 size_t returnbuffersize
;
450 struct timeval timelimit
;
452 size_t sizeofsearchparams1
;
454 size_t sizeofsearchparams2
;
455 struct attrlist searchattrs
;
459 /* LP64 version of fssearchblock. all pointers and longs
460 * grow when we're dealing with a 64-bit process.
461 * WARNING - keep in sync with fssearchblock
464 struct user64_fssearchblock
{
465 user64_addr_t returnattrs
;
466 user64_addr_t returnbuffer
;
467 user64_size_t returnbuffersize
;
468 user64_ulong_t maxmatches
;
469 struct user64_timeval timelimit
;
470 user64_addr_t searchparams1
;
471 user64_size_t sizeofsearchparams1
;
472 user64_addr_t searchparams2
;
473 user64_size_t sizeofsearchparams2
;
474 struct attrlist searchattrs
;
477 struct user32_fssearchblock
{
478 user32_addr_t returnattrs
;
479 user32_addr_t returnbuffer
;
480 user32_size_t returnbuffersize
;
481 user32_ulong_t maxmatches
;
482 struct user32_timeval timelimit
;
483 user32_addr_t searchparams1
;
484 user32_size_t sizeofsearchparams1
;
485 user32_addr_t searchparams2
;
486 user32_size_t sizeofsearchparams2
;
487 struct attrlist searchattrs
;
494 u_char reserved
[556]; // sizeof( SearchState )
498 #define FST_EOF (-1) /* end-of-file offset */
500 #endif /* __APPLE_API_UNSTABLE */
501 #endif /* !_SYS_ATTR_H_ */