-
Notifications
You must be signed in to change notification settings - Fork 91
/
sg_format.c
1782 lines (1707 loc) · 73.9 KB
/
sg_format.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
/*
* sg_format : format a SCSI disk
* potentially with a different number of blocks and block size
*
* formerly called blk512-linux.c (v0.4)
*
* Copyright (C) 2003 Grant Grundler grundler at parisc-linux dot org
* Copyright (C) 2003 James Bottomley jejb at parisc-linux dot org
* Copyright (C) 2005-2020 Douglas Gilbert dgilbert at interlog dot com
*
* 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, or (at your option)
* any later version.
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* See http://www.t10.org for relevant standards and drafts. The most recent
* draft is SBC-4 revision 2.
*/
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <unistd.h>
#define __STDC_FORMAT_MACROS 1
#include <inttypes.h>
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "sg_lib.h"
#include "sg_cmds_basic.h"
#include "sg_cmds_extra.h"
#include "sg_unaligned.h"
#include "sg_pr2serr.h"
#include "sg_pt.h"
static const char * version_str = "1.62 20201223";
#define RW_ERROR_RECOVERY_PAGE 1 /* can give alternate with --mode=MP */
#define SHORT_TIMEOUT 20 /* 20 seconds unless --wait given */
#define FORMAT_TIMEOUT (20 * 3600) /* 20 hours ! */
#define FOUR_TBYTE (4LL * 1000 * 1000 * 1000 * 1000)
#define LONG_FORMAT_TIMEOUT (40 * 3600) /* 40 hours */
#define EIGHT_TBYTE (FOUR_TBYTE * 2)
#define VLONG_FORMAT_TIMEOUT (80 * 3600) /* 3 days, 8 hours */
#define POLL_DURATION_SECS 60
#define POLL_DURATION_FFMT_SECS 10
#define DEF_POLL_TYPE_RS false /* false -> test unit ready;
true -> request sense */
#define MAX_BUFF_SZ 252
#if defined(MSC_VER) || defined(__MINGW32__)
#define HAVE_MS_SLEEP
#endif
#ifdef HAVE_MS_SLEEP
#include <windows.h>
#define sleep_for(seconds) Sleep( (seconds) * 1000)
#else
#define sleep_for(seconds) sleep(seconds)
#endif
/* FORMAT UNIT (SBC) and FORMAT MEDIUM (SSC) share the same opcode */
#define SG_FORMAT_MEDIUM_CMD 0x4
#define SG_FORMAT_MEDIUM_CMDLEN 6
/* FORMAT WITH PRESET (new in sbc4r18) */
#define SG_FORMAT_WITH_PRESET_CMD 0x38
#define SG_FORMAT_WITH_PRESET_CMDLEN 10
#define SENSE_BUFF_LEN 64 /* Arbitrary, could be larger */
struct opts_t {
bool cmplst; /* -C value */
bool cmplst_given;
bool dry_run; /* -d */
bool early; /* -e */
bool fmtmaxlba; /* -b (only with F_WITH_PRESET) */
bool fwait; /* -w (negated form IMMED) */
bool ip_def; /* -I */
bool long_lba; /* -l */
bool mode6; /* -6 */
bool pinfo; /* -p, deprecated, prefer fmtpinfo */
bool poll_type; /* -x 0|1 */
bool poll_type_given;
bool preset; /* -E */
bool quick; /* -Q */
bool do_rcap16; /* -l */
bool resize; /* -r */
bool rto_req; /* -R, deprecated, prefer fmtpinfo */
bool verbose_given;
bool verify; /* -y */
bool version_given;
int dcrt; /* -D (can be given once or twice) */
int lblk_sz; /* -s value */
int ffmt; /* -t value; fast_format if > 0 */
int fmtpinfo;
int format; /* -F */
uint32_t p_id; /* set by argument of --preset=id */
int mode_page; /* -M value */
int pfu; /* -P value */
int pie; /* -q value */
int sec_init; /* -S */
int tape; /* -T <format>, def: -1 */
int timeout; /* -m SECS, def: depends on IMMED bit */
int verbose; /* -v */
int64_t blk_count; /* -c value */
int64_t total_byte_count; /* from READ CAPACITY command */
const char * device_name;
};
static struct option long_options[] = {
{"count", required_argument, 0, 'c'},
{"cmplst", required_argument, 0, 'C'},
{"dcrt", no_argument, 0, 'D'},
{"dry-run", no_argument, 0, 'd'},
{"dry_run", no_argument, 0, 'd'},
{"early", no_argument, 0, 'e'},
{"ffmt", required_argument, 0, 't'},
{"fmtmaxlba", no_argument, 0, 'b'},
{"fmtpinfo", required_argument, 0, 'f'},
{"format", no_argument, 0, 'F'},
{"help", no_argument, 0, 'h'},
{"ip-def", no_argument, 0, 'I'},
{"ip_def", no_argument, 0, 'I'},
{"long", no_argument, 0, 'l'},
{"mode", required_argument, 0, 'M'},
{"pinfo", no_argument, 0, 'p'},
{"pfu", required_argument, 0, 'P'},
{"pie", required_argument, 0, 'q'},
{"poll", required_argument, 0, 'x'},
{"preset", required_argument, 0, 'E'},
{"quick", no_argument, 0, 'Q'},
{"resize", no_argument, 0, 'r'},
{"rto_req", no_argument, 0, 'R'},
{"security", no_argument, 0, 'S'},
{"six", no_argument, 0, '6'},
{"size", required_argument, 0, 's'},
{"tape", required_argument, 0, 'T'},
{"timeout", required_argument, 0, 'm'},
{"verbose", no_argument, 0, 'v'},
{"verify", no_argument, 0, 'y'},
{"version", no_argument, 0, 'V'},
{"wait", no_argument, 0, 'w'},
{0, 0, 0, 0},
};
static const char * fu_s = "Format unit";
static const char * fm_s = "Format medium";
static const char * fwp_s = "Format with preset";
static void
usage()
{
printf("Usage:\n"
" sg_format [--cmplst=0|1] [--count=COUNT] [--dcrt] "
"[--dry-run] [--early]\n"
" [--ffmt=FFMT] [--fmtmaxlba] [--fmtpinfo=FPI] "
"[--format] [--help]\n"
" [--ip-def] [--long] [--mode=MP] [--pfu=PFU] "
"[--pie=PIE]\n"
" [--pinfo] [--poll=PT] [--preset=ID] [--quick] "
"[--resize]\n"
" [--rto_req] [--security] [--six] [--size=LB_SZ] "
"[--tape=FM]\n"
" [--timeout=SECS] [--verbose] [--verify] "
"[--version] [--wait]\n"
" DEVICE\n"
" where:\n"
" --cmplst=0|1\n"
" -C 0|1 sets CMPLST bit in format cdb "
"(def: 1; if FFMT: 0)\n"
" --count=COUNT|-c COUNT number of blocks to report "
"after format or\n"
" resize. Format default is "
"same as current\n"
" --dcrt|-D disable certification (doesn't "
"verify media)\n"
" use twice to enable certification and "
"set FOV bit\n"
" --dry-run|-d bypass device modifying commands (i.e. "
"don't format)\n"
" --early|-e exit once format started (user can "
"monitor progress)\n"
" --ffmt=FFMT|-t FFMT fast format (def: 0 -> slow, "
"may visit every\n"
" block). 1 and 2 are fast formats; "
"1: after\n"
" format, unwritten data read "
"without error\n"
" --fmtpinfo=FPI|-f FPI FMTPINFO field value "
"(default: 0)\n"
" --format|-F do FORMAT UNIT (default: report current "
"count and size)\n"
" use thrice for FORMAT UNIT command "
"only\n"
" --fmtmaxlba|-b sets FMTMAXLBA field in FORMAT WITH "
"PRESET\n"
" --help|-h prints out this usage message\n"
" --ip-def|-I use default initialization pattern\n"
" --long|-l allow for 64 bit lbas (default: assume "
"32 bit lbas)\n"
" --mode=MP|-M MP mode page (def: 1 -> RW error "
"recovery mpage)\n"
" --pie=PIE|-q PIE Protection Information Exponent "
"(default: 0)\n"
" --pinfo|-p set upper bit of FMTPINFO field\n"
" (deprecated, use '--fmtpinfo=FPI' "
"instead)\n"
" --poll=PT|-x PT PT is poll type, 0 for test unit "
"ready\n"
" 1 for request sense (def: 0 (1 "
"for tape and\n"
" format with preset))\n");
printf(" --preset=ID|-E ID do FORMAT WITH PRESET command "
"with PRESET\n"
" IDENTIFIER field set to ID\n"
" --quick|-Q start format without pause for user "
"intervention\n"
" (i.e. no time to reconsider)\n"
" --resize|-r resize (rather than format) to COUNT "
"value\n"
" --rto_req|-R set lower bit of FMTPINFO field\n"
" (deprecated use '--fmtpinfo=FPI' "
"instead)\n"
" --security|-S set security initialization (SI) bit\n"
" --six|-6 use 6 byte MODE SENSE/SELECT to probe "
"disk\n"
" (def: use 10 byte MODE SENSE/SELECT)\n"
" --size=LB_SZ|-s LB_SZ bytes per logical block, "
"defaults to DEVICE's\n"
" current logical block size. Only "
"needed to\n"
" change current logical block "
"size\n"
" --tape=FM|-T FM request FORMAT MEDIUM with FORMAT "
"field set\n"
" to FM (def: 0 --> default format)\n"
" --timeout=SECS|-m SECS FORMAT UNIT/MEDIUM command "
"timeout in seconds\n"
" --verbose|-v increase verbosity\n"
" --verify|-y sets VERIFY bit in FORMAT MEDIUM (tape)\n"
" --version|-V print version details and exit\n"
" --wait|-w format commands wait until format "
"operations complete\n"
" (default: set IMMED=1 and poll with "
"Test Unit Ready)\n\n"
"\tExample: sg_format --format /dev/sdc\n\n"
"This utility formats a SCSI disk [FORMAT UNIT] or resizes "
"it. Alternatively\nif '--tape=FM' is given formats a tape "
"[FORMAT MEDIUM]. Another alternative\nis doing the FORMAT "
"WITH PRESET command when '--preset=ID' is given.\n\n");
printf("WARNING: This utility will destroy all the data on the "
"DEVICE when\n\t '--format', '--tape=FM' or '--preset=ID' "
"is given. Double check\n\t that you have specified the "
"correct DEVICE.\n");
}
/* Invokes a SCSI FORMAT MEDIUM command (SSC). Return of 0 -> success,
* various SG_LIB_CAT_* positive values or -1 -> other errors */
static int
sg_ll_format_medium(int sg_fd, bool verify, bool immed, int format,
void * paramp, int transfer_len, int timeout, bool noisy,
int verbose)
{
int ret, res, sense_cat;
uint8_t fm_cdb[SG_FORMAT_MEDIUM_CMDLEN] =
{SG_FORMAT_MEDIUM_CMD, 0, 0, 0, 0, 0};
uint8_t sense_b[SENSE_BUFF_LEN];
struct sg_pt_base * ptvp;
if (verify)
fm_cdb[1] |= 0x2;
if (immed)
fm_cdb[1] |= 0x1;
if (format)
fm_cdb[2] |= (0xf & format);
if (transfer_len > 0)
sg_put_unaligned_be16(transfer_len, fm_cdb + 3);
if (verbose) {
char b[128];
pr2serr(" %s cdb: %s\n", fm_s,
sg_get_command_str(fm_cdb, SG_FORMAT_MEDIUM_CMDLEN,
false, sizeof(b), b));
}
ptvp = construct_scsi_pt_obj();
if (NULL == ptvp) {
pr2serr("%s: out of memory\n", __func__);
return sg_convert_errno(ENOMEM);
}
set_scsi_pt_cdb(ptvp, fm_cdb, sizeof(fm_cdb));
set_scsi_pt_sense(ptvp, sense_b, sizeof(sense_b));
set_scsi_pt_data_out(ptvp, (uint8_t *)paramp, transfer_len);
res = do_scsi_pt(ptvp, sg_fd, timeout, verbose);
ret = sg_cmds_process_resp(ptvp, fm_s, res, noisy, verbose,
&sense_cat);
if (-1 == ret)
ret = sg_convert_errno(get_scsi_pt_os_err(ptvp));
else if (-2 == ret) {
switch (sense_cat) {
case SG_LIB_CAT_RECOVERED:
case SG_LIB_CAT_NO_SENSE:
ret = 0;
break;
default:
ret = sense_cat;
break;
}
} else {
ret = 0;
if (verbose)
pr2serr("%s command %s without error\n", fm_s,
(immed ? "launched" : "completed"));
}
destruct_scsi_pt_obj(ptvp);
return ret;
}
/* Invokes a SCSI FORMAT WITH PRESET command (SBC). Return of 0 -> success,
* various SG_LIB_CAT_* positive values or -1 -> other errors */
static int
sg_ll_format_with_preset(int sg_fd, bool immed, bool fmtmaxlba,
uint32_t preset_id, int timeout, bool noisy,
int verbose)
{
int ret, res, sense_cat;
uint8_t fwp_cdb[SG_FORMAT_WITH_PRESET_CMDLEN] =
{SG_FORMAT_WITH_PRESET_CMD, 0, 0, 0, 0, 0, 0, 0, 0, 0};
uint8_t sense_b[SENSE_BUFF_LEN];
struct sg_pt_base * ptvp;
if (immed)
fwp_cdb[1] |= 0x80;
if (fmtmaxlba)
fwp_cdb[1] |= 0x40;
if (preset_id > 0)
sg_put_unaligned_be32(preset_id, fwp_cdb + 2);
if (verbose) {
char b[128];
pr2serr(" %s cdb: %s\n", fwp_s,
sg_get_command_str(fwp_cdb,
SG_FORMAT_WITH_PRESET_CMDLEN,
false, sizeof(b), b));
}
ptvp = construct_scsi_pt_obj();
if (NULL == ptvp) {
pr2serr("%s: out of memory\n", __func__);
return sg_convert_errno(ENOMEM);
}
set_scsi_pt_cdb(ptvp, fwp_cdb, sizeof(fwp_cdb));
set_scsi_pt_sense(ptvp, sense_b, sizeof(sense_b));
res = do_scsi_pt(ptvp, sg_fd, timeout, verbose);
ret = sg_cmds_process_resp(ptvp, fwp_s, res, noisy, verbose,
&sense_cat);
if (-1 == ret)
ret = sg_convert_errno(get_scsi_pt_os_err(ptvp));
else if (-2 == ret) {
switch (sense_cat) {
case SG_LIB_CAT_RECOVERED:
case SG_LIB_CAT_NO_SENSE:
ret = 0;
break;
default:
ret = sense_cat;
break;
}
} else {
ret = 0;
if (verbose)
pr2serr("%s command %s without error\n", fwp_s,
(immed ? "launched" : "completed"));
}
destruct_scsi_pt_obj(ptvp);
return ret;
}
/* Return 0 on success, else see sg_ll_format_unit_v2() */
static int
scsi_format_unit(int fd, const struct opts_t * op)
{
bool need_param_lst, longlist, ip_desc, first;
bool immed = ! op->fwait;
int res, progress, pr, rem, param_sz, off, resp_len, tmout;
int poll_wait_secs;
int vb = op->verbose;
const int SH_FORMAT_HEADER_SZ = 4;
const int LONG_FORMAT_HEADER_SZ = 8;
const int INIT_PATTERN_DESC_SZ = 4;
const int max_param_sz = LONG_FORMAT_HEADER_SZ + INIT_PATTERN_DESC_SZ;
uint8_t * param;
uint8_t * free_param = NULL;
char b[80];
param = sg_memalign(max_param_sz, 0, &free_param, false);
if (NULL == param) {
pr2serr("%s: unable to obtain heap for parameter list\n",
__func__);
return sg_convert_errno(ENOMEM);
}
if (immed)
tmout = SHORT_TIMEOUT;
else {
if (op->total_byte_count > EIGHT_TBYTE)
tmout = VLONG_FORMAT_TIMEOUT;
else if (op->total_byte_count > FOUR_TBYTE)
tmout = LONG_FORMAT_TIMEOUT;
else
tmout = FORMAT_TIMEOUT;
}
if (op->timeout > tmout)
tmout = op->timeout;
longlist = (op->pie > 0); /* only set LONGLIST if PI_EXPONENT>0 */
ip_desc = (op->ip_def || op->sec_init);
off = longlist ? LONG_FORMAT_HEADER_SZ : SH_FORMAT_HEADER_SZ;
param[0] = op->pfu & 0x7; /* PROTECTION_FIELD_USAGE (bits 2-0) */
param[1] = (immed ? 0x2 : 0); /* FOV=0, [DPRY,DCRT,STPF,IP=0] */
if (1 == op->dcrt)
param[1] |= 0xa0; /* FOV=1, DCRT=1 */
else if (op->dcrt > 1)
param[1] |= 0x80; /* FOV=1, DCRT=0 */
if (ip_desc) {
param[1] |= 0x88; /* FOV=1, IP=1 */
if (op->sec_init)
param[off + 0] = 0x20; /* SI=1 in IP desc */
}
if (longlist)
param[3] = (op->pie & 0xf);/* PROTECTION_INTERVAL_EXPONENT */
/* with the long parameter list header, P_I_INFORMATION is always 0 */
need_param_lst = (immed || op->cmplst || (op->dcrt > 0) || ip_desc ||
(op->pfu > 0) || (op->pie > 0));
param_sz = need_param_lst ?
(off + (ip_desc ? INIT_PATTERN_DESC_SZ : 0)) : 0;
if (op->dry_run) {
res = 0;
pr2serr("Due to --dry-run option bypassing FORMAT UNIT "
"command\n");
if (vb) {
if (need_param_lst) {
pr2serr(" %s would have received parameter "
"list: ", fu_s);
hex2stderr(param, max_param_sz, -1);
} else
pr2serr(" %s would not have received a "
"parameter list\n", fu_s);
pr2serr(" %s cdb fields: fmtpinfo=0x%x, "
"longlist=%d, fmtdata=%d, cmplst=%d, "
"ffmt=%d [timeout=%d secs]\n", fu_s,
op->fmtpinfo, longlist, need_param_lst,
op->cmplst, op->ffmt, tmout);
}
} else
res = sg_ll_format_unit_v2(fd, op->fmtpinfo, longlist,
need_param_lst, op->cmplst, 0,
op->ffmt, tmout, param, param_sz,
true, vb);
if (free_param)
free(free_param);
if (res) {
sg_get_category_sense_str(res, sizeof(b), b, vb);
pr2serr("%s command: %s\n", fu_s, b);
return res;
} else if (op->verbose)
pr2serr("%s command %s without error\n", fu_s,
(immed ? "launched" : "completed"));
if (! immed)
return 0;
if (! op->dry_run)
printf("\n%s has started\n", fu_s);
if (op->early) {
if (immed)
printf("%s continuing,\n request sense or "
"test unit ready can be used to monitor "
"progress\n", fu_s);
return 0;
}
if (op->dry_run) {
printf("No point in polling for progress, so exit\n");
return 0;
}
poll_wait_secs = op->ffmt ? POLL_DURATION_FFMT_SECS :
POLL_DURATION_SECS;
if (! op->poll_type) {
for(first = true; ; first = false) {
sleep_for(poll_wait_secs);
progress = -1;
res = sg_ll_test_unit_ready_progress(fd, 0, &progress,
true, (vb > 1) ? (vb - 1) : 0);
if (progress >= 0) {
pr = (progress * 100) / 65536;
rem = ((progress * 100) % 65536) / 656;
printf("%s in progress, %d.%02d%% done\n",
fu_s, pr, rem);
} else {
if (first && op->verbose)
pr2serr("%s seems to be successful "
"and finished quickly\n",
fu_s);
break;
}
}
}
if (op->poll_type || (SG_LIB_CAT_NOT_READY == res)) {
uint8_t * reqSense;
uint8_t * free_reqSense = NULL;
reqSense = sg_memalign(MAX_BUFF_SZ, 0, &free_reqSense, false);
if (NULL == reqSense) {
pr2serr("%s: unable to obtain heap for Request "
"Sense\n", __func__);
return sg_convert_errno(ENOMEM);
}
for(first = true; ; first = false) {
sleep_for(poll_wait_secs);
memset(reqSense, 0x0, MAX_BUFF_SZ);
res = sg_ll_request_sense(fd, false, reqSense,
MAX_BUFF_SZ, false,
(vb > 1) ? (vb - 1) : 0);
if (res) {
pr2serr("polling with Request Sense command "
"failed [res=%d]\n", res);
break;
}
resp_len = reqSense[7] + 8;
if (vb > 1) {
pr2serr("Parameter data in hex:\n");
hex2stderr(reqSense, resp_len, 1);
}
progress = -1;
sg_get_sense_progress_fld(reqSense, resp_len,
&progress);
if (progress >= 0) {
pr = (progress * 100) / 65536;
rem = ((progress * 100) % 65536) / 656;
printf("%s in progress, %d.%02d%% done\n",
fu_s, pr, rem);
} else {
if (first && op->verbose)
pr2serr("%s seems to be successful "
"and finished quickly\n",
fu_s);
break;
}
}
if (free_reqSense)
free(free_reqSense);
}
printf("FORMAT UNIT Complete\n");
return 0;
}
/* Return 0 on success, else see sg_ll_format_medium() above */
static int
scsi_format_medium(int fd, const struct opts_t * op)
{
bool first;
bool immed = ! op->fwait;
int res, progress, pr, rem, resp_len, tmout;
int vb = op->verbose;
char b[80];
if (immed)
tmout = SHORT_TIMEOUT;
else {
if (op->total_byte_count > EIGHT_TBYTE)
tmout = VLONG_FORMAT_TIMEOUT;
else if (op->total_byte_count > FOUR_TBYTE)
tmout = LONG_FORMAT_TIMEOUT;
else
tmout = FORMAT_TIMEOUT;
}
if (op->timeout > tmout)
tmout = op->timeout;
if (op->dry_run) {
res = 0;
pr2serr("Due to --dry-run option bypassing %s command\n",
fm_s);
} else
res = sg_ll_format_medium(fd, op->verify, immed,
0xf & op->tape, NULL, 0, tmout,
true, vb);
if (res) {
sg_get_category_sense_str(res, sizeof(b), b, vb);
pr2serr("%s command: %s\n", fm_s, b);
return res;
}
if (! immed)
return 0;
if (! op->dry_run)
printf("\n%s has started\n", fm_s);
if (op->early) {
if (immed)
printf("%s continuing,\n request sense or "
"test unit ready can be used to monitor "
"progress\n", fm_s);
return 0;
}
if (op->dry_run) {
printf("No point in polling for progress, so exit\n");
return 0;
}
if (! op->poll_type) {
for(first = true; ; first = false) {
sleep_for(POLL_DURATION_SECS);
progress = -1;
res = sg_ll_test_unit_ready_progress(fd, 0, &progress,
true, (vb > 1) ? (vb - 1) : 0);
if (progress >= 0) {
pr = (progress * 100) / 65536;
rem = ((progress * 100) % 65536) / 656;
printf("%s in progress, %d.%02d%% done\n",
fm_s, pr, rem);
} else {
if (first && op->verbose)
pr2serr("%s seems to be successful "
"and finished quickly\n",
fm_s);
break;
}
}
}
if (op->poll_type || (SG_LIB_CAT_NOT_READY == res)) {
uint8_t * reqSense;
uint8_t * free_reqSense = NULL;
reqSense = sg_memalign(MAX_BUFF_SZ, 0, &free_reqSense, false);
if (NULL == reqSense) {
pr2serr("%s: unable to obtain heap for Request "
"Sense\n", __func__);
return sg_convert_errno(ENOMEM);
}
for(first = true; ; first = false) {
sleep_for(POLL_DURATION_SECS);
memset(reqSense, 0x0, MAX_BUFF_SZ);
res = sg_ll_request_sense(fd, false, reqSense,
MAX_BUFF_SZ, false,
(vb > 1) ? (vb - 1) : 0);
if (res) {
pr2serr("polling with Request Sense command "
"failed [res=%d]\n", res);
break;
}
resp_len = reqSense[7] + 8;
if (vb > 1) {
pr2serr("Parameter data in hex:\n");
hex2stderr(reqSense, resp_len, 1);
}
progress = -1;
sg_get_sense_progress_fld(reqSense, resp_len,
&progress);
if (progress >= 0) {
pr = (progress * 100) / 65536;
rem = ((progress * 100) % 65536) / 656;
printf("%s in progress, %d.%02d%% done\n",
fm_s, pr, rem);
} else {
if (first && op->verbose)
pr2serr("%s seems to be successful "
"and finished quickly\n",
fm_s);
break;
}
}
if (free_reqSense)
free(free_reqSense);
}
printf("FORMAT MEDIUM Complete\n");
return 0;
}
/* Return 0 on success, else see sg_ll_format_medium() above */
static int
scsi_format_with_preset(int fd, const struct opts_t * op)
{
bool first;
bool immed = ! op->fwait;
int res, progress, pr, rem, resp_len, tmout;
int vb = op->verbose;
char b[80];
if (immed)
tmout = SHORT_TIMEOUT;
else {
if (op->total_byte_count > EIGHT_TBYTE)
tmout = VLONG_FORMAT_TIMEOUT;
else if (op->total_byte_count > FOUR_TBYTE)
tmout = LONG_FORMAT_TIMEOUT;
else
tmout = FORMAT_TIMEOUT;
}
if (op->timeout > tmout)
tmout = op->timeout;
if (op->dry_run) {
res = 0;
pr2serr("Due to --dry-run option bypassing FORMAT WITH "
"PRESET command\n");
} else
res = sg_ll_format_with_preset(fd, immed, op->fmtmaxlba,
op->p_id, tmout, true, vb);
if (res) {
sg_get_category_sense_str(res, sizeof(b), b, vb);
pr2serr("%s command: %s\n", fwp_s, b);
return res;
}
if (! immed)
return 0;
if (! op->dry_run)
printf("\n%s has started\n", fwp_s);
if (op->early) {
if (immed)
printf("%s continuing,\n Request sense can "
"be used to monitor progress\n", fwp_s);
return 0;
}
if (op->dry_run) {
printf("No point in polling for progress, so exit\n");
return 0;
}
if (! op->poll_type) {
for(first = true; ; first = false) {
sleep_for(POLL_DURATION_SECS);
progress = -1;
res = sg_ll_test_unit_ready_progress(fd, 0, &progress,
true, (vb > 1) ? (vb - 1) : 0);
if (progress >= 0) {
pr = (progress * 100) / 65536;
rem = ((progress * 100) % 65536) / 656;
printf("%s in progress, %d.%02d%% done\n",
fwp_s, pr, rem);
} else {
if (first && op->verbose)
pr2serr("%s seems to be successful "
"and finished quickly\n",
fwp_s);
break;
}
}
}
if (op->poll_type || (SG_LIB_CAT_NOT_READY == res)) {
uint8_t * reqSense;
uint8_t * free_reqSense = NULL;
reqSense = sg_memalign(MAX_BUFF_SZ, 0, &free_reqSense, false);
if (NULL == reqSense) {
pr2serr("%s: unable to obtain heap for Request "
"Sense\n", __func__);
return sg_convert_errno(ENOMEM);
}
for(first = true; ; first = false) {
sleep_for(POLL_DURATION_SECS);
memset(reqSense, 0x0, MAX_BUFF_SZ);
res = sg_ll_request_sense(fd, false, reqSense,
MAX_BUFF_SZ, false,
(vb > 1) ? (vb - 1) : 0);
if (res) {
pr2serr("polling with Request Sense command "
"failed [res=%d]\n", res);
break;
}
resp_len = reqSense[7] + 8;
if (vb > 1) {
pr2serr("Parameter data in hex:\n");
hex2stderr(reqSense, resp_len, 1);
}
progress = -1;
sg_get_sense_progress_fld(reqSense, resp_len,
&progress);
if (progress >= 0) {
pr = (progress * 100) / 65536;
rem = ((progress * 100) % 65536) / 656;
printf("%s in progress, %d.%02d%% done\n",
fwp_s, pr, rem);
} else {
if (first && op->verbose)
pr2serr("%s seems to be successful "
"and finished quickly\n",
fwp_s);
break;
}
}
if (free_reqSense)
free(free_reqSense);
}
printf("FORMAT WITH PRESET Complete\n");
return 0;
}
#define VPD_DEVICE_ID 0x83
#define VPD_ASSOC_LU 0
#define VPD_ASSOC_TPORT 1
#define TPROTO_ISCSI 5
static char *
get_lu_name(const uint8_t * bp, int u_len, char * b, int b_len)
{
int len, off, sns_dlen, dlen, k;
uint8_t u_sns[512];
char * cp;
len = u_len - 4;
bp += 4;
off = -1;
if (0 == sg_vpd_dev_id_iter(bp, len, &off, VPD_ASSOC_LU,
8 /* SCSI name string (sns) */,
3 /* UTF-8 */)) {
sns_dlen = bp[off + 3];
memcpy(u_sns, bp + off + 4, sns_dlen);
/* now want to check if this is iSCSI */
off = -1;
if (0 == sg_vpd_dev_id_iter(bp, len, &off, VPD_ASSOC_TPORT,
8 /* SCSI name string (sns) */,
3 /* UTF-8 */)) {
if ((0x80 & bp[1]) &&
(TPROTO_ISCSI == (bp[0] >> 4))) {
snprintf(b, b_len, "%.*s", sns_dlen, u_sns);
return b;
}
}
} else
sns_dlen = 0;
if (0 == sg_vpd_dev_id_iter(bp, len, &off, VPD_ASSOC_LU,
3 /* NAA */, 1 /* binary */)) {
dlen = bp[off + 3];
if (! ((8 == dlen) || (16 ==dlen)))
return b;
cp = b;
for (k = 0; ((k < dlen) && (b_len > 1)); ++k) {
snprintf(cp, b_len, "%02x", bp[off + 4 + k]);
cp += 2;
b_len -= 2;
}
} else if (0 == sg_vpd_dev_id_iter(bp, len, &off, VPD_ASSOC_LU,
2 /* EUI */, 1 /* binary */)) {
dlen = bp[off + 3];
if (! ((8 == dlen) || (12 == dlen) || (16 ==dlen)))
return b;
cp = b;
for (k = 0; ((k < dlen) && (b_len > 1)); ++k) {
snprintf(cp, b_len, "%02x", bp[off + 4 + k]);
cp += 2;
b_len -= 2;
}
} else if (sns_dlen > 0)
snprintf(b, b_len, "%.*s", sns_dlen, u_sns);
return b;
}
#define SAFE_STD_INQ_RESP_LEN 36
#define VPD_SUPPORTED_VPDS 0x0
#define VPD_UNIT_SERIAL_NUM 0x80
#define VPD_DEVICE_ID 0x83
#define MAX_VPD_RESP_LEN 256
static int
print_dev_id(int fd, uint8_t * sinq_resp, int max_rlen,
const struct opts_t * op)
{
int k, n, verb, pdt, has_sn, has_di;
int res = 0;
uint8_t * b;
uint8_t * free_b = NULL;
char a[MAX_VPD_RESP_LEN];
char pdt_name[64];
verb = (op->verbose > 1) ? op->verbose - 1 : 0;
memset(sinq_resp, 0, max_rlen);
b = sg_memalign(MAX_VPD_RESP_LEN, 0, &free_b, false);
if (NULL == b) {
res = sg_convert_errno(ENOMEM);
goto out;
}
/* Standard INQUIRY */
res = sg_ll_inquiry(fd, false, false, 0, b, SAFE_STD_INQ_RESP_LEN,
true, verb);
if (res)
goto out;
n = b[4] + 5;
if (n > SAFE_STD_INQ_RESP_LEN)
n = SAFE_STD_INQ_RESP_LEN;
memcpy(sinq_resp, b, (n < max_rlen) ? n : max_rlen);
if (n == SAFE_STD_INQ_RESP_LEN) {
pdt = b[0] & 0x1f;
printf(" %.8s %.16s %.4s peripheral_type: %s [0x%x]\n",
(const char *)(b + 8), (const char *)(b + 16),
(const char *)(b + 32),
sg_get_pdt_str(pdt, sizeof(pdt_name), pdt_name), pdt);
if (op->verbose)
printf(" PROTECT=%d\n", !!(b[5] & 1));
if (b[5] & 1)
printf(" << supports protection information>>"
"\n");
} else {
pr2serr("Short INQUIRY response: %d bytes, expect at least "
"36\n", n);
res = SG_LIB_CAT_OTHER;
goto out;
}
res = sg_ll_inquiry(fd, false, true, VPD_SUPPORTED_VPDS, b,
SAFE_STD_INQ_RESP_LEN, true, verb);
if (res) {
if (op->verbose)
pr2serr("VPD_SUPPORTED_VPDS gave res=%d\n", res);
res = 0;
goto out;
}
if (VPD_SUPPORTED_VPDS != b[1]) {
if (op->verbose)
pr2serr("VPD_SUPPORTED_VPDS corrupted\n");
goto out;
}
n = sg_get_unaligned_be16(b + 2);
if (n > (SAFE_STD_INQ_RESP_LEN - 4))
n = (SAFE_STD_INQ_RESP_LEN - 4);
for (k = 0, has_sn = 0, has_di = 0; k < n; ++k) {
if (VPD_UNIT_SERIAL_NUM == b[4 + k])
++has_sn;
else if (VPD_DEVICE_ID == b[4 + k]) {
++has_di;
break;
}
}
if (has_sn) {
res = sg_ll_inquiry(fd, false, true /* evpd */,
VPD_UNIT_SERIAL_NUM, b, MAX_VPD_RESP_LEN,
true, verb);
if (res) {
if (op->verbose)
pr2serr("VPD_UNIT_SERIAL_NUM gave res=%d\n",
res);
res = 0;
goto out;
}
if (VPD_UNIT_SERIAL_NUM != b[1]) {
if (op->verbose)
pr2serr("VPD_UNIT_SERIAL_NUM corrupted\n");
goto out;
}
n = sg_get_unaligned_be16(b + 2);
if (n > (int)(MAX_VPD_RESP_LEN - 4))
n = (MAX_VPD_RESP_LEN - 4);
printf(" Unit serial number: %.*s\n", n,
(const char *)(b + 4));
}
if (has_di) {
res = sg_ll_inquiry(fd, false, true /* evpd */, VPD_DEVICE_ID,
b, MAX_VPD_RESP_LEN, true, verb);
if (res) {
if (op->verbose)
pr2serr("VPD_DEVICE_ID gave res=%d\n", res);
res = 0;
goto out;
}
if (VPD_DEVICE_ID != b[1]) {
if (op->verbose)
pr2serr("VPD_DEVICE_ID corrupted\n");
goto out;
}
n = sg_get_unaligned_be16(b + 2);
if (n > (int)(MAX_VPD_RESP_LEN - 4))
n = (MAX_VPD_RESP_LEN - 4);
n = strlen(get_lu_name(b, n + 4, a, sizeof(a)));
if (n > 0)
printf(" LU name: %.*s\n", n, a);
}
out:
if (free_b)
free(free_b);
return res;
}
#define RCAP_REPLY_LEN 32
/* Returns block size or -2 if do_16==0 and the number of blocks is too
* big, or returns -1 for other error. */
static int
print_read_cap(int fd, struct opts_t * op)