[thirdparty/glibc.git] / io / fcntl.h

/* Copyright (C) 1991,1992,1994-2001,2003,2004,2005,2006,2007,2009,2010,2011
	Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA.  */

/*
 *	POSIX Standard: 6.5 File Control Operations	<fcntl.h>
 */

#ifndef	_FCNTL_H
#define	_FCNTL_H	1

#include <features.h>

/* This must be early so <bits/fcntl.h> can define types winningly.  */
__BEGIN_DECLS

/* Get the definitions of O_*, F_*, FD_*: all the
   numbers and flag bits for `open', `fcntl', et al.  */
#include <bits/fcntl.h>

/* For XPG all symbols from <sys/stat.h> should also be available.  */
#if defined __USE_XOPEN || defined __USE_XOPEN2K8
# include <bits/types.h>         /* For __mode_t and __dev_t.  */
# define __need_timespec
# include <time.h>
# include <bits/stat.h>

# define S_IFMT		__S_IFMT
# define S_IFDIR	__S_IFDIR
# define S_IFCHR	__S_IFCHR
# define S_IFBLK	__S_IFBLK
# define S_IFREG	__S_IFREG
# ifdef __S_IFIFO
#  define S_IFIFO	__S_IFIFO
# endif
# ifdef __S_IFLNK
#  define S_IFLNK	__S_IFLNK
# endif
# if (defined __USE_UNIX98 || defined __USE_XOPEN2K8) && defined __S_IFSOCK
#  define S_IFSOCK	__S_IFSOCK
# endif

/* Protection bits.  */

# define S_ISUID	__S_ISUID       /* Set user ID on execution.  */
# define S_ISGID	__S_ISGID       /* Set group ID on execution.  */

# if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
/* Save swapped text after use (sticky bit).  This is pretty well obsolete.  */
#  define S_ISVTX	__S_ISVTX
# endif

# define S_IRUSR	__S_IREAD       /* Read by owner.  */
# define S_IWUSR	__S_IWRITE      /* Write by owner.  */
# define S_IXUSR	__S_IEXEC       /* Execute by owner.  */
/* Read, write, and execute by owner.  */
# define S_IRWXU	(__S_IREAD|__S_IWRITE|__S_IEXEC)

# define S_IRGRP	(S_IRUSR >> 3)  /* Read by group.  */
# define S_IWGRP	(S_IWUSR >> 3)  /* Write by group.  */
# define S_IXGRP	(S_IXUSR >> 3)  /* Execute by group.  */
/* Read, write, and execute by group.  */
# define S_IRWXG	(S_IRWXU >> 3)

# define S_IROTH	(S_IRGRP >> 3)  /* Read by others.  */
# define S_IWOTH	(S_IWGRP >> 3)  /* Write by others.  */
# define S_IXOTH	(S_IXGRP >> 3)  /* Execute by others.  */
/* Read, write, and execute by others.  */
# define S_IRWXO	(S_IRWXG >> 3)
#endif

#ifdef	__USE_MISC
# ifndef R_OK			/* Verbatim from <unistd.h>.  Ugh.  */
/* Values for the second argument to access.
   These may be OR'd together.  */
#  define R_OK	4		/* Test for read permission.  */
#  define W_OK	2		/* Test for write permission.  */
#  define X_OK	1		/* Test for execute permission.  */
#  define F_OK	0		/* Test for existence.  */
# endif
#endif /* Use misc.  */

/* XPG wants the following symbols.   <stdio.h> has the same definitions.  */
#if defined __USE_XOPEN || defined __USE_XOPEN2K8
# define SEEK_SET	0	/* Seek from beginning of file.  */
# define SEEK_CUR	1	/* Seek from current position.  */
# define SEEK_END	2	/* Seek from end of file.  */
#endif	/* XPG */

#ifdef __USE_ATFILE
# define AT_FDCWD		-100	/* Special value used to indicate
					   the *at functions should use the
					   current working directory. */
