Global Namespace

Overview

// typedefs

typedef int32_t xpum_device_id_t;
typedef uint32_t xpum_group_id_t;
typedef int32_t xpum_event_id_t;
typedef int32_t xpum_dump_task_id_t;
typedef int32_t xpum_device_tile_id_t;
typedef int32_t xpum_sampling_interval_t;
typedef enum xpum_result_enum xpum_result_t;
typedef enum xpum_device_type_enum xpum_device_type_t;
typedef enum xpum_device_function_type_enum xpum_device_function_type_t;
typedef enum xpum_version_enum xpum_version_t;
typedef struct xpum_version_info xpum_version_info;
typedef struct xpum_device_basic_info xpum_device_basic_info;
typedef enum xpum_device_property_name_enum xpum_device_property_name_t;
typedef struct xpum_device_property_t xpum_device_property_t;
typedef struct xpum_device_properties_t xpum_device_properties_t;
typedef struct xpum_amc_fw_version_t xpum_amc_fw_version_t;
typedef struct xpum_group_info_t xpum_group_info_t;
typedef enum xpum_health_config_type_enum xpum_health_config_type_t;
typedef enum xpum_health_type_enum xpum_health_type_t;
typedef enum xpum_health_status_enum xpum_health_status_t;
typedef enum xpum_device_mode_enum xpum_device_mode_t;
typedef enum xpum_device_config_type_enum xpum_device_config_type_t;
typedef enum xpum_diag_result_type_enum xpum_diag_result_t;
typedef enum xpum_firmware_type_enum xpum_firmware_type_t;
typedef enum xpum_firmware_flash_result_enum xpum_firmware_flash_result_t;
typedef struct xpum_firmware_flash_job xpum_firmware_flash_job;
typedef struct xpum_firmware_flash_task_result_t xpum_firmware_flash_task_result_t;
typedef enum xpum_diag_task_type_enum xpum_diag_task_type_t;
typedef enum xpum_diag_task_result_enum xpum_diag_task_result_t;
typedef enum xpum_diag_level_enum xpum_diag_level_t;
typedef enum xpum_media_format_enum xpum_media_format_t;
typedef enum xpum_media_resolution_enum xpum_media_resolution_t;
typedef enum xpum_agent_config_enum xpum_agent_config_t;
typedef enum xpum_stats_type_enum xpum_stats_type_t;
typedef struct xpum_device_stats_data_t xpum_device_stats_data_t;
typedef struct xpum_device_stats_t xpum_device_stats_t;
typedef enum xpum_engine_type_enum xpum_engine_type_t;
typedef struct xpum_device_engine_stats_t xpum_device_engine_stats_t;
typedef struct xpum_device_engine_metric_t xpum_device_engine_metric_t;
typedef enum xpum_fabric_throughput_type_enum xpum_fabric_throughput_type_t;
typedef struct xpum_device_fabric_throughput_stats_t xpum_device_fabric_throughput_stats_t;
typedef struct xpum_device_fabric_throughput_metric_t xpum_device_fabric_throughput_metric_t;
typedef struct xpum_metrics_raw_data_t xpum_metrics_raw_data_t;
typedef struct xpum_device_metric_data_t xpum_device_metric_data_t;
typedef struct xpum_device_metrics_t xpum_device_metrics_t;
typedef xpum_stats_type_t xpum_realtime_metric_type_t;
typedef struct xpum_device_realtime_metric_t xpum_device_realtime_metric_t;
typedef struct xpum_device_realtime_metrics_t xpum_device_realtime_metrics_t;
typedef struct xpum_vf_metric_t xpum_vf_metric_t;
typedef struct xpum_device_component_ratio_t xpum_device_component_ratio_t;
typedef struct xpum_device_components_ratio_t xpum_device_components_ratio_t;
typedef struct xpum_topology_t xpum_topology_t;
typedef enum xpum_link_type_enum xpum_xelink_type_t;
typedef enum xpum_ras_type_enum xpum_ras_type_t;
typedef enum xpum_policy_type_enum xpum_policy_type_t;
typedef enum xpum_policy_conditon_type_enum xpum_policy_conditon_type_t;
typedef enum xpum_policy_action_type_enum xpum_policy_action_type_t;
typedef void (*xpum_notify_callback_ptr_t)(xpum_policy_notify_callback_para_t *);
typedef enum xpum_dump_type_enum xpum_dump_type_t;
typedef struct xpum_dump_raw_data_task_t xpum_dump_raw_data_task_t;

