1 #pragma once 2 3 #include "bmcweb_config.h" 4 5 #include <bit> 6 #include <format> 7 #include <iostream> 8 #include <source_location> 9 #include <string_view> 10 #include <system_error> 11 12 // NOLINTBEGIN(readability-convert-member-functions-to-static, cert-dcl58-cpp) 13 template <> 14 struct std::formatter<void*> 15 { 16 constexpr auto parse(std::format_parse_context& ctx) 17 { 18 return ctx.begin(); 19 } 20 auto format(const void*& ptr, auto& ctx) const 21 { 22 return std::format_to(ctx.out(), "{}", 23 std::to_string(std::bit_cast<size_t>(ptr))); 24 } 25 }; 26 // NOLINTEND(readability-convert-member-functions-to-static, cert-dcl58-cpp) 27 28 namespace crow 29 { 30 enum class LogLevel 31 { 32 Disabled = 0, 33 Critical, 34 Error, 35 Warning, 36 Info, 37 Debug, 38 Enabled, 39 }; 40 41 // Mapping of the external loglvl name to internal loglvl 42 constexpr std::array<std::string_view, 7> mapLogLevelFromName{ 43 "DISABLED", "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "ENABLED"}; 44 45 constexpr crow::LogLevel getLogLevelFromName(std::string_view name) 46 { 47 const auto* iter = std::ranges::find(mapLogLevelFromName, name); 48 if (iter != mapLogLevelFromName.end()) 49 { 50 return static_cast<LogLevel>(iter - mapLogLevelFromName.begin()); 51 } 52 return crow::LogLevel::Disabled; 53 } 54 55 // configured bmcweb LogLevel 56 constexpr crow::LogLevel bmcwebCurrentLoggingLevel = 57 getLogLevelFromName(BMCWEB_LOGGING_LEVEL); 58 59 template <typename T> 60 const void* logPtr(T p) 61 { 62 static_assert(std::is_pointer<T>::value, 63 "Can't use logPtr without pointer"); 64 return std::bit_cast<const void*>(p); 65 } 66 67 template <LogLevel level, typename... Args> 68 inline void vlog(std::format_string<Args...>&& format, Args&&... args, 69 const std::source_location& loc) noexcept 70 { 71 if constexpr (bmcwebCurrentLoggingLevel < level) 72 { 73 return; 74 } 75 constexpr size_t stringIndex = static_cast<size_t>(level); 76 static_assert(stringIndex < mapLogLevelFromName.size(), 77 "Missing string for level"); 78 constexpr std::string_view levelString = mapLogLevelFromName[stringIndex]; 79 std::string_view filename = loc.file_name(); 80 filename = filename.substr(filename.rfind('/') + 1); 81 std::string logLocation; 82 logLocation = std::format("[{} {}:{}] ", levelString, filename, loc.line()); 83 try 84 { 85 // TODO, multiple static analysis tools flag that this could potentially 86 // throw Based on the documentation, it shouldn't throw, so long as none 87 // of the formatters throw, so unclear at this point why this try/catch 88 // is required, but add it to silence the static analysis tools. 89 logLocation += std::format(std::move(format), 90 std::forward<Args>(args)...); 91 } 92 catch (const std::format_error& /*error*/) 93 { 94 logLocation += "Failed to format"; 95 // Nothing more we can do here if logging is broken. 96 } 97 logLocation += '\n'; 98 // Intentionally ignore error return. 99 fwrite(logLocation.data(), sizeof(std::string::value_type), 100 logLocation.size(), stdout); 101 fflush(stdout); 102 } 103 } // namespace crow 104 105 template <typename... Args> 106 struct BMCWEB_LOG_CRITICAL 107 { 108 // NOLINTNEXTLINE(google-explicit-constructor) 109 BMCWEB_LOG_CRITICAL(std::format_string<Args...> format, Args&&... args, 110 const std::source_location& loc = 111 std::source_location::current()) noexcept 112 { 113 crow::vlog<crow::LogLevel::Critical, Args...>( 114 std::move(format), std::forward<Args>(args)..., loc); 115 } 116 }; 117 118 template <typename... Args> 119 struct BMCWEB_LOG_ERROR 120 { 121 // NOLINTNEXTLINE(google-explicit-constructor) 122 BMCWEB_LOG_ERROR(std::format_string<Args...> format, Args&&... args, 123 const std::source_location& loc = 124 std::source_location::current()) noexcept 125 { 126 crow::vlog<crow::LogLevel::Error, Args...>( 127 std::move(format), std::forward<Args>(args)..., loc); 128 } 129 }; 130 131 template <typename... Args> 132 struct BMCWEB_LOG_WARNING 133 { 134 // NOLINTNEXTLINE(google-explicit-constructor) 135 BMCWEB_LOG_WARNING(std::format_string<Args...> format, Args&&... args, 136 const std::source_location& loc = 137 std::source_location::current()) noexcept 138 { 139 crow::vlog<crow::LogLevel::Warning, Args...>( 140 std::move(format), std::forward<Args>(args)..., loc); 141 } 142 }; 143 144 template <typename... Args> 145 struct BMCWEB_LOG_INFO 146 { 147 // NOLINTNEXTLINE(google-explicit-constructor) 148 BMCWEB_LOG_INFO(std::format_string<Args...> format, Args&&... args, 149 const std::source_location& loc = 150 std::source_location::current()) noexcept 151 { 152 crow::vlog<crow::LogLevel::Info, Args...>( 153 std::move(format), std::forward<Args>(args)..., loc); 154 } 155 }; 156 157 template <typename... Args> 158 struct BMCWEB_LOG_DEBUG 159 { 160 // NOLINTNEXTLINE(google-explicit-constructor) 161 BMCWEB_LOG_DEBUG(std::format_string<Args...> format, Args&&... args, 162 const std::source_location& loc = 163 std::source_location::current()) noexcept 164 { 165 crow::vlog<crow::LogLevel::Debug, Args...>( 166 std::move(format), std::forward<Args>(args)..., loc); 167 } 168 }; 169 170 template <typename... Args> 171 BMCWEB_LOG_CRITICAL(std::format_string<Args...>, Args&&...) 172 -> BMCWEB_LOG_CRITICAL<Args...>; 173 174 template <typename... Args> 175 BMCWEB_LOG_ERROR(std::format_string<Args...>, Args&&...) 176 -> BMCWEB_LOG_ERROR<Args...>; 177 178 template <typename... Args> 179 BMCWEB_LOG_WARNING(std::format_string<Args...>, Args&&...) 180 -> BMCWEB_LOG_WARNING<Args...>; 181 182 template <typename... Args> 183 BMCWEB_LOG_INFO(std::format_string<Args...>, Args&&...) 184 -> BMCWEB_LOG_INFO<Args...>; 185 186 template <typename... Args> 187 BMCWEB_LOG_DEBUG(std::format_string<Args...>, Args&&...) 188 -> BMCWEB_LOG_DEBUG<Args...>; 189