nsh.h revision ed5a133e
1/*
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:
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#ifndef included_nsh_h
16#define included_nsh_h
17
18#include <vnet/vnet.h>
19#include <nsh/nsh_packet.h>
20#include <vnet/ip/ip4_packet.h>
21
22typedef struct {
23
24  /** Key for nsh_header_t entry: 24bit NSP 8bit NSI */
25  u32 nsp_nsi;
26
27  /** Key for nsh_header_t entry to map to. : 24bit NSP 8bit NSI
28   *  This may be ~0 if next action is to decap to NSH next protocol
29   *  Note the following heuristic:
30   *  if nsp_nsi == mapped_nsp_nsi then use-case is like SFC SFF
31   *  if nsp_nsi != mapped_nsp_nsi then use-case is like SFC SF
32   *  Note: these are heuristics. Rules about NSI decrement are out of scope
33   */
34  u32 mapped_nsp_nsi;
35
36  /* vnet intfc sw_if_index */
37  u32 sw_if_index;
38
39  u32 next_node;
40
41} nsh_map_t;
42
43typedef struct {
44  nsh_map_t map;
45  u8 is_add;
46} nsh_add_del_map_args_t;
47
48typedef struct {
49  u8 is_add;
50  nsh_header_t nsh;
51} nsh_add_del_entry_args_t;
52
53typedef struct {
54  /* API message ID base */
55  u16 msg_id_base;
56
57  /* vector of nsh_header entry instances */
58  nsh_header_t *nsh_entries;
59
60  /* hash lookup nsh header by key: {u32: nsp_nsi} */
61  uword * nsh_entry_by_key;
62
63  /* vector of nsh_mappings */
64  nsh_map_t *nsh_mappings;
65
66  /* hash lookup nsh mapping by key: {u32: nsp_nsi} */
67  uword * nsh_mapping_by_key;
68  uword * nsh_mapping_by_mapped_key; // for use in NSHSFC
69
70  /* convenience */
71  vlib_main_t * vlib_main;
72  vnet_main_t * vnet_main;
73} nsh_main_t;
74
75nsh_main_t nsh_main;
76
77u8 * format_nsh_input_map_trace (u8 * s, va_list * args);
78u8 * format_nsh_header_with_length (u8 * s, va_list * args);
79
80/* Helper macros used in nsh.c and nsh_test.c */
81#define foreach_copy_nshhdr_field               \
82_(ver_o_c)					\
83_(length)					\
84_(md_type)					\
85_(next_protocol)				\
86_(nsp_nsi)					\
87_(c1)						\
88_(c2)						\
89_(c3)						\
90_(c4)
91/* TODO Temp killing tlvs as its causing pain - fix in NSH_SFC */
92#define foreach_32bit_field			\
93_(nsp_nsi)                                      \
94_(c1)                                           \
95_(c2)                                           \
96_(c3)                                           \
97_(c4)
98
99/* Statistics (not really errors) */
100#define foreach_nsh_input_error    \
101_(MAPPED, "NSH header found and mapped") \
102_(NO_MAPPING, "no mapping for nsh key") \
103_(INVALID_NEXT_PROTOCOL, "invalid next protocol") \
104
105typedef enum {
106#define _(sym,str) NSH_INPUT_ERROR_##sym,
107    foreach_nsh_input_error
108#undef _
109  NSH_INPUT_N_ERROR,
110
111} nsh_input_error_t;
112
113#define foreach_nsh_input_next        \
114  _(DROP, "error-drop")			\
115  _(ENCAP_GRE, "gre-input" )		\
116  _(ENCAP_VXLANGPE, "vxlan-gpe-encap" ) \
117/* /\* TODO once moved to Project:NSH_SFC *\/ */
118  /* _(ENCAP_ETHERNET, "*** TX TO ETHERNET ***")   \ */
119/*   _(DECAP_ETHERNET_LOOKUP, "ethernet-input" )	\ */
120/*   _(DECAP_IP4_INPUT,  "ip4-input") \ */
121/*   _(DECAP_IP6_INPUT,  "ip6-input" ) \  */
122
123typedef enum {
124#define _(s,n) NSH_INPUT_NEXT_##s,
125  foreach_nsh_input_next
126#undef _
127  NSH_INPUT_N_NEXT,
128} nsh_input_next_t;
129
130#endif /* included_nsh_h */
131