xref: /dflybsd-src/sys/netgraph7/deflate/ng_deflate.h (revision df747d8a79103af27f9dcb69b19f48278560a56f)
1*df747d8aSNuno Antunes /*-
2*df747d8aSNuno Antunes  * Copyright (c) 2006 Alexander Motin <mav@alkar.net>
3*df747d8aSNuno Antunes  * All rights reserved.
4*df747d8aSNuno Antunes  *
5*df747d8aSNuno Antunes  * Redistribution and use in source and binary forms, with or without
6*df747d8aSNuno Antunes  * modification, are permitted provided that the following conditions
7*df747d8aSNuno Antunes  * are met:
8*df747d8aSNuno Antunes  * 1. Redistributions of source code must retain the above copyright
9*df747d8aSNuno Antunes  *    notice unmodified, this list of conditions, and the following
10*df747d8aSNuno Antunes  *    disclaimer.
11*df747d8aSNuno Antunes  * 2. Redistributions in binary form must reproduce the above copyright
12*df747d8aSNuno Antunes  *    notice, this list of conditions and the following disclaimer in the
13*df747d8aSNuno Antunes  *    documentation and/or other materials provided with the distribution.
14*df747d8aSNuno Antunes  *
15*df747d8aSNuno Antunes  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*df747d8aSNuno Antunes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*df747d8aSNuno Antunes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*df747d8aSNuno Antunes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*df747d8aSNuno Antunes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*df747d8aSNuno Antunes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*df747d8aSNuno Antunes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*df747d8aSNuno Antunes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*df747d8aSNuno Antunes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*df747d8aSNuno Antunes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*df747d8aSNuno Antunes  * SUCH DAMAGE.
26*df747d8aSNuno Antunes  *
27*df747d8aSNuno Antunes  * $FreeBSD: src/sys/netgraph/ng_deflate.h,v 1.1 2006/12/28 15:44:05 glebius Exp $
28*df747d8aSNuno Antunes  * $DragonFly: src/sys/netgraph7/ng_deflate.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
29*df747d8aSNuno Antunes  */
30*df747d8aSNuno Antunes 
31*df747d8aSNuno Antunes #ifndef _NETGRAPH_NG_DEFLATE_H_
32*df747d8aSNuno Antunes #define _NETGRAPH_NG_DEFLATE_H_
33*df747d8aSNuno Antunes 
34*df747d8aSNuno Antunes /* Node type name and magic cookie */
35*df747d8aSNuno Antunes #define NG_DEFLATE_NODE_TYPE	"deflate"
36*df747d8aSNuno Antunes #define NGM_DEFLATE_COOKIE	1166642656
37*df747d8aSNuno Antunes 
38*df747d8aSNuno Antunes /* Hook names */
39*df747d8aSNuno Antunes #define NG_DEFLATE_HOOK_COMP	"comp"		/* compression hook */
40*df747d8aSNuno Antunes #define NG_DEFLATE_HOOK_DECOMP	"decomp"	/* decompression hook */
41*df747d8aSNuno Antunes 
42*df747d8aSNuno Antunes /* Config struct */
43*df747d8aSNuno Antunes struct ng_deflate_config {
44*df747d8aSNuno Antunes 	u_char		enable;			/* node enabled */
45*df747d8aSNuno Antunes 	u_char		windowBits;		/* log2(Window size) */
46*df747d8aSNuno Antunes };
47*df747d8aSNuno Antunes 
48*df747d8aSNuno Antunes /* Keep this in sync with the above structure definition. */
49*df747d8aSNuno Antunes #define NG_DEFLATE_CONFIG_INFO	{			\
50*df747d8aSNuno Antunes 	{ "enable",	&ng_parse_uint8_type	},	\
51*df747d8aSNuno Antunes 	{ "windowBits",	&ng_parse_uint8_type	},	\
52*df747d8aSNuno Antunes 	{ NULL }					\
53*df747d8aSNuno Antunes }
54*df747d8aSNuno Antunes 
55*df747d8aSNuno Antunes /* Statistics structure for one direction. */
56*df747d8aSNuno Antunes struct ng_deflate_stats {
57*df747d8aSNuno Antunes 	uint64_t	FramesPlain;
58*df747d8aSNuno Antunes 	uint64_t	FramesComp;
59*df747d8aSNuno Antunes 	uint64_t	FramesUncomp;
60*df747d8aSNuno Antunes 	uint64_t	InOctets;
61*df747d8aSNuno Antunes 	uint64_t	OutOctets;
62*df747d8aSNuno Antunes 	uint64_t	Errors;
63*df747d8aSNuno Antunes };
64*df747d8aSNuno Antunes 
65*df747d8aSNuno Antunes /* Keep this in sync with the above structure definition. */
66*df747d8aSNuno Antunes #define NG_DEFLATE_STATS_INFO	{				\
67*df747d8aSNuno Antunes 	{ "FramesPlain",&ng_parse_uint64_type	},	\
68*df747d8aSNuno Antunes 	{ "FramesComp",	&ng_parse_uint64_type	},	\
69*df747d8aSNuno Antunes 	{ "FramesUncomp", &ng_parse_uint64_type	},	\
70*df747d8aSNuno Antunes 	{ "InOctets",	&ng_parse_uint64_type	},	\
71*df747d8aSNuno Antunes 	{ "OutOctets",	&ng_parse_uint64_type	},	\
72*df747d8aSNuno Antunes 	{ "Errors",	&ng_parse_uint64_type	},	\
73*df747d8aSNuno Antunes 	{ NULL }					\
74*df747d8aSNuno Antunes }
75*df747d8aSNuno Antunes 
76*df747d8aSNuno Antunes /* Netgraph commands */
77*df747d8aSNuno Antunes enum {
78*df747d8aSNuno Antunes 	NGM_DEFLATE_CONFIG = 1,
79*df747d8aSNuno Antunes 	NGM_DEFLATE_RESETREQ,			/* sent either way! */
80*df747d8aSNuno Antunes 	NGM_DEFLATE_GET_STATS,
81*df747d8aSNuno Antunes 	NGM_DEFLATE_CLR_STATS,
82*df747d8aSNuno Antunes 	NGM_DEFLATE_GETCLR_STATS,
83*df747d8aSNuno Antunes };
84*df747d8aSNuno Antunes 
85*df747d8aSNuno Antunes #endif /* _NETGRAPH_NG_DEFLATE_H_ */
86*df747d8aSNuno Antunes 
87