src/vnet/fib/fib_entry_src_rr.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 <vlib/vlib.h>
  17 #include <vnet/ip/format.h>
  18 #include <vnet/ip/lookup.h>
  19 #include <vnet/adj/adj.h>
  20 #include <vnet/dpo/drop_dpo.h>
  21
  22 #include "fib_entry_src.h"
  23 #include "fib_entry_src_rr.h"
  24 #include "fib_entry_cover.h"
  25 #include "fib_entry.h"
  26 #include "fib_table.h"
  27
  28 /*
  29  * fib_entry_src_rr_resolve_via_connected
  30  *
  31  * Resolve via a connected cover.
  32  */
  33 void
  34 fib_entry_src_rr_resolve_via_connected (fib_entry_src_t *src,
  35                                         const fib_entry_t *fib_entry,
  36                                         const fib_entry_t *cover)
  37 {
  38     const fib_route_path_t path = {
  39         .frp_proto = fib_proto_to_dpo(fib_entry->fe_prefix.fp_proto),
  40         .frp_addr = fib_entry->fe_prefix.fp_addr,
  41         .frp_sw_if_index = fib_entry_get_resolving_interface(
  42                                fib_entry_get_index(cover)),
  43         .frp_fib_index = ~0,
  44         .frp_weight = 1,
  45     };
  46     fib_route_path_t *paths = NULL;
  47     vec_add1(paths, path);
  48
  49     /*
  50      * since the cover is connected, the address this entry corresponds
  51      * to is a peer (ARP-able for) on the interface to which the cover is
  52      * connected. The fact we resolve via the cover, just means this RR
  53      * source is the first SRC to use said peer. The ARP source will be along
  54      * shortly to over-rule this RR source.
  55      */
  56     src->fes_pl = fib_path_list_create(FIB_PATH_LIST_FLAG_NONE, paths);
  57     src->fes_entry_flags |= (fib_entry_get_flags(fib_entry_get_index(cover)) &
  58                              FIB_ENTRY_FLAGS_RR_INHERITED);
  59
  60     vec_free(paths);
  61 }
  62
  63
  64 /**
  65  * Source initialisation Function
  66  */
  67 static void
  68 fib_entry_src_rr_init (fib_entry_src_t *src)
  69 {
  70     src->u.rr.fesr_cover = FIB_NODE_INDEX_INVALID;
  71     src->u.rr.fesr_sibling = FIB_NODE_INDEX_INVALID;
  72 }
  73
  74
  75 /*
  76  * use the path-list of the cover, unless it would form a loop.
  77  * that is unless the cover is via this entry.
  78  * If a loop were to form it would be a 1 level loop (i.e. X via X),
  79  * and there would be 2 locks on the path-list; one since its used
  80  * by the cover, and 1 from here. The first lock will go when the
  81  * cover is removed, the second, and last, when the covered walk
  82  * occurs during the cover's removel - this is not a place where
  83  * we can handle last lock gone.
  84  * In short, don't let the loop form. The usual rules of 'we must
  85  * let it form so we know when it breaks' don't apply here, since
  86  * the loop will break when the cover changes, and this function
  87  * will be called again when that happens.
  88  */
  89 void
  90 fib_entry_src_rr_use_covers_pl (fib_entry_src_t *src,
  91                                 const fib_entry_t *fib_entry,
  92                                 const fib_entry_t *cover)
  93 {
  94     fib_node_index_t *entries = NULL;
  95     dpo_proto_t proto;
  96
  97     proto = fib_proto_to_dpo(fib_entry->fe_prefix.fp_proto);
  98     vec_add1(entries, fib_entry_get_index(fib_entry));
  99
 100     if (fib_path_list_recursive_loop_detect(cover->fe_parent,
 101                                             &entries))
 102     {
 103         src->fes_pl = fib_path_list_create_special(proto,
 104                                                    FIB_PATH_LIST_FLAG_DROP,
 105                                                    drop_dpo_get(proto));
 106     }
 107     else
 108     {
 109         src->fes_pl = cover->fe_parent;
 110     }
 111     vec_free(entries);
 112 }
 113
 114 /*
 115  * Source activation. Called when the source is the new best source on the entry
 116  */
 117 static int
 118 fib_entry_src_rr_activate (fib_entry_src_t *src,
 119                            const fib_entry_t *fib_entry)
 120 {
 121     fib_entry_t *cover;
 122
 123     /*
 124      * find the covering prefix. become a dependent thereof.
 125      * for IP there should always be a cover, though it may be the default route.
 126      * For MPLS there is never a cover.
 127      */
 128     if (FIB_PROTOCOL_MPLS == fib_entry->fe_prefix.fp_proto)
 129     {
 130         src->fes_pl = fib_path_list_create_special(DPO_PROTO_MPLS,
 131                                                    FIB_PATH_LIST_FLAG_DROP,
 132                                                    NULL);
 133         fib_path_list_lock(src->fes_pl);
 134         return (!0);
 135     }
 136
 137     src->u.rr.fesr_cover = fib_table_get_less_specific(fib_entry->fe_fib_index,
 138                                                      &fib_entry->fe_prefix);
 139
 140     ASSERT(FIB_NODE_INDEX_INVALID != src->u.rr.fesr_cover);
 141
 142     cover = fib_entry_get(src->u.rr.fesr_cover);
 143
 144     src->u.rr.fesr_sibling =
 145         fib_entry_cover_track(cover, fib_entry_get_index(fib_entry));
 146
 147     /*
 148      * if the cover is attached then install an attached-host path
 149      * (like an adj-fib). Otherwise inherit the forwarding from the cover
 150      */
 151     if (FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags_i(cover))
 152     {
 153         fib_entry_src_rr_resolve_via_connected(src, fib_entry, cover);
 154     }
 155     else
 156     {
 157         fib_entry_src_rr_use_covers_pl(src, fib_entry, cover);
 158     }
 159     fib_path_list_lock(src->fes_pl);
 160
 161     /*
 162      * return go for install
 163      */
 164     return (!0);
 165 }
 166
 167 /**
 168  * Source Deactivate.
 169  * Called when the source is no longer best source on the entry
 170  */
 171 static void
 172 fib_entry_src_rr_deactivate (fib_entry_src_t *src,
 173                              const fib_entry_t *fib_entry)
 174 {
 175     fib_entry_t *cover;
 176
 177     /*
 178      * remove the depednecy on the covering entry
 179      */
 180     if (FIB_NODE_INDEX_INVALID != src->u.rr.fesr_cover)
 181     {
 182         cover = fib_entry_get(src->u.rr.fesr_cover);
 183         fib_entry_cover_untrack(cover, src->u.rr.fesr_sibling);
 184         src->u.rr.fesr_cover = FIB_NODE_INDEX_INVALID;
 185     }
 186
 187     fib_path_list_unlock(src->fes_pl);
 188     src->fes_pl = FIB_NODE_INDEX_INVALID;
 189     src->fes_entry_flags = FIB_ENTRY_FLAG_NONE;
 190 }
 191
 192 fib_entry_src_cover_res_t
 193 fib_entry_src_rr_cover_change (fib_entry_src_t *src,
 194                                const fib_entry_t *fib_entry)
 195 {
 196     fib_entry_src_cover_res_t res = {
 197         .install = !0,
 198         .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
 199     };
 200
 201     if (FIB_NODE_INDEX_INVALID == src->u.rr.fesr_cover)
 202     {
 203         /*
 204          * the source may be added, but it is not active
 205          * if it is not tracking the cover.
 206          */
 207         return (res);
 208     }
 209
 210     /*
 211      * this function is called when this entry's cover has a more specific
 212      * entry inserted benaeth it. That does not necessarily mean that this
 213      * entry is covered by the new prefix. check that
 214      */
 215     if (src->u.rr.fesr_cover != fib_table_get_less_specific(fib_entry->fe_fib_index,
 216                                                           &fib_entry->fe_prefix))
 217     {
 218         fib_entry_src_rr_deactivate(src, fib_entry);
 219         fib_entry_src_rr_activate(src, fib_entry);
 220
 221         /*
 222          * dependent children need to re-resolve to the new forwarding info
 223          */
 224         res.bw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE;
 225     }
 226     return (res);
 227 }
 228
 229 /*
 230  * fib_entry_src_rr_cover_update
 231  *
 232  * This entry's cover has updated its forwarding info. This entry
 233  * will need to re-inheret.
 234  */
 235 fib_entry_src_cover_res_t
 236 fib_entry_src_rr_cover_update (fib_entry_src_t *src,
 237                                const fib_entry_t *fib_entry)
 238 {
 239     fib_entry_src_cover_res_t res = {
 240         .install = !0,
 241         .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
 242     };
 243     fib_node_index_t old_path_list;
 244     fib_entry_t *cover;
 245
 246     if (FIB_NODE_INDEX_INVALID == src->u.rr.fesr_cover)
 247     {
 248         /*
 249          * the source may be added, but it is not active
 250          * if it is not tracking the cover.
 251          */
 252         return (res);
 253     }
 254
 255     cover = fib_entry_get(src->u.rr.fesr_cover);
 256     old_path_list = src->fes_pl;
 257
 258     /*
 259      * if the ocver is attached then install an attached-host path
 260      * (like an adj-fib). Otherwise inherit the forwarding from the cover
 261      */
 262     if (FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags_i(cover))
 263     {
 264         fib_entry_src_rr_resolve_via_connected(src, fib_entry, cover);
 265     }
 266     else
 267     {
 268         fib_entry_src_rr_use_covers_pl(src, fib_entry, cover);
 269     }
 270     fib_path_list_lock(src->fes_pl);
 271     fib_path_list_unlock(old_path_list);
 272
 273     /*
 274      * dependent children need to re-resolve to the new forwarding info
 275      */
 276     res.bw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE;
 277
 278     return (res);
 279 }
 280
 281 static u8*
 282 fib_entry_src_rr_format (fib_entry_src_t *src,
 283                          u8* s)
 284 {
 285     return (format(s, " cover:%d", src->u.rr.fesr_cover));
 286 }
 287
 288 const static fib_entry_src_vft_t rr_src_vft = {
 289     .fesv_init = fib_entry_src_rr_init,
 290     .fesv_activate = fib_entry_src_rr_activate,
 291     .fesv_deactivate = fib_entry_src_rr_deactivate,
 292     .fesv_cover_change = fib_entry_src_rr_cover_change,
 293     .fesv_cover_update = fib_entry_src_rr_cover_update,
 294     .fesv_format = fib_entry_src_rr_format,
 295 };
 296
 297 void
 298 fib_entry_src_rr_register (void)
 299 {
 300     fib_entry_src_register(FIB_SOURCE_RR, &rr_src_vft);
 301     fib_entry_src_register(FIB_SOURCE_URPF_EXEMPT, &rr_src_vft);
 302 }