NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
apsh_containers_get_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 
31 #include "apsh_common.h"
32 
33 DOCA_LOG_REGISTER(CONTAINERS_GET::MAIN);
34 
35 /* Sample's Logic */
36 doca_error_t containers_get(const char *dma_device_name,
37  const char *pci_vuid,
38  enum doca_apsh_system_os os_type,
39  const char *mem_region,
40  const char *os_symbols);
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 apsh_config apsh_conf = {0};
53  bool os_enabled = true;
54  bool pid_enabled = false;
55  struct doca_log_backend *sdk_log;
56  int exit_status = EXIT_FAILURE;
57 
58  /* Set the default configuration values (Example values) */
59  strcpy(apsh_conf.dma_dev_name, "mlx5_0");
60  strcpy(apsh_conf.system_vuid, "MT2125X03335MLNXS0D0F0");
61  apsh_conf.os_type = DOCA_APSH_SYSTEM_LINUX;
62  apsh_conf.pid = 1;
63  strcpy(apsh_conf.system_os_symbol_map_path, "/tmp/symbols.json");
64  strcpy(apsh_conf.system_mem_region_path, "/tmp/mem_regions.json");
65 
66  /* Register a logger backend */
68  if (result != DOCA_SUCCESS)
69  goto sample_exit;
70 
71  /* Register a logger backend for internal SDK errors and warnings */
73  if (result != DOCA_SUCCESS)
74  goto sample_exit;
76  if (result != DOCA_SUCCESS)
77  goto sample_exit;
78 
79  DOCA_LOG_INFO("Starting the sample");
80 
81  /* Parse cmdline/json arguments */
82  result = doca_argp_init(NULL, &apsh_conf);
83  if (result != DOCA_SUCCESS) {
84  DOCA_LOG_ERR("Failed to init ARGP resources: %s", doca_error_get_descr(result));
85  goto sample_exit;
86  }
87 
88  result = register_apsh_params(os_enabled, pid_enabled);
89  if (result != DOCA_SUCCESS) {
90  DOCA_LOG_ERR("Failed to register sample parameters: %s", doca_error_get_descr(result));
91  goto argp_cleanup;
92  }
93 
94  result = doca_argp_start(argc, argv);
95  if (result != DOCA_SUCCESS) {
96  DOCA_LOG_ERR("Failed to parse sample input: %s", doca_error_get_descr(result));
97  goto argp_cleanup;
98  }
99 
100  /* Invoke the sample's logic */
101  result = containers_get(apsh_conf.dma_dev_name,
102  apsh_conf.system_vuid,
103  apsh_conf.os_type,
104  apsh_conf.system_mem_region_path,
105  apsh_conf.system_os_symbol_map_path);
106  if (result != DOCA_SUCCESS) {
107  DOCA_LOG_ERR("containers_get() encountered an error: %s", doca_error_get_descr(result));
108  goto argp_cleanup;
109  }
110 
111  exit_status = EXIT_SUCCESS;
112 
113 argp_cleanup:
115 sample_exit:
116  if (exit_status == EXIT_SUCCESS)
117  DOCA_LOG_INFO("Sample finished successfully");
118  else
119  DOCA_LOG_INFO("Sample finished with errors");
120  return exit_status;
121 }
#define NULL
Definition: __stddef_null.h:26
doca_error_t register_apsh_params(void)
int32_t result
int main(int argc, char *argv[])
doca_error_t containers_get(const char *dma_device_name, const char *pci_vuid, enum doca_apsh_system_os os_type, const char *mem_region, const char *os_symbols)
DOCA_LOG_REGISTER(CONTAINERS_GET::MAIN)
doca_apsh_system_os
system os types
@ DOCA_APSH_SYSTEM_LINUX
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 system_vuid[DOCA_DEVINFO_VUID_SIZE+1]
DOCA_APSH_PROCESS_PID_TYPE pid
char dma_dev_name[DOCA_DEVINFO_IBDEV_NAME_SIZE+1]
char system_mem_region_path[MAX_PATH_LEN]
char system_os_symbol_map_path[MAX_PATH_LEN]
enum doca_apsh_system_os os_type