1/*
2 * ng_pptpgre.h
3 */
4
5/*-
6 * Copyright (c) 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 *
40 * $FreeBSD$
41 * $Whistle: ng_pptpgre.h,v 1.3 1999/12/08 00:11:36 archie Exp $
42 */
43
44#ifndef _NETGRAPH_NG_PPTPGRE_H_
45#define _NETGRAPH_NG_PPTPGRE_H_
46
47/* Node type name and magic cookie */
48#define NG_PPTPGRE_NODE_TYPE	"pptpgre"
49#define NGM_PPTPGRE_COOKIE	1082548365
50
51/* Hook names */
52#define NG_PPTPGRE_HOOK_UPPER	"upper"		/* to upper layers */
53#define NG_PPTPGRE_HOOK_LOWER	"lower"		/* to lower layers */
54
55/* Session hooks: prefix plus hex session ID, e.g., "session_3e14" */
56#define NG_PPTPGRE_HOOK_SESSION_P	"session_"
57#define NG_PPTPGRE_HOOK_SESSION_F	"session_%04x"
58
59/* Configuration for a session */
60struct ng_pptpgre_conf {
61	u_char		enabled;	/* enables traffic flow */
62	u_char		enableDelayedAck;/* enables delayed acks */
63	u_char		enableAlwaysAck;/* always include ack with data */
64	u_char		enableWindowing;/* enable windowing algorithm */
65	u_int16_t	cid;		/* my call id */
66	u_int16_t	peerCid;	/* peer call id */
67	u_int16_t	recvWin;	/* peer recv window size */
68	u_int16_t	peerPpd;	/* peer packet processing delay
69					   (in units of 1/10 of a second) */
70};
71
72/* Keep this in sync with the above structure definition */
73#define NG_PPTPGRE_CONF_TYPE_INFO	{			\
74	  { "enabled",		&ng_parse_uint8_type	},	\
75	  { "enableDelayedAck",	&ng_parse_uint8_type	},	\
76	  { "enableAlwaysAck",	&ng_parse_uint8_type	},	\
77	  { "enableWindowing",	&ng_parse_uint8_type	},	\
78	  { "cid",		&ng_parse_hint16_type	},	\
79	  { "peerCid",		&ng_parse_hint16_type	},	\
80	  { "recvWin",		&ng_parse_uint16_type	},	\
81	  { "peerPpd",		&ng_parse_uint16_type	},	\
82	  { NULL }						\
83}
84
85/* Statistics struct */
86struct ng_pptpgre_stats {
87	u_int32_t xmitPackets;		/* number of GRE packets xmit */
88	u_int32_t xmitOctets;		/* number of GRE octets xmit */
89	u_int32_t xmitLoneAcks;		/* ack-only packets transmitted */
90	u_int32_t xmitDrops;		/* xmits dropped due to full window */
91	u_int32_t xmitTooBig;		/* xmits dropped because too big */
92	u_int32_t recvPackets;		/* number of GRE packets rec'd */
93	u_int32_t recvOctets;		/* number of GRE octets rec'd */
94	u_int32_t recvRunts;		/* too short packets rec'd */
95	u_int32_t recvBadGRE;		/* bogus packets rec'd (bad GRE hdr) */
96	u_int32_t recvBadAcks;		/* bogus ack's rec'd in GRE header */
97	u_int32_t recvBadCID;		/* pkts with unknown call ID rec'd */
98	u_int32_t recvOutOfOrder;	/* packets rec'd out of order */
99	u_int32_t recvDuplicates;	/* packets rec'd with duplicate seq # */
100	u_int32_t recvLoneAcks;		/* ack-only packets rec'd */
101	u_int32_t recvAckTimeouts;	/* times peer failed to ack in time */
102	u_int32_t memoryFailures;	/* times we couldn't allocate memory */
103};
104
105/* Keep this in sync with the above structure definition */
106#define NG_PPTPGRE_STATS_TYPE_INFO	{			\
107	  { "xmitPackets",	&ng_parse_uint32_type	},	\
108	  { "xmitOctets",	&ng_parse_uint32_type	},	\
109	  { "xmitLoneAcks",	&ng_parse_uint32_type	},	\
110	  { "xmitDrops",	&ng_parse_uint32_type	},	\
111	  { "xmitTooBig",	&ng_parse_uint32_type	},	\
112	  { "recvPackets",	&ng_parse_uint32_type	},	\
113	  { "recvOctets",	&ng_parse_uint32_type	},	\
114	  { "recvRunts",	&ng_parse_uint32_type	},	\
115	  { "recvBadGRE",	&ng_parse_uint32_type	},	\
116	  { "recvBadAcks",	&ng_parse_uint32_type	},	\
117	  { "recvBadCID",	&ng_parse_uint32_type	},	\
118	  { "recvOutOfOrder",	&ng_parse_uint32_type	},	\
119	  { "recvDuplicates",	&ng_parse_uint32_type	},	\
120	  { "recvLoneAcks",	&ng_parse_uint32_type	},	\
121	  { "recvAckTimeouts",	&ng_parse_uint32_type	},	\
122	  { "memoryFailures",	&ng_parse_uint32_type	},	\
123	  { NULL }						\
124}
125
126/* Netgraph commands */
127enum {
128	NGM_PPTPGRE_SET_CONFIG = 1,	/* supply a struct ng_pptpgre_conf */
129	NGM_PPTPGRE_GET_CONFIG,		/* returns a struct ng_pptpgre_conf */
130	NGM_PPTPGRE_GET_STATS,		/* returns struct ng_pptpgre_stats */
131	NGM_PPTPGRE_CLR_STATS,		/* clears stats */
132	NGM_PPTPGRE_GETCLR_STATS,	/* returns & clears stats */
133};
134
135#endif /* _NETGRAPH_NG_PPTPGRE_H_ */
136