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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #ifndef __REPLICATE_DPO_H__
21 #define __REPLICATE_DPO_H__
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>
33 typedef struct replicate_main_t_
35 vlib_combined_counter_main_t repm_counters;
37 /* per-cpu vector of cloned packets */
41 extern replicate_main_t replicate_main;
44 * The number of buckets that a load-balance object can have and still
45 * fit in one cache-line
47 #define REP_NUM_INLINE_BUCKETS 4
50 * Flags on the replicate DPO
52 typedef enum replicate_flags_t_
55 REPLICATE_FLAGS_HAS_LOCAL,
56 } __clib_packed replicate_flags_t;
59 * The FIB DPO provieds;
60 * - load-balancing over the next DPOs in the chain/graph
61 * - per-route counters
63 typedef struct replicate_t_ {
65 * required for pool_get_aligned.
66 * memebers used in the switch path come first!
68 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
71 * number of buckets in the replicate.
76 * The protocol of packets that traverse this REP.
77 * need in combination with the flow hash config to determine how to hash.
80 dpo_proto_t rep_proto;
83 * Flags specifying the replicate properties/behaviour
85 replicate_flags_t rep_flags;
88 * The number of locks, which is approximately the number of users,
89 * of this load-balance.
90 * Load-balance objects of via-entries are heavily shared by recursives,
91 * so the lock count is a u32.
96 * Vector of buckets containing the next DPOs, sized as repo_num
98 dpo_id_t *rep_buckets;
101 * The rest of the cache line is used for buckets. In the common case
102 * where there there are less than 4 buckets, then the buckets are
103 * on the same cachlie and we save ourselves a pointer dereferance in
106 dpo_id_t rep_buckets_inline[REP_NUM_INLINE_BUCKETS];
109 STATIC_ASSERT(sizeof(replicate_t) <= CLIB_CACHE_LINE_BYTES,
110 "A replicate object size exceeds one cachline");
113 * Flags controlling load-balance formatting/display
115 typedef enum replicate_format_flags_t_ {
116 REPLICATE_FORMAT_NONE,
117 REPLICATE_FORMAT_DETAIL = (1 << 0),
118 } replicate_format_flags_t;
120 extern index_t replicate_create(u32 num_buckets,
121 dpo_proto_t rep_proto);
122 extern void replicate_multipath_update(
124 load_balance_path_t *next_hops);
126 extern void replicate_set_bucket(index_t repi,
128 const dpo_id_t *next);
130 extern u8* format_replicate(u8 * s, va_list * args);
132 extern const dpo_id_t *replicate_get_bucket(index_t repi,
134 extern int replicate_is_drop(const dpo_id_t *dpo);
136 extern u16 replicate_n_buckets(index_t repi);
138 extern index_t replicate_dup(replicate_flags_t flags,
142 * The encapsulation breakages are for fast DP access
144 extern replicate_t *replicate_pool;
145 static inline replicate_t*
146 replicate_get (index_t repi)
148 repi &= ~MPLS_IS_REPLICATE;
149 return (pool_elt_at_index(replicate_pool, repi));
152 #define REP_HAS_INLINE_BUCKETS(_rep) \
153 ((_rep)->rep_n_buckets <= REP_NUM_INLINE_BUCKETS)
155 static inline const dpo_id_t *
156 replicate_get_bucket_i (const replicate_t *rep,
159 ASSERT(bucket < rep->rep_n_buckets);
161 if (PREDICT_TRUE(REP_HAS_INLINE_BUCKETS(rep)))
163 return (&rep->rep_buckets_inline[bucket]);
167 return (&rep->rep_buckets[bucket]);
171 extern void replicate_module_init(void);