ng_ppp.h revision 53913
1 2/* 3 * ng_ppp.h 4 * 5 * Copyright (c) 1996-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@whistle.com> 38 * 39 * $FreeBSD: head/sys/netgraph/ng_ppp.h 53913 1999-11-30 02:45:32Z archie $ 40 * $Whistle: ng_ppp.h,v 1.8 1999/01/25 02:40:02 archie Exp $ 41 */ 42 43#ifndef _NETGRAPH_PPP_H_ 44#define _NETGRAPH_PPP_H_ 45 46/* Node type name and magic cookie */ 47#define NG_PPP_NODE_TYPE "ppp" 48#define NGM_PPP_COOKIE 940897793 49 50/* Maximum number of supported links */ 51#define NG_PPP_MAX_LINKS 16 52 53/* Pseudo-link number representing the multi-link bundle */ 54#define NG_PPP_BUNDLE_LINKNUM 0xffff 55 56/* Max allowable link latency (miliseconds) and bandwidth (bytes/second/10) */ 57#define NG_PPP_MAX_LATENCY 1000 /* 1 second */ 58#define NG_PPP_MAX_BANDWIDTH 125000 /* 10 Mbits / second */ 59 60/* Hook names */ 61#define NG_PPP_HOOK_BYPASS "bypass" /* unknown protocols */ 62#define NG_PPP_HOOK_COMPRESS "compress" /* outgoing compression */ 63#define NG_PPP_HOOK_DECOMPRESS "decompress" /* incoming decompression */ 64#define NG_PPP_HOOK_ENCRYPT "encrypt" /* outgoing encryption */ 65#define NG_PPP_HOOK_DECRYPT "decrypt" /* incoming decryption */ 66#define NG_PPP_HOOK_VJC_IP "vjc_ip" /* VJC raw IP */ 67#define NG_PPP_HOOK_VJC_COMP "vjc_vjcomp" /* VJC compressed TCP */ 68#define NG_PPP_HOOK_VJC_UNCOMP "vjc_vjuncomp" /* VJC uncompressed TCP */ 69#define NG_PPP_HOOK_VJC_VJIP "vjc_vjip" /* VJC uncompressed IP */ 70#define NG_PPP_HOOK_INET "inet" /* IP packet data */ 71#define NG_PPP_HOOK_ATALK "atalk" /* AppleTalk packet data */ 72#define NG_PPP_HOOK_IPX "ipx" /* IPX packet data */ 73 74#define NG_PPP_HOOK_LINK_PREFIX "link" /* append decimal link number */ 75 76/* Netgraph commands */ 77enum { 78 NGM_PPP_SET_CONFIG = 1, /* takes struct ng_ppp_bundle_config */ 79 NGM_PPP_GET_CONFIG, /* returns ng_ppp_bundle_config */ 80 NGM_PPP_GET_LINK_STATS, /* takes link #, returns stats struct */ 81 NGM_PPP_CLR_LINK_STATS, /* takes link #, clears link stats */ 82 NGM_PPP_GETCLR_LINK_STATS, /* takes link #, returns & clrs stats */ 83}; 84 85/* Per-link config structure */ 86struct ng_ppp_link_config { 87 u_char enableLink; /* enable this link */ 88 u_char enableProtoComp;/* enable protocol field compression */ 89 u_char enableACFComp; /* enable addr/ctrl field compression */ 90 u_int16_t mru; /* peer MRU */ 91 u_int32_t latency; /* link latency (in milliseconds) */ 92 u_int32_t bandwidth; /* link bandwidth (in bytes/second) */ 93}; 94 95/* Keep this in sync with the above structure definition */ 96#define NG_PPP_LINK_TYPE_INFO { \ 97 { \ 98 { "enable", &ng_parse_int8_type }, \ 99 { "protocomp", &ng_parse_int8_type }, \ 100 { "acfcomp", &ng_parse_int8_type }, \ 101 { "mru", &ng_parse_int16_type }, \ 102 { "latency", &ng_parse_int32_type }, \ 103 { "bandwidth", &ng_parse_int32_type }, \ 104 { NULL }, \ 105 } \ 106} 107 108/* Node config structure */ 109struct ng_ppp_node_config { 110 u_int16_t mrru; /* multilink peer MRRU */ 111 u_char enableMultilink; /* enable multilink */ 112 u_char recvShortSeq; /* recv multilink short seq # */ 113 u_char xmitShortSeq; /* xmit multilink short seq # */ 114 u_char enableRoundRobin; /* xmit whole packets */ 115 u_char enableIP; /* enable IP data flow */ 116 u_char enableAtalk; /* enable AppleTalk data flow */ 117 u_char enableIPX; /* enable IPX data flow */ 118 u_char enableCompression; /* enable PPP compression */ 119 u_char enableDecompression; /* enable PPP decompression */ 120 u_char enableEncryption; /* enable PPP encryption */ 121 u_char enableDecryption; /* enable PPP decryption */ 122 u_char enableVJCompression; /* enable VJ compression */ 123 u_char enableVJDecompression; /* enable VJ decompression */ 124 struct ng_ppp_link_config /* per link config params */ 125 links[NG_PPP_MAX_LINKS]; 126}; 127 128/* Keep this in sync with the above structure definition */ 129#define NG_PPP_CONFIG_TYPE_INFO(arytype) { \ 130 { \ 131 { "mrru", &ng_parse_int16_type }, \ 132 { "multilink", &ng_parse_int8_type }, \ 133 { "recvShortSeq", &ng_parse_int8_type }, \ 134 { "xmitShortSeq", &ng_parse_int8_type }, \ 135 { "roundRobin", &ng_parse_int8_type }, \ 136 { "ip", &ng_parse_int8_type }, \ 137 { "appletalk", &ng_parse_int8_type }, \ 138 { "ipx", &ng_parse_int8_type }, \ 139 { "comp", &ng_parse_int8_type }, \ 140 { "decomp", &ng_parse_int8_type }, \ 141 { "encryption", &ng_parse_int8_type }, \ 142 { "decryption", &ng_parse_int8_type }, \ 143 { "vjcomp", &ng_parse_int8_type }, \ 144 { "vjdecomp", &ng_parse_int8_type }, \ 145 { "links", (arytype) }, \ 146 { NULL }, \ 147 } \ 148} 149 150/* Statistics struct for a link (or the bundle if NG_PPP_BUNDLE_LINKNUM) */ 151struct ng_ppp_link_stat { 152 u_int32_t xmitFrames; /* xmit frames on link */ 153 u_int32_t xmitOctets; /* xmit octets on link */ 154 u_int32_t recvFrames; /* recv frames on link */ 155 u_int32_t recvOctets; /* recv octets on link */ 156 u_int32_t badProtos; /* frames rec'd with bogus protocol */ 157 u_int32_t dupFragments; /* MP frames with duplicate seq # */ 158}; 159 160/* Keep this in sync with the above structure definition */ 161#define NG_PPP_STATS_TYPE_INFO { \ 162 { \ 163 { "xmitFrames", &ng_parse_int32_type }, \ 164 { "xmitOctets", &ng_parse_int32_type }, \ 165 { "recvFrames", &ng_parse_int32_type }, \ 166 { "recvOctets", &ng_parse_int32_type }, \ 167 { "badProtos", &ng_parse_int32_type }, \ 168 { "dupFragments", &ng_parse_int32_type }, \ 169 { NULL }, \ 170 } \ 171} 172 173#endif /* _NETGRAPH_PPP_H_ */ 174