Folder structure#

Usage#

amdsmi folder should be copied and placed next to importing script. It should be imported as:

from amdsmi import *

try:
    amdsmi_init()

    # amdsmi calls ...

except AmdSmiException as e:
    print(e)
finally:
    try:
        amdsmi_shut_down()
    except AmdSmiException as e:
        print(e)

To initialize amdsmi lib, amdsmi_init() must be called before all other calls to amdsmi lib.

To close connection to driver, amdsmi_shut_down() must be the last call.

amdsmi_init#

Description: Initialize amdsmi lib and connect to driver

Input parameters: None

Output: None

Exceptions that can be thrown by amdsmi_init function:

• AmdSmiLibraryException

Example:

try:
    amdsmi_init()
    # continue with amdsmi
except AmdSmiException as e:
    print("Init failed")
    print(e)

amdsmi_shut_down#

Description: Finalize and close connection to driver

Input parameters: None

Output: None

Exceptions that can be thrown by amdsmi_shut_down function:

• AmdSmiLibraryException

Example:

try:
    amdsmi_init()
    amdsmi_shut_down()
except AmdSmiException as e:
    print("Shut down failed")
    print(e)

amdsmi_get_device_type#

Description: Checks the type of device with provided handle.

Input parameters: device handle as an instance of amdsmi_device_handle

Output: Integer, type of gpu

Exceptions that can be thrown by amdsmi_get_device_type function:

• AmdSmiLibraryException

Example:

try:
    type_of_GPU = amdsmi_get_device_type(device_handle)
    if type_of_GPU == 1:
        print("This is an AMD GPU")
except AmdSmiException as e:
    print(e)

amdsmi_get_device_handles#

Description: Returns list of GPU device handle objects on current machine

Input parameters: None

Output: List of GPU device handle objects

Exceptions that can be thrown by amdsmi_get_device_handles function:

• AmdSmiLibraryException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            print(amdsmi_get_device_uuid(device))
except AmdSmiException as e:
    print(e)

amdsmi_get_socket_handles#

Note: CURRENTLY HARDCODED TO RETURN DUMMY DATA Description: Returns list of socket device handle objects on current machine

Input parameters: None

Output: List of socket device handle objects

Exceptions that can be thrown by amdsmi_get_socket_handles function:

• AmdSmiLibraryException

Example:

try:
    sockets = amdsmi_get_socket_handles()
    print('Socket numbers: {}'.format(len(sockets)))
except AmdSmiException as e:
    print(e)

amdsmi_get_socket_info#

Note: CURRENTLY HARDCODED TO RETURN EMPTY VALUES Description: Return socket name

Input parameters: socket_handle socket handle

Output: Socket name

Exceptions that can be thrown by amdsmi_get_socket_info function:

• AmdSmiLibraryException

Example:

try:
    socket_handles = amdsmi_get_socket_handles()
    if len(socket_handles) == 0:
        print("No sockets on machine")
    else:
        for socket in socket_handles:
            print(amdsmi_get_socket_info(socket))
except AmdSmiException as e:
    print(e)

amdsmi_get_device_handle_from_bdf#

Description: Returns device handle from the given BDF

Input parameters: bdf string in form of either <domain>:<bus>:<device>.<function> or <bus>:<device>.<function> in hexcode format. Where:

• <domain> is 4 hex digits long from 0000-FFFF interval

• <bus> is 2 hex digits long from 00-FF interval

• <device> is 2 hex digits long from 00-1F interval

• <function> is 1 hex digit long from 0-7 interval

Output: device handle object

Exceptions that can be thrown by amdsmi_get_device_handle_from_bdf function:

• AmdSmiLibraryException

• AmdSmiBdfFormatException

Example:

try:
    device = amdsmi_get_device_handle_from_bdf("0000:23:00.0")
    print(amdsmi_get_device_uuid(device))
except AmdSmiException as e:
    print(e)

amdsmi_get_device_bdf#

Description: Returns BDF of the given device

Input parameters:

• device_handle dev for which to query

Output: BDF string in form of <domain>:<bus>:<device>.<function> in hexcode format. Where:

• <domain> is 4 hex digits long from 0000-FFFF interval

• <bus> is 2 hex digits long from 00-FF interval

• <device> is 2 hex digits long from 00-1F interval

• <function> is 1 hex digit long from 0-7 interval

Exceptions that can be thrown by amdsmi_get_device_bdf function:

