FreeBSD/Linux Kernel Cross Reference
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 * 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: src/sys/sys/stat.h,v 1.40 2004/06/17 17:16:52 phk 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 /* XXX missing blkcnt_t, blksize_t. */
45
46 #ifndef _DEV_T_DECLARED
47 typedef __dev_t dev_t;
48 #define _DEV_T_DECLARED
49 #endif
50
51 #ifndef _FFLAGS_T_DECLARED
52 typedef __fflags_t fflags_t;
53 #define _FFLAGS_T_DECLARED
54 #endif
55
56 #ifndef _GID_T_DECLARED
57 typedef __gid_t gid_t;
58 #define _GID_T_DECLARED
59 #endif
60
61 #ifndef _INO_T_DECLARED
62 typedef __ino_t ino_t;
63 #define _INO_T_DECLARED
64 #endif
65
66 #ifndef _MODE_T_DECLARED
67 typedef __mode_t mode_t;
68 #define _MODE_T_DECLARED
69 #endif
70
71 #ifndef _NLINK_T_DECLARED
72 typedef __nlink_t nlink_t;
73 #define _NLINK_T_DECLARED
74 #endif
75
76 #ifndef _OFF_T_DECLARED
77 typedef __off_t off_t;
78 #define _OFF_T_DECLARED
79 #endif
80
81 #ifndef _TIME_T_DECLARED
82 typedef __time_t time_t;
83 #define _TIME_T_DECLARED
84 #endif
85
86 #ifndef _UID_T_DECLARED
87 typedef __uid_t uid_t;
88 #define _UID_T_DECLARED
89 #endif
90
91 #if !defined(_KERNEL) && __BSD_VISIBLE
92 /*
93 * XXX we need this for struct timespec. We get miscellaneous namespace
94 * pollution with it.
95 */
96 #include <sys/time.h>
97 #endif
98
99 #if !__BSD_VISIBLE
100 #include <sys/_timespec.h>
101 #endif
102
103 #if __BSD_VISIBLE
104 struct ostat {
105 __uint16_t st_dev; /* inode's device */
106 ino_t st_ino; /* inode's number */
107 mode_t st_mode; /* inode protection mode */
108 nlink_t st_nlink; /* number of hard links */
109 __uint16_t st_uid; /* user ID of the file's owner */
110 __uint16_t st_gid; /* group ID of the file's group */
111 __uint16_t st_rdev; /* device type */
112 __int32_t st_size; /* file size, in bytes */
113 struct timespec st_atimespec; /* time of last access */
114 struct timespec st_mtimespec; /* time of last data modification */
115 struct timespec st_ctimespec; /* time of last file status change */
116 __int32_t st_blksize; /* optimal blocksize for I/O */
117 __int32_t st_blocks; /* blocks allocated for file */
118 fflags_t st_flags; /* user defined flags for file */
119 __uint32_t st_gen; /* file generation number */
120 };
121 #endif /* __BSD_VISIBLE */
122
123 struct stat {
124 __dev_t st_dev; /* inode's device */
125 ino_t st_ino; /* inode's number */
126 mode_t st_mode; /* inode protection mode */
127 nlink_t st_nlink; /* number of hard links */
128 uid_t st_uid; /* user ID of the file's owner */
129 gid_t st_gid; /* group ID of the file's group */
130 __dev_t st_rdev; /* device type */
131 #if __BSD_VISIBLE
132 struct timespec st_atimespec; /* time of last access */
133 struct timespec st_mtimespec; /* time of last data modification */
134 struct timespec st_ctimespec; /* time of last file status change */
135 #else
136 time_t st_atime; /* time of last access */
137 long st_atimensec; /* nsec of last access */
138 time_t st_mtime; /* time of last data modification */
139 long st_mtimensec; /* nsec of last data modification */
140 time_t st_ctime; /* time of last file status change */
141 long st_ctimensec; /* nsec of last file status change */
142 #endif
143 off_t st_size; /* file size, in bytes */
144 __int64_t st_blocks; /* blocks allocated for file */
145 __uint32_t st_blksize; /* optimal blocksize for I/O */
146 fflags_t st_flags; /* user defined flags for file */
147 __uint32_t st_gen; /* file generation number */
148 __int32_t st_lspare;
149 #if __BSD_VISIBLE
150 struct timespec st_birthtimespec; /* time of file creation */
151 /*
152 * Explicitly pad st_birthtimespec to 16 bytes so that the size of
153 * struct stat is backwards compatible. We use bitfields instead
154 * of an array of chars so that this doesn't require a C99 compiler
155 * to compile if the size of the padding is 0. We use 2 bitfields
156 * to cover up to 64 bits on 32-bit machines. We assume that
157 * CHAR_BIT is 8...
158 */
159 unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
160 unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
161 #else
162 time_t st_birthtime; /* time of file creation */
163 long st_birthtimensec; /* nsec of file creation */
164 unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
165 unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
166 #endif
167 };
168
169 #if __BSD_VISIBLE
170 struct nstat {
171 __dev_t st_dev; /* inode's device */
172 ino_t st_ino; /* inode's number */
173 __uint32_t st_mode; /* inode protection mode */
174 __uint32_t st_nlink; /* number of hard links */
175 uid_t st_uid; /* user ID of the file's owner */
176 gid_t st_gid; /* group ID of the file's group */
177 __dev_t st_rdev; /* device type */
178 struct timespec st_atimespec; /* time of last access */
179 struct timespec st_mtimespec; /* time of last data modification */
180 struct timespec st_ctimespec; /* time of last file status change */
181 off_t st_size; /* file size, in bytes */
182 __int64_t st_blocks; /* blocks allocated for file */
183 __uint32_t st_blksize; /* optimal blocksize for I/O */
184 fflags_t st_flags; /* user defined flags for file */
185 __uint32_t st_gen; /* file generation number */
186 struct timespec st_birthtimespec; /* time of file creation */
187 /*
188 * See above about the following padding.
189 */
190 unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
191 unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
192 };
193 #endif
194
195 #if __BSD_VISIBLE
196 #define st_atime st_atimespec.tv_sec
197 #define st_mtime st_mtimespec.tv_sec
198 #define st_ctime st_ctimespec.tv_sec
199 #define st_birthtime st_birthtimespec.tv_sec
200 #endif
201
202 #define S_ISUID 0004000 /* set user id on execution */
203 #define S_ISGID 0002000 /* set group id on execution */
204 #if __BSD_VISIBLE
205 #define S_ISTXT 0001000 /* sticky bit */
206 #endif
207
208 #define S_IRWXU 0000700 /* RWX mask for owner */
209 #define S_IRUSR 0000400 /* R for owner */
210 #define S_IWUSR 0000200 /* W for owner */
211 #define S_IXUSR 0000100 /* X for owner */
212
213 #if __BSD_VISIBLE
214 #define S_IREAD S_IRUSR
215 #define S_IWRITE S_IWUSR
216 #define S_IEXEC S_IXUSR
217 #endif
218
219 #define S_IRWXG 0000070 /* RWX mask for group */
220 #define S_IRGRP 0000040 /* R for group */
221 #define S_IWGRP 0000020 /* W for group */
222 #define S_IXGRP 0000010 /* X for group */
223
224 #define S_IRWXO 0000007 /* RWX mask for other */
225 #define S_IROTH 0000004 /* R for other */
226 #define S_IWOTH 0000002 /* W for other */
227 #define S_IXOTH 0000001 /* X for other */
228
229 #if __XSI_VISIBLE
230 #define S_IFMT 0170000 /* type of file mask */
231 #define S_IFIFO 0010000 /* named pipe (fifo) */
232 #define S_IFCHR 0020000 /* character special */
233 #define S_IFDIR 0040000 /* directory */
234 #define S_IFBLK 0060000 /* block special */
235 #define S_IFREG 0100000 /* regular */
236 #define S_IFLNK 0120000 /* symbolic link */
237 #define S_IFSOCK 0140000 /* socket */
238 #define S_ISVTX 0001000 /* save swapped text even after use */
239 #endif
240 #if __BSD_VISIBLE
241 #define S_IFWHT 0160000 /* whiteout */
242 #endif
243
244 #define S_ISDIR(m) (((m) & 0170000) == 0040000) /* directory */
245 #define S_ISCHR(m) (((m) & 0170000) == 0020000) /* char special */
246 #define S_ISBLK(m) (((m) & 0170000) == 0060000) /* block special */
247 #define S_ISREG(m) (((m) & 0170000) == 0100000) /* regular file */
248 #define S_ISFIFO(m) (((m) & 0170000) == 0010000) /* fifo or socket */
249 #if __POSIX_VISIBLE >= 200112
250 #define S_ISLNK(m) (((m) & 0170000) == 0120000) /* symbolic link */
251 #define S_ISSOCK(m) (((m) & 0170000) == 0140000) /* socket */
252 #endif
253 #if __XSI_VISIBLE
254 #define S_ISWHT(m) (((m) & 0170000) == 0160000) /* whiteout */
255 #endif
256
257 #if __BSD_VISIBLE
258 #define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
259 /* 7777 */
260 #define ALLPERMS (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
261 /* 0666 */
262 #define DEFFILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
263
264 #define S_BLKSIZE 512 /* block size used in the stat struct */
265
266 /*
267 * Definitions of flags stored in file flags word.
268 *
269 * Super-user and owner changeable flags.
270 */
271 #define UF_SETTABLE 0x0000ffff /* mask of owner changeable flags */
272 #define UF_NODUMP 0x00000001 /* do not dump file */
273 #define UF_IMMUTABLE 0x00000002 /* file may not be changed */
274 #define UF_APPEND 0x00000004 /* writes to file may only append */
275 #define UF_OPAQUE 0x00000008 /* directory is opaque wrt. union */
276 #define UF_NOUNLINK 0x00000010 /* file may not be removed or renamed */
277 /*
278 * Super-user changeable flags.
279 */
280 #define SF_SETTABLE 0xffff0000 /* mask of superuser changeable flags */
281 #define SF_ARCHIVED 0x00010000 /* file is archived */
282 #define SF_IMMUTABLE 0x00020000 /* file may not be changed */
283 #define SF_APPEND 0x00040000 /* writes to file may only append */
284 #define SF_NOUNLINK 0x00100000 /* file may not be removed or renamed */
285 #define SF_SNAPSHOT 0x00200000 /* snapshot inode */
286
287 #ifdef _KERNEL
288 /*
289 * Shorthand abbreviations of above.
290 */
291 #define OPAQUE (UF_OPAQUE)
292 #define APPEND (UF_APPEND | SF_APPEND)
293 #define IMMUTABLE (UF_IMMUTABLE | SF_IMMUTABLE)
294 #define NOUNLINK (UF_NOUNLINK | SF_NOUNLINK)
295 #endif
296
297 #endif /* __BSD_VISIBLE */
298
299 #ifndef _KERNEL
300 __BEGIN_DECLS
301 #if __BSD_VISIBLE
302 int chflags(const char *, unsigned long);
303 #endif
304 int chmod(const char *, mode_t);
305 #if __BSD_VISIBLE
306 int fchflags(int, unsigned long);
307 int fchmod(int, mode_t);
308 #endif
309 int fstat(int, struct stat *);
310 #if __BSD_VISIBLE
311 int lchflags(const char *, int);
312 int lchmod(const char *, mode_t);
313 #endif
314 #if __POSIX_VISIBLE >= 200112
315 int lstat(const char *, struct stat *);
316 #endif
317 int mkdir(const char *, mode_t);
318 int mkfifo(const char *, mode_t);
319 int stat(const char *, struct stat *);
320 mode_t umask(mode_t);
321 __END_DECLS
322 #endif /* !_KERNEL */
323
324 #endif /* !_SYS_STAT_H_ */
Cache object: 1ba2c6d0bf7ac4ed9244f97df721b3d3
|