Stream.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_STREAM_H
#define SQUID_SRC_DEBUG_STREAM_H
 
#include "base/Here.h"
// XXX should be mem/forward.h once it removes dependencies on typedefs.h
#include "mem/AllocatorProxy.h"
 
#include <iostream>
#undef assert
#include <sstream>
#include <iomanip>
#if defined(assert)
#undef assert
#endif
#if PURIFY
#define assert(EX) ((void)0)
#elif defined(NODEBUG)
#define assert(EX) ((void)0)
#else
#define assert(EX)  ((EX)?((void)0):xassert( # EX , __FILE__, __LINE__))
#endif
 
/* defined debug section limits */
#define MAX_DEBUG_SECTIONS 100
 
/* defined names for Debug Levels */
#define DBG_CRITICAL    0   
#define DBG_IMPORTANT   1   
/* levels 2-8 are still being discussed amongst the developers */
#define DBG_DATA    9   
#define DBG_PARSE_NOTE(x) (opt_parse_cfg_only?0:(x)) 
class DebugMessageHeader;
 
class Debug
{
 
public:
    class Context
    {
    public:
        Context(const int aSectionLevel, const int aLevel);
 
        int section; 
        int level; 
        int sectionLevel; 
 
    private:
        friend class Debug;
        friend class DebugMessageHeader;
 
        void rewind(const int aSection, const int aLevel);
        Context *upper; 
        std::ostringstream buf; 
        bool forceAlert; 
 
        bool waitingForIdle;
    };
 
    static bool Enabled(const int section, const int level)
    {
        return level <= Debug::Levels[section];
    }
 
    static char *debugOptions;
    static char *cache_log;
    static int rotateNumber;
    static int Levels[MAX_DEBUG_SECTIONS];
    static int override_X;
    static bool log_syslog;
 
    // TODO: Convert all helpers to use debugs() and NameThisHelper() APIs.
    static void NameThisHelper(const char *name);
 
    static void NameThisKid(int kidIdentifier);
 
    static void parseOptions(char const *);
 
    static int Level() { return Current ? Current->level : 1; }
    static int SectionLevel() { return Current ? Current->sectionLevel : 1; }
 
    static std::ostringstream &Start(const int section, const int level);
    static void Finish();
 
    static void ForceAlert();
 
    static std::ostream& Extra(std::ostream &);
 
    static void ForgetSaved();
 
    static void PrepareToDie();
 
    static void LogWaitingForIdle();
 
    /* cache_log channel */
 
    static void BanCacheLogUse();
 
    static void UseCacheLog();
 
    static void StopCacheLogUse();
 
    /* stderr channel */
 
    static void EnsureDefaultStderrLevel(int maxDefault);
 
    static void ResetStderrLevel(int maxLevel);
 
    static void SettleStderr();
 
    static bool StderrEnabled();
 
    /* syslog channel */
 
    static void ConfigureSyslog(const char *facility);
 
    static void SettleSyslog();
 
private:
    static void FormatStream(std::ostream &);
    static void LogMessage(const Context &);
 
    static Context *Current; 
};
 
FILE *DebugStream();
 
void ResyncDebugLog(FILE *newDestination);
 
/* Debug stream
 *
 * Unit tests can enable full debugging to stderr for one
 * debug section; to enable this, #define ENABLE_DEBUG_SECTION to the
 * section number before any header
 */
#define debugs(SECTION, LEVEL, CONTENT) \
   do { \
        const int _dbg_level = (LEVEL); \
        if (Debug::Enabled((SECTION), _dbg_level)) { \
            std::ostream &_dbo = Debug::Start((SECTION), _dbg_level); \
            if (_dbg_level > DBG_IMPORTANT) { \
                _dbo << (SECTION) << ',' << _dbg_level << "| " \
                     << Here() << ": "; \
            } \
            _dbo << CONTENT; \
            Debug::Finish(); \
        } \
   } while (/*CONSTCOND*/ 0)
 
std::ostream& ForceAlert(std::ostream& s);
 
/*
 * MYNAME is for use (in rare/special cases) at debug levels 0 and 1
 *
 * debugs(1,1, MYNAME << "WARNING: some message");
 */
#ifdef __PRETTY_FUNCTION__
#define MYNAME __PRETTY_FUNCTION__ << " "
#else
#define MYNAME __func__ << " "
#endif
 
/* some uint8_t do not like streaming control-chars (values 0-31, 127+) */
inline std::ostream& operator <<(std::ostream &os, const uint8_t d)
{
    return (os << (int)d);
}
 
/* Legacy debug function definitions */
void _db_rotate_log(void);
 
#endif /* SQUID_SRC_DEBUG_STREAM_H */