# define AT_SYMLINK_NOFOLLOW	0x100	/* Do not follow symbolic links.  */
# define AT_REMOVEDIR		0x200	/* Remove directory instead of
					   unlinking file.  */
# define AT_SYMLINK_FOLLOW	0x400	/* Follow symbolic links.  */
# define AT_NO_AUTOMOUNT	0x800	/* Suppress terminal automount
					   traversal.  */
# define AT_EMPTY_PATH		0x1000	/* Allow empty relative pathname.  */
# define AT_EACCESS		0x200	/* Test access permitted for
					   effective IDs, not real IDs.  */
#endif

/* Do the file control operation described by CMD on FD.
   The remaining arguments are interpreted depending on CMD.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int fcntl (int __fd, int __cmd, ...);

/* Open FILE and return a new file descriptor for it, or -1 on error.
   OFLAG determines the type of access used.  If O_CREAT is on OFLAG,
   the third argument is taken as a `mode_t', the mode of the created file.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
#ifndef __USE_FILE_OFFSET64
extern int open (__const char *__file, int __oflag, ...) __nonnull ((1));
#else
# ifdef __REDIRECT
extern int __REDIRECT (open, (__const char *__file, int __oflag, ...), open64)
     __nonnull ((1));
# else
#  define open open64
# endif
#endif
#ifdef __USE_LARGEFILE64
extern int open64 (__const char *__file, int __oflag, ...) __nonnull ((1));
#endif

#ifdef __USE_ATFILE
/* Similar to `open' but a relative path name is interpreted relative to
   the directory for which FD is a descriptor.

   NOTE: some other `openat' implementation support additional functionality
   through this interface, especially using the O_XATTR flag.  This is not
   yet supported here.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
# ifndef __USE_FILE_OFFSET64
extern int openat (int __fd, __const char *__file, int __oflag, ...)
     __nonnull ((2));
# else
#  ifdef __REDIRECT
extern int __REDIRECT (openat, (int __fd, __const char *__file, int __oflag,
				...), openat64) __nonnull ((2));
#  else
#   define openat openat64
#  endif
# endif
# ifdef __USE_LARGEFILE64
extern int openat64 (int __fd, __const char *__file, int __oflag, ...)
     __nonnull ((2));
# endif
#endif

/* Create and open FILE, with mode MODE.  This takes an `int' MODE
   argument because that is what `mode_t' will be widened to.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
#ifndef __USE_FILE_OFFSET64
extern int creat (__const char *__file, __mode_t __mode) __nonnull ((1));
#else
# ifdef __REDIRECT
extern int __REDIRECT (creat, (__const char *__file, __mode_t __mode),
		       creat64) __nonnull ((1));
# else
#  define creat creat64
# endif
#endif
#ifdef __USE_LARGEFILE64
extern int creat64 (__const char *__file, __mode_t __mode) __nonnull ((1));
#endif

#if !defined F_LOCK && (defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
					       && !defined __USE_POSIX))
/* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
   files consistent.  Some systems have them there and some here, and some
   software depends on the macros being defined without including both.  */

/* `lockf' is a simpler interface to the locking facilities of `fcntl'.
   LEN is always relative to the current file position.
   The CMD argument is one of the following.  */

# define F_ULOCK 0	/* Unlock a previously locked region.  */
# define F_LOCK  1	/* Lock a region for exclusive use.  */
# define F_TLOCK 2	/* Test and lock a region for exclusive use.  */
# define F_TEST  3	/* Test a region for other processes locks.  */

# ifndef __USE_FILE_OFFSET64
extern int lockf (int __fd, int __cmd, __off_t __len);
# else
#  ifdef __REDIRECT
extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
#  else
#   define lockf lockf64
#  endif
# endif
# ifdef __USE_LARGEFILE64
extern int lockf64 (int __fd, int __cmd, __off64_t __len);
# endif
#endif

