lib/libc/sys/fsync.2

   1 .\" Copyright (c) 1983, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\" Copyright (c) 2016 The FreeBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Parts of this documentation were written by
   7 .\" Konstantin Belousov <kib@FreeBSD.org> under sponsorship
   8 .\" from the FreeBSD Foundation.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)fsync.2     8.1 (Berkeley) 6/4/93
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd February 6, 2018
  38 .Dt FSYNC 2
  39 .Os
  40 .Sh NAME
  41 .Nm fdatasync, fsync
  42 .Nd "synchronise changes to a file"
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft int
  48 .Fn fdatasync "int fd"
  49 .Ft int
  50 .Fn fsync "int fd"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn fsync
  54 system call
  55 causes all modified data and attributes of the file referenced by
  56 the file descriptor
  57 .Fa fd
  58 to be moved to a permanent storage device.
  59 This normally results in all in-core modified copies
  60 of buffers for the associated file to be written to a disk.
  61 .Pp
  62 The
  63 .Fn fdatasync
  64 system call causes all modified data of
  65 .Fa fd
  66 to be moved to a permanent storage device.
  67 Unlike
  68 .Fn fsync ,
  69 the system call does not guarantee that file attributes or
  70 metadata necessary to access the file are committed to the permanent storage.
  71 .Pp
  72 The
  73 .Fn fsync
  74 system call
  75 should be used by programs that require a file to be
  76 in a known state, for example, in building a simple transaction
  77 facility.
  78 If the file metadata has already been committed, using
  79 .Fn fdatasync
  80 can be more efficient than
  81 .Fn fsync .
  82 .Pp
  83 Both
  84 .Fn fdatasync
  85 and
  86 .Fn fsync
  87 calls are cancellation points.
  88 .Sh RETURN VALUES
  89 .Rv -std fsync
  90 .Sh ERRORS
  91 The
  92 .Fn fsync
  93 and
  94 .Fn fdatasync
  95 calls fail if:
  96 .Bl -tag -width Er
  97 .It Bq Er EBADF
  98 The
  99 .Fa fd
 100 argument
 101 is not a valid descriptor.
 102 .It Bq Er EINVAL
 103 The
 104 .Fa fd
 105 argument
 106 refers to a socket, not to a file.
 107 .It Bq Er EIO
 108 An I/O error occurred while reading from or writing to the file system.
 109 .El
 110 .Sh SEE ALSO
 111 .Xr fsync 1 ,
 112 .Xr sync 2 ,
 113 .Xr syncer 4 ,
 114 .Xr sync 8
 115 .Sh HISTORY
 116 The
 117 .Fn fsync
 118 system call appeared in
 119 .Bx 4.2 .
 120 The
 121 .Fn fdatasync
 122 system call appeared in
 123 .Fx 11.1 .
 124 .Sh BUGS
 125 The
 126 .Fn fdatasync
 127 system call currently does not guarantee that enqueued
 128 .Xr aio 4
 129 requests for the file referenced by
 130 .Fa fd
 131 are completed before the syscall returns.