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 .Nd remove directory entry
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft int
  43 .Fn unlink "const char *path"
  44 .Ft int
  45 .Fn unlinkat "int fd" "const char *path" "int flag"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn unlink
  49 system call
  50 removes the link named by
  51 .Fa path
  52 from its directory and decrements the link count of the
  53 file which was referenced by the link.
  54 If that decrement reduces the link count of the file
  55 to zero,
  56 and no process has the file open, then
  57 all resources associated with the file are reclaimed.
  58 If one or more process have the file open when the last link is removed,
  59 the link is removed, but the removal of the file is delayed until
  60 all references to it have been closed.
  61 The
  62 .Fa path
  63 argument
  64 may not be a directory.
  65 .Pp
  66 The
  67 .Fn unlinkat
  68 system call is equivalent to
  69 .Fn unlink
  70 or
  71 .Fn rmdir
  72 except in the case where
  73 .Fa path
  74 specifies a relative path.
  75 In this case the directory entry to be removed is determined
  76 relative to the directory associated with the file descriptor
  77 .Fa fd
  78 instead of the current working directory.
  79 .Pp
  80 The values for
  81 .Fa flag
  82 are constructed by a bitwise-inclusive OR of flags from the following list,
  83 defined in
  84 .In fcntl.h :
  85 .Bl -tag -width indent
  86 .It Dv AT_REMOVEDIR
  87 Remove the directory entry specified by
  88 .Fa fd
  89 and
  90 .Fa path
  91 as a directory, not a normal file.
  92 .El
  93 .Pp
  94 If
  95 .Fn unlinkat
  96 is passed the special value
  97 .Dv AT_FDCWD
  98 in the
  99 .Fa fd
 100 parameter, the current working directory is used and the behavior is
 101 identical to a call to
 102 .Fa unlink
 103 or
 104 .Fa rmdir
 105 respectively, depending on whether or not the
 106 .Dv AT_REMOVEDIR
 107 bit is set in flag.
 108 .Sh RETURN VALUES
 109 .Rv -std unlink
 110 .Sh ERRORS
 111 The
 112 .Fn unlink
 113 succeeds unless:
 114 .Bl -tag -width Er
 115 .It Bq Er ENOTDIR
 116 A component of the path prefix is not a directory.
 117 .It Bq Er EISDIR
 118 The named file is a directory.
 119 .It Bq Er ENAMETOOLONG
 120 A component of a pathname exceeded 255 characters,
 121 or an entire path name exceeded 1023 characters.
 122 .It Bq Er ENOENT
 123 The named file does not exist.
 124 .It Bq Er EACCES
 125 Search permission is denied for a component of the path prefix.
 126 .It Bq Er EACCES
 127 Write permission is denied on the directory containing the link
 128 to be removed.
 129 .It Bq Er ELOOP
 130 Too many symbolic links were encountered in translating the pathname.
 131 .It Bq Er EPERM
 132 The named file is a directory.
 133 .It Bq Er EPERM
 134 The named file has its immutable, undeletable or append-only flag set, see the
 135 .Xr chflags 2
 136 manual page for more information.
 137 .It Bq Er EPERM
 138 The parent directory of the named file has its immutable or append-only flag
 139 set.
 140 .It Bq Er EPERM
 141 The directory containing the file is marked sticky,
 142 and neither the containing directory nor the file to be removed
 143 are owned by the effective user ID.
 144 .It Bq Er EIO
 145 An I/O error occurred while deleting the directory entry
 146 or deallocating the inode.
 147 .It Bq Er EINTEGRITY
 148 Corrupted data was detected while reading from the file system.
 149 .It Bq Er EROFS
 150 The named file resides on a read-only file system.
 151 .It Bq Er EFAULT
 152 The
 153 .Fa path
 154 argument
 155 points outside the process's allocated address space.
 156 .It Bq Er ENOSPC
 157 On file systems supporting copy-on-write or snapshots, there was not enough
 158 free space to record metadata for the delete operation of the file.
 159 .El
 160 .Pp
 161 In addition to the errors returned by the
 162 .Fn unlink ,
 163 the
 164 .Fn unlinkat
 165 may fail if:
 166 .Bl -tag -width Er
 167 .It Bq Er EBADF
 168 The
 169 .Fa path
 170 argument does not specify an absolute path and the
 171 .Fa fd
 172 argument is neither
 173 .Dv AT_FDCWD
 174 nor a valid file descriptor open for searching.
 175 .It Bq Er ENOTEMPTY
 176 The
 177 .Fa flag
 178 parameter has the
 179 .Dv AT_REMOVEDIR
 180 bit set and the
 181 .Fa path
 182 argument names a directory that is not an empty directory,
 183 or there are hard links to the directory other than dot or
 184 a single entry in dot-dot.
 185 .It Bq Er ENOTDIR
 186 The
 187 .Fa flag
 188 parameter has the
 189 .Dv AT_REMOVEDIR
 190 bit set and
 191 .Fa path
 192 does not name a directory.
 193 .It Bq Er EINVAL
 194 The value of the
 195 .Fa flag
 196 argument is not valid.
 197 .It Bq Er ENOTDIR
 198 The
 199 .Fa path
 200 argument is not an absolute path and
 201 .Fa fd
 202 is neither
 203 .Dv AT_FDCWD
 204 nor a file descriptor associated with a directory.
 205 .El
 206 .Sh SEE ALSO
 207 .Xr chflags 2 ,
 208 .Xr close 2 ,
 209 .Xr link 2 ,
 210 .Xr rmdir 2 ,
 211 .Xr symlink 7
 212 .Sh STANDARDS
 213 The
 214 .Fn unlinkat
 215 system call follows The Open Group Extended API Set 2 specification.
 216 .Sh HISTORY
 217 The
 218 .Fn unlink
 219 function appeared in
 220 .At v1 .
 221 The
 222 .Fn unlinkat
 223 system call appeared in
 224 .Fx 8.0 .
 225 .Pp
 226 The
 227 .Fn unlink
 228 system call traditionally allows the super-user to unlink directories which
 229 can damage the file system integrity.
 230 This implementation no longer permits it.