bsd/sys/stat.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  26 /*-
  27  * Copyright (c) 1982, 1986, 1989, 1993
  28  *      The Regents of the University of California.  All rights reserved.
  29  * (c) UNIX System Laboratories, Inc.
  30  * All or some portions of this file are derived from material licensed
  31  * to the University of California by American Telephone and Telegraph
  32  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  33  * the permission of UNIX System Laboratories, Inc.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)stat.h      8.9 (Berkeley) 8/17/94
  64  */
  65
  66
  67 #ifndef _SYS_STAT_H_
  68 #define _SYS_STAT_H_
  69
  70 #include <sys/time.h>
  71
  72 #ifndef _POSIX_SOURCE
  73 struct ostat {
  74         u_int16_t st_dev;               /* inode's device */
  75         ino_t     st_ino;               /* inode's number */
  76         mode_t    st_mode;              /* inode protection mode */
  77         nlink_t   st_nlink;             /* number of hard links */
  78         u_int16_t st_uid;               /* user ID of the file's owner */
  79         u_int16_t st_gid;               /* group ID of the file's group */
  80         u_int16_t st_rdev;              /* device type */
  81         int32_t   st_size;              /* file size, in bytes */
  82         struct  timespec st_atimespec;  /* time of last access */
  83         struct  timespec st_mtimespec;  /* time of last data modification */
  84         struct  timespec st_ctimespec;  /* time of last file status change */
  85         int32_t   st_blksize;           /* optimal blocksize for I/O */
  86         int32_t   st_blocks;            /* blocks allocated for file */
  87         u_int32_t st_flags;             /* user defined flags for file */
  88         u_int32_t st_gen;               /* file generation number */
  89 };
  90 #endif /* !_POSIX_SOURCE */
  91
  92 struct stat {
  93         dev_t     st_dev;               /* inode's device */
  94         ino_t     st_ino;               /* inode's number */
  95         mode_t    st_mode;              /* inode protection mode */
  96         nlink_t   st_nlink;             /* number of hard links */
  97         uid_t     st_uid;               /* user ID of the file's owner */
  98         gid_t     st_gid;               /* group ID of the file's group */
  99         dev_t     st_rdev;              /* device type */
 100 #ifndef _POSIX_SOURCE
 101         struct  timespec st_atimespec;  /* time of last access */
 102         struct  timespec st_mtimespec;  /* time of last data modification */
 103         struct  timespec st_ctimespec;  /* time of last file status change */
 104 #else
 105         time_t    st_atime;             /* time of last access */
 106         long      st_atimensec;         /* nsec of last access */
 107         time_t    st_mtime;             /* time of last data modification */
 108         long      st_mtimensec;         /* nsec of last data modification */
 109         time_t    st_ctime;             /* time of last file status change */
 110         long      st_ctimensec;         /* nsec of last file status change */
 111 #endif
 112         off_t     st_size;              /* file size, in bytes */
 113         int64_t   st_blocks;            /* blocks allocated for file */
 114         u_int32_t st_blksize;           /* optimal blocksize for I/O */
 115         u_int32_t st_flags;             /* user defined flags for file */
 116         u_int32_t st_gen;               /* file generation number */
 117         int32_t   st_lspare;
 118         int64_t   st_qspare[2];
 119 };
 120
 121
 122 #ifndef _POSIX_SOURCE
 123 #define st_atime st_atimespec.tv_sec
 124 #define st_mtime st_mtimespec.tv_sec
 125 #define st_ctime st_ctimespec.tv_sec
 126 #endif
 127
 128 #define S_ISUID 0004000                 /* set user id on execution */
 129 #define S_ISGID 0002000                 /* set group id on execution */
 130 #ifndef _POSIX_SOURCE
 131 #define S_ISTXT 0001000                 /* sticky bit */
 132 #endif
 133
 134 #define S_IRWXU 0000700                 /* RWX mask for owner */
 135 #define S_IRUSR 0000400                 /* R for owner */
 136 #define S_IWUSR 0000200                 /* W for owner */
 137 #define S_IXUSR 0000100                 /* X for owner */
 138
 139 #ifndef _POSIX_SOURCE
 140 #define S_IREAD         S_IRUSR
 141 #define S_IWRITE        S_IWUSR
 142 #define S_IEXEC         S_IXUSR
 143 #endif
 144
 145 #define S_IRWXG 0000070                 /* RWX mask for group */
 146 #define S_IRGRP 0000040                 /* R for group */
 147 #define S_IWGRP 0000020                 /* W for group */
 148 #define S_IXGRP 0000010                 /* X for group */
 149
 150 #define S_IRWXO 0000007                 /* RWX mask for other */
 151 #define S_IROTH 0000004                 /* R for other */
 152 #define S_IWOTH 0000002                 /* W for other */
 153 #define S_IXOTH 0000001                 /* X for other */
 154
 155 #ifndef _POSIX_SOURCE
 156 #define S_IFMT   0170000                /* type of file mask */
 157 #define S_IFIFO  0010000                /* named pipe (fifo) */
 158 #define S_IFCHR  0020000                /* character special */
 159 #define S_IFDIR  0040000                /* directory */
 160 #define S_IFBLK  0060000                /* block special */
 161 #define S_IFREG  0100000                /* regular */
 162 #define S_IFLNK  0120000                /* symbolic link */
 163 #define S_IFSOCK 0140000                /* socket */
 164 #define S_IFWHT  0160000                /* whiteout */
 165 #define S_ISVTX  0001000                /* save swapped text even after use */
 166 #endif
 167
 168 #define S_ISDIR(m)      ((m & 0170000) == 0040000)      /* directory */
 169 #define S_ISCHR(m)      ((m & 0170000) == 0020000)      /* char special */
 170 #define S_ISBLK(m)      ((m & 0170000) == 0060000)      /* block special */
 171 #define S_ISREG(m)      ((m & 0170000) == 0100000)      /* regular file */
 172 #define S_ISFIFO(m)     ((m & 0170000) == 0010000 || \
 173                          (m & 0170000) == 0140000)      /* fifo or socket */
 174 #ifndef _POSIX_SOURCE
 175 #define S_ISLNK(m)      ((m & 0170000) == 0120000)      /* symbolic link */
 176 #define S_ISSOCK(m)     ((m & 0170000) == 0010000 || \
 177                          (m & 0170000) == 0140000)      /* fifo or socket */
 178 #define S_ISWHT(m)      ((m & 0170000) == 0160000)      /* whiteout */
 179 #endif
 180
 181 #ifndef _POSIX_SOURCE
 182 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
 183                                                         /* 7777 */
 184 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
 185                                                         /* 0666 */
 186 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
 187
 188 #define S_BLKSIZE       512             /* block size used in the stat struct */
 189
 190 /*
 191  * Definitions of flags stored in file flags word.
 192  *
 193  * Super-user and owner changeable flags.
 194  */
 195 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
 196 #define UF_NODUMP       0x00000001      /* do not dump file */
 197 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
 198 #define UF_APPEND       0x00000004      /* writes to file may only append */
 199 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
 200 /*
 201  * Super-user changeable flags.
 202  */
 203 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
 204 #define SF_ARCHIVED     0x00010000      /* file is archived */
 205 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
 206 #define SF_APPEND       0x00040000      /* writes to file may only append */
 207
 208 #ifdef KERNEL
 209 /*
 210  * Shorthand abbreviations of above.
 211  */
 212 #define OPAQUE          (UF_OPAQUE)
 213 #define APPEND          (UF_APPEND | SF_APPEND)
 214 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
 215 #endif
 216 #endif
 217
 218 #ifndef KERNEL
 219 #include <sys/cdefs.h>
 220
 221 __BEGIN_DECLS
 222 int     chmod __P((const char *, mode_t));
 223 int     fstat __P((int, struct stat *));
 224 int     mkdir __P((const char *, mode_t));
 225 int     mkfifo __P((const char *, mode_t));
 226 int     stat __P((const char *, struct stat *));
 227 mode_t  umask __P((mode_t));
 228 #ifndef _POSIX_SOURCE
 229 int     chflags __P((const char *, u_long));
 230 int     fchflags __P((int, u_long));
 231 int     fchmod __P((int, mode_t));
 232 int     lstat __P((const char *, struct stat *));
 233 #endif
 234 __END_DECLS
 235 #endif
 236 #endif /* !_SYS_STAT_H_ */