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