• AmdSmiParameterException

• AmdSmiLibraryException

Example:

try:
    device = amdsmi_get_device_handles()[0]
    print("Device's bdf:", amdsmi_get_device_bdf(device))
except AmdSmiException as e:
    print(e)

amdsmi_get_device_uuid#

Description: Returns the UUID of the device

Input parameters:

• device_handle dev for which to query

Output: UUID string unique to the device

Exceptions that can be thrown by amdsmi_get_device_uuid function:

• AmdSmiParameterException

• AmdSmiLibraryException

Example:

try:
    device = amdsmi_get_device_handles()[0]
    print("Device UUID: ", amdsmi_get_device_uuid(device))
except AmdSmiException as e:
    print(e)

amdsmi_get_driver_version#

Description: Returns the version string of the driver

Input parameters:

• device_handle dev for which to query

Output: Driver version string that is handling the device

Exceptions that can be thrown by amdsmi_get_driver_version function:

• AmdSmiParameterException

• AmdSmiLibraryException

Example:

try:
    device = amdsmi_get_device_handles()[0]
    print("Driver version: ", amdsmi_get_driver_version(device))
except AmdSmiException as e:
    print(e)

amdsmi_get_asic_info#

Description: Returns asic information for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_asic_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            asic_info = amdsmi_get_asic_info(device)
            print(asic_info['market_name'])
            print(hex(asic_info['family']))
            print(hex(asic_info['vendor_id']))
            print(hex(asic_info['device_id']))
            print(hex(asic_info['rev_id']))
            print(asic_info['asic_serial'])
except AmdSmiException as e:
    print(e)

amdsmi_get_power_cap_info#

Description: Returns dictionary of power capabilities as currently configured on the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_power_cap_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            power_info = amdsmi_get_power_cap_info(device)
            print(power_info['power_cap'])
            print(power_info['dpm_cap'])
            print(power_info['power_cap_default'])
            print(power_info['min_power_cap'])
            print(power_info['max_power_cap'])
except AmdSmiException as e:
    print(e)

amdsmi_get_caps_info#

Description: Returns capabilities as currently configured for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_caps_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            caps_info =  amdsmi_get_caps_info(device)
            print(caps_info['ras_supported'])
            print(caps_info['gfx']['gfxip_major'])
            print(caps_info['gfx']['gfxip_minor'])
            print(caps_info['gfx']['gfxip_cu_count'])
            print(caps_info['mm_ip_list'])
            print(caps_info['gfx_ip_count'])
            print(caps_info['dma_ip_count'])
except AmdSmiException as e:
    print(e)

amdsmi_get_vbios_info#

Description: Returns the static information for the VBIOS on the device.

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_vbios_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            vbios_info = amdsmi_get_vbios_info(device)
            print(vbios_info['name'])
            print(vbios_info['vbios_version'])
            print(vbios_info['build_date'])
            print(vbios_info['part_number'])
            print(vbios_info['vbios_version_string'])
except AmdSmiException as e:
    print(e)

amdsmi_get_fw_info#

Description: Returns GPU firmware related information.

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_fw_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            firmware_list = amdsmi_get_fw_info(device)['fw_list']
            for firmware_block in firmware_list:
                print(firmware_block['fw_name'])
                print(firmware_block['fw_version'])
except AmdSmiException as e:
    print(e)

amdsmi_get_gpu_activity#

Description: Returns the engine usage for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_gpu_activity function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            engine_usage = amdsmi_get_gpu_activity(device)
            print(engine_usage['gfx_activity'])
            print(engine_usage['umc_activity'])
            print(engine_usage['mm_activity'])
except AmdSmiException as e:
    print(e)

amdsmi_get_power_measure#

Description: Returns the current power and voltage for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_power_measure function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            power_measure = amdsmi_get_power_measure(device)
            print(power_measure['average_socket_power'])
            print(power_measure['voltage_gfx'])
            print(power_measure['energy_accumulator'])
            print(power_measure['power_limit'])
except AmdSmiException as e:
    print(e)

amdsmi_get_vram_usage#

Description: Returns total VRAM and VRAM in use

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_vram_usage function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            vram_usage = amdsmi_get_vram_usage(device)
            print(vram_usage['vram_used'])
            print(vram_usage['vram_total'])
except AmdSmiException as e:
    print(e)

amdsmi_get_clock_measure#

