xref: /freebsd/sys/netgraph/ng_echo.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*
2  * ng_echo.c
3  */
4 
5 /*-
6  * Copyright (c) 1996-1999 Whistle Communications, Inc.
7  * All rights reserved.
8  *
9  * Subject to the following obligations and disclaimer of warranty, use and
10  * redistribution of this software, in source or object code forms, with or
11  * without modifications are expressly permitted by Whistle Communications;
12  * provided, however, that:
13  * 1. Any and all reproductions of the source or object code must include the
14  *    copyright notice above and the following disclaimer of warranties; and
15  * 2. No rights are granted, in any manner or form, to use Whistle
16  *    Communications, Inc. trademarks, including the mark "WHISTLE
17  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18  *    such appears in the above copyright notice or in the software.
19  *
20  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36  * OF SUCH DAMAGE.
37  *
38  * Author: Julian Elisher <julian@freebsd.org>
39  * $Whistle: ng_echo.c,v 1.13 1999/11/01 09:24:51 julian Exp $
40  */
41 
42 /*
43  * Netgraph "echo" node
44  *
45  * This node simply bounces data and messages back to whence they came.
46  */
47 
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/mbuf.h>
53 #include <netgraph/ng_message.h>
54 #include <netgraph/netgraph.h>
55 #include <netgraph/ng_echo.h>
56 
57 /* Netgraph methods */
58 static ng_constructor_t	nge_cons;
59 static ng_rcvmsg_t	nge_rcvmsg;
60 static ng_rcvdata_t	nge_rcvdata;
61 static ng_disconnect_t	nge_disconnect;
62 
63 /* Netgraph type */
64 static struct ng_type typestruct = {
65 	.version =	NG_ABI_VERSION,
66 	.name =		NG_ECHO_NODE_TYPE,
67 	.constructor =	nge_cons,
68 	.rcvmsg =	nge_rcvmsg,
69 	.rcvdata =	nge_rcvdata,
70 	.disconnect =	nge_disconnect,
71 };
72 NETGRAPH_INIT(echo, &typestruct);
73 
74 static int
75 nge_cons(node_p node)
76 {
77 	return (0);
78 }
79 
80 /*
81  * Receive control message. We just bounce it back as a reply.
82  */
83 static int
84 nge_rcvmsg(node_p node, item_p item, hook_p lasthook)
85 {
86 	struct ng_mesg *msg;
87 	int error = 0;
88 
89 	NGI_GET_MSG(item, msg);
90 	msg->header.flags |= NGF_RESP;
91 	NG_RESPOND_MSG(error, node, item, msg);
92 	return (error);
93 }
94 
95 /*
96  * Receive data
97  */
98 static int
99 nge_rcvdata(hook_p hook, item_p item)
100 {
101 	int error;
102 
103 	NG_FWD_ITEM_HOOK(error, item, hook);
104 	return (error);
105 }
106 
107 /*
108  * Removal of the last link destroys the nodeo
109  */
110 static int
111 nge_disconnect(hook_p hook)
112 {
113 	if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
114 	&& (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))) {
115 		ng_rmnode_self(NG_HOOK_NODE(hook));
116 	}
117 	return (0);
118 }
119