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         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                     l2specific_len; /* Layer 2 specific length */
  72         u16                     l2specific_type; /* Layer 2 specific type */
  73         u8                      cookie[8];      /* optional cookie */
  74         int                     cookie_len;     /* 0, 4 or 8 bytes */
  75         u8                      peer_cookie[8]; /* peer's cookie */
  76         int                     peer_cookie_len; /* 0, 4 or 8 bytes */
  77         int                     reorder_timeout; /* configured reorder timeout
  78                                                   * (in jiffies) */
  79         int                     mtu;
  80         int                     mru;
  81         char                    *ifname;
  82 };
  83
  84 struct l2tp_session {
  85         int                     magic;          /* should be
  86                                                  * L2TP_SESSION_MAGIC */
  87
  88         struct l2tp_tunnel      *tunnel;        /* back pointer to tunnel
  89                                                  * context */
  90         u32                     session_id;
  91         u32                     peer_session_id;
  92         u8                      cookie[8];
  93         int                     cookie_len;
  94         u8                      peer_cookie[8];
  95         int                     peer_cookie_len;
  96         u16                     l2specific_len;
  97         u16                     l2specific_type;
  98         u16                     hdr_len;
  99         u32                     nr;             /* session NR state (receive) */
 100         u32                     ns;             /* session NR state (send) */
 101         struct sk_buff_head     reorder_q;      /* receive reorder queue */
 102         u32                     nr_max;         /* max NR. Depends on tunnel */
 103         u32                     nr_window_size; /* NR window size */
 104         u32                     nr_oos;         /* NR of last OOS packet */
 105         int                     nr_oos_count;   /* For OOS recovery */
 106         int                     nr_oos_count_max;
 107         struct hlist_node       hlist;          /* Hash list node */
 108         atomic_t                ref_count;
 109
 110         char                    name[32];       /* for logging */
 111         char                    ifname[IFNAMSIZ];
 112         unsigned int            data_seq:2;     /* data sequencing level
 113                                                  * 0 => none, 1 => IP only,
 114                                                  * 2 => all
 115                                                  */
 116         unsigned int            recv_seq:1;     /* expect receive packets with
 117                                                  * sequence numbers? */
 118         unsigned int            send_seq:1;     /* send packets with sequence
 119                                                  * numbers? */
 120         unsigned int            lns_mode:1;     /* behave as LNS? LAC enables
 121                                                  * 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) */
 127         int                     reorder_skip;   /* set if skip to next nr */
 128         int                     mtu;
 129         int                     mru;
 130         enum l2tp_pwtype        pwtype;
 131         struct l2tp_stats       stats;
 132         struct hlist_node       global_hlist;   /* Global hash list node */
 133
 134         int (*build_header)(struct l2tp_session *session, void *buf);
 135         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);
 139 #if IS_ENABLED(CONFIG_L2TP_DEBUGFS)
 140         void (*show)(struct seq_file *m, void *priv);
 141 #endif
 142         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  */
 148 struct l2tp_tunnel_cfg {
 149         int                     debug;          /* bitmask of debug message
 150                                                  * categories */
 151         enum l2tp_encap_type    encap;
 152
 153         /* Used only for kernel-created sockets */
 154         struct in_addr          local_ip;
 155         struct in_addr          peer_ip;
 156 #if IS_ENABLED(CONFIG_IPV6)
 157         struct in6_addr         *local_ip6;
 158         struct in6_addr         *peer_ip6;
 159 #endif
 160         u16                     local_udp_port;
 161         u16                     peer_udp_port;
 162         unsigned int            use_udp_checksums:1,
 163                                 udp6_zero_tx_checksums:1,
 164                                 udp6_zero_rx_checksums:1;
 165 };
 166
 167 struct l2tp_tunnel {
 168         int                     magic;          /* Should be L2TP_TUNNEL_MAGIC */
 169
 170         unsigned long           dead;
 171
 172         struct rcu_head rcu;
 173         rwlock_t                hlist_lock;     /* protect session_hlist */
 174         struct hlist_head       session_hlist[L2TP_HASH_SIZE];
 175                                                 /* hashed list of sessions,
 176                                                  * hashed by id */
 177         u32                     tunnel_id;
 178         u32                     peer_tunnel_id;
 179         int                     version;        /* 2=>L2TPv2, 3=>L2TPv3 */
 180
 181         char                    name[20];       /* for logging */
 182         int                     debug;          /* bitmask of debug message
 183                                                  * categories */
 184         enum l2tp_encap_type    encap;
 185         struct l2tp_stats       stats;
 186
 187         struct list_head        list;           /* Keep a list of all tunnels */
 188         struct net              *l2tp_net;      /* the net we belong to */
 189
 190         atomic_t                ref_count;
 191 #ifdef CONFIG_DEBUG_FS
 192         void (*show)(struct seq_file *m, void *arg);
 193 #endif
 194         int (*recv_payload_hook)(struct sk_buff *skb);
 195         void (*old_sk_destruct)(struct sock *);
 196         struct sock             *sock;          /* Parent socket */
 197         int                     fd;             /* Parent fd, if tunnel socket
 198                                                  * was created by userspace */
 199 #if IS_ENABLED(CONFIG_IPV6)
 200         bool                    v4mapped;
 201 #endif
 202
 203         struct work_struct      del_work;
 204
 205         uint8_t                 priv[0];        /* private data */
 206 };
 207
 208 struct l2tp_nl_cmd_ops {
 209         int (*session_create)(struct net *net, u32 tunnel_id, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg);
 210         int (*session_delete)(struct l2tp_session *session);
 211 };
 212
 213 static inline void *l2tp_tunnel_priv(struct l2tp_tunnel *tunnel)
 214 {
 215         return &tunnel->priv[0];
 216 }
 217
 218 static inline void *l2tp_session_priv(struct l2tp_session *session)
 219 {
 220         return &session->priv[0];
 221 }
 222
 223 static inline struct l2tp_tunnel *l2tp_sock_to_tunnel(struct sock *sk)
 224 {
 225         struct l2tp_tunnel *tunnel;
 226
 227         if (sk == NULL)
 228                 return NULL;
 229
 230         sock_hold(sk);
 231         tunnel = (struct l2tp_tunnel *)(sk->sk_user_data);
 232         if (tunnel == NULL) {
 233                 sock_put(sk);
 234                 goto out;
 235         }
 236
 237         BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
 238
 239 out:
 240         return tunnel;
 241 }
 242
 243 struct l2tp_session *l2tp_session_get(struct net *net,
 244                                       struct l2tp_tunnel *tunnel,
 245                                       u32 session_id, bool do_ref);
 246 struct l2tp_session *l2tp_session_find(struct net *net,
 247                                        struct l2tp_tunnel *tunnel,
 248                                        u32 session_id);
 249 struct l2tp_session *l2tp_session_get_nth(struct l2tp_tunnel *tunnel, int nth,
 250                                           bool do_ref);
 251 struct l2tp_session *l2tp_session_get_by_ifname(struct net *net, char *ifname,
 252                                                 bool do_ref);
 253 struct l2tp_tunnel *l2tp_tunnel_find(struct net *net, u32 tunnel_id);
 254 struct l2tp_tunnel *l2tp_tunnel_find_nth(struct net *net, int nth);
 255
 256 int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id,
 257                        u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg,
 258                        struct l2tp_tunnel **tunnelp);
 259 void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel);
 260 void l2tp_tunnel_delete(struct l2tp_tunnel *tunnel);
 261 struct l2tp_session *l2tp_session_create(int priv_size,
 262                                          struct l2tp_tunnel *tunnel,
 263                                          u32 session_id, u32 peer_session_id,
 264                                          struct l2tp_session_cfg *cfg);
 265 void __l2tp_session_unhash(struct l2tp_session *session);
 266 int l2tp_session_delete(struct l2tp_session *session);
 267 void l2tp_session_free(struct l2tp_session *session);
 268 void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb,
 269                       unsigned char *ptr, unsigned char *optr, u16 hdrflags,
 270                       int length, int (*payload_hook)(struct sk_buff *skb));
 271 int l2tp_session_queue_purge(struct l2tp_session *session);
 272 int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb);
 273 void l2tp_session_set_header_len(struct l2tp_session *session, int version);
 274
 275 int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb,
 276                   int hdr_len);
 277
 278 int l2tp_nl_register_ops(enum l2tp_pwtype pw_type,
 279                          const struct l2tp_nl_cmd_ops *ops);
 280 void l2tp_nl_unregister_ops(enum l2tp_pwtype pw_type);
 281 int l2tp_ioctl(struct sock *sk, int cmd, unsigned long arg);
 282
 283 /* Session reference counts. Incremented when code obtains a reference
 284  * to a session.
 285  */
 286 static inline void l2tp_session_inc_refcount_1(struct l2tp_session *session)
 287 {
 288         atomic_inc(&session->ref_count);
 289 }
 290
 291 static inline void l2tp_session_dec_refcount_1(struct l2tp_session *session)
 292 {
 293         if (atomic_dec_and_test(&session->ref_count))
 294                 l2tp_session_free(session);
 295 }
 296
 297 #ifdef L2TP_REFCNT_DEBUG
 298 #define l2tp_session_inc_refcount(_s)                                   \
 299 do {                                                                    \
 300         pr_debug("l2tp_session_inc_refcount: %s:%d %s: cnt=%d\n",       \
 301                  __func__, __LINE__, (_s)->name,                        \
 302                  atomic_read(&_s->ref_count));                          \
 303         l2tp_session_inc_refcount_1(_s);                                \
 304 } while (0)
 305 #define l2tp_session_dec_refcount(_s)                                   \
 306 do {                                                                    \
 307         pr_debug("l2tp_session_dec_refcount: %s:%d %s: cnt=%d\n",       \
 308                  __func__, __LINE__, (_s)->name,                        \
 309                  atomic_read(&_s->ref_count));                          \
 310         l2tp_session_dec_refcount_1(_s);                                \
 311 } while (0)
 312 #else
 313 #define l2tp_session_inc_refcount(s) l2tp_session_inc_refcount_1(s)
 314 #define l2tp_session_dec_refcount(s) l2tp_session_dec_refcount_1(s)
 315 #endif
 316
 317 #define l2tp_printk(ptr, type, func, fmt, ...)                          \
 318 do {                                                                    \
 319         if (((ptr)->debug) & (type))                                    \
 320                 func(fmt, ##__VA_ARGS__);                               \
 321 } while (0)
 322
 323 #define l2tp_warn(ptr, type, fmt, ...)                                  \
 324         l2tp_printk(ptr, type, pr_warn, fmt, ##__VA_ARGS__)
 325 #define l2tp_info(ptr, type, fmt, ...)                                  \
 326         l2tp_printk(ptr, type, pr_info, fmt, ##__VA_ARGS__)
 327 #define l2tp_dbg(ptr, type, fmt, ...)                                   \
 328         l2tp_printk(ptr, type, pr_debug, fmt, ##__VA_ARGS__)
 329
 330 #define MODULE_ALIAS_L2TP_PWTYPE(type) \
 331         MODULE_ALIAS("net-l2tp-type-" __stringify(type))
 332
 333 #endif /* _L2TP_CORE_H_ */