POSIX_FADVISE


HOME

POSIX_FADVISE

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
VERSIONS
CONFORMING TO
NOTES
BUGS
SEE ALSO
COLOPHON

NAME

posix_fadvise − predeclare an access pattern for file data

SYNOPSIS

#include <fcntl.h>

int posix_fadvise(int fd, off_t offset, off_t len, int advice);

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

posix_fadvise():

_XOPEN_SOURCE >= 600 || _POSIX_C_SOURCE >= 200112L

DESCRIPTION

Programs can use posix_fadvise() to announce an intention to access file data in a specific pattern in the future, thus allowing the kernel to perform appropriate optimizations.

The advice applies to a (not necessarily existent) region starting at offset and extending for len bytes (or until the end of the file if len is 0) within the file referred to by fd. The advice is not binding; it merely constitutes an expectation on behalf of the application.

Permissible values for advice include:
POSIX_FADV_NORMAL

Indicates that the application has no advice to give about its access pattern for the specified data. If no advice is given for an open file, this is the default assumption.

POSIX_FADV_SEQUENTIAL

The application expects to access the specified data sequentially (with lower offsets read before higher ones).

POSIX_FADV_RANDOM

The specified data will be accessed in random order.

POSIX_FADV_NOREUSE

The specified data will be accessed only once.

POSIX_FADV_WILLNEED

The specified data will be accessed in the near future.

POSIX_FADV_DONTNEED

The specified data will not be accessed in the near future.

RETURN VALUE

On success, zero is returned. On error, an error number is returned.

ERRORS

EBADF

The fd argument was not a valid file descriptor.

EINVAL

An invalid value was specified for advice.

ESPIPE

The specified file descriptor refers to a pipe or FIFO. (Linux actually returns EINVAL in this case.)

VERSIONS

Kernel support first appeared in Linux 2.5.60; the underlying system call is called fadvise64(). Library support has been provided since glibc version 2.2, via the wrapper function posix_fadvise().

CONFORMING TO

POSIX.1-2001. Note that the type of the len argument was changed from size_t to off_t in POSIX.1-2003 TC1.

NOTES

Under Linux, POSIX_FADV_NORMAL sets the readahead window to the default size for the backing device; POSIX_FADV_SEQUENTIAL doubles this size, and POSIX_FADV_RANDOM disables file readahead entirely. These changes affect the entire file, not just the specified region (but other open file handles to the same file are unaffected).

POSIX_FADV_WILLNEED initiates a nonblocking read of the specified region into the page cache. The amount of data read may be decreased by the kernel depending on virtual memory load. (A few megabytes will usually be fully satisfied, and more is rarely useful.)

In kernels before 2.6.18, POSIX_FADV_NOREUSE had the same semantics as POSIX_FADV_WILLNEED. This was probably a bug; since kernel 2.6.18, this flag is a no-op.

POSIX_FADV_DONTNEED attempts to free cached pages associated with the specified region. This is useful, for example, while streaming large files. A program may periodically request the kernel to free cached data that has already been used, so that more useful cached pages are not discarded instead.

Pages that have not yet been written out will be unaffected, so if the application wishes to guarantee that pages will be released, it should call fsync(2) or fdatasync(2) first.

Architecture-specific variants
Some architectures require 64-bit arguments to be aligned in a suitable pair of registers (see syscall(2) for further detail). On such architectures, the call signature of posix_fadvise() shown in the SYNOPSIS would force a register to be wasted as padding between the fd and offset arguments. Therefore, these architectures define a version of the system call that orders the arguments suitably, but otherwise is otherwise exactly the same as posix_fadvise().

For example, since Linux 2.6.14, ARM has the following system call:

long arm_fadvise64_64(int fd, int advice,
loff_t
offset, loff_t len);

These architecture-specific details are generally hidden from applications by the glibc posix_fadvise() wrapper function, which invokes the appropriate architecture-specific system call.

BUGS

In kernels before 2.6.6, if len was specified as 0, then this was interpreted literally as "zero bytes", rather than as meaning "all bytes through to the end of the file".

SEE ALSO

readahead(2), sync_file_range(2), posix_fallocate(3), posix_madvise(3)

COLOPHON

This page is part of release 3.69 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at http://www.kernel.org/doc/man−pages/.




More Linux Commands

manpages/beforelight.1.html
beforelight(1) - screen saver (Commands - Linux man page)...
The beforelight program is a sample implementation of a screen saver for X servers supporting the MIT-SCREEN-SAVER extension. AUTHORS Keith Packard, MIT X Conso

manpages/XSetWMColormapWindows.3.html
XSetWMColormapWindows(3) - set or read a window's WM_COLORMA
The XSetWMColormapWindows function replaces the WM_COLORMAP_WINDOWS property on the specified window with the list of windows specified by the colormap_windows

manpages/glRasterPos4dv.3gl.html
glRasterPos4dv(3gl) - specify the raster position for pixel
The GL maintains a 3D position in window coordinates. This position, called the raster position, is used to position pixel and bitmap write operations. It is ma

manpages/startproc.html
301 Moved Permanently - statproc

manpages/ppmntsc.1.html
ppmntsc(1) - Make RGB colors legal for NTSC or PAL color sys
This program is part of Netpbm(1) This program makes colors legal in the NTSC (or PAL) color systems. Often, images generated on the computer are made for use i

manpages/is_scrollok.3ncurses.html
is_scrollok(3ncurses) - curses window properties (Man Page)
This implementation provides functions which return properties set in the WINDOW structure, allowing it to be opaque if the symbol NCURSES_OPAQUE is defined: is

manpages/inchstr.3ncurses.html
inchstr(3ncurses) - get a string of characters (and attribut
These routines return a NULL-terminated array of chtype quantities, starting at the current cursor position in the named window and ending at the right margin o

manpages/texi2pdf.1.html
texi2pdf(1) - convert Texinfo documents to PDF (Man Page)...
texi2pdf.1 - Run each Texinfo or (La)TeX FILE through TeX in turn until all cross-references are resolved, building all indices. The directory containing each F

manpages/Tcl_FSCopyDirectory.3.html
Tcl_FSCopyDirectory(3) - procedures to interact with any fil
There are several reasons for calling the Tcl_FS API functions (e.g. Tcl_FSAccess and Tcl_FSStat) rather than calling system level functions like access and sta

manpages/gnutls_anon_set_params_function.3.html
gnutls_anon_set_params_function(3) - API function (ManPage)
This function will set a callback in order for the server to get the Diffie-Hellman or RSA parameters for anonymous authentication. The callback should return G

manpages/pcre32_get_stringnumber.3.html
pcre32_get_stringnumber(3) Perl-compatible regular expressio
This convenience function finds the number of a named substring capturing parenthesis in a compiled pattern. Its arguments are: code Compiled regular expression

manpages/XtSetSensitive.3.html
XtSetSensitive(3) - set and check a widget's sensitivity sta
The XtSetSensitive function first calls XtSetValues on the current widget with an argument list specifying that the sensitive field should change to the new val





We can't live, work or learn in freedom unless the software we use is free.