#ifdef __USE_XOPEN2K
/* Advice the system about the expected behaviour of the application with
   respect to the file associated with FD.  */
# ifndef __USE_FILE_OFFSET64
extern int posix_fadvise (int __fd, __off_t __offset, __off_t __len,
			  int __advise) __THROW;
# else
 # ifdef __REDIRECT_NTH
extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
					   __off64_t __len, int __advise),
			   posix_fadvise64);
#  else
#   define posix_fadvise posix_fadvise64
#  endif
# endif
# ifdef __USE_LARGEFILE64
extern int posix_fadvise64 (int __fd, __off64_t __offset, __off64_t __len,
			    int __advise) __THROW;
# endif


/* Reserve storage for the data of the file associated with FD.

   This function is a possible cancellation point and therefore not
   marked with __THROW.  */
# ifndef __USE_FILE_OFFSET64
extern int posix_fallocate (int __fd, __off_t __offset, __off_t __len);
# else
 # ifdef __REDIRECT
extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
					 __off64_t __len),
		       posix_fallocate64);
#  else
#   define posix_fallocate posix_fallocate64
#  endif
# endif
# ifdef __USE_LARGEFILE64
extern int posix_fallocate64 (int __fd, __off64_t __offset, __off64_t __len);
# endif
#endif


/* Define some inlines helping to catch common problems.  */
#if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline \
    && defined __va_arg_pack_len
# include <bits/fcntl2.h>
#endif

__END_DECLS

#endif /* fcntl.h  */
Commit	Line	Data
620a0529	1	/* Copyright (C) 1991,1992,1994-2001,2003,2004,2005,2006,2007,2009,2010,2011
0b8f25bb	2	Free Software Foundation, Inc.
54d79e99	3	This file is part of the GNU C Library.
28f540f4	4
54d79e99	5	The GNU C Library is free software; you can redistribute it and/or
41bdb6e2 AJ	6	modify it under the terms of the GNU Lesser General Public
	7	License as published by the Free Software Foundation; either
	8	version 2.1 of the License, or (at your option) any later version.
28f540f4	9
54d79e99 UD	10	The GNU C Library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2	13	Lesser General Public License for more details.
28f540f4	14
41bdb6e2 AJ	15	You should have received a copy of the GNU Lesser General Public
	16	License along with the GNU C Library; if not, write to the Free
	17	Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	18	02111-1307 USA. */
28f540f4 RM	19
	20	/*
	21	* POSIX Standard: 6.5 File Control Operations <fcntl.h>
	22	*/
	23
	24	#ifndef _FCNTL_H
28f540f4	25	#define _FCNTL_H 1
5107cf1d	26
28f540f4 RM	27	#include <features.h>
28f540f4 RM	28
5107cf1d	29	/* This must be early so <bits/fcntl.h> can define types winningly. */
28f540f4 RM	30	__BEGIN_DECLS
	31
	32	/* Get the definitions of O_, F_, FD_*: all the
	33	numbers and flag bits for `open', `fcntl', et al. */
