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