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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
|
#include <fcntl.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <inttypes.h>
#include "linux/nvme_ioctl.h"
#include "common.h"
#include "nvme.h"
#include "nvme-print.h"
#include "nvme-ioctl.h"
#include "plugin.h"
#include "argconfig.h"
#include "suffix.h"
#define CREATE_CMD
#include "intel-nvme.h"
struct __attribute__((packed)) nvme_additional_smart_log_item {
__u8 key;
__u8 _kp[2];
__u8 norm;
__u8 _np;
union __attribute__((packed)) {
__u8 raw[6];
struct __attribute__((packed)) wear_level {
__le16 min;
__le16 max;
__le16 avg;
} wear_level;
struct __attribute__((packed)) thermal_throttle {
__u8 pct;
__u32 count;
} thermal_throttle;
} ;
__u8 _rp;
} ;
struct nvme_additional_smart_log {
struct nvme_additional_smart_log_item program_fail_cnt;
struct nvme_additional_smart_log_item erase_fail_cnt;
struct nvme_additional_smart_log_item wear_leveling_cnt;
struct nvme_additional_smart_log_item e2e_err_cnt;
struct nvme_additional_smart_log_item crc_err_cnt;
struct nvme_additional_smart_log_item timed_workload_media_wear;
struct nvme_additional_smart_log_item timed_workload_host_reads;
struct nvme_additional_smart_log_item timed_workload_timer;
struct nvme_additional_smart_log_item thermal_throttle_status;
struct nvme_additional_smart_log_item retry_buffer_overflow_cnt;
struct nvme_additional_smart_log_item pll_lock_loss_cnt;
struct nvme_additional_smart_log_item nand_bytes_written;
struct nvme_additional_smart_log_item host_bytes_written;
struct nvme_additional_smart_log_item host_ctx_wear_used;
struct nvme_additional_smart_log_item perf_stat_indicator;
struct nvme_additional_smart_log_item re_alloc_sectr_cnt;
struct nvme_additional_smart_log_item soft_ecc_err_rate;
struct nvme_additional_smart_log_item unexp_power_loss;
struct nvme_additional_smart_log_item media_bytes_read;
struct nvme_additional_smart_log_item avail_fw_downgrades;
};
struct nvme_vu_id_ctrl_field { /* CDR MR5 */
__u8 rsvd1[3];
__u8 ss;
__u8 health[20];
__u8 cls;
__u8 nlw;
__u8 scap;
__u8 sstat;
__u8 bl[8];
__u8 rsvd2[38];
__u8 ww[8]; /* little endian */
__u8 mic_bl[4];
__u8 mic_fw[4];
};
static void json_intel_id_ctrl(struct nvme_vu_id_ctrl_field *id,
char *health, char *bl, char *ww, char *mic_bl, char *mic_fw,
struct json_object *root)
{
json_object_add_value_int(root, "ss", id->ss);
json_object_add_value_string(root, "health", health );
json_object_add_value_int(root, "cls", id->cls);
json_object_add_value_int(root, "nlw", id->nlw);
json_object_add_value_int(root, "scap", id->scap);
json_object_add_value_int(root, "sstat", id->sstat);
json_object_add_value_string(root, "bl", bl);
json_object_add_value_string(root, "ww", ww);
json_object_add_value_string(root, "mic_bl", mic_bl);
json_object_add_value_string(root, "mic_fw", mic_fw);
}
static void intel_id_ctrl(__u8 *vs, struct json_object *root)
{
struct nvme_vu_id_ctrl_field* id = (struct nvme_vu_id_ctrl_field *)vs;
char health[21] = { 0 };
char bl[9] = { 0 };
char ww[19] = { 0 };
char mic_bl[5] = { 0 };
char mic_fw[5] = { 0 };
if (id->health[0]==0)
{
snprintf(health, 21, "%s", "healthy");
}
else
{
snprintf(health, 21, "%s", id->health);
}
snprintf(bl, 9, "%s", id->bl);
snprintf(ww, 19, "%02X%02X%02X%02X%02X%02X%02X%02X", id->ww[7],
id->ww[6], id->ww[5], id->ww[4], id->ww[3], id->ww[2],
id->ww[1], id->ww[0]);
snprintf(mic_bl, 5, "%s", id->mic_bl);
snprintf(mic_fw, 5, "%s", id->mic_fw);
if (root) {
json_intel_id_ctrl(id, health, bl, ww, mic_bl, mic_fw, root);
return;
}
printf("ss : %d\n", id->ss);
printf("health : %s\n", health);
printf("cls : %d\n", id->cls);
printf("nlw : %d\n", id->nlw);
printf("scap : %d\n", id->scap);
printf("sstat : %d\n", id->sstat);
printf("bl : %s\n", bl);
printf("ww : %s\n", ww);
printf("mic_bl : %s\n", mic_bl);
printf("mic_fw : %s\n", mic_fw);
}
static int id_ctrl(int argc, char **argv, struct command *cmd, struct plugin *plugin)
{
return __id_ctrl(argc, argv, cmd, plugin, intel_id_ctrl);
}
static void show_intel_smart_log_jsn(struct nvme_additional_smart_log *smart,
unsigned int nsid, const char *devname)
{
struct json_object *root, *entry_stats, *dev_stats, *multi;
root = json_create_object();
json_object_add_value_string(root, "Intel Smart log", devname);
dev_stats = json_create_object();
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->program_fail_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->program_fail_cnt.raw));
json_object_add_value_object(dev_stats, "program_fail_count", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->erase_fail_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->erase_fail_cnt.raw));
json_object_add_value_object(dev_stats, "erase_fail_count", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->wear_leveling_cnt.norm);
multi = json_create_object();
json_object_add_value_int(multi, "min", le16_to_cpu(smart->wear_leveling_cnt.wear_level.min));
json_object_add_value_int(multi, "max", le16_to_cpu(smart->wear_leveling_cnt.wear_level.max));
json_object_add_value_int(multi, "avg", le16_to_cpu(smart->wear_leveling_cnt.wear_level.avg));
json_object_add_value_object(entry_stats, "raw", multi);
json_object_add_value_object(dev_stats, "wear_leveling", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->e2e_err_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->e2e_err_cnt.raw));
json_object_add_value_object(dev_stats, "end_to_end_error_detection_count", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->crc_err_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->crc_err_cnt.raw));
json_object_add_value_object(dev_stats, "crc_error_count", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->timed_workload_media_wear.norm);
json_object_add_value_float(entry_stats, "raw", ((long double)int48_to_long(smart->timed_workload_media_wear.raw)) / 1024);
json_object_add_value_object(dev_stats, "timed_workload_media_wear", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->timed_workload_host_reads.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->timed_workload_host_reads.raw));
json_object_add_value_object(dev_stats, "timed_workload_host_reads", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->timed_workload_timer.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->timed_workload_timer.raw));
json_object_add_value_object(dev_stats, "timed_workload_timer", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->thermal_throttle_status.norm);
multi = json_create_object();
json_object_add_value_int(multi, "pct", smart->thermal_throttle_status.thermal_throttle.pct);
json_object_add_value_int(multi, "cnt", smart->thermal_throttle_status.thermal_throttle.count);
json_object_add_value_object(entry_stats, "raw", multi);
json_object_add_value_object(dev_stats, "thermal_throttle_status", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->retry_buffer_overflow_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->retry_buffer_overflow_cnt.raw));
json_object_add_value_object(dev_stats, "retry_buffer_overflow_count", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->pll_lock_loss_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->pll_lock_loss_cnt.raw));
json_object_add_value_object(dev_stats, "pll_lock_loss_count", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->nand_bytes_written.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->nand_bytes_written.raw));
json_object_add_value_object(dev_stats, "nand_bytes_written", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->host_bytes_written.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->host_bytes_written.raw));
json_object_add_value_object(dev_stats, "host_bytes_written", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->host_ctx_wear_used.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->host_ctx_wear_used.raw));
json_object_add_value_object(dev_stats, "host_ctx_wear_used", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->perf_stat_indicator.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->perf_stat_indicator.raw));
json_object_add_value_object(dev_stats, "perf_stat_indicator", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->re_alloc_sectr_cnt.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->re_alloc_sectr_cnt.raw));
json_object_add_value_object(dev_stats, "re_alloc_sectr_cnt", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->soft_ecc_err_rate.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->soft_ecc_err_rate.raw));
json_object_add_value_object(dev_stats, "soft_ecc_err_rate", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->unexp_power_loss.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->unexp_power_loss.raw));
json_object_add_value_object(dev_stats, "unexp_power_loss", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->media_bytes_read.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->media_bytes_read.raw));
json_object_add_value_object(dev_stats, "media_bytes_read", entry_stats);
entry_stats = json_create_object();
json_object_add_value_int(entry_stats, "normalized", smart->avail_fw_downgrades.norm);
json_object_add_value_int(entry_stats, "raw", int48_to_long(smart->avail_fw_downgrades.raw));
json_object_add_value_object(dev_stats, "avail_fw_downgrades", entry_stats);
json_object_add_value_object(root, "Device stats", dev_stats);
json_print_object(root, NULL);
json_free_object(root);
}
static char *id_to_key(__u8 id)
{
switch (id) {
case 0xAB:
return "program_fail_count";
case 0xAC:
return "erase_fail_count";
case 0xAD:
return "wear_leveling_count";
case 0xB8:
return "e2e_error_detect_count";
case 0xC7:
return "crc_error_count";
case 0xE2:
return "media_wear_percentage";
case 0xE3:
return "host_reads";
case 0xE4:
return "timed_work_load";
case 0xEA:
return "thermal_throttle_status";
case 0xF0:
return "retry_buff_overflow_count";
case 0xF3:
return "pll_lock_loss_counter";
case 0xF4:
return "nand_bytes_written";
case 0xF5:
return "host_bytes_written";
case 0xF6:
return "host_context_wear_used";
case 0xF7:
return "performance_status_indicator";
case 0xF8:
return "media_bytes_read";
case 0xF9:
return "available_fw_downgrades";
case 0x05:
return "re-allocated_sector_count";
case 0x0D:
return "soft_ecc_error_rate";
case 0xAE:
return "unexpected_power_loss";
default:
return "Invalid ID";
}
}
static void print_intel_smart_log_items(struct nvme_additional_smart_log_item *item)
{
if (!item->key)
return;
printf("%#x %-45s %3d %"PRIu64"\n",
item->key, id_to_key(item->key),
item->norm, int48_to_long(item->raw));
}
static void show_intel_smart_log(struct nvme_additional_smart_log *smart,
unsigned int nsid, const char *devname)
{
struct nvme_additional_smart_log_item *iter = &smart->program_fail_cnt;
int num_items = sizeof(struct nvme_additional_smart_log) /
sizeof(struct nvme_additional_smart_log_item);
printf("Additional Smart Log for NVME device:%s namespace-id:%x\n",
devname, nsid);
printf("ID KEY Normalized Raw\n");
for (int i = 0; i < num_items; i++, iter++)
print_intel_smart_log_items(iter);
}
static int get_additional_smart_log(int argc, char **argv, struct command *cmd, struct plugin *plugin)
{
const char *desc = "Get Intel vendor specific additional smart log (optionally, "\
"for the specified namespace), and show it.";
const char *namespace = "(optional) desired namespace";
const char *raw = "Dump output in binary format";
const char *json= "Dump output in json format";
struct nvme_additional_smart_log smart_log;
int err, fd;
struct config {
__u32 namespace_id;
int raw_binary;
int json;
};
struct config cfg = {
.namespace_id = NVME_NSID_ALL,
};
OPT_ARGS(opts) = {
OPT_UINT("namespace-id", 'n', &cfg.namespace_id, namespace),
OPT_FLAG("raw-binary", 'b', &cfg.raw_binary, raw),
OPT_FLAG("json", 'j', &cfg.json, json),
OPT_END()
};
fd = parse_and_open(argc, argv, desc, opts);
if (fd < 0)
return fd;
err = nvme_get_log(fd, cfg.namespace_id, 0xca, false,
NVME_NO_LOG_LSP, sizeof(smart_log), &smart_log);
if (!err) {
if (cfg.json)
show_intel_smart_log_jsn(&smart_log, cfg.namespace_id, devicename);
else if (!cfg.raw_binary)
show_intel_smart_log(&smart_log, cfg.namespace_id, devicename);
else
d_raw((unsigned char *)&smart_log, sizeof(smart_log));
}
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
return err;
}
static int get_market_log(int argc, char **argv, struct command *cmd, struct plugin *plugin)
{
const char *desc = "Get Intel Marketing Name log and show it.";
const char *raw = "dump output in binary format";
char log[512];
int err, fd;
struct config {
int raw_binary;
};
struct config cfg = {
};
OPT_ARGS(opts) = {
OPT_FLAG("raw-binary", 'b', &cfg.raw_binary, raw),
OPT_END()
};
fd = parse_and_open(argc, argv, desc, opts);
if (fd < 0)
return fd;
err = nvme_get_log(fd, NVME_NSID_ALL, 0xdd, false,
NVME_NO_LOG_LSP, sizeof(log), log);
if (!err) {
if (!cfg.raw_binary)
printf("Intel Marketing Name Log:\n%s\n", log);
else
d_raw((unsigned char *)&log, sizeof(log));
} else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
return err;
}
struct intel_temp_stats {
__le64 curr;
__le64 last_overtemp;
__le64 life_overtemp;
__le64 highest_temp;
__le64 lowest_temp;
__u8 rsvd[40];
__le64 max_operating_temp;
__le64 min_operating_temp;
__le64 est_offset;
};
static void show_temp_stats(struct intel_temp_stats *stats)
{
printf(" Intel Temperature Statistics\n");
printf("--------------------------------\n");
printf("Current temperature : %"PRIu64"\n", le64_to_cpu(stats->curr));
printf("Last critical overtemp flag : %"PRIu64"\n", le64_to_cpu(stats->last_overtemp));
printf("Life critical overtemp flag : %"PRIu64"\n", le64_to_cpu(stats->life_overtemp));
printf("Highest temperature : %"PRIu64"\n", le64_to_cpu(stats->highest_temp));
printf("Lowest temperature : %"PRIu64"\n", le64_to_cpu(stats->lowest_temp));
printf("Max operating temperature : %"PRIu64"\n", le64_to_cpu(stats->max_operating_temp));
printf("Min operating temperature : %"PRIu64"\n", le64_to_cpu(stats->min_operating_temp));
printf("Estimated offset : %"PRIu64"\n", le64_to_cpu(stats->est_offset));
}
static int get_temp_stats_log(int argc, char **argv, struct command *cmd, struct plugin *plugin)
{
struct intel_temp_stats stats;
int err, fd;
const char *desc = "Get Temperature Statistics log and show it.";
const char *raw = "dump output in binary format";
struct config {
int raw_binary;
};
struct config cfg = {
};
OPT_ARGS(opts) = {
OPT_FLAG("raw-binary", 'b', &cfg.raw_binary, raw),
OPT_END()
};
fd = parse_and_open(argc, argv, desc, opts);
if (fd < 0)
return fd;
err = nvme_get_log(fd, NVME_NSID_ALL, 0xc5, false,
NVME_NO_LOG_LSP, sizeof(stats), &stats);
if (!err) {
if (!cfg.raw_binary)
show_temp_stats(&stats);
else
d_raw((unsigned char *)&stats, sizeof(stats));
} else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
return err;
}
struct intel_lat_stats {
__u16 maj;
__u16 min;
__u32 data[1216];
};
struct __attribute__((__packed__)) optane_lat_stats {
__u16 maj;
__u16 min;
__u64 data[9];
};
#define MEDIA_MAJOR_IDX 0
#define MEDIA_MINOR_IDX 1
#define MEDIA_MAX_LEN 2
#define OPTANE_V1000_BUCKET_LEN 8
static struct intel_lat_stats stats;
static struct optane_lat_stats v1000_stats;
struct v1000_thresholds {
__u32 read[OPTANE_V1000_BUCKET_LEN];
__u32 write[OPTANE_V1000_BUCKET_LEN];
};
static struct v1000_thresholds v1000_bucket;
static __u16 media_version[MEDIA_MAX_LEN] = {0};
enum FormatUnit {
US,
MS,
S
};
/*
* COL_WIDTH controls width of columns in human-readable output.
* BUFSIZE is for local temp char[]
* US_IN_S and US_IN_MS are for unit conversions when printing.
*/
#define COL_WIDTH 12
#define BUFSIZE 10
#define US_IN_S 1000000
#define US_IN_MS 1000
static const enum FormatUnit get_seconds_magnitude(__u32 microseconds)
{
if (microseconds > US_IN_S)
return S;
else if (microseconds > US_IN_MS)
return MS;
else
return US;
}
static const float convert_seconds(__u32 microseconds)
{
float divisor = 1.0;
if (microseconds > US_IN_S)
divisor = US_IN_S;
else if (microseconds > US_IN_MS)
divisor = US_IN_MS;
return microseconds / divisor;
}
/*
* For control over whether a string will format to +/-INF or
* print out ####.##US normally.
*/
enum inf_bound_type {
NEGINF,
POSINF,
NOINF
};
/*
* Edge buckets may have range [#s, inf) or (-inf, #US] in some
* latency statistics formats.
* Passing in NEGINF to POSINF to bound_type overrides the string to
* either of "-INF" or "+INF", respectively.
*/
static void set_unit_string(char *buffer, __u32 microseconds,
enum FormatUnit unit, enum inf_bound_type bound_type)
{
if (bound_type != NOINF) {
snprintf(buffer, 5, "%s", bound_type ? "+INF" : "-INF");
return;
}
char *string;
switch (unit) {
case US:
string = "us";
break;
case MS:
string = "ms";
break;
case S:
string = "s";
break;
default:
string = "_s";
break;
}
snprintf(buffer, 11, "%4.2f%s",
convert_seconds(microseconds), string);
}
static void init_buffer(char *buffer, size_t size)
{
size_t i;
for (i = 0; i < size; i++)
buffer[i] = i + '0';
}
static void show_lat_stats_bucket(struct intel_lat_stats *stats,
__u32 lower_us, enum inf_bound_type start_type,
__u32 upper_us, enum inf_bound_type end_type, int i)
{
enum FormatUnit fu = S;
char buffer[BUFSIZE];
init_buffer(buffer, BUFSIZE);
printf("%-*d", COL_WIDTH, i);
fu = get_seconds_magnitude(lower_us);
set_unit_string(buffer, lower_us, fu, start_type);
printf("%-*s", COL_WIDTH, buffer);
fu = get_seconds_magnitude(upper_us);
set_unit_string(buffer, upper_us, fu, end_type);
printf("%-*s", COL_WIDTH, buffer);
printf("%-*d\n", COL_WIDTH, stats->data[i]);
}
static void show_optane_lat_stats_bucket(struct optane_lat_stats *stats,
__u32 lower_us, enum inf_bound_type start_type,
__u32 upper_us, enum inf_bound_type end_type, int i)
{
enum FormatUnit fu = S;
char buffer[BUFSIZE];
init_buffer(buffer, BUFSIZE);
printf("%-*d", COL_WIDTH, i);
fu = get_seconds_magnitude(lower_us);
set_unit_string(buffer, lower_us, fu, start_type);
printf("%-*s", COL_WIDTH, buffer);
fu = get_seconds_magnitude(upper_us);
set_unit_string(buffer, upper_us, fu, end_type);
printf("%-*s", COL_WIDTH, buffer);
printf("%-*lu\n", COL_WIDTH, (long unsigned int)stats->data[i]);
}
static void show_lat_stats_linear(struct intel_lat_stats *stats,
__u32 start_offset, __u32 end_offset, __u32 bytes_per,
__u32 us_step, bool nonzero_print)
{
for (int i = (start_offset / bytes_per) - 1;
i < end_offset / bytes_per; i++) {
if (nonzero_print && stats->data[i] == 0)
continue;
show_lat_stats_bucket(stats, us_step * i, NOINF,
us_step * (i + 1), NOINF, i);
}
}
/*
* For 4.0-4.5 revision.
*/
static int lat_stats_log_scale(int i)
{
static const int LATENCY_STATS_V4_BASE_BITS = 6;
static const int LATENCY_STATS_V4_BASE_VAL = (
1 << LATENCY_STATS_V4_BASE_BITS);
// if (i < 128)
if (i < (LATENCY_STATS_V4_BASE_VAL << 1))
return i;
int error_bits = (i >> LATENCY_STATS_V4_BASE_BITS) - 1;
int base = 1 << (error_bits + LATENCY_STATS_V4_BASE_BITS);
int k = i % LATENCY_STATS_V4_BASE_VAL;
return base + ((k + 0.5) * (1 << error_bits));
}
/*
* Creates a subroot in the following manner:
* {
* "latstats" : {
* "type" : "write" or "read",
* "values" : {
*/
static void lat_stats_make_json_root(
struct json_object *root, struct json_object *bucket_list,
int write)
{
struct json_object *subroot = json_create_object();
json_object_add_value_object(root, "latstats", subroot);
json_object_add_value_string(subroot, "type", write ? "write" : "read");
json_object_add_value_object(subroot, "values", bucket_list);
}
/*
* Creates a bucket under the "values" json_object. Format is:
* "values" : {
* "bucket" : {
* "id" : #,
* "start" : string,
* "end" : string,
* "value" : 0,
* },
*/
static void json_add_bucket(struct intel_lat_stats *stats,
struct json_object *bucket_list, __u32 id,
__u32 lower_us, enum inf_bound_type start_type,
__u32 upper_us, enum inf_bound_type end_type, __u32 val)
{
char buffer[BUFSIZE];
struct json_object *bucket = json_create_object();
init_buffer(buffer, BUFSIZE);
json_object_add_value_object(bucket_list,
"bucket", bucket);
json_object_add_value_int(bucket, "id", id);
set_unit_string(buffer, lower_us,
get_seconds_magnitude(lower_us), start_type);
json_object_add_value_string(bucket, "start", buffer);
set_unit_string(buffer, upper_us,
get_seconds_magnitude(upper_us), end_type);
json_object_add_value_string(bucket, "end", buffer);
json_object_add_value_int(bucket, "value", val);
}
static void json_add_bucket_optane(struct json_object *bucket_list, __u32 id,
__u32 lower_us, enum inf_bound_type start_type,
__u32 upper_us, enum inf_bound_type end_type, __u32 val)
{
char buffer[BUFSIZE];
struct json_object *bucket = json_create_object();
init_buffer(buffer, BUFSIZE);
json_object_add_value_object(bucket_list,
"bucket", bucket);
json_object_add_value_int(bucket, "id", id);
set_unit_string(buffer, lower_us,
get_seconds_magnitude(lower_us), start_type);
json_object_add_value_string(bucket, "start", buffer);
set_unit_string(buffer, upper_us,
get_seconds_magnitude(upper_us), end_type);
json_object_add_value_string(bucket, "end", buffer);
json_object_add_value_uint(bucket, "value", val);
}
static void json_lat_stats_linear(struct intel_lat_stats *stats,
struct json_object *bucket_list, __u32 start_offset,
__u32 end_offset, __u32 bytes_per,
__u32 us_step, bool nonzero_print)
{
for (int i = (start_offset / bytes_per) - 1;
i < end_offset / bytes_per; i++) {
if (nonzero_print && stats->data[i] == 0)
continue;
json_add_bucket(stats, bucket_list,
i, us_step * i, NOINF, us_step * (i + 1),
NOINF, stats->data[i]);
}
}
static void json_lat_stats_3_0(struct intel_lat_stats *stats,
int write)
{
struct json_object *root = json_create_object();
struct json_object *bucket_list = json_create_object();
lat_stats_make_json_root(root, bucket_list, write);
json_lat_stats_linear(stats, bucket_list, 4, 131, 4, 32, false);
json_lat_stats_linear(stats, bucket_list, 132, 255, 4, 1024, false);
json_lat_stats_linear(stats, bucket_list, 256, 379, 4, 32768, false);
json_lat_stats_linear(stats, bucket_list, 380, 383, 4, 32, true);
json_lat_stats_linear(stats, bucket_list, 384, 387, 4, 32, true);
json_lat_stats_linear(stats, bucket_list, 388, 391, 4, 32, true);
json_print_object(root, NULL);
json_free_object(root);
}
static void json_lat_stats_4_0(struct intel_lat_stats *stats,
int write)
{
struct json_object *root = json_create_object();
struct json_object *bucket_list = json_create_object();
lat_stats_make_json_root(root, bucket_list, write);
__u32 lower_us = 0;
__u32 upper_us = 1;
bool end = false;
int max = 1216;
for (int i = 0; i < max; i++) {
lower_us = lat_stats_log_scale(i);
if (i >= max - 1)
end = true;
else
upper_us = lat_stats_log_scale(i + 1);
json_add_bucket(stats, bucket_list, i,
lower_us, NOINF, upper_us,
end ? POSINF : NOINF, stats->data[i]);
}
json_print_object(root, NULL);
json_free_object(root);
}
static void show_lat_stats_3_0(struct intel_lat_stats *stats)
{
show_lat_stats_linear(stats, 4, 131, 4, 32, false);
show_lat_stats_linear(stats, 132, 255, 4, 1024, false);
show_lat_stats_linear(stats, 256, 379, 4, 32768, false);
show_lat_stats_linear(stats, 380, 383, 4, 32, true);
show_lat_stats_linear(stats, 384, 387, 4, 32, true);
show_lat_stats_linear(stats, 388, 391, 4, 32, true);
}
static void show_lat_stats_4_0(struct intel_lat_stats *stats)
{
int lower_us = 0;
int upper_us = 1;
bool end = false;
int max = 1216;
for (int i = 0; i < max; i++) {
lower_us = lat_stats_log_scale(i);
if (i >= max - 1)
end = true;
else
upper_us = lat_stats_log_scale(i + 1);
show_lat_stats_bucket(stats, lower_us, NOINF,
upper_us, end ? POSINF : NOINF, i);
}
}
static void jason_lat_stats_v1000_0(struct optane_lat_stats *stats, int write)
{
int i;
struct json_object *root = json_create_object();
struct json_object *bucket_list = json_create_object();
lat_stats_make_json_root(root, bucket_list, write);
if (write) {
for (i = 0; i < OPTANE_V1000_BUCKET_LEN - 1; i++)
json_add_bucket_optane(bucket_list, i,
v1000_bucket.write[i], NOINF,
v1000_bucket.write[i + 1] - 1,
NOINF,
stats->data[i]);
json_add_bucket_optane(bucket_list,
OPTANE_V1000_BUCKET_LEN - 1,
v1000_bucket.write[i],
NOINF,
v1000_bucket.write[i],
POSINF, stats->data[i]);
} else {
for (i = 0; i < OPTANE_V1000_BUCKET_LEN - 1; i++)
json_add_bucket_optane(bucket_list, i,
v1000_bucket.read[i], NOINF,
v1000_bucket.read[i + 1] - 1,
NOINF,
stats->data[i]);
json_add_bucket_optane(bucket_list,
OPTANE_V1000_BUCKET_LEN - 1,
v1000_bucket.read[i],
NOINF,
v1000_bucket.read[i],
POSINF, stats->data[i]);
}
struct json_object *subroot = json_create_object();
json_object_add_value_object(root, "Average latency since last reset", subroot);
json_object_add_value_uint(subroot, "value in us", stats->data[8]);
json_print_object(root, NULL);
json_free_object(root);
}
static void show_lat_stats_v1000_0(struct optane_lat_stats *stats, int write)
{
int i;
if (write) {
for (i = 0; i < OPTANE_V1000_BUCKET_LEN - 1; i++)
show_optane_lat_stats_bucket(stats,
v1000_bucket.write[i],
NOINF,
v1000_bucket.write[i + 1] -1,
NOINF, i);
show_optane_lat_stats_bucket(stats, v1000_bucket.write[i],
NOINF, v1000_bucket.write[i],
POSINF, i);
} else {
for (i = 0; i < OPTANE_V1000_BUCKET_LEN - 1; i++)
show_optane_lat_stats_bucket(stats,
v1000_bucket.read[i],
NOINF,
v1000_bucket.read[i + 1] -1,
NOINF, i);
show_optane_lat_stats_bucket(stats, v1000_bucket.read[i],
NOINF, v1000_bucket.read[i],
POSINF, i);
}
printf("Average latency since last reset: %lu us\n", (long unsigned int)stats->data[8]);
}
static void json_lat_stats(int write)
{
switch (media_version[MEDIA_MAJOR_IDX]) {
case 3:
json_lat_stats_3_0(&stats, write);
break;
case 4:
switch (media_version[MEDIA_MINOR_IDX]) {
case 0:
case 1:
case 2:
case 3:
case 4:
case 5:
json_lat_stats_4_0(&stats, write);
break;
default:
printf("Unsupported minor revision (%u.%u)\n",
stats.maj, stats.min);
break;
}
break;
case 1000:
switch (media_version[MEDIA_MINOR_IDX]) {
case 0:
jason_lat_stats_v1000_0(&v1000_stats, write);
break;
default:
printf("Unsupported minor revision (%u.%u)\n",
stats.maj, stats.min);
break;
}
break;
default:
printf("Unsupported revision (%u.%u)\n",
stats.maj, stats.min);
break;
}
printf("\n");
}
static void print_dash_separator(int count)
{
for (int i = 0; i < count; i++)
putchar('-');
putchar('\n');
}
static void show_lat_stats(int write)
{
static const int separator_length = 50;
printf("Intel IO %s Command Latency Statistics\n",
write ? "Write" : "Read");
printf("Major Revision : %u\nMinor Revision : %u\n",
media_version[MEDIA_MAJOR_IDX], media_version[MEDIA_MINOR_IDX]);
print_dash_separator(separator_length);
printf("%-12s%-12s%-12s%-20s\n", "Bucket", "Start", "End", "Value");
print_dash_separator(separator_length);
switch (media_version[MEDIA_MAJOR_IDX]) {
case 3:
show_lat_stats_3_0(&stats);
break;
case 4:
switch (media_version[MEDIA_MINOR_IDX]) {
case 0:
case 1:
case 2:
case 3:
case 4:
case 5:
show_lat_stats_4_0(&stats);
break;
default:
printf("Unsupported minor revision (%u.%u)\n",
stats.maj, stats.min);
break;
}
break;
case 1000:
switch (media_version[MEDIA_MINOR_IDX]) {
case 0:
show_lat_stats_v1000_0(&v1000_stats, write);
break;
default:
printf("Unsupported minor revision (%u.%u)\n",
stats.maj, stats.min);
break;
}
break;
default:
printf("Unsupported revision (%u.%u)\n",
stats.maj, stats.min);
break;
}
}
static int get_lat_stats_log(int argc, char **argv, struct command *cmd, struct plugin *plugin)
{
int err, fd;
const char *desc = "Get Intel Latency Statistics log and show it.";
const char *raw = "Dump output in binary format";
const char *json= "Dump output in json format";
const char *write = "Get write statistics (read default)";
struct config {
int raw_binary;
int json;
int write;
};
struct config cfg = {
};
OPT_ARGS(opts) = {
OPT_FLAG("write", 'w', &cfg.write, write),
OPT_FLAG("raw-binary", 'b', &cfg.raw_binary, raw),
OPT_FLAG("json", 'j', &cfg.json, json),
OPT_END()
};
fd = parse_and_open(argc, argv, desc, opts);
if (fd < 0)
return fd;
/* Query maj and minor version first */
err = nvme_get_log(fd, NVME_NSID_ALL, cfg.write ? 0xc2 : 0xc1,
false, NVME_NO_LOG_LSP, sizeof(media_version),
media_version);
if (err)
goto close_fd;
if (media_version[0] == 1000) {
__u32 thresholds[OPTANE_V1000_BUCKET_LEN] = {0};
__u32 result;
err = nvme_get_feature(fd, 0, 0xf7, 0, cfg.write ? 0x1 : 0x0, 0,
sizeof(thresholds), thresholds, &result);
if (err) {
fprintf(stderr, "Quering thresholds failed. NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
goto close_fd;
}
/* Update bucket thresholds to be printed */
if (cfg.write) {
for (int i = 0; i < OPTANE_V1000_BUCKET_LEN; i++)
v1000_bucket.write[i] = thresholds[i];
} else {
for (int i = 0; i < OPTANE_V1000_BUCKET_LEN; i++)
v1000_bucket.read[i] = thresholds[i];
}
err = nvme_get_log(fd, NVME_NSID_ALL, cfg.write ? 0xc2 : 0xc1,
false, NVME_NO_LOG_LSP, sizeof(v1000_stats),
&v1000_stats);
} else {
err = nvme_get_log(fd, NVME_NSID_ALL, cfg.write ? 0xc2 : 0xc1,
false, NVME_NO_LOG_LSP, sizeof(stats),
&stats);
}
if (!err) {
if (cfg.json)
json_lat_stats(cfg.write);
else if (!cfg.raw_binary)
show_lat_stats(cfg.write);
else
d_raw((unsigned char *)&stats, sizeof(stats));
} else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
close_fd:
close(fd);
return err;
}
struct intel_assert_dump {
__u32 coreoffset;
__u32 assertsize;
__u8 assertdumptype;
__u8 assertvalid;
__u8 reserved[2];
};
struct intel_event_dump {
__u32 numeventdumps;
__u32 coresize;
__u32 coreoffset;
__u32 eventidoffset[16];
__u8 eventIdValidity[16];
};
struct intel_vu_version {
__u16 major;
__u16 minor;
};
struct intel_event_header {
__u32 eventidsize;
struct intel_event_dump edumps[0];
};
struct intel_vu_log {
struct intel_vu_version ver;
__u32 header;
__u32 size;
__u32 numcores;
__u8 reserved[4080];
};
struct intel_vu_nlog {
struct intel_vu_version ver;
__u32 logselect;
__u32 totalnlogs;
__u32 nlognum;
__u32 nlogname;
__u32 nlogbytesize;
__u32 nlogprimarybuffsize;
__u32 tickspersecond;
__u32 corecount;
__u32 nlogpausestatus;
__u32 selectoffsetref;
__u32 selectnlogpause;
__u32 selectaddedoffset;
__u32 nlogbufnum;
__u32 nlogbufnummax;
__u32 coreselected;
__u32 reserved[3];
};
struct intel_cd_log {
union {
struct {
__u32 selectLog : 3;
__u32 selectCore : 2;
__u32 selectNlog : 8;
__u8 selectOffsetRef : 1;
__u32 selectNlogPause : 2;
__u32 reserved2 : 16;
} fields;
__u32 entireDword;
} u;
};
static void print_intel_nlog(struct intel_vu_nlog *intel_nlog)
{
printf("Version Major %u\n"
"Version Minor %u\n"
"Log_select %u\n"
"totalnlogs %u\n"
"nlognum %u\n"
"nlogname %u\n"
"nlogbytesze %u\n"
"nlogprimarybuffsize %u\n"
"tickspersecond %u\n"
"corecount %u\n"
"nlogpausestatus %u\n"
"selectoffsetref %u\n"
"selectnlogpause %u\n"
"selectaddedoffset %u\n"
"nlogbufnum %u\n"
"nlogbufnummax %u\n"
"coreselected %u\n",
intel_nlog->ver.major, intel_nlog->ver.minor,
intel_nlog->logselect, intel_nlog->totalnlogs, intel_nlog->nlognum,
intel_nlog->nlogname, intel_nlog->nlogbytesize,
intel_nlog->nlogprimarybuffsize, intel_nlog->tickspersecond,
intel_nlog->corecount, intel_nlog->nlogpausestatus,
intel_nlog->selectoffsetref, intel_nlog->selectnlogpause,
intel_nlog->selectaddedoffset, intel_nlog->nlogbufnum,
intel_nlog->nlogbufnummax, intel_nlog->coreselected);
}
static int read_entire_cmd(struct nvme_passthru_cmd *cmd, int total_size,
const size_t max_tfer, int out_fd, int ioctl_fd,
__u8 *buf)
{
int err = 0;
size_t dword_tfer = 0;
dword_tfer = min(max_tfer, total_size);
while (total_size > 0) {
err = nvme_submit_admin_passthru(ioctl_fd, cmd);
if (err) {
fprintf(stderr,
"failed on cmd.data_len %u cmd.cdw13 %u cmd.cdw12 %x cmd.cdw10 %u err %x remaining size %d\n",
cmd->data_len, cmd->cdw13, cmd->cdw12,
cmd->cdw10, err, total_size);
goto out;
}
if (out_fd > 0) {
err = write(out_fd, buf, cmd->data_len);
if (err < 0) {
perror("write failure");
goto out;
}
err = 0;
}
total_size -= dword_tfer;
cmd->cdw13 += dword_tfer;
cmd->cdw10 = dword_tfer = min(max_tfer, total_size);
cmd->data_len = (min(max_tfer, total_size)) * 4;
}
out:
return err;
}
static int write_header(__u8 *buf, int fd, size_t amnt)
{
if (write(fd, buf, amnt) < 0)
return 1;
return 0;
}
static int read_header(struct nvme_passthru_cmd *cmd,__u8 *buf, int ioctl_fd,
__u32 dw12, int nsid)
{
memset(cmd, 0, sizeof(*cmd));
memset(buf, 0, 4096);
cmd->opcode = 0xd2;
cmd->nsid = nsid;
cmd->cdw10 = 0x400;
cmd->cdw12 = dw12;
cmd->data_len = 0x1000;
cmd->addr = (unsigned long)(void *)buf;
return read_entire_cmd(cmd, 0x400, 0x400, -1, ioctl_fd, buf);
}
static int setup_file(char *f, char *file, int fd, int type)
{
struct nvme_id_ctrl ctrl;
int err = 0, i = sizeof(ctrl.sn) - 1;
err = nvme_identify_ctrl(fd, &ctrl);
if (err)
return err;
/* Remove trailing spaces from the name */
while (i && ctrl.sn[i] == ' ') {
ctrl.sn[i] = '\0';
i--;
}
sprintf(f, "%s_%-.*s.bin", type == 0 ? "Nlog" :
type == 1 ? "EventLog" : "AssertLog",
(int)sizeof(ctrl.sn), ctrl.sn);
return err;
}
static int get_internal_log_old(__u8 *buf, int output, int fd,
struct nvme_passthru_cmd *cmd)
{
struct intel_vu_log *intel;
int err = 0;
const int dwmax = 0x400;
const int dmamax = 0x1000;
intel = (struct intel_vu_log *)buf;
printf("Log major:%d minor:%d header:%d size:%d\n",
intel->ver.major, intel->ver.minor, intel->header, intel->size);
err = write(output, buf, 0x1000);
if (err < 0) {
perror("write failure");
goto out;
}
intel->size -= 0x400;
cmd->opcode = 0xd2;
cmd->cdw10 = min(dwmax, intel->size);
cmd->data_len = min(dmamax, intel->size);
err = read_entire_cmd(cmd, intel->size, dwmax, output, fd, buf);
if (err)
goto out;
err = 0;
out:
return err;
}
static int get_internal_log(int argc, char **argv, struct command *command,
struct plugin *plugin)
{
__u8 buf[0x2000];
char f[0x100];
int err, fd, output, i, j, count = 0, core_num = 1;
struct nvme_passthru_cmd cmd;
struct intel_cd_log cdlog;
struct intel_vu_log *intel = malloc(sizeof(struct intel_vu_log));
struct intel_vu_nlog *intel_nlog = (struct intel_vu_nlog *)buf;
struct intel_assert_dump *ad = (struct intel_assert_dump *) intel->reserved;
struct intel_event_header *ehdr = (struct intel_event_header *)intel->reserved;
const char *desc = "Get Intel Firmware Log and save it.";
const char *log = "Log type: 0, 1, or 2 for nlog, event log, and assert log, respectively.";
const char *core = "Select which region log should come from. -1 for all";
const char *nlognum = "Select which nlog to read. -1 for all nlogs";
const char *file = "Output file; defaults to device name provided";
const char *verbose = "To print out verbose nlog info";
const char *namespace_id = "Namespace to get logs from";
struct config {
__u32 namespace_id;
__u32 log;
int core;
int lnum;
char *file;
bool verbose;
};
struct config cfg = {
.namespace_id = -1,
.file = NULL,
.lnum = -1,
.core = -1
};
OPT_ARGS(opts) = {
OPT_UINT("log", 'l', &cfg.log, log),
OPT_INT("region", 'r', &cfg.core, core),
OPT_INT("nlognum", 'm', &cfg.lnum, nlognum),
OPT_UINT("namespace-id", 'n', &cfg.namespace_id, namespace_id),
OPT_FILE("output-file", 'o', &cfg.file, file),
OPT_FLAG("verbose-nlog", 'v', &cfg.verbose, verbose),
OPT_END()
};
fd = parse_and_open(argc, argv, desc, opts);
if (fd < 0) {
free(intel);
return fd;
}
if (cfg.log > 2 || cfg.core > 4 || cfg.lnum > 255) {
free(intel);
return EINVAL;
}
if (!cfg.file) {
err = setup_file(f, cfg.file, fd, cfg.log);
if (err)
goto out;
cfg.file = f;
}
cdlog.u.entireDword = 0;
cdlog.u.fields.selectLog = cfg.log;
cdlog.u.fields.selectCore = cfg.core < 0 ? 0 : cfg.core;
cdlog.u.fields.selectNlog = cfg.lnum < 0 ? 0 : cfg.lnum;
output = open(cfg.file, O_WRONLY | O_CREAT | O_TRUNC, 0666);
err = read_header(&cmd, buf, fd, cdlog.u.entireDword, cfg.namespace_id);
if (err)
goto out;
memcpy(intel, buf, sizeof(*intel));
/* for 1.1 Fultondales will use old nlog, but current assert/event */
if ((intel->ver.major < 1 && intel->ver.minor < 1) ||
(intel->ver.major <= 1 && intel->ver.minor <= 1 && cfg.log == 0)) {
cmd.addr = (unsigned long)(void *)buf;
err = get_internal_log_old(buf, output, fd, &cmd);
goto out;
}
if (cfg.log == 2) {
if (cfg.verbose)
printf("Log major:%d minor:%d header:%d size:%d numcores:%d\n",
intel->ver.major, intel->ver.minor,
intel->header, intel->size, intel->numcores);
err = write_header(buf, output, 0x1000);
if (err) {
perror("write failure");
goto out;
}
count = intel->numcores;
} else if (cfg.log == 0) {
if (cfg.lnum < 0)
count = intel_nlog->totalnlogs;
else
count = 1;
if (cfg.core < 0)
core_num = intel_nlog->corecount;
} else if (cfg.log == 1) {
core_num = intel->numcores;
count = 1;
err = write_header(buf, output, sizeof(*intel));
if (err)
goto out;
}
for (j = (cfg.core < 0 ? 0 : cfg.core);
j < (cfg.core < 0 ? core_num : cfg.core + 1);
j++) {
cdlog.u.fields.selectCore = j;
for (i = 0; i < count; i++) {
if (cfg.log == 2) {
if (!ad[i].assertvalid)
continue;
cmd.cdw13 = ad[i].coreoffset;
cmd.cdw10 = 0x400;
cmd.data_len = min(0x400, ad[i].assertsize) * 4;
err = read_entire_cmd(&cmd, ad[i].assertsize,
0x400, output, fd, buf);
if (err)
goto out;
} else if(cfg.log == 0) {
/* If the user selected to read the entire nlog */
if (count > 1)
cdlog.u.fields.selectNlog = i;
err = read_header(&cmd, buf, fd, cdlog.u.entireDword,
cfg.namespace_id);
if (err)
goto out;
err = write_header(buf, output, sizeof(*intel_nlog));
if (err)
goto out;
if (cfg.verbose)
print_intel_nlog(intel_nlog);
cmd.cdw13 = 0x400;
cmd.cdw10 = 0x400;
cmd.data_len = min(0x1000, intel_nlog->nlogbytesize);
err = read_entire_cmd(&cmd, intel_nlog->nlogbytesize / 4,
0x400, output, fd, buf);
if (err)
goto out;
} else if (cfg.log == 1) {
cmd.cdw13 = ehdr->edumps[j].coreoffset;
cmd.cdw10 = 0x400;
cmd.data_len = 0x400;
err = read_entire_cmd(&cmd, ehdr->edumps[j].coresize,
0x400, output, fd, buf);
if (err)
goto out;
}
}
}
err = 0;
out:
if (err > 0) {
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
} else if (err < 0) {
perror("intel log");
err = EIO;
} else
printf("Successfully wrote log to %s\n", cfg.file);
free(intel);
return err;
}
static int enable_lat_stats_tracking(int argc, char **argv,
struct command *command, struct plugin *plugin)
{
int err, fd;
const char *desc = (
"Enable/Disable Intel Latency Statistics Tracking.\n"
"No argument prints current status.");
const char *enable_desc = "Enable LST";
const char *disable_desc = "Disable LST";
const __u32 nsid = 0;
const __u8 fid = 0xe2;
const __u8 sel = 0;
const __u32 cdw11 = 0x0;
const __u32 cdw12 = 0x0;
const __u32 data_len = 32;
const __u32 save = 0;
__u32 result;
void *buf = NULL;
struct config {
bool enable, disable;
};
struct config cfg = {
.enable = false,
.disable = false,
};
const struct argconfig_commandline_options command_line_options[] = {
{"enable", 'e', "", CFG_NONE, &cfg.enable, no_argument, enable_desc},
{"disable", 'd', "", CFG_NONE, &cfg.disable, no_argument, disable_desc},
{NULL}
};
fd = parse_and_open(argc, argv, desc, command_line_options);
enum Option {
None = -1,
True = 1,
False = 0,
};
enum Option option = None;
if (cfg.enable && cfg.disable)
printf("Cannot enable and disable simultaneously.");
else if (cfg.enable || cfg.disable)
option = cfg.enable;
if (fd < 0)
return fd;
switch (option) {
case None:
err = nvme_get_feature(fd, nsid, fid, sel, cdw11, 0, data_len, buf,
&result);
if (!err) {
printf(
"Latency Statistics Tracking (FID 0x%X) is currently (%i).\n",
fid, result);
} else {
printf("Could not read feature id 0xE2.\n");
return err;
}
break;
case True:
case False:
err = nvme_set_feature(fd, nsid, fid, option, cdw12, save, 0,
data_len, buf, &result);
if (err > 0) {
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
} else if (err < 0) {
perror("Enable latency tracking");
fprintf(stderr, "Command failed while parsing.\n");
} else {
printf("Successfully set enable bit for FID (0x%X) to %i.\n",
fid, option);
}
break;
default:
printf("%d not supported.\n", option);
return EINVAL;
}
return fd;
}
static int set_lat_stats_thresholds(int argc, char **argv,
struct command *command, struct plugin *plugin)
{
int err, fd, num;
const char *desc = "Write Intel Bucket Thresholds for Latency Statistics Tracking";
const char *bucket_thresholds = "Bucket Threshold List, comma separated list: 0, 10, 20 ...";
const char *write = "Set write bucket Thresholds for latency tracking (read default)";
const __u32 nsid = 0;
const __u8 fid = 0xf7;
const __u32 cdw12 = 0x0;
const __u32 save = 0;
__u32 result;
struct config {
int write;
char *bucket_thresholds;
};
struct config cfg = {
.write = 0,
.bucket_thresholds = "",
};
OPT_ARGS(opts) = {
OPT_FLAG("write", 'w', &cfg.write, write),
OPT_LIST("bucket-thresholds", 't', &cfg.bucket_thresholds,
bucket_thresholds),
OPT_END()
};
fd = parse_and_open(argc, argv, desc, opts);
if (fd < 0)
return fd;
/* Query maj and minor version first to figure out the amount of
* valid buckets a user is allowed to modify. Read or write doesn't
* matter
*/
err = nvme_get_log(fd, NVME_NSID_ALL, 0xc2,
false, NVME_NO_LOG_LSP, sizeof(media_version),
media_version);
if (err) {
fprintf(stderr, "Querying media version failed. NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
goto close_fd;
}
if (media_version[0] == 1000) {
int thresholds[OPTANE_V1000_BUCKET_LEN] = {0};
num = argconfig_parse_comma_sep_array(cfg.bucket_thresholds,
thresholds,
sizeof(thresholds));
if (num == -1) {
fprintf(stderr, "ERROR: Bucket list is malformed\n");
goto close_fd;
}
err = nvme_set_feature(fd, nsid, fid, cfg.write ? 0x1 : 0x0,
cdw12, save, 0, OPTANE_V1000_BUCKET_LEN,
thresholds, &result);
if (err > 0) {
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
} else if (err < 0) {
perror("Enable latency tracking");
fprintf(stderr, "Command failed while parsing.\n");
}
} else {
fprintf(stderr, "Unsupported command\n");
}
close_fd:
close(fd);
return err;
}
|