oneAPI-spec icon indicating copy to clipboard operation
oneAPI-spec copied to clipboard

Bogus zesMemoryGetBandwidth() documentation

Open eero-t opened this issue 3 years ago • 2 comments

See zesMemoryGetBandwidth() documentation: https://spec.oneapi.io/level-zero/latest/sysman/api.html#zesmemorygetbandwidth

It claims following:

Parameters

  • hMemory: [in] Handle for the component.
  • pBandwidth: [in,out] Will contain the current health, free memory, total memory size.

Although zes_mem_bandwidth_t struct includes none of listed items: https://spec.oneapi.io/level-zero/latest/sysman/api.html#_CPPv419zes_mem_bandwidth_t

eero-t avatar Feb 15 '22 12:02 eero-t

Thanks for pointing this out - we'll fix the documentation. I feel that the function name is misleading. Although the call does give you the design bandwidth, it's returning much more in the form of the counters that let you compute the actual bandwidth. So perhaps it should have been named zesMemoryGetBandwidthCounters ?

AstroVPK avatar Feb 17 '22 22:02 AstroVPK

I'd care more about consistency rather than exact name. Similar function for fabric is called zesFabricPortGetThroughput()...

eero-t avatar Feb 18 '22 08:02 eero-t