d57b8d6ee81403a2ca672e37fab6a8e1ca7d385a
[kopensolaris-gnu/glibc.git] / io / sys / stat.h
1 /* Copyright (C) 1991, 1992, 1995, 1996, 1997 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      POSIX Standard: 5.6 File Characteristics        <sys/stat.h>
21  */
22
23 #ifndef _SYS_STAT_H
24 #define _SYS_STAT_H     1
25
26 #include <features.h>
27
28 #include <bits/types.h>         /* For __mode_t and __dev_t.  */
29
30 __BEGIN_DECLS
31
32 #include <bits/stat.h>
33
34 #if defined __USE_BSD || defined __USE_MISC
35 # define S_IFMT         __S_IFMT
36 # define S_IFDIR        __S_IFDIR
37 # define S_IFCHR        __S_IFCHR
38 # define S_IFBLK        __S_IFBLK
39 # define S_IFREG        __S_IFREG
40 # ifdef __S_IFLNK
41 #  define S_IFLNK       __S_IFLNK
42 # endif
43 # ifdef __S_IFSOCK
44 #  define S_IFSOCK      __S_IFSOCK
45 # endif
46 # ifdef __S_IFIFO
47 #  define S_IFIFO       __S_IFIFO
48 # endif
49 #endif
50
51 /* Test macros for file types.  */
52
53 #define __S_ISTYPE(mode, mask)  (((mode) & __S_IFMT) == (mask))
54
55 #define S_ISDIR(mode)    __S_ISTYPE((mode), __S_IFDIR)
56 #define S_ISCHR(mode)    __S_ISTYPE((mode), __S_IFCHR)
57 #define S_ISBLK(mode)    __S_ISTYPE((mode), __S_IFBLK)
58 #define S_ISREG(mode)    __S_ISTYPE((mode), __S_IFREG)
59 #ifdef __S_IFIFO
60 # define S_ISFIFO(mode)  __S_ISTYPE((mode), __S_IFIFO)
61 #endif
62
63 #ifdef  __USE_BSD
64 # ifdef __S_IFLNK
65 #  define S_ISLNK(mode)  __S_ISTYPE((mode), __S_IFLNK)
66 # else
67 #  define S_ISLNK(mode)  0
68 # endif
69 # ifdef __S_IFSOCK
70 #  define S_ISSOCK(mode) __S_ISTYPE((mode), __S_IFSOCK)
71 # endif
72 #endif
73
74
75 /* Protection bits.  */
76
77 #define S_ISUID __S_ISUID       /* Set user ID on execution.  */
78 #define S_ISGID __S_ISGID       /* Set group ID on execution.  */
79
80 #if defined __USE_BSD || defined __USE_MISC
81 /* Save swapped text after use (sticky bit).  This is pretty well obsolete.  */
82 # define S_ISVTX        __S_ISVTX
83 #endif
84
85 #define S_IRUSR __S_IREAD       /* Read by owner.  */
86 #define S_IWUSR __S_IWRITE      /* Write by owner.  */
87 #define S_IXUSR __S_IEXEC       /* Execute by owner.  */
88 /* Read, write, and execute by owner.  */
89 #define S_IRWXU (__S_IREAD|__S_IWRITE|__S_IEXEC)
90
91 #if defined __USE_MISC && defined __USE_BSD
92 # define S_IREAD                S_IRUSR
93 # define S_IWRITE       S_IWUSR
94 # define S_IEXEC                S_IXUSR
95 #endif
96
97 #define S_IRGRP (S_IRUSR >> 3)  /* Read by group.  */
98 #define S_IWGRP (S_IWUSR >> 3)  /* Write by group.  */
99 #define S_IXGRP (S_IXUSR >> 3)  /* Execute by group.  */
100 /* Read, write, and execute by group.  */
101 #define S_IRWXG (S_IRWXU >> 3)
102
103 #define S_IROTH (S_IRGRP >> 3)  /* Read by others.  */
104 #define S_IWOTH (S_IWGRP >> 3)  /* Write by others.  */
105 #define S_IXOTH (S_IXGRP >> 3)  /* Execute by others.  */
106 /* Read, write, and execute by others.  */
107 #define S_IRWXO (S_IRWXG >> 3)
108
109
110 #ifdef  __USE_BSD
111 /* Macros for common mode bit masks.  */
112 # define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
113 # define ALLPERMS (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)/* 07777 */
114 # define DEFFILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)/* 0666*/
115
116 # define S_BLKSIZE      512     /* Block size for `st_blocks'.  */
117 #endif
118
119
120 /* Get file attributes for FILE and put them in BUF.  */
121 extern int __stat __P ((__const char *__file, struct stat *__buf));
122 #ifndef __USE_FILE_OFFSET64
123 extern int stat __P ((__const char *__file, struct stat *__buf));
124 #else
125 extern int stat __P ((__const char *__file, struct stat *__buf))
126      __asm__ ("stat64");
127 #endif
128 #ifdef __USE_LARGEFILE64
129 extern int stat64 __P ((__const char *__file, struct stat64 *__buf));
130 #endif
131
132 /* Get file attributes for the file, device, pipe, or socket
133    that file descriptor FD is open on and put them in BUF.  */
134 extern int __fstat __P ((int __fd, struct stat *__buf));
135 #ifndef __USE_FILE_OFFSET64
136 extern int fstat __P ((int __fd, struct stat *__buf));
137 #else
138 extern int fstat __P ((int __fd, struct stat *__buf)) __asm__ ("fstat64");
139 #endif
140 #ifdef __USE_LARGEFILE64
141 extern int fstat64 __P ((int __fd, struct stat64 *__buf));
142 #endif
143
144 /* Get file attributes about FILE and put them in BUF.
145    If FILE is a symbolic link, do not follow it.  */
146 extern int __lstat __P ((__const char *__file, struct stat *__buf));
147 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
148 # ifndef __USE_FILE_OFFSET64
149 extern int lstat __P ((__const char *__file, struct stat *__buf));
150 # else
151 extern int lstat __P ((__const char *__file, struct stat *__buf))
152      __asm__ ("lstat64");
153 # endif
154 # ifdef __USE_LARGEFILE64
155 extern int lstat64 __P ((__const char *__file, struct stat64 *__buf));
156 # endif
157 #endif
158
159 /* Set file access permissions for FILE to MODE.
160    This takes an `int' MODE argument because that
161    is what `mode_t's get widened to.  */
162 extern int __chmod __P ((__const char *__file, __mode_t __mode));
163 extern int chmod __P ((__const char *__file, __mode_t __mode));
164
165 /* Set file access permissions of the file FD is open on to MODE.  */
166 extern int __fchmod __P ((int __fd, __mode_t __mode));
167 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
168 extern int fchmod __P ((int __fd, __mode_t __mode));
169 #endif
170
171
172 /* Set the file creation mask of the current process to MASK,
173    and return the old creation mask.  */
174 extern __mode_t __umask __P ((__mode_t __mask));
175 extern __mode_t umask __P ((__mode_t __mask));
176
177 #ifdef  __USE_GNU
178 /* Get the current `umask' value without changing it.
179    This function is only available under the GNU Hurd.  */
180 extern __mode_t getumask __P ((void));
181 #endif
182
183 /* Create a new directory named PATH, with permission bits MODE.  */
184 extern int __mkdir __P ((__const char *__path, __mode_t __mode));
185 extern int mkdir __P ((__const char *__path, __mode_t __mode));
186
187 /* Create a device file named PATH, with permission and special bits MODE
188    and device number DEV (which can be constructed from major and minor
189    device numbers with the `makedev' macro above).  */
190 extern int __mknod __P ((__const char *__path,
191                          __mode_t __mode, __dev_t __dev));
192 #if defined __USE_MISC || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
193 extern int mknod __P ((__const char *__path,
194                        __mode_t __mode, __dev_t __dev));
195 #endif
196
197
198 /* Create a new FIFO named PATH, with permission bits MODE.  */
199 extern int mkfifo __P ((__const char *__path, __mode_t __mode));
200 \f
201 /* To allow the `struct stat' structure and the file type `mode_t'
202    bits to vary without changing shared library major version number,
203    the `stat' family of functions and `mknod' are in fact inline
204    wrappers around calls to `xstat', `fxstat', `lxstat', and `xmknod',
205    which all take a leading version-number argument designating the
206    data structure and bits used.  <bits/stat.h> defines _STAT_VER with
207    the version number corresponding to `struct stat' as defined in
208    that file; and _MKNOD_VER with the version number corresponding to
209    the S_IF* macros defined therein.  It is arranged that when not
210    inlined these function are always statically linked; that way a
211    dynamically-linked executable always encodes the version number
212    corresponding to the data structures it uses, so the `x' functions
213    in the shared library can adapt without needing to recompile all
214    callers.  */
215
216 #ifndef _STAT_VER
217 # define _STAT_VER      0
218 #endif
219 #ifndef _MKNOD_VER
220 # define _MKNOD_VER     0
221 #endif
222
223 /* Wrappers for stat and mknod system calls.  */
224 extern int __fxstat __P ((int __ver, int __fildes,
225                           struct stat *__stat_buf));
226 extern int __xstat __P ((int __ver, __const char *__filename,
227                          struct stat *__stat_buf));
228 extern int __lxstat __P ((int __ver, __const char *__filename,
229                           struct stat *__stat_buf));
230 extern int __xmknod __P ((int __ver, __const char *__path,
231                           __mode_t __mode, __dev_t *__dev));
232 #if defined __USE_LARGEFILE64 || defined __USE_FILE_OFFSET64
233 extern int __fxstat64 __P ((int __ver, int __fildes,
234                             struct stat64 *__stat_buf));
235 extern int __xstat64 __P ((int __ver, __const char *__filename,
236                            struct stat64 *__stat_buf));
237 extern int __lxstat64 __P ((int __ver, __const char *__filename,
238                             struct stat64 *__stat_buf));
239 #endif
240
241 #if defined __GNUC__ && __GNUC__ >= 2
242 /* Inlined versions of the real stat and mknod functions.  */
243
244 extern __inline__ int __stat (__const char *__path, struct stat *__statbuf)
245 {
246 # ifndef __USE_FILE_OFFSET64
247   return __xstat (_STAT_VER, __path, __statbuf);
248 # else
249   return __xstat64 (_STAT_VER, __path, __statbuf);
250 # endif
251 }
252 extern __inline__ int stat (__const char *__path, struct stat *__statbuf)
253 {
254 # ifndef __USE_FILE_OFFSET64
255   return __xstat (_STAT_VER, __path, __statbuf);
256 # else
257   return __xstat64 (_STAT_VER, __path, __statbuf);
258 # endif
259 }
260
261 extern __inline__ int __lstat (__const char *__path, struct stat *__statbuf)
262 {
263 # ifndef __USE_FILE_OFFSET64
264   return __lxstat (_STAT_VER, __path, __statbuf);
265 # else
266   return __lxstat64 (_STAT_VER, __path, __statbuf);
267 # endif
268 }
269 # if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
270 extern __inline__ int lstat (__const char *__path, struct stat *__statbuf)
271 {
272 #  ifndef __USE_FILE_OFFSET64
273   return __lxstat (_STAT_VER, __path, __statbuf);
274 #  else
275   return __lxstat64 (_STAT_VER, __path, __statbuf);
276 #  endif
277 }
278 # endif
279
280 extern __inline__ int __fstat (int __fd, struct stat *__statbuf)
281 {
282 # ifndef __USE_FILE_OFFSET64
283   return __fxstat (_STAT_VER, __fd, __statbuf);
284 # else
285   return __fxstat64 (_STAT_VER, __fd, __statbuf);
286 # endif
287 }
288 extern __inline__ int fstat (int __fd, struct stat *__statbuf)
289 {
290 # ifndef __USE_FILE_OFFSET64
291   return __fxstat (_STAT_VER, __fd, __statbuf);
292 # else
293   return __fxstat64 (_STAT_VER, __fd, __statbuf);
294 # endif
295 }
296
297 extern __inline__ int __mknod (__const char *__path, __mode_t __mode,
298                                __dev_t __dev)
299 { return __xmknod (_MKNOD_VER, __path, __mode, &__dev); }
300 # if defined __USE_MISC || defined __USE_BSD
301 extern __inline__ int mknod (__const char *__path, __mode_t __mode,
302                              __dev_t __dev)
303 { return __xmknod (_MKNOD_VER, __path, __mode, &__dev); }
304 # endif
305
306 # ifdef __USE_LARGEFILE64
307 extern __inline__ int stat64 (__const char *__path, struct stat64 *__statbuf)
308 {
309   return __xstat64 (_STAT_VER, __path, __statbuf);
310 }
311
312 #  if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
313 extern __inline__ int lstat64 (__const char *__path, struct stat64 *__statbuf)
314 {
315   return __lxstat64 (_STAT_VER, __path, __statbuf);
316 }
317 #  endif
318
319 extern __inline__ int fstat64 (int __fd, struct stat64 *__statbuf)
320 {
321   return __fxstat64 (_STAT_VER, __fd, __statbuf);
322 }
323 # endif
324
325 #endif
326
327 __END_DECLS
328
329
330 #endif /* sys/stat.h  */