xref: /original-bsd/sys/sys/stat.h (revision fac0c393)
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  * %sccs.include.redist.c%
11  *
12  *	@(#)stat.h	8.10 (Berkeley) 01/09/95
13  */
14 
15 #ifndef _SYS_STAT_H_
16 #define	_SYS_STAT_H_
17 
18 #include <sys/time.h>
19 
20 #ifndef _POSIX_SOURCE
21 struct ostat {
22 	u_int16_t st_dev;		/* inode's device */
23 	ino_t	  st_ino;		/* inode's number */
24 	mode_t	  st_mode;		/* inode protection mode */
25 	nlink_t	  st_nlink;		/* number of hard links */
26 	u_int16_t st_uid;		/* user ID of the file's owner */
27 	u_int16_t st_gid;		/* group ID of the file's group */
28 	u_int16_t st_rdev;		/* device type */
29 	int32_t	  st_size;		/* file size, in bytes */
30 	struct	timespec st_atimespec;	/* time of last access */
31 	struct	timespec st_mtimespec;	/* time of last data modification */
32 	struct	timespec st_ctimespec;	/* time of last file status change */
33 	int32_t	  st_blksize;		/* optimal blocksize for I/O */
34 	int32_t	  st_blocks;		/* blocks allocated for file */
35 	u_int32_t st_flags;		/* user defined flags for file */
36 	u_int32_t st_gen;		/* file generation number */
37 };
38 #endif /* !_POSIX_SOURCE */
39 
40 struct stat {
41 	dev_t	  st_dev;		/* inode's device */
42 	ino_t	  st_ino;		/* inode's number */
43 	mode_t	  st_mode;		/* inode protection mode */
44 	nlink_t	  st_nlink;		/* number of hard links */
45 	uid_t	  st_uid;		/* user ID of the file's owner */
46 	gid_t	  st_gid;		/* group ID of the file's group */
47 	dev_t	  st_rdev;		/* device type */
48 	struct	timespec st_atimespec;	/* time of last access */
49 	struct	timespec st_mtimespec;	/* time of last data modification */
50 	struct	timespec st_ctimespec;	/* time of last file status change */
51 	off_t	  st_size;		/* file size, in bytes */
52 	int64_t	  st_blocks;		/* blocks allocated for file */
53 	u_int32_t st_blksize;		/* optimal blocksize for I/O */
54 	u_int32_t st_flags;		/* user defined flags for file */
55 	u_int32_t st_gen;		/* file generation number */
56 	int32_t	  st_lspare;
57 	int64_t	  st_qspare[2];
58 };
59 #define st_atime st_atimespec.ts_sec
60 #define st_mtime st_mtimespec.ts_sec
61 #define st_ctime st_ctimespec.ts_sec
62 
63 #define	S_ISUID	0004000			/* set user id on execution */
64 #define	S_ISGID	0002000			/* set group id on execution */
65 #ifndef _POSIX_SOURCE
66 #define	S_ISTXT	0001000			/* sticky bit */
67 #endif
68 
69 #define	S_IRWXU	0000700			/* RWX mask for owner */
70 #define	S_IRUSR	0000400			/* R for owner */
71 #define	S_IWUSR	0000200			/* W for owner */
72 #define	S_IXUSR	0000100			/* X for owner */
73 
74 #ifndef _POSIX_SOURCE
75 #define	S_IREAD		S_IRUSR
76 #define	S_IWRITE	S_IWUSR
77 #define	S_IEXEC		S_IXUSR
78 #endif
79 
80 #define	S_IRWXG	0000070			/* RWX mask for group */
81 #define	S_IRGRP	0000040			/* R for group */
82 #define	S_IWGRP	0000020			/* W for group */
83 #define	S_IXGRP	0000010			/* X for group */
84 
85 #define	S_IRWXO	0000007			/* RWX mask for other */
86 #define	S_IROTH	0000004			/* R for other */
87 #define	S_IWOTH	0000002			/* W for other */
88 #define	S_IXOTH	0000001			/* X for other */
89 
90 #ifndef _POSIX_SOURCE
91 #define	S_IFMT	 0170000		/* type of file mask */
92 #define	S_IFIFO	 0010000		/* named pipe (fifo) */
93 #define	S_IFCHR	 0020000		/* character special */
94 #define	S_IFDIR	 0040000		/* directory */
95 #define	S_IFBLK	 0060000		/* block special */
96 #define	S_IFREG	 0100000		/* regular */
97 #define	S_IFLNK	 0120000		/* symbolic link */
98 #define	S_IFSOCK 0140000		/* socket */
99 #define	S_IFWHT  0160000		/* whiteout */
100 #define	S_ISVTX	 0001000		/* save swapped text even after use */
101 #endif
102 
103 #define	S_ISDIR(m)	((m & 0170000) == 0040000)	/* directory */
104 #define	S_ISCHR(m)	((m & 0170000) == 0020000)	/* char special */
105 #define	S_ISBLK(m)	((m & 0170000) == 0060000)	/* block special */
106 #define	S_ISREG(m)	((m & 0170000) == 0100000)	/* regular file */
107 #define	S_ISFIFO(m)	((m & 0170000) == 0010000 || \
108 			 (m & 0170000) == 0140000)	/* fifo or socket */
109 #ifndef _POSIX_SOURCE
110 #define	S_ISLNK(m)	((m & 0170000) == 0120000)	/* symbolic link */
111 #define	S_ISSOCK(m)	((m & 0170000) == 0010000 || \
112 			 (m & 0170000) == 0140000)	/* fifo or socket */
113 #define	S_ISWHT(m)	((m & 0170000) == 0160000)	/* whiteout */
114 #endif
115 
116 #ifndef _POSIX_SOURCE
117 #define	ACCESSPERMS	(S_IRWXU|S_IRWXG|S_IRWXO)	/* 0777 */
118 							/* 7777 */
119 #define	ALLPERMS	(S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
120 							/* 0666 */
121 #define	DEFFILEMODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
122 
123 #define S_BLKSIZE	512		/* block size used in the stat struct */
124 
125 /*
126  * Definitions of flags stored in file flags word.
127  *
128  * Super-user and owner changeable flags.
129  */
130 #define	UF_SETTABLE	0x0000ffff	/* mask of owner changeable flags */
131 #define	UF_NODUMP	0x00000001	/* do not dump file */
132 #define	UF_IMMUTABLE	0x00000002	/* file may not be changed */
133 #define	UF_APPEND	0x00000004	/* writes to file may only append */
134 #define UF_OPAQUE	0x00000008	/* directory is opaque wrt. union */
135 /*
136  * Super-user changeable flags.
137  */
138 #define	SF_SETTABLE	0xffff0000	/* mask of superuser changeable flags */
139 #define	SF_ARCHIVED	0x00010000	/* file is archived */
140 #define	SF_IMMUTABLE	0x00020000	/* file may not be changed */
141 #define	SF_APPEND	0x00040000	/* writes to file may only append */
142 
143 #ifdef KERNEL
144 /*
145  * Shorthand abbreviations of above.
146  */
147 #define	OPAQUE		(UF_OPAQUE)
148 #define	APPEND		(UF_APPEND | SF_APPEND)
149 #define	IMMUTABLE	(UF_IMMUTABLE | SF_IMMUTABLE)
150 #endif
151 #endif
152 
153 #ifndef KERNEL
154 #include <sys/cdefs.h>
155 
156 __BEGIN_DECLS
157 int	chmod __P((const char *, mode_t));
158 int	fstat __P((int, struct stat *));
159 int	mkdir __P((const char *, mode_t));
160 int	mkfifo __P((const char *, mode_t));
161 int	stat __P((const char *, struct stat *));
162 mode_t	umask __P((mode_t));
163 #ifndef _POSIX_SOURCE
164 int	chflags __P((const char *, u_long));
165 int	fchflags __P((int, u_long));
166 int	fchmod __P((int, mode_t));
167 int	lstat __P((const char *, struct stat *));
168 #endif
169 __END_DECLS
170 #endif
171 #endif /* !_SYS_STAT_H_ */
172