/
block.cc
1243 lines (1135 loc) · 36.8 KB
/
block.cc
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
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2001-2012 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2018 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
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
Affero General Public License for more details.
You should have received a copy of the GNU Affero 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.
*/
/*
* Kern Sibbald, March MMI
* added BB02 format October MMII
*/
/**
@file
* tape block handling functions
*/
#include "include/bareos.h"
#include "stored/stored.h"
#include "stored/crc32/crc32.h"
#include "stored/dev.h"
#include "stored/device.h"
#include "stored/label.h"
#include "stored/socket_server.h"
#include "stored/spool.h"
#include "lib/berrno.h"
#include "lib/edit.h"
#include "include/jcr.h"
namespace storagedaemon {
static bool TerminateWritingVolume(DeviceControlRecord* dcr);
static bool DoNewFileBookkeeping(DeviceControlRecord* dcr);
static void RereadLastBlock(DeviceControlRecord* dcr);
bool forge_on = false; /* proceed inspite of I/O errors */
/**
* Dump the block header, then walk through
* the block printing out the record headers.
*/
void DumpBlock(DeviceBlock* b, const char* msg)
{
ser_declare;
char* p;
char Id[BLKHDR_ID_LENGTH + 1];
uint32_t CheckSum, BlockCheckSum;
uint32_t block_len;
uint32_t BlockNumber;
uint32_t VolSessionId, VolSessionTime, data_len;
int32_t FileIndex;
int32_t Stream;
int bhl, rhl;
char buf1[100], buf2[100];
UnserBegin(b->buf, BLKHDR1_LENGTH);
unser_uint32(CheckSum);
unser_uint32(block_len);
unser_uint32(BlockNumber);
UnserBytes(Id, BLKHDR_ID_LENGTH);
ASSERT(UnserLength(b->buf) == BLKHDR1_LENGTH);
Id[BLKHDR_ID_LENGTH] = 0;
if (Id[3] == '2') {
unser_uint32(VolSessionId);
unser_uint32(VolSessionTime);
bhl = BLKHDR2_LENGTH;
rhl = RECHDR2_LENGTH;
} else {
VolSessionId = VolSessionTime = 0;
bhl = BLKHDR1_LENGTH;
rhl = RECHDR1_LENGTH;
}
if (block_len > 4000000) {
Dmsg3(20, "Dump block %s 0x%x blocksize too big %u\n", msg, b, block_len);
return;
}
BlockCheckSum =
crc32_fast((uint8_t*)b->buf + BLKHDR_CS_LENGTH, block_len - BLKHDR_CS_LENGTH);
Pmsg6(000,
_("Dump block %s %x: size=%d BlkNum=%d\n"
" Hdrcksum=%x cksum=%x\n"),
msg, b, block_len, BlockNumber, CheckSum, BlockCheckSum);
p = b->buf + bhl;
while (p < (b->buf + block_len + WRITE_RECHDR_LENGTH)) {
UnserBegin(p, WRITE_RECHDR_LENGTH);
if (rhl == RECHDR1_LENGTH) {
unser_uint32(VolSessionId);
unser_uint32(VolSessionTime);
}
unser_int32(FileIndex);
unser_int32(Stream);
unser_uint32(data_len);
Pmsg6(000, _(" Rec: VId=%u VT=%u FI=%s Strm=%s len=%d p=%x\n"),
VolSessionId, VolSessionTime, FI_to_ascii(buf1, FileIndex),
stream_to_ascii(buf2, Stream, FileIndex), data_len, p);
p += data_len + rhl;
}
}
/**
* Create a new block structure.
* We pass device so that the block can inherit the
* min and max block sizes.
*/
DeviceBlock* new_block(Device* dev)
{
DeviceBlock* block = (DeviceBlock*)GetMemory(sizeof(DeviceBlock));
memset(block, 0, sizeof(DeviceBlock));
if (dev->max_block_size == 0) {
block->buf_len = dev->device->label_block_size;
Dmsg1(100,
"created new block of blocksize %d (dev->device->label_block_size) "
"as dev->max_block_size is zero\n",
block->buf_len);
} else {
block->buf_len = dev->max_block_size;
Dmsg1(100, "created new block of blocksize %d (dev->max_block_size)\n",
block->buf_len);
}
block->dev = dev;
block->block_len = block->buf_len; /* default block size */
block->buf = GetMemory(block->buf_len);
EmptyBlock(block);
block->BlockVer = BLOCK_VER; /* default write version */
Dmsg1(650, "Returning new block=%x\n", block);
return block;
}
/**
* Duplicate an existing block (eblock)
*/
DeviceBlock* dup_block(DeviceBlock* eblock)
{
DeviceBlock* block = (DeviceBlock*)GetMemory(sizeof(DeviceBlock));
int buf_len = SizeofPoolMemory(eblock->buf);
memcpy(block, eblock, sizeof(DeviceBlock));
block->buf = GetMemory(buf_len);
memcpy(block->buf, eblock->buf, buf_len);
return block;
}
/**
* Only the first block checksum error was reported.
* If there are more, report it now.
*/
void PrintBlockReadErrors(JobControlRecord* jcr, DeviceBlock* block)
{
if (block->read_errors > 1) {
Jmsg(jcr, M_ERROR, 0, _("%d block read errors not printed.\n"),
block->read_errors);
}
}
/**
* Free block
*/
void FreeBlock(DeviceBlock* block)
{
if (block) {
Dmsg1(999, "FreeBlock buffer %x\n", block->buf);
FreeMemory(block->buf);
Dmsg1(999, "FreeBlock block %x\n", block);
FreeMemory((POOLMEM*)block);
}
}
/**
* Empty the block -- for writing
*/
void EmptyBlock(DeviceBlock* block)
{
block->binbuf = WRITE_BLKHDR_LENGTH;
block->bufp = block->buf + block->binbuf;
block->read_len = 0;
block->write_failed = false;
block->block_read = false;
block->FirstIndex = block->LastIndex = 0;
}
/**
* Create block header just before write. The space
* in the buffer should have already been reserved by
* init_block.
*/
static uint32_t SerBlockHeader(DeviceBlock* block, bool DoChecksum)
{
ser_declare;
uint32_t CheckSum = 0;
uint32_t block_len = block->binbuf;
Dmsg1(1390, "SerBlockHeader: block_len=%d\n", block_len);
SerBegin(block->buf, BLKHDR2_LENGTH);
ser_uint32(CheckSum);
ser_uint32(block_len);
ser_uint32(block->BlockNumber);
SerBytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
if (BLOCK_VER >= 2) {
ser_uint32(block->VolSessionId);
ser_uint32(block->VolSessionTime);
}
/*
* Checksum whole block except for the checksum
*/
if (DoChecksum) {
CheckSum = crc32_fast((uint8_t*)block->buf + BLKHDR_CS_LENGTH,
block_len - BLKHDR_CS_LENGTH);
}
Dmsg1(1390, "ser_bloc_header: checksum=%x\n", CheckSum);
SerBegin(block->buf, BLKHDR2_LENGTH);
ser_uint32(CheckSum); /* now add checksum to block header */
return CheckSum;
}
/**
* UnSerialize the block header for reading block.
* This includes setting all the buffer pointers correctly.
*
* Returns: false on failure (not a block)
* true on success
*/
static inline bool unSerBlockHeader(JobControlRecord* jcr,
Device* dev,
DeviceBlock* block)
{
ser_declare;
char Id[BLKHDR_ID_LENGTH + 1];
uint32_t CheckSum, BlockCheckSum;
uint32_t block_len;
uint32_t block_end;
uint32_t BlockNumber;
int bhl;
UnserBegin(block->buf, BLKHDR_LENGTH);
unser_uint32(CheckSum);
unser_uint32(block_len);
unser_uint32(BlockNumber);
UnserBytes(Id, BLKHDR_ID_LENGTH);
ASSERT(UnserLength(block->buf) == BLKHDR1_LENGTH);
Id[BLKHDR_ID_LENGTH] = 0;
if (Id[3] == '1') {
bhl = BLKHDR1_LENGTH;
block->BlockVer = 1;
block->bufp = block->buf + bhl;
if (!bstrncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH)) {
dev->dev_errno = EIO;
Mmsg4(dev->errmsg,
_("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". "
"Buffer discarded.\n"),
dev->file, dev->block_num, BLKHDR1_ID, Id);
if (block->read_errors == 0 || verbose >= 2) {
Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
}
block->read_errors++;
return false;
}
} else if (Id[3] == '2') {
unser_uint32(block->VolSessionId);
unser_uint32(block->VolSessionTime);
bhl = BLKHDR2_LENGTH;
block->BlockVer = 2;
block->bufp = block->buf + bhl;
if (!bstrncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH)) {
dev->dev_errno = EIO;
Mmsg4(dev->errmsg,
_("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". "
"Buffer discarded.\n"),
dev->file, dev->block_num, BLKHDR2_ID, Id);
if (block->read_errors == 0 || verbose >= 2) {
Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
}
block->read_errors++;
return false;
}
} else {
dev->dev_errno = EIO;
Mmsg4(dev->errmsg,
_("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer "
"discarded.\n"),
dev->file, dev->block_num, BLKHDR2_ID, Id);
Dmsg1(50, "%s", dev->errmsg);
if (block->read_errors == 0 || verbose >= 2) {
Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
}
block->read_errors++;
unser_uint32(block->VolSessionId);
unser_uint32(block->VolSessionTime);
return false;
}
/*
* Sanity check
*/
if (block_len > MAX_BLOCK_LENGTH) {
dev->dev_errno = EIO;
Mmsg3(dev->errmsg,
_("Volume data error at %u:%u! Block length %u is insane (too "
"large), probably due to a bad archive.\n"),
dev->file, dev->block_num, block_len);
if (block->read_errors == 0 || verbose >= 2) {
Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
}
block->read_errors++;
return false;
}
Dmsg1(390, "unSerBlockHeader block_len=%d\n", block_len);
/*
* Find end of block or end of buffer whichever is smaller
*/
if (block_len > block->read_len) {
block_end = block->read_len;
} else {
block_end = block_len;
}
block->binbuf = block_end - bhl;
block->block_len = block_len;
block->BlockNumber = BlockNumber;
Dmsg3(390, "Read binbuf = %d %d block_len=%d\n", block->binbuf, bhl,
block_len);
if (block_len <= block->read_len && dev->DoChecksum()) {
BlockCheckSum = crc32_fast((uint8_t*)block->buf + BLKHDR_CS_LENGTH,
block_len - BLKHDR_CS_LENGTH);
if (BlockCheckSum != CheckSum) {
dev->dev_errno = EIO;
Mmsg6(dev->errmsg,
_("Volume data error at %u:%u!\n"
"Block checksum mismatch in block=%u len=%d: calc=%x blk=%x\n"),
dev->file, dev->block_num, (unsigned)BlockNumber, block_len,
BlockCheckSum, CheckSum);
if (block->read_errors == 0 || verbose >= 2) {
Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
DumpBlock(block, "with checksum error");
}
block->read_errors++;
if (!forge_on) { return false; }
}
}
return true;
}
static void RereadLastBlock(DeviceControlRecord* dcr)
{
#define CHECK_LAST_BLOCK
#ifdef CHECK_LAST_BLOCK
bool ok = true;
Device* dev = dcr->dev;
JobControlRecord* jcr = dcr->jcr;
DeviceBlock* block = dcr->block;
/*
* If the device is a tape and it supports backspace record,
* we backspace over one or two eof marks depending on
* how many we just wrote, then over the last record,
* then re-read it and verify that the block number is
* correct.
*/
if (dev->IsTape() && dev->HasCap(CAP_BSR)) {
/*
* Now back up over what we wrote and read the last block
*/
if (!dev->bsf(1)) {
BErrNo be;
ok = false;
Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"),
be.bstrerror(dev->dev_errno));
}
if (ok && dev->HasCap(CAP_TWOEOF) && !dev->bsf(1)) {
BErrNo be;
ok = false;
Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"),
be.bstrerror(dev->dev_errno));
}
/*
* Backspace over record
*/
if (ok && !dev->bsr(1)) {
BErrNo be;
ok = false;
Jmsg(jcr, M_ERROR, 0, _("Backspace record at EOT failed. ERR=%s\n"),
be.bstrerror(dev->dev_errno));
/*
* On FreeBSD systems, if the user got here, it is likely that his/her
* tape drive is "frozen". The correct thing to do is a
* rewind(), but if we do that, higher levels in cleaning up, will
* most likely write the EOS record over the beginning of the
* tape. The rewind *is* done later in mount.c when another
* tape is requested. Note, the clrerror() call in bsr()
* calls ioctl(MTCERRSTAT), which *should* fix the problem.
*/
}
if (ok) {
DeviceBlock* lblock = new_block(dev);
/*
* Note, this can destroy dev->errmsg
*/
dcr->block = lblock;
if (DeviceControlRecord::ReadStatus::Ok !=
dcr->ReadBlockFromDev(NO_BLOCK_NUMBER_CHECK)) {
Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"),
dev->errmsg);
} else {
/*
* If we wrote block and the block numbers don't agree
* we have a possible problem.
*/
if (lblock->BlockNumber != dev->LastBlock) {
if (dev->LastBlock > (lblock->BlockNumber + 1)) {
Jmsg(jcr, M_FATAL, 0,
_("Re-read of last block: block numbers differ by more than "
"one.\n"
"Probable tape misconfiguration and data loss. Read "
"block=%u Want block=%u.\n"),
lblock->BlockNumber, dev->LastBlock);
} else {
Jmsg(jcr, M_ERROR, 0,
_("Re-read of last block OK, but block numbers differ. Read "
"block=%u Want block=%u.\n"),
lblock->BlockNumber, dev->LastBlock);
}
} else {
Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
}
}
FreeBlock(lblock);
dcr->block = block;
}
}
#endif
}
/**
* If this routine is called, we do our bookkeeping and
* then assure that the volume will not be written any more.
*/
static bool TerminateWritingVolume(DeviceControlRecord* dcr)
{
Device* dev = dcr->dev;
bool ok = true;
/* Create a JobMedia record to indicated end of tape */
dev->VolCatInfo.VolCatFiles = dev->file;
if (!dcr->DirCreateJobmediaRecord(false)) {
Dmsg0(50, "Error from create JobMedia\n");
dev->dev_errno = EIO;
Mmsg2(dev->errmsg,
_("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
dcr->getVolCatName(), dcr->jcr->Job);
Jmsg(dcr->jcr, M_FATAL, 0, "%s", dev->errmsg);
ok = false;
}
dcr->block->write_failed = true;
if (!dev->weof(1)) { /* end the tape */
dev->VolCatInfo.VolCatErrors++;
Jmsg(dcr->jcr, M_ERROR, 0,
_("Error writing final EOF to tape. This Volume may not be readable.\n"
"%s"),
dev->errmsg);
ok = false;
Dmsg0(50, "Error writing final EOF to volume.\n");
}
if (ok) {
ok = WriteAnsiIbmLabels(dcr, ANSI_EOV_LABEL, dev->VolHdr.VolumeName);
}
bstrncpy(dev->VolCatInfo.VolCatStatus, "Full",
sizeof(dev->VolCatInfo.VolCatStatus));
dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
if (!dcr->DirUpdateVolumeInfo(false, true)) {
Mmsg(dev->errmsg, _("Error sending Volume info to Director.\n"));
ok = false;
Dmsg0(50, "Error updating volume info.\n");
}
Dmsg1(50, "DirUpdateVolumeInfo Terminate writing -- %s\n",
ok ? "OK" : "ERROR");
/*
* Walk through all attached dcrs setting flag to call
* SetNewFileParameters() when that dcr is next used.
*/
DeviceControlRecord* mdcr;
foreach_dlist (mdcr, dev->attached_dcrs) {
if (mdcr->jcr->JobId == 0) { continue; }
mdcr->NewFile = true; /* set reminder to do set_new_file_params */
}
/*
* Set new file/block parameters for current dcr
*/
SetNewFileParameters(dcr);
if (ok && dev->HasCap(CAP_TWOEOF) && !dev->weof(1)) { /* end the tape */
dev->VolCatInfo.VolCatErrors++;
/*
* This may not be fatal since we already wrote an EOF
*/
Jmsg(dcr->jcr, M_ERROR, 0, "%s", dev->errmsg);
Dmsg0(50, "Writing second EOF failed.\n");
}
dev->SetAteot(); /* no more writing this tape */
Dmsg1(50, "*** Leave TerminateWritingVolume -- %s\n", ok ? "OK" : "ERROR");
return ok;
}
/**
* Do bookkeeping when a new file is created on a Volume. This is
* also done for disk files to generate the jobmedia records for
* quick seeking.
*/
static bool DoNewFileBookkeeping(DeviceControlRecord* dcr)
{
Device* dev = dcr->dev;
JobControlRecord* jcr = dcr->jcr;
/*
* Create a JobMedia record so restore can seek
*/
if (!dcr->DirCreateJobmediaRecord(false)) {
Dmsg0(50, "Error from create_job_media.\n");
dev->dev_errno = EIO;
Jmsg2(jcr, M_FATAL, 0,
_("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
dcr->getVolCatName(), jcr->Job);
TerminateWritingVolume(dcr);
dev->dev_errno = EIO;
return false;
}
dev->VolCatInfo.VolCatFiles = dev->file;
if (!dcr->DirUpdateVolumeInfo(false, false)) {
Dmsg0(50, "Error from update_vol_info.\n");
TerminateWritingVolume(dcr);
dev->dev_errno = EIO;
return false;
}
Dmsg0(100, "DirUpdateVolumeInfo max file size -- OK\n");
/*
* Walk through all attached dcrs setting flag to call
* SetNewFileParameters() when that dcr is next used.
*/
DeviceControlRecord* mdcr;
foreach_dlist (mdcr, dev->attached_dcrs) {
if (mdcr->jcr->JobId == 0) { continue; }
mdcr->NewFile = true; /* set reminder to do set_new_file_params */
}
/*
* Set new file/block parameters for current dcr
*/
SetNewFileParameters(dcr);
return true;
}
#ifdef DEBUG_BLOCK_CHECKSUM
static const bool debug_block_checksum = true;
#else
static const bool debug_block_checksum = false;
#endif
#ifdef NO_TAPE_WRITE_TEST
static const bool no_tape_write_test = true;
#else
static const bool no_tape_write_test = false;
#endif
/**
* Write a block to the device
*
* Returns: true on success or EOT
* false on hard error
*/
bool DeviceControlRecord::WriteBlockToDev()
{
ssize_t status = 0;
uint32_t wlen; /* length to write */
int hit_max1, hit_max2;
bool ok = true;
DeviceControlRecord* dcr = this;
uint32_t checksum;
if (no_tape_write_test) {
EmptyBlock(block);
return true;
}
if (JobCanceled(jcr)) {
Dmsg0(100, "return WriteBlockToDev, job is canceled\n");
return false;
}
ASSERT(block->binbuf == ((uint32_t)(block->bufp - block->buf)));
wlen = block->binbuf;
if (wlen <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
Dmsg0(100, "return WriteBlockToDev no data to write\n");
return true;
}
/* DumpBlock(block, "before write"); */
if (dev->AtWeot()) {
Dmsg0(100, "return WriteBlockToDev with ST_WEOT\n");
dev->dev_errno = ENOSPC;
Jmsg1(jcr, M_FATAL, 0, _("Cannot write block. Device at EOM. dev=%s\n"),
dev->print_name());
Dmsg1(100, "Attempt to write on read-only Volume. dev=%s\n",
dev->print_name());
return false;
}
if (!dev->CanAppend()) {
dev->dev_errno = EIO;
Jmsg1(jcr, M_FATAL, 0, _("Attempt to write on read-only Volume. dev=%s\n"),
dev->print_name());
Dmsg1(100, "Attempt to write on read-only Volume. dev=%s\n",
dev->print_name());
return false;
}
if (!dev->IsOpen()) {
Jmsg1(jcr, M_FATAL, 0, _("Attempt to write on closed device=%s\n"),
dev->print_name());
Dmsg1(100, "Attempt to write on closed device=%s\n", dev->print_name());
return false;
}
/*
* Clear to the end of the buffer if it is not full,
* and on devices with CAP_ADJWRITESIZE set, apply min and fixed blocking.
*/
if (wlen != block->buf_len) {
uint32_t blen = wlen; /* current buffer length */
Dmsg2(250, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
if (!dev->HasCap(CAP_ADJWRITESIZE)) {
Dmsg1(400, "%s: block write size is not adjustable", dev->print_name());
} else {
/* (dev->HasCap(CAP_ADJWRITESIZE)) */
if (dev->min_block_size == dev->max_block_size) {
/*
* Fixed block size
*/
wlen = block->buf_len; /* fixed block size already rounded */
} else if (wlen < dev->min_block_size) {
/*
* Min block size
*/
wlen =
((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
} else {
/*
* Ensure size is rounded
*/
wlen = ((wlen + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
}
if (wlen - blen > 0) {
memset(block->bufp, 0, wlen - blen); /* clear garbage */
}
}
}
Dmsg5(400,
"dev=%s: writing %d bytes as block of %d bytes. Block sizes: min=%d, "
"max=%d\n",
dev->print_name(), block->binbuf, wlen, dev->min_block_size,
dev->max_block_size);
checksum = SerBlockHeader(block, dev->DoChecksum());
/*
* Limit maximum Volume size to value specified by user
*/
hit_max1 =
(dev->max_volume_size > 0) &&
((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
((dev->VolCatInfo.VolCatBytes + block->binbuf)) >=
dev->VolCatInfo.VolCatMaxBytes;
if (hit_max1 || hit_max2) {
char ed1[50];
uint64_t max_cap;
Dmsg0(100, "==== Output bytes Triggered medium max capacity.\n");
if (hit_max1) {
max_cap = dev->max_volume_size;
} else {
max_cap = dev->VolCatInfo.VolCatMaxBytes;
}
Jmsg(jcr, M_INFO, 0,
_("User defined maximum volume capacity %s exceeded on device %s.\n"),
edit_uint64_with_commas(max_cap, ed1), dev->print_name());
TerminateWritingVolume(dcr);
RereadLastBlock(dcr); /* DEBUG */
dev->dev_errno = ENOSPC;
return false;
}
/*
* Limit maximum File size on volume to user specified value
*/
if ((dev->max_file_size > 0) &&
(dev->file_size + block->binbuf) >= dev->max_file_size) {
dev->file_size = 0; /* reset file size */
if (!dev->weof(1)) { /* write eof */
Dmsg0(50, "WEOF error in max file size.\n");
Jmsg(jcr, M_FATAL, 0, _("Unable to write EOF. ERR=%s\n"),
dev->bstrerror());
TerminateWritingVolume(dcr);
dev->dev_errno = ENOSPC;
return false;
}
if (!WriteAnsiIbmLabels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName)) {
return false;
}
if (!DoNewFileBookkeeping(dcr)) {
/*
* Error message already sent
*/
return false;
}
}
dev->VolCatInfo.VolCatWrites++;
Dmsg1(1300, "Write block of %u bytes\n", wlen);
#ifdef DEBUG_BLOCK_ZEROING
uint32_t* bp = (uint32_t*)block->buf;
if (bp[0] == 0 && bp[1] == 0 && bp[2] == 0 && block->buf[12] == 0) {
Jmsg0(jcr, M_ABORT, 0, _("Write block header zeroed.\n"));
}
#endif
/*
* Do write here,
* make a somewhat feeble attempt to recover
* from the OS telling us it is busy.
*/
int retry = 0;
errno = 0;
status = 0;
do {
if (retry > 0 && status == -1 && errno == EBUSY) {
BErrNo be;
Dmsg4(100, "===== write retry=%d status=%d errno=%d: ERR=%s\n", retry,
status, errno, be.bstrerror());
Bmicrosleep(5, 0); /* pause a bit if busy or lots of errors */
dev->clrerror(-1);
}
status = dev->write(block->buf, (size_t)wlen);
} while (status == -1 && (errno == EBUSY) && retry++ < 3);
if (debug_block_checksum) {
uint32_t achecksum = SerBlockHeader(block, dev->DoChecksum());
if (checksum != achecksum) {
Jmsg2(jcr, M_ERROR, 0,
_("Block checksum changed during write: before=%ud after=%ud\n"),
checksum, achecksum);
DumpBlock(block, "with checksum error");
}
}
#ifdef DEBUG_BLOCK_ZEROING
if (bp[0] == 0 && bp[1] == 0 && bp[2] == 0 && block->buf[12] == 0) {
Jmsg0(jcr, M_ABORT, 0, _("Write block header zeroed.\n"));
}
#endif
if (status != (ssize_t)wlen) {
/*
* Some devices simply report EIO when the volume is full.
* With a little more thought we may be able to check
* capacity and distinguish real errors and EOT
* conditions. In any case, we probably want to
* simulate an End of Medium.
*/
if (status == -1) {
BErrNo be;
dev->clrerror(-1);
if (dev->dev_errno == 0) { dev->dev_errno = ENOSPC; /* out of space */ }
if (dev->dev_errno != ENOSPC) {
dev->VolCatInfo.VolCatErrors++;
Jmsg4(jcr, M_ERROR, 0,
_("Write error at %u:%u on device %s. ERR=%s.\n"), dev->file,
dev->block_num, dev->print_name(), be.bstrerror());
}
} else {
dev->dev_errno = ENOSPC; /* out of space */
}
if (dev->dev_errno == ENOSPC) {
Jmsg(jcr, M_INFO, 0,
_("End of Volume \"%s\" at %u:%u on device %s. Write of %u bytes "
"got %d.\n"),
dev->getVolCatName(), dev->file, dev->block_num, dev->print_name(),
wlen, status);
} else {
BErrNo be;
be.SetErrno(dev->dev_errno);
Mmsg5(dev->errmsg,
_("Write error on fd=%d at file:blk %u:%u on device %s. ERR=%s.\n"),
dev->fd(), dev->file, dev->block_num, dev->print_name(),
be.bstrerror());
}
GeneratePluginEvent(jcr, bsdEventWriteError, dcr);
if (dev->dev_errno != ENOSPC) { Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg); }
if (debug_level >= 100) {
BErrNo be;
be.SetErrno(dev->dev_errno);
Dmsg7(100,
"=== Write error. fd=%d size=%u rtn=%d dev_blk=%d blk_blk=%d "
"errno=%d: ERR=%s\n",
dev->fd(), wlen, status, dev->block_num, block->BlockNumber,
dev->dev_errno, be.bstrerror(dev->dev_errno));
}
ok = TerminateWritingVolume(dcr);
if (!ok && !forge_on) { return false; }
if (ok) { RereadLastBlock(dcr); }
return false;
}
/*
* We successfully wrote the block, now do housekeeping
*/
Dmsg2(1300, "VolCatBytes=%d newVolCatBytes=%d\n",
(int)dev->VolCatInfo.VolCatBytes,
(int)(dev->VolCatInfo.VolCatBytes + wlen));
dev->VolCatInfo.VolCatBytes += wlen;
dev->VolCatInfo.VolCatBlocks++;
dev->EndBlock = dev->block_num;
dev->EndFile = dev->file;
dev->LastBlock = block->BlockNumber;
block->BlockNumber++;
/*
* Update dcr values
*/
if (dev->IsTape()) {
dcr->EndBlock = dev->EndBlock;
dcr->EndFile = dev->EndFile;
dev->block_num++;
} else {
/*
* Save address of block just written
*/
uint64_t addr = dev->file_addr + wlen - 1;
dcr->EndBlock = (uint32_t)addr;
dcr->EndFile = (uint32_t)(addr >> 32);
dev->block_num = dcr->EndBlock;
dev->file = dcr->EndFile;
}
dcr->VolMediaId = dev->VolCatInfo.VolMediaId;
if (dcr->VolFirstIndex == 0 && block->FirstIndex > 0) {
dcr->VolFirstIndex = block->FirstIndex;
}
if (block->LastIndex > 0) { dcr->VolLastIndex = block->LastIndex; }
dcr->WroteVol = true;
dev->file_addr += wlen; /* update file address */
dev->file_size += wlen;
Dmsg2(1300, "WriteBlock: wrote block %d bytes=%d\n", dev->block_num, wlen);
EmptyBlock(block);
return true;
}
/**
* Write a block to the device, with locking and unlocking
*
* Returns: true on success
* : false on failure
*
*/
bool DeviceControlRecord::WriteBlockToDevice()
{
bool status = true;
DeviceControlRecord* dcr = this;
if (dcr->spooling) {
status = WriteBlockToSpoolFile(dcr);
return status;
}
if (!dcr->IsDevLocked()) { /* device already locked? */
/*
* Note, do not change this to dcr->r_dlock
*/
dev->rLock(); /* no, lock it */
}
/*
* If a new volume has been mounted since our last write
* Create a JobMedia record for the previous volume written,
* and set new parameters to write this volume
*
* The same applies for if we are in a new file.
*/
if (dcr->NewVol || dcr->NewFile) {
if (JobCanceled(jcr)) {
status = false;
Dmsg0(100, "Canceled\n");
goto bail_out;
}
/* Create a jobmedia record for this job */
if (!dcr->DirCreateJobmediaRecord(false)) {
dev->dev_errno = EIO;
Jmsg2(jcr, M_FATAL, 0,
_("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
dcr->getVolCatName(), jcr->Job);
SetNewVolumeParameters(dcr);
status = false;
Dmsg0(100, "cannot create media record\n");
goto bail_out;
}
if (dcr->NewVol) {
/*
* Note, setting a new volume also handles any pending new file
*/
SetNewVolumeParameters(dcr);
} else {
SetNewFileParameters(dcr);
}
}
if (!dcr->WriteBlockToDev()) {
if (JobCanceled(jcr) || jcr->is_JobType(JT_SYSTEM)) {
status = false;
} else {
status = FixupDeviceBlockWriteError(dcr);
}
}
bail_out:
if (!dcr->IsDevLocked()) { /* did we lock dev above? */
/*
* Note, do not change this to dcr->dunlock
*/
dev->Unlock(); /* unlock it now */
}
return status;
}
/**
* Read block with locking
*/
DeviceControlRecord::ReadStatus DeviceControlRecord::ReadBlockFromDevice(
bool check_block_numbers)
{
ReadStatus status;
Dmsg0(250, "Enter ReadBlockFromDevice\n");
dev->rLock();
status = ReadBlockFromDev(check_block_numbers);
dev->Unlock();
Dmsg0(250, "Leave ReadBlockFromDevice\n");
return status;
}
/**
* Read the next block into the block structure and unserialize
* the block header. For a file, the block may be partially
* or completely in the current buffer.
*/
DeviceControlRecord::ReadStatus DeviceControlRecord::ReadBlockFromDev(
bool check_block_numbers)
{
ssize_t status;
int looping;
int retry;
DeviceControlRecord* dcr = this;
if (JobCanceled(jcr)) {
Mmsg(dev->errmsg, _("Job failed or canceled.\n"));
block->read_len = 0;
return ReadStatus::Error;