xref: /freebsd-14.2/lib/libc/sys/mkfifo.2 (revision b2c76c41)
1.\" Copyright (c) 1990, 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.\"	@(#)mkfifo.2	8.1 (Berkeley) 6/4/93
29.\"
30.Dd March 30, 2020
31.Dt MKFIFO 2
32.Os
33.Sh NAME
34.Nm mkfifo ,
35.Nm mkfifoat
36.Nd make a fifo file
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In sys/types.h
41.In sys/stat.h
42.Ft int
43.Fn mkfifo "const char *path" "mode_t mode"
44.Ft int
45.Fn mkfifoat "int fd" "const char *path" "mode_t mode"
46.Sh DESCRIPTION
47The
48.Fn mkfifo
49system call
50creates a new fifo file with name
51.Fa path .
52The access permissions are
53specified by
54.Fa mode
55and restricted by the
56.Xr umask 2
57of the calling process.
58.Pp
59The fifo's owner ID is set to the process's effective user ID.
60The fifo's group ID is set to that of the parent directory in
61which it is created.
62.Pp
63The
64.Fn mkfifoat
65system call is equivalent to
66.Fn mkfifo
67except in the case where
68.Fa path
69specifies a relative path.
70In this case the newly created FIFO is created relative to the
71directory associated with the file descriptor
72.Fa fd
73instead of the current working directory.
74If
75.Fn mkfifoat
76is passed the special value
77.Dv AT_FDCWD
78in the
79.Fa fd
80parameter, the current working directory is used and the behavior is
81identical to a call to
82.Fn mkfifo .
83.Sh RETURN VALUES
84.Rv -std mkfifo
85.Sh ERRORS
86The
87.Fn mkfifo
88system call
89will fail and no fifo will be created if:
90.Bl -tag -width Er
91.It Bq Er ENOTSUP
92The kernel has not been configured to support fifo's.
93.It Bq Er ENOTDIR
94A component of the path prefix is not a directory.
95.It Bq Er ENAMETOOLONG
96A component of a pathname exceeded 255 characters,
97or an entire path name exceeded 1023 characters.
98.It Bq Er ENOENT
99A component of the path prefix does not exist.
100.It Bq Er EACCES
101A component of the path prefix denies search permission, or write permission
102is denied on the parent directory of the fifo to be created.
103.It Bq Er ELOOP
104Too many symbolic links were encountered in translating the pathname.
105.It Bq Er EROFS
106The named file would reside on a read-only file system.
107.It Bq Er EEXIST
108The named file exists.
109.It Bq Er EPERM
110The parent directory of the named file has its immutable flag set, see the
111.Xr chflags 2
112manual page for more information.
113.It Bq Er ENOSPC
114The directory in which the entry for the new fifo is being placed
115cannot be extended because there is no space left on the file
116system containing the directory.
117.It Bq Er ENOSPC
118There are no free inodes on the file system on which the
119fifo is being created.
120.It Bq Er EDQUOT
121The directory in which the entry for the new fifo
122is being placed cannot be extended because the
123user's quota of disk blocks on the file system
124containing the directory has been exhausted.
125.It Bq Er EDQUOT
126The user's quota of inodes on the file system on
127which the fifo is being created has been exhausted.
128.It Bq Er EIO
129An
130.Tn I/O
131error occurred while making the directory entry or allocating the inode.
132.It Bq Er EINTEGRITY
133Corrupted data was detected while reading from the file system.
134.It Bq Er EFAULT
135The
136.Fa path
137argument
138points outside the process's allocated address space.
139.El
140.Pp
141In addition to the errors returned by the
142.Fn mkfifo ,
143the
144.Fn mkfifoat
145may fail if:
146.Bl -tag -width Er
147.It Bq Er EBADF
148The
149.Fa path
150argument does not specify an absolute path and the
151.Fa fd
152argument is neither
153.Dv AT_FDCWD
154nor a valid file descriptor open for searching.
155.It Bq Er ENOTDIR
156The
157.Fa path
158argument is not an absolute path and
159.Fa fd
160is neither
161.Dv AT_FDCWD
162nor a file descriptor associated with a directory.
163.El
164.Sh SEE ALSO
165.Xr chflags 2 ,
166.Xr chmod 2 ,
167.Xr mknod 2 ,
168.Xr stat 2 ,
169.Xr umask 2
170.Sh STANDARDS
171The
172.Fn mkfifo
173system call is expected to conform to
174.St -p1003.1-90 .
175The
176.Fn mkfifoat
177system call follows The Open Group Extended API Set 2 specification.
178.Sh HISTORY
179The
180.Fn mkfifoat
181system call appeared in
182.Fx 8.0 .
183