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