lib/libc/sys/mknod.2

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