lib/libc/sys/mkfifo.2

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