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  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
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  * 4. Neither the name of the University nor the names of its contributors
   19  *    may be used to endorse or promote products derived from this software
   20  *    without specific prior written permission.
   21  *
   22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   32  * SUCH DAMAGE.
   33  *
   34  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
   35  * $FreeBSD: src/sys/sys/fcntl.h,v 1.16 2004/04/07 04:19:49 imp Exp $
   36  */
   37 
   38 #ifndef _SYS_FCNTL_H_
   39 #define _SYS_FCNTL_H_
   40 
   41 /*
   42  * This file includes the definitions for open and fcntl
   43  * described by POSIX for <fcntl.h>; it also includes
   44  * related kernel definitions.
   45  */
   46 
   47 #include <sys/cdefs.h>
   48 #include <sys/_types.h>
   49 
   50 #ifndef _MODE_T_DECLARED
   51 typedef __mode_t        mode_t;
   52 #define _MODE_T_DECLARED
   53 #endif
   54 
   55 #ifndef _OFF_T_DECLARED
   56 typedef __off_t         off_t;
   57 #define _OFF_T_DECLARED
   58 #endif
   59 
   60 #ifndef _PID_T_DECLARED
   61 typedef __pid_t         pid_t;
   62 #define _PID_T_DECLARED
   63 #endif
   64 
   65 /*
   66  * File status flags: these are used by open(2), fcntl(2).
   67  * They are also used (indirectly) in the kernel file structure f_flags,
   68  * which is a superset of the open/fcntl flags.  Open flags and f_flags
   69  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
   70  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
   71  */
   72 /* open-only flags */
   73 #define O_RDONLY        0x0000          /* open for reading only */
   74 #define O_WRONLY        0x0001          /* open for writing only */
   75 #define O_RDWR          0x0002          /* open for reading and writing */
   76 #define O_ACCMODE       0x0003          /* mask for above modes */
   77 
   78 /*
   79  * Kernel encoding of open mode; separate read and write bits that are
   80  * independently testable: 1 greater than the above.
   81  *
   82  * XXX
   83  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
   84  * which was documented to use FREAD/FWRITE, continues to work.
   85  */
   86 #if __BSD_VISIBLE
   87 #define FREAD           0x0001
   88 #define FWRITE          0x0002
   89 #endif
   90 #define O_NONBLOCK      0x0004          /* no delay */
   91 #define O_APPEND        0x0008          /* set append mode */
   92 #if __BSD_VISIBLE
   93 #define O_SHLOCK        0x0010          /* open with shared file lock */
   94 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
   95 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
   96 #define O_FSYNC         0x0080          /* synchronous writes */
   97 #endif
   98 #define O_SYNC          0x0080          /* POSIX synonym for O_FSYNC */
   99 #if __BSD_VISIBLE
  100 #define O_NOFOLLOW      0x0100          /* don't follow symlinks */
  101 #endif
  102 #define O_CREAT         0x0200          /* create if nonexistent */
  103 #define O_TRUNC         0x0400          /* truncate to zero length */
  104 #define O_EXCL          0x0800          /* error if already exists */
  105 #ifdef _KERNEL
  106 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
  107 #endif
  108 
  109 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
  110 #define O_NOCTTY        0x8000          /* don't assign controlling terminal */
  111 
  112 #if __BSD_VISIBLE
  113 /* Attempt to bypass buffer cache */
  114 #define O_DIRECT        0x00010000
  115 #endif
  116 
  117 /*
  118  * XXX missing O_DSYNC, O_RSYNC.
  119  */
  120 
  121 #ifdef _KERNEL
  122 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
  123 #define FFLAGS(oflags)  ((oflags) + 1)
  124 #define OFLAGS(fflags)  ((fflags) - 1)
  125 
  126 /* bits to save after open */
  127 #define FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT)
  128 /* bits settable by fcntl(F_SETFL, ...) */
  129 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|O_DIRECT)
  130 #endif
  131 
  132 /*
  133  * The O_* flags used to have only F* names, which were used in the kernel
  134  * and by fcntl.  We retain the F* names for the kernel f_flag field
  135  * and for backward compatibility for fcntl.  These flags are deprecated.
  136  */
  137 #if __BSD_VISIBLE
  138 #define FAPPEND         O_APPEND        /* kernel/compat */
  139 #define FASYNC          O_ASYNC         /* kernel/compat */
  140 #define FFSYNC          O_FSYNC         /* kernel */
  141 #define FNONBLOCK       O_NONBLOCK      /* kernel */
  142 #define FNDELAY         O_NONBLOCK      /* compat */
  143 #define O_NDELAY        O_NONBLOCK      /* compat */
  144 #endif
  145 
  146 /*
  147  * We are out of bits in f_flag (which is a short).  However,
  148  * the flag bits not set in FMASK are only meaningful in the
  149  * initial open syscall.  Those bits can thus be given a
  150  * different meaning for fcntl(2).
  151  */
  152 #if __BSD_VISIBLE
  153 
  154 /*
  155  * Set by shm_open(3) to get automatic MAP_ASYNC behavior
  156  * for POSIX shared memory objects (which are otherwise
  157  * implemented as plain files).
  158  */
  159 #define FPOSIXSHM       O_NOFOLLOW
  160 #endif
  161 
  162 /*
  163  * Constants used for fcntl(2)
  164  */
  165 
  166 /* command values */
  167 #define F_DUPFD         0               /* duplicate file descriptor */
  168 #define F_GETFD         1               /* get file descriptor flags */
  169 #define F_SETFD         2               /* set file descriptor flags */
  170 #define F_GETFL         3               /* get file status flags */
  171 #define F_SETFL         4               /* set file status flags */
  172 #if __BSD_VISIBLE || __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
  173 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
  174 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
  175 #endif
  176 #define F_GETLK         7               /* get record locking information */
  177 #define F_SETLK         8               /* set record locking information */
  178 #define F_SETLKW        9               /* F_SETLK; wait if blocked */
  179 
  180 /* file descriptor flags (F_GETFD, F_SETFD) */
  181 #define FD_CLOEXEC      1               /* close-on-exec flag */
  182 
  183 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
  184 #define F_RDLCK         1               /* shared or read lock */
  185 #define F_UNLCK         2               /* unlock */
  186 #define F_WRLCK         3               /* exclusive or write lock */
  187 #ifdef _KERNEL
  188 #define F_WAIT          0x010           /* Wait until lock is granted */
  189 #define F_FLOCK         0x020           /* Use flock(2) semantics for lock */
  190 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
  191 #endif
  192 
  193 /*
  194  * Advisory file segment locking data type -
  195  * information passed to system by user
  196  */
  197 struct flock {
  198         off_t   l_start;        /* starting offset */
  199         off_t   l_len;          /* len = 0 means until end of file */
  200         pid_t   l_pid;          /* lock owner */
  201         short   l_type;         /* lock type: read/write, etc. */
  202         short   l_whence;       /* type of l_start */
  203 };
  204 
  205 
  206 #if __BSD_VISIBLE
  207 /* lock operations for flock(2) */
  208 #define LOCK_SH         0x01            /* shared file lock */
  209 #define LOCK_EX         0x02            /* exclusive file lock */
  210 #define LOCK_NB         0x04            /* don't block when locking */
  211 #define LOCK_UN         0x08            /* unlock file */
  212 #endif
  213 
  214 /*
  215  * XXX missing posix_fadvise() and posix_fallocate(), and POSIX_FADV_* macros.
  216  */
  217 
  218 #ifndef _KERNEL
  219 __BEGIN_DECLS
  220 int     open(const char *, int, ...);
  221 int     creat(const char *, mode_t);
  222 int     fcntl(int, int, ...);
  223 #if __BSD_VISIBLE
  224 int     flock(int, int);
  225 #endif
  226 __END_DECLS
  227 #endif
  228 
  229 #endif /* !_SYS_FCNTL_H_ */

Cache object: 62eca8cdc33e235782242ca07f1d5a3e


[ 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.