unistd.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_POSIX_UNISTD_H_
#define ZEPHYR_INCLUDE_POSIX_UNISTD_H_
 
#include "posix_types.h"
 
#ifdef CONFIG_POSIX_API
#include <zephyr/fs/fs.h>
#endif
#ifdef CONFIG_NETWORKING
/* For zsock_gethostname() */
#include <zephyr/net/socket.h>
#include <zephyr/net/hostname.h>
#endif
#ifdef CONFIG_POSIX_SYSCONF
#include <zephyr/posix/signal.h>
#endif
#include <zephyr/posix/sys/confstr.h>
#include <zephyr/posix/sys/stat.h>
#include <zephyr/posix/sys/sysconf.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Version test macros */
#define _POSIX_VERSION 200809L
#define _POSIX2_VERSION (-1L)
#define _XOPEN_VERSION (-1L)
 
/* Internal helper macro to set constant if required Kconfig symbol is enabled */
#define Z_SC_VAL_IFDEF(_def, _val) COND_CODE_1(_def, (_val), (-1L))
 
/* Constants for Options and Option Groups */
#define _POSIX_ADVISORY_INFO              (-1L)
#define _POSIX_ASYNCHRONOUS_IO Z_SC_VAL_IFDEF(CONFIG_POSIX_ASYNCHRONOUS_IO, _POSIX_VERSION)
#define _POSIX_BARRIERS                   Z_SC_VAL_IFDEF(CONFIG_PTHREAD_BARRIER, _POSIX_VERSION)
#define _POSIX_CHOWN_RESTRICTED           (0)
#define _POSIX_CLOCK_SELECTION            Z_SC_VAL_IFDEF(CONFIG_POSIX_CLOCK, _POSIX_VERSION)
#define _POSIX_CPUTIME                    (-1L)
#define _POSIX_FSYNC              Z_SC_VAL_IFDEF(CONFIG_POSIX_FSYNC, _POSIX_VERSION)
#define _POSIX_IPV6                       Z_SC_VAL_IFDEF(CONFIG_NET_IPV6, _POSIX_VERSION)
#define _POSIX_JOB_CONTROL                (-1L)
#define _POSIX_MAPPED_FILES               (-1L)
#define _POSIX_MEMLOCK                    (-1L)
#define _POSIX_MEMLOCK_RANGE              (-1L)
#define _POSIX_MEMORY_PROTECTION          (-1L)
#define _POSIX_MESSAGE_PASSING            Z_SC_VAL_IFDEF(CONFIG_POSIX_MQUEUE, _POSIX_VERSION)
#define _POSIX_MONOTONIC_CLOCK            Z_SC_VAL_IFDEF(CONFIG_POSIX_CLOCK, _POSIX_VERSION)
#define _POSIX_NO_TRUNC                   (0)
#define _POSIX_PRIORITIZED_IO             (-1L)
#define _POSIX_PRIORITY_SCHEDULING Z_SC_VAL_IFDEF(CONFIG_POSIX_PRIORITY_SCHEDULING, _POSIX_VERSION)
#define _POSIX_RAW_SOCKETS                Z_SC_VAL_IFDEF(CONFIG_NET_SOCKETS_PACKET, _POSIX_VERSION)
#define _POSIX_READER_WRITER_LOCKS        Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#define _POSIX_REALTIME_SIGNALS           (-1L)
#define _POSIX_REGEXP                     (-1L)
#define _POSIX_SAVED_IDS                  (-1L)
#define _POSIX_SEMAPHORES                 Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#define _POSIX_SHARED_MEMORY_OBJECTS      (-1L)
#define _POSIX_SHELL                      (-1L)
#define _POSIX_SPAWN                      (-1L)
#define _POSIX_SPIN_LOCKS                 Z_SC_VAL_IFDEF(CONFIG_PTHREAD_SPINLOCK, _POSIX_VERSION)
#define _POSIX_SPORADIC_SERVER            (-1L)
#define _POSIX_SYNCHRONIZED_IO            (-1L)
#define _POSIX_THREAD_ATTR_STACKADDR      Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#define _POSIX_THREAD_ATTR_STACKSIZE      Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#define _POSIX_THREAD_CPUTIME             (-1L)
#define _POSIX_THREAD_PRIO_INHERIT        _POSIX_VERSION
#define _POSIX_THREAD_PRIO_PROTECT        (-1L)
#define _POSIX_THREAD_PRIORITY_SCHEDULING Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#define _POSIX_THREAD_PROCESS_SHARED      (-1L)
#define _POSIX_THREAD_ROBUST_PRIO_INHERIT (-1L)
#define _POSIX_THREAD_ROBUST_PRIO_PROTECT (-1L)
#define _POSIX_THREAD_SAFE_FUNCTIONS      Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#define _POSIX_THREAD_SPORADIC_SERVER     (-1L)
 
