[#2030] Replaced indexes for mysql reclamation queries

configure.ac
    Added mysql/upgrade_x_00010_to_00011.sh.in

src/bin/admin/tests/mysql_tests.sh.in
    mysql_upgrade_test()  - added test of upgrade from 10 to 11.

src/lib/mysql/mysql_constants.h
    Updated schema version

src/share/database/scripts/mysql/Makefile.am
    Added upgrade_x_00010_to_00011.sh

src/share/database/scripts/mysql/dhcpdb_create.mysql
    Added index replacements

src/share/database/scripts/mysql/upgrade_x_00010_to_00011.sh.in
    New file, upgrades from 10 to 11.
    Naming scheme changed to keep file order sane.

configure.ac

@@ -1794,6 +1794,8 @@ AC_CONFIG_FILES([src/share/database/scripts/mysql/upgrade_9.5_to_9.6.sh],
                 [chmod +x src/share/database/scripts/mysql/upgrade_9.5_to_9.6.sh])
 AC_CONFIG_FILES([src/share/database/scripts/mysql/upgrade_9.6_to_10.0.sh],
                 [chmod +x src/share/database/scripts/mysql/upgrade_9.6_to_10.0.sh])
+AC_CONFIG_FILES([src/share/database/scripts/mysql/upgrade_x_00010_to_00011.sh],
+                [chmod +x src/share/database/scripts/mysql/upgrade_x_00010_to_00011.sh])
 AC_CONFIG_FILES([src/share/database/scripts/mysql/wipe_data.sh],
                 [chmod +x src/share/database/scripts/mysql/wipe_data.sh])
 AC_CONFIG_FILES([src/share/database/scripts/pgsql/Makefile])

src/bin/admin/tests/mysql_tests.sh.in

@@ -261,7 +261,7 @@ mysql_upgrade_test() {
     version=$("${kea_admin}" db-version mysql -u "${db_user}" -p "${db_password}" -n "${db_name}" -d "${db_scripts_dir}")
     assert_str_eq "1.0" "${version}" "Expected kea-admin to return %s, returned value was %s"
 
-    # Ok, we have a 1.0 database. Let's upgrade it to 10.0
+    # Ok, we have a 1.0 database. Let's upgrade it to 11.0.
     run_command \
         "${kea_admin}" db-upgrade mysql -u "${db_user}" -p "${db_password}" -n "${db_name}" -d "${db_scripts_dir}"
     assert_eq 0 "${EXIT_CODE}" "kea-admin db-upgrade mysql failed, expected %d, returned non-zero status code %d\n"
@@ -832,9 +832,24 @@ insert into hosts(dhcp_identifier, dhcp_identifier_type, dhcp4_subnet_id, ipv4_a
         mysql_execute "${qry}"
     assert_eq 0 "${EXIT_CODE}" "${qry} failed: expected status code %d, returned %d"
 
-    # Verify upgraded schema reports version 10.0
+    # Check upgrade from 10.0 to 11.0.
+    qry="show indexes from lease4 where key_name = 'lease4_by_expire_state'";
+    run_command \
+        mysql_execute "${qry}"
+    assert_eq 0 "${EXIT_CODE}" "show indexes from lease4 failed. (expected status code %d, returned %d)"
+    count=$(echo "${OUTPUT}" | grep -Fci lease4_by_expire_state)
+    assert_eq 2 "${count}" "lease4_by_expire_state wrong or missing. (expected count %d, actual %d)"
+
+    qry="show indexes from lease6 where key_name = 'lease6_by_expire_state'";
+    run_command \
+        mysql_execute "${qry}"
+    assert_eq 0 "${EXIT_CODE}" "show indexes from lease6 failed. (expected status code %d, returned %d)"
+    count=$(echo "${OUTPUT}" | grep -Fci lease6_by_expire_state)
+    assert_eq 2 "${count}" "lease6_by_expire_state wrong or missing. (expected count %d, actual %d)"
+
+    # Verify upgraded schema reports version 11.0
     version=$("${kea_admin}" db-version mysql -u "${db_user}" -p "${db_password}" -n "${db_name}" -d "${db_scripts_dir}")
-    assert_str_eq "10.0" "${version}" "Expected kea-admin to return %s, returned value was %s"
+    assert_str_eq "11.0" "${version}" "Expected kea-admin to return %s, returned value was %s"
 
     # Let's wipe the whole database
     mysql_wipe

src/lib/mysql/mysql_constants.h

@@ -52,7 +52,7 @@ const int MLM_MYSQL_FETCH_FAILURE = 0;
 
 /// @name Current database schema version values.
 //@{
-const uint32_t MYSQL_SCHEMA_VERSION_MAJOR = 10;
+const uint32_t MYSQL_SCHEMA_VERSION_MAJOR = 11;
 const uint32_t MYSQL_SCHEMA_VERSION_MINOR = 0;
 
 //@}

src/share/database/scripts/mysql/Makefile.am

@@ -29,6 +29,7 @@ mysql_SCRIPTS += upgrade_9.3_to_9.4.sh
 mysql_SCRIPTS += upgrade_9.4_to_9.5.sh
 mysql_SCRIPTS += upgrade_9.5_to_9.6.sh
 mysql_SCRIPTS += upgrade_9.6_to_10.0.sh
+mysql_SCRIPTS += upgrade_x_00010_to_00011.sh
 mysql_SCRIPTS += wipe_data.sh
 
 DISTCLEANFILES = ${mysql_SCRIPTS}

src/share/database/scripts/mysql/dhcpdb_create.mysql

@@ -4014,6 +4014,28 @@ ALTER TABLE dhcp6_option_def
 UPDATE schema_version
     SET version = '10', minor = '0';
 
+# Reverse index order to improve reclamation query performance
+# Add a constraint that any state value added to the lease4 must
+# map to a value in the lease_state table.  Note we have to drop
+# the foreign keys first, then add them back.
+ALTER TABLE lease4 DROP CONSTRAINT fk_lease4_state;
+DROP INDEX lease4_by_state_expire ON lease4;
+CREATE INDEX lease4_by_expire_state ON lease4 (expire ASC, state ASC);
+ALTER TABLE lease4
+    ADD CONSTRAINT fk_lease4_state FOREIGN KEY (state)
+    REFERENCES lease_state (state);
+
+ALTER TABLE lease6 DROP CONSTRAINT fk_lease6_state;
+CREATE INDEX lease6_by_expire_state ON lease6 (expire ASC, state ASC);
+DROP INDEX lease6_by_state_expire ON lease6;
+ALTER TABLE lease6
+    ADD CONSTRAINT fk_lease6_state FOREIGN KEY (state)
+    REFERENCES lease_state (state);
+
+# Update the schema version number
+UPDATE schema_version
+    SET version = '11', minor = '0';
+
 # This line concludes database upgrade to version 10.
 
 # Notes:

src/share/database/scripts/mysql/upgrade_x_00010_to_00011.sh.in

@@ -0,0 +1,79 @@
+#!/bin/sh
+
+# Copyright (C) 2021 Internet Systems Consortium, Inc. ("ISC")
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# shellcheck disable=SC1091
+# SC1091: Not following: ... was not specified as input (see shellcheck -x).
+
+# Exit with error if commands exit with non-zero and if undefined variables are
+# used.
+set -eu
+
+# shellcheck disable=SC2034
+# SC2034: ... appears unused. Verify use (or export if used externally).
+prefix="@prefix@"
+
+# Include utilities. Use installed version if available and
+# use build version if it isn't.
+if [ -e @datarootdir@/@PACKAGE_NAME@/scripts/admin-utils.sh ]; then
+    . "@datarootdir@/@PACKAGE_NAME@/scripts/admin-utils.sh"
+else
+    . "@abs_top_builddir@/src/bin/admin/admin-utils.sh"
+fi
+
+# Check version.
+version=$(mysql_version "${@}")
+if test "${version}" != "10.0"; then
+    printf 'This script upgrades 10.0 to 11.0. '
+    printf 'Reported version is %s. Skipping upgrade.\n' "${version}"
+    exit 0
+fi
+
+# Get the schema name from database argument. We need this to
+# query information_schema for the right database.
+for arg in "${@}"
+do
+    if ! printf '%s' "${arg}" | grep -Eq '^\-\-'
+    then
+        schema="$arg"
+        break
+    fi
+done
+
+# Make sure we have the schema.
+if [ -z "$schema" ]
+then
+    printf "Could not find database schema name in cmd line args: %s\n" "${*}"
+    exit 255
+fi
+
+mysql "$@" <<EOF
+
+-- Reverse index order to improve reclamation query performance
+-- Add a constraint that any state value added to the lease4 must
+-- map to a value in the lease_state table.  Note we have to drop
+-- the foreign keys first, then add them back.
+ALTER TABLE lease4 DROP CONSTRAINT fk_lease4_state;
+DROP INDEX lease4_by_state_expire ON lease4;
+CREATE INDEX lease4_by_expire_state ON lease4 (expire ASC, state ASC);
+ALTER TABLE lease4
+    ADD CONSTRAINT fk_lease4_state FOREIGN KEY (state)
+    REFERENCES lease_state (state);
+
+ALTER TABLE lease6 DROP CONSTRAINT fk_lease6_state;
+CREATE INDEX lease6_by_expire_state ON lease6 (expire ASC, state ASC);
+DROP INDEX lease6_by_state_expire ON lease6;
+ALTER TABLE lease6
+    ADD CONSTRAINT fk_lease6_state FOREIGN KEY (state)
+    REFERENCES lease_state (state);
+
+-- Update the schema version number
+UPDATE schema_version
+    SET version = '11', minor = '0';
+
+-- This line concludes database upgrade to version 11.0
+EOF