Module Name: src
Committed By: jym
Date: Mon Jul 2 21:10:31 UTC 2012
Modified Files:
src/distrib/sets/lists/comp: mi
src/share/man/man9: Makefile uvm.9
Log Message:
Document atop(9), ptoa(9), round_page(9) and trunc_page(9).
To generate a diff of this commit:
cvs rdiff -u -r1.1767 -r1.1768 src/distrib/sets/lists/comp/mi
cvs rdiff -u -r1.365 -r1.366 src/share/man/man9/Makefile
cvs rdiff -u -r1.106 -r1.107 src/share/man/man9/uvm.9
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/distrib/sets/lists/comp/mi
diff -u src/distrib/sets/lists/comp/mi:1.1767 src/distrib/sets/lists/comp/mi:1.1768
--- src/distrib/sets/lists/comp/mi:1.1767 Wed Jun 27 22:18:06 2012
+++ src/distrib/sets/lists/comp/mi Mon Jul 2 21:10:30 2012
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1767 2012/06/27 22:18:06 jdf Exp $
+# $NetBSD: mi,v 1.1768 2012/07/02 21:10:30 jym Exp $
#
# Note: don't delete entries from here - mark them as "obsolete" instead.
#
@@ -9709,6 +9709,7 @@
./usr/share/man/cat9/VOP_WHITEOUT.0 comp-sys-catman .cat
./usr/share/man/cat9/VOP_WRITE.0 comp-sys-catman .cat
./usr/share/man/cat9/VREF.0 comp-obsolete obsolete
+./usr/share/man/cat9/atop.0 comp-sys-catman .cat
./usr/share/man/cat9/accept_filt_add.0 comp-sys-catman .cat
./usr/share/man/cat9/accept_filt_del.0 comp-sys-catman .cat
./usr/share/man/cat9/accept_filt_generic_mod_event.0 comp-sys-catman .cat
@@ -10617,6 +10618,7 @@
./usr/share/man/cat9/pserialize_read_enter.0 comp-sys-catman .cat
./usr/share/man/cat9/pserialize_read_exit.0 comp-sys-catman .cat
./usr/share/man/cat9/psignal.0 comp-sys-catman .cat
+./usr/share/man/cat9/ptoa.0 comp-sys-catman .cat
./usr/share/man/cat9/putiobuf.0 comp-sys-catman .cat
./usr/share/man/cat9/putter.0 comp-sys-catman .cat
./usr/share/man/cat9/radio.0 comp-sys-catman .cat
@@ -10639,6 +10641,7 @@
./usr/share/man/cat9/rnd_attach_source.0 comp-sys-catman .cat
./usr/share/man/cat9/rnd_detach_source.0 comp-sys-catman .cat
./usr/share/man/cat9/rnd_extract_data.0 comp-sys-catman .cat
+./usr/share/man/cat9/round_page.0 comp-sys-catman .cat
./usr/share/man/cat9/rounddown.0 comp-sys-catman .cat
./usr/share/man/cat9/roundup.0 comp-sys-catman .cat
./usr/share/man/cat9/roundup2.0 comp-sys-catman .cat
@@ -10833,6 +10836,7 @@
./usr/share/man/cat9/tprintf_open.0 comp-sys-catman .cat
./usr/share/man/cat9/transferlockers.0 comp-sys-catman .cat
./usr/share/man/cat9/trapsignal.0 comp-sys-catman .cat
+./usr/share/man/cat9/trunc_page.0 comp-sys-catman .cat
./usr/share/man/cat9/tsleep.0 comp-sys-catman .cat
./usr/share/man/cat9/ttyldisc_add.0 comp-sys-catman .cat
./usr/share/man/cat9/ttyldisc_lookup.0 comp-sys-catman .cat
@@ -15983,6 +15987,7 @@
./usr/share/man/html9/VOP_WHITEOUT.html comp-sys-htmlman html
./usr/share/man/html9/VOP_WRITE.html comp-sys-htmlman html
./usr/share/man/html9/VREF.html comp-obsolete obsolete
+./usr/share/man/html9/atop.html comp-sys-htmlman html
./usr/share/man/html9/accept_filt_add.html comp-sys-htmlman html
./usr/share/man/html9/accept_filt_del.html comp-sys-htmlman html
./usr/share/man/html9/accept_filt_generic_mod_event.html comp-sys-htmlman html
@@ -16852,6 +16857,7 @@
./usr/share/man/html9/pserialize_read_enter.html comp-sys-htmlman html
./usr/share/man/html9/pserialize_read_exit.html comp-sys-htmlman html
./usr/share/man/html9/psignal.html comp-sys-htmlman html
+./usr/share/man/html9/ptoa.html comp-sys-htmlman html
./usr/share/man/html9/putiobuf.html comp-sys-htmlman html
./usr/share/man/html9/putter.html comp-sys-htmlman html
./usr/share/man/html9/radio.html comp-sys-htmlman html
@@ -16873,6 +16879,7 @@
./usr/share/man/html9/rnd_attach_source.html comp-sys-htmlman html
./usr/share/man/html9/rnd_detach_source.html comp-sys-htmlman html
./usr/share/man/html9/rnd_extract_data.html comp-sys-htmlman html
+./usr/share/man/html9/round_page.html comp-sys-htmlman html
./usr/share/man/html9/rounddown.html comp-sys-htmlman html
./usr/share/man/html9/roundup.html comp-sys-htmlman html
./usr/share/man/html9/roundup2.html comp-sys-htmlman html
@@ -17054,6 +17061,7 @@
./usr/share/man/html9/tprintf_open.html comp-sys-htmlman html
./usr/share/man/html9/transferlockers.html comp-sys-htmlman html
./usr/share/man/html9/trapsignal.html comp-sys-htmlman html
+./usr/share/man/html9/trunc_page.html comp-sys-htmlman html
./usr/share/man/html9/tsleep.html comp-sys-htmlman html
./usr/share/man/html9/ttyldisc_add.html comp-sys-htmlman html
./usr/share/man/html9/ttyldisc_lookup.html comp-sys-htmlman html
@@ -22364,6 +22372,7 @@
./usr/share/man/man9/VOP_WHITEOUT.9 comp-sys-man .man
./usr/share/man/man9/VOP_WRITE.9 comp-sys-man .man
./usr/share/man/man9/VREF.9 comp-obsolete obsolete
+./usr/share/man/man9/atop.9 comp-sys-man .man
./usr/share/man/man9/accept_filt_add.9 comp-sys-man .man
./usr/share/man/man9/accept_filt_del.9 comp-sys-man .man
./usr/share/man/man9/accept_filt_generic_mod_event.9 comp-sys-man .man
@@ -23272,6 +23281,7 @@
./usr/share/man/man9/pserialize_read_enter.9 comp-sys-man .man
./usr/share/man/man9/pserialize_read_exit.9 comp-sys-man .man
./usr/share/man/man9/psignal.9 comp-sys-man .man
+./usr/share/man/man9/ptoa.9 comp-sys-man .man
./usr/share/man/man9/putiobuf.9 comp-sys-man .man
./usr/share/man/man9/putter.9 comp-sys-man .man
./usr/share/man/man9/radio.9 comp-sys-man .man
@@ -23294,6 +23304,7 @@
./usr/share/man/man9/rnd_attach_source.9 comp-sys-man .man
./usr/share/man/man9/rnd_detach_source.9 comp-sys-man .man
./usr/share/man/man9/rnd_extract_data.9 comp-sys-man .man
+./usr/share/man/man9/round_page.9 comp-sys-man .man
./usr/share/man/man9/rounddown.9 comp-sys-man .man
./usr/share/man/man9/roundup.9 comp-sys-man .man
./usr/share/man/man9/roundup2.9 comp-sys-man .man
@@ -23488,6 +23499,7 @@
./usr/share/man/man9/tprintf_open.9 comp-sys-man .man
./usr/share/man/man9/transferlockers.9 comp-sys-man .man
./usr/share/man/man9/trapsignal.9 comp-sys-man .man
+./usr/share/man/man9/trunc_page.9 comp-sys-man .man
./usr/share/man/man9/tsleep.9 comp-sys-man .man
./usr/share/man/man9/ttyldisc_add.9 comp-sys-man .man
./usr/share/man/man9/ttyldisc_lookup.9 comp-sys-man .man
Index: src/share/man/man9/Makefile
diff -u src/share/man/man9/Makefile:1.365 src/share/man/man9/Makefile:1.366
--- src/share/man/man9/Makefile:1.365 Sun May 13 09:00:52 2012
+++ src/share/man/man9/Makefile Mon Jul 2 21:10:31 2012
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.365 2012/05/13 09:00:52 mrg Exp $
+# $NetBSD: Makefile,v 1.366 2012/07/02 21:10:31 jym Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@@ -807,7 +807,9 @@ MLINKS+=uvm.9 uvm_init.9 uvm.9 uvm_init_
uvm.9 uvm_vsunlock.9 uvm.9 uvm_meter.9 \
uvm.9 uvm_fork.9 uvm.9 uvm_grow.9 \
uvm.9 uvn_findpages.9 \
- uvm.9 uvm_loan.9 uvm.9 uvm_unloan.9
+ uvm.9 uvm_loan.9 uvm.9 uvm_unloan.9 \
+ uvm.9 atop.9 uvm.9 ptoa.9 \
+ uvm.9 round_page.9 uvm.9 trunc_page.9
MLINKS+=uvm_km.9 uvm_km_alloc.9 uvm_km.9 uvm_km_free.9 \
uvm_km.9 uvm_km_suballoc.9
MLINKS+=uvm_map.9 uvm_unmap.9 uvm_map.9 uvm_map_pageable.9 \
Index: src/share/man/man9/uvm.9
diff -u src/share/man/man9/uvm.9:1.106 src/share/man/man9/uvm.9:1.107
--- src/share/man/man9/uvm.9:1.106 Wed Jun 1 02:22:18 2011
+++ src/share/man/man9/uvm.9 Mon Jul 2 21:10:31 2012
@@ -1,4 +1,4 @@
-.\" $NetBSD: uvm.9,v 1.106 2011/06/01 02:22:18 rmind Exp $
+.\" $NetBSD: uvm.9,v 1.107 2012/07/02 21:10:31 jym Exp $
.\"
.\" Copyright (c) 1998 Matthew R. Green
.\" All rights reserved.
@@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd June 1, 2011
+.Dd July 2, 2012
.Dt UVM 9
.Os
.Sh NAME
@@ -486,6 +486,36 @@ to
.Fa newsize .
Caller must hold a reference to the vnode.
If the vnode shrinks, pages no longer used are discarded.
+.Sh MISCELLANEOUS MACROS
+.Bl -ohang
+.It Ft paddr_t
+.Fn atop "paddr_t pa" ;
+.It Ft paddr_t
+.Fn ptoa "paddr_t pn" ;
+.It Ft paddr_t
+.Fn round_page "address" ;
+.It Ft paddr_t
+.Fn trunc_page "address" ;
+.El
+.Pp
+The
+.Fn atop
+macro converts a physical address
+.Fa pa
+into a page number.
+The
+.Fn ptoa
+macro does the opposite by converting a page number
+.Fa pn
+into a physical address.
+.Pp
+.Fn round_page
+and
+.Fn trunc_page
+macros return a page address boundary from rounding
+.Fa address
+up and down, respectively, to the nearest page boundary.
+These macros work for either addresses or byte counts.
.Sh SYSCTL
UVM provides support for the
.Dv CTL_VM
