xref: /dragonfly/sys/sys/stat.h (revision dca3c15d)
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  * 3. 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.20 1999/12/29 04:24:47 peter Exp $
36  * $DragonFly: src/sys/sys/stat.h,v 1.14 2008/11/11 00:55:49 pavalos Exp $
37  */
38 
39 #ifndef _SYS_STAT_H_
40 #define	_SYS_STAT_H_
41 
42 #if !defined(_POSIX_SOURCE)
43 /*
44  * XXX we need this for struct timespec.  We get miscellaneous namespace
45  * pollution with it.
46  */
47 #ifndef _SYS_TIME_H_
48 #include <sys/time.h>
49 #endif
50 #else	/* !_POSIX_SOURCE */
51 #include <sys/_timespec.h>
52 #endif	/* _POSIX_SOURCE */
53 
54 #ifdef _KERNEL
55 #define __dev_t	udev_t
56 #else
57 #define __dev_t	dev_t
58 #endif
59 
60 /*
61  * stat structure notes:
62  *
63  * (1) st_fsmid (DragonFly only).  This is a DragonFly supported field that
64  *     is incremented if the represented file or directory changes or, for
65  *     directories, if any change is made within the directory or any sub-
66  *     directory, recursively.
67  */
68 struct stat {
69 	ino_t	  st_ino;		/* inode's number */
70 	nlink_t	  st_nlink;		/* number of hard links */
71 	__dev_t	  st_dev;		/* inode's device */
72 	mode_t	  st_mode;		/* inode protection mode */
73 	uint16_t  st_padding1;
74 	uid_t	  st_uid;		/* user ID of the file's owner */
75 	gid_t	  st_gid;		/* group ID of the file's group */
76 	__dev_t	  st_rdev;		/* device type */
77 	struct	timespec st_atim;	/* time of last access */
78 	struct	timespec st_mtim;	/* time of last data modification */
79 	struct	timespec st_ctim;	/* time of last file status change */
80 	off_t	  st_size;		/* file size, in bytes */
81 	int64_t	  st_blocks;		/* blocks allocated for file */
82 	u_int32_t st_blksize;		/* optimal blocksize for I/O */
83 	u_int32_t st_flags;		/* user defined flags for file */
84 	u_int32_t st_gen;		/* file generation number */
85 	int32_t	  st_lspare;
86 	int64_t   st_fsmid;		/* recursive change detect */
87 	int64_t	  st_qspare;
88 };
89 
90 #define _ST_FSMID_PRESENT_
91 #define _ST_FLAGS_PRESENT_
92 
93 #undef __dev_t
94 
95 #define st_atime st_atim.tv_sec
96 #define st_mtime st_mtim.tv_sec
97 #define st_ctime st_ctim.tv_sec
98 
99 /* BSD compatibility */
100 #ifndef _POSIX_SOURCE
101 #define st_atimespec st_atim
102 #define st_mtimespec st_mtim
103 #define st_ctimespec st_ctim
104 #endif
105 
106 #define	S_ISUID	0004000			/* set user id on execution */
107 #define	S_ISGID	0002000			/* set group id on execution */
108 #ifndef _POSIX_SOURCE
109 #define	S_ISTXT	0001000			/* sticky bit */
110 #endif
111 
112 #define	S_IRWXU	0000700			/* RWX mask for owner */
113 #define	S_IRUSR	0000400			/* R for owner */
114 #define	S_IWUSR	0000200			/* W for owner */
115 #define	S_IXUSR	0000100			/* X for owner */
116 
117 #ifndef _POSIX_SOURCE
118 #define	S_IREAD		S_IRUSR
119 #define	S_IWRITE	S_IWUSR
120 #define	S_IEXEC		S_IXUSR
121 #endif
122 
123 #define	S_IRWXG	0000070			/* RWX mask for group */
124 #define	S_IRGRP	0000040			/* R for group */
125 #define	S_IWGRP	0000020			/* W for group */
126 #define	S_IXGRP	0000010			/* X for group */
127 
128 #define	S_IRWXO	0000007			/* RWX mask for other */
129 #define	S_IROTH	0000004			/* R for other */
130 #define	S_IWOTH	0000002			/* W for other */
131 #define	S_IXOTH	0000001			/* X for other */
132 
133 #ifndef _POSIX_SOURCE
134 #define	S_IFMT	 0170000		/* type of file mask */
135 #define	S_IFIFO	 0010000		/* named pipe (fifo) */
136 #define	S_IFCHR	 0020000		/* character special */
137 #define	S_IFDIR	 0040000		/* directory */
138 #define	S_IFBLK	 0060000		/* block special */
139 #define	S_IFREG	 0100000		/* regular */
140 #define	S_IFDB	 0110000		/* record access file */
141 #define	S_IFLNK	 0120000		/* symbolic link */
142 #define	S_IFSOCK 0140000		/* socket */
143 #define	S_IFWHT  0160000		/* whiteout */
144 #define	S_ISVTX	 0001000		/* save swapped text even after use */
145 #endif
146 
147 #define	S_ISDIR(m)	(((m) & 0170000) == 0040000)	/* directory */
148 #define	S_ISCHR(m)	(((m) & 0170000) == 0020000)	/* char special */
149 #define	S_ISBLK(m)	(((m) & 0170000) == 0060000)	/* block special */
150 #define	S_ISREG(m)	(((m) & 0170000) == 0100000)	/* regular file */
151 #define	S_ISDB(m)	(((m) & 0170000) == 0110000)	/* record access file */
152 #define	S_ISFIFO(m)	(((m) & 0170000) == 0010000)	/* fifo or socket */
153 #ifndef _POSIX_SOURCE
154 #define	S_ISLNK(m)	(((m) & 0170000) == 0120000)	/* symbolic link */
155 #define	S_ISSOCK(m)	(((m) & 0170000) == 0140000)	/* socket */
156 #define	S_ISWHT(m)	(((m) & 0170000) == 0160000)	/* whiteout */
157 #endif
158 
159 #ifndef _POSIX_SOURCE
160 #define	ACCESSPERMS	(S_IRWXU|S_IRWXG|S_IRWXO)	/* 0777 */
161 							/* 7777 */
162 #define	ALLPERMS	(S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
163 							/* 0666 */
164 #define	DEFFILEMODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
165 
166 #define S_BLKSIZE	512		/* block size used in the stat struct */
167 
168 /*
169  * Definitions of flags stored in file flags word.
170  *
171  * Super-user and owner changeable flags.
172  */
173 #define	UF_SETTABLE	0x0000ffff	/* mask of owner changeable flags */
174 #define	UF_NODUMP	0x00000001	/* do not dump file */
175 #define	UF_IMMUTABLE	0x00000002	/* file may not be changed */
176 #define	UF_APPEND	0x00000004	/* writes to file may only append */
177 #define UF_OPAQUE	0x00000008	/* directory is opaque wrt. union */
178 #define UF_NOUNLINK	0x00000010	/* file may not be removed or renamed */
179 #define UF_FBSDRSVD20	0x00000020	/* (unused) */
180 #define UF_NOHISTORY	0x00000040	/* do not retain history/snapshots */
181 /*
182  * Super-user changeable flags.
183  */
184 #define	SF_SETTABLE	0xffff0000	/* mask of superuser changeable flags */
185 #define	SF_ARCHIVED	0x00010000	/* file is archived */
186 #define	SF_IMMUTABLE	0x00020000	/* file may not be changed */
187 #define	SF_APPEND	0x00040000	/* writes to file may only append */
188 #define	SF_NOUNLINK	0x00100000	/* file may not be removed or renamed */
189 #define SF_FBSDRSVD20	0x00200000	/* (used by FreeBSD for snapshots) */
190 #define SF_NOHISTORY	0x00400000	/* do not retain history/snapshots */
191 
192 #ifdef _KERNEL
193 /*
194  * Shorthand abbreviations of above.
195  */
196 #define	OPAQUE		(UF_OPAQUE)
197 #define	APPEND		(UF_APPEND | SF_APPEND)
198 #define	IMMUTABLE	(UF_IMMUTABLE | SF_IMMUTABLE)
199 #define	NOUNLINK	(UF_NOUNLINK | SF_NOUNLINK)
200 #endif
201 
202 #endif /* !_POSIX_SOURCE */
203 
204 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
205 #include <sys/cdefs.h>
206 
207 __BEGIN_DECLS
208 int	chmod (const char *, mode_t);
209 int	fchmodat (int, const char *, mode_t, int);
210 int	fstat (int, struct stat *);
211 int	fstatat (int, const char *, struct stat *, int);
212 int	mkdir (const char *, mode_t);
213 int	mkfifo (const char *, mode_t);
214 #if !defined(_MKNOD_DECLARED) && __XSI_VISIBLE
215 int	mknod(const char *, mode_t, dev_t);
216 #define	_MKNOD_DECLARED
217 #endif
218 int	stat (const char *, struct stat *);
219 mode_t	umask (mode_t);
220 
221 #ifndef _POSIX_SOURCE
222 int	chflags (const char *, u_long);
223 int	fchflags (int, u_long);
224 int	lchflags (const char *, u_long);
225 int	fchmod (int, mode_t);
226 int	lchmod (const char *, mode_t);
227 int	lstat (const char *, struct stat *);
228 #endif
229 __END_DECLS
230 
231 #endif
232 
233 #endif /* !_SYS_STAT_H_ */
234