]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/l2tp/l2tp_core.h
x86/msr-index: Cleanup bit defines
[mirror_ubuntu-bionic-kernel.git] / net / l2tp / l2tp_core.h
CommitLineData
fd558d18
JC
1/*
2 * L2TP internal definitions.
3 *
4 * Copyright (c) 2008,2009 Katalix Systems Ltd
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
fbea9e07 10#include <linux/refcount.h>
fd558d18
JC
11
12#ifndef _L2TP_CORE_H_
13#define _L2TP_CORE_H_
14
15/* Just some random numbers */
16#define L2TP_TUNNEL_MAGIC 0x42114DDA
17#define L2TP_SESSION_MAGIC 0x0C04EB7D
18
f7faffa3 19/* Per tunnel, session hash table size */
fd558d18
JC
20#define L2TP_HASH_BITS 4
21#define L2TP_HASH_SIZE (1 << L2TP_HASH_BITS)
22
f7faffa3
JC
23/* System-wide, session hash table size */
24#define L2TP_HASH_BITS_2 8
25#define L2TP_HASH_SIZE_2 (1 << L2TP_HASH_BITS_2)
26
fd558d18
JC
27struct sk_buff;
28
29struct l2tp_stats {
7b7c0719
TP
30 atomic_long_t tx_packets;
31 atomic_long_t tx_bytes;
32 atomic_long_t tx_errors;
33 atomic_long_t rx_packets;
34 atomic_long_t rx_bytes;
35 atomic_long_t rx_seq_discards;
36 atomic_long_t rx_oos_packets;
37 atomic_long_t rx_errors;
38 atomic_long_t rx_cookie_discards;
fd558d18
JC
39};
40
41struct l2tp_tunnel;
42
43/* Describes a session. Contains information to determine incoming
44 * packets and transmit outgoing ones.
45 */
46struct l2tp_session_cfg {
f7faffa3 47 enum l2tp_pwtype pw_type;
95c96174 48 unsigned int data_seq:2; /* data sequencing level
fd558d18
JC
49 * 0 => none, 1 => IP only,
50 * 2 => all
51 */
95c96174 52 unsigned int recv_seq:1; /* expect receive packets with
fd558d18 53 * sequence numbers? */
95c96174 54 unsigned int send_seq:1; /* send packets with sequence
fd558d18 55 * numbers? */
95c96174 56 unsigned int lns_mode:1; /* behave as LNS? LAC enables
fd558d18
JC
57 * sequence numbers under
58 * control of LNS. */
59 int debug; /* bitmask of debug message
60 * categories */
309795f4 61 u16 vlan_id; /* VLAN pseudowire only */
f7faffa3
JC
62 u16 offset; /* offset to payload */
63 u16 l2specific_len; /* Layer 2 specific length */
64 u16 l2specific_type; /* Layer 2 specific type */
65 u8 cookie[8]; /* optional cookie */
66 int cookie_len; /* 0, 4 or 8 bytes */
67 u8 peer_cookie[8]; /* peer's cookie */
68 int peer_cookie_len; /* 0, 4 or 8 bytes */
fd558d18
JC
69 int reorder_timeout; /* configured reorder timeout
70 * (in jiffies) */
71 int mtu;
72 int mru;
309795f4 73 char *ifname;
fd558d18
JC
74};
75
76struct l2tp_session {
77 int magic; /* should be
78 * L2TP_SESSION_MAGIC */
b228a940 79 long dead;
fd558d18
JC
80
81 struct l2tp_tunnel *tunnel; /* back pointer to tunnel
82 * context */
83 u32 session_id;
84 u32 peer_session_id;
f7faffa3
JC
85 u8 cookie[8];
86 int cookie_len;
87 u8 peer_cookie[8];
88 int peer_cookie_len;
89 u16 offset; /* offset from end of L2TP header
90 to beginning of data */
91 u16 l2specific_len;
92 u16 l2specific_type;
93 u16 hdr_len;
94 u32 nr; /* session NR state (receive) */
95 u32 ns; /* session NR state (send) */
fd558d18 96 struct sk_buff_head reorder_q; /* receive reorder queue */
8a1631d5
JC
97 u32 nr_max; /* max NR. Depends on tunnel */
98 u32 nr_window_size; /* NR window size */
a0dbd822
JC
99 u32 nr_oos; /* NR of last OOS packet */
100 int nr_oos_count; /* For OOS recovery */
101 int nr_oos_count_max;
fd558d18 102 struct hlist_node hlist; /* Hash list node */
f00c854c 103 refcount_t ref_count;
fd558d18
JC
104
105 char name[32]; /* for logging */
309795f4 106 char ifname[IFNAMSIZ];
95c96174 107 unsigned int data_seq:2; /* data sequencing level
fd558d18
JC
108 * 0 => none, 1 => IP only,
109 * 2 => all
110 */
95c96174 111 unsigned int recv_seq:1; /* expect receive packets with
fd558d18 112 * sequence numbers? */
95c96174 113 unsigned int send_seq:1; /* send packets with sequence
fd558d18 114 * numbers? */
95c96174 115 unsigned int lns_mode:1; /* behave as LNS? LAC enables
fd558d18
JC
116 * sequence numbers under
117 * control of LNS. */
118 int debug; /* bitmask of debug message
119 * categories */
120 int reorder_timeout; /* configured reorder timeout
121 * (in jiffies) */
38d40b3f 122 int reorder_skip; /* set if skip to next nr */
fd558d18
JC
123 int mtu;
124 int mru;
f7faffa3 125 enum l2tp_pwtype pwtype;
fd558d18 126 struct l2tp_stats stats;
f7faffa3 127 struct hlist_node global_hlist; /* Global hash list node */
fd558d18 128
f7faffa3 129 int (*build_header)(struct l2tp_session *session, void *buf);
fd558d18
JC
130 void (*recv_skb)(struct l2tp_session *session, struct sk_buff *skb, int data_len);
131 void (*session_close)(struct l2tp_session *session);
9dd79945 132#if IS_ENABLED(CONFIG_L2TP_DEBUGFS)
0ad66140
JC
133 void (*show)(struct seq_file *m, void *priv);
134#endif
fd558d18
JC
135 uint8_t priv[0]; /* private data */
136};
137
138/* Describes the tunnel. It contains info to track all the associated
139 * sessions so incoming packets can be sorted out
140 */
141struct l2tp_tunnel_cfg {
142 int debug; /* bitmask of debug message
143 * categories */
0d76751f 144 enum l2tp_encap_type encap;
789a4a2c
JC
145
146 /* Used only for kernel-created sockets */
147 struct in_addr local_ip;
148 struct in_addr peer_ip;
f9bac8df
CE
149#if IS_ENABLED(CONFIG_IPV6)
150 struct in6_addr *local_ip6;
151 struct in6_addr *peer_ip6;
152#endif
789a4a2c
JC
153 u16 local_udp_port;
154 u16 peer_udp_port;
6b649fea
TH
155 unsigned int use_udp_checksums:1,
156 udp6_zero_tx_checksums:1,
157 udp6_zero_rx_checksums:1;
fd558d18
JC
158};
159
160struct l2tp_tunnel {
161 int magic; /* Should be L2TP_TUNNEL_MAGIC */
62b982ee
SD
162
163 unsigned long dead;
164
99469c32 165 struct rcu_head rcu;
fd558d18 166 rwlock_t hlist_lock; /* protect session_hlist */
f3c66d4e
GN
167 bool acpt_newsess; /* Indicates whether this
168 * tunnel accepts new sessions.
169 * Protected by hlist_lock.
170 */
fd558d18
JC
171 struct hlist_head session_hlist[L2TP_HASH_SIZE];
172 /* hashed list of sessions,
173 * hashed by id */
174 u32 tunnel_id;
175 u32 peer_tunnel_id;
176 int version; /* 2=>L2TPv2, 3=>L2TPv3 */
177
178 char name[20]; /* for logging */
179 int debug; /* bitmask of debug message
180 * categories */
0d76751f 181 enum l2tp_encap_type encap;
fd558d18
JC
182 struct l2tp_stats stats;
183
184 struct list_head list; /* Keep a list of all tunnels */
185 struct net *l2tp_net; /* the net we belong to */
186
fbea9e07 187 refcount_t ref_count;
0ad66140
JC
188#ifdef CONFIG_DEBUG_FS
189 void (*show)(struct seq_file *m, void *arg);
190#endif
fd558d18
JC
191 int (*recv_payload_hook)(struct sk_buff *skb);
192 void (*old_sk_destruct)(struct sock *);
193 struct sock *sock; /* Parent socket */
80d84ef3
TP
194 int fd; /* Parent fd, if tunnel socket
195 * was created by userspace */
fd558d18 196
f8ccac0e
TP
197 struct work_struct del_work;
198
fd558d18
JC
199 uint8_t priv[0]; /* private data */
200};
201
309795f4 202struct l2tp_nl_cmd_ops {
f026bc29
GN
203 int (*session_create)(struct net *net, struct l2tp_tunnel *tunnel,
204 u32 session_id, u32 peer_session_id,
205 struct l2tp_session_cfg *cfg);
309795f4
JC
206 int (*session_delete)(struct l2tp_session *session);
207};
208
fd558d18
JC
209static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel)
210{
211 return &tunnel->priv[0];
212}
213
214static inline void *l2tp_session_priv(struct l2tp_session *session)
215{
216 return &session->priv[0];
217}
218
54652eb1 219struct l2tp_tunnel *l2tp_tunnel_get(const struct net *net, u32 tunnel_id);
03b699b0
GN
220struct l2tp_tunnel *l2tp_tunnel_get_nth(const struct net *net, int nth);
221
02a25fee 222void l2tp_tunnel_free(struct l2tp_tunnel *tunnel);
54652eb1 223
9aaef50c 224struct l2tp_session *l2tp_session_get(const struct net *net,
61b9a047 225 struct l2tp_tunnel *tunnel,
a4346210
GN
226 u32 session_id);
227struct l2tp_session *l2tp_session_get_nth(struct l2tp_tunnel *tunnel, int nth);
9aaef50c 228struct l2tp_session *l2tp_session_get_by_ifname(const struct net *net,
a4346210 229 const char *ifname);
c1b1203d
JP
230
231int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id,
232 u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg,
233 struct l2tp_tunnel **tunnelp);
98aa4345
GN
234int l2tp_tunnel_register(struct l2tp_tunnel *tunnel, struct net *net,
235 struct l2tp_tunnel_cfg *cfg);
236
c1b1203d 237void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel);
62b982ee 238void l2tp_tunnel_delete(struct l2tp_tunnel *tunnel);
c1b1203d
JP
239struct l2tp_session *l2tp_session_create(int priv_size,
240 struct l2tp_tunnel *tunnel,
241 u32 session_id, u32 peer_session_id,
242 struct l2tp_session_cfg *cfg);
3953ae7b
GN
243int l2tp_session_register(struct l2tp_session *session,
244 struct l2tp_tunnel *tunnel);
245
c1b1203d
JP
246void __l2tp_session_unhash(struct l2tp_session *session);
247int l2tp_session_delete(struct l2tp_session *session);
248void l2tp_session_free(struct l2tp_session *session);
249void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb,
250 unsigned char *ptr, unsigned char *optr, u16 hdrflags,
251 int length, int (*payload_hook)(struct sk_buff *skb));
252int l2tp_session_queue_purge(struct l2tp_session *session);
253int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb);
bb5016ea 254void l2tp_session_set_header_len(struct l2tp_session *session, int version);
c1b1203d
JP
255
256int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb,
257 int hdr_len);
258
259int l2tp_nl_register_ops(enum l2tp_pwtype pw_type,
260 const struct l2tp_nl_cmd_ops *ops);
261void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type);
72fb96e7 262int l2tp_ioctl(struct sock *sk, int cmd, unsigned long arg);
309795f4 263
54652eb1
GN
264static inline void l2tp_tunnel_inc_refcount(struct l2tp_tunnel *tunnel)
265{
266 refcount_inc(&tunnel->ref_count);
267}
268
269static inline void l2tp_tunnel_dec_refcount(struct l2tp_tunnel *tunnel)
270{
271 if (refcount_dec_and_test(&tunnel->ref_count))
02a25fee 272 l2tp_tunnel_free(tunnel);
54652eb1
GN
273}
274
fd558d18
JC
275/* Session reference counts. Incremented when code obtains a reference
276 * to a session.
277 */
9ff672ba 278static inline void l2tp_session_inc_refcount(struct l2tp_session *session)
fd558d18 279{
f00c854c 280 refcount_inc(&session->ref_count);
fd558d18
JC
281}
282
9ff672ba 283static inline void l2tp_session_dec_refcount(struct l2tp_session *session)
fd558d18 284{
f00c854c 285 if (refcount_dec_and_test(&session->ref_count))
fd558d18
JC
286 l2tp_session_free(session);
287}
288
a4ca44fa
JP
289#define l2tp_printk(ptr, type, func, fmt, ...) \
290do { \
291 if (((ptr)->debug) & (type)) \
292 func(fmt, ##__VA_ARGS__); \
293} while (0)
294
295#define l2tp_warn(ptr, type, fmt, ...) \
296 l2tp_printk(ptr, type, pr_warn, fmt, ##__VA_ARGS__)
297#define l2tp_info(ptr, type, fmt, ...) \
298 l2tp_printk(ptr, type, pr_info, fmt, ##__VA_ARGS__)
299#define l2tp_dbg(ptr, type, fmt, ...) \
300 l2tp_printk(ptr, type, pr_debug, fmt, ##__VA_ARGS__)
301
f1f39f91 302#define MODULE_ALIAS_L2TP_PWTYPE(type) \
303 MODULE_ALIAS("net-l2tp-type-" __stringify(type))
304
fd558d18 305#endif /* _L2TP_CORE_H_ */