#ifndef _POSIX_THREADS
#define _POSIX_THREADS                    Z_SC_VAL_IFDEF(CONFIG_PTHREAD_IPC, _POSIX_VERSION)
#endif
 
#define _POSIX_TIMEOUTS                   Z_SC_VAL_IFDEF(CONFIG_POSIX_CLOCK, _POSIX_VERSION)
#define _POSIX_TIMERS                     Z_SC_VAL_IFDEF(CONFIG_POSIX_CLOCK, _POSIX_VERSION)
#define _POSIX_TRACE                      (-1L)
#define _POSIX_TRACE_EVENT_FILTER         (-1L)
#define _POSIX_TRACE_INHERIT              (-1L)
#define _POSIX_TRACE_LOG                  (-1L)
#define _POSIX_TYPED_MEMORY_OBJECTS       (-1L)
#define _POSIX_V6_ILP32_OFF32             (-1L)
#define _POSIX_V6_ILP32_OFFBIG            (-1L)
#define _POSIX_V6_LP64_OFF64              (-1L)
#define _POSIX_V6_LPBIG_OFFBIG            (-1L)
#define _POSIX_V7_ILP32_OFF32             (-1L)
#define _POSIX_V7_ILP32_OFFBIG            (-1L)
#define _POSIX_V7_LP64_OFF64              (-1L)
#define _POSIX_V7_LPBIG_OFFBIG            (-1L)
#define _POSIX2_C_BIND                    _POSIX_VERSION
#define _POSIX2_C_DEV                     (-1L)
#define _POSIX2_CHAR_TERM                 (-1L)
#define _POSIX2_DELAYTIMER_MAX    (-1L)
#define _POSIX2_FORT_DEV                  (-1L)
#define _POSIX2_FORT_RUN                  (-1L)
#define _POSIX2_LOCALEDEF                 (-1L)
#define _POSIX2_PBS                       (-1L)
#define _POSIX2_PBS_ACCOUNTING            (-1L)
#define _POSIX2_PBS_CHECKPOINT            (-1L)
#define _POSIX2_PBS_LOCATE                (-1L)
#define _POSIX2_PBS_MESSAGE               (-1L)
#define _POSIX2_PBS_TRACK                 (-1L)
#define _POSIX2_SW_DEV                    (-1L)
#define _POSIX2_UPE                       (-1L)
#define _XOPEN_CRYPT                      (-1L)
#define _XOPEN_ENH_I18N                   (-1L)
#define _XOPEN_REALTIME                   (-1L)
#define _XOPEN_REALTIME_THREADS           (-1L)
#define _XOPEN_SHM                        (-1L)
#define _XOPEN_STREAMS                    (-1L)
#define _XOPEN_UNIX                       (-1L)
#define _XOPEN_UUCP                       (-1L)
 
/* Maximum values */
#define _POSIX_CLOCKRES_MIN (20000000L)
 
