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