The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/fcntl.h

Version: -  FREEBSD  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 1983, 1990, 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  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  * 3. All advertising materials mentioning features or use of this software
   19  *    must display the following acknowledgement:
   20  *      This product includes software developed by the University of
   21  *      California, Berkeley and its contributors.
   22  * 4. Neither the name of the University nor the names of its contributors
   23  *    may be used to endorse or promote products derived from this software
   24  *    without specific prior written permission.
   25  *
   26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   36  * SUCH DAMAGE.
   37  *
   38  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
   39  * $FreeBSD: src/sys/sys/fcntl.h,v 1.9.2.2 2001/06/03 05:00:10 dillon Exp $
   40  */
   41 
   42 #ifndef _SYS_FCNTL_H_
   43 #define _SYS_FCNTL_H_
   44 
   45 #ifndef _SYS_TYPES_H_
   46 #include <sys/types.h>
   47 #endif
   48 
   49 /*
   50  * File status flags: these are used by open(2), fcntl(2).
   51  * They are also used (indirectly) in the kernel file structure f_flags,
   52  * which is a superset of the open/fcntl flags.  Open flags and f_flags
   53  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
   54  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
   55  */
   56 /* open-only flags */
   57 #define O_RDONLY        0x0000          /* open for reading only */
   58 #define O_WRONLY        0x0001          /* open for writing only */
   59 #define O_RDWR          0x0002          /* open for reading and writing */
   60 #define O_ACCMODE       0x0003          /* mask for above modes */
   61 
   62 /*
   63  * Kernel encoding of open mode; separate read and write bits that are
   64  * independently testable: 1 greater than the above.
   65  *
   66  * XXX
   67  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
   68  * which was documented to use FREAD/FWRITE, continues to work.
   69  */
   70 #ifndef _POSIX_SOURCE
   71 #define FREAD           0x0001
   72 #define FWRITE          0x0002
   73 #endif
   74 #define O_NONBLOCK      0x0004          /* no delay */
   75 #define O_APPEND        0x0008          /* set append mode */
   76 #ifndef _POSIX_SOURCE
   77 #define O_SHLOCK        0x0010          /* open with shared file lock */
   78 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
   79 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
   80 #define O_FSYNC         0x0080          /* synchronous writes */
   81 #define O_NOFOLLOW      0x0100          /* don't follow symlinks */
   82 #endif
   83 #define O_SYNC          0x0080          /* Same as O_FSYNC, but POSIX */
   84 #define O_CREAT         0x0200          /* create if nonexistent */
   85 #define O_TRUNC         0x0400          /* truncate to zero length */
   86 #define O_EXCL          0x0800          /* error if already exists */
   87 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
   88 #define FMARK           0x1000          /* mark during gc() */
   89 #define FDEFER          0x2000          /* defer for next gc pass */
   90 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
   91 #endif
   92 
   93 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
   94 #define O_NOCTTY        0x8000          /* don't assign controlling terminal */
   95 
   96 /* Attempt to bypass the buffer cache */
   97 #define O_DIRECT        0x00010000
   98 
   99 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  100 #define O_CLOEXEC       0x00020000      /* atomically set FD_CLOEXEC */
  101 #endif
  102 #define O_FBLOCKING     0x00040000      /* force blocking I/O */
  103 #define O_FNONBLOCKING  0x00080000      /* force non-blocking I/O */
  104 #define O_FAPPEND       0x00100000      /* force append mode for write */
  105 #define O_FOFFSET       0x00200000      /* force specific offset */
  106 #define O_FSYNCWRITE    0x00400000      /* force synchronous write */
  107 #define O_FASYNCWRITE   0x00800000      /* force asynchronous write */
  108 #define O_FUNBUFFERED   0x01000000      /* force unbuffered (direct) I/O */
  109 #define O_FBUFFERED     0x02000000      /* force buffered I/O */
  110 #define O_MAPONREAD     0x04000000      /* memory map read buffer */
  111 
  112 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  113 #define O_DIRECTORY     0x08000000      /* error if not a directory */
  114 #endif
  115 
  116 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  117 #define FREVOKED        0x10000000      /* revoked by fdrevoke() */
  118 #define FAPPENDONLY     0x20000000      /* O_APPEND cannot be changed */
  119 #define FOFFSETLOCK     0x40000000      /* f_offset locked */
  120 #define FOFFSETWAKE     0x80000000      /* f_offset wakeup */
  121 #endif
  122 
  123 #define O_FMASK         (O_FBLOCKING|O_FNONBLOCKING|O_FAPPEND|O_FOFFSET|\
  124                          O_FSYNCWRITE|O_FASYNCWRITE|O_FUNBUFFERED|O_FBUFFERED|\
  125                          O_MAPONREAD)
  126 
  127 #ifdef _KERNEL
  128 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
  129 #define FFLAGS(oflags)  ((oflags) + 1)
  130 #define OFLAGS(fflags)  ((fflags) - 1)
  131 
  132 /* bits to save after open */
  133 #define FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|\
  134                          FAPPENDONLY|FREVOKED|O_DIRECT|O_MAPONREAD)
  135 /* bits settable by fcntl(F_SETFL, ...) */
  136 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|\
  137                          O_DIRECT|O_MAPONREAD)
  138 #endif
  139 
  140 /*
  141  * The O_* flags used to have only F* names, which were used in the kernel
  142  * and by fcntl.  We retain the F* names for the kernel f_flag field
  143  * and for backward compatibility for fcntl.
  144  */
  145 #ifndef _POSIX_SOURCE
  146 #define FAPPEND         O_APPEND        /* kernel/compat */
  147 #define FASYNC          O_ASYNC         /* kernel/compat */
  148 #define FFSYNC          O_FSYNC         /* kernel */
  149 #define FNONBLOCK       O_NONBLOCK      /* kernel */
  150 #define FNDELAY         O_NONBLOCK      /* compat */
  151 #define O_NDELAY        O_NONBLOCK      /* compat */
  152 #endif
  153 
  154 /*
  155  * We are out of bits in f_flag (which is a short).  However,
  156  * the flag bits not set in FMASK are only meaningful in the
  157  * initial open syscall.  Those bits can thus be given a
  158  * different meaning for fcntl(2).
  159  */
  160 #ifndef _POSIX_SOURCE
  161 
  162 /*
  163  * Set by shm_open(3) to get automatic MAP_ASYNC behavior
  164  * for POSIX shared memory objects (which are otherwise
  165  * implemented as plain files).
  166  */
  167 #define FPOSIXSHM       O_NOFOLLOW
  168 #endif
  169 
  170 /*
  171  * Constants used by "at" family of system calls.
  172  */
  173 #define AT_FDCWD                0xFFFAFDCD      /* invalid file descriptor */
  174 #define AT_SYMLINK_NOFOLLOW     1
  175 #define AT_REMOVEDIR            2
  176 #define AT_EACCESS              4
  177 #define AT_SYMLINK_FOLLOW       8
  178 
  179 /*
  180  * Constants used for fcntl(2)
  181  */
  182 
  183 /* command values */
  184 #define F_DUPFD         0               /* duplicate file descriptor */
  185 #define F_GETFD         1               /* get file descriptor flags */
  186 #define F_SETFD         2               /* set file descriptor flags */
  187 #define F_GETFL         3               /* get file status flags */
  188 #define F_SETFL         4               /* set file status flags */
  189 #ifndef _POSIX_SOURCE
  190 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
  191 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
  192 #endif
  193 #define F_GETLK         7               /* get record locking information */
  194 #define F_SETLK         8               /* set record locking information */
  195 #define F_SETLKW        9               /* F_SETLK; wait if blocked */
  196 #define F_DUP2FD        10              /* duplicate file descriptor to arg */
  197 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  198 #define F_DUPFD_CLOEXEC 17              /* Like F_DUPFD with FD_CLOEXEC set */
  199 #endif
  200 #if __BSD_VISIBLE
  201 #define F_DUP2FD_CLOEXEC 18             /* Like F_DUP2FD with FD_CLOEXEC set */
  202 #endif
  203 
  204 /* file descriptor flags (F_GETFD, F_SETFD) */
  205 #define FD_CLOEXEC      1               /* close-on-exec flag */
  206 
  207 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
  208 #define F_RDLCK         1               /* shared or read lock */
  209 #define F_UNLCK         2               /* unlock */
  210 #define F_WRLCK         3               /* exclusive or write lock */
  211 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  212 #define F_WAIT          0x010           /* Wait until lock is granted */
  213 #define F_UNUSED020     0x020
  214 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
  215 #define F_NOEND         0x080           /* l_len = 0, internally used */
  216 #endif
  217 
  218 
  219 /*
  220  * Advisory file segment locking data type -
  221  * information passed to system by user
  222  */
  223 struct flock {
  224         off_t   l_start;        /* starting offset */
  225         off_t   l_len;          /* len = 0 means until end of file */
  226         pid_t   l_pid;          /* lock owner */
  227         short   l_type;         /* lock type: read/write, etc. */
  228         short   l_whence;       /* type of l_start */
  229 };
  230 
  231 #ifdef _KERNEL
  232 union fcntl_dat {
  233         int             fc_fd;          /* F_DUPFD */
  234         int             fc_cloexec;     /* F_GETFD/F_SETFD */
  235         int             fc_flags;       /* F_GETFL/F_SETFL */
  236         int             fc_owner;       /* F_GETOWN/F_SETOWN */
  237         struct flock    fc_flock;       /* F_GETLK/F_SETLK */
  238 };
  239 #endif /* _KERNEL */
  240 
  241 
  242 #ifndef _POSIX_SOURCE
  243 /* lock operations for flock(2) */
  244 #define LOCK_SH         0x01            /* shared file lock */
  245 #define LOCK_EX         0x02            /* exclusive file lock */
  246 #define LOCK_NB         0x04            /* don't block when locking */
  247 #define LOCK_UN         0x08            /* unlock file */
  248 #endif
  249 
  250 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
  251 #include <sys/cdefs.h>
  252 
  253 __BEGIN_DECLS
  254 int     open (const char *, int, ...);
  255 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  256 int     openat (int, const char *, int, ...);
  257 #endif
  258 int     creat (const char *, mode_t);
  259 int     fcntl (int, int, ...);
  260 #ifndef _POSIX_SOURCE
  261 int     flock (int, int);
  262 #endif /* !_POSIX_SOURCE */
  263 __END_DECLS
  264 #endif
  265 
  266 #endif /* !_SYS_FCNTL_H_ */

Cache object: 007a76506843872988279b40942f30d0


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.