5107cf1d	34	#include <bits/fcntl.h>
28f540f4	35
6077fe6e	36	/* For XPG all symbols from <sys/stat.h> should also be available. */
f095bb72 UD	37	#if defined __USE_XOPEN \|\| defined __USE_XOPEN2K8
	38	# include <bits/types.h> /* For __mode_t and __dev_t. */
	39	# define __need_timespec
	40	# include <time.h>
	41	# include <bits/stat.h>
	42
	43	# define S_IFMT __S_IFMT
	44	# define S_IFDIR __S_IFDIR
	45	# define S_IFCHR __S_IFCHR
	46	# define S_IFBLK __S_IFBLK
	47	# define S_IFREG __S_IFREG
	48	# ifdef __S_IFIFO
	49	# define S_IFIFO __S_IFIFO
	50	# endif
	51	# ifdef __S_IFLNK
	52	# define S_IFLNK __S_IFLNK
	53	# endif
	54	# if (defined __USE_UNIX98 \|\| defined __USE_XOPEN2K8) && defined __S_IFSOCK
	55	# define S_IFSOCK __S_IFSOCK
	56	# endif
	57
	58	/* Protection bits. */
	59
	60	# define S_ISUID __S_ISUID /* Set user ID on execution. */
	61	# define S_ISGID __S_ISGID /* Set group ID on execution. */
	62
	63	# if defined __USE_BSD \|\| defined __USE_MISC \|\| defined __USE_XOPEN
	64	/* Save swapped text after use (sticky bit). This is pretty well obsolete. */
	65	# define S_ISVTX __S_ISVTX
	66	# endif
	67
	68	# define S_IRUSR __S_IREAD /* Read by owner. */
	69	# define S_IWUSR __S_IWRITE /* Write by owner. */
	70	# define S_IXUSR __S_IEXEC /* Execute by owner. */
	71	/* Read, write, and execute by owner. */
	72	# define S_IRWXU (__S_IREAD\|__S_IWRITE\|__S_IEXEC)
	73
	74	# define S_IRGRP (S_IRUSR >> 3) /* Read by group. */
	75	# define S_IWGRP (S_IWUSR >> 3) /* Write by group. */
	76	# define S_IXGRP (S_IXUSR >> 3) /* Execute by group. */
	77	/* Read, write, and execute by group. */
	78	# define S_IRWXG (S_IRWXU >> 3)
	79
	80	# define S_IROTH (S_IRGRP >> 3) /* Read by others. */
	81	# define S_IWOTH (S_IWGRP >> 3) /* Write by others. */
	82	# define S_IXOTH (S_IXGRP >> 3) /* Execute by others. */
	83	/* Read, write, and execute by others. */
	84	# define S_IRWXO (S_IRWXG >> 3)
9756dfe1 UD	85	#endif
9756dfe1 UD	86
28f540f4	87	#ifdef __USE_MISC
dfd2257a	88	# ifndef R_OK /* Verbatim from <unistd.h>. Ugh. */
28f540f4 RM	89	/* Values for the second argument to access.
28f540f4 RM	90	These may be OR'd together. */
dfd2257a UD	91	# define R_OK 4 /* Test for read permission. */
	92	# define W_OK 2 /* Test for write permission. */
	93	# define X_OK 1 /* Test for execute permission. */
	94	# define F_OK 0 /* Test for existence. */
	95	# endif
28f540f4 RM	96	#endif /* Use misc. */
28f540f4 RM	97
f095bb72 UD	98	/* XPG wants the following symbols. <stdio.h> has the same definitions. */
f095bb72 UD	99	#if defined __USE_XOPEN \|\| defined __USE_XOPEN2K8
4bae5567 UD	100	# define SEEK_SET 0 /* Seek from beginning of file. */
	101	# define SEEK_CUR 1 /* Seek from current position. */
	102	# define SEEK_END 2 /* Seek from end of file. */
	103	#endif /* XPG */
	104
0b8f25bb	105	#ifdef __USE_ATFILE
26cec518	106	# define AT_FDCWD -100 /* Special value used to indicate
c804fb5f UD	107	the *at functions should use the
c804fb5f UD	108	current working directory. */
26cec518 UD	109	# define AT_SYMLINK_NOFOLLOW 0x100 /* Do not follow symbolic links. */
	110	# define AT_REMOVEDIR 0x200 /* Remove directory instead of
	111	unlinking file. */
