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