Document & cross Xr rtable_walk(9).

With inputs from jmc@ and schwarze@

3 files changed, 80 insertions, 4 deletions

diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index e92d1f3e2e1..8f729746f3f 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.295 2019/06/21 09:39:48 visa Exp $
+#	$OpenBSD: Makefile,v 1.296 2019/07/12 16:53:57 mpi Exp $
 #	$NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $
 
 #	Makefile for section 9 (kernel function and variable) manual pages.
@@ -29,7 +29,8 @@ MAN=	aml_evalnode.9 atomic_add_int.9 atomic_cas_uint.9 \
 	pmap.9 pool.9 pool_cache_init.9 ppsratecheck.9 printf.9 psignal.9 \
 	RBT_INIT.9 \
 	radio.9 arc4random.9 rasops.9 ratecheck.9 refcnt_init.9 resettodr.9 \
-	rssadapt.9 route.9 rt_ifa_add.9 rt_timer_add.9 rtalloc.9 rtable_add.9 \
+	rssadapt.9 route.9 rt_ifa_add.9 rt_timer_add.9 \
+	rtalloc.9 rtable_add.9 rtable_walk.9 \
 	rtlabel_id2name.9 rtrequest.9 rwlock.9 SRPL_EMPTY_LOCKED.9 SipHash24.9 \
 	sensor_attach.9 sigio_init.9 \
 	SMR_LIST_INIT.9 SMR_PTR_GET.9 smr_call.9 \
diff --git a/share/man/man9/rtable_walk.9 b/share/man/man9/rtable_walk.9
new file mode 100644
index 00000000000..028969471da
--- /dev/null
+++ b/share/man/man9/rtable_walk.9
@@ -0,0 +1,74 @@
+.\"     $OpenBSD: rtable_walk.9,v 1.1 2019/07/12 16:53:57 mpi Exp $
+.\"
+.\" Copyright (c) 2019 Martin Pieuchot <mpi@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: July 12 2019 $
+.Dt RTABLE_WALK 9
+.Os
+.Sh NAME
+.Nm rtable_walk
+.Nd iterate over a routing table
+.Sh SYNOPSIS
+.In net/rtable.h
+.Ft int
+.Fo rtable_walk
+.Fa "unsigned int rtableid"
+.Fa "sa_family_t af"
+.Fa "struct rtentry **prt"
+.Fa "int (*func)(struct rtentry *, void *, unsigned int)"
+.Fa "void *arg"
+.Fc
+.Sh DESCRIPTION
+The
+.Fn rtable_walk
+function iterates over the routing table
+.Fa rtableid
+and applies
+.Fa func
+to all entries of address family
+.Fa af .
+.Pp
+The iteration is interrupted as soon as
+.Fa func
+returns a non-zero value.
+If
+.Fa prt
+is not
+.Dv NULL
+when the iteration is interrupted, it is set to the current
+routing entry.
+In that case
+.Fn rtfree
+must be called on the routing entry pointed to by
+.Fa prt .
+.Sh CONTEXT
+.Fn rtable_walk
+can be called during autoconf or from process context.
+.Sh RETURN VALUES
+.Fn rtable_walk
+returns any non-zero value returned by
+.Fa func .
+It may also fail with:
+.Pp
+.Bl -tag -width Er -compact
+.It Bq Er EAFNOSUPPORT
+A routing table with ID of
+.Fa rtableid
+and address family of
+.Fa af
+doesn't exist.
+.El
+.Sh SEE ALSO
+.Xr rtfree 9
diff --git a/share/man/man9/rtalloc.9 b/share/man/man9/rtalloc.9
index 6be60ccd5f8..b9faff21752 100644
--- a/share/man/man9/rtalloc.9
+++ b/share/man/man9/rtalloc.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: rtalloc.9,v 1.11 2015/12/02 14:13:14 jmc Exp $
+.\" $OpenBSD: rtalloc.9,v 1.12 2019/07/12 16:53:57 mpi Exp $
 .\"
 .\" Copyright (c) 2014-2015 Martin Pieuchot
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: December 2 2015 $
+.Dd $Mdocdate: July 12 2019 $
 .Dt RTALLOC 9
 .Os
 .Sh NAME
@@ -102,4 +102,5 @@ can be called during autoconf, from process context, or from interrupt context.
 returns 1 if the route entry is valid, otherwise 0.
 .Sh SEE ALSO
 .Xr route 4 ,
+.Xr rtable_walk 9 ,
 .Xr rtrequest 9