Description: Returns the clock measure for the given GPU

Input parameters:

• device_handle device which to query

• clock_type one of AmdSmiClkType enum values:

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_clock_measure function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            clock_measure = amdsmi_get_clock_measure(device, AmdSmiClkType.GFX)
            print(clock_measure['cur_clk'])
            print(clock_measure['avg_clk'])
            print(clock_measure['min_clk'])
            print(clock_measure['max_clk'])
except AmdSmiException as e:
    print(e)

amdsmi_get_pcie_link_status#

Description: Returns the pcie link status for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_pcie_link_status function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            pcie_link_status = amdsmi_get_pcie_link_status(device)
            print(pcie_link_status["pcie_lanes"])
            print(pcie_link_status["pcie_speed"])
except AmdSmiException as e:
    print(e)

amdsmi_get_pcie_link_caps#

Description: Returns the max pcie link capabilities for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_pcie_link_caps function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            pcie_caps = amdsmi_get_pcie_link_caps(device)
            print(pcie_caps['pcie_lanes'])
            print(pcie_caps['pcie_speed'])
except AmdSmiException as e:
    print(e)

amdsmi_get_bad_page_info#

Description: Returns bad page info for the given GPU

Input parameters:

• device_handle device which to query

Output: List consisting of dictionaries with fields for each bad page found

Exceptions that can be thrown by amdsmi_get_bad_page_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            bad_page_info = amdsmi_get_bad_page_info(device)
            if not len(bad_page_info):
                print("No bad pages found")
                continue
            for bad_page in bad_page_info:
                print(bad_page["value"])
                print(bad_page["page_address"])
                print(bad_page["page_size"])
                print(bad_page["status"])
except AmdSmiException as e:
    print(e)

amdsmi_get_target_frequency_range#

Description: Returns the supported frequency target range for the given GPU

Note: Not Supported

Input parameters:

• device_handle device which to query

• clock_type one of AmdSmiClkType enum values:

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_target_frequency_range function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            print("=============== GFX DOMAIN ================")
            freq_range = amdsmi_get_target_frequency_range(device,
                AmdSmiClkType.GFX)
            print(freq_range['supported_upper_bound'])
            print(freq_range['supported_lower_bound'])
            print(freq_range['current_upper_bound'])
            print(freq_range['current_lower_bound'])
            print("=============== MEM DOMAIN ================")
            freq_range = amdsmi_get_target_frequency_range(device,
                AmdSmiClkType.MEM)
            print(freq_range['supported_upper_bound'])
            print(freq_range['supported_lower_bound'])
            print(freq_range['current_upper_bound'])
            print(freq_range['current_lower_bound'])
            print("=============== VCLK0 DOMAIN ================")
            freq_range = amdsmi_get_target_frequency_range(device,
                AmdSmiClkType.VCLK0)
            print(freq_range['supported_upper_bound'])
            print(freq_range['supported_lower_bound'])
            print(freq_range['current_upper_bound'])
            print(freq_range['current_lower_bound'])
except AmdSmiException as e:
    print(e)

amdsmi_get_process_list#

Description: Returns the list of processes for the given GPU

Input parameters:

• device_handle device which to query

Output: List of process handles found

Exceptions that can be thrown by amdsmi_get_process_list function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            processes = amdsmi_get_process_list(device)
            print(processes)
except AmdSmiException as e:
    print(e)

amdsmi_get_process_info#

Description: Returns the info for the given process

Input parameters:

• device_handle device which to query

• process_handle process which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_process_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            processes = amdsmi_get_process_list(device)
            for process in processes:
                print(amdsmi_get_process_info(device, process))
except AmdSmiException as e:
    print(e)

amdsmi_get_ecc_error_count#

Description: Returns the ECC error count for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_get_ecc_error_count function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            ecc_error_count = amdsmi_get_ecc_error_count(device)
            print(ecc_error_count["correctable_count"])
            print(ecc_error_count["uncorrectable_count"])
except AmdSmiException as e:
    print(e)

amdsmi_get_board_info#

Description: Returns board info for the given GPU

Input parameters:

• device_handle device which to query

Output: Dictionary with fields correctable and uncorrectable

Exceptions that can be thrown by amdsmi_get_board_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    device = amdsmi_get_device_handle_from_bdf("0000:23.00.0")
    board_info = amdsmi_get_board_info(device)
    print(board_info["serial_number"])
    print(board_info["product_serial"])
    print(board_info["product_name"])
