121 lines
5.5 KiB
C++
121 lines
5.5 KiB
C++
/*
|
|
* Copyright (C) 2017-2020 Apple Inc. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <wtf/CryptographicallyRandomNumber.h>
|
|
#include <wtf/Logger.h>
|
|
|
|
namespace WTF {
|
|
|
|
class LoggerHelper {
|
|
public:
|
|
virtual ~LoggerHelper() = default;
|
|
|
|
virtual const Logger& logger() const = 0;
|
|
virtual const char* logClassName() const = 0;
|
|
virtual WTFLogChannel& logChannel() const = 0;
|
|
virtual const void* logIdentifier() const = 0;
|
|
|
|
#if !RELEASE_LOG_DISABLED
|
|
|
|
#define LOGIDENTIFIER WTF::Logger::LogSiteIdentifier(logClassName(), __func__, logIdentifier())
|
|
|
|
#if VERBOSE_RELEASE_LOG
|
|
#define ALWAYS_LOG(...) logger().logAlwaysVerbose(logChannel(), __FILE__, __func__, __LINE__, __VA_ARGS__)
|
|
#define ERROR_LOG(...) logger().errorVerbose(logChannel(), __FILE__, __func__, __LINE__, __VA_ARGS__)
|
|
#define WARNING_LOG(...) logger().warningVerbose(logChannel(), __FILE__, __func__, __LINE__, __VA_ARGS__)
|
|
#define INFO_LOG(...) logger().infoVerbose(logChannel(), __FILE__, __func__, __LINE__, __VA_ARGS__)
|
|
#define DEBUG_LOG(...) logger().debugVerbose(logChannel(), __FILE__, __func__, __LINE__, __VA_ARGS__)
|
|
#else
|
|
#define ALWAYS_LOG(...) logger().logAlways(logChannel(), __VA_ARGS__)
|
|
#define ERROR_LOG(...) logger().error(logChannel(), __VA_ARGS__)
|
|
#define WARNING_LOG(...) logger().warning(logChannel(), __VA_ARGS__)
|
|
#define INFO_LOG(...) logger().info(logChannel(), __VA_ARGS__)
|
|
#define DEBUG_LOG(...) logger().debug(logChannel(), __VA_ARGS__)
|
|
#endif
|
|
|
|
#define WILL_LOG(_level_) logger().willLog(logChannel(), _level_)
|
|
|
|
#define ALWAYS_LOG_IF(condition, ...) if (condition) ALWAYS_LOG(__VA_ARGS__)
|
|
#define ERROR_LOG_IF(condition, ...) if (condition) ERROR_LOG(__VA_ARGS__)
|
|
#define WARNING_LOG_IF(condition, ...) if (condition) WARNING_LOG(__VA_ARGS__)
|
|
#define INFO_LOG_IF(condition, ...) if (condition) INFO_LOG(__VA_ARGS__)
|
|
#define DEBUG_LOG_IF(condition, ...) if (condition) DEBUG_LOG(__VA_ARGS__)
|
|
|
|
#define ALWAYS_LOG_IF_POSSIBLE(...) if (loggerPtr()) loggerPtr()->logAlways(logChannel(), __VA_ARGS__)
|
|
#define ERROR_LOG_IF_POSSIBLE(...) if (loggerPtr()) loggerPtr()->error(logChannel(), __VA_ARGS__)
|
|
#define WARNING_LOG_IF_POSSIBLE(...) if (loggerPtr()) loggerPtr()->warning(logChannel(), __VA_ARGS__)
|
|
#define INFO_LOG_IF_POSSIBLE(...) if (loggerPtr()) loggerPtr()->info(logChannel(), __VA_ARGS__)
|
|
#define DEBUG_LOG_IF_POSSIBLE(...) if (loggerPtr()) loggerPtr()->debug(logChannel(), __VA_ARGS__)
|
|
#define WILL_LOG_IF_POSSIBLE(_level_) if (loggerPtr()) loggerPtr()->willLog(logChannel(), _level_)
|
|
|
|
static const void* childLogIdentifier(const void* parentIdentifier, uint64_t childIdentifier)
|
|
{
|
|
static constexpr uint64_t parentMask = 0xffffffffffff0000ull;
|
|
static constexpr uint64_t maskLowerWord = 0xffffull;
|
|
return reinterpret_cast<const void*>((bitwise_cast<uintptr_t>(parentIdentifier) & parentMask) | (childIdentifier & maskLowerWord));
|
|
}
|
|
|
|
static const void* uniqueLogIdentifier()
|
|
{
|
|
uint64_t highWord = cryptographicallyRandomNumber();
|
|
uint64_t lowWord = cryptographicallyRandomNumber();
|
|
return reinterpret_cast<const void*>((highWord << 32) + lowWord);
|
|
}
|
|
#else // RELEASE_LOG_DISABLED
|
|
|
|
#define LOGIDENTIFIER (std::nullopt)
|
|
|
|
#define ALWAYS_LOG(channelName, ...) (UNUSED_PARAM(channelName))
|
|
#define ERROR_LOG(channelName, ...) (UNUSED_PARAM(channelName))
|
|
#define WARNING_LOG(channelName, ...) (UNUSED_PARAM(channelName))
|
|
#define NOTICE_LOG(channelName, ...) (UNUSED_PARAM(channelName))
|
|
#define INFO_LOG(channelName, ...) (UNUSED_PARAM(channelName))
|
|
#define DEBUG_LOG(channelName, ...) (UNUSED_PARAM(channelName))
|
|
#define WILL_LOG(_level_) false
|
|
|
|
#define ALWAYS_LOG_IF(condition, ...) ((void)0)
|
|
#define ERROR_LOG_IF(condition, ...) ((void)0)
|
|
#define WARNING_LOG_IF(condition, ...) ((void)0)
|
|
#define INFO_LOG_IF(condition, ...) ((void)0)
|
|
#define DEBUG_LOG_IF(condition, ...) ((void)0)
|
|
|
|
#define ALWAYS_LOG_IF_POSSIBLE(...) ((void)0)
|
|
#define ERROR_LOG_IF_POSSIBLE(...) ((void)0)
|
|
#define WARNING_LOG_IF_POSSIBLE(...) ((void)0)
|
|
#define INFO_LOG_IF_POSSIBLE(...) ((void)0)
|
|
#define DEBUG_LOG_IF_POSSIBLE(...) ((void)0)
|
|
#define WILL_LOG_IF_POSSIBLE(_level_) ((void)0)
|
|
|
|
#endif // RELEASE_LOG_DISABLED
|
|
|
|
};
|
|
|
|
} // namespace WTF
|
|
|
|
using WTF::LoggerHelper;
|
|
|