1/* $OpenBSD: ip_ipcomp.h,v 1.11 2020/09/01 01:53:34 gnezdo Exp $ */
2
3/*
4 * Copyright (c) 2001 Jean-Jacques Bernard-Gundol (jj@wabbitt.org)
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/* IP payload compression protocol (IPComp), see RFC 2393 */
31
32#ifndef _NETINET_IP_IPCOMP_H_
33#define _NETINET_IP_IPCOMP_H_
34
35struct ipcompstat {
36 uint64_t ipcomps_hdrops; /* Packet shorter than header shows */
37 uint64_t ipcomps_nopf; /* Protocol family not supported */
38 uint64_t ipcomps_notdb;
39 uint64_t ipcomps_badkcr;
40 uint64_t ipcomps_qfull;
41 uint64_t ipcomps_noxform;
42 uint64_t ipcomps_wrap;
43 uint64_t ipcomps_input; /* Input IPcomp packets */
44 uint64_t ipcomps_output; /* Output IPcomp packets */
45 uint64_t ipcomps_invalid; /* Trying to use an invalid
46 * TDB */
47 uint64_t ipcomps_ibytes; /* Input bytes */
48 uint64_t ipcomps_obytes; /* Output bytes */
49 uint64_t ipcomps_toobig; /* Packet got larger than
50 * IP_MAXPACKET */
51 uint64_t ipcomps_pdrops; /* Packet blocked due to policy */
52 uint64_t ipcomps_crypto; /* "Crypto" processing failure */
53 uint64_t ipcomps_minlen; /* packets too short for compress */
54 uint64_t ipcomps_outfail; /* Packet output failure */
55};
56
57/* IPCOMP header */
58struct ipcomp {
59 u_int8_t ipcomp_nh; /* Next header */
60 u_int8_t ipcomp_flags; /* Flags: reserved field: 0 */
61 u_int16_t ipcomp_cpi; /* Compression Parameter Index,
62 * Network order */
63};
64
65/* Length of IPCOMP header */
66#define IPCOMP_HLENGTH 4
67
68/*
69 * Names for IPCOMP sysctl objects
70 */
71#define IPCOMPCTL_ENABLE 1 /* Enable COMP processing */
72#define IPCOMPCTL_STATS 2 /* COMP stats */
73#define IPCOMPCTL_MAXID 3
74
75#define IPCOMPCTL_NAMES { \
76 { 0, 0 }, \
77 { "enable", CTLTYPE_INT }, \
78 { "stats", CTLTYPE_STRUCT }, \
79}
80
81#ifdef _KERNEL
82
83#include <sys/percpu.h>
84
85enum ipcomp_counters {
86 ipcomps_hdrops, /* Packet shorter than header shows */
87 ipcomps_nopf, /* Protocol family not supported */
88 ipcomps_notdb,
89 ipcomps_badkcr,
90 ipcomps_qfull,
91 ipcomps_noxform,
92 ipcomps_wrap,
93 ipcomps_input, /* Input IPcomp packets */
94 ipcomps_output, /* Output IPcomp packets */
95 ipcomps_invalid, /* Trying to use an invalid
96 * TDB */
97 ipcomps_ibytes, /* Input bytes */
98 ipcomps_obytes, /* Output bytes */
99 ipcomps_toobig, /* Packet got larger than
100 * IP_MAXPACKET */
101 ipcomps_pdrops, /* Packet blocked due to policy */
102 ipcomps_crypto, /* "Crypto" processing failure */
103 ipcomps_minlen, /* packets too short for compress */
104 ipcomps_outfail, /* Packet output failure */
105
106 ipcomps_ncounters
107};
108
109extern struct cpumem *ipcompcounters;
110
111static inline void
112ipcompstat_inc(enum ipcomp_counters c)
113{
114 counters_inc(ipcompcounters, c);
115}
116
117static inline void
118ipcompstat_add(enum ipcomp_counters c, uint64_t v)
119{
120 counters_add(ipcompcounters, c, v);
121}
122
123extern int ipcomp_enable;
124
125#endif /* _KERNEL */
126#endif /* _NETINET_IP_IPCOMP_H_ */