NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
dma_copy_dpu_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 <string.h>
28 
29 #include <doca_argp.h>
30 #include <doca_dev.h>
31 #include <doca_log.h>
32 
33 #include "dma_common.h"
34 
35 DOCA_LOG_REGISTER(DMA_COPY_DPU::MAIN);
36 
37 /* Sample's Logic */
38 doca_error_t dma_copy_dpu(const char *export_desc_file_path,
39  const char *buffer_info_file_path,
40  const char *pcie_addr,
41  int num_src_buf,
42  int num_dst_buf);
43 
44 /*
45  * Sample main function
46  *
47  * @argc [in]: command line arguments size
48  * @argv [in]: array of command line arguments
49  * @return: EXIT_SUCCESS on success and EXIT_FAILURE otherwise
50  */
51 int main(int argc, char **argv)
52 {
53  struct dma_config dma_conf;
55  struct doca_log_backend *sdk_log;
56  int exit_status = EXIT_FAILURE;
57 
58  /* Set the default configuration values (Example values) */
59  strcpy(dma_conf.pci_address, "03:00.0");
60  strcpy(dma_conf.export_desc_path, "/tmp/export_desc.txt");
61  strcpy(dma_conf.buf_info_path, "/tmp/buffer_info.txt");
62  /* No need to set cpy_txt because we get it from the host */
63  dma_conf.cpy_txt[0] = '\0';
64  dma_conf.num_dst_buf = 1;
65  dma_conf.num_src_buf = 1;
66 
67  /* Register a logger backend */
69  if (result != DOCA_SUCCESS)
70  goto sample_exit;
71 
72  /* Register a logger backend for internal SDK errors and warnings */
74  if (result != DOCA_SUCCESS)
75  goto sample_exit;
77  if (result != DOCA_SUCCESS)
78  goto sample_exit;
79 
80  DOCA_LOG_INFO("Starting the sample");
81 
82 #ifndef DOCA_ARCH_DPU
83  DOCA_LOG_ERR("Sample can run only on the DPU");
84  goto sample_exit;
85 #endif
86 
87  result = doca_argp_init(NULL, &dma_conf);
88  if (result != DOCA_SUCCESS) {
89  DOCA_LOG_ERR("Failed to init ARGP resources: %s", doca_error_get_descr(result));
90  goto sample_exit;
91  }
93  if (result != DOCA_SUCCESS) {
94  DOCA_LOG_ERR("Failed to register DMA sample parameters: %s", doca_error_get_descr(result));
95  goto argp_cleanup;
96  }
97 
98  result = doca_argp_start(argc, argv);
99  if (result != DOCA_SUCCESS) {
100  DOCA_LOG_ERR("Failed to parse sample input: %s", doca_error_get_descr(result));
101  goto argp_cleanup;
102  }
103 
105  dma_conf.buf_info_path,
106  dma_conf.pci_address,
107  dma_conf.num_src_buf,
108  dma_conf.num_dst_buf);
109  if (result != DOCA_SUCCESS) {
110  DOCA_LOG_ERR("dma_copy_dpu() encountered an error: %s", doca_error_get_descr(result));
111  goto argp_cleanup;
112  }
113 
114  exit_status = EXIT_SUCCESS;
115 
116 argp_cleanup:
118 sample_exit:
119  if (exit_status == EXIT_SUCCESS)
120  DOCA_LOG_INFO("Sample finished successfully");
121  else
122  DOCA_LOG_INFO("Sample finished with errors");
123  return exit_status;
124 }
#define NULL
Definition: __stddef_null.h:26
int32_t result
doca_error_t register_dma_params(bool is_remote)
Definition: dma_common.c:204
int main(int argc, char **argv)
DOCA_LOG_REGISTER(DMA_COPY_DPU::MAIN)
doca_error_t dma_copy_dpu(const char *export_desc_file_path, const char *buffer_info_file_path, const char *pcie_addr, int num_src_buf, int num_dst_buf)
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
char buf_info_path[MAX_ARG_SIZE]
Definition: dma_common.h:49
int num_dst_buf
Definition: dma_common.h:51
char export_desc_path[MAX_ARG_SIZE]
Definition: dma_common.h:48
char cpy_txt[MAX_TXT_SIZE]
Definition: dma_common.h:47
char pci_address[DOCA_DEVINFO_PCI_ADDR_SIZE]
Definition: dma_common.h:46
int num_src_buf
Definition: dma_common.h:50