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