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