NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
dpa_kernel_launch_main.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022-2023 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 #include <unistd.h>
28 
29 #include <doca_error.h>
30 #include <doca_log.h>
31 
32 #include "dpa_common.h"
33 
34 DOCA_LOG_REGISTER(KERNEL_LAUNCH::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 {
48  struct dpa_config cfg;
49  struct dpa_resources resources = {0};
51  struct doca_log_backend *sdk_log;
52  int exit_status = EXIT_FAILURE;
53 
54  strcpy(cfg.pf_device_name, DEVICE_DEFAULT_NAME);
55  strcpy(cfg.rdma_device_name, DEVICE_DEFAULT_NAME);
56 
58  if (result != DOCA_SUCCESS)
59  goto sample_exit;
60 
62  if (result != DOCA_SUCCESS)
63  goto sample_exit;
65  if (result != DOCA_SUCCESS)
66  goto sample_exit;
67 
68  DOCA_LOG_INFO("Starting the sample");
69 
71  if (result != DOCA_SUCCESS) {
72  DOCA_LOG_ERR("Failed to init ARGP resources: %s", doca_error_get_descr(result));
73  goto sample_exit;
74  }
75 
77  if (result != DOCA_SUCCESS) {
78  DOCA_LOG_ERR("Failed to register sample parameters: %s", doca_error_get_descr(result));
79  goto argp_cleanup;
80  }
81 
82  result = doca_argp_start(argc, argv);
83  if (result != DOCA_SUCCESS) {
84  DOCA_LOG_ERR("Failed to parse sample input: %s", doca_error_get_descr(result));
85  goto argp_cleanup;
86  }
87 
89  if (result != DOCA_SUCCESS) {
90  DOCA_LOG_ERR("Failed to Allocate DPA Resources: %s", doca_error_get_descr(result));
91  goto argp_cleanup;
92  }
93 
95  if (result != DOCA_SUCCESS) {
96  DOCA_LOG_ERR("kernel_launch() encountered an error: %s", doca_error_get_descr(result));
97  goto dpa_cleanup;
98  }
99 
100  exit_status = EXIT_SUCCESS;
101 
102 dpa_cleanup:
104  if (result != DOCA_SUCCESS) {
105  DOCA_LOG_ERR("Failed to destroy DOCA DPA resources: %s", doca_error_get_descr(result));
106  exit_status = EXIT_FAILURE;
107  }
108 argp_cleanup:
110 sample_exit:
111  if (exit_status == EXIT_SUCCESS)
112  DOCA_LOG_INFO("Sample finished successfully");
113  else
114  DOCA_LOG_INFO("Sample finished with errors");
115  return exit_status;
116 }
#define NULL
Definition: __stddef_null.h:26
int32_t result
doca_error_t destroy_dpa_resources(struct dpa_resources *resources)
Destroy DOCA DPA resources.
Definition: dpa_common.c:769
doca_error_t register_dpa_params(void)
Register the command line parameters for the sample.
Definition: dpa_common.c:126
doca_error_t allocate_dpa_resources(struct dpa_config *cfg, struct dpa_resources *resources)
Allocate DOCA DPA resources.
Definition: dpa_common.c:660
#define DEVICE_DEFAULT_NAME
device default name
Definition: dpa_common.h:55
int main(int argc, char **argv)
doca_error_t kernel_launch(struct dpa_resources *resources)
DOCA_LOG_REGISTER(KERNEL_LAUNCH::MAIN)
struct rdma_resources resources
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 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
const struct ip_frag_config * cfg
Definition: ip_frag_dp.c:0
Configuration struct.
Definition: dpa_common.h:100
A struct that includes all the resources needed for DPA.
Definition: dpa_common.h:85