summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorglebius <glebius@FreeBSD.org>2012-07-04 07:42:12 +0000
committerglebius <glebius@FreeBSD.org>2012-07-04 07:42:12 +0000
commite5f970ed4ae0b5e770b2a67c389d8eb77ec82993 (patch)
tree92135bc0a7ebb3d73b1ba5d278bd6bad8f1e1d40
parent418a04b4676ef1730c653057e7bea6e0d8ff06aa (diff)
downloadFreeBSD-src-e5f970ed4ae0b5e770b2a67c389d8eb77ec82993.zip
FreeBSD-src-e5f970ed4ae0b5e770b2a67c389d8eb77ec82993.tar.gz
Document RO_RTFREE() macro.
-rw-r--r--share/man/man9/rtalloc.911
1 files changed, 10 insertions, 1 deletions
diff --git a/share/man/man9/rtalloc.9 b/share/man/man9/rtalloc.9
index ab5379a..ea22f87 100644
--- a/share/man/man9/rtalloc.9
+++ b/share/man/man9/rtalloc.9
@@ -28,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 14, 2011
+.Dd July 4, 2012
.Dt RTALLOC 9
.Os
.Sh NAME
@@ -52,6 +52,7 @@
.Fn RT_UNLOCK "struct rt_entry *rt"
.Fn RT_ADDREF "struct rt_entry *rt"
.Fn RT_REMREF "struct rt_entry *rt"
+.Fn RO_RTFREE "struct route *ro"
.Ft void
.Fn rtfree "struct rt_entry *rt"
.Ft "struct rtentry *"
@@ -203,6 +204,14 @@ Its usage is contrary to
.Fn RT_ADDREF .
.Pp
The
+.Fn RO_RTFREE
+macro is used to free route entry that is referenced by struct route.
+At certain circumstances the latter may not hold a reference on rtentry,
+and
+.Fn RO_RTFREE
+treats such routes correctly.
+.Pp
+The
.Fn rtfree
function does the actual free of the routing table entry, and shouldn't
be called directly by facilities, that just perform routing table lookups.
OpenPOWER on IntegriCloud