diff options
Diffstat (limited to 'vnet/vnet/nsh-gre')
-rw-r--r-- | vnet/vnet/nsh-gre/decap.c | 365 | ||||
-rw-r--r-- | vnet/vnet/nsh-gre/encap.c | 303 | ||||
-rw-r--r-- | vnet/vnet/nsh-gre/nsh_gre.c | 537 | ||||
-rw-r--r-- | vnet/vnet/nsh-gre/nsh_gre.h | 123 | ||||
-rw-r--r-- | vnet/vnet/nsh-gre/nsh_gre_error.def | 17 | ||||
-rw-r--r-- | vnet/vnet/nsh-gre/nsh_gre_packet.h | 93 |
6 files changed, 1438 insertions, 0 deletions
diff --git a/vnet/vnet/nsh-gre/decap.c b/vnet/vnet/nsh-gre/decap.c new file mode 100644 index 00000000000..9ef52ffb6de --- /dev/null +++ b/vnet/vnet/nsh-gre/decap.c @@ -0,0 +1,365 @@ +/* + * nsh.c: nsh packet processing + * + * Copyright (c) 2013 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <vlib/vlib.h> +#include <vnet/pg/pg.h> +#include <vnet/nsh-gre/nsh_gre.h> +#include <vnet/nsh-gre/nsh_gre_packet.h> + +vlib_node_registration_t nsh_input_node; + +typedef struct { + u32 next_index; + u32 tunnel_index; + u32 error; + nsh_header_t h; +} nsh_rx_trace_t; + + +u8 * format_nsh_header_with_length (u8 * s, va_list * args) +{ + nsh_header_t * h = va_arg (*args, nsh_header_t *); + u32 max_header_bytes = va_arg (*args, u32); + u32 tmp, header_bytes; + + header_bytes = sizeof (h[0]); + if (max_header_bytes != 0 && header_bytes > max_header_bytes) + return format (s, "gre-nsh header truncated"); + + s = format (s, "ver %d ", h->ver_o_c>>6); + + if (h->ver_o_c & NSH_GRE_O_BIT) + s = format (s, "O-set "); + + if (h->ver_o_c & NSH_GRE_C_BIT) + s = format (s, "C-set "); + + s = format (s, "len %d (%d bytes) md_type %d next_protocol %d\n", + h->length, h->length * 4, h->md_type, h->next_protocol); + + tmp = clib_net_to_host_u32 (h->spi_si); + + s = format (s, " spi %d si %d ", + (tmp>>NSH_GRE_SPI_SHIFT) & NSH_GRE_SPI_MASK, + tmp & NSH_GRE_SINDEX_MASK); + + s = format (s, "c1 %u c2 %u c3 %u c4 %u", + clib_net_to_host_u32 (h->c1), + clib_net_to_host_u32 (h->c2), + clib_net_to_host_u32 (h->c3), + clib_net_to_host_u32 (h->c4)); + + return s; +} + + +u8 * format_nsh_rx_trace (u8 * s, va_list * args) +{ + CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *); + CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *); + nsh_rx_trace_t * t = va_arg (*args, nsh_rx_trace_t *); + + if (t->tunnel_index != ~0) + { + s = format (s, "NSH: tunnel %d next %d error %d", t->tunnel_index, + t->next_index, t->error); + } + else + { + s = format (s, "NSH: no tunnel next %d error %d\n", t->next_index, + t->error); + } + s = format (s, "\n %U", format_nsh_header_with_length, &t->h, + (u32) sizeof (t->h) /* max size */); + return s; +} + +static uword +nsh_gre_input (vlib_main_t * vm, + vlib_node_runtime_t * node, + vlib_frame_t * from_frame) +{ + u32 n_left_from, next_index, * from, * to_next; + nsh_gre_main_t * ngm = &nsh_gre_main; + u32 last_tunnel_index = ~0; + u64 last_key = ~0ULL; + u32 pkts_decapsulated = 0; + + from = vlib_frame_vector_args (from_frame); + n_left_from = from_frame->n_vectors; + + next_index = node->cached_next_index; + + while (n_left_from > 0) + { + u32 n_left_to_next; + + vlib_get_next_frame (vm, node, next_index, + to_next, n_left_to_next); + + while (n_left_from >= 4 && n_left_to_next >= 2) + { + u32 bi0, bi1; + vlib_buffer_t * b0, * b1; + u32 next0, next1; + nsh_header_t * h0, * h1; + uword * p0, * p1; + u32 tunnel_index0, tunnel_index1; + nsh_gre_tunnel_t * t0, * t1; + u64 key0, key1; + u32 error0, error1; + + /* Prefetch next iteration. */ + { + vlib_buffer_t * p2, * p3; + + p2 = vlib_get_buffer (vm, from[2]); + p3 = vlib_get_buffer (vm, from[3]); + + vlib_prefetch_buffer_header (p2, LOAD); + vlib_prefetch_buffer_header (p3, LOAD); + + CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD); + CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD); + } + + bi0 = from[0]; + bi1 = from[1]; + to_next[0] = bi0; + to_next[1] = bi1; + from += 2; + to_next += 2; + n_left_to_next -= 2; + n_left_from -= 2; + + b0 = vlib_get_buffer (vm, bi0); + b1 = vlib_get_buffer (vm, bi1); + + h0 = vlib_buffer_get_current (b0); + h1 = vlib_buffer_get_current (b1); + + /* gre stashed the src ip4 address for us... */ + key0 = (((u64)(vnet_buffer(b0)->gre.src))<<32) | h0->spi_si; + key1 = (((u64)(vnet_buffer(b1)->gre.src))<<32) | h1->spi_si; + + /* "pop" nsh header */ + vlib_buffer_advance (b0, sizeof (*h0)); + vlib_buffer_advance (b1, sizeof (*h1)); + + tunnel_index0 = ~0; + tunnel_index1 = ~0; + error0 = 0; + error1 = 0; + next0 = NSH_INPUT_NEXT_DROP; + next1 = NSH_INPUT_NEXT_DROP; + + if (PREDICT_FALSE(key0 != last_key)) + { + p0 = hash_get (ngm->nsh_gre_tunnel_by_src_address, key0); + + if (p0 == 0) + { + error0 = NSH_GRE_ERROR_NO_SUCH_TUNNEL; + goto trace0; + } + + last_key = key0; + tunnel_index0 = last_tunnel_index = p0[0]; + } + else + tunnel_index0 = last_tunnel_index; + + t0 = pool_elt_at_index (ngm->tunnels, tunnel_index0); + + /* Required to make the l2 tag push / pop code work on l2 subifs */ + vnet_update_l2_len (b0); + + next0 = t0->decap_next_index; + + /* ip[46] lookup in the configured FIB, otherwise an opaque */ + vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->decap_fib_index; + + trace0: + b0->error = error0 ? node->errors[error0] : 0; + + if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) + { + nsh_rx_trace_t *tr = vlib_add_trace (vm, node, + b0, sizeof (*tr)); + tr->next_index = next0; + tr->error = error0; + tr->tunnel_index = tunnel_index0; + tr->h = h0[0]; + } + + if (PREDICT_FALSE(key1 != last_key)) + { + p1 = hash_get (ngm->nsh_gre_tunnel_by_src_address, key1); + + if (p1 == 0) + { + error1 = NSH_GRE_ERROR_NO_SUCH_TUNNEL; + goto trace1; + } + + last_key = key1; + tunnel_index1 = last_tunnel_index = p1[0]; + } + else + tunnel_index1 = last_tunnel_index; + + t1 = pool_elt_at_index (ngm->tunnels, tunnel_index1); + + /* Required to make the l2 tag push / pop code work on l2 subifs */ + vnet_update_l2_len (b1); + + next1 = t1->decap_next_index; + + /* ip[46] lookup in the configured FIB, otherwise an opaque */ + vnet_buffer(b1)->sw_if_index[VLIB_TX] = t1->decap_fib_index; + + pkts_decapsulated +=2; + + trace1: + b1->error = error1 ? node->errors[error1] : 0; + + if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED)) + { + nsh_rx_trace_t *tr = vlib_add_trace (vm, node, + b1, sizeof (*tr)); + tr->next_index = next1; + tr->error = error1; + tr->tunnel_index = tunnel_index1; + tr->h = h1[0]; + } + + vlib_validate_buffer_enqueue_x2 (vm, node, next_index, + to_next, n_left_to_next, + bi0, bi1, next0, next1); + } + + while (n_left_from > 0 && n_left_to_next > 0) + { + u32 bi0; + vlib_buffer_t * b0; + u32 next0; + nsh_header_t * h0; + uword * p0; + u32 tunnel_index0; + nsh_gre_tunnel_t * t0; + u64 key0; + u32 error0; + + bi0 = from[0]; + to_next[0] = bi0; + from += 1; + to_next += 1; + n_left_from -= 1; + n_left_to_next -= 1; + + b0 = vlib_get_buffer (vm, bi0); + h0 = vlib_buffer_get_current (b0); + + /* gre stashed the src ip4 address for us... */ + key0 = (((u64)(vnet_buffer(b0)->gre.src))<<32) | h0->spi_si; + + /* "pop" nsh header */ + vlib_buffer_advance (b0, sizeof (*h0)); + + tunnel_index0 = ~0; + error0 = 0; + next0 = NSH_INPUT_NEXT_DROP; + + if (PREDICT_FALSE(key0 != last_key)) + { + p0 = hash_get (ngm->nsh_gre_tunnel_by_src_address, key0); + + if (p0 == 0) + { + error0 = NSH_GRE_ERROR_NO_SUCH_TUNNEL; + goto trace00; + } + + last_key = key0; + tunnel_index0 = last_tunnel_index = p0[0]; + } + else + tunnel_index0 = last_tunnel_index; + + t0 = pool_elt_at_index (ngm->tunnels, tunnel_index0); + + /* Required to make the l2 tag push / pop code work on l2 subifs */ + vnet_update_l2_len (b0); + + next0 = t0->decap_next_index; + + /* ip[46] lookup in the configured FIB, otherwise an opaque */ + vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->decap_fib_index; + pkts_decapsulated ++; + + trace00: + b0->error = error0 ? node->errors[error0] : 0; + + if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) + { + nsh_rx_trace_t *tr = vlib_add_trace (vm, node, + b0, sizeof (*tr)); + tr->next_index = next0; + tr->error = error0; + tr->tunnel_index = tunnel_index0; + tr->h = h0[0]; + } + vlib_validate_buffer_enqueue_x1 (vm, node, next_index, + to_next, n_left_to_next, + bi0, next0); + } + + vlib_put_next_frame (vm, node, next_index, n_left_to_next); + } + vlib_node_increment_counter (vm, nsh_gre_input_node.index, + NSH_GRE_ERROR_DECAPSULATED, + pkts_decapsulated); + return from_frame->n_vectors; +} + +static char * nsh_error_strings[] = { +#define nsh_gre_error(n,s) s, +#include <vnet/nsh-gre/nsh_gre_error.def> +#undef nsh_gre_error +#undef _ +}; + +VLIB_REGISTER_NODE (nsh_gre_input_node) = { + .function = nsh_gre_input, + .name = "nsh-gre-input", + /* Takes a vector of packets. */ + .vector_size = sizeof (u32), + + .n_errors = NSH_GRE_N_ERROR, + .error_strings = nsh_error_strings, + + .n_next_nodes = NSH_INPUT_N_NEXT, + .next_nodes = { +#define _(s,n) [NSH_INPUT_NEXT_##s] = n, + foreach_nsh_gre_input_next +#undef _ + }, + + .format_buffer = format_nsh_header_with_length, + .format_trace = format_nsh_rx_trace, + // $$$$ .unformat_buffer = unformat_nsh_gre_header, +}; diff --git a/vnet/vnet/nsh-gre/encap.c b/vnet/vnet/nsh-gre/encap.c new file mode 100644 index 00000000000..875e8311098 --- /dev/null +++ b/vnet/vnet/nsh-gre/encap.c @@ -0,0 +1,303 @@ +/* + * Copyright (c) 2015 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#include <vppinfra/error.h> +#include <vppinfra/hash.h> +#include <vnet/vnet.h> +#include <vnet/ip/ip.h> +#include <vnet/ethernet/ethernet.h> +#include <vnet/nsh-gre/nsh_gre.h> + +/* Statistics (not really errors) */ +#define foreach_nsh_gre_encap_error \ +_(ENCAPSULATED, "good packets encapsulated") + +static char * nsh_gre_encap_error_strings[] = { +#define _(sym,string) string, + foreach_nsh_gre_encap_error +#undef _ +}; + +typedef enum { +#define _(sym,str) NSH_GRE_ENCAP_ERROR_##sym, + foreach_nsh_gre_encap_error +#undef _ + NSH_GRE_ENCAP_N_ERROR, +} nsh_gre_encap_error_t; + +typedef enum { + NSH_GRE_ENCAP_NEXT_IP4_LOOKUP, + NSH_GRE_ENCAP_NEXT_DROP, + NSH_GRE_ENCAP_N_NEXT, +} nsh_gre_encap_next_t; + +typedef struct { + u32 tunnel_index; +} nsh_gre_encap_trace_t; + +u8 * format_nsh_gre_encap_trace (u8 * s, va_list * args) +{ + CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *); + CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *); + nsh_gre_encap_trace_t * t = va_arg (*args, nsh_gre_encap_trace_t *); + + s = format (s, "NSH-GRE-ENCAP: tunnel %d", t->tunnel_index); + return s; +} + +static uword +nsh_gre_encap (vlib_main_t * vm, + vlib_node_runtime_t * node, + vlib_frame_t * from_frame) +{ + u32 n_left_from, next_index, * from, * to_next; + nsh_gre_main_t * ngm = &nsh_gre_main; + vnet_main_t * vnm = ngm->vnet_main; + u32 pkts_encapsulated = 0; + u16 old_l0 = 0, old_l1 = 0; + + from = vlib_frame_vector_args (from_frame); + n_left_from = from_frame->n_vectors; + + next_index = node->cached_next_index; + + while (n_left_from > 0) + { + u32 n_left_to_next; + + vlib_get_next_frame (vm, node, next_index, + to_next, n_left_to_next); + + while (n_left_from >= 4 && n_left_to_next >= 2) + { + u32 bi0, bi1; + vlib_buffer_t * b0, * b1; + u32 next0 = NSH_GRE_ENCAP_NEXT_IP4_LOOKUP; + u32 next1 = NSH_GRE_ENCAP_NEXT_IP4_LOOKUP; + vnet_hw_interface_t * hi0, * hi1; + ip4_header_t * ip0, * ip1; + u64 * copy_src0, * copy_dst0; + u64 * copy_src1, * copy_dst1; + nsh_gre_tunnel_t * t0, * t1; + u16 new_l0, new_l1; + ip_csum_t sum0, sum1; + + /* Prefetch next iteration. */ + { + vlib_buffer_t * p2, * p3; + + p2 = vlib_get_buffer (vm, from[2]); + p3 = vlib_get_buffer (vm, from[3]); + + vlib_prefetch_buffer_header (p2, LOAD); + vlib_prefetch_buffer_header (p3, LOAD); + + CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD); + CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD); + } + + bi0 = from[0]; + bi1 = from[1]; + to_next[0] = bi0; + to_next[1] = bi1; + from += 2; + to_next += 2; + n_left_to_next -= 2; + n_left_from -= 2; + + b0 = vlib_get_buffer (vm, bi0); + b1 = vlib_get_buffer (vm, bi1); + + hi0 = vnet_get_sup_hw_interface + (vnm, vnet_buffer(b0)->sw_if_index[VLIB_TX]); + hi1 = vnet_get_sup_hw_interface + (vnm, vnet_buffer(b1)->sw_if_index[VLIB_TX]); + + t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance); + t1 = pool_elt_at_index (ngm->tunnels, hi1->dev_instance); + + ASSERT(vec_len(t0->rewrite) >= 24); + ASSERT(vec_len(t1->rewrite) >= 24); + + /* Apply the rewrite string. $$$$ vnet_rewrite? */ + vlib_buffer_advance (b0, -(word)_vec_len(t0->rewrite)); + vlib_buffer_advance (b1, -(word)_vec_len(t1->rewrite)); + + ip0 = vlib_buffer_get_current(b0); + ip1 = vlib_buffer_get_current(b1); + /* Copy the fixed header */ + copy_dst0 = (u64 *) ip0; + copy_src0 = (u64 *) t0->rewrite; + copy_dst1 = (u64 *) ip1; + copy_src1 = (u64 *) t1->rewrite; + + copy_dst0[0] = copy_src0[0]; + copy_dst0[1] = copy_src0[1]; + copy_dst0[2] = copy_src0[2]; + + copy_dst1[0] = copy_src1[0]; + copy_dst1[1] = copy_src1[1]; + copy_dst1[2] = copy_src1[2]; + + /* If there are TLVs to copy, do so */ + if (PREDICT_FALSE (_vec_len(t0->rewrite) > 24)) + memcpy (©_dst0[3], t0->rewrite + 24 , + _vec_len (t0->rewrite)-24); + + if (PREDICT_FALSE (_vec_len(t1->rewrite) > 24)) + memcpy (©_dst1[3], t1->rewrite + 24 , + _vec_len (t1->rewrite)-24); + + /* fix the <bleep>ing outer-IP checksums */ + sum0 = ip0->checksum; + /* old_l0 always 0, see the rewrite setup */ + new_l0 = + clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)); + + sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t, + length /* changed member */); + ip0->checksum = ip_csum_fold (sum0); + ip0->length = new_l0; + + sum1 = ip1->checksum; + /* old_l1 always 1, see the rewrite setup */ + new_l1 = + clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)); + + sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t, + length /* changed member */); + ip1->checksum = ip_csum_fold (sum1); + ip1->length = new_l1; + + /* Reset to look up tunnel partner in the configured FIB */ + vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index; + vnet_buffer(b1)->sw_if_index[VLIB_TX] = t1->encap_fib_index; + pkts_encapsulated += 2; + + if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) + { + nsh_gre_encap_trace_t *tr = + vlib_add_trace (vm, node, b0, sizeof (*tr)); + tr->tunnel_index = t0 - ngm->tunnels; + } + + if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED)) + { + nsh_gre_encap_trace_t *tr = + vlib_add_trace (vm, node, b1, sizeof (*tr)); + tr->tunnel_index = t1 - ngm->tunnels; + } + + vlib_validate_buffer_enqueue_x2 (vm, node, next_index, + to_next, n_left_to_next, + bi0, bi1, next0, next1); + } + + while (n_left_from > 0 && n_left_to_next > 0) + { + u32 bi0; + vlib_buffer_t * b0; + u32 next0 = NSH_GRE_ENCAP_NEXT_IP4_LOOKUP; + vnet_hw_interface_t * hi0; + ip4_header_t * ip0; + u64 * copy_src0, * copy_dst0; + nsh_gre_tunnel_t * t0; + u16 new_l0; + ip_csum_t sum0; + + bi0 = from[0]; + to_next[0] = bi0; + from += 1; + to_next += 1; + n_left_from -= 1; + n_left_to_next -= 1; + + b0 = vlib_get_buffer (vm, bi0); + + /* 1-wide cache? */ + hi0 = vnet_get_sup_hw_interface + (vnm, vnet_buffer(b0)->sw_if_index[VLIB_TX]); + + t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance); + + ASSERT(vec_len(t0->rewrite) >= 24); + + /* Apply the rewrite string. $$$$ vnet_rewrite? */ + vlib_buffer_advance (b0, -(word)_vec_len(t0->rewrite)); + + ip0 = vlib_buffer_get_current(b0); + /* Copy the fixed header */ + copy_dst0 = (u64 *) ip0; + copy_src0 = (u64 *) t0->rewrite; + copy_dst0[0] = copy_src0[0]; + copy_dst0[1] = copy_src0[1]; + copy_dst0[2] = copy_src0[2]; + + /* If there are TLVs to copy, do so */ + if (PREDICT_FALSE (_vec_len(t0->rewrite) > 24)) + memcpy (©_dst0[3], t0->rewrite + 24 , + _vec_len (t0->rewrite)-24); + + /* fix the <bleep>ing outer-IP checksum */ + sum0 = ip0->checksum; + /* old_l0 always 0, see the rewrite setup */ + new_l0 = + clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)); + + sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t, + length /* changed member */); + ip0->checksum = ip_csum_fold (sum0); + ip0->length = new_l0; + + /* Reset to look up tunnel partner in the configured FIB */ + vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index; + pkts_encapsulated ++; + + if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED)) + { + nsh_gre_encap_trace_t *tr = + vlib_add_trace (vm, node, b0, sizeof (*tr)); + tr->tunnel_index = t0 - ngm->tunnels; + } + vlib_validate_buffer_enqueue_x1 (vm, node, next_index, + to_next, n_left_to_next, + bi0, next0); + } + + vlib_put_next_frame (vm, node, next_index, n_left_to_next); + } + vlib_node_increment_counter (vm, node->node_index, + NSH_GRE_ENCAP_ERROR_ENCAPSULATED, + pkts_encapsulated); + return from_frame->n_vectors; +} + +VLIB_REGISTER_NODE (nsh_gre_encap_node) = { + .function = nsh_gre_encap, + .name = "nsh-gre-encap", + .vector_size = sizeof (u32), + .format_trace = format_nsh_gre_encap_trace, + .type = VLIB_NODE_TYPE_INTERNAL, + + .n_errors = ARRAY_LEN(nsh_gre_encap_error_strings), + .error_strings = nsh_gre_encap_error_strings, + + .n_next_nodes = NSH_GRE_ENCAP_N_NEXT, + + // add dispositions here + .next_nodes = { + [NSH_GRE_ENCAP_NEXT_IP4_LOOKUP] = "ip4-lookup", + [NSH_GRE_ENCAP_NEXT_DROP] = "error-drop", + }, +}; diff --git a/vnet/vnet/nsh-gre/nsh_gre.c b/vnet/vnet/nsh-gre/nsh_gre.c new file mode 100644 index 00000000000..f85e71a2d43 --- /dev/null +++ b/vnet/vnet/nsh-gre/nsh_gre.c @@ -0,0 +1,537 @@ +/* + * Copyright (c) 2015 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#include <vppinfra/error.h> +#include <vppinfra/hash.h> +#include <vnet/vnet.h> +#include <vnet/ip/ip.h> +#include <vnet/l2/l2_input.h> +#include <vnet/ethernet/ethernet.h> +#include <vnet/nsh-gre/nsh_gre.h> + +nsh_gre_main_t nsh_gre_main; + +static u8 * format_decap_next (u8 * s, va_list * args) +{ + u32 next_index = va_arg (*args, u32); + + switch (next_index) + { + case NSH_INPUT_NEXT_DROP: + return format (s, "drop"); + case NSH_INPUT_NEXT_IP4_INPUT: + return format (s, "ip4"); + case NSH_INPUT_NEXT_IP6_INPUT: + return format (s, "ip6"); + default: + return format (s, "index %d", next_index); + } + return s; +} + + +u8 * format_nsh_gre_tunnel (u8 * s, va_list * args) +{ + nsh_gre_tunnel_t * t = va_arg (*args, nsh_gre_tunnel_t *); + nsh_gre_main_t * ngm = &nsh_gre_main; + + s = format (s, "[%d] %U (src) %U (dst) fibs: (encap %d, decap %d)", + t - ngm->tunnels, + format_ip4_address, &t->src, + format_ip4_address, &t->dst, + t->encap_fib_index, + t->decap_fib_index); + + s = format (s, " decap-next %U\n", format_decap_next, t->decap_next_index); + + s = format (s, " ver %d ", (t->ver_o_c>>6)); + if (t->ver_o_c & NSH_GRE_O_BIT) + s = format (s, "O-set "); + + if (t->ver_o_c & NSH_GRE_C_BIT) + s = format (s, "C-set "); + + s = format (s, "len %d (%d bytes) md_type %d next_protocol %d\n", + t->length, t->length * 4, t->md_type, t->next_protocol); + + s = format (s, " service path %d service index %d\n", + (t->spi_si>>NSH_GRE_SPI_SHIFT) & NSH_GRE_SPI_MASK, + t->spi_si & NSH_GRE_SINDEX_MASK); + + s = format (s, " c1 %d c2 %d c3 %d c4 %d\n", + t->c1, t->c2, t->c3, t->c4); + + return s; +} + +static u8 * format_nsh_gre_name (u8 * s, va_list * args) +{ + nsh_gre_main_t * ngm = &nsh_gre_main; + u32 i = va_arg (*args, u32); + u32 show_dev_instance = ~0; + + if (i < vec_len (ngm->dev_inst_by_real)) + show_dev_instance = ngm->dev_inst_by_real[i]; + + if (show_dev_instance != ~0) + i = show_dev_instance; + + return format (s, "nsh_gre_tunnel%d", i); +} + +static int nsh_gre_name_renumber (vnet_hw_interface_t * hi, + u32 new_dev_instance) +{ + nsh_gre_main_t * ngm = &nsh_gre_main; + + vec_validate_init_empty (ngm->dev_inst_by_real, hi->dev_instance, ~0); + + ngm->dev_inst_by_real [hi->dev_instance] = new_dev_instance; + + return 0; +} + +static uword dummy_interface_tx (vlib_main_t * vm, + vlib_node_runtime_t * node, + vlib_frame_t * frame) +{ + clib_warning ("you shouldn't be here, leaking buffers..."); + return frame->n_vectors; +} + +VNET_DEVICE_CLASS (nsh_gre_device_class,static) = { + .name = "NSH_GRE", + .format_device_name = format_nsh_gre_name, + .format_tx_trace = format_nsh_gre_encap_trace, + .tx_function = dummy_interface_tx, + .name_renumber = nsh_gre_name_renumber, +}; + +static uword dummy_set_rewrite (vnet_main_t * vnm, + u32 sw_if_index, + u32 l3_type, + void * dst_address, + void * rewrite, + uword max_rewrite_bytes) +{ + return 0; +} + +static u8 * format_nsh_gre_header_with_length (u8 * s, va_list * args) +{ + u32 dev_instance = va_arg (*args, u32); + s = format (s, "unimplemented dev %u", dev_instance); + return s; +} + +VNET_HW_INTERFACE_CLASS (nsh_gre_hw_class) = { + .name = "NSH_GRE", + .format_header = format_nsh_gre_header_with_length, + .set_rewrite = dummy_set_rewrite, +}; + +#define foreach_copy_field \ +_(src.as_u32) \ +_(dst.as_u32) \ +_(encap_fib_index) \ +_(decap_fib_index) \ +_(decap_next_index) \ +_(ver_o_c) \ +_(length) \ +_(md_type) \ +_(next_protocol) \ +_(spi_si) \ +_(c1) \ +_(c2) \ +_(c3) \ +_(c4) \ +_(tlvs) + +#define foreach_32bit_field \ +_(spi_si) \ +_(c1) \ +_(c2) \ +_(c3) \ +_(c4) + +static int nsh_gre_rewrite (nsh_gre_tunnel_t * t) +{ + u8 *rw = 0; + ip4_header_t * ip0; + nsh_header_t * nsh0; + ip4_gre_and_nsh_header_t * h0; + int len; + + len = sizeof (*h0) + vec_len(t->tlvs)*4; + + vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES); + + h0 = (ip4_gre_and_nsh_header_t *) rw; + + /* Fixed portion of the (outer) ip4 header */ + ip0 = &h0->ip4; + ip0->ip_version_and_header_length = 0x45; + ip0->ttl = 254; + ip0->protocol = IP_PROTOCOL_GRE; + /* we fix up the ip4 header length and checksum after-the-fact */ + ip0->src_address.as_u32 = t->src.as_u32; + ip0->dst_address.as_u32 = t->dst.as_u32; + ip0->checksum = ip4_header_checksum (ip0); + + /* GRE header, zero execpt for the NSH ethertype */ + h0->gre.protocol = clib_host_to_net_u16(GRE_PROTOCOL_nsh); + + /* NSH header */ + nsh0 = &h0->nsh; + nsh0->ver_o_c = t->ver_o_c; + nsh0->md_type = t->md_type; + nsh0->next_protocol = t->next_protocol; + nsh0->spi_si = t->spi_si; + nsh0->c1 = t->c1; + nsh0->c2 = t->c2; + nsh0->c3 = t->c3; + nsh0->c4 = t->c4; + + /* Endian swap 32-bit fields */ +#define _(x) nsh0->x = clib_host_to_net_u32(nsh0->x); + foreach_32bit_field; +#undef _ + + /* fix nsh header length */ + t->length = 6 + vec_len(t->tlvs); + nsh0->length = t->length; + + /* Copy any TLVs */ + if (vec_len(t->tlvs)) + memcpy (nsh0->tlvs, t->tlvs, 4*vec_len(t->tlvs)); + + t->rewrite = rw; + return (0); +} + +int vnet_nsh_gre_add_del_tunnel (vnet_nsh_gre_add_del_tunnel_args_t *a, + u32 * sw_if_indexp) +{ + nsh_gre_main_t * ngm = &nsh_gre_main; + nsh_gre_tunnel_t *t = 0; + vnet_main_t * vnm = ngm->vnet_main; + vnet_hw_interface_t * hi; + uword * p; + u32 hw_if_index = ~0; + u32 sw_if_index = ~0; + int rv; + u64 key; + u32 spi_si_net_byte_order; + + spi_si_net_byte_order = clib_host_to_net_u32(a->spi_si); + + key = (((u64)(a->src.as_u32))<<32) | spi_si_net_byte_order; + + p = hash_get (ngm->nsh_gre_tunnel_by_src_address, key); + + if (a->is_add) + { + /* adding a tunnel: tunnel must not already exist */ + if (p) + return VNET_API_ERROR_INVALID_VALUE; + + if (a->decap_next_index >= NSH_INPUT_N_NEXT) + return VNET_API_ERROR_INVALID_DECAP_NEXT; + + pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES); + memset (t, 0, sizeof (*t)); + + /* copy from arg structure */ +#define _(x) t->x = a->x; + foreach_copy_field; +#undef _ + + rv = nsh_gre_rewrite (t); + + if (rv) + { + pool_put (ngm->tunnels, t); + return rv; + } + + hash_set (ngm->nsh_gre_tunnel_by_src_address, key, t - ngm->tunnels); + + if (vec_len (ngm->free_nsh_gre_tunnel_hw_if_indices) > 0) + { + hw_if_index = ngm->free_nsh_gre_tunnel_hw_if_indices + [vec_len (ngm->free_nsh_gre_tunnel_hw_if_indices)-1]; + _vec_len (ngm->free_nsh_gre_tunnel_hw_if_indices) -= 1; + + hi = vnet_get_hw_interface (vnm, hw_if_index); + hi->dev_instance = t - ngm->tunnels; + hi->hw_instance = hi->dev_instance; + } + else + { + hw_if_index = vnet_register_interface + (vnm, nsh_gre_device_class.index, t - ngm->tunnels, + nsh_gre_hw_class.index, t - ngm->tunnels); + hi = vnet_get_hw_interface (vnm, hw_if_index); + hi->output_node_index = nsh_gre_encap_node.index; + } + + t->hw_if_index = hw_if_index; + t->sw_if_index = sw_if_index = hi->sw_if_index; + + vnet_sw_interface_set_flags (vnm, hi->sw_if_index, + VNET_SW_INTERFACE_FLAG_ADMIN_UP); + } + else + { + /* deleting a tunnel: tunnel must exist */ + if (!p) + return VNET_API_ERROR_NO_SUCH_ENTRY; + + t = pool_elt_at_index (ngm->tunnels, p[0]); + + vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */); + vec_add1 (ngm->free_nsh_gre_tunnel_hw_if_indices, t->hw_if_index); + + hash_unset (ngm->nsh_gre_tunnel_by_src_address, key); + vec_free (t->rewrite); + pool_put (ngm->tunnels, t); + } + + if (sw_if_indexp) + *sw_if_indexp = sw_if_index; + + return 0; +} + +static u32 fib_index_from_fib_id (u32 fib_id) +{ + ip4_main_t * im = &ip4_main; + uword * p; + + p = hash_get (im->fib_index_by_table_id, fib_id); + if (!p) + return ~0; + + return p[0]; +} + +static uword unformat_decap_next (unformat_input_t * input, va_list * args) +{ + u32 * result = va_arg (*args, u32 *); + u32 tmp; + + if (unformat (input, "drop")) + *result = NSH_INPUT_NEXT_DROP; + else if (unformat (input, "ip4")) + *result = NSH_INPUT_NEXT_IP4_INPUT; + else if (unformat (input, "ip6")) + *result = NSH_INPUT_NEXT_IP6_INPUT; + else if (unformat (input, "ethernet")) + *result = NSH_INPUT_NEXT_IP6_INPUT; + else if (unformat (input, "%d", &tmp)) + *result = tmp; + else + return 0; + return 1; +} + +static clib_error_t * +nsh_gre_add_del_tunnel_command_fn (vlib_main_t * vm, + unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + unformat_input_t _line_input, * line_input = &_line_input; + ip4_address_t src, dst; + u8 is_add = 1; + u8 src_set = 0; + u8 dst_set = 0; + u32 encap_fib_index = 0; + u32 decap_fib_index = 0; + u8 ver_o_c = 0; + u8 length = 0; + u8 md_type = 0; + u8 next_protocol = 1; /* ip4 */ + u32 spi; + u8 spi_set = 0; + u32 si; + u8 si_set = 0; + u32 spi_si; + u32 c1 = 0; + u32 c2 = 0; + u32 c3 = 0; + u32 c4 = 0; + u32 decap_next_index = 1; /* ip4_input */ + u32 *tlvs = 0; + u32 tmp; + int rv; + vnet_nsh_gre_add_del_tunnel_args_t _a, * a = &_a; + + /* Get a line of input. */ + if (! unformat_user (input, unformat_line_input, line_input)) + return 0; + + while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { + if (unformat (line_input, "del")) + is_add = 0; + else if (unformat (line_input, "src %U", + unformat_ip4_address, &src)) + src_set = 1; + else if (unformat (line_input, "dst %U", + unformat_ip4_address, &dst)) + dst_set = 1; + else if (unformat (line_input, "encap-vrf-id %d", &tmp)) + { + encap_fib_index = fib_index_from_fib_id (tmp); + if (encap_fib_index == ~0) + return clib_error_return (0, "nonexistent encap fib id %d", tmp); + } + else if (unformat (line_input, "decap-vrf-id %d", &tmp)) + { + decap_fib_index = fib_index_from_fib_id (tmp); + if (decap_fib_index == ~0) + return clib_error_return (0, "nonexistent decap fib id %d", tmp); + } + else if (unformat (line_input, "decap-next %U", unformat_decap_next, + &decap_next_index)) + ; + else if (unformat (line_input, "version %d", &tmp)) + ver_o_c |= (tmp & 3) << 6; + else if (unformat (line_input, "o-bit %d", &tmp)) + ver_o_c |= (tmp & 1) << 5; + else if (unformat (line_input, "c-bit %d", &tmp)) + ver_o_c |= (tmp & 1) << 4; + else if (unformat (line_input, "md-type %d", &tmp)) + md_type = tmp; + else if (unformat(line_input, "next-ip4")) + next_protocol = 1; + else if (unformat(line_input, "next-ip6")) + next_protocol = 2; + else if (unformat(line_input, "next-ethernet")) + next_protocol = 3; + else if (unformat (line_input, "c1 %d", &c1)) + ; + else if (unformat (line_input, "c2 %d", &c2)) + ; + else if (unformat (line_input, "c3 %d", &c3)) + ; + else if (unformat (line_input, "c4 %d", &c4)) + ; + else if (unformat (line_input, "spi %d", &spi)) + spi_set = 1; + else if (unformat (line_input, "si %d", &si)) + si_set = 1; + else if (unformat (line_input, "tlv %x")) + vec_add1 (tlvs, tmp); + else + return clib_error_return (0, "parse error: '%U'", + format_unformat_error, line_input); + } + + unformat_free (line_input); + + if (src_set == 0) + return clib_error_return (0, "tunnel src address not specified"); + + if (dst_set == 0) + return clib_error_return (0, "tunnel dst address not specified"); + + if (spi_set == 0) + return clib_error_return (0, "spi not specified"); + + if (si_set == 0) + return clib_error_return (0, "si not specified"); + + spi_si = (spi<<8) | si; + + memset (a, 0, sizeof (*a)); + + a->is_add = is_add; + +#define _(x) a->x = x; + foreach_copy_field; +#undef _ + + rv = vnet_nsh_gre_add_del_tunnel (a, 0 /* hw_if_indexp */); + + switch(rv) + { + case 0: + break; + case VNET_API_ERROR_INVALID_DECAP_NEXT: + return clib_error_return (0, "invalid decap-next..."); + + case VNET_API_ERROR_TUNNEL_EXIST: + return clib_error_return (0, "tunnel already exists..."); + + case VNET_API_ERROR_NO_SUCH_ENTRY: + return clib_error_return (0, "session does not exist..."); + + default: + return clib_error_return + (0, "vnet_nsh_gre_add_del_tunnel returned %d", rv); + } + + return 0; +} + +VLIB_CLI_COMMAND (create_nsh_gre_tunnel_command, static) = { + .path = "nsh gre tunnel", + .short_help = + "nsh gre tunnel src <ip4-addr> dst <ip4-addr>" + " c1 <nn> c2 <nn> c3 <nn> c4 <nn> spi <nn> si <nn>\n" + " [encap-fib-id <nn>] [decap-fib-id <nn>] [o-bit <1|0>] [c-bit <1|0>]\n" + " [md-type <nn>][next-ip4][next-ip6][next-ethernet]\n" + " [tlv <xx>]\n", + .function = nsh_gre_add_del_tunnel_command_fn, +}; + +static clib_error_t * +show_nsh_gre_tunnel_command_fn (vlib_main_t * vm, + unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + nsh_gre_main_t * ngm = &nsh_gre_main; + nsh_gre_tunnel_t * t; + + if (pool_elts (ngm->tunnels) == 0) + vlib_cli_output (vm, "No nsh-gre tunnels configured..."); + + pool_foreach (t, ngm->tunnels, + ({ + vlib_cli_output (vm, "%U", format_nsh_gre_tunnel, t); + })); + + return 0; +} + +VLIB_CLI_COMMAND (show_nsh_gre_tunnel_command, static) = { + .path = "show nsh gre tunnel", + .function = show_nsh_gre_tunnel_command_fn, +}; + +clib_error_t *nsh_gre_init (vlib_main_t *vm) +{ + nsh_gre_main_t *ngm = &nsh_gre_main; + + ngm->vnet_main = vnet_get_main(); + ngm->vlib_main = vm; + + ngm->nsh_gre_tunnel_by_src_address = hash_create (0, sizeof (uword)); + gre_register_input_protocol (vm, GRE_PROTOCOL_nsh, + nsh_gre_input_node.index); + return 0; +} + +VLIB_INIT_FUNCTION(nsh_gre_init); + diff --git a/vnet/vnet/nsh-gre/nsh_gre.h b/vnet/vnet/nsh-gre/nsh_gre.h new file mode 100644 index 00000000000..c82c80f6a68 --- /dev/null +++ b/vnet/vnet/nsh-gre/nsh_gre.h @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2015 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef included_vnet_nsh_gre_h +#define included_vnet_nsh_gre_h + +#include <vnet/vnet.h> +#include <vnet/gre/gre.h> +#include <vnet/nsh-gre/nsh_gre_packet.h> +#include <vnet/ip/ip4_packet.h> + +typedef CLIB_PACKED (struct { + ip4_header_t ip4; /* 20 bytes */ + gre_header_t gre; /* 4 bytes */ + nsh_header_t nsh; /* 28 bytes */ +}) ip4_gre_and_nsh_header_t; + +typedef struct { + /* Rewrite string. $$$$ embed vnet_rewrite header */ + u8 * rewrite; + + /* tunnel src and dst addresses */ + ip4_address_t src; + ip4_address_t dst; + + /* FIB indices */ + u32 encap_fib_index; /* tunnel partner lookup here */ + u32 decap_fib_index; /* inner IP lookup here */ + + /* when decapsulating, send pkts here */ + u32 decap_next_index; + + /* vnet intfc hw/sw_if_index */ + u32 hw_if_index; + u32 sw_if_index; + + /* NSH header fields in HOST byte order */ + u8 ver_o_c; + u8 length; + u8 md_type; + u8 next_protocol; + u32 spi_si; + + /* Context headers, always present, in HOST byte order */ + u32 c1, c2, c3, c4; + u32 * tlvs; +} nsh_gre_tunnel_t; + +#define foreach_nsh_gre_input_next \ + _ (DROP, "error-drop") \ + _ (IP4_INPUT, "ip4-input") \ + _ (IP6_INPUT, "ip6-input") \ + _ (ETHERNET_INPUT, "ethernet-input") + +typedef enum { +#define _(s,n) NSH_INPUT_NEXT_##s, + foreach_nsh_gre_input_next +#undef _ + NSH_INPUT_N_NEXT, +} nsh_gre_input_next_t; + +typedef enum { +#define nsh_gre_error(n,s) NSH_GRE_ERROR_##n, +#include <vnet/nsh-gre/nsh_gre_error.def> +#undef nsh_gre_error + NSH_GRE_N_ERROR, +} nsh_gre_input_error_t; + +typedef struct { + /* vector of encap tunnel instances */ + nsh_gre_tunnel_t *tunnels; + + /* lookup tunnel by tunnel partner src address */ + uword * nsh_gre_tunnel_by_src_address; + + /* Free vlib hw_if_indices */ + u32 * free_nsh_gre_tunnel_hw_if_indices; + + /* show device instance by real device instance */ + u32 * dev_inst_by_real; + + /* convenience */ + vlib_main_t * vlib_main; + vnet_main_t * vnet_main; +} nsh_gre_main_t; + +nsh_gre_main_t nsh_gre_main; + +vlib_node_registration_t nsh_gre_input_node; +vlib_node_registration_t nsh_gre_encap_node; + +u8 * format_nsh_gre_encap_trace (u8 * s, va_list * args); + +typedef struct { + u8 is_add; + ip4_address_t src, dst; + u32 encap_fib_index; + u32 decap_fib_index; + u32 decap_next_index; + u8 ver_o_c; + u8 length; + u8 md_type; + u8 next_protocol; + u32 spi_si; + u32 c1, c2, c3, c4; + u32 * tlvs; +} vnet_nsh_gre_add_del_tunnel_args_t; + +int vnet_nsh_gre_add_del_tunnel (vnet_nsh_gre_add_del_tunnel_args_t *a, + u32 * sw_if_indexp); + +#endif /* included_vnet_nsh_gre_h */ diff --git a/vnet/vnet/nsh-gre/nsh_gre_error.def b/vnet/vnet/nsh-gre/nsh_gre_error.def new file mode 100644 index 00000000000..532b02a6e89 --- /dev/null +++ b/vnet/vnet/nsh-gre/nsh_gre_error.def @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2015 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +nsh_gre_error (DECAPSULATED, "good packets decapsulated") +nsh_gre_error (NO_SUCH_TUNNEL, "no such tunnel packets") +nsh_gre_error (INVALID_NEXT_PROTOCOL, "invalid next protocol") diff --git a/vnet/vnet/nsh-gre/nsh_gre_packet.h b/vnet/vnet/nsh-gre/nsh_gre_packet.h new file mode 100644 index 00000000000..0620f227b9f --- /dev/null +++ b/vnet/vnet/nsh-gre/nsh_gre_packet.h @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2015 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef included_vnet_nsh_gre_packet_h +#define included_vnet_nsh_gre_packet_h + +/* + * NSH_GRE packet format from draft-quinn-sfc-nsh-03.txt + * + * NSH Base Header + * 0 1 2 3 + * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + * |Ver|O|C|R|R|R|R|R|R| Length | MD Type | Next Protocol | + * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + * + * + * Base Header Field Descriptions: + * + * Version: The version field is used to ensure backward compatibility + * going forward with future NSH updates. + * + * O bit: Indicates that this packet is an operations and management + * (OAM) packet. SFF and SFs nodes MUST examine the payload and take + * appropriate action (e.g. return status information). + * + * OAM message specifics and handling details are outside the scope of + * this document. + * + * C bit: Indicates that a critical metadata TLV is present (see section + * 7). This bit acts as an indication for hardware implementers to + * decide how to handle the presence of a critical TLV without + * necessarily needing to parse all TLVs present. The C bit MUST be set + * to 1 if one or more critical TLVs are present. + * + * All other flag fields are reserved. + * + * Length: total length, in 4 byte words, of the NSH header, including + * optional variable TLVs. Length must be equal or greater than 6. + * + * MD Type: indicates the format of NSH beyond the base header and the + * type of metadata being carried. This typing is used to describe the + * use for the metadata. A new registry will be requested from IANA for + * the MD Type. NSH defines one type, type = 0x1 which indicates that + * the format of the header is as per this draft. + * + * The format of the base header is invariant, and not described by MD + * Type. + * + * Next Protocol: indicates the protocol type of the original packet. A + * new IANA registry will be created for protocol type. + * + * This draft defines the following Next Protocol values: + * + * 0x1 : IPv4 + * 0x2 : IPv6 + * 0x3 : Ethernet + */ + +typedef CLIB_PACKED(struct { + u8 ver_o_c; + u8 length; + u8 md_type; + u8 next_protocol; + u32 spi_si; + /* Context headers, always present */ + u32 c1; u32 c2; u32 c3; u32 c4; + + /* Optional variable length metadata */ + u32 tlvs[0]; +}) nsh_header_t; + +#define NSH_GRE_VERSION (0<<6) +#define NSH_GRE_O_BIT (1<<5) +#define NSH_GRE_C_BIT (1<<4) + +/* Network byte order shift / mask */ +#define NSH_GRE_SINDEX_MASK 0xFF +#define NSH_GRE_SPI_MASK (0x00FFFFFF) +#define NSH_GRE_SPI_SHIFT 8 + +#endif /* included_vnet_nsh_gre_packet_h */ |