Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src remove ubc_alloc(9) and ubc_release(9) from ubc...



details:   https://anonhg.NetBSD.org/src/rev/a6dbc03e48eb
branches:  trunk
changeset: 319002:a6dbc03e48eb
user:      jdolecek <jdolecek%NetBSD.org@localhost>
date:      Sat May 12 14:49:34 2018 +0000
description:
remove ubc_alloc(9) and ubc_release(9) from ubc(9) from the documentation, they
are internal (static) functions

pointed out by Matthew Green in private email

diffstat:

 distrib/sets/lists/comp/mi |  14 ++++----
 share/man/man9/Makefile    |   5 +-
 share/man/man9/ubc.9       |  72 +++++++++++++++------------------------------
 3 files changed, 33 insertions(+), 58 deletions(-)

diffs (197 lines):

diff -r 8da561613125 -r a6dbc03e48eb distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi        Sat May 12 10:33:06 2018 +0000
+++ b/distrib/sets/lists/comp/mi        Sat May 12 14:49:34 2018 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: mi,v 1.2192 2018/05/05 02:14:59 christos Exp $
+#      $NetBSD: mi,v 1.2193 2018/05/12 14:49:34 jdolecek Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 ./etc/mtree/set.comp                           comp-sys-root
@@ -11647,9 +11647,9 @@
 ./usr/share/man/cat9/uao_detach.0              comp-sys-catman         .cat
 ./usr/share/man/cat9/uao_reference.0           comp-sys-catman         .cat
 ./usr/share/man/cat9/ubc.0                     comp-sys-catman         .cat
-./usr/share/man/cat9/ubc_alloc.0               comp-sys-catman         .cat
+./usr/share/man/cat9/ubc_alloc.0               comp-obsolete           obsolete
 ./usr/share/man/cat9/ubc_purge.0               comp-sys-catman         .cat
-./usr/share/man/cat9/ubc_release.0             comp-sys-catman         .cat
+./usr/share/man/cat9/ubc_release.0             comp-obsolete           obsolete
 ./usr/share/man/cat9/ubc_uiomove.0             comp-sys-catman         .cat
 ./usr/share/man/cat9/ubc_zerorange.0           comp-sys-catman         .cat
 ./usr/share/man/cat9/ucas.0                    comp-sys-catman         .cat
@@ -19299,9 +19299,9 @@
 ./usr/share/man/html9/uao_detach.html          comp-sys-htmlman        html
 ./usr/share/man/html9/uao_reference.html       comp-sys-htmlman        html
 ./usr/share/man/html9/ubc.html                 comp-sys-htmlman        html
-./usr/share/man/html9/ubc_alloc.html           comp-sys-htmlman        html
+./usr/share/man/html9/ubc_alloc.html           comp-obsolete           obsolete
 ./usr/share/man/html9/ubc_purge.html           comp-sys-htmlman        html
-./usr/share/man/html9/ubc_release.html         comp-sys-htmlman        html
+./usr/share/man/html9/ubc_release.html         comp-obsolete           obsolete
 ./usr/share/man/html9/ubc_uiomove.html         comp-sys-htmlman        html
 ./usr/share/man/html9/ubc_zerorange.html       comp-sys-htmlman        html
 ./usr/share/man/html9/ucas.html                        comp-sys-htmlman        html
@@ -27159,9 +27159,9 @@
 ./usr/share/man/man9/uao_detach.9              comp-sys-man            .man
 ./usr/share/man/man9/uao_reference.9           comp-sys-man            .man
 ./usr/share/man/man9/ubc.9                     comp-sys-man            .man
-./usr/share/man/man9/ubc_alloc.9               comp-sys-man            .man
+./usr/share/man/man9/ubc_alloc.9               comp-obsolete           obsolete
 ./usr/share/man/man9/ubc_purge.9               comp-sys-man            .man
-./usr/share/man/man9/ubc_release.9             comp-sys-man            .man
+./usr/share/man/man9/ubc_release.9             comp-obsolete           obsolete
 ./usr/share/man/man9/ubc_uiomove.9             comp-sys-man            .man
 ./usr/share/man/man9/ubc_zerorange.9           comp-sys-man            .man
 ./usr/share/man/man9/ucas.9                    comp-sys-man            .man
diff -r 8da561613125 -r a6dbc03e48eb share/man/man9/Makefile
--- a/share/man/man9/Makefile   Sat May 12 10:33:06 2018 +0000
+++ b/share/man/man9/Makefile   Sat May 12 14:49:34 2018 +0000
@@ -1,4 +1,4 @@
-#       $NetBSD: Makefile,v 1.419 2018/04/10 16:12:29 maxv Exp $
+#       $NetBSD: Makefile,v 1.420 2018/05/12 14:49:34 jdolecek Exp $
 
 #      Makefile for section 9 (kernel function and variable) manual pages.
 
@@ -921,8 +921,7 @@
 MLINKS+=todr.9 todr_gettime.9 todr.9 todr_settime.9 \
        todr.9 clock_ymdhms_to_secs.9 todr.9 clock_secs_to_ymdhms.9
 
-MLINKS+=ubc.9 ubc_alloc.9 ubc.9 ubc_release.9 ubc.9 ubc_uiomove.9
-MLINKS+=ubc.9 ubc_zerorange.9 ubc.9 ubc_purge.9
+MLINKS+=ubc.9 ubc_uiomove.9 ubc.9 ubc_zerorange.9 ubc.9 ubc_purge.9
 MLINKS+=uvm.9 uvm_init.9 uvm.9 uvm_init_limits.9 uvm.9 uvm_setpagesize.9 \
        uvm.9 uvm_swap_init.9 uvm.9 uvm_fault.9 \
        uvm.9 uvm_vnp_setsize.9 \
diff -r 8da561613125 -r a6dbc03e48eb share/man/man9/ubc.9
--- a/share/man/man9/ubc.9      Sat May 12 10:33:06 2018 +0000
+++ b/share/man/man9/ubc.9      Sat May 12 14:49:34 2018 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: ubc.9,v 1.13 2017/04/06 09:52:32 abhinav Exp $
+.\"    $NetBSD: ubc.9,v 1.14 2018/05/12 14:49:34 jdolecek 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 April 6, 2017
+.Dd May 12, 2018
 .Dt UBC 9
 .Os
 .Sh NAME
@@ -32,11 +32,6 @@
 .Nd unified buffer cache
 .Sh SYNOPSIS
 .In uvm/uvm.h
-.Ft void *
-.Fn ubc_alloc "struct uvm_object *uobj" "voff_t offset" "vsize_t *lenp" \
-"int advice" "int flags"
-.Ft void
-.Fn ubc_release "void *va" "int flags"
 .Ft int
 .Fn ubc_uiomove "struct uvm_object *uobj" "struct uio *uio" "vsize_t todo" \
  "int advice" "int flags"
@@ -46,18 +41,11 @@
 .Ft void
 .Fn ubc_purge "struct uvm_object *uobj"
 .Sh DESCRIPTION
-.Fn ubc_alloc
-creates a kernel mapping of
-.Fa uobj
-starting at offset
-.Fa offset .
-The desired length of the mapping is pointed to by
-.Fa lenp ,
-but the actual mapping may be smaller than this.
-.Fa lenp
-is updated to contain the actual length mapped.
+.Fn ubc_uiomove
+allocates an UBC memory window, performs I/O on it and unmaps the window.
+The
 .Fa advice
-is the access pattern hint, which must be one of
+parameter is the access pattern hint, which must be one of
 .Pp
 .Bl -tag -offset indent -width "UVM_ADV_SEQUENTIAL" -compact
 .It UVM_ADV_NORMAL
@@ -68,9 +56,9 @@
 Sequential access hint (from lower offset to higher offset)
 .El
 .Pp
-The possible
+and the
 .Fa flags
-are
+parameter is
 .Pp
 .Bl -tag -offset indent -width "UVM_ADV_SEQUENTIAL" -compact
 .It UBC_READ
@@ -80,8 +68,19 @@
 .It UBC_FAULTBUSY
 Fault in window's pages already during mapping operation.
 Makes sense only for write.
+.It UBC_UNMAP
+Do not cache mapping.
+.It UBC_PARTIALOK
+Indicate that it is acceptable to return if an error occurs mid-transfer.
 .El
 .Pp
+UBC memory window is a kernel mapping of
+.Fa uobj
+starting at offset
+.Fa offset .
+The desired length of the mapping is pointed to by
+.Fa lenp ,
+but the actual mapping may be smaller than this.
 Once the mapping is created, it must be accessed only by methods that can
 handle faults, such as
 .Xr uiomove 9
@@ -90,42 +89,19 @@
 Page faults on the mapping will result in the object's pager
 method being called to resolve the fault.
 .Pp
-.Fn ubc_release
-frees the mapping at
-.Fa va
-for reuse.
 The mapping may be cached to speed future accesses to the same region
-of the object.
-The flags can be any of
-.Pp
-.Bl -tag -offset indent -width "UVM_ADV_SEQUENTIAL" -compact
-.It UBC_UNMAP
-Do not cache mapping.
-.El
-.Pp
-.Fn ubc_uiomove
-allocates an UBC memory window, performs I/O on it and unmaps the window.
-The
-.Fa advice
-parameter takes the same values as the respective parameter in
-.Fn ubc_alloc
-and the
+of the object, unless
+.Dv UBC_UNMAP
+was specified in
 .Fa flags
-parameter takes the same arguments as
-.Fn ubc_alloc
-and
-.Fn ubc_release .
-Additionally, the flag
-.Dv UBC_PARTIALOK
-can be provided to indicate that it is acceptable to return if an error
-occurs mid-transfer.
+parameter.
 .Pp
 .Fn ubc_zerorange
 sets a range of bytes in a UVM object to zero.
 The
 .Fa flags
 parameter takes the same arguments as
-.Fn ubc_release .
+.Fn ubc_uiomove .
 .Pp
 .Fn ubc_purge
 disassociates all UBC structures from an empty UVM object,



Home | Main Index | Thread Index | Old Index