#include <config.h>

Inheritance diagram for zth::DefaultConfig:

Classes
struct	Allocator
	Allocator type. More...

Static Public Member Functions
static constexpr struct timespec	MinTimeslice ()
	Minimum time slice before zth::yield() actually yields.

static constexpr struct timespec	TimesliceOverrunReportThreshold ()
	Print an overrun reported when this timeslice is exceeded.

Static Public Attributes
static bool const	Debug
	This is a debug build when set to `true`.

static bool const	EnableAssert
	When `true`, enable zth_assert().

static bool const	EnableFullAssert
	Show failing expression in case of a failed assert.

static bool const	EnableThreads
	Add (Worker) thread support when `true`.

static bool const	EnableDebugPrint
	Actually do print the debug output.

static bool const	SupportDebugPrint
	Add support to enable debug output prints.

static bool const	EnableColorLog = true
	Enable colored output.

static int const	Print_banner = 12
	ANSI color used by zth_dbg(). Printing this category is disabled when set to 0.

static int const	Print_worker = 5

static int const	Print_waiter = 1

static int const	Print_io = 9

static int const	Print_perf = 6

static int const	Print_fiber = 10

static int const	Print_context = 2

static int const	Print_sync = 11

static int const	Print_list = 8

static int const	Print_zmq = 9

static int const	Print_fsm = 14

static int const	Print_thread = 3

static size_t const	DefaultFiberStackSize = 0x20000
	Default fiber stack size in bytes.

static bool const	EnableStackGuard = Debug
	When `true`, enable stack guards.

static bool const	EnableStackWaterMark = Debug
	When `true`, enable stack watermark to detect maximum stack usage.

static bool const	ContextSignals = false
	Take POSIX signal into account when doing a context switch.

static bool const	CheckTimesliceOverrun = Debug
	Check time slice overrun at every context switch.

static bool const	NamedSynchronizer = SupportDebugPrint && Print_sync > 0
	Save names for all zth::Synchronizer instances.

static size_t const	PerfEventBufferSize = 128
	Buffer size for perf events.

static size_t const	PerfEventBufferThresholdToTriggerVCDWrite = PerfEventBufferSize / 2
	Threshold when to force writing out VCD buffer.

static size_t const	PerfVCDFileBuffer = 0x1000
	VCD file buffer in bytes.

static bool const	DoPerfEvent = false
	Record and output perf events.

static bool const	EnablePerfEvent
	Enable (but not necessarily record) perf.

static bool const	PerfSyscall = true
	Also record syscalls by perf.

static bool const	NamedFsm = Debug \|\| (EnableDebugPrint && Print_fsm > 0)
	Use named FSM guards/actions.

static bool const	UseZMQ
	Enable ZeroMQ support.

static bool const	UseLimitedFormatSpecifiers
	Use limited formatting specifiers.

Detailed Description

Definition at line 54 of file config.h.

Member Function Documentation

◆ MinTimeslice()

static constexpr struct timespec zth::DefaultConfig::MinTimeslice ( )

inlinestatic

Minimum time slice before zth::yield() actually yields.

Definition at line 148 of file config.h.

◆ TimesliceOverrunReportThreshold()

static constexpr struct timespec zth::DefaultConfig::TimesliceOverrunReportThreshold ( )

inlinestatic

Print an overrun reported when this timeslice is exceeded.

Definition at line 153 of file config.h.

Member Data Documentation

◆ CheckTimesliceOverrun

bool const zth::DefaultConfig::CheckTimesliceOverrun = Debug

static

Check time slice overrun at every context switch.

Definition at line 159 of file config.h.

◆ ContextSignals

bool const zth::DefaultConfig::ContextSignals = false

static

Take POSIX signal into account when doing a context switch.

Definition at line 145 of file config.h.

◆ Debug

bool const zth::DefaultConfig::Debug

static

Initial value:

=
 
                true

This is a debug build when set to true.

Definition at line 56 of file config.h.

◆ DefaultFiberStackSize

size_t const zth::DefaultConfig::DefaultFiberStackSize = 0x20000

static

Default fiber stack size in bytes.

Definition at line 139 of file config.h.

◆ DoPerfEvent

bool const zth::DefaultConfig::DoPerfEvent = false

static

Record and output perf events.

Definition at line 171 of file config.h.

◆ EnableAssert

bool const zth::DefaultConfig::EnableAssert

static

Initial value:

=
 
                Debug

When true, enable zth_assert().

Definition at line 64 of file config.h.

◆ EnableColorLog

bool const zth::DefaultConfig::EnableColorLog = true

static

Enable colored output.

Definition at line 119 of file config.h.

◆ EnableDebugPrint

bool const zth::DefaultConfig::EnableDebugPrint

static

Initial value:

=
 
                false

Actually do print the debug output.

Needs SupportDebugPrint to be true. Can be overridden by ZTH_CONFIG_ENABLE_DEBUG_PRINT environment variable.

Definition at line 97 of file config.h.

◆ EnableFullAssert

bool const zth::DefaultConfig::EnableFullAssert

static

Initial value:

=
 
                EnableAssert

Show failing expression in case of a failed assert.

Disable to reduce binary size.

Definition at line 75 of file config.h.

◆ EnablePerfEvent

bool const zth::DefaultConfig::EnablePerfEvent

static

