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