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