Initial value:

=
 
                true

Enable (but not necessarily record) perf.

Definition at line 173 of file config.h.

◆ EnableStackGuard

bool const zth::DefaultConfig::EnableStackGuard = Debug

static

When true, enable stack guards.

Definition at line 141 of file config.h.

◆ EnableStackWaterMark

bool const zth::DefaultConfig::EnableStackWaterMark = Debug

static

When true, enable stack watermark to detect maximum stack usage.

Definition at line 143 of file config.h.

◆ EnableThreads

bool const zth::DefaultConfig::EnableThreads

static

Initial value:

=
 
                false

Add (Worker) thread support when true.

Definition at line 84 of file config.h.

◆ NamedFsm

bool const zth::DefaultConfig::NamedFsm = Debug || (EnableDebugPrint && Print_fsm > 0)

static

Use named FSM guards/actions.

Definition at line 184 of file config.h.

◆ NamedSynchronizer

bool const zth::DefaultConfig::NamedSynchronizer = SupportDebugPrint && Print_sync > 0

static

Save names for all zth::Synchronizer instances.

Definition at line 161 of file config.h.

◆ PerfEventBufferSize

size_t const zth::DefaultConfig::PerfEventBufferSize = 128

static

Buffer size for perf events.

Definition at line 164 of file config.h.

◆ PerfEventBufferThresholdToTriggerVCDWrite

size_t const zth::DefaultConfig::PerfEventBufferThresholdToTriggerVCDWrite = PerfEventBufferSize / 2

static

Threshold when to force writing out VCD buffer.

Definition at line 166 of file config.h.

◆ PerfSyscall

bool const zth::DefaultConfig::PerfSyscall = true

static

Also record syscalls by perf.

Definition at line 181 of file config.h.

◆ PerfVCDFileBuffer

size_t const zth::DefaultConfig::PerfVCDFileBuffer = 0x1000

static

VCD file buffer in bytes.

Definition at line 168 of file config.h.

◆ Print_banner

int const zth::DefaultConfig::Print_banner = 12

static

ANSI color used by zth_dbg(). Printing this category is disabled when set to 0.

Definition at line 125 of file config.h.

◆ Print_context

int const zth::DefaultConfig::Print_context = 2

static

Definition at line 131 of file config.h.

◆ Print_fiber

int const zth::DefaultConfig::Print_fiber = 10

static

Definition at line 130 of file config.h.

◆ Print_fsm

int const zth::DefaultConfig::Print_fsm = 14

static

Definition at line 135 of file config.h.

◆ Print_io

int const zth::DefaultConfig::Print_io = 9

static

Definition at line 128 of file config.h.

◆ Print_list

int const zth::DefaultConfig::Print_list = 8

static

Definition at line 133 of file config.h.

◆ Print_perf

int const zth::DefaultConfig::Print_perf = 6

static

Definition at line 129 of file config.h.

◆ Print_sync

int const zth::DefaultConfig::Print_sync = 11

static

Definition at line 132 of file config.h.

◆ Print_thread

int const zth::DefaultConfig::Print_thread = 3

static

Definition at line 136 of file config.h.

◆ Print_waiter

int const zth::DefaultConfig::Print_waiter = 1

static

Definition at line 127 of file config.h.

◆ Print_worker

int const zth::DefaultConfig::Print_worker = 5

static

Definition at line 126 of file config.h.

◆ Print_zmq

int const zth::DefaultConfig::Print_zmq = 9

static

Definition at line 134 of file config.h.

◆ SupportDebugPrint

bool const zth::DefaultConfig::SupportDebugPrint

static

Initial value:

=
 
                Debug

Add support to enable debug output prints.

The output is only actually printed when EnableDebugPrint is true.

Definition at line 109 of file config.h.

◆ UseLimitedFormatSpecifiers

bool const zth::DefaultConfig::UseLimitedFormatSpecifiers

static

Initial value:

=
 
                false

Use limited formatting specifiers.

Definition at line 195 of file config.h.

◆ UseZMQ

bool const zth::DefaultConfig::UseZMQ

static

Initial value:

=
 
                true

Enable ZeroMQ support.

Definition at line 187 of file config.h.

The documentation for this struct was generated from the following file:

include/libzth/config.h

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ MinTimeslice()

◆ TimesliceOverrunReportThreshold()

Member Data Documentation

◆ CheckTimesliceOverrun

◆ ContextSignals

◆ Debug

◆ DefaultFiberStackSize

◆ DoPerfEvent

◆ EnableAssert

◆ EnableColorLog

◆ EnableDebugPrint

◆ EnableFullAssert

◆ EnablePerfEvent

◆ EnableStackGuard

◆ EnableStackWaterMark

◆ EnableThreads

◆ NamedFsm

◆ NamedSynchronizer

◆ PerfEventBufferSize

◆ PerfEventBufferThresholdToTriggerVCDWrite

◆ PerfSyscall

◆ PerfVCDFileBuffer

◆ Print_banner

◆ Print_context

◆ Print_fiber

◆ Print_fsm

◆ Print_io

◆ Print_list

◆ Print_perf

◆ Print_sync

◆ Print_thread

◆ Print_waiter

◆ Print_worker

◆ Print_zmq

◆ SupportDebugPrint

◆ UseLimitedFormatSpecifiers

◆ UseZMQ