xref: /dragonfly/sys/netgraph7/tee/ng_tee.h (revision 0147868ed7917851594b33d2d64fdac33ef85dc6)
1 
2 /*
3  * ng_tee.h
4  */
5 
6 /*-
7  * Copyright (c) 1996-1999 Whistle Communications, Inc.
8  * All rights reserved.
9  *
10  * Subject to the following obligations and disclaimer of warranty, use and
11  * redistribution of this software, in source or object code forms, with or
12  * without modifications are expressly permitted by Whistle Communications;
13  * provided, however, that:
14  * 1. Any and all reproductions of the source or object code must include the
15  *    copyright notice above and the following disclaimer of warranties; and
16  * 2. No rights are granted, in any manner or form, to use Whistle
17  *    Communications, Inc. trademarks, including the mark "WHISTLE
18  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
19  *    such appears in the above copyright notice or in the software.
20  *
21  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
22  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
23  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
24  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
26  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
27  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
28  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
29  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
30  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
31  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
32  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
33  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37  * OF SUCH DAMAGE.
38  *
39  * Author: Archie Cobbs <archie@freebsd.org>
40  *
41  * $FreeBSD: src/sys/netgraph/ng_tee.h,v 1.8 2005/01/07 01:45:39 imp Exp $
42  * $DragonFly: src/sys/netgraph7/ng_tee.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
43  * $Whistle: ng_tee.h,v 1.2 1999/01/20 00:22:14 archie Exp $
44  */
45 
46 #ifndef _NETGRAPH_NG_TEE_H_
47 #define _NETGRAPH_NG_TEE_H_
48 
49 /* Node type name and magic cookie */
50 #define NG_TEE_NODE_TYPE      "tee"
51 #define NGM_TEE_COOKIE                  916107047
52 
53 /* Hook names */
54 #define NG_TEE_HOOK_RIGHT     "right"
55 #define NG_TEE_HOOK_LEFT      "left"
56 #define NG_TEE_HOOK_RIGHT2LEFT          "right2left"
57 #define NG_TEE_HOOK_LEFT2RIGHT          "left2right"
58 
59 /* Statistics structure for one hook */
60 struct ng_tee_hookstat {
61           u_int64_t inOctets;
62           u_int64_t inFrames;
63           u_int64_t outOctets;
64           u_int64_t outFrames;
65 };
66 
67 /* Keep this in sync with the above structure definition */
68 #define NG_TEE_HOOKSTAT_INFO  {                                       \
69             { "inOctets",               &ng_parse_uint64_type         },        \
70             { "inFrames",               &ng_parse_uint64_type         },        \
71             { "outOctets",    &ng_parse_uint64_type         },        \
72             { "outFrames",    &ng_parse_uint64_type         },        \
73             { NULL }                                                            \
74 }
75 
76 /* Statistics structure returned by NGM_TEE_GET_STATS */
77 struct ng_tee_stats {
78           struct ng_tee_hookstat        right;
79           struct ng_tee_hookstat        left;
80           struct ng_tee_hookstat        right2left;
81           struct ng_tee_hookstat        left2right;
82 };
83 
84 /* Keep this in sync with the above structure definition */
85 #define NG_TEE_STATS_INFO(hstype)       {                             \
86             { "right",                  (hstype)            },        \
87             { "left",                   (hstype)            },        \
88             { "right2left",   (hstype)            },        \
89             { "left2right",   (hstype)            },        \
90             { NULL }                                                            \
91 }
92 
93 /* Netgraph commands */
94 enum {
95           NGM_TEE_GET_STATS = 1,                  /* get stats */
96           NGM_TEE_CLR_STATS,            /* clear stats */
97           NGM_TEE_GETCLR_STATS,                   /* atomically get and clear stats */
98 };
99 
100 #endif /* _NETGRAPH_NG_TEE_H_ */
101