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

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

Version: ~ [ linux-5.15-rc5 ] ~ [ linux-5.14.11 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.72 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.152 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.210 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.250 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.286 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.288 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ 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 #include <linux/refcount.h>
 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 
 19 /* Per tunnel, session hash table size */
 20 #define L2TP_HASH_BITS  4
 21 #define L2TP_HASH_SIZE  (1 << L2TP_HASH_BITS)
 22 
 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 
 27 struct sk_buff;
 28 
 29 struct l2tp_stats {
 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;
 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 {
 47         enum l2tp_pwtype        pw_type;
 48         unsigned int            data_seq:2;     /* data sequencing level
 49                                                  * 0 => none, 1 => IP only,
 50                                                  * 2 => all
 51                                                  */
 52         unsigned int            recv_seq:1;     /* expect receive packets with
 53                                                  * sequence numbers? */
 54         unsigned int            send_seq:1;     /* send packets with sequence
 55                                                  * numbers? */
 56         unsigned int            lns_mode:1;     /* behave as LNS? LAC enables
 57                                                  * sequence numbers under
 58                                                  * control of LNS. */
 59         int                     debug;          /* bitmask of debug message
 60                                                  * categories */
 61         u16                     vlan_id;        /* VLAN pseudowire only */
 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 */
 69         int                     reorder_timeout; /* configured reorder timeout
 70                                                   * (in jiffies) */
 71         int                     mtu;
 72         int                     mru;
 73         char                    *ifname;
 74 };
 75 
 76 struct l2tp_session {
 77         int                     magic;          /* should be
 78                                                  * L2TP_SESSION_MAGIC */
 79         long                    dead;
 80 
 81         struct l2tp_tunnel      *tunnel;        /* back pointer to tunnel
 82                                                  * context */
 83         u32                     session_id;
 84         u32                     peer_session_id;
 85         u8                      cookie[8];
 86         int                     cookie_len;
 87         u8                      peer_cookie[8];
 88         int                     peer_cookie_len;
 89         u16                     offset;         /* offset from end of L2TP header
 90                                                    to beginning of data */
 91         u16                     l2specific_len;
 92         u16                     l2specific_type;
 93         u16                     hdr_len;
 94         u32                     nr;             /* session NR state (receive) */
 95         u32                     ns;             /* session NR state (send) */
 96         struct sk_buff_head     reorder_q;      /* receive reorder queue */
 97         u32                     nr_max;         /* max NR. Depends on tunnel */
 98         u32                     nr_window_size; /* NR window size */
 99         u32                     nr_oos;         /* NR of last OOS packet */
100         int                     nr_oos_count;   /* For OOS recovery */
101         int                     nr_oos_count_max;
102         struct hlist_node       hlist;          /* Hash list node */
103         refcount_t              ref_count;
104 
105         char                    name[32];       /* for logging */
106         char                    ifname[IFNAMSIZ];
107         unsigned int            data_seq:2;     /* data sequencing level
108                                                  * 0 => none, 1 => IP only,
109                                                  * 2 => all
110                                                  */
111         unsigned int            recv_seq:1;     /* expect receive packets with
112                                                  * sequence numbers? */
113         unsigned int            send_seq:1;     /* send packets with sequence
114                                                  * numbers? */
115         unsigned int            lns_mode:1;     /* behave as LNS? LAC enables
116                                                  * sequence numbers under
117                                                  * control of LNS. */
118         int                     debug;          /* bitmask of debug message
119                                                  * categories */
120         int                     reorder_timeout; /* configured reorder timeout
121                                                   * (in jiffies) */
122         int                     reorder_skip;   /* set if skip to next nr */
123         int                     mtu;
124         int                     mru;
125         enum l2tp_pwtype        pwtype;
126         struct l2tp_stats       stats;
127         struct hlist_node       global_hlist;   /* Global hash list node */
128 
129         int (*build_header)(struct l2tp_session *session, void *buf);
130         void (*recv_skb)(struct l2tp_session *session, struct sk_buff *skb, int data_len);
131         void (*session_close)(struct l2tp_session *session);
132 #if IS_ENABLED(CONFIG_L2TP_DEBUGFS)
133         void (*show)(struct seq_file *m, void *priv);
134 #endif
135         uint8_t                 priv[0];        /* private data */
136 };
137 
138 /* Describes the tunnel. It contains info to track all the associated
139  * sessions so incoming packets can be sorted out
140  */
141 struct l2tp_tunnel_cfg {
142         int                     debug;          /* bitmask of debug message
143                                                  * categories */
144         enum l2tp_encap_type    encap;
145 
146         /* Used only for kernel-created sockets */
147         struct in_addr          local_ip;
148         struct in_addr          peer_ip;
149 #if IS_ENABLED(CONFIG_IPV6)
150         struct in6_addr         *local_ip6;
151         struct in6_addr         *peer_ip6;
152 #endif
153         u16                     local_udp_port;
154         u16                     peer_udp_port;
155         unsigned int            use_udp_checksums:1,
156                                 udp6_zero_tx_checksums:1,
157                                 udp6_zero_rx_checksums:1;
158 };
159 
160 struct l2tp_tunnel {
161         int                     magic;          /* Should be L2TP_TUNNEL_MAGIC */
162 
163         unsigned long           dead;
164 
165         struct rcu_head rcu;
166         rwlock_t                hlist_lock;     /* protect session_hlist */
167         bool                    acpt_newsess;   /* Indicates whether this
168                                                  * tunnel accepts new sessions.
169                                                  * Protected by hlist_lock.
170                                                  */
171         struct hlist_head       session_hlist[L2TP_HASH_SIZE];
172                                                 /* hashed list of sessions,
173                                                  * hashed by id */
174         u32                     tunnel_id;
175         u32                     peer_tunnel_id;
176         int                     version;        /* 2=>L2TPv2, 3=>L2TPv3 */
177 
178         char                    name[20];       /* for logging */
179         int                     debug;          /* bitmask of debug message
180                                                  * categories */
181         enum l2tp_encap_type    encap;
182         struct l2tp_stats       stats;
183 
184         struct list_head        list;           /* Keep a list of all tunnels */
185         struct net              *l2tp_net;      /* the net we belong to */
186 
187         refcount_t              ref_count;
188 #ifdef CONFIG_DEBUG_FS
189         void (*show)(struct seq_file *m, void *arg);
190 #endif
191         int (*recv_payload_hook)(struct sk_buff *skb);
192         void (*old_sk_destruct)(struct sock *);
193         struct sock             *sock;          /* Parent socket */
194         int                     fd;             /* Parent fd, if tunnel socket
195                                                  * was created by userspace */
196 
197         struct work_struct      del_work;
198 
199         uint8_t                 priv[0];        /* private data */
200 };
201 
202 struct l2tp_nl_cmd_ops {
203         int (*session_create)(struct net *net, struct l2tp_tunnel *tunnel,
204                               u32 session_id, u32 peer_session_id,
205                               struct l2tp_session_cfg *cfg);
206         int (*session_delete)(struct l2tp_session *session);
207 };
208 
209 static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel)
210 {
211         return &tunnel->priv[0];
212 }
213 
214 static inline void *l2tp_session_priv(struct l2tp_session *session)
215 {
216         return &session->priv[0];
217 }
218 
219 struct l2tp_tunnel *l2tp_tunnel_get(const struct net *net, u32 tunnel_id);
220 void l2tp_tunnel_free(struct l2tp_tunnel *tunnel);
221 
222 struct l2tp_session *l2tp_session_get(const struct net *net,
223                                       struct l2tp_tunnel *tunnel,
224                                       u32 session_id);
225 struct l2tp_session *l2tp_session_get_nth(struct l2tp_tunnel *tunnel, int nth);
226 struct l2tp_session *l2tp_session_get_by_ifname(const struct net *net,
227                                                 const char *ifname);
228 struct l2tp_tunnel *l2tp_tunnel_find_nth(const struct net *net, int nth);
229 
230 int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id,
231                        u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg,
232                        struct l2tp_tunnel **tunnelp);
233 int l2tp_tunnel_register(struct l2tp_tunnel *tunnel, struct net *net,
234                          struct l2tp_tunnel_cfg *cfg);
235 
236 void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel);
237 void l2tp_tunnel_delete(struct l2tp_tunnel *tunnel);
238 struct l2tp_session *l2tp_session_create(int priv_size,
239                                          struct l2tp_tunnel *tunnel,
240                                          u32 session_id, u32 peer_session_id,
241                                          struct l2tp_session_cfg *cfg);
242 int l2tp_session_register(struct l2tp_session *session,
243                           struct l2tp_tunnel *tunnel);
244 
245 void __l2tp_session_unhash(struct l2tp_session *session);
246 int l2tp_session_delete(struct l2tp_session *session);
247 void l2tp_session_free(struct l2tp_session *session);
248 void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb,
249                       unsigned char *ptr, unsigned char *optr, u16 hdrflags,
250                       int length, int (*payload_hook)(struct sk_buff *skb));
251 int l2tp_session_queue_purge(struct l2tp_session *session);
252 int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb);
253 void l2tp_session_set_header_len(struct l2tp_session *session, int version);
254 
255 int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb,
256                   int hdr_len);
257 
258 int l2tp_nl_register_ops(enum l2tp_pwtype pw_type,
259                          const struct l2tp_nl_cmd_ops *ops);
260 void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type);
261 int l2tp_ioctl(struct sock *sk, int cmd, unsigned long arg);
262 
263 static inline void l2tp_tunnel_inc_refcount(struct l2tp_tunnel *tunnel)
264 {
265         refcount_inc(&tunnel->ref_count);
266 }
267 
268 static inline void l2tp_tunnel_dec_refcount(struct l2tp_tunnel *tunnel)
269 {
270         if (refcount_dec_and_test(&tunnel->ref_count))
271                 l2tp_tunnel_free(tunnel);
272 }
273 
274 /* Session reference counts. Incremented when code obtains a reference
275  * to a session.
276  */
277 static inline void l2tp_session_inc_refcount(struct l2tp_session *session)
278 {
279         refcount_inc(&session->ref_count);
280 }
281 
282 static inline void l2tp_session_dec_refcount(struct l2tp_session *session)
283 {
284         if (refcount_dec_and_test(&session->ref_count))
285                 l2tp_session_free(session);
286 }
287 
288 #define l2tp_printk(ptr, type, func, fmt, ...)                          \
289 do {                                                                    \
290         if (((ptr)->debug) & (type))                                    \
291                 func(fmt, ##__VA_ARGS__);                               \
292 } while (0)
293 
294 #define l2tp_warn(ptr, type, fmt, ...)                                  \
295         l2tp_printk(ptr, type, pr_warn, fmt, ##__VA_ARGS__)
296 #define l2tp_info(ptr, type, fmt, ...)                                  \
297         l2tp_printk(ptr, type, pr_info, fmt, ##__VA_ARGS__)
298 #define l2tp_dbg(ptr, type, fmt, ...)                                   \
299         l2tp_printk(ptr, type, pr_debug, fmt, ##__VA_ARGS__)
300 
301 #define MODULE_ALIAS_L2TP_PWTYPE(type) \
302         MODULE_ALIAS("net-l2tp-type-" __stringify(type))
303 
304 #endif /* _L2TP_CORE_H_ */
305 

~ [ 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