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