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_insert 9 30.Sh NAME 31.Nm vm_map_insert 32.Nd insert an object into a map 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_insert "vm_map_t map" "vm_object_t object" "vm_ooffset_t offset" "vm_offset_t start" "vm_offset_t end" "vm_prot_t prot" "vm_prot_t max" "int cow" 39.Sh DESCRIPTION 40The 41.Fn vm_map_insert 42function inserts a mapping for the entire vm_object 43.Fa object 44into the target map 45.Fa map . 46.Pp 47The 48.Fa offset 49argument specifies the offset into the 50.Fa object 51at which to begin mapping. 52The object's size should match that of the specified address range. 53.Pp 54The 55.Fa start 56and 57.Fa end 58arguments specify the bounds of the mapped object's window in the 59address space of 60.Fa map . 61.Pp 62The 63.Fa cow 64argument specifies the flags which should be propagated to the new entry, 65for example, to indicate that this is a copy-on-write mapping. 66.Sh IMPLEMENTATION NOTES 67This function implicitly creates a new 68.Dv vm_map_entry 69by calling the internal function 70.Fn vm_map_entry_create . 71This function may use the 72.Dv Giant 73lock to ensure that only a single thread is present in the function. 74.Sh RETURN VALUES 75The 76.Fn vm_map_insert 77function returns 78.Dv KERN_SUCCESS 79if the mapping could be made successfully. 80.Pp 81Otherwise, 82.Dv KERN_INVALID_ADDRESS 83will be returned if the start of the range could not be found, or 84.Dv KERN_NO_SPACE 85if the range was found to be part of an existing entry or if it 86overlaps the end of the map. 87.Sh SEE ALSO 88.Xr vm_map 9 89.Sh AUTHORS 90This man page was written by 91.An Bruce M Simpson Aq bms@spc.org . 92