mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-18 10:35:55 +00:00
Code Issues Releases Activity
b54b1bab4b
freebsd/sys/netgraph/ng_ppp.h
Gleb Smirnoff ccb07cc3db Before this commit, if the compression is enabled the, ng_ppp(4) 
node would send every outgoing frame to the "compress" hook.
Packets received on the "compress" hook were expected to be
compressed and PROT_COMPD tag was put on them unconditionally.

After this commit an alternative compression mode can be set.
In this mode the node doesn't put the PROT_COMPD, the compressor
should put it itself. This is important for such kind of
compressors, that can submit uncompressed frames.

Before this commit, if the decompression is enabled, the ng_ppp(4)
node would send and incoming frame to the "decompress" hook
only if it has the PROT_COMPD proto tag on it.

After this commit an alternative decompression mode can be set.
In this mode the node sends all the incoming packets to the
decompression hook. This is important for such kind of compressors
that need uncompressed packets too, to keep their library in sync.

These new features will be used in new version of mpd4, and in new
compressor nodes.

Submitted by:	Alexander Motin <mav alkar.net>
2006-12-28 13:21:54 +00:00

216 lines
8.6 KiB
C
Raw Blame History

/*
* ng_ppp.h
*/
/*-
* Copyright (c) 1996-2000 Whistle Communications, Inc.
* All rights reserved.
*
* Subject to the following obligations and disclaimer of warranty, use and
* redistribution of this software, in source or object code forms, with or
* without modifications are expressly permitted by Whistle Communications;
* provided, however, that:
* 1. Any and all reproductions of the source or object code must include the
* copyright notice above and the following disclaimer of warranties; and
* 2. No rights are granted, in any manner or form, to use Whistle
* Communications, Inc. trademarks, including the mark "WHISTLE
* COMMUNICATIONS" on advertising, endorsements, or otherwise except as
* such appears in the above copyright notice or in the software.
*
* THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
* REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
* INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
* WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
* REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
* SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
* IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
* RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
* WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
* Author: Archie Cobbs <archie@freebsd.org>
*
* $FreeBSD$
* $Whistle: ng_ppp.h,v 1.8 1999/01/25 02:40:02 archie Exp $
*/
#ifndef _NETGRAPH_NG_PPP_H_
#define _NETGRAPH_NG_PPP_H_
/* Node type name and magic cookie */
#define NG_PPP_NODE_TYPE "ppp"
#define NGM_PPP_COOKIE 940897795
/* Maximum number of supported links */
#define NG_PPP_MAX_LINKS 16
/* Pseudo-link number representing the multi-link bundle */
#define NG_PPP_BUNDLE_LINKNUM 0xffff
/* Max allowable link latency (miliseconds) and bandwidth (bytes/second/10) */
#define NG_PPP_MAX_LATENCY 1000 /* 1 second */
#define NG_PPP_MAX_BANDWIDTH 125000 /* 10 Mbits / second */
/* Hook names */
#define NG_PPP_HOOK_BYPASS "bypass" /* unknown protocols */
#define NG_PPP_HOOK_COMPRESS "compress" /* outgoing compression */
#define NG_PPP_HOOK_DECOMPRESS "decompress" /* incoming decompression */
#define NG_PPP_HOOK_ENCRYPT "encrypt" /* outgoing encryption */
#define NG_PPP_HOOK_DECRYPT "decrypt" /* incoming decryption */
#define NG_PPP_HOOK_VJC_IP "vjc_ip" /* VJC raw IP */
#define NG_PPP_HOOK_VJC_COMP "vjc_vjcomp" /* VJC compressed TCP */
#define NG_PPP_HOOK_VJC_UNCOMP "vjc_vjuncomp" /* VJC uncompressed TCP */
#define NG_PPP_HOOK_VJC_VJIP "vjc_vjip" /* VJC uncompressed IP */
#define NG_PPP_HOOK_INET "inet" /* IP packet data */
#define NG_PPP_HOOK_ATALK "atalk" /* AppleTalk packet data */
#define NG_PPP_HOOK_IPX "ipx" /* IPX packet data */
#define NG_PPP_HOOK_IPV6 "ipv6" /* IPv6 packet data */
#define NG_PPP_HOOK_LINK_PREFIX "link" /* append decimal link number */
/* Compress hook operation modes */
enum {
NG_PPP_COMPRESS_NONE = 0, /* compression disabled */
NG_PPP_COMPRESS_SIMPLE, /* original operation mode */
NG_PPP_COMPRESS_FULL, /* compressor returns proto */
};
/* Decompress hook operation modes */
enum {
NG_PPP_DECOMPRESS_NONE = 0, /* decompression disabled */
NG_PPP_DECOMPRESS_SIMPLE, /* original operation mode */
NG_PPP_DECOMPRESS_FULL, /* forward any packet to decompressor */
};
/* Netgraph commands */
enum {
NGM_PPP_SET_CONFIG = 1, /* takes struct ng_ppp_node_conf */
NGM_PPP_GET_CONFIG, /* returns ng_ppp_node_conf */
NGM_PPP_GET_MP_STATE, /* returns ng_ppp_mp_state */
NGM_PPP_GET_LINK_STATS, /* takes link #, returns stats struct */
NGM_PPP_CLR_LINK_STATS, /* takes link #, clears link stats */
NGM_PPP_GETCLR_LINK_STATS, /* takes link #, returns & clrs stats */
};
/* Multi-link sequence number state (for debugging) */
struct ng_ppp_mp_state {
int32_t rseq[NG_PPP_MAX_LINKS]; /* highest rec'd MP seq # */
int32_t mseq; /* min rseq[i] */
int32_t xseq; /* next xmit MP seq # */
};
/* Keep this in sync with the above structure definition */
#define NG_PPP_MP_STATE_TYPE_INFO(atype) { \
{ "rseq", (atype) }, \
{ "mseq", &ng_parse_hint32_type }, \
{ "xseq", &ng_parse_hint32_type }, \
{ NULL } \
}
/* Per-link config structure */
struct ng_ppp_link_conf {
u_char enableLink; /* enable this link */
u_char enableProtoComp;/* enable protocol field compression */
u_char enableACFComp; /* enable addr/ctrl field compression */
u_int16_t mru; /* peer MRU */
u_int32_t latency; /* link latency (in milliseconds) */
u_int32_t bandwidth; /* link bandwidth (in bytes/sec/10) */
};
/* Keep this in sync with the above structure definition */
#define NG_PPP_LINK_TYPE_INFO { \
{ "enableLink", &ng_parse_uint8_type }, \
{ "enableProtoComp", &ng_parse_uint8_type }, \
{ "enableACFComp", &ng_parse_uint8_type }, \
{ "mru", &ng_parse_uint16_type }, \
{ "latency", &ng_parse_uint32_type }, \
{ "bandwidth", &ng_parse_uint32_type }, \
{ NULL } \
}
/* Bundle config structure */
struct ng_ppp_bund_conf {
u_int16_t mrru; /* multilink peer MRRU */
u_char enableMultilink; /* enable multilink */
u_char recvShortSeq; /* recv multilink short seq # */
u_char xmitShortSeq; /* xmit multilink short seq # */
u_char enableRoundRobin; /* xmit whole packets */
u_char enableIP; /* enable IP data flow */
u_char enableIPv6; /* enable IPv6 data flow */
u_char enableAtalk; /* enable AppleTalk data flow */
u_char enableIPX; /* enable IPX data flow */
u_char enableCompression; /* enable PPP compression */
u_char enableDecompression; /* enable PPP decompression */
u_char enableEncryption; /* enable PPP encryption */
u_char enableDecryption; /* enable PPP decryption */
u_char enableVJCompression; /* enable VJ compression */
u_char enableVJDecompression; /* enable VJ decompression */
};
/* Keep this in sync with the above structure definition */
#define NG_PPP_BUND_TYPE_INFO { \
{ "mrru", &ng_parse_uint16_type }, \
{ "enableMultilink", &ng_parse_uint8_type }, \
{ "recvShortSeq", &ng_parse_uint8_type }, \
{ "xmitShortSeq", &ng_parse_uint8_type }, \
{ "enableRoundRobin", &ng_parse_uint8_type }, \
{ "enableIP", &ng_parse_uint8_type }, \
{ "enableIPv6", &ng_parse_uint8_type }, \
{ "enableAtalk", &ng_parse_uint8_type }, \
{ "enableIPX", &ng_parse_uint8_type }, \
{ "enableCompression", &ng_parse_uint8_type }, \
{ "enableDecompression", &ng_parse_uint8_type }, \
{ "enableEncryption", &ng_parse_uint8_type }, \
{ "enableDecryption", &ng_parse_uint8_type }, \
{ "enableVJCompression", &ng_parse_uint8_type }, \
{ "enableVJDecompression", &ng_parse_uint8_type }, \
{ NULL } \
}
/* Total node config structure */
struct ng_ppp_node_conf {
struct ng_ppp_bund_conf bund;
struct ng_ppp_link_conf links[NG_PPP_MAX_LINKS];
};
/* Keep this in sync with the above structure definition */
#define NG_PPP_CONFIG_TYPE_INFO(bctype, arytype) { \
{ "bund", (bctype) }, \
{ "links", (arytype) }, \
{ NULL } \
}
/* Statistics struct for a link (or the bundle if NG_PPP_BUNDLE_LINKNUM) */
struct ng_ppp_link_stat {
u_int32_t xmitFrames; /* xmit frames on link */
u_int32_t xmitOctets; /* xmit octets on link */
u_int32_t recvFrames; /* recv frames on link */
u_int32_t recvOctets; /* recv octets on link */
u_int32_t badProtos; /* frames rec'd with bogus protocol */
u_int32_t runts; /* Too short MP fragments */
u_int32_t dupFragments; /* MP frames with duplicate seq # */
u_int32_t dropFragments; /* MP fragments we had to drop */
};
/* Keep this in sync with the above structure definition */
#define NG_PPP_STATS_TYPE_INFO { \
{ "xmitFrames", &ng_parse_uint32_type }, \
{ "xmitOctets", &ng_parse_uint32_type }, \
{ "recvFrames", &ng_parse_uint32_type }, \
{ "recvOctets", &ng_parse_uint32_type }, \
{ "badProtos", &ng_parse_uint32_type }, \
{ "runts", &ng_parse_uint32_type }, \
{ "dupFragments", &ng_parse_uint32_type }, \
{ "dropFragments", &ng_parse_uint32_type }, \
{ NULL } \
}
#endif /* _NETGRAPH_NG_PPP_H_ */
Reference in New Issue View Git Blame Copy Permalink