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