Windows下C++打印堆栈

搜索了下在Windows下C++打印堆栈的相关资料，发现很多都是类似，且方法比较复杂，因此自己封装了一个接口。主要用到了CaptureStackBackTrace，SymFromAddr，SymGetLineFromAddr64这三个接口。CaptureStackBackTrace用于获取当前堆栈，SymFromAddr用于获取符号信息，SymGetLineFromAddr64用于获取文件和行号信息。

header.h

/// @brief 获取当前调用堆栈
/// @details 默认获取堆栈深度为5层。\n
///    https://msdn.microsoft.com/en-us/library/windows/desktop/ms680578(v=vs.85).aspx \n
///    在MSDN示例代码中获取文件行号信息需要设置SymSetOptions(SYMOPT_LOAD_LINES)，\n
///    并强调只有在设置这个参数后才能检索到文件行号信息。\n
///    但本人在测试过程中，未设置该参数，仍然能获取到行号信息，因此在代码中屏蔽了该设置。\n
///    如果需要设置该参数，要注意SymSetOptions并不是线程安全的，要注意同步问题。\n
///    参见 https://msdn.microsoft.com/en-us/library/windows/desktop/ms681366(v=vs.85).aspx \n里面说明：\n
///    所有的DbgHelp接口，正如SymSetOptions，是单线程的。因此，多线程调用这个接口，\n
///    将很可能导致预料外的行为或者内存异常。为了避免这个问题，在多线程调用这个接口的时候要进行同步处理。\n
/// @warning 需要注意多线程问题。

string TraceStack();

source.cpp

string TraceStack()
{
	static const int MAX_STACK_FRAMES = 5;
	
	void *pStack[MAX_STACK_FRAMES];

	HANDLE process = GetCurrentProcess();
	SymInitialize(process, NULL, TRUE);
	WORD frames = CaptureStackBackTrace(0, MAX_STACK_FRAMES, pStack, NULL);

	std::ostringstream oss;
	oss << "stack traceback: " << std::endl;
	for (WORD i = 0; i < frames; ++i) {
		DWORD64 address = (DWORD64)(pStack[i]);

		DWORD64 displacementSym = 0;
		char buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR)];
		PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)buffer;
		pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
		pSymbol->MaxNameLen = MAX_SYM_NAME;

		DWORD displacementLine = 0;
		IMAGEHLP_LINE64 line;
		//SymSetOptions(SYMOPT_LOAD_LINES);
		line.SizeOfStruct = sizeof(IMAGEHLP_LINE64);

		if (SymFromAddr(process, address, &displacementSym, pSymbol)
		 && SymGetLineFromAddr64(process, address, &displacementLine, &line)) {
			oss << "\t" << pSymbol->Name << " at " << line.FileName << ":" << line.LineNumber << "(0x" << std::hex << pSymbol->Address << std::dec << ")" << std::endl;
		}
		else {
			oss << "\terror: " << GetLastError() << std::endl;
		}
	}
	return oss.str();
}

Windows下C++打印堆栈

猜你喜欢