The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/stat.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: bdb59146338f5bb78dcd4283ddf102e2


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.