/*
- * Copyright (c) 2000-2008 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2016 Apple Computer, Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
/* The following option only valid when requesting ATTR_CMN_RETURNED_ATTRS */
#define FSOPT_PACK_INVAL_ATTRS 0x00000008
+#ifdef PRIVATE
+#define FSOPT_EXCHANGE_DATA_ONLY 0x0000010
+#endif
+
+#define FSOPT_ATTR_CMN_EXTENDED 0x00000020
+#ifdef PRIVATE
+#define FSOPT_LIST_SNAPSHOT 0x00000040
+#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
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 {
u_short bitmapcount; /* number of attr. bit sets in list (should be 5) */
- u_int16_t reserved; /* (to maintain 4-byte alignment) */
+ 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 */
*
* VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent
* decompression of compressed files using decmpfs.
+ *
+ * VOL_CAP_FMT_64BIT_OBJECT_IDS: When set, the volume uses object IDs that
+ * are 64-bit. This means that ATTR_CMN_FILEID and ATTR_CMN_PARENTID are the
+ * 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.
*/
#define VOL_CAP_FMT_PERSISTENTOBJECTIDS 0x00000001
#define VOL_CAP_FMT_SYMBOLICLINKS 0x00000002
#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_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
/*
*
* 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.
+ *
*/
#define VOL_CAP_INT_SEARCHFS 0x00000001
#define VOL_CAP_INT_ATTRLIST 0x00000002
/* Volume supports kqueue notifications for remote events */
#define VOL_CAP_INT_REMOTE_EVENT 0x00008000
#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
typedef struct vol_attributes_attr {
attribute_set_t validattr;
#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 */
+
+/* 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_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_RETURNED_ATTRS 0x80000000
-#define ATTR_CMN_VALIDMASK 0x8FE7FFFF
-#define ATTR_CMN_SETMASK 0x01C7FF00
+#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_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 0xC007FFFF
+#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
#define ATTR_DIR_LINKCOUNT 0x00000001
#define ATTR_DIR_ENTRYCOUNT 0x00000002
#define ATTR_DIR_MOUNTSTATUS 0x00000004
-#define DIR_MNTSTATUS_MNTPOINT 0x00000001
+#define ATTR_DIR_ALLOCSIZE 0x00000008
+#define ATTR_DIR_IOBLOCKSIZE 0x00000010
+#define ATTR_DIR_DATALENGTH 0x00000020
+
+/* ATTR_DIR_MOUNTSTATUS Flags: */
+#define DIR_MNTSTATUS_MNTPOINT 0x00000001
+#define DIR_MNTSTATUS_TRIGGER 0x00000002
-#define ATTR_DIR_VALIDMASK 0x00000007
+#define ATTR_DIR_VALIDMASK 0x0000003f
#define ATTR_DIR_SETMASK 0x00000000
#define ATTR_FILE_LINKCOUNT 0x00000001
#define ATTR_FILE_DATAALLOCSIZE 0x00000400
#define ATTR_FILE_RSRCLENGTH 0x00001000
#define ATTR_FILE_RSRCALLOCSIZE 0x00002000
-/* Only used when CONFIG_PROTECT is ON */
-#define ATTR_FILE_PROTECTION_CLASS 0x00004000
-#define ATTR_FILE_VALIDMASK 0x000077FF
-#define ATTR_FILE_SETMASK 0x00004020
+#define ATTR_FILE_VALIDMASK 0x000037FF
+/*
+ * Settable ATTR_FILE_* attributes include:
+ * ATTR_FILE_DEVTYPE
+ */
+#define ATTR_FILE_SETMASK 0x00000020
+
+/* 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_VALIDMASK 0x0000001c
+#define ATTR_CMNEXT_SETMASK 0x00000000
+/* 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
/* Obsolete, implemented, not supported */
-#define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 /* not implemented */
-#define ATTR_CMN_NAMEDATTRLIST 0x00100000 /* not implemented */
+#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
*/
#endif /* KERNEL */
-
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 */