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 /*      $NetBSD: fcntl.h,v 1.34.64.1 2009/03/18 05:33:23 snj Exp $      */
    2 
    3 /*-
    4  * Copyright (c) 1983, 1990, 1993
    5  *      The Regents of the University of California.  All rights reserved.
    6  * (c) UNIX System Laboratories, Inc.
    7  * All or some portions of this file are derived from material licensed
    8  * to the University of California by American Telephone and Telegraph
    9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   10  * the permission of UNIX System Laboratories, Inc.
   11  *
   12  * Redistribution and use in source and binary forms, with or without
   13  * modification, are permitted provided that the following conditions
   14  * are met:
   15  * 1. Redistributions of source code must retain the above copyright
   16  *    notice, this list of conditions and the following disclaimer.
   17  * 2. Redistributions in binary form must reproduce the above copyright
   18  *    notice, this list of conditions and the following disclaimer in the
   19  *    documentation and/or other materials provided with the distribution.
   20  * 3. Neither the name of the University nor the names of its contributors
   21  *    may be used to endorse or promote products derived from this software
   22  *    without specific prior written permission.
   23  *
   24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   34  * SUCH DAMAGE.
   35  *
   36  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
   37  */
   38 
   39 #ifndef _SYS_FCNTL_H_
   40 #define _SYS_FCNTL_H_
   41 
   42 /*
   43  * This file includes the definitions for open and fcntl
   44  * described by POSIX for <fcntl.h>; it also includes
   45  * related kernel definitions.
   46  */
   47 
   48 #ifndef _KERNEL
   49 #include <sys/featuretest.h>
   50 #include <sys/types.h>
   51 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
   52 #include <sys/stat.h>
   53 #endif /* _XOPEN_SOURCE || _NETBSD_SOURCE */
   54 #endif /* !_KERNEL */
   55 
   56 /*
   57  * File status flags: these are used by open(2), fcntl(2).
   58  * They are also used (indirectly) in the kernel file structure f_flags,
   59  * which is a superset of the open/fcntl flags.  Open flags and f_flags
   60  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
   61  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
   62  */
   63 /* open-only flags */
   64 #define O_RDONLY        0x00000000      /* open for reading only */
   65 #define O_WRONLY        0x00000001      /* open for writing only */
   66 #define O_RDWR          0x00000002      /* open for reading and writing */
   67 #define O_ACCMODE       0x00000003      /* mask for above modes */
   68 
   69 /*
   70  * Kernel encoding of open mode; separate read and write bits that are
   71  * independently testable: 1 greater than the above.
   72  *
   73  * XXX
   74  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
   75  * which was documented to use FREAD/FWRITE, continues to work.
   76  */
   77 #if defined(_NETBSD_SOURCE)
   78 #define FREAD           0x00000001
   79 #define FWRITE          0x00000002
   80 #endif
   81 #define O_NONBLOCK      0x00000004      /* no delay */
   82 #define O_APPEND        0x00000008      /* set append mode */
   83 #if defined(_NETBSD_SOURCE)
   84 #define O_SHLOCK        0x00000010      /* open with shared file lock */
   85 #define O_EXLOCK        0x00000020      /* open with exclusive file lock */
   86 #define O_ASYNC         0x00000040      /* signal pgrp when data ready */
   87 #endif
   88 #if (_POSIX_C_SOURCE - 0) >= 199309L || \
   89     (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \
   90     (_XOPEN_SOURCE - 0) >= 500 || defined(_NETBSD_SOURCE)
   91 #define O_SYNC          0x00000080      /* synchronous writes */
   92 #endif
   93 #if defined(_NETBSD_SOURCE)
   94 #define O_NOFOLLOW      0x00000100      /* don't follow symlinks on the last */
   95                                         /* path component */
   96 #endif
   97 #define O_CREAT         0x00000200      /* create if nonexistent */
   98 #define O_TRUNC         0x00000400      /* truncate to zero length */
   99 #define O_EXCL          0x00000800      /* error if already exists */
  100 
  101 #if (_POSIX_C_SOURCE - 0) >= 199309L || (_XOPEN_SOURCE - 0) >= 500 || \
  102     defined(_NETBSD_SOURCE)
  103 #define O_DSYNC         0x00010000      /* write: I/O data completion */
  104 #define O_RSYNC         0x00020000      /* read: I/O completion as for write */
  105 #endif
  106 
  107 #if defined(_NETBSD_SOURCE)
  108 #define O_ALT_IO        0x00040000      /* use alternate i/o semantics */
  109 #define O_DIRECT        0x00080000      /* direct I/O hint */
  110 #endif
  111 
  112 /* defined by POSIX 1003.1; BSD default, but required to be bitwise distinct */
  113 #define O_NOCTTY        0x00008000      /* don't assign controlling terminal */
  114 
  115 #ifdef _KERNEL
  116 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
  117 #define FFLAGS(oflags)  ((oflags) + 1)
  118 #define OFLAGS(fflags)  ((fflags) - 1)
  119 
  120 /* all bits settable during open(2) */
  121 #define O_MASK          (O_ACCMODE|O_NONBLOCK|O_APPEND|O_SHLOCK|O_EXLOCK|\
  122                          O_ASYNC|O_SYNC|O_CREAT|O_TRUNC|O_EXCL|O_DSYNC|\
  123                          O_RSYNC|O_NOCTTY|O_ALT_IO|O_NOFOLLOW|O_DIRECT)
  124 
  125 #define FMARK           0x00001000      /* mark during gc() */
  126 #define FDEFER          0x00002000      /* defer for next gc pass */
  127 #define FHASLOCK        0x00004000      /* descriptor holds advisory lock */
  128 #define FSCAN           0x00100000      /* scan during gc passes */
  129 #define FKIOCTL         0x80000000      /* kernel originated ioctl */
  130 /* bits settable by fcntl(F_SETFL, ...) */
  131 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FDSYNC|FRSYNC|FALTIO|\
  132                          FDIRECT)
  133 /* bits to save after open(2) */
  134 #define FMASK           (FREAD|FWRITE|FCNTLFLAGS)
  135 #endif /* _KERNEL */
  136 
  137 /*
  138  * The O_* flags used to have only F* names, which were used in the kernel
  139  * and by fcntl.  We retain the F* names for the kernel f_flags field
  140  * and for backward compatibility for fcntl.
  141  */
  142 #if defined(_NETBSD_SOURCE)
  143 #define FAPPEND         O_APPEND        /* kernel/compat */
  144 #define FASYNC          O_ASYNC         /* kernel/compat */
  145 #define O_FSYNC         O_SYNC          /* compat */
  146 #define FNDELAY         O_NONBLOCK      /* compat */
  147 #define O_NDELAY        O_NONBLOCK      /* compat */
  148 #endif
  149 #if defined(_KERNEL)
  150 #define FNONBLOCK       O_NONBLOCK      /* kernel */
  151 #define FFSYNC          O_SYNC          /* kernel */
  152 #define FDSYNC          O_DSYNC         /* kernel */
  153 #define FRSYNC          O_RSYNC         /* kernel */
  154 #define FALTIO          O_ALT_IO        /* kernel */
  155 #define FDIRECT         O_DIRECT        /* kernel */
  156 #endif
  157 
  158 /*
  159  * Constants used for fcntl(2)
  160  */
  161 
  162 /* command values */
  163 #define F_DUPFD         0               /* duplicate file descriptor */
  164 #define F_GETFD         1               /* get file descriptor flags */
  165 #define F_SETFD         2               /* set file descriptor flags */
  166 #define F_GETFL         3               /* get file status flags */
  167 #define F_SETFL         4               /* set file status flags */
  168 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 500 || \
  169     defined(_NETBSD_SOURCE)
  170 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
  171 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
  172 #endif
  173 #define F_GETLK         7               /* get record locking information */
  174 #define F_SETLK         8               /* set record locking information */
  175 #define F_SETLKW        9               /* F_SETLK; wait if blocked */
  176 #if defined(_NETBSD_SOURCE)
  177 #define F_CLOSEM        10              /* close all fds >= to the one given */
  178 #define F_MAXFD         11              /* return the max open fd */
  179 #endif
  180 
  181 /* file descriptor flags (F_GETFD, F_SETFD) */
  182 #define FD_CLOEXEC      1               /* close-on-exec flag */
  183 
  184 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
  185 #define F_RDLCK         1               /* shared or read lock */
  186 #define F_UNLCK         2               /* unlock */
  187 #define F_WRLCK         3               /* exclusive or write lock */
  188 #ifdef _KERNEL
  189 #define F_WAIT          0x010           /* Wait until lock is granted */
  190 #define F_FLOCK         0x020           /* Use flock(2) semantics for lock */
  191 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
  192 #endif
  193 
  194 /* Constants for fcntl's passed to the underlying fs - like ioctl's. */
  195 #if defined(_NETBSD_SOURCE)
  196 #define F_PARAM_MASK    0xfff
  197 #define F_PARAM_LEN(x)  (((x) >> 16) & F_PARAM_MASK)
  198 #define F_PARAM_MAX     4095
  199 #define F_FSCTL         (int)0x80000000 /* This fcntl goes to the fs */
  200 #define F_FSVOID        (int)0x40000000 /* no parameters */
  201 #define F_FSOUT         (int)0x20000000 /* copy out parameter */
  202 #define F_FSIN          (int)0x10000000 /* copy in parameter */
  203 #define F_FSINOUT       (F_FSIN | F_FSOUT)
  204 #define F_FSDIRMASK     (int)0x70000000 /* mask for IN/OUT/VOID */
  205 #define F_FSPRIV        (int)0x00008000 /* command is fs-specific */
  206 
  207 /*
  208  * Define command macros for operations which, if implemented, must be
  209  * the same for all fs's.
  210  */
  211 #define _FCN(inout, num, len) \
  212                 (F_FSCTL | inout | ((len & F_PARAM_MASK) << 16) | (num))
  213 #define _FCNO(c)        _FCN(F_FSVOID,  (c), 0)
  214 #define _FCNR(c, t)     _FCN(F_FSIN,    (c), (int)sizeof(t))
  215 #define _FCNW(c, t)     _FCN(F_FSOUT,   (c), (int)sizeof(t))
  216 #define _FCNRW(c, t)    _FCN(F_FSINOUT, (c), (int)sizeof(t))
  217 
  218 /*
  219  * Define command macros for fs-specific commands.
  220  */
  221 #define _FCN_FSPRIV(inout, fs, num, len) \
  222         (F_FSCTL | F_FSPRIV | inout | ((len & F_PARAM_MASK) << 16) |    \
  223          (fs) << 8 | (num))
  224 #define _FCNO_FSPRIV(f, c)      _FCN_FSPRIV(F_FSVOID,  (f), (c), 0)
  225 #define _FCNR_FSPRIV(f, c, t)   _FCN_FSPRIV(F_FSIN,    (f), (c), (int)sizeof(t))
  226 #define _FCNW_FSPRIV(f, c, t)   _FCN_FSPRIV(F_FSOUT,   (f), (c), (int)sizeof(t))
  227 #define _FCNRW_FSPRIV(f, c, t)  _FCN_FSPRIV(F_FSINOUT, (f), (c), (int)sizeof(t))
  228 
  229 #endif /* _NETBSD_SOURCE */
  230 
  231 /*
  232  * Advisory file segment locking data type -
  233  * information passed to system by user
  234  */
  235 struct flock {
  236         off_t   l_start;        /* starting offset */
  237         off_t   l_len;          /* len = 0 means until end of file */
  238         pid_t   l_pid;          /* lock owner */
  239         short   l_type;         /* lock type: read/write, etc. */
  240         short   l_whence;       /* type of l_start */
  241 };
  242 
  243 
  244 #if defined(_NETBSD_SOURCE)
  245 /* lock operations for flock(2) */
  246 #define LOCK_SH         0x01            /* shared file lock */
  247 #define LOCK_EX         0x02            /* exclusive file lock */
  248 #define LOCK_NB         0x04            /* don't block when locking */
  249 #define LOCK_UN         0x08            /* unlock file */
  250 #endif
  251 
  252 /* Always ensure that these are consistent with <stdio.h> and <unistd.h>! */
  253 #ifndef SEEK_SET
  254 #define SEEK_SET        0       /* set file offset to offset */
  255 #endif
  256 #ifndef SEEK_CUR
  257 #define SEEK_CUR        1       /* set file offset to current plus offset */
  258 #endif
  259 #ifndef SEEK_END
  260 #define SEEK_END        2       /* set file offset to EOF plus offset */
  261 #endif
  262 
  263 /*
  264  * posix_advise advisories.
  265  */
  266 
  267 #define POSIX_FADV_NORMAL       0       /* default advice / no advice */
  268 #define POSIX_FADV_RANDOM       1       /* random access */
  269 #define POSIX_FADV_SEQUENTIAL   2       /* sequential access(lower to higher) */
  270 #define POSIX_FADV_WILLNEED     3       /* be needed in near future */
  271 #define POSIX_FADV_DONTNEED     4       /* not be needed in near future */
  272 #define POSIX_FADV_NOREUSE      5       /* be accessed once */
  273 
  274 #ifndef _KERNEL
  275 #include <sys/cdefs.h>
  276 
  277 __BEGIN_DECLS
  278 int     open(const char *, int, ...);
  279 int     creat(const char *, mode_t);
  280 int     fcntl(int, int, ...);
  281 #if defined(_NETBSD_SOURCE)
  282 int     flock(int, int);
  283 #endif /* _NETBSD_SOURCE */
  284 int     posix_fadvise(int, off_t, off_t, int);
  285 __END_DECLS
  286 #endif /* !_KERNEL */
  287 
  288 #endif /* !_SYS_FCNTL_H_ */

Cache object: 98ae0f0080b219f97112d7a078838ca6


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