]>
Commit | Line | Data |
---|---|---|
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 |
27 | struct sk_buff; |
28 | ||
29 | struct 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 | ||
41 | struct l2tp_tunnel; | |
42 | ||
43 | /* Describes a session. Contains information to determine incoming | |
44 | * packets and transmit outgoing ones. | |
45 | */ | |
46 | struct 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 | ||
76 | struct l2tp_session { | |
77 | int magic; /* should be | |
78 | * L2TP_SESSION_MAGIC */ | |
79 | ||
80 | struct l2tp_tunnel *tunnel; /* back pointer to tunnel | |
81 | * context */ | |
82 | u32 session_id; | |
83 | u32 peer_session_id; | |
f7faffa3 JC |
84 | u8 cookie[8]; |
85 | int cookie_len; | |
86 | u8 peer_cookie[8]; | |
87 | int peer_cookie_len; | |
88 | u16 offset; /* offset from end of L2TP header | |
89 | to beginning of data */ | |
90 | u16 l2specific_len; | |
91 | u16 l2specific_type; | |
92 | u16 hdr_len; | |
93 | u32 nr; /* session NR state (receive) */ | |
94 | u32 ns; /* session NR state (send) */ | |
fd558d18 | 95 | struct sk_buff_head reorder_q; /* receive reorder queue */ |
8a1631d5 JC |
96 | u32 nr_max; /* max NR. Depends on tunnel */ |
97 | u32 nr_window_size; /* NR window size */ | |
a0dbd822 JC |
98 | u32 nr_oos; /* NR of last OOS packet */ |
99 | int nr_oos_count; /* For OOS recovery */ | |
100 | int nr_oos_count_max; | |
fd558d18 | 101 | struct hlist_node hlist; /* Hash list node */ |
f00c854c | 102 | refcount_t ref_count; |
fd558d18 JC |
103 | |
104 | char name[32]; /* for logging */ | |
309795f4 | 105 | char ifname[IFNAMSIZ]; |
95c96174 | 106 | unsigned int data_seq:2; /* data sequencing level |
fd558d18 JC |
107 | * 0 => none, 1 => IP only, |
108 | * 2 => all | |
109 | */ | |
95c96174 | 110 | unsigned int recv_seq:1; /* expect receive packets with |
fd558d18 | 111 | * sequence numbers? */ |
95c96174 | 112 | unsigned int send_seq:1; /* send packets with sequence |
fd558d18 | 113 | * numbers? */ |
95c96174 | 114 | unsigned int lns_mode:1; /* behave as LNS? LAC enables |
fd558d18 JC |
115 | * sequence numbers under |
116 | * control of LNS. */ | |
117 | int debug; /* bitmask of debug message | |
118 | * categories */ | |
119 | int reorder_timeout; /* configured reorder timeout | |
120 | * (in jiffies) */ | |
38d40b3f | 121 | int reorder_skip; /* set if skip to next nr */ |
fd558d18 JC |
122 | int mtu; |
123 | int mru; | |
f7faffa3 | 124 | enum l2tp_pwtype pwtype; |
fd558d18 | 125 | struct l2tp_stats stats; |
f7faffa3 | 126 | struct hlist_node global_hlist; /* Global hash list node */ |
fd558d18 | 127 | |
f7faffa3 | 128 | int (*build_header)(struct l2tp_session *session, void *buf); |
fd558d18 JC |
129 | void (*recv_skb)(struct l2tp_session *session, struct sk_buff *skb, int data_len); |
130 | void (*session_close)(struct l2tp_session *session); | |
131 | void (*ref)(struct l2tp_session *session); | |
132 | void (*deref)(struct l2tp_session *session); | |
9dd79945 | 133 | #if IS_ENABLED(CONFIG_L2TP_DEBUGFS) |
0ad66140 JC |
134 | void (*show)(struct seq_file *m, void *priv); |
135 | #endif | |
fd558d18 JC |
136 | uint8_t priv[0]; /* private data */ |
137 | }; | |
138 | ||
139 | /* Describes the tunnel. It contains info to track all the associated | |
140 | * sessions so incoming packets can be sorted out | |
141 | */ | |
142 | struct l2tp_tunnel_cfg { | |
143 | int debug; /* bitmask of debug message | |
144 | * categories */ | |
0d76751f | 145 | enum l2tp_encap_type encap; |
789a4a2c JC |
146 | |
147 | /* Used only for kernel-created sockets */ | |
148 | struct in_addr local_ip; | |
149 | struct in_addr peer_ip; | |
f9bac8df CE |
150 | #if IS_ENABLED(CONFIG_IPV6) |
151 | struct in6_addr *local_ip6; | |
152 | struct in6_addr *peer_ip6; | |
153 | #endif | |
789a4a2c JC |
154 | u16 local_udp_port; |
155 | u16 peer_udp_port; | |
6b649fea TH |
156 | unsigned int use_udp_checksums:1, |
157 | udp6_zero_tx_checksums:1, | |
158 | udp6_zero_rx_checksums:1; | |
fd558d18 JC |
159 | }; |
160 | ||
161 | struct l2tp_tunnel { | |
162 | int magic; /* Should be L2TP_TUNNEL_MAGIC */ | |
99469c32 | 163 | struct rcu_head rcu; |
fd558d18 | 164 | rwlock_t hlist_lock; /* protect session_hlist */ |
f3c66d4e GN |
165 | bool acpt_newsess; /* Indicates whether this |
166 | * tunnel accepts new sessions. | |
167 | * Protected by hlist_lock. | |
168 | */ | |
fd558d18 JC |
169 | struct hlist_head session_hlist[L2TP_HASH_SIZE]; |
170 | /* hashed list of sessions, | |
171 | * hashed by id */ | |
172 | u32 tunnel_id; | |
173 | u32 peer_tunnel_id; | |
174 | int version; /* 2=>L2TPv2, 3=>L2TPv3 */ | |
175 | ||
176 | char name[20]; /* for logging */ | |
177 | int debug; /* bitmask of debug message | |
178 | * categories */ | |
0d76751f | 179 | enum l2tp_encap_type encap; |
fd558d18 JC |
180 | struct l2tp_stats stats; |
181 | ||
182 | struct list_head list; /* Keep a list of all tunnels */ | |
183 | struct net *l2tp_net; /* the net we belong to */ | |
184 | ||
fbea9e07 | 185 | refcount_t ref_count; |
0ad66140 JC |
186 | #ifdef CONFIG_DEBUG_FS |
187 | void (*show)(struct seq_file *m, void *arg); | |
188 | #endif | |
fd558d18 JC |
189 | int (*recv_payload_hook)(struct sk_buff *skb); |
190 | void (*old_sk_destruct)(struct sock *); | |
191 | struct sock *sock; /* Parent socket */ | |
80d84ef3 TP |
192 | int fd; /* Parent fd, if tunnel socket |
193 | * was created by userspace */ | |
e18503f4 FC |
194 | #if IS_ENABLED(CONFIG_IPV6) |
195 | bool v4mapped; | |
196 | #endif | |
fd558d18 | 197 | |
f8ccac0e TP |
198 | struct work_struct del_work; |
199 | ||
fd558d18 JC |
200 | uint8_t priv[0]; /* private data */ |
201 | }; | |
202 | ||
309795f4 | 203 | struct l2tp_nl_cmd_ops { |
f026bc29 GN |
204 | int (*session_create)(struct net *net, struct l2tp_tunnel *tunnel, |
205 | u32 session_id, u32 peer_session_id, | |
206 | struct l2tp_session_cfg *cfg); | |
309795f4 JC |
207 | int (*session_delete)(struct l2tp_session *session); |
208 | }; | |
209 | ||
fd558d18 JC |
210 | static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel) |
211 | { | |
212 | return &tunnel->priv[0]; | |
213 | } | |
214 | ||
215 | static inline void *l2tp_session_priv(struct l2tp_session *session) | |
216 | { | |
217 | return &session->priv[0]; | |
218 | } | |
219 | ||
220 | static inline struct l2tp_tunnel *l2tp_sock_to_tunnel(struct sock *sk) | |
221 | { | |
222 | struct l2tp_tunnel *tunnel; | |
223 | ||
224 | if (sk == NULL) | |
225 | return NULL; | |
226 | ||
227 | sock_hold(sk); | |
228 | tunnel = (struct l2tp_tunnel *)(sk->sk_user_data); | |
229 | if (tunnel == NULL) { | |
230 | sock_put(sk); | |
231 | goto out; | |
232 | } | |
233 | ||
234 | BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC); | |
235 | ||
236 | out: | |
237 | return tunnel; | |
238 | } | |
239 | ||
54652eb1 GN |
240 | struct l2tp_tunnel *l2tp_tunnel_get(const struct net *net, u32 tunnel_id); |
241 | ||
9aaef50c | 242 | struct l2tp_session *l2tp_session_get(const struct net *net, |
61b9a047 GN |
243 | struct l2tp_tunnel *tunnel, |
244 | u32 session_id, bool do_ref); | |
e08293a4 GN |
245 | struct l2tp_session *l2tp_session_get_nth(struct l2tp_tunnel *tunnel, int nth, |
246 | bool do_ref); | |
9aaef50c GN |
247 | struct l2tp_session *l2tp_session_get_by_ifname(const struct net *net, |
248 | const char *ifname, | |
2777e2ab | 249 | bool do_ref); |
2f858b92 GN |
250 | struct l2tp_tunnel *l2tp_tunnel_find(const struct net *net, u32 tunnel_id); |
251 | struct l2tp_tunnel *l2tp_tunnel_find_nth(const struct net *net, int nth); | |
c1b1203d JP |
252 | |
253 | int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id, | |
254 | u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg, | |
255 | struct l2tp_tunnel **tunnelp); | |
256 | void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel); | |
257 | int l2tp_tunnel_delete(struct l2tp_tunnel *tunnel); | |
258 | struct l2tp_session *l2tp_session_create(int priv_size, | |
259 | struct l2tp_tunnel *tunnel, | |
260 | u32 session_id, u32 peer_session_id, | |
261 | struct l2tp_session_cfg *cfg); | |
262 | void __l2tp_session_unhash(struct l2tp_session *session); | |
263 | int l2tp_session_delete(struct l2tp_session *session); | |
264 | void l2tp_session_free(struct l2tp_session *session); | |
265 | void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb, | |
266 | unsigned char *ptr, unsigned char *optr, u16 hdrflags, | |
267 | int length, int (*payload_hook)(struct sk_buff *skb)); | |
268 | int l2tp_session_queue_purge(struct l2tp_session *session); | |
269 | int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb); | |
bb5016ea | 270 | void l2tp_session_set_header_len(struct l2tp_session *session, int version); |
c1b1203d JP |
271 | |
272 | int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb, | |
273 | int hdr_len); | |
274 | ||
275 | int l2tp_nl_register_ops(enum l2tp_pwtype pw_type, | |
276 | const struct l2tp_nl_cmd_ops *ops); | |
277 | void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type); | |
72fb96e7 | 278 | int l2tp_ioctl(struct sock *sk, int cmd, unsigned long arg); |
309795f4 | 279 | |
54652eb1 GN |
280 | static inline void l2tp_tunnel_inc_refcount(struct l2tp_tunnel *tunnel) |
281 | { | |
282 | refcount_inc(&tunnel->ref_count); | |
283 | } | |
284 | ||
285 | static inline void l2tp_tunnel_dec_refcount(struct l2tp_tunnel *tunnel) | |
286 | { | |
287 | if (refcount_dec_and_test(&tunnel->ref_count)) | |
288 | kfree_rcu(tunnel, rcu); | |
289 | } | |
290 | ||
fd558d18 JC |
291 | /* Session reference counts. Incremented when code obtains a reference |
292 | * to a session. | |
293 | */ | |
294 | static inline void l2tp_session_inc_refcount_1(struct l2tp_session *session) | |
295 | { | |
f00c854c | 296 | refcount_inc(&session->ref_count); |
fd558d18 JC |
297 | } |
298 | ||
299 | static inline void l2tp_session_dec_refcount_1(struct l2tp_session *session) | |
300 | { | |
f00c854c | 301 | if (refcount_dec_and_test(&session->ref_count)) |
fd558d18 JC |
302 | l2tp_session_free(session); |
303 | } | |
304 | ||
305 | #ifdef L2TP_REFCNT_DEBUG | |
a4ca44fa JP |
306 | #define l2tp_session_inc_refcount(_s) \ |
307 | do { \ | |
308 | pr_debug("l2tp_session_inc_refcount: %s:%d %s: cnt=%d\n", \ | |
309 | __func__, __LINE__, (_s)->name, \ | |
f00c854c | 310 | refcount_read(&_s->ref_count)); \ |
a4ca44fa JP |
311 | l2tp_session_inc_refcount_1(_s); \ |
312 | } while (0) | |
313 | #define l2tp_session_dec_refcount(_s) \ | |
314 | do { \ | |
315 | pr_debug("l2tp_session_dec_refcount: %s:%d %s: cnt=%d\n", \ | |
316 | __func__, __LINE__, (_s)->name, \ | |
f00c854c | 317 | refcount_read(&_s->ref_count)); \ |
a4ca44fa JP |
318 | l2tp_session_dec_refcount_1(_s); \ |
319 | } while (0) | |
fd558d18 JC |
320 | #else |
321 | #define l2tp_session_inc_refcount(s) l2tp_session_inc_refcount_1(s) | |
322 | #define l2tp_session_dec_refcount(s) l2tp_session_dec_refcount_1(s) | |
323 | #endif | |
324 | ||
a4ca44fa JP |
325 | #define l2tp_printk(ptr, type, func, fmt, ...) \ |
326 | do { \ | |
327 | if (((ptr)->debug) & (type)) \ | |
328 | func(fmt, ##__VA_ARGS__); \ | |
329 | } while (0) | |
330 | ||
331 | #define l2tp_warn(ptr, type, fmt, ...) \ | |
332 | l2tp_printk(ptr, type, pr_warn, fmt, ##__VA_ARGS__) | |
333 | #define l2tp_info(ptr, type, fmt, ...) \ | |
334 | l2tp_printk(ptr, type, pr_info, fmt, ##__VA_ARGS__) | |
335 | #define l2tp_dbg(ptr, type, fmt, ...) \ | |
336 | l2tp_printk(ptr, type, pr_debug, fmt, ##__VA_ARGS__) | |
337 | ||
f1f39f91 | 338 | #define MODULE_ALIAS_L2TP_PWTYPE(type) \ |
339 | MODULE_ALIAS("net-l2tp-type-" __stringify(type)) | |
340 | ||
fd558d18 | 341 | #endif /* _L2TP_CORE_H_ */ |