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