*: Upgrade fmtlib and print enum value explicitly (#8332)

close #8331

contrib/fmtlib-cmake/CMakeLists.txt

@@ -9,11 +9,11 @@ set (SRCS
     ../fmtlib/include/fmt/core.h
     ../fmtlib/include/fmt/format.h
     ../fmtlib/include/fmt/format-inl.h
-    ../fmtlib/include/fmt/locale.h
     ../fmtlib/include/fmt/os.h
     ../fmtlib/include/fmt/ostream.h
     ../fmtlib/include/fmt/printf.h
     ../fmtlib/include/fmt/ranges.h
+    ../fmtlib/include/fmt/std.h
     ../fmtlib/include/fmt/xchar.h
 )
 

dbms/src/DataStreams/RuntimeFilter.cpp

@@ -75,7 +75,7 @@ void RuntimeFilter::build()
         throw TiFlashException(
             Errors::Coprocessor::BadRequest,
             "The source expr {} of rf {} should be column ref",
-            source_expr.tp(),
+            tipb::ExprType_Name(source_expr.tp()),
             id);
     }
 }

dbms/src/Encryption/RateLimiter.h

@@ -18,6 +18,7 @@
 #include <Common/nocopyable.h>
 #include <Server/StorageConfigParser.h>
 #include <fmt/core.h>
+#include <fmt/std.h>
 
 #include <atomic>
 #include <chrono>

dbms/src/Flash/Coprocessor/DAGUtils.cpp

@@ -753,11 +753,11 @@ const String & getAggFunctionName(const tipb::Expr & expr)
             return it->second;
     }
 
-    const auto errmsg = fmt::format(
+    throw TiFlashException(
+        Errors::Coprocessor::Unimplemented,
         "{}(distinct={}) is not supported.",
         tipb::ExprType_Name(expr.tp()),
-        expr.has_distinct() ? "true" : "false");
-    throw TiFlashException(errmsg, Errors::Coprocessor::Unimplemented);
+        expr.has_distinct());
 }
 
 const String & getWindowFunctionName(const tipb::Expr & expr)
@@ -766,8 +766,7 @@ const String & getWindowFunctionName(const tipb::Expr & expr)
     if (it != window_func_map.end())
         return it->second;
 
-    const auto errmsg = fmt::format("{} is not supported.", tipb::ExprType_Name(expr.tp()));
-    throw TiFlashException(errmsg, Errors::Coprocessor::Unimplemented);
+    throw TiFlashException(Errors::Coprocessor::Unimplemented, "{} is not supported.", tipb::ExprType_Name(expr.tp()));
 }
 
 
@@ -786,8 +785,9 @@ const String & getFunctionName(const tipb::Expr & expr)
         auto it = scalar_func_map.find(expr.sig());
         if (it == scalar_func_map.end())
             throw TiFlashException(
-                tipb::ScalarFuncSig_Name(expr.sig()) + " is not supported.",
-                Errors::Coprocessor::Unimplemented);
+                Errors::Coprocessor::Unimplemented,
+                "{} is not supported.",
+                tipb::ScalarFuncSig_Name(expr.sig()));
         return it->second;
     }
 }
@@ -803,7 +803,7 @@ String getExchangeTypeName(const tipb::ExchangeType & tp)
     case tipb::ExchangeType::Hash:
         return "Hash";
     default:
-        throw TiFlashException(fmt::format("Not supported Exchange type: {}", tp), Errors::Coprocessor::Internal);
+        throw TiFlashException(Errors::Coprocessor::Internal, "Not supported Exchange type: {}", fmt::underlying(tp));
     }
 }
 
@@ -826,7 +826,7 @@ String getJoinTypeName(const tipb::JoinType & tp)
     case tipb::JoinType::TypeSemiJoin:
         return "SemiJoin";
     default:
-        throw TiFlashException(fmt::format("Not supported Join type: {}", tp), Errors::Coprocessor::Internal);
+        throw TiFlashException(Errors::Coprocessor::Internal, "Not supported Join type: {}", fmt::underlying(tp));
     }
 }
 
