Messages.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
/* DEBUG: section 00    Debug Routines */
 
#ifndef SQUID_SRC_DEBUG_MESSAGES_H
#define SQUID_SRC_DEBUG_MESSAGES_H
 
#include "debug/Stream.h"
 
#include <array>
#include <limits>
 
// XXX: Replace Debug class with namespace and use that namespace here.
 
typedef size_t DebugMessageId;
 
class DebugMessage
{
public:
    bool configured() const { return id > 0; }
 
    bool levelled() const { return level >= 0; }
 
    bool limited() const { return limit < std::numeric_limits<decltype(limit)>::max(); }
 
    int currentLevel(const int defaultLevel) const {
        if (configured()) {
            if (count_++ < limit)
                return level;
            return (level <= DBG_IMPORTANT) ? 3 : 8;
        }
        return defaultLevel;
    }
 
    DebugMessageId id = 0;
 
    /* all these configurable members are ignored unless configured() */
 
    int level = -1;
 
    uint64_t limit = std::numeric_limits<uint64_t>::max();
 
private:
    mutable uint64_t count_ = 0;
};
 
constexpr DebugMessageId DebugMessageIdUpperBound = 73;
 
class DebugMessages
{
public:
    typedef std::array<DebugMessage, DebugMessageIdUpperBound> Storage;
    Storage messages;
};
 
inline DebugMessages *DebugMessagesConfig = nullptr;
 
// Using a template allows us to check message ID range at compile time.
template <DebugMessageId id>
inline int
DebugMessageLevel(const int defaultLevel)
{
    static_assert(id > 0, "debugs() message ID must be positive");
    static_assert(id < DebugMessageIdUpperBound, "debugs() message ID must be smaller than DebugMessageIdUpperBound");
    if (const auto configured = DebugMessagesConfig)
        return (configured->messages)[id].currentLevel(defaultLevel);
    return defaultLevel;
}
 
/* convenience macros for calling DebugMessageLevel */
#define Critical(id) DebugMessageLevel<id>(DBG_CRITICAL)
#define Important(id) DebugMessageLevel<id>(DBG_IMPORTANT)
#define Dbg(id, defaultLevel) DebugMessageLevel<id>(defaultLevel)
 
#endif /* SQUID_SRC_DEBUG_MESSAGES_H */