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