bsd/sys/attr.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  * attr.h - attribute data structures and interfaces
  26  *
  27  * Copyright (c) 1998, Apple Computer, Inc.  All Rights Reserved.
  28  */
  29
  30 #ifndef _SYS_ATTR_H_
  31 #define _SYS_ATTR_H_
  32
  33 #include <sys/appleapiopts.h>
  34
  35 #ifdef __APPLE_API_UNSTABLE
  36 #include <sys/types.h>
  37 #include <sys/ucred.h>
  38 #include <sys/time.h>
  39 #include <sys/cdefs.h>
  40
  41 #define FSOPT_NOFOLLOW          0x00000001
  42 #define FSOPT_NOINMEMUPDATE     0x00000002
  43 #define FSOPT_REPORT_FULLSIZE   0x00000004
  44
  45 /* we currently aren't anywhere near this amount for a valid
  46  * fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
  47  * but we put a sanity check in to avoid abuse of the value passed in from
  48  * user land.
  49  */
  50 #define SEARCHFS_MAX_SEARCHPARMS  4096
  51
  52 typedef u_int32_t text_encoding_t;
  53
  54 typedef u_int32_t fsobj_type_t;
  55
  56 typedef u_int32_t fsobj_tag_t;
  57
  58 typedef u_int32_t fsfile_type_t;
  59
  60 typedef u_int32_t fsvolid_t;
  61
  62 typedef struct fsobj_id {
  63         u_int32_t               fid_objno;
  64         u_int32_t               fid_generation;
  65 } fsobj_id_t;
  66
  67 typedef u_int32_t attrgroup_t;
  68
  69 struct attrlist {
  70         u_short bitmapcount;                    /* number of attr. bit sets in list (should be 5) */
  71         u_int16_t reserved;                             /* (to maintain 4-byte alignment) */
  72         attrgroup_t commonattr;                 /* common attribute group */
  73         attrgroup_t volattr;                    /* Volume attribute group */
  74         attrgroup_t dirattr;                    /* directory attribute group */
  75         attrgroup_t fileattr;                   /* file attribute group */
  76         attrgroup_t forkattr;                   /* fork attribute group */
  77 };
  78 #define ATTR_BIT_MAP_COUNT 5
  79
  80 typedef struct attribute_set {
  81         attrgroup_t commonattr;                 /* common attribute group */
  82         attrgroup_t volattr;                    /* Volume attribute group */
  83         attrgroup_t dirattr;                    /* directory attribute group */
  84         attrgroup_t fileattr;                   /* file attribute group */
  85         attrgroup_t forkattr;                   /* fork attribute group */
  86 } attribute_set_t;
  87
  88 typedef struct attrreference {
  89         int32_t     attr_dataoffset;
  90         u_int32_t   attr_length;
  91 } attrreference_t;
  92
  93 /* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */
  94
  95 struct diskextent {
  96         u_int32_t                                       startblock;                             /* first block allocated */
  97         u_int32_t                                       blockcount;                             /* number of blocks allocated */
  98 };
  99
 100 typedef struct diskextent extentrecord[8];
 101
 102 typedef u_int32_t vol_capabilities_set_t[4];
 103
 104 #define VOL_CAPABILITIES_FORMAT 0
 105 #define VOL_CAPABILITIES_INTERFACES 1
 106 #define VOL_CAPABILITIES_RESERVED1 2
 107 #define VOL_CAPABILITIES_RESERVED2 3
 108
 109 typedef struct vol_capabilities_attr {
 110         vol_capabilities_set_t capabilities;
 111         vol_capabilities_set_t valid;
 112 } vol_capabilities_attr_t;
 113
 114 /*
 115  * XXX this value needs to be raised - 3893388
 116  */
 117 #define ATTR_MAX_BUFFER         8192
 118
 119 /*
 120  * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs
 121  * that are persistent (retain their values even when the volume is
 122  * unmounted and remounted), and a file or directory can be looked up
 123  * by ID.  Volumes that support VolFS and can support Carbon File ID
 124  * references should set this bit.
 125  *
 126  * VOL_CAP_FMT_SYMBOLICLINKS: When set, the volume supports symbolic
 127  * links.  The symlink(), readlink(), and lstat() calls all use this
 128  * symbolic link.
 129  *
 130  * VOL_CAP_FMT_HARDLINKS: When set, the volume supports hard links.
 131  * The link() call creates hard links.
 132  *
 133  * VOL_CAP_FMT_JOURNAL: When set, the volume is capable of supporting
 134  * a journal used to speed recovery in case of unplanned shutdown
 135  * (such as a power outage or crash).  This bit does not necessarily
 136  * mean the volume is actively using a journal for recovery.
 137  *
 138  * VOL_CAP_FMT_JOURNAL_ACTIVE: When set, the volume is currently using
 139  * a journal for use in speeding recovery after an unplanned shutdown.
 140  * This bit can be set only if VOL_CAP_FMT_JOURNAL is also set.
 141  *
 142  * VOL_CAP_FMT_NO_ROOT_TIMES: When set, the volume format does not
 143  * store reliable times for the root directory, so you should not
 144  * depend on them to detect changes, etc.
 145  *
 146  * VOL_CAP_FMT_SPARSE_FILES: When set, the volume supports sparse files.
 147  * That is, files which can have "holes" that have never been written
 148  * to, and are not allocated on disk.  Sparse files may have an
 149  * allocated size that is less than the file's logical length.
 150  *
 151  * VOL_CAP_FMT_ZERO_RUNS: For security reasons, parts of a file (runs)
 152  * that have never been written to must appear to contain zeroes.  When
 153  * this bit is set, the volume keeps track of allocated but unwritten
 154  * runs of a file so that it can substitute zeroes without actually
 155  * writing zeroes to the media.  This provides performance similar to
 156  * sparse files, but not the space savings.
 157  *
 158  * VOL_CAP_FMT_CASE_SENSITIVE: When set, file and directory names are
 159  * case sensitive (upper and lower case are different).  When clear,
 160  * an upper case character is equivalent to a lower case character,
 161  * and you can't have two names that differ solely in the case of
 162  * the characters.
 163  *
 164  * VOL_CAP_FMT_CASE_PRESERVING: When set, file and directory names
 165  * preserve the difference between upper and lower case.  If clear,
 166  * the volume may change the case of some characters (typically
 167  * making them all upper or all lower case).  A volume that sets
 168  * VOL_CAP_FMT_CASE_SENSITIVE should also set VOL_CAP_FMT_CASE_PRESERVING.
 169  *
 170  * VOL_CAP_FMT_FAST_STATFS: This bit is used as a hint to upper layers
 171  * (especially Carbon) that statfs() is fast enough that its results
 172  * need not be cached by those upper layers.  A volume that caches
 173  * the statfs information in its in-memory structures should set this bit.
 174  * A volume that must always read from disk or always perform a network
 175  * transaction should not set this bit.
 176  *
 177  * VOL_CAP_FMT_2TB_FILESIZE: When set, the volume format supports file
 178  * size upto 2TB.  This bit does not necessarily mean that the file
 179  * system does not support file size more than 2TB.   This bit does
 180  * not mean that the currently available space on the volume is 2TB.
 181  */
 182 #define VOL_CAP_FMT_PERSISTENTOBJECTIDS         0x00000001
 183 #define VOL_CAP_FMT_SYMBOLICLINKS               0x00000002
 184 #define VOL_CAP_FMT_HARDLINKS                   0x00000004
 185 #define VOL_CAP_FMT_JOURNAL                     0x00000008
 186 #define VOL_CAP_FMT_JOURNAL_ACTIVE              0x00000010
 187 #define VOL_CAP_FMT_NO_ROOT_TIMES               0x00000020
 188 #define VOL_CAP_FMT_SPARSE_FILES                0x00000040
 189 #define VOL_CAP_FMT_ZERO_RUNS                   0x00000080
 190 #define VOL_CAP_FMT_CASE_SENSITIVE              0x00000100
 191 #define VOL_CAP_FMT_CASE_PRESERVING             0x00000200
 192 #define VOL_CAP_FMT_FAST_STATFS                 0x00000400
 193 #define VOL_CAP_FMT_2TB_FILESIZE                0x00000800
 194
 195
 196 /*
 197  * VOL_CAP_INT_SEARCHFS: When set, the volume implements the
 198  * searchfs() system call (the vnop_searchfs vnode operation).
 199  *
 200  * VOL_CAP_INT_ATTRLIST: When set, the volume implements the
 201  * getattrlist() and setattrlist() system calls (vnop_getattrlist
 202  * and vnop_setattrlist vnode operations) for the volume, files,
 203  * and directories.  The volume may or may not implement the
 204  * readdirattr() system call.  XXX Is there any minimum set
 205  * of attributes that should be supported?  To determine the
 206  * set of supported attributes, get the ATTR_VOL_ATTRIBUTES
 207  * attribute of the volume.
 208  *
 209  * VOL_CAP_INT_NFSEXPORT: When set, the volume implements exporting
 210  * of NFS volumes.
 211  *
 212  * VOL_CAP_INT_READDIRATTR: When set, the volume implements the
 213  * readdirattr() system call (vnop_readdirattr vnode operation).
 214  *
 215  * VOL_CAP_INT_EXCHANGEDATA: When set, the volume implements the
 216  * exchangedata() system call (VNOP_EXCHANGE vnode operation).
 217  *
 218  * VOL_CAP_INT_COPYFILE: When set, the volume implements the
 219  * VOP_COPYFILE vnode operation.  (XXX There should be a copyfile()
 220  * system call in <unistd.h>.)
 221  *
 222  * VOL_CAP_INT_ALLOCATE: When set, the volume implements the
 223  * VNOP_ALLOCATE vnode operation, which means it implements the
 224  * F_PREALLOCATE selector of fcntl(2).
 225  *
 226  * VOL_CAP_INT_VOL_RENAME: When set, the volume implements the
 227  * ATTR_VOL_NAME attribute for both getattrlist() and setattrlist().
 228  * The volume can be renamed by setting ATTR_VOL_NAME with setattrlist().
 229  *
 230  * VOL_CAP_INT_ADVLOCK: When set, the volume implements POSIX style
 231  * byte range locks via vnop_advlock (accessible from fcntl(2)).
 232  *
 233  * VOL_CAP_INT_FLOCK: When set, the volume implements whole-file flock(2)
 234  * style locks via vnop_advlock.  This includes the O_EXLOCK and O_SHLOCK
 235  * flags of the open(2) call.
 236  *
 237  */
 238 #define VOL_CAP_INT_SEARCHFS                    0x00000001
 239 #define VOL_CAP_INT_ATTRLIST                    0x00000002
 240 #define VOL_CAP_INT_NFSEXPORT                   0x00000004
 241 #define VOL_CAP_INT_READDIRATTR                 0x00000008
 242 #define VOL_CAP_INT_EXCHANGEDATA                0x00000010
 243 #define VOL_CAP_INT_COPYFILE                    0x00000020
 244 #define VOL_CAP_INT_ALLOCATE                    0x00000040
 245 #define VOL_CAP_INT_VOL_RENAME                  0x00000080
 246 #define VOL_CAP_INT_ADVLOCK                     0x00000100
 247 #define VOL_CAP_INT_FLOCK                       0x00000200
 248 #define VOL_CAP_INT_EXTENDED_SECURITY           0x00000400
 249 #define VOL_CAP_INT_USERACCESS                  0x00000800
 250
 251 typedef struct vol_attributes_attr {
 252         attribute_set_t validattr;
 253         attribute_set_t nativeattr;
 254 } vol_attributes_attr_t;
 255
 256 #define ATTR_CMN_NAME                           0x00000001
 257 #define ATTR_CMN_DEVID                          0x00000002
 258 #define ATTR_CMN_FSID                           0x00000004
 259 #define ATTR_CMN_OBJTYPE                        0x00000008
 260 #define ATTR_CMN_OBJTAG                         0x00000010
 261 #define ATTR_CMN_OBJID                          0x00000020
 262 #define ATTR_CMN_OBJPERMANENTID                 0x00000040
 263 #define ATTR_CMN_PAROBJID                       0x00000080
 264 #define ATTR_CMN_SCRIPT                         0x00000100
 265 #define ATTR_CMN_CRTIME                         0x00000200
 266 #define ATTR_CMN_MODTIME                        0x00000400
 267 #define ATTR_CMN_CHGTIME                        0x00000800
 268 #define ATTR_CMN_ACCTIME                        0x00001000
 269 #define ATTR_CMN_BKUPTIME                       0x00002000
 270 #define ATTR_CMN_FNDRINFO                       0x00004000
 271 #define ATTR_CMN_OWNERID                        0x00008000
 272 #define ATTR_CMN_GRPID                          0x00010000
 273 #define ATTR_CMN_ACCESSMASK                     0x00020000
 274 #define ATTR_CMN_FLAGS                          0x00040000
 275 #define ATTR_CMN_USERACCESS                     0x00200000
 276 #define ATTR_CMN_EXTENDED_SECURITY              0x00400000
 277 #define ATTR_CMN_UUID                           0x00800000
 278 #define ATTR_CMN_GRPUUID                        0x01000000
 279
 280 #define ATTR_CMN_VALIDMASK                      0x003FFFFF
 281 #define ATTR_CMN_SETMASK                        0x01C7FF00
 282 #define ATTR_CMN_VOLSETMASK                     0x00006700
 283
 284 #define ATTR_VOL_FSTYPE                         0x00000001
 285 #define ATTR_VOL_SIGNATURE                      0x00000002
 286 #define ATTR_VOL_SIZE                           0x00000004
 287 #define ATTR_VOL_SPACEFREE                      0x00000008
 288 #define ATTR_VOL_SPACEAVAIL                     0x00000010
 289 #define ATTR_VOL_MINALLOCATION                  0x00000020
 290 #define ATTR_VOL_ALLOCATIONCLUMP                0x00000040
 291 #define ATTR_VOL_IOBLOCKSIZE                    0x00000080
 292 #define ATTR_VOL_OBJCOUNT                       0x00000100
 293 #define ATTR_VOL_FILECOUNT                      0x00000200
 294 #define ATTR_VOL_DIRCOUNT                       0x00000400
 295 #define ATTR_VOL_MAXOBJCOUNT                    0x00000800
 296 #define ATTR_VOL_MOUNTPOINT                     0x00001000
 297 #define ATTR_VOL_NAME                           0x00002000
 298 #define ATTR_VOL_MOUNTFLAGS                     0x00004000
 299 #define ATTR_VOL_MOUNTEDDEVICE                  0x00008000
 300 #define ATTR_VOL_ENCODINGSUSED                  0x00010000
 301 #define ATTR_VOL_CAPABILITIES                   0x00020000
 302 #define ATTR_VOL_ATTRIBUTES                     0x40000000
 303 #define ATTR_VOL_INFO                           0x80000000
 304
 305 #define ATTR_VOL_VALIDMASK                      0xC003FFFF
 306 #define ATTR_VOL_SETMASK                        0x80002000
 307
 308
 309 /* File/directory attributes: */
 310 #define ATTR_DIR_LINKCOUNT                      0x00000001
 311 #define ATTR_DIR_ENTRYCOUNT                     0x00000002
 312 #define ATTR_DIR_MOUNTSTATUS                    0x00000004
 313 #define DIR_MNTSTATUS_MNTPOINT          0x00000001
 314
 315 #define ATTR_DIR_VALIDMASK                      0x00000007
 316 #define ATTR_DIR_SETMASK                        0x00000000
 317
 318 #define ATTR_FILE_LINKCOUNT                     0x00000001
 319 #define ATTR_FILE_TOTALSIZE                     0x00000002
 320 #define ATTR_FILE_ALLOCSIZE                     0x00000004
 321 #define ATTR_FILE_IOBLOCKSIZE                   0x00000008
 322 #define ATTR_FILE_DEVTYPE                       0x00000020
 323 #define ATTR_FILE_FORKCOUNT                     0x00000080
 324 #define ATTR_FILE_FORKLIST                      0x00000100
 325 #define ATTR_FILE_DATALENGTH                    0x00000200
 326 #define ATTR_FILE_DATAALLOCSIZE                 0x00000400
 327 #define ATTR_FILE_RSRCLENGTH                    0x00001000
 328 #define ATTR_FILE_RSRCALLOCSIZE                 0x00002000
 329
 330 #define ATTR_FILE_VALIDMASK                     0x00007FFF
 331 #define ATTR_FILE_SETMASK                       0x00000020
 332
 333 #define ATTR_FORK_TOTALSIZE                     0x00000001
 334 #define ATTR_FORK_ALLOCSIZE                     0x00000002
 335
 336 #define ATTR_FORK_VALIDMASK                     0x00000003
 337 #define ATTR_FORK_SETMASK                       0x00000000
 338
 339 /* Obsolete, implemented, not supported */
 340 #define ATTR_CMN_NAMEDATTRCOUNT                 0x00080000      /* not implemented */
 341 #define ATTR_CMN_NAMEDATTRLIST                  0x00100000      /* not implemented */
 342 #define ATTR_FILE_CLUMPSIZE                     0x00000010      /* obsolete */
 343 #define ATTR_FILE_FILETYPE                      0x00000040      /* always zero */
 344 #define ATTR_FILE_DATAEXTENTS                   0x00000800      /* obsolete, HFS-specific */
 345 #define ATTR_FILE_RSRCEXTENTS                   0x00004000      /* obsolete, HFS-specific */
 346
 347 /*
 348  * Searchfs
 349  */
 350 #define SRCHFS_START                            0x00000001
 351 #define SRCHFS_MATCHPARTIALNAMES                0x00000002
 352 #define SRCHFS_MATCHDIRS                        0x00000004
 353 #define SRCHFS_MATCHFILES                       0x00000008
 354 #define SRCHFS_SKIPLINKS                        0x00000010
 355 #define SRCHFS_SKIPINVISIBLE                    0x00000020
 356 #define SRCHFS_SKIPPACKAGES                     0x00000040
 357 #define SRCHFS_SKIPINAPPROPRIATE                0x00000080
 358
 359 #define SRCHFS_NEGATEPARAMS                     0x80000000
 360 #define SRCHFS_VALIDOPTIONSMASK                 0x800000FF
 361
 362 struct fssearchblock {
 363         struct attrlist         *returnattrs;
 364         void                            *returnbuffer;
 365         size_t                          returnbuffersize;
 366         u_long                          maxmatches;
 367         struct timeval          timelimit;
 368         void                            *searchparams1;
 369         size_t                          sizeofsearchparams1;
 370         void                            *searchparams2;
 371         size_t                          sizeofsearchparams2;
 372         struct attrlist         searchattrs;
 373 };
 374
 375 #ifdef KERNEL
 376 /* LP64 version of fssearchblock.  all pointers and longs
 377  * grow when we're dealing with a 64-bit process.
 378  * WARNING - keep in sync with fssearchblock
 379  */
 380 // LP64todo - should this move?
 381
 382 #if __DARWIN_ALIGN_NATURAL
 383 #pragma options align=natural
 384 #endif
 385
 386 struct user_fssearchblock {
 387         user_addr_t         returnattrs;
 388         user_addr_t         returnbuffer;
 389         user_size_t         returnbuffersize;
 390         user_ulong_t        maxmatches;
 391         struct timeval          timelimit;
 392         user_addr_t         searchparams1;
 393         user_size_t         sizeofsearchparams1;
 394         user_addr_t         searchparams2;
 395         user_size_t         sizeofsearchparams2;
 396         struct attrlist         searchattrs;
 397 };
 398
 399 #if __DARWIN_ALIGN_NATURAL
 400 #pragma options align=reset
 401 #endif
 402
 403
 404 #endif // KERNEL
 405
 406
 407 struct searchstate {
 408         u_char                          reserved[556];          //      sizeof( SearchState )
 409 };
 410
 411
 412 #define FST_EOF (-1)                            /* end-of-file offset */
 413
 414 #endif /* __APPLE_API_UNSTABLE */
 415 #endif /* !_SYS_ATTR_H_ */