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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  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  * SPDX-License-Identifier: BSD-3-Clause
    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  * $FreeBSD: stable/12/sys/sys/fcntl.h 326023 2017-11-20 19:43:44Z pfg $
   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 #define _OFF_T_DECLARED
   60 #endif
   61 
   62 #ifndef _PID_T_DECLARED
   63 typedef __pid_t         pid_t;
   64 #define _PID_T_DECLARED
   65 #endif
   66 
   67 /*
   68  * File status flags: these are used by open(2), fcntl(2).
   69  * They are also used (indirectly) in the kernel file structure f_flags,
   70  * which is a superset of the open/fcntl flags.  Open flags and f_flags
   71  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
   72  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
   73  */
   74 /* open-only flags */
   75 #define O_RDONLY        0x0000          /* open for reading only */
   76 #define O_WRONLY        0x0001          /* open for writing only */
   77 #define O_RDWR          0x0002          /* open for reading and writing */
   78 #define O_ACCMODE       0x0003          /* mask for above modes */
   79 
   80 /*
   81  * Kernel encoding of open mode; separate read and write bits that are
   82  * independently testable: 1 greater than the above.
   83  *
   84  * XXX
   85  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
   86  * which was documented to use FREAD/FWRITE, continues to work.
   87  */
   88 #if __BSD_VISIBLE
   89 #define FREAD           0x0001
   90 #define FWRITE          0x0002
   91 #endif
   92 #define O_NONBLOCK      0x0004          /* no delay */
   93 #define O_APPEND        0x0008          /* set append mode */
   94 #if __BSD_VISIBLE
   95 #define O_SHLOCK        0x0010          /* open with shared file lock */
   96 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
   97 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
   98 #define O_FSYNC         0x0080          /* synchronous writes */
   99 #endif
  100 #define O_SYNC          0x0080          /* POSIX synonym for O_FSYNC */
  101 #if __POSIX_VISIBLE >= 200809
  102 #define O_NOFOLLOW      0x0100          /* don't follow symlinks */
  103 #endif
  104 #define O_CREAT         0x0200          /* create if nonexistent */
  105 #define O_TRUNC         0x0400          /* truncate to zero length */
  106 #define O_EXCL          0x0800          /* error if already exists */
  107 #ifdef _KERNEL
  108 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
  109 #endif
  110 
  111 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
  112 #define O_NOCTTY        0x8000          /* don't assign controlling terminal */
  113 
  114 #if __BSD_VISIBLE
  115 /* Attempt to bypass buffer cache */
  116 #define O_DIRECT        0x00010000
  117 #endif
  118 
  119 #if __POSIX_VISIBLE >= 200809
  120 #define O_DIRECTORY     0x00020000      /* Fail if not directory */
  121 #define O_EXEC          0x00040000      /* Open for execute only */
  122 #endif
  123 #ifdef  _KERNEL
  124 #define FEXEC           O_EXEC
  125 #endif
  126 
  127 #if __POSIX_VISIBLE >= 200809
  128 /* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */
  129 #define O_TTY_INIT      0x00080000      /* Restore default termios attributes */
  130 
  131 #define O_CLOEXEC       0x00100000
  132 #endif
  133 
  134 #if __BSD_VISIBLE
  135 #define O_VERIFY        0x00200000      /* open only after verification */
  136 #endif
  137 
  138 /*
  139  * XXX missing O_DSYNC, O_RSYNC.
  140  */
  141 
  142 #ifdef _KERNEL
  143 
  144 /* Only for devfs d_close() flags. */
  145 #define FLASTCLOSE      O_DIRECTORY
  146 #define FREVOKE         O_VERIFY
  147 /* Only for fo_close() from half-succeeded open */
  148 #define FOPENFAILED     O_TTY_INIT
  149 
  150 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
  151 #define FFLAGS(oflags)  ((oflags) & O_EXEC ? (oflags) : (oflags) + 1)
  152 #define OFLAGS(fflags)  ((fflags) & O_EXEC ? (fflags) : (fflags) - 1)
  153 
  154 /* bits to save after open */
  155 #define FMASK   (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT|FEXEC)
  156 /* bits settable by fcntl(F_SETFL, ...) */
  157 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT)
  158 
  159 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \
  160     defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4)
  161 /*
  162  * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC
  163  * behavior for POSIX shared memory objects (which are otherwise
  164  * implemented as plain files).
  165  */
  166 #define FPOSIXSHM       O_NOFOLLOW
  167 #undef FCNTLFLAGS
  168 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \
  169                          O_DIRECT)
  170 #endif
  171 #endif
  172 
  173 /*
  174  * The O_* flags used to have only F* names, which were used in the kernel
  175  * and by fcntl.  We retain the F* names for the kernel f_flag field
  176  * and for backward compatibility for fcntl.  These flags are deprecated.
  177  */
  178 #if __BSD_VISIBLE
  179 #define FAPPEND         O_APPEND        /* kernel/compat */
  180 #define FASYNC          O_ASYNC         /* kernel/compat */
  181 #define FFSYNC          O_FSYNC         /* kernel */
  182 #define FNONBLOCK       O_NONBLOCK      /* kernel */
  183 #define FNDELAY         O_NONBLOCK      /* compat */
  184 #define O_NDELAY        O_NONBLOCK      /* compat */
  185 #endif
  186 
  187 /*
  188  * We are out of bits in f_flag (which is a short).  However,
  189  * the flag bits not set in FMASK are only meaningful in the
  190  * initial open syscall.  Those bits can thus be given a
  191  * different meaning for fcntl(2).
  192  */
  193 #if __BSD_VISIBLE
  194 /* Read ahead */
  195 #define FRDAHEAD        O_CREAT
  196 #endif
  197 
  198 #if __POSIX_VISIBLE >= 200809
  199 /*
  200  * Magic value that specify the use of the current working directory
  201  * to determine the target of relative file paths in the openat() and
  202  * similar syscalls.
  203  */
  204 #define AT_FDCWD                -100
  205 
  206 /*
  207  * Miscellaneous flags for the *at() syscalls.
  208  */
  209 #define AT_EACCESS              0x100   /* Check access using effective user and group ID */
  210 #define AT_SYMLINK_NOFOLLOW     0x200   /* Do not follow symbolic links */
  211 #define AT_SYMLINK_FOLLOW       0x400   /* Follow symbolic link */
  212 #define AT_REMOVEDIR            0x800   /* Remove directory instead of file */
  213 #endif
  214 
  215 /*
  216  * Constants used for fcntl(2)
  217  */
  218 
  219 /* command values */
  220 #define F_DUPFD         0               /* duplicate file descriptor */
  221 #define F_GETFD         1               /* get file descriptor flags */
  222 #define F_SETFD         2               /* set file descriptor flags */
  223 #define F_GETFL         3               /* get file status flags */
  224 #define F_SETFL         4               /* set file status flags */
  225 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
  226 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
  227 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
  228 #endif
  229 #if __BSD_VISIBLE
  230 #define F_OGETLK        7               /* get record locking information */
  231 #define F_OSETLK        8               /* set record locking information */
  232 #define F_OSETLKW       9               /* F_SETLK; wait if blocked */
  233 #define F_DUP2FD        10              /* duplicate file descriptor to arg */
  234 #endif
  235 #define F_GETLK         11              /* get record locking information */
  236 #define F_SETLK         12              /* set record locking information */
  237 #define F_SETLKW        13              /* F_SETLK; wait if blocked */
  238 #if __BSD_VISIBLE
  239 #define F_SETLK_REMOTE  14              /* debugging support for remote locks */
  240 #define F_READAHEAD     15              /* read ahead */
  241 #define F_RDAHEAD       16              /* Darwin compatible read ahead */
  242 #endif
  243 #if __POSIX_VISIBLE >= 200809
  244 #define F_DUPFD_CLOEXEC 17              /* Like F_DUPFD, but FD_CLOEXEC is set */
  245 #endif
  246 #if __BSD_VISIBLE
  247 #define F_DUP2FD_CLOEXEC 18             /* Like F_DUP2FD, but FD_CLOEXEC is set */
  248 #endif
  249 
  250 /* file descriptor flags (F_GETFD, F_SETFD) */
  251 #define FD_CLOEXEC      1               /* close-on-exec flag */
  252 
  253 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
  254 #define F_RDLCK         1               /* shared or read lock */
  255 #define F_UNLCK         2               /* unlock */
  256 #define F_WRLCK         3               /* exclusive or write lock */
  257 #if __BSD_VISIBLE
  258 #define F_UNLCKSYS      4               /* purge locks for a given system ID */ 
  259 #define F_CANCEL        5               /* cancel an async lock request */
  260 #endif
  261 #ifdef _KERNEL
  262 #define F_WAIT          0x010           /* Wait until lock is granted */
  263 #define F_FLOCK         0x020           /* Use flock(2) semantics for lock */
  264 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
  265 #define F_REMOTE        0x080           /* Lock owner is remote NFS client */
  266 #define F_NOINTR        0x100           /* Ignore signals when waiting */
  267 #endif
  268 
  269 /*
  270  * Advisory file segment locking data type -
  271  * information passed to system by user
  272  */
  273 struct flock {
  274         off_t   l_start;        /* starting offset */
  275         off_t   l_len;          /* len = 0 means until end of file */
  276         pid_t   l_pid;          /* lock owner */
  277         short   l_type;         /* lock type: read/write, etc. */
  278         short   l_whence;       /* type of l_start */
  279         int     l_sysid;        /* remote system id or zero for local */
  280 };
  281 
  282 #if __BSD_VISIBLE
  283 /*
  284  * Old advisory file segment locking data type,
  285  * before adding l_sysid.
  286  */
  287 struct __oflock {
  288         off_t   l_start;        /* starting offset */
  289         off_t   l_len;          /* len = 0 means until end of file */
  290         pid_t   l_pid;          /* lock owner */
  291         short   l_type;         /* lock type: read/write, etc. */
  292         short   l_whence;       /* type of l_start */
  293 };
  294 #endif
  295 
  296 #if __BSD_VISIBLE
  297 /* lock operations for flock(2) */
  298 #define LOCK_SH         0x01            /* shared file lock */
  299 #define LOCK_EX         0x02            /* exclusive file lock */
  300 #define LOCK_NB         0x04            /* don't block when locking */
  301 #define LOCK_UN         0x08            /* unlock file */
  302 #endif
  303 
  304 #if __POSIX_VISIBLE >= 200112
  305 /*
  306  * Advice to posix_fadvise
  307  */
  308 #define POSIX_FADV_NORMAL       0       /* no special treatment */
  309 #define POSIX_FADV_RANDOM       1       /* expect random page references */
  310 #define POSIX_FADV_SEQUENTIAL   2       /* expect sequential page references */
  311 #define POSIX_FADV_WILLNEED     3       /* will need these pages */
  312 #define POSIX_FADV_DONTNEED     4       /* dont need these pages */
  313 #define POSIX_FADV_NOREUSE      5       /* access data only once */
  314 #endif
  315 
  316 #ifndef _KERNEL
  317 __BEGIN_DECLS
  318 int     open(const char *, int, ...);
  319 int     creat(const char *, mode_t);
  320 int     fcntl(int, int, ...);
  321 #if __BSD_VISIBLE
  322 int     flock(int, int);
  323 #endif
  324 #if __POSIX_VISIBLE >= 200809
  325 int     openat(int, const char *, int, ...);
  326 #endif
  327 #if __POSIX_VISIBLE >= 200112
  328 int     posix_fadvise(int, off_t, off_t, int);
  329 int     posix_fallocate(int, off_t, off_t);
  330 #endif
  331 __END_DECLS
  332 #endif
  333 
  334 #endif /* !_SYS_FCNTL_H_ */

Cache object: 412603abd7989be2f017d4f2880ec943


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