sys/netgraph/pptpgre/ng_pptpgre.h

   1
   2 /*
   3  * ng_pptpgre.h
   4  *
   5  * Copyright (c) 1999 Whistle Communications, Inc.
   6  * All rights reserved.
   7  *
   8  * Subject to the following obligations and disclaimer of warranty, use and
   9  * redistribution of this software, in source or object code forms, with or
  10  * without modifications are expressly permitted by Whistle Communications;
  11  * provided, however, that:
  12  * 1. Any and all reproductions of the source or object code must include the
  13  *    copyright notice above and the following disclaimer of warranties; and
  14  * 2. No rights are granted, in any manner or form, to use Whistle
  15  *    Communications, Inc. trademarks, including the mark "WHISTLE
  16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  17  *    such appears in the above copyright notice or in the software.
  18  *
  19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  35  * OF SUCH DAMAGE.
  36  *
  37  * Author: Archie Cobbs <archie@freebsd.org>
  38  *
  39  * $FreeBSD: src/sys/netgraph/ng_pptpgre.h,v 1.1.4.4 2002/07/02 23:44:03 archie Exp $
  40  * $DragonFly: src/sys/netgraph/pptpgre/ng_pptpgre.h,v 1.2 2003/06/17 04:28:51 dillon Exp $
  41  * $Whistle: ng_pptpgre.h,v 1.3 1999/12/08 00:11:36 archie Exp $
  42  */
  43
  44 #ifndef _NETGRAPH_PPTPGRE_H_
  45 #define _NETGRAPH_PPTPGRE_H_
  46
  47 /* Node type name and magic cookie */
  48 #define NG_PPTPGRE_NODE_TYPE    "pptpgre"
  49 #define NGM_PPTPGRE_COOKIE      942783547
  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 /* Configuration for a session */
  56 struct ng_pptpgre_conf {
  57         u_char          enabled;        /* enables traffic flow */
  58         u_char          enableDelayedAck;/* enables delayed acks */
  59         u_char          enableAlwaysAck;/* always include ack with data */
  60         u_int16_t       cid;            /* my call id */
  61         u_int16_t       peerCid;        /* peer call id */
  62         u_int16_t       recvWin;        /* peer recv window size */
  63         u_int16_t       peerPpd;        /* peer packet processing delay
  64                                            (in units of 1/10 of a second) */
  65 };
  66
  67 /* Keep this in sync with the above structure definition */
  68 #define NG_PPTPGRE_CONF_TYPE_INFO       {                       \
  69           { "enabled",          &ng_parse_uint8_type    },      \
  70           { "enableDelayedAck", &ng_parse_uint8_type    },      \
  71           { "enableAlwaysAck",  &ng_parse_uint8_type    },      \
  72           { "cid",              &ng_parse_hint16_type   },      \
  73           { "peerCid",          &ng_parse_hint16_type   },      \
  74           { "recvWin",          &ng_parse_uint16_type   },      \
  75           { "peerPpd",          &ng_parse_uint16_type   },      \
  76           { NULL }                                              \
  77 }
  78
  79 /* Statistics struct */
  80 struct ng_pptpgre_stats {
  81         u_int32_t xmitPackets;          /* number of GRE packets xmit */
  82         u_int32_t xmitOctets;           /* number of GRE octets xmit */
  83         u_int32_t xmitLoneAcks;         /* ack-only packets transmitted */
  84         u_int32_t xmitDrops;            /* xmits dropped due to full window */
  85         u_int32_t xmitTooBig;           /* xmits dropped because too big */
  86         u_int32_t recvPackets;          /* number of GRE packets rec'd */
  87         u_int32_t recvOctets;           /* number of GRE octets rec'd */
  88         u_int32_t recvRunts;            /* too short packets rec'd */
  89         u_int32_t recvBadGRE;           /* bogus packets rec'd (bad GRE hdr) */
  90         u_int32_t recvBadAcks;          /* bogus ack's rec'd in GRE header */
  91         u_int32_t recvBadCID;           /* pkts with unknown call ID rec'd */
  92         u_int32_t recvOutOfOrder;       /* packets rec'd out of order */
  93         u_int32_t recvDuplicates;       /* packets rec'd with duplicate seq # */
  94         u_int32_t recvLoneAcks;         /* ack-only packets rec'd */
  95         u_int32_t recvAckTimeouts;      /* times peer failed to ack in time */
  96         u_int32_t memoryFailures;       /* times we couldn't allocate memory */
  97 };
  98
  99 /* Keep this in sync with the above structure definition */
 100 #define NG_PPTPGRE_STATS_TYPE_INFO      {                       \
 101           { "xmitPackets",      &ng_parse_uint32_type   },      \
 102           { "xmitOctets",       &ng_parse_uint32_type   },      \
 103           { "xmitLoneAcks",     &ng_parse_uint32_type   },      \
 104           { "xmitDrops",        &ng_parse_uint32_type   },      \
 105           { "xmitTooBig",       &ng_parse_uint32_type   },      \
 106           { "recvPackets",      &ng_parse_uint32_type   },      \
 107           { "recvOctets",       &ng_parse_uint32_type   },      \
 108           { "recvRunts",        &ng_parse_uint32_type   },      \
 109           { "recvBadGRE",       &ng_parse_uint32_type   },      \
 110           { "recvBadAcks",      &ng_parse_uint32_type   },      \
 111           { "recvBadCID",       &ng_parse_uint32_type   },      \
 112           { "recvOutOfOrder",   &ng_parse_uint32_type   },      \
 113           { "recvDuplicates",   &ng_parse_uint32_type   },      \
 114           { "recvLoneAcks",     &ng_parse_uint32_type   },      \
 115           { "recvAckTimeouts",  &ng_parse_uint32_type   },      \
 116           { "memoryFailures",   &ng_parse_uint32_type   },      \
 117           { NULL }                                              \
 118 }
 119
 120 /* Netgraph commands */
 121 enum {
 122         NGM_PPTPGRE_SET_CONFIG = 1,     /* supply a struct ng_pptpgre_conf */
 123         NGM_PPTPGRE_GET_CONFIG,         /* returns a struct ng_pptpgre_conf */
 124         NGM_PPTPGRE_GET_STATS,          /* returns struct ng_pptpgre_stats */
 125         NGM_PPTPGRE_CLR_STATS,          /* clears stats */
 126         NGM_PPTPGRE_GETCLR_STATS,       /* returns & clears stats */
 127 };
 128
 129 #endif /* _NETGRAPH_PPTPGRE_H_ */