@@ -838,8 +838,9 @@ String getJoinExecTypeName(const tipb::JoinExecType & tp)
         return "HashJoin";
     default:
         throw TiFlashException(
-            fmt::format("Not supported Join exectution type: {}", tp),
-            Errors::Coprocessor::Internal);
+            Errors::Coprocessor::Internal,
+            "Not supported Join exectution type: {}",
+            fmt::underlying(tp));
     }
 }
 
@@ -882,7 +883,7 @@ String getFieldTypeName(Int32 tp)
     case TiDB::TypeString:
         return "String";
     default:
-        throw TiFlashException(fmt::format("Not supported field type: {}", tp), Errors::Coprocessor::Internal);
+        throw TiFlashException(Errors::Coprocessor::Internal, "Not supported field type: {}", tp);
     }
 }
 

dbms/src/Flash/Coprocessor/JoinInterpreterHelper.cpp

@@ -119,8 +119,10 @@ std::pair<ASTTableJoin::Kind, size_t> getJoinKindAndBuildSideIndex(
     auto join_type_it = join_type_map.find(std::make_pair(tipb_join_type, inner_index));
     if (unlikely(join_type_it == join_type_map.end()))
         throw TiFlashException(
-            fmt::format("Unknown join type in dag request {} {}", tipb_join_type, inner_index),
-            Errors::Coprocessor::BadRequest);
+            Errors::Coprocessor::BadRequest,
+            "Unknown join type in dag request {} {}",
+            fmt::underlying(tipb_join_type),
+            inner_index);
     return join_type_it->second;
 }
 

dbms/src/Flash/Disaggregated/S3LockClient.cpp

@@ -118,7 +118,11 @@ std::pair<bool, String> S3LockClient::makeCall(
                 throw Exception(ErrorCodes::TIMEOUT_EXCEEDED, "deadline exceed, " + tracing_log->identifier());
             }
             // retry
-            LOG_ERROR(tracing_log, "meets error, code={} msg={}", status.error_code(), status.error_message());
+            LOG_ERROR(
+                tracing_log,
+                "meets error, code={} msg={}",
+                magic_enum::enum_name(status.error_code()),
+                status.error_message());
             address = updateOwnerAddr(deadline, tracing_log);
         }
 

dbms/src/Flash/FlashService.cpp

@@ -300,7 +300,12 @@ grpc::Status FlashService::Coprocessor(
     };
     grpc::Status ret = cop_limiter->executeFor(std::move(exec_func), max_queued_duration_ms, std::move(timeout_func));
 
-    LOG_IMPL(log, log_level, "Handle coprocessor request done: {}, {}", ret.error_code(), ret.error_message());
+    LOG_IMPL(
+        log,
+        log_level,
+        "Handle coprocessor request done: {}, {}",
+        magic_enum::enum_name(ret.error_code()),
+        ret.error_message());
     return ret;
 }
 
@@ -342,7 +347,11 @@ grpc::Status FlashService::BatchCoprocessor(
         return cop_handler.execute();
     });
 
-    LOG_INFO(log, "Handle batch coprocessor request done: {}, {}", ret.error_code(), ret.error_message());
+    LOG_INFO(
+        log,
+        "Handle batch coprocessor request done: {}, {}",
+        magic_enum::enum_name(ret.error_code()),
+        ret.error_message());
     return ret;
 }
 
@@ -459,7 +468,12 @@ grpc::Status FlashService::CoprocessorStream(
     grpc::Status ret
         = cop_stream_limiter->executeFor(std::move(exec_func), max_queued_duration_ms, std::move(timeout_func));
 
-    LOG_IMPL(log, log_level, "Handle coprocessor stream request done: {}, {}", ret.error_code(), ret.error_message());
+    LOG_IMPL(
+        log,
+        log_level,
+        "Handle coprocessor stream request done: {}, {}",
+        magic_enum::enum_name(ret.error_code()),
+        ret.error_message());
     return ret;
 }
 

dbms/src/Flash/LogSearch.cpp

@@ -18,6 +18,7 @@
 #include <boost_wrapper/string.h>
 
 #include <boost/algorithm/string/predicate.hpp>
