StackTrace.h File Reference

Describes functionality for performing stack traces. More...

#include <cstddef>

Include dependency graph for StackTrace.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	stacktrace::StackFrame
	Stores information about a single stack frame. More...
Namespaces
namespace	stacktrace
	Holds the C-style interface for the stack trace routines.
Defines
#define	STACKTRACE_USE_BACKTRACE
Typedefs
typedef int	stacktrace::machineInstruction
	typedef in case type needs to change on other platforms (i.e. long for 64 bit architectures?)
Functions
void	stacktrace::getCurrentStackFrame (struct StackFrame *frame)
	stores information about the caller's stack frame into frame
int	stacktrace::unrollStackFrame (struct StackFrame *curFrame, struct StackFrame *nextFrame)
	stores information about the caller to curFrame into nextFrame
void	stacktrace::freeStackTrace (struct StackFrame *frame)
	frees a list of StackFrames, such as is returned by recordStackTrace
struct StackFrame *	stacktrace::allocateStackTrace (unsigned int size)
	preallocates a stack trace of a particular size (doesn't actually perform a stack trace, merely allocates the linked list)
void	stacktrace::displayStackTrace (const struct StackFrame *frame)
	dumps stored stack trace to stderr
void	stacktrace::displayCurrentStackTrace (unsigned int limit=-1U, unsigned int skip=0)
	dumps current stack trace to stderr, up to limit depth and skipping the top skip frames
struct StackFrame *	stacktrace::recordStackTrace (unsigned int limit=-1U, unsigned int skip=0)
	repeatedly calls unrollStackFrame() until the root frame is reached or limit is hit, skipping the top skip frames
struct StackFrame *	stacktrace::recordOverStackTrace (struct StackFrame *frame, unsigned int skip=0)
	repeatedly calls unrollStackFrame() until the root frame is reached or end of frame list is hit, skipping the top skip frames

---

Detailed Description

Describes functionality for performing stack traces.

Author:

ejt (Creator)

Definition in file StackTrace.h.

---

Define Documentation

#define STACKTRACE_USE_BACKTRACE

Definition at line 9 of file StackTrace.h.