Bug#37592337 Add cmake option ENABLE_HYPERGRAPH_OPTIMIZER

OPTIMIZER_SWITCH_HYPERGRAPH_OPTIMIZER is currently not part of
OPTIMIZER_SWITCH_DEFAULT.  Add a cmake option
ENABLE_HYPERGRAPH_OPTIMIZER to enable adding it.  Default value OFF,
if set to ON it will also enable WITH_HYPERGRAPH_OPTIMIZER.

We currently test the hypergraph optimizer with a special --hypergraph to mtr.
This flag is passed on to mysqltest, which will do
      "SET @@session.optimizer_switch='hypergraph_optimizer=on', "
      "@@global.optimizer_switch='hypergraph_optimizer=on';";
for each connection.

Handling of .result differences between traditional and hypergraph optimizer
is based on special tags in the .mtr tests, environment variables and
special diff handling of .result files.

Extend mysqltest to also ask the server "is the hypergraph optimizer active"?
If so, activate the special diff handling in mysqltest.

Also for the mtr tests: ask the server rather than relying on a
special environment variable HYPERGRAPH_TEST set by mtr.

A few .mtr tests did SHOW STATUS LIKE 'Created_tmp_tables' and failed
due to the extra "SHOW VARIABLES LIKE 'optimizer_switch'" from
mysqltest. Fixed by doing "FLUSH STATUS" in each test.

The patch also introduces a new option --hypergraph-off. With this
option mysqltest will do
      "SET @@session.optimizer_switch='hypergraph_optimizer=off', "
      "@@global.optimizer_switch='hypergraph_optimizer=off';";
for each connection.
This is implemented in order to be able to test the old optimizer when
OPTIMIZER_SWITCH_HYPERGRAPH_OPTIMIZER is part of
OPTIMIZER_SWITCH_DEFAULT.

To summarize the options:
--hypergraph       : mysqltest turns hypergraph ON
--hypergraph-off   : mysqltest turns hypergraph OFF
both options given : illegal, mtr aborts
none of them given : mysqltest asks server whether hypergraph is ON/OFF

A few mtr tests will explicitly turn hypergraph ON themselves, by doing
--source include/have_hypergraph.inc
This will re-enable hypergraph for that particular test even when
--hypergraph-off is given.

For test suites which have not been prepared for running with
--hypergraph, running against a server built with
ENABLE_HYPERGRAPH_OPTIMIZER, the new --hypergraph-off option will
revert back to the original behaviour, e.g:

./mtr --mem --force --parallel=8 --with-ndb-only --hypergraph-off

Change-Id: I3f53eec974a0b40d58a97420e1f0a75aceb265ce

Author: Tor Didriksen

CMakeLists.txt

@@ -2258,6 +2258,13 @@ ELSE()
   # Do not initialize the option, set it ON for $<CONFIG:Debug>
   SET(WITH_HYPERGRAPH_OPTIMIZER_DEFAULT "default")
 ENDIF()
+OPTION(ENABLE_HYPERGRAPH_OPTIMIZER
+  "Enable hypergraph optimizer in OPTIMIZER_SWITCH_DEFAULT" OFF
+  )
+IF(ENABLE_HYPERGRAPH_OPTIMIZER)
+  SET(WITH_HYPERGRAPH_OPTIMIZER ON)
+  SET(WITH_HYPERGRAPH_OPTIMIZER ON CACHE BOOL "" FORCE)
+ENDIF()
 
 # Allow SHOW PARSE_TREE on debug build by default.
 IF(CMAKE_BUILD_TYPE_UPPER STREQUAL "DEBUG" OR WITH_DEBUG)

client/mysqltest.cc

