]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libc/sys/intro.2
MFC r343111,343113-343115 (by mckusick):
[FreeBSD/FreeBSD.git] / lib / libc / sys / intro.2
1 .\" Copyright (c) 1980, 1983, 1986, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)intro.2     8.5 (Berkeley) 2/27/95
29 .\" $FreeBSD$
30 .\"
31 .Dd September 8, 2016
32 .Dt INTRO 2
33 .Os
34 .Sh NAME
35 .Nm intro
36 .Nd introduction to system calls and error numbers
37 .Sh LIBRARY
38 .Lb libc
39 .Sh SYNOPSIS
40 .In errno.h
41 .Sh DESCRIPTION
42 This section provides an overview of the system calls,
43 their error returns, and other common definitions and concepts.
44 .\".Pp
45 .\".Sy System call restart
46 .\".Pp
47 .\"(more later...)
48 .Sh RETURN VALUES
49 Nearly all of the system calls provide an error number referenced via
50 the external identifier errno.
51 This identifier is defined in
52 .In sys/errno.h
53 as
54 .Pp
55 .Dl extern    int *       __error();
56 .Dl #define   errno       (* __error())
57 .Pp
58 The
59 .Va __error()
60 function returns a pointer to a field in the thread specific structure for
61 threads other than the initial thread.
62 For the initial thread and
63 non-threaded processes,
64 .Va __error()
65 returns a pointer to a global
66 .Va errno
67 variable that is compatible with the previous definition.
68 .Pp
69 When a system call detects an error,
70 it returns an integer value
71 indicating failure (usually -1)
72 and sets the variable
73 .Va errno
74 accordingly.
75 (This allows interpretation of the failure on receiving
76 a -1 and to take action accordingly.)
77 Successful calls never set
78 .Va errno ;
79 once set, it remains until another error occurs.
80 It should only be examined after an error.
81 Note that a number of system calls overload the meanings of these
82 error numbers, and that the meanings must be interpreted according
83 to the type and circumstances of the call.
84 .Pp
85 The following is a complete list of the errors and their
86 names as given in
87 .In sys/errno.h .
88 .Bl -hang -width Ds
89 .It Er 0 Em "Undefined error: 0" .
90 Not used.
91 .It Er 1 EPERM Em "Operation not permitted" .
92 An attempt was made to perform an operation limited to processes
93 with appropriate privileges or to the owner of a file or other
94 resources.
95 .It Er 2 ENOENT Em "No such file or directory" .
96 A component of a specified pathname did not exist, or the
97 pathname was an empty string.
98 .It Er 3 ESRCH Em "No such process" .
99 No process could be found corresponding to that specified by the given
100 process ID.
101 .It Er 4 EINTR Em "Interrupted system call" .
102 An asynchronous signal (such as
103 .Dv SIGINT
104 or
105 .Dv SIGQUIT )
106 was caught by the process during the execution of an interruptible
107 function.
108 If the signal handler performs a normal return, the
109 interrupted system call will seem to have returned the error condition.
110 .It Er 5 EIO Em "Input/output error" .
111 Some physical input or output error occurred.
112 This error will not be reported until a subsequent operation on the same file
113 descriptor and may be lost (over written) by any subsequent errors.
114 .It Er 6 ENXIO Em "Device not configured" .
115 Input or output on a special file referred to a device that did not
116 exist, or
117 made a request beyond the limits of the device.
118 This error may also occur when, for example,
119 a tape drive is not online or no disk pack is
120 loaded on a drive.
121 .It Er 7 E2BIG Em "Argument list too long" .
122 The number of bytes used for the argument and environment
123 list of the new process exceeded the current limit
124 .Dv ( NCARGS
125 in
126 .In sys/param.h ) .
127 .It Er 8 ENOEXEC Em "Exec format error" .
128 A request was made to execute a file
129 that, although it has the appropriate permissions,
130 was not in the format required for an
131 executable file.
132 .It Er 9 EBADF Em "Bad file descriptor" .
133 A file descriptor argument was out of range, referred to no open file,
134 or a read (write) request was made to a file that was only open for
135 writing (reading).
136 .It Er 10 ECHILD Em "\&No child processes" .
137 A
138 .Xr wait 2
139 or
140 .Xr waitpid 2
141 function was executed by a process that had no existing or unwaited-for
142 child processes.
143 .It Er 11 EDEADLK Em "Resource deadlock avoided" .
144 An attempt was made to lock a system resource that
145 would have resulted in a deadlock situation.
146 .It Er 12 ENOMEM Em "Cannot allocate memory" .
147 The new process image required more memory than was allowed by the hardware
148 or by system-imposed memory management constraints.
149 A lack of swap space is normally temporary; however,
150 a lack of core is not.
151 Soft limits may be increased to their corresponding hard limits.
152 .It Er 13 EACCES Em "Permission denied" .
153 An attempt was made to access a file in a way forbidden
154 by its file access permissions.
155 .It Er 14 EFAULT Em "Bad address" .
156 The system detected an invalid address in attempting to
157 use an argument of a call.
158 .It Er 15 ENOTBLK Em "Block device required" .
159 A block device operation was attempted on a non-block device or file.
160 .It Er 16 EBUSY Em "Device busy" .
161 An attempt to use a system resource which was in use at the time
162 in a manner which would have conflicted with the request.
163 .It Er 17 EEXIST Em "File exists" .
164 An existing file was mentioned in an inappropriate context,
165 for instance, as the new link name in a
166 .Xr link 2
167 system call.
168 .It Er 18 EXDEV Em "Cross-device link" .
169 A hard link to a file on another file system
170 was attempted.
171 .It Er 19 ENODEV Em "Operation not supported by device" .
172 An attempt was made to apply an inappropriate
173 function to a device,
174 for example,
175 trying to read a write-only device such as a printer.
176 .It Er 20 ENOTDIR Em "Not a directory" .
177 A component of the specified pathname existed, but it was
178 not a directory, when a directory was expected.
179 .It Er 21 EISDIR Em "Is a directory" .
180 An attempt was made to open a directory with write mode specified.
181 .It Er 22 EINVAL Em "Invalid argument" .
182 Some invalid argument was supplied.
183 (For example,
184 specifying an undefined signal to a
185 .Xr signal 3
186 function
187 or a
188 .Xr kill 2
189 system call).
190 .It Er 23 ENFILE Em "Too many open files in system" .
191 Maximum number of open files allowable on the system
192 has been reached and requests for an open cannot be satisfied
193 until at least one has been closed.
194 .It Er 24 EMFILE Em "Too many open files" .
195 Maximum number of file descriptors allowable in the process
196 has been reached and requests for an open cannot be satisfied
197 until at least one has been closed.
198 The
199 .Xr getdtablesize 2
200 system call will obtain the current limit.
201 .It Er 25 ENOTTY Em "Inappropriate ioctl for device" .
202 A control function (see
203 .Xr ioctl 2 )
204 was attempted for a file or
205 special device for which the operation was inappropriate.
206 .It Er 26 ETXTBSY Em "Text file busy" .
207 The new process was a pure procedure (shared text) file
208 which was open for writing by another process, or
209 while the pure procedure file was being executed an
210 .Xr open 2
211 call requested write access.
212 .It Er 27 EFBIG Em "File too large" .
213 The size of a file exceeded the maximum.
214 .It Er 28 ENOSPC Em "No space left on device" .
215 A
216 .Xr write 2
217 to an ordinary file, the creation of a
218 directory or symbolic link, or the creation of a directory
219 entry failed because no more disk blocks were available
220 on the file system, or the allocation of an inode for a newly
221 created file failed because no more inodes were available
222 on the file system.
223 .It Er 29 ESPIPE Em "Illegal seek" .
224 An
225 .Xr lseek 2
226 system call was issued on a socket, pipe or
227 .Tn FIFO .
228 .It Er 30 EROFS Em "Read-only file system" .
229 An attempt was made to modify a file or directory
230 on a file system that was read-only at the time.
231 .It Er 31 EMLINK Em "Too many links" .
232 Maximum allowable hard links to a single file has been exceeded (limit
233 of 32767 hard links per file).
234 .It Er 32 EPIPE Em "Broken pipe" .
235 A write on a pipe, socket or
236 .Tn FIFO
237 for which there is no process
238 to read the data.
239 .It Er 33 EDOM Em "Numerical argument out of domain" .
240 A numerical input argument was outside the defined domain of the mathematical
241 function.
242 .It Er 34 ERANGE Em "Result too large" .
243 A numerical result of the function was too large to fit in the
244 available space (perhaps exceeded precision).
245 .It Er 35 EAGAIN Em "Resource temporarily unavailable" .
246 This is a temporary condition and later calls to the
247 same routine may complete normally.
248 .It Er 36 EINPROGRESS Em "Operation now in progress" .
249 An operation that takes a long time to complete (such as
250 a
251 .Xr connect 2 )
252 was attempted on a non-blocking object (see
253 .Xr fcntl 2 ) .
254 .It Er 37 EALREADY Em "Operation already in progress" .
255 An operation was attempted on a non-blocking object that already
256 had an operation in progress.
257 .It Er 38 ENOTSOCK Em "Socket operation on non-socket" .
258 Self-explanatory.
259 .It Er 39 EDESTADDRREQ Em "Destination address required" .
260 A required address was omitted from an operation on a socket.
261 .It Er 40 EMSGSIZE Em "Message too long" .
262 A message sent on a socket was larger than the internal message buffer
263 or some other network limit.
264 .It Er 41 EPROTOTYPE Em "Protocol wrong type for socket" .
265 A protocol was specified that does not support the semantics of the
266 socket type requested.
267 For example, you cannot use the
268 .Tn ARPA
269 Internet
270 .Tn UDP
271 protocol with type
272 .Dv SOCK_STREAM .
273 .It Er 42 ENOPROTOOPT Em "Protocol not available" .
274 A bad option or level was specified in a
275 .Xr getsockopt 2
276 or
277 .Xr setsockopt 2
278 call.
279 .It Er 43 EPROTONOSUPPORT Em "Protocol not supported" .
280 The protocol has not been configured into the
281 system or no implementation for it exists.
282 .It Er 44 ESOCKTNOSUPPORT Em "Socket type not supported" .
283 The support for the socket type has not been configured into the
284 system or no implementation for it exists.
285 .It Er 45 EOPNOTSUPP Em "Operation not supported" .
286 The attempted operation is not supported for the type of object referenced.
287 Usually this occurs when a file descriptor refers to a file or socket
288 that cannot support this operation,
289 for example, trying to
290 .Em accept
291 a connection on a datagram socket.
292 .It Er 46 EPFNOSUPPORT Em "Protocol family not supported" .
293 The protocol family has not been configured into the
294 system or no implementation for it exists.
295 .It Er 47 EAFNOSUPPORT Em "Address family not supported by protocol family" .
296 An address incompatible with the requested protocol was used.
297 For example, you should not necessarily expect to be able to use
298 .Tn NS
299 addresses with
300 .Tn ARPA
301 Internet protocols.
302 .It Er 48 EADDRINUSE Em "Address already in use" .
303 Only one usage of each address is normally permitted.
304 .It Er 49 EADDRNOTAVAIL Em "Can't assign requested address" .
305 Normally results from an attempt to create a socket with an
306 address not on this machine.
307 .It Er 50 ENETDOWN Em "Network is down" .
308 A socket operation encountered a dead network.
309 .It Er 51 ENETUNREACH Em "Network is unreachable" .
310 A socket operation was attempted to an unreachable network.
311 .It Er 52 ENETRESET Em "Network dropped connection on reset" .
312 The host you were connected to crashed and rebooted.
313 .It Er 53 ECONNABORTED Em "Software caused connection abort" .
314 A connection abort was caused internal to your host machine.
315 .It Er 54 ECONNRESET Em "Connection reset by peer" .
316 A connection was forcibly closed by a peer.
317 This normally
318 results from a loss of the connection on the remote socket
319 due to a timeout or a reboot.
320 .It Er 55 ENOBUFS Em "\&No buffer space available" .
321 An operation on a socket or pipe was not performed because
322 the system lacked sufficient buffer space or because a queue was full.
323 .It Er 56 EISCONN Em "Socket is already connected" .
324 A
325 .Xr connect 2
326 request was made on an already connected socket; or,
327 a
328 .Xr sendto 2
329 or
330 .Xr sendmsg 2
331 request on a connected socket specified a destination
332 when already connected.
333 .It Er 57 ENOTCONN Em "Socket is not connected" .
334 An request to send or receive data was disallowed because
335 the socket was not connected and (when sending on a datagram socket)
336 no address was supplied.
337 .It Er 58 ESHUTDOWN Em "Can't send after socket shutdown" .
338 A request to send data was disallowed because the socket
339 had already been shut down with a previous
340 .Xr shutdown 2
341 call.
342 .It Er 60 ETIMEDOUT Em "Operation timed out" .
343 A
344 .Xr connect 2
345 or
346 .Xr send 2
347 request failed because the connected party did not
348 properly respond after a period of time.
349 (The timeout
350 period is dependent on the communication protocol.)
351 .It Er 61 ECONNREFUSED Em "Connection refused" .
352 No connection could be made because the target machine actively
353 refused it.
354 This usually results from trying to connect
355 to a service that is inactive on the foreign host.
356 .It Er 62 ELOOP Em "Too many levels of symbolic links" .
357 A path name lookup involved more than 32
358 .Pq Dv MAXSYMLINKS
359 symbolic links.
360 .It Er 63 ENAMETOOLONG Em "File name too long" .
361 A component of a path name exceeded
362 .Brq Dv NAME_MAX
363 characters, or an entire
364 path name exceeded
365 .Brq Dv PATH_MAX
366 characters.
367 (See also the description of
368 .Dv _PC_NO_TRUNC
369 in
370 .Xr pathconf 2 . )
371 .It Er 64 EHOSTDOWN Em "Host is down" .
372 A socket operation failed because the destination host was down.
373 .It Er 65 EHOSTUNREACH Em "No route to host" .
374 A socket operation was attempted to an unreachable host.
375 .It Er 66 ENOTEMPTY Em "Directory not empty" .
376 A directory with entries other than
377 .Ql .\&
378 and
379 .Ql ..\&
380 was supplied to a remove directory or rename call.
381 .It Er 67 EPROCLIM Em "Too many processes" .
382 .It Er 68 EUSERS Em "Too many users" .
383 The quota system ran out of table entries.
384 .It Er 69 EDQUOT Em "Disc quota exceeded" .
385 A
386 .Xr write 2
387 to an ordinary file, the creation of a
388 directory or symbolic link, or the creation of a directory
389 entry failed because the user's quota of disk blocks was
390 exhausted, or the allocation of an inode for a newly
391 created file failed because the user's quota of inodes
392 was exhausted.
393 .It Er 70 ESTALE Em "Stale NFS file handle" .
394 An attempt was made to access an open file (on an
395 .Tn NFS
396 file system)
397 which is now unavailable as referenced by the file descriptor.
398 This may indicate the file was deleted on the
399 .Tn NFS
400 server or some
401 other catastrophic event occurred.
402 .It Er 72 EBADRPC Em "RPC struct is bad" .
403 Exchange of
404 .Tn RPC
405 information was unsuccessful.
406 .It Er 73 ERPCMISMATCH Em "RPC version wrong" .
407 The version of
408 .Tn RPC
409 on the remote peer is not compatible with
410 the local version.
411 .It Er 74 EPROGUNAVAIL Em "RPC prog. not avail" .
412 The requested program is not registered on the remote host.
413 .It Er 75 EPROGMISMATCH Em "Program version wrong" .
414 The requested version of the program is not available
415 on the remote host
416 .Pq Tn RPC .
417 .It Er 76 EPROCUNAVAIL Em "Bad procedure for program" .
418 An
419 .Tn RPC
420 call was attempted for a procedure which does not exist
421 in the remote program.
422 .It Er 77 ENOLCK Em "No locks available" .
423 A system-imposed limit on the number of simultaneous file
424 locks was reached.
425 .It Er 78 ENOSYS Em "Function not implemented" .
426 Attempted a system call that is not available on this
427 system.
428 .It Er 79 EFTYPE Em "Inappropriate file type or format" .
429 The file was the wrong type for the operation, or a data file had
430 the wrong format.
431 .It Er 80 EAUTH Em "Authentication error" .
432 Attempted to use an invalid authentication ticket to mount a
433 .Tn NFS
434 file system.
435 .It Er 81 ENEEDAUTH Em "Need authenticator" .
436 An authentication ticket must be obtained before the given
437 .Tn NFS
438 file system may be mounted.
439 .It Er 82 EIDRM Em "Identifier removed" .
440 An IPC identifier was removed while the current process was waiting on it.
441 .It Er 83 ENOMSG Em "No message of desired type" .
442 An IPC message queue does not contain a message of the desired type, or a
443 message catalog does not contain the requested message.
444 .It Er 84 EOVERFLOW Em "Value too large to be stored in data type" .
445 A numerical result of the function was too large to be stored in the caller
446 provided space.
447 .It Er 85 ECANCELED Em "Operation canceled" .
448 The scheduled operation was canceled.
449 .It Er 86 EILSEQ Em "Illegal byte sequence" .
450 While decoding a multibyte character the function came along an
451 invalid or an incomplete sequence of bytes or the given wide
452 character is invalid.
453 .It Er 87 ENOATTR Em "Attribute not found" .
454 The specified extended attribute does not exist.
455 .It Er 88 EDOOFUS Em "Programming error" .
456 A function or API is being abused in a way which could only be detected
457 at run-time.
458 .It Er 89 EBADMSG Em "Bad message" .
459 A corrupted message was detected.
460 .It Er 90 EMULTIHOP Em "Multihop attempted" .
461 This error code is unused, but present for compatibility with other systems.
462 .It Er 91 ENOLINK Em "Link has been severed" .
463 This error code is unused, but present for compatibility with other systems.
464 .It Er 92 EPROTO Em "Protocol error" .
465 A device or socket encountered an unrecoverable protocol error.
466 .It Er 93 ENOTCAPABLE Em "Capabilities insufficient" .
467 An operation on a capability file descriptor requires greater privilege than
468 the capability allows.
469 .It Er 94 ECAPMODE Em "Not permitted in capability mode" .
470 The system call or operation is not permitted for capability mode processes.
471 .It Er 95 ENOTRECOVERABLE Em "State not recoverable" .
472 The state protected by a robust mutex is not recoverable.
473 .It Er 96 EOWNERDEAD Em "Previous owner died" .
474 The owner of a robust mutex terminated while holding the mutex lock.
475 .It Er 97 EINTEGRITY Em "Integrity check failed" .
476 An integrity check such as a check-hash or a cross-correlation failed.
477 The integrity error falls between
478 .Er EINVAL
479 that identifies errors in parameters to a system call and
480 .Er EIO
481 that identifies errors with the underlying storage media.
482 It is typically raised by intermediate kernel layers such as a
483 filesystem or an in-kernel GEOM subsystem when they detect inconsistencies.
484 Uses include allowing the
485 .Xr mount 8
486 command to return a different exit value to automate the running of
487 .Xr fsck 8
488 during a system boot.
489 .El
490 .Sh DEFINITIONS
491 .Bl -tag -width Ds
492 .It Process ID .
493 Each active process in the system is uniquely identified by a non-negative
494 integer called a process ID.
495 The range of this ID is from 0 to 99999.
496 .It Parent process ID
497 A new process is created by a currently active process (see
498 .Xr fork 2 ) .
499 The parent process ID of a process is initially the process ID of its creator.
500 If the creating process exits,
501 the parent process ID of each child is set to the ID of the calling process's
502 reaper (see
503 .Xr procctl 2 ) ,
504 normally
505 .Xr init 8 .
506 .It Process Group
507 Each active process is a member of a process group that is identified by
508 a non-negative integer called the process group ID.
509 This is the process
510 ID of the group leader.
511 This grouping permits the signaling of related
512 processes (see
513 .Xr termios 4 )
514 and the job control mechanisms of
515 .Xr csh 1 .
516 .It Session
517 A session is a set of one or more process groups.
518 A session is created by a successful call to
519 .Xr setsid 2 ,
520 which causes the caller to become the only member of the only process
521 group in the new session.
522 .It Session leader
523 A process that has created a new session by a successful call to
524 .Xr setsid 2 ,
525 is known as a session leader.
526 Only a session leader may acquire a terminal as its controlling terminal (see
527 .Xr termios 4 ) .
528 .It Controlling process
529 A session leader with a controlling terminal is a controlling process.
530 .It Controlling terminal
531 A terminal that is associated with a session is known as the controlling
532 terminal for that session and its members.
533 .It "Terminal Process Group ID"
534 A terminal may be acquired by a session leader as its controlling terminal.
535 Once a terminal is associated with a session, any of the process groups
536 within the session may be placed into the foreground by setting
537 the terminal process group ID to the ID of the process group.
538 This facility is used
539 to arbitrate between multiple jobs contending for the same terminal;
540 (see
541 .Xr csh 1
542 and
543 .Xr tty 4 ) .
544 .It "Orphaned Process Group"
545 A process group is considered to be
546 .Em orphaned
547 if it is not under the control of a job control shell.
548 More precisely, a process group is orphaned
549 when none of its members has a parent process that is in the same session
550 as the group,
551 but is in a different process group.
552 Note that when a process exits, the parent process for its children
553 is normally changed to be
554 .Xr init 8 ,
555 which is in a separate session.
556 Not all members of an orphaned process group are necessarily orphaned
557 processes (those whose creating process has exited).
558 The process group of a session leader is orphaned by definition.
559 .It "Real User ID and Real Group ID"
560 Each user on the system is identified by a positive integer
561 termed the real user ID.
562 .Pp
563 Each user is also a member of one or more groups.
564 One of these groups is distinguished from others and
565 used in implementing accounting facilities.
566 The positive
567 integer corresponding to this distinguished group is termed
568 the real group ID.
569 .Pp
570 All processes have a real user ID and real group ID.
571 These are initialized from the equivalent attributes
572 of the process that created it.
573 .It "Effective User Id, Effective Group Id, and Group Access List"
574 Access to system resources is governed by two values:
575 the effective user ID, and the group access list.
576 The first member of the group access list is also known as the
577 effective group ID.
578 (In POSIX.1, the group access list is known as the set of supplementary
579 group IDs, and it is unspecified whether the effective group ID is
580 a member of the list.)
581 .Pp
582 The effective user ID and effective group ID are initially the
583 process's real user ID and real group ID respectively.
584 Either
585 may be modified through execution of a set-user-ID or set-group-ID
586 file (possibly by one its ancestors) (see
587 .Xr execve 2 ) .
588 By convention, the effective group ID (the first member of the group access
589 list) is duplicated, so that the execution of a set-group-ID program
590 does not result in the loss of the original (real) group ID.
591 .Pp
592 The group access list is a set of group IDs
593 used only in determining resource accessibility.
594 Access checks
595 are performed as described below in ``File Access Permissions''.
596 .It "Saved Set User ID and Saved Set Group ID"
597 When a process executes a new file, the effective user ID is set
598 to the owner of the file if the file is set-user-ID, and the effective
599 group ID (first element of the group access list) is set to the group
600 of the file if the file is set-group-ID.
601 The effective user ID of the process is then recorded as the saved set-user-ID,
602 and the effective group ID of the process is recorded as the saved set-group-ID.
603 These values may be used to regain those values as the effective user
604 or group ID after reverting to the real ID (see
605 .Xr setuid 2 ) .
606 (In POSIX.1, the saved set-user-ID and saved set-group-ID are optional,
607 and are used in setuid and setgid, but this does not work as desired
608 for the super-user.)
609 .It Super-user
610 A process is recognized as a
611 .Em super-user
612 process and is granted special privileges if its effective user ID is 0.
613 .It Descriptor
614 An integer assigned by the system when a file is referenced
615 by
616 .Xr open 2
617 or
618 .Xr dup 2 ,
619 or when a socket is created by
620 .Xr pipe 2 ,
621 .Xr socket 2
622 or
623 .Xr socketpair 2 ,
624 which uniquely identifies an access path to that file or socket from
625 a given process or any of its children.
626 .It File Name
627 Names consisting of up to
628 .Brq Dv NAME_MAX
629 characters may be used to name
630 an ordinary file, special file, or directory.
631 .Pp
632 These characters may be arbitrary eight-bit values,
633 excluding
634 .Dv NUL
635 .Tn ( ASCII
636 0) and the
637 .Ql \&/
638 character (slash,
639 .Tn ASCII
640 47).
641 .Pp
642 Note that it is generally unwise to use
643 .Ql \&* ,
644 .Ql \&? ,
645 .Ql \&[
646 or
647 .Ql \&]
648 as part of
649 file names because of the special meaning attached to these characters
650 by the shell.
651 .It Path Name
652 A path name is a
653 .Dv NUL Ns -terminated
654 character string starting with an
655 optional slash
656 .Ql \&/ ,
657 followed by zero or more directory names separated
658 by slashes, optionally followed by a file name.
659 The total length of a path name must be less than
660 .Brq Dv PATH_MAX
661 characters.
662 (On some systems, this limit may be infinite.)
663 .Pp
664 If a path name begins with a slash, the path search begins at the
665 .Em root
666 directory.
667 Otherwise, the search begins from the current working directory.
668 A slash by itself names the root directory.
669 An empty
670 pathname refers to the current directory.
671 .It Directory
672 A directory is a special type of file that contains entries
673 that are references to other files.
674 Directory entries are called links.
675 By convention, a directory
676 contains at least two links,
677 .Ql .\&
678 and
679 .Ql \&.. ,
680 referred to as
681 .Em dot
682 and
683 .Em dot-dot
684 respectively.
685 Dot refers to the directory itself and
686 dot-dot refers to its parent directory.
687 .It "Root Directory and Current Working Directory"
688 Each process has associated with it a concept of a root directory
689 and a current working directory for the purpose of resolving path
690 name searches.
691 A process's root directory need not be the root
692 directory of the root file system.
693 .It File Access Permissions
694 Every file in the file system has a set of access permissions.
695 These permissions are used in determining whether a process
696 may perform a requested operation on the file (such as opening
697 a file for writing).
698 Access permissions are established at the
699 time a file is created.
700 They may be changed at some later time
701 through the
702 .Xr chmod 2
703 call.
704 .Pp
705 File access is broken down according to whether a file may be: read,
706 written, or executed.
707 Directory files use the execute
708 permission to control if the directory may be searched.
709 .Pp
710 File access permissions are interpreted by the system as
711 they apply to three different classes of users: the owner
712 of the file, those users in the file's group, anyone else.
713 Every file has an independent set of access permissions for
714 each of these classes.
715 When an access check is made, the system
716 decides if permission should be granted by checking the access
717 information applicable to the caller.
718 .Pp
719 Read, write, and execute/search permissions on
720 a file are granted to a process if:
721 .Pp
722 The process's effective user ID is that of the super-user.
723 (Note:
724 even the super-user cannot execute a non-executable file.)
725 .Pp
726 The process's effective user ID matches the user ID of the owner
727 of the file and the owner permissions allow the access.
728 .Pp
729 The process's effective user ID does not match the user ID of the
730 owner of the file, and either the process's effective
731 group ID matches the group ID
732 of the file, or the group ID of the file is in
733 the process's group access list,
734 and the group permissions allow the access.
735 .Pp
736 Neither the effective user ID nor effective group ID
737 and group access list of the process
738 match the corresponding user ID and group ID of the file,
739 but the permissions for ``other users'' allow access.
740 .Pp
741 Otherwise, permission is denied.
742 .It Sockets and Address Families
743 A socket is an endpoint for communication between processes.
744 Each socket has queues for sending and receiving data.
745 .Pp
746 Sockets are typed according to their communications properties.
747 These properties include whether messages sent and received
748 at a socket require the name of the partner, whether communication
749 is reliable, the format used in naming message recipients, etc.
750 .Pp
751 Each instance of the system supports some
752 collection of socket types; consult
753 .Xr socket 2
754 for more information about the types available and
755 their properties.
756 .Pp
757 Each instance of the system supports some number of sets of
758 communications protocols.
759 Each protocol set supports addresses
760 of a certain format.
761 An Address Family is the set of addresses
762 for a specific group of protocols.
763 Each socket has an address
764 chosen from the address family in which the socket was created.
765 .El
766 .Sh SEE ALSO
767 .Xr intro 3 ,
768 .Xr perror 3