lib/libc/sys/utimensat.2

   1 .\"     $NetBSD: utimes.2,v 1.13 1999/03/22 19:45:11 garbled Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\" Copyright (c) 2012, Jilles Tjoelker
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)utimes.2    8.1 (Berkeley) 6/4/93
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd September 23, 2020
  35 .Dt UTIMENSAT 2
  36 .Os
  37 .Sh NAME
  38 .Nm futimens ,
  39 .Nm utimensat
  40 .Nd set file access and modification times
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/stat.h
  45 .Ft int
  46 .Fn futimens "int fd" "const struct timespec times[2]"
  47 .Ft int
  48 .Fo utimensat
  49 .Fa "int fd"
  50 .Fa "const char *path"
  51 .Fa "const struct timespec times[2]"
  52 .Fa "int flag"
  53 .Fc
  54 .Sh DESCRIPTION
  55 The access and modification times of the file named by
  56 .Fa path
  57 or referenced by
  58 .Fa fd
  59 are changed as specified by the argument
  60 .Fa times .
  61 The inode-change-time of the file is set to the current time.
  62 .Pp
  63 If
  64 .Fa path
  65 specifies a relative path,
  66 it is relative to the current working directory if
  67 .Fa fd
  68 is
  69 .Dv AT_FDCWD
  70 and otherwise relative to the directory associated with the file descriptor
  71 .Fa fd .
  72 .Pp
  73 The
  74 .Va tv_nsec
  75 field of a
  76 .Vt timespec
  77 structure
  78 can be set to the special value
  79 .Dv UTIME_NOW
  80 to set the current time, or to
  81 .Dv UTIME_OMIT
  82 to leave the time unchanged.
  83 In either case, the
  84 .Va tv_sec
  85 field is ignored.
  86 .Pp
  87 If
  88 .Fa times
  89 is
  90 .No non- Ns Dv NULL ,
  91 it is assumed to point to an array of two timespec structures.
  92 The access time is set to the value of the first element, and the
  93 modification time is set to the value of the second element.
  94 For file systems that support file birth (creation) times (such as
  95 .Dv UFS2 ) ,
  96 the birth time will be set to the value of the second element
  97 if the second element is older than the currently set birth time.
  98 To set both a birth time and a modification time,
  99 two calls are required; the first to set the birth time
 100 and the second to set the (presumably newer) modification time.
 101 Ideally a new system call will be added that allows the setting
 102 of all three times at once.
 103 If
 104 .Fa times
 105 is
 106 .Dv NULL ,
 107 this is equivalent to passing
 108 a pointer to an array of two timespec structures
 109 with both
 110 .Va tv_nsec
 111 fields set to
 112 .Dv UTIME_NOW .
 113 .Pp
 114 If both
 115 .Va tv_nsec
 116 fields are
 117 .Dv UTIME_OMIT ,
 118 the timestamps remain unchanged and
 119 no permissions are needed for the file itself,
 120 although search permissions may be required for the path prefix.
 121 The call may or may not succeed if the named file does not exist.
 122 .Pp
 123 If both
 124 .Va tv_nsec
 125 fields are
 126 .Dv UTIME_NOW ,
 127 the caller must be the owner of the file, have permission to
 128 write the file, or be the super-user.
 129 .Pp
 130 For all other values of the timestamps,
 131 the caller must be the owner of the file or be the super-user.
 132 .Pp
 133 The values for the
 134 .Fa flag
 135 argument of the
 136 .Fn utimensat
 137 system call
 138 are constructed by a bitwise-inclusive OR of flags from the following list,
 139 defined in
 140 .In fcntl.h :
 141 .Bl -tag -width indent
 142 .It Dv AT_SYMLINK_NOFOLLOW
 143 If
 144 .Fa path
 145 names a symbolic link, the symbolic link's times are changed.
 146 By default,
 147 .Fn utimensat
 148 changes the times of the file referenced by the symbolic link.
 149 .It Dv AT_BENEATH
 150 Only allow to change the times of a file which is beneath of
 151 the topping directory.
 152 See the description of the
 153 .Dv O_BENEATH
 154 flag in the
 155 .Xr open 2
 156 manual page.
 157 .It Dv AT_RESOLVE_BENEATH
 158 Only walks paths below the topping directory.
 159 See the description of the
 160 .Dv O_RESOLVE_BENEATH
 161 flag in the
 162 .Xr open 2
 163 manual page.
 164 .El
 165 .Sh RETURN VALUES
 166 .Rv -std
 167 .Sh COMPATIBILITY
 168 If the running kernel does not support this system call,
 169 a wrapper emulates it using
 170 .Xr fstatat 2 ,
 171 .Xr futimesat 2
 172 and
 173 .Xr lutimes 2 .
 174 As a result, timestamps will be rounded down to the nearest microsecond,
 175 .Dv UTIME_OMIT
 176 is not atomic and
 177 .Dv AT_SYMLINK_NOFOLLOW
 178 is not available with a path relative to a file descriptor.
 179 .Sh ERRORS
 180 These system calls will fail if:
 181 .Bl -tag -width Er
 182 .It Bq Er EACCES
 183 The
 184 .Fa times
 185 argument is
 186 .Dv NULL ,
 187 or both
 188 .Va tv_nsec
 189 values are
 190 .Dv UTIME_NOW ,
 191 and the effective user ID of the process does not
 192 match the owner of the file, and is not the super-user, and write
 193 access is denied.
 194 .It Bq Er EFAULT
 195 The
 196 .Fa times
 197 argument
 198 points outside the process's allocated address space.
 199 .It Bq Er EINVAL
 200 The
 201 .Va tv_nsec
 202 component of at least one of the values specified by the
 203 .Fa times
 204 argument has a value less than 0 or greater than 999999999 and is not equal to
 205 .Dv UTIME_NOW
 206 or
 207 .Dv UTIME_OMIT .
 208 .It Bq Er EIO
 209 An I/O error occurred while reading or writing the affected inode.
 210 .It Bq Er EINTEGRITY
 211 Corrupted data was detected while reading from the file system.
 212 .It Bq Er EPERM
 213 The
 214 .Fa times
 215 argument is not
 216 .Dv NULL
 217 nor are both
 218 .Va tv_nsec
 219 values
 220 .Dv UTIME_NOW ,
 221 nor are both
 222 .Va tv_nsec
 223 values
 224 .Dv UTIME_OMIT
 225 and the calling process's effective user ID
 226 does not match the owner of the file and is not the super-user.
 227 .It Bq Er EPERM
 228 The named file has its immutable or append-only flag set, see the
 229 .Xr chflags 2
 230 manual page for more information.
 231 .It Bq Er EROFS
 232 The file system containing the file is mounted read-only.
 233 .El
 234 .Pp
 235 The
 236 .Fn futimens
 237 system call
 238 will fail if:
 239 .Bl -tag -width Er
 240 .It Bq Er EBADF
 241 The
 242 .Fa fd
 243 argument
 244 does not refer to a valid descriptor.
 245 .El
 246 .Pp
 247 The
 248 .Fn utimensat
 249 system call
 250 will fail if:
 251 .Bl -tag -width Er
 252 .It Bq Er EACCES
 253 Search permission is denied for a component of the path prefix.
 254 .It Bq Er EBADF
 255 The
 256 .Fa path
 257 argument does not specify an absolute path and the
 258 .Fa fd
 259 argument is neither
 260 .Dv AT_FDCWD
 261 nor a valid file descriptor.
 262 .It Bq Er EFAULT
 263 The
 264 .Fa path
 265 argument
 266 points outside the process's allocated address space.
 267 .It Bq Er ELOOP
 268 Too many symbolic links were encountered in translating the pathname.
 269 .It Bq Er ENAMETOOLONG
 270 A component of a pathname exceeded
 271 .Dv NAME_MAX
 272 characters, or an entire path name exceeded
 273 .Dv PATH_MAX
 274 characters.
 275 .It Bq Er ENOENT
 276 The named file does not exist.
 277 .It Bq Er ENOTDIR
 278 A component of the path prefix is not a directory.
 279 .It Bq Er ENOTDIR
 280 The
 281 .Fa path
 282 argument is not an absolute path and
 283 .Fa fd
 284 is neither
 285 .Dv AT_FDCWD
 286 nor a file descriptor associated with a directory.
 287 .It Bq Er ENOTCAPABLE
 288 .Fa path
 289 is an absolute path,
 290 or contained a ".." component leading to a
 291 directory outside of the directory hierarchy specified by
 292 .Fa fd ,
 293 and the process is in capability mode.
 294 .It Bq Er ENOTCAPABLE
 295 The
 296 .Dv AT_BENEATH
 297 flag was provided to
 298 .Fn utimensat ,
 299 and the absolute
 300 .Fa path
 301 does not have its tail fully contained under the topping directory,
 302 or the relative
 303 .Fa path
 304 escapes it.
 305 .El
 306 .Sh SEE ALSO
 307 .Xr chflags 2 ,
 308 .Xr stat 2 ,
 309 .Xr symlink 2 ,
 310 .Xr utimes 2 ,
 311 .Xr utime 3 ,
 312 .Xr symlink 7
 313 .Sh STANDARDS
 314 The
 315 .Fn futimens
 316 and
 317 .Fn utimensat
 318 system calls are expected to conform to
 319 .St -p1003.1-2008 .
 320 .Sh HISTORY
 321 The
 322 .Fn futimens
 323 and
 324 .Fn utimensat
 325 system calls appeared in
 326 .Fx 10.3 .