xref: /freebsd/share/man/man9/vm_map_madvise.9 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
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.Dd July 19, 2003
27.Dt VM_MAP_MADVISE 9
28.Os
29.Sh NAME
30.Nm vm_map_madvise
31.Nd apply advice about use of memory to map entries
32.Sh SYNOPSIS
33.In sys/param.h
34.In vm/vm.h
35.In vm/vm_map.h
36.Ft int
37.Fo vm_map_madvise
38.Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "int behav"
39.Fc
40.Sh DESCRIPTION
41The
42.Fn vm_map_madvise
43function applies the flags
44.Fa behav
45to the entries within
46.Fa map
47between
48.Fa start
49and
50.Fa end .
51.Pp
52Advisories are classified as either those affecting the
53.Vt vm_map_entry
54structure, or those affecting the underlying objects.
55.Pp
56The
57.Fn vm_map_madvise
58function is used by the
59.Xr madvise 2
60system call.
61.Sh RETURN VALUES
62The
63.Fn vm_map_madvise
64function returns 0 if successful.
65If the
66.Fa behav
67argument was not recognised,
68.Dv KERN_INVALID_ARGUMENT
69is returned.
70.Sh SEE ALSO
71.Xr madvise 2 ,
72.Xr vm_map 9
73.Sh AUTHORS
74This manual page was written by
75.An Bruce M Simpson Aq Mt bms@spc.org .
76