Public Member Functions
	debug_ring (vcpuid::type vcpuid) noexcept

virtual	~debug_ring () noexcept=default

virtual void	write (const std::string &str) noexcept

Detailed Description

Debug Ring

The debug ring is a simple debug facility that allows the vmm to write string data into a ring buffer while a reader that has shared access to the same buffer can read from the debug ring to extract the strings that are written to the buffer.

Definition at line 38 of file debug_ring.h.

Constructor & Destructor Documentation

◆ debug_ring()

debug_ring::debug_ring ( vcpuid::type vcpuid )

noexcept

Default Constructor

Precondition: expects: none

Postcondition: ensures: none

Definition at line 59 of file debug_ring.cpp.

◆ ~debug_ring()

virtual debug_ring::~debug_ring ( )

virtualdefaultnoexcept

Debug Ring Destructor

Precondition: expects: none

Postcondition: ensures: none

Member Function Documentation

◆ write()

void debug_ring::write ( const std::string & str )

virtualnoexcept

Write to Debug Ring

Writes a string to the debug ring. If the string is larger than the debug ring's internal buffer, the write will fail. If the debug ring is full, the write will keep removing existing strings in the buffer until enough space is made, to add the string.

Precondition: expects: none

Postcondition: ensures: none

Parameters

str	the string to write to the debug ring

Definition at line 79 of file debug_ring.cpp.

The documentation for this class was generated from the following files:

/home/user/hypervisor/bfvmm/include/debug_ring/debug_ring.h
/home/user/hypervisor/bfvmm/src/debug_ring/src/debug_ring.cpp