blob: 4b9a3b724423967b2adf24d3f9efa0c7a6f77b9e [file] [log] [blame]
James Chapmanfd558d12010-04-02 06:18:33 +00001/*
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 */
10
11#ifndef _L2TP_CORE_H_
12#define _L2TP_CORE_H_
13
14/* Just some random numbers */
15#define L2TP_TUNNEL_MAGIC 0x42114DDA
16#define L2TP_SESSION_MAGIC 0x0C04EB7D
17
James Chapmanf7faffa2010-04-02 06:18:49 +000018/* Per tunnel, session hash table size */
James Chapmanfd558d12010-04-02 06:18:33 +000019#define L2TP_HASH_BITS 4
20#define L2TP_HASH_SIZE (1 << L2TP_HASH_BITS)
21
James Chapmanf7faffa2010-04-02 06:18:49 +000022/* System-wide, session hash table size */
23#define L2TP_HASH_BITS_2 8
24#define L2TP_HASH_SIZE_2 (1 << L2TP_HASH_BITS_2)
25
James Chapmanfd558d12010-04-02 06:18:33 +000026/* Debug message categories for the DEBUG socket option */
27enum {
28 L2TP_MSG_DEBUG = (1 << 0), /* verbose debug (if
29 * compiled in) */
30 L2TP_MSG_CONTROL = (1 << 1), /* userspace - kernel
31 * interface */
32 L2TP_MSG_SEQ = (1 << 2), /* sequence numbers */
33 L2TP_MSG_DATA = (1 << 3), /* data packets */
34};
35
36struct sk_buff;
37
38struct l2tp_stats {
Tom Parkin7b7c0712013-03-19 06:11:22 +000039 atomic_long_t tx_packets;
40 atomic_long_t tx_bytes;
41 atomic_long_t tx_errors;
42 atomic_long_t rx_packets;
43 atomic_long_t rx_bytes;
44 atomic_long_t rx_seq_discards;
45 atomic_long_t rx_oos_packets;
46 atomic_long_t rx_errors;
47 atomic_long_t rx_cookie_discards;
James Chapmanfd558d12010-04-02 06:18:33 +000048};
49
50struct l2tp_tunnel;
51
52/* Describes a session. Contains information to determine incoming
53 * packets and transmit outgoing ones.
54 */
55struct l2tp_session_cfg {
James Chapmanf7faffa2010-04-02 06:18:49 +000056 enum l2tp_pwtype pw_type;
Eric Dumazet95c96172012-04-15 05:58:06 +000057 unsigned int data_seq:2; /* data sequencing level
James Chapmanfd558d12010-04-02 06:18:33 +000058 * 0 => none, 1 => IP only,
59 * 2 => all
60 */
Eric Dumazet95c96172012-04-15 05:58:06 +000061 unsigned int recv_seq:1; /* expect receive packets with
James Chapmanfd558d12010-04-02 06:18:33 +000062 * sequence numbers? */
Eric Dumazet95c96172012-04-15 05:58:06 +000063 unsigned int send_seq:1; /* send packets with sequence
James Chapmanfd558d12010-04-02 06:18:33 +000064 * numbers? */
Eric Dumazet95c96172012-04-15 05:58:06 +000065 unsigned int lns_mode:1; /* behave as LNS? LAC enables
James Chapmanfd558d12010-04-02 06:18:33 +000066 * sequence numbers under
67 * control of LNS. */
68 int debug; /* bitmask of debug message
69 * categories */
James Chapman309795f2010-04-02 06:19:10 +000070 u16 vlan_id; /* VLAN pseudowire only */
James Chapmanf7faffa2010-04-02 06:18:49 +000071 u16 offset; /* offset to payload */
72 u16 l2specific_len; /* Layer 2 specific length */
73 u16 l2specific_type; /* Layer 2 specific type */
74 u8 cookie[8]; /* optional cookie */
75 int cookie_len; /* 0, 4 or 8 bytes */
76 u8 peer_cookie[8]; /* peer's cookie */
77 int peer_cookie_len; /* 0, 4 or 8 bytes */
James Chapmanfd558d12010-04-02 06:18:33 +000078 int reorder_timeout; /* configured reorder timeout
79 * (in jiffies) */
80 int mtu;
81 int mru;
James Chapman309795f2010-04-02 06:19:10 +000082 char *ifname;
James Chapmanfd558d12010-04-02 06:18:33 +000083};
84
85struct l2tp_session {
86 int magic; /* should be
87 * L2TP_SESSION_MAGIC */
88
89 struct l2tp_tunnel *tunnel; /* back pointer to tunnel
90 * context */
91 u32 session_id;
92 u32 peer_session_id;
James Chapmanf7faffa2010-04-02 06:18:49 +000093 u8 cookie[8];
94 int cookie_len;
95 u8 peer_cookie[8];
96 int peer_cookie_len;
97 u16 offset; /* offset from end of L2TP header
98 to beginning of data */
99 u16 l2specific_len;
100 u16 l2specific_type;
101 u16 hdr_len;
102 u32 nr; /* session NR state (receive) */
103 u32 ns; /* session NR state (send) */
James Chapmanfd558d12010-04-02 06:18:33 +0000104 struct sk_buff_head reorder_q; /* receive reorder queue */
James Chapman8a1631d2013-07-02 20:28:59 +0100105 u32 nr_max; /* max NR. Depends on tunnel */
106 u32 nr_window_size; /* NR window size */
James Chapmanfd558d12010-04-02 06:18:33 +0000107 struct hlist_node hlist; /* Hash list node */
108 atomic_t ref_count;
109
110 char name[32]; /* for logging */
James Chapman309795f2010-04-02 06:19:10 +0000111 char ifname[IFNAMSIZ];
Eric Dumazet95c96172012-04-15 05:58:06 +0000112 unsigned int data_seq:2; /* data sequencing level
James Chapmanfd558d12010-04-02 06:18:33 +0000113 * 0 => none, 1 => IP only,
114 * 2 => all
115 */
Eric Dumazet95c96172012-04-15 05:58:06 +0000116 unsigned int recv_seq:1; /* expect receive packets with
James Chapmanfd558d12010-04-02 06:18:33 +0000117 * sequence numbers? */
Eric Dumazet95c96172012-04-15 05:58:06 +0000118 unsigned int send_seq:1; /* send packets with sequence
James Chapmanfd558d12010-04-02 06:18:33 +0000119 * numbers? */
Eric Dumazet95c96172012-04-15 05:58:06 +0000120 unsigned int lns_mode:1; /* behave as LNS? LAC enables
James Chapmanfd558d12010-04-02 06:18:33 +0000121 * sequence numbers under
122 * control of LNS. */
123 int debug; /* bitmask of debug message
124 * categories */
125 int reorder_timeout; /* configured reorder timeout
126 * (in jiffies) */
James Chapman38d40b32012-05-09 23:43:08 +0000127 int reorder_skip; /* set if skip to next nr */
James Chapmanfd558d12010-04-02 06:18:33 +0000128 int mtu;
129 int mru;
James Chapmanf7faffa2010-04-02 06:18:49 +0000130 enum l2tp_pwtype pwtype;
James Chapmanfd558d12010-04-02 06:18:33 +0000131 struct l2tp_stats stats;
James Chapmanf7faffa2010-04-02 06:18:49 +0000132 struct hlist_node global_hlist; /* Global hash list node */
James Chapmanfd558d12010-04-02 06:18:33 +0000133
James Chapmanf7faffa2010-04-02 06:18:49 +0000134 int (*build_header)(struct l2tp_session *session, void *buf);
James Chapmanfd558d12010-04-02 06:18:33 +0000135 void (*recv_skb)(struct l2tp_session *session, struct sk_buff *skb, int data_len);
136 void (*session_close)(struct l2tp_session *session);
137 void (*ref)(struct l2tp_session *session);
138 void (*deref)(struct l2tp_session *session);
David S. Millerf66ef2d2010-04-03 15:01:37 -0700139#if defined(CONFIG_L2TP_DEBUGFS) || defined(CONFIG_L2TP_DEBUGFS_MODULE)
James Chapman0ad66142010-04-02 06:19:33 +0000140 void (*show)(struct seq_file *m, void *priv);
141#endif
James Chapmanfd558d12010-04-02 06:18:33 +0000142 uint8_t priv[0]; /* private data */
143};
144
145/* Describes the tunnel. It contains info to track all the associated
146 * sessions so incoming packets can be sorted out
147 */
148struct l2tp_tunnel_cfg {
149 int debug; /* bitmask of debug message
150 * categories */
James Chapman0d767512010-04-02 06:19:00 +0000151 enum l2tp_encap_type encap;
James Chapman789a4a22010-04-02 06:19:40 +0000152
153 /* Used only for kernel-created sockets */
154 struct in_addr local_ip;
155 struct in_addr peer_ip;
Chris Elstonf9bac8d2012-04-29 21:48:52 +0000156#if IS_ENABLED(CONFIG_IPV6)
157 struct in6_addr *local_ip6;
158 struct in6_addr *peer_ip6;
159#endif
James Chapman789a4a22010-04-02 06:19:40 +0000160 u16 local_udp_port;
161 u16 peer_udp_port;
Eric Dumazet7bddd0d2010-04-04 01:02:46 -0700162 unsigned int use_udp_checksums:1;
James Chapmanfd558d12010-04-02 06:18:33 +0000163};
164
165struct l2tp_tunnel {
166 int magic; /* Should be L2TP_TUNNEL_MAGIC */
xeb@mail.ru99469c32012-08-24 01:07:38 +0000167 struct rcu_head rcu;
James Chapmanfd558d12010-04-02 06:18:33 +0000168 rwlock_t hlist_lock; /* protect session_hlist */
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 */
James Chapman0d767512010-04-02 06:19:00 +0000179 enum l2tp_encap_type encap;
James Chapmanfd558d12010-04-02 06:18:33 +0000180 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
185 atomic_t ref_count;
James Chapman0ad66142010-04-02 06:19:33 +0000186#ifdef CONFIG_DEBUG_FS
187 void (*show)(struct seq_file *m, void *arg);
188#endif
James Chapmanfd558d12010-04-02 06:18:33 +0000189 int (*recv_payload_hook)(struct sk_buff *skb);
190 void (*old_sk_destruct)(struct sock *);
191 struct sock *sock; /* Parent socket */
Tom Parkin80d84ef2013-01-22 05:13:48 +0000192 int fd; /* Parent fd, if tunnel socket
193 * was created by userspace */
James Chapmanfd558d12010-04-02 06:18:33 +0000194
Tom Parkinf8ccac02013-01-31 23:43:00 +0000195 struct work_struct del_work;
196
James Chapmanfd558d12010-04-02 06:18:33 +0000197 uint8_t priv[0]; /* private data */
198};
199
James Chapman309795f2010-04-02 06:19:10 +0000200struct l2tp_nl_cmd_ops {
201 int (*session_create)(struct net *net, u32 tunnel_id, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg);
202 int (*session_delete)(struct l2tp_session *session);
203};
204
James Chapmanfd558d12010-04-02 06:18:33 +0000205static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel)
206{
207 return &tunnel->priv[0];
208}
209
210static inline void *l2tp_session_priv(struct l2tp_session *session)
211{
212 return &session->priv[0];
213}
214
215static inline struct l2tp_tunnel *l2tp_sock_to_tunnel(struct sock *sk)
216{
217 struct l2tp_tunnel *tunnel;
218
219 if (sk == NULL)
220 return NULL;
221
222 sock_hold(sk);
223 tunnel = (struct l2tp_tunnel *)(sk->sk_user_data);
224 if (tunnel == NULL) {
225 sock_put(sk);
226 goto out;
227 }
228
229 BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
230
231out:
232 return tunnel;
233}
234
Tom Parkin80d84ef2013-01-22 05:13:48 +0000235extern struct sock *l2tp_tunnel_sock_lookup(struct l2tp_tunnel *tunnel);
236extern void l2tp_tunnel_sock_put(struct sock *sk);
James Chapmanf7faffa2010-04-02 06:18:49 +0000237extern struct l2tp_session *l2tp_session_find(struct net *net, struct l2tp_tunnel *tunnel, u32 session_id);
James Chapmanfd558d12010-04-02 06:18:33 +0000238extern struct l2tp_session *l2tp_session_find_nth(struct l2tp_tunnel *tunnel, int nth);
James Chapman309795f2010-04-02 06:19:10 +0000239extern struct l2tp_session *l2tp_session_find_by_ifname(struct net *net, char *ifname);
James Chapmanfd558d12010-04-02 06:18:33 +0000240extern struct l2tp_tunnel *l2tp_tunnel_find(struct net *net, u32 tunnel_id);
241extern struct l2tp_tunnel *l2tp_tunnel_find_nth(struct net *net, int nth);
242
243extern int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id, u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg, struct l2tp_tunnel **tunnelp);
Tom Parkine34f4c72013-03-19 06:11:14 +0000244extern void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel);
James Chapman309795f2010-04-02 06:19:10 +0000245extern int l2tp_tunnel_delete(struct l2tp_tunnel *tunnel);
James Chapmanfd558d12010-04-02 06:18:33 +0000246extern struct l2tp_session *l2tp_session_create(int priv_size, struct l2tp_tunnel *tunnel, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg);
Tom Parkinf6e16b22013-03-19 06:11:23 +0000247extern void __l2tp_session_unhash(struct l2tp_session *session);
James Chapman309795f2010-04-02 06:19:10 +0000248extern int l2tp_session_delete(struct l2tp_session *session);
James Chapmanfd558d12010-04-02 06:18:33 +0000249extern void l2tp_session_free(struct l2tp_session *session);
James Chapmanf7faffa2010-04-02 06:18:49 +0000250extern void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb, unsigned char *ptr, unsigned char *optr, u16 hdrflags, int length, int (*payload_hook)(struct sk_buff *skb));
Tom Parkin48f72f92013-03-19 06:11:19 +0000251extern int l2tp_session_queue_purge(struct l2tp_session *session);
James Chapmanfd558d12010-04-02 06:18:33 +0000252extern int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb);
253
James Chapmanfd558d12010-04-02 06:18:33 +0000254extern int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb, int hdr_len);
James Chapmanfd558d12010-04-02 06:18:33 +0000255
James Chapman309795f2010-04-02 06:19:10 +0000256extern int l2tp_nl_register_ops(enum l2tp_pwtype pw_type, const struct l2tp_nl_cmd_ops *ops);
257extern void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type);
258
James Chapmanfd558d12010-04-02 06:18:33 +0000259/* Session reference counts. Incremented when code obtains a reference
260 * to a session.
261 */
262static inline void l2tp_session_inc_refcount_1(struct l2tp_session *session)
263{
264 atomic_inc(&session->ref_count);
265}
266
267static inline void l2tp_session_dec_refcount_1(struct l2tp_session *session)
268{
269 if (atomic_dec_and_test(&session->ref_count))
270 l2tp_session_free(session);
271}
272
273#ifdef L2TP_REFCNT_DEBUG
Joe Perchesa4ca44f2012-05-16 09:55:56 +0000274#define l2tp_session_inc_refcount(_s) \
275do { \
276 pr_debug("l2tp_session_inc_refcount: %s:%d %s: cnt=%d\n", \
277 __func__, __LINE__, (_s)->name, \
278 atomic_read(&_s->ref_count)); \
279 l2tp_session_inc_refcount_1(_s); \
280} while (0)
281#define l2tp_session_dec_refcount(_s) \
282do { \
283 pr_debug("l2tp_session_dec_refcount: %s:%d %s: cnt=%d\n", \
284 __func__, __LINE__, (_s)->name, \
285 atomic_read(&_s->ref_count)); \
286 l2tp_session_dec_refcount_1(_s); \
287} while (0)
James Chapmanfd558d12010-04-02 06:18:33 +0000288#else
289#define l2tp_session_inc_refcount(s) l2tp_session_inc_refcount_1(s)
290#define l2tp_session_dec_refcount(s) l2tp_session_dec_refcount_1(s)
291#endif
292
Joe Perchesa4ca44f2012-05-16 09:55:56 +0000293#define l2tp_printk(ptr, type, func, fmt, ...) \
294do { \
295 if (((ptr)->debug) & (type)) \
296 func(fmt, ##__VA_ARGS__); \
297} while (0)
298
299#define l2tp_warn(ptr, type, fmt, ...) \
300 l2tp_printk(ptr, type, pr_warn, fmt, ##__VA_ARGS__)
301#define l2tp_info(ptr, type, fmt, ...) \
302 l2tp_printk(ptr, type, pr_info, fmt, ##__VA_ARGS__)
303#define l2tp_dbg(ptr, type, fmt, ...) \
304 l2tp_printk(ptr, type, pr_debug, fmt, ##__VA_ARGS__)
305
James Chapmanfd558d12010-04-02 06:18:33 +0000306#endif /* _L2TP_CORE_H_ */