FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
mpls_label_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 #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 /**
25  * Maximum number of labels in one DPO
26  */
27 #define MPLS_LABEL_DPO_MAX_N_LABELS 12
28 /**
29  * A representation of an MPLS label for imposition in the data-path
30  */
31 typedef struct mpls_label_dpo_t
32 {
33  /**
34  * The MPLS label header to impose. Outer most label first.
35  * Each DPO will occupy one cache line, stuff that many labels in.
36  */
38 
39  /**
40  * Next DPO in the graph
41  */
43 
44  /**
45  * The protocol of the payload/packets that are being encapped
46  */
48 
49  /**
50  * Size of the label stack
51  */
53 
54  /**
55  * Cached amount of header bytes to paint
56  */
58 
59  /**
60  * Number of locks/users of the label
61  */
64 
65 /**
66  * @brief Assert that the MPLS label object is less than a cache line in size.
67  * Should this get any bigger then we will need to reconsider how many labels
68  * can be pushed in one object.
69  */
71  "MPLS label DPO is larger than one cache line.");
72 
73 /**
74  * @brief Create an MPLS label object
75  *
76  * @param label_stack The stack if labels to impose, outer most label first
77  * @param eos The inner most label's EOS bit
78  * @param ttl The inner most label's TTL bit
79  * @param exp The inner most label's EXP bit
80  * @param payload_proto The ptocool of the payload packets that will
81  * be imposed with this label header.
82  * @param dpo The parent of the created MPLS label object
83  */
84 extern index_t mpls_label_dpo_create(mpls_label_t *label_stack,
85  mpls_eos_bit_t eos,
86  u8 ttl,
87  u8 exp,
88  dpo_proto_t payload_proto,
89  const dpo_id_t *dpo);
90 
91 extern u8* format_mpls_label_dpo(u8 *s, va_list *args);
92 
93 
94 /*
95  * Encapsulation violation for fast data-path access
96  */
98 
99 static inline mpls_label_dpo_t *
101 {
102  return (pool_elt_at_index(mpls_label_dpo_pool, index));
103 }
104 
105 extern void mpls_label_dpo_module_init(void);
106 
107 #endif
void mpls_label_dpo_module_init(void)
mpls_label_dpo_t * mpls_label_dpo_pool
STATIC_ASSERT((sizeof(mpls_label_dpo_t)<=CLIB_CACHE_LINE_BYTES),"MPLS label DPO is larger than one cache line.")
Assert that the MPLS label object is less than a cache line in size.
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:24
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
#define MPLS_LABEL_DPO_MAX_N_LABELS
Maximum number of labels in one DPO.
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
dpo_proto_t mld_payload_proto
The protocol of the payload/packets that are being encapped.
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:166
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
u8 * format_mpls_label_dpo(u8 *s, va_list *args)
index_t mpls_label_dpo_create(mpls_label_t *label_stack, mpls_eos_bit_t eos, u8 ttl, u8 exp, dpo_proto_t payload_proto, const dpo_id_t *dpo)
Create an MPLS label object.
u16 mld_n_hdr_bytes
Cached amount of header bytes to paint.
u16 mld_n_labels
Size of the label stack.
static mpls_label_dpo_t * mpls_label_dpo_get(index_t index)
struct mpls_label_dpo_t mpls_label_dpo_t
A representation of an MPLS label for imposition in the data-path.
dpo_id_t mld_dpo
Next DPO in the graph.
mpls_unicast_header_t mld_hdr[MPLS_LABEL_DPO_MAX_N_LABELS]
The MPLS label header to impose.
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
u16 mld_locks
Number of locks/users of the label.
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
A representation of an MPLS label for imposition in the data-path.
enum mpls_eos_bit_t_ mpls_eos_bit_t