BUG#31795721: ENUMERATION VALUE ENUM_SESSION_TRACK_GTIDS::OFF DEFINED AS A GLOBAL SYMBOL

Background:

The C++ enum type enum_session_track_gtids was defined in global scope
and had a member named 'OFF'.  This resulted in OFF being a global
symbol.

Problem:

The name is too broad and the use case too narrow for it to live in
global scope.  (In fact, it was used by mistake in one place where
another type was expected.)

Fix:
Prefix the members of this enum type with SESSION_TRACK_GTIDS .

RB:25022

Author: Sven Sandberg

sql/rpl_context.cc

@@ -38,7 +38,7 @@ Session_consistency_gtids_ctx::Session_consistency_gtids_ctx()
     : m_sid_map(nullptr),
       m_gtid_set(nullptr),
       m_listener(nullptr),
-      m_curr_session_track_gtids(OFF) {}
+      m_curr_session_track_gtids(SESSION_TRACK_GTIDS_OFF) {}
 
 Session_consistency_gtids_ctx::~Session_consistency_gtids_ctx() {
   if (m_gtid_set) {
@@ -55,7 +55,8 @@ Session_consistency_gtids_ctx::~Session_consistency_gtids_ctx() {
 inline bool Session_consistency_gtids_ctx::shall_collect(const THD *thd) {
   return /* Do not track OWN_GTID if session does not own a
             (non-anonymous) GTID. */
-      (thd->owned_gtid.sidno > 0 || m_curr_session_track_gtids == ALL_GTIDS) &&
+      (thd->owned_gtid.sidno > 0 ||
+       m_curr_session_track_gtids == SESSION_TRACK_GTIDS_ALL_GTIDS) &&
       /* if there is no listener/tracker, then there is no reason to collect */
       m_listener != nullptr &&
       /* ROLLBACK statements may end up calling trans_commit_stmt */
@@ -71,7 +72,7 @@ bool Session_consistency_gtids_ctx::notify_after_transaction_commit(
 
   if (!shall_collect(thd)) return res;
 
-  if (m_curr_session_track_gtids == ALL_GTIDS) {
+  if (m_curr_session_track_gtids == SESSION_TRACK_GTIDS_ALL_GTIDS) {
     /*
      If one is configured to read all writes, we always collect
      the GTID_EXECUTED.
@@ -97,7 +98,7 @@ bool Session_consistency_gtids_ctx::notify_after_gtid_executed_update(
 
   if (!shall_collect(thd)) return res;
 
-  if (m_curr_session_track_gtids == OWN_GTID) {
+  if (m_curr_session_track_gtids == SESSION_TRACK_GTIDS_OWN_GTID) {
     DBUG_ASSERT(global_gtid_mode.get() != Gtid_mode::OFF);
     DBUG_ASSERT(thd->owned_gtid.sidno > 0);
     const Gtid &gtid = thd->owned_gtid;

sql/session_tracker.cc

@@ -1577,9 +1577,11 @@ bool Session_gtids_tracker::update(THD *thd) {
     We are updating this using the previous value. No change needed.
     Bailing out.
   */
-  if (m_enabled == (thd->variables.session_track_gtids != OFF)) return false;
+  if (m_enabled ==
+      (thd->variables.session_track_gtids != SESSION_TRACK_GTIDS_OFF))
+    return false;
 
-  m_enabled = thd->variables.session_track_gtids != OFF &&
+  m_enabled = thd->variables.session_track_gtids != SESSION_TRACK_GTIDS_OFF &&
               /* No need to track GTIDs for system threads. */
               thd->system_thread == NON_SYSTEM_THREAD;
   if (m_enabled) {

sql/sys_vars.cc

@@ -1405,8 +1405,9 @@ static Sys_var_enum Sys_session_track_gtids(
     "included in the response packet sent by the server."
     "(Default: OFF).",
     SESSION_VAR(session_track_gtids), CMD_LINE(REQUIRED_ARG),
-    session_track_gtids_names, DEFAULT(OFF), NO_MUTEX_GUARD, NOT_IN_BINLOG,
-    ON_CHECK(check_outside_trx), ON_UPDATE(on_session_track_gtids_update));
+    session_track_gtids_names, DEFAULT(SESSION_TRACK_GTIDS_OFF), NO_MUTEX_GUARD,
+    NOT_IN_BINLOG, ON_CHECK(check_outside_trx),
+    ON_UPDATE(on_session_track_gtids_update));
 
 static bool binlog_direct_check(sys_var *self, THD *thd, set_var *var) {
   if (check_session_admin(self, thd, var)) return true;
@@ -6348,8 +6349,9 @@ static Sys_var_enum Sys_session_track_transaction_info(
     "characteristics (isolation level, read only/read write, snapshot - "
     "but not any work done / data modified within the transaction).",
     SESSION_VAR(session_track_transaction_info), CMD_LINE(REQUIRED_ARG),
-    session_track_transaction_info_names, DEFAULT(OFF), NO_MUTEX_GUARD,
-    NOT_IN_BINLOG, ON_CHECK(nullptr), ON_UPDATE(update_session_track_tx_info));
+    session_track_transaction_info_names, DEFAULT(TX_TRACK_NONE),
+    NO_MUTEX_GUARD, NOT_IN_BINLOG, ON_CHECK(nullptr),
+    ON_UPDATE(update_session_track_tx_info));
 
 static bool update_session_track_state_change(sys_var *, THD *thd,
                                               enum_var_type) {

sql/system_variables.h

@@ -87,7 +87,11 @@ enum enum_transaction_write_set_hashing_algorithm {
 };
 
 // Values for session_track_gtids sysvar
-enum enum_session_track_gtids { OFF = 0, OWN_GTID = 1, ALL_GTIDS = 2 };
+enum enum_session_track_gtids {
+  SESSION_TRACK_GTIDS_OFF = 0,
+  SESSION_TRACK_GTIDS_OWN_GTID = 1,
+  SESSION_TRACK_GTIDS_ALL_GTIDS = 2
+};
 
 /** Values for use_secondary_engine sysvar. */
 enum use_secondary_engine {