+#include <magic_enum.hpp>
 
 namespace DB
 {
@@ -365,7 +366,11 @@ LogIterator::~LogIterator()
 {
     if (err_info.has_value())
     {
-        LOG_DEBUG(log, "LogIterator search end with error {} at line {}.", err_info->second, err_info->first);
+        LOG_DEBUG(
+            log,
+            "LogIterator search end with error {} at line {}.",
+            magic_enum::enum_name(err_info->second),
+            err_info->first);
     }
 }
 

dbms/src/Flash/Mpp/AsyncRequestHandler.h

@@ -197,7 +197,7 @@ class AsyncRequestHandler final : public GRPCKickTag
             String done_msg = fmt::format("Exchange receiver meet error : {}", finish_status.error_message());
             String log_msg = fmt::format(
                 "Finish fail. err code: {}, err msg: {}, retry time {}",
-                finish_status.error_code(),
+                magic_enum::enum_name(finish_status.error_code()),
                 finish_status.error_message(),
                 retry_times);
             retryOrDone(std::move(done_msg), log_msg);

dbms/src/Flash/Mpp/ExchangeReceiver.cpp

@@ -173,7 +173,7 @@ class AsyncRequestHandlerv1 : public GRPCKickTag
                 LOG_WARNING(
                     log,
                     "Finish fail. err code: {}, err msg: {}, retry time {}",
-                    finish_status.error_code(),
+                    magic_enum::enum_name(finish_status.error_code()),
                     finish_status.error_message(),
                     retry_times);
                 retryOrDone(fmt::format("Exchange receiver meet error : {}", finish_status.error_message()));
@@ -681,7 +681,7 @@ void ExchangeReceiverBase<RPCContext>::readLoop(const Request & req)
                 LOG_WARNING(
                     log,
                     "EstablishMPPConnectionRequest meets rpc fail. Err code = {}, err msg = {}, retriable = {}",
-                    status.error_code(),
+                    magic_enum::enum_name(status.error_code()),
                     status.error_message(),
                     retriable);
                 // if we have received some data, we should not retry.

dbms/src/Flash/Mpp/MppVersion.h

@@ -14,6 +14,9 @@
 
 #pragma once
 
+#include <common/defines.h>
+#include <fmt/format.h>
+
 #include <string>
 
 namespace DB
@@ -26,6 +29,11 @@ enum MppVersion : int64_t
     //
     MppVersionMAX,
 };
+// Make MppVersion formatable by fmtlib
+ALWAYS_INLINE inline auto format_as(MppVersion v)
+{
+    return fmt::underlying(v);
+}
 
 enum MPPDataPacketVersion : int64_t
 {
@@ -34,11 +42,16 @@ enum MPPDataPacketVersion : int64_t
     //
     MPPDataPacketMAX,
 };
+// Make MPPDataPacketVersion formatable by fmtlib
+ALWAYS_INLINE inline auto format_as(MPPDataPacketVersion v)
+{
+    return fmt::underlying(v);
+}
 
 bool ReportStatusToCoordinator(int64_t mpp_version, const std::string & coordinator_address);
 bool ReportExecutionSummaryToCoordinator(int64_t mpp_version, bool report_execution_summary);
 bool CheckMppVersion(int64_t mpp_version);
 std::string GenMppVersionErrorMessage(int64_t mpp_version);
 int64_t GetMppVersion();
 
-} // namespace DB
+} // namespace DB

dbms/src/Flash/Planner/PhysicalPlan.cpp

@@ -232,7 +232,7 @@ void PhysicalPlan::build(const tipb::Executor * executor)
     }
     default:
         throw TiFlashException(
-            fmt::format("{} executor is not supported", executor->tp()),
+            fmt::format("{} executor is not supported", fmt::underlying(executor->tp())),
             Errors::Planner::Unimplemented);
     }
 }

dbms/src/Flash/tests/gtest_collation.cpp

@@ -233,7 +233,7 @@ std::queue<tipb::ExecType> ExecutorCollation::checkExecutorCollation(
             break; /// Do nothing
         default:
         {
-            auto exception_str = fmt::format("Unhandled executor {}", type);
+            auto exception_str = fmt::format("Unhandled executor {}", fmt::underlying(type));
             throw Exception(exception_str);
         }
         }
@@ -313,7 +313,7 @@ void ExecutorCollation::checkScalarFunctionCollation(std::shared_ptr<tipb::DAGRe
             break; /// Do nothing
         default:
         {
-            auto exception_str = fmt::format("Unhandled executor {}", type);
+            auto exception_str = fmt::format("Unhandled executor {}", fmt::underlying(type));
             throw Exception(exception_str);
         }
         }

