1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
6 #define __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
10 #include <sys/queue.h>
12 #include <rte_mempool.h>
15 #include <rte_ethdev.h>
16 #include <rte_sched.h>
17 #include <rte_port_in_action.h>
18 #include <rte_table_action.h>
19 #include <rte_pipeline.h>
21 #include <rte_ethdev_driver.h>
22 #include <rte_tm_driver.h>
23 #include <rte_flow_driver.h>
25 #include "rte_eth_softnic.h"
40 /** Traffic Management (TM) */
42 uint32_t n_queues; /**< Number of queues */
43 uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
52 TAILQ_HEAD(flow_list, rte_flow);
54 struct flow_attr_map {
55 char pipeline_name[NAME_SIZE];
60 #ifndef SOFTNIC_FLOW_MAX_GROUPS
61 #define SOFTNIC_FLOW_MAX_GROUPS 64
64 struct flow_internals {
65 struct flow_attr_map ingress_map[SOFTNIC_FLOW_MAX_GROUPS];
66 struct flow_attr_map egress_map[SOFTNIC_FLOW_MAX_GROUPS];
72 struct softnic_mempool_params {
78 struct softnic_mempool {
79 TAILQ_ENTRY(softnic_mempool) node;
81 struct rte_mempool *m;
85 TAILQ_HEAD(softnic_mempool_list, softnic_mempool);
90 struct softnic_swq_params {
95 TAILQ_ENTRY(softnic_swq) node;
100 TAILQ_HEAD(softnic_swq_list, softnic_swq);
105 struct softnic_link_params {
106 const char *dev_name;
107 uint16_t port_id; /**< Valid only when *dev_name* is NULL. */
110 struct softnic_link {
111 TAILQ_ENTRY(softnic_link) node;
112 char name[NAME_SIZE];
118 TAILQ_HEAD(softnic_link_list, softnic_link);
124 #ifndef TM_MAX_SUBPORTS
125 #define TM_MAX_SUBPORTS 8
128 #ifndef TM_MAX_PIPES_PER_SUBPORT
129 #define TM_MAX_PIPES_PER_SUBPORT 4096
133 struct rte_sched_port_params port_params;
135 struct rte_sched_subport_params subport_params[TM_MAX_SUBPORTS];
137 struct rte_sched_pipe_params
138 pipe_profiles[RTE_SCHED_PIPE_PROFILES_PER_PORT];
139 uint32_t n_pipe_profiles;
140 uint32_t pipe_to_profile[TM_MAX_SUBPORTS * TM_MAX_PIPES_PER_SUBPORT];
145 TM_NODE_LEVEL_PORT = 0,
146 TM_NODE_LEVEL_SUBPORT,
153 /* TM Shaper Profile */
154 struct tm_shaper_profile {
155 TAILQ_ENTRY(tm_shaper_profile) node;
156 uint32_t shaper_profile_id;
158 struct rte_tm_shaper_params params;
161 TAILQ_HEAD(tm_shaper_profile_list, tm_shaper_profile);
163 /* TM Shared Shaper */
164 struct tm_shared_shaper {
165 TAILQ_ENTRY(tm_shared_shaper) node;
166 uint32_t shared_shaper_id;
168 uint32_t shaper_profile_id;
171 TAILQ_HEAD(tm_shared_shaper_list, tm_shared_shaper);
173 /* TM WRED Profile */
174 struct tm_wred_profile {
175 TAILQ_ENTRY(tm_wred_profile) node;
176 uint32_t wred_profile_id;
178 struct rte_tm_wred_params params;
181 TAILQ_HEAD(tm_wred_profile_list, tm_wred_profile);
185 TAILQ_ENTRY(tm_node) node;
187 uint32_t parent_node_id;
191 struct tm_node *parent_node;
192 struct tm_shaper_profile *shaper_profile;
193 struct tm_wred_profile *wred_profile;
194 struct rte_tm_node_params params;
195 struct rte_tm_node_stats stats;
199 TAILQ_HEAD(tm_node_list, tm_node);
201 /* TM Hierarchy Specification */
202 struct tm_hierarchy {
203 struct tm_shaper_profile_list shaper_profiles;
204 struct tm_shared_shaper_list shared_shapers;
205 struct tm_wred_profile_list wred_profiles;
206 struct tm_node_list nodes;
208 uint32_t n_shaper_profiles;
209 uint32_t n_shared_shapers;
210 uint32_t n_wred_profiles;
213 uint32_t n_tm_nodes[TM_NODE_LEVEL_MAX];
216 struct tm_internals {
217 /** Hierarchy specification
219 * -Hierarchy is unfrozen at init and when port is stopped.
220 * -Hierarchy is frozen on successful hierarchy commit.
221 * -Run-time hierarchy changes are not allowed, therefore it makes
222 * sense to keep the hierarchy frozen after the port is started.
224 struct tm_hierarchy h;
225 int hierarchy_frozen;
228 struct tm_params params;
231 struct softnic_tmgr_port {
232 TAILQ_ENTRY(softnic_tmgr_port) node;
233 char name[NAME_SIZE];
234 struct rte_sched_port *s;
237 TAILQ_HEAD(softnic_tmgr_port_list, softnic_tmgr_port);
243 TAILQ_ENTRY(softnic_tap) node;
244 char name[NAME_SIZE];
248 TAILQ_HEAD(softnic_tap_list, softnic_tap);
253 struct softnic_port_in_action_profile_params {
254 uint64_t action_mask;
255 struct rte_port_in_action_fltr_config fltr;
256 struct rte_port_in_action_lb_config lb;
259 struct softnic_port_in_action_profile {
260 TAILQ_ENTRY(softnic_port_in_action_profile) node;
261 char name[NAME_SIZE];
262 struct softnic_port_in_action_profile_params params;
263 struct rte_port_in_action_profile *ap;
266 TAILQ_HEAD(softnic_port_in_action_profile_list, softnic_port_in_action_profile);
271 struct softnic_table_action_profile_params {
272 uint64_t action_mask;
273 struct rte_table_action_common_config common;
274 struct rte_table_action_lb_config lb;
275 struct rte_table_action_mtr_config mtr;
276 struct rte_table_action_tm_config tm;
277 struct rte_table_action_encap_config encap;
278 struct rte_table_action_nat_config nat;
279 struct rte_table_action_ttl_config ttl;
280 struct rte_table_action_stats_config stats;
283 struct softnic_table_action_profile {
284 TAILQ_ENTRY(softnic_table_action_profile) node;
285 char name[NAME_SIZE];
286 struct softnic_table_action_profile_params params;
287 struct rte_table_action_profile *ap;
290 TAILQ_HEAD(softnic_table_action_profile_list, softnic_table_action_profile);
295 struct pipeline_params {
296 uint32_t timer_period_ms;
297 uint32_t offset_port_id;
300 enum softnic_port_in_type {
308 struct softnic_port_in_params {
310 enum softnic_port_in_type type;
311 char dev_name[NAME_SIZE];
318 const char *mempool_name;
323 const char *mempool_name;
324 const char *file_name;
325 uint32_t n_bytes_per_pkt;
331 char action_profile_name[NAME_SIZE];
334 enum softnic_port_out_type {
342 struct softnic_port_out_params {
343 enum softnic_port_out_type type;
344 char dev_name[NAME_SIZE];
351 const char *file_name;
360 enum softnic_table_type {
368 struct softnic_table_acl_params {
370 uint32_t ip_header_offset;
374 struct softnic_table_array_params {
379 #ifndef TABLE_RULE_MATCH_SIZE_MAX
380 #define TABLE_RULE_MATCH_SIZE_MAX 256
383 struct softnic_table_hash_params {
387 uint8_t key_mask[TABLE_RULE_MATCH_SIZE_MAX];
389 int extendable_bucket;
392 struct softnic_table_lpm_params {
398 struct softnic_table_params {
400 enum softnic_table_type match_type;
402 struct softnic_table_acl_params acl;
403 struct softnic_table_array_params array;
404 struct softnic_table_hash_params hash;
405 struct softnic_table_lpm_params lpm;
409 char action_profile_name[NAME_SIZE];
412 struct softnic_port_in {
413 struct softnic_port_in_params params;
414 struct softnic_port_in_action_profile *ap;
415 struct rte_port_in_action *a;
418 struct softnic_port_out {
419 struct softnic_port_out_params params;
422 struct softnic_table {
423 struct softnic_table_params params;
424 struct softnic_table_action_profile *ap;
425 struct rte_table_action *a;
426 struct flow_list flows;
430 TAILQ_ENTRY(pipeline) node;
431 char name[NAME_SIZE];
433 struct rte_pipeline *p;
434 struct pipeline_params params;
435 struct softnic_port_in port_in[RTE_PIPELINE_PORT_IN_MAX];
436 struct softnic_port_out port_out[RTE_PIPELINE_PORT_OUT_MAX];
437 struct softnic_table table[RTE_PIPELINE_TABLE_MAX];
439 uint32_t n_ports_out;
442 struct rte_ring *msgq_req;
443 struct rte_ring *msgq_rsp;
444 uint32_t timer_period_ms;
451 TAILQ_HEAD(pipeline_list, pipeline);
456 #ifndef THREAD_PIPELINES_MAX
457 #define THREAD_PIPELINES_MAX 256
460 #ifndef THREAD_MSGQ_SIZE
461 #define THREAD_MSGQ_SIZE 64
464 #ifndef THREAD_TIMER_PERIOD_MS
465 #define THREAD_TIMER_PERIOD_MS 100
469 * Master thead: data plane thread context
471 struct softnic_thread {
472 struct rte_ring *msgq_req;
473 struct rte_ring *msgq_rsp;
479 * Data plane threads: context
481 #ifndef TABLE_RULE_ACTION_SIZE_MAX
482 #define TABLE_RULE_ACTION_SIZE_MAX 2048
485 struct softnic_table_data {
486 struct rte_table_action *a;
489 struct pipeline_data {
490 struct rte_pipeline *p;
491 struct softnic_table_data table_data[RTE_PIPELINE_TABLE_MAX];
494 struct rte_ring *msgq_req;
495 struct rte_ring *msgq_rsp;
496 uint64_t timer_period; /* Measured in CPU cycles. */
499 uint8_t buffer[TABLE_RULE_ACTION_SIZE_MAX];
502 struct softnic_thread_data {
503 struct rte_pipeline *p[THREAD_PIPELINES_MAX];
504 uint32_t n_pipelines;
506 struct pipeline_data pipeline_data[THREAD_PIPELINES_MAX];
507 struct rte_ring *msgq_req;
508 struct rte_ring *msgq_rsp;
509 uint64_t timer_period; /* Measured in CPU cycles. */
511 uint64_t time_next_min;
513 } __rte_cache_aligned;
518 struct pmd_internals {
520 struct pmd_params params;
523 struct tm_internals tm; /**< Traffic Management */
526 struct flow_internals flow;
527 struct softnic_conn *conn;
528 struct softnic_mempool_list mempool_list;
529 struct softnic_swq_list swq_list;
530 struct softnic_link_list link_list;
531 struct softnic_tmgr_port_list tmgr_port_list;
532 struct softnic_tap_list tap_list;
533 struct softnic_port_in_action_profile_list port_in_action_profile_list;
534 struct softnic_table_action_profile_list table_action_profile_list;
535 struct pipeline_list pipeline_list;
536 struct softnic_thread thread[RTE_MAX_LCORE];
537 struct softnic_thread_data thread_data[RTE_MAX_LCORE];
544 flow_attr_map_set(struct pmd_internals *softnic,
547 const char *pipeline_name,
550 struct flow_attr_map *
551 flow_attr_map_get(struct pmd_internals *softnic,
559 softnic_mempool_init(struct pmd_internals *p);
562 softnic_mempool_free(struct pmd_internals *p);
564 struct softnic_mempool *
565 softnic_mempool_find(struct pmd_internals *p,
568 struct softnic_mempool *
569 softnic_mempool_create(struct pmd_internals *p,
571 struct softnic_mempool_params *params);
577 softnic_swq_init(struct pmd_internals *p);
580 softnic_swq_free(struct pmd_internals *p);
583 softnic_softnic_swq_free_keep_rxq_txq(struct pmd_internals *p);
586 softnic_swq_find(struct pmd_internals *p,
590 softnic_swq_create(struct pmd_internals *p,
592 struct softnic_swq_params *params);
598 softnic_link_init(struct pmd_internals *p);
601 softnic_link_free(struct pmd_internals *p);
603 struct softnic_link *
604 softnic_link_find(struct pmd_internals *p,
607 struct softnic_link *
608 softnic_link_create(struct pmd_internals *p,
610 struct softnic_link_params *params);
616 softnic_tmgr_init(struct pmd_internals *p);
619 softnic_tmgr_free(struct pmd_internals *p);
621 struct softnic_tmgr_port *
622 softnic_tmgr_port_find(struct pmd_internals *p,
625 struct softnic_tmgr_port *
626 softnic_tmgr_port_create(struct pmd_internals *p,
630 tm_hierarchy_init(struct pmd_internals *p);
633 tm_hierarchy_free(struct pmd_internals *p);
636 tm_used(struct rte_eth_dev *dev)
638 struct pmd_internals *p = dev->data->dev_private;
640 return p->soft.tm.h.n_tm_nodes[TM_NODE_LEVEL_PORT];
643 extern const struct rte_tm_ops pmd_tm_ops;
649 softnic_tap_init(struct pmd_internals *p);
652 softnic_tap_free(struct pmd_internals *p);
655 softnic_tap_find(struct pmd_internals *p,
659 softnic_tap_create(struct pmd_internals *p,
666 softnic_port_in_action_profile_init(struct pmd_internals *p);
669 softnic_port_in_action_profile_free(struct pmd_internals *p);
671 struct softnic_port_in_action_profile *
672 softnic_port_in_action_profile_find(struct pmd_internals *p,
675 struct softnic_port_in_action_profile *
676 softnic_port_in_action_profile_create(struct pmd_internals *p,
678 struct softnic_port_in_action_profile_params *params);
684 softnic_table_action_profile_init(struct pmd_internals *p);
687 softnic_table_action_profile_free(struct pmd_internals *p);
689 struct softnic_table_action_profile *
690 softnic_table_action_profile_find(struct pmd_internals *p,
693 struct softnic_table_action_profile *
694 softnic_table_action_profile_create(struct pmd_internals *p,
696 struct softnic_table_action_profile_params *params);
702 softnic_pipeline_init(struct pmd_internals *p);
705 softnic_pipeline_free(struct pmd_internals *p);
708 softnic_pipeline_disable_all(struct pmd_internals *p);
711 softnic_pipeline_find(struct pmd_internals *p, const char *name);
714 softnic_pipeline_create(struct pmd_internals *p,
716 struct pipeline_params *params);
719 softnic_pipeline_port_in_create(struct pmd_internals *p,
720 const char *pipeline_name,
721 struct softnic_port_in_params *params,
725 softnic_pipeline_port_in_connect_to_table(struct pmd_internals *p,
726 const char *pipeline_name,
731 softnic_pipeline_port_out_create(struct pmd_internals *p,
732 const char *pipeline_name,
733 struct softnic_port_out_params *params);
736 softnic_pipeline_port_out_find(struct pmd_internals *softnic,
737 const char *pipeline_name,
742 softnic_pipeline_table_create(struct pmd_internals *p,
743 const char *pipeline_name,
744 struct softnic_table_params *params);
746 struct softnic_table_rule_match_acl {
773 struct softnic_table_rule_match_array {
777 struct softnic_table_rule_match_hash {
778 uint8_t key[TABLE_RULE_MATCH_SIZE_MAX];
781 struct softnic_table_rule_match_lpm {
793 struct softnic_table_rule_match {
794 enum softnic_table_type match_type;
797 struct softnic_table_rule_match_acl acl;
798 struct softnic_table_rule_match_array array;
799 struct softnic_table_rule_match_hash hash;
800 struct softnic_table_rule_match_lpm lpm;
804 struct softnic_table_rule_action {
805 uint64_t action_mask;
806 struct rte_table_action_fwd_params fwd;
807 struct rte_table_action_lb_params lb;
808 struct rte_table_action_mtr_params mtr;
809 struct rte_table_action_tm_params tm;
810 struct rte_table_action_encap_params encap;
811 struct rte_table_action_nat_params nat;
812 struct rte_table_action_ttl_params ttl;
813 struct rte_table_action_stats_params stats;
814 struct rte_table_action_time_params time;
818 TAILQ_ENTRY(rte_flow) node;
819 struct softnic_table_rule_match match;
820 struct softnic_table_rule_action action;
822 struct pipeline *pipeline;
827 softnic_pipeline_port_in_stats_read(struct pmd_internals *p,
828 const char *pipeline_name,
830 struct rte_pipeline_port_in_stats *stats,
834 softnic_pipeline_port_in_enable(struct pmd_internals *p,
835 const char *pipeline_name,
839 softnic_pipeline_port_in_disable(struct pmd_internals *p,
840 const char *pipeline_name,
844 softnic_pipeline_port_out_stats_read(struct pmd_internals *p,
845 const char *pipeline_name,
847 struct rte_pipeline_port_out_stats *stats,
851 softnic_pipeline_table_stats_read(struct pmd_internals *p,
852 const char *pipeline_name,
854 struct rte_pipeline_table_stats *stats,
858 softnic_pipeline_table_rule_add(struct pmd_internals *p,
859 const char *pipeline_name,
861 struct softnic_table_rule_match *match,
862 struct softnic_table_rule_action *action,
866 softnic_pipeline_table_rule_add_bulk(struct pmd_internals *p,
867 const char *pipeline_name,
869 struct softnic_table_rule_match *match,
870 struct softnic_table_rule_action *action,
875 softnic_pipeline_table_rule_add_default(struct pmd_internals *p,
876 const char *pipeline_name,
878 struct softnic_table_rule_action *action,
882 softnic_pipeline_table_rule_delete(struct pmd_internals *p,
883 const char *pipeline_name,
885 struct softnic_table_rule_match *match);
888 softnic_pipeline_table_rule_delete_default(struct pmd_internals *p,
889 const char *pipeline_name,
893 softnic_pipeline_table_rule_stats_read(struct pmd_internals *p,
894 const char *pipeline_name,
897 struct rte_table_action_stats_counters *stats,
901 softnic_pipeline_table_mtr_profile_add(struct pmd_internals *p,
902 const char *pipeline_name,
904 uint32_t meter_profile_id,
905 struct rte_table_action_meter_profile *profile);
908 softnic_pipeline_table_mtr_profile_delete(struct pmd_internals *p,
909 const char *pipeline_name,
911 uint32_t meter_profile_id);
914 softnic_pipeline_table_rule_mtr_read(struct pmd_internals *p,
915 const char *pipeline_name,
919 struct rte_table_action_mtr_counters *stats,
923 softnic_pipeline_table_dscp_table_update(struct pmd_internals *p,
924 const char *pipeline_name,
927 struct rte_table_action_dscp_table *dscp_table);
930 softnic_pipeline_table_rule_ttl_read(struct pmd_internals *p,
931 const char *pipeline_name,
934 struct rte_table_action_ttl_counters *stats,
941 softnic_thread_init(struct pmd_internals *p);
944 softnic_thread_free(struct pmd_internals *p);
947 softnic_thread_pipeline_enable(struct pmd_internals *p,
949 const char *pipeline_name);
952 softnic_thread_pipeline_disable(struct pmd_internals *p,
954 const char *pipeline_name);
960 softnic_cli_process(char *in,
966 softnic_cli_script_process(struct pmd_internals *softnic,
967 const char *file_name,
968 size_t msg_in_len_max,
969 size_t msg_out_len_max);
971 #endif /* __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__ */