src/vnet/dpo/replicate_dpo.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
  17  *
  18  */
  19
  20 #ifndef __REPLICATE_DPO_H__
  21 #define __REPLICATE_DPO_H__
  22
  23 #include <vlib/vlib.h>
  24 #include <vnet/ip/lookup.h>
  25 #include <vnet/dpo/dpo.h>
  26 #include <vnet/dpo/load_balance.h>
  27 #include <vnet/fib/fib_types.h>
  28 #include <vnet/mpls/mpls_types.h>
  29
  30 /**
  31  * replicate main
  32  */
  33 typedef struct replicate_main_t_
  34 {
  35     vlib_combined_counter_main_t repm_counters;
  36
  37     /* per-cpu vector of cloned packets */
  38     u32 **clones;
  39 } replicate_main_t;
  40
  41 extern replicate_main_t replicate_main;
  42
  43 /**
  44  * The number of buckets that a load-balance object can have and still
  45  * fit in one cache-line
  46  */
  47 #define REP_NUM_INLINE_BUCKETS 4
  48
  49 /**
  50  * The FIB DPO provieds;
  51  *  - load-balancing over the next DPOs in the chain/graph
  52  *  - per-route counters
  53  */
  54 typedef struct replicate_t_ {
  55     /**
  56      * number of buckets in the replicate.
  57      */
  58     u16 rep_n_buckets;
  59
  60    /**
  61      * The protocol of packets that traverse this REP.
  62      * need in combination with the flow hash config to determine how to hash.
  63      * u8.
  64      */
  65     dpo_proto_t rep_proto;
  66
  67     /**
  68      * The number of locks, which is approximately the number of users,
  69      * of this load-balance.
  70      * Load-balance objects of via-entries are heavily shared by recursives,
  71      * so the lock count is a u32.
  72      */
  73     u32 rep_locks;
  74
  75     /**
  76      * Vector of buckets containing the next DPOs, sized as repo_num
  77      */
  78     dpo_id_t *rep_buckets;
  79
  80     /**
  81      * The rest of the cache line is used for buckets. In the common case
  82      * where there there are less than 4 buckets, then the buckets are
  83      * on the same cachlie and we save ourselves a pointer dereferance in
  84      * the data-path.
  85      */
  86     dpo_id_t rep_buckets_inline[REP_NUM_INLINE_BUCKETS];
  87 } replicate_t;
  88
  89 STATIC_ASSERT(sizeof(replicate_t) <= CLIB_CACHE_LINE_BYTES,
  90               "A replicate object size exceeds one cachline");
  91
  92 /**
  93  * Flags controlling load-balance formatting/display
  94  */
  95 typedef enum replicate_format_flags_t_ {
  96     REPLICATE_FORMAT_NONE,
  97     REPLICATE_FORMAT_DETAIL = (1 << 0),
  98 } replicate_format_flags_t;
  99
 100 extern index_t replicate_create(u32 num_buckets,
 101                                 dpo_proto_t rep_proto);
 102 extern void replicate_multipath_update(
 103     const dpo_id_t *dpo,
 104     load_balance_path_t *next_hops);
 105
 106 extern void replicate_set_bucket(index_t repi,
 107                                  u32 bucket,
 108                                  const dpo_id_t *next);
 109
 110 extern u8* format_replicate(u8 * s, va_list * args);
 111
 112 extern const dpo_id_t *replicate_get_bucket(index_t repi,
 113                                             u32 bucket);
 114 extern int replicate_is_drop(const dpo_id_t *dpo);
 115
 116 extern u16 replicate_n_buckets(index_t repi);
 117
 118 /**
 119  * The encapsulation breakages are for fast DP access
 120  */
 121 extern replicate_t *replicate_pool;
 122 static inline replicate_t*
 123 replicate_get (index_t repi)
 124 {
 125     repi &= ~MPLS_IS_REPLICATE;
 126     return (pool_elt_at_index(replicate_pool, repi));
 127 }
 128
 129 #define REP_HAS_INLINE_BUCKETS(_rep)            \
 130     ((_rep)->rep_n_buckets <= REP_NUM_INLINE_BUCKETS)
 131
 132 static inline const dpo_id_t *
 133 replicate_get_bucket_i (const replicate_t *rep,
 134                            u32 bucket)
 135 {
 136     ASSERT(bucket < rep->rep_n_buckets);
 137
 138     if (PREDICT_TRUE(REP_HAS_INLINE_BUCKETS(rep)))
 139     {
 140         return (&rep->rep_buckets_inline[bucket]);
 141     }
 142     else
 143     {
 144         return (&rep->rep_buckets[bucket]);
 145     }
 146 }
 147
 148 extern void replicate_module_init(void);
 149
 150 #endif