dbms/src/Flash/tests/gtest_join_executor.cpp

@@ -2291,7 +2291,7 @@ ColumnsWithTypeAndName genSemiJoinResult(
             r.column = r.column->filter(filter, -1);
     }
     else
-        throw Exception(ErrorCodes::LOGICAL_ERROR, "Semi join Type {} is not supported", type);
+        throw Exception(ErrorCodes::LOGICAL_ERROR, "Semi join Type {} is not supported", magic_enum::enum_name(type));
     return res;
 }
 } // namespace
@@ -3133,4 +3133,4 @@ CATCH
 #undef WRAP_FOR_JOIN_TEST_END
 
 } // namespace tests
-} // namespace DB
+} // namespace DB

dbms/src/Interpreters/SettingsCommon.h

@@ -91,6 +91,12 @@ struct SettingInt
     std::atomic<IntType> value;
 };
 
+// Make SettingInt formatable by fmtlib
+template <typename IntType>
+ALWAYS_INLINE inline auto format_as(SettingInt<IntType> s)
+{
+    return s.get();
+}
 
 using SettingUInt64 = SettingInt<UInt64>;
 using SettingInt64 = SettingInt<Int64>;
@@ -338,6 +344,12 @@ struct SettingFloat
     std::atomic<float> value;
 };
 
+// Make SettingFloat formatable by fmtlib
+ALWAYS_INLINE inline auto format_as(SettingFloat s)
+{
+    return s.get();
+}
+
 /// MemoryLimit can either be an UInt64 (means memory limit in bytes),
 /// or be a float-point number (means memory limit ratio of total RAM, from 0.0 to 1.0).
 /// 0 or 0.0 means unlimited.
@@ -439,6 +451,12 @@ struct SettingDouble
     std::atomic<double> value;
 };
 
+// Make SettingDouble formatable by fmtlib
+ALWAYS_INLINE inline auto format_as(SettingDouble s)
+{
+    return s.get();
+}
+
 enum class LoadBalancing
 {
     /// among replicas with a minimum number of errors selected randomly

dbms/src/Interpreters/WindowDescription.cpp

@@ -48,7 +48,7 @@ WindowFrame::FrameType getFrameTypeFromTipb(const tipb::WindowFrameType & type)
     case tipb::WindowFrameType::Groups:
         return WindowFrame::FrameType::Groups;
     default:
-        throw Exception(ErrorCodes::BAD_ARGUMENTS, "Unknown frame type {}", type);
+        throw Exception(ErrorCodes::BAD_ARGUMENTS, "Unknown frame type {}", fmt::underlying(type));
     }
 }
 

dbms/src/Server/MockComputeClient.h

@@ -42,7 +42,7 @@ class MockComputeClient
         {
             throw Exception(fmt::format(
                 "Meet error while dispatch mpp task, error code = {}, message = {}",
-                status.error_code(),
+                magic_enum::enum_name(status.error_code()),
                 status.error_message()));
         }
         if (response.has_error())
@@ -63,7 +63,7 @@ class MockComputeClient
         {
             throw Exception(fmt::format(
                 "Meet error while run coprocessor task, error code = {}, message = {}",
-                status.error_code(),
+                magic_enum::enum_name(status.error_code()),
                 status.error_message()));
         }
 
@@ -73,4 +73,4 @@ class MockComputeClient
 private:
     std::unique_ptr<tikvpb::Tikv::Stub> stub{};
 };
-} // namespace DB
+} // namespace DB

dbms/src/Server/Server.cpp

@@ -367,7 +367,7 @@ pingcap::ClusterConfig getClusterConfig(
         ca_path,
         cert_path,
         key_path,
-        config.api_version);
+        fmt::underlying(config.api_version));
     return config;
 }
 

dbms/src/Storages/DeltaMerge/DeltaMergeStore.cpp

@@ -1589,7 +1589,7 @@ bool DeltaMergeStore::checkSegmentUpdate(
             LOG_DEBUG(
                 log,
                 "Foreground flush cache in checkSegmentUpdate, thread={} segment={} input_type={}",
-                thread_type,
+                magic_enum::enum_name(thread_type),
                 segment->info(),
                 magic_enum::enum_name(input_type));
             segment->flushCache(*dm_context);