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