/*-

 * © Portions copyright (c) 2005 Nokia Corporation.  All rights reserved.

 * © Portions copyright (c) 2006-2007 Symbian Software Ltd. All rights reserved.

 * Copyright (c) 1983, 1990, 1993

 *	The Regents of the University of California.  All rights reserved.

 * (c) UNIX System Laboratories, Inc.

 * All or some portions of this file are derived from material licensed

 * to the University of California by American Telephone and Telegraph

 * Co. or Unix System Laboratories, Inc. and are reproduced herein with

 * the permission of UNIX System Laboratories, Inc.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 * 4. Neither the name of the University nor the names of its contributors

 *    may be used to endorse or promote products derived from this software

 *    without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND

 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

 * SUCH DAMAGE.

 *

 *	@(#)fcntl.h	8.3 (Berkeley) 1/21/94

 * $FreeBSD: src/sys/sys/fcntl.h,v 1.16 2004/04/07 04:19:49 imp Exp $

 */

#ifndef _SYS_FCNTL_H_

#define	_SYS_FCNTL_H_

/*

 * This file includes the definitions for open and fcntl

 * described by POSIX for <fcntl.h>; it also includes

 * related kernel definitions.

 */

#include <sys/cdefs.h>

#include <sys/_types.h>

#ifndef _MODE_T_DECLARED

typedef	__mode_t	mode_t;

#define	_MODE_T_DECLARED

#endif

#ifndef _OFF_T_DECLARED

typedef	__off_t		off_t;

#define	_OFF_T_DECLARED

#endif

#ifndef _PID_T_DECLARED

typedef	__pid_t		pid_t;

#define	_PID_T_DECLARED

#endif

/*

 * File status flags: these are used by open(2), fcntl(2).

 * They are also used (indirectly) in the kernel file structure f_flags,

 * which is a superset of the open/fcntl flags.  Open flags and f_flags

 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).

 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.

 */

/* open-only flags */

#define	O_RDONLY	0x0000		/* open for reading only */

#define	O_WRONLY	0x0001		/* open for writing only */

#define	O_RDWR		0x0002		/* open for reading and writing */

#define	O_ACCMODE	0x0003		/* mask for above modes */

/*

 * Kernel encoding of open mode; separate read and write bits that are

 * independently testable: 1 greater than the above.

 *

 * XXX

 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,

 * which was documented to use FREAD/FWRITE, continues to work.

 */

#if __BSD_VISIBLE

#define	FREAD		0x0001

#define	FWRITE		0x0002

#endif

#define	O_NONBLOCK	0x0004		/* no delay */

#define	O_APPEND	0x0008		/* set append mode */

#if __BSD_VISIBLE

#define	O_SHLOCK	0x0010		/* open with shared file lock */

#define	O_EXLOCK	0x0020		/* open with exclusive file lock */

#define	O_ASYNC		0x0040		/* signal pgrp when data ready */

#define	O_FSYNC		0x0080		/* synchronous writes */

#endif

#define	O_SYNC		0x0080		/* POSIX synonym for O_FSYNC */

#if __BSD_VISIBLE

#define	O_NOFOLLOW	0x0100		/* don't follow symlinks */

#endif

#define	O_CREAT		0x0200		/* create if nonexistent */

#define	O_TRUNC		0x0400		/* truncate to zero length */

#define	O_EXCL		0x0800		/* error if already exists */

#ifdef _KERNEL

#define	FHASLOCK	0x4000		/* descriptor holds advisory lock */

#endif

/* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */

#define	O_NOCTTY	0x8000		/* don't assign controlling terminal */

#if __BSD_VISIBLE

/* Attempt to bypass buffer cache */

#define O_DIRECT	0x00010000

#endif

//Copied from MRT1.0 fcntl.h header

#define _FBUFFERED  0x10000 /* buffer at the interface to the file system */

#define _FBINARY        0x10000

#define _FTEXT          0x20000

#define O_BINARY	_FBINARY

#define O_TEXT		_FTEXT

#define O_BUFFERED  _FBUFFERED

/*

 * XXX missing O_DSYNC, O_RSYNC.

 */

#ifdef _KERNEL

/* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */

#define	FFLAGS(oflags)	((oflags) + 1)

