vm_page_insert (9)

Leading comments

Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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(s), this list of conditions and the following disclaimer as
   the first lines of this file unmodified other than the possible
   addition of one or more copyright notices.
2. Redistributions in binary for...

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

NAME

vm_page_insert vm_page_remove - add/remove page from an object

SYNOPSIS

In sys/param.h In vm/vm.h In vm/vm_page.h Ft void Fn vm_page_insert vm_page_t m vm_object_t object vm_pindex_t pindex Ft void Fn vm_page_remove vm_page_t m

DESCRIPTION

The Fn vm_page_insert function adds a page to the given object at the given index. The page is added to both the VM page hash table and to the object's list of pages, but the hardware page tables are not updated. In the case of a user page, it will be faulted in when it is accessed. If the page is a kernel page, the caller is expected to handle adding the page to the kernel's pmap.

If PG_WRITEABLE is set in the page's flags, OBJ_WRITEABLE and OBJ_MIGHTBEDIRTY are set in the object's flags.

The Fn vm_page_remove function removes the given page from its object, and from the VM page hash table. The page must be busy prior to this call, or the system will panic. The pmap entry for the page is not removed by this function.

The arguments to Fn vm_page_insert are:

Fa m

The page to add to the object.

Fa object

The object the page should be added to.

Fa pindex

The index into the object the page should be at.

The arguments to Fn vm_page_remove are:

Fa m

The page to remove.

IMPLEMENTATION NOTES

The index of a page in a VM object is the byte index into the same object truncated to a page boundary. For example, if the page size is 4096 bytes, and the address in the object is 81944, the page index is 20.

AUTHORS

This manual page was written by An Chad David Aq davidc@acns.ab.ca .