usr/src/man/man3c/posix_fallocate.3c

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH POSIX_FALLOCATE 3C "Jul 14, 2008"
  12 .SH NAME
  13 posix_fallocate \- file space control
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <fcntl.h>
  18
  19 \fBint\fR \fBposix_fallocate\fR(\fBint\fR \fIfd\fR, \fBoff_t\fR \fIoffset\fR, \fBoff_t\fR \fIlen\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBposix_fallocate()\fR function ensures that any required storage for
  26 regular file data starting at \fIoffset\fR and continuing for \fIlen\fR bytes
  27 is allocated on the file system storage media. If \fBposix_fallocate()\fR
  28 returns successfully, subsequent writes to the specified file data will not
  29 fail due to the lack of free space on the file system storage media.
  30 .sp
  31 .LP
  32 If the \fIoffset\fR+\fIlen\fR is beyond the current file size, then
  33 \fBposix_fallocate()\fR adjusts the file size to \fIoffset\fR+\fIlen\fR.
  34 Otherwise, the file size is not changed.
  35 .sp
  36 .LP
  37 Space allocated with \fBposix_fallocate()\fR is freed by a successful call to
  38 \fBcreat\fR(2) or \fBopen\fR(2) that truncates the size of the file. Space
  39 allocated with \fBposix_fallocate()\fR may be freed by a successful call to
  40 \fBftruncate\fR(3C) that reduces the file size to a size smaller than
  41 \fIoffset\fR+\fIlen\fR.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 Upon successful completion, \fBposix_fallocate()\fR returns zero. Otherwise, an
  46 error number is returned to indicate the error.
  47 .SH ERRORS
  48 .sp
  49 .LP
  50 The \fBposix_fallocate()\fR function will fail if:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEBADF\fR\fR
  55 .ad
  56 .RS 10n
  57 The \fIfd\fR argument is not a valid file descriptor or references a file that
  58 was opened without write permission.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBEFBIG\fR\fR
  65 .ad
  66 .RS 10n
  67 The value of \fIoffset\fR+\fIlen\fR is greater than the maximum file size.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBEINTR\fR\fR
  74 .ad
  75 .RS 10n
  76 A signal was caught during execution.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBEINVAL\fR\fR
  83 .ad
  84 .RS 10n
  85 The \fIlen\fR argument is less than or equal to zero, or the \fIoffset\fR
  86 argument is less than zero, or the underlying file system does not support this
  87 operation.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEIO\fR\fR
  94 .ad
  95 .RS 10n
  96 An I/O error occurred while reading from or writing to a file system.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBENODEV\fR\fR
 103 .ad
 104 .RS 10n
 105 The \fIfd\fR argument does not refer to a regular file.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBENOSPC\fR\fR
 112 .ad
 113 .RS 10n
 114 There is insufficient free space remaining on the file system storage media.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fBESPIPE\fR\fR
 121 .ad
 122 .RS 10n
 123 The \fIfd\fR argument is associated with a pipe or FIFO.
 124 .RE
 125
 126 .SH USAGE
 127 .sp
 128 .LP
 129 The \fBposix_fallocate()\fR function has a transitional interface for 64-bit
 130 file offsets. See \fBlf64\fR(5).
 131 .SH ATTRIBUTES
 132 .sp
 133 .LP
 134 See \fBattributes\fR(5) for descriptions of the following attributes:
 135 .sp
 136
 137 .sp
 138 .TS
 139 box;
 140 c | c
 141 l | l .
 142 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 143 _
 144 Interface Stability     Committed
 145 _
 146 MT-Level        MT-Safe
 147 _
 148 Standard        See \fBstandards\fR(5).
 149 .TE
 150
 151 .SH SEE ALSO
 152 .sp
 153 .LP
 154 \fBcreat\fR(2), \fBopen\fR(2), \fBunlink\fR(2), \fBftruncate\fR(3C),
 155 \fBattributes\fR(5), \fBstandards\fR(5)