diff options
Diffstat (limited to 'src/vnet/span')
| -rw-r--r-- | src/vnet/span/node.c | 366 | ||||
| -rw-r--r-- | src/vnet/span/span.api | 56 | ||||
| -rw-r--r-- | src/vnet/span/span.c | 249 | ||||
| -rw-r--r-- | src/vnet/span/span.h | 77 | ||||
| -rw-r--r-- | src/vnet/span/span_api.c | 159 | ||||
| -rw-r--r-- | src/vnet/span/span_doc.md | 65 |
6 files changed, 972 insertions, 0 deletions
diff --git a/src/vnet/span/node.c b/src/vnet/span/node.c new file mode 100644 index 00000000..9d83d4ef --- /dev/null +++ b/src/vnet/span/node.c @@ -0,0 +1,366 @@ +/* + * Copyright (c) 2016 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/vnet.h> +#include <vppinfra/error.h> + +#include <vnet/span/span.h> +#include <vnet/l2/l2_input.h> +#include <vnet/l2/l2_output.h> +#include <vnet/l2/feat_bitmap.h> + +#include <vppinfra/error.h> +#include <vppinfra/elog.h> + +vlib_node_registration_t span_node; + +/* packet trace format function */ +u8 * +format_span_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 *); + span_trace_t *t = va_arg (*args, span_trace_t *); + + vnet_main_t *vnm = &vnet_main; + s = format (s, "SPAN: mirrored %U -> %U", + format_vnet_sw_if_index_name, vnm, t->src_sw_if_index, + format_vnet_sw_if_index_name, vnm, t->mirror_sw_if_index); + + return s; +} + +#define foreach_span_error \ +_(HITS, "SPAN incomming packets processed") + +typedef enum +{ +#define _(sym,str) SPAN_ERROR_##sym, + foreach_span_error +#undef _ + SPAN_N_ERROR, +} span_error_t; + +static char *span_error_strings[] = { +#define _(sym,string) string, + foreach_span_error +#undef _ +}; + +static_always_inline void +span_mirror (vlib_main_t * vm, vlib_node_runtime_t * node, u32 sw_if_index0, + vlib_buffer_t * b0, vlib_frame_t ** mirror_frames, + vlib_rx_or_tx_t rxtx, span_feat_t sf) +{ + vlib_buffer_t *c0; + span_main_t *sm = &span_main; + vnet_main_t *vnm = &vnet_main; + u32 *to_mirror_next = 0; + u32 i; + + span_interface_t *si0 = vec_elt_at_index (sm->interfaces, sw_if_index0); + span_mirror_t *sm0 = &si0->mirror_rxtx[sf][rxtx]; + + if (sm0->num_mirror_ports == 0) + return; + + /* Don't do it again */ + if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_SPAN_CLONE)) + return; + + /* *INDENT-OFF* */ + clib_bitmap_foreach (i, sm0->mirror_ports, ( + { + if (mirror_frames[i] == 0) + { + if (sf == SPAN_FEAT_L2) + mirror_frames[i] = vlib_get_frame_to_node (vnm->vlib_main, l2output_node.index); + else + mirror_frames[i] = vnet_get_frame_to_sw_interface (vnm, i); + } + to_mirror_next = vlib_frame_vector_args (mirror_frames[i]); + to_mirror_next += mirror_frames[i]->n_vectors; + /* This can fail */ + c0 = vlib_buffer_copy (vm, b0); + if (PREDICT_TRUE(c0 != 0)) + { + vnet_buffer (c0)->sw_if_index[VLIB_TX] = i; + c0->flags |= VNET_BUFFER_F_SPAN_CLONE; + if (sf == SPAN_FEAT_L2) + vnet_buffer (c0)->l2.feature_bitmap = L2OUTPUT_FEAT_OUTPUT; + to_mirror_next[0] = vlib_get_buffer_index (vm, c0); + mirror_frames[i]->n_vectors++; + if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED)) + { + span_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t)); + t->src_sw_if_index = sw_if_index0; + t->mirror_sw_if_index = i; + } + } + })); + /* *INDENT-ON* */ +} + +static_always_inline uword +span_node_inline_fn (vlib_main_t * vm, vlib_node_runtime_t * node, + vlib_frame_t * frame, vlib_rx_or_tx_t rxtx, + span_feat_t sf) +{ + span_main_t *sm = &span_main; + vnet_main_t *vnm = &vnet_main; + u32 n_left_from, *from, *to_next; + u32 n_span_packets = 0; + u32 next_index; + u32 sw_if_index; + static __thread vlib_frame_t **mirror_frames = 0; + + from = vlib_frame_vector_args (frame); + n_left_from = frame->n_vectors; + next_index = node->cached_next_index; + + vec_validate_aligned (mirror_frames, sm->max_sw_if_index, + CLIB_CACHE_LINE_BYTES); + + 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; + u32 bi1; + vlib_buffer_t *b0; + vlib_buffer_t *b1; + u32 sw_if_index0; + u32 next0 = 0; + u32 sw_if_index1; + u32 next1 = 0; + + /* speculatively enqueue b0, b1 to the current next frame */ + to_next[0] = bi0 = from[0]; + to_next[1] = bi1 = from[1]; + to_next += 2; + n_left_to_next -= 2; + from += 2; + n_left_from -= 2; + + b0 = vlib_get_buffer (vm, bi0); + b1 = vlib_get_buffer (vm, bi1); + sw_if_index0 = vnet_buffer (b0)->sw_if_index[rxtx]; + sw_if_index1 = vnet_buffer (b1)->sw_if_index[rxtx]; + + span_mirror (vm, node, sw_if_index0, b0, mirror_frames, rxtx, sf); + span_mirror (vm, node, sw_if_index1, b1, mirror_frames, rxtx, sf); + + switch (sf) + { + case SPAN_FEAT_L2: + if (rxtx == VLIB_RX) + { + next0 = vnet_l2_feature_next (b0, sm->l2_input_next, + L2INPUT_FEAT_SPAN); + next1 = vnet_l2_feature_next (b1, sm->l2_input_next, + L2INPUT_FEAT_SPAN); + } + else + { + next0 = vnet_l2_feature_next (b0, sm->l2_output_next, + L2OUTPUT_FEAT_SPAN); + next1 = vnet_l2_feature_next (b1, sm->l2_output_next, + L2OUTPUT_FEAT_SPAN); + } + break; + case SPAN_FEAT_DEVICE: + default: + vnet_feature_next (sw_if_index0, &next0, b0); + vnet_feature_next (sw_if_index1, &next1, b1); + break; + } + + /* verify speculative enqueue, maybe switch current next frame */ + 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 sw_if_index0; + u32 next0 = 0; + + /* speculatively enqueue b0 to the current next frame */ + to_next[0] = bi0 = from[0]; + to_next += 1; + n_left_to_next -= 1; + from += 1; + n_left_from -= 1; + + b0 = vlib_get_buffer (vm, bi0); + sw_if_index0 = vnet_buffer (b0)->sw_if_index[rxtx]; + + span_mirror (vm, node, sw_if_index0, b0, mirror_frames, rxtx, sf); + + switch (sf) + { + case SPAN_FEAT_L2: + if (rxtx == VLIB_RX) + next0 = vnet_l2_feature_next (b0, sm->l2_input_next, + L2INPUT_FEAT_SPAN); + else + next0 = vnet_l2_feature_next (b0, sm->l2_output_next, + L2OUTPUT_FEAT_SPAN); + break; + case SPAN_FEAT_DEVICE: + default: + vnet_feature_next (sw_if_index0, &next0, b0); + break; + } + + /* verify speculative enqueue, maybe switch current next frame */ + 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); + } + + + for (sw_if_index = 0; sw_if_index < vec_len (mirror_frames); sw_if_index++) + { + vlib_frame_t *f = mirror_frames[sw_if_index]; + if (f == 0) + continue; + + if (sf == SPAN_FEAT_L2) + vlib_put_frame_to_node (vnm->vlib_main, l2output_node.index, f); + else + vnet_put_frame_to_sw_interface (vnm, sw_if_index, f); + mirror_frames[sw_if_index] = 0; + } + vlib_node_increment_counter (vm, span_node.index, SPAN_ERROR_HITS, + n_span_packets); + + return frame->n_vectors; +} + +static uword +span_device_input_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node, + vlib_frame_t * frame) +{ + return span_node_inline_fn (vm, node, frame, VLIB_RX, SPAN_FEAT_DEVICE); +} + +static uword +span_device_output_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node, + vlib_frame_t * frame) +{ + return span_node_inline_fn (vm, node, frame, VLIB_TX, SPAN_FEAT_DEVICE); +} + +static uword +span_l2_input_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node, + vlib_frame_t * frame) +{ + return span_node_inline_fn (vm, node, frame, VLIB_RX, SPAN_FEAT_L2); +} + +static uword +span_l2_output_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node, + vlib_frame_t * frame) +{ + return span_node_inline_fn (vm, node, frame, VLIB_TX, SPAN_FEAT_L2); +} + +#define span_node_defs \ + .vector_size = sizeof (u32), \ + .format_trace = format_span_trace, \ + .type = VLIB_NODE_TYPE_INTERNAL, \ + .n_errors = ARRAY_LEN(span_error_strings), \ + .error_strings = span_error_strings, \ + .n_next_nodes = 0, \ + .next_nodes = { \ + [0] = "error-drop" \ + } + +/* *INDENT-OFF* */ +VLIB_REGISTER_NODE (span_input_node) = { + span_node_defs, + .function = span_device_input_node_fn, + .name = "span-input", +}; + +VLIB_NODE_FUNCTION_MULTIARCH (span_input_node, span_device_input_node_fn) + +VLIB_REGISTER_NODE (span_output_node) = { + span_node_defs, + .function = span_device_output_node_fn, + .name = "span-output", +}; + +VLIB_NODE_FUNCTION_MULTIARCH (span_output_node, span_device_output_node_fn) + +VLIB_REGISTER_NODE (span_l2_input_node) = { + span_node_defs, + .function = span_l2_input_node_fn, + .name = "span-l2-input", +}; + +VLIB_NODE_FUNCTION_MULTIARCH (span_l2_input_node, span_l2_input_node_fn) + +VLIB_REGISTER_NODE (span_l2_output_node) = { + span_node_defs, + .function = span_l2_output_node_fn, + .name = "span-l2-output", +}; + +VLIB_NODE_FUNCTION_MULTIARCH (span_l2_output_node, span_l2_output_node_fn) + +clib_error_t *span_init (vlib_main_t * vm) +{ + span_main_t *sm = &span_main; + + sm->vlib_main = vm; + sm->vnet_main = vnet_get_main (); + + /* Initialize the feature next-node indexes */ + feat_bitmap_init_next_nodes (vm, + span_l2_input_node.index, + L2INPUT_N_FEAT, + l2input_get_feat_names (), + sm->l2_input_next); + + feat_bitmap_init_next_nodes (vm, + span_l2_output_node.index, + L2OUTPUT_N_FEAT, + l2output_get_feat_names (), + sm->l2_output_next); + return 0; +} + +VLIB_INIT_FUNCTION (span_init); +/* *INDENT-ON* */ + +#undef span_node_defs +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ diff --git a/src/vnet/span/span.api b/src/vnet/span/span.api new file mode 100644 index 00000000..03cd60ec --- /dev/null +++ b/src/vnet/span/span.api @@ -0,0 +1,56 @@ +/* Hey Emacs use -*- mode: C -*- */ +/* + * Copyright (c) 2016 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. + */ + + /** \brief Enable/Disable span to mirror traffic from one interface to another + @param client_index - opaque cookie to identify the sender + @param context - sender context which was passed in the request + @param sw_if_index_from - interface to be mirorred + @param sw_if_index_to - interface where the traffic is mirrored + @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled + @param is_l2 - 0 = mirror at hw device level, 1 = mirror at L2 +*/ +autoreply define sw_interface_span_enable_disable { + u32 client_index; + u32 context; + u32 sw_if_index_from; + u32 sw_if_index_to; + u8 state; + u8 is_l2; +}; + +/** \brief SPAN dump request + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param is_l2 - 0 = hw device level, 1 = L2 +*/ +define sw_interface_span_dump { + u32 client_index; + u32 context; + u8 is_l2; +}; + +/** \brief Reply to SPAN dump request + @param context - sender context which was passed in the request + @param sw_if_index_from - mirorred interface + @param sw_if_index_to - interface where the traffic is mirrored + @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled +*/ +define sw_interface_span_details { + u32 context; + u32 sw_if_index_from; + u32 sw_if_index_to; + u8 state; +}; diff --git a/src/vnet/span/span.c b/src/vnet/span/span.c new file mode 100644 index 00000000..2fd9cd87 --- /dev/null +++ b/src/vnet/span/span.c @@ -0,0 +1,249 @@ +/* + * Copyright (c) 2016 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 <vppinfra/error.h> +#include <vnet/feature/feature.h> +#include <vnet/l2/l2_input.h> +#include <vnet/l2/l2_output.h> + +#include <vnet/span/span.h> + +typedef enum +{ + SPAN_DISABLE = 0, + SPAN_RX = 1, + SPAN_TX = 2, + SPAN_BOTH = SPAN_RX | SPAN_TX +} span_state_t; + +static_always_inline u32 +span_dst_set (span_mirror_t * sm, u32 dst_sw_if_index, int enable) +{ + if (dst_sw_if_index == ~0) + { + ASSERT (enable == 0); + clib_bitmap_zero (sm->mirror_ports); + } + else + sm->mirror_ports = + clib_bitmap_set (sm->mirror_ports, dst_sw_if_index, enable); + + u32 last = sm->num_mirror_ports; + sm->num_mirror_ports = clib_bitmap_count_set_bits (sm->mirror_ports); + return last; +} + +int +span_add_delete_entry (vlib_main_t * vm, + u32 src_sw_if_index, u32 dst_sw_if_index, u8 state, + span_feat_t sf) +{ + span_main_t *sm = &span_main; + + if (state > SPAN_BOTH) + return VNET_API_ERROR_UNIMPLEMENTED; + + if ((src_sw_if_index == ~0) || (dst_sw_if_index == ~0 && state > 0) + || (src_sw_if_index == dst_sw_if_index)) + return VNET_API_ERROR_INVALID_INTERFACE; + + vec_validate_aligned (sm->interfaces, src_sw_if_index, + CLIB_CACHE_LINE_BYTES); + + span_interface_t *si = vec_elt_at_index (sm->interfaces, src_sw_if_index); + + int rx = ! !(state & SPAN_RX); + int tx = ! !(state & SPAN_TX); + + span_mirror_t *rxm = &si->mirror_rxtx[sf][VLIB_RX]; + span_mirror_t *txm = &si->mirror_rxtx[sf][VLIB_TX]; + + u32 last_rx_ports_count = span_dst_set (rxm, dst_sw_if_index, rx); + u32 last_tx_ports_count = span_dst_set (txm, dst_sw_if_index, tx); + + int enable_rx = last_rx_ports_count == 0 && rxm->num_mirror_ports == 1; + int disable_rx = last_rx_ports_count > 0 && rxm->num_mirror_ports == 0; + int enable_tx = last_tx_ports_count == 0 && txm->num_mirror_ports == 1; + int disable_tx = last_tx_ports_count > 0 && txm->num_mirror_ports == 0; + + switch (sf) + { + case SPAN_FEAT_DEVICE: + if (enable_rx || disable_rx) + vnet_feature_enable_disable ("device-input", "span-input", + src_sw_if_index, rx, 0, 0); + if (enable_tx || disable_tx) + vnet_feature_enable_disable ("interface-output", "span-output", + src_sw_if_index, tx, 0, 0); + break; + case SPAN_FEAT_L2: + if (enable_rx || disable_rx) + l2input_intf_bitmap_enable (src_sw_if_index, L2INPUT_FEAT_SPAN, rx); + if (enable_tx || disable_tx) + l2output_intf_bitmap_enable (src_sw_if_index, L2OUTPUT_FEAT_SPAN, tx); + break; + default: + return VNET_API_ERROR_UNIMPLEMENTED; + } + + if (dst_sw_if_index != ~0 && dst_sw_if_index > sm->max_sw_if_index) + sm->max_sw_if_index = dst_sw_if_index; + + return 0; +} + +static uword +unformat_span_state (unformat_input_t * input, va_list * args) +{ + span_state_t *state = va_arg (*args, span_state_t *); + if (unformat (input, "disable")) + *state = SPAN_DISABLE; + else if (unformat (input, "rx")) + *state = SPAN_RX; + else if (unformat (input, "tx")) + *state = SPAN_TX; + else if (unformat (input, "both")) + *state = SPAN_BOTH; + else + return 0; + return 1; +} + +static clib_error_t * +set_interface_span_command_fn (vlib_main_t * vm, + unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + span_main_t *sm = &span_main; + u32 src_sw_if_index = ~0; + u32 dst_sw_if_index = ~0; + span_feat_t sf = SPAN_FEAT_DEVICE; + span_state_t state = SPAN_BOTH; + int state_set = 0; + + while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) + { + if (unformat (input, "%U", unformat_vnet_sw_interface, + sm->vnet_main, &src_sw_if_index)) + ; + else if (unformat (input, "destination %U", unformat_vnet_sw_interface, + sm->vnet_main, &dst_sw_if_index)) + ; + else if (unformat (input, "%U", unformat_span_state, &state)) + { + if (state_set) + return clib_error_return (0, "Multiple mirror states in input"); + state_set = 1; + } + else if (unformat (input, "l2")) + sf = SPAN_FEAT_L2; + else + return clib_error_return (0, "Invalid input"); + } + + int rv = + span_add_delete_entry (vm, src_sw_if_index, dst_sw_if_index, state, sf); + if (rv == VNET_API_ERROR_INVALID_INTERFACE) + return clib_error_return (0, "Invalid interface"); + return 0; +} + +/* *INDENT-OFF* */ +VLIB_CLI_COMMAND (set_interface_span_command, static) = { + .path = "set interface span", + .short_help = "set interface span <if-name> [l2] {disable | destination <if-name> [both|rx|tx]}", + .function = set_interface_span_command_fn, +}; +/* *INDENT-ON* */ + +static clib_error_t * +show_interfaces_span_command_fn (vlib_main_t * vm, + unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + span_main_t *sm = &span_main; + span_interface_t *si; + vnet_main_t *vnm = &vnet_main; + u8 header = 1; + static const char *states[] = { + [SPAN_DISABLE] = "none", + [SPAN_RX] = "rx", + [SPAN_TX] = "tx", + [SPAN_BOTH] = "both" + }; + u8 *s = 0; + + /* *INDENT-OFF* */ + vec_foreach (si, sm->interfaces) + { + span_mirror_t * drxm = &si->mirror_rxtx[SPAN_FEAT_DEVICE][VLIB_RX]; + span_mirror_t * dtxm = &si->mirror_rxtx[SPAN_FEAT_DEVICE][VLIB_TX]; + + span_mirror_t * lrxm = &si->mirror_rxtx[SPAN_FEAT_L2][VLIB_RX]; + span_mirror_t * ltxm = &si->mirror_rxtx[SPAN_FEAT_L2][VLIB_TX]; + + if (drxm->num_mirror_ports || dtxm->num_mirror_ports || + lrxm->num_mirror_ports || ltxm->num_mirror_ports) + { + u32 i; + clib_bitmap_t *d = clib_bitmap_dup_or (drxm->mirror_ports, dtxm->mirror_ports); + clib_bitmap_t *l = clib_bitmap_dup_or (lrxm->mirror_ports, ltxm->mirror_ports); + clib_bitmap_t *b = clib_bitmap_dup_or (d, l); + if (header) + { + vlib_cli_output (vm, "%-20s %-20s %6s %6s", "Source", "Destination", + "Device", "L2"); + header = 0; + } + s = format (s, "%U", format_vnet_sw_if_index_name, vnm, + si - sm->interfaces); + clib_bitmap_foreach (i, b, ( + { + int device = (clib_bitmap_get (drxm->mirror_ports, i) + + clib_bitmap_get (dtxm->mirror_ports, i) * 2); + int l2 = (clib_bitmap_get (lrxm->mirror_ports, i) + + clib_bitmap_get (ltxm->mirror_ports, i) * 2); + + vlib_cli_output (vm, "%-20v %-20U (%6s) (%6s)", s, + format_vnet_sw_if_index_name, vnm, i, + states[device], states[l2]); + vec_reset_length (s); + })); + clib_bitmap_free (b); + clib_bitmap_free (l); + clib_bitmap_free (d); + } + } + /* *INDENT-ON* */ + vec_free (s); + return 0; +} + +/* *INDENT-OFF* */ +VLIB_CLI_COMMAND (show_interfaces_span_command, static) = { + .path = "show interface span", + .short_help = "Shows SPAN mirror table", + .function = show_interfaces_span_command_fn, +}; +/* *INDENT-ON* */ + +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ diff --git a/src/vnet/span/span.h b/src/vnet/span/span.h new file mode 100644 index 00000000..10de8272 --- /dev/null +++ b/src/vnet/span/span.h @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2016 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 __span_h__ +#define __span_h__ + +#include <vnet/vnet.h> +#include <vnet/ip/ip.h> +#include <vnet/l2/l2_output.h> + +typedef enum +{ + SPAN_FEAT_DEVICE, + SPAN_FEAT_L2, + SPAN_FEAT_N +} span_feat_t; + +typedef struct +{ + clib_bitmap_t *mirror_ports; + u32 num_mirror_ports; +} span_mirror_t; + +typedef struct +{ + span_mirror_t mirror_rxtx[SPAN_FEAT_N][VLIB_N_RX_TX]; +} span_interface_t; + +typedef struct +{ + /* l2 feature Next nodes */ + u32 l2_input_next[32]; + u32 l2_output_next[32]; + + /* per-interface vector of span instances */ + span_interface_t *interfaces; + + /* biggest sw_if_index used so far */ + u32 max_sw_if_index; + + /* convenience */ + vlib_main_t *vlib_main; + vnet_main_t *vnet_main; +} span_main_t; + +span_main_t span_main; + +typedef struct +{ + u32 src_sw_if_index; /* mirrored interface index */ + u32 mirror_sw_if_index; /* output interface index */ +} span_trace_t; + +#endif /* __span_h__ */ + +int +span_add_delete_entry (vlib_main_t * vm, u32 src_sw_if_index, + u32 dst_sw_if_index, u8 state, span_feat_t sf); +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ diff --git a/src/vnet/span/span_api.c b/src/vnet/span/span_api.c new file mode 100644 index 00000000..64a71a2e --- /dev/null +++ b/src/vnet/span/span_api.c @@ -0,0 +1,159 @@ +/* + *------------------------------------------------------------------ + * span_api.c - span mirroring api + * + * Copyright (c) 2016 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 <vnet/vnet.h> +#include <vlibmemory/api.h> + +#include <vnet/interface.h> +#include <vnet/api_errno.h> +#include <vnet/span/span.h> + +#include <vnet/vnet_msg_enum.h> + +#define vl_typedefs /* define message structures */ +#include <vnet/vnet_all_api_h.h> +#undef vl_typedefs + +#define vl_endianfun /* define message structures */ +#include <vnet/vnet_all_api_h.h> +#undef vl_endianfun + +/* instantiate all the print functions we know about */ +#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__) +#define vl_printfun +#include <vnet/vnet_all_api_h.h> +#undef vl_printfun + +#include <vlibapi/api_helper_macros.h> + +#define foreach_vpe_api_msg \ +_(SW_INTERFACE_SPAN_ENABLE_DISABLE, sw_interface_span_enable_disable) \ +_(SW_INTERFACE_SPAN_DUMP, sw_interface_span_dump) \ + +static void + vl_api_sw_interface_span_enable_disable_t_handler + (vl_api_sw_interface_span_enable_disable_t * mp) +{ + vl_api_sw_interface_span_enable_disable_reply_t *rmp; + int rv; + + vlib_main_t *vm = vlib_get_main (); + + rv = span_add_delete_entry (vm, ntohl (mp->sw_if_index_from), + ntohl (mp->sw_if_index_to), mp->state, + mp->is_l2 ? SPAN_FEAT_L2 : SPAN_FEAT_DEVICE); + + REPLY_MACRO (VL_API_SW_INTERFACE_SPAN_ENABLE_DISABLE_REPLY); +} + +static void +vl_api_sw_interface_span_dump_t_handler (vl_api_sw_interface_span_dump_t * mp) +{ + + unix_shared_memory_queue_t *q; + span_interface_t *si; + vl_api_sw_interface_span_details_t *rmp; + span_main_t *sm = &span_main; + + q = vl_api_client_index_to_input_queue (mp->client_index); + if (!q) + return; + + span_feat_t sf = mp->is_l2 ? SPAN_FEAT_L2 : SPAN_FEAT_DEVICE; + /* *INDENT-OFF* */ + vec_foreach (si, sm->interfaces) + { + span_mirror_t * rxm = &si->mirror_rxtx[sf][VLIB_RX]; + span_mirror_t * txm = &si->mirror_rxtx[sf][VLIB_TX]; + if (rxm->num_mirror_ports || txm->num_mirror_ports) + { + clib_bitmap_t *b; + u32 i; + b = clib_bitmap_dup_or (rxm->mirror_ports, txm->mirror_ports); + clib_bitmap_foreach (i, b, ( + { + rmp = vl_msg_api_alloc (sizeof (*rmp)); + memset (rmp, 0, sizeof (*rmp)); + rmp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_SPAN_DETAILS); + rmp->context = mp->context; + + rmp->sw_if_index_from = htonl (si - sm->interfaces); + rmp->sw_if_index_to = htonl (i); + rmp->state = (u8) (clib_bitmap_get (rxm->mirror_ports, i) + + clib_bitmap_get (txm->mirror_ports, i) * 2); + + vl_msg_api_send_shmem (q, (u8 *) & rmp); + })); + clib_bitmap_free (b); + } + } + /* *INDENT-ON* */ +} + +/* + * vpe_api_hookup + * Add vpe's API message handlers to the table. + * vlib has alread mapped shared memory and + * added the client registration handlers. + * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process() + */ +#define vl_msg_name_crc_list +#include <vnet/vnet_all_api_h.h> +#undef vl_msg_name_crc_list + +static void +setup_message_id_table (api_main_t * am) +{ +#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id); + foreach_vl_msg_name_crc_span; +#undef _ +} + +static clib_error_t * +span_api_hookup (vlib_main_t * vm) +{ + api_main_t *am = &api_main; + +#define _(N,n) \ + vl_msg_api_set_handlers(VL_API_##N, #n, \ + vl_api_##n##_t_handler, \ + vl_noop_handler, \ + vl_api_##n##_t_endian, \ + vl_api_##n##_t_print, \ + sizeof(vl_api_##n##_t), 1); + foreach_vpe_api_msg; +#undef _ + + /* + * Set up the (msg_name, crc, message-id) table + */ + setup_message_id_table (am); + + return 0; +} + +VLIB_API_INIT_FUNCTION (span_api_hookup); + +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ diff --git a/src/vnet/span/span_doc.md b/src/vnet/span/span_doc.md new file mode 100644 index 00000000..46480b28 --- /dev/null +++ b/src/vnet/span/span_doc.md @@ -0,0 +1,65 @@ +# VPP SPAN implementation {#span_doc} + +This is a memo intended to contain documentation of the VPP SPAN implementation. +Everything that is not directly obvious should come here. + + +## Switched Port Analyzer (SPAN) +Port mirroring is used on a network switch to send a copy of network packets seen on one switch port to a network monitoring connection on another switch port. +Can be used by network engineers or administrators to measure performnce, analyze and debug data or diagnose errors on a network. + +### RX traffic node +There is one static node to mirror incomming packets. +* span-input: Creates a copy of incomming buffer due to incomming buffers can be reused internally. + +Chaining: dpdk-input -> span-input -> +* original buffer is sent to ethernet-input for processing +* buffer copy is sent to interface-output + +### Configuration +SPAN supports the following CLI configuration commands: + +#### Enable/Disable SPAN (CLI) + set interface span <if-name> [disable | destination <if-name>] + +<if-name>: mirrored interface name +destination <if-name>: monitoring interface name +disable: delete mirroring + +#### Enable/Disabl SPAN (API) +SPAN supports the following API configuration command: + sw_interface_span_enable_disable src GigabitEthernet0/8/0 dst GigabitEthernet0/9/0 + sw_interface_span_enable_disable src_sw_if_index 1 dst_sw_if_index 2 + +src/src_sw_if_index: mirrored interface name +dst/dst_sw_if_index: monitoring interface name + +#### Remove SPAN entry (API) +SPAN supports the following API configuration command: + sw_interface_span_enable_disable src_sw_if_index 1 dst_sw_if_index 2 disable + +src_sw_if_index: mirrored interface name +dst_sw_if_index: monitoring interface name + +### Configuration example + +Mirror all packets on interface GigabitEthernet0/10/0 to interface GigabitEthernet0/11/0. + +Configure IPv4 addresses on mirrored interface: +set interface ip address GigabitEthernet0/10/0 192.168.1.13/24 +set interface state GigabitEthernet0/10/0 up + +Configure IPv4 addresses on monitoring interface: +set interface ip address GigabitEthernet0/11/0 192.168.2.13/24 +set interface state GigabitEthernet0/11/0 up + +Configure SPAN +set span src GigabitEthernet0/10/0 dst GigabitEthernet0/11/0 + +### Operational data + +Active SPAN mirroring CLI show command: + show interfaces span + +Active SPAN mirroring API dump command: + sw_interface_span_dump |