xnu-6153.61.1.tar.gz

[apple/xnu.git] / bsd / sys / attr.h

diff --git a/bsd/sys/attr.h b/bsd/sys/attr.h
index e33ad2b8688385dc85eb9b278882a702aaa61c5e..5b4f4c133d8f791b774393cd7b2283cd0e43a95f 100644 (file)
--- a/bsd/sys/attr.h
+++ b/bsd/sys/attr.h
@@ -1,8 +1,8 @@
 /*
 /*

- * Copyright (c) 2000-2010 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2018 Apple Computer, Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

- * 
+ *

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in


@@ -11,10 +11,10 @@
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.

- * 
+ *

  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.

- * 
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -22,7 +22,7 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
+ *

  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 


@@ -43,16 +43,29 @@
 #include <sys/time.h>
 #include <sys/cdefs.h>
 
 #include <sys/time.h>
 #include <sys/cdefs.h>
 

-#define FSOPT_NOFOLLOW                 0x00000001
-#define FSOPT_NOINMEMUPDATE    0x00000002
-#define FSOPT_REPORT_FULLSIZE  0x00000004
+#define FSOPT_NOFOLLOW          0x00000001
+#define FSOPT_NOINMEMUPDATE     0x00000002
+#define FSOPT_REPORT_FULLSIZE   0x00000004

 /* The following option only valid when requesting ATTR_CMN_RETURNED_ATTRS */
 /* The following option only valid when requesting ATTR_CMN_RETURNED_ATTRS */

-#define FSOPT_PACK_INVAL_ATTRS 0x00000008
+#define FSOPT_PACK_INVAL_ATTRS  0x00000008

 
 #ifdef PRIVATE
 #define FSOPT_EXCHANGE_DATA_ONLY 0x0000010
 #endif
 
 
 #ifdef PRIVATE
 #define FSOPT_EXCHANGE_DATA_ONLY 0x0000010
 #endif
 

