xref: /netbsd-src/lib/libc/sys/fdatasync.2 (revision 93f9db1b75d415b78f73ed629beeb86235153473)
1.\"	$NetBSD: fdatasync.2,v 1.3 1998/06/06 22:47:00 scottr Exp $
2.\"
3.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Klaus Klein.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd May 30, 1998
38.Dt FDATASYNC 2
39.Os NetBSD 1.4
40.Sh NAME
41.Nm fdatasync
42.Nd synchronize the data of a file
43.Sh SYNOPSIS
44.Fd #include <unistd.h>
45.Ft int
46.Fn fdatasync "int fd"
47.Sh DESCRIPTION
48The
49.Fn fdatasync
50function forces all modified data associated with the file descriptor
51.Fa fd
52to be flushed to stable storage.
53.Pp
54The functionality is as described for
55.Xr fsync 2 ,
56with the exception that file status information need not be synchronized,
57which may result in a performance gain, compared to
58.Xr fsync 2 .
59This behaviour is commonly known as
60.Bf -symbolic
61synchronized I/O data integrity completion.
62.Ef
63.Pp
64.Sh RETURN VALUES
65A value of 0 is returned on success.  Otherwise, a value -1 is returned and
66.Dv errno
67is set to indicate the error.
68.Sh ERRORS
69The
70.Fn fdatasync
71function will fail if:
72.Bl -tag -width Er
73.It Bq Er EBADF
74The
75.Fa fd
76argument is not a valid file descriptor.
77.It Bq Er EINVAL
78This implementation does not support syncronized I/O for this file.
79.It Bq Er ENOSYS
80The
81.Fn fdatasync
82function is not supported by this implementation.
83.El
84.Pp
85In the event that any of the I/O operations to be performed fail,
86.Fn fdatasync
87returns the eror conditions defined for
88.Xr read 2
89and
90.Xr write 2 ,
91and outstanding I/O operations are not guaranteed to have been completed.
92.Sh SEE ALSO
93.Xr fsync 2 ,
94.Xr open 2 ,
95.Xr read 2 ,
96.Xr write 2
97.Sh STANDARDS
98The
99.Fn fdatasync
100function conforms to
101.St -p1003.1b-93 .
102