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