src/vnet/adj/adj_mcast.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <vnet/adj/adj.h>
  17 #include <vnet/adj/adj_internal.h>
  18 #include <vnet/fib/fib_walk.h>
  19 #include <vnet/ip/ip.h>
  20
  21 /*
  22  * The 'DB' of all mcast adjs.
  23  * There is only one mcast per-interface per-protocol, so this is a per-interface
  24  * vector
  25  */
  26 static adj_index_t *adj_mcasts[FIB_PROTOCOL_MAX];
  27
  28 static u32
  29 adj_get_mcast_node (fib_protocol_t proto)
  30 {
  31     switch (proto) {
  32     case FIB_PROTOCOL_IP4:
  33         return (ip4_rewrite_mcast_node.index);
  34     case FIB_PROTOCOL_IP6:
  35         return (ip6_rewrite_mcast_node.index);
  36     case FIB_PROTOCOL_MPLS:
  37         break;
  38     }
  39     ASSERT(0);
  40     return (0);
  41 }
  42
  43 /*
  44  * adj_mcast_add_or_lock
  45  *
  46  * The next_hop address here is used for source address selection in the DP.
  47  * The mcast adj is added to an interface's connected prefix, the next-hop
  48  * passed here is the local prefix on the same interface.
  49  */
  50 adj_index_t
  51 adj_mcast_add_or_lock (fib_protocol_t proto,
  52                        vnet_link_t link_type,
  53                        u32 sw_if_index)
  54 {
  55     ip_adjacency_t * adj;
  56
  57     vec_validate_init_empty(adj_mcasts[proto], sw_if_index, ADJ_INDEX_INVALID);
  58
  59     if (ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
  60     {
  61         vnet_main_t *vnm;
  62
  63         vnm = vnet_get_main();
  64         adj = adj_alloc(proto);
  65
  66         adj->lookup_next_index = IP_LOOKUP_NEXT_MCAST;
  67         adj->ia_nh_proto = proto;
  68         adj->ia_link = link_type;
  69         adj_mcasts[proto][sw_if_index] = adj_get_index(adj);
  70         adj_lock(adj_get_index(adj));
  71
  72         vnet_rewrite_init(vnm, sw_if_index,
  73                           adj_get_mcast_node(proto),
  74                           vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
  75                           &adj->rewrite_header);
  76
  77         /*
  78          * we need a rewrite where the destination IP address is converted
  79          * to the appropriate link-layer address. This is interface specific.
  80          * So ask the interface to do it.
  81          */
  82         vnet_update_adjacency_for_sw_interface(vnm, sw_if_index,
  83                                                adj_get_index(adj));
  84     }
  85     else
  86     {
  87         adj = adj_get(adj_mcasts[proto][sw_if_index]);
  88         adj_lock(adj_get_index(adj));
  89     }
  90
  91     return (adj_get_index(adj));
  92 }
  93
  94 /**
  95  * adj_mcast_update_rewrite
  96  *
  97  * Update the adjacency's rewrite string. A NULL string implies the
  98  * rewirte is reset (i.e. when ARP/ND etnry is gone).
  99  * NB: the adj being updated may be handling traffic in the DP.
 100  */
 101 void
 102 adj_mcast_update_rewrite (adj_index_t adj_index,
 103                           u8 *rewrite)
 104 {
 105     ip_adjacency_t *adj;
 106
 107     ASSERT(ADJ_INDEX_INVALID != adj_index);
 108
 109     adj = adj_get(adj_index);
 110
 111     /*
 112      * update the adj's rewrite string and build the arc
 113      * from the rewrite node to the interface's TX node
 114      */
 115     adj_nbr_update_rewrite_internal(adj, IP_LOOKUP_NEXT_MCAST,
 116                                     adj_get_mcast_node(adj->ia_nh_proto),
 117                                     vnet_tx_node_index_for_sw_interface(
 118                                         vnet_get_main(),
 119                                         adj->rewrite_header.sw_if_index),
 120                                     rewrite);
 121 }
 122
 123 void
 124 adj_mcast_remove (fib_protocol_t proto,
 125                   u32 sw_if_index)
 126 {
 127     ASSERT(sw_if_index < vec_len(adj_mcasts[proto]));
 128
 129     adj_mcasts[proto][sw_if_index] = ADJ_INDEX_INVALID;
 130 }
 131
 132 static clib_error_t *
 133 adj_mcast_interface_state_change (vnet_main_t * vnm,
 134                                   u32 sw_if_index,
 135                                   u32 flags)
 136 {
 137     /*
 138      * for each mcast on the interface trigger a walk back to the children
 139      */
 140     fib_protocol_t proto;
 141     ip_adjacency_t *adj;
 142
 143
 144     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 145     {
 146         if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
 147             ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
 148             continue;
 149
 150         adj = adj_get(adj_mcasts[proto][sw_if_index]);
 151
 152         fib_node_back_walk_ctx_t bw_ctx = {
 153             .fnbw_reason = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
 154                             FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
 155                             FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
 156         };
 157
 158         fib_walk_sync(FIB_NODE_TYPE_ADJ, adj_get_index(adj), &bw_ctx);
 159     }
 160
 161     return (NULL);
 162 }
 163
 164 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_mcast_interface_state_change);
 165
 166 /**
 167  * @brief Invoked on each SW interface of a HW interface when the
 168  * HW interface state changes
 169  */
 170 static void
 171 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
 172                                       u32 sw_if_index,
 173                                       void *arg)
 174 {
 175     adj_mcast_interface_state_change(vnm, sw_if_index, (uword) arg);
 176 }
 177
 178 /**
 179  * @brief Registered callback for HW interface state changes
 180  */
 181 static clib_error_t *
 182 adj_mcast_hw_interface_state_change (vnet_main_t * vnm,
 183                                      u32 hw_if_index,
 184                                      u32 flags)
 185 {
 186     /*
 187      * walk SW interfaces on the HW
 188      */
 189     uword sw_flags;
 190
 191     sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
 192                 VNET_SW_INTERFACE_FLAG_ADMIN_UP :
 193                 0);
 194
 195     vnet_hw_interface_walk_sw(vnm, hw_if_index,
 196                               adj_nbr_hw_sw_interface_state_change,
 197                               (void*) sw_flags);
 198
 199     return (NULL);
 200 }
 201
 202 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(
 203     adj_mcast_hw_interface_state_change);
 204
 205 static clib_error_t *
 206 adj_mcast_interface_delete (vnet_main_t * vnm,
 207                             u32 sw_if_index,
 208                             u32 is_add)
 209 {
 210     /*
 211      * for each mcast on the interface trigger a walk back to the children
 212      */
 213     fib_protocol_t proto;
 214     ip_adjacency_t *adj;
 215
 216     if (is_add)
 217     {
 218         /*
 219          * not interested in interface additions. we will not back walk
 220          * to resolve paths through newly added interfaces. Why? The control
 221          * plane should have the brains to add interfaces first, then routes.
 222          * So the case where there are paths with a interface that matches
 223          * one just created is the case where the path resolved through an
 224          * interface that was deleted, and still has not been removed. The
 225          * new interface added, is NO GUARANTEE that the interface being
 226          * added now, even though it may have the same sw_if_index, is the
 227          * same interface that the path needs. So tough!
 228          * If the control plane wants these routes to resolve it needs to
 229          * remove and add them again.
 230          */
 231         return (NULL);
 232     }
 233
 234     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 235     {
 236         if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
 237             ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
 238             continue;
 239
 240         adj = adj_get(adj_mcasts[proto][sw_if_index]);
 241
 242         fib_node_back_walk_ctx_t bw_ctx = {
 243             .fnbw_reason =  FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
 244         };
 245
 246         fib_walk_sync(FIB_NODE_TYPE_ADJ, adj_get_index(adj), &bw_ctx);
 247     }
 248
 249     return (NULL);
 250 }
 251
 252 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_mcast_interface_delete);
 253
 254 u8*
 255 format_adj_mcast (u8* s, va_list *ap)
 256 {
 257     index_t index = va_arg(*ap, index_t);
 258     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 259     vnet_main_t * vnm = vnet_get_main();
 260     ip_adjacency_t * adj = adj_get(index);
 261
 262     s = format(s, "%U-mcast: ",
 263                format_fib_protocol, adj->ia_nh_proto);
 264     s = format (s, "%U",
 265                 format_vnet_rewrite,
 266                 vnm->vlib_main, &adj->rewrite_header,
 267                 sizeof (adj->rewrite_data), 0);
 268
 269     return (s);
 270 }
 271
 272
 273 static void
 274 adj_dpo_lock (dpo_id_t *dpo)
 275 {
 276     adj_lock(dpo->dpoi_index);
 277 }
 278 static void
 279 adj_dpo_unlock (dpo_id_t *dpo)
 280 {
 281     adj_unlock(dpo->dpoi_index);
 282 }
 283
 284 const static dpo_vft_t adj_mcast_dpo_vft = {
 285     .dv_lock = adj_dpo_lock,
 286     .dv_unlock = adj_dpo_unlock,
 287     .dv_format = format_adj_mcast,
 288 };
 289
 290 /**
 291  * @brief The per-protocol VLIB graph nodes that are assigned to a mcast
 292  *        object.
 293  *
 294  * this means that these graph nodes are ones from which a mcast is the
 295  * parent object in the DPO-graph.
 296  */
 297 const static char* const adj_mcast_ip4_nodes[] =
 298 {
 299     "ip4-rewrite-mcast",
 300     NULL,
 301 };
 302 const static char* const adj_mcast_ip6_nodes[] =
 303 {
 304     "ip6-rewrite-mcast",
 305     NULL,
 306 };
 307
 308 const static char* const * const adj_mcast_nodes[DPO_PROTO_NUM] =
 309 {
 310     [DPO_PROTO_IP4]  = adj_mcast_ip4_nodes,
 311     [DPO_PROTO_IP6]  = adj_mcast_ip6_nodes,
 312     [DPO_PROTO_MPLS] = NULL,
 313 };
 314
 315 /**
 316  * @brief Return the size of the adj DB.
 317  * This is only for testing purposes so an efficient implementation is not needed
 318  */
 319 u32
 320 adj_mcast_db_size (void)
 321 {
 322     u32 n_adjs, sw_if_index;
 323     fib_protocol_t proto;
 324
 325     n_adjs = 0;
 326     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 327     {
 328         for (sw_if_index = 0;
 329              sw_if_index < vec_len(adj_mcasts[proto]);
 330              sw_if_index++)
 331         {
 332             if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
 333             {
 334                 n_adjs++;
 335             }
 336         }
 337     }
 338
 339     return (n_adjs);
 340 }
 341
 342 void
 343 adj_mcast_module_init (void)
 344 {
 345     dpo_register(DPO_ADJACENCY_MCAST, &adj_mcast_dpo_vft, adj_mcast_nodes);
 346 }