AMD_DBGAPI  0.46.0
amd-dbgapi.h
Go to the documentation of this file.
1 /* Copyright (c) 2019-2021 Advanced Micro Devices, Inc.
2 
3  Permission is hereby granted, free of charge, to any person obtaining a copy
4  of this software and associated documentation files (the "Software"), to deal
5  in the Software without restriction, including without limitation the rights
6  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7  copies of the Software, and to permit persons to whom the Software is
8  furnished to do so, subject to the following conditions:
9 
10  The above copyright notice and this permission notice shall be included in
11  all copies or substantial portions of the Software.
12 
13  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19  THE SOFTWARE. */
20 
388 #ifndef AMD_DBGAPI_H
389 #define AMD_DBGAPI_H 1
390 
391 /* Placeholder for calling convention and import/export macros */
392 #if !defined(AMD_DBGAPI_CALL)
393 #define AMD_DBGAPI_CALL
394 #endif /* !defined (AMD_DBGAPI_CALL) */
395 
396 #if !defined(AMD_DBGAPI_EXPORT_DECORATOR)
397 #if defined(__GNUC__)
398 #define AMD_DBGAPI_EXPORT_DECORATOR __attribute__ ((visibility ("default")))
399 #elif defined(_MSC_VER)
400 #define AMD_DBGAPI_EXPORT_DECORATOR __declspec(dllexport)
401 #endif /* defined (_MSC_VER) */
402 #endif /* !defined (AMD_DBGAPI_EXPORT_DECORATOR) */
403 
404 #if !defined(AMD_DBGAPI_IMPORT_DECORATOR)
405 #if defined(__GNUC__)
406 #define AMD_DBGAPI_IMPORT_DECORATOR
407 #elif defined(_MSC_VER)
408 #define AMD_DBGAPI_IMPORT_DECORATOR __declspec(dllimport)
409 #endif /* defined (_MSC_VER) */
410 #endif /* !defined (AMD_DBGAPI_IMPORT_DECORATOR) */
411 
412 #define AMD_DBGAPI_EXPORT AMD_DBGAPI_EXPORT_DECORATOR AMD_DBGAPI_CALL
413 #define AMD_DBGAPI_IMPORT AMD_DBGAPI_IMPORT_DECORATOR AMD_DBGAPI_CALL
414 
415 #if !defined(AMD_DBGAPI)
416 #if defined(AMD_DBGAPI_EXPORTS)
417 #define AMD_DBGAPI AMD_DBGAPI_EXPORT
418 #else /* !defined (AMD_DBGAPI_EXPORTS) */
419 #define AMD_DBGAPI AMD_DBGAPI_IMPORT
420 #endif /* !defined (AMD_DBGAPI_EXPORTS) */
421 #endif /* !defined (AMD_DBGAPI) */
422 
423 #if defined(__cplusplus)
424 extern "C" {
425 #endif /* defined (__cplusplus) */
426 
427 #if defined(__linux__)
428 #include <sys/types.h>
429 #endif /* __linux__ */
430 
431 #include <stddef.h>
432 #include <stdint.h>
433 
453 #define AMD_DBGAPI_VERSION_0_24
454 
459 #define AMD_DBGAPI_VERSION_0_30
460 
465 #define AMD_DBGAPI_VERSION_0_41
466 
471 #define AMD_DBGAPI_VERSION_0_42
472 
477 #define AMD_DBGAPI_VERSION_0_46
478 
486 
514 
518 typedef uint64_t amd_dbgapi_size_t;
519 
523 typedef enum
524 {
534 
542 #if defined(__linux__)
544 #endif /* __linux__ */
545 
569 #if defined(__linux__)
571 #endif /* __linux__ */
572 
580 #if defined(__linux__)
581 typedef uint64_t amd_dbgapi_os_agent_id_t;
582 #endif /* __linux__ */
583 
590 #if defined(__linux__)
591 typedef uint64_t amd_dbgapi_os_queue_id_t;
592 #endif /* __linux__ */
593 
602 #if defined(__linux__)
604 #endif /* __linux__ */
605 
613 #if defined(__linux__)
614 typedef enum
615 {
675 #endif /* __linux__ */
676 
689 typedef enum
690 {
911 
929  amd_dbgapi_status_t status,
930  const char **status_string) AMD_DBGAPI_VERSION_0_24;
931 
955 #define AMD_DBGAPI_VERSION_MAJOR 0
956 
961 #define AMD_DBGAPI_VERSION_MINOR 46
962 
977  uint32_t *major, uint32_t *minor, uint32_t *patch) AMD_DBGAPI_VERSION_0_24;
978 
987 const char AMD_DBGAPI *
989 
1037 
1064 
1085 typedef struct
1086 {
1087  uint64_t handle;
1089 
1093 #define AMD_DBGAPI_ARCHITECTURE_NONE ((amd_dbgapi_architecture_id_t){ 0 })
1094 
1102 typedef enum
1103 {
1155 
1195  amd_dbgapi_architecture_id_t architecture_id,
1196  amd_dbgapi_architecture_info_t query, size_t value_size,
1197  void *value) AMD_DBGAPI_VERSION_0_30;
1198 
1228  uint32_t elf_amdgpu_machine,
1230 
1237 typedef struct amd_dbgapi_symbolizer_id_s *amd_dbgapi_symbolizer_id_t;
1238 
1331  amd_dbgapi_architecture_id_t architecture_id,
1333  const void *memory, char **instruction_text,
1334  amd_dbgapi_symbolizer_id_t symbolizer_id,
1335  amd_dbgapi_status_t (*symbolizer) (
1336  amd_dbgapi_symbolizer_id_t symbolizer_id,
1338  char **symbol_text)) AMD_DBGAPI_VERSION_0_30;
1339 
1343 typedef enum
1344 {
1455 
1459 typedef enum
1460 {
1471 
1544  amd_dbgapi_architecture_id_t architecture_id,
1546  const void *memory, amd_dbgapi_instruction_kind_t *instruction_kind,
1547  amd_dbgapi_instruction_properties_t *instruction_properties,
1548  void **instruction_information) AMD_DBGAPI_VERSION_0_46;
1549 
1571 typedef struct amd_dbgapi_client_process_s *amd_dbgapi_client_process_id_t;
1572 
1583 typedef struct
1584 {
1585  uint64_t handle;
1587 
1591 #define AMD_DBGAPI_PROCESS_NONE ((amd_dbgapi_process_id_t){ 0 })
1592 
1599 typedef enum
1600 {
1631 
1676  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41;
1677 
1760  amd_dbgapi_client_process_id_t client_process_id,
1762 
1809 
1824 typedef enum
1825 {
1857 
1881  amd_dbgapi_process_id_t process_id,
1883 
1895 typedef enum
1896 {
1906 
1932  amd_dbgapi_process_id_t process_id,
1934 
1961 typedef struct
1962 {
1963  uint64_t handle;
1965 
1969 #define AMD_DBGAPI_CODE_OBJECT_NONE ((amd_dbgapi_code_object_id_t){ 0 })
1970 
1977 typedef enum
1978 {
2040 
2080  amd_dbgapi_code_object_id_t code_object_id,
2081  amd_dbgapi_code_object_info_t query, size_t value_size,
2082  void *value) AMD_DBGAPI_VERSION_0_41;
2083 
2134  amd_dbgapi_process_id_t process_id, size_t *code_object_count,
2135  amd_dbgapi_code_object_id_t **code_objects,
2137 
2154 typedef struct
2155 {
2156  uint64_t handle;
2158 
2162 #define AMD_DBGAPI_AGENT_NONE ((amd_dbgapi_agent_id_t){ 0 })
2163 
2170 typedef enum
2171 {
2218 
2259  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41;
2260 
2310  amd_dbgapi_process_id_t process_id, size_t *agent_count,
2311  amd_dbgapi_agent_id_t **agents,
2313 
2332 typedef struct
2333 {
2334  uint64_t handle;
2336 
2340 #define AMD_DBGAPI_QUEUE_NONE ((amd_dbgapi_queue_id_t){ 0 })
2341 
2348 typedef enum
2349 {
2398 
2439  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41;
2440 
2444 typedef enum
2445 {
2459 
2463 typedef enum
2464 {
2493 
2543  amd_dbgapi_process_id_t process_id, size_t *queue_count,
2544  amd_dbgapi_queue_id_t **queues,
2546 
2610  amd_dbgapi_queue_id_t queue_id,
2611  amd_dbgapi_os_queue_packet_id_t *read_packet_id,
2612  amd_dbgapi_os_queue_packet_id_t *write_packet_id,
2613  size_t *packets_byte_size, void **packets_bytes) AMD_DBGAPI_VERSION_0_41;
2614 
2633 typedef struct
2634 {
2635  uint64_t handle;
2637 
2641 #define AMD_DBGAPI_DISPATCH_NONE ((amd_dbgapi_dispatch_id_t){ 0 })
2642 
2649 typedef enum
2650 {
2743 
2787  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41;
2788 
2795 typedef enum
2796 {
2807 
2814 typedef enum
2815 {
2829 
2874  amd_dbgapi_process_id_t process_id, size_t *dispatch_count,
2875  amd_dbgapi_dispatch_id_t **dispatches,
2877 
2894 typedef struct
2895 {
2896  uint64_t handle;
2898 
2902 #define AMD_DBGAPI_WAVE_NONE ((amd_dbgapi_wave_id_t){ 0 })
2903 
2910 typedef enum
2911 {
3003 
3048  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41;
3049 
3053 typedef enum
3054 {
3078 
3085 typedef enum
3086 {
3270 
3319  amd_dbgapi_process_id_t process_id, size_t *wave_count,
3320  amd_dbgapi_wave_id_t **waves,
3322 
3404 
3408 typedef enum
3409 {
3419 
3527  amd_dbgapi_wave_id_t wave_id,
3529 
3630 typedef struct
3631 {
3632  uint64_t handle;
3634 
3638 #define AMD_DBGAPI_DISPLACED_STEPPING_NONE \
3639  (amd_dbgapi_displaced_stepping_id_t{ 0 })
3640 
3648 typedef enum
3649 {
3656 
3697  amd_dbgapi_displaced_stepping_id_t displaced_stepping_id,
3698  amd_dbgapi_displaced_stepping_info_t query, size_t value_size,
3699  void *value) AMD_DBGAPI_VERSION_0_41;
3700 
3783  amd_dbgapi_wave_id_t wave_id, const void *saved_instruction_bytes,
3784  amd_dbgapi_displaced_stepping_id_t *displaced_stepping)
3786 
3838  amd_dbgapi_wave_id_t wave_id,
3839  amd_dbgapi_displaced_stepping_id_t displaced_stepping)
3841 
3875 typedef struct
3876 {
3877  uint64_t handle;
3879 
3883 #define AMD_DBGAPI_WATCHPOINT_NONE ((amd_dbgapi_watchpoint_id_t){ 0 })
3884 
3891 typedef enum
3892 {
3899 
3939  amd_dbgapi_watchpoint_id_t watchpoint_id,
3940  amd_dbgapi_watchpoint_info_t query, size_t value_size,
3941  void *value) AMD_DBGAPI_VERSION_0_41;
3942 
3949 typedef enum
3950 {
3968 
3975 typedef enum
3976 {
3996 
4003 typedef struct
4004 {
4005  size_t count;
4008 
4087  amd_dbgapi_watchpoint_id_t *watchpoint_id,
4088  amd_dbgapi_global_address_t *watchpoint_address,
4089  amd_dbgapi_size_t *watchpoint_size) AMD_DBGAPI_VERSION_0_41;
4090 
4116  amd_dbgapi_process_id_t process_id,
4118 
4140 typedef struct
4141 {
4142  uint64_t handle;
4144 
4148 #define AMD_DBGAPI_REGISTER_CLASS_NONE ((amd_dbgapi_register_class_id_t){ 0 })
4149 
4157 typedef enum
4158 {
4172 
4213  amd_dbgapi_register_class_id_t register_class_id,
4214  amd_dbgapi_register_class_info_t query, size_t value_size,
4215  void *value) AMD_DBGAPI_VERSION_0_41;
4216 
4258  amd_dbgapi_architecture_id_t architecture_id, size_t *register_class_count,
4260 
4269 typedef struct
4270 {
4271  uint64_t handle;
4273 
4277 #define AMD_DBGAPI_REGISTER_NONE ((amd_dbgapi_register_id_t){ 0 })
4278 
4285 typedef enum
4286 {
4332 
4374  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_46;
4375 
4379 typedef enum
4380 {
4390 
4425  amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id,
4427 
4473  amd_dbgapi_architecture_id_t architecture_id, size_t *register_count,
4475 
4520  amd_dbgapi_wave_id_t wave_id, size_t *register_count,
4522 
4560  amd_dbgapi_architecture_id_t architecture_id, uint64_t dwarf_register,
4562 
4566 typedef enum
4567 {
4577 
4616  amd_dbgapi_register_class_id_t register_class_id,
4617  amd_dbgapi_register_id_t register_id,
4618  amd_dbgapi_register_class_state_t *register_class_state)
4620 
4675  amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id,
4676  amd_dbgapi_size_t offset, amd_dbgapi_size_t value_size,
4677  void *value) AMD_DBGAPI_VERSION_0_41;
4678 
4738  amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id,
4739  amd_dbgapi_size_t offset, amd_dbgapi_size_t value_size,
4740  const void *value) AMD_DBGAPI_VERSION_0_42;
4741 
4794  amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id,
4796 
4804 typedef struct
4805 {
4807  amd_dbgapi_register_id_t saved_return_address_register[2];
4809 
4849 typedef uint32_t amd_dbgapi_lane_id_t;
4850 
4854 #define AMD_DBGAPI_LANE_NONE ((amd_dbgapi_lane_id_t) (-1))
4855 
4869 typedef struct
4870 {
4871  uint64_t handle;
4873 
4877 #define AMD_DBGAPI_ADDRESS_CLASS_NONE ((amd_dbgapi_address_class_id_t){ 0 })
4878 
4886 typedef enum
4887 {
4915 
4956  amd_dbgapi_address_class_id_t address_class_id,
4957  amd_dbgapi_address_class_info_t query, size_t value_size,
4958  void *value) AMD_DBGAPI_VERSION_0_46;
4959 
5002  amd_dbgapi_architecture_id_t architecture_id, size_t *address_class_count,
5004 
5044  amd_dbgapi_architecture_id_t architecture_id, uint64_t dwarf_address_class,
5046 
5058 typedef struct
5059 {
5060  uint64_t handle;
5062 
5066 #define AMD_DBGAPI_ADDRESS_SPACE_NONE ((amd_dbgapi_address_space_id_t){ 0 })
5067 
5074 #define AMD_DBGAPI_ADDRESS_SPACE_GLOBAL ((amd_dbgapi_address_space_id_t){ 1 })
5075 
5079 typedef enum
5080 {
5097 
5105 typedef enum
5106 {
5140 
5180  amd_dbgapi_address_space_id_t address_space_id,
5181  amd_dbgapi_address_space_info_t query, size_t value_size,
5182  void *value) AMD_DBGAPI_VERSION_0_46;
5183 
5223  amd_dbgapi_architecture_id_t architecture_id, size_t *address_space_count,
5225 
5266  amd_dbgapi_architecture_id_t architecture_id, uint64_t dwarf_address_space,
5268 
5272 typedef enum
5273 {
5283 
5324  amd_dbgapi_address_space_id_t address_space_id1,
5325  amd_dbgapi_address_space_id_t address_space_id2,
5326  amd_dbgapi_address_space_alias_t *address_space_alias)
5328 
5346 
5425  amd_dbgapi_wave_id_t wave_id, amd_dbgapi_lane_id_t lane_id,
5426  amd_dbgapi_address_space_id_t source_address_space_id,
5427  amd_dbgapi_segment_address_t source_segment_address,
5428  amd_dbgapi_address_space_id_t destination_address_space_id,
5429  amd_dbgapi_segment_address_t *destination_segment_address)
5431 
5436 typedef enum
5437 {
5449 
5511  amd_dbgapi_wave_id_t wave_id, amd_dbgapi_lane_id_t lane_id,
5512  amd_dbgapi_address_space_id_t address_space_id,
5513  amd_dbgapi_segment_address_t segment_address,
5514  amd_dbgapi_address_class_id_t address_class_id,
5515  amd_dbgapi_address_class_state_t *address_class_state)
5517 
5608  amd_dbgapi_process_id_t process_id, amd_dbgapi_wave_id_t wave_id,
5609  amd_dbgapi_lane_id_t lane_id,
5610  amd_dbgapi_address_space_id_t address_space_id,
5611  amd_dbgapi_segment_address_t segment_address,
5612  amd_dbgapi_size_t *value_size, void *value) AMD_DBGAPI_VERSION_0_41;
5613 
5704  amd_dbgapi_process_id_t process_id, amd_dbgapi_wave_id_t wave_id,
5705  amd_dbgapi_lane_id_t lane_id,
5706  amd_dbgapi_address_space_id_t address_space_id,
5707  amd_dbgapi_segment_address_t segment_address,
5708  amd_dbgapi_size_t *value_size, const void *value) AMD_DBGAPI_VERSION_0_41;
5709 
5728 typedef enum
5729 {
5741 
5781  amd_dbgapi_process_id_t process_id,
5783 
5815 typedef struct
5816 {
5817  uint64_t handle;
5819 
5823 #define AMD_DBGAPI_EVENT_NONE ((amd_dbgapi_event_id_t){ 0 })
5824 
5828 typedef enum
5829 {
5929 
5966  amd_dbgapi_process_id_t process_id, amd_dbgapi_event_id_t *event_id,
5968 
5972 typedef enum
5973 {
5989 
5996 typedef enum
5997 {
6032 
6074  size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41;
6075 
6103 
6125 typedef enum
6126 {
6149 
6170 
6195 typedef struct
6196 {
6197  uint64_t handle;
6199 
6203 typedef enum
6204 {
6214 
6218 #define AMD_DBGAPI_SHARED_LIBRARY_NONE ((amd_dbgapi_shared_library_id_t){ 0 })
6219 
6227 typedef enum
6228 {
6235 
6275  amd_dbgapi_shared_library_id_t shared_library_id,
6276  amd_dbgapi_shared_library_info_t query, size_t value_size,
6277  void *value) AMD_DBGAPI_VERSION_0_41;
6278 
6317  amd_dbgapi_shared_library_id_t shared_library_id,
6318  amd_dbgapi_shared_library_state_t shared_library_state)
6320 
6333 typedef struct
6334 {
6335  uint64_t handle;
6337 
6341 #define AMD_DBGAPI_BREAKPOINT_NONE ((amd_dbgapi_breakpoint_id_t){ 0 })
6342 
6349 typedef enum
6350 {
6362 
6402  amd_dbgapi_breakpoint_id_t breakpoint_id,
6403  amd_dbgapi_breakpoint_info_t query, size_t value_size,
6404  void *value) AMD_DBGAPI_VERSION_0_41;
6405 
6409 typedef enum
6410 {
6420 
6430 typedef struct amd_dbgapi_client_thread_s *amd_dbgapi_client_thread_id_t;
6431 
6470  amd_dbgapi_breakpoint_id_t breakpoint_id,
6471  amd_dbgapi_client_thread_id_t client_thread_id,
6473 
6481 {
6482 
6494  void *(*allocate_memory) (size_t byte_size);
6495 
6512  void (*deallocate_memory) (void *data);
6513 
6542  amd_dbgapi_client_process_id_t client_process_id,
6543  amd_dbgapi_os_process_id_t *os_pid);
6544 
6580  amd_dbgapi_client_process_id_t client_process_id,
6581  const char *shared_library_name,
6582  amd_dbgapi_shared_library_id_t shared_library_id,
6583  amd_dbgapi_shared_library_state_t *shared_library_state);
6584 
6608  amd_dbgapi_client_process_id_t client_process_id,
6609  amd_dbgapi_shared_library_id_t shared_library_id);
6643  amd_dbgapi_client_process_id_t client_process_id,
6644  amd_dbgapi_shared_library_id_t shared_library_id,
6645  const char *symbol_name, amd_dbgapi_global_address_t *address);
6646 
6695  amd_dbgapi_client_process_id_t client_process_id,
6696  amd_dbgapi_shared_library_id_t shared_library_id,
6698  amd_dbgapi_breakpoint_id_t breakpoint_id);
6699 
6731  amd_dbgapi_client_process_id_t client_process_id,
6732  amd_dbgapi_breakpoint_id_t breakpoint_id);
6733 
6742  void (*log_message) (amd_dbgapi_log_level_t level, const char *message);
6743 };
6744 
6747 #if defined(__cplusplus)
6748 } /* extern "C" */
6749 #endif /* defined (__cplusplus) */
6750 
6751 #endif /* amd-dbgapi.h */
#define AMD_DBGAPI
Definition: amd-dbgapi.h:419
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_agent_list(amd_dbgapi_process_id_t process_id, size_t *agent_count, amd_dbgapi_agent_id_t **agents, amd_dbgapi_changed_t *changed) AMD_DBGAPI_VERSION_0_41
Return the list of agents.
amd_dbgapi_agent_info_t
Agent queries that are supported by amd_dbgapi_agent_get_info.
Definition: amd-dbgapi.h:2171
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_agent_get_info(amd_dbgapi_agent_id_t agent_id, amd_dbgapi_agent_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about an agent.
@ AMD_DBGAPI_AGENT_INFO_OS_ID
Native operating system agent ID.
Definition: amd-dbgapi.h:2216
@ AMD_DBGAPI_AGENT_INFO_PCI_DEVICE_ID
PCI device ID of the agent.
Definition: amd-dbgapi.h:2201
@ AMD_DBGAPI_AGENT_INFO_PROCESS
Return the process to which this agent belongs.
Definition: amd-dbgapi.h:2176
@ AMD_DBGAPI_AGENT_INFO_PCI_VENDOR_ID
PCI vendor ID of the agent.
Definition: amd-dbgapi.h:2197
@ AMD_DBGAPI_AGENT_INFO_NAME
Agent name.
Definition: amd-dbgapi.h:2182
@ AMD_DBGAPI_AGENT_INFO_ARCHITECTURE
Return the architecture of this agent.
Definition: amd-dbgapi.h:2187
@ AMD_DBGAPI_AGENT_INFO_EXECUTION_UNIT_COUNT
Total number of Execution Units (EUs) available in the agent.
Definition: amd-dbgapi.h:2206
@ AMD_DBGAPI_AGENT_INFO_PCI_SLOT
PCI slot of the agent in BDF format (see [Bus:Device.Function (BDF) Notation][bfd].
Definition: amd-dbgapi.h:2193
@ AMD_DBGAPI_AGENT_INFO_MAX_WAVES_PER_EXECUTION_UNIT
Maximum number of waves supported by an execution unit.
Definition: amd-dbgapi.h:2211
amd_dbgapi_architecture_info_t
Architecture queries that are supported by amd_dbgapi_architecture_get_info.
Definition: amd-dbgapi.h:1103
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_classify_instruction(amd_dbgapi_architecture_id_t architecture_id, amd_dbgapi_global_address_t address, amd_dbgapi_size_t *size, const void *memory, amd_dbgapi_instruction_kind_t *instruction_kind, amd_dbgapi_instruction_properties_t *instruction_properties, void **instruction_information) AMD_DBGAPI_VERSION_0_46
Classify a single instruction.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_architecture_get_info(amd_dbgapi_architecture_id_t architecture_id, amd_dbgapi_architecture_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_30
Query information about an architecture.
struct amd_dbgapi_symbolizer_id_s * amd_dbgapi_symbolizer_id_t
Opaque client symbolizer handle.
Definition: amd-dbgapi.h:1237
amd_dbgapi_instruction_kind_t
The kinds of instruction classifications.
Definition: amd-dbgapi.h:1344
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_disassemble_instruction(amd_dbgapi_architecture_id_t architecture_id, amd_dbgapi_global_address_t address, amd_dbgapi_size_t *size, const void *memory, char **instruction_text, amd_dbgapi_symbolizer_id_t symbolizer_id, amd_dbgapi_status_t(*symbolizer)(amd_dbgapi_symbolizer_id_t symbolizer_id, amd_dbgapi_global_address_t address, char **symbol_text)) AMD_DBGAPI_VERSION_0_30
Disassemble a single instruction.
amd_dbgapi_instruction_properties_t
A bit mask of the properties of an instruction.
Definition: amd-dbgapi.h:1460
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_get_architecture(uint32_t elf_amdgpu_machine, amd_dbgapi_architecture_id_t *architecture_id) AMD_DBGAPI_VERSION_0_24
Get an architecture from the AMD GPU ELF EF_AMDGPU_MACH value corresponding to the architecture.
@ AMD_DBGAPI_ARCHITECTURE_INFO_ELF_AMDGPU_MACHINE
Return the AMD GPU ELF EF_AMDGPU_MACH value corresponding to the architecture.
Definition: amd-dbgapi.h:1118
@ AMD_DBGAPI_ARCHITECTURE_INFO_MINIMUM_INSTRUCTION_ALIGNMENT
Return the minimum instruction alignment in bytes for the architecture.
Definition: amd-dbgapi.h:1129
@ AMD_DBGAPI_ARCHITECTURE_INFO_BREAKPOINT_INSTRUCTION_SIZE
Return the breakpoint instruction size in bytes for the architecture.
Definition: amd-dbgapi.h:1134
@ AMD_DBGAPI_ARCHITECTURE_INFO_PC_REGISTER
Return the register handle for the PC for the architecture.
Definition: amd-dbgapi.h:1153
@ AMD_DBGAPI_ARCHITECTURE_INFO_BREAKPOINT_INSTRUCTION_PC_ADJUST
Return the number of bytes to subtract from the PC after stopping due to a breakpoint instruction to ...
Definition: amd-dbgapi.h:1148
@ AMD_DBGAPI_ARCHITECTURE_INFO_LARGEST_INSTRUCTION_SIZE
Return the largest instruction size in bytes for the architecture.
Definition: amd-dbgapi.h:1123
@ AMD_DBGAPI_ARCHITECTURE_INFO_BREAKPOINT_INSTRUCTION
Return the breakpoint instruction for the architecture.
Definition: amd-dbgapi.h:1142
@ AMD_DBGAPI_ARCHITECTURE_INFO_NAME
Return the architecture name.
Definition: amd-dbgapi.h:1110
@ AMD_DBGAPI_INSTRUCTION_KIND_BARRIER
The instruction performs some kind of execution barrier which may result in the wave being halted unt...
Definition: amd-dbgapi.h:1438
@ AMD_DBGAPI_INSTRUCTION_KIND_INDIRECT_CALL_REGISTER_PAIRS
The instruction unconditionally branches to an address held in a pair of source registers and the add...
Definition: amd-dbgapi.h:1407
@ AMD_DBGAPI_INSTRUCTION_KIND_SEQUENTIAL
The instruction executes sequentially.
Definition: amd-dbgapi.h:1355
@ AMD_DBGAPI_INSTRUCTION_KIND_INDIRECT_BRANCH_CONDITIONAL_REGISTER_PAIR
The instruction conditionally branches to an address held in a pair of registers.
Definition: amd-dbgapi.h:1386
@ AMD_DBGAPI_INSTRUCTION_KIND_SPECIAL
The instruction has some form of special behavior not covered by any of the other instruction kinds.
Definition: amd-dbgapi.h:1453
@ AMD_DBGAPI_INSTRUCTION_KIND_HALT
The instruction unconditionally halts the wave.
Definition: amd-dbgapi.h:1431
@ AMD_DBGAPI_INSTRUCTION_KIND_TRAP
The instruction enters the trap handler.
Definition: amd-dbgapi.h:1426
@ AMD_DBGAPI_INSTRUCTION_KIND_DIRECT_CALL_REGISTER_PAIR
The instruction unconditionally branches to a literal address and the address of the following instru...
Definition: amd-dbgapi.h:1397
@ AMD_DBGAPI_INSTRUCTION_KIND_INDIRECT_BRANCH_REGISTER_PAIR
The instruction unconditionally branches to an address held in a pair of registers.
Definition: amd-dbgapi.h:1376
@ AMD_DBGAPI_INSTRUCTION_KIND_DIRECT_BRANCH_CONDITIONAL
The instruction conditionally branches to a literal address.
Definition: amd-dbgapi.h:1368
@ AMD_DBGAPI_INSTRUCTION_KIND_SLEEP
The instruction causes the wave to stop executing for some period of time, before continuing executio...
Definition: amd-dbgapi.h:1444
@ AMD_DBGAPI_INSTRUCTION_KIND_TERMINATE
The instruction terminates the wave execution.
Definition: amd-dbgapi.h:1412
@ AMD_DBGAPI_INSTRUCTION_KIND_UNKNOWN
The instruction classification is unknown.
Definition: amd-dbgapi.h:1349
@ AMD_DBGAPI_INSTRUCTION_KIND_DIRECT_BRANCH
The instruction unconditionally branches to a literal address.
Definition: amd-dbgapi.h:1361
@ AMD_DBGAPI_INSTRUCTION_PROPERTY_RESERVED
A reserved value only present to ensure that the underlying representation of this enumeration type i...
Definition: amd-dbgapi.h:1469
@ AMD_DBGAPI_INSTRUCTION_PROPERTY_NONE
The instruction has no properties.
Definition: amd-dbgapi.h:1464
uint64_t amd_dbgapi_size_t
Integral type used for sizes, including memory allocations, in the inferior.
Definition: amd-dbgapi.h:518
uint64_t amd_dbgapi_os_queue_id_t
Native operating system queue ID.
Definition: amd-dbgapi.h:591
uint64_t amd_dbgapi_global_address_t
Integral type used for a global virtual memory address in the inferior process.
Definition: amd-dbgapi.h:513
uint64_t amd_dbgapi_os_queue_packet_id_t
Native operating system queue packet ID.
Definition: amd-dbgapi.h:603
uint64_t amd_dbgapi_os_agent_id_t
Native operating system agent ID.
Definition: amd-dbgapi.h:581
amd_dbgapi_os_queue_type_t
Native operating system queue type.
Definition: amd-dbgapi.h:615
int amd_dbgapi_notifier_t
Type used to notify the client of the library that a process may have pending events.
Definition: amd-dbgapi.h:570
pid_t amd_dbgapi_os_process_id_t
Native operating system process ID.
Definition: amd-dbgapi.h:543
amd_dbgapi_changed_t
Indication of if a value has changed.
Definition: amd-dbgapi.h:524
@ AMD_DBGAPI_OS_QUEUE_TYPE_UNKNOWN
Unknown queue type.
Definition: amd-dbgapi.h:619
@ AMD_DBGAPI_OS_QUEUE_TYPE_AMD_SDMA
Queue supports the AMD SDMA protocol.
Definition: amd-dbgapi.h:669
@ AMD_DBGAPI_OS_QUEUE_TYPE_AMD_PM4
Queue supports the AMD PM4 protocol.
Definition: amd-dbgapi.h:665
@ AMD_DBGAPI_OS_QUEUE_TYPE_HSA_KERNEL_DISPATCH_MULTIPLE_PRODUCER
Queue supports the HSA kernel dispatch with multiple producers protocol.
Definition: amd-dbgapi.h:635
@ AMD_DBGAPI_OS_QUEUE_TYPE_HSA_KERNEL_DISPATCH_SINGLE_PRODUCER
Queue supports the HSA kernel dispatch with single producer protocol.
Definition: amd-dbgapi.h:651
@ AMD_DBGAPI_OS_QUEUE_TYPE_AMD_SDMA_XGMI
Queue supports the AMD SDMA XGMI protocol.
Definition: amd-dbgapi.h:673
@ AMD_DBGAPI_OS_QUEUE_TYPE_HSA_KERNEL_DISPATCH_COOPERATIVE
Queue supports HSA kernel dispatch with multiple producers protocol that supports cooperative dispatc...
Definition: amd-dbgapi.h:661
@ AMD_DBGAPI_CHANGED_YES
The value has changed.
Definition: amd-dbgapi.h:532
@ AMD_DBGAPI_CHANGED_NO
The value has not changed.
Definition: amd-dbgapi.h:528
amd_dbgapi_breakpoint_info_t
Breakpoint queries that are supported by amd_dbgapi_breakpoint_get_info.
Definition: amd-dbgapi.h:6350
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_report_shared_library(amd_dbgapi_shared_library_id_t shared_library_id, amd_dbgapi_shared_library_state_t shared_library_state) AMD_DBGAPI_VERSION_0_41
Report that a shared library enabled by the amd_dbgapi_callbacks_s::enable_notify_shared_library call...
amd_dbgapi_breakpoint_action_t
The action to perform after reporting a breakpoint has been hit.
Definition: amd-dbgapi.h:6410
amd_dbgapi_shared_library_info_t
Shared library queries that are supported by amd_dbgapi_shared_library_get_info.
Definition: amd-dbgapi.h:6228
amd_dbgapi_shared_library_state_t
The state of a shared library.
Definition: amd-dbgapi.h:6204
struct amd_dbgapi_client_thread_s * amd_dbgapi_client_thread_id_t
Opaque client thread handle.
Definition: amd-dbgapi.h:6430
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_breakpoint_get_info(amd_dbgapi_breakpoint_id_t breakpoint_id, amd_dbgapi_breakpoint_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a breakpoint.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_shared_library_get_info(amd_dbgapi_shared_library_id_t shared_library_id, amd_dbgapi_shared_library_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a shared library.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_report_breakpoint_hit(amd_dbgapi_breakpoint_id_t breakpoint_id, amd_dbgapi_client_thread_id_t client_thread_id, amd_dbgapi_breakpoint_action_t *breakpoint_action) AMD_DBGAPI_VERSION_0_41
Report that a breakpoint inserted by the amd_dbgapi_callbacks_s::insert_breakpoint calback has been h...
@ AMD_DBGAPI_BREAKPOINT_INFO_PROCESS
Return the process to which this breakpoint belongs.
Definition: amd-dbgapi.h:6360
@ AMD_DBGAPI_BREAKPOINT_INFO_SHARED_LIBRARY
Return the shared library to which this breakpoint belongs.
Definition: amd-dbgapi.h:6355
@ AMD_DBGAPI_BREAKPOINT_ACTION_RESUME
Resume execution.
Definition: amd-dbgapi.h:6414
@ AMD_DBGAPI_BREAKPOINT_ACTION_HALT
Leave execution halted.
Definition: amd-dbgapi.h:6418
@ AMD_DBGAPI_SHARED_LIBRARY_INFO_PROCESS
Return the process to which this shared library belongs.
Definition: amd-dbgapi.h:6233
@ AMD_DBGAPI_SHARED_LIBRARY_STATE_LOADED
The shared library is loaded.
Definition: amd-dbgapi.h:6208
@ AMD_DBGAPI_SHARED_LIBRARY_STATE_UNLOADED
The shared library is unloaded.
Definition: amd-dbgapi.h:6212
amd_dbgapi_code_object_info_t
Code object queries that are supported by amd_dbgapi_code_object_get_info.
Definition: amd-dbgapi.h:1978
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_code_object_list(amd_dbgapi_process_id_t process_id, size_t *code_object_count, amd_dbgapi_code_object_id_t **code_objects, amd_dbgapi_changed_t *changed) AMD_DBGAPI_VERSION_0_41
Return the list of loaded code objects.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_code_object_get_info(amd_dbgapi_code_object_id_t code_object_id, amd_dbgapi_code_object_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a code object.
@ AMD_DBGAPI_CODE_OBJECT_INFO_PROCESS
Return the process to which this code object belongs.
Definition: amd-dbgapi.h:1983
@ AMD_DBGAPI_CODE_OBJECT_INFO_URI_NAME
The URI name of the ELF shared object from which the code object was loaded.
Definition: amd-dbgapi.h:2032
@ AMD_DBGAPI_CODE_OBJECT_INFO_LOAD_ADDRESS
The difference between the address in the ELF shared object and the address the code object is loaded...
Definition: amd-dbgapi.h:2038
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_dispatch_list(amd_dbgapi_process_id_t process_id, size_t *dispatch_count, amd_dbgapi_dispatch_id_t **dispatches, amd_dbgapi_changed_t *changed) AMD_DBGAPI_VERSION_0_41
Return the list of dispatches.
amd_dbgapi_dispatch_info_t
Dispatch queries that are supported by amd_dbgapi_dispatch_get_info.
Definition: amd-dbgapi.h:2650
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_dispatch_get_info(amd_dbgapi_dispatch_id_t dispatch_id, amd_dbgapi_dispatch_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a dispatch.
amd_dbgapi_dispatch_barrier_t
Dispatch barrier.
Definition: amd-dbgapi.h:2796
amd_dbgapi_dispatch_fence_scope_t
Dispatch memory fence scope.
Definition: amd-dbgapi.h:2815
@ AMD_DBGAPI_DISPATCH_INFO_ACQUIRE_FENCE
Return the dispatch acquire fence.
Definition: amd-dbgapi.h:2686
@ AMD_DBGAPI_DISPATCH_INFO_KERNEL_ARGUMENT_SEGMENT_ADDRESS
Return the dispatch kernel argument segment address.
Definition: amd-dbgapi.h:2721
@ AMD_DBGAPI_DISPATCH_INFO_QUEUE
Return the queue to which this dispatch belongs.
Definition: amd-dbgapi.h:2655
@ AMD_DBGAPI_DISPATCH_INFO_GROUP_SEGMENT_SIZE
Return the dispatch group segment size in bytes.
Definition: amd-dbgapi.h:2716
@ AMD_DBGAPI_DISPATCH_INFO_AGENT
Return the agent to which this dispatch belongs.
Definition: amd-dbgapi.h:2660
@ AMD_DBGAPI_DISPATCH_INFO_WORK_GROUP_SIZES
Return the dispatch workgroup size (work-items) in the X, Y, and Z dimensions.
Definition: amd-dbgapi.h:2701
@ AMD_DBGAPI_DISPATCH_INFO_GRID_DIMENSIONS
Return the dispatch grid dimensionality.
Definition: amd-dbgapi.h:2696
@ AMD_DBGAPI_DISPATCH_INFO_OS_QUEUE_PACKET_ID
Return the queue packet ID of the dispatch packet that initiated the dispatch.
Definition: amd-dbgapi.h:2676
@ AMD_DBGAPI_DISPATCH_INFO_PROCESS
Return the process to which this dispatch belongs.
Definition: amd-dbgapi.h:2665
@ AMD_DBGAPI_DISPATCH_INFO_GRID_SIZES
Return the dispatch grid size (work-items) in the X, Y, and Z dimensions.
Definition: amd-dbgapi.h:2706
@ AMD_DBGAPI_DISPATCH_INFO_RELEASE_FENCE
Return the dispatch release fence.
Definition: amd-dbgapi.h:2691
@ AMD_DBGAPI_DISPATCH_INFO_BARRIER
Return the dispatch barrier setting.
Definition: amd-dbgapi.h:2681
@ AMD_DBGAPI_DISPATCH_INFO_ARCHITECTURE
Return the architecture of this dispatch.
Definition: amd-dbgapi.h:2670
@ AMD_DBGAPI_DISPATCH_INFO_KERNEL_DESCRIPTOR_ADDRESS
Return the dispatch kernel descriptor address.
Definition: amd-dbgapi.h:2726
@ AMD_DBGAPI_DISPATCH_INFO_PRIVATE_SEGMENT_SIZE
Return the dispatch private segment size in bytes.
Definition: amd-dbgapi.h:2711
@ AMD_DBGAPI_DISPATCH_INFO_KERNEL_COMPLETION_ADDRESS
Return the dispatch completion event address.
Definition: amd-dbgapi.h:2741
@ AMD_DBGAPI_DISPATCH_INFO_KERNEL_CODE_ENTRY_ADDRESS
Return the dispatch kernel code entry address.
Definition: amd-dbgapi.h:2731
@ AMD_DBGAPI_DISPATCH_BARRIER_NONE
Dispatch has no barrier.
Definition: amd-dbgapi.h:2800
@ AMD_DBGAPI_DISPATCH_BARRIER_PRESENT
Dispatch has a barrier.
Definition: amd-dbgapi.h:2805
@ AMD_DBGAPI_DISPATCH_FENCE_SCOPE_NONE
There is no fence.
Definition: amd-dbgapi.h:2819
@ AMD_DBGAPI_DISPATCH_FENCE_SCOPE_AGENT
There is a fence with agent memory scope.
Definition: amd-dbgapi.h:2823
@ AMD_DBGAPI_DISPATCH_FENCE_SCOPE_SYSTEM
There is a fence with system memory scope.
Definition: amd-dbgapi.h:2827
amd_dbgapi_displaced_stepping_info_t
Displaced stepping queries that are supported by amd_dbgapi_displaced_stepping_id_t.
Definition: amd-dbgapi.h:3649
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_displaced_stepping_get_info(amd_dbgapi_displaced_stepping_id_t displaced_stepping_id, amd_dbgapi_displaced_stepping_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a displaced stepping buffer.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_displaced_stepping_complete(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_displaced_stepping_id_t displaced_stepping) AMD_DBGAPI_VERSION_0_42
Complete a displaced stepping buffer for a wave.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_displaced_stepping_start(amd_dbgapi_wave_id_t wave_id, const void *saved_instruction_bytes, amd_dbgapi_displaced_stepping_id_t *displaced_stepping) AMD_DBGAPI_VERSION_0_46
Associate an active displaced stepping buffer with a wave.
@ AMD_DBGAPI_DISPLACED_STEPPING_INFO_PROCESS
Return the process to which this displaced stepping belongs.
Definition: amd-dbgapi.h:3654
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_event_processed(amd_dbgapi_event_id_t event_id) AMD_DBGAPI_VERSION_0_41
Report that an event has been processed.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_event_get_info(amd_dbgapi_event_id_t event_id, amd_dbgapi_event_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about an event.
amd_dbgapi_event_info_t
Event queries that are supported by amd_dbgapi_event_get_info.
Definition: amd-dbgapi.h:5997
amd_dbgapi_runtime_state_t
Inferior runtime state.
Definition: amd-dbgapi.h:5973
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_next_pending_event(amd_dbgapi_process_id_t process_id, amd_dbgapi_event_id_t *event_id, amd_dbgapi_event_kind_t *kind) AMD_DBGAPI_VERSION_0_41
Obtain the next pending event.
amd_dbgapi_event_kind_t
The event kinds.
Definition: amd-dbgapi.h:5829
@ AMD_DBGAPI_EVENT_INFO_CLIENT_THREAD
Return the client thread of a AMD_DBGAPI_EVENT_KIND_BREAKPOINT_RESUME event.
Definition: amd-dbgapi.h:6023
@ AMD_DBGAPI_EVENT_INFO_KIND
Return the event kind.
Definition: amd-dbgapi.h:6007
@ AMD_DBGAPI_EVENT_INFO_RUNTIME_STATE
Return if the runtime loaded in the inferior is supported by the library for a AMD_DBGAPI_EVENT_KIND_...
Definition: amd-dbgapi.h:6030
@ AMD_DBGAPI_EVENT_INFO_BREAKPOINT
Return the breakpoint of a AMD_DBGAPI_EVENT_KIND_BREAKPOINT_RESUME event.
Definition: amd-dbgapi.h:6018
@ AMD_DBGAPI_EVENT_INFO_WAVE
Return the wave of a AMD_DBGAPI_EVENT_KIND_WAVE_STOP or AMD_DBGAPI_EVENT_KIND_WAVE_COMMAND_TERMINATED...
Definition: amd-dbgapi.h:6013
@ AMD_DBGAPI_EVENT_INFO_PROCESS
Return the process to which this event belongs.
Definition: amd-dbgapi.h:6002
@ AMD_DBGAPI_RUNTIME_STATE_UNLOADED
The runtime has been unloaded.
Definition: amd-dbgapi.h:5981
@ AMD_DBGAPI_RUNTIME_STATE_LOADED_SUCCESS
The runtime has been loaded and debugging is supported by the library.
Definition: amd-dbgapi.h:5977
@ AMD_DBGAPI_RUNTIME_STATE_LOADED_ERROR_RESTRICTION
The runtime has been loaded but there is a restriction error that prevents debugging the process.
Definition: amd-dbgapi.h:5987
@ AMD_DBGAPI_EVENT_KIND_CODE_OBJECT_LIST_UPDATED
The list of code objects has changed.
Definition: amd-dbgapi.h:5868
@ AMD_DBGAPI_EVENT_KIND_WAVE_COMMAND_TERMINATED
A command for a wave was not able to complete because the wave has terminated.
Definition: amd-dbgapi.h:5852
@ AMD_DBGAPI_EVENT_KIND_QUEUE_ERROR
An event has occurred that is causing the queue to enter the error state.
Definition: amd-dbgapi.h:5927
@ AMD_DBGAPI_EVENT_KIND_WAVE_STOP
A wave has stopped.
Definition: amd-dbgapi.h:5837
@ AMD_DBGAPI_EVENT_KIND_BREAKPOINT_RESUME
Request to resume a host breakpoint.
Definition: amd-dbgapi.h:5881
@ AMD_DBGAPI_EVENT_KIND_RUNTIME
The runtime support in the inferior has been loaded or unloaded.
Definition: amd-dbgapi.h:5891
@ AMD_DBGAPI_EVENT_KIND_NONE
No event.
Definition: amd-dbgapi.h:5833
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_initialize(amd_dbgapi_callbacks_t *callbacks) AMD_DBGAPI_VERSION_0_30
Initialize the library.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_finalize(void) AMD_DBGAPI_VERSION_0_24
Finalize the library.
amd_dbgapi_log_level_t
The logging levels supported.
Definition: amd-dbgapi.h:6126
void AMD_DBGAPI amd_dbgapi_set_log_level(amd_dbgapi_log_level_t level) AMD_DBGAPI_VERSION_0_24
Set the logging level.
@ AMD_DBGAPI_LOG_LEVEL_NONE
Print no messages.
Definition: amd-dbgapi.h:6130
@ AMD_DBGAPI_LOG_LEVEL_VERBOSE
Print fatal error, warning, info, and verbose messages.
Definition: amd-dbgapi.h:6147
@ AMD_DBGAPI_LOG_LEVEL_INFO
Print fatal error, warning, and info messages.
Definition: amd-dbgapi.h:6143
@ AMD_DBGAPI_LOG_LEVEL_WARNING
Print fatal error and warning messages.
Definition: amd-dbgapi.h:6139
@ AMD_DBGAPI_LOG_LEVEL_FATAL_ERROR
Print fatal error messages.
Definition: amd-dbgapi.h:6135
amd_dbgapi_address_class_info_t
Source language address class queries that are supported by ::amd_dbgapi_architecture_address_class_g...
Definition: amd-dbgapi.h:4887
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_dwarf_address_class_to_address_class(amd_dbgapi_architecture_id_t architecture_id, uint64_t dwarf_address_class, amd_dbgapi_address_class_id_t *address_class_id) AMD_DBGAPI_VERSION_0_41
Return the architecture source language address class from a DWARF address class number for an archit...
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_read_memory(amd_dbgapi_process_id_t process_id, amd_dbgapi_wave_id_t wave_id, amd_dbgapi_lane_id_t lane_id, amd_dbgapi_address_space_id_t address_space_id, amd_dbgapi_segment_address_t segment_address, amd_dbgapi_size_t *value_size, void *value) AMD_DBGAPI_VERSION_0_41
Read memory.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_address_is_in_address_class(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_lane_id_t lane_id, amd_dbgapi_address_space_id_t address_space_id, amd_dbgapi_segment_address_t segment_address, amd_dbgapi_address_class_id_t address_class_id, amd_dbgapi_address_class_state_t *address_class_state) AMD_DBGAPI_VERSION_0_41
Determine if a segment address in an address space is a member of a source language address class.
uint32_t amd_dbgapi_lane_id_t
A wave lane handle.
Definition: amd-dbgapi.h:4849
amd_dbgapi_address_space_alias_t
Indication of whether addresses in two address spaces may alias.
Definition: amd-dbgapi.h:5273
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_address_space_get_info(amd_dbgapi_address_space_id_t address_space_id, amd_dbgapi_address_space_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_46
Query information about an address space.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_write_memory(amd_dbgapi_process_id_t process_id, amd_dbgapi_wave_id_t wave_id, amd_dbgapi_lane_id_t lane_id, amd_dbgapi_address_space_id_t address_space_id, amd_dbgapi_segment_address_t segment_address, amd_dbgapi_size_t *value_size, const void *value) AMD_DBGAPI_VERSION_0_41
Write memory.
uint64_t amd_dbgapi_segment_address_t
Each address space has its own linear address to access it termed a segment address.
Definition: amd-dbgapi.h:5345
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_address_spaces_may_alias(amd_dbgapi_address_space_id_t address_space_id1, amd_dbgapi_address_space_id_t address_space_id2, amd_dbgapi_address_space_alias_t *address_space_alias) AMD_DBGAPI_VERSION_0_41
Determine if an address in one address space may alias an address in another address space.
amd_dbgapi_address_space_access_t
Indication of how the address space is accessed.
Definition: amd-dbgapi.h:5080
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_set_memory_precision(amd_dbgapi_process_id_t process_id, amd_dbgapi_memory_precision_t memory_precision) AMD_DBGAPI_VERSION_0_24
Control precision of memory access reporting.
amd_dbgapi_address_class_state_t
Indication of whether a segment address in an address space is a member of an source language address...
Definition: amd-dbgapi.h:5437
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_dwarf_address_space_to_address_space(amd_dbgapi_architecture_id_t architecture_id, uint64_t dwarf_address_space, amd_dbgapi_address_space_id_t *address_space_id) AMD_DBGAPI_VERSION_0_41
Return the address space from an AMD GPU DWARF address space number for an architecture.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_convert_address_space(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_lane_id_t lane_id, amd_dbgapi_address_space_id_t source_address_space_id, amd_dbgapi_segment_address_t source_segment_address, amd_dbgapi_address_space_id_t destination_address_space_id, amd_dbgapi_segment_address_t *destination_segment_address) AMD_DBGAPI_VERSION_0_41
Convert a source segment address in the source address space into a destination segment address in th...
amd_dbgapi_address_space_info_t
Address space queries that are supported by amd_dbgapi_address_space_get_info.
Definition: amd-dbgapi.h:5106
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_architecture_address_class_list(amd_dbgapi_architecture_id_t architecture_id, size_t *address_class_count, amd_dbgapi_address_class_id_t **address_classes) AMD_DBGAPI_VERSION_0_24
Report the list of source language address classes supported by the architecture.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_address_class_get_info(amd_dbgapi_address_class_id_t address_class_id, amd_dbgapi_address_class_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_46
Query information about a source language address class of an architecture.
amd_dbgapi_memory_precision_t
Memory access precision.
Definition: amd-dbgapi.h:5729
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_architecture_address_space_list(amd_dbgapi_architecture_id_t architecture_id, size_t *address_space_count, amd_dbgapi_address_space_id_t **address_spaces) AMD_DBGAPI_VERSION_0_24
Report the list of address spaces supported by the architecture.
@ AMD_DBGAPI_ADDRESS_CLASS_INFO_NAME
Return the source language address class name.
Definition: amd-dbgapi.h:4899
@ AMD_DBGAPI_ADDRESS_CLASS_INFO_ADDRESS_SPACE
Return the architecture specific address space that is used to implement a pointer or reference to th...
Definition: amd-dbgapi.h:4908
@ AMD_DBGAPI_ADDRESS_CLASS_INFO_DWARF
Return the AMD GPU DWARF address class number for the address class' architecture.
Definition: amd-dbgapi.h:4913
@ AMD_DBGAPI_ADDRESS_CLASS_INFO_ARCHITECTURE
Return the architecture to which this address class belongs.
Definition: amd-dbgapi.h:4892
@ AMD_DBGAPI_ADDRESS_SPACE_ALIAS_NONE
No addresses in the address spaces can alias.
Definition: amd-dbgapi.h:5277
@ AMD_DBGAPI_ADDRESS_SPACE_ALIAS_MAY
Addresses in the address spaces may alias.
Definition: amd-dbgapi.h:5281
@ AMD_DBGAPI_ADDRESS_SPACE_ACCESS_DISPATCH_CONSTANT
The address space is only read the waves of a kernel dispatch.
Definition: amd-dbgapi.h:5095
@ AMD_DBGAPI_ADDRESS_SPACE_ACCESS_PROGRAM_CONSTANT
The address space is read only.
Definition: amd-dbgapi.h:5090
@ AMD_DBGAPI_ADDRESS_SPACE_ACCESS_ALL
The address space supports all accesses.
Definition: amd-dbgapi.h:5085
@ AMD_DBGAPI_ADDRESS_CLASS_STATE_NOT_MEMBER
The segment address in the address space is not a member of the source language address class.
Definition: amd-dbgapi.h:5442
@ AMD_DBGAPI_ADDRESS_CLASS_STATE_MEMBER
The segment address in the address space is a member of the source language address class.
Definition: amd-dbgapi.h:5447
@ AMD_DBGAPI_ADDRESS_SPACE_INFO_ACCESS
Return the address space access.
Definition: amd-dbgapi.h:5133
@ AMD_DBGAPI_ADDRESS_SPACE_INFO_DWARF
Return the AMD GPU DWARF address space number for the address space's architecture.
Definition: amd-dbgapi.h:5138
@ AMD_DBGAPI_ADDRESS_SPACE_INFO_ADDRESS_SIZE
Return the byte size of an address in the address space.
Definition: amd-dbgapi.h:5123
@ AMD_DBGAPI_ADDRESS_SPACE_INFO_NULL_ADDRESS
Return the NULL segment address value in the address space.
Definition: amd-dbgapi.h:5128
@ AMD_DBGAPI_ADDRESS_SPACE_INFO_ARCHITECTURE
Return the architecture to which this address space belongs.
Definition: amd-dbgapi.h:5111
@ AMD_DBGAPI_ADDRESS_SPACE_INFO_NAME
Return the address space name.
Definition: amd-dbgapi.h:5118
@ AMD_DBGAPI_MEMORY_PRECISION_NONE
Memory instructions execute normally and a wave does not wait for the memory access to complete.
Definition: amd-dbgapi.h:5734
@ AMD_DBGAPI_MEMORY_PRECISION_PRECISE
A wave waits for memory instructions to complete before executing further instructions.
Definition: amd-dbgapi.h:5739
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_detach(amd_dbgapi_process_id_t process_id) AMD_DBGAPI_VERSION_0_24
Detach from a process and no longer have debug control of the AMD GPU devices it uses.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_set_wave_creation(amd_dbgapi_process_id_t process_id, amd_dbgapi_wave_creation_t creation) AMD_DBGAPI_VERSION_0_24
Set the wave creation mode for a process.
amd_dbgapi_wave_creation_t
The kinds of wave creation supported by the hardware.
Definition: amd-dbgapi.h:1896
struct amd_dbgapi_client_process_s * amd_dbgapi_client_process_id_t
Opaque client process handle.
Definition: amd-dbgapi.h:1571
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_set_progress(amd_dbgapi_process_id_t process_id, amd_dbgapi_progress_t progress) AMD_DBGAPI_VERSION_0_24
Set the progress required for a process.
amd_dbgapi_progress_t
The kinds of progress supported by the library.
Definition: amd-dbgapi.h:1825
amd_dbgapi_process_info_t
Process queries that are supported by amd_dbgapi_process_get_info.
Definition: amd-dbgapi.h:1600
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_attach(amd_dbgapi_client_process_id_t client_process_id, amd_dbgapi_process_id_t *process_id) AMD_DBGAPI_VERSION_0_30
Attach to a process in order to provide debug control of the AMD GPUs it uses.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_get_info(amd_dbgapi_process_id_t process_id, amd_dbgapi_process_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a process.
@ AMD_DBGAPI_WAVE_CREATION_NORMAL
Normal wave creation allows new waves to be created.
Definition: amd-dbgapi.h:1900
@ AMD_DBGAPI_WAVE_CREATION_STOP
Stop wave creation prevents new waves from being created.
Definition: amd-dbgapi.h:1904
@ AMD_DBGAPI_PROGRESS_NO_FORWARD
No forward progress is needed.
Definition: amd-dbgapi.h:1855
@ AMD_DBGAPI_PROGRESS_NORMAL
Normal progress is needed.
Definition: amd-dbgapi.h:1831
@ AMD_DBGAPI_PROCESS_INFO_WATCHPOINT_COUNT
Return the number of data watchpoints supported by the process.
Definition: amd-dbgapi.h:1611
@ AMD_DBGAPI_PROCESS_INFO_PRECISE_MEMORY_SUPPORTED
Return if the architectures of all the agents of a process support controlling memory precision.
Definition: amd-dbgapi.h:1623
@ AMD_DBGAPI_PROCESS_INFO_NOTIFIER
The notifier for the process that indicates if pending events are available.
Definition: amd-dbgapi.h:1605
@ AMD_DBGAPI_PROCESS_INFO_WATCHPOINT_SHARE
Return how watchpoints are shared between processes.
Definition: amd-dbgapi.h:1617
@ AMD_DBGAPI_PROCESS_INFO_OS_ID
Native operating system process ID.
Definition: amd-dbgapi.h:1629
amd_dbgapi_queue_state_t
Queue state.
Definition: amd-dbgapi.h:2445
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_queue_packet_list(amd_dbgapi_queue_id_t queue_id, amd_dbgapi_os_queue_packet_id_t *read_packet_id, amd_dbgapi_os_queue_packet_id_t *write_packet_id, size_t *packets_byte_size, void **packets_bytes) AMD_DBGAPI_VERSION_0_41
Return the packets for a queue.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_queue_list(amd_dbgapi_process_id_t process_id, size_t *queue_count, amd_dbgapi_queue_id_t **queues, amd_dbgapi_changed_t *changed) AMD_DBGAPI_VERSION_0_41
Return the list of queues.
amd_dbgapi_queue_error_reason_t
A bit mask of the reasons that a queue is in error.
Definition: amd-dbgapi.h:2464
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_queue_get_info(amd_dbgapi_queue_id_t queue_id, amd_dbgapi_queue_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a queue.
amd_dbgapi_queue_info_t
Queue queries that are supported by amd_dbgapi_queue_get_info.
Definition: amd-dbgapi.h:2349
@ AMD_DBGAPI_QUEUE_STATE_VALID
Queue is in a valid state.
Definition: amd-dbgapi.h:2449
@ AMD_DBGAPI_QUEUE_STATE_ERROR
Queue is in an error state.
Definition: amd-dbgapi.h:2457
@ AMD_DBGAPI_QUEUE_ERROR_REASON_NONE
If none of the bits are set, then the queue is not in the error state.
Definition: amd-dbgapi.h:2468
@ AMD_DBGAPI_QUEUE_ERROR_REASON_ASSERT_TRAP
A wave on the queue had an assert trap.
Definition: amd-dbgapi.h:2480
@ AMD_DBGAPI_QUEUE_ERROR_REASON_WAVE_ERROR
A wave on the queue executed an instruction that caused an error.
Definition: amd-dbgapi.h:2486
@ AMD_DBGAPI_QUEUE_ERROR_REASON_RESERVED
A reserved value only present to ensure that the underlying representation of this enumeration type i...
Definition: amd-dbgapi.h:2491
@ AMD_DBGAPI_QUEUE_ERROR_REASON_INVALID_PACKET
A packet on the queue is invalid.
Definition: amd-dbgapi.h:2472
@ AMD_DBGAPI_QUEUE_ERROR_REASON_MEMORY_VIOLATION
A wave on the queue had a memory violation.
Definition: amd-dbgapi.h:2476
@ AMD_DBGAPI_QUEUE_INFO_ARCHITECTURE
Return the architecture of this queue.
Definition: amd-dbgapi.h:2364
@ AMD_DBGAPI_QUEUE_INFO_PROCESS
Return the process to which this queue belongs.
Definition: amd-dbgapi.h:2359
@ AMD_DBGAPI_QUEUE_INFO_TYPE
Return the queue type.
Definition: amd-dbgapi.h:2369
@ AMD_DBGAPI_QUEUE_INFO_ADDRESS
Return the base address of the memory holding the queue packets.
Definition: amd-dbgapi.h:2386
@ AMD_DBGAPI_QUEUE_INFO_STATE
Return the queue state.
Definition: amd-dbgapi.h:2374
@ AMD_DBGAPI_QUEUE_INFO_AGENT
Return the agent to which this queue belongs.
Definition: amd-dbgapi.h:2354
@ AMD_DBGAPI_QUEUE_INFO_SIZE
Return the size in bytes of the memory holding the queue packets.
Definition: amd-dbgapi.h:2391
@ AMD_DBGAPI_QUEUE_INFO_ERROR_REASON
Return the reason the queue is in error as a bit set.
Definition: amd-dbgapi.h:2381
@ AMD_DBGAPI_QUEUE_INFO_OS_ID
Native operating system queue ID.
Definition: amd-dbgapi.h:2396
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_write_register(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id, amd_dbgapi_size_t offset, amd_dbgapi_size_t value_size, const void *value) AMD_DBGAPI_VERSION_0_42
Write a register.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_prefetch_register(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id, amd_dbgapi_size_t register_count) AMD_DBGAPI_VERSION_0_41
Prefetch register values.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_dwarf_register_to_register(amd_dbgapi_architecture_id_t architecture_id, uint64_t dwarf_register, amd_dbgapi_register_id_t *register_id) AMD_DBGAPI_VERSION_0_41
Return a register handle from an AMD GPU DWARF register number for an architecture.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_architecture_register_class_list(amd_dbgapi_architecture_id_t architecture_id, size_t *register_class_count, amd_dbgapi_register_class_id_t **register_classes) AMD_DBGAPI_VERSION_0_24
Report the list of register classes supported by the architecture.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_register_is_in_register_class(amd_dbgapi_register_class_id_t register_class_id, amd_dbgapi_register_id_t register_id, amd_dbgapi_register_class_state_t *register_class_state) AMD_DBGAPI_VERSION_0_41
Determine if a register is a member of a register class.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_architecture_register_class_get_info(amd_dbgapi_register_class_id_t register_class_id, amd_dbgapi_register_class_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a register class of an architecture.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_wave_register_list(amd_dbgapi_wave_id_t wave_id, size_t *register_count, amd_dbgapi_register_id_t **registers) AMD_DBGAPI_VERSION_0_41
Report the list of registers supported by a wave.
amd_dbgapi_register_info_t
Register queries that are supported by amd_dbgapi_register_get_info.
Definition: amd-dbgapi.h:4286
amd_dbgapi_register_class_info_t
Register class queries that are supported by amd_dbgapi_architecture_register_class_get_info.
Definition: amd-dbgapi.h:4158
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_wave_register_exists(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id, amd_dbgapi_register_exists_t *exists) AMD_DBGAPI_VERSION_0_41
Query if a register exists for a wave.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_read_register(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_register_id_t register_id, amd_dbgapi_size_t offset, amd_dbgapi_size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Read a register.
amd_dbgapi_register_exists_t
Indication of if a wave has a register.
Definition: amd-dbgapi.h:4380
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_register_get_info(amd_dbgapi_register_id_t register_id, amd_dbgapi_register_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_46
Query information about a register.
amd_dbgapi_register_class_state_t
Indication of whether a register is a member of a register class.
Definition: amd-dbgapi.h:4567
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_architecture_register_list(amd_dbgapi_architecture_id_t architecture_id, size_t *register_count, amd_dbgapi_register_id_t **registers) AMD_DBGAPI_VERSION_0_24
Report the list of registers supported by the architecture.
@ AMD_DBGAPI_REGISTER_INFO_ARCHITECTURE
Return the architecture to which this register belongs.
Definition: amd-dbgapi.h:4291
@ AMD_DBGAPI_REGISTER_INFO_NAME
Return the register name.
Definition: amd-dbgapi.h:4298
@ AMD_DBGAPI_REGISTER_INFO_SIZE
Return the size of the register in bytes.
Definition: amd-dbgapi.h:4303
@ AMD_DBGAPI_REGISTER_INFO_DWARF
Return the AMD GPU DWARF register number for the register's architecture.
Definition: amd-dbgapi.h:4330
@ AMD_DBGAPI_REGISTER_INFO_TYPE
Return the register type as a C style type string.
Definition: amd-dbgapi.h:4325
@ AMD_DBGAPI_REGISTER_CLASS_INFO_ARCHITECTURE
Return the architecture to which this register class belongs.
Definition: amd-dbgapi.h:4163
@ AMD_DBGAPI_REGISTER_CLASS_INFO_NAME
Return the register class name.
Definition: amd-dbgapi.h:4170
@ AMD_DBGAPI_REGISTER_ABSENT
The wave does not have the register.
Definition: amd-dbgapi.h:4384
@ AMD_DBGAPI_REGISTER_PRESENT
The wave has the register.
Definition: amd-dbgapi.h:4388
@ AMD_DBGAPI_REGISTER_CLASS_STATE_NOT_MEMBER
The register is not a member of the register class.
Definition: amd-dbgapi.h:4571
@ AMD_DBGAPI_REGISTER_CLASS_STATE_MEMBER
The register is a member of the register class.
Definition: amd-dbgapi.h:4575
amd_dbgapi_status_t
AMD debugger API status codes.
Definition: amd-dbgapi.h:690
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_get_status_string(amd_dbgapi_status_t status, const char **status_string) AMD_DBGAPI_VERSION_0_24
Query a textual description of a status code.
@ AMD_DBGAPI_STATUS_ERROR_INVALID_REGISTER_CLASS_ID
The register class handle is invalid.
Definition: amd-dbgapi.h:839
@ AMD_DBGAPI_STATUS_ERROR_INVALID_LANE_ID
The lane handle is invalid.
Definition: amd-dbgapi.h:847
@ AMD_DBGAPI_STATUS_ERROR_INVALID_BREAKPOINT_ID
The breakpoint handle is invalid.
Definition: amd-dbgapi.h:875
@ AMD_DBGAPI_STATUS_ERROR_INVALID_CODE_OBJECT_ID
The code object handle is invalid.
Definition: amd-dbgapi.h:778
@ AMD_DBGAPI_STATUS_ERROR_NO_WATCHPOINT_AVAILABLE
No more watchpoints available.
Definition: amd-dbgapi.h:835
@ AMD_DBGAPI_STATUS_ERROR_INVALID_SHARED_LIBRARY_ID
The shared library handle is invalid.
Definition: amd-dbgapi.h:871
@ AMD_DBGAPI_STATUS_ERROR_INVALID_WAVE_ID
The wave handle is invalid.
Definition: amd-dbgapi.h:802
@ AMD_DBGAPI_STATUS_ERROR_MEMORY_ACCESS
An error occurred while trying to access memory in the inferior.
Definition: amd-dbgapi.h:859
@ AMD_DBGAPI_STATUS_ERROR_ILLEGAL_INSTRUCTION
The bytes being disassembled are not a legal instruction.
Definition: amd-dbgapi.h:774
@ AMD_DBGAPI_STATUS_SUCCESS
The function has executed successfully.
Definition: amd-dbgapi.h:694
@ AMD_DBGAPI_STATUS_ERROR_NOT_SUPPORTED
The operation is not supported.
Definition: amd-dbgapi.h:730
@ AMD_DBGAPI_STATUS_ERROR_DISPLACED_STEPPING_ACTIVE
The wave has an active displaced stepping buffer.
Definition: amd-dbgapi.h:904
@ AMD_DBGAPI_STATUS_ERROR_ALREADY_INITIALIZED
The library is already initialized.
Definition: amd-dbgapi.h:742
@ AMD_DBGAPI_STATUS_ERROR_WAVE_OUTSTANDING_STOP
The wave has an outstanding stop request.
Definition: amd-dbgapi.h:814
@ AMD_DBGAPI_STATUS_ERROR_INVALID_AGENT_ID
The agent handle is invalid.
Definition: amd-dbgapi.h:790
@ AMD_DBGAPI_STATUS_ERROR_NOT_INITIALIZED
The library is not initialized.
Definition: amd-dbgapi.h:746
@ AMD_DBGAPI_STATUS_ERROR_SYMBOL_NOT_FOUND
The symbol was not found.
Definition: amd-dbgapi.h:896
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ARGUMENT_COMPATIBILITY
An invalid combination of arguments was given to the function.
Definition: amd-dbgapi.h:738
@ AMD_DBGAPI_STATUS_ERROR_INVALID_WATCHPOINT_ID
The watchpoint handle is invalid.
Definition: amd-dbgapi.h:831
@ AMD_DBGAPI_STATUS_ERROR_RESUME_DISPLACED_STEPPING
The wave cannot be resumed in the manner requested due to displaced stepping restrictions.
Definition: amd-dbgapi.h:909
@ AMD_DBGAPI_STATUS_ERROR_PROCESS_EXITED
The native operating system process associated with a client process has exited.
Definition: amd-dbgapi.h:888
@ AMD_DBGAPI_STATUS_ERROR_INVALID_CLIENT_PROCESS_ID
The client process handle is invalid.
Definition: amd-dbgapi.h:883
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ARCHITECTURE_ID
The architecture handle is invalid.
Definition: amd-dbgapi.h:770
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ARGUMENT
An invalid argument was given to the function.
Definition: amd-dbgapi.h:734
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ADDRESS_CLASS_ID
The address class handle is invalid.
Definition: amd-dbgapi.h:851
@ AMD_DBGAPI_STATUS_ERROR_DISPLACED_STEPPING_BUFFER_UNAVAILABLE
No more displaced stepping buffers are available that are suitable for the requested wave.
Definition: amd-dbgapi.h:827
@ AMD_DBGAPI_STATUS_ERROR_INVALID_EVENT_ID
The event handle is invalid.
Definition: amd-dbgapi.h:867
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ADDRESS
The address is not within the shared library.
Definition: amd-dbgapi.h:900
@ AMD_DBGAPI_STATUS_ERROR_WAVE_NOT_STOPPED
The wave is not stopped.
Definition: amd-dbgapi.h:806
@ AMD_DBGAPI_STATUS_ERROR_WAVE_STOPPED
The wave is stopped.
Definition: amd-dbgapi.h:810
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ADDRESS_SPACE_ID
The address space handle is invalid.
Definition: amd-dbgapi.h:855
@ AMD_DBGAPI_STATUS_ERROR_INVALID_PROCESS_ID
The process handle is invalid.
Definition: amd-dbgapi.h:786
@ AMD_DBGAPI_STATUS_ERROR_WAVE_NOT_RESUMABLE
The wave cannot be resumed.
Definition: amd-dbgapi.h:818
@ AMD_DBGAPI_STATUS_ERROR_LIBRARY_NOT_LOADED
The shared library is not currently loaded.
Definition: amd-dbgapi.h:892
@ AMD_DBGAPI_STATUS_ERROR_RESTRICTION
There is a restriction error that prevents debugging the process.
Definition: amd-dbgapi.h:762
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ADDRESS_SPACE_CONVERSION
The segment address cannot be converted to the requested address space.
Definition: amd-dbgapi.h:863
@ AMD_DBGAPI_STATUS_ERROR_INVALID_ELF_AMDGPU_MACHINE
The ELF AMD GPU machine value is invalid or unsupported.
Definition: amd-dbgapi.h:782
@ AMD_DBGAPI_STATUS_FATAL
A fatal error has occurred.
Definition: amd-dbgapi.h:720
@ AMD_DBGAPI_STATUS_ERROR_INVALID_DISPLACED_STEPPING_ID
The displaced stepping handle is invalid.
Definition: amd-dbgapi.h:822
@ AMD_DBGAPI_STATUS_ERROR_CLIENT_CALLBACK
A callback to the client reported an error.
Definition: amd-dbgapi.h:879
@ AMD_DBGAPI_STATUS_ERROR_ALREADY_ATTACHED
The process is already attached to the given inferior process.
Definition: amd-dbgapi.h:766
@ AMD_DBGAPI_STATUS_ERROR_INVALID_QUEUE_ID
The queue handle is invalid.
Definition: amd-dbgapi.h:794
@ AMD_DBGAPI_STATUS_ERROR_INVALID_REGISTER_ID
The register handle is invalid.
Definition: amd-dbgapi.h:843
@ AMD_DBGAPI_STATUS_ERROR_INVALID_DISPATCH_ID
The dispatch handle is invalid.
Definition: amd-dbgapi.h:798
@ AMD_DBGAPI_STATUS_ERROR
A generic error has occurred.
Definition: amd-dbgapi.h:698
@ AMD_DBGAPI_STATUS_ERROR_UNIMPLEMENTED
The operation is not currently implemented.
Definition: amd-dbgapi.h:726
#define AMD_DBGAPI_VERSION_0_42
The function was introduced in version 0.42 of the interface and has the symbol version string of "AM...
Definition: amd-dbgapi.h:471
#define AMD_DBGAPI_VERSION_0_30
The function was introduced in version 0.30 of the interface and has the symbol version string of "AM...
Definition: amd-dbgapi.h:459
#define AMD_DBGAPI_VERSION_0_24
The function was introduced in version 0.24 of the interface and has the symbol version string of "AM...
Definition: amd-dbgapi.h:453
#define AMD_DBGAPI_VERSION_0_46
The function was introduced in version 0.46 of the interface and has the symbol version string of "AM...
Definition: amd-dbgapi.h:477
#define AMD_DBGAPI_VERSION_0_41
The function was introduced in version 0.41 of the interface and has the symbol version string of "AM...
Definition: amd-dbgapi.h:465
const char AMD_DBGAPI * amd_dbgapi_get_build_name(void) AMD_DBGAPI_VERSION_0_24
Query the installed library build name.
void AMD_DBGAPI amd_dbgapi_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch) AMD_DBGAPI_VERSION_0_24
Query the version of the installed library.
amd_dbgapi_watchpoint_info_t
Watchpoint queries that are supported by amd_dbgapi_watchpoint_get_info.
Definition: amd-dbgapi.h:3892
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_set_watchpoint(amd_dbgapi_process_id_t process_id, amd_dbgapi_global_address_t address, amd_dbgapi_size_t size, amd_dbgapi_watchpoint_kind_t kind, amd_dbgapi_watchpoint_id_t *watchpoint_id, amd_dbgapi_global_address_t *watchpoint_address, amd_dbgapi_size_t *watchpoint_size) AMD_DBGAPI_VERSION_0_41
Set a hardware data watchpoint.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_watchpoint_get_info(amd_dbgapi_watchpoint_id_t watchpoint_id, amd_dbgapi_watchpoint_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a watchpoint.
amd_dbgapi_watchpoint_kind_t
Watchpoint memory access kinds.
Definition: amd-dbgapi.h:3976
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_remove_watchpoint(amd_dbgapi_process_id_t process_id, amd_dbgapi_watchpoint_id_t watchpoint_id) AMD_DBGAPI_VERSION_0_24
Remove a hardware data watchpoint previously set by amd_dbgapi_set_watchpoint.
amd_dbgapi_watchpoint_share_kind_t
The way watchpoints are shared between processes.
Definition: amd-dbgapi.h:3950
@ AMD_DBGAPI_WATCHPOINT_INFO_PROCESS
Return the process to which this watchpoint belongs.
Definition: amd-dbgapi.h:3897
@ AMD_DBGAPI_WATCHPOINT_KIND_STORE_AND_RMW
Write access by store instructions or read-modify-write access by atomic instructions.
Definition: amd-dbgapi.h:3985
@ AMD_DBGAPI_WATCHPOINT_KIND_ALL
Read, write, or read-modify-write access by load, store, or atomic instructions.
Definition: amd-dbgapi.h:3994
@ AMD_DBGAPI_WATCHPOINT_KIND_LOAD
Read access by load instructions.
Definition: amd-dbgapi.h:3980
@ AMD_DBGAPI_WATCHPOINT_KIND_RMW
Read-modify-write access by atomic instructions.
Definition: amd-dbgapi.h:3989
@ AMD_DBGAPI_WATCHPOINT_SHARE_KIND_UNSHARED
The watchpoints are not shared across processes.
Definition: amd-dbgapi.h:3960
@ AMD_DBGAPI_WATCHPOINT_SHARE_KIND_SHARED
The watchpoints of a process are shared between all processes.
Definition: amd-dbgapi.h:3966
@ AMD_DBGAPI_WATCHPOINT_SHARE_KIND_UNSUPPORTED
Watchpoints are not supported.
Definition: amd-dbgapi.h:3954
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_wave_stop(amd_dbgapi_wave_id_t wave_id) AMD_DBGAPI_VERSION_0_41
Request a wave to stop executing.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_process_wave_list(amd_dbgapi_process_id_t process_id, size_t *wave_count, amd_dbgapi_wave_id_t **waves, amd_dbgapi_changed_t *changed) AMD_DBGAPI_VERSION_0_41
Return the list of existing waves.
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_wave_resume(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_resume_mode_t resume_mode) AMD_DBGAPI_VERSION_0_46
Resume execution of a stopped wave.
amd_dbgapi_wave_state_t
The execution state of a wave.
Definition: amd-dbgapi.h:3054
amd_dbgapi_resume_mode_t
The mode in which to resuming the execution of a wave.
Definition: amd-dbgapi.h:3409
amd_dbgapi_status_t AMD_DBGAPI amd_dbgapi_wave_get_info(amd_dbgapi_wave_id_t wave_id, amd_dbgapi_wave_info_t query, size_t value_size, void *value) AMD_DBGAPI_VERSION_0_41
Query information about a wave.
amd_dbgapi_wave_info_t
Wave queries that are supported by amd_dbgapi_wave_get_info.
Definition: amd-dbgapi.h:2911
amd_dbgapi_wave_stop_reason_t
A bit mask of the reasons that a wave stopped.
Definition: amd-dbgapi.h:3086
@ AMD_DBGAPI_WAVE_STATE_STOP
The wave is stopped.
Definition: amd-dbgapi.h:3076
@ AMD_DBGAPI_WAVE_STATE_SINGLE_STEP
The wave is running in single-step mode.
Definition: amd-dbgapi.h:3063
@ AMD_DBGAPI_WAVE_STATE_RUN
The wave is running.
Definition: amd-dbgapi.h:3058
@ AMD_DBGAPI_RESUME_MODE_SINGLE_STEP
Resume execution in in single step mode.
Definition: amd-dbgapi.h:3417
@ AMD_DBGAPI_RESUME_MODE_NORMAL
Resume normal execution.
Definition: amd-dbgapi.h:3413
@ AMD_DBGAPI_WAVE_INFO_ARCHITECTURE
Return the architecture of this wave.
Definition: amd-dbgapi.h:2969
@ AMD_DBGAPI_WAVE_INFO_DISPATCH
Return the dispatch to which this wave belongs.
Definition: amd-dbgapi.h:2947
@ AMD_DBGAPI_WAVE_INFO_QUEUE
Return the queue to which this wave belongs.
Definition: amd-dbgapi.h:2953
@ AMD_DBGAPI_WAVE_INFO_WAVE_NUMBER_IN_WORK_GROUP
The wave's number in the workgroup.
Definition: amd-dbgapi.h:2996
@ AMD_DBGAPI_WAVE_INFO_WORK_GROUP_COORD
The wave workgroup coordinate in the dispatch grid dimensions.
Definition: amd-dbgapi.h:2989
@ AMD_DBGAPI_WAVE_INFO_EXEC_MASK
Return the current execution mask of the wave.
Definition: amd-dbgapi.h:2983
@ AMD_DBGAPI_WAVE_INFO_STATE
Return the wave's state.
Definition: amd-dbgapi.h:2916
@ AMD_DBGAPI_WAVE_INFO_PROCESS
Return the process to which this wave belongs.
Definition: amd-dbgapi.h:2964
@ AMD_DBGAPI_WAVE_INFO_AGENT
Return the agent to which this wave belongs.
Definition: amd-dbgapi.h:2959
@ AMD_DBGAPI_WAVE_INFO_WATCHPOINTS
Return the watchpoint(s) the wave triggered.
Definition: amd-dbgapi.h:2936
@ AMD_DBGAPI_WAVE_INFO_LANE_COUNT
The number of lanes supported by the wave.
Definition: amd-dbgapi.h:3001
@ AMD_DBGAPI_WAVE_INFO_PC
Return the current program counter value of the wave.
Definition: amd-dbgapi.h:2975
@ AMD_DBGAPI_WAVE_INFO_STOP_REASON
Return the reason the wave stopped as a bit set.
Definition: amd-dbgapi.h:2923
@ AMD_DBGAPI_WAVE_STOP_REASON_FP_DIVIDE_BY_0
The wave stopped due to triggering an enabled floating point divide by zero exception.
Definition: amd-dbgapi.h:3135
@ AMD_DBGAPI_WAVE_STOP_REASON_WATCHPOINT
The wave stopped due to triggering a data watchpoint.
Definition: amd-dbgapi.h:3109
@ AMD_DBGAPI_WAVE_STOP_REASON_MEMORY_VIOLATION
The wave stopped due to triggering a memory violation.
Definition: amd-dbgapi.h:3220
@ AMD_DBGAPI_WAVE_STOP_REASON_SINGLE_STEP
The wave stopped due to completing an instruction single-step.
Definition: amd-dbgapi.h:3113
@ AMD_DBGAPI_WAVE_STOP_REASON_ILLEGAL_INSTRUCTION
The wave stopped due to executing an illegal instruction.
Definition: amd-dbgapi.h:3230
@ AMD_DBGAPI_WAVE_STOP_REASON_DEBUG_TRAP
The wave stopped due to executing a debug trap instruction.
Definition: amd-dbgapi.h:3175
@ AMD_DBGAPI_WAVE_STOP_REASON_FP_INPUT_DENORMAL
The wave stopped due to triggering an enabled floating point input denormal exception.
Definition: amd-dbgapi.h:3130
@ AMD_DBGAPI_WAVE_STOP_REASON_ECC_ERROR
The wave stopped due to detecting an unrecoverable ECC error.
Definition: amd-dbgapi.h:3245
@ AMD_DBGAPI_WAVE_STOP_REASON_FATAL_HALT
The wave stopped after causing a hardware fatal halt.
Definition: amd-dbgapi.h:3254
@ AMD_DBGAPI_WAVE_STOP_REASON_ASSERT_TRAP
The wave stopped due to executing an assert trap instruction.
Definition: amd-dbgapi.h:3193
@ AMD_DBGAPI_WAVE_STOP_REASON_NONE
If none of the bits are set, then amd_dbgapi_wave_stop stopped the wave.
Definition: amd-dbgapi.h:3091
@ AMD_DBGAPI_WAVE_STOP_REASON_BREAKPOINT
The wave stopped due to executing a breakpoint instruction.
Definition: amd-dbgapi.h:3097
@ AMD_DBGAPI_WAVE_STOP_REASON_XNACK_ERROR
The wave stopped with an XNACK error.
Definition: amd-dbgapi.h:3263
@ AMD_DBGAPI_WAVE_STOP_REASON_FP_INVALID_OPERATION
The wave stopped due to triggering an enabled floating point invalid operation exception.
Definition: amd-dbgapi.h:3155
@ AMD_DBGAPI_WAVE_STOP_REASON_RESERVED
A reserved value only present to ensure that the underlying representation of this enumeration type i...
Definition: amd-dbgapi.h:3268
@ AMD_DBGAPI_WAVE_STOP_REASON_QUEUE_ERROR
The wave belongs to a queue that is in the error state.
Definition: amd-dbgapi.h:3125
@ AMD_DBGAPI_WAVE_STOP_REASON_TRAP
The wave stopped due to executing an trap instruction other than the AMD_DBGAPI_WAVE_STOP_REASON_DEBU...
Definition: amd-dbgapi.h:3205
@ AMD_DBGAPI_WAVE_STOP_REASON_INT_DIVIDE_BY_0
The wave stopped due to triggering an enabled integer divide by zero exception.
Definition: amd-dbgapi.h:3160
@ AMD_DBGAPI_WAVE_STOP_REASON_FP_UNDERFLOW
The wave stopped due to triggering an enabled floating point underflow exception.
Definition: amd-dbgapi.h:3145
@ AMD_DBGAPI_WAVE_STOP_REASON_FP_INEXACT
The wave stopped due to triggering an enabled floating point inexact exception.
Definition: amd-dbgapi.h:3150
@ AMD_DBGAPI_WAVE_STOP_REASON_FP_OVERFLOW
The wave stopped due to triggering an enabled floating point overflow exception.
Definition: amd-dbgapi.h:3140
Opaque source language address class handle.
Definition: amd-dbgapi.h:4870
uint64_t handle
Definition: amd-dbgapi.h:4871
Opaque address space handle.
Definition: amd-dbgapi.h:5059
uint64_t handle
Definition: amd-dbgapi.h:5060
Opaque agent handle.
Definition: amd-dbgapi.h:2155
uint64_t handle
Definition: amd-dbgapi.h:2156
Opaque architecture handle.
Definition: amd-dbgapi.h:1086
uint64_t handle
Definition: amd-dbgapi.h:1087
Opaque breakpoint handle.
Definition: amd-dbgapi.h:6334
uint64_t handle
Definition: amd-dbgapi.h:6335
Callbacks that the client of the library must provide.
Definition: amd-dbgapi.h:6481
amd_dbgapi_status_t(* get_os_pid)(amd_dbgapi_client_process_id_t client_process_id, amd_dbgapi_os_process_id_t *os_pid)
Return the native operating system process handle for the process identified by the client process ha...
Definition: amd-dbgapi.h:6541
amd_dbgapi_status_t(* remove_breakpoint)(amd_dbgapi_client_process_id_t client_process_id, amd_dbgapi_breakpoint_id_t breakpoint_id)
Remove a breakpoint previously inserted by amd_dbgapi_callbacks_s::insert_breakpoint.
Definition: amd-dbgapi.h:6730
amd_dbgapi_status_t(* get_symbol_address)(amd_dbgapi_client_process_id_t client_process_id, amd_dbgapi_shared_library_id_t shared_library_id, const char *symbol_name, amd_dbgapi_global_address_t *address)
Return the address of a symbol in a shared library.
Definition: amd-dbgapi.h:6642
void(* deallocate_memory)(void *data)
Deallocate memory that was allocated by amd_dbgapi_callbacks_s::allocate_memory.
Definition: amd-dbgapi.h:6512
amd_dbgapi_status_t(* enable_notify_shared_library)(amd_dbgapi_client_process_id_t client_process_id, const char *shared_library_name, amd_dbgapi_shared_library_id_t shared_library_id, amd_dbgapi_shared_library_state_t *shared_library_state)
Request to be notified when a shared library is loaded and unloaded.
Definition: amd-dbgapi.h:6579
amd_dbgapi_status_t(* disable_notify_shared_library)(amd_dbgapi_client_process_id_t client_process_id, amd_dbgapi_shared_library_id_t shared_library_id)
Request to stop being notified for a shared library previously set by amd_dbgapi_callbacks_s::enable_...
Definition: amd-dbgapi.h:6607
void(* log_message)(amd_dbgapi_log_level_t level, const char *message)
Report a log message.
Definition: amd-dbgapi.h:6742
amd_dbgapi_status_t(* insert_breakpoint)(amd_dbgapi_client_process_id_t client_process_id, amd_dbgapi_shared_library_id_t shared_library_id, amd_dbgapi_global_address_t address, amd_dbgapi_breakpoint_id_t breakpoint_id)
Insert a breakpoint in a shared library using a global address.
Definition: amd-dbgapi.h:6694
Opaque code object handle.
Definition: amd-dbgapi.h:1962
uint64_t handle
Definition: amd-dbgapi.h:1963
Instruction information for direct call instructions.
Definition: amd-dbgapi.h:4805
amd_dbgapi_global_address_t target_address
Definition: amd-dbgapi.h:4806
Opaque dispatch handle.
Definition: amd-dbgapi.h:2634
uint64_t handle
Definition: amd-dbgapi.h:2635
Opaque displaced stepping handle.
Definition: amd-dbgapi.h:3631
uint64_t handle
Definition: amd-dbgapi.h:3632
Opaque event handle.
Definition: amd-dbgapi.h:5816
uint64_t handle
Definition: amd-dbgapi.h:5817
Opaque process handle.
Definition: amd-dbgapi.h:1584
uint64_t handle
Definition: amd-dbgapi.h:1585
Opaque queue handle.
Definition: amd-dbgapi.h:2333
uint64_t handle
Definition: amd-dbgapi.h:2334
Opaque register class handle.
Definition: amd-dbgapi.h:4141
uint64_t handle
Definition: amd-dbgapi.h:4142
Opaque register handle.
Definition: amd-dbgapi.h:4270
uint64_t handle
Definition: amd-dbgapi.h:4271
Opaque shared library handle.
Definition: amd-dbgapi.h:6196
uint64_t handle
Definition: amd-dbgapi.h:6197
Opaque hardware data watchpoint handle.
Definition: amd-dbgapi.h:3876
uint64_t handle
Definition: amd-dbgapi.h:3877
A set of watchpoints.
Definition: amd-dbgapi.h:4004
amd_dbgapi_watchpoint_id_t * watchpoint_ids
Definition: amd-dbgapi.h:4006
size_t count
Definition: amd-dbgapi.h:4005
Opaque wave handle.
Definition: amd-dbgapi.h:2895
uint64_t handle
Definition: amd-dbgapi.h:2896