diff options
Diffstat (limited to 'include/odp/api/spec/traffic_mngr.h')
| -rw-r--r-- | include/odp/api/spec/traffic_mngr.h | 112 |
1 files changed, 103 insertions, 9 deletions
diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h index 03294c820..04848a0ea 100644 --- a/include/odp/api/spec/traffic_mngr.h +++ b/include/odp/api/spec/traffic_mngr.h @@ -1651,7 +1651,8 @@ typedef struct { /** Get tm_node Info * * The odp_tm_node_info() function is used to extract various bits of - * configuration associated with a given tm_node. + * configuration associated with a given tm_node. The info structure is written + * only on success. * * @param tm_node Specifies the tm_node to be queried. * @param[out] info A pointer to an odp_tm_node_info_t record that is to @@ -1711,7 +1712,7 @@ typedef struct { * from their fanin list, a reasonable list walk can occur - even while past or * future entries are being removed or while future entries are being added. * Note that all new additions to a fanin list always take place at the end of - * the list. + * the list. The info structure is written only on success. * * @param tm_node Specifies the tm_node to be queried. * @param[in,out] info A pointer to an odp_tm_node_fanin_info_t record that @@ -1756,7 +1757,8 @@ typedef struct { /** Get tm_queue Info * * The odp_tm_queue_info() function is used to extract various bits of - * configuration associated with a given tm_queue. + * configuration associated with a given tm_queue. The info structure is + * written only on success. * * @param tm_queue Specifies the tm_queue to be queried. * @param[out] info A pointer to an odp_tm_queue_info_t record that is to @@ -1840,11 +1842,12 @@ typedef struct { * byte counts or both are being requested. It is an error to request * neither. The implementation may still return both sets of counts * regardless of query_flags if the cost of returning all the counts is - * comparable to the cost of checking the query_flags. + * comparable to the cost of checking the query_flags. The info structure is + * written only on success. * * @param tm_queue Specifies the tm_queue (and indirectly the * TM system). - * @param[out] query_flags A set of flag bits indicating which counters are + * @param query_flags A set of flag bits indicating which counters are * being requested to be returned in the info record. * @param[out] info Pointer to an odp_tm_query_info_t record where the * requested queue info is returned. @@ -1860,12 +1863,12 @@ int odp_tm_queue_query(odp_tm_queue_t tm_queue, * requested. It is an error to request neither. The implementation may * still return both sets of counts regardless of query_flags if the cost of * returning all the counts is comparable to the cost of checking the - * query_flags. + * query_flags. The info structure is written only on success. * * @param odp_tm Specifies the TM system. * @param priority Supplies the strict priority level used to specify * which tm_queues are included in the info values. - * @param[out] query_flags A set of flag bits indicating which counters are + * @param query_flags A set of flag bits indicating which counters are * being requested to be returned in the info record. * @param[out] info Pointer to an odp_tm_query_info_t record where the * requested queue info is returned. @@ -1882,10 +1885,10 @@ int odp_tm_priority_query(odp_tm_t odp_tm, * requested. It is an error to request neither. The implementation may * still return both sets of counts regardless of query_flags if the cost of * returning all the counts is comparable to the cost of checking the - * query_flags. + * query_flags. The info structure is written only on success. * * @param odp_tm Specifies the TM system. - * @param[out] query_flags A set of flag bits indicating which counters are + * @param query_flags A set of flag bits indicating which counters are * being requested to be returned in the info record. * @param[out] info Pointer to an odp_tm_query_info_t record where the * requested queue info is returned. @@ -1952,6 +1955,97 @@ odp_bool_t odp_tm_is_idle(odp_tm_t odp_tm); void odp_tm_stats_print(odp_tm_t odp_tm); /** + * Get printable value for an odp_tm_t + * + * @param hdl odp_tm_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_t handle. + */ +uint64_t odp_tm_to_u64(odp_tm_t hdl); + +/** + * Get printable value for an odp_tm_queue_t + * + * @param hdl odp_tm_queue_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_queue_t handle. + */ +uint64_t odp_tm_queue_to_u64(odp_tm_queue_t hdl); + +/** + * Get printable value for an odp_tm_node_t + * + * @param hdl odp_tm_node_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_node_t handle. + */ +uint64_t odp_tm_node_to_u64(odp_tm_node_t hdl); + +/** + * Get printable value for an odp_tm_shaper_t + * + * @param hdl odp_tm_shaper_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_shaper_t handle. + */ +uint64_t odp_tm_shaper_to_u64(odp_tm_shaper_t hdl); + +/** + * Get printable value for an odp_tm_sched_t + * + * @param hdl odp_tm_sched_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_sched_t handle. + */ +uint64_t odp_tm_sched_to_u64(odp_tm_sched_t hdl); + +/** + * Get printable value for an odp_tm_threshold_t + * + * @param hdl odp_tm_threshold_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_threshold_t handle. + */ +uint64_t odp_tm_threshold_to_u64(odp_tm_threshold_t hdl); + +/** + * Get printable value for an odp_tm_wred_t + * + * @param hdl odp_tm_wred_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_tm_wred_t handle. + */ +uint64_t odp_tm_wred_to_u64(odp_tm_wred_t hdl); + +/** * @} */ |