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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-3-Clause
    3  *
    4  * Copyright (c) 1982, 1986, 1989, 1993
    5  *      The Regents of the University of California.  All rights reserved.
    6  * (c) UNIX System Laboratories, Inc.
    7  * All or some portions of this file are derived from material licensed
    8  * to the University of California by American Telephone and Telegraph
    9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   10  * the permission of UNIX System Laboratories, Inc.
   11  *
   12  * Redistribution and use in source and binary forms, with or without
   13  * modification, are permitted provided that the following conditions
   14  * are met:
   15  * 1. Redistributions of source code must retain the above copyright
   16  *    notice, this list of conditions and the following disclaimer.
   17  * 2. Redistributions in binary form must reproduce the above copyright
   18  *    notice, this list of conditions and the following disclaimer in the
   19  *    documentation and/or other materials provided with the distribution.
   20  * 3. Neither the name of the University nor the names of its contributors
   21  *    may be used to endorse or promote products derived from this software
   22  *    without specific prior written permission.
   23  *
   24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   34  * SUCH DAMAGE.
   35  *
   36  *      @(#)stat.h      8.12 (Berkeley) 6/16/95
   37  * $FreeBSD: head/sys/sys/stat.h 345280 2019-03-18 19:23:19Z emaste $
   38  */
   39 
   40 #ifndef _SYS_STAT_H_
   41 #define _SYS_STAT_H_
   42 
   43 #include <sys/cdefs.h>
   44 #include <sys/_timespec.h>
   45 #include <sys/_types.h>
   46 
   47 #ifndef _BLKSIZE_T_DECLARED
   48 typedef __blksize_t     blksize_t;
   49 #define _BLKSIZE_T_DECLARED
   50 #endif
   51 
   52 #ifndef _BLKCNT_T_DECLARED
   53 typedef __blkcnt_t      blkcnt_t;
   54 #define _BLKCNT_T_DECLARED
   55 #endif
   56 
   57 #ifndef _DEV_T_DECLARED
   58 typedef __dev_t         dev_t;
   59 #define _DEV_T_DECLARED
   60 #endif
   61 
   62 #ifndef _FFLAGS_T_DECLARED
   63 typedef __fflags_t      fflags_t;
   64 #define _FFLAGS_T_DECLARED
   65 #endif
   66 
   67 #ifndef _GID_T_DECLARED
   68 typedef __gid_t         gid_t;
   69 #define _GID_T_DECLARED
   70 #endif
   71 
   72 #ifndef _INO_T_DECLARED
   73 typedef __ino_t         ino_t;
   74 #define _INO_T_DECLARED
   75 #endif
   76 
   77 #ifndef _MODE_T_DECLARED
   78 typedef __mode_t        mode_t;
   79 #define _MODE_T_DECLARED
   80 #endif
   81 
   82 #ifndef _NLINK_T_DECLARED
   83 typedef __nlink_t       nlink_t;
   84 #define _NLINK_T_DECLARED
   85 #endif
   86 
   87 #ifndef _OFF_T_DECLARED
   88 typedef __off_t         off_t;
   89 #define _OFF_T_DECLARED
   90 #endif
   91 
   92 #ifndef _UID_T_DECLARED
   93 typedef __uid_t         uid_t;
   94 #define _UID_T_DECLARED
   95 #endif
   96 
   97 #if !defined(_KERNEL) && __BSD_VISIBLE
   98 /*
   99  * XXX We get miscellaneous namespace pollution with this.
  100  */
  101 #include <sys/time.h>
  102 #endif
  103 
  104 #ifdef _KERNEL
  105 struct ostat {
  106         __uint16_t st_dev;              /* inode's device */
  107         __uint32_t st_ino;              /* inode's number */
  108         mode_t    st_mode;              /* inode protection mode */
  109         __uint16_t st_nlink;            /* number of hard links */
  110         __uint16_t st_uid;              /* user ID of the file's owner */
  111         __uint16_t st_gid;              /* group ID of the file's group */
  112         __uint16_t st_rdev;             /* device type */
  113         __int32_t st_size;              /* file size, in bytes */
  114         struct  timespec st_atim;       /* time of last access */
  115         struct  timespec st_mtim;       /* time of last data modification */
  116         struct  timespec st_ctim;       /* time of last file status change */
  117         __int32_t st_blksize;           /* optimal blocksize for I/O */
  118         __int32_t st_blocks;            /* blocks allocated for file */
  119         fflags_t  st_flags;             /* user defined flags for file */
  120         __uint32_t st_gen;              /* file generation number */
  121 };
  122 #endif
  123 
  124 #if defined(_WANT_FREEBSD11_STAT) || defined(_KERNEL)
  125 struct freebsd11_stat {
  126         __uint32_t st_dev;              /* inode's device */
  127         __uint32_t st_ino;              /* inode's number */
  128         mode_t    st_mode;              /* inode protection mode */
  129         __uint16_t st_nlink;            /* number of hard links */
  130         uid_t     st_uid;               /* user ID of the file's owner */
  131         gid_t     st_gid;               /* group ID of the file's group */
  132         __uint32_t st_rdev;             /* device type */
  133         struct  timespec st_atim;       /* time of last access */
  134         struct  timespec st_mtim;       /* time of last data modification */
  135         struct  timespec st_ctim;       /* time of last file status change */
  136         off_t     st_size;              /* file size, in bytes */
  137         blkcnt_t st_blocks;             /* blocks allocated for file */
  138         blksize_t st_blksize;           /* optimal blocksize for I/O */
  139         fflags_t  st_flags;             /* user defined flags for file */
  140         __uint32_t st_gen;              /* file generation number */
  141         __int32_t st_lspare;
  142         struct timespec st_birthtim;    /* time of file creation */
  143         /*
  144          * Explicitly pad st_birthtim to 16 bytes so that the size of
  145          * struct stat is backwards compatible.  We use bitfields instead
  146          * of an array of chars so that this doesn't require a C99 compiler
  147          * to compile if the size of the padding is 0.  We use 2 bitfields
  148          * to cover up to 64 bits on 32-bit machines.  We assume that
  149          * CHAR_BIT is 8...
  150          */
  151         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
  152         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
  153 };
  154 #endif /* _WANT_FREEBSD11_STAT || _KERNEL */
  155 
  156 #if defined(__i386__)
  157 #define __STAT_TIME_T_EXT       1
  158 #endif
  159 
  160 struct stat {
  161         dev_t     st_dev;               /* inode's device */
  162         ino_t     st_ino;               /* inode's number */
  163         nlink_t   st_nlink;             /* number of hard links */
  164         mode_t    st_mode;              /* inode protection mode */
  165         __int16_t st_padding0;
  166         uid_t     st_uid;               /* user ID of the file's owner */
  167         gid_t     st_gid;               /* group ID of the file's group */
  168         __int32_t st_padding1;
  169         dev_t     st_rdev;              /* device type */
  170 #ifdef  __STAT_TIME_T_EXT
  171         __int32_t st_atim_ext;
  172 #endif
  173         struct  timespec st_atim;       /* time of last access */
  174 #ifdef  __STAT_TIME_T_EXT
  175         __int32_t st_mtim_ext;
  176 #endif
  177         struct  timespec st_mtim;       /* time of last data modification */
  178 #ifdef  __STAT_TIME_T_EXT
  179         __int32_t st_ctim_ext;
  180 #endif
  181         struct  timespec st_ctim;       /* time of last file status change */
  182 #ifdef  __STAT_TIME_T_EXT
  183         __int32_t st_btim_ext;
  184 #endif
  185         struct  timespec st_birthtim;   /* time of file creation */
  186         off_t     st_size;              /* file size, in bytes */
  187         blkcnt_t st_blocks;             /* blocks allocated for file */
  188         blksize_t st_blksize;           /* optimal blocksize for I/O */
  189         fflags_t  st_flags;             /* user defined flags for file */
  190         __uint64_t st_gen;              /* file generation number */
  191         __uint64_t st_spare[10];
  192 };
  193 
  194 #ifdef _KERNEL
  195 struct nstat {
  196         __uint32_t st_dev;              /* inode's device */
  197         __uint32_t st_ino;              /* inode's number */
  198         __uint32_t st_mode;             /* inode protection mode */
  199         __uint32_t st_nlink;            /* number of hard links */
  200         uid_t     st_uid;               /* user ID of the file's owner */
  201         gid_t     st_gid;               /* group ID of the file's group */
  202         __uint32_t st_rdev;             /* device type */
  203         struct  timespec st_atim;       /* time of last access */
  204         struct  timespec st_mtim;       /* time of last data modification */
  205         struct  timespec st_ctim;       /* time of last file status change */
  206         off_t     st_size;              /* file size, in bytes */
  207         blkcnt_t st_blocks;             /* blocks allocated for file */
  208         blksize_t st_blksize;           /* optimal blocksize for I/O */
  209         fflags_t  st_flags;             /* user defined flags for file */
  210         __uint32_t st_gen;              /* file generation number */
  211         struct timespec st_birthtim;    /* time of file creation */
  212         /*
  213          * See comment in the definition of struct freebsd11_stat
  214          * above about the following padding.
  215          */
  216         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
  217         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
  218 };
  219 #endif
  220 
  221 #ifndef _KERNEL
  222 #define st_atime                st_atim.tv_sec
  223 #define st_mtime                st_mtim.tv_sec
  224 #define st_ctime                st_ctim.tv_sec
  225 #if __BSD_VISIBLE
  226 #define st_birthtime            st_birthtim.tv_sec
  227 #define st_atimensec            st_atim.tv_nsec
  228 #define st_mtimensec            st_mtim.tv_nsec
  229 #define st_ctimensec            st_ctim.tv_nsec
  230 #define st_birthtimensec        st_birthtim.tv_nsec
  231 #endif
  232 
  233 /* For compatibility. */
  234 #if __BSD_VISIBLE
  235 #define st_atimespec            st_atim
  236 #define st_mtimespec            st_mtim
  237 #define st_ctimespec            st_ctim
  238 #define st_birthtimespec        st_birthtim
  239 #endif
  240 #endif /* !_KERNEL */
  241 
  242 #define S_ISUID 0004000                 /* set user id on execution */
  243 #define S_ISGID 0002000                 /* set group id on execution */
  244 #if __BSD_VISIBLE
  245 #define S_ISTXT 0001000                 /* sticky bit */
  246 #endif
  247 
  248 #define S_IRWXU 0000700                 /* RWX mask for owner */
  249 #define S_IRUSR 0000400                 /* R for owner */
  250 #define S_IWUSR 0000200                 /* W for owner */
  251 #define S_IXUSR 0000100                 /* X for owner */
  252 
  253 #if __BSD_VISIBLE
  254 #define S_IREAD         S_IRUSR
  255 #define S_IWRITE        S_IWUSR
  256 #define S_IEXEC         S_IXUSR
  257 #endif
  258 
  259 #define S_IRWXG 0000070                 /* RWX mask for group */
  260 #define S_IRGRP 0000040                 /* R for group */
  261 #define S_IWGRP 0000020                 /* W for group */
  262 #define S_IXGRP 0000010                 /* X for group */
  263 
  264 #define S_IRWXO 0000007                 /* RWX mask for other */
  265 #define S_IROTH 0000004                 /* R for other */
  266 #define S_IWOTH 0000002                 /* W for other */
  267 #define S_IXOTH 0000001                 /* X for other */
  268 
  269 #if __XSI_VISIBLE
  270 #define S_IFMT   0170000                /* type of file mask */
  271 #define S_IFIFO  0010000                /* named pipe (fifo) */
  272 #define S_IFCHR  0020000                /* character special */
  273 #define S_IFDIR  0040000                /* directory */
  274 #define S_IFBLK  0060000                /* block special */
  275 #define S_IFREG  0100000                /* regular */
  276 #define S_IFLNK  0120000                /* symbolic link */
  277 #define S_IFSOCK 0140000                /* socket */
  278 #define S_ISVTX  0001000                /* save swapped text even after use */
  279 #endif
  280 #if __BSD_VISIBLE
  281 #define S_IFWHT  0160000                /* whiteout */
  282 #endif
  283 
  284 #define S_ISDIR(m)      (((m) & 0170000) == 0040000)    /* directory */
  285 #define S_ISCHR(m)      (((m) & 0170000) == 0020000)    /* char special */
  286 #define S_ISBLK(m)      (((m) & 0170000) == 0060000)    /* block special */
  287 #define S_ISREG(m)      (((m) & 0170000) == 0100000)    /* regular file */
  288 #define S_ISFIFO(m)     (((m) & 0170000) == 0010000)    /* fifo or socket */
  289 #if __POSIX_VISIBLE >= 200112
  290 #define S_ISLNK(m)      (((m) & 0170000) == 0120000)    /* symbolic link */
  291 #define S_ISSOCK(m)     (((m) & 0170000) == 0140000)    /* socket */
  292 #endif
  293 #if __BSD_VISIBLE
  294 #define S_ISWHT(m)      (((m) & 0170000) == 0160000)    /* whiteout */
  295 #endif
  296 
  297 #if __BSD_VISIBLE
  298 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
  299                                                         /* 7777 */
  300 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
  301                                                         /* 0666 */
  302 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
  303 
  304 #define S_BLKSIZE       512             /* block size used in the stat struct */
  305 
  306 /*
  307  * Definitions of flags stored in file flags word.
  308  *
  309  * Super-user and owner changeable flags.
  310  */
  311 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
  312 #define UF_NODUMP       0x00000001      /* do not dump file */
  313 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
  314 #define UF_APPEND       0x00000004      /* writes to file may only append */
  315 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
  316 #define UF_NOUNLINK     0x00000010      /* file may not be removed or renamed */
  317 /*
  318  * These two bits are defined in MacOS X.  They are not currently used in
  319  * FreeBSD.
  320  */
  321 #if 0
  322 #define UF_COMPRESSED   0x00000020      /* file is compressed */
  323 #define UF_TRACKED      0x00000040      /* renames and deletes are tracked */
  324 #endif
  325 
  326 #define UF_SYSTEM       0x00000080      /* Windows system file bit */
  327 #define UF_SPARSE       0x00000100      /* sparse file */
  328 #define UF_OFFLINE      0x00000200      /* file is offline */
  329 #define UF_REPARSE      0x00000400      /* Windows reparse point file bit */
  330 #define UF_ARCHIVE      0x00000800      /* file needs to be archived */
  331 #define UF_READONLY     0x00001000      /* Windows readonly file bit */
  332 /* This is the same as the MacOS X definition of UF_HIDDEN. */
  333 #define UF_HIDDEN       0x00008000      /* file is hidden */
  334 
  335 /*
  336  * Super-user changeable flags.
  337  */
  338 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
  339 #define SF_ARCHIVED     0x00010000      /* file is archived */
  340 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
  341 #define SF_APPEND       0x00040000      /* writes to file may only append */
  342 #define SF_NOUNLINK     0x00100000      /* file may not be removed or renamed */
  343 #define SF_SNAPSHOT     0x00200000      /* snapshot inode */
  344 
  345 #ifdef _KERNEL
  346 /*
  347  * Shorthand abbreviations of above.
  348  */
  349 #define OPAQUE          (UF_OPAQUE)
  350 #define APPEND          (UF_APPEND | SF_APPEND)
  351 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
  352 #define NOUNLINK        (UF_NOUNLINK | SF_NOUNLINK)
  353 #endif
  354 
  355 #endif /* __BSD_VISIBLE */
  356 
  357 #if __POSIX_VISIBLE >= 200809
  358 #define UTIME_NOW       -1
  359 #define UTIME_OMIT      -2
  360 #endif
  361 
  362 #ifndef _KERNEL
  363 __BEGIN_DECLS
  364 #if __BSD_VISIBLE
  365 int     chflags(const char *, unsigned long);
  366 int     chflagsat(int, const char *, unsigned long, int);
  367 #endif
  368 int     chmod(const char *, mode_t);
  369 #if __BSD_VISIBLE
  370 int     fchflags(int, unsigned long);
  371 #endif
  372 #if __POSIX_VISIBLE >= 200112
  373 int     fchmod(int, mode_t);
  374 #endif
  375 #if __POSIX_VISIBLE >= 200809
  376 int     fchmodat(int, const char *, mode_t, int);
  377 int     futimens(int fd, const struct timespec times[2]);
  378 int     utimensat(int fd, const char *path, const struct timespec times[2],
  379                 int flag);
  380 #endif
  381 int     fstat(int, struct stat *);
  382 #if __BSD_VISIBLE
  383 int     lchflags(const char *, unsigned long);
  384 int     lchmod(const char *, mode_t);
  385 #endif
  386 #if __POSIX_VISIBLE >= 200112
  387 int     lstat(const char * __restrict, struct stat * __restrict);
  388 #endif
  389 int     mkdir(const char *, mode_t);
  390 int     mkfifo(const char *, mode_t);
  391 #if !defined(_MKNOD_DECLARED) && __XSI_VISIBLE
  392 int     mknod(const char *, mode_t, dev_t);
  393 #define _MKNOD_DECLARED
  394 #endif
  395 int     stat(const char * __restrict, struct stat * __restrict);
  396 mode_t  umask(mode_t);
  397 #if __POSIX_VISIBLE >= 200809
  398 int     fstatat(int, const char *, struct stat *, int);
  399 int     mkdirat(int, const char *, mode_t);
  400 int     mkfifoat(int, const char *, mode_t);
  401 #endif
  402 #if __XSI_VISIBLE >= 700
  403 int     mknodat(int, const char *, mode_t, dev_t);
  404 #endif
  405 __END_DECLS
  406 #endif /* !_KERNEL */
  407 
  408 #endif /* !_SYS_STAT_H_ */

Cache object: eeb37383da8f5739c5ff6b6d37e28b86


[ 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.