2007-11-21 18:22:29 +00:00
|
|
|
.\" Copyright (c) 2006, Michael Kerrisk <mtk.manpages@gmail.com>
|
2006-03-01 04:10:55 +00:00
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-03-01 04:10:55 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-03-01 04:10:55 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
_exit.2, brk.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, getdtablesize.2, gethostname.2, getpagesize.2, getsid.2, killpg.2, mknod.2, mknodat.2, poll.2, posix_fadvise.2, pread.2, readlink.2, setpgid.2, setreuid.2, sigaltstack.2, stat.2, symlink.2, sync.2, truncate.2, vfork.2, wait.2, wait4.2, a64l.3, abs.3, acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atoi.3, cbrt.3, ceil.3, copysign.3, cosh.3, dirfd.3, div.3, ecvt.3, erf.3, erfc.3, exp.3, exp2.3, fabs.3, fdim.3, ffs.3, floor.3, fma.3, fmax.3, fmin.3, fmod.3, fpclassify.3, frexp.3, ftw.3, fwide.3, gcvt.3, getcwd.3, getdate.3, getgrent.3, gethostid.3, getpass.3, getpwent.3, getsubopt.3, getw.3, hypot.3, ilogb.3, index.3, isalpha.3, isgreater.3, iswblank.3, j0.3, ldexp.3, lockf.3, log.3, log10.3, log1p.3, logb.3, lrint.3, lround.3, mkstemp.3, mktemp.3, modf.3, mq_receive.3, mq_send.3, nan.3, nextafter.3, posix_fallocate.3, posix_memalign.3, printf.3, qecvt.3, random.3, realpath.3, remainder.3, remquo.3, rint.3, round.3, scalb.3, scalbln.3, scanf.3, siginterrupt.3, signbit.3, sigset.3, sinh.3, sqrt.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strfry.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtod.3, strtok.3, strtol.3, strtoul.3, strxfrm.3, tanh.3, tgamma.3, trunc.3, ttyslot.3, ualarm.3, usleep.3, wprintf.3, armscii-8.7, cp1251.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-3.7, iso_8859-5.7, iso_8859-6.7, iso_8859-8.7, koi8-u.7: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 17:19:13 +00:00
|
|
|
.TH POSIX_FALLOCATE 3 2010-09-20 "GNU" "Linux Programmer's Manual"
|
2006-03-01 04:10:55 +00:00
|
|
|
.SH NAME
|
|
|
|
posix_fallocate \- allocate file space
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
2008-03-18 07:44:01 +00:00
|
|
|
.B #include <fcntl.h>
|
2006-03-01 04:10:55 +00:00
|
|
|
.sp
|
|
|
|
.BI "int posix_fallocate(int " fd ", off_t " offset ", off_t " len );
|
|
|
|
.fi
|
2010-09-19 16:32:23 +00:00
|
|
|
.sp
|
|
|
|
.ad l
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.BR posix_fallocate ():
|
|
|
|
.RS 4
|
|
|
|
_XOPEN_SOURCE\ >=\ 600 || _POSIX_C_SOURCE\ >=\ 200112L
|
|
|
|
.RE
|
|
|
|
.ad
|
2006-03-01 04:10:55 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
The function
|
|
|
|
.BR posix_fallocate ()
|
|
|
|
ensures that disk space is allocated for the file referred to by the
|
|
|
|
descriptor
|
|
|
|
.I fd
|
|
|
|
for the bytes in the range starting at
|
2007-09-20 16:26:31 +00:00
|
|
|
.I offset
|
2007-04-12 22:42:49 +00:00
|
|
|
and continuing for
|
2006-03-01 04:10:55 +00:00
|
|
|
.I len
|
|
|
|
bytes.
|
|
|
|
After a successful call to
|
|
|
|
.BR posix_fallocate (),
|
|
|
|
subsequent writes to bytes in the specified range are
|
|
|
|
guaranteed not to fail because of lack of disk space.
|
|
|
|
|
|
|
|
If the size of the file is less than
|
|
|
|
.IR offset + len ,
|
|
|
|
then the file is increased to this size;
|
|
|
|
otherwise the file size is left unchanged.
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
.BR posix_fallocate ()
|
|
|
|
returns zero on success, or an error number on failure.
|
|
|
|
Note that
|
2007-09-20 16:26:31 +00:00
|
|
|
.I errno
|
2006-03-01 04:10:55 +00:00
|
|
|
is not set.
|
|
|
|
.SH "ERRORS"
|
|
|
|
.TP
|
|
|
|
.B EBADF
|
|
|
|
.I fd
|
|
|
|
is not a valid file descriptor, or is not opened for writing.
|
|
|
|
.TP
|
|
|
|
.B EFBIG
|
|
|
|
.I offset+len
|
|
|
|
exceeds the maximum file size.
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
.I offset
|
2009-03-30 01:04:59 +00:00
|
|
|
was less than 0, or
|
2006-03-01 04:10:55 +00:00
|
|
|
.I len
|
2009-03-30 01:04:59 +00:00
|
|
|
was less than or equal to 0.
|
2006-03-01 04:10:55 +00:00
|
|
|
.TP
|
|
|
|
.B ENODEV
|
|
|
|
.I fd
|
|
|
|
does not refer to a regular file.
|
|
|
|
.TP
|
|
|
|
.B ENOSPC
|
2007-04-12 22:42:49 +00:00
|
|
|
There is not enough space left on the device containing the file
|
2006-03-01 04:10:55 +00:00
|
|
|
referred to by
|
2007-09-04 06:30:39 +00:00
|
|
|
.IR fd .
|
2006-03-01 04:10:55 +00:00
|
|
|
.TP
|
|
|
|
.B ESPIPE
|
|
|
|
.I fd
|
|
|
|
refers to a pipe of file descriptor.
|
2007-05-16 04:53:05 +00:00
|
|
|
.SH VERSIONS
|
2006-03-01 04:10:55 +00:00
|
|
|
.BR posix_fallocate ()
|
|
|
|
is available since glibc 2.1.94.
|
|
|
|
.SH "CONFORMING TO"
|
|
|
|
POSIX.1-2001.
|
2009-03-30 01:16:38 +00:00
|
|
|
|
2009-09-27 07:50:38 +00:00
|
|
|
POSIX.1-2008 says that an implementation
|
2009-03-30 01:16:38 +00:00
|
|
|
.I shall
|
|
|
|
give the
|
|
|
|
.B EINVAL
|
|
|
|
error if
|
|
|
|
.I len
|
|
|
|
was 0, or
|
|
|
|
.I offset
|
|
|
|
was less than 0.
|
|
|
|
POSIX.1-2001 says that an implementation
|
|
|
|
.I shall
|
|
|
|
give the
|
|
|
|
.B EINVAL
|
|
|
|
error if
|
|
|
|
.I len
|
|
|
|
is less than 0, or
|
|
|
|
.I offset
|
|
|
|
was less than 0, and
|
|
|
|
.I may
|
|
|
|
give the error if
|
|
|
|
.I len
|
|
|
|
equals zero.
|
2006-03-01 04:10:55 +00:00
|
|
|
.SH "SEE ALSO"
|
2007-10-13 11:03:14 +00:00
|
|
|
.BR fallocate (2),
|
2006-03-01 04:10:55 +00:00
|
|
|
.BR lseek (2),
|
2007-01-28 20:00:24 +00:00
|
|
|
.BR posix_fadvise (2),
|
|
|
|
.BR feature_test_macros (7)
|