FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
replicate_dpo.h
Go to the documentation of this file.
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 {
36 
37  /* per-cpu vector of cloned packets */
40 
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  * Flags on the replicate DPO
51  */
52 typedef enum replicate_flags_t_
53 {
56 } __clib_packed replicate_flags_t;
57 
58 /**
59  * The FIB DPO provieds;
60  * - load-balancing over the next DPOs in the chain/graph
61  * - per-route counters
62  */
63 typedef struct replicate_t_ {
64  /**
65  * required for pool_get_aligned.
66  * memebers used in the switch path come first!
67  */
68  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
69 
70  /**
71  * number of buckets in the replicate.
72  */
74 
75  /**
76  * The protocol of packets that traverse this REP.
77  * need in combination with the flow hash config to determine how to hash.
78  * u8.
79  */
81 
82  /**
83  * Flags specifying the replicate properties/behaviour
84  */
85  replicate_flags_t rep_flags;
86 
87  /**
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.
92  */
94 
95  /**
96  * Vector of buckets containing the next DPOs, sized as repo_num
97  */
99 
100  /**
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
104  * the data-path.
105  */
106  dpo_id_t rep_buckets_inline[REP_NUM_INLINE_BUCKETS];
107 } replicate_t;
108 
110  "A replicate object size exceeds one cacheline");
111 
112 /**
113  * Flags controlling load-balance formatting/display
114  */
119 
120 extern index_t replicate_create(u32 num_buckets,
121  dpo_proto_t rep_proto);
122 extern void replicate_multipath_update(
123  const dpo_id_t *dpo,
124  load_balance_path_t *next_hops);
125 
126 extern void replicate_set_bucket(index_t repi,
127  u32 bucket,
128  const dpo_id_t *next);
129 
130 extern u8* format_replicate(u8 * s, va_list * args);
131 
132 extern const dpo_id_t *replicate_get_bucket(index_t repi,
133  u32 bucket);
134 extern int replicate_is_drop(const dpo_id_t *dpo);
135 
136 extern u16 replicate_n_buckets(index_t repi);
137 
138 extern index_t replicate_dup(replicate_flags_t flags,
139  index_t repi);
140 
141 /**
142  * The encapsulation breakages are for fast DP access
143  */
145 static inline replicate_t*
147 {
148  repi &= ~MPLS_IS_REPLICATE;
149  return (pool_elt_at_index(replicate_pool, repi));
150 }
151 
152 #define REP_HAS_INLINE_BUCKETS(_rep) \
153  ((_rep)->rep_n_buckets <= REP_NUM_INLINE_BUCKETS)
154 
155 static inline const dpo_id_t *
157  u32 bucket)
158 {
159  ASSERT(bucket < rep->rep_n_buckets);
160 
162  {
163  return (&rep->rep_buckets_inline[bucket]);
164  }
165  else
166  {
167  return (&rep->rep_buckets[bucket]);
168  }
169 }
170 
171 extern void replicate_module_init(void);
172 
173 #endif
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 flags
Definition: vhost_user.h:141
The FIB DPO provieds;.
Definition: replicate_dpo.h:63
const dpo_id_t * replicate_get_bucket(index_t repi, u32 bucket)
#define PREDICT_TRUE(x)
Definition: clib.h:113
Definitions for all things IP (v4|v6) unicast and multicast lookup related.
void replicate_set_bucket(index_t repi, u32 bucket, const dpo_id_t *next)
u32 rep_locks
The number of locks, which is approximately the number of users, of this load-balance.
Definition: replicate_dpo.h:93
enum replicate_format_flags_t_ replicate_format_flags_t
Flags controlling load-balance formatting/display.
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
dpo_proto_t rep_proto
The protocol of packets that traverse this REP.
Definition: replicate_dpo.h:80
index_t replicate_create(u32 num_buckets, dpo_proto_t rep_proto)
enum replicate_flags_t_ replicate_flags_t
Flags on the replicate DPO.
index_t replicate_dup(replicate_flags_t flags, index_t repi)
dpo_id_t * rep_buckets
Vector of buckets containing the next DPOs, sized as repo_num.
Definition: replicate_dpo.h:98
static replicate_t * replicate_get(index_t repi)
replicate_t * replicate_pool
The encapsulation breakages are for fast DP access.
Definition: replicate_dpo.c:57
unsigned char u8
Definition: types.h:56
u16 replicate_n_buckets(index_t repi)
#define MPLS_IS_REPLICATE
The top bit of the index, which is the result of the MPLS lookup is used to determine if the DPO is a...
Definition: mpls_types.h:66
replicate_main_t replicate_main
The one instance of replicate main.
Definition: replicate_dpo.c:62
unsigned int u32
Definition: types.h:88
#define REP_HAS_INLINE_BUCKETS(_rep)
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
int replicate_is_drop(const dpo_id_t *dpo)
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
replicate main
Definition: replicate_dpo.h:33
replicate_format_flags_t_
Flags controlling load-balance formatting/display.
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
struct replicate_main_t_ replicate_main_t
replicate main
unsigned short u16
Definition: types.h:57
vlib_combined_counter_main_t repm_counters
Definition: replicate_dpo.h:35
dpo_id_t rep_buckets_inline[REP_NUM_INLINE_BUCKETS]
The rest of the cache line is used for buckets.
u8 * format_replicate(u8 *s, va_list *args)
#define ASSERT(truth)
void replicate_multipath_update(const dpo_id_t *dpo, load_balance_path_t *next_hops)
u16 rep_n_buckets
number of buckets in the replicate.
Definition: replicate_dpo.h:73
replicate_flags_t_
Flags on the replicate DPO.
Definition: replicate_dpo.h:52
STATIC_ASSERT(sizeof(replicate_t)<=CLIB_CACHE_LINE_BYTES, "A replicate object size exceeds one cacheline")
#define REP_NUM_INLINE_BUCKETS
The number of buckets that a load-balance object can have and still fit in one cache-line.
Definition: replicate_dpo.h:47
static const dpo_id_t * replicate_get_bucket_i(const replicate_t *rep, u32 bucket)
One path from an [EU]CMP set that the client wants to add to a load-balance object.
Definition: load_balance.h:62
A collection of combined counters.
Definition: counter.h:188
void replicate_module_init(void)
replicate_flags_t rep_flags
Flags specifying the replicate properties/behaviour.
Definition: replicate_dpo.h:85
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
struct replicate_t_ replicate_t
The FIB DPO provieds;.