diff --git a/CMakeLists.txt b/CMakeLists.txt index cb0b2ae2b..0e0b1ea04 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -55,6 +55,7 @@ option(ICEBERG_SQL_MYSQL "Build the MySQL connector for the SQL catalog" OFF) option(ICEBERG_S3 "Build with S3 support" OFF) option(ICEBERG_SIGV4 "Build with SigV4 support" OFF) option(ICEBERG_BUNDLE_AWSSDK "Bundle AWS SDK for S3/SigV4 support" ON) +option(ICEBERG_SPDLOG "Use spdlog as the default logging backend" ON) option(ICEBERG_ENABLE_ASAN "Enable Address Sanitizer" OFF) option(ICEBERG_ENABLE_UBSAN "Enable Undefined Behavior Sanitizer" OFF) diff --git a/cmake_modules/IcebergThirdpartyToolchain.cmake b/cmake_modules/IcebergThirdpartyToolchain.cmake index 8e10fd8ec..fa99db664 100644 --- a/cmake_modules/IcebergThirdpartyToolchain.cmake +++ b/cmake_modules/IcebergThirdpartyToolchain.cmake @@ -720,7 +720,9 @@ resolve_zlib_dependency() resolve_nanoarrow_dependency() resolve_croaring_dependency() resolve_nlohmann_json_dependency() -resolve_spdlog_dependency() +if(ICEBERG_SPDLOG) + resolve_spdlog_dependency() +endif() if(ICEBERG_S3 OR ICEBERG_SIGV4) if(ICEBERG_SIGV4 AND NOT ICEBERG_BUILD_REST) diff --git a/meson.build b/meson.build index 46446cd8d..46d7ab6ae 100644 --- a/meson.build +++ b/meson.build @@ -31,7 +31,9 @@ project( ) cpp = meson.get_compiler('cpp') -args = cpp.get_supported_arguments(['/bigobj']) +# /Zc:preprocessor: MSVC's conforming preprocessor, required for the __VA_OPT__ +# used by the logging macros. get_supported_arguments drops it on non-MSVC. +args = cpp.get_supported_arguments(['/bigobj', '/Zc:preprocessor']) add_project_arguments(args, language: 'cpp') subdir('src') diff --git a/src/iceberg/CMakeLists.txt b/src/iceberg/CMakeLists.txt index 18615c202..a4f8ccb26 100644 --- a/src/iceberg/CMakeLists.txt +++ b/src/iceberg/CMakeLists.txt @@ -17,6 +17,18 @@ set(ICEBERG_INCLUDES "$" "$") + +# Generate the logging backend config header. ALWAYS generated (not gated by +# ICEBERG_SPDLOG) so logging/logger.cc can include it in both ON and OFF builds; +# only the definedness of ICEBERG_HAS_SPDLOG varies. Generated into the build +# tree (already on ICEBERG_INCLUDES), included as "iceberg/logging/config.h", and +# NOT installed (it must never appear in a public/installed header). +if(ICEBERG_SPDLOG) + set(ICEBERG_HAS_SPDLOG ON) +endif() +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/logging/config.h.in" + "${CMAKE_CURRENT_BINARY_DIR}/logging/config.h") + set(ICEBERG_SOURCES arrow_c_data_util.cc arrow_c_data_guard_internal.cc @@ -47,6 +59,9 @@ set(ICEBERG_SOURCES inheritable_metadata.cc json_serde.cc location_provider.cc + logging/cerr_logger.cc + logging/logger.cc + logging/loggers.cc manifest/manifest_adapter.cc manifest/manifest_entry.cc manifest/manifest_filter_manager.cc @@ -142,24 +157,34 @@ list(APPEND ICEBERG_STATIC_BUILD_INTERFACE_LIBS "$,nanoarrow::nanoarrow_static,$,nanoarrow::nanoarrow_static,nanoarrow::nanoarrow_shared>>" nlohmann_json::nlohmann_json - spdlog::spdlog ZLIB::ZLIB) list(APPEND ICEBERG_SHARED_BUILD_INTERFACE_LIBS "$,nanoarrow::nanoarrow_static,$,nanoarrow::nanoarrow_shared,nanoarrow::nanoarrow_static>>" nlohmann_json::nlohmann_json - spdlog::spdlog ZLIB::ZLIB) list(APPEND ICEBERG_STATIC_INSTALL_INTERFACE_LIBS "$,iceberg::nanoarrow_static,$,nanoarrow::nanoarrow_static,nanoarrow::nanoarrow_shared>>" "$,iceberg::nlohmann_json,$,nlohmann_json::nlohmann_json,nlohmann_json::nlohmann_json>>" - "$,iceberg::spdlog,spdlog::spdlog>") +) list(APPEND ICEBERG_SHARED_INSTALL_INTERFACE_LIBS "$,iceberg::nanoarrow_static,$,nanoarrow::nanoarrow_shared,nanoarrow::nanoarrow_static>>" "$,iceberg::nlohmann_json,$,nlohmann_json::nlohmann_json,nlohmann_json::nlohmann_json>>" - "$,iceberg::spdlog,spdlog::spdlog>") +) + +# spdlog backend: linked and compiled only when ICEBERG_SPDLOG is ON. When OFF, +# the core library has no spdlog dependency and CerrLogger is the default sink. +if(ICEBERG_SPDLOG) + list(APPEND ICEBERG_SOURCES logging/internal/spdlog_logger.cc) + list(APPEND ICEBERG_STATIC_BUILD_INTERFACE_LIBS spdlog::spdlog) + list(APPEND ICEBERG_SHARED_BUILD_INTERFACE_LIBS spdlog::spdlog) + list(APPEND ICEBERG_STATIC_INSTALL_INTERFACE_LIBS + "$,iceberg::spdlog,spdlog::spdlog>") + list(APPEND ICEBERG_SHARED_INSTALL_INTERFACE_LIBS + "$,iceberg::spdlog,spdlog::spdlog>") +endif() add_iceberg_lib(iceberg SOURCES diff --git a/src/iceberg/logging/cerr_logger.cc b/src/iceberg/logging/cerr_logger.cc new file mode 100644 index 000000000..a5fd64344 --- /dev/null +++ b/src/iceberg/logging/cerr_logger.cc @@ -0,0 +1,105 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/cerr_logger.h" + +#include +#include +#include +#include +#include +#include +#include + +#if defined(_WIN32) +# include +#elif defined(__APPLE__) +# include +#else +# include + +# include +#endif + +namespace iceberg { + +namespace { + +/// \brief OS-native thread id, cached per thread to avoid a syscall per log. +/// +/// Matches the cross-process-correlatable id used by spdlog/glog (not the opaque +/// std::thread::id), and avoids the std::formatter (P2693) +/// minimum-toolchain dependency. +uint64_t OsThreadId() noexcept { + static thread_local uint64_t tid = []() -> uint64_t { +#if defined(_WIN32) + return static_cast(::GetCurrentThreadId()); +#elif defined(__APPLE__) + uint64_t id = 0; + pthread_threadid_np(nullptr, &id); + return id; +#else + return static_cast(::syscall(SYS_gettid)); +#endif + }(); + return tid; +} + +/// \brief Trailing path component of a source file path. +std::string_view Basename(std::string_view path) noexcept { + auto pos = path.find_last_of("/\\"); + return pos == std::string_view::npos ? path : path.substr(pos + 1); +} + +/// \brief Format a record into a single newline-terminated line. +std::string FormatLine(const LogMessage& message) { + auto now = + std::chrono::floor(std::chrono::system_clock::now()); + return std::format("{:%Y-%m-%dT%H:%M:%S}Z {} [{}] {}:{}] {}\n", now, + ToString(message.level), OsThreadId(), + Basename(message.location.file_name()), message.location.line(), + message.message); +} + +} // namespace + +void CerrLogger::Log(LogMessage&& message) noexcept { + try { + std::string line = FormatLine(message); + std::lock_guard lock(mutex_); + std::cerr << line; + } catch (...) { + // Logging must never throw. Best-effort fallback, swallow any failure. + try { + std::lock_guard lock(mutex_); + std::cerr << "\n"; + } catch (...) { + } + } +} + +void CerrLogger::Flush() noexcept { + try { + std::lock_guard lock(mutex_); + std::cerr.flush(); + } catch (...) { + } +} + +} // namespace iceberg diff --git a/src/iceberg/logging/cerr_logger.h b/src/iceberg/logging/cerr_logger.h new file mode 100644 index 000000000..15af69625 --- /dev/null +++ b/src/iceberg/logging/cerr_logger.h @@ -0,0 +1,59 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#pragma once + +/// \file iceberg/logging/cerr_logger.h +/// \brief Always-available std::cerr logging backend. + +#include +#include + +#include "iceberg/iceberg_export.h" +#include "iceberg/logging/log_level.h" +#include "iceberg/logging/logger.h" + +namespace iceberg { + +/// \brief Logger that writes one line per record to std::cerr. +/// +/// Line layout: `YYYY-MM-DDThh:mm:ss.mmmZ LEVEL [tid] file:line] message`. +/// The minimum level is held in a lock-free atomic; a mutex serializes the +/// whole-line write so concurrent records never interleave. Pure standard +/// library -- always compiled, regardless of ICEBERG_SPDLOG. +class ICEBERG_EXPORT CerrLogger : public Logger { + public: + explicit CerrLogger(LogLevel level = LogLevel::kInfo) : level_(level) {} + + bool ShouldLog(LogLevel level) const override { + return level >= level_.load(std::memory_order_relaxed); + } + void Log(LogMessage&& message) noexcept override; + void SetLevel(LogLevel level) override { + level_.store(level, std::memory_order_relaxed); + } + LogLevel level() const override { return level_.load(std::memory_order_relaxed); } + void Flush() noexcept override; + + private: + std::atomic level_; + std::mutex mutex_; +}; + +} // namespace iceberg diff --git a/src/iceberg/logging/config.h.in b/src/iceberg/logging/config.h.in new file mode 100644 index 000000000..1b1e0d02c --- /dev/null +++ b/src/iceberg/logging/config.h.in @@ -0,0 +1,30 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#pragma once + +// Internal, build-generated configuration for the logging backend. +// This header is NOT installed and must only be included from .cc files +// (logger.cc, internal/spdlog_logger.cc) -- never from a public header. +// +// ICEBERG_HAS_SPDLOG is defined when the project is built with -DICEBERG_SPDLOG=ON +// and left undefined otherwise. Always test it with #ifdef / #ifndef, never #if +// (it carries no value). + +#cmakedefine ICEBERG_HAS_SPDLOG diff --git a/src/iceberg/logging/internal/spdlog_logger.cc b/src/iceberg/logging/internal/spdlog_logger.cc new file mode 100644 index 000000000..4ede3f402 --- /dev/null +++ b/src/iceberg/logging/internal/spdlog_logger.cc @@ -0,0 +1,103 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/internal/spdlog_logger.h" + +#ifdef ICEBERG_HAS_SPDLOG + +# include +# include +# include +# include + +# include +# include + +namespace iceberg::internal { + +namespace { + +spdlog::level::level_enum ToSpdLevel(LogLevel level) noexcept { + switch (level) { + case LogLevel::kTrace: + return spdlog::level::trace; + case LogLevel::kDebug: + return spdlog::level::debug; + case LogLevel::kInfo: + return spdlog::level::info; + case LogLevel::kWarn: + return spdlog::level::warn; + case LogLevel::kError: + return spdlog::level::err; + case LogLevel::kCritical: + case LogLevel::kFatal: + // spdlog has no "fatal"; the process abort is owned by the macro layer. + return spdlog::level::critical; + case LogLevel::kOff: + return spdlog::level::off; + } + return spdlog::level::off; +} + +} // namespace + +SpdLogger::SpdLogger(LogLevel level) + : SpdLogger(std::make_shared( + "iceberg", std::make_shared()), + level) {} + +Status SpdLogger::Initialize( + const std::unordered_map& properties) { + if (auto it = properties.find(std::string(kPatternProperty)); it != properties.end()) { + logger_->set_pattern(it->second); + } + // Apply "level" via the base implementation. + return Logger::Initialize(properties); +} + +SpdLogger::SpdLogger(std::shared_ptr logger, LogLevel level) + : logger_(std::move(logger)), level_(level) { + if (logger_) { + logger_->set_level(spdlog::level::trace); // filtering is done by ShouldLog + } +} + +void SpdLogger::Log(LogMessage&& message) noexcept { + try { + spdlog::source_loc loc{message.location.file_name(), + static_cast(message.location.line()), + message.location.function_name()}; + // Pass the pre-formatted text as an argument ("{}") so any braces in the + // message are not re-interpreted as a format string. + logger_->log(loc, ToSpdLevel(message.level), "{}", message.message); + } catch (...) { + // Logging must never throw. + } +} + +void SpdLogger::Flush() noexcept { + try { + logger_->flush(); + } catch (...) { + } +} + +} // namespace iceberg::internal + +#endif // ICEBERG_HAS_SPDLOG diff --git a/src/iceberg/logging/internal/spdlog_logger.h b/src/iceberg/logging/internal/spdlog_logger.h new file mode 100644 index 000000000..ee18e7049 --- /dev/null +++ b/src/iceberg/logging/internal/spdlog_logger.h @@ -0,0 +1,87 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#pragma once + +/// \file iceberg/logging/internal/spdlog_logger.h +/// \brief spdlog-backed logging sink. +/// +/// INTERNAL, NOT INSTALLED. It is only included from .cc files (logger.cc and +/// spdlog_logger.cc) after config.h, and only when the project is built with +/// ICEBERG_SPDLOG=ON. SpdLogger is not a consumer-constructible public type -- +/// applications obtain it via the default logger or the "logger-impl"="spdlog" +/// registry factory. + +#include "iceberg/logging/config.h" + +#ifdef ICEBERG_HAS_SPDLOG + +# include +# include + +# include + +# include "iceberg/logging/log_level.h" +# include "iceberg/logging/logger.h" + +namespace iceberg::internal { + +/// \brief Logger backed by spdlog (synchronous only in v1). +/// +/// Synchronous because spdlog::source_loc holds non-owning const char* that are +/// unsafe to forward into an async logger (spdlog #3227). +/// ICEBERG_EXPORT so the symbol is linkable from in-tree tests (and any +/// internal consumer) under -fvisibility=hidden / MSVC DLL builds. The header +/// is still not installed -- this is a binary-visibility detail, not public API. +class ICEBERG_EXPORT SpdLogger : public Logger { + public: + /// \brief Construct over a default stderr-backed spdlog logger. + explicit SpdLogger(LogLevel level = LogLevel::kInfo); + + /// \brief Construct over a caller-provided spdlog logger. + /// + /// The logger MUST be synchronous. Log() forwards spdlog::source_loc, which + /// borrows the std::source_location's const char* pointers; an async spdlog + /// logger would queue them past their lifetime (spdlog #3227 -> UB). This is a + /// caller contract -- spdlog exposes no reliable sync/async query to assert on. + explicit SpdLogger(std::shared_ptr logger, + LogLevel level = LogLevel::kInfo); + + /// \brief Apply the "pattern" property (spdlog set_pattern), then "level". + Status Initialize( + const std::unordered_map& properties) override; + + bool ShouldLog(LogLevel level) const override { + return level >= level_.load(std::memory_order_relaxed); + } + void Log(LogMessage&& message) noexcept override; + void SetLevel(LogLevel level) override { + level_.store(level, std::memory_order_relaxed); + } + LogLevel level() const override { return level_.load(std::memory_order_relaxed); } + void Flush() noexcept override; + + private: + std::shared_ptr logger_; + std::atomic level_; +}; + +} // namespace iceberg::internal + +#endif // ICEBERG_HAS_SPDLOG diff --git a/src/iceberg/logging/logger.cc b/src/iceberg/logging/logger.cc new file mode 100644 index 000000000..a4c4a246a --- /dev/null +++ b/src/iceberg/logging/logger.cc @@ -0,0 +1,159 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/logger.h" + +#include +#include +#include +#include +#include + +// Build-generated, .cc-only (never from a public header). Defines +// ICEBERG_HAS_SPDLOG when built with -DICEBERG_SPDLOG=ON; tested with #ifdef. +#include "iceberg/logging/cerr_logger.h" +#include "iceberg/logging/config.h" +#ifdef ICEBERG_HAS_SPDLOG +# include "iceberg/logging/internal/spdlog_logger.h" +#endif + +namespace iceberg { + +namespace { + +/// \brief Logger that drops every record. +class NoopLogger final : public Logger { + public: + bool ShouldLog(LogLevel /*level*/) const override { return false; } + void Log(LogMessage&& /*message*/) noexcept override {} + void SetLevel(LogLevel /*level*/) override {} + LogLevel level() const override { return LogLevel::kOff; } + bool IsNoop() const override { return true; } +}; + +/// \brief Construct the process default logger for this build configuration. +/// +/// Prefers the spdlog backend when compiled in; otherwise the always-available +/// std::cerr logger. +std::shared_ptr MakeDefaultLogger() { +#ifdef ICEBERG_HAS_SPDLOG + return std::make_shared(); +#else + return std::make_shared(); +#endif +} + +/// \brief The process-global default-logger slot. +struct DefaultSlot { + std::mutex mtx; + std::shared_ptr logger; + // Seeded to 1 so a fresh thread (tls_gen == 0) always refreshes on first use. + std::atomic gen{1}; + + DefaultSlot() : logger(MakeDefaultLogger()) {} +}; + +/// \brief Immortal (leaked, hence reachable -> LSan-clean) accessor for the slot. +DefaultSlot& Slot() { + static auto* slot = new DefaultSlot(); + return *slot; +} + +} // namespace + +std::shared_ptr Logger::Noop() { + // Intentionally leaked: reachable via the function-local static (LSan-clean) + // and never destroyed, so logging during static teardown stays safe. + static auto* instance = new std::shared_ptr(std::make_shared()); + return *instance; +} + +std::shared_ptr GetDefaultLogger() { + DefaultSlot& slot = Slot(); + std::lock_guard lock(slot.mtx); + return slot.logger; +} + +void SetDefaultLogger(std::shared_ptr logger) { + if (!logger) { + logger = Logger::Noop(); + } + DefaultSlot& slot = Slot(); + std::lock_guard lock(slot.mtx); + slot.logger = std::move(logger); + // Publish the swap; the mutex provides the happens-before, gen is a detector. + slot.gen.fetch_add(1, std::memory_order_relaxed); +} + +void SetDefaultLevel(LogLevel level) { + DefaultSlot& slot = Slot(); + std::lock_guard lock(slot.mtx); + slot.logger->SetLevel(level); +} + +namespace detail { + +const std::shared_ptr& CurrentLogger() noexcept { + static thread_local std::shared_ptr tls; + static thread_local uint64_t tls_gen = 0; + // Sentinel whose destructor marks the cache dead at thread exit. It is + // declared after tls/tls_gen, so it is destroyed FIRST (reverse order); once + // dead, a log from any later-destroyed thread_local destructor must not touch + // the (about-to-be / already) destroyed tls slot. + static thread_local struct AliveFlag { + bool value = true; + ~AliveFlag() { value = false; } + } alive; + if (!alive.value) { + // Thread teardown: the TLS cache is unsafe. Fall back to an immortal logger + // (leaked, never destroyed) so logging during teardown stays safe. + static const std::shared_ptr kFallback = Logger::Noop(); + return kFallback; + } + DefaultSlot& slot = Slot(); + uint64_t current = slot.gen.load(std::memory_order_relaxed); + if (current != tls_gen) { + std::lock_guard lock(slot.mtx); + tls = slot.logger; + tls_gen = current; + } + return tls; +} + +void Emit(Logger& logger, LogLevel level, const std::source_location& location, + std::string&& message) { + logger.Log(LogMessage{.level = level, + .message = std::move(message), + .location = location, + .attributes = {}}); +} + +void EmitFormatError(Logger& logger, LogLevel level, + const std::source_location& location) noexcept { + // Fixed short literal (<= 15 bytes, fits SSO on libstdc++/libc++/MSVC -> no heap + // allocation), no std::format, no retry. Cannot throw or recurse. + logger.Log(LogMessage{.level = level, + .message = std::string(""), + .location = location, + .attributes = {}}); +} + +} // namespace detail + +} // namespace iceberg diff --git a/src/iceberg/logging/logger.h b/src/iceberg/logging/logger.h new file mode 100644 index 000000000..2fe2ef92c --- /dev/null +++ b/src/iceberg/logging/logger.h @@ -0,0 +1,385 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#pragma once + +/// \file iceberg/logging/logger.h +/// \brief Pluggable logging interface, the process-global default logger, and +/// the logging macros. +/// +/// This header is backend-agnostic: it never includes the build-generated +/// backend configuration header and never references the spdlog feature macro, +/// so consumers see one stable API regardless of how the backend was configured. + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "iceberg/iceberg_export.h" +#include "iceberg/logging/log_level.h" +#include "iceberg/result.h" + +namespace iceberg { + +/// \brief A structured key/value attribute attached to a log record. +/// +/// Both key and value are owned so a sink may retain the record safely. +/// Unused in v1; reserved so structured logging can be added without an ABI +/// break to LogMessage. +struct LogAttribute { + std::string key; + std::string value; +}; + +/// \brief A single log record handed to a Logger. +/// +/// The formatted message is owned (moved in by the logging macros), so a sink +/// may safely retain the record beyond the Log() call. The member set must not +/// depend on the build's logging backend (the spdlog backend never appears here). +struct LogMessage { + LogLevel level = LogLevel::kOff; + std::string message; + std::source_location location = std::source_location::current(); + std::vector attributes; +}; + +/// \brief Well-known Logger::Initialize() property keys. +/// +/// `level` is honored by the base Logger::Initialize (parsed via +/// LogLevelFromString) on every backend. `pattern` is honored only by the +/// spdlog backend; CerrLogger uses a fixed layout and ignores it. +inline constexpr std::string_view kLevelProperty = "level"; +inline constexpr std::string_view kPatternProperty = "pattern"; + +/// \brief Pluggable logging sink. +/// +/// ShouldLog() is the single authority for runtime filtering -- the macros call +/// it on every (compile-time-enabled) statement, so level changes by any path +/// take effect immediately. Implementations must be thread-safe and must not +/// throw. They must also obey: +/// - No reentrancy: Log()/Flush() must not call the logging macros or +/// GetDefaultLogger() (UB -- deadlock with mutex-based sinks). +/// - level() is an accessor consistent with ShouldLog (used by SetDefaultLevel +/// and introspection); ShouldLog may implement finer logic than a level compare. +class ICEBERG_EXPORT Logger { + public: + virtual ~Logger() = default; + + /// \brief Property-based setup, called by Loggers::Load() before first use. + /// + /// The base implementation applies the "level" property (parsed via + /// LogLevelFromString); an unrecognized value is an InvalidArgument error. + /// Formatting sinks override this to also apply "pattern" and then delegate + /// to this base for "level". + virtual Status Initialize( + const std::unordered_map& properties) { + if (auto it = properties.find(std::string(kLevelProperty)); it != properties.end()) { + auto parsed = LogLevelFromString(it->second); + if (!parsed) return std::unexpected(parsed.error()); + SetLevel(*parsed); + } + return {}; + } + + /// \brief Cheap check whether a record at \p level would be emitted. + virtual bool ShouldLog(LogLevel level) const = 0; + + /// \brief Emit one (already-formatted) record, taking ownership. Must not throw. + virtual void Log(LogMessage&& message) noexcept = 0; + + /// \brief Set the minimum level this logger emits. + virtual void SetLevel(LogLevel level) = 0; + + /// \brief Return the minimum level this logger emits. + virtual LogLevel level() const = 0; + + /// \brief Flush any buffered output. Must not throw; best-effort on the fatal path. + virtual void Flush() noexcept {} + + /// \brief Return true if this logger is a no-op. + virtual bool IsNoop() const { return false; } + + /// \brief Return a shared, immortal no-op logger singleton. + static std::shared_ptr Noop(); +}; + +/// \brief Return the process-global default logger (never null). +/// +/// Off the hot path -- acquires the slot lock and returns an owning copy. The +/// logging macros use the cheaper internal hot-path accessor instead. +ICEBERG_EXPORT std::shared_ptr GetDefaultLogger(); + +/// \brief Install a new process-global default logger. +/// +/// A null argument installs the no-op logger. Thread-safe; intended for +/// occasional (configuration-time) use rather than the hot path. +ICEBERG_EXPORT void SetDefaultLogger(std::shared_ptr logger); + +/// \brief Set the minimum level of the current default logger. +/// +/// Convenience for `GetDefaultLogger()->SetLevel(level)`. Filtering is always +/// decided by the logger's own ShouldLog(), so changing a logger's level by any +/// means (this, SetLevel on a held handle, or Initialize) takes effect immediately. +ICEBERG_EXPORT void SetDefaultLevel(LogLevel level); + +// --------------------------------------------------------------------------- +// Using the API directly (the LOG_* macros that wrap this are added later in +// the stack). Example: a custom sink, installed as the process default. +// +// class MySink : public Logger { +// public: +// bool ShouldLog(LogLevel level) const override { return level >= level_; } +// void Log(LogMessage&& m) noexcept override { write_line(m.message); } +// void SetLevel(LogLevel level) override { level_ = level; } +// LogLevel level() const override { return level_; } +// private: +// std::atomic level_{LogLevel::kInfo}; +// }; +// +// SetDefaultLogger(std::make_shared()); // install process-wide +// SetDefaultLevel(LogLevel::kDebug); // adjust the threshold +// +// auto logger = GetDefaultLogger(); // borrow the current default +// if (logger->ShouldLog(LogLevel::kInfo)) { +// logger->Log(LogMessage{.level = LogLevel::kInfo, .message = "scan ready"}); +// } +// +// // Or configure from catalog-style properties (applies the "level" key): +// auto sink = std::make_shared(); +// auto status = sink->Initialize({{std::string(kLevelProperty), "warn"}}); // -> kWarn +// --------------------------------------------------------------------------- + +namespace detail { + +/// \brief Hot-path accessor for the default logger. +/// +/// Returns a reference to a thread-local cached shared_ptr that is refreshed +/// only when the default logger has changed (no lock / no refcount churn in +/// steady state). The reference is valid for the duration of the calling +/// statement. +ICEBERG_EXPORT const std::shared_ptr& CurrentLogger() noexcept; + +/// \brief Build a LogMessage from the already-formatted text and dispatch it. +/// +/// Declared ICEBERG_EXPORT because the logging macros expand into this call in +/// consumer translation units. +ICEBERG_EXPORT void Emit(Logger& logger, LogLevel level, + const std::source_location& location, std::string&& message); + +/// \brief Emit a fixed fallback record when formatting threw. +/// +/// noexcept, allocation-light (small/SSO literal), performs no std::format, and +/// does not recurse -- so the macro's "logging never throws" guarantee holds +/// even when a format argument throws. +ICEBERG_EXPORT void EmitFormatError(Logger& logger, LogLevel level, + const std::source_location& location) noexcept; + +/// \brief Runtime (non-literal) format-string helper. +/// +/// std::format requires a compile-time format string; this routes a runtime +/// string through std::vformat. Args are bound as named lvalues and the +/// arg-store is held in a named variable so it outlives the vformat call +/// (C++23 make_format_args rejects rvalues -- P2905 / LWG3631). +template +std::string VFormat(std::string_view fmt, Args&&... args) { + auto store = std::make_format_args(args...); + return std::vformat(fmt, store); +} + +} // namespace detail + +} // namespace iceberg + +// --------------------------------------------------------------------------- +// Logging macros. +// +// Every macro takes a std::format string followed by its arguments. The +// rendered line depends on the active backend (see cerr_logger.h for the +// std::cerr layout, or the spdlog pattern); the examples below show the call +// site and, for the default CerrLogger, the line it produces. +// +// ICEBERG_LOG_TRACE("entering scan for {}", table); +// 2026-06-16T10:59:41.186Z trace [12345] table_scan.cc:88] entering scan for db.t +// ICEBERG_LOG_DEBUG("cache miss key={}", key); +// 2026-06-16T10:59:41.186Z debug [12345] cache.cc:42] cache miss key=manifest-7 +// ICEBERG_LOG_INFO("loaded {} manifests in {} ms", n, ms); +// 2026-06-16T10:59:41.186Z info [12345] table_scan.cc:91] loaded 5 manifests in 12 ms +// ICEBERG_LOG_WARN("retry {} after {}", attempt, err); +// 2026-06-16T10:59:41.186Z warn [12345] io.cc:51] retry 2 after timeout +// ICEBERG_LOG_ERROR("commit failed: {}", status); +// 2026-06-16T10:59:41.186Z error [12345] txn.cc:77] commit failed: conflict +// ICEBERG_LOG_CRITICAL("metadata unreadable at {}", path); +// 2026-06-16T10:59:41.186Z critical [12345] meta.cc:30] metadata unreadable at s3://b/m.json +// ICEBERG_LOG_FATAL("unrecoverable: {}", reason); // emits, flushes, then std::abort() +// 2026-06-16T10:59:41.186Z fatal [12345] boot.cc:19] unrecoverable: bad config +// +// Less common forms: +// ICEBERG_LOG(level, "level chosen at runtime: {}", x); // runtime severity +// ICEBERG_LOG_TO(logger, level, "to an explicit logger {}", y); +// ICEBERG_LOG_RUNTIME_FMT(level, fmt_string, args...); // non-literal format +// +// With ICEBERG_LOG_SHORT_MACROS defined, bare aliases (LOG_INFO, ...) are also +// available. A format string is mandatory; zero extra args is fine +// (ICEBERG_LOG_INFO("done")). +// --------------------------------------------------------------------------- + +/// \brief Compile-time severity floor: statements below this level are removed +/// entirely from the build (their format call sites and source_location literals +/// are never emitted). Defaults to keeping everything. ICEBERG_LOG_FATAL is never +/// gated by this floor -- its abort is always compiled in. +#ifndef ICEBERG_LOG_ACTIVE_LEVEL +# define ICEBERG_LOG_ACTIVE_LEVEL ::iceberg::LogLevel::kTrace +#endif + +// Internal: fixed-severity emit with compile-time floor then the authoritative +// Logger::ShouldLog (the single source of truth for runtime filtering), with +// formatting only on the taken path, never throwing. +#define ICEBERG_INTERNAL_LOG(level_, FMT_, ...) \ + do { \ + if constexpr ((level_) >= ICEBERG_LOG_ACTIVE_LEVEL) { \ + const auto& _ib_logger = ::iceberg::detail::CurrentLogger(); \ + if (_ib_logger && _ib_logger->ShouldLog(level_)) { \ + try { \ + ::iceberg::detail::Emit(*_ib_logger, (level_), \ + ::std::source_location::current(), \ + ::std::format(FMT_ __VA_OPT__(, ) __VA_ARGS__)); \ + } catch (...) { \ + ::iceberg::detail::EmitFormatError(*_ib_logger, (level_), \ + ::std::source_location::current()); \ + } \ + } \ + } \ + } while (0) + +#define ICEBERG_LOG_TRACE(...) \ + ICEBERG_INTERNAL_LOG(::iceberg::LogLevel::kTrace, __VA_ARGS__) +#define ICEBERG_LOG_DEBUG(...) \ + ICEBERG_INTERNAL_LOG(::iceberg::LogLevel::kDebug, __VA_ARGS__) +#define ICEBERG_LOG_INFO(...) \ + ICEBERG_INTERNAL_LOG(::iceberg::LogLevel::kInfo, __VA_ARGS__) +#define ICEBERG_LOG_WARN(...) \ + ICEBERG_INTERNAL_LOG(::iceberg::LogLevel::kWarn, __VA_ARGS__) +#define ICEBERG_LOG_ERROR(...) \ + ICEBERG_INTERNAL_LOG(::iceberg::LogLevel::kError, __VA_ARGS__) +#define ICEBERG_LOG_CRITICAL(...) \ + ICEBERG_INTERNAL_LOG(::iceberg::LogLevel::kCritical, __VA_ARGS__) + +// FATAL: emit if enabled (never compile-stripped), then ALWAYS flush + abort. +// Acquires the default logger ONCE and uses the same instance for emit and flush +// so a concurrent SetDefaultLogger cannot flush a different logger than it emitted to. +#define ICEBERG_LOG_FATAL(FMT_, ...) \ + do { \ + auto _ib_logger = ::iceberg::GetDefaultLogger(); \ + if (_ib_logger && _ib_logger->ShouldLog(::iceberg::LogLevel::kFatal)) { \ + try { \ + ::iceberg::detail::Emit(*_ib_logger, ::iceberg::LogLevel::kFatal, \ + ::std::source_location::current(), \ + ::std::format(FMT_ __VA_OPT__(, ) __VA_ARGS__)); \ + } catch (...) { \ + ::iceberg::detail::EmitFormatError(*_ib_logger, ::iceberg::LogLevel::kFatal, \ + ::std::source_location::current()); \ + } \ + } \ + if (_ib_logger) _ib_logger->Flush(); \ + ::std::abort(); \ + } while (0) + +// Generic, runtime-level form against the default logger. No compile-time floor +// (the level is not a constant). Acquires the logger once; aborts when level == kFatal +// (flushing that same logger first). +#define ICEBERG_LOG(level_, FMT_, ...) \ + do { \ + const ::iceberg::LogLevel _ib_lvl = (level_); \ + const auto& _ib_logger = ::iceberg::detail::CurrentLogger(); \ + if (_ib_logger && _ib_logger->ShouldLog(_ib_lvl)) { \ + try { \ + ::iceberg::detail::Emit(*_ib_logger, _ib_lvl, ::std::source_location::current(), \ + ::std::format(FMT_ __VA_OPT__(, ) __VA_ARGS__)); \ + } catch (...) { \ + ::iceberg::detail::EmitFormatError(*_ib_logger, _ib_lvl, \ + ::std::source_location::current()); \ + } \ + } \ + if (_ib_lvl == ::iceberg::LogLevel::kFatal) { \ + if (_ib_logger) _ib_logger->Flush(); \ + ::std::abort(); \ + } \ + } while (0) + +// Generic form targeting an EXPLICIT logger (must be an lvalue Logger&). Honors +// only that logger's ShouldLog. Aborts when level == kFatal. +#define ICEBERG_LOG_TO(logger_, level_, FMT_, ...) \ + do { \ + ::iceberg::Logger& _ib_logger = (logger_); \ + const ::iceberg::LogLevel _ib_lvl = (level_); \ + if (_ib_logger.ShouldLog(_ib_lvl)) { \ + try { \ + ::iceberg::detail::Emit(_ib_logger, _ib_lvl, ::std::source_location::current(), \ + ::std::format(FMT_ __VA_OPT__(, ) __VA_ARGS__)); \ + } catch (...) { \ + ::iceberg::detail::EmitFormatError(_ib_logger, _ib_lvl, \ + ::std::source_location::current()); \ + } \ + } \ + if (_ib_lvl == ::iceberg::LogLevel::kFatal) { \ + _ib_logger.Flush(); \ + ::std::abort(); \ + } \ + } while (0) + +// Runtime (non-literal) format string against the default logger. Acquires the +// logger once; aborts when level == kFatal (flushing that same logger first). +#define ICEBERG_LOG_RUNTIME_FMT(level_, FMT_, ...) \ + do { \ + const ::iceberg::LogLevel _ib_lvl = (level_); \ + const auto& _ib_logger = ::iceberg::detail::CurrentLogger(); \ + if (_ib_logger && _ib_logger->ShouldLog(_ib_lvl)) { \ + try { \ + ::iceberg::detail::Emit( \ + *_ib_logger, _ib_lvl, ::std::source_location::current(), \ + ::iceberg::detail::VFormat((FMT_)__VA_OPT__(, ) __VA_ARGS__)); \ + } catch (...) { \ + ::iceberg::detail::EmitFormatError(*_ib_logger, _ib_lvl, \ + ::std::source_location::current()); \ + } \ + } \ + if (_ib_lvl == ::iceberg::LogLevel::kFatal) { \ + if (_ib_logger) _ib_logger->Flush(); \ + ::std::abort(); \ + } \ + } while (0) + +// Bare, Java-style aliases. Opt-IN only (define ICEBERG_LOG_SHORT_MACROS before +// including this header) to avoid colliding with glog/abseil/windows.h in +// consumer translation units. No bare LOG(level) is provided. +#ifdef ICEBERG_LOG_SHORT_MACROS +# define LOG_TRACE(...) ICEBERG_LOG_TRACE(__VA_ARGS__) +# define LOG_DEBUG(...) ICEBERG_LOG_DEBUG(__VA_ARGS__) +# define LOG_INFO(...) ICEBERG_LOG_INFO(__VA_ARGS__) +# define LOG_WARN(...) ICEBERG_LOG_WARN(__VA_ARGS__) +# define LOG_ERROR(...) ICEBERG_LOG_ERROR(__VA_ARGS__) +# define LOG_CRITICAL(...) ICEBERG_LOG_CRITICAL(__VA_ARGS__) +# define LOG_FATAL(...) ICEBERG_LOG_FATAL(__VA_ARGS__) +#endif // ICEBERG_LOG_SHORT_MACROS diff --git a/src/iceberg/logging/loggers.cc b/src/iceberg/logging/loggers.cc new file mode 100644 index 000000000..e439ed736 --- /dev/null +++ b/src/iceberg/logging/loggers.cc @@ -0,0 +1,147 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/loggers.h" + +#include +#include +#include +#include +#include +#include +#include + +// Build-generated, .cc-only. Defines ICEBERG_HAS_SPDLOG; tested with #ifdef. +#include "iceberg/logging/cerr_logger.h" +#include "iceberg/logging/config.h" +#include "iceberg/util/macros.h" +#ifdef ICEBERG_HAS_SPDLOG +# include "iceberg/logging/internal/spdlog_logger.h" +#endif + +namespace iceberg { + +namespace { + +/// \brief Registry-constructible no-op logger (Load returns unique_ptr). +class NoopLogger final : public Logger { + public: + bool ShouldLog(LogLevel /*level*/) const override { return false; } + void Log(LogMessage&& /*message*/) noexcept override {} + void SetLevel(LogLevel /*level*/) override {} + LogLevel level() const override { return LogLevel::kOff; } + bool IsNoop() const override { return true; } +}; + +/// \brief Extract the logger type, defaulting to the compiled-in backend. +std::string InferLoggerType( + const std::unordered_map& properties) { + auto it = properties.find(std::string(kLoggerImpl)); + if (it != properties.end() && !it->second.empty()) { + return it->second; + } +#ifdef ICEBERG_HAS_SPDLOG + return std::string(kLoggerTypeSpdlog); +#else + return std::string(kLoggerTypeCerr); +#endif +} + +struct LoggerRegistryState { + std::shared_mutex mtx; + std::unordered_map map; +}; + +LoggerRegistryState& GetRegistry() { + static auto* state = + new LoggerRegistryState{.map = { + {std::string(kLoggerTypeNoop), + [](const std::unordered_map&) + -> Result> { + return std::make_unique(); + }}, + {std::string(kLoggerTypeCerr), + [](const std::unordered_map&) + -> Result> { + return std::make_unique(); + }}, +#ifdef ICEBERG_HAS_SPDLOG + {std::string(kLoggerTypeSpdlog), + [](const std::unordered_map&) + -> Result> { + return std::make_unique(); + }}, +#endif + }}; + return *state; +} + +} // namespace + +Status Loggers::Register(std::string_view logger_type, LoggerFactory factory) { + if (!factory) { + return InvalidArgument("Logger factory for '{}' must not be empty", logger_type); + } + auto& registry = GetRegistry(); + std::unique_lock lock(registry.mtx); + registry.map[std::string(logger_type)] = std::move(factory); + return {}; +} + +Result> Loggers::Load( + const std::unordered_map& properties) { + std::string logger_type = InferLoggerType(properties); + + LoggerFactory factory; + { + auto& registry = GetRegistry(); + std::shared_lock lock(registry.mtx); + auto it = registry.map.find(logger_type); + if (it == registry.map.end()) { + return InvalidArgument( + "Unknown logger type '{}'. Register a factory with Loggers::Register() " + "before using this type.", + logger_type); + } + factory = it->second; + } + + try { + ICEBERG_ASSIGN_OR_RAISE(auto logger, factory(properties)); + if (!logger) { + return InvalidArgument("Logger factory for '{}' returned null", logger_type); + } + ICEBERG_RETURN_UNEXPECTED(logger->Initialize(properties)); + return logger; + } catch (const std::exception& ex) { + return InvalidArgument("Logger factory for '{}' failed: {}", logger_type, ex.what()); + } catch (...) { + return InvalidArgument("Logger factory for '{}' failed with unknown exception", + logger_type); + } +} + +Status Loggers::LoadAndSetDefault( + const std::unordered_map& properties) { + ICEBERG_ASSIGN_OR_RAISE(auto logger, Load(properties)); + SetDefaultLogger(std::shared_ptr(std::move(logger))); + return {}; +} + +} // namespace iceberg diff --git a/src/iceberg/logging/loggers.h b/src/iceberg/logging/loggers.h new file mode 100644 index 000000000..36ccab1d5 --- /dev/null +++ b/src/iceberg/logging/loggers.h @@ -0,0 +1,68 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#pragma once + +/// \file iceberg/logging/loggers.h +/// \brief Property-driven registry/factory for Logger backends. + +#include +#include +#include +#include +#include + +#include "iceberg/iceberg_export.h" +#include "iceberg/logging/logger.h" +#include "iceberg/result.h" + +namespace iceberg { + +/// \brief Property key selecting the logger implementation. +constexpr std::string_view kLoggerImpl = "logger-impl"; +/// \brief Built-in logger type identifiers. +constexpr std::string_view kLoggerTypeNoop = "noop"; +constexpr std::string_view kLoggerTypeCerr = "cerr"; +constexpr std::string_view kLoggerTypeSpdlog = "spdlog"; + +/// \brief Factory constructing a Logger from catalog-style properties. +using LoggerFactory = std::function>( + const std::unordered_map& properties)>; + +/// \brief Registry of logger factories, mirroring MetricsReporters. +/// +/// Built-in factories: "noop", "cerr", and (only when built with ICEBERG_SPDLOG) +/// "spdlog". When the "logger-impl" property is absent, the default is "spdlog" +/// if compiled in, otherwise "cerr" -- an intentional divergence from the metrics +/// registry's noop default (we want logs by default). +class ICEBERG_EXPORT Loggers { + public: + /// \brief Construct and initialize a logger from properties. + static Result> Load( + const std::unordered_map& properties); + + /// \brief Register a factory for \p logger_type (overwrites any existing). + static Status Register(std::string_view logger_type, LoggerFactory factory); + + /// \brief Load a logger from properties and install it as the default. + static Status LoadAndSetDefault( + const std::unordered_map& properties); +}; + +} // namespace iceberg diff --git a/src/iceberg/logging/meson.build b/src/iceberg/logging/meson.build index 3c286a196..9dd01c481 100644 --- a/src/iceberg/logging/meson.build +++ b/src/iceberg/logging/meson.build @@ -15,4 +15,17 @@ # specific language governing permissions and limitations # under the License. -install_headers(['log_level.h'], subdir: 'iceberg/logging') +# Generate the .cc-only logging backend config header. The meson build always +# links spdlog, so ICEBERG_HAS_SPDLOG is always defined here. Generated into +# build/src/iceberg/logging/config.h (resolved via include_directories('..'), +# which exposes both the source and build trees); not installed. +logging_config_data = configuration_data() +logging_config_data.set('ICEBERG_HAS_SPDLOG', 1) +configure_file(output: 'config.h', configuration: logging_config_data) + +# Public logging headers. The build-generated config.h and the internal +# SpdLogger header are intentionally NOT installed. +install_headers( + ['cerr_logger.h', 'log_level.h', 'logger.h', 'loggers.h'], + subdir: 'iceberg/logging', +) diff --git a/src/iceberg/meson.build b/src/iceberg/meson.build index 7a6ba4f8b..6f964ad1f 100644 --- a/src/iceberg/meson.build +++ b/src/iceberg/meson.build @@ -39,6 +39,8 @@ configure_file( install_dir: get_option('includedir') / 'iceberg', ) +# Generate iceberg/logging/config.h (must precede the library() that compiles +# the logging sources which include it). subdir('logging') iceberg_include_dir = include_directories('..') @@ -72,6 +74,10 @@ iceberg_sources = files( 'inspect/snapshots_table.cc', 'json_serde.cc', 'location_provider.cc', + 'logging/cerr_logger.cc', + 'logging/internal/spdlog_logger.cc', + 'logging/logger.cc', + 'logging/loggers.cc', 'manifest/manifest_adapter.cc', 'manifest/manifest_entry.cc', 'manifest/manifest_filter_manager.cc', diff --git a/src/iceberg/test/CMakeLists.txt b/src/iceberg/test/CMakeLists.txt index 0a7db5ed2..1f4f70ce7 100644 --- a/src/iceberg/test/CMakeLists.txt +++ b/src/iceberg/test/CMakeLists.txt @@ -64,7 +64,9 @@ function(add_iceberg_test test_name) endif() if(MSVC_TOOLCHAIN) - target_compile_options(${test_name} PRIVATE /bigobj) + # /Zc:preprocessor: conforming preprocessor for the __VA_OPT__ in the logging + # macros (MSVC's traditional preprocessor rejects it). + target_compile_options(${test_name} PRIVATE /bigobj /Zc:preprocessor) endif() add_test(NAME ${test_name} COMMAND ${test_name}) @@ -102,7 +104,16 @@ add_iceberg_test(table_test table_test.cc table_update_test.cc) -add_iceberg_test(logging_test SOURCES log_level_test.cc) +add_iceberg_test(logging_test + SOURCES + cerr_logger_test.cc + log_level_test.cc + logger_test.cc + loggers_test.cc + logging_end_to_end_test.cc + macros_active_level_test.cc + macros_test.cc + spdlog_logger_test.cc) add_iceberg_test(expression_test SOURCES diff --git a/src/iceberg/test/cerr_logger_test.cc b/src/iceberg/test/cerr_logger_test.cc new file mode 100644 index 000000000..126698307 --- /dev/null +++ b/src/iceberg/test/cerr_logger_test.cc @@ -0,0 +1,111 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/cerr_logger.h" + +#include +#include +#include +#include +#include +#include + +#include + +#include "iceberg/logging/log_level.h" +#include "iceberg/logging/logger.h" + +namespace iceberg { + +namespace { + +/// \brief RAII redirect of std::cerr to a stringstream for the test scope. +class CerrCapture { + public: + CerrCapture() : old_(std::cerr.rdbuf(buffer_.rdbuf())) {} + ~CerrCapture() { std::cerr.rdbuf(old_); } + std::string str() const { return buffer_.str(); } + + private: + std::ostringstream buffer_; + std::streambuf* old_; +}; + +LogMessage MakeMessage(LogLevel level, std::string text) { + return LogMessage{.level = level, + .message = std::move(text), + .location = std::source_location::current(), + .attributes = {}}; +} + +} // namespace + +TEST(CerrLoggerTest, DefaultLevelIsInfo) { + CerrLogger logger; + EXPECT_EQ(logger.level(), LogLevel::kInfo); + EXPECT_FALSE(logger.ShouldLog(LogLevel::kDebug)); + EXPECT_TRUE(logger.ShouldLog(LogLevel::kInfo)); + EXPECT_TRUE(logger.ShouldLog(LogLevel::kError)); +} + +TEST(CerrLoggerTest, SetLevelFilters) { + CerrLogger logger(LogLevel::kError); + EXPECT_FALSE(logger.ShouldLog(LogLevel::kWarn)); + logger.SetLevel(LogLevel::kTrace); + EXPECT_TRUE(logger.ShouldLog(LogLevel::kTrace)); +} + +TEST(CerrLoggerTest, LineContainsLevelAndMessage) { + CerrLogger logger; + CerrCapture capture; + logger.Log(MakeMessage(LogLevel::kError, "boom 42")); + std::string out = capture.str(); + EXPECT_NE(out.find("error"), std::string::npos); + EXPECT_NE(out.find("boom 42"), std::string::npos); + EXPECT_NE(out.find("cerr_logger_test.cc"), std::string::npos); + EXPECT_EQ(out.back(), '\n'); +} + +TEST(CerrLoggerTest, ConcurrentLogsDoNotInterleave) { + CerrLogger logger(LogLevel::kTrace); + CerrCapture capture; + constexpr int kThreads = 8; + constexpr int kPerThread = 50; + + std::vector threads; + for (int t = 0; t < kThreads; ++t) { + threads.emplace_back([&logger] { + for (int i = 0; i < kPerThread; ++i) { + logger.Log(MakeMessage(LogLevel::kInfo, "line")); + } + }); + } + for (auto& thread : threads) thread.join(); + + // Every record is exactly one well-formed line; no interleaving means the + // line count equals the record count. + std::string out = capture.str(); + int newlines = 0; + for (char c : out) { + if (c == '\n') ++newlines; + } + EXPECT_EQ(newlines, kThreads * kPerThread); +} + +} // namespace iceberg diff --git a/src/iceberg/test/logger_test.cc b/src/iceberg/test/logger_test.cc new file mode 100644 index 000000000..ed1c88aa5 --- /dev/null +++ b/src/iceberg/test/logger_test.cc @@ -0,0 +1,149 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/logger.h" + +#include +#include +#include +#include + +#include + +#include "iceberg/logging/log_level.h" +#include "iceberg/test/logging_test_helpers.h" + +namespace iceberg { + +TEST(LoggerTest, NoopIsSharedImmortalAndSilent) { + auto noop = Logger::Noop(); + ASSERT_NE(noop, nullptr); + EXPECT_TRUE(noop->IsNoop()); + EXPECT_FALSE(noop->ShouldLog(LogLevel::kFatal)); + EXPECT_EQ(noop->level(), LogLevel::kOff); + // Same singleton instance every call. + EXPECT_EQ(noop.get(), Logger::Noop().get()); +} + +TEST(LoggerTest, DefaultLoggerIsNeverNull) { EXPECT_NE(GetDefaultLogger(), nullptr); } + +TEST(LoggerTest, SetAndGetDefaultLogger) { + auto capturing = std::make_shared(); + ScopedDefaultLogger guard(capturing); + EXPECT_EQ(GetDefaultLogger().get(), capturing.get()); + EXPECT_EQ(detail::CurrentLogger().get(), capturing.get()); +} + +TEST(LoggerTest, SetNullFallsBackToNoop) { + ScopedDefaultLogger guard(std::make_shared()); + SetDefaultLogger(nullptr); + EXPECT_TRUE(GetDefaultLogger()->IsNoop()); +} + +TEST(LoggerTest, CurrentLoggerTracksSwaps) { + auto first = std::make_shared(); + auto second = std::make_shared(); + ScopedDefaultLogger guard(first); + EXPECT_EQ(detail::CurrentLogger().get(), first.get()); + SetDefaultLogger(second); + // Generation bump must invalidate the thread-local cache. + EXPECT_EQ(detail::CurrentLogger().get(), second.get()); +} + +TEST(LoggerTest, SetDefaultLevelUpdatesLogger) { + auto capturing = std::make_shared(); + ScopedDefaultLogger guard(capturing); + SetDefaultLevel(LogLevel::kError); + EXPECT_EQ(capturing->level(), LogLevel::kError); +} + +// Filtering is decided by the logger's own ShouldLog (no separate cached gate), +// so lowering a logger's level out-of-band (not via SetDefaultLevel) takes effect +// immediately -- this is the regression guard for the dropped g_effective_level gate. +TEST(LoggerTest, OutOfBandLevelLoweringTakesEffect) { + auto capturing = std::make_shared(); + capturing->SetLevel(LogLevel::kError); + ScopedDefaultLogger guard(capturing); + EXPECT_FALSE(detail::CurrentLogger()->ShouldLog(LogLevel::kInfo)); + capturing->SetLevel(LogLevel::kTrace); // lowered directly on the handle + EXPECT_TRUE(detail::CurrentLogger()->ShouldLog(LogLevel::kInfo)); +} + +TEST(LoggerTest, ConcurrentSwapAndReadIsSafe) { + // Stress CurrentLogger()/GetDefaultLogger() against SetDefaultLogger() swaps. + // Run under TSan in CI; here it asserts no crash and a valid logger throughout. + auto a = std::make_shared(); + auto b = std::make_shared(); + ScopedDefaultLogger guard(a); + std::atomic stop{false}; + std::atomic saw_null{false}; + std::vector readers; + for (int i = 0; i < 6; ++i) { + readers.emplace_back([&stop, &saw_null] { + // ASSERT_* doesn't propagate from non-main threads; record via a flag. + while (!stop.load(std::memory_order_relaxed)) { + const auto& l = detail::CurrentLogger(); + if (!l) saw_null.store(true, std::memory_order_relaxed); + (void)l->ShouldLog(LogLevel::kError); + (void)GetDefaultLogger(); + } + }); + } + for (int i = 0; i < 2000; ++i) SetDefaultLogger((i & 1) ? a : b); + stop.store(true, std::memory_order_relaxed); + for (auto& t : readers) t.join(); + EXPECT_FALSE(saw_null.load()); // CurrentLogger() is never null across swaps +} + +TEST(LoggerTest, InitializeAppliesLevelProperty) { + CapturingLogger logger; + auto status = logger.Initialize({{std::string(kLevelProperty), std::string("error")}}); + ASSERT_TRUE(status.has_value()); + EXPECT_EQ(logger.level(), LogLevel::kError); +} + +TEST(LoggerTest, InitializeRejectsInvalidLevel) { + CapturingLogger logger; + auto status = + logger.Initialize({{std::string(kLevelProperty), std::string("not-a-level")}}); + ASSERT_FALSE(status.has_value()); + EXPECT_EQ(status.error().kind, ErrorKind::kInvalidArgument); +} + +// Logging during thread teardown (from a thread_local destructor) must not crash: +// CurrentLogger() serves the live cache or falls back to an immortal logger. Run +// under ASan in CI for full signal. +TEST(LoggerTest, LoggingFromThreadLocalDestructorIsSafe) { + std::thread([] { + struct Probe { + ~Probe() { + const auto& logger = detail::CurrentLogger(); + if (logger) { + detail::Emit(*logger, LogLevel::kInfo, std::source_location::current(), + "from thread_local dtor"); + } + } + }; + static thread_local Probe probe; + (void)probe; + }).join(); + SUCCEED(); +} + +} // namespace iceberg diff --git a/src/iceberg/test/loggers_test.cc b/src/iceberg/test/loggers_test.cc new file mode 100644 index 000000000..29547a890 --- /dev/null +++ b/src/iceberg/test/loggers_test.cc @@ -0,0 +1,104 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include "iceberg/logging/loggers.h" + +#include +#include +#include + +#include + +#include "iceberg/logging/log_level.h" +#include "iceberg/logging/logger.h" +#include "iceberg/test/logging_test_helpers.h" + +namespace iceberg { + +TEST(LoggersTest, LoadDefaultReturnsNonNullNonNoop) { + auto result = Loggers::Load({}); + ASSERT_TRUE(result.has_value()); + ASSERT_NE(result.value(), nullptr); + // The default backend (spdlog or cerr) is a real sink, never the no-op. + EXPECT_FALSE(result.value()->IsNoop()); +} + +TEST(LoggersTest, LoadNoopByProperty) { + auto result = Loggers::Load({{std::string(kLoggerImpl), std::string(kLoggerTypeNoop)}}); + ASSERT_TRUE(result.has_value()); + EXPECT_TRUE(result.value()->IsNoop()); +} + +TEST(LoggersTest, LoadCerrByProperty) { + auto result = Loggers::Load({{std::string(kLoggerImpl), std::string(kLoggerTypeCerr)}}); + ASSERT_TRUE(result.has_value()); + ASSERT_NE(result.value(), nullptr); + EXPECT_FALSE(result.value()->IsNoop()); +} + +TEST(LoggersTest, UnknownTypeIsAnError) { + auto result = + Loggers::Load({{std::string(kLoggerImpl), std::string("does-not-exist")}}); + ASSERT_FALSE(result.has_value()); + EXPECT_EQ(result.error().kind, ErrorKind::kInvalidArgument); +} + +TEST(LoggersTest, RegisterCustomFactoryThenLoad) { + auto status = Loggers::Register("capturing", + [](const std::unordered_map&) + -> Result> { + return std::make_unique(); + }); + ASSERT_TRUE(status.has_value()); + + auto result = Loggers::Load({{std::string(kLoggerImpl), "capturing"}}); + ASSERT_TRUE(result.has_value()); + EXPECT_NE(dynamic_cast(result.value().get()), nullptr); +} + +TEST(LoggersTest, RegisterRejectsEmptyFactory) { + auto status = Loggers::Register("bad", LoggerFactory{}); + ASSERT_FALSE(status.has_value()); + EXPECT_EQ(status.error().kind, ErrorKind::kInvalidArgument); +} + +TEST(LoggersTest, LoadAndSetDefaultInstallsLogger) { + auto previous = GetDefaultLogger(); + auto status = Loggers::LoadAndSetDefault( + {{std::string(kLoggerImpl), std::string(kLoggerTypeNoop)}}); + ASSERT_TRUE(status.has_value()); + EXPECT_TRUE(GetDefaultLogger()->IsNoop()); + SetDefaultLogger(previous); // restore +} + +TEST(LoggersTest, LoadAppliesLevelProperty) { + auto result = Loggers::Load({{std::string(kLoggerImpl), std::string(kLoggerTypeCerr)}, + {std::string(kLevelProperty), std::string("error")}}); + ASSERT_TRUE(result.has_value()); + EXPECT_EQ(result.value()->level(), LogLevel::kError); +} + +TEST(LoggersTest, LoadRejectsInvalidLevelProperty) { + auto result = Loggers::Load({{std::string(kLoggerImpl), std::string(kLoggerTypeCerr)}, + {std::string(kLevelProperty), std::string("not-a-level")}}); + ASSERT_FALSE(result.has_value()); + EXPECT_EQ(result.error().kind, ErrorKind::kInvalidArgument); +} + +} // namespace iceberg diff --git a/src/iceberg/test/logging_end_to_end_test.cc b/src/iceberg/test/logging_end_to_end_test.cc new file mode 100644 index 000000000..b11f6da5a --- /dev/null +++ b/src/iceberg/test/logging_end_to_end_test.cc @@ -0,0 +1,168 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// End-to-end tests: exercise the public surface the way an application does -- +// configure/install a real backend via the registry, log through the LOG_* +// macros, and observe the actual output. The per-layer unit tests cover each +// piece in isolation against a fake; these cover the seams between them. + +// Internal/build-generated header is acceptable in a test TU (not installed). +#include "iceberg/logging/config.h" + +#include +#include +#include +#include + +#include + +#include "iceberg/logging/cerr_logger.h" +#include "iceberg/logging/log_level.h" +#include "iceberg/logging/logger.h" +#include "iceberg/logging/loggers.h" +#include "iceberg/test/logging_test_helpers.h" + +#ifdef ICEBERG_HAS_SPDLOG +# include +# include + +# include "iceberg/logging/internal/spdlog_logger.h" +#endif + +namespace iceberg { + +namespace { + +/// \brief RAII redirect of std::cerr to a stringstream for the test scope. +class CerrCapture { + public: + CerrCapture() : old_(std::cerr.rdbuf(buffer_.rdbuf())) {} + ~CerrCapture() { std::cerr.rdbuf(old_); } + std::string str() const { return buffer_.str(); } + + private: + std::ostringstream buffer_; + std::streambuf* old_; +}; + +} // namespace + +// Configure CerrLogger through the registry, install it as the process default, +// then log via a macro and observe the formatted line on std::cerr -- the full +// registry -> default-slot -> macro -> Emit -> backend -> output path. +TEST(LoggingEndToEndTest, ConfiguredCerrLoggerEmitsFormattedLineThroughMacro) { + ScopedDefaultLogger guard(GetDefaultLogger()); // save + restore the default + auto status = Loggers::LoadAndSetDefault( + {{std::string(kLoggerImpl), std::string(kLoggerTypeCerr)}}); + ASSERT_TRUE(status.has_value()); + + std::string out; + { + CerrCapture capture; + ICEBERG_LOG_WARN("u={}", 7); + out = capture.str(); + } + EXPECT_NE(out.find("warn"), std::string::npos); + EXPECT_NE(out.find("u=7"), std::string::npos); + EXPECT_NE(out.find("logging_end_to_end_test.cc"), std::string::npos); + EXPECT_EQ(out.back(), '\n'); +} + +// The level set on the installed default logger gates emission decided through +// the whole macro path (not just a direct ShouldLog() call). +TEST(LoggingEndToEndTest, InstalledLevelFiltersThroughFullMacroPath) { + ScopedDefaultLogger guard(GetDefaultLogger()); + auto status = Loggers::LoadAndSetDefault( + {{std::string(kLoggerImpl), std::string(kLoggerTypeCerr)}}); + ASSERT_TRUE(status.has_value()); + SetDefaultLevel(LogLevel::kError); + + { + CerrCapture capture; + ICEBERG_LOG_INFO("dropped {}", 1); + EXPECT_TRUE(capture.str().empty()); + } + { + CerrCapture capture; + ICEBERG_LOG_ERROR("kept {}", 2); + EXPECT_NE(capture.str().find("kept 2"), std::string::npos); + } +} + +// The "level" property set at configuration time gates emission through the full +// registry -> Initialize -> default-slot -> macro path. +TEST(LoggingEndToEndTest, ConfiguredLevelByPropertyFiltersThroughMacro) { + ScopedDefaultLogger guard(GetDefaultLogger()); + auto status = + Loggers::LoadAndSetDefault({{std::string(kLoggerImpl), std::string(kLoggerTypeCerr)}, + {std::string(kLevelProperty), std::string("error")}}); + ASSERT_TRUE(status.has_value()); + + { + CerrCapture capture; + ICEBERG_LOG_INFO("dropped {}", 1); + EXPECT_TRUE(capture.str().empty()); + } + { + CerrCapture capture; + ICEBERG_LOG_ERROR("kept {}", 2); + EXPECT_NE(capture.str().find("kept 2"), std::string::npos); + } +} + +// The process default with no configuration is a real sink (never the no-op), +// and is the backend the build was compiled with: spdlog when ICEBERG_SPDLOG is +// ON, otherwise the std::cerr logger. +TEST(LoggingEndToEndTest, DefaultLoggerIsTheCompiledBackend) { + auto def = GetDefaultLogger(); + ASSERT_NE(def, nullptr); + EXPECT_FALSE(def->IsNoop()); +#ifdef ICEBERG_HAS_SPDLOG + EXPECT_NE(dynamic_cast(def.get()), nullptr); +#else + EXPECT_NE(dynamic_cast(def.get()), nullptr); +#endif +} + +#ifdef ICEBERG_HAS_SPDLOG +// The "spdlog" registry type resolves to the spdlog-backed sink by name. +TEST(LoggingEndToEndTest, SpdlogFactoryLoadsByName) { + auto result = + Loggers::Load({{std::string(kLoggerImpl), std::string(kLoggerTypeSpdlog)}}); + ASSERT_TRUE(result.has_value()); + ASSERT_NE(result.value(), nullptr); + EXPECT_FALSE(result.value()->IsNoop()); + EXPECT_NE(dynamic_cast(result.value().get()), nullptr); +} + +// A macro statement reaches a real spdlog sink: install a SpdLogger backed by an +// ostream sink as the default, log through the macro, and observe the output. +TEST(LoggingEndToEndTest, MacroLogsThroughRealSpdLogger) { + std::ostringstream out; + auto sink = std::make_shared(out); + auto spd = std::make_shared("e2e", sink); + ScopedDefaultLogger guard(std::make_shared(spd, LogLevel::kTrace)); + + ICEBERG_LOG_INFO("v={}", 9); + GetDefaultLogger()->Flush(); + EXPECT_NE(out.str().find("v=9"), std::string::npos); +} +#endif // ICEBERG_HAS_SPDLOG + +} // namespace iceberg diff --git a/src/iceberg/test/logging_test_helpers.h b/src/iceberg/test/logging_test_helpers.h new file mode 100644 index 000000000..00a57cf82 --- /dev/null +++ b/src/iceberg/test/logging_test_helpers.h @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#pragma once + +#include +#include +#include +#include + +#include "iceberg/logging/logger.h" + +namespace iceberg { + +/// \brief Test sink that records every emitted LogMessage under a mutex. +class CapturingLogger : public Logger { + public: + bool ShouldLog(LogLevel level) const override { return level >= level_; } + + void Log(LogMessage&& message) noexcept override { + std::lock_guard lock(mutex_); + records_.push_back(std::move(message)); + } + + void SetLevel(LogLevel level) override { level_ = level; } + LogLevel level() const override { return level_; } + + std::vector records() const { + std::lock_guard lock(mutex_); + return records_; + } + + std::size_t count() const { + std::lock_guard lock(mutex_); + return records_.size(); + } + + private: + mutable std::mutex mutex_; + LogLevel level_ = LogLevel::kTrace; + std::vector records_; +}; + +/// \brief RAII guard that restores the process default logger on scope exit, so +/// tests that swap the global default don't leak state into other tests. +class ScopedDefaultLogger { + public: + explicit ScopedDefaultLogger(std::shared_ptr logger) + : previous_(GetDefaultLogger()) { + SetDefaultLogger(std::move(logger)); + } + ~ScopedDefaultLogger() { SetDefaultLogger(previous_); } + + ScopedDefaultLogger(const ScopedDefaultLogger&) = delete; + ScopedDefaultLogger& operator=(const ScopedDefaultLogger&) = delete; + + private: + std::shared_ptr previous_; +}; + +} // namespace iceberg diff --git a/src/iceberg/test/macros_active_level_test.cc b/src/iceberg/test/macros_active_level_test.cc new file mode 100644 index 000000000..95ede353a --- /dev/null +++ b/src/iceberg/test/macros_active_level_test.cc @@ -0,0 +1,57 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// Compile-time floor set to kOff for this translation unit: every fixed-severity +// macro below kFatal must be stripped to nothing, while ICEBERG_LOG_FATAL must +// still abort (its abort is never gated by the compile-time floor). +#define ICEBERG_LOG_ACTIVE_LEVEL ::iceberg::LogLevel::kOff + +#include + +#include + +#include "iceberg/logging/log_level.h" +#include "iceberg/logging/logger.h" +#include "iceberg/test/logging_test_helpers.h" + +namespace iceberg { + +TEST(MacrosActiveLevelTest, BelowFloorStatementsAreCompiledOut) { + auto logger = std::make_shared(); + logger->SetLevel(LogLevel::kTrace); + ScopedDefaultLogger guard(logger); + + int calls = 0; + auto counted = [&calls]() { + ++calls; + return 1; + }; + // Stripped at compile time -> arguments never evaluated, nothing emitted, + // even though the runtime logger would accept these levels. + ICEBERG_LOG_INFO("{}", counted()); + ICEBERG_LOG_CRITICAL("{}", counted()); + EXPECT_EQ(calls, 0); + EXPECT_EQ(logger->count(), 0u); +} + +TEST(MacrosActiveLevelDeathTest, FatalStillAbortsWhenEverythingElseStripped) { + EXPECT_DEATH({ ICEBERG_LOG_FATAL("still fatal"); }, ""); +} + +} // namespace iceberg diff --git a/src/iceberg/test/macros_test.cc b/src/iceberg/test/macros_test.cc new file mode 100644 index 000000000..c61d3e578 --- /dev/null +++ b/src/iceberg/test/macros_test.cc @@ -0,0 +1,146 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +#include + +#include + +#include "iceberg/logging/cerr_logger.h" +#include "iceberg/logging/log_level.h" +#include "iceberg/logging/logger.h" +#include "iceberg/test/logging_test_helpers.h" + +namespace iceberg { + +namespace { + +std::shared_ptr InstallCapturing(LogLevel level = LogLevel::kTrace) { + auto logger = std::make_shared(); + logger->SetLevel(level); + return logger; +} + +} // namespace + +TEST(MacrosTest, InfoFormatsAndCapturesLocation) { + auto logger = InstallCapturing(); + ScopedDefaultLogger guard(logger); + ICEBERG_LOG_INFO("x={}", 42); + auto records = logger->records(); + ASSERT_EQ(records.size(), 1u); + EXPECT_EQ(records[0].level, LogLevel::kInfo); + EXPECT_EQ(records[0].message, "x=42"); + EXPECT_NE(records[0].location.line(), 0u); +} + +TEST(MacrosTest, RuntimeLevelFiltersBelowThreshold) { + auto logger = InstallCapturing(); + ScopedDefaultLogger guard(logger); + SetDefaultLevel(LogLevel::kError); + ICEBERG_LOG_INFO("dropped"); + ICEBERG_LOG_ERROR("kept"); + auto records = logger->records(); + ASSERT_EQ(records.size(), 1u); + EXPECT_EQ(records[0].message, "kept"); +} + +TEST(MacrosTest, DisabledLevelDoesNotEvaluateArguments) { + auto logger = InstallCapturing(); + ScopedDefaultLogger guard(logger); + SetDefaultLevel(LogLevel::kError); + int calls = 0; + auto counted = [&calls]() { + ++calls; + return 1; + }; + ICEBERG_LOG_INFO("{}", counted()); + EXPECT_EQ(calls, 0); +} + +TEST(MacrosTest, DanglingElseBindsCorrectly) { + auto logger = InstallCapturing(); + ScopedDefaultLogger guard(logger); + bool took_else = false; + if (false) + ICEBERG_LOG_INFO("if-branch"); + else + took_else = true; + EXPECT_TRUE(took_else); + EXPECT_EQ(logger->count(), 0u); +} + +TEST(MacrosTest, GenericRuntimeLevelMacroCompilesAndLogs) { + auto logger = InstallCapturing(); + ScopedDefaultLogger guard(logger); + LogLevel level = LogLevel::kWarn; + ICEBERG_LOG(level, "n={}", 7); + auto records = logger->records(); + ASSERT_EQ(records.size(), 1u); + EXPECT_EQ(records[0].message, "n=7"); + EXPECT_EQ(records[0].level, LogLevel::kWarn); +} + +TEST(MacrosTest, LogToHonorsOnlyExplicitLoggerNotDefaultGate) { + auto sink = InstallCapturing(); + ScopedDefaultLogger guard(InstallCapturing()); + SetDefaultLevel(LogLevel::kOff); // default gate would block everything + ICEBERG_LOG_TO(*sink, LogLevel::kInfo, "explicit {}", 1); + EXPECT_EQ(sink->count(), 1u); +} + +TEST(MacrosTest, NeverThrowsOnBadRuntimeFormat) { + auto logger = InstallCapturing(); + ScopedDefaultLogger guard(logger); + // Invalid runtime format string -> std::vformat throws -> swallowed -> fallback. + EXPECT_NO_THROW(ICEBERG_LOG_RUNTIME_FMT(LogLevel::kInfo, "{")); + auto records = logger->records(); + ASSERT_EQ(records.size(), 1u); + EXPECT_EQ(records[0].message, ""); +} + +TEST(MacrosDeathTest, FatalEmitsThenAborts) { + // Default logger writes to std::cerr; the message must appear before abort. + EXPECT_DEATH({ ICEBERG_LOG_FATAL("fatalmsg {}", 7); }, "fatalmsg 7"); +} + +TEST(MacrosDeathTest, FatalAbortsEvenWhenRuntimeDisabled) { + EXPECT_DEATH( + { + SetDefaultLevel(LogLevel::kOff); + ICEBERG_LOG_FATAL("suppressed"); + }, + ""); +} + +TEST(MacrosDeathTest, GenericRuntimeFatalEmitsThenAborts) { + // ICEBERG_LOG with a runtime kFatal level must also emit then abort. + EXPECT_DEATH({ ICEBERG_LOG(LogLevel::kFatal, "gfatal {}", 1); }, "gfatal 1"); +} + +TEST(MacrosDeathTest, LogToFatalEmitsThenAborts) { + // ICEBERG_LOG_TO with kFatal must emit to the explicit logger then abort. + EXPECT_DEATH( + { + CerrLogger sink(LogLevel::kTrace); + ICEBERG_LOG_TO(sink, LogLevel::kFatal, "tofatal {}", 2); + }, + "tofatal 2"); +} + +} // namespace iceberg diff --git a/src/iceberg/test/meson.build b/src/iceberg/test/meson.build index a76a15553..559219f60 100644 --- a/src/iceberg/test/meson.build +++ b/src/iceberg/test/meson.build @@ -61,7 +61,18 @@ iceberg_tests = { 'table_update_test.cc', ), }, - 'logging_test': {'sources': files('log_level_test.cc')}, + 'logging_test': { + 'sources': files( + 'cerr_logger_test.cc', + 'log_level_test.cc', + 'logger_test.cc', + 'loggers_test.cc', + 'logging_end_to_end_test.cc', + 'macros_active_level_test.cc', + 'macros_test.cc', + 'spdlog_logger_test.cc', + ), + }, 'expression_test': { 'sources': files( 'aggregate_test.cc', diff --git a/src/iceberg/test/spdlog_logger_test.cc b/src/iceberg/test/spdlog_logger_test.cc new file mode 100644 index 000000000..30bbe6ff7 --- /dev/null +++ b/src/iceberg/test/spdlog_logger_test.cc @@ -0,0 +1,106 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// Internal/build-generated header is acceptable in a test TU (not installed). +#include "iceberg/logging/config.h" + +#ifdef ICEBERG_HAS_SPDLOG + +# include +# include +# include +# include +# include + +# include +# include +# include + +# include "iceberg/logging/internal/spdlog_logger.h" +# include "iceberg/logging/log_level.h" +# include "iceberg/logging/logger.h" + +namespace iceberg { + +namespace { + +LogMessage MakeMessage(LogLevel level, std::string text) { + return LogMessage{.level = level, + .message = std::move(text), + .location = std::source_location::current(), + .attributes = {}}; +} + +internal::SpdLogger MakeCapturing(std::ostringstream& out, + LogLevel level = LogLevel::kTrace) { + auto sink = std::make_shared(out); + auto spd = std::make_shared("test", sink); + return internal::SpdLogger(spd, level); +} + +} // namespace + +TEST(SpdLoggerTest, DefaultLevelIsInfo) { + internal::SpdLogger logger; + EXPECT_EQ(logger.level(), LogLevel::kInfo); + EXPECT_FALSE(logger.ShouldLog(LogLevel::kDebug)); + EXPECT_TRUE(logger.ShouldLog(LogLevel::kError)); +} + +TEST(SpdLoggerTest, ForwardsMessageToSink) { + std::ostringstream out; + auto logger = MakeCapturing(out); + logger.Log(MakeMessage(LogLevel::kError, "boom 42")); + logger.Flush(); + EXPECT_NE(out.str().find("boom 42"), std::string::npos); +} + +TEST(SpdLoggerTest, MessageBracesAreNotInterpreted) { + std::ostringstream out; + auto logger = MakeCapturing(out); + // A pre-formatted message containing braces must pass through verbatim. + logger.Log(MakeMessage(LogLevel::kInfo, "literal {not a placeholder}")); + logger.Flush(); + EXPECT_NE(out.str().find("literal {not a placeholder}"), std::string::npos); +} + +TEST(SpdLoggerTest, CriticalAndFatalBothEmit) { + std::ostringstream out; + auto logger = MakeCapturing(out); + logger.Log(MakeMessage(LogLevel::kCritical, "crit")); + logger.Log(MakeMessage(LogLevel::kFatal, "fatal-tag")); + logger.Flush(); + EXPECT_NE(out.str().find("crit"), std::string::npos); + EXPECT_NE(out.str().find("fatal-tag"), std::string::npos); +} + +TEST(SpdLoggerTest, PatternPropertyChangesLayout) { + std::ostringstream out; + auto logger = MakeCapturing(out); + auto status = + logger.Initialize({{std::string(kPatternProperty), std::string("PFX %v")}}); + ASSERT_TRUE(status.has_value()); + logger.Log(MakeMessage(LogLevel::kError, "hello")); + logger.Flush(); + EXPECT_NE(out.str().find("PFX hello"), std::string::npos); +} + +} // namespace iceberg + +#endif // ICEBERG_HAS_SPDLOG