FD.io VPP  v17.07-30-g839fa73
Vector Packet Processing
mpls_disposition.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_DISP_DPO_H__
17 #define __MPLS_DISP_DPO_H__
18 
19 #include <vnet/vnet.h>
20 #include <vnet/mpls/packet.h>
21 #include <vnet/dpo/dpo.h>
22 #include <vnet/mfib/mfib_types.h>
23 
24 /**
25  * A representation of an MPLS label for imposition in the data-path
26  */
27 typedef struct mpls_disp_dpo_t
28 {
29  /**
30  * Next DPO in the graph
31  */
33 
34  /**
35  * The protocol of the payload/packets that are being encapped
36  */
38 
39  /**
40  * RPF-ID (if this is an mcast disposition)
41  */
43 
44  /**
45  * Number of locks/users of the label
46  */
49 
50 /**
51  * @brief Assert that the MPLS label object is less than a cache line in size.
52  * Should this get any bigger then we will need to reconsider how many labels
53  * can be pushed in one object.
54  */
55 _Static_assert((sizeof(mpls_disp_dpo_t) <= CLIB_CACHE_LINE_BYTES),
56  "MPLS Disposition DPO is larger than one cache line.");
57 
58 /**
59  * @brief Create an MPLS label object
60  *
61  * @param payload_proto The ptocool of the payload packets that will
62  * be imposed with this label header.
63  * @param dpo The parent of the created MPLS label object
64  */
65 extern index_t mpls_disp_dpo_create(dpo_proto_t payload_proto,
66  fib_rpf_id_t rpf_id,
67  const dpo_id_t *dpo);
68 
69 extern u8* format_mpls_disp_dpo(u8 *s, va_list *args);
70 
71 
72 /*
73  * Encapsulation violation for fast data-path access
74  */
76 
77 static inline mpls_disp_dpo_t *
79 {
80  return (pool_elt_at_index(mpls_disp_dpo_pool, index));
81 }
82 
83 extern void mpls_disp_dpo_module_init(void);
84 
85 #endif
u16 mdd_locks
Number of locks/users of the label.
index_t mpls_disp_dpo_create(dpo_proto_t payload_proto, fib_rpf_id_t rpf_id, const dpo_id_t *dpo)
Create an MPLS label object.
struct mpls_disp_dpo_t mpls_disp_dpo_t
A representation of an MPLS label for imposition in the data-path.
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 mdd_payload_proto
The protocol of the payload/packets that are being encapped.
fib_rpf_id_t mdd_rpf_id
RPF-ID (if this is an mcast disposition)
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:152
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
mpls_disp_dpo_t * mpls_disp_dpo_pool
u8 * format_mpls_disp_dpo(u8 *s, va_list *args)
u32 fib_rpf_id_t
An RPF-ID is numerical value that is used RPF validate.
Definition: fib_types.h:315
A representation of an MPLS label for imposition in the data-path.
void mpls_disp_dpo_module_init(void)
dpo_id_t mdd_dpo
Next DPO in the graph.
unsigned short u16
Definition: types.h:57
static mpls_disp_dpo_t * mpls_disp_dpo_get(index_t index)
unsigned char u8
Definition: types.h:56
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67