xref: /freebsd/share/man/man9/vm_map_madvise.9 (revision 2357939bc239bd5334a169b62313806178dd8f30)
1.\"
2.\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd July 19, 2003
29.Dt vm_map_madvise 9
30.Sh NAME
31.Nm vm_map_madvise
32.Nd apply advice about use of memory to map entries
33.Sh SYNOPSIS
34.In sys/param.h
35.In vm/vm.h
36.In vm/vm_map.h
37.Ft int
38.Fn vm_map_madvise "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "int behav"
39.Sh DESCRIPTION
40The
41.Fn vm_map_madvise
42function applies the flags
43.Fa behav
44to the entries within
45.Fa map
46between
47.Fa start
48and
49.Fa end .
50.Pp
51Advisories are classified as either those affecting the
52.Dv vm_map_entry
53structure, or those affecting the underlying objects.
54.Pp
55The
56.Fn vm_map_madvise
57function is used by the
58.Fn madvise
59system call.
60.Sh RETURN VALUES
61The
62.Fn vm_map_madvise
63function returns 0 if successful.
64If the
65.Fa behav
66argument was not recognised,
67.Dv KERN_INVALID_ARGUMENT
68is returned.
69.Sh SEE ALSO
70.Xr madvise 2 ,
71.Xr vm_map 9
72.Sh AUTHORS
73This man page was written by
74.An Bruce M Simpson Aq bms@spc.org .
75