-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathGPUmodule.py
executable file
·2741 lines (2482 loc) · 135 KB
/
GPUmodule.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
"""GPUmodules - Classes to represent GPUs and sets of GPUs used in
rickslab-gpu-utils.
Copyright (C) 2019 RicksLab
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
"""
__author__ = 'RicksLab'
__copyright__ = 'Copyright (C) 2019 RicksLab'
__license__ = 'GNU General Public License'
__program_name__ = 'gpu-utils'
__maintainer__ = 'RicksLab'
__docformat__ = 'reStructuredText'
# pylint: disable=multiple-statements
# pylint: disable=line-too-long
# pylint: disable=consider-using-f-string
# pylint: disable=bad-continuation-in-string
# pylint: disable=no-member
import re
import subprocess
from shlex import split as shlex_split
import os
import sys
import logging
from typing import Union, List, Dict, TextIO, IO, Generator, Any, Tuple, Set, Optional
from pathlib import Path
from uuid import uuid4
from glob import glob
from datetime import datetime
from numpy import nan as np_nan
from GPUmodules.env import GUT_CONST
from GPUmodules.GPUKeys import GpuEnum, GpuType, GpuCompatibility, GpuVendor, SensorSet, SensorType, OdMode
from GPUmodules.RegexPatterns import PatternKeys as PK
LOGGER = logging.getLogger('gpu-utils')
PATTERNS = GUT_CONST.PATTERNS
class ObjDict(dict):
""" Allow access of dictionary keys by key name.
"""
# pylint: disable=attribute-defined-outside-init
# pylint: disable=too-many-instance-attributes
def __getattr__(self, name) -> str:
if name in self:
return self[name]
raise AttributeError('No such attribute: {}'.format(name))
def __setattr__(self, name, value) -> None:
self[name] = value
def __delattr__(self, name) -> None:
if name in self:
del self[name]
else:
raise AttributeError('No such attribute: {}'.format(name))
class GpuItem:
""" An object to store GPU details.
"""
# pylint: disable=attribute-defined-outside-init
# pylint: disable=too-many-instance-attributes
mark_up_codes = GUT_CONST.mark_up_codes
_finalized: bool = False
_button_labels: Dict[str, str] = {'loading': 'Load%',
'power': 'Power',
'power_cap': 'PowerCap',
'temp_val': 'Temp',
'vddgfx_val': 'VddGfx',
'sclk_ps_val': 'SCLK Pstate',
'sclk_f_val': 'SCLK',
'mclk_ps_val': 'MCLK Pstate',
'mclk_f_val': 'MCLK'}
_fan_item_list: Set[str] = {'fan_enable', 'fan_target', 'fan_speed', 'fan_speed_range',
'pwm_mode', 'fan_pwm', 'fan_pwm_range'}
_apu_gpus: Set[str] = {'Carrizo', 'Renoir', 'Cezanne', 'Wrestler', 'Llano', 'Ontario', 'Trinity',
'Richland', 'Kabini', 'Kaveri', 'Picasso', 'Bristol Ridge', 'Raven Ridge',
'Hondo', 'Desna', 'Zacate', 'Weatherford', 'Godavari', 'Temash', 'WinterPark',
'BeaverCreek', 'Lucienne', 'Rembrandt', 'Dali', 'Stoney Ridge', 'Pollock',
'Barcelo', 'Beema', 'Mullins'}
# List of parameters for non-compatible AMD GPUs.
short_list: Set[str] = {'vendor', 'pp_features', 'readable', 'writable', 'compute', 'card_num', 'id',
'model_device_decode', 'gpu_type', 'card_path', 'sys_card_path', 'hwmon_path', 'pcie_id'}
GPU_NC_Param_List: Set[str] = {*short_list, 'model', 'driver', 'model_device_decode'}
# Define table parameters labels.
table_parameters: List[str] = ['model_display', 'loading', 'mem_loading', 'mem_vram_usage', 'mem_gtt_usage',
'power', 'power_cap', 'energy', 'temp_val', 'vddgfx_val',
'fan_pwm', 'sclk_f_val', 'sclk_ps_val', 'mclk_f_val', 'mclk_ps_val', 'ppm']
short_table_parameters: List[str] = ['model_display', 'power', 'energy', 'temp_val', 'vddgfx_val',
'sclk_f_val', 'sclk_ps_val', 'mclk_f_val', 'mclk_ps_val', 'ppm']
table_param_labels: Dict[str, str] = {
'model_display': 'Model',
'loading': 'GPU Load %',
'mem_loading': 'Mem Load %',
'mem_vram_usage': 'VRAM Usage %',
'mem_gtt_usage': 'GTT Usage %',
'power': 'Power (W)',
'power_cap': 'Power Cap (W)',
'energy': 'Energy (kWh)',
'temp_val': 'T (C)',
'vddgfx_val': 'VddGFX (mV)',
'fan_pwm': 'Fan Spd (%)',
'sclk_f_val': 'Sclk (MHz)',
'sclk_ps_val': 'Sclk Pstate',
'mclk_f_val': 'Mclk (MHz)',
'mclk_ps_val': 'Mclk Pstate',
'ppm': 'Perf Mode'}
# Complete GPU print items, use skip lists where appropriate.
_GPU_CLINFO_Labels: Dict[str, str] = {
'opencl_version': ' Device OpenCL C Version',
'device_name': ' Device Name',
'device_version': ' Device Version',
'driver_version': ' Driver Version',
'max_cu': ' Max Compute Units',
'simd_per_cu': ' SIMD per CU',
'simd_width': ' SIMD Width',
'simd_ins_width': ' SIMD Instruction Width',
'max_mem_allocation': ' CL Max Memory Allocation',
'max_wi_dim': ' Max Work Item Dimensions',
'max_wi_sizes': ' Max Work Item Sizes',
'max_wg_size': ' Max Work Group Size',
'prf_wg_size': ' Preferred Work Group Size',
'prf_wg_multiple': ' Preferred Work Group Multiple'}
_GPU_Param_Labels: Dict[str, str] = {
'card_num': 'Card Number',
'vendor': 'Vendor',
'pp_features': 'PP Features',
'readable': 'Readable',
'writable': 'Writable',
'compute': 'Compute',
'unique_id': 'GPU UID',
'serial_number': 'GPU S/N',
'id': 'Device ID',
'model_device_decode': 'Decoded Device ID',
'model': 'Card Model',
'model_display': 'Display Card Model',
'card_index': 'Card Index',
'pcie_id': 'PCIe ID',
'link_spd': ' Link Speed',
'link_wth': ' Link Width',
'sep1': '#',
'driver': 'Driver',
'vbios': 'vBIOS Version',
'compute_platform': 'Compute Platform',
'compute_mode': 'Compute Mode',
'gpu_type': 'GPU Type',
'hwmon_path': 'HWmon',
'card_path': 'Card Path',
'sys_card_path': 'System Card Path',
'sep2': '#',
'power': 'Current Power (W)',
'power_cap': 'Power Cap (W)',
'power_cap_range': ' Power Cap Range (W)',
'fan_enable': 'Fan Enable',
'pwm_mode': 'Fan PWM Mode',
'fan_target': 'Fan Target Speed (rpm)',
'fan_speed': 'Current Fan Speed (rpm)',
'fan_pwm': 'Current Fan PWM (%)',
'fan_speed_range': ' Fan Speed Range (rpm)',
'fan_pwm_range': ' Fan PWM Range (%)',
'sep3': '#',
'loading': 'Current GPU Loading (%)',
'mem_loading': 'Current Memory Loading (%)',
'mem_gtt_usage': 'Current GTT Memory Usage (%)',
'mem_gtt_used': ' Current GTT Memory Used (GB)',
'mem_gtt_total': ' Total GTT Memory (GB)',
'mem_vram_usage': 'Current VRAM Usage (%)',
'mem_vram_used': ' Current VRAM Used (GB)',
'mem_vram_total': ' Total VRAM (GB)',
'temperatures': 'Current Temps (C)',
'temp_crits': 'Critical Temps (C)',
'voltages': 'Current Voltages (V)',
'vddc_range': ' Vddc Range',
'vddgfx_offset': ' Vddgfx Offset (mV)',
'vddgfx_offset_range': ' Vddgfx Offset Range (mV)',
'frequencies': 'Current Clk Frequencies (MHz)',
'frequencies_max': 'Maximum Clk Frequencies (MHz)',
'sclk_ps': 'Current SCLK P-State',
'sclk_f_range': ' SCLK Range',
'mclk_ps': 'Current MCLK P-State',
'mclk_f_range': ' MCLK Range',
'ppm': 'Power Profile Mode',
'power_dpm_state': 'Power DPM State',
'power_dpm_force': 'Power DPM Force Performance Level'}
# Skip list initialization
_unsupported_skip_list: Set = set(_GPU_Param_Labels) - GPU_NC_Param_List
# AMD Type skip lists.
amd_type_skip_lists: Dict[GpuType, Set] = {}
for amd_gpu_type in GpuType:
amd_type_skip_lists.update({amd_gpu_type: set()})
amd_type_skip_lists[GpuType.Undefined] = _unsupported_skip_list
amd_type_skip_lists[GpuType.Unsupported] = _unsupported_skip_list
amd_type_skip_lists[GpuType.Offset] = {'vddc_range'}
amd_type_skip_lists[GpuType.CurvePts] = {'vddgfx_offset', 'vddgfx_offset_range'}
amd_type_skip_lists[GpuType.PStatesNE] = {'vddc_range', 'sclk_f_range', 'mclk_f_range', 'vddgfx_offset',
'vddgfx_offset_range'}
amd_type_skip_lists[GpuType.PStates] = {'vddgfx_offset', 'vddgfx_offset_range'}
amd_type_skip_lists[GpuType.Legacy] = {'vbios', 'loading', 'mem_loading', 'sclk_ps', 'mclk_ps', 'ppm', 'power',
'power_cap', 'power_cap_range', 'mem_vram_total', 'mem_vram_used',
'mem_gtt_total', 'mem_gtt_used', 'mem_vram_usage', 'mem_gtt_usage',
'fan_speed_range', 'fan_enable', 'fan_target', 'fan_speed', 'vddc_range',
'frequencies', 'sclk_f_range', 'mclk_f_range', 'vddgfx_offset',
'vddgfx_offset_range'}
amd_type_skip_lists[GpuType.LegacyAPU] = {'unique_id', 'vbios', 'loading', 'sclk_ps', 'mclk_ps', 'ppm',
'vddc_range', 'mem_vram_total', 'mem_gtt_total', 'mem_vram_used',
'mem_gtt_used', 'power_cap_range', 'power', 'power_cap', 'vddgfx_offset',
'vddgfx_offset_range', *_fan_item_list}
amd_type_skip_lists[GpuType.APU] = {'unique_id', 'loading', 'ppm', 'pwm_mode', 'fan_pwm', 'vddc_range',
'power_cap_range', 'power_cap', 'vddgfx_offset', 'vddgfx_offset_range',
*_fan_item_list}
# Vendor specific skip lists.
vendor_skip_lists: Dict[GpuVendor, Set] = {}
for vendor in GpuVendor:
vendor_skip_lists.update({vendor: set()})
vendor_skip_lists[GpuVendor.ASPEED] = _unsupported_skip_list
vendor_skip_lists[GpuVendor.MATROX] = _unsupported_skip_list
vendor_skip_lists[GpuVendor.AMD] = {'frequencies_max', 'compute_mode', 'serial_number', 'card_index'}
vendor_skip_lists[GpuVendor.NVIDIA] = {'fan_enable', 'fan_speed', 'fan_pwm_range', 'fan_speed_range', 'pwm_mode',
'mem_gtt_total', 'mem_gtt_used', 'mem_gtt_usage', 'pp_features',
'mclk_ps', 'mclk_f_range', 'sclk_f_range', 'vddc_range', 'power_dpm_force',
'temp_crits', 'voltages', 'vddgfx_offset'}
# GPU sensor reading details
sensor_sets = {SensorSet.Static: {'HWMON': ['power_cap_range', 'temp_crits',
'fan_speed_range', 'fan_pwm_range']},
SensorSet.Dynamic: {'HWMON': ['power', 'power_cap', 'temperatures', 'voltages',
'frequencies', 'fan_enable', 'fan_target',
'fan_speed', 'pwm_mode', 'fan_pwm']},
SensorSet.Info: {'DEVICE': ['unique_id', 'vbios', 'mem_vram_total', 'mem_gtt_total']},
SensorSet.State: {'DEVICE': ['loading', 'mem_loading', 'mem_gtt_used', 'mem_vram_used',
'link_spd', 'link_wth', 'sclk_ps', 'mclk_ps', 'ppm',
'power_dpm_force', 'power_dpm_state']},
SensorSet.Monitor: {'HWMON': ['power', 'power_cap', 'temperatures', 'voltages',
'frequencies', 'fan_pwm'],
'DEVICE': ['loading', 'mem_loading', 'mem_gtt_used', 'mem_vram_used',
'sclk_ps', 'mclk_ps', 'ppm']},
SensorSet.All: {'DEVICE': ['unique_id', 'vbios', 'loading', 'mem_loading',
'link_spd', 'link_wth', 'sclk_ps', 'mclk_ps', 'pstates',
'ppm', 'power_dpm_force', 'power_dpm_state',
'mem_vram_total', 'mem_gtt_total',
'mem_vram_used', 'mem_gtt_used'],
'HWMON': ['power_cap_range', 'temp_crits', 'power', 'power_cap',
'temperatures', 'voltages', 'frequencies',
'fan_speed_range', 'fan_pwm_range', 'fan_enable', 'fan_target',
'fan_speed', 'pwm_mode', 'fan_pwm']}}
_gbcf: float = 1.0/(1024*1024*1024)
_sensor_details = {GpuVendor.AMD: {
'HWMON': {
'power': {'type': SensorType.SingleParam,
'cf': 0.000001, 'sensor': ('power1_average', )},
'power_cap': {'type': SensorType.SingleParam,
'cf': 0.000001, 'sensor': ('power1_cap', )},
'power_cap_range': {'type': SensorType.MinMax,
'cf': 0.000001, 'sensor': ('power1_cap_min', 'power1_cap_max')},
'fan_enable': {'type': SensorType.SingleParam,
'cf': 1, 'sensor': ('fan1_enable', )},
'fan_target': {'type': SensorType.SingleParam,
'cf': 1, 'sensor': ('fan1_target', )},
'fan_speed': {'type': SensorType.SingleParam,
'cf': 1, 'sensor': ('fan1_input', )},
'fan_speed_range': {'type': SensorType.MinMax,
'cf': 1, 'sensor': ('fan1_min', 'fan1_max')},
'pwm_mode': {'type': SensorType.SingleParam,
'cf': 1, 'sensor': ('pwm1_enable', )},
'fan_pwm': {'type': SensorType.SingleParam,
'cf': 0.39216, 'sensor': ('pwm1', )},
'fan_pwm_range': {'type': SensorType.MinMax,
'cf': 0.39216, 'sensor': ('pwm1_min', 'pwm1_max')},
'temp_crits': {'type': SensorType.InputLabelX,
'cf': 0.001, 'sensor': ('temp*_crit', )},
'frequencies': {'type': SensorType.InputLabelX,
'cf': 0.000001, 'sensor': ('freq*_input', )},
'voltages': {'type': SensorType.InputLabelX,
'cf': 1, 'sensor': ('in*_input', )},
'temperatures': {'type': SensorType.InputLabelX,
'cf': 0.001, 'sensor': ('temp*_input', )},
'vddgfx': {'type': SensorType.InputLabelX,
'cf': 0.001, 'sensor': ('in*_input', )}},
'DEVICE': {
'id': {'type': SensorType.MLMS,
'cf': None, 'sensor': ('vendor', 'device',
'subsystem_vendor', 'subsystem_device')},
'unique_id': {'type': SensorType.SingleString,
'cf': None, 'sensor': ('unique_id', )},
'loading': {'type': SensorType.SingleParam,
'cf': 1, 'sensor': ('gpu_busy_percent', )},
'mem_loading': {'type': SensorType.SingleParam,
'cf': 1, 'sensor': ('mem_busy_percent', )},
'mem_vram_total': {'type': SensorType.SingleParam,
'cf': _gbcf, 'sensor': ('mem_info_vram_total', )},
'mem_vram_used': {'type': SensorType.SingleParam,
'cf': _gbcf, 'sensor': ('mem_info_vram_used', )},
'mem_gtt_total': {'type': SensorType.SingleParam,
'cf': _gbcf, 'sensor': ('mem_info_gtt_total', )},
'mem_gtt_used': {'type': SensorType.SingleParam,
'cf': _gbcf, 'sensor': ('mem_info_gtt_used', )},
'link_spd': {'type': SensorType.SingleString,
'cf': None, 'sensor': ('current_link_speed', )},
'link_wth': {'type': SensorType.SingleString,
'cf': None, 'sensor': ('current_link_width', )},
'sclk_ps': {'type': SensorType.MLSS,
'cf': None, 'sensor': ('pp_dpm_sclk', )},
'mclk_ps': {'type': SensorType.MLSS,
'cf': None, 'sensor': ('pp_dpm_mclk', )},
'pstates': {'type': SensorType.AllPStates,
'cf': None, 'sensor': ('pp_dpm_*clk', )},
'power_dpm_state': {'type': SensorType.SingleString,
'cf': None,
'sensor': ('power_dpm_state', )},
'power_dpm_force': {'type': SensorType.SingleString,
'cf': None,
'sensor': ('power_dpm_force_performance_level', )},
'ppm': {'type': SensorType.SingleStringSelect,
'cf': None, 'sensor': ('pp_power_profile_mode', )},
'vbios': {'type': SensorType.SingleString,
'cf': None, 'sensor': ('vbios_version', )}}},
GpuVendor.PCIE: {
'DEVICE': {
'id': {'type': SensorType.MLMS,
'cf': None, 'sensor': ('vendor', 'device',
'subsystem_vendor',
'subsystem_device')}}}}
nv_query_items = {SensorSet.Static: {
'power_cap': ('power.limit', ),
'power_cap_range': ('power.min_limit', 'power.max_limit'),
'mem_vram_total': ('memory.total', ),
'frequencies_max': ('clocks.max.gr', 'clocks.max.sm', 'clocks.max.mem'),
'vbios': ('vbios_version', ),
'compute_mode': ('compute_mode', ),
'driver': ('driver_version', ),
'model': ('name', ),
'serial_number': ('serial', ),
'card_index': ('index', ),
'unique_id': ('gpu_uuid', )},
SensorSet.Dynamic: {
'power': ('power.draw', ),
'temperatures': ('temperature.gpu', 'temperature.memory'),
'frequencies': ('clocks.gr', 'clocks.sm', 'clocks.mem', 'clocks.video'),
'loading': ('utilization.gpu', ),
'mem_loading': ('utilization.memory', ),
'mem_vram_used': ('memory.used', ),
'fan_speed': ('fan.speed', ),
'ppm': ('gom.current', ),
'link_wth': ('pcie.link.width.current', ),
'link_spd': ('pcie.link.gen.current', ),
'pstates': ('pstate', )},
SensorSet.Monitor: {
'power': ('power.draw', ),
'power_cap': ('power.limit', ),
'temperatures': ('temperature.gpu', ),
'frequencies': ('clocks.gr', 'clocks.mem'),
'loading': ('utilization.gpu', ),
'mem_loading': ('utilization.memory', ),
'mem_vram_used': ('memory.used', ),
'fan_speed': ('fan.speed', ),
'ppm': ('gom.current', ),
'pstates': ('pstate', )},
SensorSet.All: {
'power_cap': ('power.limit', ),
'power_cap_range': ('power.min_limit', 'power.max_limit'),
'mem_vram_total': ('memory.total', ),
'vbios': ('vbios_version', ),
'driver': ('driver_version', ),
'compute_mode': ('compute_mode', ),
'model': ('name', ),
'serial_number': ('serial', ),
'card_index': ('index', ),
'unique_id': ('gpu_uuid', ),
'power': ('power.draw', ),
'temperatures': ('temperature.gpu', 'temperature.memory'),
'frequencies': ('clocks.gr', 'clocks.sm', 'clocks.mem', 'clocks.video'),
'frequencies_max': ('clocks.max.gr', 'clocks.max.sm', 'clocks.max.mem'),
'loading': ('utilization.gpu', ),
'mem_loading': ('utilization.memory', ),
'mem_vram_used': ('memory.used', ),
'fan_speed': ('fan.speed', ),
'ppm': ('gom.current', ),
'link_wth': ('pcie.link.width.current', ),
'link_spd': ('pcie.link.gen.current', ),
'pstates': ('pstate', )}}
pp_od_clk_voltage_headers = ['OD_SCLK', 'OD_MCLK', 'OD_VDDC_CURVE', 'OD_RANGE', 'OD_VDDGFX_OFFSET']
def __repr__(self) -> str:
""" Return dictionary representing all parts of the GpuItem object.
:return: Dictionary of core GPU parameters.
"""
return str({'params': self.prm, 'clinfo': self.clinfo,
'sclk_state': self.sclk_state, 'mclk_state': self.mclk_state,
'vddc_curve': self.vddc_curve, 'vddc_curve_range': self.vddc_curve_range,
'ppm_modes': self.ppm_modes})
def __str__(self) -> str:
""" Return simple string representing the GpuItem object.
:return: GPU_item informational string
"""
return 'GPU_Item: uuid={}'.format(self.prm.uuid)
def __init__(self, item_id: str):
""" Initialize GpuItem object.
:param item_id: UUID of the new item.
"""
time_0 = GUT_CONST.now(GUT_CONST.useltz)
self.validated_sensors: bool = False
self.read_time = GUT_CONST.now(GUT_CONST.useltz)
self.energy: Dict[str, Any] = {'t0': time_0, 'tn': time_0, 'cumulative': 0.0}
self.read_skip: tuple = () # List of parameters that are to be skipped.
self.read_disabled: List[str] = [] # List of parameters that failed during read.
self.write_disabled: List[str] = [] # List of parameters that failed during write.
self.prm: ObjDict = ObjDict({
'uuid': item_id,
'unique_id': '',
'card_num': None,
'pcie_id': '',
'driver': '',
'vendor': GpuVendor.Undefined,
'pp_features': '',
'readable': False,
'writable': False,
'compute': 'Unkown',
'compute_platform': None,
'compute_mode': None,
'gpu_type': GpuType.Undefined,
'id': {'vendor': '', 'device': '', 'subsystem_vendor': '', 'subsystem_device': ''},
'model_device_decode': 'UNDETERMINED',
'model': '',
'model_display': '',
'serial_number': '',
'card_index': '',
'card_path': '',
'sys_card_path': '',
'hwmon_path': '',
'energy': 0.0,
'power': None,
'power_cap': None,
'power_cap_range': [None, None],
'fan_enable': None,
'pwm_mode': [None, 'UNK'],
'fan_pwm': None,
'fan_speed': None,
'fan_speed_range': [None, None],
'fan_pwm_range': [None, None],
'fan_target': None,
'temp_crits': None,
'vddgfx_offset': 0,
'vddgfx_offset_range': [-25, 25],
'vddgfx': None,
'vddc_range': ['', ''],
'temperatures': None,
'voltages': None,
'frequencies': None,
'frequencies_max': None,
'loading': None,
'mem_loading': None,
'mem_vram_total': None,
'mem_vram_used': None,
'mem_vram_usage': None,
'mem_gtt_total': None,
'mem_gtt_used': None,
'mem_gtt_usage': None,
'pstate': None,
'mclk_ps': ['', ''],
'mclk_f_range': ['', ''],
'mclk_mask': '',
'sclk_ps': ['', ''],
'sclk_f_range': ['', ''],
'sclk_mask': '',
'link_spd': '',
'link_wth': '',
'ppm': '',
'power_dpm_state': '',
'power_dpm_force': '',
'vbios': ''})
self.clinfo: ObjDict = ObjDict({
'device_name': '',
'device_version': '',
'driver_version': '',
'opencl_version': '',
'pcie_id': '',
'max_cu': '',
'simd_per_cu': '',
'simd_width': '',
'simd_ins_width': '',
'max_mem_allocation': '',
'max_wi_dim': '',
'max_wi_sizes': '',
'max_wg_size': '',
'prf_wg_size': '',
'prf_wg_multiple': ''})
self.all_pstates: Dict[str, Dict[int, dict]] = {} # 'CLK': {N: {'value': 'MHz', 'state': bool}}
self.sclk_dpm_state: Dict[int, str] = {} # {1: 'Mhz'}
self.mclk_dpm_state: Dict[int, str] = {} # {1: 'Mhz'}
self.sclk_state: Dict[int, List[str]] = {} # {1: ['Mhz', 'mV']}
self.mclk_state: Dict[int, List[str]] = {} # {1: ['Mhz', 'mV']}
self.vddc_curve: Dict[int, List[str]] = {} # {1: ['Mhz', 'mV']}
self.vddc_curve_range: Dict[int, dict] = {} # {1: {'SCLK': ['val1', 'val2'], 'VOLT': ['val1', 'val2']}
self.ppm_modes: Dict[str, List[str]] = {} # {'1': ['Name', 'Description']}
self.raw: Dict[str, dict] = {'DEVICE': {}, 'HWMON': {}}
self.table_parameters_status: Dict[str, bool] = {}
for item in self.table_parameters:
self.table_parameters_status.update({item: True})
self.finalize_fan_option()
@classmethod
def finalize_fan_option(cls) -> None:
""" Finalize class variables of gpu parameters based on command line options. This must be
done after setting of env. Doing it at the instantiation of a GpuItem assures that.
"""
if cls._finalized: return
cls._finalized = True
if not GUT_CONST.show_fans:
for fan_item in cls._fan_item_list:
# Remove fan params from GPU_Param_Labels
if fan_item in cls._GPU_Param_Labels:
del cls._GPU_Param_Labels[fan_item]
# Remove fan params from Table_Param_Labels
if fan_item in cls.table_param_labels:
del cls.table_param_labels[fan_item]
# Remove fan params from SensorSets
for sensor_set in (SensorSet.Static, SensorSet.Dynamic, SensorSet.Monitor, SensorSet.All):
if fan_item in cls.sensor_sets[sensor_set]['HWMON']:
try:
cls.sensor_sets[sensor_set]['HWMON'].remove(fan_item)
except ValueError: pass
# Remove fan params from table param list
if fan_item in cls.table_parameters:
try:
cls.short_table_parameters.remove(fan_item)
cls.table_parameters.remove(fan_item)
except ValueError: pass
@classmethod
def is_apu(cls, name: str) -> bool:
""" Check if given GPU name is an APU.
:param name: Target GPU name
:return: True if name matches APU name
"""
if not name: return False
for apu_name in cls._apu_gpus:
if re.search(apu_name, name, re.IGNORECASE):
return True
return False
@classmethod
def get_button_label(cls, name: str) -> str:
""" Return button label for given parameter name.
:param name: Parameter name
:return: Button label
"""
if name not in cls._button_labels:
raise KeyError('{} not in button_label dict'.format(name))
return cls._button_labels[name]
def set_params_value(self, name: str, value: Union[int, float, str, list, None]) -> None:
""" Set parameter value for give name.
:param name: Parameter name
:param value: parameter value
"""
self.read_time = GUT_CONST.now(GUT_CONST.useltz)
LOGGER.debug('Set param value: [%s], type: [%s]', value, type(value))
if isinstance(value, tuple):
self.prm[name] = list(value)
elif name == 'pwm_mode':
self.prm[name][0] = value
if value == 0: self.prm[name][1] = 'None'
elif value == 1: self.prm[name][1] = 'Manual'
else: self.prm[name][1] = 'Dynamic'
elif name == 'ppm':
self.prm[name] = re.sub(PATTERNS[PK.PPM_CHK], '', value).strip()
self.prm[name] = re.sub(PATTERNS[PK.PPM_NOTCHK], '-', self.prm[name])
elif name == 'power':
if isinstance(value, (int, float)):
time_n = GUT_CONST.now(GUT_CONST.useltz)
self.prm[name] = value
delta_hrs = ((time_n - self.energy['tn']).total_seconds()) / 3600
self.energy['tn'] = time_n
self.energy['cumulative'] += delta_hrs * value / 1000
self.prm['energy'] = round(self.energy['cumulative'], 6)
else:
GUT_CONST.process_message('Error: Invalid power value read [{}]'.format(value), log_flag=True)
self.disable_param_read('power')
self.disable_param_read('energy')
elif name == 'sclk_ps':
mask = ''
ps_key = 'NA'
for ps_val in value:
if not mask:
mask = ps_val.split(':')[0].strip()
else:
mask += ',' + ps_val.split(':')[0].strip()
sclk_ps = ps_val.strip('*').strip().split(': ')
if len(sclk_ps) < 2:
LOGGER.debug('sclk_ps value error: [%s]', sclk_ps)
else:
if sclk_ps[0].isnumeric():
ps_key = int(sclk_ps[0])
self.sclk_dpm_state.update({ps_key: sclk_ps[1]})
if '*' in ps_val:
self.prm.sclk_ps[0] = ps_key
self.prm.sclk_ps[1] = sclk_ps[1]
self.prm.sclk_mask = mask
LOGGER.debug('Mask: [%s], ps: [%s, %s]', mask, self.prm.sclk_ps[0], self.prm.sclk_ps[1])
elif name == 'mclk_ps':
mask = ''
ps_key = 'NA'
for ps_val in value:
if not mask:
mask = ps_val.split(':')[0].strip()
else:
mask += ',' + ps_val.split(':')[0].strip()
mclk_ps = ps_val.strip('*').strip().split(': ')
if len(mclk_ps) < 2:
LOGGER.debug('mclk_ps value error: [%s]', mclk_ps)
else:
if mclk_ps[0].isnumeric():
ps_key = int(mclk_ps[0])
self.mclk_dpm_state.update({ps_key: mclk_ps[1]})
if '*' in ps_val:
self.prm.mclk_ps[0] = ps_key
self.prm.mclk_ps[1] = mclk_ps[1]
self.prm.mclk_mask = mask
LOGGER.debug('Mask: [%s], ps: [%s, %s]', mask, self.prm.mclk_ps[0], self.prm.mclk_ps[1])
elif name == 'fan_pwm':
if isinstance(value, int):
self.prm.fan_pwm = value
elif isinstance(value, float):
self.prm.fan_pwm = int(value)
elif isinstance(value, str):
self.prm.fan_pwm = int(value) if value.isnumeric() else None
else:
self.prm.fan_pwm = None
elif re.fullmatch(PATTERNS[PK.GPUMEMTYPE], name):
self.prm[name] = value
self.set_memory_usage()
elif name == 'id':
self.prm.id = dict(zip(('vendor', 'device', 'subsystem_vendor', 'subsystem_device'), list(value)))
self.prm.model_device_decode = self.read_pciid_model()
self.prm.model_display = self.fit_display_name(self.prm.model_device_decode)
else:
self.prm[name] = value
@staticmethod
def fit_display_name(name: str, length: int = GUT_CONST.mon_field_width) -> str:
""" Convert the given name to a display name which is optimally simplified and truncated.
:param name: The GPU name to be converted.
:param length: The target length, default is the monitor field width.
:return: Simplified and truncated string
"""
fit_name = ''
model_display_components = re.sub(PATTERNS[PK.GPU_GENERIC], '', name).split()
for name_component in model_display_components:
if len(name_component) + len(fit_name) + 1 > length:
break
fit_name = re.sub(r'\s*/\s*', '/', '{} {}'.format(fit_name, name_component))
return fit_name
def param_is_active(self, parameter_name: str) -> bool:
""" Return True if given parameter is not skipped and not disabled.
:param parameter_name:
:return:
"""
if parameter_name in self.read_disabled: return False
if parameter_name in self.read_skip: return False
return True
def disable_param_read(self, parameter_name: Union[Tuple[str, ...], str, None]) -> None:
""" Disable further reading of the specified parameter.
:param parameter_name: A single parameter name to be disabled.
:return:
"""
if isinstance(parameter_name, str): parameter_name = (parameter_name, )
for target_param in parameter_name:
if self.param_is_active(target_param):
message = 'Warning: Can not read parameter: {}, ' \
'disabling for this GPU: {}'.format(target_param, self.prm.card_num)
GUT_CONST.process_message(message, log_flag=True)
self.read_disabled.append(target_param)
def get_params_value(self, name: str, num_as_int: bool = False) -> Optional[Union[dict, int, float, str, list, GpuEnum, datetime]]:
""" Get parameter value for given name.
:param name: Parameter name
:param num_as_int: Convert float to int if True
:return: Parameter value
"""
if name == 'read_time':
if self.param_is_active('energy') and self.param_is_active('power'):
return self.energy['tn']
return self.read_time
# Parameters with '_val' as a suffix are derived from a direct source.
if re.fullmatch(PATTERNS[PK.VAL_ITEM], name):
if name == 'temp_val':
if not self.prm['temperatures']:
return None
for temp_name in ('edge', 'temperature.gpu', 'temp1_input'):
if temp_name in self.prm['temperatures']:
if self.prm['temperatures'][temp_name]:
if num_as_int:
return int(self.prm['temperatures'][temp_name])
return round(self.prm['temperatures'][temp_name], 1)
for value in self.prm['temperatures'].values():
return value
return None
if name == 'vddgfx_val':
if not self.prm['voltages']:
return np_nan
if 'vddgfx' in self.prm['voltages']:
if isinstance(self.prm['voltages']['vddgfx'], str):
return int(self.prm['voltages']['vddgfx'])
for value in self.prm['voltages'].values():
return value
if name == 'sclk_ps_val':
return self.prm['sclk_ps'][0]
if name == 'sclk_f_val':
if self.prm['frequencies']:
for clock_name in ('sclk', 'clocks.gr'):
if clock_name in self.prm['frequencies']:
if isinstance(self.prm['frequencies'][clock_name], str) and\
self.prm['frequencies'][clock_name].isnumeric():
return int(self.prm['frequencies'][clock_name])
if self.prm['sclk_ps'][1]:
return self.prm['sclk_ps'][1]
if self.prm['frequencies']:
for value in self.prm['frequencies'].values():
return value
return None
if name == 'mclk_ps_val':
return self.prm['mclk_ps'][0]
if name == 'mclk_f_val':
if self.prm['frequencies']:
for clock_name in ('mclk', 'clocks.mem'):
if clock_name in self.prm['frequencies']:
if isinstance(self.prm['frequencies'][clock_name], str) and\
self.prm['frequencies'][clock_name].isnumeric():
return int(self.prm['frequencies'][clock_name])
if self.prm['mclk_ps'][1]:
return self.prm['mclk_ps'][1]
return None
# Set type for params that could be float or int
if name in {'fan_pwm', 'fan_speed', 'power_cap', 'power', 'vddgfx_offset'}:
if num_as_int:
if isinstance(self.prm[name], int):
return self.prm[name]
if isinstance(self.prm[name], float):
return int(self.prm[name])
if isinstance(self.prm[name], str):
return int(self.prm[name]) if self.prm[name].isnumeric() else None
return None
if name in self.prm:
return self.prm[name]
return None
def set_memory_usage(self) -> None:
"""
Set system and vram memory usage percentage.
"""
if self.prm.mem_gtt_used is None or self.prm.mem_gtt_total is None:
self.prm.mem_gtt_usage = None
else:
self.prm.mem_gtt_usage = 100.0 * self.prm.mem_gtt_used / self.prm.mem_gtt_total
if self.prm.mem_vram_used is None or self.prm.mem_vram_total is None:
self.prm.mem_vram_usage = None
else:
self.prm.mem_vram_usage = 100.0 * self.prm.mem_vram_used / self.prm.mem_vram_total
def read_pciid_model(self) -> str:
"""
Read the model name from the system pcid.ids file
:return: GPU model name
"""
if not GUT_CONST.sys_pciid:
message = 'Error: pciid file not defined'
GUT_CONST.process_message(message, log_flag=True)
return ''
if not os.path.isfile(GUT_CONST.sys_pciid):
message = 'Error: Can not access system pci.ids file [{}]'.format(GUT_CONST.sys_pciid)
GUT_CONST.process_message(message, log_flag=True)
return ''
with open(GUT_CONST.sys_pciid, 'r', encoding='utf8') as pci_id_file_ptr:
model_str = ''
level = 0
for line_item in pci_id_file_ptr:
line = line_item.rstrip()
if len(line) < 4:
continue
if line[0] == '#':
continue
if level == 0:
if re.fullmatch(PATTERNS[PK.PCIIID_L0], line):
if line[:4] == self.prm.id['vendor'].replace('0x', ''):
level += 1
continue
elif level == 1:
if re.fullmatch(PATTERNS[PK.PCIIID_L0], line):
break
if re.fullmatch(PATTERNS[PK.PCIIID_L1], line):
if line[1:5] == self.prm.id['device'].replace('0x', ''):
model_str = line[5:]
level += 1
continue
elif level == 2:
if re.fullmatch(PATTERNS[PK.PCIIID_L0], line):
break
if re.fullmatch(PATTERNS[PK.PCIIID_L1], line):
break
if re.fullmatch(PATTERNS[PK.PCIIID_L2], line):
if line[2:6] == self.prm.id['subsystem_vendor'].replace('0x', ''):
if line[7:11] == self.prm.id['subsystem_device'].replace('0x', ''):
model_str = line[11:]
break
return model_str.strip()
def populate_prm_from_dict(self, params: Dict[str, any]) -> None:
"""
Populate elements of a GpuItem with items from a dict with keys that align to elements of GpuItem.
:param params: A dictionary of parameters with keys that align to GpuItem elements.
"""
LOGGER.debug('prm dict:\n%s', params)
set_ocl_ver = None
for source_name, source_value in params.items():
# Set primary parameter
if source_name not in self.prm:
raise KeyError('Populate dict contains unmatched key: {}'.format(source_name))
self.prm[source_name] = source_value
# Set secondary parameters
if source_name == 'card_path' and source_value:
card_num_str = source_value.replace('{}card'.format(GUT_CONST.card_root), '').replace('/device', '')
self.prm.card_num = int(card_num_str) if card_num_str.isnumeric() else None
elif source_name == 'compute_platform':
set_ocl_ver = source_value
elif source_name == 'gpu_type' and source_value:
self.prm.gpu_type = source_value
try:
self.read_skip = self.amd_type_skip_lists[self.prm.gpu_type]
except KeyError:
pass
# Compute platform requires that compute bool be set first
if set_ocl_ver:
self.prm.compute_platform = set_ocl_ver if self.prm.compute else 'None'
def set_clinfo_values(self, ocl_dict: Dict[str, Union[int, str, list]]) -> None:
""" Set clinfo values in GPU item dictionary.
:param ocl_dict: dictionary of opencl name and values.
"""
for ocl_name, ocl_val in ocl_dict.items():
if ocl_name in self.clinfo:
self.clinfo[ocl_name] = ocl_val
def get_clinfo_value(self, name: str) -> Union[int, str, list, None]:
""" Get clinfo parameter value for give name.
:param name: clinfo Parameter name
:return: clinfo Parameter value
"""
try:
return self.clinfo[name]
except KeyError:
return None
def is_valid_power_cap(self, power_cap: int) -> bool:
"""
Check if a given power_cap value is valid.
:param power_cap: Target power cap value to be tested.
:return: True if valid
"""
power_cap_range = self.prm.power_cap_range
if power_cap_range[0] <= power_cap <= power_cap_range[1]:
return True
if power_cap < 0:
# negative values will be interpreted as reset request
return True
return False
def is_valid_fan_pwm(self, pwm_value: int) -> bool:
""" Check if a given fan_pwm value is valid.
:param pwm_value: Target fan_pwm value to be tested.
:return: True if valid
"""
pwm_range = self.prm.fan_pwm_range
if pwm_range[0] <= pwm_value <= pwm_range[1]:
return True
if pwm_value < 0:
# negative values will be interpreted as reset request
return True
return False
def is_valid_mclk_pstate(self, pstate: List[int]) -> bool:
""" Check if given mclk pstate value is valid.
:param pstate: pstate = [pstate_number, clk_value, vddc_value]
:return: Return True if valid
"""
mclk_range = self.prm.mclk_f_range
try:
mclk_min = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(mclk_range[0])))
mclk_max = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(mclk_range[1])))
except TypeError:
return False
if pstate[1] < mclk_min or pstate[1] > mclk_max:
return False
if self.prm.gpu_type in (GpuType.PStatesNE, GpuType.PStates):
try:
vddc_min = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(self.prm.vddc_range[0])))
vddc_max = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(self.prm.vddc_range[1])))
except TypeError:
return False
if pstate[2] < vddc_min or pstate[2] > vddc_max:
return False
return True
def is_valid_sclk_pstate(self, pstate: List[int]) -> bool:
""" Check if given sclk pstate value is valid.
:param pstate: pstate = [pstate_number, clk_value, vddc_value]
:return: Return True if valid
"""
sclk_range = self.prm.sclk_f_range
sclk_min = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(sclk_range[0])))
sclk_max = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(sclk_range[1])))
if pstate[1] < sclk_min or pstate[1] > sclk_max:
return False
if self.prm.gpu_type in {GpuType.PStatesNE, GpuType.PStates}:
try:
vddc_min = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(self.prm.vddc_range[0])))
vddc_max = int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', str(self.prm.vddc_range[1])))
except TypeError:
return False
print('{}:{} {}:{}'.format(pstate[2], vddc_min, pstate[2], vddc_max))
if pstate[2] < vddc_min or pstate[2] > vddc_max:
return False
return True
def is_changed_sclk_pstate(self, pstate: List[int]) -> bool:
""" Check if given sclk pstate value different from current.
:param pstate: pstate = [pstate_number, clk_value, vddc_value]
:return: Return True if changed
"""
if int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', self.sclk_state[pstate[0]][0])) != pstate[1]:
return True
if self.prm.gpu_type in (GpuType.PStatesNE, GpuType.PStates):
if int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', self.sclk_state[pstate[0]][1])) != pstate[2]:
return True
return False
def is_changed_mclk_pstate(self, pstate: List[int]) -> bool:
""" Check if given mclk pstate value different from current.
:param pstate: pstate = [pstate_number, clk_value, vddc_value]
:return: Return True if changed
"""
if int(re.sub(PATTERNS[PK.END_IN_ALPHA], '', self.mclk_state[pstate[0]][0])) != pstate[1]:
return True
if self.prm.gpu_type in (GpuType.PStatesNE, GpuType.PStates):