A Protocol Independent Hierarchical FIB (VPP-352)
[vpp.git] / vnet / vnet / dpo / mpls_label_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 #ifndef __MPLS_LABEL_DPO_H__
17 #define __MPLS_LABEL_DPO_H__
18
19 #include <vnet/vnet.h>
20 #include <vnet/mpls/packet.h>
21 #include <vnet/dpo/dpo.h>
22
23 /**
24  * A representation of an MPLS label for imposition in the data-path
25  */
26 typedef struct mpls_label_dpo_t
27 {
28     /**
29      * The MPLS label header to impose
30      */
31     mpls_unicast_header_t mld_hdr;
32
33     /**
34      * Next DPO in the graph
35      */
36     dpo_id_t mld_dpo;
37
38     /**
39      * Number of locks/users of the label
40      */
41     u16 mld_locks;
42 } mpls_label_dpo_t;
43
44 extern index_t mpls_label_dpo_create(mpls_label_t label,
45                                      mpls_eos_bit_t eos,
46                                      u8 ttl,
47                                      u8 exp,
48                                      const dpo_id_t *dpo);
49
50 extern u8* format_mpls_label_dpo(u8 *s, va_list *args);
51
52
53 /*
54  * Encapsulation violation for fast data-path access
55  */
56 extern mpls_label_dpo_t *mpls_label_dpo_pool;
57
58 static inline mpls_label_dpo_t *
59 mpls_label_dpo_get (index_t index)
60 {
61     return (pool_elt_at_index(mpls_label_dpo_pool, index));
62 }
63
64 extern void mpls_label_dpo_module_init(void);
65
66 #endif