intrte_metrics_init(intsocket_id)
Initializes metric module. This function must be called from a primary process before metrics are used.
Parameterssocket_id Socket to use for shared memory allocation.
Returns
0 on success Negative error code (from rte_errno.h) on error: -EEXIST - a memzone for metrics already
exists but metrics is not initialized -ENOMEM - cannot allocate metrics memzone -E_RTE_SECONDARY -
function called from secondary process
intrte_metrics_deinit(void)
Deinitialize metric module. This function must be called from a primary process after all the metrics
usage is over, to release the shared memory.
Returns
-EINVAL - invalid parameter. -EIO: Error, unable to access metrics shared memory (rte_metrics_init()
not called) 0 - success
intrte_metrics_reg_name(constchar*name)
Register a metric, making it available as a reporting parameter.
Registering a metric is the way producers declare a parameter that they wish to be reported. Once
registered, the associated numeric key can be obtained via rte_metrics_get_names(), which is required for
updating said metric's value.
Parametersname Metric name. If this exceeds RTE_METRICS_MAX_NAME_LEN (including the NULL terminator), it is
truncated.
Returns
• Zero or positive: Success (index key of new metric)
• -EIO: Error, unable to access metrics shared memory (rte_metrics_init() not called)
• -EINVAL: Error, invalid parameters
• -ENOMEM: Error, maximum metrics reached
intrte_metrics_reg_names(constchar*const*names,uint16_tcnt_names)
Register a set of metrics.
This is a bulk version of rte_metrics_reg_names() and aside from handling multiple keys at once is
functionally identical.
Parametersnames List of metric names
cnt_names Number of metrics in set
Returns
• Zero or positive: Success (index key of start of set)
• -EIO: Error, unable to access metrics shared memory (rte_metrics_init() not called)
• -EINVAL: Error, invalid parameters
• -ENOMEM: Error, maximum metrics reached
intrte_metrics_get_names(structrte_metric_name*names,uint16_tcapacity)
Get metric name-key lookup table.
Parametersnames A struct rte_metric_name array of at least capacity in size to receive key names. If this is
NULL, function returns the required number of elements for this array.
capacity Size (number of elements) of struct rte_metric_name array. Disregarded if names is NULL.
Returns
• Positive value above capacity: error, names is too small. Return value is required size.
• Positive value equal or less than capacity: Success. Return value is number of elements filled in.
• Negative value: error.
intrte_metrics_get_values(intport_id,structrte_metric_value*values,uint16_tcapacity)
Get metric value table.
Parametersport_id Port id to query
values A struct rte_metric_value array of at least capacity in size to receive metric ids and values.
If this is NULL, function returns the required number of elements for this array.
capacity Size (number of elements) of struct rte_metric_value array. Disregarded if names is NULL.
Returns
• Positive value above capacity: error, values is too small. Return value is required size.
• Positive value equal or less than capacity: Success. Return value is number of elements filled in.
• Negative value: error.
intrte_metrics_update_value(intport_id,uint16_tkey,constuint64_tvalue)
Updates a metric
Parametersport_id Port to update metrics for
key Id of metric to update
value New value
Returns
• -EIO if unable to access shared metrics memory
• Zero on success
intrte_metrics_update_values(intport_id,uint16_tkey,constuint64_t*values,uint32_tcount)
Updates a metric set. Note that it is an error to try to update across a set boundary.
Parametersport_id Port to update metrics for
key Base id of metrics set to update
values Set of new values
count Number of new values
Returns
• -ERANGE if count exceeds metric set size
• -EIO if unable to access shared metrics memory
• Zero on success
Install Now
PNG Icons
