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 .\" 4. 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 January 23, 2015
  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 .El
 150 .Sh RETURN VALUES
 151 .Rv -std
 152 .Sh COMPATIBILITY
 153 If the running kernel does not support this system call,
 154 a wrapper emulates it using
 155 .Xr fstatat 2 ,
 156 .Xr futimesat 2
 157 and
 158 .Xr lutimes 2 .
 159 As a result, timestamps will be rounded down to the nearest microsecond,
 160 .Dv UTIME_OMIT
 161 is not atomic and
 162 .Dv AT_SYMLINK_NOFOLLOW
 163 is not available with a path relative to a file descriptor.
 164 .Sh ERRORS
 165 These system calls will fail if:
 166 .Bl -tag -width Er
 167 .It Bq Er EACCES
 168 The
 169 .Fa times
 170 argument is
 171 .Dv NULL ,
 172 or both
 173 .Va tv_nsec
 174 values are
 175 .Dv UTIME_NOW ,
 176 and the effective user ID of the process does not
 177 match the owner of the file, and is not the super-user, and write
 178 access is denied.
 179 .It Bq Er EFAULT
 180 The
 181 .Fa times
 182 argument
 183 points outside the process's allocated address space.
 184 .It Bq Er EINVAL
 185 The
 186 .Va tv_usec
 187 component of at least one of the values specified by the
 188 .Fa times
 189 argument has a value less than 0 or greater than 999999.
 190 .It Bq Er EIO
 191 An I/O error occurred while reading or writing the affected inode.
 192 .It Bq Er EPERM
 193 The
 194 .Fa times
 195 argument is not
 196 .Dv NULL
 197 nor are both
 198 .Va tv_nsec
 199 values
 200 .Dv UTIME_NOW ,
 201 nor are both
 202 .Va tv_nsec
 203 values
 204 .Dv UTIME_OMIT
 205 and the calling process's effective user ID
 206 does not match the owner of the file and is not the super-user.
 207 .It Bq Er EPERM
 208 The named file has its immutable or append-only flag set, see the
 209 .Xr chflags 2
 210 manual page for more information.
 211 .It Bq Er EROFS
 212 The file system containing the file is mounted read-only.
 213 .El
 214 .Pp
 215 The
 216 .Fn futimens
 217 system call
 218 will fail if:
 219 .Bl -tag -width Er
 220 .It Bq Er EBADF
 221 The
 222 .Fa fd
 223 argument
 224 does not refer to a valid descriptor.
 225 .El
 226 .Pp
 227 The
 228 .Fn utimensat
 229 system call
 230 will fail if:
 231 .Bl -tag -width Er
 232 .It Bq Er EACCES
 233 Search permission is denied for a component of the path prefix.
 234 .It Bq Er EBADF
 235 The
 236 .Fa path
 237 argument does not specify an absolute path and the
 238 .Fa fd
 239 argument is neither
 240 .Dv AT_FDCWD
 241 nor a valid file descriptor.
 242 .It Bq Er EFAULT
 243 The
 244 .Fa path
 245 argument
 246 points outside the process's allocated address space.
 247 .It Bq Er ELOOP
 248 Too many symbolic links were encountered in translating the pathname.
 249 .It Bq Er ENAMETOOLONG
 250 A component of a pathname exceeded
 251 .Dv NAME_MAX
 252 characters, or an entire path name exceeded
 253 .Dv PATH_MAX
 254 characters.
 255 .It Bq Er ENOENT
 256 The named file does not exist.
 257 .It Bq Er ENOTDIR
 258 A component of the path prefix is not a directory.
 259 .It Bq Er ENOTDIR
 260 The
 261 .Fa path
 262 argument is not an absolute path and
 263 .Fa fd
 264 is neither
 265 .Dv AT_FDCWD
 266 nor a file descriptor associated with a directory.
 267 .It Bq Er ENOTSUP
 268 The running kernel does not support this system call and
 269 .Dv AT_SYMLINK_NOFOLLOW
 270 is used with a path relative to a file descriptor.
 271 .El
 272 .Sh SEE ALSO
 273 .Xr chflags 2 ,
 274 .Xr stat 2 ,
 275 .Xr symlink 2 ,
 276 .Xr utimes 2 ,
 277 .Xr utime 3 ,
 278 .Xr symlink 7
 279 .Sh STANDARDS
 280 The
 281 .Fn futimens
 282 and
 283 .Fn utimensat
 284 system calls are expected to conform to
 285 .St -p1003.1-2008 .
 286 .Sh HISTORY
 287 The
 288 .Fn futimens
 289 and
 290 .Fn utimensat
 291 system calls appeared in
 292 .Fx 11.0 .