xref: /freebsd/share/man/man9/vm_map_remove.9 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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_REMOVE 9
28.Os
29.Sh NAME
30.Nm vm_map_remove
31.Nd remove a virtual address range from a map
32.Sh SYNOPSIS
33.In sys/param.h
34.In vm/vm.h
35.In vm/vm_map.h
36.Ft int
37.Fn vm_map_remove "vm_map_t map" "vm_offset_t start" "vm_offset_t end"
38.Sh DESCRIPTION
39The
40.Fn vm_map_remove
41function removes the given address range bounded by
42.Fa start
43and
44.Fa end
45from the target
46.Fa map .
47.Sh IMPLEMENTATION NOTES
48This is the exported form of
49.Xr vm_map_delete 9
50which may be called by consumers of the VM subsystem.
51.Pp
52The function calls
53.Xr vm_map_lock 9
54to hold a lock on
55.Fa map
56for the duration of the function call.
57.Sh RETURN VALUES
58The
59.Fn vm_map_remove
60always returns
61.Dv KERN_SUCCESS .
62.Sh SEE ALSO
63.Xr vm_map 9 ,
64.Xr vm_map_delete 9
65.Sh AUTHORS
66This manual page was written by
67.An Bruce M Simpson Aq Mt bms@spc.org .
68