root/sys/sys/unistd.h
/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1989, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * 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.
 * 3. 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.
 */

#ifndef _SYS_UNISTD_H_
#define _SYS_UNISTD_H_

#include <sys/cdefs.h>

/*
 * POSIX options and option groups we unconditionally do or don't
 * implement.  Those options which are implemented (or not) entirely
 * in user mode are defined in <unistd.h>.  Please keep this list in
 * alphabetical order.
 *
 * Anything which is defined as zero below **must** have an
 * implementation for the corresponding sysconf() which is able to
 * determine conclusively whether or not the feature is supported.
 * Anything which is defined as other than -1 below **must** have
 * complete headers, types, and function declarations as specified by
 * the POSIX standard; however, if the relevant sysconf() function
 * returns -1, the functions may be stubbed out.
 */
#define _POSIX_ADVISORY_INFO            200112L
#define _POSIX_ASYNCHRONOUS_IO          200112L
#define _POSIX_CHOWN_RESTRICTED         1
#define _POSIX_CLOCK_SELECTION          (-1)
#define _POSIX_CPUTIME                  200112L
#define _POSIX_FSYNC                    200112L
#define _POSIX_IPV6                     0
#define _POSIX_JOB_CONTROL              1
#define _POSIX_MAPPED_FILES             200112L
#define _POSIX_MEMLOCK                  (-1)
#define _POSIX_MEMLOCK_RANGE            200112L
#define _POSIX_MEMORY_PROTECTION        200112L
#define _POSIX_MESSAGE_PASSING          200112L
#define _POSIX_MONOTONIC_CLOCK          200112L
#define _POSIX_NO_TRUNC                 1
#define _POSIX_PRIORITIZED_IO           (-1)
#define _POSIX_PRIORITY_SCHEDULING      0
#define _POSIX_RAW_SOCKETS              200112L
#define _POSIX_REALTIME_SIGNALS         200112L
#define _POSIX_SEMAPHORES               200112L
#define _POSIX_SHARED_MEMORY_OBJECTS    200112L
#define _POSIX_SPORADIC_SERVER          (-1)
#define _POSIX_SYNCHRONIZED_IO          (-1)
#define _POSIX_TIMEOUTS                 200112L
#define _POSIX_TIMERS                   200112L
#define _POSIX_TYPED_MEMORY_OBJECTS     (-1)
#define _POSIX_VDISABLE                 0xff

#if __XSI_VISIBLE
#define _XOPEN_SHM                      1
#define _XOPEN_STREAMS                  (-1)
#endif

/*
 * Although we have saved user/group IDs, we do not use them in setuid
 * as described in POSIX 1003.1, because the feature does not work for
 * root.  We use the saved IDs in seteuid/setegid, which are not currently
 * part of the POSIX 1003.1 specification.  XXX revisit for 1003.1-2001
 * as this is now mandatory.
 */
#ifdef  _NOT_AVAILABLE
#define _POSIX_SAVED_IDS        1 /* saved set-user-ID and set-group-ID */
#endif

/* Define the POSIX.1 version we target for compliance. */
#define _POSIX_VERSION          200809L

/* access function */
#define F_OK            0       /* test for existence of file */
#define X_OK            0x01    /* test for execute or search permission */
#define W_OK            0x02    /* test for write permission */
#define R_OK            0x04    /* test for read permission */

/* whence values for lseek(2) */
#ifndef SEEK_SET
#define SEEK_SET        0       /* set file offset to offset */
#define SEEK_CUR        1       /* set file offset to current plus offset */
#define SEEK_END        2       /* set file offset to EOF plus offset */
#endif
#if __BSD_VISIBLE
#define SEEK_DATA       3       /* set file offset to next data past offset */
#define SEEK_HOLE       4       /* set file offset to next hole past offset */
#endif

#ifndef _POSIX_SOURCE
/* whence values for lseek(2); renamed by POSIX 1003.1 */
#define L_SET           SEEK_SET
#define L_INCR          SEEK_CUR
#define L_XTND          SEEK_END
#endif

/* configurable pathname variables */
#define _PC_LINK_MAX             1
#define _PC_MAX_CANON            2
#define _PC_MAX_INPUT            3
#define _PC_NAME_MAX             4
#define _PC_PATH_MAX             5
#define _PC_PIPE_BUF             6
#define _PC_CHOWN_RESTRICTED     7
#define _PC_NO_TRUNC             8
#define _PC_VDISABLE             9

#if __POSIX_VISIBLE >= 199309
#define _PC_ASYNC_IO            53
#define _PC_PRIO_IO             54
#define _PC_SYNC_IO             55
#endif

