~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/net/l2tp/l2tp_core.h

Version: ~ [ linux-5.9-rc6 ] ~ [ linux-5.8.10 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.66 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.146 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.198 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.236 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.236 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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         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;
 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 int            data_seq:2;     /* data sequencing level
 58                                                  * 0 => none, 1 => IP only,
 59                                                  * 2 => all
 60                                                  */
 61         unsigned int            recv_seq:1;     /* expect receive packets with
 62                                                  * sequence numbers? */
 63         unsigned int            send_seq:1;     /* send packets with sequence
 64                                                  * numbers? */
 65         unsigned int            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         u32                     nr_max;         /* max NR. Depends on tunnel */
106         u32                     nr_window_size; /* NR window size */
107         u32                     nr_oos;         /* NR of last OOS packet */
108         int                     nr_oos_count;   /* For OOS recovery */
109         int                     nr_oos_count_max;
110         struct hlist_node       hlist;          /* Hash list node */
111         atomic_t                ref_count;
112 
113         char                    name[32];       /* for logging */
114         char                    ifname[IFNAMSIZ];
115         unsigned int            data_seq:2;     /* data sequencing level
116                                                  * 0 => none, 1 => IP only,
117                                                  * 2 => all
118                                                  */
119         unsigned int            recv_seq:1;     /* expect receive packets with
120                                                  * sequence numbers? */
121         unsigned int            send_seq:1;     /* send packets with sequence
122                                                  * numbers? */
123         unsigned int            lns_mode:1;     /* behave as LNS? LAC enables
124                                                  * sequence numbers under
125                                                  * control of LNS. */
126         int                     debug;          /* bitmask of debug message
127                                                  * categories */
128         int                     reorder_timeout; /* configured reorder timeout
129                                                   * (in jiffies) */
130         int                     reorder_skip;   /* set if skip to next nr */
131         int                     mtu;
132         int                     mru;
133         enum l2tp_pwtype        pwtype;
134         struct l2tp_stats       stats;
135         struct hlist_node       global_hlist;   /* Global hash list node */
136 
137         int (*build_header)(struct l2tp_session *session, void *buf);
138         void (*recv_skb)(struct l2tp_session *session, struct sk_buff *skb, int data_len);
139         void (*session_close)(struct l2tp_session *session);
140         void (*ref)(struct l2tp_session *session);
141         void (*deref)(struct l2tp_session *session);
142 #if defined(CONFIG_L2TP_DEBUGFS) || defined(CONFIG_L2TP_DEBUGFS_MODULE)
143         void (*show)(struct seq_file *m, void *priv);
144 #endif
145         uint8_t                 priv[0];        /* private data */
146 };
147 
148 /* Describes the tunnel. It contains info to track all the associated
149  * sessions so incoming packets can be sorted out
150  */
151 struct l2tp_tunnel_cfg {
152         int                     debug;          /* bitmask of debug message
153                                                  * categories */
154         enum l2tp_encap_type    encap;
155 
156         /* Used only for kernel-created sockets */
157         struct in_addr          local_ip;
158         struct in_addr          peer_ip;
159 #if IS_ENABLED(CONFIG_IPV6)
160         struct in6_addr         *local_ip6;
161         struct in6_addr         *peer_ip6;
162 #endif
163         u16                     local_udp_port;
164         u16                     peer_udp_port;
165         unsigned int            use_udp_checksums:1,
166                                 udp6_zero_tx_checksums:1,
167                                 udp6_zero_rx_checksums:1;
168 };
169 
170 struct l2tp_tunnel {
171         int                     magic;          /* Should be L2TP_TUNNEL_MAGIC */
172 
173         unsigned long           dead;
174 
175         struct rcu_head rcu;
176         rwlock_t                hlist_lock;     /* protect session_hlist */
177         bool                    acpt_newsess;   /* Indicates whether this
178                                                  * tunnel accepts new sessions.
179                                                  * Protected by hlist_lock.
180                                                  */
181         struct hlist_head       session_hlist[L2TP_HASH_SIZE];
182                                                 /* hashed list of sessions,
183                                                  * hashed by id */
184         u32                     tunnel_id;
185         u32                     peer_tunnel_id;
186         int                     version;        /* 2=>L2TPv2, 3=>L2TPv3 */
187 
188         char                    name[20];       /* for logging */
189         int                     debug;          /* bitmask of debug message
190                                                  * categories */
191         enum l2tp_encap_type    encap;
192         struct l2tp_stats       stats;
193 
194         struct list_head        list;           /* Keep a list of all tunnels */
195         struct net              *l2tp_net;      /* the net we belong to */
196 
197         atomic_t                ref_count;
198 #ifdef CONFIG_DEBUG_FS
199         void (*show)(struct seq_file *m, void *arg);
200 #endif
201         int (*recv_payload_hook)(struct sk_buff *skb);
202         void (*old_sk_destruct)(struct sock *);
203         struct sock             *sock;          /* Parent socket */
204         int                     fd;             /* Parent fd, if tunnel socket
205                                                  * was created by userspace */
206 
207         struct work_struct      del_work;
208 
209         uint8_t                 priv[0];        /* private data */
210 };
211 
212 struct l2tp_nl_cmd_ops {
213         int (*session_create)(struct net *net, struct l2tp_tunnel *tunnel,
214                               u32 session_id, u32 peer_session_id,
215                               struct l2tp_session_cfg *cfg);
216         int (*session_delete)(struct l2tp_session *session);
217 };
218 
219 static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel)
220 {
221         return &tunnel->priv[0];
222 }
223 
224 static inline void *l2tp_session_priv(struct l2tp_session *session)
225 {
226         return &session->priv[0];
227 }
228 
229 struct l2tp_tunnel *l2tp_tunnel_get(const struct net *net, u32 tunnel_id);
230 struct l2tp_tunnel *l2tp_tunnel_get_nth(const struct net *net, int nth);
231 
232 void l2tp_tunnel_free(struct l2tp_tunnel *tunnel);
233 
234 struct l2tp_session *l2tp_session_get(const struct net *net,
235                                       struct l2tp_tunnel *tunnel,
236                                       u32 session_id, bool do_ref);
237 struct l2tp_session *l2tp_session_find(struct net *net,
238                                        struct l2tp_tunnel *tunnel,
239                                        u32 session_id);
240 struct l2tp_session *l2tp_session_get_nth(struct l2tp_tunnel *tunnel, int nth,
241                                           bool do_ref);
242 struct l2tp_session *l2tp_session_get_by_ifname(const struct net *net,
243                                                 const char *ifname,
244                                                 bool do_ref);
245 
246 int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id,
247                        u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg,
248                        struct l2tp_tunnel **tunnelp);
249 int l2tp_tunnel_register(struct l2tp_tunnel *tunnel, struct net *net,
250                          struct l2tp_tunnel_cfg *cfg);
251 
252 void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel);
253 void l2tp_tunnel_delete(struct l2tp_tunnel *tunnel);
254 struct l2tp_session *l2tp_session_create(int priv_size,
255                                          struct l2tp_tunnel *tunnel,
256                                          u32 session_id, u32 peer_session_id,
257                                          struct l2tp_session_cfg *cfg);
258 int l2tp_session_register(struct l2tp_session *session,
259                           struct l2tp_tunnel *tunnel);
260 
261 void __l2tp_session_unhash(struct l2tp_session *session);
262 int l2tp_session_delete(struct l2tp_session *session);
263 void l2tp_session_free(struct l2tp_session *session);
264 void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb,
265                       unsigned char *ptr, unsigned char *optr, u16 hdrflags,
266                       int length, int (*payload_hook)(struct sk_buff *skb));
267 int l2tp_session_queue_purge(struct l2tp_session *session);
268 int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb);
269 void l2tp_session_set_header_len(struct l2tp_session *session, int version);
270 
271 int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb,
272                   int hdr_len);
273 
274 int l2tp_nl_register_ops(enum l2tp_pwtype pw_type,
275                          const struct l2tp_nl_cmd_ops *ops);
276 void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type);
277 int l2tp_ioctl(struct sock *sk, int cmd, unsigned long arg);
278 
279 static inline void l2tp_tunnel_inc_refcount(struct l2tp_tunnel *tunnel)
280 {
281         atomic_inc(&tunnel->ref_count);
282 }
283 
284 static inline void l2tp_tunnel_dec_refcount(struct l2tp_tunnel *tunnel)
285 {
286         if (atomic_dec_and_test(&tunnel->ref_count))
287                 l2tp_tunnel_free(tunnel);
288 }
289 
290 /* Session reference counts. Incremented when code obtains a reference
291  * to a session.
292  */
293 static inline void l2tp_session_inc_refcount_1(struct l2tp_session *session)
294 {
295         atomic_inc(&session->ref_count);
296 }
297 
298 static inline void l2tp_session_dec_refcount_1(struct l2tp_session *session)
299 {
300         if (atomic_dec_and_test(&session->ref_count))
301                 l2tp_session_free(session);
302 }
303 
304 #ifdef L2TP_REFCNT_DEBUG
305 #define l2tp_session_inc_refcount(_s)                                   \
306 do {                                                                    \
307         pr_debug("l2tp_session_inc_refcount: %s:%d %s: cnt=%d\n",       \
308                  __func__, __LINE__, (_s)->name,                        \
309                  atomic_read(&_s->ref_count));                          \
310         l2tp_session_inc_refcount_1(_s);                                \
311 } while (0)
312 #define l2tp_session_dec_refcount(_s)                                   \
313 do {                                                                    \
314         pr_debug("l2tp_session_dec_refcount: %s:%d %s: cnt=%d\n",       \
315                  __func__, __LINE__, (_s)->name,                        \
316                  atomic_read(&_s->ref_count));                          \
317         l2tp_session_dec_refcount_1(_s);                                \
318 } while (0)
319 #else
320 #define l2tp_session_inc_refcount(s) l2tp_session_inc_refcount_1(s)
321 #define l2tp_session_dec_refcount(s) l2tp_session_dec_refcount_1(s)
322 #endif
323 
324 #define l2tp_printk(ptr, type, func, fmt, ...)                          \
325 do {                                                                    \
326         if (((ptr)->debug) & (type))                                    \
327                 func(fmt, ##__VA_ARGS__);                               \
328 } while (0)
329 
330 #define l2tp_warn(ptr, type, fmt, ...)                                  \
331         l2tp_printk(ptr, type, pr_warn, fmt, ##__VA_ARGS__)
332 #define l2tp_info(ptr, type, fmt, ...)                                  \
333         l2tp_printk(ptr, type, pr_info, fmt, ##__VA_ARGS__)
334 #define l2tp_dbg(ptr, type, fmt, ...)                                   \
335         l2tp_printk(ptr, type, pr_debug, fmt, ##__VA_ARGS__)
336 
337 #endif /* _L2TP_CORE_H_ */
338 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp