xref: /freebsd/sys/netgraph/ng_bpf.h (revision 61ba55bcf70f2340f9c943c9571113b3fd8eda69)
1 /*
2  * ng_bpf.h
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: Archie Cobbs <archie@freebsd.org>
39  * $Whistle: ng_bpf.h,v 1.3 1999/12/03 20:30:23 archie Exp $
40  */
41 
42 #ifndef _NETGRAPH_NG_BPF_H_
43 #define _NETGRAPH_NG_BPF_H_
44 
45 /* Node type name and magic cookie */
46 #define NG_BPF_NODE_TYPE	"bpf"
47 #define NGM_BPF_COOKIE		944100792
48 
49 /* Program structure for one hook */
50 struct ng_bpf_hookprog {
51 	char		thisHook[NG_HOOKSIZ];		/* name of hook */
52 	char		ifMatch[NG_HOOKSIZ];		/* match dest hook */
53 	char		ifNotMatch[NG_HOOKSIZ];		/* !match dest hook */
54 	int32_t		bpf_prog_len;			/* #insns in program */
55 	struct bpf_insn	bpf_prog[];			/* bpf program */
56 };
57 
58 #define NG_BPF_HOOKPROG_SIZE(numInsn)	\
59 	(sizeof(struct ng_bpf_hookprog) + (numInsn) * sizeof(struct bpf_insn))
60 
61 /* Keep this in sync with the above structure definition */
62 #define NG_BPF_HOOKPROG_TYPE_INFO(bptype)	{		\
63 	  { "thisHook",		&ng_parse_hookbuf_type	},	\
64 	  { "ifMatch",		&ng_parse_hookbuf_type	},	\
65 	  { "ifNotMatch",	&ng_parse_hookbuf_type	},	\
66 	  { "bpf_prog_len",	&ng_parse_int32_type	},	\
67 	  { "bpf_prog",		(bptype)		},	\
68 	  { NULL }						\
69 }
70 
71 /* Statistics structure for one hook */
72 struct ng_bpf_hookstat {
73 	u_int64_t	recvFrames;
74 	u_int64_t	recvOctets;
75 	u_int64_t	recvMatchFrames;
76 	u_int64_t	recvMatchOctets;
77 	u_int64_t	xmitFrames;
78 	u_int64_t	xmitOctets;
79 };
80 
81 /* Keep this in sync with the above structure definition */
82 #define NG_BPF_HOOKSTAT_TYPE_INFO	{			\
83 	  { "recvFrames",	&ng_parse_uint64_type	},	\
84 	  { "recvOctets",	&ng_parse_uint64_type	},	\
85 	  { "recvMatchFrames",	&ng_parse_uint64_type	},	\
86 	  { "recvMatchOctets",	&ng_parse_uint64_type	},	\
87 	  { "xmitFrames",	&ng_parse_uint64_type	},	\
88 	  { "xmitOctets",	&ng_parse_uint64_type	},	\
89 	  { NULL }						\
90 }
91 
92 /* Netgraph commands */
93 enum {
94 	NGM_BPF_SET_PROGRAM = 1,	/* supply a struct ng_bpf_hookprog */
95 	NGM_BPF_GET_PROGRAM,		/* returns a struct ng_bpf_hookprog */
96 	NGM_BPF_GET_STATS,		/* supply name as char[NG_HOOKSIZ] */
97 	NGM_BPF_CLR_STATS,		/* supply name as char[NG_HOOKSIZ] */
98 	NGM_BPF_GETCLR_STATS,		/* supply name as char[NG_HOOKSIZ] */
99 };
100 
101 #endif /* _NETGRAPH_NG_BPF_H_ */
102