doca_pcc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_PCC_H_
#define DOCA_PCC_H_
 
#include <stdbool.h>
#include <doca_compat.h>
#include <doca_error.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct doca_devinfo;
struct doca_dev;
struct doca_pcc;
 
struct doca_pcc_app;
 
/* Single trace message struct */
struct doca_pcc_bin_report;
 
DOCA_STABLE
doca_error_t doca_devinfo_get_is_pcc_supported(const struct doca_devinfo *devinfo);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_np_cap_is_supported(const struct doca_devinfo *devinfo);
 
DOCA_STABLE
doca_error_t doca_pcc_create(struct doca_dev *doca_dev, struct doca_pcc **pcc);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_np_create(struct doca_dev *doca_dev, struct doca_pcc **pcc);
 
DOCA_STABLE
doca_error_t doca_pcc_destroy(struct doca_pcc *pcc);
 
DOCA_STABLE
doca_error_t doca_pcc_start(struct doca_pcc *pcc);
 
DOCA_STABLE
doca_error_t doca_pcc_stop(struct doca_pcc *pcc);
 
DOCA_STABLE
doca_error_t doca_pcc_get_min_num_threads(struct doca_pcc *pcc, uint32_t *min_num_threads);
 
DOCA_STABLE
doca_error_t doca_pcc_get_max_num_threads(struct doca_pcc *pcc, uint32_t *max_num_threads);
 
DOCA_STABLE
doca_error_t doca_pcc_set_app(struct doca_pcc *pcc, struct doca_pcc_app *app);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_cap_get_num_probe_format_slots(struct doca_pcc *pcc, uint32_t *num_probe_format_slots);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_set_ccmad_probe_packet_format(struct doca_pcc *pcc, uint32_t probe_format_slot);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_set_ifa1_probe_packet_format(struct doca_pcc *pcc, uint32_t probe_format_slot);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_set_ifa2_probe_packet_format(struct doca_pcc *pcc, uint32_t probe_format_slot);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_rp_set_ccmad_remote_sw_handler(struct doca_pcc *pcc, uint32_t probe_format_slot, bool sw_handler);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_cap_is_ccmad_custom_header_supported(const struct doca_devinfo *devinfo);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_rp_set_ccmad_custom_header_size(struct doca_pcc *pcc,
                              uint32_t probe_format_slot,
                              uint8_t header_size);
 
typedef enum {
    DOCA_PCC_CCMAD_CUSTOM_HEADER_LOCATION_MAD_PAYLOAD = 1, 
} doca_pcc_ccmad_custom_header_loc_t;
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_rp_set_ccmad_custom_header_location(struct doca_pcc *pcc,
                              uint32_t probe_format_slot,
                              doca_pcc_ccmad_custom_header_loc_t header_loc);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_set_ifa1_probe_marker(struct doca_pcc *pcc, uint32_t probe_format_slot, uint64_t probe_marker);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_rp_set_ifa2_gns(struct doca_pcc *pcc, uint32_t probe_format_slot, uint8_t gns);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_np_set_ifa2_gns_ignore(struct doca_pcc *pcc,
                         uint32_t probe_format_slot,
                         uint8_t ignore_mask,
                         uint8_t ignore_value);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_rp_set_ifa2_hop_limit(struct doca_pcc *pcc, uint32_t probe_format_slot, uint8_t hop_limit);
 
DOCA_STABLE
doca_error_t doca_pcc_set_thread_affinity(struct doca_pcc *pcc, uint32_t num_threads, uint32_t *affinity_configs);
 
DOCA_STABLE
doca_error_t doca_pcc_set_trace_message(struct doca_pcc *pcc, char **trace_message);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_activate_tracer(struct doca_pcc *pcc);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_deactivate_tracer(struct doca_pcc *pcc);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_trace_buf_set(struct doca_pcc *pcc, void *buf_addr, uint32_t buf_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_trace_buf_get(struct doca_pcc *pcc, void **buf_addr, uint32_t *buf_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_trace_file_set(struct doca_pcc *pcc, const char *file_path);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_trace_file_get(struct doca_pcc *pcc, char **file_path, uint32_t *file_path_len);
 
typedef int (*doca_pcc_trace_callback_t)(void *ctx, struct doca_pcc_bin_report *reps, int reps_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_register_trace_handler(struct doca_pcc *pcc,
                         doca_pcc_trace_callback_t trace_callback,
                         void *user_ctx);
 
DOCA_STABLE
doca_error_t doca_pcc_set_print_buffer_size(struct doca_pcc *pcc, size_t buffer_size);
 
DOCA_STABLE
doca_error_t doca_pcc_set_dev_coredump_file(struct doca_pcc *pcc, const char *file_name);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_set_mailbox(struct doca_pcc *pcc, uint32_t max_request_size, uint32_t max_response_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_mailbox_get_request_buffer(struct doca_pcc *pcc, void **request_buffer);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_mailbox_get_response_buffer(struct doca_pcc *pcc, void **response_buffer);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_mailbox_send(struct doca_pcc *pcc,
                   uint32_t request_size,
                   uint32_t *response_size,
                   uint32_t *cb_ret_val);
 
DOCA_STABLE
doca_error_t doca_pcc_wait(struct doca_pcc *pcc, int wait_time);
 
typedef enum {
    DOCA_PCC_PS_ACTIVE = 0,      
    DOCA_PCC_PS_STANDBY = 1,     
    DOCA_PCC_PS_DEACTIVATED = 2, 
    DOCA_PCC_PS_ERROR = 3,       
} doca_pcc_process_state_t;
 
DOCA_STABLE
doca_error_t doca_pcc_get_process_state(const struct doca_pcc *pcc, doca_pcc_process_state_t *process_state);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_dump_debug(const struct doca_pcc *pcc);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pcc_enable_debug(const struct doca_pcc *pcc, bool enable);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_PCC_H_ */