xref: /freebsd/sys/netgraph/ng_etf.h (revision 70fe064ad7cab6c0444b91622f60ec6a462f308a)
1 /*-
2  * ng_etf.h
3  *
4  * Copyright (c) 2001, FreeBSD Incorporated
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * Author: Julian Elischer <julian@freebsd.org>
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef _NETGRAPH_ETHERTYPE_FILTER_H_
35 #define _NETGRAPH_ETHERTYPE_FILTER_H_
36 
37 /* Node type name. This should be unique among all netgraph node types */
38 #define NG_ETF_NODE_TYPE	"etf"
39 
40 /* Node type cookie. Should also be unique. This value MUST change whenever
41    an incompatible change is made to this header file, to insure consistency.
42    The de facto method for generating cookies is to take the output of the
43    date command: date -u +'%s' */
44 #define NGM_ETF_COOKIE		983084516
45 
46 /* Hook names */
47 #define NG_ETF_HOOK_DOWNSTREAM	"downstream"
48 #define NG_ETF_HOOK_NOMATCH	"nomatch"
49 
50 /* Netgraph commands understood by this node type */
51 enum {
52 	NGM_ETF_SET_FLAG = 1,
53 	NGM_ETF_GET_STATUS,
54 	NGM_ETF_SET_FILTER,
55 
56 };
57 
58 /* This structure is returned by the NGM_ETF_GET_STATUS command */
59 struct ng_etfstat {
60 	u_int32_t   packets_in;		/* packets in from downstream */
61 	u_int32_t   packets_out;	/* packets out towards downstream */
62 };
63 
64 /*
65  * This needs to be kept in sync with the above structure definition
66  */
67 #define NG_ETF_STATS_TYPE_INFO	{				\
68 	{							\
69 	  { "packets_in",	&ng_parse_uint32_type	},	\
70 	  { "packets_out",	&ng_parse_uint32_type	},	\
71 	  { NULL },						\
72 	}							\
73 }
74 
75 /* This structure is returned by the NGM_ETF_GET_STATUS command */
76 struct ng_etffilter {
77 	char		matchhook[NG_HOOKLEN + 1]; /* hook name */
78 	u_int16_t	ethertype;	/* this ethertype to this hook */
79 };
80 
81 /*
82  * This needs to be kept in sync with the above structure definition
83  */
84 #define NG_ETF_FILTER_TYPE_INFO	{				\
85 	{							\
86           { "matchhook",	&ng_parse_hookbuf_type  },	\
87 	  { "ethertype",	&ng_parse_uint16_type   },	\
88 	  { NULL },						\
89 	}							\
90 }
91 
92 #endif /* _NETGRAPH_ETHERTYPE_FILTER_H_ */
93