-
Notifications
You must be signed in to change notification settings - Fork 4k
/
Copy pathibd2sdi.cc
2327 lines (1929 loc) · 76 KB
/
ibd2sdi.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
/*****************************************************************************
Copyright (c) 2016, 2024, Oracle and/or its affiliates.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License, version 2.0, as published by the
Free Software Foundation.
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
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, version 2.0,
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 St, Fifth Floor, Boston, MA 02110-1301 USA
*****************************************************************************/
#include "my_config.h"
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <time.h>
#include <limits>
#ifndef _WIN32
#include <unistd.h>
#endif
#include <zlib.h>
#include <iostream>
#include <map>
#include "my_rapidjson_size_t.h"
#include <rapidjson/document.h>
#include <rapidjson/error/en.h>
#include <rapidjson/filewritestream.h>
#include <rapidjson/istreamwrapper.h>
#include <rapidjson/ostreamwrapper.h>
#include <rapidjson/prettywriter.h>
#include <exception>
#include <iostream>
#include <sstream>
#include "my_compiler.h"
#include "my_dbug.h"
#include "my_dir.h"
#include "my_getopt.h"
#include "my_io.h"
#include "my_macros.h"
#include "nulls.h"
#include "print_version.h"
#include "template_utils.h"
#include "typelib.h"
#include "welcome_copyright_notice.h"
#include "btr0cur.h"
#include "dict0sdi-decompress.h"
#include "fil0fil.h"
#include "fsp0fsp.h"
#include "lob0lob.h"
#include "mach0data.h"
#include "page0page.h"
#include "page0size.h"
#include "page0types.h"
#include "univ.i"
#include "ut0byte.h"
#include "ut0crc32.h"
typedef enum { SUCCESS, FALIURE, NO_RECORDS } err_t;
/** Length of ID field in record of SDI Index. */
static const uint32_t REC_DATA_ID_LEN = 8;
/** Length of TYPE field in record of SDI Index. */
static const uint32_t REC_DATA_TYPE_LEN = 4;
/** Length of UNCOMPRESSED_LEN field in record of SDI Index. */
static const uint32_t REC_DATA_UNCOMP_LEN = 4;
/** Length of COMPRESSED_LEN field in record of SDI Index. */
static const uint32_t REC_DATA_COMP_LEN = 4;
/** SDI Index record Origin. */
static const uint32_t REC_ORIGIN = 0;
/** Length of SDI Index record header. */
static const uint32_t REC_MIN_HEADER_SIZE = REC_N_NEW_EXTRA_BYTES;
/** Stored at rec origin minus 3rd byte. Only 3bits of 3rd byte are used for
rec type. */
static const uint32_t REC_OFF_TYPE = 3;
/** Stored at rec_origin minus 2nd byte and length 2 bytes. */
static const uint32_t REC_OFF_NEXT = 2;
/** Offset of TYPE field in record (0). */
static const uint32_t REC_OFF_DATA_TYPE = REC_ORIGIN;
// ut_ad(REC_OFF_DATA_ID == 0);
/** Offset of ID field in record (4). */
static const uint32_t REC_OFF_DATA_ID = REC_OFF_DATA_TYPE + REC_DATA_TYPE_LEN;
// ut_ad(REC_OFF_DATA_TYPE == 8);
/** Offset of 6-byte trx id (12). */
static const uint32_t REC_OFF_DATA_TRX_ID = REC_OFF_DATA_ID + REC_DATA_ID_LEN;
// ut_ad(REC_OFF_DATA_TRX_ID == 12);
/** 7-byte roll-ptr (18). */
static const uint32_t REC_OFF_DATA_ROLL_PTR =
REC_OFF_DATA_TRX_ID + DATA_TRX_ID_LEN;
// ut_ad(REC_OFF_DATA_ROLL_PTR == 18);
/** 4-byte un-compressed len (25) */
static const uint32_t REC_OFF_DATA_UNCOMP_LEN =
REC_OFF_DATA_ROLL_PTR + DATA_ROLL_PTR_LEN;
/** 4-byte compressed len (29) */
static const uint32_t REC_OFF_DATA_COMP_LEN =
REC_OFF_DATA_UNCOMP_LEN + REC_DATA_UNCOMP_LEN;
/** Variable length Data (33). */
static const uint32_t REC_OFF_DATA_VARCHAR =
REC_OFF_DATA_COMP_LEN + REC_DATA_COMP_LEN;
// ut_ad(REC_OFF_DATA_VARCHAR == 33);
/** Record size in page. This will be used determine the maximum number
of records on a page. */
static const uint32_t SDI_REC_SIZE = 1 /* rec_len */
+ REC_MIN_HEADER_SIZE /* rec_header */
+ REC_DATA_TYPE_LEN /* type field size */
+ REC_DATA_ID_LEN /* id field len */
+ DATA_ROLL_PTR_LEN /* roll ptr len */
+ DATA_TRX_ID_LEN /* TRX_ID len */;
/** If page 0 is corrupted, the maximum number of pages to scan to
determine page size. */
static const page_no_t MAX_PAGES_TO_SCAN = 60;
/** Indicates error. */
static const uint64_t IB_ERROR = SIZE_T_MAX;
static const uint32_t IB_ERROR_32 = (~((uint32)0));
/** SDI BLOB not expected before the following page number.
0 (tablespace header), 1 (tabespace bitmap), 2 (ibuf bitmap)
3 (SDI Index root page) */
static const uint64_t SDI_BLOB_ALLOWED = 4;
/** Replaces declaration in srv0srv.c */
ulong srv_page_size;
ulong srv_page_size_shift;
page_size_t univ_page_size(0, 0, false);
/** Global options structure. Option values passed at command line are
stored in this structure */
struct sdi_options {
uint64_t sdi_rec_id;
uint64_t sdi_rec_type;
bool skip_data;
bool is_sdi_id;
bool is_sdi_type;
bool is_sdi_rec;
bool no_checksum;
bool is_dump_file;
const char *dbug_setting;
char *dump_filename;
ulong strict_check;
bool pretty;
};
struct sdi_options opts;
/** Possible values for "--strict-check" for strictly verify checksum */
static const char *checksum_algorithms[] = {"crc32", "innodb", "none", NullS};
/** Used to define an enumerate type of the "checksum algorithm". */
static TYPELIB checksum_algorithms_typelib = {
array_elements(checksum_algorithms) - 1, "", checksum_algorithms, nullptr};
/* Command line argument for ibd2sdi tool. */
static struct my_option ibd2sdi_options[] = {
{"help", 'h', "Display this help and exit.", nullptr, nullptr, nullptr,
GET_NO_ARG, NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
{"version", 'v', "Display version information and exit.", nullptr, nullptr,
nullptr, GET_NO_ARG, NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
#ifndef NDEBUG
{"debug", '#', "Output debug log. See " REFMAN "dbug-package.html",
&opts.dbug_setting, &opts.dbug_setting, nullptr, GET_STR, OPT_ARG, 0, 0, 0,
nullptr, 0, nullptr},
#endif /* !NDEBUG */
{"dump-file", 'd',
"Dump the tablespace SDI into the file passed by user."
" Without the filename, it will default to stdout",
&opts.dump_filename, &opts.dump_filename, nullptr, GET_STR, REQUIRED_ARG,
0, 0, 0, nullptr, 0, nullptr},
{"skip-data", 's',
"Skip retrieving data from SDI records. Retrieve only"
" id and type.",
&opts.skip_data, &opts.skip_data, nullptr, GET_BOOL, NO_ARG, 0, 0, 0,
nullptr, 0, nullptr},
{"id", 'i', "Retrieve the SDI record matching the id passed by user.",
&opts.sdi_rec_id, &opts.sdi_rec_id, nullptr, GET_ULL, REQUIRED_ARG, 0, 0,
ULLONG_MAX, nullptr, 1, nullptr},
{"type", 't', "Retrieve the SDI records matching the type passed by user.",
&opts.sdi_rec_type, &opts.sdi_rec_type, nullptr, GET_ULL, REQUIRED_ARG, 0,
0, ULLONG_MAX, nullptr, 1, nullptr},
{"strict-check", 'c',
"Specify the strict checksum algorithm by the user."
" Allowed values are innodb, crc32, none.",
&opts.strict_check, &opts.strict_check, &checksum_algorithms_typelib,
GET_ENUM, REQUIRED_ARG, 0, 0, 0, nullptr, 0, nullptr},
{"no-check", 'n', "Ignore the checksum verification.", &opts.no_checksum,
&opts.no_checksum, nullptr, GET_BOOL, NO_ARG, 0, 0, 0, nullptr, 0,
nullptr},
{"pretty", 'p',
"Pretty format the SDI output."
"If false, SDI would be not human readable but it will be of less size",
&opts.pretty, &opts.pretty, nullptr, GET_BOOL, OPT_ARG, 1, 0, 0, nullptr,
0, nullptr},
{nullptr, 0, nullptr, nullptr, nullptr, nullptr, GET_NO_ARG, NO_ARG, 0, 0,
0, nullptr, 0, nullptr}};
/** A dummy implementation. Actual implementation available in fil0fil.cc */
std::ostream &Fil_page_header::print(std::ostream &out) const noexcept {
return out;
}
/** Report a failed assertion.
@param[in] expr the failed assertion if not NULL
@param[in] file source file containing the assertion
@param[in] line line number of the assertion */
[[noreturn]] void ut_dbg_assertion_failed(const char *expr, const char *file,
uint64_t line) {
fprintf(stderr, "ibd2sdi: Assertion failure in file %s line " UINT64PF "\n",
file, line);
if (expr != nullptr) {
fprintf(stderr, "ibd2sdi: Failing assertion: %s\n", expr);
}
fflush(stderr);
fflush(stdout);
abort();
}
/** Tries to delete temporary file.
@param[in] temp_filename The name of file to delete*/
static void try_delete_temporary_filename(const char *temp_filename) {
if (my_delete(temp_filename, MYF(0)) != 0) {
ib::warn() << "Removal of temporary file " << temp_filename
<< " failed because of system error: " << strerror(errno);
}
}
/** Create a file in a system's temporary directory.
@param[in,out] temp_file_buf Buffer to hold the temporary file
name generated
@param[in] dir directory used for creation of
temporary file, nullptr if system
tmpdir to be used
@param[in] prefix_pattern the temp file name is prefixed with
this string
@return File pointer of the created file */
static FILE *create_tmp_file(char *temp_file_buf, const char *dir,
const char *prefix_pattern) {
FILE *file = nullptr;
File fd = create_temp_file(temp_file_buf, dir, prefix_pattern,
O_CREAT | O_RDWR, KEEP_FILE, MYF(0));
if (fd >= 0) {
file = my_fdopen(fd, temp_file_buf, O_RDWR, MYF(0));
}
DBUG_EXECUTE_IF("ib_tmp_file_fail", file = nullptr; errno = EACCES;);
if (file == nullptr) {
ib::error() << "Unable to create temporary file. err: " << strerror(errno);
if (fd >= 0) {
try_delete_temporary_filename(temp_file_buf);
my_close(fd, MYF(0));
}
}
return (file);
}
/** Print the ibd2sdi tool usage. */
static void usage() {
#ifdef NDEBUG
print_version();
#else
print_version_debug();
#endif /* NDEBUG */
puts(ORACLE_WELCOME_COPYRIGHT_NOTICE("2015"));
printf(
"Usage: %s [-v] [-c <strict-check>] [-d <dump file name>] [-n]"
" filename1 [filenames]\n",
my_progname);
printf("See " REFMAN "ibd2sdi.html for usage hints.\n");
my_print_help(ibd2sdi_options);
my_print_variables(ibd2sdi_options);
}
/** Parse the options passed to tool. */
extern "C" bool ibd2sdi_get_one_option(int optid,
const struct my_option *opt
[[maybe_unused]],
char *argument [[maybe_unused]]) {
switch (optid) {
#ifndef NDEBUG
case '#':
opts.dbug_setting =
argument ? argument
: IF_WIN("d:O,ibd2sdi.trace", "d:o,/tmp/ibd2sdi.trace");
DBUG_PUSH(opts.dbug_setting);
break;
#endif /* !NDEBUG */
case 'v':
#ifdef NDEBUG
print_version();
#else
print_version_debug();
#endif /* DBUG */
exit(EXIT_SUCCESS);
break;
case 'c':
switch (opts.strict_check) {
case 0:
srv_checksum_algorithm = SRV_CHECKSUM_ALGORITHM_STRICT_CRC32;
break;
case 1:
srv_checksum_algorithm = SRV_CHECKSUM_ALGORITHM_STRICT_INNODB;
break;
case 2:
srv_checksum_algorithm = SRV_CHECKSUM_ALGORITHM_STRICT_NONE;
break;
default:
return (true);
}
break;
case 'd':
opts.is_dump_file = true;
break;
case 'i':
opts.is_sdi_id = true;
break;
case 't':
opts.is_sdi_type = true;
break;
case 'n':
opts.no_checksum = true;
break;
case 'p':
break;
case 'h':
usage();
exit(EXIT_SUCCESS);
break;
}
return (false);
}
/** Retrieve the options passed to the tool. */
static bool get_options(int *argc, char ***argv) {
if (handle_options(argc, argv, ibd2sdi_options, ibd2sdi_get_one_option)) {
exit(true);
}
/* The next arg must be the filename */
if (!*argc) {
usage();
return (true);
}
return (false);
}
/** Error logging classes. */
namespace ib {
logger::~logger() = default;
info::~info() {
std::cerr << "[INFO] ibd2sdi: " << m_oss.str() << "." << std::endl;
}
warn::~warn() {
std::cerr << "[WARNING] ibd2sdi: " << m_oss.str() << "." << std::endl;
}
error::~error() {
std::cerr << "[ERROR] ibd2sdi: " << m_oss.str() << "." << std::endl;
}
/*
MSVS complains: Warning C4722: destructor never returns, potential memory leak.
But, the whole point of using ib::fatal temporary object is to cause an abort.
*/
MY_COMPILER_DIAGNOSTIC_PUSH()
MY_COMPILER_MSVC_DIAGNOSTIC_IGNORE(4722)
fatal::~fatal() {
std::cerr << "[FATAL] ibd2sdi: " << m_oss.str() << "." << std::endl;
ut_error;
}
// Restore the MSVS checks for Warning C4722, silenced for ib::fatal::~fatal().
MY_COMPILER_DIAGNOSTIC_POP()
/* TODO: Improve Object creation & destruction on NDEBUG */
class dbug : public logger {
public:
~dbug() override { DBUG_PRINT("ibd2sdi", ("%s", m_oss.str().c_str())); }
};
} // namespace ib
/** Check if page is corrupted or not.
@param[in] buf page frame
@param[in] page_size page size
@retval true if page is corrupted
@retval false if page is not corrupted */
static bool is_page_corrupted(const byte *buf, const page_size_t &page_size) {
BlockReporter reporter(false, buf, page_size, opts.strict_check);
return (reporter.is_corrupted());
}
/** Seek the file pointer to page offset in the file.
@param[in] file_in File pointer
@param[in] page_size page size
@param[in] page_num page number
@retval true success
@retval false error */
static bool seek_to_page(File file_in, const page_size_t &page_size,
page_no_t page_num) {
my_off_t offset = page_num * page_size.physical();
DBUG_EXECUTE_IF("ib_seek_error", offset = -1;);
if (my_seek(file_in, offset, MY_SEEK_SET, MYF(0)) == MY_FILEPOS_ERROR) {
ib::error() << "Error: Unable to seek to necessary offset for"
" file with descriptor "
<< file_in
<< " and error msg"
" is: "
<< strerror(errno);
return (false);
}
return (true);
}
/** Read physical page size from file into buffer.
@param[in] page_num page number
@param[in] page_size page size of the tablespace
@param[in] buf_len length of buffer
@param[in,out] buf read the file in buffer
@param[in,out] file_in file pointer created for the tablespace
@return number of bytes read or IB_ERROR on error */
static size_t read_page(page_no_t page_num, const page_size_t &page_size,
uint32_t buf_len, byte *buf, File file_in) {
if (!seek_to_page(file_in, page_size, page_num)) {
return (IB_ERROR);
}
size_t physical_page_size = static_cast<size_t>(page_size.physical());
ut_ad(physical_page_size >= UNIV_ZIP_SIZE_MIN);
ut_ad(buf_len >= physical_page_size);
size_t n_bytes_read = my_read(file_in, buf, physical_page_size, MYF(0));
ut_ad(n_bytes_read == physical_page_size || n_bytes_read == IB_ERROR);
return (n_bytes_read);
}
/** Datafile information. */
typedef struct ib_file {
/** 0 in fil_per_table tablespaces, else the first page number in
subsequent data file in multi-file tablespace. */
page_no_t first_page_num;
/** Total number of pages in a data file. */
page_no_t tot_num_of_pages;
/** File handle of the data file. */
File file_handle;
} ib_file_t;
/** Class to hold information about a single InnoDB tablespace. */
class ib_tablespace {
public:
/** Constructor from space_id & page_size.
@param[in] space_id tablespace id
@param[in] page_size tablespace page size */
ib_tablespace(space_id_t space_id, const page_size_t &page_size)
: m_space_id(space_id),
m_page_size(page_size),
m_file_vec(),
m_page_num_recs(0),
m_max_recs_per_page(page_size.logical() / SDI_REC_SIZE),
m_sdi_root(0),
m_tot_pages(0) {}
/** Destructor. Closes open file handles of Datafiles. */
~ib_tablespace() {
std::vector<ib_file>::const_iterator it;
for (it = m_file_vec.begin(); it != m_file_vec.end(); ++it) {
File file_handle = it->file_handle;
if (file_handle != -1) {
my_close(file_handle, MYF(0));
}
}
}
/** Copy Constructor.
@param[in] copy another object of ib_tablespace */
ib_tablespace(const ib_tablespace ©) = default;
/** Add Datafile to vector of datafiles. Also
resize of vector of pages.
@param[in] data_file Datafile */
inline void add_data_file(const ib_file_t &data_file) {
m_file_vec.push_back(data_file);
m_page_num_recs.resize(m_page_num_recs.size() +
static_cast<size_t>(data_file.tot_num_of_pages),
0);
m_tot_pages += data_file.tot_num_of_pages;
}
/** Add the SDI root page numbers to tablespace.
@param[in] root root page number of SDI */
inline void add_sdi(page_no_t root) { m_sdi_root = root; }
/** @return SDI root page number */
inline page_no_t get_sdi_root() const { return (m_sdi_root); }
/** Return space id of the tablespace.
@return space id of the tablespace */
inline space_id_t get_space_id() const { return (m_space_id); }
/** Return the page size of the tablespace.
@return the page size of the tablespace. */
inline const page_size_t &get_page_size() const { return (m_page_size); }
/** Return the number of data files of tablespace.
@return the number of data files of tablespace */
inline uint64_t get_file_count() const { return (m_file_vec.size()); }
/** Return the first page number of nth Datafile.
@param[in] df_num Datafile number
@return the first page number of nth Datafile */
inline ib_file_t get_nth_data_file(uint64_t df_num) const {
ut_ad(df_num < m_file_vec.size());
return (m_file_vec[static_cast<unsigned>(df_num)]);
}
/** Increment the number of records on a page. This counter is
used to detect page corruption. Every page has limit on maximum
number of records stored.
@param[in] page_num Page on which record is found
@return true if the number of records exceed the max limit(i.e
corruption detected), else return false. */
bool inc_num_of_recs_on_page(page_no_t page_num) {
ut_ad(page_num < m_page_num_recs.size());
++m_page_num_recs[page_num];
if (m_page_num_recs[page_num] > get_max_recs_per_page()) {
ib::error() << "Record Corruption detected. Too many"
" records or infinite loop detected. Aborting";
ib::error() << "The current iteration num is "
<< m_page_num_recs[page_num]
<< ". Maximum number of records expected on"
<< " the page " << page_num << " is "
<< get_max_recs_per_page();
return (true);
}
return (false);
}
/** Get the maximum number of records possible on a page.
@return the maximum possible number of records on a page */
inline uint64_t get_max_recs_per_page() const {
return (m_max_recs_per_page);
}
/** Get the number of records on a page.
@param[in] page_num Page number
@return the number of records on page */
inline uint64_t get_cur_num_recs_on_page(page_no_t page_num) const {
ut_ad(page_num < m_page_num_recs.size());
return (m_page_num_recs[page_num]);
}
/** Return the file handle for which the page belongs. This
is applicable for multi-file tablespaces (like ibdata*)
@param[in] page_num Page number
@param[in,out] offset_in_datafile offset of page
in data file
@return the File handle if found, else -1. */
inline File get_file_handle_for_page(page_no_t page_num,
page_no_t *offset_in_datafile) const {
/* Now find which datafile of the tablespace to use for reading
the page. */
File file_in = -1;
*offset_in_datafile = FIL_NULL;
for (uint32_t i = 0; i < get_file_count(); i++) {
ib_file_t file = get_nth_data_file(i);
if (page_num < file.first_page_num + file.tot_num_of_pages) {
file_in = file.file_handle;
*offset_in_datafile = page_num - file.first_page_num;
break;
}
}
return (file_in);
}
/** Check if SDI exists in a tablespace. If SDI exists, retrieve
SDI root page number.
@param[in,out] root SDI root page number
@return false on success, true on failure */
inline bool check_sdi(page_no_t &root);
/** Return the total number of pages of the tablespaces.
This includes pages of all datafiles (ibdata*)
@return total number of pages of tablespace */
inline page_no_t get_tot_pages() const { return (m_tot_pages); }
private:
/** Return the SDI Root page number stored in a page.
@param[in] buf Page read from buffer
@return SDI root page number */
inline page_no_t get_sdi_root_page_num(byte *buf);
/** Space id of tablespace. */
space_id_t m_space_id;
/** Page size of tablespace. */
page_size_t m_page_size;
/** Vector of datafiles of a tablespace. */
std::vector<ib_file_t> m_file_vec;
/** Vector of pages. For each page, the number of records
found on each page of tablespace is stored in vector. */
std::vector<uint64_t> m_page_num_recs;
/** Maximum number of records possible on a page. */
uint64_t m_max_recs_per_page;
/** Root page number of SDI. */
page_no_t m_sdi_root;
/** Total number of pages of all data files. */
page_no_t m_tot_pages;
};
/** Read page from file into memory. If page is compressed SDI page,
decompress and store the uncompressed copy in the buffer.
@param[in] ts tablespace structure
@param[in] page_num page number
@param[in] buf_len buf_len
@param[in,out] buf the page read will stored in this buffer
@return number of bytes read from file on success, else return IB_ERROR on
failure */
static size_t fetch_page(ib_tablespace *ts, page_no_t page_num,
uint32_t buf_len, byte *buf) {
DBUG_TRACE;
ib::dbug() << "Read page number: " << page_num;
const page_size_t &page_size = ts->get_page_size();
/* Get last data file first page_num & total_pages in the
datafile to check the bounds. */
ut_ad(ts->get_file_count() > 0);
DBUG_EXECUTE_IF("ib_invalid_page", page_num = ts->get_tot_pages(););
if (page_num >= ts->get_tot_pages()) {
ib::error() << "Read requested on invalid page number " << page_num
<< ". The maximum valid page number"
<< " in the tablespace is " << ts->get_tot_pages() - 1;
return IB_ERROR;
}
/* Now find which datafile of the tablespace to use for reading
the page. */
page_no_t offset_in_datafile;
File file_in = ts->get_file_handle_for_page(page_num, &offset_in_datafile);
ut_ad(file_in != -1);
ut_ad(buf_len >= page_size.physical());
size_t n_bytes = IB_ERROR;
memset(buf, 0, page_size.physical());
n_bytes = read_page(offset_in_datafile, page_size, buf_len, buf, file_in);
if (n_bytes == IB_ERROR) {
return IB_ERROR;
}
if (!opts.no_checksum) {
bool corrupt_status = is_page_corrupted(buf, page_size);
if (corrupt_status) {
page_id_t page_id(ts->get_space_id(), page_num);
ib::error() << "Page " << page_id
<< " is corrupted."
" Checksum verification failed";
return IB_ERROR;
}
}
if (page_size.is_compressed() && fil_page_get_type(buf) == FIL_PAGE_SDI) {
byte *uncomp_buf = static_cast<byte *>(ut::malloc(2 * page_size.logical()));
byte *uncomp_page =
static_cast<byte *>(ut_align(uncomp_buf, page_size.logical()));
memset(uncomp_page, 0, page_size.logical());
page_zip_des_t page_zip;
page_zip_des_init(&page_zip);
page_zip.data = buf;
page_zip.ssize = page_size_to_ssize(page_size.physical());
DBUG_EXECUTE_IF("ib_decompress_fail",
mach_write_to_2(buf + PAGE_HEADER + PAGE_N_HEAP, 10000););
page_id_t page_id(ts->get_space_id(), page_num);
if (!page_zip_decompress_low(&page_zip, uncomp_page, true)) {
/* To indicate error */
n_bytes = IB_ERROR;
ib::error() << "Decompression failed for"
" compressed page "
<< page_id;
} else {
ib::dbug() << "Decompression Success for"
" compressed page "
<< page_id;
/* Page is decompressed. */
memset(buf, 0, buf_len);
ut_ad(buf_len >= page_size.logical());
memcpy(buf, uncomp_page, page_size.logical());
}
ut::free(uncomp_buf);
}
return n_bytes;
}
class tablespace_creator {
public:
/** Constructor
@param[in] num_files number of ibd files
@param[in] ibd_files array of ibd file names */
tablespace_creator(uint32_t num_files, char **ibd_files)
: m_num_files(num_files), m_ibd_files(ibd_files), m_tablespace(nullptr) {}
/* Destructor */
~tablespace_creator() { delete m_tablespace; }
/** Create tablespace from the ibd files passed.
@return false on success, true on failure */
bool create();
/** Return the tablespace object created from files.
@return tablespace object */
inline ib_tablespace *get_tablespace() { return (m_tablespace); }
private:
/** Determine page_size by reading MAX_PAGES_TO_SCAN pages (or actual
number of pages if less) and verifying the checksums.
@param[in] file_in File pointer
@param[in,out] page_size determined page size
@return true if valid page_size is determined, else false */
bool determine_page_size(File file_in, page_size_t &page_size);
/** Determine the minimum corruption ratio and update page_size.
@param[in] file_in file pointer
@param[in] num_pages Total number pages to verify checksum
@param[in] in_page_size the current page_size used for checksum
@param[in,out] final_page_size updated to in_page_size if the current
corruption ratio is less than minimum
corruption ratio
@param[in,out] min_corr_ratio updated if the current page_size
corruption ratio is less than
current value.*/
void determine_min_corruption_ratio(File file_in, page_no_t num_pages,
const page_size_t &in_page_size,
page_size_t &final_page_size,
double *min_corr_ratio);
/** Verify checksum of the pages and return corruption ratio
@param[in] file_in file pointer
@param[in] page_size page size
@param[in] num_pages Total number pages to verify checksum */
double get_page_size_corruption_count(File file_in,
const page_size_t &page_size,
page_no_t num_pages);
/** Find the page_size from the map with the least corruption count.
@param[in,out] page_size page size structure to hold determined
page size */
void find_best_page_size(page_size_t &page_size);
/** Get the page size of the tablespace from the tablespace header.
If tablespace header is corrupted, we will determine the page size by
reading some other pages and calculating checksums.
@param[in] buf buffer which contains first page of tablespace
@param[in] file_in File handle
@param[in,out] page_size page_size that is determined
@return true if page_size is determined, else false */
bool get_page_size(const byte *buf, File file_in, page_size_t &page_size);
/** The total number of files passed to the tool. */
uint32_t m_num_files;
/** The files passed to the tool. */
char **m_ibd_files;
/** Tablespace object created from the list of file passed to
the tool. */
ib_tablespace *m_tablespace;
};
/** Create tablespace from the ibd files passed.
@return false on success, true on failure */
bool tablespace_creator::create() {
byte buf[UNIV_ZIP_SIZE_MIN];
memset(buf, 0, UNIV_ZIP_SIZE_MIN);
DBUG_TRACE;
for (uint32_t i = 0; i < m_num_files; i++) {
const char *filename = m_ibd_files[i];
MY_STAT stat_info;
/* stat the file to get size and page count. */
if (my_stat(filename, &stat_info, MYF(0)) == nullptr) {
ib::error() << "Unable to get file stats " << filename;
ib::error() << "File doesn't exist";
return true;
}
uint64_t size = stat_info.st_size;
DBUG_EXECUTE_IF("ib_file_open_error", filename = "junk_file";);
File file_in = my_open(filename, O_RDONLY, MYF(0));
/* If file_in is NULL, terminate as some error encountered. */
if (file_in == -1) {
ib::error() << "Unable to open file " << filename;
return true;
}
/* Read minimum page_size. */
size_t bytes = my_read(file_in, buf, UNIV_ZIP_SIZE_MIN, MYF(0));
if (bytes != UNIV_ZIP_SIZE_MIN) {
ib::error() << " Unable to read the page header"
<< " of " << UNIV_ZIP_SIZE_MIN << " bytes";
if (bytes != IB_ERROR) {
ib::error() << " Bytes read was " << bytes;
}
my_close(file_in, MYF(0));
return true;
}
const space_id_t space_id =
mach_read_from_4(buf + FIL_PAGE_ARCH_LOG_NO_OR_SPACE_ID);
const page_no_t first_page_num = mach_read_from_4(buf + FIL_PAGE_OFFSET);
ib::dbug() << "The space id of the file " << filename << " is " << space_id;
if (i == 0) {
/* First data file of system tablespace
or single table tablespace */
page_size_t page_size(univ_page_size);
bool success = get_page_size(buf, file_in, page_size);
if (!success) {
return true;
}
ut_ad(first_page_num == 0);
const auto max_tablespace_size = uint64_t{page_size.physical()} *
std::numeric_limits<page_no_t>::max();
if (!(size < max_tablespace_size)) {
ib::error()
<< "Tablespace file reaches max permissible size for page size "
<< page_size.physical() << ", and crosses the limit by "
<< size - max_tablespace_size << " bytes";
return true;
}
const auto pages = static_cast<page_no_t>(size / page_size.physical());
const auto computed_size = uint64_t{pages} * page_size.physical();
DBUG_EXECUTE_IF("ib_partial_page", size++;);
if (computed_size != size) {
ib::warn() << "There is a partial page at the"
<< " end, of size " << size - computed_size
<< ". This partial page is ignored";
}
ib::dbug() << "Total Size in the file: " << size;
ib::dbug() << "Total Number of pages in the file: " << pages;
ib::dbug() << "Physical Page size in the file: " << page_size.physical();
ib_file_t ibd_file;
ibd_file.first_page_num = first_page_num;
ibd_file.file_handle = file_in;
ibd_file.tot_num_of_pages = pages;
m_tablespace = new ib_tablespace(space_id, page_size);
m_tablespace->add_data_file(ibd_file);
page_no_t root;
if (m_tablespace->check_sdi(root)) {
ib::error() << "SDI doesn't exist for"
" this tablespace or the SDI"
" root page numbers couldn't"
" be determined";
return true;
}
m_tablespace->add_sdi(root);
} else {
/* We found next file of system tablespace. */
ut_ad(m_tablespace != nullptr);
if (space_id != m_tablespace->get_space_id()) {
ib::error() << "Multiple tablespaces passed."
<< " Please specify only one"
<< " tablespace";
my_close(file_in, MYF(0));
return true;
}
/* This datafile should belong system tablespace
only. */
ut_ad(space_id == 0);
const page_size_t &page_size = m_tablespace->get_page_size();
uint64_t phys_page_size = page_size.physical();
bool all_zero_page = false;
byte full_page[UNIV_PAGE_SIZE_MAX];
memset(full_page, 0, UNIV_ZIP_SIZE_MAX);
read_page(0, page_size, UNIV_PAGE_SIZE_MAX, full_page, file_in);
if (buf_page_is_zeroes(full_page, page_size)) {
all_zero_page = true;
}
/* Calculate the last page number of the
last data_file */
uint64_t tot_data_files = m_tablespace->get_file_count();
ib_file_t file = m_tablespace->get_nth_data_file(tot_data_files - 1);
page_no_t last_file_first_page_num = file.first_page_num;
page_no_t last_file_tot_pages = file.tot_num_of_pages;
page_no_t last_page_num_of_last_data_file =
last_file_first_page_num + last_file_tot_pages - 1;
if (!all_zero_page &&
(first_page_num != last_page_num_of_last_data_file + 1)) {
ib::error() << "The first page num " << first_page_num
<< " of this"
" datafile "