except AmdSmiException as e:
    print(e)

amdsmi_get_ras_block_features_enabled#

Description: Returns status of each RAS block for the given GPU

Input parameters:

• device_handle device which to query

Output: List containing dictionaries with fields for each RAS block

Exceptions that can be thrown by amdsmi_get_ras_block_features_enabled function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            ras_block_features = amdsmi_get_ras_block_features_enabled(device)
            print(ras_block_features)
except AmdSmiException as e:
    print(e)

AmdSmiEventReader class#

Description: Providing methods for event monitoring. This is context manager class. Can be used with with statement for automatic cleanup.

Methods:

Constructor#

Description: Allocates a new event reader notifier to monitor different types of events for the given GPU

Input parameters:

• device_handle device handle corresponding to the device on which to listen for events

• event_types list of event types from AmdSmiEvtNotificationType enum. Specifying which events to collect for the given device.

read#

Description: Reads events on the given device. When event is caught, device handle, message and event type are returned. Reading events stops when timestamp passes without event reading.

Input parameters:

• timestamp number of milliseconds to wait for an event to occur. If event does not happen monitoring is finished

• num_elem number of events. This is optional parameter. Default value is 10.

stop#

Description: Any resources used by event notification for the the given device will be freed with this function. This can be used explicitly or automatically using with statement, like in the examples below. This should be called either manually or automatically for every created AmdSmiEventReader object.

Input parameters: None

Example with manual cleanup of AmdSmiEventReader:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        event = AmdSmiEventReader(device[0], AmdSmiEvtNotificationType.GPU_PRE_RESET, AmdSmiEvtNotificationType.GPU_POST_RESET)
        event.read(10000)
except AmdSmiException as e:
    print(e)
finally:
    event.stop()

Example with automatic cleanup using with statement:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        with AmdSmiEventReader(device[0], AmdSmiEvtNotificationType.GPU_PRE_RESET, AmdSmiEvtNotificationType.GPU_POST_RESET) as event:
            event.read(10000)
except AmdSmiException as e:
    print(e)

amdsmi_dev_open_supported_func_iterator#

Description: Get a function name iterator of supported AMDSMI functions for a device

Input parameters:

• device_handle device which to query

Output: Handle for a function iterator

Exceptions that can be thrown by amdsmi_dev_open_supported_func_iterator function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            obj_handle = amdsmi_dev_open_supported_func_iterator(device)
            print(obj_handle)
            amdsmi_dev_close_supported_func_iterator(obj_handle)
except AmdSmiException as e:
    print(e)

amdsmi_dev_open_supported_variant_iterator#

Description: Get a variant iterator for a given handle

Input parameters:

• obj_handle Object handle for witch to return a variant handle

Output: Variant iterator handle

Exceptions that can be thrown by amdsmi_dev_open_supported_variant_iterator function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            obj_handle = amdsmi_dev_open_supported_func_iterator(device)
            var_iter = amdsmi_dev_open_supported_variant_iterator(obj_handle)
            print(var_iter)
            amdsmi_dev_close_supported_func_iterator(obj_handle)
            amdsmi_dev_close_supported_func_iterator(var_iter)
except AmdSmiException as e:
    print(e)

amdsmi_next_func_iter#

Description: Advance an object identifier iterator

Input parameters:

• obj_handle Object handle to advance

Output: Next iterator handle

Exceptions that can be thrown by amdsmi_next_func_iter function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            obj_handle = amdsmi_dev_open_supported_func_iterator(device)
            print(obj_handle)
            obj_handle = amdsmi_next_func_iter(obj_handle)
            print(obj_handle)
            amdsmi_dev_close_supported_func_iterator(obj_handle)
except AmdSmiException as e:
    print(e)

amdsmi_dev_close_supported_func_iterator#

Description: Close a variant iterator handle

Input parameters:

• obj_handle Object handle to be closed

Output: None

Exceptions that can be thrown by amdsmi_dev_close_supported_func_iterator function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            obj_handle = amdsmi_dev_open_supported_func_iterator(device)
            amdsmi_dev_close_supported_func_iterator(obj_handle)
except AmdSmiException as e:
    print(e)

amdsmi_get_func_iter_value#

Description: Get the value associated with a function/variant iterator

Input parameters:

• obj_handle Object handle to query

Output: Data associated with a function/variant iterator

