API refactoring : classify - vpp - Vector Packet Processing

diff options

author	Pavel Kotucek <pkotucek@cisco.com>	2017-01-24 10:58:12 +0100
committer	Damjan Marion <dmarion.lists@gmail.com>	2017-01-25 15:53:22 +0000
commit	d2c97d988b2fbc28f0905d1826b428967d09348a (patch)
tree	253b423a12a287761b91384d53642a408dd4e868 /src/vlib/cli_funcs.h
parent	4bce290f3ee6e85c1dc6fb1d0d8d2c0e2650f670 (diff)

API refactoring : classify

Change-Id: Ib75197ef8e5057e7f0d9361a10705c3743d05333 Signed-off-by: Pavel Kotucek <pkotucek@cisco.com>

Diffstat (limited to 'src/vlib/cli_funcs.h')

0 files changed, 0 insertions, 0 deletions

/* * 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. */ /* * pg.h: VLIB packet generator * * Copyright (c) 2008 Eliot Dresselhaus * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef included_vlib_pg_h #define included_vlib_pg_h #include <vlib/vlib.h> /* for VLIB_N_RX_TX */ #include <vnet/pg/edit.h> #include <vppinfra/fifo.h> /* for buffer_fifo */ #include <vppinfra/pcap.h> #include <vnet/interface.h> #include <vnet/ethernet/mac_address.h> #include <vnet/gso/gro.h> extern vnet_device_class_t pg_dev_class; struct pg_main_t; struct pg_stream_t; typedef struct pg_edit_group_t { /* Edits in this group. */ pg_edit_t *edits; /* Vector of non-fixed edits for this group. */ pg_edit_t *non_fixed_edits; /* Fixed edits for this group. */ u8 *fixed_packet_data; u8 *fixed_packet_data_mask; /* Byte offset where packet data begins. */ u32 start_byte_offset; /* Number of packet bytes for this edit group. */ u32 n_packet_bytes; /* Function to perform miscellaneous edits (e.g. set IP checksum, ...). */ void (*edit_function) (struct pg_main_t * pg, struct pg_stream_t * s, struct pg_edit_group_t * g, u32 * buffers, u32 n_buffers); /* Opaque data for edit function's use. */ uword edit_function_opaque; } pg_edit_group_t; /* Packets are made of multiple buffers chained together. This struct keeps track of data per-chain index. */ typedef struct { /* Vector of buffer edits for this stream and buffer index. */ pg_edit_t *edits; /* Buffers pre-initialized with fixed buffer data for this stream. */ u32 *buffer_fifo; } pg_buffer_index_t; typedef struct pg_stream_t { /* Stream name. */ u8 *name; u32 flags; /* Stream is currently enabled. */ #define PG_STREAM_FLAGS_IS_ENABLED (1 << 0) /* Edit groups are created by each protocol level (e.g. ethernet, ip4, tcp, ...). */ pg_edit_group_t *edit_groups; pg_edit_type_t packet_size_edit_type; /* Min/max packet size. */ u32 min_packet_bytes, max_packet_bytes; /* Vector of non-fixed edits for this stream. All fixed edits are performed and placed into fixed_packet_data. */ pg_edit_t *non_fixed_edits; /* Packet data with all fixed edits performed. All packets in stream are initialized according with this data. Mask specifies which bits of packet data are covered by fixed edits. */ u8 *fixed_packet_data, *fixed_packet_data_mask; /* Size to use for buffers. 0 means use buffers big enough for max_packet_bytes. */ u32 buffer_bytes; /* Buffer flags to set in each packet e.g. l2 valid flags */ u32 buffer_flags; /* Buffer offload flags to set in each packet e.g. checksum offload flags */ u32 buffer_oflags; /* Last packet length if packet size edit type is increment. */ u32 last_increment_packet_size; /* Index into main interface pool for this stream. */ u32 pg_if_index; /* Interface used to mark packets for this stream. May be different than hw/sw index from pg main interface pool. They will be different if this stream is being used generate buffers as if they were received on a non-pg interface. For example, suppose you are trying to test vlan code and you want to generate buffers that appear to come from an ethernet interface. */ u32 sw_if_index[VLIB_N_RX_TX]; /* Node where stream's buffers get put. */ u32 node_index; /* Worker thread index */ u32 worker_index; /* Output next index to reach output node from stream input node. */ u32 next_index; u32 if_id; /* Number of packets currently generated. */ u64 n_packets_generated; /* Stream is disabled when packet limit is reached. Zero means no packet limit. */ u64 n_packets_limit; /* Only generate up to n_max_frame per frame. */ u32 n_max_frame; /* Rate for this stream in packets/second. Zero means unlimited rate. */ f64 rate_packets_per_second; f64 time_last_generate; f64 packet_accumulator; pg_buffer_index_t *buffer_indices; u8 **replay_packet_templates; u64 *replay_packet_timestamps; u32 current_replay_packet_index; } pg_stream_t; always_inline void pg_buffer_index_free (pg_buffer_index_t * bi) { vec_free (bi->edits); clib_fifo_free (bi->buffer_fifo); } always_inline void pg_edit_group_free (pg_edit_group_t * g) { pg_edit_t *e; vec_foreach (e, g->edits) pg_edit_free (e); vec_free (g->edits); vec_free (g->fixed_packet_data); vec_free (g->fixed_packet_data_mask); } always_inline void pg_stream_free (pg_stream_t * s) { int i; pg_edit_group_t *g; pg_edit_t *e; vec_foreach (e, s->non_fixed_edits) pg_edit_free (e); vec_free (s->non_fixed_edits); vec_foreach (g, s->edit_groups) pg_edit_group_free (g); vec_free (s->edit_groups); vec_free (s->fixed_packet_data); vec_free (s->fixed_packet_data_mask); vec_free (s->name); for (i = 0; i < vec_len (s->replay_packet_templates); i++) vec_free (s->replay_packet_templates[i]); vec_free (s->replay_packet_templates); vec_free (s->replay_packet_timestamps); { pg_buffer_index_t *bi; vec_foreach (bi, s->buffer_indices) pg_buffer_index_free (bi); vec_free (s->buffer_indices); } } always_inline int pg_stream_is_enabled (pg_stream_t * s) { return (s->flags & PG_STREAM_FLAGS_IS_ENABLED) != 0; } always_inline pg_edit_group_t * pg_stream_get_group (pg_stream_t * s, u32 group_index) { return vec_elt_at_index (s->edit_groups, group_index); } always_inline void * pg_create_edit_group (pg_stream_t * s, int n_edit_bytes, int n_packet_bytes, u32 * group_index) { pg_edit_group_t *g; int n_edits; vec_add2 (s->edit_groups, g, 1); if (group_index) *group_index = g - s->edit_groups; ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0); n_edits = n_edit_bytes / sizeof (pg_edit_t); vec_resize (g->edits, n_edits); g->n_packet_bytes = n_packet_bytes; return g->edits; } always_inline void * pg_add_edits (pg_stream_t * s, int n_edit_bytes, int n_packet_bytes, u32 group_index) { pg_edit_group_t *g = pg_stream_get_group (s, group_index); pg_edit_t *e; int n_edits; ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0); n_edits = n_edit_bytes / sizeof (pg_edit_t); vec_add2 (g->edits, e, n_edits); g->n_packet_bytes += n_packet_bytes; return e; } always_inline void * pg_get_edit_group (pg_stream_t * s, u32 group_index) { pg_edit_group_t *g = pg_stream_get_group (s, group_index); return g->edits; } /* Number of bytes for all groups >= given group. */ always_inline uword pg_edit_group_n_bytes (pg_stream_t * s, u32 group_index) { pg_edit_group_t *g; uword n_bytes = 0; for (g = s->edit_groups + group_index; g < vec_end (s->edit_groups); g++) n_bytes += g->n_packet_bytes; return n_bytes; } always_inline void pg_free_edit_group (pg_stream_t * s) { uword i = vec_len (s->edit_groups) - 1; pg_edit_group_t *g = pg_stream_get_group (s, i); pg_edit_group_free (g); clib_memset (g, 0, sizeof (g[0])); _vec_len (s->edit_groups) = i; } typedef enum pg_interface_mode_t_ { PG_MODE_ETHERNET, PG_MODE_IP4, PG_MODE_IP6, } pg_interface_mode_t; typedef struct { /* TX lock */ volatile u32 *lockp; /* VLIB interface indices. */ u32 hw_if_index, sw_if_index; /* Identifies stream for this interface. */ u32 id; u8 coalesce_enabled; gro_flow_table_t *flow_table; u8 gso_enabled; u32 gso_size; pcap_main_t pcap_main; char *pcap_file_name; pg_interface_mode_t mode; mac_address_t *allowed_mcast_macs; } pg_interface_t; /* Per VLIB node data. */ typedef struct { /* Parser function indexed by node index. */ unformat_function_t *unformat_edit; } pg_node_t; typedef struct pg_main_t { /* Pool of streams. */ pg_stream_t *streams; /* Bitmap indicating which streams are currently enabled. */ uword **enabled_streams; /* Hash mapping name -> stream index. */ uword *stream_index_by_name; /* Pool of interfaces. */ pg_interface_t *interfaces; uword *if_index_by_if_id; uword *if_id_by_sw_if_index; /* Vector of buffer indices for use in pg_stream_fill_replay, per thread */ u32 **replay_buffers_by_thread; /* Per VLIB node information. */ pg_node_t *nodes; u16 msg_id_base; } pg_main_t; /* Global main structure. */ extern pg_main_t pg_main; /* Global node. */ extern vlib_node_registration_t pg_input_node; /* Buffer generator input, output node functions. */ vlib_node_function_t pg_input, pg_output; /* Stream add/delete. */ void pg_stream_del (pg_main_t * pg, uword index); void pg_stream_add (pg_main_t * pg, pg_stream_t * s_init); void pg_stream_change (pg_main_t * pg, pg_stream_t * s); /* Enable/disable stream. */ void pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s, int is_enable); /* Enable/disable packet coalesce on given interface */ void pg_interface_enable_disable_coalesce (pg_interface_t * pi, u8 enable, u32 tx_node_index); /* Find/create free packet-generator interface index. */ u32 pg_interface_add_or_get (pg_main_t *pg, uword stream_index, u8 gso_enabled, u32 gso_size, u8 coalesce_enabled, pg_interface_mode_t mode); always_inline pg_node_t * pg_get_node (uword node_index) { pg_main_t *pg = &pg_main; vec_validate (pg->nodes, node_index); return pg->nodes + node_index; } void pg_edit_group_get_fixed_packet_data (pg_stream_t * s, u32 group_index, void *fixed_packet_data, void *fixed_packet_data_mask); void pg_enable_disable (u32 stream_index, int is_enable); typedef struct { u32 hw_if_index; u32 dev_instance; u8 is_enabled; char *pcap_file_name; u32 count; } pg_capture_args_t; clib_error_t *pg_capture (pg_capture_args_t * a); typedef struct { u32 buffer_index; vlib_buffer_t buffer; } pg_output_trace_t; #endif /* included_vlib_pg_h */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */


context:
space:
mode: