xref: /freebsd/share/man/man9/pmap_kextract.9 (revision d62e01996e7cb54f16272219e6ccd334b4822126)
174e4a8d2SMina Galić.\"
274e4a8d2SMina Galić.\" SPDX-License-Identifier: BSD-2-Clause
374e4a8d2SMina Galić.\"
474e4a8d2SMina Galić.\" Copyright (c) 2023 The FreeBSD Foundation
574e4a8d2SMina Galić.\"
674e4a8d2SMina Galić.\" This manual page was written by Mina Galić <FreeBSD@igalic.co> under
774e4a8d2SMina Galić.\" sponsorship from the FreeBSD Foundation.
874e4a8d2SMina Galić.\"
9*d62e0199SMitchell Horne.Dd October 16, 2023
1074e4a8d2SMina Galić.Dt PMAP_KEXTRACT 9
1174e4a8d2SMina Galić.Os
1274e4a8d2SMina Galić.Sh NAME
1374e4a8d2SMina Galić.Nm pmap_kextract ,
1474e4a8d2SMina Galić.Nm vtophys
1574e4a8d2SMina Galić.Nd extract a physical address from the kernel page table
1674e4a8d2SMina Galić.Sh SYNOPSIS
1774e4a8d2SMina Galić.In sys/param.h
1874e4a8d2SMina Galić.In vm/vm.h
1974e4a8d2SMina Galić.In vm/pmap.h
2074e4a8d2SMina Galić.Ft vm_paddr_t
2174e4a8d2SMina Galić.Fo pmap_kextract
2274e4a8d2SMina Galić.Fa "vm_offset_t va"
2374e4a8d2SMina Galić.Fc
2474e4a8d2SMina Galić.Ft vm_paddr_t
2574e4a8d2SMina Galić.Fo vtophys
2674e4a8d2SMina Galić.Fa "vm_offset_t va"
2774e4a8d2SMina Galić.Fc
2874e4a8d2SMina Galić.Sh DESCRIPTION
2974e4a8d2SMina GalićThe
3074e4a8d2SMina Galić.Fn pmap_kextract
31*d62e0199SMitchell Hornefunction retrieves the underlying physical memory address corresponding to the
32*d62e0199SMitchell Hornegiven kernel virtual address
3374e4a8d2SMina Galić.Fa va .
3474e4a8d2SMina GalićThe value of
3574e4a8d2SMina Galić.Fa va
36*d62e0199SMitchell Hornemust belong to a valid mapping in the kernel address space.
3774e4a8d2SMina Galić.Pp
3874e4a8d2SMina Galić.Fn vtophys
3974e4a8d2SMina Galićis an alias for
4074e4a8d2SMina Galić.Fn pmap_kextract
4174e4a8d2SMina Galićand behaves identically.
4274e4a8d2SMina Galić.Sh RETURN VALUES
4374e4a8d2SMina GalićThe
4474e4a8d2SMina Galić.Fn pmap_kextract
45*d62e0199SMitchell Hornefunction returns the address of physical memory mapped at the kernel
46*d62e0199SMitchell Hornevirtual address
4774e4a8d2SMina Galić.Fa va .
4874e4a8d2SMina Galić.Pp
4974e4a8d2SMina Galić.Fn pmap_kextract
5074e4a8d2SMina Galićgenerally does not fail.
5174e4a8d2SMina GalićHowever, if supplied with an illegitimate value for
5274e4a8d2SMina Galić.Fa va ,
5374e4a8d2SMina Galićthe function may return zero, an invalid non-zero value, or call
5474e4a8d2SMina Galić.Xr panic 9 .
5574e4a8d2SMina Galić.Sh SEE ALSO
5674e4a8d2SMina Galić.Xr pmap 9 ,
5774e4a8d2SMina Galić.Xr pmap_extract 9
5874e4a8d2SMina Galić.Sh AUTHORS
5974e4a8d2SMina Galić.An -nosplit
6074e4a8d2SMina GalićThis manual page was written by
6174e4a8d2SMina Galić.An Mina Galić Aq Mt FreeBSD@igalic.co ,
6274e4a8d2SMina Galićbased on the
6374e4a8d2SMina Galić.Xr pmap_extract 9
6474e4a8d2SMina Galićpage written by
6574e4a8d2SMina Galić.An Bruce M Simpson Aq Mt bms@spc.org .
66