l2tp: Add debugfs files for dumping l2tp debug info
[linux-3.10.git] / net / l2tp / l2tp_core.h
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  */
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
18 /* Per tunnel, session hash table size */
19 #define L2TP_HASH_BITS  4
20 #define L2TP_HASH_SIZE  (1 << L2TP_HASH_BITS)
21
22 /* 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
26 /* Debug message categories for the DEBUG socket option */
27 enum {
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
36 struct sk_buff;
37
38 struct l2tp_stats {
39         u64                     tx_packets;
40         u64                     tx_bytes;
41         u64                     tx_errors;
42         u64                     rx_packets;
43         u64                     rx_bytes;
44         u64                     rx_seq_discards;
45         u64                     rx_oos_packets;
46         u64                     rx_errors;
47         u64                     rx_cookie_discards;
48 };
49
50 struct l2tp_tunnel;
51
52 /* Describes a session. Contains information to determine incoming
53  * packets and transmit outgoing ones.
54  */
55 struct l2tp_session_cfg {
56         enum l2tp_pwtype        pw_type;
57         unsigned                data_seq:2;     /* data sequencing level
58                                                  * 0 => none, 1 => IP only,
59                                                  * 2 => all
60                                                  */
61         unsigned                recv_seq:1;     /* expect receive packets with
62                                                  * sequence numbers? */
63         unsigned                send_seq:1;     /* send packets with sequence
64                                                  * numbers? */
65         unsigned                lns_mode:1;     /* behave as LNS? LAC enables
66                                                  * sequence numbers under
67                                                  * control of LNS. */
68         int                     debug;          /* bitmask of debug message
69                                                  * categories */
70         u16                     vlan_id;        /* VLAN pseudowire only */
71         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 */
78         int                     reorder_timeout; /* configured reorder timeout
79                                                   * (in jiffies) */
80         int                     mtu;
81         int                     mru;
82         char                    *ifname;
83 };
84
85 struct 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;
93         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) */
104         struct sk_buff_head     reorder_q;      /* receive reorder queue */
105         struct hlist_node       hlist;          /* Hash list node */
106         atomic_t                ref_count;
107
108         char                    name[32];       /* for logging */
109         char                    ifname[IFNAMSIZ];
110         unsigned                data_seq:2;     /* data sequencing level
111                                                  * 0 => none, 1 => IP only,
112                                                  * 2 => all
113                                                  */
114         unsigned                recv_seq:1;     /* expect receive packets with
115                                                  * sequence numbers? */
116         unsigned                send_seq:1;     /* send packets with sequence
117                                                  * numbers? */
118         unsigned                lns_mode:1;     /* behave as LNS? LAC enables
119                                                  * sequence numbers under
120                                                  * control of LNS. */
121         int                     debug;          /* bitmask of debug message
122                                                  * categories */
123         int                     reorder_timeout; /* configured reorder timeout
124                                                   * (in jiffies) */
125         int                     mtu;
126         int                     mru;
127         enum l2tp_pwtype        pwtype;
128         struct l2tp_stats       stats;
129         struct hlist_node       global_hlist;   /* Global hash list node */
130
131         int (*build_header)(struct l2tp_session *session, void *buf);
132         void (*recv_skb)(struct l2tp_session *session, struct sk_buff *skb, int data_len);
133         void (*session_close)(struct l2tp_session *session);
134         void (*ref)(struct l2tp_session *session);
135         void (*deref)(struct l2tp_session *session);
136 #ifdef CONFIG_L2TP_DEBUGFS
137         void (*show)(struct seq_file *m, void *priv);
138 #endif
139         uint8_t                 priv[0];        /* private data */
140 };
141
142 /* Describes the tunnel. It contains info to track all the associated
143  * sessions so incoming packets can be sorted out
144  */
145 struct l2tp_tunnel_cfg {
146         int                     debug;          /* bitmask of debug message
147                                                  * categories */
148         enum l2tp_encap_type    encap;
149 };
150
151 struct l2tp_tunnel {
152         int                     magic;          /* Should be L2TP_TUNNEL_MAGIC */
153         rwlock_t                hlist_lock;     /* protect session_hlist */
154         struct hlist_head       session_hlist[L2TP_HASH_SIZE];
155                                                 /* hashed list of sessions,
156                                                  * hashed by id */
157         u32                     tunnel_id;
158         u32                     peer_tunnel_id;
159         int                     version;        /* 2=>L2TPv2, 3=>L2TPv3 */
160
161         char                    name[20];       /* for logging */
162         int                     debug;          /* bitmask of debug message
163                                                  * categories */
164         enum l2tp_encap_type    encap;
165         struct l2tp_stats       stats;
166
167         struct list_head        list;           /* Keep a list of all tunnels */
168         struct net              *l2tp_net;      /* the net we belong to */
169
170         atomic_t                ref_count;
171 #ifdef CONFIG_DEBUG_FS
172         void (*show)(struct seq_file *m, void *arg);
173 #endif
174         int (*recv_payload_hook)(struct sk_buff *skb);
175         void (*old_sk_destruct)(struct sock *);
176         struct sock             *sock;          /* Parent socket */
177         int                     fd;
178
179         uint8_t                 priv[0];        /* private data */
180 };
181
182 struct l2tp_nl_cmd_ops {
183         int (*session_create)(struct net *net, u32 tunnel_id, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg);
184         int (*session_delete)(struct l2tp_session *session);
185 };
186
187 static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel)
188 {
189         return &tunnel->priv[0];
190 }
191
192 static inline void *l2tp_session_priv(struct l2tp_session *session)
193 {
194         return &session->priv[0];
195 }
196
197 static inline struct l2tp_tunnel *l2tp_sock_to_tunnel(struct sock *sk)
198 {
199         struct l2tp_tunnel *tunnel;
200
201         if (sk == NULL)
202                 return NULL;
203
204         sock_hold(sk);
205         tunnel = (struct l2tp_tunnel *)(sk->sk_user_data);
206         if (tunnel == NULL) {
207                 sock_put(sk);
208                 goto out;
209         }
210
211         BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
212
213 out:
214         return tunnel;
215 }
216
217 extern struct l2tp_session *l2tp_session_find(struct net *net, struct l2tp_tunnel *tunnel, u32 session_id);
218 extern struct l2tp_session *l2tp_session_find_nth(struct l2tp_tunnel *tunnel, int nth);
219 extern struct l2tp_session *l2tp_session_find_by_ifname(struct net *net, char *ifname);
220 extern struct l2tp_tunnel *l2tp_tunnel_find(struct net *net, u32 tunnel_id);
221 extern struct l2tp_tunnel *l2tp_tunnel_find_nth(struct net *net, int nth);
222
223 extern 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);
224 extern int l2tp_tunnel_delete(struct l2tp_tunnel *tunnel);
225 extern 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);
226 extern int l2tp_session_delete(struct l2tp_session *session);
227 extern void l2tp_tunnel_free(struct l2tp_tunnel *tunnel);
228 extern void l2tp_session_free(struct l2tp_session *session);
229 extern 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));
230 extern int l2tp_udp_recv_core(struct l2tp_tunnel *tunnel, struct sk_buff *skb, int (*payload_hook)(struct sk_buff *skb));
231 extern int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb);
232
233 extern int l2tp_xmit_core(struct l2tp_session *session, struct sk_buff *skb, size_t data_len);
234 extern int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb, int hdr_len);
235 extern void l2tp_tunnel_destruct(struct sock *sk);
236 extern void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel);
237 extern void l2tp_session_set_header_len(struct l2tp_session *session, int version);
238
239 extern int l2tp_nl_register_ops(enum l2tp_pwtype pw_type, const struct l2tp_nl_cmd_ops *ops);
240 extern void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type);
241
242 /* Tunnel reference counts. Incremented per session that is added to
243  * the tunnel.
244  */
245 static inline void l2tp_tunnel_inc_refcount_1(struct l2tp_tunnel *tunnel)
246 {
247         atomic_inc(&tunnel->ref_count);
248 }
249
250 static inline void l2tp_tunnel_dec_refcount_1(struct l2tp_tunnel *tunnel)
251 {
252         if (atomic_dec_and_test(&tunnel->ref_count))
253                 l2tp_tunnel_free(tunnel);
254 }
255 #ifdef L2TP_REFCNT_DEBUG
256 #define l2tp_tunnel_inc_refcount(_t) do { \
257                 printk(KERN_DEBUG "l2tp_tunnel_inc_refcount: %s:%d %s: cnt=%d\n", __func__, __LINE__, (_t)->name, atomic_read(&_t->ref_count)); \
258                 l2tp_tunnel_inc_refcount_1(_t);                         \
259         } while (0)
260 #define l2tp_tunnel_dec_refcount(_t) do { \
261                 printk(KERN_DEBUG "l2tp_tunnel_dec_refcount: %s:%d %s: cnt=%d\n", __func__, __LINE__, (_t)->name, atomic_read(&_t->ref_count)); \
262                 l2tp_tunnel_dec_refcount_1(_t);                         \
263         } while (0)
264 #else
265 #define l2tp_tunnel_inc_refcount(t) l2tp_tunnel_inc_refcount_1(t)
266 #define l2tp_tunnel_dec_refcount(t) l2tp_tunnel_dec_refcount_1(t)
267 #endif
268
269 /* Session reference counts. Incremented when code obtains a reference
270  * to a session.
271  */
272 static inline void l2tp_session_inc_refcount_1(struct l2tp_session *session)
273 {
274         atomic_inc(&session->ref_count);
275 }
276
277 static inline void l2tp_session_dec_refcount_1(struct l2tp_session *session)
278 {
279         if (atomic_dec_and_test(&session->ref_count))
280                 l2tp_session_free(session);
281 }
282
283 #ifdef L2TP_REFCNT_DEBUG
284 #define l2tp_session_inc_refcount(_s) do { \
285                 printk(KERN_DEBUG "l2tp_session_inc_refcount: %s:%d %s: cnt=%d\n", __func__, __LINE__, (_s)->name, atomic_read(&_s->ref_count)); \
286                 l2tp_session_inc_refcount_1(_s);                                \
287         } while (0)
288 #define l2tp_session_dec_refcount(_s) do { \
289                 printk(KERN_DEBUG "l2tp_session_dec_refcount: %s:%d %s: cnt=%d\n", __func__, __LINE__, (_s)->name, atomic_read(&_s->ref_count)); \
290                 l2tp_session_dec_refcount_1(_s);                                \
291         } while (0)
292 #else
293 #define l2tp_session_inc_refcount(s) l2tp_session_inc_refcount_1(s)
294 #define l2tp_session_dec_refcount(s) l2tp_session_dec_refcount_1(s)
295 #endif
296
297 #endif /* _L2TP_CORE_H_ */