/* Minimum values */
#define _POSIX_AIO_LISTIO_MAX               (2)
#define _POSIX_AIO_MAX                      (1)
#define _POSIX_ARG_MAX                      (4096)
#define _POSIX_CHILD_MAX                    (25)
#define _POSIX_DELAYTIMER_MAX               (32)
#define _POSIX_HOST_NAME_MAX                (255)
#define _POSIX_LINK_MAX                     (8)
#define _POSIX_LOGIN_NAME_MAX               (9)
#define _POSIX_MAX_CANON                    (255)
#define _POSIX_MAX_INPUT                    (255)
#define _POSIX_MQ_OPEN_MAX                  Z_SC_VAL_IFDEF(CONFIG_POSIX_MQUEUE, \
                                                CONFIG_MSG_COUNT_MAX)
#define _POSIX_MQ_PRIO_MAX                  (32)
#define _POSIX_NAME_MAX                     (14)
#define _POSIX_NGROUPS_MAX                  (8)
#define _POSIX_OPEN_MAX                     CONFIG_POSIX_MAX_FDS
#define _POSIX_PATH_MAX                     (256)
#define _POSIX_PIPE_BUF                     (512)
#define _POSIX_RE_DUP_MAX                   (255)
#define _POSIX_RTSIG_MAX                    CONFIG_POSIX_RTSIG_MAX
#define _POSIX_SEM_NSEMS_MAX                CONFIG_SEM_NAMELEN_MAX
#define _POSIX_SEM_VALUE_MAX                CONFIG_SEM_VALUE_MAX
#define _POSIX_SIGQUEUE_MAX                 (32)
#define _POSIX_SSIZE_MAX                    (32767)
#define _POSIX_SS_REPL_MAX                  (4)
#define _POSIX_STREAM_MAX                   (8)
#define _POSIX_SYMLINK_MAX                  (255)
#define _POSIX_SYMLOOP_MAX                  (8)
#define _POSIX_THREAD_DESTRUCTOR_ITERATIONS (4)
#define _POSIX_THREAD_KEYS_MAX              (128)
#define _POSIX_THREAD_THREADS_MAX           (64)
#define _POSIX_TIMER_MAX                    (32)
#define _POSIX_TRACE_EVENT_NAME_MAX         (30)
#define _POSIX_TRACE_NAME_MAX               (8)
#define _POSIX_TRACE_SYS_MAX                (8)
#define _POSIX_TRACE_USER_EVENT_MAX         (32)
#define _POSIX_TTY_NAME_MAX                 (9)
#define _POSIX_TZNAME_MAX                   (6)
#define _POSIX2_BC_BASE_MAX                 (99)
#define _POSIX2_BC_DIM_MAX                  (2048)
#define _POSIX2_BC_SCALE_MAX                (99)
#define _POSIX2_BC_STRING_MAX               (1000)
#define _POSIX2_CHARCLASS_NAME_MAX          (14)
#define _POSIX2_COLL_WEIGHTS_MAX            (2)
#define _POSIX2_EXPR_NEST_MAX               (32)
#define _POSIX2_LINE_MAX                    (2048)
#define _XOPEN_IOV_MAX                      (16)
#define _XOPEN_NAME_MAX                     (255)
#define _XOPEN_PATH_MAX                     (1024)
 
/* Other invariant values */
#define NL_LANGMAX (14)
#define NL_MSGMAX  (32767)
#define NL_SETMAX  (255)
#define NL_TEXTMAX (_POSIX2_LINE_MAX)
#define NZERO      (20)
 
/* Runtime invariant values */
#define AIO_LISTIO_MAX                _POSIX_AIO_LISTIO_MAX
#define AIO_MAX                       _POSIX_AIO_MAX
#define AIO_PRIO_DELTA_MAX            (0)
#define DELAYTIMER_MAX                _POSIX_DELAYTIMER_MAX
#define HOST_NAME_MAX                 COND_CODE_1(CONFIG_NETWORKING,      \
                                                  (NET_HOSTNAME_MAX_LEN), \
                                                  (_POSIX_HOST_NAME_MAX))