#define	OFLAGS(fflags)	((fflags) - 1)

/* bits to save after open */

#define	FMASK		(FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT)

/* bits settable by fcntl(F_SETFL, ...) */

#define	FCNTLFLAGS	(FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|O_DIRECT)

#endif

/*

 * The O_* flags used to have only F* names, which were used in the kernel

 * and by fcntl.  We retain the F* names for the kernel f_flag field

 * and for backward compatibility for fcntl.  These flags are deprecated.

 */

#if __BSD_VISIBLE

#define	FAPPEND		O_APPEND	/* kernel/compat */

#define	FASYNC		O_ASYNC		/* kernel/compat */

#define	FFSYNC		O_FSYNC		/* kernel */

#define	FNONBLOCK	O_NONBLOCK	/* kernel */

#define	FNDELAY		O_NONBLOCK	/* compat */

#define	O_NDELAY	O_NONBLOCK	/* compat */

#endif

/*

 * We are out of bits in f_flag (which is a short).  However,

 * the flag bits not set in FMASK are only meaningful in the

 * initial open syscall.  Those bits can thus be given a

 * different meaning for fcntl(2).

 */

#if __BSD_VISIBLE

/*

 * Set by shm_open(3) to get automatic MAP_ASYNC behavior

 * for POSIX shared memory objects (which are otherwise

 * implemented as plain files).

 */

#define	FPOSIXSHM	O_NOFOLLOW

#endif

/*SYMBIAN Flag for tmpfile removal*/

#ifdef __SYMBIAN32__

#define O_TMPFILE 	0x10000000		/* flag for cleanup of tmpfiles*/

#endif //__SYMBIAN32__

/*

 * Constants used for fcntl(2)

 */

/* command values */

#define	F_DUPFD		0		/* duplicate file descriptor */

#define	F_GETFD		1		/* get file descriptor flags */

#define	F_SETFD		2		/* set file descriptor flags */

#define	F_GETFL		3		/* get file status flags */

#define	F_SETFL		4		/* set file status flags */

#if __BSD_VISIBLE || __XSI_VISIBLE || __POSIX_VISIBLE >= 200112

#define	F_GETOWN	5		/* get SIGIO/SIGURG proc/pgrp */

#define F_SETOWN	6		/* set SIGIO/SIGURG proc/pgrp */

#endif

#define	F_GETLK		7		/* get record locking information */

#define	F_SETLK		8		/* set record locking information */

#define	F_SETLKW	9		/* F_SETLK; wait if blocked */

/* file descriptor flags (F_GETFD, F_SETFD) */

#define	FD_CLOEXEC	1		/* close-on-exec flag */

/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */

#define	F_RDLCK		1		/* shared or read lock */

#define	F_UNLCK		2		/* unlock */

#define	F_WRLCK		3		/* exclusive or write lock */

#ifdef _KERNEL

#define	F_WAIT		0x010		/* Wait until lock is granted */

#define	F_FLOCK		0x020	 	/* Use flock(2) semantics for lock */

#define	F_POSIX		0x040	 	/* Use POSIX semantics for lock */

#endif

/*

 * Advisory file segment locking data type -

 * information passed to system by user

 */

struct flock {

	off_t	l_start;	/* starting offset */

	off_t	l_len;		/* len = 0 means until end of file */

	pid_t	l_pid;		/* lock owner */

	short	l_type;		/* lock type: read/write, etc. */

	short	l_whence;	/* type of l_start */

};

#if __BSD_VISIBLE

/* lock operations for flock(2) */

#define	LOCK_SH		0x01		/* shared file lock */

#define	LOCK_EX		0x02		/* exclusive file lock */

#define	LOCK_NB		0x04		/* don't block when locking */

#define	LOCK_UN		0x08		/* unlock file */

#endif

/*

 * XXX missing posix_fadvise() and posix_fallocate(), and POSIX_FADV_* macros.

 */

#ifndef _KERNEL

__BEGIN_DECLS

IMPORT_C int	open(const char *, int, ...);

IMPORT_C int	creat(const char *, mode_t);

IMPORT_C int	fcntl(int, int, ...);

#if __BSD_VISIBLE

int	flock(int, int);

#endif

__END_DECLS

#endif

#endif /* !_SYS_FCNTL_H_ */