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 #ifndef __MPLS_LABEL_DPO_H__
17 #define __MPLS_LABEL_DPO_H__
19 #include <vnet/vnet.h>
20 #include <vnet/mpls/packet.h>
21 #include <vnet/dpo/dpo.h>
24 * A representation of an MPLS label for imposition in the data-path
26 typedef struct mpls_label_dpo_t
29 * The MPLS label header to impose. Outer most label first.
31 mpls_unicast_header_t mld_hdr[8];
34 * Next DPO in the graph
39 * The protocol of the payload/packets that are being encapped
41 dpo_proto_t mld_payload_proto;
44 * Size of the label stack
49 * Number of locks/users of the label
55 * @brief Assert that the MPLS label object is less than a cache line in size.
56 * Should this get any bigger then we will need to reconsider how many labels
57 * can be pushed in one object.
59 _Static_assert((sizeof(mpls_label_dpo_t) <= CLIB_CACHE_LINE_BYTES),
60 "MPLS label DPO is larger than one cache line.");
63 * @brief Create an MPLS label object
65 * @param label_stack The stack if labels to impose, outer most label first
66 * @param eos The inner most label's EOS bit
67 * @param ttl The inner most label's TTL bit
68 * @param exp The inner most label's EXP bit
69 * @param payload_proto The ptocool of the payload packets that will
70 * be imposed with this label header.
71 * @param dpo The parent of the created MPLS label object
73 extern index_t mpls_label_dpo_create(mpls_label_t *label_stack,
77 dpo_proto_t payload_proto,
80 extern u8* format_mpls_label_dpo(u8 *s, va_list *args);
84 * Encapsulation violation for fast data-path access
86 extern mpls_label_dpo_t *mpls_label_dpo_pool;
88 static inline mpls_label_dpo_t *
89 mpls_label_dpo_get (index_t index)
91 return (pool_elt_at_index(mpls_label_dpo_pool, index));
94 extern void mpls_label_dpo_module_init(void);