Handling of printing debug messages. More...

#include "stdafx.h"
#include "core/string_consumer.hpp"
#include "console_func.h"
#include "debug.h"
#include "string_func.h"
#include "fileio_func.h"
#include "settings_type.h"
#include <mutex>
#include "3rdparty/fmt/chrono.h"
#include "network/network_admin.h"
#include "safeguards.h"

Data Structures
struct	QueuedDebugItem
	Element in the queue of debug messages that have to be passed to either NetworkAdminConsole or IConsolePrint. More...

Functions
void	DumpDebugFacilityNames (std::back_insert_iterator< std::string > &output_iterator)
	Dump the available debug facility names in the help text.
void	DebugPrint (Facility facility, Severity severity, std::string &&message)
	Internal function for outputting the debug line.
void	SetDebugString (std::string_view s, SetDebugStringErrorFunc error_func)
	Set debugging levels by parsing the text in s.
std::string	GetDebugString ()
	Print out the current debug-level.
std::string	GetLogPrefix (bool force)
	Get the prefix for logs.
void	DebugSendRemoteMessages ()
	Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop thread to prevent concurrent accesses to both the NetworkAdmin's packet queue as well as IConsolePrint's buffers.
void	DebugReconsiderSendRemoteMessages ()
	Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.

Variables
std::atomic< bool >	_debug_remote_console
	Whether we need to send data to either NetworkAdminConsole or IConsolePrint.
std::mutex	_debug_remote_console_mutex
	Mutex to guard the queue of debug messages for either NetworkAdminConsole or IConsolePrint.
std::vector< QueuedDebugItem >	_debug_remote_console_queue
	Queue for debug messages to be passed to NetworkAdminConsole or IConsolePrint.
std::vector< QueuedDebugItem >	_debug_remote_console_queue_spare
	Spare queue to swap with _debug_remote_console_queue.
EnumIndexArray< Severity, Facility, Facility::End >	_debug_level
	Severity level for each debug facility.
static EnumIndexArray< std::string_view, Facility, Facility::End >	_debug_facilities
	Name for each debug facility.

Detailed Description

Handling of printing debug messages.

Definition in file debug.cpp.

Function Documentation

◆ DebugPrint()

void DebugPrint	(	Facility	facility,
		Severity	severity,
		std::string &&	message )

Internal function for outputting the debug line.

Parameters

facility	The facility category/classification of the debug message.
severity	The severity of the debug level; lower is more likely to be shown.
message	The message to output.

Definition at line 88 of file debug.cpp.

References _debug_facilities, _debug_remote_console, _debug_remote_console_mutex, _debug_remote_console_queue, Autosave, Critical, Desync, FioFOpenFile(), GetLogPrefix(), lock, and Random.

Referenced by StringConsumer::LogError().

◆ DebugReconsiderSendRemoteMessages()

void DebugReconsiderSendRemoteMessages ( )

Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.

The former is when they have enabled console handling whereas the latter depends on the gui.developer setting's value.

This is to be called from the GameLoop thread.

Definition at line 231 of file debug.cpp.

References _debug_remote_console, _settings_client, Automatic, Console, and ServerNetworkAdminSocketHandler::IterateActive().

Referenced by LoadFromConfig(), ServerNetworkAdminSocketHandler::ReceiveAdminUpdateFrequency(), and ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler().

◆ DebugSendRemoteMessages()

void DebugSendRemoteMessages ( )

Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop thread to prevent concurrent accesses to both the NetworkAdmin's packet queue as well as IConsolePrint's buffers.

This is to be called from the GameLoop thread.

Definition at line 207 of file debug.cpp.

References _debug_facilities, _debug_remote_console, _debug_remote_console_mutex, _debug_remote_console_queue, _debug_remote_console_queue_spare, _settings_client, CC_DEBUG, IConsolePrint(), lock, and NetworkAdminConsole().

◆ DumpDebugFacilityNames()

void DumpDebugFacilityNames ( std::back_insert_iterator< std::string > & output_iterator )

Dump the available debug facility names in the help text.

Parameters

output_iterator The iterator to write the string to.