#define LOGIN_NAME_MAX                _POSIX_LOGIN_NAME_MAX
#define MQ_OPEN_MAX                   _POSIX_MQ_OPEN_MAX
#define MQ_PRIO_MAX                   _POSIX_MQ_PRIO_MAX
 
#ifndef ATEXIT_MAX
#define ATEXIT_MAX 8
#endif
 
#ifndef PAGE_SIZE
#define PAGE_SIZE                     BIT(CONFIG_POSIX_PAGE_SIZE_BITS)
#endif
 
#ifndef PAGESIZE
#define PAGESIZE                      PAGE_SIZE
#endif
 
#define PTHREAD_DESTRUCTOR_ITERATIONS _POSIX_THREAD_DESTRUCTOR_ITERATIONS
#define PTHREAD_KEYS_MAX              COND_CODE_1(CONFIG_PTHREAD_IPC,             \
                                                  (CONFIG_MAX_PTHREAD_KEY_COUNT), \
                                                  (_POSIX_THREAD_KEYS_MAX))
#define PTHREAD_THREADS_MAX           COND_CODE_1(CONFIG_PTHREAD_IPC,         \
                                                  (CONFIG_MAX_PTHREAD_COUNT), \
                                                  (0))
#define SEM_NSEMS_MAX                 _POSIX_SEM_NSEMS_MAX
#define SEM_VALUE_MAX                 CONFIG_SEM_VALUE_MAX
#define SIGQUEUE_MAX                  _POSIX_SIGQUEUE_MAX
#define STREAM_MAX                    _POSIX_STREAM_MAX
#define SYMLOOP_MAX                   _POSIX_SYMLOOP_MAX
#define TIMER_MAX                     Z_SC_VAL_IFDEF(CONFIG_TIMER, CONFIG_MAX_TIMER_COUNT)
#define TTY_NAME_MAX                  _POSIX_TTY_NAME_MAX
#define TZNAME_MAX                    _POSIX_TZNAME_MAX
 
/* Pathname variable values */
#define FILESIZEBITS             (32)
#define POSIX_ALLOC_SIZE_MIN     (256)
#define POSIX_REC_INCR_XFER_SIZE (1024)
#define POSIX_REC_MAX_XFER_SIZE  (32767)
#define POSIX_REC_MIN_XFER_SIZE  (1)
#define POSIX_REC_XFER_ALIGN     (4)
#define SYMLINK_MAX              _POSIX_SYMLINK_MAX
 
#ifdef CONFIG_POSIX_API
/* File related operations */
int close(int file);
ssize_t write(int file, const void *buffer, size_t count);
ssize_t read(int file, void *buffer, size_t count);
off_t lseek(int file, off_t offset, int whence);
int fsync(int fd);
int ftruncate(int fd, off_t length);
 
/* File System related operations */
int rename(const char *old, const char *newp);
int unlink(const char *path);
int stat(const char *path, struct stat *buf);
int mkdir(const char *path, mode_t mode);
 
FUNC_NORETURN void _exit(int status);
 
#ifdef CONFIG_NETWORKING
static inline int gethostname(char *buf, size_t len)
{
        return zsock_gethostname(buf, len);
}
#endif /* CONFIG_NETWORKING */
 
#endif /* CONFIG_POSIX_API */
 
#ifdef CONFIG_GETOPT
int getopt(int argc, char *const argv[], const char *optstring);
extern char *optarg;
extern int opterr, optind, optopt;
#endif
 
int getentropy(void *buffer, size_t length);
pid_t getpid(void);
unsigned sleep(unsigned int seconds);
int usleep(useconds_t useconds);
#ifdef CONFIG_POSIX_SYSCONF_IMPL_FULL
long sysconf(int opt);
#endif
#if _POSIX_C_SOURCE >= 2
size_t confstr(int name, char *buf, size_t len);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /* ZEPHYR_INCLUDE_POSIX_UNISTD_H_ */