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