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.
16 * bier_imposition : The BIER imposition object
18 * A BIER imposition object is present in the IP mcast output list
19 * and represents the imposition of a BIER bitmask. After BIER header
20 * imposition the packet is forward within the appropriate/specifid
24 #ifndef __BIER_IMPOSITION_H__
25 #define __BIER_IMPOSITION_H__
27 #include <vnet/bier/bier_types.h>
28 #include <vnet/fib/fib_types.h>
29 #include <vnet/dpo/dpo.h>
32 * The BIER imposition object
34 typedef struct bier_imp_t_ {
36 * The BIER table into which to forward the post imposed packet
38 bier_table_id_t bi_tbl;
46 * The DPO contirubted from the resolving BIER table.
47 * One per-IP protocol. This allows us to share a BIER imposition
48 * object for a IPv4 and IPv6 mfib path.
50 dpo_id_t bi_dpo[FIB_PROTOCOL_IP_MAX];
53 * The Header to impose.
59 * This is a memory v. speed tradeoff. We inline here the
60 * largest header type so as the bitstring is on the same
61 * cacheline as the header.
63 bier_bit_mask_4096_t bi_bits;
66 extern index_t bier_imp_add_or_lock(const bier_table_id_t *bt,
68 const bier_bit_string_t *bs);
70 extern void bier_imp_unlock(index_t bii);
71 extern void bier_imp_lock(index_t bii);
73 extern u8* format_bier_imp(u8* s, va_list *ap);
75 extern void bier_imp_contribute_forwarding(index_t bii,
79 extern bier_imp_t *bier_imp_pool;
81 always_inline bier_imp_t*
82 bier_imp_get (index_t bii)
84 return (pool_elt_at_index(bier_imp_pool, bii));