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