mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-23 11:18:54 +00:00
107 lines
3.2 KiB
Groff
107 lines
3.2 KiB
Groff
.\" Copyright (c) 1983, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)fsync.2 8.1 (Berkeley) 6/4/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd June 4, 1993
|
|
.Dt FSYNC 2
|
|
.Os BSD 4.2
|
|
.Sh NAME
|
|
.Nm fsync
|
|
.Nd "synchronise changes to a file"
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.Fd #include <unistd.h>
|
|
.Ft int
|
|
.Fn fsync "int fd"
|
|
.Sh DESCRIPTION
|
|
.Fn Fsync
|
|
causes all modified data and attributes of
|
|
.Fa fd
|
|
to be moved to a permanent storage device.
|
|
This normally results in all in-core modified copies
|
|
of buffers for the associated file to be written to a disk.
|
|
.Pp
|
|
.Fn Fsync
|
|
should be used by programs that require a file to be
|
|
in a known state, for example, in building a simple transaction
|
|
facility.
|
|
.Sh IMPLEMENTATION NOTES
|
|
.Pp
|
|
In the non-threaded library
|
|
.Fn fsync
|
|
is implemented as the
|
|
.Va fsync
|
|
syscall.
|
|
.Pp
|
|
In the threaded library, the
|
|
.Va fsync
|
|
syscall is assembled to
|
|
.Fn _thread_sys_fsync
|
|
and
|
|
.Fn fsync
|
|
is implemented as a function which locks
|
|
.Fa fd
|
|
for read and write, then calls
|
|
.Fn _thread_sys_fsync .
|
|
Before returning,
|
|
.Fn fsync
|
|
unlocks
|
|
.Fa fd .
|
|
.Sh RETURN VALUES
|
|
A 0 value is returned on success. A -1 value indicates
|
|
an error.
|
|
.Sh ERRORS
|
|
The
|
|
.Fn fsync
|
|
fails if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EBADF
|
|
.Fa Fd
|
|
is not a valid descriptor.
|
|
.It Bq Er EINVAL
|
|
.Fa Fd
|
|
refers to a socket, not to a file.
|
|
.It Bq Er EIO
|
|
An I/O error occurred while reading from or writing to the file system.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr sync 2 ,
|
|
.Xr syncer 4 ,
|
|
.Xr sync 8
|
|
.Sh HISTORY
|
|
The
|
|
.Fn fsync
|
|
function call appeared in
|
|
.Bx 4.2 .
|