;;; plugin-node-skel.el - vpp engine plug-in "node.c" skeleton
;;;
;;; 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.
(require 'skeleton)
(define-skeleton skel-plugin-qsnode
"Insert a plug-in 'node.c' skeleton "
nil
'(if (not (boundp 'plugin-name))
(setq plugin-name (read-string "Plugin name: ")))
'(setq PLUGIN-NAME (upcase plugin-name))
'(setq capital-oh-en "ON")
"/*
* node.c - skeleton vpp engine plug-in dual-loop node skeleton
*
* Copyright (c) <current-year> <your-organization>
* 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 <vnet/pg/pg.h>
#include <vppinfra/error.h>
#include <" plugin-name "/" plugin-name ".h>
typedef struct
{
u32 sw_if_index;
u32 next_index;
} " plugin-name "_trace_t;
#ifndef CLIB_MARCH_VARIANT
/* packet trace format function */
static u8 * format_" plugin-name "_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 *);
" plugin-name "_trace_t * t = va_arg (*args, " plugin-name "_trace_t *);
s = format (s, \"" PLUGIN-NAME ": sw_if_index %d, next index %d\\n\",
t->sw_if_index, t->next_index);
return s;
}
vlib_node_registration_t " plugin-name "_node;
#endif /* CLIB_MARCH_VARIANT */
#define foreach_" plugin-name "_error \\
_(SWAPPED, \"Mac swap packets processed\")
typedef enum
{
#define _(sym,str) " PLUGIN-NAME "_ERROR_##sym,
foreach_" plugin-name "_error
#undef _
" PLUGIN-NAME "_N_ERROR,
} " plugin-name "_error_t;
#ifndef CLIB_MARCH_VARIANT
static char * " plugin-name "_error_strings[] =
{
#define _(sym,string) string,
foreach_" plugin-name "_error
#undef _
};
#endif /* CLIB_MARCH_VARIANT */
typedef enum
{
" PLUGIN-NAME "_NEXT_DROP,
" PLUGIN-NAME "_N_NEXT,
} " plugin-name "_next_t;
always_inline uword
"plugin-name"_inline (vlib_main_t * vm,
vlib_node_runtime_t * node, vlib_frame_t * frame,
int is_ip4, int is_trace)
{
u32 n_left_from, *from;
vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
u16 nexts[VLIB_FRAME_SIZE], *next;
from = vlib_frame_vector_args (frame);
n_left_from = frame->n_vectors;
vlib_get_buffers (vm, from, bufs, n_left_from);
b = bufs;
next = nexts;
while (n_left_from >= 4)
{
/* Prefetch next iteration. */
if (PREDICT_TRUE (n_left_from >= 8))
{
vlib_prefetch_buffer_header (b[4], STORE);
vlib_prefetch_buffer_header (b[5], STORE);
vlib_prefetch_buffer_header (b[6], STORE);
vlib_prefetch_buffer_header (b[7], STORE);
CLIB_PREFETCH (b[4]->data, CLIB_CACHE_LINE_BYTES, STORE);
CLIB_PREFETCH (b[5]->data, CLIB_CACHE_LINE_BYTES, STORE);
/*
* Copyright (c) 2017-2019 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/session/application.h>
#include <vnet/session/application_interface.h>
#include <vnet/session/session.h>
#define ECHO_SERVER_DBG (0)
#define DBG(_fmt, _args...) \
if (ECHO_SERVER_DBG) \
clib_warning (_fmt, ##_args)
typedef struct
{
/*
* Server app parameters
*/
svm_msg_q_t **vpp_queue;
svm_queue_t *vl_input_queue; /**< Sever's event queue */
u32 app_index; /**< Server app index */
u32 my_client_index; /**< API client handle */
u32 node_index; /**< process node index for event scheduling */
/*
* Config params
*/
u8 no_echo; /**< Don't echo traffic */
u32 fifo_size; /**< Fifo size */
u32 rcv_buffer_size; /**< Rcv buffer size */
u32 prealloc_fifos; /**< Preallocate fifos */
u32 private_segment_count; /**< Number of private segments */
u32 private_segment_size; /**< Size of private segments */
char *server_uri; /**< Server URI */
u32 tls_engine; /**< TLS engine: mbedtls/openssl */
u32 ckpair_index; /**< Cert and key for tls/quic */
u8 is_dgram; /**< set if transport is dgram */
/*
* Test state
*/
u8 **rx_buf; /**< Per-thread RX buffer */
u64 byte_index;
u32 **rx_retries;
u8 transport_proto;
u64 listener_handle; /**< Session handle of the root listener */
vlib_main_t *vlib_main;
} echo_server_main_t;
echo_server_main_t echo_server_main;
int
quic_echo_server_qsession_accept_callback (session_t * s)
{
DBG ("QSession %u accept w/opaque %d", s->session_index, s->opaque);
return 0;
}
int
quic_echo_server_session_accept_callback (session_t * s)
{
echo_server_main_t *esm = &echo_server_main;
if (s->listener_handle == esm->listener_handle)
return quic_echo_server_qsession_accept_callback (s);
DBG ("SSESSION %u accept w/opaque %d", s->session_index, s->opaque);
esm->vpp_queue[s->thread_index] =
session_main_get_vpp_event_queue (s->thread_index);
s->session_state = SESSION_STATE_READY;
esm->byte_index = 0;
ASSERT (vec_len (esm->rx_retries) > s->thread_index);
vec_validate (esm->rx_retries[s->thread_index], s->session_index);
esm->rx_retries[s->thread_index][s->session_index] = 0;
return 0;
}
int
echo_server_session_accept_callback (session_t * s)
{
echo_server_main_t *esm = &echo_server_main;
esm->vpp_queue[s->thread_index] =
session_main_get_vpp_event_queue (s->thread_index);
s->session_state = SESSION_STATE_READY;
esm->byte_index = 0;
ASSERT (vec_len (esm->rx_retries) > s->thread_index);
vec_validate (esm->rx_retries[s->thread_index], s->session_index);
esm->rx_retries[s->thread_index][s->session_index] = 0;
return 0;
}
void
echo_server_session_disconnect_callback (session_t * s)
{
echo_server_main_t *esm = &echo_server_main;
vnet_disconnect_args_t _a = { 0 }, *a = &_a;
a->handle = session_handle (s);
a->app_index = esm->app_index;
vnet_disconnect_session (a);
}
void
echo_server_session_reset_callback (session_t * s)
{
echo_server_main_t *esm = &echo_server_main;
vnet_disconnect_args_t _a = { 0 }, *a = &_a;
clib_warning ("Reset session %U", format_session, s, 2);
a->handle = session_handle (s);
a->app_index = esm->app_index;
vnet_disconnect_session (a);
}
int
echo_server_session_connected_callback (u32 app_index, u32 api_context,
session_t * s, session_error_t err)
{
clib_warning ("called...");
return -1;
}
int
echo_server_add_segment_callback (u32 client_index, u64 segment_handle)
{
/* New heaps may be added */
return 0;
}
int
echo_server_redirect_connect_callback (u32 client_index, void *mp)
{
clib_warning ("called...");
return -1;
}
void
test_bytes (echo_server_main_t * esm, int actual_transfer)
{
int i;
u32 my_thread_id = vlib_get_thread_index ();
for (i = 0; i < actual_transfer; i++)
{
if (esm->rx_buf[my_thread_id][i] != ((esm->byte_index + i) & 0xff))
{
clib_warning ("at %lld expected %d got %d", esm->byte_index + i,
(esm->byte_index + i) & 0xff,
esm->rx_buf[my_thread_id][i]);
}
}
esm->byte_index += actual_transfer;
}
/*
* If no-echo, just drop the data and be done with it.
*/
int
echo_server_builtin_server_rx_callback_no_echo (session_t * s)
{
svm_fifo_t *rx_fifo = s->rx_fifo;
svm_fifo_dequeue_drop (rx_fifo, svm_fifo_max_dequeue_cons (rx_fifo));
return 0;
}
int
echo_server_rx_callback (session_t * s)
{
u32 n_written, max_dequeue, max_enqueue, max_transfer;
int actual_transfer;
svm_fifo_t *tx_fifo, *rx_fifo;
echo_server_main_t *esm = &echo_server_main;
u32 thread_index = vlib_get_thread_index ();
app_session_transport_t at;
ASSERT (s->thread_index == thread_index);
rx_fifo = s->rx_fifo;
tx_fifo = s->tx_fifo;
ASSERT (rx_fifo->master_thread_index == thread_index);
ASSERT (tx_fifo->master_thread_index == thread_index);
max_enqueue = svm_fifo_max_enqueue_prod (tx_fifo);
if (!esm->is_dgram)
{
max_dequeue = svm_fifo_max_dequeue_cons (rx_fifo);
}
else
{
session_dgram_pre_hdr_t ph;
svm_fifo_peek (rx_fifo, 0, sizeof (ph), (u8 *) & ph);
max_dequeue = ph.data_length - ph.data_offset;
if (!esm->vpp_queue[s->thread_index])
{
svm_msg_q_t *mq;
mq = session_main_get_vpp_event_queue (s->thread_index);
esm->vpp_queue[s->thread_index] = mq;
}
max_enqueue -= sizeof (session_dgram_hdr_t);
}
if (PREDICT_FALSE (max_dequeue == 0))
return 0;
/* Number of bytes we're going to copy */
max_transfer = clib_min (max_dequeue, max_enqueue);
/* No space in tx fifo */
if (PREDICT_FALSE (max_transfer == 0))
{
/* XXX timeout for session that are stuck */
rx_event:
/* Program self-tap to retry */
if (svm_fifo_set_event (rx_fifo))
{
if (session_send_io_evt_to_thread (rx_fifo,
SESSION_IO_EVT_BUILTIN_RX))
clib_warning ("failed to enqueue self-tap");
vec_validate (esm->rx_retries[s->thread_index], s->session_index);
if (esm->rx_retries[thread_index][s->session_index] == 500000)
{
clib_warning ("session stuck: %U", format_session, s, 2);
}
if (esm->rx_retries[thread_index][s->session_index] < 500001)
esm->rx_retries[thread_index][s->session_index]++;
}
return 0;
}
vec_validate (esm->rx_buf[thread_index], max_transfer);
if (!esm->is_dgram)
{
actual_transfer = app_recv_stream_raw (rx_fifo,
esm->rx_buf[thread_index],
max_transfer,
0 /* don't clear event */ ,
0 /* peek */ );
}
else
{
actual_transfer = app_recv_dgram_raw (rx_fifo,
esm->rx_buf[thread_index],
max_transfer, &at,
0 /* don't clear event */ ,
0 /* peek */ );
}
ASSERT (actual_transfer == max_transfer);
/* test_bytes (esm, actual_transfer); */
/*
* Echo back
*/
if (!esm->is_dgram)
{
n_written = app_send_stream_raw (tx_fifo,
esm->vpp_queue[thread_index],
esm->rx_buf[thread_index],
actual_transfer, SESSION_IO_EVT_TX,
1 /* do_evt */ , 0);
}
else
{
n_written = app_send_dgram_raw (tx_fifo, &at,
esm->vpp_queue[s->thread_index],
esm->rx_buf[thread_index],
actual_transfer, SESSION_IO_EVT_TX,
1 /* do_evt */ , 0);
}
if (n_written != max_transfer)
clib_warning ("short trout! written %u read %u", n_written, max_transfer);
if (PREDICT_FALSE (svm_fifo_max_dequeue_cons (rx_fifo)))
goto rx_event;
return 0;
}
static session_cb_vft_t echo_server_session_cb_vft = {
.session_accept_callback = echo_server_session_accept_callback,
.session_disconnect_callback = echo_server_session_disconnect_callback,
.session_connected_callback = echo_server_session_connected_callback,
.add_segment_callback = echo_server_add_segment_callback,
.builtin_app_rx_callback = echo_server_rx_callback,
.session_reset_callback = echo_server_session_reset_callback
};
static int
echo_server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
{
vnet_app_add_cert_key_pair_args_t _ck_pair, *ck_pair = &_ck_pair;
echo_server_main_t *esm = &echo_server_main;
vnet_app_attach_args_t _a, *a = &_a;
u64 options[APP_OPTIONS_N_OPTIONS];
u32 segment_size = 512 << 20;
clib_memset (a, 0, sizeof (*a));
clib_memset (options, 0, sizeof (options));
if (esm->no_echo)
echo_server_session_cb_vft.builtin_app_rx_callback =
echo_server_builtin_server_rx_callback_no_echo;
else
echo_server_session_cb_vft.builtin_app_rx_callback =
echo_server_rx_callback;
if (esm->transport_proto == TRANSPORT_PROTO_QUIC)
echo_server_session_cb_vft.session_accept_callback =
quic_echo_server_session_accept_callback;
if (esm->private_segment_size)
segment_size = esm->private_segment_size;
a->api_client_index = ~0;
a->name = format (0, "echo_server");
a->session_cb_vft = &echo_server_session_cb_vft;
a->options = options;
a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
a->options[APP_OPTIONS_RX_FIFO_SIZE] = esm->fifo_size;
a->options[APP_OPTIONS_TX_FIFO_SIZE] = esm->fifo_size;
a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = esm->private_segment_count;
a->options[APP_OPTIONS_TLS_ENGINE] = esm->tls_engine;
a->options[APP_OPTIONS_PCT_FIRST_ALLOC] = 100;
a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
esm->prealloc_fifos ? esm->prealloc_fifos : 1;
a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
if (appns_id)
{
a->namespace_id = appns_id;
a->options[APP_OPTIONS_FLAGS] |= appns_flags;
a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
}
if (vnet_application_attach (a))
{
clib_warning ("failed to attach server");
return -1;
}
esm->app_index = a->app_index;
vec_free (a->name);
clib_memset (ck_pair, 0, sizeof (*ck_pair));
ck_pair->cert = (u8 *) test_srv_crt_rsa;
ck_pair->key = (u8 *) test_srv_key_rsa;
ck_pair->cert_len = test_srv_crt_rsa_len;
ck_pair->key_len = test_srv_key_rsa_len;
vnet_app_add_cert_key_pair (ck_pair);
esm->ckpair_index = ck_pair->index;
return 0;
}
static int
echo_server_detach (void)
{
echo_server_main_t *esm = &echo_server_main;
vnet_app_detach_args_t _da, *da = &_da;
int rv;
da->app_index = esm->app_index;
da->api_client_index = ~0;
rv = vnet_application_detach (da);
esm->app_index = ~0;
vnet_app_del_cert_key_pair (esm->ckpair_index);
return rv;
}
static int
echo_client_transport_needs_crypto (transport_proto_t proto)
{
return proto == TRANSPORT_PROTO_TLS || proto == TRANSPORT_PROTO_DTLS ||
proto == TRANSPORT_PROTO_QUIC;
}
static int
echo_server_listen ()
{
i32 rv;
echo_server_main_t *esm = &echo_server_main;
vnet_listen_args_t _args = { 0 }, *args = &_args;
args->sep_ext.app_wrk_index = 0;
if ((rv = parse_uri (esm->server_uri, &args->sep_ext)))
{
return -1;
}
args->app_index = esm->app_index;
if (echo_client_transport_needs_crypto (args->sep_ext.transport_proto))
{
session_endpoint_alloc_ext_cfg (&args->sep_ext,
TRANSPORT_ENDPT_EXT_CFG_CRYPTO);
args->sep_ext.ext_cfg->crypto.ckpair_index = esm->ckpair_index;
}
if (args->sep_ext.transport_proto == TRANSPORT_PROTO_UDP)
{
args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
}
rv = vnet_listen (args);
esm->listener_handle = args->handle;
if (args->sep_ext.ext_cfg)
clib_mem_free (args->sep_ext.ext_cfg);
return rv;
}
static int
echo_server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
u64 appns_secret)
{
echo_server_main_t *esm = &echo_server_main;
vlib_thread_main_t *vtm = vlib_get_thread_main ();
u32 num_threads;
int i;
num_threads = 1 /* main thread */ + vtm->n_threads;
vec_validate (echo_server_main.vpp_queue, num_threads - 1);
vec_validate (esm->rx_buf, num_threads - 1);
vec_validate (esm->rx_retries, num_threads - 1);
for (i = 0; i < vec_len (esm->rx_retries); i++)
vec_validate (esm->rx_retries[i],
pool_elts (session_main.wrk[i].sessions));
esm->rcv_buffer_size = clib_max (esm->rcv_buffer_size, esm->fifo_size);
for (i = 0; i < num_threads; i++)
vec_validate (esm->rx_buf[i], esm->rcv_buffer_size);
if (echo_server_attach (appns_id, appns_flags, appns_secret))
{
clib_warning ("failed to attach server");
return -1;
}
if (echo_server_listen ())
{
clib_warning ("failed to start listening");
if (echo_server_detach ())
clib_warning ("failed to detach");
return -1;
}
return 0;
}
static clib_error_t *
echo_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
vlib_cli_command_t * cmd)
{
session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
echo_server_main_t *esm = &echo_server_main;
u8 server_uri_set = 0, *appns_id = 0;
u64 tmp, appns_flags = 0, appns_secret = 0;
char *default_uri = "tcp://0.0.0.0/1234";
int rv, is_stop = 0, barrier_acq_needed = 0;
clib_error_t *error = 0;
/* The request came over the binary api and the inband cli handler
* is not mp_safe. Drop the barrier to make sure the workers are not
* blocked.
*/
if (vlib_num_workers () && vlib_thread_is_main_w_barrier ())
{
barrier_acq_needed = 1;
vlib_worker_thread_barrier_release (vm);
}
esm->no_echo = 0;
esm->fifo_size = 64 << 10;
esm->rcv_buffer_size = 128 << 10;
esm->prealloc_fifos = 0;
esm->private_segment_count = 0;
esm->private_segment_size = 0;
esm->tls_engine = CRYPTO_ENGINE_OPENSSL;
vec_free (esm->server_uri);
while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
{
if (unformat (input, "uri %s", &esm->server_uri))
server_uri_set = 1;
else if (unformat (input, "no-echo"))
esm->no_echo = 1;
else if (unformat (input, "fifo-size %d", &esm->fifo_size))
esm->fifo_size <<= 10;
else if (unformat (input, "rcv-buf-size %d", &esm->rcv_buffer_size))
;
else if (unformat (input, "prealloc-fifos %d", &esm->prealloc_fifos))
;
else if (unformat (input, "private-segment-count %d",
&esm->private_segment_count))
;
else if (unformat (input, "private-segment-size %U",
unformat_memory_size, &tmp))
{
if (tmp >= 0x100000000ULL)
{
error = clib_error_return (
0, "private segment size %lld (%llu) too large", tmp, tmp);
goto cleanup;
}
esm->private_segment_size = tmp;
}
else if (unformat (input, "appns %_%v%_", &appns_id))
;
else if (unformat (input, "all-scope"))
appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
| APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
else if (unformat (input, "local-scope"))
appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
else if (unformat (input, "global-scope"))
appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
else if (unformat (input, "secret %lu", &appns_secret))
;
else if (unformat (input, "stop"))
is_stop = 1;
else if (unformat (input, "tls-engine %d", &esm->tls_engine))
;
else
{
error = clib_error_return (0, "failed: unknown input `%U'",
format_unformat_error, input);
goto cleanup;
}
}
if (is_stop)
{
if (esm->app_index == (u32) ~ 0)
{
clib_warning ("server not running");
error = clib_error_return (0, "failed: server not running");
goto cleanup;
}
rv = echo_server_detach ();
if (rv)
{
clib_warning ("failed: detach");
error = clib_error_return (0, "failed: server detach %d", rv);
goto cleanup;
}
goto cleanup;
}
vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
if (!server_uri_set)
{
clib_warning ("No uri provided! Using default: %s", default_uri);
esm->server_uri = (char *) format (0, "%s%c", default_uri, 0);
}
if ((rv = parse_uri ((char *) esm->server_uri, &sep)))
{
error = clib_error_return (0, "Uri parse error: %d", rv);
goto cleanup;
}
esm->transport_proto = sep.transport_proto;
esm->is_dgram = (sep.transport_proto == TRANSPORT_PROTO_UDP);
rv = echo_server_create (vm, appns_id, appns_flags, appns_secret);
if (rv)
{
vec_free (esm->server_uri);
error = clib_error_return (0, "failed: server_create returned %d", rv);
goto cleanup;
}
cleanup:
vec_free (appns_id);
if (barrier_acq_needed)
vlib_worker_thread_barrier_sync (vm);
return error;
}
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (echo_server_create_command, static) =
{
.path = "test echo server",
.short_help = "test echo server proto <proto> [no echo][fifo-size <mbytes>]"
"[rcv-buf-size <bytes>][prealloc-fifos <count>]"
"[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
"[uri <tcp://ip/port>]",
.function = echo_server_create_command_fn,
};
/* *INDENT-ON* */
clib_error_t *
echo_server_main_init (vlib_main_t * vm)
{
echo_server_main_t *esm = &echo_server_main;
esm->my_client_index = ~0;
return 0;
}
VLIB_INIT_FUNCTION (echo_server_main_init);
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/