// enums

enum xpum_agent_config_enum;
enum xpum_device_config_type_enum;
enum xpum_device_function_type_enum;
enum xpum_device_mode_enum;
enum xpum_device_property_name_enum;
enum xpum_device_type_enum;
enum xpum_diag_level_enum;
enum xpum_diag_result_type_enum;
enum xpum_diag_task_result_enum;
enum xpum_diag_task_type_enum;
enum xpum_dump_type_enum;
enum xpum_ecc_action_t;
enum xpum_ecc_state_t;
enum xpum_engine_type_enum;
enum xpum_engine_type_flags_t;
enum xpum_fabric_throughput_type_enum;
enum xpum_firmware_flash_result_enum;
enum xpum_firmware_type_enum;
enum xpum_frequency_type_t;
enum xpum_health_config_type_enum;
enum xpum_health_status_enum;
enum xpum_health_type_enum;
enum xpum_link_type_enum;
enum xpum_media_format_enum;
enum xpum_media_resolution_enum;
enum xpum_policy_action_type_enum;
enum xpum_policy_conditon_type_enum;
enum xpum_policy_type_enum;
enum xpum_precheck_component_status_t;
enum xpum_precheck_component_type_t;
enum xpum_precheck_error_category_t;
enum xpum_precheck_error_severity_t;
enum xpum_precheck_error_type_t;
enum xpum_ras_type_enum;
enum xpum_result_enum;
enum xpum_scheduler_mode_t;
enum xpum_standby_mode_t;
enum xpum_standby_type_t;
enum xpum_stats_type_enum;
enum xpum_version_enum;

// structs

struct parent_switch;
struct xpum_amc_fw_version_t;
struct xpum_device_basic_info;
struct xpum_device_component_ratio_t;
struct xpum_device_components_ratio_t;
struct xpum_device_engine_metric_t;
struct xpum_device_engine_stats_t;
struct xpum_device_fabric_throughput_metric_t;
struct xpum_device_fabric_throughput_stats_t;
struct xpum_device_metric_data_t;
struct xpum_device_metrics_t;
struct xpum_device_performancefactor_t;
struct xpum_device_process_t;
struct xpum_device_properties_t;
struct xpum_device_property_t;
struct xpum_device_realtime_metric_t;
struct xpum_device_realtime_metrics_t;
struct xpum_device_stats_data_t;
struct xpum_device_stats_t;
struct xpum_device_util_by_process_t;
struct xpum_diag_component_info_t;
struct xpum_diag_media_codec_metrics_t;
struct xpum_diag_task_info_t;
struct xpum_diag_xe_link_throughput_t;
struct xpum_dump_raw_data_option_t;
struct xpum_dump_raw_data_task_t;
struct xpum_fabric_port_config_t;
struct xpum_firmware_flash_job;
struct xpum_firmware_flash_task_result_t;
struct xpum_frequency_range_t;
struct xpum_group_info_t;
struct xpum_health_data_t;
struct xpum_metrics_raw_data_t;
struct xpum_policy_action_t;
struct xpum_policy_condition_t;
struct xpum_policy_notify_callback_para_t;
struct xpum_policy_t;
struct xpum_power_burst_limit_t;
struct xpum_power_limits_t;
struct xpum_power_peak_limit_t;
struct xpum_power_prop_data_t;
struct xpum_power_sustained_limit_t;
struct xpum_precheck_component_info_t;
struct xpum_precheck_error_t;
struct xpum_precheck_options;
struct xpum_scheduler_data_t;
struct xpum_scheduler_debug_t;
struct xpum_scheduler_exclusive_t;
struct xpum_scheduler_timeout_t;
struct xpum_scheduler_timeslice_t;
struct xpum_sensor_reading_t;
struct xpum_standby_data_t;
struct xpum_topology_t;
struct xpum_version_info;
struct xpum_vf_metric_t;
struct xpum_vgpu_config_t;
struct xpum_vgpu_function_info_t;
struct xpum_vgpu_precheck_result_t;
struct xpum_xelink_topo_info;
struct xpum_xelink_unit;

