debug.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef DEBUG_H
#define DEBUG_H
 
#include "cpu.h"
#include <chrono>
#include "core/format.hpp"
 
/* Debugging messages policy:
 * These should be the severities used for direct Debug() calls
 * maximum debugging level should be 10 if really deep, deep
 * debugging is needed.
 * (there is room for exceptions, but you have to have a good cause):
 * 0   - errors or severe warnings
 * 1   - other non-fatal, non-severe warnings
 * 2   - crude progress indicator of functionality
 * 3   - important debugging messages (function entry)
 * 4   - debugging messages (crude loop status, etc.)
 * 5   - detailed debugging information
 * 6.. - extremely detailed spamming
 */

#define Debug(category, level, format_string, ...) do { if ((level) == 0 || _debug_ ## category ## _level >= (level)) DebugPrint(#category, level, fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__)); } while (false)
void DebugPrint(std::string_view category, int level, std::string &&message);
 
extern int _debug_driver_level;
extern int _debug_grf_level;
extern int _debug_map_level;
extern int _debug_misc_level;
extern int _debug_net_level;
extern int _debug_sprite_level;
extern int _debug_oldloader_level;
extern int _debug_yapf_level;
extern int _debug_fontcache_level;
extern int _debug_script_level;
extern int _debug_sl_level;
extern int _debug_gamelog_level;
extern int _debug_desync_level;
extern int _debug_console_level;
#ifdef RANDOM_DEBUG
extern int _debug_random_level;
#endif
 
void DumpDebugFacilityNames(std::back_insert_iterator<std::string> &output_iterator);
using SetDebugStringErrorFunc = void(std::string_view);
void SetDebugString(std::string_view s, SetDebugStringErrorFunc error_func);
std::string GetDebugString();

struct TicToc {
  struct State {
    const std::string_view name;
    const std::optional<uint32_t> max_count;
    uint32_t count = 0;
    uint64_t chrono_sum = 0;
 
    using States = std::vector<State *>;
 
    State(std::string_view name, std::optional<uint32_t> max_count = {}) : name(name), max_count(max_count)
    {
      GetStates().push_back(this);
    }

    ~State()
    {
      /* Container might be already destroyed. */
      if (!GetStates().empty()) std::erase(GetStates(), this);
    }
 
    static States &GetStates()
    {
      thread_local static States s_states;
      return s_states;
    }
 
    void OutputAndReset(const std::string_view prefix = "")
    {
      Debug(misc, 0, "[{}] [{}] {} calls in {} us [avg: {:.1f} us]", prefix, this->name, this->count, this->chrono_sum, this->chrono_sum / static_cast<double>(this->count));
      this->count = 0;
      this->chrono_sum = 0;
    }
  };
 
  State &state;
  std::chrono::high_resolution_clock::time_point chrono_start; 
 
  inline TicToc(State &state) : state(state), chrono_start(std::chrono::high_resolution_clock::now()) { }

  inline ~TicToc()
  {
    this->state.chrono_sum += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - this->chrono_start)).count();
    this->state.count++;
    if (this->state.max_count.has_value() && this->state.count == this->state.max_count.value()) {
      this->state.OutputAndReset("MaxCount");
    }
  }
 
  static void Tick(const std::string_view prefix)
  {
    for (auto state : State::GetStates()) {
      if (state->max_count.has_value() || state->count == 0) continue;
      state->OutputAndReset(prefix);
    }
  }
};
 
void ShowInfoI(std::string_view str);
#define ShowInfo(format_string, ...) ShowInfoI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))
 
std::string GetLogPrefix(bool force = false);
 
void DebugSendRemoteMessages();
void DebugReconsiderSendRemoteMessages();
 
#endif /* DEBUG_H */