@@ -172,6 +172,7 @@ enum {
   OPT_CURSOR_PROTOCOL,
   OPT_EXPLAIN_PROTOCOL,
   OPT_HYPERGRAPH,
+  OPT_HYPERGRAPH_OFF,
   OPT_JSON_EXPLAIN_PROTOCOL,
   OPT_LOG_DIR,
   OPT_MARK_PROGRESS,
@@ -239,6 +240,10 @@ static const char *load_default_groups[] = {"mysqltest", "client", nullptr};
 static char line_buffer[MAX_DELIMITER_LENGTH], *line_buffer_pos = line_buffer;
 static bool can_handle_expired_passwords = true;
 static bool opt_hypergraph = false;
+static bool opt_hypergraph_off = false;
+static bool hypergraph_enabled = false;
+
+bool hypergraph_is_active() { return opt_hypergraph || hypergraph_enabled; }
 
 /*
   These variables control the behavior of the asynchronous operations for
@@ -1311,7 +1316,7 @@ void handle_error(struct st_command *command, std::uint32_t err_errno,
                   const char *interpolated_query = nullptr) {
   DBUG_TRACE;
 
-  if (opt_hypergraph && err_errno == ER_HYPERGRAPH_NOT_SUPPORTED_YET) {
+  if (hypergraph_is_active() && err_errno == ER_HYPERGRAPH_NOT_SUPPORTED_YET) {
     const char errstr[] = "<ignored hypergraph optimizer error: ";
     dynstr_append_mem(ds, errstr, sizeof(errstr) - 1);
     replace_dynstr_append(ds, err_error);
@@ -2082,7 +2087,7 @@ static bool show_diff(DYNAMIC_STRING *ds, const char *filename1,
                                "2>&1", nullptr);
           if (exit_code > 1) diff_name = nullptr;
         }
-      } else if (exit_code == 1 && opt_hypergraph &&
+      } else if (exit_code == 1 && hypergraph_is_active() &&
                  is_diff_clean_except_hypergraph(&ds_diff)) {
         dynstr_free(&ds_diff);
         return true;
@@ -6631,6 +6636,18 @@ static bool enable_hypergraph_optimizer(st_connection *con) {
   return mysql_query_wrapper(&con->mysql, set_stmt) != 0;
 }
 
+/**
+   Disable the hypergraph optimizer in a connection. This allows you to test
+   the traditional optimizer in a mysqld server configured with
+   hypergraph_optimizer default ON.
+ */
+static bool disable_hypergraph_optimizer(st_connection *con) {
+  const char *set_stmt =
+      "SET @@session.optimizer_switch='hypergraph_optimizer=off', "
+      "@@global.optimizer_switch='hypergraph_optimizer=off';";
+  return mysql_query_wrapper(&con->mysql, set_stmt) != 0;
+}
+
 /*
   Open a new connection to MySQL Server with the parameters
   specified. Make the new connection the current connection.
@@ -6741,6 +6758,8 @@ static void do_connect(struct st_command *command) {
       assert(con_slot != next_con);
       if (opt_hypergraph) {
         enable_hypergraph_optimizer(con_slot);
+      } else if (opt_hypergraph_off) {
+        disable_hypergraph_optimizer(con_slot);
       }
     }
     /* mysql_reconnect changes this setting to true. We really want it to be
@@ -7870,9 +7889,15 @@ static struct my_option my_long_options[] = {
     {"host", 'h', "Connect to host.", &opt_host, &opt_host, nullptr, GET_STR,
      REQUIRED_ARG, 0, 0, 0, nullptr, 0, nullptr},
     {"hypergraph", OPT_HYPERGRAPH,
-     "Force all queries to be run under the hypergraph optimizer.",
+     "Force all queries to be run under the hypergraph optimizer. "
+     "SET @@optimizer_switch='hypergraph_optimizer=ON",
      &opt_hypergraph, &opt_hypergraph, nullptr, GET_BOOL, NO_ARG, 0, 0, 0,
      nullptr, 0, nullptr},
+    {"hypergraph-off", OPT_HYPERGRAPH_OFF,
+     "Force all queries to be run under the old optimizer. "
+     "SET @@optimizer_switch='hypergraph_optimizer=OFF",
+     &opt_hypergraph_off, &opt_hypergraph_off, nullptr, GET_BOOL, NO_ARG, 0, 0,
+     0, nullptr, 0, nullptr},
     {"include", 'i', "Include SQL before each test case.", &opt_include,
      &opt_include, nullptr, GET_STR, REQUIRED_ARG, 0, 0, 0, nullptr, 0,
      nullptr},
@@ -9161,7 +9186,7 @@ static void run_query(struct st_connection *cn, struct st_command *command,
     dynstr_append_mem(ds, "\n", 1);
   }
 
-  if (skip_if_hypergraph && opt_hypergraph) {
+  if (skip_if_hypergraph && hypergraph_is_active()) {
     constexpr char message[] =
         "<ignored hypergraph optimizer error: statement skipped by "
         "test>\n";
@@ -9699,6 +9724,10 @@ int main(int argc, char **argv) {
 
   parse_args(argc, argv);
 
+  if (opt_hypergraph && opt_hypergraph_off) {
+    die("Cannot specify both hypergraph and hypergraph-off");
+  }
+
 #ifdef _WIN32
   // Create an event to request stack trace when timeout occurs
   if (opt_safe_process_pid) create_stacktrace_collector_event();
@@ -9855,6 +9884,28 @@ int main(int argc, char **argv) {
           "hypergraph optimizer. (errno=%d)",
           my_errno());
     }
+  } else if (opt_hypergraph_off) {
+    if (disable_hypergraph_optimizer(con)) {
+      die("--hypergraph-off was given, (errno=%d)", my_errno());
+    }
+  } else {
+    // No explicit hypergraph option? Ask the server hypergraph is enabled.
+    std::string optimizer_switch;
+    if (query_get_string(&con->mysql, "SHOW VARIABLES LIKE 'optimizer_switch'",
+                         1, &optimizer_switch)) {
+      die("Failed to get optimizer_switch from server");
+    }
+    // It is tempting to FLUSH STATUS, but this modifies the database, and will
+    // cause misc tests (with implicit assumptions about database state)
+    // to fail. The query above will create a temporary table, so mtr tests
+    // making assumptions about 'Created_tmp_tables' must FLUSH STATUS.
+    //     if (mysql_query(&con->mysql, "FLUSH STATUS")) {
+    //       die("Failed to FLUSH STATUS");
+    //     }
+    const size_t found_hyper = optimizer_switch.find("hypergraph_optimizer=on");
+    if (found_hyper != std::string::npos) {
+      hypergraph_enabled = true;
+    }
   }
 
   if (opt_include) {

mysql-test/include/disable_hypergraph.inc

@@ -2,6 +2,8 @@
 # including include/have_hypergraph.inc.
 
 --disable_query_log
-SET @@session.optimizer_switch = 'hypergraph_optimizer=off',
-    @@global.optimizer_switch = 'hypergraph_optimizer=off';
+if(!$hypergraph_was_active) {
+  SET @@session.optimizer_switch = 'hypergraph_optimizer=off',
+      @@global.optimizer_switch = 'hypergraph_optimizer=off';
+}
 --enable_query_log

mysql-test/include/have_hypergraph.inc

@@ -10,10 +10,14 @@
 #     --source include/disable_hypergraph.inc
 
 --disable_query_log
---error 0, ER_HYPERGRAPH_NOT_SUPPORTED_YET
-SET @@session.optimizer_switch = 'hypergraph_optimizer=on',
-    @@global.optimizer_switch = 'hypergraph_optimizer=on';
-if (`SELECT NOT FIND_IN_SET('hypergraph_optimizer=on', @@optimizer_switch)`) {
-   --skip Test requires binaries built with WITH_HYPERGRAPH_OPTIMIZER=ON
+--source include/hypergraph_is_active.inc
+--let $hypergraph_was_active=$hypergraph_is_active;
+if(!$hypergraph_is_active) {
+  --error 0, ER_HYPERGRAPH_NOT_SUPPORTED_YET
+  SET @@session.optimizer_switch = 'hypergraph_optimizer=on',
+      @@global.optimizer_switch = 'hypergraph_optimizer=on';
+  if (`SELECT NOT FIND_IN_SET('hypergraph_optimizer=on', @@optimizer_switch)`) {
+     --skip Test requires binaries built with WITH_HYPERGRAPH_OPTIMIZER=ON
+  }
 }
 --enable_query_log

mysql-test/include/hypergraph_is_active.inc

@@ -0,0 +1,9 @@
+# include/hypergraph_is_active.inc
+#
+# Ask the server whether hypergraph_optimizer is ON
+#
+--let $hypergraph_is_active= 0
+if (`select locate('hypergraph_optimizer=on', @@optimizer_switch) > 0`)
+{
+   --let $hypergraph_is_active= 1
+}

mysql-test/include/mysqld--help.inc

@@ -68,6 +68,7 @@ perl;
     s/\b286720\b/262144/;
     s/\b442368\b/262144/;
     s/\b221184\b/262144/;
+    s/hypergraph_optimizer=on/hypergraph_optimizer=off/;
     # Replacing port number with string
     s/^port \d+/port ####/;
     # log-tc-size varies by platform

mysql-test/include/not_hypergraph.inc

@@ -1,14 +1,13 @@
 # include/not_hypergraph.inc
 #
-# Skip the test if we are forcing the hypergraph optimizer. This is typically
+# Skip the test if we are using the hypergraph optimizer. This is typically
 # because the test expects some given query plan, or more generally expects
 # certain debug/non-critical input that will differ. Tests that give the wrong
 # answer or crash under the hypergraph optimizer should not be using this file;
 # instead, the optimizer should error out with ER_HYPERGRAPH_NOT_SUPPORTED_YET.
 #
 
-if ($HYPERGRAPH_TEST) {
-  --skip Not supported under '--hypergraph'
+if (`select locate('hypergraph_optimizer=on', @@optimizer_switch) > 0`)
+{
+  --skip server has hypergraph_optimizer ON
 }
-
-

mysql-test/include/subquery_sj.inc

@@ -2,6 +2,7 @@
 # Nested Loops semi-join subquery evaluation tests
 #
 --source include/elide_costs.inc
+--source include/hypergraph_is_active.inc
 
 # This portion of the file vas developed when subquery materialization
 # was rule-based; to preserve the intended test scenarios, we switch
@@ -4351,12 +4352,12 @@ WHERE col_varchar_10_latin1_key IN (
     WHERE alias1.pk AND alias1.pk < 3 OR alias1.pk AND alias3.pk);
 ANALYZE TABLE t1, t2, t3;
 eval EXPLAIN $query;
-if ($HYPERGRAPH_TEST) {
+if ($hypergraph_is_active) {
   # Different warnings with hypergraph than with old optimizer.
   --disable_warnings
 }
 eval $query;
-if ($HYPERGRAPH_TEST) {
+if ($hypergraph_is_active) {
   --enable_warnings
 }
 

mysql-test/mysql-test-run.pl

@@ -299,6 +299,7 @@
 our $opt_gcov_exe                  = "gcov";
 our $opt_gcov_msg                  = "mysql-test-gcov.msg";
 our $opt_hypergraph                = 0;
+our $opt_hypergraph_off            = 0;
 our $opt_keep_ndbfs                = 0;
 our $opt_mem                       = $ENV{'MTR_MEM'} ? 1 : 0;
 our $opt_only_big_test             = 0;
@@ -1675,6 +1676,7 @@ sub print_global_resfile {
   resfile_global("gprof",            $opt_gprof            ? 1 : 0);
   resfile_global("helgrind",         $opt_helgrind         ? 1 : 0);
   resfile_global("hypergraph",       $opt_hypergraph       ? 1 : 0);
+  resfile_global("hypergraph-off",   $opt_hypergraph_off   ? 1 : 0);
   resfile_global("initialize",       \@opt_extra_bootstrap_opt);
   resfile_global("max-connections",  $opt_max_connections);
   resfile_global("mem",              $opt_mem              ? 1 : 0);
@@ -1733,6 +1735,7 @@ sub command_line_setup {
     'cursor-protocol'       => \$opt_cursor_protocol,
     'explain-protocol'      => \$opt_explain_protocol,
     'hypergraph'            => \$opt_hypergraph,
+    'hypergraph-off'        => \$opt_hypergraph_off,
     'json-explain-protocol' => \$opt_json_explain_protocol,
     'opt-trace-protocol'    => \$opt_trace_protocol,
     'ps-protocol'           => \$opt_ps_protocol,
@@ -3582,10 +3585,6 @@ sub environment_setup {
     mtr_exe_exists("$path_client_bindir/mysql_tzinfo_to_sql");
   $ENV{'MYSQL_TZINFO_TO_SQL'} = native_path($exe_mysql_tzinfo_to_sql);
 
-  # Create an environment variable to make it possible
-  # to detect that the hypergraph optimizer is being used from test cases
-  $ENV{'HYPERGRAPH_TEST'} = $opt_hypergraph;
-
   # Create an environment variable to make it possible
   # to detect that valgrind is being used from test cases
   $ENV{'VALGRIND_TEST'} = $opt_valgrind;
@@ -7637,9 +7636,15 @@ ($$$)
   mtr_add_arg($args, "--verbose");
   mtr_add_arg($args, "--logdir=%s/tmp",  $opt_vardir);
 
+  if ($opt_hypergraph && $opt_hypergraph_off) {
+    die "Cannot specify both hypergraph and hypergraph-off";
+  }
   if ($opt_hypergraph) {
     mtr_add_arg($args, "--hypergraph");
   }
+  if ($opt_hypergraph_off) {
+    mtr_add_arg($args, "--hypergraph-off");
+  }
 
   if (IS_WINDOWS) {
     mtr_add_arg($args, "--protocol=pipe");
@@ -7765,9 +7770,15 @@ ($)
     mtr_add_arg($args, "--colored-diff", $opt_colored_diff);
   }
 
+  if ($opt_hypergraph && $opt_hypergraph_off) {
+    die "Cannot specify both hypergraph and hypergraph-off";
+  }
   if ($opt_hypergraph) {
     mtr_add_arg($args, "--hypergraph");
   }
+  if ($opt_hypergraph_off) {
+    mtr_add_arg($args, "--hypergraph-off");
+  }
 
   foreach my $arg (@opt_extra_mysqltest_opt) {
     mtr_add_arg($args, $arg);
@@ -8357,6 +8368,7 @@ ($)
   explain-protocol      Run 'EXPLAIN EXTENDED' on all SELECT, INSERT,
                         REPLACE, UPDATE and DELETE queries.
   hypergraph            Set the 'hypergraph_optimizer=on' optimizer switch.
+  hypergraph-off        Set the 'hypergraph_optimizer=off' optimizer switch.
   json-explain-protocol Run 'EXPLAIN FORMAT=JSON' on all SELECT, INSERT,
                         REPLACE, UPDATE and DELETE queries.
   opt-trace-protocol    Print optimizer trace.

mysql-test/r/temptable_basic.result

@@ -1,3 +1,4 @@
+FLUSH STATUS;
 SET @@GLOBAL.internal_tmp_mem_storage_engine = TempTable;
 CREATE TABLE t_int (c INT);
 CREATE TABLE t_char (c CHAR(20));

mysql-test/r/temptable_fallback.result

@@ -1,3 +1,4 @@
+FLUSH STATUS;
 # Disable sorting by addon fields, as that will enable the
 # StreamingIterator in many of the test cases, resulting in
 # fewer materializations.

mysql-test/r/temptable_no_pad_collation.result

@@ -1,6 +1,7 @@
 #
 # Prepare
 #
+FLUSH STATUS;
 SET @big_tables_saved = @@big_tables;
 SET @optimizer_switch_saved = @@optimizer_switch;
 #

mysql-test/r/using_hypergraph_optimizer.result

@@ -80,6 +80,7 @@ COUNT(*)
 SET optimizer_switch = 'hypergraph_optimizer=off';
 PREPARE ps_set FROM 'SET @x = (SELECT COUNT(*) FROM t)';
 PREPARE ps_select FROM 'SELECT COUNT(*) FROM t';
+SET optimizer_switch = 'hypergraph_optimizer=on';
 EXECUTE ps_set;
 SELECT COUNT(*) FROM INFORMATION_SCHEMA.OPTIMIZER_TRACE
 WHERE TRACE LIKE '%Constructed hypergraph%';
@@ -117,6 +118,7 @@ SELECT @x;
 3
 # Clean up for Bug #33296454
 DROP TABLE t;
+SET optimizer_switch = 'hypergraph_optimizer=on';
 # Bug #33296454 done
 #
 # Bug #33296504: Use the hypergraph optimizer for subqueries in INSERT statements
@@ -171,6 +173,7 @@ COUNT(*)
 0
 # Clean up for Bug #33296504
 DROP TABLE t1, t2, t3;
+SET optimizer_switch = 'hypergraph_optimizer=on';
 # Bug #33296504 done
 #
 # WL#14673: Enable the hypergraph optimizer for DELETE

mysql-test/suite/binlog_gtid/t/binlog_gtid_myisam.test

@@ -1,6 +1,7 @@
 --source include/force_myisam_default.inc
 --source include/have_myisam.inc
 --source include/have_log_bin.inc
+--source include/hypergraph_is_active.inc
 
 #
 # Bug#27716     multi-update did partially and has not binlogged
@@ -22,7 +23,7 @@ CREATE TABLE `t2` (
 insert into t1 values (1,1),(2,2);
 insert into t2 values (1,1),(4,4);
 reset binary logs and gtids;
-if ($HYPERGRAPH_TEST) {
+if ($hypergraph_is_active) {
   # Hypergraph uses hash join and updates the rows in a different order.
   --replace_result "'4'" "'3'"
 }

mysql-test/suite/binlog_nogtid/t/binlog_myisam.test

@@ -2,6 +2,7 @@
 --source include/have_myisam.inc
 --source include/have_log_bin.inc
 --source common/binlog/innodb.inc
+--source include/hypergraph_is_active.inc
 #
 # Bug#27716     multi-update did partially and has not binlogged
 #
@@ -22,7 +23,7 @@ CREATE TABLE `t2` (
 insert into t1 values (1,1),(2,2);
 insert into t2 values (1,1),(4,4);
 reset binary logs and gtids;
-if ($HYPERGRAPH_TEST) {
+if ($hypergraph_is_active) {
   # Hypergraph uses hash join and updates the rows in a different order.
   --replace_result "'4'" "'3'"
 }