Differences between current version and predecessor to the previous major change of madvise(2).
Other diffs: Previous Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 4 | Last edited on Sunday, May 30, 2004 4:36:27 pm | by JohnMcPherson | |
| Older page: | version 1 | Last edited on Tuesday, June 4, 2002 12:23:42 am | by perry | Revert |
@@ -1,164 +1,45 @@
-MADVISE
-!!!MADVISE
-NAME
-SYNOPSIS
-DESCRIPTION
-RETURN VALUE
-ERRORS
-LINUX NOTES
-HISTORY
-CONFORMING TO
-SEE ALSO
-----
!!NAME
+madvise - give advice about use of memory
-
-madvise - give advice about use of memory
!!SYNOPSIS
+ __#include <sys/mman.h>__
+ __int madvise(void *__''start''__, size_t__ ''length''__, int__ ''advice'' __);__
-__#include __
-
-
-__int madvise(void *__''start''__, size_t__
-''length''__, int__ ''advice''
-__);__
!!DESCRIPTION
+The madvise(2) system call advises the kernel about how to handle paging input/output in the address range beginning at address ''start'' and with size ''length'' bytes. It allows an application to tell the kernel how it expects to use some mapped or shared memory areas, so that the kernel can choose appropriate read-ahead and caching techniques. This call does not influence the semantics of the application, but may influence its performance. The kernel is free to ignore the advice.
+The advice is indicated in the ''advice'' parameter which can be
-The
__madvise__ system call advises
the kernel about how
-to handle paging input/output
in the address
range beginning
-at address ''start''
and with size ''length'' bytes
.
-It allows an application to tell
the kernel how
it expects
-use some mapped or shared memory areas, so that the
-kernel can choose appropriate
read-
ahead and caching
-techniques
. This call does
not influence
the semantics of
-but may influence its performance. The
-is
free to ignore the advice
.
+;[MADV
_NORMAL]: No special treatment. This is
the default.
+;[MADV_RANDOM]: Expect page references in random order. (Hence, read ahead may be less useful than normally.)
+;[MADV_SEQUENTIAL]: Expect page references in sequential order. (Hence, pages
in the given
range can be aggressively read ahead,
and may be freed soon after they are accessed
.)
+;[MADV_WILLNEED]: Expect access in
the near future. (Hence,
it might be a good idea
to read some pages
ahead.)
+;[MADV_DONTNEED]: Do
not expect access in
the near future. (For the time being,
the application is finished with the given range
, so the
kernel can
free resources associated with it
.)
-
-The advice is indicated in the ''advice'' parameter which
-can be
-
-
-__MADV_NORMAL__
-
-
-No special treatment. This is the default.
-
-
-__MADV_RANDOM__
-
-
-Expect page references in random order. (Hence, read ahead
-may be less useful than normally.)
-
-
-__MADV_SEQUENTIAL__
-
-
-Expect page references in sequential order. (Hence, pages in
-the given range can be aggressively read ahead, and may be
-freed soon after they are accessed.)
-
-
-__MADV_WILLNEED__
-
-
-Expect access in the near future. (Hence, it might be a good
-idea to read some pages ahead.)
-
-
-__MADV_DONTNEED__
-
-
-Do not expect access in the near future. (For the time
-being, the application is finished with the given range, so
-the kernel can free resources associated with
-it.)
!!RETURN VALUE
+On success madvise(2) returns zero. On error, it returns -1 and ''errno'' is set appropiately.
-
-On success __madvise__ returns zero. On error, it returns
--1 and ''errno'' is set appropiately.
!!ERRORS
+;[EINVAL]: the value ''len'' is negative, ''start'' is not page-aligned, ''advice'' is not a valid value, or the application is attempting to release locked or shared pages (with MADV_DONTNEED).
+;[ENOMEM]: addresses in the specified range are not currently mapped, or are outside the address space of the process.
+;[ENOMEM]: (for MADV_WILLNEED) Not enough memory - paging in failed.
+;[EIO]: (for MADV_WILLNEED) Paging in this area would exceed the process's maximum resident set size.
+;[EBADF]: the map exists, but the area maps something that isn't a file.
+;[EAGAIN]: a kernel resource was temporarily unavailable.
-
-__EINVAL__
-
-
-the value ''len'' is negative, ''start'' is not
-page-aligned, ''advice'' is not a valid value, or the
-application is attempting to release locked or shared pages
-(with MADV_DONTNEED).
-
-
-__ENOMEM__
-
-
-addresses in the specified range are not currently mapped,
-or are outside the address space of the
-process.
-
-
-__ENOMEM__
-
-
-(for MADV_WILLNEED) Not enough memory - paging in
-failed.
-
-
-__EIO__
-
-
-(for MADV_WILLNEED) Paging in this area would exceed the
-process's maximum resident set size.
-
-
-__EBADF__
-
-
-the map exists, but the area maps something that isn't a
-file.
-
-
-__EAGAIN__
-
-
-a kernel resource was temporarily unavailable.
!!LINUX NOTES
+The current Linux implementation (2.4.0) views this system call more as a command than as advice and hence may return an error when it cannot do what it usually would do in response to this advice. (See the ERRORS description above.) This is nonstandard behaviour.
-
-The current Linux implementation (2.4.) views this system
-call more as a command than as advice and hence may return
-an error when it cannot do what it usually would do in
-response to this advice. (See the ERRORS description above.)
-This is nonstandard behaviour.
-
-
-
-
-
-that are not mapped, the Linux version of __
madvise__
-
-__
ENOMEM__
from the system call, as it
+The Linux implementation requires that the address ''start'' be page-aligned, and allows ''length'' to be zero. If there are some parts of the specified address range
+that are not mapped, the Linux version of madvise(2)
ignores them and applies the call to the rest (but returns [
ENOMEM]
from the system call, as it
should).
!!HISTORY
+The __madvise__ function first appeared in 4.4BSD.
-
-The __madvise__ function first appeared in
-4.4BSD.
!!CONFORMING TO
+[POSIX].1b (POSIX.4). The Austin draft describes __posix_madvise__ with constants POSIX_MADV_NORMAL, etc., with a behaviour close to that described here. There is a
+similar ''posix_fadvise'' for file access.
-
-POSIX.1b (POSIX.4). The Austin draft describes
-__posix_madvise__ with constants POSIX_MADV_NORMAL, etc.,
-with a behaviour close to that described here. There is a
-similar ''posix_fadvise'' for file access.
!!SEE ALSO
-
-
-
-
-
-----
+getrlimit(2), mmap(2), mincore(2), mprotect(2), msync(2), munmap(2)
