2 * Copyright (c) 2015 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.
15 #ifndef included_nsh_h
16 #define included_nsh_h
18 #include <vnet/vnet.h>
19 #include <nsh/nsh_packet.h>
20 #include <vnet/ip/ip4_packet.h>
26 } nsh_option_map_by_key_t;
32 #define MAX_METADATA_LEN 62
34 * rewrite and rewrite_size used to support varied nsh header
37 /* Required for pool_get_aligned */
38 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
40 nsh_base_header_t nsh_base;
42 nsh_md1_data_t md1_data;
43 nsh_md2_data_t md2_data;
45 u8 tlvs_len; /* configured md2 metadata's length, unit: byte */
46 u8 * tlvs_data; /* configured md2 metadata, network order */
48 /** Rewrite string. network order
49 * contains base header and metadata */
51 u8 rewrite_size; /* unit: byte */
56 nsh_entry_t nsh_entry;
57 } nsh_add_del_entry_args_t;
60 /* Required for pool_get_aligned */
61 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
63 /** Key for nsh_header_t entry: 24bit NSP 8bit NSI */
65 /** Key for nsh_header_t entry to map to. : 24bit NSP 8bit NSI
66 * This may be ~0 if next action is to decap to NSH next protocol
67 * Note the following heuristic:
68 * if nsp_nsi == mapped_nsp_nsi then use-case is like SFC SFF
69 * if nsp_nsi != mapped_nsp_nsi then use-case is like SFC SF
70 * Note: these are heuristics. Rules about NSI decrement are out of scope
73 /* NSH Header action: swap, push and pop */
76 /** vnet intfc hw_if_index */
78 /* vnet intfc sw_if_index */
91 } nsh_add_del_map_args_t;
94 u32 transport_type; /* 1:vxlan; */
95 u32 transport_index; /* transport's sw_if_index */
96 } nsh_proxy_session_by_key_t;
99 /* 24bit NSP 8bit NSI */
101 } nsh_proxy_session_t;
103 #define MAX_MD2_OPTIONS 256
106 /* API message ID base */
109 /* vector of nsh_header entry instances */
110 nsh_entry_t *nsh_entries;
112 /* hash lookup nsh header by key: {u32: nsp_nsi} */
113 uword * nsh_entry_by_key;
115 /* vector of nsh_mappings */
116 nsh_map_t *nsh_mappings;
118 /* hash lookup nsh mapping by key: {u32: nsp_nsi} */
119 uword * nsh_mapping_by_key;
120 uword * nsh_mapping_by_mapped_key; // for use in NSHSFC
122 /* vector of nsh_proxy */
123 nsh_proxy_session_t *nsh_proxy_sessions;
125 /* hash lookup nsh_proxy by key */
126 uword * nsh_proxy_session_by_key;
128 /** Free vlib hw_if_indices */
129 u32 * free_nsh_tunnel_hw_if_indices;
130 /** Mapping from sw_if_index to tunnel index */
131 u32 * tunnel_index_by_sw_if_index;
133 /* vector of nsh_option_map */
134 nsh_option_map_t * nsh_option_mappings;
135 /* hash lookup nsh_option_map by key */
136 uword * nsh_option_map_by_key;
138 /* Array of function pointers to process MD-Type 2 handling routines */
140 * For API or CLI configuration and construct the rewrite buffer, invokes add_options() function.
141 * In the encap node, i.e. when performing PUSH nsh header, invokes options() function.
142 * In the swap node, i.e. when performing SWAP nsh header, invokes swap_options() function.
143 * In the decap node, i.e. when performing POP nsh header, invokes pop_options() function.
145 u8 options_size[MAX_MD2_OPTIONS]; /* sum of header and metadata */
146 int (*add_options[MAX_MD2_OPTIONS]) (u8 * opt,
148 int (*options[MAX_MD2_OPTIONS]) (vlib_buffer_t * b,
149 nsh_tlv_header_t * opt);
150 int (*swap_options[MAX_MD2_OPTIONS]) (vlib_buffer_t * b,
151 nsh_tlv_header_t * old_opt,
152 nsh_tlv_header_t * new_opt);
153 int (*pop_options[MAX_MD2_OPTIONS]) (vlib_buffer_t * b,
154 nsh_tlv_header_t * opt);
155 u8 *(*trace[MAX_MD2_OPTIONS]) (u8 * s, nsh_tlv_header_t * opt);
156 uword decap_v4_next_override;
158 /* Feature arc indices */
159 u8 input_feature_arc_index;
160 u8 output_feature_arc_index;
162 u32 nsh_input_node_index;
163 u32 nsh_proxy_node_index;
164 u32 nsh_classifier_node_index;
167 vlib_main_t * vlib_main;
168 vnet_main_t * vnet_main;
171 extern nsh_main_t nsh_main;
172 extern vlib_node_registration_t nsh_aware_vnf_proxy_node;
173 extern vlib_node_registration_t nsh_eth_output_node;
179 u8 * format_nsh_input_map_trace (u8 * s, va_list * args);
180 u8 * format_nsh_header_with_length (u8 * s, va_list * args);
182 /* Helper macros used in nsh.c and nsh_test.c */
183 #define foreach_copy_nsh_base_hdr_field \
190 /* Statistics (not really errors) */
191 #define foreach_nsh_node_error \
192 _(MAPPED, "NSH header found and mapped") \
193 _(NO_MAPPING, "no mapping for nsh key") \
194 _(NO_ENTRY, "no entry for nsh key") \
195 _(NO_PROXY, "no proxy for transport key") \
196 _(INVALID_NEXT_PROTOCOL, "invalid next protocol") \
197 _(INVALID_OPTIONS, "invalid md2 options") \
198 _(INVALID_TTL, "ttl equals zero") \
201 #define _(sym,str) NSH_NODE_ERROR_##sym,
202 foreach_nsh_node_error
208 #define foreach_nsh_node_next \
209 _(DROP, "error-drop") \
210 _(ENCAP_GRE4, "gre4-input" ) \
211 _(ENCAP_GRE6, "gre6-input" ) \
212 _(ENCAP_VXLANGPE, "vxlan-gpe-encap" ) \
213 _(ENCAP_VXLAN4, "vxlan4-encap" ) \
214 _(ENCAP_VXLAN6, "vxlan6-encap" ) \
215 _(DECAP_ETH_INPUT, "ethernet-input" ) \
216 _(ENCAP_LISP_GPE, "interface-output" ) \
217 _(ENCAP_ETHERNET, "nsh-eth-output") \
218 /* _(DECAP_IP4_INPUT, "ip4-input") \ */
219 /* _(DECAP_IP6_INPUT, "ip6-input" ) \ */
222 #define _(s,n) NSH_NODE_NEXT_##s,
223 foreach_nsh_node_next
238 NSH_AWARE_VNF_PROXY_TYPE,
241 #define VNET_SW_INTERFACE_FLAG_ADMIN_DOWN 0
243 /* md2 class and type definition */
244 #define NSH_MD2_IOAM_CLASS 0x9
245 #define NSH_MD2_IOAM_OPTION_TYPE_TRACE 0x3B
246 #define NSH_MD2_IOAM_OPTION_TYPE_PROOF_OF_TRANSIT 0x3C
248 #define NSH_MD2_IOAM_TRACE_DUMMY_LEN 0x8
250 #define MAX_NSH_HEADER_LEN 256
251 #define MAX_NSH_OPTION_LEN 128
254 nsh_md2_register_option (u16 class,
257 int add_options (u8 * opt,
259 int options(vlib_buffer_t * b,
260 nsh_tlv_header_t * opt),
261 int swap_options (vlib_buffer_t * b,
262 nsh_tlv_header_t * old_opt,
263 nsh_tlv_header_t * new_opt),
264 int pop_options (vlib_buffer_t * b,
265 nsh_tlv_header_t * opt),
267 nsh_tlv_header_t * opt));
269 typedef struct _nsh_main_dummy
271 u8 output_feature_arc_index;
275 nsh_add_del_map (nsh_add_del_map_args_t * a, u32 * map_indexp);
278 nsh_add_del_proxy_session (nsh_add_del_map_args_t * a);
281 nsh_md2_lookup_option (u16 class, u8 type);
284 nsh_add_del_entry (nsh_add_del_entry_args_t * a, u32 * entry_indexp);
287 format_nsh_node_map_trace (u8 * s, va_list * args);
290 format_nsh_header (u8 * s, va_list * args);
293 nsh_api_init (vlib_main_t * vm, nsh_main_t * nm);
295 #endif /* included_nsh_h */