Definition at line 65 of file debug.cpp.

References _debug_facilities, and End.

Referenced by ShowHelp().

◆ GetDebugString()

std::string GetDebugString ( )

Print out the current debug-level.

Just return a string with the values of all the debug categories.

Returns: string with debug-levels

Definition at line 172 of file debug.cpp.

References _debug_facilities, _debug_level, and End.

Referenced by ConDebugLevel().

◆ GetLogPrefix()

std::string GetLogPrefix ( bool force )

Get the prefix for logs.

If show_date_in_logs or force is enabled it returns the date, otherwise it returns an empty string.

Parameters

force Whether to force the prefix on.

Returns: The prefix for logs.

Definition at line 191 of file debug.cpp.

References _settings_client.

Referenced by DebugPrint(), and IConsolePrint().

◆ SetDebugString()

void SetDebugString	(	std::string_view	s,
		SetDebugStringErrorFunc	error_func )

Set debugging levels by parsing the text in s.

For setting individual levels a string like "net=3,grf=6" should be used. If the string starts with a number, the number is used as global debugging level.

Parameters

s	Text describing the wanted debugging levels.
error_func	The function to call if a parse error occurs.

Definition at line 122 of file debug.cpp.

References _debug_facilities, _debug_level, StringConsumer::AnyBytesLeft(), StringConsumer::ReadUntilCharNotIn(), StringConsumer::SkipUntilCharIn(), and StringConsumer::TryReadIntegerBase().

Referenced by ConDebugLevel(), and openttd_main().

Variable Documentation

◆ _debug_facilities

EnumIndexArray<std::string_view, Facility, Facility::End> _debug_facilities

static

Initial value:

                                        = {
  "driver", 
  "grf", 
  "map", 
  "misc", 
  "net", 
  "sprite", 
  "oldloader", 
  "yapf", 
  "fontcache", 
  "script", 
  "sl", 
  "gamelog", 
  "desync", 
  "console", 
  "random", 
}

Name for each debug facility.

Definition at line 43 of file debug.cpp.

Referenced by DebugPrint(), DebugSendRemoteMessages(), DumpDebugFacilityNames(), GetDebugString(), and SetDebugString().

◆ _debug_level

EnumIndexArray<Severity, Facility, Facility::End> _debug_level

Severity level for each debug facility.

Definition at line 40 of file debug.cpp.

Referenced by GetDebugString(), IsVisibleSeverity(), and SetDebugString().

◆ _debug_remote_console

std::atomic<bool> _debug_remote_console

Whether we need to send data to either NetworkAdminConsole or IConsolePrint.

Definition at line 34 of file debug.cpp.

Referenced by DebugPrint(), DebugReconsiderSendRemoteMessages(), and DebugSendRemoteMessages().

◆ _debug_remote_console_mutex

std::mutex _debug_remote_console_mutex

Mutex to guard the queue of debug messages for either NetworkAdminConsole or IConsolePrint.

Definition at line 35 of file debug.cpp.

Referenced by DebugPrint(), and DebugSendRemoteMessages().

◆ _debug_remote_console_queue

std::vector<QueuedDebugItem> _debug_remote_console_queue

Queue for debug messages to be passed to NetworkAdminConsole or IConsolePrint.

Definition at line 36 of file debug.cpp.

Referenced by DebugPrint(), and DebugSendRemoteMessages().

◆ _debug_remote_console_queue_spare

std::vector<QueuedDebugItem> _debug_remote_console_queue_spare

Spare queue to swap with _debug_remote_console_queue.

Definition at line 37 of file debug.cpp.

Referenced by DebugSendRemoteMessages().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ DebugPrint()

◆ DebugReconsiderSendRemoteMessages()

◆ DebugSendRemoteMessages()

◆ DumpDebugFacilityNames()

◆ GetDebugString()

◆ GetLogPrefix()

◆ SetDebugString()

Variable Documentation

◆ _debug_facilities

◆ _debug_level

◆ _debug_remote_console

◆ _debug_remote_console_mutex

◆ _debug_remote_console_queue

◆ _debug_remote_console_queue_spare