-
Notifications
You must be signed in to change notification settings - Fork 4k
/
Copy pathhandler.cc
8973 lines (7697 loc) · 311 KB
/
handler.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) 2000, 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 */
/** @file sql/handler.cc
@brief
Implements functions in the handler interface that are shared between all
storage engines.
*/
#include "sql/handler.h"
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <algorithm>
#include <atomic>
#include <bit>
#include <cmath>
#include <list>
#include <random> // std::uniform_real_distribution
#include <string>
#include <string_view>
#include <vector>
#include "keycache.h"
#include "m_string.h"
#include "my_bitmap.h" // MY_BITMAP
#include "my_check_opt.h"
#include "my_dbug.h"
#include "my_macros.h"
#include "my_pointer_arithmetic.h"
#include "my_psi_config.h"
#include "my_sqlcommand.h"
#include "my_sys.h" // MEM_DEFINED_IF_ADDRESSABLE()
#include "myisam.h" // TT_FOR_UPGRADE
#include "mysql/binlog/event/binlog_event.h"
#include "mysql/components/services/bits/psi_bits.h"
#include "mysql/components/services/log_builtins.h"
#include "mysql/components/services/log_shared.h"
#include "mysql/my_loglevel.h"
#include "mysql/plugin.h"
#include "mysql/psi/mysql_file.h"
#include "mysql/psi/mysql_mutex.h"
#include "mysql/psi/mysql_table.h"
#include "mysql/psi/mysql_transaction.h"
#include "mysql/psi/psi_table.h"
#include "mysql/service_mysql_alloc.h"
#include "mysql/strings/m_ctype.h"
#include "mysql_com.h"
#include "mysql_version.h" // MYSQL_VERSION_ID
#include "mysqld_error.h"
#include "prealloced_array.h"
#include "sd_notify.h" // for sysd::notify() calls
#include "sql/auth/auth_common.h" // check_readonly() and SUPER_ACL
#include "sql/binlog.h" // mysql_bin_log
#include "sql/check_stack.h"
#include "sql/clone_handler.h"
#include "sql/current_thd.h"
#include "sql/dd/cache/dictionary_client.h" // dd::cache::Dictionary_client
#include "sql/dd/dd.h" // dd::get_dictionary
#include "sql/dd/dictionary.h" // dd:acquire_shared_table_mdl
#include "sql/dd/types/table.h" // dd::Table
#include "sql/dd_table_share.h" // open_table_def
#include "sql/debug_sync.h" // DEBUG_SYNC
#include "sql/derror.h" // ER_DEFAULT
#include "sql/error_handler.h" // Internal_error_handler
#include "sql/field.h"
#include "sql/item.h"
#include "sql/join_optimizer/cost_model.h" // EstimateIndexRangeScanCost
#include "sql/lock.h" // MYSQL_LOCK
#include "sql/log.h"
#include "sql/log_event.h" // Write_rows_log_event
#include "sql/mdl.h"
#include "sql/mysqld.h" // global_system_variables heap_hton ..
#include "sql/opt_costconstantcache.h" // reload_optimizer_cost_constants
#include "sql/opt_costmodel.h"
#include "sql/opt_hints.h"
#include "sql/protocol.h"
#include "sql/psi_memory_key.h"
#include "sql/query_options.h"
#include "sql/record_buffer.h" // Record_buffer
#include "sql/rpl_filter.h"
#include "sql/rpl_gtid.h"
#include "sql/rpl_handler.h" // RUN_HOOK
#include "sql/rpl_replica_commit_order_manager.h" // Commit_order_manager
#include "sql/rpl_rli.h" // is_atomic_ddl_commit_on_slave
#include "sql/rpl_write_set_handler.h" // add_pke
#include "sql/sdi_utils.h" // import_serialized_meta_data
#include "sql/session_tracker.h"
#include "sql/sql_base.h" // free_io_cache
#include "sql/sql_bitmap.h"
#include "sql/sql_class.h"
#include "sql/sql_error.h"
#include "sql/sql_lex.h"
#include "sql/sql_parse.h" // check_stack_overrun
#include "sql/sql_plugin.h" // plugin_foreach
#include "sql/sql_select.h" // actual_key_parts
#include "sql/sql_table.h" // build_table_filename
#include "sql/strfunc.h" // strnncmp_nopads
#include "sql/system_variables.h"
#include "sql/table.h"
#include "sql/tc_log.h"
#include "sql/thr_malloc.h"
#include "sql/transaction.h" // trans_commit_implicit
#include "sql/transaction_info.h"
#include "sql/xa.h"
#include "sql/xa/sql_cmd_xa.h" // Sql_cmd_xa_*
#include "sql_string.h"
#include "sql_tmp_table.h" // free_tmp_table
#include "string_with_len.h"
#include "template_utils.h"
#include "uniques.h" // Unique_on_insert
/**
@def MYSQL_TABLE_IO_WAIT
Instrumentation helper for table io_waits.
Note that this helper is intended to be used from
within the handler class only, as it uses members
from @c handler
Performance schema events are instrumented as follows:
- in non batch mode, one event is generated per call
- in batch mode, the number of rows affected is saved
in @c m_psi_numrows, so that @c end_psi_batch_mode()
generates a single event for the batch.
@param OP the table operation to be performed
@param INDEX the table index used if any, or MAX_KEY.
@param RESULT the result of the table operation performed
@param PAYLOAD instrumented code to execute
@sa handler::end_psi_batch_mode.
*/
#ifdef HAVE_PSI_TABLE_INTERFACE
#define MYSQL_TABLE_IO_WAIT(OP, INDEX, RESULT, PAYLOAD) \
{ \
if (m_psi != nullptr) { \
switch (m_psi_batch_mode) { \
case PSI_BATCH_MODE_NONE: { \
PSI_table_locker *sub_locker = nullptr; \
PSI_table_locker_state reentrant_safe_state; \
reentrant_safe_state.m_thread = nullptr; \
reentrant_safe_state.m_wait = nullptr; \
sub_locker = PSI_TABLE_CALL(start_table_io_wait)( \
&reentrant_safe_state, m_psi, OP, INDEX, __FILE__, __LINE__); \
PAYLOAD \
if (sub_locker != nullptr) PSI_TABLE_CALL(end_table_io_wait) \
(sub_locker, 1); \
break; \
} \
case PSI_BATCH_MODE_STARTING: { \
m_psi_locker = PSI_TABLE_CALL(start_table_io_wait)( \
&m_psi_locker_state, m_psi, OP, INDEX, __FILE__, __LINE__); \
PAYLOAD \
if (RESULT != HA_ERR_END_OF_FILE) m_psi_numrows++; \
m_psi_batch_mode = PSI_BATCH_MODE_STARTED; \
break; \
} \
case PSI_BATCH_MODE_STARTED: \
default: { \
assert(m_psi_batch_mode == PSI_BATCH_MODE_STARTED); \
PAYLOAD \
if (RESULT != HA_ERR_END_OF_FILE) m_psi_numrows++; \
break; \
} \
} \
} else { \
PAYLOAD \
} \
}
#else
#define MYSQL_TABLE_IO_WAIT(OP, INDEX, RESULT, PAYLOAD) PAYLOAD
#endif
/**
@def MYSQL_TABLE_LOCK_WAIT
Instrumentation helper for table io_waits.
@param OP the table operation to be performed
@param FLAGS per table operation flags.
@param PAYLOAD the code to instrument.
@sa MYSQL_END_TABLE_WAIT.
*/
#ifdef HAVE_PSI_TABLE_INTERFACE
#define MYSQL_TABLE_LOCK_WAIT(OP, FLAGS, PAYLOAD) \
{ \
if (m_psi != nullptr) { \
PSI_table_locker *locker; \
PSI_table_locker_state state; \
locker = PSI_TABLE_CALL(start_table_lock_wait)(&state, m_psi, OP, FLAGS, \
__FILE__, __LINE__); \
PAYLOAD \
if (locker != nullptr) PSI_TABLE_CALL(end_table_lock_wait)(locker); \
} else { \
PAYLOAD \
} \
}
#else
#define MYSQL_TABLE_LOCK_WAIT(OP, FLAGS, PAYLOAD) PAYLOAD
#endif
using std::list;
using std::log2;
using std::max;
using std::min;
/**
While we have legacy_db_type, we have this array to
check for dups and to find handlerton from legacy_db_type.
Remove when legacy_db_type is finally gone
*/
static Prealloced_array<st_plugin_int *, PREALLOC_NUM_HA> se_plugin_array(
PSI_NOT_INSTRUMENTED);
/**
Array allowing to check if handlerton is builtin without
acquiring LOCK_plugin.
*/
static Prealloced_array<bool, PREALLOC_NUM_HA> builtin_htons(
PSI_NOT_INSTRUMENTED);
st_plugin_int *hton2plugin(uint slot) { return se_plugin_array[slot]; }
size_t num_hton2plugins() { return se_plugin_array.size(); }
st_plugin_int *insert_hton2plugin(uint slot, st_plugin_int *plugin) {
if (se_plugin_array.assign_at(slot, plugin)) return nullptr;
builtin_htons.assign_at(slot, true);
return se_plugin_array[slot];
}
st_plugin_int *remove_hton2plugin(uint slot) {
st_plugin_int *retval = se_plugin_array[slot];
se_plugin_array[slot] = nullptr;
builtin_htons.assign_at(slot, false);
return retval;
}
const char *ha_resolve_storage_engine_name(const handlerton *db_type) {
return db_type == nullptr ? "UNKNOWN" : hton2plugin(db_type->slot)->name.str;
}
static handlerton *installed_htons[128];
/* number of storage engines (from installed_htons[]) that support 2pc */
ulong total_ha_2pc = 0;
/* size of savepoint storage area (see ha_init) */
ulong savepoint_alloc_size = 0;
namespace {
struct Storage_engine_identifier {
const LEX_CSTRING canonical;
const LEX_CSTRING legacy;
};
const Storage_engine_identifier se_names[] = {
{{STRING_WITH_LEN("INNODB")}, {STRING_WITH_LEN("INNOBASE")}},
{{STRING_WITH_LEN("NDBCLUSTER")}, {STRING_WITH_LEN("NDB")}},
{{STRING_WITH_LEN("MEMORY")}, {STRING_WITH_LEN("HEAP")}},
{{STRING_WITH_LEN("MRG_MYISAM")}, {STRING_WITH_LEN("MERGE")}}};
const auto se_names_end = std::end(se_names);
std::vector<std::string> disabled_se_names;
} // namespace
const char *ha_row_type[] = {"",
"FIXED",
"DYNAMIC",
"COMPRESSED",
"REDUNDANT",
"COMPACT",
/* Reserved to be "PAGE" in future versions */ "?",
"?",
"?",
"?"};
const char *tx_isolation_names[] = {"READ-UNCOMMITTED", "READ-COMMITTED",
"REPEATABLE-READ", "SERIALIZABLE", NullS};
TYPELIB tx_isolation_typelib = {array_elements(tx_isolation_names) - 1, "",
tx_isolation_names, nullptr};
// Called for each SE to check if given db.table_name is a system table.
static bool check_engine_system_table_handlerton(THD *unused, plugin_ref plugin,
void *arg);
static int ha_discover(THD *thd, const char *db, const char *name,
uchar **frmblob, size_t *frmlen);
/**
Structure used by SE during check for system table.
This structure is passed to each SE handlerton and the status (OUT param)
is collected.
*/
struct st_sys_tbl_chk_params {
const char *db; // IN param
const char *table_name; // IN param
bool is_sql_layer_system_table; // IN param
legacy_db_type db_type; // IN param
enum enum_sys_tbl_chk_status {
// db.table_name is not a supported system table.
NOT_KNOWN_SYSTEM_TABLE,
/*
db.table_name is a system table,
but may not be supported by SE.
*/
KNOWN_SYSTEM_TABLE,
/*
db.table_name is a system table,
and is supported by SE.
*/
SUPPORTED_SYSTEM_TABLE
} status; // OUT param
};
static plugin_ref ha_default_plugin(THD *thd) {
if (thd->variables.table_plugin) return thd->variables.table_plugin;
return my_plugin_lock(thd, &global_system_variables.table_plugin);
}
/** @brief
Return the default storage engine handlerton used for non-temp tables
for thread
SYNOPSIS
ha_default_handlerton(thd)
thd current thread
RETURN
pointer to handlerton
*/
handlerton *ha_default_handlerton(THD *thd) {
plugin_ref plugin = ha_default_plugin(thd);
assert(plugin);
handlerton *hton = plugin_data<handlerton *>(plugin);
assert(hton);
return hton;
}
static plugin_ref ha_default_temp_plugin(THD *thd) {
if (thd->variables.temp_table_plugin) return thd->variables.temp_table_plugin;
return my_plugin_lock(thd, &global_system_variables.temp_table_plugin);
}
/** @brief
Return the default storage engine handlerton used for explicitly
created temp tables for a thread
SYNOPSIS
ha_default_temp_handlerton(thd)
thd current thread
RETURN
pointer to handlerton
*/
handlerton *ha_default_temp_handlerton(THD *thd) {
plugin_ref plugin = ha_default_temp_plugin(thd);
assert(plugin);
handlerton *hton = plugin_data<handlerton *>(plugin);
assert(hton);
return hton;
}
/**
Resolve handlerton plugin by name, without checking for "DEFAULT" or
HTON_NOT_USER_SELECTABLE.
@param thd Thread context.
@param name Plugin name.
@return plugin or NULL if not found.
*/
plugin_ref ha_resolve_by_name_raw(THD *thd, const LEX_CSTRING &name) {
return plugin_lock_by_name(thd, name, MYSQL_STORAGE_ENGINE_PLUGIN);
}
static const CHARSET_INFO &hton_charset() { return *system_charset_info; }
/**
Return the storage engine handlerton for the supplied name.
@param thd Current thread. May be nullptr, (e.g. during initialize).
@param name Name of storage engine.
@param is_temp_table true if table is a temporary table.
@return Pointer to storage engine plugin handle.
*/
plugin_ref ha_resolve_by_name(THD *thd, const LEX_CSTRING *name,
bool is_temp_table) {
if (thd && 0 == strnncmp_nopads(hton_charset(), *name,
{STRING_WITH_LEN("DEFAULT")})) {
return is_temp_table ? ha_default_plugin(thd) : ha_default_temp_plugin(thd);
}
// Note that thd CAN be nullptr here - it is not actually needed by
// ha_resolve_by_name_raw().
plugin_ref plugin = ha_resolve_by_name_raw(thd, *name);
if (plugin == nullptr) {
// If we fail to resolve the name passed in, we try to see if it is a
// historical alias.
auto match = std::find_if(
std::begin(se_names), se_names_end,
[&](const Storage_engine_identifier &sei) {
return (0 == strnncmp_nopads(hton_charset(), *name, sei.legacy));
});
if (match != se_names_end) {
// if it is, we resolve using the new name
plugin = ha_resolve_by_name_raw(thd, match->canonical);
}
}
if (plugin != nullptr) {
handlerton *hton = plugin_data<handlerton *>(plugin);
if (hton && !(hton->flags & HTON_NOT_USER_SELECTABLE)) return plugin;
/*
unlocking plugin immediately after locking is relatively low cost.
*/
plugin_unlock(thd, plugin);
}
return nullptr;
}
bool ha_secondary_engine_supports_ddl(
THD *thd, const LEX_CSTRING &secondary_engine) noexcept {
/* Allow DDLs by default if plugin is not installed. Otherwise let the plugin
* handler decide the fate. */
bool ret = true;
auto *plugin = ha_resolve_by_name_raw(thd, secondary_engine);
if (plugin != nullptr) {
const auto *se_hton = plugin_data<const handlerton *>(plugin);
ret = (se_hton != nullptr) ? secondary_engine_supports_ddl(se_hton) : false;
plugin_unlock(thd, plugin);
}
return ret;
}
/**
Read a comma-separated list of storage engine names. Look up each in the
known list of canonical and legacy names. In case of a match; add both the
canonical and the legacy name to disabled_se_names, which is a static vector
of disabled storage engine names.
If there is no match, the unmodified name is added to the vector.
*/
void set_externally_disabled_storage_engine_names(const char *disabled_list) {
assert(disabled_list != nullptr);
myu::Split(
disabled_list, disabled_list + strlen(disabled_list), myu::IsComma,
[](const char *f, const char *l) {
auto tr = myu::FindTrimmedRange(f, l, myu::IsSpace);
if (tr.first == tr.second) return;
const LEX_CSTRING dse{tr.first,
static_cast<size_t>(tr.second - tr.first)};
auto match = std::find_if(
std::begin(se_names), se_names_end,
[&](const Storage_engine_identifier &seid) {
return (
(0 == strnncmp_nopads(hton_charset(), dse, seid.canonical)) ||
(0 == strnncmp_nopads(hton_charset(), dse, seid.legacy)));
});
if (match == se_names_end) {
disabled_se_names.emplace_back(dse.str, dse.length);
return;
}
disabled_se_names.emplace_back(match->canonical.str,
match->canonical.length);
disabled_se_names.emplace_back(match->legacy.str, match->legacy.length);
});
}
static bool is_storage_engine_name_externally_disabled(const char *name) {
const LEX_CSTRING n{name, strlen(name)};
return std::any_of(
disabled_se_names.begin(), disabled_se_names.end(),
[&](const std::string &dse) {
return (0 == strnncmp_nopads(hton_charset(), n,
{dse.c_str(), dse.length()}));
});
}
/**
Returns true if the storage engine of the handlerton argument has
been listed in the disabled_storage_engines system variable. @note
that the SE may still be internally enabled, that is
HaIsInternallyEnabled may return true.
*/
bool ha_is_externally_disabled(const handlerton &htnr) {
const char *se_name = ha_resolve_storage_engine_name(&htnr);
assert(se_name != nullptr);
return is_storage_engine_name_externally_disabled(se_name);
}
// Check if storage engine is disabled for table/tablespace creation.
bool ha_is_storage_engine_disabled(handlerton *se_handle) {
assert(se_handle != nullptr);
return ha_is_externally_disabled(*se_handle);
}
plugin_ref ha_lock_engine(THD *thd, const handlerton *hton) {
if (hton) {
st_plugin_int **plugin = &se_plugin_array[hton->slot];
#ifdef NDEBUG
/*
Take a shortcut for builtin engines -- return pointer to plugin
without acquiring LOCK_plugin mutex. This is safe safe since such
plugins are not deleted until shutdown and we don't do reference
counting in non-debug builds for them.
Since we have reference to handlerton on our hands, this method
can't be called concurrently to non-builtin handlerton initialization/
deinitialization. So it is safe to access builtin_htons[] without
additional locking.
*/
if (builtin_htons[hton->slot]) return *plugin;
return my_plugin_lock(thd, plugin);
#else
/*
We can't take shortcut in debug builds.
At least assert that builtin_htons[slot] is set correctly.
*/
assert(builtin_htons[hton->slot] == (plugin[0]->plugin_dl == nullptr));
return my_plugin_lock(thd, &plugin);
#endif
}
return nullptr;
}
handlerton *ha_resolve_by_legacy_type(THD *thd, enum legacy_db_type db_type) {
plugin_ref plugin;
switch (db_type) {
case DB_TYPE_DEFAULT:
return ha_default_handlerton(thd);
default:
if (db_type > DB_TYPE_UNKNOWN && db_type < DB_TYPE_DEFAULT &&
(plugin = ha_lock_engine(thd, installed_htons[db_type])))
return plugin_data<handlerton *>(plugin);
[[fallthrough]];
case DB_TYPE_UNKNOWN:
return nullptr;
}
}
/**
Use other database handler if databasehandler is not compiled in.
*/
handlerton *ha_checktype(THD *thd, enum legacy_db_type database_type,
bool no_substitute, bool report_error) {
DBUG_TRACE;
handlerton *hton = ha_resolve_by_legacy_type(thd, database_type);
if (ha_storage_engine_is_enabled(hton)) return hton;
if (no_substitute) {
if (report_error) {
const char *engine_name = ha_resolve_storage_engine_name(hton);
my_error(ER_FEATURE_DISABLED, MYF(0), engine_name, engine_name);
}
return nullptr;
}
(void)RUN_HOOK(transaction, after_rollback, (thd, false));
switch (database_type) {
case DB_TYPE_MRG_ISAM:
return ha_resolve_by_legacy_type(thd, DB_TYPE_MRG_MYISAM);
default:
break;
}
return ha_default_handlerton(thd);
} /* ha_checktype */
/**
Create handler object for the table in the storage engine.
@param share TABLE_SHARE for the table, can be NULL if caller
didn't perform full-blown open of table definition.
@param partitioned Indicates whether table is partitioned.
@param alloc Memory root to be used for allocating handler object.
@param db_type Table's storage engine.
@note This function will try to use default storage engine if one which
was specified through db_type parameter is not available.
*/
handler *get_new_handler(TABLE_SHARE *share, bool partitioned, MEM_ROOT *alloc,
handlerton *db_type) {
handler *file;
DBUG_TRACE;
DBUG_PRINT("enter", ("alloc: %p", alloc));
if (db_type && db_type->state == SHOW_OPTION_YES && db_type->create) {
if ((file = db_type->create(db_type, share, partitioned, alloc)))
file->init();
return file;
}
/*
Try the default table type
Here the call to current_thd() is ok as we call this function a lot of
times but we enter this branch very seldom.
*/
return get_new_handler(share, partitioned, alloc,
ha_default_handlerton(current_thd));
}
static const char **handler_errmsgs;
static const char *get_handler_errmsg(int nr) {
return handler_errmsgs[nr - HA_ERR_FIRST];
}
/**
Register handler error messages for use with my_error().
@retval
0 OK
@retval
!=0 Error
*/
int ha_init_errors(void) {
#define SETMSG(nr, msg) handler_errmsgs[(nr)-HA_ERR_FIRST] = (msg)
/* Allocate a pointer array for the error message strings. */
/* Zerofill it to avoid uninitialized gaps. */
if (!(handler_errmsgs = static_cast<const char **>(my_malloc(
key_memory_errmsgs_handler, HA_ERR_ERRORS * sizeof(char *),
MYF(MY_WME | MY_ZEROFILL)))))
return 1;
/* Set the dedicated error messages. */
SETMSG(HA_ERR_KEY_NOT_FOUND, ER_DEFAULT(ER_KEY_NOT_FOUND));
SETMSG(HA_ERR_FOUND_DUPP_KEY, ER_DEFAULT(ER_DUP_KEY));
SETMSG(HA_ERR_RECORD_CHANGED, "Update wich is recoverable");
SETMSG(HA_ERR_WRONG_INDEX, "Wrong index given to function");
SETMSG(HA_ERR_CRASHED, ER_DEFAULT(ER_NOT_KEYFILE));
SETMSG(HA_ERR_WRONG_IN_RECORD, ER_DEFAULT(ER_CRASHED_ON_USAGE));
SETMSG(HA_ERR_OUT_OF_MEM, "Table handler out of memory");
SETMSG(HA_ERR_NOT_A_TABLE, "Incorrect file format '%.64s'");
SETMSG(HA_ERR_WRONG_COMMAND, "Command not supported");
SETMSG(HA_ERR_OLD_FILE, ER_DEFAULT(ER_OLD_KEYFILE));
SETMSG(HA_ERR_NO_ACTIVE_RECORD, "No record read in update");
SETMSG(HA_ERR_RECORD_DELETED, "Intern record deleted");
SETMSG(HA_ERR_RECORD_FILE_FULL, ER_DEFAULT(ER_RECORD_FILE_FULL));
SETMSG(HA_ERR_INDEX_FILE_FULL, "No more room in index file '%.64s'");
SETMSG(HA_ERR_END_OF_FILE, "End in next/prev/first/last");
SETMSG(HA_ERR_UNSUPPORTED, ER_DEFAULT(ER_ILLEGAL_HA));
SETMSG(HA_ERR_TOO_BIG_ROW, "Too big row");
SETMSG(HA_WRONG_CREATE_OPTION, "Wrong create option");
SETMSG(HA_ERR_FOUND_DUPP_UNIQUE, ER_DEFAULT(ER_DUP_UNIQUE));
SETMSG(HA_ERR_UNKNOWN_CHARSET, "Can't open charset");
SETMSG(HA_ERR_WRONG_MRG_TABLE_DEF, ER_DEFAULT(ER_WRONG_MRG_TABLE));
SETMSG(HA_ERR_CRASHED_ON_REPAIR, ER_DEFAULT(ER_CRASHED_ON_REPAIR));
SETMSG(HA_ERR_CRASHED_ON_USAGE, ER_DEFAULT(ER_CRASHED_ON_USAGE));
SETMSG(HA_ERR_LOCK_WAIT_TIMEOUT, ER_DEFAULT(ER_LOCK_WAIT_TIMEOUT));
SETMSG(HA_ERR_LOCK_TABLE_FULL, ER_DEFAULT(ER_LOCK_TABLE_FULL));
SETMSG(HA_ERR_READ_ONLY_TRANSACTION, ER_DEFAULT(ER_READ_ONLY_TRANSACTION));
SETMSG(HA_ERR_LOCK_DEADLOCK, ER_DEFAULT(ER_LOCK_DEADLOCK));
SETMSG(HA_ERR_CANNOT_ADD_FOREIGN, ER_DEFAULT(ER_CANNOT_ADD_FOREIGN));
SETMSG(HA_ERR_NO_REFERENCED_ROW, ER_DEFAULT(ER_NO_REFERENCED_ROW_2));
SETMSG(HA_ERR_ROW_IS_REFERENCED, ER_DEFAULT(ER_ROW_IS_REFERENCED_2));
SETMSG(HA_ERR_NO_SAVEPOINT, "No savepoint with that name");
SETMSG(HA_ERR_NON_UNIQUE_BLOCK_SIZE, "Non unique key block size");
SETMSG(HA_ERR_NO_SUCH_TABLE, "No such table: '%.64s'");
SETMSG(HA_ERR_TABLE_EXIST, ER_DEFAULT(ER_TABLE_EXISTS_ERROR));
SETMSG(HA_ERR_NO_CONNECTION, "Could not connect to storage engine");
SETMSG(HA_ERR_TABLE_DEF_CHANGED, ER_DEFAULT(ER_TABLE_DEF_CHANGED));
SETMSG(HA_ERR_FOREIGN_DUPLICATE_KEY,
"FK constraint would lead to duplicate key");
SETMSG(HA_ERR_TABLE_NEEDS_UPGRADE, ER_DEFAULT(ER_TABLE_NEEDS_UPGRADE));
SETMSG(HA_ERR_TABLE_READONLY, ER_DEFAULT(ER_OPEN_AS_READONLY));
SETMSG(HA_ERR_AUTOINC_READ_FAILED, ER_DEFAULT(ER_AUTOINC_READ_FAILED));
SETMSG(HA_ERR_AUTOINC_ERANGE, ER_DEFAULT(ER_WARN_DATA_OUT_OF_RANGE));
SETMSG(HA_ERR_TOO_MANY_CONCURRENT_TRXS,
ER_DEFAULT(ER_TOO_MANY_CONCURRENT_TRXS));
SETMSG(HA_ERR_INDEX_COL_TOO_LONG, ER_DEFAULT(ER_INDEX_COLUMN_TOO_LONG));
SETMSG(HA_ERR_INDEX_CORRUPT, ER_DEFAULT(ER_INDEX_CORRUPT));
SETMSG(HA_FTS_INVALID_DOCID, "Invalid InnoDB FTS Doc ID");
SETMSG(HA_ERR_TABLE_IN_FK_CHECK, ER_DEFAULT(ER_TABLE_IN_FK_CHECK));
SETMSG(HA_ERR_TABLESPACE_EXISTS, "Tablespace already exists");
SETMSG(HA_ERR_TABLESPACE_MISSING, ER_DEFAULT(ER_TABLESPACE_MISSING));
SETMSG(HA_ERR_FTS_EXCEED_RESULT_CACHE_LIMIT,
"FTS query exceeds result cache limit");
SETMSG(HA_ERR_TEMP_FILE_WRITE_FAILURE,
ER_DEFAULT(ER_TEMP_FILE_WRITE_FAILURE));
SETMSG(HA_ERR_INNODB_FORCED_RECOVERY, ER_DEFAULT(ER_INNODB_FORCED_RECOVERY));
SETMSG(HA_ERR_FTS_TOO_MANY_WORDS_IN_PHRASE,
"Too many words in a FTS phrase or proximity search");
SETMSG(HA_ERR_TABLE_CORRUPT, ER_DEFAULT(ER_TABLE_CORRUPT));
SETMSG(HA_ERR_TABLESPACE_MISSING, ER_DEFAULT(ER_TABLESPACE_MISSING));
SETMSG(HA_ERR_TABLESPACE_IS_NOT_EMPTY,
ER_DEFAULT(ER_TABLESPACE_IS_NOT_EMPTY));
SETMSG(HA_ERR_WRONG_FILE_NAME, ER_DEFAULT(ER_WRONG_FILE_NAME));
SETMSG(HA_ERR_NOT_ALLOWED_COMMAND, ER_DEFAULT(ER_NOT_ALLOWED_COMMAND));
SETMSG(HA_ERR_COMPUTE_FAILED, "Compute virtual column value failed");
SETMSG(HA_ERR_DISK_FULL_NOWAIT, ER_DEFAULT(ER_DISK_FULL_NOWAIT));
SETMSG(HA_ERR_NO_SESSION_TEMP, ER_DEFAULT(ER_NO_SESSION_TEMP));
SETMSG(HA_ERR_WRONG_TABLE_NAME, ER_DEFAULT(ER_WRONG_TABLE_NAME));
SETMSG(HA_ERR_TOO_LONG_PATH, ER_DEFAULT(ER_TABLE_NAME_CAUSES_TOO_LONG_PATH));
SETMSG(HA_ERR_FTS_TOO_MANY_NESTED_EXP,
"Too many nested sub-expressions in a full-text search");
/* Register the error messages for use with my_error(). */
return my_error_register(get_handler_errmsg, HA_ERR_FIRST, HA_ERR_LAST);
}
int ha_finalize_handlerton(st_plugin_int *plugin) {
handlerton *hton = (handlerton *)plugin->data;
DBUG_TRACE;
/* hton can be NULL here, if ha_initialize_handlerton() failed. */
if (!hton) goto end;
switch (hton->state) {
case SHOW_OPTION_NO:
case SHOW_OPTION_DISABLED:
break;
case SHOW_OPTION_YES:
if (installed_htons[hton->db_type] == hton)
installed_htons[hton->db_type] = nullptr;
break;
};
if (hton->panic) hton->panic(hton, HA_PANIC_CLOSE);
if (plugin->plugin->deinit) {
/*
Today we have no defined/special behavior for uninstalling
engine plugins.
*/
DBUG_PRINT("info", ("Deinitializing plugin: '%s'", plugin->name.str));
if (plugin->plugin->deinit(plugin)) {
DBUG_PRINT("warning", ("Plugin '%s' deinit function returned error.",
plugin->name.str));
}
}
/*
In case a plugin is uninstalled and re-installed later, it should
reuse an array slot. Otherwise the number of uninstall/install
cycles would be limited.
*/
if (hton->slot != HA_SLOT_UNDEF) {
/* Make sure we are not unpluging another plugin */
assert(se_plugin_array[hton->slot] == plugin);
assert(hton->slot < se_plugin_array.size());
se_plugin_array[hton->slot] = nullptr;
builtin_htons[hton->slot] = false; /* Extra correctness. */
}
my_free(hton);
plugin->data = nullptr;
end:
return 0;
}
int ha_initialize_handlerton(st_plugin_int *plugin) {
handlerton *hton;
DBUG_TRACE;
DBUG_PRINT("plugin", ("initialize plugin: '%s'", plugin->name.str));
hton = static_cast<handlerton *>(my_malloc(key_memory_handlerton_objects,
sizeof(handlerton),
MYF(MY_WME | MY_ZEROFILL)));
if (hton == nullptr) {
LogErr(ERROR_LEVEL, ER_HANDLERTON_OOM, plugin->name.str);
goto err_no_hton_memory;
}
hton->slot = HA_SLOT_UNDEF;
/* Historical Requirement */
plugin->data = hton; // shortcut for the future
if (plugin->plugin->init && plugin->plugin->init(hton)) {
LogErr(ERROR_LEVEL, ER_PLUGIN_INIT_FAILED, plugin->name.str);
goto err;
}
/*
the switch below and hton->state should be removed when
command-line options for plugins will be implemented
*/
DBUG_PRINT("info", ("hton->state=%d", hton->state));
switch (hton->state) {
case SHOW_OPTION_NO:
break;
case SHOW_OPTION_YES: {
uint tmp;
ulong fslot;
/* now check the db_type for conflict */
if (hton->db_type <= DB_TYPE_UNKNOWN ||
hton->db_type >= DB_TYPE_DEFAULT || installed_htons[hton->db_type]) {
int idx = (int)DB_TYPE_FIRST_DYNAMIC;
while (idx < (int)DB_TYPE_DEFAULT && installed_htons[idx]) idx++;
if (idx == (int)DB_TYPE_DEFAULT) {
LogErr(WARNING_LEVEL, ER_TOO_MANY_STORAGE_ENGINES);
goto err_deinit;
}
if (hton->db_type != DB_TYPE_UNKNOWN)
LogErr(WARNING_LEVEL, ER_SE_TYPECODE_CONFLICT, plugin->plugin->name,
idx);
hton->db_type = (enum legacy_db_type)idx;
}
/*
In case a plugin is uninstalled and re-installed later, it should
reuse an array slot. Otherwise the number of uninstall/install
cycles would be limited. So look for a free slot.
*/
DBUG_PRINT("plugin",
("total_ha: %lu", static_cast<ulong>(se_plugin_array.size())));
for (fslot = 0; fslot < se_plugin_array.size(); fslot++) {
if (!se_plugin_array[fslot]) break;
}
if (fslot < se_plugin_array.size())
hton->slot = fslot;
else {
hton->slot = se_plugin_array.size();
}
if (se_plugin_array.assign_at(hton->slot, plugin) ||
builtin_htons.assign_at(hton->slot, (plugin->plugin_dl == nullptr)))
goto err_deinit;
installed_htons[hton->db_type] = hton;
tmp = hton->savepoint_offset;
hton->savepoint_offset = savepoint_alloc_size;
savepoint_alloc_size += tmp;
if (hton->prepare) total_ha_2pc++;
break;
}
[[fallthrough]];
default:
hton->state = SHOW_OPTION_DISABLED;
break;
}
/*
This is entirely for legacy. We will create a new "disk based" hton and a
"memory" hton which will be configurable longterm. We should be able to
remove partition and myisammrg.
*/
switch (hton->db_type) {
case DB_TYPE_HEAP:
heap_hton = hton;
break;
case DB_TYPE_TEMPTABLE:
temptable_hton = hton;
break;
case DB_TYPE_MYISAM:
myisam_hton = hton;
break;
case DB_TYPE_INNODB:
innodb_hton = hton;
break;
default:
break;
};
/*
Re-load the optimizer cost constants since this storage engine can
have non-default cost constants.
*/
reload_optimizer_cost_constants();
return 0;
err_deinit:
/*
Let plugin do its inner deinitialization as plugin->init()
was successfully called before.
*/
if (plugin->plugin->deinit) (void)plugin->plugin->deinit(plugin);
err:
my_free(hton);
err_no_hton_memory:
plugin->data = nullptr;
return 1;
}
int ha_init() {
const int error = 0;
DBUG_TRACE;
/*
Check if there is a transaction-capable storage engine besides the
binary log.
*/
opt_using_transactions =
se_plugin_array.size() > static_cast<ulong>(opt_bin_log);
savepoint_alloc_size += sizeof(SAVEPOINT);
return error;
}
void ha_end() {
// Unregister handler error messages.
my_error_unregister(HA_ERR_FIRST, HA_ERR_LAST);
my_free(handler_errmsgs);
}
static bool dropdb_handlerton(THD *, plugin_ref plugin, void *path) {
handlerton *hton = plugin_data<handlerton *>(plugin);
if (hton->state == SHOW_OPTION_YES && hton->drop_database)
hton->drop_database(hton, (char *)path);
return false;
}
void ha_drop_database(char *path) {
plugin_foreach(nullptr, dropdb_handlerton, MYSQL_STORAGE_ENGINE_PLUGIN, path);
}
static bool closecon_handlerton(THD *thd, plugin_ref plugin, void *) {
handlerton *hton = plugin_data<handlerton *>(plugin);
/*
there's no need to rollback here as all transactions must
be rolled back already
*/
if (hton->state == SHOW_OPTION_YES && thd_get_ha_data(thd, hton)) {
if (hton->close_connection) hton->close_connection(hton, thd);
/* make sure ha_data is reset and ha_data_lock is released */
thd_set_ha_data(thd, hton, nullptr);
}
return false;
}
static bool reset_plugin_vars_handlerton(THD *thd, plugin_ref plugin, void *) {
handlerton *hton = plugin_data<handlerton *>(plugin);
if (hton->reset_plugin_vars != nullptr) hton->reset_plugin_vars(thd);
return false;
}
void ha_reset_plugin_vars(THD *thd) {
plugin_foreach(thd, reset_plugin_vars_handlerton, MYSQL_STORAGE_ENGINE_PLUGIN,
nullptr);
}
/**
@note
don't bother to rollback here, it's done already
*/
void ha_close_connection(THD *thd) {
plugin_foreach(thd, closecon_handlerton, MYSQL_STORAGE_ENGINE_PLUGIN,
nullptr);
}
static bool kill_handlerton(THD *thd, plugin_ref plugin, void *) {
handlerton *hton = plugin_data<handlerton *>(plugin);
if (hton->state == SHOW_OPTION_YES && hton->kill_connection) {
if (thd_get_ha_data(thd, hton)) hton->kill_connection(hton, thd);
}
return false;
}
void ha_kill_connection(THD *thd) {
plugin_foreach(thd, kill_handlerton, MYSQL_STORAGE_ENGINE_PLUGIN, nullptr);
}
/** Invoke handlerton::pre_dd_shutdown() on a plugin.
@param plugin storage engine plugin
@retval false (always) */
static bool pre_dd_shutdown_handlerton(THD *, plugin_ref plugin, void *) {
handlerton *hton = plugin_data<handlerton *>(plugin);
if (hton->state == SHOW_OPTION_YES && hton->pre_dd_shutdown) {
/*
systemd notifications are added here to make the case of "InnoDB purge
thread taking a long time to shut down" externally visible. The message is
kept general to accommodate pre_dd_shutdown handlertons of other SEs (if
any).
*/
sysd::notify("STATUS=Pre DD shutdown of MySQL SE plugin ",
ha_resolve_storage_engine_name(hton), " in progress\n");
hton->pre_dd_shutdown(hton);
sysd::notify("STATUS=Pre DD shutdown of MySQL SE plugin ",
ha_resolve_storage_engine_name(hton), " completed\n");