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  * 4. 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/_types.h>
  43
  44 #ifndef _BLKSIZE_T_DECLARED
  45 typedef __blksize_t     blksize_t;
  46 #define _BLKSIZE_T_DECLARED
  47 #endif
  48
  49 #ifndef _BLKCNT_T_DECLARED
  50 typedef __blkcnt_t      blkcnt_t;
  51 #define _BLKCNT_T_DECLARED
  52 #endif
  53
  54 #ifndef _DEV_T_DECLARED
  55 typedef __dev_t         dev_t;
  56 #define _DEV_T_DECLARED
  57 #endif
  58
  59 #ifndef _FFLAGS_T_DECLARED
  60 typedef __fflags_t      fflags_t;
  61 #define _FFLAGS_T_DECLARED
  62 #endif
  63
  64 #ifndef _GID_T_DECLARED
  65 typedef __gid_t         gid_t;
  66 #define _GID_T_DECLARED
  67 #endif
  68
  69 #ifndef _INO_T_DECLARED
  70 typedef __ino_t         ino_t;
  71 #define _INO_T_DECLARED
  72 #endif
  73
  74 #ifndef _MODE_T_DECLARED
  75 typedef __mode_t        mode_t;
  76 #define _MODE_T_DECLARED
  77 #endif
  78
  79 #ifndef _NLINK_T_DECLARED
  80 typedef __nlink_t       nlink_t;
  81 #define _NLINK_T_DECLARED
  82 #endif
  83
  84 #ifndef _OFF_T_DECLARED
  85 typedef __off_t         off_t;
  86 #define _OFF_T_DECLARED
  87 #endif
  88
  89 #ifndef _TIME_T_DECLARED
  90 typedef __time_t        time_t;
  91 #define _TIME_T_DECLARED
  92 #endif
  93
  94 #ifndef _UID_T_DECLARED
  95 typedef __uid_t         uid_t;
  96 #define _UID_T_DECLARED
  97 #endif
  98
  99 #if !defined(_KERNEL) && __BSD_VISIBLE
 100 /*
 101  * XXX we need this for struct timespec.  We get miscellaneous namespace
 102  * pollution with it.
 103  */
 104 #include <sys/time.h>
 105 #endif
 106
 107 #if !__BSD_VISIBLE
 108 #include <sys/_timespec.h>
 109 #endif
 110
 111 #if __BSD_VISIBLE
 112 struct ostat {
 113         __uint16_t st_dev;              /* inode's device */
 114         ino_t     st_ino;               /* inode's number */
 115         mode_t    st_mode;              /* inode protection mode */
 116         nlink_t   st_nlink;             /* number of hard links */
 117         __uint16_t st_uid;              /* user ID of the file's owner */
 118         __uint16_t st_gid;              /* group ID of the file's group */
 119         __uint16_t st_rdev;             /* device type */
 120         __int32_t st_size;              /* file size, in bytes */
 121         struct  timespec st_atimespec;  /* time of last access */
 122         struct  timespec st_mtimespec;  /* time of last data modification */
 123         struct  timespec st_ctimespec;  /* time of last file status change */
 124         __int32_t st_blksize;           /* optimal blocksize for I/O */
 125         __int32_t st_blocks;            /* blocks allocated for file */
 126         fflags_t  st_flags;             /* user defined flags for file */
 127         __uint32_t st_gen;              /* file generation number */
 128 };
 129 #endif /* __BSD_VISIBLE */
 130
 131 struct stat {
 132         __dev_t   st_dev;               /* inode's device */
 133         ino_t     st_ino;               /* inode's number */
 134         mode_t    st_mode;              /* inode protection mode */
 135         nlink_t   st_nlink;             /* number of hard links */
 136         uid_t     st_uid;               /* user ID of the file's owner */
 137         gid_t     st_gid;               /* group ID of the file's group */
 138         __dev_t   st_rdev;              /* device type */
 139 #if __BSD_VISIBLE
 140         struct  timespec st_atimespec;  /* time of last access */
 141         struct  timespec st_mtimespec;  /* time of last data modification */
 142         struct  timespec st_ctimespec;  /* time of last file status change */
 143 #else
 144         time_t    st_atime;             /* time of last access */
 145         long      __st_atimensec;       /* nsec of last access */
 146         time_t    st_mtime;             /* time of last data modification */
 147         long      __st_mtimensec;       /* nsec of last data modification */
 148         time_t    st_ctime;             /* time of last file status change */
 149         long      __st_ctimensec;       /* nsec of last file status change */
 150 #endif
 151         off_t     st_size;              /* file size, in bytes */
 152         blkcnt_t st_blocks;             /* blocks allocated for file */
 153         blksize_t st_blksize;           /* optimal blocksize for I/O */
 154         fflags_t  st_flags;             /* user defined flags for file */
 155         __uint32_t st_gen;              /* file generation number */
 156         __int32_t st_lspare;
 157 #if __BSD_VISIBLE
 158         struct timespec st_birthtimespec; /* time of file creation */
 159         /*
 160          * Explicitly pad st_birthtimespec to 16 bytes so that the size of
 161          * struct stat is backwards compatible.  We use bitfields instead
 162          * of an array of chars so that this doesn't require a C99 compiler
 163          * to compile if the size of the padding is 0.  We use 2 bitfields
 164          * to cover up to 64 bits on 32-bit machines.  We assume that
 165          * CHAR_BIT is 8...
 166          */
 167         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 168         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 169 #else
 170         time_t    st_birthtime;         /* time of file creation */
 171         long      st_birthtimensec;     /* nsec of file creation */
 172         unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
 173         unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
 174 #endif
 175 };
 176
 177 #if __BSD_VISIBLE
 178 struct nstat {
 179         __dev_t   st_dev;               /* inode's device */
 180         ino_t     st_ino;               /* inode's number */
 181         __uint32_t st_mode;             /* inode protection mode */
 182         __uint32_t st_nlink;            /* number of hard links */
 183         uid_t     st_uid;               /* user ID of the file's owner */
 184         gid_t     st_gid;               /* group ID of the file's group */
 185         __dev_t   st_rdev;              /* device type */
 186         struct  timespec st_atimespec;  /* time of last access */
 187         struct  timespec st_mtimespec;  /* time of last data modification */
 188         struct  timespec st_ctimespec;  /* time of last file status change */
 189         off_t     st_size;              /* file size, in bytes */
 190         blkcnt_t st_blocks;             /* blocks allocated for file */
 191         blksize_t st_blksize;           /* optimal blocksize for I/O */
 192         fflags_t  st_flags;             /* user defined flags for file */
 193         __uint32_t st_gen;              /* file generation number */
 194         struct timespec st_birthtimespec; /* time of file creation */
 195         /*
 196          * See above about the following padding.
 197          */
 198         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 199         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 200 };
 201 #endif
 202
 203 #if __BSD_VISIBLE
 204 #define st_atime st_atimespec.tv_sec
 205 #define st_mtime st_mtimespec.tv_sec
 206 #define st_ctime st_ctimespec.tv_sec
 207 #define st_birthtime st_birthtimespec.tv_sec
 208 #endif
 209
 210 #define S_ISUID 0004000                 /* set user id on execution */
 211 #define S_ISGID 0002000                 /* set group id on execution */
 212 #if __BSD_VISIBLE
 213 #define S_ISTXT 0001000                 /* sticky bit */
 214 #endif
 215
 216 #define S_IRWXU 0000700                 /* RWX mask for owner */
 217 #define S_IRUSR 0000400                 /* R for owner */
 218 #define S_IWUSR 0000200                 /* W for owner */
 219 #define S_IXUSR 0000100                 /* X for owner */
 220
 221 #if __BSD_VISIBLE
 222 #define S_IREAD         S_IRUSR
 223 #define S_IWRITE        S_IWUSR
 224 #define S_IEXEC         S_IXUSR
 225 #endif
 226
 227 #define S_IRWXG 0000070                 /* RWX mask for group */
 228 #define S_IRGRP 0000040                 /* R for group */
 229 #define S_IWGRP 0000020                 /* W for group */
 230 #define S_IXGRP 0000010                 /* X for group */
 231
 232 #define S_IRWXO 0000007                 /* RWX mask for other */
 233 #define S_IROTH 0000004                 /* R for other */
 234 #define S_IWOTH 0000002                 /* W for other */
 235 #define S_IXOTH 0000001                 /* X for other */
 236
 237 #if __XSI_VISIBLE
 238 #define S_IFMT   0170000                /* type of file mask */
 239 #define S_IFIFO  0010000                /* named pipe (fifo) */
 240 #define S_IFCHR  0020000                /* character special */
 241 #define S_IFDIR  0040000                /* directory */
 242 #define S_IFBLK  0060000                /* block special */
 243 #define S_IFREG  0100000                /* regular */
 244 #define S_IFLNK  0120000                /* symbolic link */
 245 #define S_IFSOCK 0140000                /* socket */
 246 #define S_ISVTX  0001000                /* save swapped text even after use */
 247 #endif
 248 #if __BSD_VISIBLE
 249 #define S_IFWHT  0160000                /* whiteout */
 250 #endif
 251
 252 #define S_ISDIR(m)      (((m) & 0170000) == 0040000)    /* directory */
 253 #define S_ISCHR(m)      (((m) & 0170000) == 0020000)    /* char special */
 254 #define S_ISBLK(m)      (((m) & 0170000) == 0060000)    /* block special */
 255 #define S_ISREG(m)      (((m) & 0170000) == 0100000)    /* regular file */
 256 #define S_ISFIFO(m)     (((m) & 0170000) == 0010000)    /* fifo or socket */
 257 #if __POSIX_VISIBLE >= 200112
 258 #define S_ISLNK(m)      (((m) & 0170000) == 0120000)    /* symbolic link */
 259 #define S_ISSOCK(m)     (((m) & 0170000) == 0140000)    /* socket */
 260 #endif
 261 #if __BSD_VISIBLE
 262 #define S_ISWHT(m)      (((m) & 0170000) == 0160000)    /* whiteout */
 263 #endif
 264
 265 #if __BSD_VISIBLE
 266 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
 267                                                         /* 7777 */
 268 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
 269                                                         /* 0666 */
 270 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
 271
 272 #define S_BLKSIZE       512             /* block size used in the stat struct */
 273
 274 /*
 275  * Definitions of flags stored in file flags word.
 276  *
 277  * Super-user and owner changeable flags.
 278  */
 279 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
 280 #define UF_NODUMP       0x00000001      /* do not dump file */
 281 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
 282 #define UF_APPEND       0x00000004      /* writes to file may only append */
 283 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
 284 #define UF_NOUNLINK     0x00000010      /* file may not be removed or renamed */
 285 /*
 286  * Super-user changeable flags.
 287  */
 288 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
 289 #define SF_ARCHIVED     0x00010000      /* file is archived */
 290 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
 291 #define SF_APPEND       0x00040000      /* writes to file may only append */
 292 #define SF_NOUNLINK     0x00100000      /* file may not be removed or renamed */
 293 #define SF_SNAPSHOT     0x00200000      /* snapshot inode */
 294
 295 #ifdef _KERNEL
 296 /*
 297  * Shorthand abbreviations of above.
 298  */
 299 #define OPAQUE          (UF_OPAQUE)
 300 #define APPEND          (UF_APPEND | SF_APPEND)
 301 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
 302 #define NOUNLINK        (UF_NOUNLINK | SF_NOUNLINK)
 303 #endif
 304
 305 #endif /* __BSD_VISIBLE */
 306
 307 #ifndef _KERNEL
 308 __BEGIN_DECLS
 309 #if __BSD_VISIBLE
 310 int     chflags(const char *, unsigned long);
 311 #endif
 312 int     chmod(const char *, mode_t);
 313 #if __BSD_VISIBLE
 314 int     fchflags(int, unsigned long);
 315 #endif
 316 #if __POSIX_VISIBLE >= 200112
 317 int     fchmod(int, mode_t);
 318 #endif
 319 #if __POSIX_VISIBLE >= 200809
 320 int     fchmodat(int, const char *, mode_t, int);
 321 #endif
 322 int     fstat(int, struct stat *);
 323 #if __BSD_VISIBLE
 324 int     lchflags(const char *, int);
 325 int     lchmod(const char *, mode_t);
 326 #endif
 327 #if __POSIX_VISIBLE >= 200112
 328 int     lstat(const char * __restrict, struct stat * __restrict);
 329 #endif
 330 int     mkdir(const char *, mode_t);
 331 int     mkfifo(const char *, mode_t);
 332 #if !defined(_MKNOD_DECLARED) && __XSI_VISIBLE
 333 int     mknod(const char *, mode_t, dev_t);
 334 #define _MKNOD_DECLARED
 335 #endif
 336 int     stat(const char * __restrict, struct stat * __restrict);
 337 mode_t  umask(mode_t);
 338 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
 339 int     fstatat(int, const char *, struct stat *, int);
 340 int     mkdirat(int, const char *, mode_t);
 341 int     mkfifoat(int, const char *, mode_t);
 342 #endif
 343 #if __BSD_VISIBLE || __XSI_VISIBLE >= 700
 344 int     mknodat(int, const char *, mode_t, dev_t);
 345 #endif
 346 __END_DECLS
 347 #endif /* !_KERNEL */
 348
 349 #endif /* !_SYS_STAT_H_ */