c804fb5f	112	# define AT_SYMLINK_FOLLOW 0x400 /* Follow symbolic links. */
620a0529 UD	113	# define AT_NO_AUTOMOUNT 0x800 /* Suppress terminal automount
620a0529 UD	114	traversal. */
46998f74	115	# define AT_EMPTY_PATH 0x1000 /* Allow empty relative pathname. */
d15b99ac RM	116	# define AT_EACCESS 0x200 /* Test access permitted for
d15b99ac RM	117	effective IDs, not real IDs. */
26cec518 UD	118	#endif
26cec518 UD	119
28f540f4	120	/* Do the file control operation described by CMD on FD.
2c008571 UD	121	The remaining arguments are interpreted depending on CMD.
	122
	123	This function is a cancellation point and therefore not marked with
	124	__THROW. */
	125	extern int fcntl (int __fd, int __cmd, ...);
28f540f4 RM	126
	127	/* Open FILE and return a new file descriptor for it, or -1 on error.
	128	OFLAG determines the type of access used. If O_CREAT is on OFLAG,
2c008571 UD	129	the third argument is taken as a `mode_t', the mode of the created file.
	130
	131	This function is a cancellation point and therefore not marked with
	132	__THROW. */
dfd2257a	133	#ifndef __USE_FILE_OFFSET64
8a1f658b	134	extern int open (__const char *__file, int __oflag, ...) __nonnull ((1));
dfd2257a	135	#else
918b9d72	136	# ifdef __REDIRECT
8a1f658b UD	137	extern int __REDIRECT (open, (__const char *__file, int __oflag, ...), open64)
8a1f658b UD	138	__nonnull ((1));
918b9d72 UD	139	# else
	140	# define open open64
	141	# endif
dfd2257a UD	142	#endif
dfd2257a UD	143	#ifdef __USE_LARGEFILE64
8a1f658b	144	extern int open64 (__const char *__file, int __oflag, ...) __nonnull ((1));
dfd2257a	145	#endif
28f540f4	146
0b8f25bb RM	147	#ifdef __USE_ATFILE
0b8f25bb RM	148	/* Similar to `open' but a relative path name is interpreted relative to
4973cbe5 UD	149	the directory for which FD is a descriptor.
4973cbe5 UD	150
0b8f25bb	151	NOTE: some other `openat' implementation support additional functionality
4973cbe5 UD	152	through this interface, especially using the O_XATTR flag. This is not
	153	yet supported here.
	154
	155	This function is a cancellation point and therefore not marked with
	156	__THROW. */
	157	# ifndef __USE_FILE_OFFSET64
	158	extern int openat (int __fd, __const char *__file, int __oflag, ...)
	159	__nonnull ((2));
	160	# else
	161	# ifdef __REDIRECT
	162	extern int __REDIRECT (openat, (int __fd, __const char *__file, int __oflag,
	163	...), openat64) __nonnull ((2));
	164	# else
	165	# define openat openat64
	166	# endif
	167	# endif
f095bb72	168	# ifdef __USE_LARGEFILE64
4973cbe5 UD	169	extern int openat64 (int __fd, __const char *__file, int __oflag, ...)
4973cbe5 UD	170	__nonnull ((2));
f095bb72	171	# endif
4973cbe5 UD	172	#endif
4973cbe5 UD	173
2c008571 UD	174	/* Create and open FILE, with mode MODE. This takes an `int' MODE
	175	argument because that is what `mode_t' will be widened to.
	176
	177	This function is a cancellation point and therefore not marked with
	178	__THROW. */
dfd2257a	179	#ifndef __USE_FILE_OFFSET64
8a1f658b	180	extern int creat (__const char *__file, __mode_t __mode) __nonnull ((1));
dfd2257a	181	#else
918b9d72	182	# ifdef __REDIRECT
2c008571	183	extern int __REDIRECT (creat, (__const char *__file, __mode_t __mode),
8a1f658b	184	creat64) __nonnull ((1));
918b9d72 UD	185	# else
	186	# define creat creat64
	187	# endif
