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: src/sys/sys/stat.h,v 1.20 1999/12/29 04:24:47 peter Exp $
  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 #if !defined(_KERNEL) && __BSD_VISIBLE
  45 /*
  46  * XXX We get miscellaneous namespace pollution with this.
  47  */
  48 #include <sys/time.h>
  49 #else
  50 #include <sys/_timespec.h>
  51 #endif
  52
  53 /*
  54  * stat structure notes:
  55  *
  56  * NOTE: st_fsmid removed in DragonFly 2.5.x.
  57  */
  58 struct stat {
  59         ino_t           st_ino;         /* inode's number */
  60         nlink_t         st_nlink;       /* number of hard links */
  61         dev_t           st_dev;         /* inode's device */
  62         mode_t          st_mode;        /* inode protection mode */
  63         uint16_t        st_padding1;
  64         uid_t           st_uid;         /* user ID of the file's owner */
  65         gid_t           st_gid;         /* group ID of the file's group */
  66         dev_t           st_rdev;                /* device type */
  67         struct timespec st_atim;        /* time of last access */
  68         struct timespec st_mtim;        /* time of last data modification */
  69         struct timespec st_ctim;        /* time of last file status change */
  70         off_t           st_size;        /* file size, in bytes */
  71         blkcnt_t        st_blocks;      /* blocks allocated for file */
  72         u_int32_t       __old_st_blksize; /* old ABI compatibility only */
  73         u_int32_t       st_flags;       /* user defined flags for file */
  74         u_int32_t       st_gen;         /* file generation number */
  75         int32_t         st_lspare;
  76         blksize_t       st_blksize;     /* optimal blocksize for I/O */
  77         int64_t         st_qspare2;
  78 };
  79
  80 /*#define _ST_FSMID_PRESENT_*/
  81 #define _ST_FLAGS_PRESENT_
  82
  83 #define st_atime st_atim.tv_sec
  84 #define st_mtime st_mtim.tv_sec
  85 #define st_ctime st_ctim.tv_sec
  86
  87 /* BSD compatibility */
  88 #if __BSD_VISIBLE
  89 #define st_atimespec st_atim
  90 #define st_mtimespec st_mtim
  91 #define st_ctimespec st_ctim
  92 #endif
  93
  94 /* Always ensure that these are consistent with <fcntl.h>! */
  95 #ifndef S_ISUID
  96 #define S_ISUID 0004000                 /* set user id on execution */
  97 #endif
  98 #ifndef S_ISGID
  99 #define S_ISGID 0002000                 /* set group id on execution */
 100 #endif
 101 #if __BSD_VISIBLE
 102 #define S_ISTXT 0001000                 /* sticky bit */
 103 #endif
 104
 105 #ifndef S_IRWXU
 106 #define S_IRWXU 0000700                 /* RWX mask for owner */
 107 #endif
 108 #ifndef S_IRUSR
 109 #define S_IRUSR 0000400                 /* R for owner */
 110 #endif
 111 #ifndef S_IWUSR
 112 #define S_IWUSR 0000200                 /* W for owner */
 113 #endif
 114 #ifndef S_IXUSR
 115 #define S_IXUSR 0000100                 /* X for owner */
 116 #endif
 117
 118 #if __BSD_VISIBLE
 119 #define S_IREAD         S_IRUSR
 120 #define S_IWRITE        S_IWUSR
 121 #define S_IEXEC         S_IXUSR
 122 #endif
 123
 124 #ifndef S_IRWXG
 125 #define S_IRWXG 0000070                 /* RWX mask for group */
 126 #endif
 127 #ifndef S_IRGRP
 128 #define S_IRGRP 0000040                 /* R for group */
 129 #endif
 130 #ifndef S_IWGRP
 131 #define S_IWGRP 0000020                 /* W for group */
 132 #endif
 133 #ifndef S_IXGRP
 134 #define S_IXGRP 0000010                 /* X for group */
 135 #endif
 136
 137 #ifndef S_IRWXO
 138 #define S_IRWXO 0000007                 /* RWX mask for other */
 139 #endif
 140 #ifndef S_IROTH
 141 #define S_IROTH 0000004                 /* R for other */
 142 #endif
 143 #ifndef S_IWOTH
 144 #define S_IWOTH 0000002                 /* W for other */
 145 #endif
 146 #ifndef S_IXOTH
 147 #define S_IXOTH 0000001                 /* X for other */
 148 #endif
 149
 150 #if __XSI_VISIBLE
 151 #define S_IFMT   0170000                /* type of file mask */
 152 #define S_IFIFO  0010000                /* named pipe (fifo) */
 153 #define S_IFCHR  0020000                /* character special */
 154 #define S_IFDIR  0040000                /* directory */
 155 #define S_IFBLK  0060000                /* block special */
 156 #define S_IFREG  0100000                /* regular */
 157 #define S_IFLNK  0120000                /* symbolic link */
 158 #define S_IFSOCK 0140000                /* socket */
 159 #define S_ISVTX  0001000                /* save swapped text even after use */
 160 #endif
 161 #if __BSD_VISIBLE
 162 #define S_IFDB   0110000                /* record access file */
 163 #define S_IFWHT  0160000                /* whiteout */
 164 #endif
 165
 166 #define S_ISDIR(m)      (((m) & 0170000) == 0040000)    /* directory */
 167 #define S_ISCHR(m)      (((m) & 0170000) == 0020000)    /* char special */
 168 #define S_ISBLK(m)      (((m) & 0170000) == 0060000)    /* block special */
 169 #define S_ISREG(m)      (((m) & 0170000) == 0100000)    /* regular file */
 170 #define S_ISDB(m)       (((m) & 0170000) == 0110000)    /* record access file */
 171 #define S_ISFIFO(m)     (((m) & 0170000) == 0010000)    /* fifo or socket */
 172 #if __POSIX_VISIBLE
 173 #define S_ISLNK(m)      (((m) & 0170000) == 0120000)    /* symbolic link */
 174 #define S_ISSOCK(m)     (((m) & 0170000) == 0140000)    /* socket */
 175 #endif
 176 #if __BSD_VISIBLE
 177 #define S_ISWHT(m)      (((m) & 0170000) == 0160000)    /* whiteout */
 178 #endif
 179
 180 /*
 181  * The value of `buf' is a pointer to a `stat' data structure. Since we don't
 182  * implement message queues, semaphores, and shared memory objects as distinct
 183  * file types, the following macros evaluate to zero.
 184  *
 185  * XXX: Add S_TYPEISTMO() once we grow support for POSIX typed memory objects.
 186  */
 187 #define S_TYPEISMQ(buf)         (0)     /* message queue */
 188 #define S_TYPEISSEM(buf)        (0)     /* semaphore */
 189 #define S_TYPEISSHM(buf)        (0)     /* shared memory object */
 190
 191 #if __BSD_VISIBLE
 192 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
 193                                                         /* 7777 */
 194 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
 195                                                         /* 0666 */
 196 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
 197
 198 #define S_BLKSIZE       512             /* block size used in the stat struct */
 199
 200 /*
 201  * Definitions of flags stored in file flags word.
 202  *
 203  * Super-user and owner changeable flags.
 204  */
 205 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
 206 #define UF_NODUMP       0x00000001      /* do not dump file */
 207 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
 208 #define UF_APPEND       0x00000004      /* writes to file may only append */
 209 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
 210 #define UF_NOUNLINK     0x00000010      /* file may not be removed or renamed */
 211 #define UF_UNUSED5      0x00000020      /* (unused) */
 212 #define UF_NOHISTORY    0x00000040      /* do not retain history/snapshots */
 213 #define UF_CACHE        0x00000080      /* enable data swapcache */
 214 #define UF_XLINK        0x00000100      /* cross-link (hardlink) boundary */
 215
 216 /*
 217  * Super-user changeable flags.
 218  */
 219 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
 220 #define SF_ARCHIVED     0x00010000      /* file is archived */
 221 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
 222 #define SF_APPEND       0x00040000      /* writes to file may only append */
 223 #define SF_NOUNLINK     0x00100000      /* file may not be removed or renamed */
 224 #define SF_UNUSED17     0x00200000      /* (used by FreeBSD for snapshots) */
 225 #define SF_NOHISTORY    0x00400000      /* do not retain history/snapshots */
 226 #define SF_NOCACHE      0x00800000      /* disable data swapcache */
 227 #define SF_XLINK        0x01000000      /* cross-link (hardlink) boundary */
 228
 229 #ifdef _KERNEL
 230 /*
 231  * Shorthand abbreviations of above.
 232  */
 233 #define OPAQUE          (UF_OPAQUE)
 234 #define APPEND          (UF_APPEND | SF_APPEND)
 235 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
 236 #define NOUNLINK        (UF_NOUNLINK | SF_NOUNLINK)
 237 #endif
 238
 239 #endif /* __BSD_VISIBLE */
 240
 241 #if __POSIX_VISIBLE >= 200809
 242 #define UTIME_NOW       -1
 243 #define UTIME_OMIT      -2
 244 #endif
 245
 246 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
 247
 248 __BEGIN_DECLS
 249 int     chmod(const char *, mode_t);
 250 int     fchmod(int, mode_t);
 251 #if __POSIX_VISIBLE >= 200809
 252 int     fchmodat(int, const char *, mode_t, int);
 253 int     futimens(int, const struct timespec *);
 254 int     utimensat(int, const char *, const struct timespec *, int);
 255 #endif
 256 int     fstat(int, struct stat *);
 257 #if __POSIX_VISIBLE >= 199506
 258 int     lstat(const char * __restrict, struct stat * __restrict);
 259 #endif
 260 int     mkdir(const char *, mode_t);
 261 int     mkfifo(const char *, mode_t);
 262 #if !defined(_MKNOD_DECLARED) && __XSI_VISIBLE
 263 int     mknod(const char *, mode_t, dev_t);
 264 #define _MKNOD_DECLARED
 265 #endif
 266 int     stat(const char * __restrict, struct stat * __restrict);
 267 mode_t  umask(mode_t);
 268 #if __POSIX_VISIBLE >= 200809
 269 int     fstatat(int, const char * __restrict, struct stat * __restrict, int);
 270 int     mkdirat(int, const char *, mode_t);
 271 int     mkfifoat(int, const char *, mode_t);
 272 #endif
 273 #if __XSI_VISIBLE >= 700
 274 int     mknodat(int, const char *, mode_t, dev_t);
 275 #endif
 276 #if __BSD_VISIBLE
 277 int     chflags(const char *, unsigned long);
 278 int     fchflags(int, unsigned long);
 279 int     lchflags(const char *, unsigned long);
 280 int     chflagsat(int, const char *, unsigned long, int);
 281 int     lchmod(const char *, mode_t);
 282 #endif
 283 __END_DECLS
 284
 285 #endif
 286
 287 #endif /* !_SYS_STAT_H_ */