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