NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
flow_vxlan_shared_encap_main.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2024-2025 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_flow.h>
30 #include <doca_log.h>
31 
32 #include <dpdk_utils.h>
33 
34 DOCA_LOG_REGISTER(FLOW_VXLAN_SHARED_ENCAP::MAIN);
35 
36 /* Sample's Logic */
38 
39 /*
40  * Sample main function
41  *
42  * @argc [in]: command line arguments size
43  * @argv [in]: array of command line arguments
44  * @return: EXIT_SUCCESS on success and EXIT_FAILURE otherwise
45  */
46 int main(int argc, char **argv)
47 {
49  struct doca_log_backend *sdk_log;
50  int exit_status = EXIT_FAILURE;
51  struct application_dpdk_config dpdk_config = {
52  .port_config.nb_ports = 2,
53  .port_config.nb_queues = 4,
54  .port_config.nb_hairpin_q = 1,
55  .reserve_main_thread = true,
56  };
57 
58  /* Register a logger backend */
60  if (result != DOCA_SUCCESS)
61  goto sample_exit;
62 
63  /* Register a logger backend for internal SDK errors and warnings */
65  if (result != DOCA_SUCCESS)
66  goto sample_exit;
68  if (result != DOCA_SUCCESS)
69  goto sample_exit;
70 
71  DOCA_LOG_INFO("Starting the sample");
72 
74  if (result != DOCA_SUCCESS) {
75  DOCA_LOG_ERR("Failed to init ARGP resources: %s", doca_error_get_descr(result));
76  goto sample_exit;
77  }
79 
80  result = doca_argp_start(argc, argv);
81  if (result != DOCA_SUCCESS) {
82  DOCA_LOG_ERR("Failed to parse sample input: %s", doca_error_get_descr(result));
83  goto argp_cleanup;
84  }
85 
86  /* update queues and ports */
87  result = dpdk_queues_and_ports_init(&dpdk_config);
88  if (result != DOCA_SUCCESS) {
89  DOCA_LOG_ERR("Failed to update ports and queues");
90  goto dpdk_cleanup;
91  }
92 
93  /* run sample */
95  if (result != DOCA_SUCCESS) {
96  DOCA_LOG_ERR("flow_vxlan_shared_encap() encountered an error: %s", doca_error_get_descr(result));
97  goto dpdk_ports_queues_cleanup;
98  }
99 
100  exit_status = EXIT_SUCCESS;
101 
102 dpdk_ports_queues_cleanup:
103  dpdk_queues_and_ports_fini(&dpdk_config);
104 dpdk_cleanup:
105  dpdk_fini();
106 argp_cleanup:
108 sample_exit:
109  if (exit_status == EXIT_SUCCESS)
110  DOCA_LOG_INFO("Sample finished successfully");
111  else
112  DOCA_LOG_INFO("Sample finished with errors");
113  return exit_status;
114 }
#define NULL
Definition: __stddef_null.h:26
int32_t result
doca_error_t dpdk_init(int argc, char **argv)
Definition: dpdk_utils.c:907
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_vxlan_shared_encap(int nb_queues)
int main(int argc, char **argv)
DOCA_LOG_REGISTER(FLOW_VXLAN_SHARED_ENCAP::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.
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