lib/libc/sys/unlink.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 .\"     @(#)unlink.2    8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 30, 2020
  32 .Dt UNLINK 2
  33 .Os
  34 .Sh NAME
  35 .Nm unlink ,
  36 .Nm unlinkat ,
  37 .Nm funlinkat
  38 .Nd remove directory entry
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In unistd.h
  43 .Ft int
  44 .Fn unlink "const char *path"
  45 .Ft int
  46 .Fn unlinkat "int dfd" "const char *path" "int flag"
  47 .Ft int
  48 .Fn funlinkat "int dfd" "const char *path" "int fd" "int flag"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn unlink
  52 system call
  53 removes the link named by
  54 .Fa path
  55 from its directory and decrements the link count of the
  56 file which was referenced by the link.
  57 If that decrement reduces the link count of the file
  58 to zero,
  59 and no process has the file open, then
  60 all resources associated with the file are reclaimed.
  61 If one or more process have the file open when the last link is removed,
  62 the link is removed, but the removal of the file is delayed until
  63 all references to it have been closed.
  64 The
  65 .Fa path
  66 argument
  67 may not be a directory.
  68 .Pp
  69 The
  70 .Fn unlinkat
  71 system call is equivalent to
  72 .Fn unlink
  73 or
  74 .Fn rmdir
  75 except in the case where
  76 .Fa path
  77 specifies a relative path.
  78 In this case the directory entry to be removed is determined
  79 relative to the directory associated with the file descriptor
  80 .Fa dfd
  81 instead of the current working directory.
  82 .Pp
  83 The values for
  84 .Fa flag
  85 are constructed by a bitwise-inclusive OR of flags from the following list,
  86 defined in
  87 .In fcntl.h :
  88 .Bl -tag -width indent
  89 .It Dv AT_REMOVEDIR
  90 Remove the directory entry specified by
  91 .Fa fd
  92 and
  93 .Fa path
  94 as a directory, not a normal file.
  95 .It Dv AT_BENEATH
  96 Only unlink files and directories which are beneath of the topping
  97 directory.
  98 See the description of the
  99 .Dv O_BENEATH
 100 flag in the
 101 .Xr open 2
 102 manual page.
 103 .El
 104 .Pp
 105 If
 106 .Fn unlinkat
 107 is passed the special value
 108 .Dv AT_FDCWD
 109 in the
 110 .Fa fd
 111 parameter, the current working directory is used and the behavior is
 112 identical to a call to
 113 .Fa unlink
 114 or
 115 .Fa rmdir
 116 respectively, depending on whether or not the
 117 .Dv AT_REMOVEDIR
 118 bit is set in flag.
 119 .Pp
 120 The
 121 .Fn funlinkat
 122 system call can be used to unlink an already-opened file, unless that
 123 file has been replaced since it was opened.
 124 It is equivalent to
 125 .Fn unlinkat
 126 in the case where
 127 .Fa path
 128 is already open as the file descriptor
 129 .Fa fd .
 130 Otherwise, the path will not be removed and an error will be returned.
 131 The
 132 .Fa fd
 133 can be set the
 134 .Dv FD_NONE .
 135 In that case
 136 .Fn funlinkat
 137 behaves exactly like
 138 .Fn unlinkat .
 139 .Sh RETURN VALUES
 140 .Rv -std unlink
 141 .Sh ERRORS
 142 The
 143 .Fn unlink
 144 succeeds unless:
 145 .Bl -tag -width Er
 146 .It Bq Er ENOTDIR
 147 A component of the path prefix is not a directory.
 148 .It Bq Er EISDIR
 149 The named file is a directory.
 150 .It Bq Er ENAMETOOLONG
 151 A component of a pathname exceeded 255 characters,
 152 or an entire path name exceeded 1023 characters.
 153 .It Bq Er ENOENT
 154 The named file does not exist.
 155 .It Bq Er EACCES
 156 Search permission is denied for a component of the path prefix.
 157 .It Bq Er EACCES
 158 Write permission is denied on the directory containing the link
 159 to be removed.
 160 .It Bq Er ELOOP
 161 Too many symbolic links were encountered in translating the pathname.
 162 .It Bq Er EPERM
 163 The named file is a directory.
 164 .It Bq Er EPERM
 165 The named file has its immutable, undeletable or append-only flag set, see the
 166 .Xr chflags 2
 167 manual page for more information.
 168 .It Bq Er EPERM
 169 The parent directory of the named file has its immutable or append-only flag
 170 set.
 171 .It Bq Er EPERM
 172 The directory containing the file is marked sticky,
 173 and neither the containing directory nor the file to be removed
 174 are owned by the effective user ID.
 175 .It Bq Er EIO
 176 An I/O error occurred while deleting the directory entry
 177 or deallocating the inode.
 178 .It Bq Er EINTEGRITY
 179 Corrupted data was detected while reading from the file system.
 180 .It Bq Er EROFS
 181 The named file resides on a read-only file system.
 182 .It Bq Er EFAULT
 183 The
 184 .Fa path
 185 argument
 186 points outside the process's allocated address space.
 187 .It Bq Er ENOSPC
 188 On file systems supporting copy-on-write or snapshots, there was not enough
 189 free space to record metadata for the delete operation of the file.
 190 .El
 191 .Pp
 192 In addition to the errors returned by the
 193 .Fn unlink ,
 194 the
 195 .Fn unlinkat
 196 may fail if:
 197 .Bl -tag -width Er
 198 .It Bq Er EBADF
 199 The
 200 .Fa path
 201 argument does not specify an absolute path and the
 202 .Fa fd
 203 argument is neither
 204 .Dv AT_FDCWD
 205 nor a valid file descriptor open for searching.
 206 .It Bq Er ENOTEMPTY
 207 The
 208 .Fa flag
 209 parameter has the
 210 .Dv AT_REMOVEDIR
 211 bit set and the
 212 .Fa path
 213 argument names a directory that is not an empty directory,
 214 or there are hard links to the directory other than dot or
 215 a single entry in dot-dot.
 216 .It Bq Er ENOTDIR
 217 The
 218 .Fa flag
 219 parameter has the
 220 .Dv AT_REMOVEDIR
 221 bit set and
 222 .Fa path
 223 does not name a directory.
 224 .It Bq Er EINVAL
 225 The value of the
 226 .Fa flag
 227 argument is not valid.
 228 .It Bq Er ENOTDIR
 229 The
 230 .Fa path
 231 argument is not an absolute path and
 232 .Fa fd
 233 is neither
 234 .Dv AT_FDCWD
 235 nor a file descriptor associated with a directory.
 236 .It Bq Er ENOTCAPABLE
 237 .Fa path
 238 is an absolute path,
 239 or contained a ".." component leading to a
 240 directory outside of the directory hierarchy specified by
 241 .Fa fd ,
 242 and the process is in capability mode.
 243 .It Bq Er ENOTCAPABLE
 244 The
 245 .Dv AT_BENEATH
 246 flag was provided to
 247 .Fn unlinkat ,
 248 and the absolute
 249 .Fa path
 250 does not have its tail fully contained under the topping directory,
 251 or the relative
 252 .Fa path
 253 escapes it.
 254 .El
 255 .Pp
 256 In addition to the errors returned by
 257 .Fn unlinkat ,
 258 .Fn funlinkat
 259 may fail if:
 260 .Bl -tag -width Er
 261 .It Bq Er EDEADLK
 262 The file descriptor is not associated with the path.
 263 .El
 264 .Sh SEE ALSO
 265 .Xr chflags 2 ,
 266 .Xr close 2 ,
 267 .Xr link 2 ,
 268 .Xr rmdir 2 ,
 269 .Xr symlink 7
 270 .Sh STANDARDS
 271 The
 272 .Fn unlinkat
 273 system call follows The Open Group Extended API Set 2 specification.
 274 .Sh HISTORY
 275 The
 276 .Fn unlink
 277 function appeared in
 278 .At v1 .
 279 The
 280 .Fn unlinkat
 281 system call appeared in
 282 .Fx 8.0 .
 283 The
 284 .Fn funlinkat
 285 system call appeared in
 286 .Fx 13.0 .
 287 .Pp
 288 The
 289 .Fn unlink
 290 system call traditionally allows the super-user to unlink directories which
 291 can damage the file system integrity.
 292 This implementation no longer permits it.