File metrics.h

FileList > docs > sw > include > opae > metrics.h

Go to the source code of this file.

Functions for Discover/ Enumerates metrics and retrieves values.

• #include <opae/types.h>

Public Functions

Type	Name
fpga_result	fpgaGetMetricsByIndex (fpga_handle handle, uint64_t * metric_num, uint64_t num_metric_indexes, fpga_metric * metrics) Retrieve metrics values by index.
fpga_result	fpgaGetMetricsByName (fpga_handle handle, char ** metrics_names, uint64_t num_metric_names, fpga_metric * metrics) Retrieve metric values by names.
fpga_result	fpgaGetMetricsInfo (fpga_handle handle, fpga_metric_info * metric_info, uint64_t * num_metrics) Retrieve metrics information.
fpga_result	fpgaGetMetricsThresholdInfo (fpga_handle handle, struct metric_threshold * metric_thresholds, uint32_t * num_thresholds) Retrieve metrics / sendor threshold information and values.
fpga_result	fpgaGetNumMetrics (fpga_handle handle, uint64_t * num_metrics) Enumerates number of metrics.

Public Functions Documentation

function fpgaGetMetricsByIndex

Retrieve metrics values by index.

fpga_result fpgaGetMetricsByIndex (
    fpga_handle handle,
    uint64_t * metric_num,
    uint64_t num_metric_indexes,
    fpga_metric * metrics
) 

Parameters:

• handle Handle to previously opened fpga resource
• metric_num Pointer to array of metric index user allocates metric array
• num_metric_indexes Size of metric array
• metrics pointer to array of metric struct

Returns:

FPGA_OK on success. FPGA_NOT_FOUND if the Metrics are not found. FPGA_NO_MEMORY if there was not enough memory to enumerates metrics.

function fpgaGetMetricsByName

Retrieve metric values by names.

fpga_result fpgaGetMetricsByName (
    fpga_handle handle,
    char ** metrics_names,
    uint64_t num_metric_names,
    fpga_metric * metrics
) 

Parameters:

• handle Handle to previously opened fpga resource
• metrics_names Pointer to array of metrics name user allocates metrics name array
• num_metric_names Size of metric name array
• metrics Pointer to array of metric struct

Returns:

FPGA_OK on success. FPGA_NOT_FOUND if the Metrics are not found

function fpgaGetMetricsInfo

Retrieve metrics information.

fpga_result fpgaGetMetricsInfo (
    fpga_handle handle,
    fpga_metric_info * metric_info,
    uint64_t * num_metrics
) 

Parameters:

• handle Handle to previously opened fpga resource
• metric_info Pointer to array of metric info struct user allocates metrics info array
• num_metrics Size of metric info array

Returns:

FPGA_OK on success. FPGA_NOT_FOUND if the Metrics are not found. FPGA_NO_MEMORY if there was not enough memory to enumerates metrics.

function fpgaGetMetricsThresholdInfo

Retrieve metrics / sendor threshold information and values.

fpga_result fpgaGetMetricsThresholdInfo (
    fpga_handle handle,
    struct metric_threshold * metric_thresholds,
    uint32_t * num_thresholds
) 

Parameters:

• handle Handle to previously opened fpga resource
• metrics_threshold pointer to array of metric thresholds user allocates threshold array memory Number of thresholds returns enumerated thresholds if user pass NULL metrics_thresholds
• num_thresholds number of thresholds

Returns:

FPGA_OK on success. FPGA_NOT_FOUND if the Metrics are not found. FPGA_NO_MEMORY if there was not enough memory to enumerates metrics.

function fpgaGetNumMetrics

Enumerates number of metrics.

fpga_result fpgaGetNumMetrics (
    fpga_handle handle,
    uint64_t * num_metrics
) 

Parameters:

• handle Handle to previously opened fpga resource
• num_metrics Number of metrics are discovered in fpga resource

Returns:

FPGA_OK on success. FPGA_NOT_FOUND if the Metrics are not discovered

---

The documentation for this class was generated from the following file docs/sw/include/opae/metrics.h