Exceptions that can be thrown by amdsmi_get_func_iter_value function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            obj_handle = amdsmi_dev_open_supported_func_iterator(device)
            value = amdsmi_get_func_iter_value(obj_handle)
            print(value)
            amdsmi_dev_close_supported_func_iterator(obj_handle)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_pci_bandwidth#

Description: Control the set of allowed PCIe bandwidths that can be used

Input parameters:

• device_handle handle for the given device

• bw_bitmask A bitmask indicating the indices of the bandwidths that are to be enabled (1) and disabled (0)

Output: None

Exceptions that can be thrown by amdsmi_dev_set_pci_bandwidth function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_set_pci_bandwidth(device, 0)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_power_cap#

Description: Set the power cap value

Input parameters:

• device_handle handle for the given device

• sensor_ind a 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0

• cap int that indicates the desired power cap, in microwatts

Output: None

Exceptions that can be thrown by amdsmi_dev_set_power_cap function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            power_cap = 250 * 1000000
             amdsmi_dev_set_power_cap(device, 0, power_cap)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_power_profile#

Description: Set the power profile

Input parameters:

• device_handle handle for the given device

• reserved Not currently used, set to 0

• profile a amdsmi_power_profile_preset_masks_t that hold the mask of the desired new power profile

Output: None

Exceptions that can be thrown by amdsmi_dev_set_power_profile function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            profile = ...
             amdsmi_dev_set_power_profile(device, 0, profile)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_clk_range#

Description: This function sets the clock range information

Input parameters:

• device_handle handle for the given device

• min_clk_value minimum clock value for desired clock range

• max_clk_value maximum clock value for desired clock range

• clk_typeAMDSMI_CLK_TYPE_SYS | AMDSMI_CLK_TYPE_MEM range type

Output: None

Exceptions that can be thrown by amdsmi_dev_set_clk_range function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            amdsmi_dev_set_clk_range(device, 0, 1000, AmdSmiClkType.AMDSMI_CLK_TYPE_SYS)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_pci_id#

Description: Get the unique PCI device identifier associated for a device

Input parameters:

• device_handle device which to query

Output: device bdf The format of bdfid will be as follows:

BDFID = ((DOMAIN & 0xffffffff) << 32) | ((BUS & 0xff) << 8) | ((DEVICE & 0x1f) <<3 ) | (FUNCTION & 0x7)

Exceptions that can be thrown by amdsmi_dev_get_pci_id function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            bdfid = amdsmi_dev_get_pci_id(device)
            print(bdfid)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_pci_bandwidth#

Description: Get the list of possible PCIe bandwidths that are available.

Input parameters:

• device_handle device which to query

Output: Dictionary with the possible T/s values and associated number of lanes

transfer_rate dictionary

Exceptions that can be thrown by amdsmi_dev_get_pci_bandwidth function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            bandwidth = amdsmi_dev_get_pci_bandwidth(device)
            print(bandwidth)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_pci_throughput#

Description: Get PCIe traffic information

Input parameters:

• device_handle device which to query

Output: Dictionary with the fields

Exceptions that can be thrown by amdsmi_dev_get_pci_throughput function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            pci = amdsmi_dev_get_pci_throughput(device)
            print(pci)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_pci_replay_counter#

Description: Get PCIe replay counter

Input parameters:

• device_handle device which to query

Output: counter value The sum of the NAK’s received and generated by the GPU

Exceptions that can be thrown by amdsmi_dev_get_pci_replay_counter function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            counter =  amdsmi_dev_get_pci_replay_counter(device)
            print(counter)
except AmdSmiException as e:
    print(e)

amdsmi_topo_get_numa_affinity#

Description: Get the NUMA node associated with a device

Input parameters:

• device_handle device which to query

Output: NUMA node value

Exceptions that can be thrown by amdsmi_topo_get_numa_affinity function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            numa_node = amdsmi_topo_get_numa_affinity(device)
            print(numa_node)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_power_ave#

Description: Get the average power consumption of the device

Input parameters:

• device_handle device which to query

• sensor_id a 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0.

Output: the average power consumption

Exceptions that can be thrown by amdsmi_dev_get_power_ave function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            power = amdsmi_dev_get_power_ave(device)
            print(power)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_energy_count#

Description: Get the energy accumulator counter of the device.

Input parameters:

