NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
flow_ct_udp_single_match_main.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2024 NVIDIA CORPORATION AND AFFILIATES. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification, are permitted
5  * provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright notice, this list of
7  * conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright notice, this list of
9  * conditions and the following disclaimer in the documentation and/or other materials
10  * provided with the distribution.
11  * * Neither the name of the NVIDIA CORPORATION nor the names of its contributors may be used
12  * to endorse or promote products derived from this software without specific prior written
13  * permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
17  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
19  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21  * STRICT LIABILITY, OR TOR (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  *
24  */
25 
26 #include <stdlib.h>
27 
28 #include <doca_argp.h>
29 #include <doca_log.h>
30 #include <doca_dpdk.h>
31 
32 #include <dpdk_utils.h>
33 
34 #include "flow_ct_common.h"
35 #include "common.h"
36 
37 DOCA_LOG_REGISTER(FLOW_CT_UDP_SINGL_MATCH::MAIN);
38 
39 /* Sample's Logic */
40 doca_error_t flow_ct_udp_single_match(uint16_t nb_queues, struct doca_dev *ct_dev);
41 
42 /*
43  * Sample main function
44  *
45  * @argc [in]: command line arguments size
46  * @argv [in]: array of command line arguments
47  * @return: EXIT_SUCCESS on success and EXIT_FAILURE otherwise
48  */
49 int main(int argc, char **argv)
50 {
52  struct doca_log_backend *sdk_log;
53  int exit_status = EXIT_FAILURE;
54  struct doca_dev *ct_dev = NULL;
55  struct ct_config ct_cfg = {0};
56  struct application_dpdk_config dpdk_config = {
57  .port_config.nb_ports = 2,
58  .port_config.nb_queues = 2,
59  .port_config.isolated_mode = 1,
60  .port_config.switch_mode = 1,
61  .reserve_main_thread = false,
62  };
63 
64  /* Register a logger backend */
66  if (result != DOCA_SUCCESS)
67  goto sample_exit;
68 
69  /* Register a logger backend for internal SDK errors and warnings */
71  if (result != DOCA_SUCCESS)
72  goto sample_exit;
74  if (result != DOCA_SUCCESS)
75  goto sample_exit;
76 
77  DOCA_LOG_INFO("Starting the sample");
78 
79  result = doca_argp_init(NULL, &ct_cfg);
80  if (result != DOCA_SUCCESS) {
81  DOCA_LOG_ERR("Failed to init ARGP resources: %s", doca_error_get_descr(result));
82  goto sample_exit;
83  }
85 
87  if (result != DOCA_SUCCESS) {
88  DOCA_LOG_ERR("Failed to register Flow Ct sample parameters: %s", doca_error_get_descr(result));
89  goto argp_cleanup;
90  }
91 
92  result = doca_argp_start(argc, argv);
93  if (result != DOCA_SUCCESS) {
94  DOCA_LOG_ERR("Failed to parse sample input: %s", doca_error_get_descr(result));
95  goto argp_cleanup;
96  }
97 
99  if (result != DOCA_SUCCESS) {
100  DOCA_LOG_ERR("Failed to open Flow CT device: %s", doca_error_get_descr(result));
101  goto dpdk_cleanup;
102  }
103 
105  if (result != DOCA_SUCCESS) {
106  DOCA_LOG_ERR("Failed to open Flow CT device: %s", doca_error_get_descr(result));
107  goto device_cleanup;
108  }
109 
110  /* update queues and ports */
111  result = dpdk_queues_and_ports_init(&dpdk_config);
112  if (result != DOCA_SUCCESS) {
113  DOCA_LOG_ERR("Failed to update ports and queues");
114  goto device_cleanup;
115  }
116 
117  /* run sample */
118  result = flow_ct_udp_single_match(dpdk_config.port_config.nb_queues, ct_dev);
119  if (result != DOCA_SUCCESS) {
120  DOCA_LOG_ERR("flow_ct_udp_single_match() encountered an error: %s", doca_error_get_descr(result));
121  goto dpdk_ports_queues_cleanup;
122  }
123 
124  exit_status = EXIT_SUCCESS;
125 dpdk_ports_queues_cleanup:
126  dpdk_queues_and_ports_fini(&dpdk_config);
127 device_cleanup:
128  doca_dev_close(ct_dev);
129 dpdk_cleanup:
130  dpdk_fini();
131 argp_cleanup:
133 sample_exit:
134  if (exit_status == EXIT_SUCCESS)
135  DOCA_LOG_INFO("Sample finished successfully");
136  else
137  DOCA_LOG_INFO("Sample finished with errors");
138  return exit_status;
139 }
#define NULL
Definition: __stddef_null.h:26
int32_t result
static doca_error_t open_doca_device_with_pci(const char *pcie_value, struct doca_dev **retval)
Definition: device.c:43
void dpdk_fini(void)
Definition: dpdk_utils.c:919
doca_error_t dpdk_queues_and_ports_init(struct application_dpdk_config *app_dpdk_config)
Definition: dpdk_utils.c:515
void dpdk_queues_and_ports_fini(struct application_dpdk_config *app_dpdk_config)
Definition: dpdk_utils.c:564
doca_error_t flow_ct_dpdk_init(int argc, char **dpdk_argv)
doca_error_t flow_ct_capable(struct doca_devinfo *dev_info)
doca_error_t flow_ct_register_params(void)
#define FLOW_CT_COMMON_DEVARGS
doca_error_t flow_ct_udp_single_match(uint16_t nb_queues, struct doca_dev *ct_dev)
int main(int argc, char **argv)
DOCA_LOG_REGISTER(FLOW_CT_UDP_SINGL_MATCH::MAIN)
DOCA_EXPERIMENTAL doca_error_t doca_argp_start(int argc, char **argv)
Parse incoming arguments (cmd line/json).
DOCA_EXPERIMENTAL doca_error_t doca_argp_init(const char *program_name, void *program_config)
Initialize the parser interface.
DOCA_EXPERIMENTAL void doca_argp_set_dpdk_program(doca_argp_dpdk_cb_t callback)
Mark the program as based on DPDK API.
DOCA_EXPERIMENTAL doca_error_t doca_argp_destroy(void)
ARG Parser destroy.
DOCA_STABLE doca_error_t doca_dev_close(struct doca_dev *dev)
Destroy allocated local device instance.
DOCA_EXPERIMENTAL doca_error_t doca_dpdk_port_probe(struct doca_dev *dev, const char *devargs)
Attach a DPDK port specified by DOCA device.
enum doca_error doca_error_t
DOCA API return codes.
DOCA_STABLE const char * doca_error_get_descr(doca_error_t error)
Returns the description string of an error code.
@ DOCA_SUCCESS
Definition: doca_error.h:38
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_standard(void)
Create default, non configurable backend for application messages.
#define DOCA_LOG_ERR(format,...)
Generates an ERROR application log message.
Definition: doca_log.h:466
#define DOCA_LOG_INFO(format,...)
Generates an INFO application log message.
Definition: doca_log.h:486
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_file_sdk(FILE *fptr, struct doca_log_backend **backend)
Create a logging backend with a FILE* stream for SDK messages.
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_set_sdk_level(struct doca_log_backend *backend, uint32_t level)
Set the log level limit for SDK logging backends.
@ DOCA_LOG_LEVEL_WARNING
Definition: doca_log.h:47
struct application_port_config port_config
Definition: dpdk_utils.h:70
char ct_dev_pci_addr[MAX_PORTS][DOCA_DEVINFO_PCI_ADDR_SIZE]