sys/sys/stat.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)stat.h      8.12 (Berkeley) 6/16/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _SYS_STAT_H_
  39 #define _SYS_STAT_H_
  40
  41 #include <sys/cdefs.h>
  42 #include <sys/_timespec.h>
  43 #include <sys/_types.h>
  44
  45 #ifndef _BLKSIZE_T_DECLARED
  46 typedef __blksize_t     blksize_t;
  47 #define _BLKSIZE_T_DECLARED
  48 #endif
  49
  50 #ifndef _BLKCNT_T_DECLARED
  51 typedef __blkcnt_t      blkcnt_t;
  52 #define _BLKCNT_T_DECLARED
  53 #endif
  54
  55 #ifndef _DEV_T_DECLARED
  56 typedef __dev_t         dev_t;
  57 #define _DEV_T_DECLARED
  58 #endif
  59
  60 #ifndef _FFLAGS_T_DECLARED
  61 typedef __fflags_t      fflags_t;
  62 #define _FFLAGS_T_DECLARED
  63 #endif
  64
  65 #ifndef _GID_T_DECLARED
  66 typedef __gid_t         gid_t;
  67 #define _GID_T_DECLARED
  68 #endif
  69
  70 #ifndef _INO_T_DECLARED
  71 typedef __ino_t         ino_t;
  72 #define _INO_T_DECLARED
  73 #endif
  74
  75 #ifndef _MODE_T_DECLARED
  76 typedef __mode_t        mode_t;
  77 #define _MODE_T_DECLARED
  78 #endif
  79
  80 #ifndef _NLINK_T_DECLARED
  81 typedef __nlink_t       nlink_t;
  82 #define _NLINK_T_DECLARED
  83 #endif
  84
  85 #ifndef _OFF_T_DECLARED
  86 typedef __off_t         off_t;
  87 #define _OFF_T_DECLARED
  88 #endif
  89
  90 #ifndef _UID_T_DECLARED
  91 typedef __uid_t         uid_t;
  92 #define _UID_T_DECLARED
  93 #endif
  94
  95 #if !defined(_KERNEL) && __BSD_VISIBLE
  96 /*
  97  * XXX We get miscellaneous namespace pollution with this.
  98  */
  99 #include <sys/time.h>
 100 #endif
 101
 102 #ifdef _KERNEL
 103 struct ostat {
 104         __uint16_t st_dev;              /* inode's device */
 105         __uint32_t st_ino;              /* inode's number */
 106         mode_t    st_mode;              /* inode protection mode */
 107         __uint16_t st_nlink;            /* number of hard links */
 108         __uint16_t st_uid;              /* user ID of the file's owner */
 109         __uint16_t st_gid;              /* group ID of the file's group */
 110         __uint16_t st_rdev;             /* device type */
 111         __int32_t st_size;              /* file size, in bytes */
 112         struct  timespec st_atim;       /* time of last access */
 113         struct  timespec st_mtim;       /* time of last data modification */
 114         struct  timespec st_ctim;       /* time of last file status change */
 115         __int32_t st_blksize;           /* optimal blocksize for I/O */
 116         __int32_t st_blocks;            /* blocks allocated for file */
 117         fflags_t  st_flags;             /* user defined flags for file */
 118         __uint32_t st_gen;              /* file generation number */
 119 };
 120 #endif
 121
 122 #if defined(_WANT_FREEBSD11_STAT) || defined(_KERNEL)
 123 struct freebsd11_stat {
 124         __uint32_t st_dev;              /* inode's device */
 125         __uint32_t st_ino;              /* inode's number */
 126         mode_t    st_mode;              /* inode protection mode */
 127         __uint16_t st_nlink;            /* number of hard links */
 128         uid_t     st_uid;               /* user ID of the file's owner */
 129         gid_t     st_gid;               /* group ID of the file's group */
 130         __uint32_t st_rdev;             /* device type */
 131         struct  timespec st_atim;       /* time of last access */
 132         struct  timespec st_mtim;       /* time of last data modification */
 133         struct  timespec st_ctim;       /* time of last file status change */
 134         off_t     st_size;              /* file size, in bytes */
 135         blkcnt_t st_blocks;             /* blocks allocated for file */
 136         blksize_t st_blksize;           /* optimal blocksize for I/O */
 137         fflags_t  st_flags;             /* user defined flags for file */
 138         __uint32_t st_gen;              /* file generation number */
 139         __int32_t st_lspare;
 140         struct timespec st_birthtim;    /* time of file creation */
 141         /*
 142          * Explicitly pad st_birthtim to 16 bytes so that the size of
 143          * struct stat is backwards compatible.  We use bitfields instead
 144          * of an array of chars so that this doesn't require a C99 compiler
 145          * to compile if the size of the padding is 0.  We use 2 bitfields
 146          * to cover up to 64 bits on 32-bit machines.  We assume that
 147          * CHAR_BIT is 8...
 148          */
 149         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 150         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 151 };
 152 #endif /* _WANT_FREEBSD11_STAT || _KERNEL */
 153
 154 #if defined(__i386__)
 155 #define __STAT_TIME_T_EXT       1
 156 #endif
 157
 158 struct stat {
 159         dev_t     st_dev;               /* inode's device */
 160         ino_t     st_ino;               /* inode's number */
 161         nlink_t   st_nlink;             /* number of hard links */
 162         mode_t    st_mode;              /* inode protection mode */
 163         __int16_t st_padding0;
 164         uid_t     st_uid;               /* user ID of the file's owner */
 165         gid_t     st_gid;               /* group ID of the file's group */
 166         __int32_t st_padding1;
 167         dev_t     st_rdev;              /* device type */
 168 #ifdef  __STAT_TIME_T_EXT
 169         __int32_t st_atim_ext;
 170 #endif
 171         struct  timespec st_atim;       /* time of last access */
 172 #ifdef  __STAT_TIME_T_EXT
 173         __int32_t st_mtim_ext;
 174 #endif
 175         struct  timespec st_mtim;       /* time of last data modification */
 176 #ifdef  __STAT_TIME_T_EXT
 177         __int32_t st_ctim_ext;
 178 #endif
 179         struct  timespec st_ctim;       /* time of last file status change */
 180 #ifdef  __STAT_TIME_T_EXT
 181         __int32_t st_btim_ext;
 182 #endif
 183         struct  timespec st_birthtim;   /* time of file creation */
 184         off_t     st_size;              /* file size, in bytes */
 185         blkcnt_t st_blocks;             /* blocks allocated for file */
 186         blksize_t st_blksize;           /* optimal blocksize for I/O */
 187         fflags_t  st_flags;             /* user defined flags for file */
 188         __uint64_t st_gen;              /* file generation number */
 189         __uint64_t st_spare[10];
 190 };
 191
 192 #ifdef _KERNEL
 193 struct nstat {
 194         __uint32_t st_dev;              /* inode's device */
 195         __uint32_t st_ino;              /* inode's number */
 196         __uint32_t st_mode;             /* inode protection mode */
 197         __uint32_t st_nlink;            /* number of hard links */
 198         uid_t     st_uid;               /* user ID of the file's owner */
 199         gid_t     st_gid;               /* group ID of the file's group */
 200         __uint32_t st_rdev;             /* device type */
 201         struct  timespec st_atim;       /* time of last access */
 202         struct  timespec st_mtim;       /* time of last data modification */
 203         struct  timespec st_ctim;       /* time of last file status change */
 204         off_t     st_size;              /* file size, in bytes */
 205         blkcnt_t st_blocks;             /* blocks allocated for file */
 206         blksize_t st_blksize;           /* optimal blocksize for I/O */
 207         fflags_t  st_flags;             /* user defined flags for file */
 208         __uint32_t st_gen;              /* file generation number */
 209         struct timespec st_birthtim;    /* time of file creation */
 210         /*
 211          * See comment in the definition of struct freebsd11_stat
 212          * above about the following padding.
 213          */
 214         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 215         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 216 };
 217 #endif
 218
 219 #ifndef _KERNEL
 220 #define st_atime                st_atim.tv_sec
 221 #define st_mtime                st_mtim.tv_sec
 222 #define st_ctime                st_ctim.tv_sec
 223 #if __BSD_VISIBLE
 224 #define st_birthtime            st_birthtim.tv_sec
 225 #endif
 226
 227 /* For compatibility. */
 228 #if __BSD_VISIBLE
 229 #define st_atimespec            st_atim
 230 #define st_mtimespec            st_mtim
 231 #define st_ctimespec            st_ctim
 232 #define st_birthtimespec        st_birthtim
 233 #endif
 234 #endif /* !_KERNEL */
 235
 236 #define S_ISUID 0004000                 /* set user id on execution */
 237 #define S_ISGID 0002000                 /* set group id on execution */
 238 #if __BSD_VISIBLE
 239 #define S_ISTXT 0001000                 /* sticky bit */
 240 #endif
 241
 242 #define S_IRWXU 0000700                 /* RWX mask for owner */
 243 #define S_IRUSR 0000400                 /* R for owner */
 244 #define S_IWUSR 0000200                 /* W for owner */
 245 #define S_IXUSR 0000100                 /* X for owner */
 246
 247 #if __BSD_VISIBLE
 248 #define S_IREAD         S_IRUSR
 249 #define S_IWRITE        S_IWUSR
 250 #define S_IEXEC         S_IXUSR
 251 #endif
 252
 253 #define S_IRWXG 0000070                 /* RWX mask for group */
 254 #define S_IRGRP 0000040                 /* R for group */
 255 #define S_IWGRP 0000020                 /* W for group */
 256 #define S_IXGRP 0000010                 /* X for group */
 257
 258 #define S_IRWXO 0000007                 /* RWX mask for other */
 259 #define S_IROTH 0000004                 /* R for other */
 260 #define S_IWOTH 0000002                 /* W for other */
 261 #define S_IXOTH 0000001                 /* X for other */
 262
 263 #if __XSI_VISIBLE
 264 #define S_IFMT   0170000                /* type of file mask */
 265 #define S_IFIFO  0010000                /* named pipe (fifo) */
 266 #define S_IFCHR  0020000                /* character special */
 267 #define S_IFDIR  0040000                /* directory */
 268 #define S_IFBLK  0060000                /* block special */
 269 #define S_IFREG  0100000                /* regular */
 270 #define S_IFLNK  0120000                /* symbolic link */
 271 #define S_IFSOCK 0140000                /* socket */
 272 #define S_ISVTX  0001000                /* save swapped text even after use */
 273 #endif
 274 #if __BSD_VISIBLE
 275 #define S_IFWHT  0160000                /* whiteout */
 276 #endif
 277
 278 #define S_ISDIR(m)      (((m) & 0170000) == 0040000)    /* directory */
 279 #define S_ISCHR(m)      (((m) & 0170000) == 0020000)    /* char special */
 280 #define S_ISBLK(m)      (((m) & 0170000) == 0060000)    /* block special */
 281 #define S_ISREG(m)      (((m) & 0170000) == 0100000)    /* regular file */
 282 #define S_ISFIFO(m)     (((m) & 0170000) == 0010000)    /* fifo or socket */
 283 #if __POSIX_VISIBLE >= 200112
 284 #define S_ISLNK(m)      (((m) & 0170000) == 0120000)    /* symbolic link */
 285 #define S_ISSOCK(m)     (((m) & 0170000) == 0140000)    /* socket */
 286 #endif
 287 #if __BSD_VISIBLE
 288 #define S_ISWHT(m)      (((m) & 0170000) == 0160000)    /* whiteout */
 289 #endif
 290
 291 #if __BSD_VISIBLE
 292 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
 293                                                         /* 7777 */
 294 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
 295                                                         /* 0666 */
 296 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
 297
 298 #define S_BLKSIZE       512             /* block size used in the stat struct */
 299
 300 /*
 301  * Definitions of flags stored in file flags word.
 302  *
 303  * Super-user and owner changeable flags.
 304  */
 305 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
 306 #define UF_NODUMP       0x00000001      /* do not dump file */
 307 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
 308 #define UF_APPEND       0x00000004      /* writes to file may only append */
 309 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
 310 #define UF_NOUNLINK     0x00000010      /* file may not be removed or renamed */
 311 /*
 312  * These two bits are defined in MacOS X.  They are not currently used in
 313  * FreeBSD.
 314  */
 315 #if 0
 316 #define UF_COMPRESSED   0x00000020      /* file is compressed */
 317 #define UF_TRACKED      0x00000040      /* renames and deletes are tracked */
 318 #endif
 319
 320 #define UF_SYSTEM       0x00000080      /* Windows system file bit */
 321 #define UF_SPARSE       0x00000100      /* sparse file */
 322 #define UF_OFFLINE      0x00000200      /* file is offline */
 323 #define UF_REPARSE      0x00000400      /* Windows reparse point file bit */
 324 #define UF_ARCHIVE      0x00000800      /* file needs to be archived */
 325 #define UF_READONLY     0x00001000      /* Windows readonly file bit */
 326 /* This is the same as the MacOS X definition of UF_HIDDEN. */
 327 #define UF_HIDDEN       0x00008000      /* file is hidden */
 328
 329 /*
 330  * Super-user changeable flags.
 331  */
 332 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
 333 #define SF_ARCHIVED     0x00010000      /* file is archived */
 334 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
 335 #define SF_APPEND       0x00040000      /* writes to file may only append */
 336 #define SF_NOUNLINK     0x00100000      /* file may not be removed or renamed */
 337 #define SF_SNAPSHOT     0x00200000      /* snapshot inode */
 338
 339 #ifdef _KERNEL
 340 /*
 341  * Shorthand abbreviations of above.
 342  */
 343 #define OPAQUE          (UF_OPAQUE)
 344 #define APPEND          (UF_APPEND | SF_APPEND)
 345 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
 346 #define NOUNLINK        (UF_NOUNLINK | SF_NOUNLINK)
 347 #endif
 348
 349 #endif /* __BSD_VISIBLE */
 350
 351 #if __POSIX_VISIBLE >= 200809
 352 #define UTIME_NOW       -1
 353 #define UTIME_OMIT      -2
 354 #endif
 355
 356 #ifndef _KERNEL
 357 __BEGIN_DECLS
 358 #if __BSD_VISIBLE
 359 int     chflags(const char *, unsigned long);
 360 int     chflagsat(int, const char *, unsigned long, int);
 361 #endif
 362 int     chmod(const char *, mode_t);
 363 #if __BSD_VISIBLE
 364 int     fchflags(int, unsigned long);
 365 #endif
 366 #if __POSIX_VISIBLE >= 200112
 367 int     fchmod(int, mode_t);
 368 #endif
 369 #if __POSIX_VISIBLE >= 200809
 370 int     fchmodat(int, const char *, mode_t, int);
 371 int     futimens(int fd, const struct timespec times[2]);
 372 int     utimensat(int fd, const char *path, const struct timespec times[2],
 373                 int flag);
 374 #endif
 375 int     fstat(int, struct stat *);
 376 #if __BSD_VISIBLE
 377 int     lchflags(const char *, unsigned long);
 378 int     lchmod(const char *, mode_t);
 379 #endif
 380 #if __POSIX_VISIBLE >= 200112
 381 int     lstat(const char * __restrict, struct stat * __restrict);
 382 #endif
 383 int     mkdir(const char *, mode_t);
 384 int     mkfifo(const char *, mode_t);
 385 #if !defined(_MKNOD_DECLARED) && __XSI_VISIBLE
 386 int     mknod(const char *, mode_t, dev_t);
 387 #define _MKNOD_DECLARED
 388 #endif
 389 int     stat(const char * __restrict, struct stat * __restrict);
 390 mode_t  umask(mode_t);
 391 #if __POSIX_VISIBLE >= 200809
 392 int     fstatat(int, const char *, struct stat *, int);
 393 int     mkdirat(int, const char *, mode_t);
 394 int     mkfifoat(int, const char *, mode_t);
 395 #endif
 396 #if __XSI_VISIBLE >= 700
 397 int     mknodat(int, const char *, mode_t, dev_t);
 398 #endif
 399 __END_DECLS
 400 #endif /* !_KERNEL */
 401
 402 #endif /* !_SYS_STAT_H_ */