• device_handle device which to query

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_dev_get_energy_count function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            power = amdsmi_dev_get_energy_count(device)
            print(power)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_memory_total#

Description: Get the total amount of memory that exists

Input parameters:

• device_handle device which to query

• mem_type enum AmdSmiMemoryType

Output: total amount of memory

Exceptions that can be thrown by amdsmi_dev_get_memory_total function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            memory = amdsmi_dev_get_memory_total(device)
            print(memory)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_od_clk_info#

Description: This function sets the clock frequency information

Input parameters:

• device_handle handle for the given device

• level AMDSMI_FREQ_IND_MIN|AMDSMI_FREQ_IND_MAX to set the minimum (0) or maximum (1) speed

• clk_value value to apply to the clock range

• clk_type AMDSMI_CLK_TYPE_SYS | AMDSMI_CLK_TYPE_MEM range type

Output: None

Exceptions that can be thrown by amdsmi_dev_set_od_clk_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_set_od_clk_info(
                device,
                AmdSmiFreqInd.AMDSMI_FREQ_IND_MAX,
                1000,
                AmdSmiClkType.AMDSMI_CLK_TYPE_SYS
            )
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_memory_usage#

Description: Get the current memory usage

Input parameters:

• device_handle device which to query

• mem_type enum AmdSmiMemoryType

Output: the amount of memory currently being used

Exceptions that can be thrown by amdsmi_dev_get_memory_usage function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            memory = amdsmi_dev_get_memory_usage(device)
            print(memory)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_od_volt_info#

Description: This function sets 1 of the 3 voltage curve points

Input parameters:

• device_handle handle for the given device

• vpoint voltage point [0|1|2] on the voltage curve

• clk_value clock value component of voltage curve point

• volt_value voltage value component of voltage curve point

Output: None

Exceptions that can be thrown by amdsmi_dev_set_od_volt_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_set_od_volt_info(device, 1, 1000, 980)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_memory_busy_percent#

Description: Get percentage of time any device memory is being used

Input parameters:

• device_handle device which to query

Output: percentage of time that any device memory is being used for the specified device.

Exceptions that can be thrown by amdsmi_dev_get_memory_busy_percent function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = gpuvsmi_get_devices()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            busy_percent = amdsmi_dev_get_memory_busy_percent(device)
            print(busy_percent)
except AmdSmiException as e:
    print(e)

amdsmi_dev_set_perf_level_v1#

Description: Set the PowerPlay performance level associated with the device with provided device handle with the provided value

Input parameters:

• device_handle handle for the given device

• perf_lvl the value to which the performance level should be set

Output: None

Exceptions that can be thrown by amdsmi_dev_set_perf_level_v1 function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_set_perf_level_v1(device, AmdSmiDevPerfLevel.AMDSMI_DEV_PERF_LEVEL_HIGH)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_fan_rpms#

Description: Get the fan speed in RPMs of the device with the specified device handle and 0-based sensor index.

Input parameters:

• device_handle handle for the given device

• sensor_idx a 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0.

Output: Fan speed in rpms as integer

Exceptions that can be thrown by amdsmi_dev_get_fan_rpms function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            fan_rpm = amdsmi_dev_get_fan_rpms(device, 0)
            print(fan_rpm)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_fan_speed#

Description: Get the fan speed for the specified device as a value relative to AMDSMI_MAX_FAN_SPEED

Input parameters:

• device_handle handle for the given device

• sensor_idx a 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0.

Output: Fan speed in relative to MAX

Exceptions that can be thrown by amdsmi_dev_get_fan_speed function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            fan_speed = amdsmi_dev_get_fan_speed(device, 0)
            print(fan_speed)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_fan_speed_max#

Description: Get the max fan speed of the device with provided device handle

Input parameters:

• device_handle handle for the given device

• sensor_idx a 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0.

Output: Max fan speed as integer

Exceptions that can be thrown by amdsmi_dev_get_fan_speed_max function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            max_fan_speed = amdsmi_dev_get_fan_speed_max(device, 0)
            print(max_fan_speed)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_temp_metric#

Description: Get the temperature metric value for the specified metric, from the specified temperature sensor on the specified device

Input parameters:

• device_handle handle for the given device

• sensor_type part of device from which temperature should be obtained

• metric enum indicated which temperature value should be retrieved

Output: Temperature as integer in millidegrees Celcius