dfd2257a UD	188	#endif
dfd2257a UD	189	#ifdef __USE_LARGEFILE64
8a1f658b	190	extern int creat64 (__const char *__file, __mode_t __mode) __nonnull ((1));
dfd2257a	191	#endif
28f540f4	192
9756dfe1 UD	193	#if !defined F_LOCK && (defined __USE_MISC \|\| (defined __USE_XOPEN_EXTENDED \
9756dfe1 UD	194	&& !defined __USE_POSIX))
28f540f4 RM	195	/* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
	196	files consistent. Some systems have them there and some here, and some
	197	software depends on the macros being defined without including both. */
	198
	199	/* `lockf' is a simpler interface to the locking facilities of `fcntl'.
	200	LEN is always relative to the current file position.
	201	The CMD argument is one of the following. */
	202
dfd2257a UD	203	# define F_ULOCK 0 /* Unlock a previously locked region. */
	204	# define F_LOCK 1 /* Lock a region for exclusive use. */
	205	# define F_TLOCK 2 /* Test and lock a region for exclusive use. */
	206	# define F_TEST 3 /* Test a region for other processes locks. */
28f540f4	207
dfd2257a	208	# ifndef __USE_FILE_OFFSET64
8dab36a1	209	extern int lockf (int __fd, int __cmd, __off_t __len);
dfd2257a	210	# else
b6a2b287	211	# ifdef __REDIRECT
8dab36a1	212	extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
b6a2b287 UD	213	# else
	214	# define lockf lockf64
	215	# endif
dfd2257a UD	216	# endif
dfd2257a UD	217	# ifdef __USE_LARGEFILE64
8dab36a1	218	extern int lockf64 (int __fd, int __cmd, __off64_t __len);
dfd2257a	219	# endif
28f540f4 RM	220	#endif
28f540f4 RM	221
bb8e0116 UD	222	#ifdef __USE_XOPEN2K
	223	/* Advice the system about the expected behaviour of the application with
	224	respect to the file associated with FD. */
	225	# ifndef __USE_FILE_OFFSET64
f38afd78	226	extern int posix_fadvise (int __fd, __off_t __offset, __off_t __len,
bb8e0116 UD	227	int __advise) __THROW;
bb8e0116 UD	228	# else
b6a2b287	229	# ifdef __REDIRECT_NTH
f377d022 UD	230	extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
	231	__off64_t __len, int __advise),
	232	posix_fadvise64);
b6a2b287 UD	233	# else
	234	# define posix_fadvise posix_fadvise64
	235	# endif
bb8e0116 UD	236	# endif
bb8e0116 UD	237	# ifdef __USE_LARGEFILE64
f38afd78	238	extern int posix_fadvise64 (int __fd, __off64_t __offset, __off64_t __len,
bb8e0116 UD	239	int __advise) __THROW;
	240	# endif
	241
	242
73299943 UD	243	/* Reserve storage for the data of the file associated with FD.
73299943 UD	244
4c1423ed	245	This function is a possible cancellation point and therefore not
73299943	246	marked with __THROW. */
bb8e0116	247	# ifndef __USE_FILE_OFFSET64
089d05d5	248	extern int posix_fallocate (int __fd, __off_t __offset, __off_t __len);
bb8e0116	249	# else
b6a2b287	250	# ifdef __REDIRECT
bb8e0116	251	extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
089d05d5	252	__off64_t __len),
bb8e0116	253	posix_fallocate64);
b6a2b287 UD	254	# else
	255	# define posix_fallocate posix_fallocate64
	256	# endif
bb8e0116 UD	257	# endif
bb8e0116 UD	258	# ifdef __USE_LARGEFILE64
089d05d5	259	extern int posix_fallocate64 (int __fd, __off64_t __offset, __off64_t __len);
bb8e0116 UD	260	# endif
	261	#endif
	262
ddfd0535	263
3a50811c	264	/* Define some inlines helping to catch common problems. */
de1c3ebb	265	#if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline \
3a50811c	266	&& defined __va_arg_pack_len
ddfd0535 UD	267	# include <bits/fcntl2.h>
	268	#endif
	269
28f540f4 RM	270	__END_DECLS
	271
	272	#endif /* fcntl.h */