epoc32/include/stdapis/sys/fcntl.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100 (2010-03-31)
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*-
     2  * 
     3  * Copyright (c) 1983, 1990, 1993
     4  *	The Regents of the University of California.  All rights reserved.
     5  * (c) UNIX System Laboratories, Inc.
     6  * All or some portions of this file are derived from material licensed
     7  * to the University of California by American Telephone and Telegraph
     8  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
     9  * the permission of UNIX System Laboratories, Inc.
    10  *
    11  * Redistribution and use in source and binary forms, with or without
    12  * modification, are permitted provided that the following conditions
    13  * are met:
    14  * 1. Redistributions of source code must retain the above copyright
    15  *    notice, this list of conditions and the following disclaimer.
    16  * 2. Redistributions in binary form must reproduce the above copyright
    17  *    notice, this list of conditions and the following disclaimer in the
    18  *    documentation and/or other materials provided with the distribution.
    19  * 4. Neither the name of the University nor the names of its contributors
    20  *    may be used to endorse or promote products derived from this software
    21  *    without specific prior written permission.
    22  *
    23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    33  * SUCH DAMAGE.
    34  * * © * Portions Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
    35  *
    36  *	@(#)fcntl.h	8.3 (Berkeley) 1/21/94
    37  * $FreeBSD: src/sys/sys/fcntl.h,v 1.16 2004/04/07 04:19:49 imp Exp $
    38  */
    39 
    40 #ifndef _SYS_FCNTL_H_
    41 #define	_SYS_FCNTL_H_
    42 
    43 /*
    44  * This file includes the definitions for open and fcntl
    45  * described by POSIX for <fcntl.h>; it also includes
    46  * related kernel definitions.
    47  */
    48 
    49 #include <sys/cdefs.h>
    50 #include <sys/_types.h>
    51 
    52 #ifndef _MODE_T_DECLARED
    53 typedef	__mode_t	mode_t;
    54 #define	_MODE_T_DECLARED
    55 #endif
    56 
    57 #ifndef _OFF_T_DECLARED
    58 typedef	__off_t		off_t;
    59 
    60 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
    61 typedef	__off_t		off64_t;
    62 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
    63 
    64 #define	_OFF_T_DECLARED
    65 #endif
    66 
    67 #ifndef _PID_T_DECLARED
    68 typedef	__pid_t		pid_t;
    69 #define	_PID_T_DECLARED
    70 #endif
    71 
    72 /*
    73  * File status flags: these are used by open(2), fcntl(2).
    74  * They are also used (indirectly) in the kernel file structure f_flags,
    75  * which is a superset of the open/fcntl flags.  Open flags and f_flags
    76  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
    77  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
    78  */
    79 /* open-only flags */
    80 #define	O_RDONLY	0x0000		/* open for reading only */
    81 #define	O_WRONLY	0x0001		/* open for writing only */
    82 #define	O_RDWR		0x0002		/* open for reading and writing */
    83 #define	O_ACCMODE	0x0003		/* mask for above modes */
    84 
    85 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
    86 #define O_LARGEFILE 0x0004
    87 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
    88 
    89 /*
    90  * Kernel encoding of open mode; separate read and write bits that are
    91  * independently testable: 1 greater than the above.
    92  *
    93  * XXX
    94  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
    95  * which was documented to use FREAD/FWRITE, continues to work.
    96  */
    97 #if __BSD_VISIBLE
    98 #define	FREAD		0x0001
    99 #define	FWRITE		0x0002
   100 #endif
   101 #define	O_NONBLOCK	0x0004		/* no delay */
   102 #define	O_APPEND	0x0008		/* set append mode */
   103 #if __BSD_VISIBLE
   104 #define	O_SHLOCK	0x0010		/* open with shared file lock */
   105 #define	O_EXLOCK	0x0020		/* open with exclusive file lock */
   106 #define	O_ASYNC		0x0040		/* signal pgrp when data ready */
   107 #define	O_FSYNC		0x0080		/* synchronous writes */
   108 #endif
   109 #define	O_SYNC		0x0080		/* POSIX synonym for O_FSYNC */
   110 #if __BSD_VISIBLE
   111 #define	O_NOFOLLOW	0x0100		/* don't follow symlinks */
   112 #endif
   113 #define	O_CREAT		0x0200		/* create if nonexistent */
   114 #define	O_TRUNC		0x0400		/* truncate to zero length */
   115 #define	O_EXCL		0x0800		/* error if already exists */
   116 #ifdef _KERNEL
   117 #define	FHASLOCK	0x4000		/* descriptor holds advisory lock */
   118 #endif
   119 
   120 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
   121 #define	O_NOCTTY	0x8000		/* don't assign controlling terminal */
   122 
   123 #if __BSD_VISIBLE
   124 /* Attempt to bypass buffer cache */
   125 #define O_DIRECT	0x00010000
   126 #endif
   127 
   128 //Copied from MRT1.0 fcntl.h header
   129 #define _FBUFFERED  0x10000 /* buffer at the interface to the file system */
   130 #define _FBINARY        0x10000
   131 #define _FTEXT          0x20000
   132 #define O_BINARY	_FBINARY
   133 #define O_TEXT		_FTEXT
   134 #define O_BUFFERED  _FBUFFERED
   135 
   136 /*
   137  * XXX missing O_DSYNC, O_RSYNC.
   138  */
   139 
   140 #ifdef _KERNEL
   141 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
   142 #define	FFLAGS(oflags)	((oflags) + 1)
   143 #define	OFLAGS(fflags)	((fflags) - 1)
   144 
   145 /* bits to save after open */
   146 #define	FMASK		(FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT)
   147 /* bits settable by fcntl(F_SETFL, ...) */
   148 #define	FCNTLFLAGS	(FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|O_DIRECT)
   149 #endif
   150 
   151 /*
   152  * The O_* flags used to have only F* names, which were used in the kernel
   153  * and by fcntl.  We retain the F* names for the kernel f_flag field
   154  * and for backward compatibility for fcntl.  These flags are deprecated.
   155  */
   156 #if __BSD_VISIBLE
   157 #define	FAPPEND		O_APPEND	/* kernel/compat */
   158 #define	FASYNC		O_ASYNC		/* kernel/compat */
   159 #define	FFSYNC		O_FSYNC		/* kernel */
   160 #define	FNONBLOCK	O_NONBLOCK	/* kernel */
   161 #define	FNDELAY		O_NONBLOCK	/* compat */
   162 #define	O_NDELAY	O_NONBLOCK	/* compat */
   163 #endif
   164 
   165 /*
   166  * We are out of bits in f_flag (which is a short).  However,
   167  * the flag bits not set in FMASK are only meaningful in the
   168  * initial open syscall.  Those bits can thus be given a
   169  * different meaning for fcntl(2).
   170  */
   171 #if __BSD_VISIBLE
   172 
   173 /*
   174  * Set by shm_open(3) to get automatic MAP_ASYNC behavior
   175  * for POSIX shared memory objects (which are otherwise
   176  * implemented as plain files).
   177  */
   178 #define	FPOSIXSHM	O_NOFOLLOW
   179 #endif
   180 
   181 /*SYMBIAN Flag for tmpfile removal*/
   182 #ifdef __SYMBIAN32__
   183 #define O_TMPFILE 	0x10000000		/* flag for cleanup of tmpfiles*/
   184 #endif //__SYMBIAN32__
   185 /*SYMBIAN Flag for shm_open()*/
   186 #ifdef __SYMBIAN32__
   187 #define O_SHMFLG 	0x01000000		/* flag for shm_open()*/
   188 #endif //__SYMBIAN32__
   189 /*
   190  * Constants used for fcntl(2)
   191  */
   192 
   193 /* command values */
   194 #define	F_DUPFD		0		/* duplicate file descriptor */
   195 #define	F_GETFD		1		/* get file descriptor flags */
   196 #define	F_SETFD		2		/* set file descriptor flags */
   197 #define	F_GETFL		3		/* get file status flags */
   198 #define	F_SETFL		4		/* set file status flags */
   199 #if __BSD_VISIBLE || __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
   200 #define	F_GETOWN	5		/* get SIGIO/SIGURG proc/pgrp */
   201 #define F_SETOWN	6		/* set SIGIO/SIGURG proc/pgrp */
   202 #endif
   203 #define	F_GETLK		7		/* get record locking information */
   204 #define	F_SETLK		8		/* set record locking information */
   205 #define	F_SETLKW	9		/* F_SETLK; wait if blocked */
   206 
   207 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   208 #define F_GETLK64	F_GETLK
   209 #define F_SETLK64	F_SETLK
   210 #define F_SETLKW64	F_SETLKW
   211 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   212 
   213 /* file descriptor flags (F_GETFD, F_SETFD) */
   214 #define	FD_CLOEXEC	1		/* close-on-exec flag */
   215 
   216 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
   217 #define	F_RDLCK		1		/* shared or read lock */
   218 #define	F_UNLCK		2		/* unlock */
   219 #define	F_WRLCK		3		/* exclusive or write lock */
   220 #ifdef _KERNEL
   221 #define	F_WAIT		0x010		/* Wait until lock is granted */
   222 #define	F_FLOCK		0x020	 	/* Use flock(2) semantics for lock */
   223 #define	F_POSIX		0x040	 	/* Use POSIX semantics for lock */
   224 #endif
   225 
   226 /*
   227  * Advisory file segment locking data type -
   228  * information passed to system by user
   229  */
   230 struct flock {
   231 	off_t	l_start;	/* starting offset */
   232 	off_t	l_len;		/* len = 0 means until end of file */
   233 	pid_t	l_pid;		/* lock owner */
   234 	short	l_type;		/* lock type: read/write, etc. */
   235 	short	l_whence;	/* type of l_start */
   236 };
   237 
   238 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   239 #define flock64	flock
   240 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   241 
   242 
   243 #if __BSD_VISIBLE
   244 /* lock operations for flock(2) */
   245 #define	LOCK_SH		0x01		/* shared file lock */
   246 #define	LOCK_EX		0x02		/* exclusive file lock */
   247 #define	LOCK_NB		0x04		/* don't block when locking */
   248 #define	LOCK_UN		0x08		/* unlock file */
   249 #endif
   250 
   251 /*
   252  * XXX missing posix_fadvise() and posix_fallocate(), and POSIX_FADV_* macros.
   253  */
   254 
   255 #ifndef _KERNEL
   256 __BEGIN_DECLS
   257 IMPORT_C int	open(const char *, int, ...);
   258 IMPORT_C int	creat(const char *, mode_t);
   259 IMPORT_C int	fcntl(int, int, ...);
   260 
   261 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   262 #define open64	open
   263 #define creat64	creat
   264 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   265 
   266 #if __BSD_VISIBLE
   267 int	flock(int, int);
   268 #endif
   269 __END_DECLS
   270 #endif
   271 
   272 #endif /* !_SYS_FCNTL_H_ */