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. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)stat.h      8.12 (Berkeley) 6/16/95
  39  * $FreeBSD$
  40  */
  41
  42 #ifndef _SYS_STAT_H_
  43 #define _SYS_STAT_H_
  44
  45 #include <sys/cdefs.h>
  46 #include <sys/_types.h>
  47
  48 /* XXX missing blkcnt_t, blksize_t. */
  49
  50 #ifndef _DEV_T_DECLARED
  51 typedef __dev_t         dev_t;
  52 #define _DEV_T_DECLARED
  53 #endif
  54
  55 #ifndef _FFLAGS_T_DECLARED
  56 typedef __fflags_t      fflags_t;
  57 #define _FFLAGS_T_DECLARED
  58 #endif
  59
  60 #ifndef _GID_T_DECLARED
  61 typedef __gid_t         gid_t;
  62 #define _GID_T_DECLARED
  63 #endif
  64
  65 #ifndef _INO_T_DECLARED
  66 typedef __ino_t         ino_t;
  67 #define _INO_T_DECLARED
  68 #endif
  69
  70 #ifndef _MODE_T_DECLARED
  71 typedef __mode_t        mode_t;
  72 #define _MODE_T_DECLARED
  73 #endif
  74
  75 #ifndef _NLINK_T_DECLARED
  76 typedef __nlink_t       nlink_t;
  77 #define _NLINK_T_DECLARED
  78 #endif
  79
  80 #ifndef _OFF_T_DECLARED
  81 typedef __off_t         off_t;
  82 #define _OFF_T_DECLARED
  83 #endif
  84
  85 #ifndef _TIME_T_DECLARED
  86 typedef __time_t        time_t;
  87 #define _TIME_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 need this for struct timespec.  We get miscellaneous namespace
  98  * pollution with it.
  99  */
 100 #include <sys/time.h>
 101 #endif
 102
 103 #if !__BSD_VISIBLE
 104 #include <sys/_timespec.h>
 105 #endif
 106
 107 #if __BSD_VISIBLE
 108 struct ostat {
 109         __uint16_t st_dev;              /* inode's device */
 110         ino_t     st_ino;               /* inode's number */
 111         mode_t    st_mode;              /* inode protection mode */
 112         nlink_t   st_nlink;             /* number of hard links */
 113         __uint16_t st_uid;              /* user ID of the file's owner */
 114         __uint16_t st_gid;              /* group ID of the file's group */
 115         __uint16_t st_rdev;             /* device type */
 116         __int32_t st_size;              /* file size, in bytes */
 117         struct  timespec st_atimespec;  /* time of last access */
 118         struct  timespec st_mtimespec;  /* time of last data modification */
 119         struct  timespec st_ctimespec;  /* time of last file status change */
 120         __int32_t st_blksize;           /* optimal blocksize for I/O */
 121         __int32_t st_blocks;            /* blocks allocated for file */
 122         fflags_t  st_flags;             /* user defined flags for file */
 123         __uint32_t st_gen;              /* file generation number */
 124 };
 125 #endif /* __BSD_VISIBLE */
 126
 127 struct stat {
 128         __udev_t  st_dev;               /* inode's device */
 129         ino_t     st_ino;               /* inode's number */
 130         mode_t    st_mode;              /* inode protection mode */
 131         nlink_t   st_nlink;             /* number of hard links */
 132         uid_t     st_uid;               /* user ID of the file's owner */
 133         gid_t     st_gid;               /* group ID of the file's group */
 134         __udev_t  st_rdev;              /* device type */
 135 #if __BSD_VISIBLE
 136         struct  timespec st_atimespec;  /* time of last access */
 137         struct  timespec st_mtimespec;  /* time of last data modification */
 138         struct  timespec st_ctimespec;  /* time of last file status change */
 139 #else
 140         time_t    st_atime;             /* time of last access */
 141         long      st_atimensec;         /* nsec of last access */
 142         time_t    st_mtime;             /* time of last data modification */
 143         long      st_mtimensec;         /* nsec of last data modification */
 144         time_t    st_ctime;             /* time of last file status change */
 145         long      st_ctimensec;         /* nsec of last file status change */
 146 #endif
 147         off_t     st_size;              /* file size, in bytes */
 148         __int64_t st_blocks;            /* blocks allocated for file */
 149         __uint32_t st_blksize;          /* optimal blocksize for I/O */
 150         fflags_t  st_flags;             /* user defined flags for file */
 151         __uint32_t st_gen;              /* file generation number */
 152         __int32_t st_lspare;
 153 #if __BSD_VISIBLE
 154         struct timespec st_birthtimespec; /* time of file creation */
 155         /*
 156          * Explicitly pad st_birthtimespec to 16 bytes so that the size of
 157          * struct stat is backwards compatible.  We use bitfields instead
 158          * of an array of chars so that this doesn't require a C99 compiler
 159          * to compile if the size of the padding is 0.  We use 2 bitfields
 160          * to cover up to 64 bits on 32-bit machines.  We assume that
 161          * CHAR_BIT is 8...
 162          */
 163         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 164         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 165 #else
 166         time_t    st_birthtime;         /* time of file creation */
 167         long      st_birthtimensec;     /* nsec of file creation */
 168         unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
 169         unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
 170 #endif
 171 };
 172
 173 #if __BSD_VISIBLE
 174 struct nstat {
 175         __udev_t st_dev;                /* inode's device */
 176         ino_t     st_ino;               /* inode's number */
 177         __uint32_t st_mode;             /* inode protection mode */
 178         __uint32_t st_nlink;            /* number of hard links */
 179         uid_t     st_uid;               /* user ID of the file's owner */
 180         gid_t     st_gid;               /* group ID of the file's group */
 181         __udev_t st_rdev;               /* device type */
 182         struct  timespec st_atimespec;  /* time of last access */
 183         struct  timespec st_mtimespec;  /* time of last data modification */
 184         struct  timespec st_ctimespec;  /* time of last file status change */
 185         off_t     st_size;              /* file size, in bytes */
 186         __int64_t st_blocks;            /* blocks allocated for file */
 187         __uint32_t st_blksize;          /* optimal blocksize for I/O */
 188         fflags_t  st_flags;             /* user defined flags for file */
 189         __uint32_t st_gen;              /* file generation number */
 190         struct timespec st_birthtimespec; /* time of file creation */
 191         /*
 192          * See above about the following padding.
 193          */
 194         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 195         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
 196 };
 197 #endif
 198
 199 #if __BSD_VISIBLE
 200 #define st_atime st_atimespec.tv_sec
 201 #define st_mtime st_mtimespec.tv_sec
 202 #define st_ctime st_ctimespec.tv_sec
 203 #define st_birthtime st_birthtimespec.tv_sec
 204 #endif
 205
 206 #define S_ISUID 0004000                 /* set user id on execution */
 207 #define S_ISGID 0002000                 /* set group id on execution */
 208 #if __BSD_VISIBLE
 209 #define S_ISTXT 0001000                 /* sticky bit */
 210 #endif
 211
 212 #define S_IRWXU 0000700                 /* RWX mask for owner */
 213 #define S_IRUSR 0000400                 /* R for owner */
 214 #define S_IWUSR 0000200                 /* W for owner */
 215 #define S_IXUSR 0000100                 /* X for owner */
 216
 217 #if __BSD_VISIBLE
 218 #define S_IREAD         S_IRUSR
 219 #define S_IWRITE        S_IWUSR
 220 #define S_IEXEC         S_IXUSR
 221 #endif
 222
 223 #define S_IRWXG 0000070                 /* RWX mask for group */
 224 #define S_IRGRP 0000040                 /* R for group */
 225 #define S_IWGRP 0000020                 /* W for group */
 226 #define S_IXGRP 0000010                 /* X for group */
 227
 228 #define S_IRWXO 0000007                 /* RWX mask for other */
 229 #define S_IROTH 0000004                 /* R for other */
 230 #define S_IWOTH 0000002                 /* W for other */
 231 #define S_IXOTH 0000001                 /* X for other */
 232
 233 #if __XSI_VISIBLE
 234 #define S_IFMT   0170000                /* type of file mask */
 235 #define S_IFIFO  0010000                /* named pipe (fifo) */
 236 #define S_IFCHR  0020000                /* character special */
 237 #define S_IFDIR  0040000                /* directory */
 238 #define S_IFBLK  0060000                /* block special */
 239 #define S_IFREG  0100000                /* regular */
 240 #define S_IFLNK  0120000                /* symbolic link */
 241 #define S_IFSOCK 0140000                /* socket */
 242 #define S_ISVTX  0001000                /* save swapped text even after use */
 243 #endif
 244 #if __BSD_VISIBLE
 245 #define S_IFWHT  0160000                /* whiteout */
 246 #endif
 247
 248 #define S_ISDIR(m)      (((m) & 0170000) == 0040000)    /* directory */
 249 #define S_ISCHR(m)      (((m) & 0170000) == 0020000)    /* char special */
 250 #define S_ISBLK(m)      (((m) & 0170000) == 0060000)    /* block special */
 251 #define S_ISREG(m)      (((m) & 0170000) == 0100000)    /* regular file */
 252 #define S_ISFIFO(m)     (((m) & 0170000) == 0010000)    /* fifo or socket */
 253 #if __POSIX_VISIBLE >= 200112
 254 #define S_ISLNK(m)      (((m) & 0170000) == 0120000)    /* symbolic link */
 255 #define S_ISSOCK(m)     (((m) & 0170000) == 0140000)    /* socket */
 256 #endif
 257 #if __XSI_VISIBLE
 258 #define S_ISWHT(m)      (((m) & 0170000) == 0160000)    /* whiteout */
 259 #endif
 260
 261 #if __BSD_VISIBLE
 262 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
 263                                                         /* 7777 */
 264 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
 265                                                         /* 0666 */
 266 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
 267
 268 #define S_BLKSIZE       512             /* block size used in the stat struct */
 269
 270 /*
 271  * Definitions of flags stored in file flags word.
 272  *
 273  * Super-user and owner changeable flags.
 274  */
 275 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
 276 #define UF_NODUMP       0x00000001      /* do not dump file */
 277 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
 278 #define UF_APPEND       0x00000004      /* writes to file may only append */
 279 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
 280 #define UF_NOUNLINK     0x00000010      /* file may not be removed or renamed */
 281 /*
 282  * Super-user changeable flags.
 283  */
 284 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
 285 #define SF_ARCHIVED     0x00010000      /* file is archived */
 286 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
 287 #define SF_APPEND       0x00040000      /* writes to file may only append */
 288 #define SF_NOUNLINK     0x00100000      /* file may not be removed or renamed */
 289 #define SF_SNAPSHOT     0x00200000      /* snapshot inode */
 290
 291 #ifdef _KERNEL
 292 /*
 293  * Shorthand abbreviations of above.
 294  */
 295 #define OPAQUE          (UF_OPAQUE)
 296 #define APPEND          (UF_APPEND | SF_APPEND)
 297 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
 298 #define NOUNLINK        (UF_NOUNLINK | SF_NOUNLINK)
 299 #endif
 300
 301 #endif /* __BSD_VISIBLE */
 302
 303 #ifndef _KERNEL
 304 __BEGIN_DECLS
 305 #if __BSD_VISIBLE
 306 int     chflags(const char *, unsigned long);
 307 #endif
 308 int     chmod(const char *, mode_t);
 309 #if __BSD_VISIBLE
 310 int     fchflags(int, unsigned long);
 311 int     fchmod(int, mode_t);
 312 #endif
 313 int     fstat(int, struct stat *);
 314 #if __BSD_VISIBLE
 315 int     lchflags(const char *, int);
 316 int     lchmod(const char *, mode_t);
 317 #endif
 318 #if __POSIX_VISIBLE >= 200112
 319 int     lstat(const char *, struct stat *);
 320 #endif
 321 int     mkdir(const char *, mode_t);
 322 int     mkfifo(const char *, mode_t);
 323 int     stat(const char *, struct stat *);
 324 mode_t  umask(mode_t);
 325 __END_DECLS
 326 #endif /* !_KERNEL */
 327
 328 #endif /* !_SYS_STAT_H_ */