Exceptions that can be thrown by amdsmi_dev_get_temp_metric function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            temp_metric =  amdsmi_dev_get_temp_metric(device, AmdSmiTemperatureType.EDGE,
                            AmdSmiTemperatureMetric.CURRENT)
            print(temp_metric)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_volt_metric#

Description: Get the voltage metric value for the specified metric, from the specified voltage sensor on the specified device

Input parameters:

• device_handle handle for the given device

• sensor_type part of device from which voltage should be obtained

• metric enum indicated which voltage value should be retrieved

Output: Voltage as integer in millivolts

Exceptions that can be thrown by amdsmi_dev_get_volt_metric function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            voltage =  amdsmi_dev_get_volt_metric(device, AmdSmiVoltageType.VDDGFX,
                        AmdSmiVoltageMetric.AVERAGE)
            print(voltage)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_busy_percent#

Description: Get percentage of time device is busy doing any processing

Input parameters:

• device_handle handle for the given device

Output: How busy the device is (as percentage of time)

Exceptions that can be thrown by amdsmi_dev_get_busy_percent function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            busy = amdsmi_dev_get_busy_percent(dev)
            print(busy)
except AmdSmiException as e:
    print(e)

amdsmi_get_utilization_count#

Description: Get coarse grain utilization counter of the specified device

Input parameters:

• device_handle handle for the given device

• counter_types variable number of counter types desired

Output: List containing dictionaries with fields

Exceptions that can be thrown by amdsmi_get_utilization_count function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            utilization = amdsmi_get_utilization_count(
                            device,
                            AmdSmiUtilizationCounterType.COARSE_GRAIN_GFX_ACTIVITY
                            )
            print(utilization)
            utilization = amdsmi_get_utilization_count(
                            device,
                            AmdSmiUtilizationCounterType.COARSE_GRAIN_GFX_ACTIVITY,
                            AmdSmiUtilizationCounterType.COARSE_GRAIN_MEM_ACTIVITY
                            )
            print(utilization)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_perf_level#

Description: Get the performance level of the device with provided device handle

Input parameters:

• device_handle handle for the given device

Output: Performance level as enum value of dev_perf_level_t

Exceptions that can be thrown by amdsmi_dev_get_perf_level function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            perf_level = amdsmi_dev_get_perf_level(dev)
            print(perf_level)
except AmdSmiException as e:
    print(e)

amdsmi_set_perf_determinism_mode#

Description: Enter performance determinism mode with provided device handle

Input parameters:

• device_handle handle for the given device

• clkvalue softmax value for GFXCLK in MHz

Output: None

Exceptions that can be thrown by amdsmi_set_perf_determinism_mode function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            amdsmi_set_perf_determinism_mode(device, 1333)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_overdrive_level#

Description: Get the overdrive percent associated with the device with provided device handle

Input parameters:

• device_handle handle for the given device

Output: Overdrive percentage as integer

Exceptions that can be thrown by amdsmi_dev_get_overdrive_level function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            od_level = amdsmi_dev_get_overdrive_level(dev)
            print(od_level)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_gpu_clk_freq#

Description: Get the list of possible system clock speeds of device for a specified clock type

Input parameters:

• device_handle handle for the given device

• clk_type the type of clock for which the frequency is desired

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_dev_get_gpu_clk_freq function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_get_gpu_clk_freq(device, AmdSmiClkType.SYS)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_od_volt_info#

Description: This function retrieves the voltage/frequency curve information

Input parameters:

• device_handle handle for the given device

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_dev_get_od_volt_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_get_od_volt_info(dev)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_gpu_metrics_info#

Description: This function retrieves the gpu metrics information

Input parameters:

• device_handle handle for the given device

Output: Dictionary with fields

