1/* Copyright (c) 2013-2020 Jeffrey Pfau
 2 *
 3 * This Source Code Form is subject to the terms of the Mozilla Public
 4 * License, v. 2.0. If a copy of the MPL was not distributed with this
 5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 6#ifndef STACK_TRACE_H
 7#define STACK_TRACE_H
 8
 9#include <mgba-util/common.h>
10
11CXX_GUARD_START
12
13#include <mgba/core/cpu.h>
14#include <mgba/core/log.h>
15#include <mgba-util/vector.h>
16
17struct mDebuggerSymbols;
18
19enum mStackTraceMode {
20	STACK_TRACE_DISABLED = 0,
21	STACK_TRACE_ENABLED = 1,
22	STACK_TRACE_BREAK_ON_RETURN = 2,
23	STACK_TRACE_BREAK_ON_CALL = 4,
24	STACK_TRACE_BREAK_ON_BOTH = STACK_TRACE_BREAK_ON_RETURN | STACK_TRACE_BREAK_ON_CALL
25};
26
27struct mStackFrame {
28	int callSegment;
29	uint32_t callAddress;
30	int entrySegment;
31	uint32_t entryAddress;
32	int frameBaseSegment;
33	uint32_t frameBaseAddress;
34	void* regs;
35	bool finished;
36	bool breakWhenFinished;
37	bool interrupt;
38};
39
40DECLARE_VECTOR(mStackFrames, struct mStackFrame);
41
42struct mStackTrace {
43	struct mStackFrames stack;
44	size_t registersSize;
45
46	void (*formatRegisters)(struct mStackFrame* frame, char* out, size_t* length);
47};
48
49void mStackTraceInit(struct mStackTrace* stack, size_t registersSize);
50void mStackTraceDeinit(struct mStackTrace* stack);
51
52void mStackTraceClear(struct mStackTrace* stack);
53size_t mStackTraceGetDepth(struct mStackTrace* stack);
54struct mStackFrame* mStackTracePush(struct mStackTrace* stack, uint32_t pc, uint32_t destAddress, uint32_t sp, void* regs);
55struct mStackFrame* mStackTracePushSegmented(struct mStackTrace* stack, int pcSegment, uint32_t pc, int destSegment, uint32_t destAddress, int spSegment, uint32_t sp, void* regs);
56struct mStackFrame* mStackTraceGetFrame(struct mStackTrace* stack, uint32_t frame);
57void mStackTraceFormatFrame(struct mStackTrace* stack, struct mDebuggerSymbols* st, uint32_t frame, char* out, size_t* length);
58void mStackTracePop(struct mStackTrace* stack);
59
60CXX_GUARD_END
61
62#endif