vm_map_submap (9)

Leading comments

Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documenta...

(The comments found at the beginning of the groff file "man9/vm_map_submap.9freebsd".)

NAME

vm_map_submap - create a subordinate map

SYNOPSIS

In sys/param.h In vm/vm.h In vm/vm_map.h Ft int Fo vm_map_submap Fa vm_map_t map vm_offset_t start vm_offset_t end vm_map_t submap Fc

DESCRIPTION

The Fn vm_map_submap function marks the range bounded by Fa start and Fa end within the map Fa map as being handled by a subordinate map Fa sub_map .

It is generally called by the kernel memory allocator.

IMPLEMENTATION NOTES

This function is for internal use only.

Both maps must exist. The range must have been created with vm_map_find9 previously.

No other operations may have been performed on this range before calling this function. Only the Fn vm_fault operation may be performed within this range after calling this function.

To remove a submapping, one must first remove the range from the parent Fa map , and then destroy the Fa sub_map . This procedure is not recommended.

RETURN VALUES

The Fn vm_map_submap function returns KERN_SUCCESS if successful.

Otherwise, it returns KERN_INVALID_ARGUMENT if the caller requested copy-on-write flags, or if the range specified for the sub-map was out of range for the parent map, or if a NULL backing object was specified.

SEE ALSO

vm_map9, vm_map_find9

AUTHORS

This manual page was written by An Bruce M Simpson Aq bms@spc.org .