src/plugins/pppoe/pppoe.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Intel and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef _PPPOE_H
  19 #define _PPPOE_H
  20
  21 #include <vnet/plugin/plugin.h>
  22 #include <vppinfra/lock.h>
  23 #include <vppinfra/error.h>
  24 #include <vppinfra/hash.h>
  25 #include <vnet/vnet.h>
  26 #include <vnet/ip/ip.h>
  27 #include <vnet/ethernet/ethernet.h>
  28 #include <vnet/ip/ip4_packet.h>
  29 #include <vnet/ip/ip6_packet.h>
  30 #include <vnet/dpo/dpo.h>
  31 #include <vnet/adj/adj_types.h>
  32 #include <vnet/fib/fib_table.h>
  33 #include <vlib/vlib.h>
  34 #include <vppinfra/bihash_8_8.h>
  35
  36
  37 typedef struct
  38 {
  39   u8 ver_type;
  40   u8 code;
  41   u16 session_id;
  42   u16 length;
  43   u16 ppp_proto;
  44 } pppoe_header_t;
  45
  46 #define PPPOE_VER_TYPE 0x11
  47 #define PPPOE_PADS 0x65
  48
  49 typedef struct
  50 {
  51   /* Required for pool_get_aligned  */
  52   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  53
  54   /* pppoe session_id in HOST byte order */
  55   u16 session_id;
  56
  57   /* session client addresses */
  58   ip46_address_t client_ip;
  59
  60   /* the index of tx interface for pppoe encaped packet */
  61   u32 encap_if_index;
  62
  63   /** FIB indices - inner IP packet lookup here */
  64   u32 decap_fib_index;
  65
  66   u8 local_mac[6];
  67   u8 client_mac[6];
  68
  69   /* vnet intfc index */
  70   u32 sw_if_index;
  71   u32 hw_if_index;
  72
  73 } pppoe_session_t;
  74
  75 #define foreach_pppoe_input_next        \
  76 _(DROP, "error-drop")                  \
  77 _(IP4_INPUT, "ip4-input")              \
  78 _(IP6_INPUT, "ip6-input" )             \
  79 _(CP_INPUT, "pppoe-cp-dispatch" )      \
  80
  81 typedef enum
  82 {
  83 #define _(s,n) PPPOE_INPUT_NEXT_##s,
  84   foreach_pppoe_input_next
  85 #undef _
  86     PPPOE_INPUT_N_NEXT,
  87 } pppoe_input_next_t;
  88
  89 typedef enum
  90 {
  91 #define pppoe_error(n,s) PPPOE_ERROR_##n,
  92 #include <pppoe/pppoe_error.def>
  93 #undef pppoe_error
  94   PPPOE_N_ERROR,
  95 } pppoe_input_error_t;
  96
  97 extern char *pppoe_error_strings[];
  98
  99 #define MTU 1500
 100 #define MTU_BUFFERS ((MTU + vlib_buffer_get_default_data_size(vm) - 1) / vlib_buffer_get_default_data_size(vm))
 101 #define NUM_BUFFERS_TO_ALLOC 32
 102
 103 /*
 104  * The size of pppoe session table
 105  */
 106 #define PPPOE_NUM_BUCKETS (64 * 1024)
 107 #define PPPOE_MEMORY_SIZE (8<<20)
 108
 109 /*
 110  * The PPPoE key is the mac address and session ID
 111  */
 112 typedef struct
 113 {
 114   union
 115   {
 116     struct
 117     {
 118       u16 session_id;
 119       u8 mac[6];
 120     } fields;
 121     struct
 122     {
 123       u32 w0;
 124       u32 w1;
 125     } words;
 126     u64 raw;
 127   };
 128 } pppoe_entry_key_t;
 129
 130 /*
 131  * The PPPoE entry results
 132  */
 133 typedef struct
 134 {
 135   union
 136   {
 137     struct
 138     {
 139       u32 sw_if_index;
 140
 141       u32 session_index;
 142
 143     } fields;
 144     u64 raw;
 145   };
 146 }  pppoe_entry_result_t;
 147
 148 typedef struct
 149 {
 150   /* Vector of encap session instances, */
 151   pppoe_session_t *sessions;
 152
 153   /* For CP:  vector of CP path */
 154     BVT (clib_bihash) link_table;
 155
 156   /* For DP:  vector of DP path */
 157     BVT (clib_bihash) session_table;
 158
 159   /* Free vlib hw_if_indices */
 160   u32 *free_pppoe_session_hw_if_indices;
 161
 162   /* Mapping from sw_if_index to session index */
 163   u32 *session_index_by_sw_if_index;
 164
 165   /* used for pppoe cp path */
 166   u32 cp_if_index;
 167
 168   /* API message ID base */
 169   u16 msg_id_base;
 170
 171   /* convenience */
 172   vlib_main_t *vlib_main;
 173   vnet_main_t *vnet_main;
 174
 175 } pppoe_main_t;
 176
 177 extern pppoe_main_t pppoe_main;
 178
 179 extern vlib_node_registration_t pppoe_input_node;
 180 extern vlib_node_registration_t pppoe_cp_dispatch_node;
 181
 182 typedef struct
 183 {
 184   u8 is_add;
 185   u8 is_ip6;
 186   u16 session_id;
 187   ip46_address_t client_ip;
 188   u32 encap_if_index;
 189   u32 decap_fib_index;
 190   u8 local_mac[6];
 191   u8 client_mac[6];
 192 } vnet_pppoe_add_del_session_args_t;
 193
 194 int vnet_pppoe_add_del_session
 195   (vnet_pppoe_add_del_session_args_t * a, u32 * sw_if_indexp);
 196
 197 typedef struct
 198 {
 199   u8 is_add;
 200   u32 client_if_index;
 201   u32 cp_if_index;
 202 } vnet_pppoe_add_del_tap_args_t;
 203
 204 int pppoe_add_del_cp (u32 cp_if_index, u8 is_add);
 205
 206 always_inline u64
 207 pppoe_make_key (u8 * mac_address, u16 session_id)
 208 {
 209   u64 temp;
 210
 211   /*
 212    * The mac address in memory is A:B:C:D:E:F
 213    * The session_id in register is H:L
 214    */
 215 #if CLIB_ARCH_IS_LITTLE_ENDIAN
 216   /*
 217    * Create the in-register key as F:E:D:C:B:A:H:L
 218    * In memory the key is L:H:A:B:C:D:E:F
 219    */
 220   temp = *((u64 *) (mac_address)) << 16;
 221   temp = (temp & ~0xffff) | (u64) (session_id);
 222 #else
 223   /*
 224    * Create the in-register key as H:L:A:B:C:D:E:F
 225    * In memory the key is H:L:A:B:C:D:E:F
 226    */
 227   temp = *((u64 *) (mac_address)) >> 16;
 228   temp = temp | (((u64) session_id) << 48);
 229 #endif
 230
 231   return temp;
 232 }
 233
 234 /**
 235  * Perform learning on one packet based on the mac table lookup result.
 236  * */
 237 static_always_inline void
 238 pppoe_learn_process (BVT (clib_bihash) * table,
 239                      u32 sw_if_index0,
 240                      pppoe_entry_key_t * key0,
 241                      pppoe_entry_key_t * cached_key,
 242                      u32 * bucket0, pppoe_entry_result_t * result0)
 243 {
 244   /* Check mac table lookup result */
 245   if (PREDICT_TRUE (result0->fields.sw_if_index == sw_if_index0))
 246     {
 247       /*
 248        * The entry was in the table, and the sw_if_index matched, the normal case
 249        */
 250       return;
 251     }
 252   else if (result0->fields.sw_if_index == ~0)
 253     {
 254       /* The entry was not in table, so add it  */
 255       result0->fields.sw_if_index = sw_if_index0;
 256       result0->fields.session_index = ~0;
 257       cached_key->raw = ~0;     /* invalidate the cache */
 258     }
 259   else
 260     {
 261       /* The entry was in the table, but with the wrong sw_if_index mapping (mac move) */
 262       result0->fields.sw_if_index = sw_if_index0;
 263     }
 264
 265   /* Update the entry */
 266   BVT (clib_bihash_kv) kv;
 267   kv.key = key0->raw;
 268   kv.value = result0->raw;
 269   BV (clib_bihash_add_del) (table, &kv, 1 /* is_add */ );
 270 }
 271
 272 static_always_inline void
 273 pppoe_lookup_1 (BVT (clib_bihash) * table,
 274                 pppoe_entry_key_t * cached_key,
 275                 pppoe_entry_result_t * cached_result,
 276                 u8 * mac0,
 277                 u16 session_id0,
 278                 pppoe_entry_key_t * key0,
 279                 u32 * bucket0, pppoe_entry_result_t * result0)
 280 {
 281   /* set up key */
 282   key0->raw = pppoe_make_key (mac0, session_id0);
 283   *bucket0 = ~0;
 284
 285   if (key0->raw == cached_key->raw)
 286     {
 287       /* Hit in the one-entry cache */
 288       result0->raw = cached_result->raw;
 289     }
 290   else
 291     {
 292       /* Do a regular session table lookup */
 293       BVT (clib_bihash_kv) kv;
 294
 295       kv.key = key0->raw;
 296       kv.value = ~0ULL;
 297       BV (clib_bihash_search_inline) (table, &kv);
 298       result0->raw = kv.value;
 299
 300       /* Update one-entry cache */
 301       cached_key->raw = key0->raw;
 302       cached_result->raw = result0->raw;
 303     }
 304 }
 305
 306 static_always_inline void
 307 pppoe_update_1 (BVT (clib_bihash) * table,
 308                 u8 * mac0,
 309                 u16 session_id0,
 310                 pppoe_entry_key_t * key0,
 311                 u32 * bucket0, pppoe_entry_result_t * result0)
 312 {
 313   /* set up key */
 314   key0->raw = pppoe_make_key (mac0, session_id0);
 315   *bucket0 = ~0;
 316
 317   /* Update the entry */
 318   BVT (clib_bihash_kv) kv;
 319   kv.key = key0->raw;
 320   kv.value = result0->raw;
 321   BV (clib_bihash_add_del) (table, &kv, 1 /* is_add */ );
 322
 323 }
 324 #endif /* _PPPOE_H */
 325
 326 /*
 327  * fd.io coding-style-patch-verification: ON
 328  *
 329  * Local Variables:
 330  * eval: (c-set-style "gnu")
 331  * End:
 332  */