debug_ring_interface.h File Reference

Go to the source code of this file.

Data Structures
struct	debug_ring_resources_t

Typedefs
typedef struct debug_ring_resources_t *(*	get_drr_t) (uint64_t vcpuid)

Functions
uint64_t	debug_ring_read (struct debug_ring_resources_t *drr, char *str, uint64_t len)

Typedef Documentation

get_drr_t

typedef struct debug_ring_resources_t*(* get_drr_t) (uint64_t vcpuid)

Get Debug Ring Resource Typedef

Precondition

expects: none

Postcondition

ensures: none

This is used by the driver entry to as the function signature for getting it's internal debug ring

Definition at line 47 of file debug_ring_interface.h.

Function Documentation

debug_ring_read()

uint64_t debug_ring_read ( struct debug_ring_resources_t *  drr, char *  str, uint64_t  len  )

inline

Debug Ring Read

Reads strings that have been written to the debug ring. Although you can provide any buffer size you want, it's advised to provide a buffer that is the same size as the buffer that was originally allocated.

Precondition

expects: none

Postcondition

ensures: none

Parameters

drr	the debug_ring_resource that was used to create the debug ring
str	the buffer to read the string into. should be the same size as drr in bytes
len	the length of the str buffer in bytes

Returns

the number of bytes read from the debug ring, 0 on error

Definition at line 124 of file debug_ring_interface.h.