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 June 6, 2019
  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 EROFS
 179 The named file resides on a read-only file system.
 180 .It Bq Er EFAULT
 181 The
 182 .Fa path
 183 argument
 184 points outside the process's allocated address space.
 185 .It Bq Er ENOSPC
 186 On file systems supporting copy-on-write or snapshots, there was not enough
 187 free space to record metadata for the delete operation of the file.
 188 .El
 189 .Pp
 190 In addition to the errors returned by the
 191 .Fn unlink ,
 192 the
 193 .Fn unlinkat
 194 may fail if:
 195 .Bl -tag -width Er
 196 .It Bq Er EBADF
 197 The
 198 .Fa path
 199 argument does not specify an absolute path and the
 200 .Fa fd
 201 argument is neither
 202 .Dv AT_FDCWD
 203 nor a valid file descriptor open for searching.
 204 .It Bq Er ENOTEMPTY
 205 The
 206 .Fa flag
 207 parameter has the
 208 .Dv AT_REMOVEDIR
 209 bit set and the
 210 .Fa path
 211 argument names a directory that is not an empty directory,
 212 or there are hard links to the directory other than dot or
 213 a single entry in dot-dot.
 214 .It Bq Er ENOTDIR
 215 The
 216 .Fa flag
 217 parameter has the
 218 .Dv AT_REMOVEDIR
 219 bit set and
 220 .Fa path
 221 does not name a directory.
 222 .It Bq Er EINVAL
 223 The value of the
 224 .Fa flag
 225 argument is not valid.
 226 .It Bq Er ENOTDIR
 227 The
 228 .Fa path
 229 argument is not an absolute path and
 230 .Fa fd
 231 is neither
 232 .Dv AT_FDCWD
 233 nor a file descriptor associated with a directory.
 234 .It Bq Er ENOTCAPABLE
 235 .Fa path
 236 is an absolute path,
 237 or contained a ".." component leading to a
 238 directory outside of the directory hierarchy specified by
 239 .Fa fd ,
 240 and the process is in capability mode.
 241 .It Bq Er ENOTCAPABLE
 242 The
 243 .Dv AT_BENEATH
 244 flag was provided to
 245 .Fn unlinkat ,
 246 and the absolute
 247 .Fa path
 248 does not have its tail fully contained under the topping directory,
 249 or the relative
 250 .Fa path
 251 escapes it.
 252 .El
 253 .Pp
 254 In addition to the errors returned by
 255 .Fn unlinkat ,
 256 .Fn funlinkat
 257 may fail if:
 258 .Bl -tag -width Er
 259 .It Bq Er EDEADLK
 260 The file descriptor is not associated with the path.
 261 .El
 262 .Sh SEE ALSO
 263 .Xr chflags 2 ,
 264 .Xr close 2 ,
 265 .Xr link 2 ,
 266 .Xr rmdir 2 ,
 267 .Xr symlink 7
 268 .Sh STANDARDS
 269 The
 270 .Fn unlinkat
 271 system call follows The Open Group Extended API Set 2 specification.
 272 .Sh HISTORY
 273 The
 274 .Fn unlink
 275 function appeared in
 276 .At v1 .
 277 The
 278 .Fn unlinkat
 279 system call appeared in
 280 .Fx 8.0 .
 281 The
 282 .Fn funlinkat
 283 system call appeared in
 284 .Fx 13.0 .
 285 .Pp
 286 The
 287 .Fn unlink
 288 system call traditionally allows the super-user to unlink directories which
 289 can damage the file system integrity.
 290 This implementation no longer permits it.