1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2006 Alexander Motin <mav@alkar.net>
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 * $FreeBSD$
30 */
31
32#ifndef _NETGRAPH_NG_DEFLATE_H_
33#define _NETGRAPH_NG_DEFLATE_H_
34
35/* Node type name and magic cookie */
36#define NG_DEFLATE_NODE_TYPE	"deflate"
37#define NGM_DEFLATE_COOKIE	1166642656
38
39/* Hook names */
40#define NG_DEFLATE_HOOK_COMP	"comp"		/* compression hook */
41#define NG_DEFLATE_HOOK_DECOMP	"decomp"	/* decompression hook */
42
43/* Config struct */
44struct ng_deflate_config {
45	u_char		enable;			/* node enabled */
46	u_char		windowBits;		/* log2(Window size) */
47};
48
49/* Keep this in sync with the above structure definition. */
50#define NG_DEFLATE_CONFIG_INFO	{			\
51	{ "enable",	&ng_parse_uint8_type	},	\
52	{ "windowBits",	&ng_parse_uint8_type	},	\
53	{ NULL }					\
54}
55
56/* Statistics structure for one direction. */
57struct ng_deflate_stats {
58	uint64_t	FramesPlain;
59	uint64_t	FramesComp;
60	uint64_t	FramesUncomp;
61	uint64_t	InOctets;
62	uint64_t	OutOctets;
63	uint64_t	Errors;
64};
65
66/* Keep this in sync with the above structure definition. */
67#define NG_DEFLATE_STATS_INFO	{				\
68	{ "FramesPlain",&ng_parse_uint64_type	},	\
69	{ "FramesComp",	&ng_parse_uint64_type	},	\
70	{ "FramesUncomp", &ng_parse_uint64_type	},	\
71	{ "InOctets",	&ng_parse_uint64_type	},	\
72	{ "OutOctets",	&ng_parse_uint64_type	},	\
73	{ "Errors",	&ng_parse_uint64_type	},	\
74	{ NULL }					\
75}
76
77/* Netgraph commands */
78enum {
79	NGM_DEFLATE_CONFIG = 1,
80	NGM_DEFLATE_RESETREQ,			/* sent either way! */
81	NGM_DEFLATE_GET_STATS,
82	NGM_DEFLATE_CLR_STATS,
83	NGM_DEFLATE_GETCLR_STATS,
84};
85
86#endif /* _NETGRAPH_NG_DEFLATE_H_ */
87
88