src/vnet/bier/bier_fmask_db.h

   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  * @brief bier_fmask_db : The BIER fmask Database
  17  */
  18
  19 #ifndef __BIER_FMASK_DB_H__
  20 #define __BIER_FMASK_DB_H__
  21
  22 #include <vnet/ip/ip.h>
  23
  24 #include <vnet/fib/fib_types.h>
  25
  26 /**
  27  * BIER header encapulsation types
  28  */
  29 typedef enum bier_hdr_type_t_ {
  30     /**
  31      * BIER Header in MPLS networks
  32      */
  33     BIER_HDR_O_MPLS,
  34
  35     /**
  36      * BIER header in non-MPLS networks
  37      */
  38     BIER_HDR_O_OTHER,
  39 } __attribute__((packed)) bier_hdr_type_t;
  40
  41 /**
  42  * BIER next-hop type
  43  */
  44 typedef enum bier_nh_type_t_ {
  45     /**
  46      * BIER Header in MPLS networks
  47      */
  48     BIER_NH_IP,
  49
  50     /**
  51      * BIER header in non-MPLS networks
  52      */
  53     BIER_NH_UDP,
  54 } __attribute__((packed)) bier_nh_type_t;
  55
  56 /**
  57  * A key/ID for a BIER forwarding Mas (FMask).
  58  * This is a simplified version of a fib_route_path_t.
  59  */
  60 typedef struct bier_fmask_id_t_ {
  61     union {
  62         /**
  63          * next-hop of the peer
  64          */
  65         ip46_address_t bfmi_nh;
  66
  67         /**
  68          * ID of the next-hop object, e.g. a UDP-encap
  69          */
  70         u32 bfmi_id;
  71     };
  72     /**
  73      * The BIER table this fmask is in
  74      */
  75     index_t bfmi_bti;
  76
  77     /**
  78      * Type of BIER header this fmask supports
  79      */
  80     bier_hdr_type_t bfmi_hdr_type;
  81
  82     /**
  83      * Union discriminatrr
  84      */
  85     bier_nh_type_t bfmi_nh_type;
  86 } __attribute__((packed)) bier_fmask_id_t;
  87
  88 extern index_t
  89 bier_fmask_db_find_or_create_and_lock(index_t bti,
  90                                       const fib_route_path_t *rpath);
  91 extern index_t bier_fmask_db_find (index_t bti,
  92                                    const fib_route_path_t *rpath);
  93
  94 extern void bier_fmask_db_remove (const bier_fmask_id_t *fmid);
  95
  96 /**
  97  * Walk all the BIER fmasks
  98  */
  99 typedef walk_rc_t (*bier_fmask_walk_fn_t) (index_t bfmi, void *ctx);
 100
 101 extern void bier_fmask_db_walk(bier_fmask_walk_fn_t fn, void *ctx);
 102
 103 #endif