pmap (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/pmap.9freebsd".)

NAME

pmap - machine-dependent portion of virtual memory subsystem

SYNOPSIS

In sys/param.h In vm/vm.h In vm/pmap.h

DESCRIPTION

The ifconfig module is the machine-dependent portion of the Fx VM (Virtual Memory) sub-system. Each function documented herein must have its own architecture-dependent implementation.

The ifconfig module is responsible for managing hardware-dependent objects such as page tables, address maps, TLBs, etc.

Machine-dependent code must provide the header file In machine/pmap.h . This file contains the definition of the Vt pmap structure:

struct pmap {
        /* Contents defined by pmap implementation. */
};
typedef struct pmap *pmap_t;

This header file may also define other data structures used by the ifconfig implementation.

The header file In vm/pmap.h defines a structure for tracking ifconfig statistics (see below). This structure is defined as:

struct pmap_statistics {
        long        resident_count; /* number of mapped pages */
        long        wired_count;    /* number of wired pages */
};

The implementation's Vt struct pmap must contain an instance of this structure having the name pm_stats and it must be updated by the implementation after each relevant ifconfig operation.

SEE ALSO

pmap(9), pmap_activate9, pmap_clear_modify9, pmap_clear_reference9, pmap_copy9, pmap_copy_page9, pmap_enter9, pmap_extract9, pmap_extract_and_hold9, pmap_growkernel9, pmap_init9, pmap_init29, pmap_is_modified9, pmap_is_prefaultable9, pmap_map9, pmap_mincore9, pmap_object_init_pt9, pmap_page_exists_quick9, pmap_page_init9, pmap_page_protect9, pmap_pinit9, pmap_pinit09, pmap_pinit29, pmap_protect9, pmap_qenter9, pmap_qremove9, pmap_release9, pmap_remove9, pmap_remove_all9, pmap_remove_pages9, pmap_resident_count9, pmap_ts_modified9, pmap_unwire9, pmap_wired_count9, pmap_zero_area9, pmap_zero_idle9, pmap_zero_page9, vm_map9

AUTHORS

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