+#define FSOPT_ATTR_CMN_EXTENDED 0x00000020
+#ifdef PRIVATE
+#define FSOPT_LIST_SNAPSHOT     0x00000040
+#ifndef FSOPT_NOFIRMLINKPATH /*a copy is in fsgetpath.h */
+#define FSOPT_NOFIRMLINKPATH     0x00000080
+#endif /* FSOPT_NOFIRMLINKPATH */
+#define FSOPT_FOLLOW_FIRMLINK    0x00000100
+#define FSOPT_RETURN_REALDEV     0x00000200
+#ifndef FSOPT_ISREALFSID  /*a copy is in fsgetpath.h */
+#define FSOPT_ISREALFSID         FSOPT_RETURN_REALDEV
+#endif
+#endif /* PRIVATE */
+

 /* we currently aren't anywhere near this amount for a valid
  * fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
  * but we put a sanity check in to avoid abuse of the value passed in from
 /* we currently aren't anywhere near this amount for a valid
  * fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
  * but we put a sanity check in to avoid abuse of the value passed in from


@@ -70,30 +83,27 @@ typedef u_int32_t fsfile_type_t;
 
 typedef u_int32_t fsvolid_t;
 
 
 typedef u_int32_t fsvolid_t;
 

-typedef struct fsobj_id {
-       u_int32_t               fid_objno;
-       u_int32_t               fid_generation;
-} fsobj_id_t;
+#include <sys/_types/_fsobj_id_t.h> /* file object id type */

 
 typedef u_int32_t attrgroup_t;
 
 struct attrlist {
 
 typedef u_int32_t attrgroup_t;
 
 struct attrlist {

-       u_short bitmapcount;                    /* number of attr. bit sets in list (should be 5) */
-       u_int16_t reserved;                             /* (to maintain 4-byte alignment) */
-       attrgroup_t commonattr;                 /* common attribute group */
-       attrgroup_t volattr;                    /* Volume attribute group */
-       attrgroup_t dirattr;                    /* directory attribute group */
-       attrgroup_t fileattr;                   /* file attribute group */
-       attrgroup_t forkattr;                   /* fork attribute group */
+       u_short bitmapcount;                    /* number of attr. bit sets in list (should be 5) */
+       u_int16_t reserved;                     /* (to maintain 4-byte alignment) */
+       attrgroup_t commonattr;                 /* common attribute group */
+       attrgroup_t volattr;                    /* Volume attribute group */
+       attrgroup_t dirattr;                    /* directory attribute group */
+       attrgroup_t fileattr;                   /* file attribute group */
+       attrgroup_t forkattr;                   /* fork attribute group */

 };
 #define ATTR_BIT_MAP_COUNT 5
 
 typedef struct attribute_set {
 };
 #define ATTR_BIT_MAP_COUNT 5
 
 typedef struct attribute_set {

-       attrgroup_t commonattr;                 /* common attribute group */
-       attrgroup_t volattr;                    /* Volume attribute group */
-       attrgroup_t dirattr;                    /* directory attribute group */
-       attrgroup_t fileattr;                   /* file attribute group */
-       attrgroup_t forkattr;                   /* fork attribute group */
+       attrgroup_t commonattr;                 /* common attribute group */
+       attrgroup_t volattr;                    /* Volume attribute group */
+       attrgroup_t dirattr;                    /* directory attribute group */
+       attrgroup_t fileattr;                   /* file attribute group */
+       attrgroup_t forkattr;                   /* fork attribute group */

 } attribute_set_t;
 
 typedef struct attrreference {
 } attribute_set_t;
 
 typedef struct attrreference {


@@ -104,8 +114,8 @@ typedef struct attrreference {
 /* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */
 
 struct diskextent {
 /* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */
 
 struct diskextent {

-       u_int32_t                                       startblock;                             /* first block allocated */
-       u_int32_t                                       blockcount;                             /* number of blocks allocated */
+       u_int32_t                                       startblock;                             /* first block allocated */
+       u_int32_t                                       blockcount;                             /* number of blocks allocated */

 };
 
 typedef struct diskextent extentrecord[8];
 };
 
 typedef struct diskextent extentrecord[8];


@@ -125,7 +135,7 @@ typedef struct vol_capabilities_attr {
 /*
  * XXX this value needs to be raised - 3893388
  */
 /*
  * XXX this value needs to be raised - 3893388
  */

-#define ATTR_MAX_BUFFER                8192
+#define ATTR_MAX_BUFFER         8192

 
 /*
  * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs
 
 /*
  * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs


@@ -183,8 +193,8 @@ typedef struct vol_capabilities_attr {
  * need not be cached by those upper layers.  A volume that caches
  * the statfs information in its in-memory structures should set this bit.
  * A volume that must always read from disk or always perform a network
  * need not be cached by those upper layers.  A volume that caches
  * the statfs information in its in-memory structures should set this bit.
  * A volume that must always read from disk or always perform a network

- * transaction should not set this bit.  
- * 
+ * transaction should not set this bit.
+ *

  * VOL_CAP_FMT_2TB_FILESIZE: If this bit is set the volume format supports
  * file sizes larger than 4GB, and potentially up to 2TB; it does not
  * indicate whether the filesystem supports files larger than that.
  * VOL_CAP_FMT_2TB_FILESIZE: If this bit is set the volume format supports
  * file sizes larger than 4GB, and potentially up to 2TB; it does not
  * indicate whether the filesystem supports files larger than that.


@@ -204,12 +214,12 @@ typedef struct vol_capabilities_attr {
  * system are persistent and not recycled.  This is a very specialized
  * capability and it is assumed that most file systems will not support
  * it.  Its use is for legacy non-posix APIs like ResolveFileIDRef.
  * system are persistent and not recycled.  This is a very specialized
  * capability and it is assumed that most file systems will not support
  * it.  Its use is for legacy non-posix APIs like ResolveFileIDRef.

- * 
- * VOL_CAP_FMT_NO_VOLUME_SIZES: When set, the volume does not support 
+ *
+ * VOL_CAP_FMT_NO_VOLUME_SIZES: When set, the volume does not support

  * returning values for total data blocks, available blocks, or free blocks
  * (as in f_blocks, f_bavail, or f_bfree in "struct statfs").  Historically,
  * those values were set to 0xFFFFFFFF for volumes that did not support them.
  * returning values for total data blocks, available blocks, or free blocks
  * (as in f_blocks, f_bavail, or f_bfree in "struct statfs").  Historically,
  * those values were set to 0xFFFFFFFF for volumes that did not support them.

- * 
+ *

  * VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent
  * decompression of compressed files using decmpfs.
  *
  * VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent
  * decompression of compressed files using decmpfs.
  *


@@ -218,26 +228,57 @@ typedef struct vol_capabilities_attr {
  * only legitimate attributes for obtaining object IDs from this volume and the
  * 32-bit fid_objno fields of the fsobj_id_t returned by ATTR_CMN_OBJID,
  * ATTR_CMN_OBJPERMID, and ATTR_CMN_PAROBJID are undefined.
  * only legitimate attributes for obtaining object IDs from this volume and the
  * 32-bit fid_objno fields of the fsobj_id_t returned by ATTR_CMN_OBJID,
  * ATTR_CMN_OBJPERMID, and ATTR_CMN_PAROBJID are undefined.

+ *
+ * VOL_CAP_FMT_DIR_HARDLINKS: When set, the volume supports directory
+ * hard links.
+ *
+ * VOL_CAP_FMT_DOCUMENT_ID: When set, the volume supports document IDs
+ * (an ID which persists across object ID changes) for document revisions.
+ *
+ * VOL_CAP_FMT_WRITE_GENERATION_COUNT: When set, the volume supports write
+ * generation counts (a count of how many times an object has been modified)
+ *
+ * VOL_CAP_FMT_NO_IMMUTABLE_FILES: When set, the volume does not support
+ * setting the UF_IMMUTABLE flag.
+ *
+ * VOL_CAP_FMT_NO_PERMISSIONS: When set, the volume does not support setting
+ * permissions.
+ *
+ * VOL_CAP_FMT_SHARED_SPACE: When set, the volume supports sharing space with
+ * other filesystems i.e. multiple logical filesystems can exist in the same
+ * "partition". An implication of this is that the filesystem which sets
+ * this capability treats waitfor arguments to VFS_SYNC as bit flags.
+ *
+ * VOL_CAP_FMT_VOL_GROUPS: When set, this volume is part of a volume-group
+ * that implies multiple volumes must be mounted in order to boot and root the
+ * operating system. Typically, this means a read-only system volume and a
+ * writable data volume.

  */
  */

-#define VOL_CAP_FMT_PERSISTENTOBJECTIDS                0x00000001
-#define VOL_CAP_FMT_SYMBOLICLINKS              0x00000002
-#define VOL_CAP_FMT_HARDLINKS                  0x00000004
-#define VOL_CAP_FMT_JOURNAL                    0x00000008
-#define VOL_CAP_FMT_JOURNAL_ACTIVE             0x00000010
-#define VOL_CAP_FMT_NO_ROOT_TIMES              0x00000020
-#define VOL_CAP_FMT_SPARSE_FILES               0x00000040
-#define VOL_CAP_FMT_ZERO_RUNS                  0x00000080
-#define VOL_CAP_FMT_CASE_SENSITIVE             0x00000100
-#define VOL_CAP_FMT_CASE_PRESERVING            0x00000200
-#define VOL_CAP_FMT_FAST_STATFS                0x00000400
-#define VOL_CAP_FMT_2TB_FILESIZE               0x00000800
-#define VOL_CAP_FMT_OPENDENYMODES              0x00001000
-#define VOL_CAP_FMT_HIDDEN_FILES               0x00002000
-#define VOL_CAP_FMT_PATH_FROM_ID               0x00004000
-#define VOL_CAP_FMT_NO_VOLUME_SIZES            0x00008000
-#define VOL_CAP_FMT_DECMPFS_COMPRESSION                0x00010000
-#define VOL_CAP_FMT_64BIT_OBJECT_IDS           0x00020000
-
+#define VOL_CAP_FMT_PERSISTENTOBJECTIDS         0x00000001
+#define VOL_CAP_FMT_SYMBOLICLINKS               0x00000002
+#define VOL_CAP_FMT_HARDLINKS                   0x00000004
+#define VOL_CAP_FMT_JOURNAL                     0x00000008
+#define VOL_CAP_FMT_JOURNAL_ACTIVE              0x00000010
+#define VOL_CAP_FMT_NO_ROOT_TIMES               0x00000020
+#define VOL_CAP_FMT_SPARSE_FILES                0x00000040
+#define VOL_CAP_FMT_ZERO_RUNS                   0x00000080
+#define VOL_CAP_FMT_CASE_SENSITIVE              0x00000100
+#define VOL_CAP_FMT_CASE_PRESERVING             0x00000200
+#define VOL_CAP_FMT_FAST_STATFS                 0x00000400
+#define VOL_CAP_FMT_2TB_FILESIZE                0x00000800
+#define VOL_CAP_FMT_OPENDENYMODES               0x00001000
+#define VOL_CAP_FMT_HIDDEN_FILES                0x00002000
+#define VOL_CAP_FMT_PATH_FROM_ID                0x00004000
+#define VOL_CAP_FMT_NO_VOLUME_SIZES             0x00008000
+#define VOL_CAP_FMT_DECMPFS_COMPRESSION         0x00010000
+#define VOL_CAP_FMT_64BIT_OBJECT_IDS            0x00020000
+#define VOL_CAP_FMT_DIR_HARDLINKS               0x00040000
+#define VOL_CAP_FMT_DOCUMENT_ID                 0x00080000
+#define VOL_CAP_FMT_WRITE_GENERATION_COUNT      0x00100000
+#define VOL_CAP_FMT_NO_IMMUTABLE_FILES          0x00200000
+#define VOL_CAP_FMT_NO_PERMISSIONS              0x00400000
+#define VOL_CAP_FMT_SHARED_SPACE                0x00800000
+#define VOL_CAP_FMT_VOL_GROUPS                  0x01000000

 
 /*
  * VOL_CAP_INT_SEARCHFS: When set, the volume implements the
 
 /*
  * VOL_CAP_INT_SEARCHFS: When set, the volume implements the


@@ -295,164 +336,250 @@ typedef struct vol_capabilities_attr {
  *
  * VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports
  * native named streams.
  *
  * VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports
  * native named streams.

+ *
+ * VOL_CAP_INT_CLONE: When set, the volume supports clones.
+ *
+ * VOL_CAP_INT_SNAPSHOT: When set, the volume supports snapshots.
+ *
+ * VOL_CAP_INT_RENAME_SWAP: When set, the volume supports swapping
+ * file system objects.
+ *
+ * VOL_CAP_INT_RENAME_EXCL: When set, the volume supports an
+ * exclusive rename operation.
+ *
+ * VOL_CAP_INT_RENAME_OPENFAIL: When set, the volume may fail rename
+ * operations on files that are open.

  */
  */

-#define VOL_CAP_INT_SEARCHFS                   0x00000001
-#define VOL_CAP_INT_ATTRLIST                   0x00000002
-#define VOL_CAP_INT_NFSEXPORT                  0x00000004
-#define VOL_CAP_INT_READDIRATTR                        0x00000008
-#define VOL_CAP_INT_EXCHANGEDATA               0x00000010
-#define VOL_CAP_INT_COPYFILE                   0x00000020
-#define VOL_CAP_INT_ALLOCATE                   0x00000040
-#define VOL_CAP_INT_VOL_RENAME                 0x00000080
-#define VOL_CAP_INT_ADVLOCK                    0x00000100
-#define VOL_CAP_INT_FLOCK                      0x00000200
-#define VOL_CAP_INT_EXTENDED_SECURITY          0x00000400
-#define VOL_CAP_INT_USERACCESS                 0x00000800
-#define VOL_CAP_INT_MANLOCK                    0x00001000
-#define VOL_CAP_INT_NAMEDSTREAMS               0x00002000
-#define VOL_CAP_INT_EXTENDED_ATTR              0x00004000
+#define VOL_CAP_INT_SEARCHFS                    0x00000001
+#define VOL_CAP_INT_ATTRLIST                    0x00000002
+#define VOL_CAP_INT_NFSEXPORT                   0x00000004
+#define VOL_CAP_INT_READDIRATTR                 0x00000008
+#define VOL_CAP_INT_EXCHANGEDATA                0x00000010
+#define VOL_CAP_INT_COPYFILE                    0x00000020
+#define VOL_CAP_INT_ALLOCATE                    0x00000040
+#define VOL_CAP_INT_VOL_RENAME                  0x00000080
+#define VOL_CAP_INT_ADVLOCK                     0x00000100
+#define VOL_CAP_INT_FLOCK                       0x00000200
+#define VOL_CAP_INT_EXTENDED_SECURITY           0x00000400
+#define VOL_CAP_INT_USERACCESS                  0x00000800
+#define VOL_CAP_INT_MANLOCK                     0x00001000
+#define VOL_CAP_INT_NAMEDSTREAMS                0x00002000
+#define VOL_CAP_INT_EXTENDED_ATTR               0x00004000

 #ifdef PRIVATE
 /* Volume supports kqueue notifications for remote events */
 #ifdef PRIVATE
 /* Volume supports kqueue notifications for remote events */

-#define VOL_CAP_INT_REMOTE_EVENT               0x00008000
+#define VOL_CAP_INT_REMOTE_EVENT                0x00008000

 #endif /* PRIVATE */
 #endif /* PRIVATE */

+#define VOL_CAP_INT_CLONE                       0x00010000
+#define VOL_CAP_INT_SNAPSHOT                    0x00020000
+#define VOL_CAP_INT_RENAME_SWAP                 0x00040000
+#define VOL_CAP_INT_RENAME_EXCL                 0x00080000
+#define VOL_CAP_INT_RENAME_OPENFAIL             0x00100000

 
 typedef struct vol_attributes_attr {
        attribute_set_t validattr;
        attribute_set_t nativeattr;
 } vol_attributes_attr_t;
 
 
 typedef struct vol_attributes_attr {
        attribute_set_t validattr;
        attribute_set_t nativeattr;
 } vol_attributes_attr_t;
 

-#define ATTR_CMN_NAME                          0x00000001
-#define ATTR_CMN_DEVID                         0x00000002
-#define ATTR_CMN_FSID                          0x00000004
-#define ATTR_CMN_OBJTYPE                       0x00000008
-#define ATTR_CMN_OBJTAG                                0x00000010
-#define ATTR_CMN_OBJID                         0x00000020
-#define ATTR_CMN_OBJPERMANENTID                        0x00000040
-#define ATTR_CMN_PAROBJID                      0x00000080
-#define ATTR_CMN_SCRIPT                                0x00000100
-#define ATTR_CMN_CRTIME                                0x00000200
-#define ATTR_CMN_MODTIME                       0x00000400
-#define ATTR_CMN_CHGTIME                       0x00000800
-#define ATTR_CMN_ACCTIME                       0x00001000
-#define ATTR_CMN_BKUPTIME                      0x00002000
-#define ATTR_CMN_FNDRINFO                      0x00004000
-#define ATTR_CMN_OWNERID                       0x00008000
-#define ATTR_CMN_GRPID                         0x00010000
-#define ATTR_CMN_ACCESSMASK                    0x00020000
-#define ATTR_CMN_FLAGS                         0x00040000
-/*  #define ATTR_CMN_NAMEDATTRCOUNT            0x00080000       not implemented */
-/*  #define ATTR_CMN_NAMEDATTRLIST             0x00100000       not implemented */
-#define ATTR_CMN_USERACCESS                    0x00200000
-#define ATTR_CMN_EXTENDED_SECURITY             0x00400000
-#define ATTR_CMN_UUID                          0x00800000
-#define ATTR_CMN_GRPUUID                       0x01000000
-#define ATTR_CMN_FILEID                                0x02000000
-#define ATTR_CMN_PARENTID                      0x04000000
-#define ATTR_CMN_FULLPATH                      0x08000000
-#define ATTR_CMN_ADDEDTIME                     0x10000000
+#define ATTR_CMN_NAME                           0x00000001
+#define ATTR_CMN_DEVID                          0x00000002
+#define ATTR_CMN_FSID                           0x00000004
+#define ATTR_CMN_OBJTYPE                        0x00000008
+#define ATTR_CMN_OBJTAG                         0x00000010
+#define ATTR_CMN_OBJID                          0x00000020
+#define ATTR_CMN_OBJPERMANENTID                 0x00000040
+#define ATTR_CMN_PAROBJID                       0x00000080
+#define ATTR_CMN_SCRIPT                         0x00000100
+#define ATTR_CMN_CRTIME                         0x00000200
+#define ATTR_CMN_MODTIME                        0x00000400
+#define ATTR_CMN_CHGTIME                        0x00000800
+#define ATTR_CMN_ACCTIME                        0x00001000
+#define ATTR_CMN_BKUPTIME                       0x00002000
+#define ATTR_CMN_FNDRINFO                       0x00004000
+#define ATTR_CMN_OWNERID                        0x00008000
+#define ATTR_CMN_GRPID                          0x00010000
+#define ATTR_CMN_ACCESSMASK                     0x00020000
+#define ATTR_CMN_FLAGS                          0x00040000
+
+/* The following were defined as:                              */
+/*      #define ATTR_CMN_NAMEDATTRCOUNT                0x00080000      */
+/*      #define ATTR_CMN_NAMEDATTRLIST         0x00100000      */
+/* These bits have been salvaged for use as:                   */
+/*     #define ATTR_CMN_GEN_COUNT              0x00080000      */
+/*     #define ATTR_CMN_DOCUMENT_ID            0x00100000      */
+/* They can only be used with the  FSOPT_ATTR_CMN_EXTENDED     */
+/* option flag.                                                 */
+
+#define ATTR_CMN_GEN_COUNT                      0x00080000
+#define ATTR_CMN_DOCUMENT_ID                    0x00100000
+
+#define ATTR_CMN_USERACCESS                     0x00200000
+#define ATTR_CMN_EXTENDED_SECURITY              0x00400000
+#define ATTR_CMN_UUID                           0x00800000
+#define ATTR_CMN_GRPUUID                        0x01000000
+#define ATTR_CMN_FILEID                         0x02000000
+#define ATTR_CMN_PARENTID                       0x04000000
+#define ATTR_CMN_FULLPATH                       0x08000000
+#define ATTR_CMN_ADDEDTIME                      0x10000000
+#define ATTR_CMN_ERROR                          0x20000000
+#define ATTR_CMN_DATA_PROTECT_FLAGS             0x40000000

 
 /*
 
 /*

- * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2).
- * It is always the first attribute in the return buffer.
+ * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2) and
+ * getattrlistbulk(2). It is always the first attribute in the return buffer.

  */
  */

-#define ATTR_CMN_RETURNED_ATTRS                        0x80000000
-
-#define ATTR_CMN_VALIDMASK                     0x9FE7FFFF
-#define ATTR_CMN_SETMASK                       0x01C7FF00
-#define ATTR_CMN_VOLSETMASK                    0x00006700
-
-#define ATTR_VOL_FSTYPE                                0x00000001
-#define ATTR_VOL_SIGNATURE                     0x00000002
-#define ATTR_VOL_SIZE                          0x00000004
-#define ATTR_VOL_SPACEFREE                     0x00000008
-#define ATTR_VOL_SPACEAVAIL                    0x00000010
-#define ATTR_VOL_MINALLOCATION                 0x00000020
-#define ATTR_VOL_ALLOCATIONCLUMP               0x00000040
-#define ATTR_VOL_IOBLOCKSIZE                   0x00000080
-#define ATTR_VOL_OBJCOUNT                      0x00000100
-#define ATTR_VOL_FILECOUNT                     0x00000200
-#define ATTR_VOL_DIRCOUNT                      0x00000400
-#define ATTR_VOL_MAXOBJCOUNT                   0x00000800
-#define ATTR_VOL_MOUNTPOINT                    0x00001000
-#define ATTR_VOL_NAME                          0x00002000
-#define ATTR_VOL_MOUNTFLAGS                    0x00004000
-#define ATTR_VOL_MOUNTEDDEVICE                 0x00008000
-#define ATTR_VOL_ENCODINGSUSED                 0x00010000
-#define ATTR_VOL_CAPABILITIES                  0x00020000
-#define ATTR_VOL_UUID                          0x00040000
-#define ATTR_VOL_ATTRIBUTES                    0x40000000
-#define ATTR_VOL_INFO                          0x80000000
-
-#define ATTR_VOL_VALIDMASK                     0xC007FFFF
-#define ATTR_VOL_SETMASK                       0x80002000
+#define ATTR_CMN_RETURNED_ATTRS                 0x80000000
+
+#define ATTR_CMN_VALIDMASK                      0xFFFFFFFF
+/*
+ * The settable ATTR_CMN_* attributes include the following:
+ * ATTR_CMN_SCRIPT
+ * ATTR_CMN_CRTIME
+ * ATTR_CMN_MODTIME
+ * ATTR_CMN_CHGTIME
+ *
+ * ATTR_CMN_ACCTIME
+ * ATTR_CMN_BKUPTIME
+ * ATTR_CMN_FNDRINFO
+ * ATTR_CMN_OWNERID
+ *
+ * ATTR_CMN_GRPID
+ * ATTR_CMN_ACCESSMASK
+ * ATTR_CMN_FLAGS
+ *
+ * ATTR_CMN_EXTENDED_SECURITY
+ * ATTR_CMN_UUID
+ *
+ * ATTR_CMN_GRPUUID
+ *
+ * ATTR_CMN_DATA_PROTECT_FLAGS
+ */
+#define ATTR_CMN_SETMASK                        0x51C7FF00
+#define ATTR_CMN_VOLSETMASK                     0x00006700
+
+#define ATTR_VOL_FSTYPE                         0x00000001
+#define ATTR_VOL_SIGNATURE                      0x00000002
+#define ATTR_VOL_SIZE                           0x00000004
+#define ATTR_VOL_SPACEFREE                      0x00000008
+#define ATTR_VOL_SPACEAVAIL                     0x00000010
+#define ATTR_VOL_MINALLOCATION                  0x00000020
+#define ATTR_VOL_ALLOCATIONCLUMP                0x00000040
+#define ATTR_VOL_IOBLOCKSIZE                    0x00000080
+#define ATTR_VOL_OBJCOUNT                       0x00000100
+#define ATTR_VOL_FILECOUNT                      0x00000200
+#define ATTR_VOL_DIRCOUNT                       0x00000400
+#define ATTR_VOL_MAXOBJCOUNT                    0x00000800
+#define ATTR_VOL_MOUNTPOINT                     0x00001000
+#define ATTR_VOL_NAME                           0x00002000
+#define ATTR_VOL_MOUNTFLAGS                     0x00004000
+#define ATTR_VOL_MOUNTEDDEVICE                  0x00008000
+#define ATTR_VOL_ENCODINGSUSED                  0x00010000
+#define ATTR_VOL_CAPABILITIES                   0x00020000
+#define ATTR_VOL_UUID                           0x00040000
+#define ATTR_VOL_QUOTA_SIZE                     0x10000000
+#define ATTR_VOL_RESERVED_SIZE          0x20000000
+#define ATTR_VOL_ATTRIBUTES                     0x40000000
+#define ATTR_VOL_INFO                           0x80000000
+
+#define ATTR_VOL_VALIDMASK                      0xF007FFFF
+
+/*
+ * The list of settable ATTR_VOL_* attributes include the following:
+ * ATTR_VOL_NAME
+ * ATTR_VOL_INFO
+ */
+#define ATTR_VOL_SETMASK                        0x80002000

 
 
 /* File/directory attributes: */
 
 
 /* File/directory attributes: */

-#define ATTR_DIR_LINKCOUNT                     0x00000001
-#define ATTR_DIR_ENTRYCOUNT                    0x00000002
-#define ATTR_DIR_MOUNTSTATUS                   0x00000004
-/* ATTR_DIR_MOUNTSTATUS Flags: */
-#define          DIR_MNTSTATUS_MNTPOINT                0x00000001
-#define          DIR_MNTSTATUS_TRIGGER                 0x00000002
+#define ATTR_DIR_LINKCOUNT                      0x00000001
+#define ATTR_DIR_ENTRYCOUNT                     0x00000002
+#define ATTR_DIR_MOUNTSTATUS                    0x00000004
+#define ATTR_DIR_ALLOCSIZE                      0x00000008
+#define ATTR_DIR_IOBLOCKSIZE                    0x00000010
+#define ATTR_DIR_DATALENGTH                     0x00000020

 
 

-#define ATTR_DIR_VALIDMASK                     0x00000007
-#define ATTR_DIR_SETMASK                       0x00000000
+/* ATTR_DIR_MOUNTSTATUS Flags: */
+#define   DIR_MNTSTATUS_MNTPOINT                0x00000001
+#define   DIR_MNTSTATUS_TRIGGER                 0x00000002
+
+#define ATTR_DIR_VALIDMASK                      0x0000003f
+#define ATTR_DIR_SETMASK                        0x00000000
+
+#define ATTR_FILE_LINKCOUNT                     0x00000001
+#define ATTR_FILE_TOTALSIZE                     0x00000002
+#define ATTR_FILE_ALLOCSIZE                     0x00000004
+#define ATTR_FILE_IOBLOCKSIZE                   0x00000008
+#define ATTR_FILE_DEVTYPE                       0x00000020
+#define ATTR_FILE_FORKCOUNT                     0x00000080
+#define ATTR_FILE_FORKLIST                      0x00000100
+#define ATTR_FILE_DATALENGTH                    0x00000200
+#define ATTR_FILE_DATAALLOCSIZE                 0x00000400
+#define ATTR_FILE_RSRCLENGTH                    0x00001000
+#define ATTR_FILE_RSRCALLOCSIZE                 0x00002000
+
+#define ATTR_FILE_VALIDMASK                     0x000037FF
+/*
+ * Settable ATTR_FILE_* attributes include:
+ * ATTR_FILE_DEVTYPE
+ */
+#define ATTR_FILE_SETMASK                       0x00000020

 
 

-#define ATTR_FILE_LINKCOUNT                    0x00000001
-#define ATTR_FILE_TOTALSIZE                    0x00000002
-#define ATTR_FILE_ALLOCSIZE                    0x00000004
-#define ATTR_FILE_IOBLOCKSIZE                  0x00000008
-#define ATTR_FILE_DEVTYPE                      0x00000020
-#define ATTR_FILE_FORKCOUNT                    0x00000080
-#define ATTR_FILE_FORKLIST                     0x00000100
-#define ATTR_FILE_DATALENGTH                   0x00000200
-#define ATTR_FILE_DATAALLOCSIZE                        0x00000400
-#define ATTR_FILE_RSRCLENGTH                   0x00001000
-#define ATTR_FILE_RSRCALLOCSIZE                        0x00002000
+/* CMNEXT attributes extend the common attributes, but in the forkattr field */
+#define ATTR_CMNEXT_RELPATH     0x00000004
+#define ATTR_CMNEXT_PRIVATESIZE 0x00000008
+#define ATTR_CMNEXT_LINKID      0x00000010
+#define ATTR_CMNEXT_NOFIRMLINKPATH     0x00000020
+#define ATTR_CMNEXT_REALDEVID   0x00000040
+#define ATTR_CMNEXT_REALFSID    0x00000080

 
 

-#define ATTR_FILE_VALIDMASK                    0x000037FF
-#define ATTR_FILE_SETMASK                      0x00000020
+#define ATTR_CMNEXT_VALIDMASK   0x000000fc
+#define ATTR_CMNEXT_SETMASK             0x00000000

 
 

-#define ATTR_FORK_TOTALSIZE                    0x00000001
-#define ATTR_FORK_ALLOCSIZE                    0x00000002
+/* Deprecated fork attributes */
+#define ATTR_FORK_TOTALSIZE                     0x00000001
+#define ATTR_FORK_ALLOCSIZE                     0x00000002
+#define ATTR_FORK_RESERVED                      0xffffffff

 
 

-#define ATTR_FORK_VALIDMASK                    0x00000003
-#define ATTR_FORK_SETMASK                      0x00000000
+#define ATTR_FORK_VALIDMASK                     0x00000003
+#define ATTR_FORK_SETMASK                       0x00000000

 
 /* Obsolete, implemented, not supported */
 
 /* Obsolete, implemented, not supported */

-#define ATTR_CMN_NAMEDATTRCOUNT                        0x00080000      /* not implemented */
-#define ATTR_CMN_NAMEDATTRLIST                 0x00100000      /* not implemented */
-#define ATTR_FILE_CLUMPSIZE                    0x00000010      /* obsolete */
-#define ATTR_FILE_FILETYPE                     0x00000040      /* always zero */
-#define ATTR_FILE_DATAEXTENTS                  0x00000800      /* obsolete, HFS-specific */
-#define ATTR_FILE_RSRCEXTENTS                  0x00004000      /* obsolete, HFS-specific */
+#define ATTR_CMN_NAMEDATTRCOUNT                 0x00080000
+#define ATTR_CMN_NAMEDATTRLIST                  0x00100000
+#define ATTR_FILE_CLUMPSIZE                     0x00000010      /* obsolete */
+#define ATTR_FILE_FILETYPE                      0x00000040      /* always zero */
+#define ATTR_FILE_DATAEXTENTS                   0x00000800      /* obsolete, HFS-specific */
+#define ATTR_FILE_RSRCEXTENTS                   0x00004000      /* obsolete, HFS-specific */
+
+/* Required attributes for getattrlistbulk(2) */
+#define ATTR_BULK_REQUIRED (ATTR_CMN_NAME | ATTR_CMN_RETURNED_ATTRS)

 
 /*
  * Searchfs
  */
 
 /*
  * Searchfs
  */

-#define SRCHFS_START                           0x00000001
-#define SRCHFS_MATCHPARTIALNAMES               0x00000002
-#define SRCHFS_MATCHDIRS                       0x00000004
-#define SRCHFS_MATCHFILES                      0x00000008
-#define SRCHFS_SKIPLINKS                       0x00000010
-#define SRCHFS_SKIPINVISIBLE                   0x00000020
-#define SRCHFS_SKIPPACKAGES                    0x00000040
-#define SRCHFS_SKIPINAPPROPRIATE               0x00000080
-
-#define SRCHFS_NEGATEPARAMS                    0x80000000
-#define SRCHFS_VALIDOPTIONSMASK                        0x800000FF
+#define SRCHFS_START                            0x00000001
+#define SRCHFS_MATCHPARTIALNAMES                0x00000002
+#define SRCHFS_MATCHDIRS                        0x00000004
+#define SRCHFS_MATCHFILES                       0x00000008
+#define SRCHFS_SKIPLINKS                        0x00000010
+#define SRCHFS_SKIPINVISIBLE                    0x00000020
+#define SRCHFS_SKIPPACKAGES                     0x00000040
+#define SRCHFS_SKIPINAPPROPRIATE                0x00000080
+
+#define SRCHFS_NEGATEPARAMS                     0x80000000
+#define SRCHFS_VALIDOPTIONSMASK                 0x800000FF

 
 struct fssearchblock {
 
 struct fssearchblock {

-       struct attrlist         *returnattrs;
-       void                            *returnbuffer;
-       size_t                          returnbuffersize;
-       u_long                          maxmatches;
-       struct timeval          timelimit;
-       void                            *searchparams1;
-       size_t                          sizeofsearchparams1;
-       void                            *searchparams2;
-       size_t                          sizeofsearchparams2;
-       struct attrlist         searchattrs;
+       struct attrlist         *returnattrs;
+       void                            *returnbuffer;
+       size_t                          returnbuffersize;
+       u_long                          maxmatches;
+       struct timeval          timelimit;
+       void                            *searchparams1;
+       size_t                          sizeofsearchparams1;
+       void                            *searchparams2;
+       size_t                          sizeofsearchparams2;
+       struct attrlist         searchattrs;

 };
 
 #ifdef KERNEL
 };
 
 #ifdef KERNEL


@@ -466,12 +593,12 @@ struct user64_fssearchblock {
        user64_addr_t         returnbuffer;
        user64_size_t         returnbuffersize;
        user64_ulong_t        maxmatches;
        user64_addr_t         returnbuffer;
        user64_size_t         returnbuffersize;
        user64_ulong_t        maxmatches;

-       struct user64_timeval   timelimit;
+       struct user64_timeval   timelimit;

        user64_addr_t         searchparams1;
        user64_size_t         sizeofsearchparams1;
        user64_addr_t         searchparams2;
        user64_size_t         sizeofsearchparams2;
        user64_addr_t         searchparams1;
        user64_size_t         sizeofsearchparams1;
        user64_addr_t         searchparams2;
        user64_size_t         sizeofsearchparams2;

-       struct attrlist         searchattrs;
+       struct attrlist         searchattrs;

 };
 
 struct user32_fssearchblock {
 };
 
 struct user32_fssearchblock {


@@ -479,23 +606,23 @@ struct user32_fssearchblock {
        user32_addr_t         returnbuffer;
        user32_size_t         returnbuffersize;
        user32_ulong_t        maxmatches;
        user32_addr_t         returnbuffer;
        user32_size_t         returnbuffersize;
        user32_ulong_t        maxmatches;

-       struct user32_timeval   timelimit;
+       struct user32_timeval   timelimit;

        user32_addr_t         searchparams1;
        user32_size_t         sizeofsearchparams1;
        user32_addr_t         searchparams2;
        user32_size_t         sizeofsearchparams2;
        user32_addr_t         searchparams1;
        user32_size_t         sizeofsearchparams1;
        user32_addr_t         searchparams2;
        user32_size_t         sizeofsearchparams2;

-       struct attrlist         searchattrs;
+       struct attrlist         searchattrs;

 };
 
 #endif /* KERNEL */
 
 };
 
 #endif /* KERNEL */
 

-

 struct searchstate {
 struct searchstate {

-       u_char                          reserved[556];          //      sizeof( SearchState )
-};
-
+       uint32_t                        ss_union_flags;         // for SRCHFS_START
+       uint32_t                        ss_union_layer;         // 0 = top
+       u_char                          ss_fsstate[548];        // fs private
+} __attribute__((packed));

 
 

-#define FST_EOF (-1)                           /* end-of-file offset */
+#define FST_EOF (-1)                            /* end-of-file offset */

 
 #endif /* __APPLE_API_UNSTABLE */
 #endif /* !_SYS_ATTR_H_ */
 
 #endif /* __APPLE_API_UNSTABLE */
 #endif /* !_SYS_ATTR_H_ */