#if __POSIX_VISIBLE >= 200112
#define _PC_ALLOC_SIZE_MIN      10
#define _PC_FILESIZEBITS        12
#define _PC_REC_INCR_XFER_SIZE  14
#define _PC_REC_MAX_XFER_SIZE   15
#define _PC_REC_MIN_XFER_SIZE   16
#define _PC_REC_XFER_ALIGN      17
#define _PC_SYMLINK_MAX         18
#endif

#if __BSD_VISIBLE
#define _PC_ACL_EXTENDED        59
#define _PC_ACL_PATH_MAX        60
#define _PC_CAP_PRESENT         61
#define _PC_INF_PRESENT         62
#define _PC_MAC_PRESENT         63
#define _PC_ACL_NFS4            64
#define _PC_DEALLOC_PRESENT     65
#define _PC_NAMEDATTR_ENABLED   66
#define _PC_HAS_NAMEDATTR       67
#define _PC_XATTR_ENABLED       _PC_NAMEDATTR_ENABLED   /* Solaris Compatible */
#define _PC_XATTR_EXISTS        _PC_HAS_NAMEDATTR       /* Solaris Compatible */
#define _PC_HAS_HIDDENSYSTEM    68
#define _PC_CLONE_BLKSIZE       69
#define _PC_CASE_INSENSITIVE    70
#endif

/* From OpenSolaris, used by SEEK_DATA/SEEK_HOLE. */
#define _PC_MIN_HOLE_SIZE       21

#if __BSD_VISIBLE
/*
 * rfork() options.
 *
 * XXX currently, some operations without RFPROC set are not supported.
 */
#define RFNAMEG         (1<<0)  /* UNIMPL new plan9 `name space' */
#define RFENVG          (1<<1)  /* UNIMPL copy plan9 `env space' */
#define RFFDG           (1<<2)  /* copy fd table */
#define RFNOTEG         (1<<3)  /* UNIMPL create new plan9 `note group' */
#define RFPROC          (1<<4)  /* change child (else changes curproc) */
#define RFMEM           (1<<5)  /* share `address space' */
#define RFNOWAIT        (1<<6)  /* give child to init */
#define RFCNAMEG        (1<<10) /* UNIMPL zero plan9 `name space' */
#define RFCENVG         (1<<11) /* UNIMPL zero plan9 `env space' */
#define RFCFDG          (1<<12) /* close all fds, zero fd table */
#define RFTHREAD        (1<<13) /* enable kernel thread support */
#define RFSIGSHARE      (1<<14) /* share signal handlers */
#define RFLINUXTHPN     (1<<16) /* do linux clone exit parent notification */
#define RFSTOPPED       (1<<17) /* leave child in a stopped state */
#define RFHIGHPID       (1<<18) /* use a pid higher than 10 (idleproc) */
#define RFTSIGZMB       (1<<19) /* select signal for exit parent notification */
#define RFTSIGSHIFT     20      /* selected signal number is in bits 20-27  */
#define RFTSIGMASK      0xFF
#define RFTSIGNUM(flags)        (((flags) >> RFTSIGSHIFT) & RFTSIGMASK)
#define RFTSIGFLAGS(signum)     ((signum) << RFTSIGSHIFT)
#define RFPROCDESC      (1<<28) /* return a process descriptor */
/* kernel: parent sleeps until child exits (vfork) */
#define RFPPWAIT        (1<<31)
/* user: vfork(2) semantics, clear signals */
#define RFSPAWN         (1U<<31)
#define RFFLAGS         (RFFDG | RFPROC | RFMEM | RFNOWAIT | RFCFDG | \
    RFTHREAD | RFSIGSHARE | RFLINUXTHPN | RFSTOPPED | RFHIGHPID | RFTSIGZMB | \
    RFPROCDESC | RFSPAWN | RFPPWAIT)
#define RFKERNELONLY    (RFSTOPPED | RFHIGHPID | RFPROCDESC)

/* kcmp() options. */
#define KCMP_FILE       100
#define KCMP_FILEOBJ    101
#define KCMP_FILES      102
#define KCMP_SIGHAND    103
#define KCMP_VM         104

#define SWAPOFF_FORCE   0x00000001

/*
 * close_range() options.
 */
#define CLOSE_RANGE_CLOEXEC     (1<<2)
#define CLOSE_RANGE_CLOFORK     (1<<3)

/*
 * copy_file_range flags visible to user space.
 * High order 8 bits reserved for kernel flags.
 * Allocate from bit 23 down, to try and avoid conflicts with
 * future Linux flags.
 */
#define COPY_FILE_RANGE_CLONE           0x00800000      /* Require cloning. */
#define COPY_FILE_RANGE_USERFLAGS       (COPY_FILE_RANGE_CLONE)

#endif /* __BSD_VISIBLE */

#endif /* !_SYS_UNISTD_H_ */