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 February 23, 2021
  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_RESOLVE_BENEATH
  96 Only walk paths below the directory specified by the
  97 .Ar fd
  98 descriptor.
  99 See the description of the
 100 .Dv O_RESOLVE_BENEATH
 101 flag in the
 102 .Xr open 2
 103 manual page.
 104 .El
 105 .Pp
 106 If
 107 .Fn unlinkat
 108 is passed the special value
 109 .Dv AT_FDCWD
 110 in the
 111 .Fa fd
 112 parameter, the current working directory is used and the behavior is
 113 identical to a call to
 114 .Fa unlink
 115 or
 116 .Fa rmdir
 117 respectively, depending on whether or not the
 118 .Dv AT_REMOVEDIR
 119 bit is set in flag.
 120 .Pp
 121 The
 122 .Fn funlinkat
 123 system call can be used to unlink an already-opened file, unless that
 124 file has been replaced since it was opened.
 125 It is equivalent to
 126 .Fn unlinkat
 127 in the case where
 128 .Fa path
 129 is already open as the file descriptor
 130 .Fa fd .
 131 Otherwise, the path will not be removed and an error will be returned.
 132 The
 133 .Fa fd
 134 can be set the
 135 .Dv FD_NONE .
 136 In that case
 137 .Fn funlinkat
 138 behaves exactly like
 139 .Fn unlinkat .
 140 .Sh RETURN VALUES
 141 .Rv -std unlink
 142 .Sh ERRORS
 143 The
 144 .Fn unlink
 145 succeeds unless:
 146 .Bl -tag -width Er
 147 .It Bq Er ENOTDIR
 148 A component of the path prefix is not a directory.
 149 .It Bq Er EISDIR
 150 The named file is a directory.
 151 .It Bq Er ENAMETOOLONG
 152 A component of a pathname exceeded 255 characters,
 153 or an entire path name exceeded 1023 characters.
 154 .It Bq Er ENOENT
 155 The named file does not exist.
 156 .It Bq Er EACCES
 157 Search permission is denied for a component of the path prefix.
 158 .It Bq Er EACCES
 159 Write permission is denied on the directory containing the link
 160 to be removed.
 161 .It Bq Er ELOOP
 162 Too many symbolic links were encountered in translating the pathname.
 163 .It Bq Er EPERM
 164 The named file is a directory.
 165 .It Bq Er EPERM
 166 The named file has its immutable, undeletable or append-only flag set, see the
 167 .Xr chflags 2
 168 manual page for more information.
 169 .It Bq Er EPERM
 170 The parent directory of the named file has its immutable or append-only flag
 171 set.
 172 .It Bq Er EPERM
 173 The directory containing the file is marked sticky,
 174 and neither the containing directory nor the file to be removed
 175 are owned by the effective user ID.
 176 .It Bq Er EIO
 177 An I/O error occurred while deleting the directory entry
 178 or deallocating the inode.
 179 .It Bq Er EINTEGRITY
 180 Corrupted data was detected while reading from the file system.
 181 .It Bq Er EROFS
 182 The named file resides on a read-only file system.
 183 .It Bq Er EFAULT
 184 The
 185 .Fa path
 186 argument
 187 points outside the process's allocated address space.
 188 .It Bq Er ENOSPC
 189 On file systems supporting copy-on-write or snapshots, there was not enough
 190 free space to record metadata for the delete operation of the file.
 191 .El
 192 .Pp
 193 In addition to the errors returned by the
 194 .Fn unlink ,
 195 the
 196 .Fn unlinkat
 197 may fail if:
 198 .Bl -tag -width Er
 199 .It Bq Er EBADF
 200 The
 201 .Fa path
 202 argument does not specify an absolute path and the
 203 .Fa fd
 204 argument is neither
 205 .Dv AT_FDCWD
 206 nor a valid file descriptor open for searching.
 207 .It Bq Er ENOTEMPTY
 208 The
 209 .Fa flag
 210 parameter has the
 211 .Dv AT_REMOVEDIR
 212 bit set and the
 213 .Fa path
 214 argument names a directory that is not an empty directory,
 215 or there are hard links to the directory other than dot or
 216 a single entry in dot-dot.
 217 .It Bq Er ENOTDIR
 218 The
 219 .Fa flag
 220 parameter has the
 221 .Dv AT_REMOVEDIR
 222 bit set and
 223 .Fa path
 224 does not name a directory.
 225 .It Bq Er EINVAL
 226 The value of the
 227 .Fa flag
 228 argument is not valid.
 229 .It Bq Er ENOTDIR
 230 The
 231 .Fa path
 232 argument is not an absolute path and
 233 .Fa fd
 234 is neither
 235 .Dv AT_FDCWD
 236 nor a file descriptor associated with a directory.
 237 .It Bq Er ENOTCAPABLE
 238 .Fa path
 239 is an absolute path,
 240 or contained a ".." component leading to a
 241 directory outside of the directory hierarchy specified by
 242 .Fa fd ,
 243 and the process is in capability mode or the
 244 .Dv AT_RESOLVE_BENEATH
 245 flag was specified.
 246 .El
 247 .Pp
 248 In addition to the errors returned by
 249 .Fn unlinkat ,
 250 .Fn funlinkat
 251 may fail if:
 252 .Bl -tag -width Er
 253 .It Bq Er EDEADLK
 254 The file descriptor is not associated with the path.
 255 .El
 256 .Sh SEE ALSO
 257 .Xr chflags 2 ,
 258 .Xr close 2 ,
 259 .Xr link 2 ,
 260 .Xr rmdir 2 ,
 261 .Xr symlink 7
 262 .Sh STANDARDS
 263 The
 264 .Fn unlinkat
 265 system call follows The Open Group Extended API Set 2 specification.
 266 .Sh HISTORY
 267 The
 268 .Fn unlink
 269 function appeared in
 270 .At v1 .
 271 The
 272 .Fn unlinkat
 273 system call appeared in
 274 .Fx 8.0 .
 275 The
 276 .Fn funlinkat
 277 system call appeared in
 278 .Fx 13.0 .
 279 .Pp
 280 The
 281 .Fn unlink
 282 system call traditionally allows the super-user to unlink directories which
 283 can damage the file system integrity.
 284 This implementation no longer permits it.