-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
Copy pathunistd.h
553 lines (470 loc) · 19.6 KB
/
unistd.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
/****************************************************************************
* include/unistd.h
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __INCLUDE_UNISTD_H
#define __INCLUDE_UNISTD_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <sys/types.h>
#include <nuttx/compiler.h>
#include <limits.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Bit values for the second argument to access */
#define F_OK 0 /* Test existence */
#define X_OK 1 /* Test execute permission */
#define W_OK 2 /* Test write permission */
#define R_OK 4 /* Test read permission */
/* POSIX feature set macros */
#define POSIX_VERSION
#undef _POSIX_SAVED_IDS
#undef _POSIX_JOB_CONTROL
#define _POSIX_MESSAGE_PASSING 1
#define _POSIX_PRIORITY_SCHEDULING 1
#ifndef CONFIG_DISABLE_POSIX_TIMERS
# define _POSIX_TIMERS 1
#endif
#if !defined(CONFIG_DISABLE_MQUEUE) && !defined(CONFIG_DISABLE_PTHREAD)
# define _POSIX_TIMEOUTS 1
#endif
#undef _POSIX_MEMLOCK
#undef _POSIX_MEMLOCK_RANGE
#undef _POSIX_FSYNC
#define _POSIX_SYNCHRONIZED_IO 1
#ifdef CONFIG_LIBC_PASSWD_LINESIZE
# define _POSIX_GETPW_R_SIZE_MAX CONFIG_LIBC_PASSWD_LINESIZE
#endif
#define _POSIX_VERSION 201712L
#define _POSIX_PRIORITIZED_IO _POSIX_VERSION
#define _POSIX_CPUTIME _POSIX_VERSION
#define _POSIX_THREAD_CPUTIME _POSIX_VERSION
#define _POSIX_REALTIME_SIGNALS _POSIX_VERSION
#define _POSIX_THREAD_PRIORITY_SCHEDULING _POSIX_VERSION
#define _POSIX_SEMAPHORES _POSIX_VERSION
#define _POSIX_SHARED_MEMORY_OBJECTS _POSIX_VERSION
#define _POSIX_THREAD_PROCESS_SHARED _POSIX_VERSION
#define _POSIX_MAPPED_FILES _POSIX_VERSION
#define _POSIX_THREADS _POSIX_VERSION
#ifdef CONFIG_FS_AIO
# define _POSIX_ASYNCHRONOUS_IO _POSIX_VERSION
#else
# undef _POSIX_ASYNCHRONOUS_IO
#endif
#ifdef CONFIG_SCHED_SPORADIC
# define _POSIX_SPORADIC_SERVER 1
# define _POSIX_THREAD_SPORADIC_SERVER 1
#else
# define _POSIX_SPORADIC_SERVER -1
# define _POSIX_THREAD_SPORADIC_SERVER -1
#endif
/* Execution time constants (not supported) */
#undef _POSIX_CHOWN_RESTRICTED
#undef _POSIX_NO_TRUNC
#undef _POSIX_VDISABLE
#define _POSIX_SYNC_IO 1
#undef _POSIX_ASYNC_IO
#undef _POSIX_PRIO_IO
#define _XOPEN_UNIX 1
#define _XOPEN_VERSION 700L
/* Constants used with POSIX pathconf(). pathconf() will return -1 and set
* errno to ENOSYS for most of these.
*/
#define _PC_2_SYMLINKS 0x0001
#define _PC_ALLOC_SIZE_MIN 0x0002
#define _PC_ASYNC_IO 0x0003
#define _PC_CHOWN_RESTRICTED 0x0004
#define _PC_FILESIZEBITS 0x0005
#define _PC_LINK_MAX 0x0006
#define _PC_MAX_CANON 0x0007
#define _PC_MAX_INPUT 0x0008
#define _PC_NAME_MAX 0x0009
#define _PC_NO_TRUNC 0x000a
#define _PC_PATH_MAX 0x000b
#define _PC_PIPE_BUF 0x000c
#define _PC_PRIO_IO 0x000d
#define _PC_REC_INCR_XFER_SIZE 0x000e
#define _PC_REC_MIN_XFER_SIZE 0x000f
#define _PC_REC_XFER_ALIGN 0x0010
#define _PC_SYMLINK_MAX 0x0011
#define _PC_SYNC_IO 0x0012
#define _PC_VDISABLE 0x0013
/* Constants used with POSIX sysconf(). sysconf() will return -1 and set
* errno to ENOSYS for most of these.
*/
#define _SC_2_C_BIND 0x0001
#define _SC_2_C_DEV 0x0002
#define _SC_2_CHAR_TERM 0x0003
#define _SC_2_FORT_DEV 0x0004
#define _SC_2_FORT_RUN 0x0005
#define _SC_2_LOCALEDEF 0x0006
#define _SC_2_PBS 0x0007
#define _SC_2_PBS_ACCOUNTING 0x0008
#define _SC_2_PBS_CHECKPOINT 0x0009
#define _SC_2_PBS_LOCATE 0x000a
#define _SC_2_PBS_MESSAGE 0x000b
#define _SC_2_PBS_TRACK 0x000c
#define _SC_2_SW_DEV 0x000d
#define _SC_2_UPE 0x000e
#define _SC_2_VERSION 0x000f
#define _SC_ADVISORY_INFO 0x0010
#define _SC_AIO_LISTIO_MAX 0x0011
#define _SC_AIO_MAX 0x0012
#define _SC_AIO_PRIO_DELTA_MAX 0x0013
#define _SC_ARG_MAX 0x0014
#define _SC_ASYNCHRONOUS_IO 0x0015
#define _SC_ATEXIT_MAX 0x0016
#define _SC_BARRIERS 0x0017
#define _SC_BC_BASE_MAX 0x0018
#define _SC_BC_DIM_MAX 0x0019
#define _SC_BC_SCALE_MAX 0x001a
#define _SC_BC_STRING_MAX 0x001b
#define _SC_CHILD_MAX 0x001c
#define _SC_CLK_TCK 0x001d
#define _SC_CLOCK_SELECTION 0x001e
#define _SC_COLL_WEIGHTS_MAX 0x001f
#define _SC_CPUTIME 0x0020
#define _SC_DELAYTIMER_MAX 0x0021
#define _SC_EXPR_NEST_MAX 0x0022
#define _SC_FSYNC 0x0023
#define _SC_GETGR_R_SIZE_MAX 0x0024
#define _SC_GETPW_R_SIZE_MAX 0x0025
#define _SC_HOST_NAME_MAX 0x0026
#define _SC_IOV_MAX 0x0027
#define _SC_IPV6 0x0028
#define _SC_JOB_CONTROL 0x0029
#define _SC_LINE_MAX 0x002a
#define _SC_LOGIN_NAME_MAX 0x002b
#define _SC_MAPPED_FILES 0x002c
#define _SC_MEMLOCK 0x002d
#define _SC_MEMLOCK_RANGE 0x002e
#define _SC_MEMORY_PROTECTION 0x002f
#define _SC_MESSAGE_PASSING 0x0030
#define _SC_MONOTONIC_CLOCK 0x0031
#define _SC_MQ_OPEN_MAX 0x0032
#define _SC_MQ_PRIO_MAX 0x0033
#define _SC_NGROUPS_MAX 0x0034
#define _SC_OPEN_MAX 0x0035
#define _SC_PAGE_SIZE 0x0036
#define _SC_PAGESIZE _SC_PAGE_SIZE
#define _SC_PRIORITIZED_IO 0x0037
#define _SC_PRIORITY_SCHEDULING 0x0038
#define _SC_RAW_SOCKETS 0x0039
#define _SC_RE_DUP_MAX 0x003a
#define _SC_READER_WRITER_LOCKS 0x003b
#define _SC_REALTIME_SIGNALS 0x003c
#define _SC_REGEXP 0x003d
#define _SC_RTSIG_MAX 0x003e
#define _SC_SAVED_IDS 0x003f
#define _SC_SEM_NSEMS_MAX 0x0040
#define _SC_SEM_VALUE_MAX 0x0041
#define _SC_SEMAPHORES 0x0042
#define _SC_SHARED_MEMORY_OBJECTS 0x0043
#define _SC_SHELL 0x0044
#define _SC_SIGQUEUE_MAX 0x0045
#define _SC_SPAWN 0x0046
#define _SC_SPIN_LOCKS 0x0047
#define _SC_SPORADIC_SERVER 0x0048
#define _SC_SS_REPL_MAX 0x0049
#define _SC_STREAM_MAX 0x004a
#define _SC_SYMLOOP_MAX 0x004b
#define _SC_SYNCHRONIZED_IO 0x004c
#define _SC_THREAD_ATTR_STACKADDR 0x004d
#define _SC_THREAD_ATTR_STACKSIZE 0x004e
#define _SC_THREAD_CPUTIME 0x004f
#define _SC_THREAD_DESTRUCTOR_ITERATIONS 0x0050
#define _SC_THREAD_KEYS_MAX 0x0051
#define _SC_THREAD_PRIO_INHERIT 0x0052
#define _SC_THREAD_PRIO_PROTECT 0x0053
#define _SC_THREAD_PRIORITY_SCHEDULING 0x0054
#define _SC_THREAD_PROCESS_SHARED 0x0055
#define _SC_THREAD_SAFE_FUNCTIONS 0x0056
#define _SC_THREAD_SPORADIC_SERVER 0x0057
#define _SC_THREAD_STACK_MIN 0x0058
#define _SC_THREAD_THREADS_MAX 0x0059
#define _SC_THREADS 0x005a
#define _SC_TIMEOUTS 0x005b
#define _SC_TIMER_MAX 0x005c
#define _SC_TIMERS 0x005d
#define _SC_TRACE 0x005e
#define _SC_TRACE_EVENT_FILTER 0x005f
#define _SC_TRACE_EVENT_NAME_MAX 0x0060
#define _SC_TRACE_INHERIT 0x0061
#define _SC_TRACE_LOG 0x0062
#define _SC_TRACE_NAME_MAX 0x0063
#define _SC_TRACE_SYS_MAX 0x0064
#define _SC_TRACE_USER_EVENT_MAX 0x0065
#define _SC_TTY_NAME_MAX 0x0066
#define _SC_TYPED_MEMORY_OBJECTS 0x0067
#define _SC_TZNAME_MAX 0x0068
#define _SC_V6_ILP32_OFF32 0x0069
#define _SC_V6_ILP32_OFFBIG 0x006a
#define _SC_V6_LP64_OFF64 0x006b
#define _SC_V6_LPBIG_OFFBIG 0x006c
#define _SC_VERSION 0x006d
#define _SC_XBS5_ILP32_OFF32 0x006e /* (LEGACY) */
#define _SC_XBS5_ILP32_OFFBIG 0x006f /* (LEGACY) */
#define _SC_XBS5_LP64_OFF64 0x0070 /* (LEGACY) */
#define _SC_XBS5_LPBIG_OFFBIG 0x0071 /* (LEGACY) */
#define _SC_XOPEN_CRYPT 0x0072
#define _SC_XOPEN_ENH_I18N 0x0073
#define _SC_XOPEN_LEGACY 0x0074
#define _SC_XOPEN_REALTIME 0x0075
#define _SC_XOPEN_REALTIME_THREADS 0x0076
#define _SC_XOPEN_SHM 0x0077
#define _SC_XOPEN_STREAMS 0x0078
#define _SC_XOPEN_UNIX 0x0079
#define _SC_XOPEN_VERSION 0x007a
#define _SC_PHYS_PAGES 0x007b
#define _SC_AVPHYS_PAGES 0x007c
#define _SC_NPROCESSORS_CONF 0x007d
#define _SC_NPROCESSORS_ONLN 0x007e
/* The following symbolic constants must be defined for file streams: */
#define STDERR_FILENO 2 /* File number of stderr */
#define STDIN_FILENO 0 /* File number of stdin */
#define STDOUT_FILENO 1 /* File number of stdout */
/* Helpers and legacy compatibility definitions */
#define fdatasync(f) fsync(f)
#define getdtablesize(f) ((int)sysconf(_SC_OPEN_MAX))
#define getpagesize(f) ((int)sysconf(_SC_PAGESIZE))
/* Accessor functions associated with getopt(). */
#define optarg (*(getoptargp()))
#define opterr (*(getopterrp()))
#define optind (*(getoptindp()))
#define optopt (*(getoptoptp()))
#if defined(CONFIG_FS_LARGEFILE)
# define lseek64 lseek
# define pread64 pread
# define pwrite64 pwrite
# define truncate64 truncate
# define ftruncate64 ftruncate
# define lockf64 lockf
#endif
/* NOTE: NuttX provides only one implementation: If
* CONFIG_LIBC_ENVPATH is defined, then only execvp/execlp/execvpe behavior
* is supported; otherwise, only execv/execl/execve behavior is supported.
*/
#ifdef CONFIG_LIBC_EXECFUNCS
# define execvp execv
# define execlp execl
# define execvpe execve
#endif
/* Commands for lockf()
* F_ULOCK - Unlock
* F_LOCK - Blocking Exclusive Lock
* F_TLOCK - Attempted Exclusive Locking
* F_TEST - Test Locked Status
*/
#define F_ULOCK 0
#define F_LOCK 1
#define F_TLOCK 2
#define F_TEST 3
/****************************************************************************
* Public Data
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/* Task Control Interfaces */
pid_t fork(void);
pid_t vfork(void);
pid_t getpid(void);
pid_t getpgid(pid_t pid);
pid_t getpgrp(void);
pid_t gettid(void);
pid_t getppid(void);
void _exit(int status) noreturn_function;
unsigned int sleep(unsigned int seconds);
int usleep(useconds_t usec);
int pause(void);
int nice(int inc);
int daemon(int nochdir, int noclose);
/* File descriptor operations */
int close(int fd);
int dup(int fd);
int dup2(int fd1, int fd2);
int dup3(int fd1, int fd2, int flags);
int fsync(int fd);
off_t lseek(int fd, off_t offset, int whence);
ssize_t read(int fd, FAR void *buf, size_t nbytes);
ssize_t write(int fd, FAR const void *buf, size_t nbytes);
ssize_t pread(int fd, FAR void *buf, size_t nbytes, off_t offset);
ssize_t pwrite(int fd, FAR const void *buf, size_t nbytes, off_t offset);
int ftruncate(int fd, off_t length);
int fchown(int fd, uid_t owner, gid_t group);
int lockf(int fd, int cmd, off_t len);
/* Check if a file descriptor corresponds to a terminal I/O file */
int isatty(int fd);
FAR char *ttyname(int fd);
int ttyname_r(int fd, FAR char *buf, size_t buflen);
/* Memory management */
#if defined(CONFIG_ARCH_ADDRENV) && defined(CONFIG_MM_PGALLOC) && \
defined(CONFIG_ARCH_USE_MMU)
FAR void *sbrk(intptr_t incr);
#endif
/* Special devices */
#define pipe(fd) pipe2(fd, 0)
int pipe2(int pipefd[2], int flags);
/* Schedule an alarm */
unsigned int alarm(unsigned int seconds);
/* Working directory operations */
int chdir(FAR const char *path);
int fchdir(int fd);
FAR char *getcwd(FAR char *buf, size_t size);
FAR char *get_current_dir_name(void);
/* File path operations */
int access(FAR const char *path, int amode);
int faccessat(int dirfd, FAR const char *path, int mode, int flags);
int rmdir(FAR const char *pathname);
int unlink(FAR const char *pathname);
int unlinkat(int dirfd, FAR const char *pathname, int flags);
int truncate(FAR const char *path, off_t length);
int link(FAR const char *path1, FAR const char *path2);
int linkat(int olddirfd, FAR const char *path1,
int newdirfd, FAR const char *path2, int flags);
int symlink(FAR const char *path1, FAR const char *path2);
int symlinkat(FAR const char *path1, int dirfd,
FAR const char *path2);
ssize_t readlink(FAR const char *path, FAR char *buf, size_t bufsize);
ssize_t readlinkat(int dirfd, FAR const char *path, FAR char *buf,
size_t bufsize);
int chown(FAR const char *path, uid_t owner, gid_t group);
int lchown(FAR const char *path, uid_t owner, gid_t group);
int fchownat(int dirfd, FAR const char *path, uid_t owner,
gid_t group, int flags);
/* Execution of programs from files */
#ifdef CONFIG_LIBC_EXECFUNCS
int execl(FAR const char *path, FAR const char *arg0, ...);
int execle(FAR const char *path, FAR const char *arg0, ...);
int execv(FAR const char *path, FAR char * const argv[]);
int execve(FAR const char *path, FAR char *const argv[],
FAR char *const envp[]);
#endif
/* Byte operations */
void swab(FAR const void *src, FAR void *dest, ssize_t nbytes);
/* getopt and friends */
int getopt(int argc, FAR char * const argv[], FAR const char *optstring);
/* Accessor functions associated with getopt(). */
FAR char **getoptargp(void); /* Optional argument following option */
FAR int *getopterrp(void); /* Print error message */
FAR int *getoptindp(void); /* Index into argv */
FAR int *getoptoptp(void); /* Unrecognized option character */
int gethostname(FAR char *name, size_t namelen);
int sethostname(FAR const char *name, size_t namelen);
/* Get configurable system variables */
long sysconf(int name);
long fpathconf(int fildes, int name);
long pathconf(FAR const char *path, int name);
/* User and group identity management */
int setuid(uid_t uid);
uid_t getuid(void);
int setgid(gid_t gid);
gid_t getgid(void);
int seteuid(uid_t uid);
uid_t geteuid(void);
int setegid(gid_t gid);
gid_t getegid(void);
int setreuid(uid_t ruid, uid_t euid);
int setregid(gid_t rgid, gid_t egid);
int getentropy(FAR void *buffer, size_t length);
void sync(void);
int syncfs(int fd);
int profil(FAR unsigned short *buf, size_t bufsiz,
size_t offset, unsigned int scale);
FAR char *getpass(FAR const char *prompt);
#ifdef CONFIG_CRYPTO
FAR char *crypt(FAR const char *key, FAR const char *salt);
FAR char *crypt_r(FAR const char *key, FAR const char *salt,
FAR char *output);
#endif
#if CONFIG_FORTIFY_SOURCE > 0
fortify_function(getcwd) FAR char *getcwd(FAR char *buf,
size_t size)
{
fortify_assert(size <= fortify_size(buf, 0));
return __real_getcwd(buf, size);
}
fortify_function(gethostname) int gethostname(FAR char *name,
size_t namelen)
{
fortify_assert(namelen <= fortify_size(name, 0));
return __real_gethostname(name, namelen);
}
fortify_function(pread) ssize_t pread(int fd, FAR void *buf,
size_t nbytes, off_t offset)
{
fortify_assert(nbytes <= fortify_size(buf, 0));
return __real_pread(fd, buf, nbytes, offset);
}
fortify_function(read) ssize_t read(int fd, FAR void *buf,
size_t nbytes)
{
fortify_assert(nbytes <= fortify_size(buf, 0));
return __real_read(fd, buf, nbytes);
}
fortify_function(readlink) ssize_t readlink(FAR const char *path,
FAR char *buf,
size_t bufsize)
{
fortify_assert(bufsize <= fortify_size(buf, 0));
return __real_readlink(path, buf, bufsize);
}
fortify_function(readlinkat) ssize_t readlinkat(int dirfd,
FAR const char *path,
FAR char *buf,
size_t bufsize)
{
fortify_assert(bufsize <= fortify_size(buf, 0));
return __real_readlinkat(dirfd, path, buf, bufsize);
}
fortify_function(ttyname_r) int ttyname_r(int fd, FAR char *buf,
size_t buflen)
{
fortify_assert(buflen <= fortify_size(buf, 0));
return __real_ttyname_r(fd, buf, buflen);
}
fortify_function(pwrite) ssize_t pwrite(int fd, FAR const void *buf,
size_t nbytes, off_t offset)
{
fortify_assert(nbytes <= fortify_size(buf, 0));
return __real_pwrite(fd, buf, nbytes, offset);
}
fortify_function(write) ssize_t write(int fd, FAR const void *buf,
size_t nbytes)
{
fortify_assert(nbytes <= fortify_size(buf, 0));
return __real_write(fd, buf, nbytes);
}
#endif
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __INCLUDE_UNISTD_H */