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 * Flags present on an MPLS label sourced path-extension
26 typedef enum mpls_label_dpo_attr_t_
29 * Do not decrement the TTL of IP packet during imposition
31 MPLS_LABEL_DPO_ATTR_NO_IP_TTL_DECR,
32 MPLS_LABEL_DPO_ATTR_UNIFORM_MODE,
33 } mpls_label_dpo_attr_t;
35 #define MPLS_LABEL_DPO_ATTR_MAX (MPLS_LABEL_DPO_ATTR_UNIFORM_MODE+1)
37 typedef enum mpls_label_dpo_flags_t_
39 MPLS_LABEL_DPO_FLAG_NONE = 0,
40 MPLS_LABEL_DPO_FLAG_NO_IP_TTL_DECR = (1 << MPLS_LABEL_DPO_ATTR_NO_IP_TTL_DECR),
41 MPLS_LABEL_DPO_FLAG_UNIFORM_MODE = (1 << MPLS_LABEL_DPO_ATTR_UNIFORM_MODE),
42 } __attribute__ ((packed)) mpls_label_dpo_flags_t;
44 #define MPLS_LABEL_DPO_ATTR_NAMES { \
45 [MPLS_LABEL_DPO_ATTR_NO_IP_TTL_DECR] = "no-ip-tll-decr", \
46 [MPLS_LABEL_DPO_ATTR_UNIFORM_MODE] = "uniform-mode", \
49 #define FOR_EACH_MPLS_LABEL_DPO_ATTR(_item) \
50 for (_item = MPLS_LABEL_DPO_ATTR_NO_IP_TTL_DECR; \
51 _item <= MPLS_LABEL_DPO_ATTR_UNIFORM_MODE; \
55 * Format the flags variable
57 extern u8* format_mpls_label_dpo_flags(u8 *s, va_list *args);
60 * Maximum number of labels in one DPO
62 #define MPLS_LABEL_DPO_MAX_N_LABELS 12
65 * A representation of an MPLS label for imposition in the data-path
67 typedef struct mpls_label_dpo_t
70 * The MPLS label header to impose. Outer most label first.
71 * Each DPO will occupy one cache line, stuff that many labels in.
73 mpls_unicast_header_t mld_hdr[MPLS_LABEL_DPO_MAX_N_LABELS];
76 * Next DPO in the graph
81 * The protocol of the payload/packets that are being encapped
83 dpo_proto_t mld_payload_proto;
88 mpls_label_dpo_flags_t mld_flags;
91 * Size of the label stack
96 * Cached amount of header bytes to paint
101 * Number of locks/users of the label
107 * @brief Assert that the MPLS label object is less than a cache line in size.
108 * Should this get any bigger then we will need to reconsider how many labels
109 * can be pushed in one object.
111 STATIC_ASSERT((sizeof(mpls_label_dpo_t) <= CLIB_CACHE_LINE_BYTES),
112 "MPLS label DPO is larger than one cache line.");
115 * @brief Create an MPLS label object
117 * @param label_stack The stack if labels to impose, outer most label first
118 * @param eos The inner most label's EOS bit
119 * @param payload_proto The ptocool of the payload packets that will
120 * be imposed with this label header.
121 * @param parent The parent of the created MPLS label object
122 * @param dpo The MPLS label DPO created
124 extern void mpls_label_dpo_create(fib_mpls_label_t *label_stack,
126 dpo_proto_t payload_proto,
127 mpls_label_dpo_flags_t flags,
128 const dpo_id_t *paremt,
131 extern u8* format_mpls_label_dpo(u8 *s, va_list *args);
135 * Encapsulation violation for fast data-path access
137 extern mpls_label_dpo_t *mpls_label_dpo_pool;
139 static inline mpls_label_dpo_t *
140 mpls_label_dpo_get (index_t index)
142 return (pool_elt_at_index(mpls_label_dpo_pool, index));
145 extern void mpls_label_dpo_module_init(void);
148 * test function to get the registered DPO type for the flags
150 extern dpo_type_t mpls_label_dpo_get_type(mpls_label_dpo_flags_t flags);