forked from linux-nvme/nvme-cli
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathnvme.c
3297 lines (2956 loc) · 111 KB
/
nvme.c
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
/*
* nvme.c -- NVM-Express command line utility.
*
* Copyright (c) 2014-2015, Intel Corporation.
*
* Written by Keith Busch <[email protected]>
*
* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* This program uses NVMe IOCTLs to run native nvme commands to a device.
*/
#include <endian.h>
#include <errno.h>
#include <getopt.h>
#include <fcntl.h>
#include <inttypes.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <math.h>
#ifdef LIBUDEV_EXISTS
#include <libudev.h>
#endif
#include <linux/fs.h>
#include <sys/ioctl.h>
#include <sys/mman.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/time.h>
#include "common.h"
#include "src/argconfig.h"
#include "src/suffix.h"
#define array_len(x) ((size_t)(sizeof(x) / sizeof(0[x])))
#define min(x, y) (x) > (y) ? (y) : (x)
#define max(x, y) (x) > (y) ? (x) : (y)
static int fd;
static struct stat nvme_stat;
static const char *devicename;
static const char nvme_version_string[] = NVME_VERSION;
#define COMMAND_LIST \
ENTRY(LIST, "list", "List all NVMe devices and namespaces on machine", list) \
ENTRY(ID_CTRL, "id-ctrl", "Send NVMe Identify Controller", id_ctrl) \
ENTRY(ID_NS, "id-ns", "Send NVMe Identify Namespace, display structure", id_ns) \
ENTRY(LIST_NS, "list-ns", "Send NVMe Identify List, display structure", list_ns) \
ENTRY(CREATE_NS, "create-ns", "Creates a namespace with the provided parameters", create_ns) \
ENTRY(DELETE_NS, "delete-ns", "Deletes a namespace from the controller", delete_ns) \
ENTRY(ATTACH_NS, "attach-ns", "Attaches a namespace to requested controller(s)", attach_ns) \
ENTRY(DETACH_NS, "detach-ns", "Detaches a namespace from requested controller(s)", detach_ns) \
ENTRY(LIST_CTRL, "list-ctrl", "Send NVMe Identify Controller List, display structure", list_ctrl) \
ENTRY(GET_NS_ID, "get-ns-id", "Retrieve the namespace ID of opened block device", get_ns_id) \
ENTRY(GET_LOG, "get-log", "Generic NVMe get log, returns log in raw format", get_log) \
ENTRY(GET_FW_LOG, "fw-log", "Retrieve FW Log, show it", get_fw_log) \
ENTRY(GET_SMART_LOG, "smart-log", "Retrieve SMART Log, show it", get_smart_log) \
ENTRY(GET_ADDITIONAL_SMART_LOG, "smart-log-add", "Retrieve additional SMART Log, show it", get_additional_smart_log) \
ENTRY(GET_ERR_LOG, "error-log", "Retrieve Error Log, show it", get_error_log) \
ENTRY(GET_FEATURE, "get-feature", "Get feature and show the resulting value", get_feature) \
ENTRY(SET_FEATURE, "set-feature", "Set a feature and show the resulting value", set_feature) \
ENTRY(FORMAT, "format", "Format namespace with new block format", format) \
ENTRY(FW_ACTIVATE, "fw-activate", "Activate new firmware slot", fw_activate) \
ENTRY(FW_DOWNLOAD, "fw-download", "Download new firmware", fw_download) \
ENTRY(ADMIN_PASSTHRU, "admin-passthru", "Submit arbitrary admin command, return results", admin_passthru) \
ENTRY(IO_PASSTHRU, "io-passthru", "Submit an arbitrary IO command, return results", io_passthru) \
ENTRY(SECURITY_SEND, "security-send", "Submit a Security Send command, return results", sec_send) \
ENTRY(SECURITY_RECV, "security-recv", "Submit a Security Receive command, return results", sec_recv) \
ENTRY(RESV_ACQUIRE, "resv-acquire", "Submit a Reservation Acquire, return results", resv_acquire) \
ENTRY(RESV_REGISTER, "resv-register", "Submit a Reservation Register, return results", resv_register) \
ENTRY(RESV_RELEASE, "resv-release", "Submit a Reservation Release, return results", resv_release) \
ENTRY(RESV_REPORT, "resv-report", "Submit a Reservation Report, return results", resv_report) \
ENTRY(DSM, "dsm", "Submit a Data Set Management command, return results", dsm) \
ENTRY(FLUSH, "flush", "Submit a Flush command, return results", flush) \
ENTRY(COMPARE, "compare", "Submit a Comapre command, return results", compare) \
ENTRY(READ_CMD, "read", "Submit a read command, return results", read_cmd) \
ENTRY(WRITE_CMD, "write", "Submit a write command, return results", write_cmd) \
ENTRY(REGISTERS, "show-regs", "Shows the controller registers. Requires admin character device", show_registers) \
ENTRY(VERSION, "version", "Shows the program version", version) \
ENTRY(HELP, "help", "Display this help", help)
#define ENTRY(i, n, h, f) \
static int f(int argc, char **argv);
COMMAND_LIST
#undef ENTRY
enum {
#define ENTRY(i, n, h, f) i,
COMMAND_LIST
#undef ENTRY
NUM_COMMANDS
};
struct command {
char *name;
char *help;
char *path;
char *man;
int (*fn)(int argc, char **argv);
};
struct command commands[] = {
#define ENTRY(i, n, h, f)\
{ \
.name = n, \
.help = h, \
.fn = f, \
.path = "Documentation/nvme-"n".1", \
.man = "nvme-"n, \
},
COMMAND_LIST
#undef ENTRY
};
static unsigned long long elapsed_utime(struct timeval start_time,
struct timeval end_time)
{
unsigned long long ret = (end_time.tv_sec - start_time.tv_sec)*1000000 +
(end_time.tv_usec - start_time.tv_usec);
return ret;
}
static void open_dev(const char *dev)
{
int err;
devicename = dev;
fd = open(dev, O_RDONLY);
if (fd < 0)
goto perror;
err = fstat(fd, &nvme_stat);
if (err < 0)
goto perror;
if (!S_ISCHR(nvme_stat.st_mode) && !S_ISBLK(nvme_stat.st_mode)) {
fprintf(stderr, "%s is not a block or character device\n", dev);
exit(ENODEV);
}
return;
perror:
perror(dev);
exit(errno);
}
static void get_dev(int optind, int argc, char **argv)
{
if (optind >= argc) {
errno = EINVAL;
perror(argv[0]);
exit(errno);
}
open_dev((const char *)argv[optind]);
}
static void show_error_log(struct nvme_error_log_page *err_log, int entries)
{
int i;
printf("Error Log Entries for device:%s entries:%d\n", devicename,
entries);
printf(".................\n");
for (i = 0; i < entries; i++) {
printf(" Entry[%2d] \n", i);
printf(".................\n");
printf("error_count : %"PRIu64"\n", (uint64_t)le64toh(err_log[i].error_count));
printf("sqid : %d\n", err_log[i].sqid);
printf("cmdid : %#x\n", err_log[i].cmdid);
printf("status_field : %#x\n", err_log[i].status_field);
printf("parm_err_loc : %#x\n", err_log[i].parm_error_location);
printf("lba : %#"PRIx64"\n",(uint64_t)le64toh(err_log[i].lba));
printf("nsid : %d\n", err_log[i].nsid);
printf("vs : %d\n", err_log[i].vs);
printf(".................\n");
}
}
static void show_nvme_resv_report(struct nvme_reservation_status *status)
{
int i, regctl;
regctl = status->regctl[0] | (status->regctl[1] << 8);
printf("\nNVME Reservation status:\n\n");
printf("gen : %d\n", le32toh(status->gen));
printf("regctl : %d\n", regctl);
printf("rtype : %d\n", status->rtype);
printf("ptpls : %d\n", status->ptpls);
for (i = 0; i < regctl; i++) {
printf("regctl[%d] :\n", i);
printf(" cntlid : %x\n", le16toh(status->regctl_ds[i].cntlid));
printf(" rcsts : %x\n", status->regctl_ds[i].rcsts);
printf(" hostid : %"PRIx64"\n", (uint64_t)le64toh(status->regctl_ds[i].hostid));
printf(" rkey : %"PRIx64"\n", (uint64_t)le64toh(status->regctl_ds[i].rkey));
}
printf("\n");
}
static char *fw_to_string(__u64 fw)
{
static char ret[9];
char *c = (char *)&fw;
int i;
for (i = 0; i < 8; i++)
ret[i] = c[i] >= '!' && c[i] <= '~' ? c[i] : '.';
ret[i] = '\0';
return ret;
}
static void show_fw_log(struct nvme_firmware_log_page *fw_log)
{
int i;
printf("Firmware Log for device:%s\n", devicename);
printf("afi : %#x\n", fw_log->afi);
for (i = 0; i < 7; i++)
if (fw_log->frs[i])
printf("frs%d : %#016"PRIx64" (%s)\n", i + 1, (uint64_t)fw_log->frs[i],
fw_to_string(fw_log->frs[i]));
}
static unsigned long int48_to_long(__u8 *data)
{
int i;
long result = 0;
for (i = 0; i < 6; i++) {
result *= 256;
result += data[5 - i];
}
return result;
}
static void show_smart_log(struct nvme_smart_log *smart, unsigned int nsid)
{
/* convert temperature from Kelvin to Celsius */
int c;
unsigned int temperature = ((smart->temperature[1] << 8) |
smart->temperature[0]) - 273;
printf("Smart Log for NVME device:%s namespace-id:%x\n", devicename, nsid);
printf("critical_warning : %#x\n", smart->critical_warning);
printf("temperature : %u C\n", temperature);
printf("available_spare : %u%%\n", smart->avail_spare);
printf("available_spare_threshold : %u%%\n", smart->spare_thresh);
printf("percentage_used : %u%%\n", smart->percent_used);
printf("data_units_read : %'.0Lf\n",
int128_to_double(smart->data_units_read));
printf("data_units_written : %'.0Lf\n",
int128_to_double(smart->data_units_written));
printf("host_read_commands : %'.0Lf\n",
int128_to_double(smart->host_reads));
printf("host_write_commands : %'.0Lf\n",
int128_to_double(smart->host_writes));
printf("controller_busy_time : %'.0Lf\n",
int128_to_double(smart->ctrl_busy_time));
printf("power_cycles : %'.0Lf\n",
int128_to_double(smart->power_cycles));
printf("power_on_hours : %'.0Lf\n",
int128_to_double(smart->power_on_hours));
printf("unsafe_shutdowns : %'.0Lf\n",
int128_to_double(smart->unsafe_shutdowns));
printf("media_errors : %'.0Lf\n",
int128_to_double(smart->media_errors));
printf("num_err_log_entries : %'.0Lf\n",
int128_to_double(smart->num_err_log_entries));
printf("Critical Composite Temperature Time : %u\n", smart->warning_temp_time);
for (c=0; c < 8; c++) {
printf("Temperature Sensor %d : %u C\n", c+1, smart->temp_sensor[c] ? smart->temp_sensor[c]-273 : 0);
}
}
static void show_additional_smart_log(struct nvme_additional_smart_log *smart, unsigned int nsid)
{
printf("Additional Smart Log for NVME device:%s namespace-id:%x\n", devicename, nsid);
printf("key normalized raw\n");
printf("program_fail_count : %3d%% %lu\n",
smart->program_fail_cnt.norm,
int48_to_long(smart->program_fail_cnt.raw));
printf("erase_fail_count : %3d%% %lu\n",
smart->erase_fail_cnt.norm,
int48_to_long(smart->erase_fail_cnt.raw));
printf("wear_leveling : %3d%% min: %u, max: %u, avg: %u\n",
smart->wear_leveling_cnt.norm,
smart->wear_leveling_cnt.wear_level.min,
smart->wear_leveling_cnt.wear_level.max,
smart->wear_leveling_cnt.wear_level.avg);
printf("end_to_end_error_detection_count: %3d%% %lu\n",
smart->e2e_err_cnt.norm,
int48_to_long(smart->e2e_err_cnt.raw));
printf("crc_error_count : %3d%% %lu\n",
smart->crc_err_cnt.norm,
int48_to_long(smart->crc_err_cnt.raw));
printf("timed_workload_media_wear : %3d%% %.3f%%\n",
smart->timed_workload_media_wear.norm,
((float)int48_to_long(smart->timed_workload_media_wear.raw)) / 1024);
printf("timed_workload_host_reads : %3d%% %lu%%\n",
smart->timed_workload_host_reads.norm,
int48_to_long(smart->timed_workload_host_reads.raw));
printf("timed_workload_timer : %3d%% %lu min\n",
smart->timed_workload_timer.norm,
int48_to_long(smart->timed_workload_timer.raw));
printf("thermal_throttle_status : %3d%% %u%%, cnt: %u\n",
smart->thermal_throttle_status.norm,
smart->thermal_throttle_status.thermal_throttle.pct,
smart->thermal_throttle_status.thermal_throttle.count);
printf("retry_buffer_overflow_count : %3d%% %lu\n",
smart->retry_buffer_overflow_cnt.norm,
int48_to_long(smart->retry_buffer_overflow_cnt.raw));
printf("pll_lock_loss_count : %3d%% %lu\n",
smart->pll_lock_loss_cnt.norm,
int48_to_long(smart->pll_lock_loss_cnt.raw));
printf("nand_bytes_written : %3d%% sectors: %lu\n",
smart->nand_bytes_written.norm,
int48_to_long(smart->nand_bytes_written.raw));
printf("host_bytes_written : %3d%% sectors: %lu\n",
smart->host_bytes_written.norm,
int48_to_long(smart->host_bytes_written.raw));
}
char* nvme_feature_to_string(int feature)
{
switch (feature)
{
case NVME_FEAT_ARBITRATION: return "Arbitration";
case NVME_FEAT_POWER_MGMT: return "Power Management";
case NVME_FEAT_LBA_RANGE: return "LBA Range Type";
case NVME_FEAT_TEMP_THRESH: return "Temperature Threshold";
case NVME_FEAT_ERR_RECOVERY: return "Error Recovery";
case NVME_FEAT_VOLATILE_WC: return "Volatile Write Cache";
case NVME_FEAT_NUM_QUEUES: return "Number of Queues";
case NVME_FEAT_IRQ_COALESCE: return "Interrupt Coalescing";
case NVME_FEAT_IRQ_CONFIG: return "Interrupt Vector Configuration";
case NVME_FEAT_WRITE_ATOMIC: return "Write Atomicity Normal";
case NVME_FEAT_ASYNC_EVENT: return "Async Event Configuration";
case NVME_FEAT_AUTO_PST: return "Autonomous Power State Transition";
case NVME_FEAT_HOST_MEM_BUF: return "Host Memory Buffer";
case NVME_FEAT_SW_PROGRESS: return "Software Progress";
case NVME_FEAT_HOST_ID: return "Host Identifier";
case NVME_FEAT_RESV_MASK: return "Reservation Notification Mask";
case NVME_FEAT_RESV_PERSIST: return "Reservation Persistence";
default: return "Unknown";
}
}
char* nvme_select_to_string(int sel)
{
switch (sel)
{
case 0: return "Current";
case 1: return "Default";
case 2: return "Saved";
case 3: return "Supported capabilities";
default: return "Reserved";
}
}
static const char *nvme_status_to_string(__u32 status)
{
switch (status & 0x3ff) {
case NVME_SC_SUCCESS: return "SUCCESS";
case NVME_SC_INVALID_OPCODE: return "INVALID_OPCODE";
case NVME_SC_INVALID_FIELD: return "INVALID_FIELD";
case NVME_SC_CMDID_CONFLICT: return "CMDID_CONFLICT";
case NVME_SC_DATA_XFER_ERROR: return "DATA_XFER_ERROR";
case NVME_SC_POWER_LOSS: return "POWER_LOSS";
case NVME_SC_INTERNAL: return "INTERNAL";
case NVME_SC_ABORT_REQ: return "ABORT_REQ";
case NVME_SC_ABORT_QUEUE: return "ABORT_QUEUE";
case NVME_SC_FUSED_FAIL: return "FUSED_FAIL";
case NVME_SC_FUSED_MISSING: return "FUSED_MISSING";
case NVME_SC_INVALID_NS: return "INVALID_NS";
case NVME_SC_CMD_SEQ_ERROR: return "CMD_SEQ_ERROR";
case NVME_SC_LBA_RANGE: return "LBA_RANGE";
case NVME_SC_CAP_EXCEEDED: return "CAP_EXCEEDED";
case NVME_SC_NS_NOT_READY: return "NS_NOT_READY";
case NVME_SC_CQ_INVALID: return "CQ_INVALID";
case NVME_SC_QID_INVALID: return "QID_INVALID";
case NVME_SC_QUEUE_SIZE: return "QUEUE_SIZE";
case NVME_SC_ABORT_LIMIT: return "ABORT_LIMIT";
case NVME_SC_ABORT_MISSING: return "ABORT_MISSING";
case NVME_SC_ASYNC_LIMIT: return "ASYNC_LIMIT";
case NVME_SC_FIRMWARE_SLOT: return "FIRMWARE_SLOT";
case NVME_SC_FIRMWARE_IMAGE: return "FIRMWARE_IMAGE";
case NVME_SC_INVALID_VECTOR: return "INVALID_VECTOR";
case NVME_SC_INVALID_LOG_PAGE: return "INVALID_LOG_PAGE";
case NVME_SC_INVALID_FORMAT: return "INVALID_FORMAT";
case NVME_SC_BAD_ATTRIBUTES: return "BAD_ATTRIBUTES";
case NVME_SC_WRITE_FAULT: return "WRITE_FAULT";
case NVME_SC_READ_ERROR: return "READ_ERROR";
case NVME_SC_GUARD_CHECK: return "GUARD_CHECK";
case NVME_SC_APPTAG_CHECK: return "APPTAG_CHECK";
case NVME_SC_REFTAG_CHECK: return "REFTAG_CHECK";
case NVME_SC_COMPARE_FAILED: return "COMPARE_FAILED";
case NVME_SC_ACCESS_DENIED: return "ACCESS_DENIED";
default: return "Unknown";
}
}
static int identify(int namespace, void *ptr, __u32 cns)
{
struct nvme_admin_cmd cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.opcode = nvme_admin_identify;
cmd.nsid = namespace;
cmd.addr = (__u64)((unsigned long)ptr);
cmd.data_len = 4096;
cmd.cdw10 = cns;
return ioctl(fd, NVME_IOCTL_ADMIN_CMD, &cmd);
}
static int nvme_get_log(void *log_addr, __u32 data_len, __u32 dw10, __u32 nsid)
{
struct nvme_admin_cmd cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.opcode = nvme_admin_get_log_page;
cmd.addr = (__u64)((unsigned long)log_addr);
cmd.data_len = data_len;
cmd.cdw10 = dw10;
cmd.nsid = nsid;
return ioctl(fd, NVME_IOCTL_ADMIN_CMD, &cmd);
}
static void d_raw(unsigned char *buf, unsigned len)
{
unsigned i;
for (i = 0; i < len; i++)
putchar(*(buf+i));
}
char* nvme_feature_lba_type_to_string(__u8 type)
{
switch (type)
{
case 0: return "Reserved";
case 1: return "Filesystem";
case 2: return "RAID";
case 3: return "Cache";
case 4: return "Page / Swap file";
default:
if (type>=0x05 && type<=0x7f)
return "Reserved";
else
return "Vendor Specific";
}
}
static void show_lba_range(struct nvme_lba_range_type *lbrt, int nr_ranges)
{
int i, j;
for (i = 0; i <= nr_ranges; i++) {
printf("\ttype : %#x - %s\n", lbrt[i].type, nvme_feature_lba_type_to_string(lbrt[i].type));
printf("\tattributes : %#x - %s, %s\n", lbrt[i].attributes, (lbrt[i].attributes & 0x0001) ? "LBA range may be overwritten":"LBA range should not be overwritten",
((lbrt[i].attributes & 0x0002) >> 1) ? "LBA range should be hidden from the OS/EFI/BIOS":"LBA range should be visible from the OS/EFI/BIOS");
printf("\tslba : %#"PRIx64"\n", (uint64_t)(lbrt[i].slba));
printf("\tnlb : %#"PRIx64"\n", (uint64_t)(lbrt[i].nlb));
printf("\tguid : ");
for (j = 0; j < 16; j++)
printf("%02x", lbrt[i].guid[j]);
printf("\n");
}
}
static int get_smart_log(int argc, char **argv)
{
struct nvme_smart_log smart_log;
const char *desc = "smart-log: retrieve SMART log for the given "\
"device (or optionally, namespace) in either hex-dump "\
"(default) or binary format.";
const char *namespace = "(optional) desired namespace";
const char *raw = "output in binary format";
int err;
struct config {
__u32 namespace_id;
__u8 raw_binary;
};
struct config cfg;
const struct config defaults = {
.namespace_id = 0xffffffff,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace},
{"raw-binary", "", CFG_NONE, &defaults.raw_binary, no_argument, raw},
{"b", "", CFG_NONE, &defaults.raw_binary, no_argument, raw},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
err = nvme_get_log(&smart_log,
sizeof(smart_log), 0x2 | (((sizeof(smart_log) / 4) - 1) << 16),
cfg.namespace_id);
if (!err) {
if (!cfg.raw_binary)
show_smart_log(&smart_log, cfg.namespace_id);
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_additional_smart_log(int argc, char **argv)
{
struct nvme_additional_smart_log smart_log;
int err;
char *desc = "Get additional smart log (optionally, "\
"for the specified namspace), and show it.";
const char *namespace = "(optional) desired namespace";
const char *raw = "dump output in binary format";
struct config {
__u32 namespace_id;
__u8 raw_binary;
};
struct config cfg;
const struct config defaults = {
.namespace_id = 0xffffffff,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace},
{"raw-binary", "", CFG_NONE, &defaults.raw_binary, no_argument, raw},
{"b", "", CFG_NONE, &defaults.raw_binary, no_argument, raw},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
err = nvme_get_log(&smart_log,
sizeof(smart_log), 0xCA | (((sizeof(smart_log) / 4) - 1) << 16),
cfg.namespace_id);
if (!err) {
if (!cfg.raw_binary)
show_additional_smart_log(&smart_log, cfg.namespace_id);
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_error_log(int argc, char **argv)
{
const char *desc = "error-log: retrieve specified number of "\
"error log entries from a given device (or "\
"namespace) in either hex-dump (default) or binary format.";
const char *namespace_id = "desired namespace";
const char *log_entries = "number of entries to retrieve";
const char *raw_binary = "dump in binary format";
struct nvme_id_ctrl ctrl;
int err;
struct config {
__u32 namespace_id;
__u32 log_entries;
__u8 raw_binary;
};
struct config cfg;
const struct config defaults = {
.namespace_id = 0xffffffff,
.log_entries = 64,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"log-entries", "NUM", CFG_POSITIVE, &defaults.log_entries, required_argument, log_entries},
{"e", "NUM", CFG_POSITIVE, &defaults.log_entries, required_argument, log_entries},
{"raw-binary", "", CFG_NONE, &defaults.raw_binary, no_argument, raw_binary},
{"b", "", CFG_NONE, &defaults.raw_binary, no_argument, raw_binary},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
if (!cfg.log_entries) {
fprintf(stderr, "non-zero log-entries is required param\n");
return EINVAL;
}
err = identify(0, &ctrl, 1);
cfg.log_entries = min(cfg.log_entries, ctrl.elpe + 1);
if (err) {
fprintf(stderr, "could not identify controller\n");
return ENODEV;
} else {
struct nvme_error_log_page err_log[cfg.log_entries];
err = nvme_get_log(err_log,
sizeof(err_log), 0x1 | (((sizeof(err_log) / 4) - 1) << 16),
cfg.namespace_id);
if (!err) {
if (!cfg.raw_binary)
show_error_log(err_log, cfg.log_entries);
else
d_raw((unsigned char *)err_log, sizeof(err_log));
}
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
}
return err;
}
static int get_fw_log(int argc, char **argv)
{
const char *desc = "fw-log: retrieve the firmware log for the "\
"specified device in either hex-dump (default) or binary "\
"format.";
const char *raw_binary = "use binary output";
int err;
struct nvme_firmware_log_page fw_log;
struct config {
__u8 raw_binary;
};
struct config cfg;
const struct config defaults = {
};
const struct argconfig_commandline_options command_line_options[] = {
{"raw-binary", "", CFG_NONE, &defaults.raw_binary, no_argument, raw_binary},
{"b", "", CFG_NONE, &defaults.raw_binary, no_argument, raw_binary},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
err = nvme_get_log(&fw_log,
sizeof(fw_log), 0x3 | (((sizeof(fw_log) / 4) - 1) << 16),
0xffffffff);
if (!err) {
if (!cfg.raw_binary)
show_fw_log(&fw_log);
else
d_raw((unsigned char *)&fw_log, sizeof(fw_log));
}
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
else
perror("fw log");
return err;
}
static int get_log(int argc, char **argv)
{
const char *desc = "get-log: retrieve desired number of bytes "\
"from a given log on a specified device in either "\
"hex-dump (default) or binary format";
const char *namespace_id = "desired namespace";
const char *log_id = "name of log to retrieve";
const char *log_len = "how many bytes to retrieve";
const char *raw_binary = "output in raw format";
int err;
struct config {
__u32 namespace_id;
__u32 log_id;
__u32 log_len;
__u8 raw_binary;
};
struct config cfg;
const struct config defaults = {
.namespace_id = 0xffffffff,
.log_id = 0,
.log_len = 0,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"log-id", "NUM", CFG_POSITIVE, &defaults.log_id, required_argument, log_id},
{"i", "NUM", CFG_POSITIVE, &defaults.log_id, required_argument, log_id},
{"log-len", "NUM", CFG_POSITIVE, &defaults.log_len, required_argument, log_len},
{"l", "NUM", CFG_POSITIVE, &defaults.log_len, required_argument, log_len},
{"raw-binary", "", CFG_NONE, &defaults.raw_binary, no_argument, raw_binary},
{"b", "", CFG_NONE, &defaults.raw_binary, no_argument, raw_binary},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
if (!cfg.log_len) {
fprintf(stderr, "non-zero log-len is required param\n");
return EINVAL;
} else {
unsigned char log[cfg.log_len];
err = nvme_get_log(log, cfg.log_len, cfg.log_id | (((cfg.log_len / 4) - 1) << 16),
cfg.namespace_id);
if (!err) {
if (!cfg.raw_binary) {
printf("Device:%s log-id:%d namespace-id:%#x\n",
devicename, cfg.log_id,
cfg.namespace_id);
d(log, cfg.log_len, 16, 1);
} else
d_raw((unsigned char *)log, cfg.log_len);
} else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
return err;
}
}
static int list_ctrl(int argc, char **argv)
{
const char *desc = "list-ctrl: show controller information for the "\
"given device (and optionally, namespace)";
const char *controller = "controller to display";
const char *namespace_id = "optional namespace attached to controller";
int err, i;
struct nvme_controller_list *cntlist;
struct config {
__u16 cntid;
__u32 namespace_id;
};
struct config cfg;
const struct config defaults = {
.cntid = 0,
};
const struct argconfig_commandline_options command_line_options[] = {
{"cntid", "NUM", CFG_SHORT, &defaults.cntid, required_argument, controller},
{"c", "NUM", CFG_SHORT, &defaults.cntid, required_argument, controller},
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
if (posix_memalign((void *)&cntlist, getpagesize(), 0x1000))
return ENOMEM;
err = identify(cfg.namespace_id, cntlist,
cfg.cntid << 16 | cfg.namespace_id ? 0x12 : 0x13);
if (!err) {
for (i = 0; i < (min(cntlist->num, 2048)); i++)
printf("[%4u]:%#x\n", i, cntlist->identifier[i]);
}
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x) cntid:%d\n",
nvme_status_to_string(err), err, cfg.cntid);
return err;
}
static int list_ns(int argc, char **argv)
{
const char *desc = "list-ns: for the specified device, show the "\
"namespace list (optionally starting with a given namespace)";
const char *namespace_id = "namespace to start after";
const char *all = "show all namespaces in the subsystem, whether attached or inactive";
int err, i;
__u32 ns_list[1024];
struct config {
__u32 namespace_id;
__u8 all;
};
struct config cfg;
const struct config defaults = {
.namespace_id = 0,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"all", "", CFG_NONE, &defaults.all, no_argument, all},
{"a", "", CFG_NONE, &defaults.all, no_argument, all},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
get_dev(1, argc, argv);
err = identify(cfg.namespace_id, ns_list, cfg.all ? 0x10 : 2);
if (!err) {
for (i = 0; i < 1024; i++)
if (ns_list[i])
printf("[%4u]:%#x\n", i, ns_list[i]);
}
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x) NSID:%d\n",
nvme_status_to_string(err), err, cfg.namespace_id);
return err;
}
static int delete_ns(int argc, char **argv)
{
struct nvme_admin_cmd cmd;
const char *desc = "delete-ns: delete the given namespace by "\
"sending a namespace management command to "\
"the given device. All controllers should be detached from "\
"the namespace prior to namespace deletion. A namespace ID "\
"becomes inactive when that namespace is detached (or, if "\
"the namespace is not already inactive, once deleted).";
const char *namespace_id = "namespace to delete";
int err;
struct config {
__u32 namespace_id;
};
struct config cfg;
const struct config defaults = {
.namespace_id = 0,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{0}
};
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
if (!cfg.namespace_id) {
fprintf(stderr, "%s: namespace-id parameter required\n",
commands[DELETE_NS].name);
return EINVAL;
}
get_dev(1, argc, argv);
memset(&cmd, 0, sizeof(cmd));
cmd.opcode = nvme_admin_ns_mgmt;
cmd.nsid = cfg.namespace_id;
cmd.cdw10 = 1;
err = ioctl(fd, NVME_IOCTL_ADMIN_CMD, &cmd);
if (!err)
printf("%s: Success, deleted nsid:%d\n", commands[DELETE_NS].name,
cfg.namespace_id);
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
else
fprintf(stderr, "system error:(%x)\n", err);
return err;
}
static int nvme_attach_ns(int argc, char **argv, int attach, const char *desc)
{
struct nvme_controller_list *cntlist;
struct nvme_admin_cmd cmd;
char *name = commands[attach ? ATTACH_NS : DETACH_NS].name;
int err, i, list[2048];
const char *namespace_id = "namespace to attach";
const char *cont = "optional comma-sep controllers list";
struct config {
char *cntlist;
__u32 namespace_id;
};
struct config cfg;
const struct config defaults = {
.cntlist = "",
.namespace_id = 0,
};
const struct argconfig_commandline_options command_line_options[] = {
{"namespace-id", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"n", "NUM", CFG_POSITIVE, &defaults.namespace_id, required_argument, namespace_id},
{"controllers", "LIST", CFG_STRING, &defaults.cntlist, required_argument, cont},
{"c", "LIST", CFG_STRING, &defaults.cntlist, required_argument, cont},
{0}
};
if (posix_memalign((void *)&cntlist, getpagesize(), 0x1000))
return ENOMEM;
memset(cntlist, 0, sizeof(*cntlist));
argconfig_parse(argc, argv, desc, command_line_options,
&defaults, &cfg, sizeof(cfg));
if (!cfg.namespace_id) {
fprintf(stderr, "%s: namespace-id parameter required\n",
name);
return EINVAL;
}
cntlist->num = argconfig_parse_comma_sep_array(cfg.cntlist,
list, 2047);
for (i = 0; i < cntlist->num; i++)
cntlist->identifier[i] = htole16((uint16_t)list[i]);
get_dev(1, argc, argv);
memset(&cmd, 0, sizeof(cmd));
cmd.opcode = nvme_admin_ns_attach;
cmd.addr = (__u64)((unsigned long)cntlist);
cmd.data_len = 4096;
cmd.nsid = cfg.namespace_id;
cmd.cdw10 = attach ? 0 : 1;
err = ioctl(fd, NVME_IOCTL_ADMIN_CMD, &cmd);
if (!err)
printf("%s: Success, nsid:%d\n", name, cfg.namespace_id);
else if (err > 0)
fprintf(stderr, "NVMe Status:%s(%x)\n",
nvme_status_to_string(err), err);
else
fprintf(stderr, "system error:(%x)\n", err);
return err;
}
static int attach_ns(int argc, char **argv)
{
const char *desc = "attach-ns: attach the given namespace to the "\
"given controller or comma-sep list of controllers. ID of the "\
"given namespace becomes active upon attachment to a "\
"controller. A namespace must be attached to a controller "\
"before IO commands may be directed to that namespace.";
return nvme_attach_ns(argc, argv, 1, desc);
}
static int detach_ns(int argc, char **argv)
{
const char *desc = "detach-ns: detach the given namespace from the "\
"given controller; de-activates the given namespace's ID. A "\
"namespace must be attached to a controller before IO "\
"commands may be directed to that namespace.";
return nvme_attach_ns(argc, argv, 0, desc);
}
static int create_ns(int argc, char **argv)
{
struct nvme_admin_cmd cmd;
struct nvme_id_ns *ns;
const char *desc = "create-ns: send a namespace management command "\
"to the specified device to create a namespace with the given "\
"parameters. The next available namespace ID is used for the "\
"create operation. Note that create-ns does not attach the "\
"namespace to a controller, the attach-ns command is needed.";
int err = 0;
struct config {
__u64 nsze;
__u64 ncap;
__u8 flbas;
__u8 dps;
__u8 nmic;