OS-969 want to perturb vnics

OS-997 net_* and hook_* man pages are wrong
Reviewed by: Jerry Jelinek <jerry.jelinek@joyent.com>
Reviewed by: Rob Gulewich <robert.gulewich@joyent.com>
Reviewed by: Brendan Gregg <brendan.gregg@joyent.com>

4 files changed, 35 insertions, 13 deletions

diff --git a/usr/src/man/man9f/net_hook_register.9f b/usr/src/man/man9f/net_hook_register.9f
index 6cffdc1e64..3d10a10524 100644
--- a/usr/src/man/man9f/net_hook_register.9f
+++ b/usr/src/man/man9f/net_hook_register.9f
@@ -1,9 +1,10 @@
 '\" te
 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
+.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved.
 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH NET_HOOK_REGISTER 9F "May 1, 2008"
+.TH NET_HOOK_REGISTER 9F "Mar 5, 2012"
 .SH NAME
 net_hook_register \- add a hook to be called in event processing
 .SH SYNOPSIS
@@ -11,7 +12,7 @@ net_hook_register \- add a hook to be called in event processing
 .nf
 #include <sys/neti.h>
 
-\fBnet_hook_t\fR \fBnet_hook_register\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBhook_t\fR *\fIhook\fR);
+\fBint\fR \fBnet_hook_register\fR(\fBnet_handle_t\fR \fIinfo\fR, \fBchar\fR *\fIevent\fR, \fBhook_t\fR *\fIhook\fR);
 .fi
 
 .SH INTERFACE LEVEL
@@ -22,7 +23,7 @@ Solaris DDI specific (Solaris DDI).
 .sp
 .ne 2
 .na
-\fB\fInet\fR\fR
+\fB\fIinfo\fR\fR
 .ad
 .RS 8n
 value returned from a successful call to \fBnet_protocol_register()\fR.
@@ -31,6 +32,15 @@ value returned from a successful call to \fBnet_protocol_register()\fR.
 .sp
 .ne 2
 .na
+\fB\fIname\fR\fR
+.ad
+.RS 8n
+unique name for this hook.
+.RE
+
+.sp
+.ne 2
+.na
 \fB\fIhook\fR\fR
 .ad
 .RS 8n
@@ -42,9 +52,10 @@ pointer to a \fBhook_t\fR structure.
 .LP
 The \fBnet_hook_register()\fR function uses hooks that allow callbacks to be
 registered with events that belong to a network protocol. A successful call to
-\fBnet_hook_register()\fR requires that a valid handle for a network protocol
-be provided (the \fInet\fR parameter), along with a hook description that
-includes a reference to an available event.
+\fBnet_hook_register()\fR requires that a valid handle for a network protocol be
+provided (the \fIinfo\fR parameter), along with a unique name and a hook
+description that includes a reference to an available event. No two hooks on the
+same netstack may share a name.
 .sp
 .LP
 While it is possible to use the same \fBhook_t\fR structure with multiple calls
@@ -154,6 +165,14 @@ because it conflicts with another hook. An example of this might be specifying
 with this value.
 .RE
 
+.sp
+.ne 2
+.na
+\fBESHUTDOWN\fR
+.ad
+.RS 10n
+The netstack corresponding to \fIinfo\fR is condemned or no longer exists.
+
 .SH CONTEXT
 .sp
 .LP
diff --git a/usr/src/man/man9f/net_instance_alloc.9f b/usr/src/man/man9f/net_instance_alloc.9f
index 0f51ce67d6..146054f5d4 100644
--- a/usr/src/man/man9f/net_instance_alloc.9f
+++ b/usr/src/man/man9f/net_instance_alloc.9f
@@ -1,9 +1,10 @@
 '\" te
 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
+.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved.
 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH NET_INSTANCE_ALLOC 9F "May 1, 2008"
+.TH NET_INSTANCE_ALLOC 9F "Mar 5, 2012"
 .SH NAME
 net_instance_alloc \- allocate a net_instance_t structure
 .SH SYNOPSIS
@@ -25,7 +26,7 @@ Solaris DDI specific (Solaris DDI).
 \fB\fIversion\fR\fR
 .ad
 .RS 11n
-must always be the symbol \fBNETI_VERSION\fR.
+must always be the symbol \fBNETINFO_VERSION\fR.
 .RE
 
 .SH DESCRIPTION
diff --git a/usr/src/man/man9f/net_protocol_lookup.9f b/usr/src/man/man9f/net_protocol_lookup.9f
index d6707d7c9e..cafa4c2c4f 100644
--- a/usr/src/man/man9f/net_protocol_lookup.9f
+++ b/usr/src/man/man9f/net_protocol_lookup.9f
@@ -1,9 +1,10 @@
 '\" te
 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
+.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved.
 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH NET_PROTOCOL_LOOKUP 9F "May 1, 2008"
+.TH NET_PROTOCOL_LOOKUP 9F "Mar 5, 2012"
 .SH NAME
 net_protocol_lookup \- locate an implementation of a network layer protocol
 .SH SYNOPSIS
@@ -11,7 +12,7 @@ net_protocol_lookup \- locate an implementation of a network layer protocol
 .nf
 #include <sys/neti.h>
 
-\fBnet_data_t\fR \fBnet_protocol_lookup\fR(\fBnetid_t\fR \fIid\fR, \fBconst\fR \fBchar\fR *\fIprotocol\fR);
+\fBnet_handle_t\fR \fBnet_protocol_lookup\fR(\fBnetid_t\fR \fIid\fR, \fBconst\fR \fBchar\fR *\fIprotocol\fR);
 .fi
 
 .SH INTERFACE LEVEL
diff --git a/usr/src/man/man9f/net_protocol_release.9f b/usr/src/man/man9f/net_protocol_release.9f
index 5f9d1c5be5..f1759d099d 100644
--- a/usr/src/man/man9f/net_protocol_release.9f
+++ b/usr/src/man/man9f/net_protocol_release.9f
@@ -1,9 +1,10 @@
 '\" te
 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
+.\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved.
 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH NET_PROTOCOL_RELEASE 9F "May 1, 2008"
+.TH NET_PROTOCOL_RELEASE 9F "Mar 5, 2012"
 .SH NAME
 net_protocol_release \- indicate that a reference to a network protocol is no
 longer required
@@ -12,7 +13,7 @@ longer required
 .nf
 #include <sys/neti.h>
 
-\fBint\fR \fBnet_protocol_release\fR(\fBnet_data_t\fR *\fInet\fR);
+\fBint\fR \fBnet_protocol_release\fR(\fBnet_handle_t\fR \fIinfo\fR);
 .fi
 
 .SH INTERFACE LEVEL
@@ -23,7 +24,7 @@ Solaris DDI specific (Solaris DDI).
 .sp
 .ne 2
 .na
-\fB\fInet\fR\fR
+\fB\fIinfo\fR\fR
 .ad
 .RS 7n
 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).