posix_fadvise(2) [freebsd man page]

POSIX_FADVISE(2)					      BSD System Calls Manual						  POSIX_FADVISE(2)

NAME

     posix_fadvise -- give advice about use of file data

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <fcntl.h>

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

DESCRIPTION

     The posix_fadvise() system call allows a process to describe to the system its data access behavior for an open file descriptor fd.  The
     advice covers the data starting at offset offset and continuing for len bytes.  If len is zero, all data from offset to the end of the file
     is covered.

     The behavior is specified by the advice parameter and may be one of:

     POSIX_FADV_NORMAL	    Tells the system to revert to the default data access behavior.

     POSIX_FADV_RANDOM	    Is a hint that file data will be accessed randomly, and prefetching is likely not advantageous.

     POSIX_FADV_SEQUENTIAL  Tells the system that file data will be accessed sequentially.  This currently does nothing as the default behavior
			    uses heuristics to detect sequential behavior.

     POSIX_FADV_WILLNEED    Tells the system that the specified data will be accessed in the near future.  The system may initiate an asynchronous
			    read of the data if it is not already present in memory.

     POSIX_FADV_DONTNEED    Tells the system that the specified data will not be accessed in the near future.  The system may decrease the in-mem-
			    ory priority of clean data within the specified range and future access to this data may require a read operation.

     POSIX_FADV_NOREUSE     Tells the system that the specified data will only be accessed once and then not reused.  The system may decrease the
			    in-memory priority of data once it has been read or written.  Future access to this data may require a read operation.

RETURN VALUES

     The posix_fadvise() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to
     indicate the error.

ERRORS

     The posix_fadvise() system call returns zero on success, and an error on failure:

     [EBADF]		The fd argument is not a valid file descriptor.

     [EINVAL]		The advice argument is not valid.

     [EINVAL]		The offset or len arguments are negative, or offset + len is greater than the maximum file size.

     [ENODEV]		The fd argument does not refer to a regular file.

     [ESPIPE]		The fd argument is associated with a pipe or FIFO.

SEE ALSO

     madvise(2)

STANDARDS

     The posix_fadvise() interface conforms to IEEE Std 1003.1-2001 (``POSIX.1'').

HISTORY

     The posix_fadvise() system call first appeared in FreeBSD 9.1.

BSD
								 January 30, 2014							       BSD

posix_fadvise(3C)					   Standard C Library Functions 					 posix_fadvise(3C)

NAME

       posix_fadvise - file advisory information

SYNOPSIS

       #include <fcntl.h>

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

DESCRIPTION

       The posix_fadvise() function advises the system on the expected behavior of the application with respect to the data in the file associated
       with the open file descriptor, fd, starting at offset and continuing for len bytes. The specified range need not  currently  exist  in  the
       file.  If  len  is  zero, all data following offset is specified. The system may use this information to optimize handling of the specified
       data. The posix_fadvise() function has no effect on the semantics of other operations on the specified data, although  it  may  affect  the
       performance of other operations.

       The advice to be applied to the data is specified by the advice parameter and may be one of the following values:

       POSIX_FADV_NORMAL	Specifies that the application has no advice to give on its behavior with respect to the specified data. It is the
				default characteristic if no advice is given for an open file.

       POSIX_FADV_SEQUENTIAL	Specifies that the application expects to access the specified data sequentially from lower offsets to higher off-
				sets.

       POSIX_FADV_RANDOM	Specifies that the application expects to access the specified data in a random order.

       POSIX_FADV_WILLNEED	Specifies that the application expects to access the specified data in the near future.

       POSIX_FADV_DONTNEED	Specifies that the application expects that it will not access the specified data in the near future.

       POSIX_FADV_NOREUSE	Specifies that the application expects to access the specified data once and then not reuse it thereafter.

       These values are defined in <fcntl.h>

RETURN VALUES

       Upon successful completion, posix_fadvise() returns zero. Otherwise, an error number is returned to indicate the error.

ERRORS

       The posix_fadvise() function will fail if:

       EBADF	 The fd argument is not a valid file descriptor.

       EINVAL	 The value of advice is invalid, or the value of len is less than zero.

       ESPIPE	 The fd argument is associated with a pipe or FIFO.

USAGE

       The posix_fadvise() function has a transitional interface for 64-bit file offsets. See lf64(5).

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+
       |Standard		     |See standards(5). 	   |
       +-----------------------------+-----------------------------+

SEE ALSO

       posix_madvise(3C), attributes(5), standards(5)

SunOS 5.11							    14 Jul 2008 						 posix_fadvise(3C)