NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
apsh_injection_detect_get_sample.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022 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 #include <inttypes.h>
26 
27 #include <doca_apsh.h>
28 #include <doca_log.h>
29 
30 #include "apsh_common.h"
31 
32 DOCA_LOG_REGISTER(INJECTION_DETECT_GET);
33 
34 /*
35  * Calls the DOCA APSH API function that matches this sample name and prints the result
36  *
37  * @dma_device_name [in]: IBDEV Name of the device to use for DMA
38  * @pci_vuid [in]: VUID of the device exposed to the target system
39  * @os_type [in]: Indicates the OS type of the target system
40  * @pid [in]: PID of the target process
41  * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
42  */
43 doca_error_t injection_detect_get(const char *dma_device_name,
44  const char *pci_vuid,
45  enum doca_apsh_system_os os_type,
47  const char *mem_region,
48  const char *os_symbols)
49 {
51  int i, nb_processes;
52  struct doca_apsh_ctx *apsh_ctx;
53  struct doca_apsh_system *sys;
54  struct doca_apsh_process *proc, **processes;
55  int num_injection_detect;
56  struct doca_apsh_injection_detect **injection_detect_list;
57 
58  /* Init */
59  result = init_doca_apsh(dma_device_name, &apsh_ctx);
60  if (result != DOCA_SUCCESS) {
61  DOCA_LOG_ERR("Failed to init the DOCA APSH lib");
62  return result;
63  }
64  DOCA_LOG_INFO("DOCA APSH lib context init successful");
65 
66  result = init_doca_apsh_system(apsh_ctx, os_type, os_symbols, mem_region, pci_vuid, &sys);
67  if (result != DOCA_SUCCESS) {
68  DOCA_LOG_ERR("Failed to init the system context");
69  return result;
70  }
71  DOCA_LOG_INFO("DOCA APSH system context created");
72 
73  result = process_get(pid, sys, &nb_processes, &processes, &proc);
74  if (result != DOCA_SUCCESS) {
76  DOCA_LOG_ERR("Process pid %d not found", pid);
77  else
78  DOCA_LOG_ERR("DOCA APSH encountered an error: %s", doca_error_get_descr(result));
79  cleanup_doca_apsh(apsh_ctx, sys);
80  return result;
81  }
82  DOCA_LOG_INFO("Process with PID %u found", pid);
84 
85  result = doca_apsh_injection_detect_get(proc, &injection_detect_list, &num_injection_detect);
86  if (result != DOCA_SUCCESS) {
87  DOCA_LOG_ERR("Failed to read injection_detect info from host");
88  doca_apsh_processes_free(processes);
89  cleanup_doca_apsh(apsh_ctx, sys);
90  return result;
91  }
92  DOCA_LOG_INFO("Successfully performed %s. Host proc(%d) contains %d injection_detect",
93  __func__,
94  pid,
95  num_injection_detect);
96 
97  /* Print some attributes of the injection_detect */
98  DOCA_LOG_INFO("INJECTION_detects for process %u:", pid);
99  for (i = 0; i < num_injection_detect; ++i) {
100  DOCA_LOG_INFO("\tINJECTION_detect %d - Process pid: %u, start address: 0x%" PRIx64
101  ", end address: 0x%" PRIx64 ", vad start address: 0x%" PRIx64
102  ", vad end address: 0x%" PRIx64 ", vad path: %s",
103  i,
104  doca_apsh_injection_detect_info_get(injection_detect_list[i],
106  doca_apsh_injection_detect_info_get(injection_detect_list[i],
108  doca_apsh_injection_detect_info_get(injection_detect_list[i],
110  doca_apsh_injection_detect_info_get(injection_detect_list[i],
112  doca_apsh_injection_detect_info_get(injection_detect_list[i],
114  doca_apsh_injection_detect_info_get(injection_detect_list[i],
116  }
117 
118  /* Cleanup */
119  doca_apsh_injection_detect_free(injection_detect_list);
120  doca_apsh_processes_free(processes);
121  cleanup_doca_apsh(apsh_ctx, sys);
122  return DOCA_SUCCESS;
123 }
int32_t pid
int32_t result
doca_error_t process_get(DOCA_APSH_PROCESS_PID_TYPE pid, struct doca_apsh_system *sys, int *nb_procs, struct doca_apsh_process ***processes, struct doca_apsh_process **process)
Definition: apsh_common.c:397
doca_error_t cleanup_doca_apsh(struct doca_apsh_ctx *ctx, struct doca_apsh_system *system)
Definition: apsh_common.c:384
doca_error_t init_doca_apsh_system(struct doca_apsh_ctx *ctx, enum doca_apsh_system_os os_type, const char *os_symbols, const char *mem_region, const char *pci_vuid, struct doca_apsh_system **system)
Definition: apsh_common.c:325
doca_error_t init_doca_apsh(const char *dma_device_name, struct doca_apsh_ctx **ctx)
Definition: apsh_common.c:287
DOCA_LOG_REGISTER(INJECTION_DETECT_GET)
doca_error_t injection_detect_get(const char *dma_device_name, const char *pci_vuid, enum doca_apsh_system_os os_type, DOCA_APSH_PROCESS_PID_TYPE pid, const char *mem_region, const char *os_symbols)
uint32_t DOCA_APSH_PROCESS_PID_TYPE
process pid type
doca_apsh_system_os
system os types
@ DOCA_APSH_INJECTION_DETECT_VAD_START
@ DOCA_APSH_INJECTION_DETECT_VAD_FILE_PATH
@ DOCA_APSH_INJECTION_DETECT_VAD_END
@ DOCA_APSH_INJECTION_DETECT_SUSPECTED_AREA_END
@ DOCA_APSH_INJECTION_DETECT_PID
@ DOCA_APSH_INJECTION_DETECT_SUSPECTED_AREA_START
@ DOCA_APSH_PROCESS_COMM
#define doca_apsh_injection_detect_info_get(suspected_injection, attr)
Get attribute value for a suspected_injection.
Definition: doca_apsh.h:1658
DOCA_EXPERIMENTAL void doca_apsh_injection_detect_free(struct doca_apsh_injection_detect **suspected_injections)
Destroys an injection_detect context.
DOCA_EXPERIMENTAL doca_error_t doca_apsh_injection_detect_get(struct doca_apsh_process *process, struct doca_apsh_injection_detect ***suspected_injections, int *suspected_injections_size)
Get suspected code injections of current process.
#define doca_apsh_process_info_get(process, attr)
Get attribute value for a process.
Definition: doca_apsh.h:618
DOCA_EXPERIMENTAL void doca_apsh_processes_free(struct doca_apsh_process **processes)
Destroys a process context.
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_ERROR_NOT_FOUND
Definition: doca_error.h:54
@ DOCA_SUCCESS
Definition: doca_error.h:38
#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