summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorMartin Pieuchot <mpi@cvs.openbsd.org>2015-09-11 19:27:06 +0000
committerMartin Pieuchot <mpi@cvs.openbsd.org>2015-09-11 19:27:06 +0000
commit27a5f76bf7342c569af95f87f2415b310151ac11 (patch)
treedad32b9cc28d7d152b116906e2eda6b19a313b93 /share
parent8cb12af7abe545546c2692ce0731ea72c887947b (diff)
Document rtref(9).
Diffstat (limited to 'share')
-rw-r--r--share/man/man9/Makefile5
-rw-r--r--share/man/man9/rtalloc.912
2 files changed, 13 insertions, 4 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 2c196f289a1..f97e153e884 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.242 2015/09/11 19:13:22 dlg Exp $
+# $OpenBSD: Makefile,v 1.243 2015/09/11 19:27:05 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.
@@ -335,7 +335,8 @@ MLINKS+=rt_timer_add.9 rt_timer_queue_create.9 \
rt_timer_add.9 rt_timer_queue_change.9 \
rt_timer_add.9 rt_timer_queue_destroy.9 \
rt_timer_add.9 rt_timer_remove_all.9
-MLINKS+=rtalloc.9 rtalloc_mpath.9 rtalloc.9 rtisvalid.9 rtalloc.9 rtfree.9
+MLINKS+=rtalloc.9 rtalloc_mpath.9 rtalloc.9 rtisvalid.9 rtalloc.9 rtref.9 \
+ rtalloc.9 rtfree.9
MLINKS+=rtable_add.9 rtable_exists.9 rtable_add.9 rtable_get.9 \
rtable_add.9 rtable_l2.9 rtable_add.9 rtable_l2set.9
MLINKS+=rtlabel_id2name.9 rtlabel_name2id.9 \
diff --git a/share/man/man9/rtalloc.9 b/share/man/man9/rtalloc.9
index 1110bbc214c..9b406cdb8b7 100644
--- a/share/man/man9/rtalloc.9
+++ b/share/man/man9/rtalloc.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: rtalloc.9,v 1.5 2015/09/01 13:46:58 jmc Exp $
+.\" $OpenBSD: rtalloc.9,v 1.6 2015/09/11 19:27:05 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: September 1 2015 $
+.Dd $Mdocdate: September 11 2015 $
.Dt RTALLOC 9
.Os
.Sh NAME
@@ -34,6 +34,8 @@
.Ft int
.Fn rtisvalid "struct rtentry *rt"
.Ft void
+.Fn rtref "struct rtentry *rt"
+.Ft void
.Fn rtfree "struct rtentry *rt"
.Sh DESCRIPTION
The
@@ -76,6 +78,11 @@ Cached entries that are no longer valid should be released by calling
.Fn rtfree .
.Pp
The
+.Fn rtref
+function increments a reference to the routing entry
+.Fa rt .
+.Pp
+The
.Fn rtfree
function releases a reference to the routing entry
.Fa rt ,
@@ -84,6 +91,7 @@ freeing it if the reference count drops to 0.
.Fn rtalloc ,
.Fn rtalloc_mpath ,
.Fn rtisvalid ,
+.Fn rtref ,
and
.Fn rtfree
can be called during autoconf, from process context, or from interrupt context.