// global functions

XPUM_API xpum_result_t xpumInit(void);
XPUM_API xpum_result_t xpumShutdown(void);

XPUM_API xpum_result_t xpumVersionInfo(
    xpum_version_info versionInfoList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetDeviceList(
    xpum_device_basic_info deviceList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetDeviceProperties(
    xpum_device_id_t deviceId,
    xpum_device_properties_t* pXpumProperties
    );

XPUM_API const char* getXpumDevicePropertyNameString(xpum_device_property_name_t name);

XPUM_API xpum_result_t xpumGetDeviceIdByBDF(
    const char* bdf,
    xpum_device_id_t* deviceId
    );

XPUM_API xpum_result_t xpumGetAMCFirmwareVersions(
    xpum_amc_fw_version_t versionList[],
    int* count,
    const char* username,
    const char* password
    );

XPUM_API xpum_result_t xpumGetAMCFirmwareVersionsErrorMsg(
    char* buffer,
    int* count
    );

XPUM_API xpum_result_t xpumGetSerialNumberAndAmcFwVersion(
    xpum_device_id_t deviceId,
    const char* username,
    const char* password,
    char serialNumber[XPUM_MAX_STR_LENGTH],
    char amcFwVersion[XPUM_MAX_STR_LENGTH]
    );

XPUM_API xpum_result_t xpumGroupCreate(
    const char* groupName,
    xpum_group_id_t* pGroupId
    );

XPUM_API xpum_result_t xpumGroupDestroy(xpum_group_id_t groupId);

XPUM_API xpum_result_t xpumGroupAddDevice(
    xpum_group_id_t groupId,
    xpum_device_id_t deviceId
    );

XPUM_API xpum_result_t xpumGroupRemoveDevice(
    xpum_group_id_t groupId,
    xpum_device_id_t deviceId
    );

XPUM_API xpum_result_t xpumGroupGetInfo(
    xpum_group_id_t groupId,
    xpum_group_info_t* pGroupInfo
    );

XPUM_API xpum_result_t xpumGetAllGroupIds(
    xpum_group_id_t groupIds[],
    int* count
    );

XPUM_API xpum_result_t xpumSetHealthConfig(
    xpum_device_id_t deviceId,
    xpum_health_config_type_t key,
    void* value
    );

XPUM_API xpum_result_t xpumSetHealthConfigByGroup(
    xpum_group_id_t groupId,
    xpum_health_config_type_t key,
    void* value
    );

XPUM_API xpum_result_t xpumGetHealthConfig(
    xpum_device_id_t deviceId,
    xpum_health_config_type_t key,
    void* value
    );

XPUM_API xpum_result_t xpumGetHealthConfigByGroup(
    xpum_group_id_t groupId,
    xpum_health_config_type_t key,
    xpum_device_id_t deviceIdList[],
    void* valueList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetHealth(
    xpum_device_id_t deviceId,
    xpum_health_type_t type,
    xpum_health_data_t* data
    );

XPUM_API xpum_result_t xpumGetHealthByGroup(
    xpum_group_id_t groupId,
    xpum_health_type_t type,
    xpum_health_data_t dataList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetDeviceStandbys(
    xpum_device_id_t deviceId,
    xpum_standby_data_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumSetDeviceStandby(
    xpum_device_id_t deviceId,
    const xpum_standby_data_t standby
    );

XPUM_API xpum_result_t xpumGetDevicePowerLimits(
    xpum_device_id_t deviceId,
    int32_t tileId,
    xpum_power_limits_t* pPowerLimits
    );

XPUM_API xpum_result_t xpumSetDevicePowerSustainedLimits(
    xpum_device_id_t deviceId,
    int32_t tileId,
    const xpum_power_sustained_limit_t sustained_limit
    );

XPUM_API xpum_result_t xpumGetDeviceFrequencyRanges(
    xpum_device_id_t deviceId,
    xpum_frequency_range_t* dataArray,
    uint32_t* count
    );

XPUM_API xpum_result_t xpumSetDeviceFrequencyRange(
    xpum_device_id_t deviceId,
    const xpum_frequency_range_t frequency
    );

XPUM_API xpum_result_t xpumGetDeviceSchedulers(
    xpum_device_id_t deviceId,
    xpum_scheduler_data_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumSetDeviceSchedulerTimeoutMode(
    xpum_device_id_t deviceId,
    const xpum_scheduler_timeout_t sched_timeout
    );

XPUM_API xpum_result_t xpumGetDevicePowerProps(
    xpum_device_id_t deviceId,
    xpum_power_prop_data_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumSetDeviceSchedulerTimesliceMode(
    xpum_device_id_t deviceId,
    const xpum_scheduler_timeslice_t sched_timeslice
    );

XPUM_API xpum_result_t xpumSetDeviceSchedulerExclusiveMode(
    xpum_device_id_t deviceId,
    const xpum_scheduler_exclusive_t sched_exclusive
    );

XPUM_API xpum_result_t xpumSetDeviceSchedulerDebugMode(
    xpum_device_id_t deviceId,
    const xpum_scheduler_debug_t sched_debug
    );

XPUM_API xpum_result_t xpumGetFreqAvailableClocks(
    xpum_device_id_t deviceId,
    uint32_t tileId,
    double dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetDeviceProcessState(
    xpum_device_id_t deviceId,
    xpum_device_process_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumApplyPPR(
    xpum_device_id_t deviceId,
    xpum_diag_result_t* diagResult,
    xpum_health_status_t* healthState
    );

XPUM_API xpum_result_t xpumResetDevice(xpum_device_id_t deviceId, bool force);

XPUM_API xpum_result_t xpumGetDeviceComponentOccupancyRatio(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    xpum_sampling_interval_t samplingInterval,
    xpum_device_components_ratio_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetDeviceUtilizationByProcess(
    xpum_device_id_t deviceId,
    uint32_t utilInterval,
    xpum_device_util_by_process_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetAllDeviceUtilizationByProcess(
    uint32_t utilInterval,
    xpum_device_util_by_process_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetPerformanceFactor(
    xpum_device_id_t deviceId,
    xpum_device_performancefactor_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumSetPerformanceFactor(
    xpum_device_id_t deviceId,
    xpum_device_performancefactor_t performanceFactor
    );

XPUM_API xpum_result_t xpumGetFabricPortConfig(
    xpum_device_id_t deviceId,
    xpum_fabric_port_config_t dataArray[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumSetFabricPortConfig(
    xpum_device_id_t deviceId,
    xpum_fabric_port_config_t fabricPortConfig
    );

XPUM_API xpum_result_t xpumGetEccState(
    xpum_device_id_t deviceId,
    bool* available,
    bool* configurable,
    xpum_ecc_state_t* current,
    xpum_ecc_state_t* pending,
    xpum_ecc_action_t* action
    );

XPUM_API xpum_result_t xpumSetEccState(
    xpum_device_id_t deviceId,
    xpum_ecc_state_t newState,
    bool* available,
    bool* configurable,
    xpum_ecc_state_t* current,
    xpum_ecc_state_t* pending,
    xpum_ecc_action_t* action
    );

XPUM_API xpum_result_t xpumRunFirmwareFlash(
    xpum_device_id_t deviceId,
    xpum_firmware_flash_job* job,
    const char* username,
    const char* password
    );

XPUM_API xpum_result_t xpumRunFirmwareFlashEx(
    xpum_device_id_t deviceId,
    xpum_firmware_flash_job* job,
    const char* username,
    const char* password,
    bool force
    );

XPUM_API xpum_result_t xpumGetFirmwareFlashResult(
    xpum_device_id_t deviceId,
    xpum_firmware_type_t firmwareType,
    xpum_firmware_flash_task_result_t* result
    );

XPUM_API xpum_result_t xpumGetFirmwareFlashErrorMsg(char* buffer, int* count);

XPUM_API xpum_result_t xpumRunDiagnostics(
    xpum_device_id_t deviceId,
    xpum_diag_level_t level
    );

XPUM_API xpum_result_t xpumRunMultipleSpecificDiagnostics(
    xpum_device_id_t deviceId,
    xpum_diag_task_type_t types[],
    int count
    );

XPUM_API xpum_result_t xpumRunDiagnosticsByGroup(
    xpum_group_id_t groupId,
    xpum_diag_level_t level
    );

XPUM_API xpum_result_t xpumRunMultipleSpecificDiagnosticsByGroup(
    xpum_group_id_t groupId,
    xpum_diag_task_type_t types[],
    int count
    );

XPUM_API xpum_result_t xpumGetDiagnosticsResult(
    xpum_device_id_t deviceId,
    xpum_diag_task_info_t* result
    );

XPUM_API xpum_result_t xpumGetDiagnosticsResultByGroup(
    xpum_group_id_t groupId,
    xpum_diag_task_info_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetDiagnosticsMediaCodecResult(
    xpum_device_id_t deviceId,
    xpum_diag_media_codec_metrics_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetDiagnosticsXeLinkThroughputResult(
    xpum_device_id_t deviceId,
    xpum_diag_xe_link_throughput_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumRunStress(
    xpum_device_id_t deviceId,
    uint32_t stressTime
    );

XPUM_API xpum_result_t xpumCheckStress(
    xpum_device_id_t deviceId,
    xpum_diag_task_info_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumPrecheck(
    xpum_precheck_component_info_t resultList[],
    int* count,
    xpum_precheck_options options
    );

XPUM_API xpum_result_t xpumGetPrecheckErrorList(
    xpum_precheck_error_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumSetAgentConfig(xpum_agent_config_t key, void* value);
XPUM_API xpum_result_t xpumGetAgentConfig(xpum_agent_config_t key, void* value);

XPUM_API xpum_result_t xpumGetStats(
    xpum_device_id_t deviceId,
    xpum_device_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumGetStatsEx(
    xpum_device_id_t deviceIdList[],
    uint32_t deviceCount,
    xpum_device_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumGetEngineStats(
    xpum_device_id_t deviceId,
    xpum_device_engine_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumGetEngineStatsEx(
    xpum_device_id_t deviceIdList[],
    uint32_t deviceCount,
    xpum_device_engine_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumGetFabricThroughputStats(
    xpum_device_id_t deviceId,
    xpum_device_fabric_throughput_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumGetFabricThroughputStatsEx(
    xpum_device_id_t deviceIdList[],
    uint32_t deviceCount,
    xpum_device_fabric_throughput_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumGetMetricsFromSysfs(
    const char** bdfs,
    uint32_t length,
    xpum_device_stats_t dataList[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetStatsByGroup(
    xpum_group_id_t groupId,
    xpum_device_stats_t dataList[],
    uint32_t* count,
    uint64_t* begin,
    uint64_t* end,
    uint64_t sessionId
    );

XPUM_API xpum_result_t xpumStartDumpRawDataTask(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    const xpum_dump_type_t dumpTypeList[],
    const int count,
    const char* dumpFilePath,
    xpum_dump_raw_data_task_t* taskInfo
    );

XPUM_API xpum_result_t xpumStartDumpRawDataTaskEx(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    const xpum_dump_type_t dumpTypeList[],
    const int count,
    const char* dumpFilePath,
    xpum_dump_raw_data_option_t dumpOptions,
    xpum_dump_raw_data_task_t* taskInfo
    );

XPUM_API xpum_result_t xpumStopDumpRawDataTask(
    xpum_dump_task_id_t taskId,
    xpum_dump_raw_data_task_t* taskInfo
    );

XPUM_API xpum_result_t xpumListDumpRawDataTasks(
    xpum_dump_raw_data_task_t taskList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetTopology(
    xpum_device_id_t deviceId,
    xpum_topology_t* topology,
    long unsigned int* memSize
    );

XPUM_API xpum_result_t xpumExportTopology2XML(char xmlBuffer[], int* memSize);

XPUM_API xpum_result_t xpumGetXelinkTopology(
    xpum_xelink_topo_info xelink_topo[],
    int* count
    );

XPUM_API xpum_result_t xpumSetPolicy(
    xpum_device_id_t deviceId,
    xpum_policy_t policy
    );

XPUM_API xpum_result_t xpumSetPolicyByGroup(
    xpum_group_id_t groupId,
    xpum_policy_t policy
    );

XPUM_API xpum_result_t xpumGetPolicy(
    xpum_device_id_t deviceId,
    xpum_policy_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetPolicyByGroup(
    xpum_group_id_t groupId,
    xpum_policy_t resultList[],
    int* count
    );

XPUM_API xpum_result_t xpumGetAMCSensorReading(
    xpum_sensor_reading_t data[],
    int* count
    );

XPUM_API xpum_result_t xpumDoVgpuPrecheck(xpum_vgpu_precheck_result_t* result);

XPUM_API xpum_result_t xpumCreateVf(
    xpum_device_id_t deviceId,
    xpum_vgpu_config_t* conf
    );

XPUM_API xpum_result_t xpumGetDeviceFunctionList(
    xpum_device_id_t deviceId,
    xpum_vgpu_function_info_t list[],
    int* count
    );

XPUM_API xpum_result_t xpumRemoveAllVf(xpum_device_id_t deviceId);

XPUM_API xpum_result_t xpumGetVfMetrics(
    xpum_device_id_t deviceId,
    xpum_vf_metric_t dataList[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGenerateDebugLog(const char* fileName);

XPUM_API xpum_result_t xpumGetRealtimeMetrics(
    xpum_device_id_t deviceId,
    xpum_device_realtime_metrics_t dataList[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetRealtimeMetricsEx(
    xpum_device_id_t deviceIdList[],
    uint32_t deviceCount,
    xpum_device_realtime_metrics_t dataList[],
    uint32_t* count
    );

// macros

#define XPUM_DEVICE_ID_ALL_DEVICES
#define XPUM_MAX_CACHED_METRICS_TASK_NUM
#define XPUM_MAX_COMPONENT_OCCUPANCY_NUM
#define XPUM_MAX_CPU_LIST_LEN
#define XPUM_MAX_CPU_S_LEN
#define XPUM_MAX_DEVICE_UUID_SIZE
#define XPUM_MAX_NUM_DEVICES
#define XPUM_MAX_NUM_GROUPS
#define XPUM_MAX_NUM_PROPERTIES
#define XPUM_MAX_PATH_LEN
#define XPUM_MAX_STR_LENGTH
#define XPUM_MAX_VERSION_STR_LENGTH
#define XPUM_MAX_VF_NUM
#define XPUM_MAX_XELINK_PORT

Detailed Documentation

Typedefs

typedef int32_t xpum_device_id_t

Device id

typedef uint32_t xpum_group_id_t

Group id

typedef int32_t xpum_event_id_t

Event id

typedef int32_t xpum_dump_task_id_t

Task id

typedef int32_t xpum_device_tile_id_t

Tile id

typedef int32_t xpum_sampling_interval_t

sampling interval

typedef enum xpum_result_enum xpum_result_t

API call results

typedef enum xpum_version_enum xpum_version_t

XPUM version types

typedef struct xpum_version_info xpum_version_info

XPUM version info

typedef struct xpum_device_basic_info xpum_device_basic_info

Device basic info

typedef enum xpum_device_property_name_enum xpum_device_property_name_t

Device property types

typedef struct xpum_device_property_t xpum_device_property_t

Struct for one device property.

typedef struct xpum_device_properties_t xpum_device_properties_t

Struct stores all properties of a device.

typedef struct xpum_amc_fw_version_t xpum_amc_fw_version_t

Struct AMC firmware version.

typedef struct xpum_group_info_t xpum_group_info_t

Struct for group info.

typedef enum xpum_health_config_type_enum xpum_health_config_type_t

Definitions for health

typedef enum xpum_device_mode_enum xpum_device_mode_t

Definitions for configuration

typedef enum xpum_firmware_type_enum xpum_firmware_type_t

Firmware types.

Definitions for firmware update

typedef enum xpum_firmware_flash_result_enum xpum_firmware_flash_result_t

Firmware flash states.

typedef struct xpum_firmware_flash_job xpum_firmware_flash_job

Firmware flash job.

typedef struct xpum_firmware_flash_task_result_t xpum_firmware_flash_task_result_t

The struct stores the firmware flash states.

typedef enum xpum_diag_task_type_enum xpum_diag_task_type_t

Definitions for diagnosis

typedef enum xpum_agent_config_enum xpum_agent_config_t

Agent setting types.

Definitions for agent setting

typedef enum xpum_stats_type_enum xpum_stats_type_t

Statistics and metrics types.

Definitions for metrics collection

typedef struct xpum_device_stats_data_t xpum_device_stats_data_t

Struct to store statistics data for different metric types.

typedef struct xpum_device_stats_t xpum_device_stats_t

Struct to store device statistics data.

typedef enum xpum_engine_type_enum xpum_engine_type_t

Engine types.

typedef struct xpum_device_engine_stats_t xpum_device_engine_stats_t

Struct to store device engine statistics data.

typedef struct xpum_device_engine_metric_t xpum_device_engine_metric_t

Struct to store device engine metric data.

typedef enum xpum_fabric_throughput_type_enum xpum_fabric_throughput_type_t

Fabric throughput types.

typedef struct xpum_device_fabric_throughput_stats_t xpum_device_fabric_throughput_stats_t

Struct to store device fabric throughput statistics data.

typedef struct xpum_device_fabric_throughput_metric_t xpum_device_fabric_throughput_metric_t

Struct to store device fabric throughput metric data.

typedef struct xpum_metrics_raw_data_t xpum_metrics_raw_data_t

Struct to store raw statistics data, not aggregated yet.

typedef struct xpum_device_metric_data_t xpum_device_metric_data_t

Struct to store metric data for different metric types.

typedef struct xpum_device_metrics_t xpum_device_metrics_t

Struct to store device metrics data.

typedef struct xpum_device_realtime_metric_t xpum_device_realtime_metric_t

Struct to store realtime data for different metric types.

typedef struct xpum_device_realtime_metrics_t xpum_device_realtime_metrics_t

Struct to store device realtime datas.

typedef struct xpum_vf_metric_t xpum_vf_metric_t

Struct to store metrics of a VF(Virtual Function)

typedef struct xpum_device_component_ratio_t xpum_device_component_ratio_t

Struct to store one component occupancy.

typedef struct xpum_device_components_ratio_t xpum_device_components_ratio_t

Struct to store all component occupancy ratio.

typedef struct xpum_topology_t xpum_topology_t

Struct to store topology data.

typedef struct xpum_dump_raw_data_task_t xpum_dump_raw_data_task_t

dump raw data task structure

Macros

#define XPUM_DEVICE_ID_ALL_DEVICES

The device id stand for all devices

#define XPUM_MAX_CACHED_METRICS_TASK_NUM

The max number of cached metrics collecting task

#define XPUM_MAX_COMPONENT_OCCUPANCY_NUM

The max number of monitored function component occupancy situation in GPU

#define XPUM_MAX_DEVICE_UUID_SIZE

Max uuid bytes

#define XPUM_MAX_NUM_DEVICES

Max number of devices supported by XPUM

#define XPUM_MAX_NUM_GROUPS

Max limit on the number of groups supported by XPUM

#define XPUM_MAX_NUM_PROPERTIES

Max limit on the number of properties of a device supported by XPUM

#define XPUM_MAX_STR_LENGTH

Max string length

#define XPUM_MAX_VERSION_STR_LENGTH

Max version string length