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 /* 137 * Max size of attribute buffer if IOPOL_TYPE_VFS_SUPPORT_LONG_PATHS is enabled 138 */ 139 #define ATTR_MAX_BUFFER_LONGPATHS (ATTR_MAX_BUFFER - MAXPATHLEN + MAXLONGPATHLEN) 140 141 /* 142 * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs 143 * that are persistent (retain their values even when the volume is 144 * unmounted and remounted), and a file or directory can be looked up 145 * by ID. Volumes that support VolFS and can support Carbon File ID 146 * references should set this bit. 147 * 148 * VOL_CAP_FMT_SYMBOLICLINKS: When set, the volume supports symbolic 149 * links. The symlink(), readlink(), and lstat() calls all use this 150 * symbolic link. 151 * 152 * VOL_CAP_FMT_HARDLINKS: When set, the volume supports hard links. 153 * The link() call creates hard links. 154 * 155 * VOL_CAP_FMT_JOURNAL: When set, the volume is capable of supporting 156 * a journal used to speed recovery in case of unplanned shutdown 157 * (such as a power outage or crash). This bit does not necessarily 158 * mean the volume is actively using a journal for recovery. 159 * 160 * VOL_CAP_FMT_JOURNAL_ACTIVE: When set, the volume is currently using 161 * a journal for use in speeding recovery after an unplanned shutdown. 162 * This bit can be set only if VOL_CAP_FMT_JOURNAL is also set. 163 * 164 * VOL_CAP_FMT_NO_ROOT_TIMES: When set, the volume format does not 165 * store reliable times for the root directory, so you should not 166 * depend on them to detect changes, etc. 167 * 168 * VOL_CAP_FMT_SPARSE_FILES: When set, the volume supports sparse files. 169 * That is, files which can have "holes" that have never been written 170 * to, and are not allocated on disk. Sparse files may have an 171 * allocated size that is less than the file's logical length. 172 * 173 * VOL_CAP_FMT_ZERO_RUNS: For security reasons, parts of a file (runs) 174 * that have never been written to must appear to contain zeroes. When 175 * this bit is set, the volume keeps track of allocated but unwritten 176 * runs of a file so that it can substitute zeroes without actually 177 * writing zeroes to the media. This provides performance similar to 178 * sparse files, but not the space savings. 179 * 180 * VOL_CAP_FMT_CASE_SENSITIVE: When set, file and directory names are 181 * case sensitive (upper and lower case are different). When clear, 182 * an upper case character is equivalent to a lower case character, 183 * and you can't have two names that differ solely in the case of 184 * the characters. 185 * 186 * VOL_CAP_FMT_CASE_PRESERVING: When set, file and directory names 187 * preserve the difference between upper and lower case. If clear, 188 * the volume may change the case of some characters (typically 189 * making them all upper or all lower case). A volume that sets 190 * VOL_CAP_FMT_CASE_SENSITIVE should also set VOL_CAP_FMT_CASE_PRESERVING. 191 * 192 * VOL_CAP_FMT_FAST_STATFS: This bit is used as a hint to upper layers 193 * (especially Carbon) that statfs() is fast enough that its results 194 * need not be cached by those upper layers. A volume that caches 195 * the statfs information in its in-memory structures should set this bit. 196 * A volume that must always read from disk or always perform a network 197 * transaction should not set this bit. 198 * 199 * VOL_CAP_FMT_2TB_FILESIZE: If this bit is set the volume format supports 200 * file sizes larger than 4GB, and potentially up to 2TB; it does not 201 * indicate whether the filesystem supports files larger than that. 202 * 203 * VOL_CAP_FMT_OPENDENYMODES: When set, the volume supports open deny 204 * modes (e.g. "open for read write, deny write"; effectively, mandatory 205 * file locking based on open modes). 206 * 207 * VOL_CAP_FMT_HIDDEN_FILES: When set, the volume supports the UF_HIDDEN 208 * file flag, and the UF_HIDDEN flag is mapped to that volume's native 209 * "hidden" or "invisible" bit (which may be the invisible bit from the 210 * Finder Info extended attribute). 211 * 212 * VOL_CAP_FMT_PATH_FROM_ID: When set, the volume supports the ability 213 * to derive a pathname to the root of the file system given only the 214 * id of an object. This also implies that object ids on this file 215 * system are persistent and not recycled. This is a very specialized 216 * capability and it is assumed that most file systems will not support 217 * it. Its use is for legacy non-posix APIs like ResolveFileIDRef. 218 * 219 * VOL_CAP_FMT_NO_VOLUME_SIZES: When set, the volume does not support 220 * returning values for total data blocks, available blocks, or free blocks 221 * (as in f_blocks, f_bavail, or f_bfree in "struct statfs"). Historically, 222 * those values were set to 0xFFFFFFFF for volumes that did not support them. 223 * 224 * VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent 225 * decompression of compressed files using decmpfs. 226 * 227 * VOL_CAP_FMT_64BIT_OBJECT_IDS: When set, the volume uses object IDs that 228 * are 64-bit. This means that ATTR_CMN_FILEID and ATTR_CMN_PARENTID are the 229 * only legitimate attributes for obtaining object IDs from this volume and the 230 * 32-bit fid_objno fields of the fsobj_id_t returned by ATTR_CMN_OBJID, 231 * ATTR_CMN_OBJPERMID, and ATTR_CMN_PAROBJID are undefined. 232 * 233 * VOL_CAP_FMT_DIR_HARDLINKS: When set, the volume supports directory 234 * hard links. 235 * 236 * VOL_CAP_FMT_DOCUMENT_ID: When set, the volume supports document IDs 237 * (an ID which persists across object ID changes) for document revisions. 238 * 239 * VOL_CAP_FMT_WRITE_GENERATION_COUNT: When set, the volume supports write 240 * generation counts (a count of how many times an object has been modified) 241 * 242 * VOL_CAP_FMT_NO_IMMUTABLE_FILES: When set, the volume does not support 243 * setting the UF_IMMUTABLE flag. 244 * 245 * VOL_CAP_FMT_NO_PERMISSIONS: When set, the volume does not support setting 246 * permissions. 247 * 248 * VOL_CAP_FMT_SHARED_SPACE: When set, the volume supports sharing space with 249 * other filesystems i.e. multiple logical filesystems can exist in the same 250 * "partition". An implication of this is that the filesystem which sets 251 * this capability treats waitfor arguments to VFS_SYNC as bit flags. 252 * 253 * VOL_CAP_FMT_VOL_GROUPS: When set, this volume is part of a volume-group 254 * that implies multiple volumes must be mounted in order to boot and root the 255 * operating system. Typically, this means a read-only system volume and a 256 * writable data volume. 257 * 258 * VOL_CAP_FMT_SEALED: When set, this volume is cryptographically sealed. 259 * Any modifications to volume data or metadata will be detected and may 260 * render the volume unusable. 261 * 262 * VOL_CAP_FMT_CLONE_MAPPING: When set, this volume supports full clone tracking. 263 * See ATTR_CMNEXT_CLONE_REFCNT and ATTR_CMNEXT_CLONEID for more details. 264 * Other features like extended directory statistics, for fast directory sizing, 265 * and attribution tags may be supported as well. 266 * See VOL_CAP_INT_ATTRIBUTION_TAG for more details related to tagging. 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 #define VOL_CAP_FMT_CLONE_MAPPING 0x04000000 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 * VOL_CAP_INT_ATTRIBUTION_TAG: When set, the volume supports establishing 370 * an owner relationship between a file (excluding small files) and a process 371 * on the first read/write/truncate/clone operation. 372 * 373 * VOL_CAP_INT_PUNCHHOLE: When set, the volume supports the F_PUNCHHOLE 374 * fcntl. 375 */ 376 #define VOL_CAP_INT_SEARCHFS 0x00000001 377 #define VOL_CAP_INT_ATTRLIST 0x00000002 378 #define VOL_CAP_INT_NFSEXPORT 0x00000004 379 #define VOL_CAP_INT_READDIRATTR 0x00000008 380 #define VOL_CAP_INT_EXCHANGEDATA 0x00000010 381 #define VOL_CAP_INT_COPYFILE 0x00000020 382 #define VOL_CAP_INT_ALLOCATE 0x00000040 383 #define VOL_CAP_INT_VOL_RENAME 0x00000080 384 #define VOL_CAP_INT_ADVLOCK 0x00000100 385 #define VOL_CAP_INT_FLOCK 0x00000200 386 #define VOL_CAP_INT_EXTENDED_SECURITY 0x00000400 387 #define VOL_CAP_INT_USERACCESS 0x00000800 388 #define VOL_CAP_INT_MANLOCK 0x00001000 389 #define VOL_CAP_INT_NAMEDSTREAMS 0x00002000 390 #define VOL_CAP_INT_EXTENDED_ATTR 0x00004000 391 #ifdef PRIVATE 392 /* Additional VOL_CAP_INT values in attr_private.h */ 393 #endif /* PRIVATE */ 394 #define VOL_CAP_INT_CLONE 0x00010000 395 #define VOL_CAP_INT_SNAPSHOT 0x00020000 396 #define VOL_CAP_INT_RENAME_SWAP 0x00040000 397 #define VOL_CAP_INT_RENAME_EXCL 0x00080000 398 #define VOL_CAP_INT_RENAME_OPENFAIL 0x00100000 399 #define VOL_CAP_INT_RENAME_SECLUDE 0x00200000 400 #define VOL_CAP_INT_ATTRIBUTION_TAG 0x00400000 401 #define VOL_CAP_INT_PUNCHHOLE 0x00800000 402 403 typedef struct vol_attributes_attr { 404 attribute_set_t validattr; 405 attribute_set_t nativeattr; 406 } vol_attributes_attr_t; 407 408 #define ATTR_CMN_NAME 0x00000001 409 #define ATTR_CMN_DEVID 0x00000002 410 #define ATTR_CMN_FSID 0x00000004 411 #define ATTR_CMN_OBJTYPE 0x00000008 412 #define ATTR_CMN_OBJTAG 0x00000010 413 #define ATTR_CMN_OBJID 0x00000020 414 #define ATTR_CMN_OBJPERMANENTID 0x00000040 415 #define ATTR_CMN_PAROBJID 0x00000080 416 #define ATTR_CMN_SCRIPT 0x00000100 417 #define ATTR_CMN_CRTIME 0x00000200 418 #define ATTR_CMN_MODTIME 0x00000400 419 #define ATTR_CMN_CHGTIME 0x00000800 420 #define ATTR_CMN_ACCTIME 0x00001000 421 #define ATTR_CMN_BKUPTIME 0x00002000 422 #define ATTR_CMN_FNDRINFO 0x00004000 423 #define ATTR_CMN_OWNERID 0x00008000 424 #define ATTR_CMN_GRPID 0x00010000 425 #define ATTR_CMN_ACCESSMASK 0x00020000 426 #define ATTR_CMN_FLAGS 0x00040000 427 428 /* The following were defined as: */ 429 /* #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 */ 430 /* #define ATTR_CMN_NAMEDATTRLIST 0x00100000 */ 431 /* These bits have been salvaged for use as: */ 432 /* #define ATTR_CMN_GEN_COUNT 0x00080000 */ 433 /* #define ATTR_CMN_DOCUMENT_ID 0x00100000 */ 434 /* They can only be used with the FSOPT_ATTR_CMN_EXTENDED */ 435 /* option flag. */ 436 437 #define ATTR_CMN_GEN_COUNT 0x00080000 438 #define ATTR_CMN_DOCUMENT_ID 0x00100000 439 440 #define ATTR_CMN_USERACCESS 0x00200000 441 #define ATTR_CMN_EXTENDED_SECURITY 0x00400000 442 #define ATTR_CMN_UUID 0x00800000 443 #define ATTR_CMN_GRPUUID 0x01000000 444 #define ATTR_CMN_FILEID 0x02000000 445 #define ATTR_CMN_PARENTID 0x04000000 446 #define ATTR_CMN_FULLPATH 0x08000000 447 #define ATTR_CMN_ADDEDTIME 0x10000000 448 #define ATTR_CMN_ERROR 0x20000000 449 #define ATTR_CMN_DATA_PROTECT_FLAGS 0x40000000 450 451 /* 452 * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2) and 453 * getattrlistbulk(2). It is always the first attribute in the return buffer. 454 */ 455 #define ATTR_CMN_RETURNED_ATTRS 0x80000000 456 457 #define ATTR_CMN_VALIDMASK 0xFFFFFFFF 458 /* 459 * The settable ATTR_CMN_* attributes include the following: 460 * ATTR_CMN_SCRIPT 461 * ATTR_CMN_CRTIME 462 * ATTR_CMN_MODTIME 463 * ATTR_CMN_CHGTIME 464 * 465 * ATTR_CMN_ACCTIME 466 * ATTR_CMN_BKUPTIME 467 * ATTR_CMN_FNDRINFO 468 * ATTR_CMN_OWNERID 469 * 470 * ATTR_CMN_GRPID 471 * ATTR_CMN_ACCESSMASK 472 * ATTR_CMN_FLAGS 473 * 474 * ATTR_CMN_EXTENDED_SECURITY 475 * ATTR_CMN_UUID 476 * 477 * ATTR_CMN_GRPUUID 478 * 479 * ATTR_CMN_DATA_PROTECT_FLAGS 480 */ 481 #define ATTR_CMN_SETMASK 0x51C7FF00 482 #define ATTR_CMN_VOLSETMASK 0x00006700 483 484 #define ATTR_VOL_FSTYPE 0x00000001 485 #define ATTR_VOL_SIGNATURE 0x00000002 486 #define ATTR_VOL_SIZE 0x00000004 487 #define ATTR_VOL_SPACEFREE 0x00000008 488 #define ATTR_VOL_SPACEAVAIL 0x00000010 489 #define ATTR_VOL_MINALLOCATION 0x00000020 490 #define ATTR_VOL_ALLOCATIONCLUMP 0x00000040 491 #define ATTR_VOL_IOBLOCKSIZE 0x00000080 492 #define ATTR_VOL_OBJCOUNT 0x00000100 493 #define ATTR_VOL_FILECOUNT 0x00000200 494 #define ATTR_VOL_DIRCOUNT 0x00000400 495 #define ATTR_VOL_MAXOBJCOUNT 0x00000800 496 #define ATTR_VOL_MOUNTPOINT 0x00001000 497 #define ATTR_VOL_NAME 0x00002000 498 #define ATTR_VOL_MOUNTFLAGS 0x00004000 499 #define ATTR_VOL_MOUNTEDDEVICE 0x00008000 500 #define ATTR_VOL_ENCODINGSUSED 0x00010000 501 #define ATTR_VOL_CAPABILITIES 0x00020000 502 #define ATTR_VOL_UUID 0x00040000 503 #define ATTR_VOL_MOUNTEXTFLAGS 0x00080000 504 #define ATTR_VOL_FSTYPENAME 0x00100000 505 #define ATTR_VOL_FSSUBTYPE 0x00200000 506 #define ATTR_VOL_OWNER 0x00400000 507 #define ATTR_VOL_SPACEUSED 0x00800000 508 #define ATTR_VOL_QUOTA_SIZE 0x10000000 509 #define ATTR_VOL_RESERVED_SIZE 0x20000000 510 #define ATTR_VOL_ATTRIBUTES 0x40000000 511 #define ATTR_VOL_INFO 0x80000000 512 513 #define ATTR_VOL_VALIDMASK 0xF0FFFFFF 514 515 /* 516 * The list of settable ATTR_VOL_* attributes include the following: 517 * ATTR_VOL_NAME 518 * ATTR_VOL_INFO 519 */ 520 #define ATTR_VOL_SETMASK 0x80002000 521 522 523 /* File/directory attributes: */ 524 #define ATTR_DIR_LINKCOUNT 0x00000001 525 #define ATTR_DIR_ENTRYCOUNT 0x00000002 526 #define ATTR_DIR_MOUNTSTATUS 0x00000004 527 #define ATTR_DIR_ALLOCSIZE 0x00000008 528 #define ATTR_DIR_IOBLOCKSIZE 0x00000010 529 #define ATTR_DIR_DATALENGTH 0x00000020 530 531 /* ATTR_DIR_MOUNTSTATUS Flags: */ 532 #define DIR_MNTSTATUS_MNTPOINT 0x00000001 533 #define DIR_MNTSTATUS_TRIGGER 0x00000002 534 535 #define ATTR_DIR_VALIDMASK 0x0000003f 536 #define ATTR_DIR_SETMASK 0x00000000 537 538 #define ATTR_FILE_LINKCOUNT 0x00000001 539 #define ATTR_FILE_TOTALSIZE 0x00000002 540 #define ATTR_FILE_ALLOCSIZE 0x00000004 541 #define ATTR_FILE_IOBLOCKSIZE 0x00000008 542 #define ATTR_FILE_DEVTYPE 0x00000020 543 #define ATTR_FILE_FORKCOUNT 0x00000080 544 #define ATTR_FILE_FORKLIST 0x00000100 545 #define ATTR_FILE_DATALENGTH 0x00000200 546 #define ATTR_FILE_DATAALLOCSIZE 0x00000400 547 #define ATTR_FILE_RSRCLENGTH 0x00001000 548 #define ATTR_FILE_RSRCALLOCSIZE 0x00002000 549 550 #define ATTR_FILE_VALIDMASK 0x000037FF 551 /* 552 * Settable ATTR_FILE_* attributes include: 553 * ATTR_FILE_DEVTYPE 554 */ 555 #define ATTR_FILE_SETMASK 0x00000020 556 557 /* CMNEXT attributes extend the common attributes, but in the forkattr field */ 558 #define ATTR_CMNEXT_RELPATH 0x00000004 559 #define ATTR_CMNEXT_PRIVATESIZE 0x00000008 560 #define ATTR_CMNEXT_LINKID 0x00000010 561 #define ATTR_CMNEXT_NOFIRMLINKPATH 0x00000020 562 #define ATTR_CMNEXT_REALDEVID 0x00000040 563 #define ATTR_CMNEXT_REALFSID 0x00000080 564 #define ATTR_CMNEXT_CLONEID 0x00000100 565 #define ATTR_CMNEXT_EXT_FLAGS 0x00000200 566 #define ATTR_CMNEXT_RECURSIVE_GENCOUNT 0x00000400 567 #define ATTR_CMNEXT_ATTRIBUTION_TAG 0x00000800 568 #define ATTR_CMNEXT_CLONE_REFCNT 0x00001000 569 570 #define ATTR_CMNEXT_VALIDMASK 0x00001ffc 571 #define ATTR_CMNEXT_SETMASK 0x00000000 572 573 /* Deprecated fork attributes */ 574 #define ATTR_FORK_TOTALSIZE 0x00000001 575 #define ATTR_FORK_ALLOCSIZE 0x00000002 576 #define ATTR_FORK_RESERVED 0xffffffff 577 578 #define ATTR_FORK_VALIDMASK 0x00000003 579 #define ATTR_FORK_SETMASK 0x00000000 580 581 /* Obsolete, implemented, not supported */ 582 #define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 583 #define ATTR_CMN_NAMEDATTRLIST 0x00100000 584 #define ATTR_FILE_CLUMPSIZE 0x00000010 /* obsolete */ 585 #define ATTR_FILE_FILETYPE 0x00000040 /* always zero */ 586 #define ATTR_FILE_DATAEXTENTS 0x00000800 /* obsolete, HFS-specific */ 587 #define ATTR_FILE_RSRCEXTENTS 0x00004000 /* obsolete, HFS-specific */ 588 589 /* Required attributes for getattrlistbulk(2) */ 590 #define ATTR_BULK_REQUIRED (ATTR_CMN_NAME | ATTR_CMN_RETURNED_ATTRS) 591 592 /* 593 * Searchfs 594 */ 595 #define SRCHFS_START 0x00000001 596 #define SRCHFS_MATCHPARTIALNAMES 0x00000002 597 #define SRCHFS_MATCHDIRS 0x00000004 598 #define SRCHFS_MATCHFILES 0x00000008 599 #define SRCHFS_SKIPLINKS 0x00000010 600 #define SRCHFS_SKIPINVISIBLE 0x00000020 601 #define SRCHFS_SKIPPACKAGES 0x00000040 602 #define SRCHFS_SKIPINAPPROPRIATE 0x00000080 603 604 #define SRCHFS_NEGATEPARAMS 0x80000000 605 #define SRCHFS_VALIDOPTIONSMASK 0x800000FF 606 607 struct fssearchblock { 608 struct attrlist *returnattrs; 609 void *returnbuffer; 610 size_t returnbuffersize; 611 u_long maxmatches; 612 struct timeval timelimit; 613 void *searchparams1; 614 size_t sizeofsearchparams1; 615 void *searchparams2; 616 size_t sizeofsearchparams2; 617 struct attrlist searchattrs; 618 }; 619 620 #ifdef KERNEL 621 /* LP64 version of fssearchblock. all pointers and longs 622 * grow when we're dealing with a 64-bit process. 623 * WARNING - keep in sync with fssearchblock 624 */ 625 626 struct user64_fssearchblock { 627 user64_addr_t returnattrs; 628 user64_addr_t returnbuffer; 629 user64_size_t returnbuffersize; 630 user64_ulong_t maxmatches; 631 struct user64_timeval timelimit; 632 user64_addr_t searchparams1; 633 user64_size_t sizeofsearchparams1; 634 user64_addr_t searchparams2; 635 user64_size_t sizeofsearchparams2; 636 struct attrlist searchattrs; 637 }; 638 639 struct user32_fssearchblock { 640 user32_addr_t returnattrs; 641 user32_addr_t returnbuffer; 642 user32_size_t returnbuffersize; 643 user32_ulong_t maxmatches; 644 struct user32_timeval timelimit; 645 user32_addr_t searchparams1; 646 user32_size_t sizeofsearchparams1; 647 user32_addr_t searchparams2; 648 user32_size_t sizeofsearchparams2; 649 struct attrlist searchattrs; 650 }; 651 652 #endif /* KERNEL */ 653 654 struct searchstate { 655 uint32_t ss_union_flags; // for SRCHFS_START 656 uint32_t ss_union_layer; // 0 = top 657 u_char ss_fsstate[548]; // fs private 658 } __attribute__((packed)); 659 660 #define FST_EOF (-1) /* end-of-file offset */ 661 662 #endif /* __APPLE_API_UNSTABLE */ 663 664 #ifdef PRIVATE 665 #include <sys/attr_private.h> 666 #endif 667 668 #endif /* !_SYS_ATTR_H_ */ 669