vnet/vnet/l2tp/decap.c

   1 /*
   2  * decap.c : L2TPv3 tunnel decapsulation
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vppinfra/error.h>
  19 #include <vppinfra/hash.h>
  20 #include <vnet/vnet.h>
  21 #include <vnet/ip/ip.h>
  22 #include <vnet/ethernet/ethernet.h>
  23 #include <vnet/l2tp/l2tp.h>
  24
  25 /* Statistics (not really errors) */
  26 #define foreach_l2t_decap_error                                   \
  27 _(USER_TO_NETWORK, "L2TP user (ip6) to L2 network pkts")        \
  28 _(SESSION_ID_MISMATCH, "l2tpv3 local session id mismatches")    \
  29 _(COOKIE_MISMATCH, "l2tpv3 local cookie mismatches")
  30
  31 static char * l2t_decap_error_strings[] = {
  32 #define _(sym,string) string,
  33   foreach_l2t_decap_error
  34 #undef _
  35 };
  36
  37 typedef enum {
  38 #define _(sym,str) L2T_DECAP_ERROR_##sym,
  39     foreach_l2t_decap_error
  40 #undef _
  41     L2T_DECAP_N_ERROR,
  42 } l2t_DECAP_error_t;
  43
  44 typedef enum {
  45     L2T_DECAP_NEXT_DROP,
  46     L2T_DECAP_NEXT_L2_INPUT,
  47     L2T_DECAP_N_NEXT,
  48     /* Pseudo next index */
  49     L2T_DECAP_NEXT_NO_INTERCEPT = L2T_DECAP_N_NEXT,
  50 } l2t_decap_next_t;
  51
  52 #define NSTAGES 3
  53
  54 static inline void stage0 (vlib_main_t * vm,
  55                            vlib_node_runtime_t * node,
  56                            u32 buffer_index)
  57 {
  58     vlib_buffer_t *b = vlib_get_buffer (vm, buffer_index);
  59     vlib_prefetch_buffer_header (b, STORE);
  60     /* l2tpv3 header is a long way away, need 2 cache lines */
  61     CLIB_PREFETCH (b->data, 2*CLIB_CACHE_LINE_BYTES, STORE);
  62 }
  63
  64 static inline void stage1 (vlib_main_t * vm,
  65                            vlib_node_runtime_t * node,
  66                            u32 bi)
  67 {
  68     vlib_buffer_t *b = vlib_get_buffer (vm, bi);
  69     l2t_main_t *lm = &l2t_main;
  70     ip6_header_t * ip6 = vlib_buffer_get_current (b);
  71     u32 session_index;
  72     uword *p = 0;
  73     l2tpv3_header_t * l2t;
  74
  75     /* Not L2tpv3 (0x73, 0t115)? Use the normal path. */
  76     if (PREDICT_FALSE(ip6->protocol != IP_PROTOCOL_L2TP)) {
  77         vnet_buffer(b)->l2t.next_index = L2T_DECAP_NEXT_NO_INTERCEPT;
  78         return;
  79     }
  80
  81     /* Make up your minds, people... */
  82     switch (lm->lookup_type) {
  83     case L2T_LOOKUP_SRC_ADDRESS:
  84         p = hash_get_mem (lm->session_by_src_address, &ip6->src_address);
  85         break;
  86     case L2T_LOOKUP_DST_ADDRESS:
  87         p = hash_get_mem (lm->session_by_dst_address, &ip6->dst_address);
  88         break;
  89     case L2T_LOOKUP_SESSION_ID:
  90         l2t = (l2tpv3_header_t*)(ip6+1);
  91         p = hash_get (lm->session_by_session_id, l2t->session_id);
  92         break;
  93     default:
  94         ASSERT(0);
  95     }
  96
  97     if (PREDICT_FALSE(p == 0)) {
  98         vnet_buffer(b)->l2t.next_index = L2T_DECAP_NEXT_NO_INTERCEPT;
  99         return;
 100     } else {
 101         session_index = p[0];
 102     }
 103
 104     /* Remember mapping index, prefetch the mini counter */
 105     vnet_buffer(b)->l2t.next_index = L2T_DECAP_NEXT_L2_INPUT;
 106     vnet_buffer(b)->l2t.session_index = session_index;
 107
 108     /* $$$$$ prefetch counter */
 109 }
 110
 111 static inline u32 last_stage (vlib_main_t *vm, vlib_node_runtime_t *node,
 112                               u32 bi)
 113 {
 114     vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 115     l2t_main_t *lm = &l2t_main;
 116     ip6_header_t * ip6 = vlib_buffer_get_current (b);
 117     vlib_node_t *n = vlib_get_node (vm, l2t_decap_node.index);
 118     u32 node_counter_base_index = n->error_heap_index;
 119     vlib_error_main_t * em = &vm->error_main;
 120     l2tpv3_header_t * l2tp;
 121     u32 counter_index;
 122     l2t_session_t * session;
 123     u32 session_index;
 124     u32 next_index;
 125
 126     /* Other-than-output pkt? We're done... */
 127     if (vnet_buffer(b)->l2t.next_index != L2T_DECAP_NEXT_L2_INPUT) {
 128       next_index = vnet_buffer(b)->l2t.next_index;
 129       goto done;
 130     }
 131
 132     em->counters[node_counter_base_index + L2T_DECAP_ERROR_USER_TO_NETWORK] += 1;
 133
 134     session_index = vnet_buffer(b)->l2t.session_index;
 135
 136     counter_index =
 137         session_index_to_counter_index (session_index,
 138                                         SESSION_COUNTER_USER_TO_NETWORK);
 139
 140     /* per-mapping byte stats include the ethernet header */
 141     vlib_increment_combined_counter (&lm->counter_main,
 142                                      os_get_cpu_number(),
 143                                      counter_index,
 144                                      1 /* packet_increment */,
 145                                      vlib_buffer_length_in_chain (vm, b) +
 146                                      sizeof (ethernet_header_t));
 147
 148     session = pool_elt_at_index (lm->sessions, session_index);
 149
 150     l2tp = vlib_buffer_get_current (b) + sizeof (*ip6);
 151
 152     if (PREDICT_FALSE(l2tp->session_id != session->local_session_id)) {
 153       // Key matched but session id does not. Assume packet is not for us.
 154       em->counters[node_counter_base_index + L2T_DECAP_ERROR_SESSION_ID_MISMATCH] += 1;
 155       next_index = L2T_DECAP_NEXT_NO_INTERCEPT;
 156       goto done;
 157     }
 158
 159     if (PREDICT_FALSE (l2tp->cookie != session->local_cookie[0])) {
 160         if (l2tp->cookie != session->local_cookie[1]) {
 161             // Key and session ID matched, but cookie doesn't. Drop this packet.
 162             b->error = node->errors[L2T_DECAP_ERROR_COOKIE_MISMATCH];
 163             next_index = L2T_DECAP_NEXT_DROP;
 164             goto done;
 165         }
 166     }
 167
 168     vnet_buffer(b)->sw_if_index[VLIB_RX] = session->sw_if_index;
 169
 170     /* strip the ip6 and L2TP header */
 171     vlib_buffer_advance (b, sizeof (*ip6) + session->l2tp_hdr_size);
 172
 173     /* Required to make the l2 tag push / pop code work on l2 subifs */
 174     vnet_update_l2_len (b);
 175
 176     if (PREDICT_FALSE(b->flags & VLIB_BUFFER_IS_TRACED)) {
 177         l2t_trace_t *t = vlib_add_trace (vm, node, b, sizeof (*t));
 178         t->is_user_to_network = 1;
 179         t->our_address.as_u64[0] =
 180             ip6->dst_address.as_u64[0];
 181         t->our_address.as_u64[1] =
 182             ip6->dst_address.as_u64[1];
 183         t->client_address.as_u64[0] =
 184             ip6->src_address.as_u64[0];
 185         t->client_address.as_u64[1] =
 186             ip6->src_address.as_u64[1];
 187         t->session_index = session_index;
 188     }
 189
 190     return L2T_DECAP_NEXT_L2_INPUT;
 191
 192  done:
 193    if (next_index == L2T_DECAP_NEXT_NO_INTERCEPT) {
 194       // Go to next node on the ip6 configuration chain
 195       ip6_main_t * im = &ip6_main;
 196       ip_lookup_main_t * lm = &im->lookup_main;
 197       ip_config_main_t * cm = &lm->rx_config_mains[VNET_UNICAST];
 198       ip6_l2tpv3_config_t * c0;
 199
 200       vnet_get_config_data (&cm->config_main,
 201                             &b->current_config_index,
 202                             &next_index,
 203                             sizeof (c0[0]));
 204     }
 205
 206     if (PREDICT_FALSE(b->flags & VLIB_BUFFER_IS_TRACED)) {
 207         l2t_trace_t *t = vlib_add_trace (vm, node, b, sizeof (*t));
 208         t->is_user_to_network = 1;
 209         t->our_address.as_u64[0] =
 210             ip6->dst_address.as_u64[0];
 211         t->our_address.as_u64[1] =
 212             ip6->dst_address.as_u64[1];
 213         t->client_address.as_u64[0] =
 214             ip6->src_address.as_u64[0];
 215         t->client_address.as_u64[1] =
 216             ip6->src_address.as_u64[1];
 217         t->session_index = ~0;
 218     }
 219     return next_index;
 220 }
 221
 222 #include <vnet/pipeline.h>
 223
 224 static uword l2t_decap_node_fn (vlib_main_t * vm,
 225                               vlib_node_runtime_t * node,
 226                               vlib_frame_t * frame)
 227 {
 228     return dispatch_pipeline (vm, node, frame);
 229 }
 230
 231 VLIB_REGISTER_NODE (l2t_decap_node) = {
 232   .function = l2t_decap_node_fn,
 233   .name = "l2tp-decap",
 234   .vector_size = sizeof (u32),
 235   .format_trace = format_l2t_trace,
 236   .type = VLIB_NODE_TYPE_INTERNAL,
 237
 238   .n_errors = ARRAY_LEN(l2t_decap_error_strings),
 239   .error_strings = l2t_decap_error_strings,
 240
 241   .n_next_nodes = L2T_DECAP_N_NEXT,
 242
 243   /* edit / add dispositions here */
 244   .next_nodes = {
 245         [L2T_DECAP_NEXT_L2_INPUT] = "l2-input",
 246         [L2T_DECAP_NEXT_DROP] = "error-drop",
 247   },
 248 };
 249
 250 VLIB_NODE_FUNCTION_MULTIARCH (l2t_decap_node, l2t_decap_node_fn)
 251
 252 void l2tp_decap_init (void)
 253 {
 254   ip6_register_protocol (IP_PROTOCOL_L2TP, l2t_decap_node.index);
 255 }