1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
9 #include <rte_ethdev_driver.h>
10 #include <rte_ethdev_vdev.h>
11 #include <rte_malloc.h>
12 #include <rte_bus_vdev.h>
13 #include <rte_kvargs.h>
14 #include <rte_errno.h>
16 #include <rte_tm_driver.h>
18 #include "rte_eth_softnic.h"
19 #include "rte_eth_softnic_internals.h"
21 #define PMD_PARAM_FIRMWARE "firmware"
22 #define PMD_PARAM_CONN_PORT "conn_port"
23 #define PMD_PARAM_CPU_ID "cpu_id"
24 #define PMD_PARAM_TM_N_QUEUES "tm_n_queues"
25 #define PMD_PARAM_TM_QSIZE0 "tm_qsize0"
26 #define PMD_PARAM_TM_QSIZE1 "tm_qsize1"
27 #define PMD_PARAM_TM_QSIZE2 "tm_qsize2"
28 #define PMD_PARAM_TM_QSIZE3 "tm_qsize3"
30 static const char *pmd_valid_args[] = {
34 PMD_PARAM_TM_N_QUEUES,
42 static const char welcome[] =
44 "Welcome to Soft NIC!\n"
47 static const char prompt[] = "softnic> ";
49 struct softnic_conn_params conn_params_default = {
54 .buf_size = 1024 * 1024,
55 .msg_in_len_max = 1024,
56 .msg_out_len_max = 1024 * 1024,
57 .msg_handle = softnic_cli_process,
58 .msg_handle_arg = NULL,
61 static const struct rte_eth_dev_info pmd_dev_info = {
63 .max_rx_pktlen = UINT32_MAX,
64 .max_rx_queues = UINT16_MAX,
65 .max_tx_queues = UINT16_MAX,
76 .rx_offload_capa = DEV_RX_OFFLOAD_CRC_STRIP,
79 static int pmd_softnic_logtype;
81 #define PMD_LOG(level, fmt, args...) \
82 rte_log(RTE_LOG_ ## level, pmd_softnic_logtype, \
83 "%s(): " fmt "\n", __func__, ##args)
86 pmd_dev_infos_get(struct rte_eth_dev *dev __rte_unused,
87 struct rte_eth_dev_info *dev_info)
89 memcpy(dev_info, &pmd_dev_info, sizeof(*dev_info));
93 pmd_dev_configure(struct rte_eth_dev *dev __rte_unused)
99 pmd_rx_queue_setup(struct rte_eth_dev *dev,
100 uint16_t rx_queue_id,
102 unsigned int socket_id,
103 const struct rte_eth_rxconf *rx_conf __rte_unused,
104 struct rte_mempool *mb_pool __rte_unused)
106 uint32_t size = RTE_ETH_NAME_MAX_LEN + strlen("_rxq") + 4;
110 snprintf(name, sizeof(name), "%s_rxq%04x",
114 r = rte_ring_create(name,
117 RING_F_SP_ENQ | RING_F_SC_DEQ);
121 dev->data->rx_queues[rx_queue_id] = r;
126 pmd_tx_queue_setup(struct rte_eth_dev *dev,
127 uint16_t tx_queue_id,
129 unsigned int socket_id,
130 const struct rte_eth_txconf *tx_conf __rte_unused)
132 uint32_t size = RTE_ETH_NAME_MAX_LEN + strlen("_txq") + 4;
136 snprintf(name, sizeof(name), "%s_txq%04x",
140 r = rte_ring_create(name,
143 RING_F_SP_ENQ | RING_F_SC_DEQ);
147 dev->data->tx_queues[tx_queue_id] = r;
152 pmd_dev_start(struct rte_eth_dev *dev)
154 dev->data->dev_link.link_status = ETH_LINK_UP;
160 pmd_dev_stop(struct rte_eth_dev *dev)
162 dev->data->dev_link.link_status = ETH_LINK_DOWN;
166 pmd_dev_close(struct rte_eth_dev *dev)
171 for (i = 0; i < dev->data->nb_rx_queues; i++)
172 rte_ring_free((struct rte_ring *)dev->data->rx_queues[i]);
175 for (i = 0; i < dev->data->nb_tx_queues; i++)
176 rte_ring_free((struct rte_ring *)dev->data->tx_queues[i]);
180 pmd_link_update(struct rte_eth_dev *dev __rte_unused,
181 int wait_to_complete __rte_unused)
187 pmd_tm_ops_get(struct rte_eth_dev *dev __rte_unused, void *arg)
189 *(const struct rte_tm_ops **)arg = &pmd_tm_ops;
194 static const struct eth_dev_ops pmd_ops = {
195 .dev_configure = pmd_dev_configure,
196 .dev_start = pmd_dev_start,
197 .dev_stop = pmd_dev_stop,
198 .dev_close = pmd_dev_close,
199 .link_update = pmd_link_update,
200 .dev_infos_get = pmd_dev_infos_get,
201 .rx_queue_setup = pmd_rx_queue_setup,
202 .tx_queue_setup = pmd_tx_queue_setup,
203 .tm_ops_get = pmd_tm_ops_get,
207 pmd_rx_pkt_burst(void *rxq,
208 struct rte_mbuf **rx_pkts,
211 return (uint16_t)rte_ring_sc_dequeue_burst(rxq,
218 pmd_tx_pkt_burst(void *txq,
219 struct rte_mbuf **tx_pkts,
222 return (uint16_t)rte_ring_sp_enqueue_burst(txq,
229 pmd_init(struct pmd_params *params)
231 struct pmd_internals *p;
234 p = rte_zmalloc_socket(params->name,
235 sizeof(struct pmd_internals),
242 memcpy(&p->params, params, sizeof(p->params));
245 softnic_mempool_init(p);
247 softnic_link_init(p);
249 softnic_tmgr_init(p);
251 softnic_port_in_action_profile_init(p);
252 softnic_table_action_profile_init(p);
253 softnic_pipeline_init(p);
255 status = softnic_thread_init(p);
261 if (params->conn_port) {
262 struct softnic_conn_params conn_params;
264 memcpy(&conn_params, &conn_params_default, sizeof(conn_params));
265 conn_params.port = p->params.conn_port;
266 conn_params.msg_handle_arg = p;
268 p->conn = softnic_conn_init(&conn_params);
269 if (p->conn == NULL) {
270 softnic_thread_free(p);
280 pmd_free(struct pmd_internals *p)
285 if (p->params.conn_port)
286 softnic_conn_free(p->conn);
288 softnic_thread_free(p);
289 softnic_pipeline_free(p);
290 softnic_table_action_profile_free(p);
291 softnic_port_in_action_profile_free(p);
293 softnic_tmgr_free(p);
295 softnic_link_free(p);
297 softnic_mempool_free(p);
302 static struct ether_addr eth_addr = {
307 pmd_ethdev_register(struct rte_vdev_device *vdev,
308 struct pmd_params *params,
311 struct rte_eth_dev *dev;
313 /* Ethdev entry allocation */
314 dev = rte_eth_dev_allocate(params->name);
319 dev->rx_pkt_burst = pmd_rx_pkt_burst;
320 dev->tx_pkt_burst = pmd_tx_pkt_burst;
321 dev->tx_pkt_prepare = NULL;
322 dev->dev_ops = &pmd_ops;
323 dev->device = &vdev->device;
326 dev->data->dev_private = dev_private;
327 dev->data->dev_link.link_speed = ETH_SPEED_NUM_100G;
328 dev->data->dev_link.link_duplex = ETH_LINK_FULL_DUPLEX;
329 dev->data->dev_link.link_autoneg = ETH_LINK_FIXED;
330 dev->data->dev_link.link_status = ETH_LINK_DOWN;
331 dev->data->mac_addrs = ð_addr;
332 dev->data->promiscuous = 1;
333 dev->data->kdrv = RTE_KDRV_NONE;
334 dev->data->numa_node = params->cpu_id;
336 rte_eth_dev_probing_finish(dev);
342 get_string(const char *key __rte_unused, const char *value, void *extra_args)
344 if (!value || !extra_args)
347 *(char **)extra_args = strdup(value);
349 if (!*(char **)extra_args)
356 get_uint32(const char *key __rte_unused, const char *value, void *extra_args)
358 if (!value || !extra_args)
361 *(uint32_t *)extra_args = strtoull(value, NULL, 0);
367 get_uint16(const char *key __rte_unused, const char *value, void *extra_args)
369 if (!value || !extra_args)
372 *(uint16_t *)extra_args = strtoull(value, NULL, 0);
378 pmd_parse_args(struct pmd_params *p, const char *params)
380 struct rte_kvargs *kvlist;
383 kvlist = rte_kvargs_parse(params, pmd_valid_args);
387 /* Set default values */
388 memset(p, 0, sizeof(*p));
389 p->firmware = SOFTNIC_FIRMWARE;
390 p->cpu_id = SOFTNIC_CPU_ID;
391 p->tm.n_queues = SOFTNIC_TM_N_QUEUES;
392 p->tm.qsize[0] = SOFTNIC_TM_QUEUE_SIZE;
393 p->tm.qsize[1] = SOFTNIC_TM_QUEUE_SIZE;
394 p->tm.qsize[2] = SOFTNIC_TM_QUEUE_SIZE;
395 p->tm.qsize[3] = SOFTNIC_TM_QUEUE_SIZE;
397 /* Firmware script (optional) */
398 if (rte_kvargs_count(kvlist, PMD_PARAM_FIRMWARE) == 1) {
399 ret = rte_kvargs_process(kvlist, PMD_PARAM_FIRMWARE,
400 &get_string, &p->firmware);
405 /* Connection listening port (optional) */
406 if (rte_kvargs_count(kvlist, PMD_PARAM_CONN_PORT) == 1) {
407 ret = rte_kvargs_process(kvlist, PMD_PARAM_CONN_PORT,
408 &get_uint16, &p->conn_port);
413 /* CPU ID (optional) */
414 if (rte_kvargs_count(kvlist, PMD_PARAM_CPU_ID) == 1) {
415 ret = rte_kvargs_process(kvlist, PMD_PARAM_CPU_ID,
416 &get_uint32, &p->cpu_id);
421 /* TM number of queues (optional) */
422 if (rte_kvargs_count(kvlist, PMD_PARAM_TM_N_QUEUES) == 1) {
423 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_N_QUEUES,
424 &get_uint32, &p->tm.n_queues);
429 /* TM queue size 0 .. 3 (optional) */
430 if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE0) == 1) {
431 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE0,
432 &get_uint32, &p->tm.qsize[0]);
437 if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE1) == 1) {
438 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE1,
439 &get_uint32, &p->tm.qsize[1]);
444 if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE2) == 1) {
445 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE2,
446 &get_uint32, &p->tm.qsize[2]);
451 if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE3) == 1) {
452 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE3,
453 &get_uint32, &p->tm.qsize[3]);
459 rte_kvargs_free(kvlist);
464 pmd_probe(struct rte_vdev_device *vdev)
471 const char *name = rte_vdev_device_name(vdev);
473 PMD_LOG(INFO, "Probing device \"%s\"", name);
475 /* Parse input arguments */
476 params = rte_vdev_device_args(vdev);
480 status = pmd_parse_args(&p, params);
486 /* Allocate and initialize soft ethdev private data */
487 dev_private = pmd_init(&p);
488 if (dev_private == NULL)
491 /* Register soft ethdev */
492 PMD_LOG(INFO, "Creating soft ethdev \"%s\"", p.name);
494 status = pmd_ethdev_register(vdev, &p, dev_private);
496 pmd_free(dev_private);
504 pmd_remove(struct rte_vdev_device *vdev)
506 struct rte_eth_dev *dev = NULL;
507 struct pmd_internals *p;
512 PMD_LOG(INFO, "Removing device \"%s\"", rte_vdev_device_name(vdev));
514 /* Find the ethdev entry */
515 dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
518 p = dev->data->dev_private;
520 /* Free device data structures*/
522 rte_eth_dev_release_port(dev);
528 static struct rte_vdev_driver pmd_softnic_drv = {
530 .remove = pmd_remove,
533 RTE_PMD_REGISTER_VDEV(net_softnic, pmd_softnic_drv);
534 RTE_PMD_REGISTER_PARAM_STRING(net_softnic,
535 PMD_PARAM_FIRMWARE "=<string> "
536 PMD_PARAM_CONN_PORT "=<uint16> "
537 PMD_PARAM_CPU_ID "=<uint32> "
538 PMD_PARAM_TM_N_QUEUES "=<uint32> "
539 PMD_PARAM_TM_QSIZE0 "=<uint32> "
540 PMD_PARAM_TM_QSIZE1 "=<uint32> "
541 PMD_PARAM_TM_QSIZE2 "=<uint32> "
542 PMD_PARAM_TM_QSIZE3 "=<uint32>"
546 RTE_INIT(pmd_softnic_init_log)
548 pmd_softnic_logtype = rte_log_register("pmd.net.softnic");
549 if (pmd_softnic_logtype >= 0)
550 rte_log_set_level(pmd_softnic_logtype, RTE_LOG_NOTICE);
554 rte_pmd_softnic_manage(uint16_t port_id)
556 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
557 struct pmd_internals *softnic;
559 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
560 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
563 softnic = dev->data->dev_private;
565 softnic_conn_poll_for_conn(softnic->conn);
567 softnic_conn_poll_for_msg(softnic->conn);