xref: /freebsd-14.2/lib/libc/sys/fsync.2 (revision 1b2fbe6f)
1.\" Copyright (c) 1983, 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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)fsync.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd June 4, 1993
36.Dt FSYNC 2
37.Os BSD 4.2
38.Sh NAME
39.Nm fsync
40.Nd "synchronise changes to a file"
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.Fd #include <unistd.h>
45.Ft int
46.Fn fsync "int fd"
47.Sh DESCRIPTION
48.Fn Fsync
49causes all modified data and attributes of
50.Fa fd
51to be moved to a permanent storage device.
52This normally results in all in-core modified copies
53of buffers for the associated file to be written to a disk.
54.Pp
55.Fn Fsync
56should be used by programs that require a file to be
57in a known state, for example, in building a simple transaction
58facility.
59.Sh IMPLEMENTATION NOTES
60.Pp
61In the non-threaded library
62.Fn fsync
63is implemented as the
64.Va fsync
65syscall.
66.Pp
67In the threaded library, the
68.Va fsync
69syscall is assembled to
70.Fn _thread_sys_fsync
71and
72.Fn fsync
73is implemented as a function which locks
74.Fa fd
75for read and write, then calls
76.Fn _thread_sys_fsync .
77Before returning,
78.Fn fsync
79unlocks
80.Fa fd .
81.Sh RETURN VALUES
82A 0 value is returned on success.  A -1 value indicates
83an error.
84.Sh ERRORS
85The
86.Fn fsync
87fails if:
88.Bl -tag -width Er
89.It Bq Er EBADF
90.Fa Fd
91is not a valid descriptor.
92.It Bq Er EINVAL
93.Fa Fd
94refers to a socket, not to a file.
95.It Bq Er EIO
96An I/O error occurred while reading from or writing to the file system.
97.El
98.Sh SEE ALSO
99.Xr sync 2 ,
100.Xr syncer 4 ,
101.Xr sync 8
102.Sh HISTORY
103The
104.Fn fsync
105function call appeared in
106.Bx 4.2 .
107