Field | Description ---|--- temperature_edge| edge temperature valuetemperature_hotspot| hotspot temperature valuetemperature_mem| memory temperature valuetemperature_vrgfx| vrgfx temperature valuetemperature_vrsoc| vrsoc temperature valuetemperature_vrmem| vrmem temperature valueaverage_gfx_activity| average gfx activityaverage_umc_activity| average umc activityaverage_mm_activity| average mm activityaverage_socket_power| average socket powerenergy_accumulator| energy accumulator valuesystem_clock_counter| system clock counteraverage_gfxclk_frequency| average gfx clock frequencyaverage_socclk_frequency| average soc clock frequencyaverage_uclk_frequency| average uclk frequencyaverage_vclk0_frequency| average vclk0 frequencyaverage_dclk0_frequency| average dclk0 frequencyaverage_vclk1_frequency| average vclk1 frequencyaverage_dclk1_frequency| average dclk1 frequencycurrent_gfxclk| current gfx clockcurrent_socclk| current soc clockcurrent_uclk| current uclkcurrent_vclk0| current vclk0current_dclk0| current dclk0current_vclk1| current vclk1current_dclk1| current dclk1throttle_status| current throttle statuscurrent_fan_speed| current fan speedpcie_link_width| pcie link widthpcie_link_speed| pcie link speedpadding| paddinggfx_activity_acc| gfx activity accmem_actvity_acc| mem activity acctemperature_hbm` | hbm temperature

Exceptions that can be thrown by amdsmi_dev_get_gpu_metrics_info function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_get_gpu_metrics_info(dev)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_od_volt_curve_regions#

Description: This function will retrieve the current valid regions in the frequency/voltage space

Input parameters:

• device_handle handle for the given device

• num_regions number of freq volt regions

Output: List containing a dictionary with fields for each freq volt region

Exceptions that can be thrown by amdsmi_dev_get_od_volt_curve_regions function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_get_od_volt_curve_regions(device, 3)
except AmdSmiException as e:
    print(e)

amdsmi_dev_get_power_profile_presets#

Description: Get the list of available preset power profiles and an indication of which profile is currently active

Input parameters:

• device_handle handle for the given device

• sensor_idx number of freq volt regions

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_dev_get_power_profile_presets function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
             amdsmi_dev_get_power_profile_presets(device, 0)
except AmdSmiException as e:
    print(e)

amdsmi_dev_counter_group_supported#

Description: Tell if an event group is supported by a given device

Input parameters:

• device_handle device which to query

• event_group event group being checked for support

Output: None

Exceptions that can be thrown by amdsmi_dev_counter_group_supported function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            amdsmi_dev_counter_group_supported(device, AmdSmiEventGroup.XGMI)
except AmdSmiException as e:
    print(e)

amdsmi_dev_create_counter#

Description: Creates a performance counter object

Input parameters:

• device_handle device which to query

• event_type event group being checked for support

Output: An event handle of the newly created performance counter object

Exceptions that can be thrown by amdsmi_dev_create_counter function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            event_handle = amdsmi_dev_create_counter(device, AmdSmiEventGroup.XGMI)
except AmdSmiException as e:
    print(e)

amdsmi_dev_destroy_counter#

Description: Destroys a performance counter object

Input parameters:

• event_handle event handle of the performance counter object

Output: None

Exceptions that can be thrown by amdsmi_dev_destroy_counter function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            event_handle = amdsmi_dev_create_counter(device, AmdSmiEventGroup.XGMI)
            amdsmi_dev_destroy_counter(event_handle)
except AmdSmiException as e:
    print(e)

amdsmi_control_counter#

Description: Issue performance counter control commands

Input parameters:

• event_handle event handle of the performance counter object

• counter_command command being passed to counter as AmdSmiCounterCommand

Output: None

Exceptions that can be thrown by amdsmi_control_counter function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            event_handle = amdsmi_dev_create_counter(device, AmdSmiEventType.XGMI_1_REQUEST_TX)
            amdsmi_control_counter(event_handle, AmdSmiCounterCommand.CMD_START)
except AmdSmiException as e:
    print(e)

amdsmi_read_counter#

Description: Read the current value of a performance counter

Input parameters:

• event_handle event handle of the performance counter object

Output: Dictionary with fields

Exceptions that can be thrown by amdsmi_read_counter function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException

Example:

try:
    devices = amdsmi_get_device_handles()
    if len(devices) == 0:
        print("No GPUs on machine")
    else:
        for device in devices:
            event_handle = amdsmi_dev_create_counter(device, AmdSmiEventType.XGMI_1_REQUEST_TX)
            amdsmi_read_counter(event_handle)
except AmdSmiException as e:
    print(e)

amdsmi_counter_get_available_counters#

Description: Get the number of currently available counters

Input parameters:

• device_handle handle for the given device

• event_group event group being checked as AmdSmiEventGroup

Output: Number of available counters for the given device of the inputted event group

Exceptions that can be thrown by amdsmi_counter_get_available_counters function:

• AmdSmiLibraryException

• AmdSmiRetryException

• AmdSmiParameterException