blob: 75a20bddceee5d108d3a032946d234f2dc3ce23b [file] [log] [blame]
/*
* Copyright (C) 2017-2019 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())
#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__)
#define WILL_LOG(_level_) logger().willLog(logChannel(), _level_)
#define ALWAYS_LOG_IF(condition, ...) if (condition) logger().logAlways(logChannel(), __VA_ARGS__)
#define ERROR_LOG_IF(condition, ...) if (condition) logger().error(logChannel(), __VA_ARGS__)
#define WARNING_LOG_IF(condition, ...) if (condition) logger().warning(logChannel(), __VA_ARGS__)
#define INFO_LOG_IF(condition, ...) if (condition) logger().info(logChannel(), __VA_ARGS__)
#define DEBUG_LOG_IF(condition, ...) if (condition) logger().debug(logChannel(), __VA_ARGS__)
const void* childLogIdentifier(uint64_t identifier) const
{
static const int64_t parentMask = 0xffffffffffff0000l;
static const int64_t maskLowerWord = 0xffffl;
return reinterpret_cast<const void*>((reinterpret_cast<uint64_t>(logIdentifier()) & parentMask) | (identifier & maskLowerWord));
}
static const void* uniqueLogIdentifier()
{
static uint64_t logIdentifier = cryptographicallyRandomNumber();
return reinterpret_cast<const void*>(++logIdentifier);
}
#else
#define LOGIDENTIFIER (WTF::nullopt)
#define ALWAYS_LOG(...) ((void)0)
#define ERROR_LOG(...) ((void)0)
#define ERROR_LOG(...) ((void)0)
#define WARNING_LOG(...) ((void)0)
#define NOTICE_LOG(...) ((void)0)
#define INFO_LOG(...) ((void)0)
#define DEBUG_LOG(...) ((void)0)
#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)
#endif
};
} // namespace WTF
using WTF::LoggerHelper;