mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

replay: add proper kdoc for ReplayState

Browse Source 
Remove the non-standard comment formatting and move the descriptions
into a proper kdoc comment.

Reviewed-by: Pavel Dovgalyuk <Pavel.Dovgalyuk@ispras.ru>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20231211091346.14616-8-alex.bennee@linaro.org>
This commit is contained in:
Alex Bennée 2023-12-11 09:13:36 +00:00
parent 8835ed3293
commit 808eab6241
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
replay/replay-internal.h
View File

@ -63,24 +63,31 @@ enum ReplayEvents {
EVENT_COUNT EVENT_COUNT
}; };
/**
* typedef ReplayState - global tracking Replay state
*
* This structure tracks where we are in the current ReplayState
* including the logged events from the recorded replay stream. Some
* of the data is also stored/restored from VMStateDescription when VM
* save/restore events take place.
*
* @cached_clock: Cached clocks values
* @current_icount: number of processed instructions
* @instruction_count: number of instructions until next event
* @data_kind: current event
* @has_unread_data: 1 if event not yet processed
* @file_offset: offset into replay log at replay snapshot
* @block_request_id: current serialised block request id
* @read_event_id: current async read event id
*/
typedef struct ReplayState { typedef struct ReplayState {
/*! Cached clock values. */
int64_t cached_clock[REPLAY_CLOCK_COUNT]; int64_t cached_clock[REPLAY_CLOCK_COUNT];
/*! Current icount - number of processed instructions. */
uint64_t current_icount; uint64_t current_icount;
/*! Number of instructions to be executed before other events happen. */
int instruction_count; int instruction_count;
/*! Type of the currently executed event. */
unsigned int data_kind; unsigned int data_kind;
/*! Flag which indicates that event is not processed yet. */
unsigned int has_unread_data; unsigned int has_unread_data;
/*! Temporary variable for saving current log offset. */
uint64_t file_offset; uint64_t file_offset;
/*! Next block operation id.
This counter is global, because requests from different
block devices should not get overlapping ids. */
uint64_t block_request_id; uint64_t block_request_id;
/*! Asynchronous event id read from the log */
uint64_t read_event_id; uint64_t read_event_id;
} ReplayState; } ReplayState;
extern ReplayState replay_state; extern ReplayState replay_state;