/usr/lib/gcc/x86_64-linux-gnu/5/include/d/core/sys/windows/stacktrace.d is in libphobos-5-dev 5.5.0-12ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | /**
* ...
*
* Copyright: Copyright Benjamin Thaut 2010 - 2013.
* License: Distributed under the
* $(LINK2 http://www.boost.org/LICENSE_1_0.txt, Boost Software License 1.0).
* (See accompanying file LICENSE)
* Authors: Benjamin Thaut, Sean Kelly
* Source: $(DRUNTIMESRC core/sys/windows/_stacktrace.d)
*/
module core.sys.windows.stacktrace;
version(Windows):
import core.demangle;
import core.runtime;
import core.stdc.stdlib;
import core.stdc.string;
import core.sys.windows.dbghelp;
import core.sys.windows.windows;
//debug=PRINTF;
debug(PRINTF) import core.stdc.stdio;
extern(Windows) void RtlCaptureContext(CONTEXT* ContextRecord);
extern(Windows) DWORD GetEnvironmentVariableA(LPCSTR lpName, LPSTR pBuffer, DWORD nSize);
extern(Windows) alias USHORT function(ULONG FramesToSkip, ULONG FramesToCapture, PVOID *BackTrace, PULONG BackTraceHash) RtlCaptureStackBackTraceFunc;
private __gshared RtlCaptureStackBackTraceFunc RtlCaptureStackBackTrace;
private __gshared immutable bool initialized;
class StackTrace : Throwable.TraceInfo
{
public:
/**
* Constructor
* Params:
* skip = The number of stack frames to skip.
* context = The context to receive the stack trace from. Can be null.
*/
this(size_t skip, CONTEXT* context)
{
if(context is null)
{
version(Win64)
static enum INTERNALFRAMES = 3;
else version(Win32)
static enum INTERNALFRAMES = 2;
skip += INTERNALFRAMES; //skip the stack frames within the StackTrace class
}
else
{
//When a exception context is given the first stack frame is repeated for some reason
version(Win64)
static enum INTERNALFRAMES = 1;
else version(Win32)
static enum INTERNALFRAMES = 1;
skip += INTERNALFRAMES;
}
if( initialized )
m_trace = trace(skip, context);
}
int opApply( scope int delegate(ref const(char[])) dg ) const
{
return opApply( (ref size_t, ref const(char[]) buf)
{
return dg( buf );
});
}
int opApply( scope int delegate(ref size_t, ref const(char[])) dg ) const
{
int result;
foreach( i, e; resolve(m_trace) )
{
if( (result = dg( i, e )) != 0 )
break;
}
return result;
}
override string toString() const
{
string result;
foreach( e; this )
{
result ~= e ~ "\n";
}
return result;
}
/**
* Receive a stack trace in the form of an address list.
* Params:
* skip = How many stack frames should be skipped.
* context = The context that should be used. If null the current context is used.
* Returns:
* A list of addresses that can be passed to resolve at a later point in time.
*/
static ulong[] trace(size_t skip = 0, CONTEXT* context = null)
{
synchronized( typeid(StackTrace) )
{
return traceNoSync(skip, context);
}
}
/**
* Resolve a stack trace.
* Params:
* addresses = A list of addresses to resolve.
* Returns:
* An array of strings with the results.
*/
static char[][] resolve(const(ulong)[] addresses)
{
synchronized( typeid(StackTrace) )
{
return resolveNoSync(addresses);
}
}
private:
ulong[] m_trace;
static ulong[] traceNoSync(size_t skip, CONTEXT* context)
{
auto dbghelp = DbgHelp.get();
if(dbghelp is null)
return []; // dbghelp.dll not available
if(RtlCaptureStackBackTrace !is null && context is null)
{
size_t[63] buffer = void; // On windows xp the sum of "frames to skip" and "frames to capture" can't be greater then 63
auto backtraceLength = RtlCaptureStackBackTrace(cast(ULONG)skip, cast(ULONG)(buffer.length - skip), cast(void**)buffer.ptr, null);
// If we get a backtrace and it does not have the maximum length use it.
// Otherwise rely on tracing through StackWalk64 which is slower but works when no frame pointers are available.
if(backtraceLength > 1 && backtraceLength < buffer.length - skip)
{
debug(PRINTF) printf("Using result from RtlCaptureStackBackTrace\n");
version(Win64)
{
return buffer[0..backtraceLength].dup;
}
else version(Win32)
{
auto result = new ulong[backtraceLength];
foreach(i, ref e; result)
{
e = buffer[i];
}
return result;
}
}
}
HANDLE hThread = GetCurrentThread();
HANDLE hProcess = GetCurrentProcess();
CONTEXT ctxt;
if(context is null)
{
ctxt.ContextFlags = CONTEXT_FULL;
RtlCaptureContext(&ctxt);
}
else
{
ctxt = *context;
}
//x86
STACKFRAME64 stackframe;
with (stackframe)
{
version(X86)
{
enum Flat = ADDRESS_MODE.AddrModeFlat;
AddrPC.Offset = ctxt.Eip;
AddrPC.Mode = Flat;
AddrFrame.Offset = ctxt.Ebp;
AddrFrame.Mode = Flat;
AddrStack.Offset = ctxt.Esp;
AddrStack.Mode = Flat;
}
else version(X86_64)
{
enum Flat = ADDRESS_MODE.AddrModeFlat;
AddrPC.Offset = ctxt.Rip;
AddrPC.Mode = Flat;
AddrFrame.Offset = ctxt.Rbp;
AddrFrame.Mode = Flat;
AddrStack.Offset = ctxt.Rsp;
AddrStack.Mode = Flat;
}
}
version (X86) enum imageType = IMAGE_FILE_MACHINE_I386;
else version (X86_64) enum imageType = IMAGE_FILE_MACHINE_AMD64;
else static assert(0, "unimplemented");
ulong[] result;
size_t frameNum = 0;
// do ... while so that we don't skip the first stackframe
do
{
if( stackframe.AddrPC.Offset == stackframe.AddrReturn.Offset )
{
debug(PRINTF) printf("Endless callstack\n");
break;
}
if(frameNum >= skip)
{
result ~= stackframe.AddrPC.Offset;
}
frameNum++;
}
while (dbghelp.StackWalk64(imageType, hProcess, hThread, &stackframe,
&ctxt, null, null, null, null));
return result;
}
static char[][] resolveNoSync(const(ulong)[] addresses)
{
auto dbghelp = DbgHelp.get();
if(dbghelp is null)
return []; // dbghelp.dll not available
HANDLE hProcess = GetCurrentProcess();
static struct BufSymbol
{
align(1):
IMAGEHLP_SYMBOL64 _base;
TCHAR[1024] _buf;
}
BufSymbol bufSymbol=void;
IMAGEHLP_SYMBOL64* symbol = &bufSymbol._base;
symbol.SizeOfStruct = IMAGEHLP_SYMBOL64.sizeof;
symbol.MaxNameLength = bufSymbol._buf.length;
char[][] trace;
foreach(pc; addresses)
{
if( pc != 0 )
{
char[] res;
if (dbghelp.SymGetSymFromAddr64(hProcess, pc, null, symbol) &&
*symbol.Name.ptr)
{
DWORD disp;
IMAGEHLP_LINE64 line=void;
line.SizeOfStruct = IMAGEHLP_LINE64.sizeof;
if (dbghelp.SymGetLineFromAddr64(hProcess, pc, &disp, &line))
res = formatStackFrame(cast(void*)pc, symbol.Name.ptr,
line.FileName, line.LineNumber);
else
res = formatStackFrame(cast(void*)pc, symbol.Name.ptr);
}
else
res = formatStackFrame(cast(void*)pc);
trace ~= res;
}
}
return trace;
}
static char[] formatStackFrame(void* pc)
{
import core.stdc.stdio : snprintf;
char[2+2*size_t.sizeof+1] buf=void;
immutable len = snprintf(buf.ptr, buf.length, "0x%p", pc);
cast(uint)len < buf.length || assert(0);
return buf[0 .. len].dup;
}
static char[] formatStackFrame(void* pc, char* symName)
{
char[2048] demangleBuf=void;
auto res = formatStackFrame(pc);
res ~= " in ";
const(char)[] tempSymName = symName[0 .. strlen(symName)];
//Deal with dmd mangling of long names
version(DigitalMars) version(Win32)
{
size_t decodeIndex = 0;
tempSymName = decodeDmdString(tempSymName, decodeIndex);
}
res ~= demangle(tempSymName, demangleBuf);
return res;
}
static char[] formatStackFrame(void* pc, char* symName,
in char* fileName, uint lineNum)
{
import core.stdc.stdio : snprintf;
char[11] buf=void;
auto res = formatStackFrame(pc, symName);
res ~= " at ";
res ~= fileName[0 .. strlen(fileName)];
res ~= "(";
immutable len = snprintf(buf.ptr, buf.length, "%u", lineNum);
cast(uint)len < buf.length || assert(0);
res ~= buf[0 .. len];
res ~= ")";
return res;
}
}
// Workaround OPTLINK bug (Bugzilla 8263)
extern(Windows) BOOL FixupDebugHeader(HANDLE hProcess, ULONG ActionCode,
ulong CallbackContext, ulong UserContext)
{
if (ActionCode == CBA_READ_MEMORY)
{
auto p = cast(IMAGEHLP_CBA_READ_MEMORY*)CallbackContext;
if (!(p.addr & 0xFF) && p.bytes == 0x1C &&
// IMAGE_DEBUG_DIRECTORY.PointerToRawData
(*cast(DWORD*)(p.addr + 24) & 0xFF) == 0x20)
{
immutable base = DbgHelp.get().SymGetModuleBase64(hProcess, p.addr);
// IMAGE_DEBUG_DIRECTORY.AddressOfRawData
if (base + *cast(DWORD*)(p.addr + 20) == p.addr + 0x1C &&
*cast(DWORD*)(p.addr + 0x1C) == 0 &&
*cast(DWORD*)(p.addr + 0x20) == ('N'|'B'<<8|'0'<<16|'9'<<24))
{
debug(PRINTF) printf("fixup IMAGE_DEBUG_DIRECTORY.AddressOfRawData\n");
memcpy(p.buf, cast(void*)p.addr, 0x1C);
*cast(DWORD*)(p.buf + 20) = cast(DWORD)(p.addr - base) + 0x20;
*p.bytesread = 0x1C;
return TRUE;
}
}
}
return FALSE;
}
private string generateSearchPath()
{
__gshared string[3] defaultPathList = ["_NT_SYMBOL_PATH",
"_NT_ALTERNATE_SYMBOL_PATH",
"SYSTEMROOT"];
string path;
char[2048] temp;
DWORD len;
foreach( e; defaultPathList )
{
if( (len = GetEnvironmentVariableA( e.ptr, temp.ptr, temp.length )) > 0 )
{
path ~= temp[0 .. len];
path ~= ";";
}
}
path ~= "\0";
return path;
}
shared static this()
{
auto dbghelp = DbgHelp.get();
if( dbghelp is null )
return; // dbghelp.dll not available
auto kernel32Handle = LoadLibraryA( "kernel32.dll" );
if(kernel32Handle !is null)
{
RtlCaptureStackBackTrace = cast(RtlCaptureStackBackTraceFunc) GetProcAddress(kernel32Handle, "RtlCaptureStackBackTrace");
debug(PRINTF)
{
if(RtlCaptureStackBackTrace !is null)
printf("Found RtlCaptureStackBackTrace\n");
}
}
debug(PRINTF)
{
API_VERSION* dbghelpVersion = dbghelp.ImagehlpApiVersion();
printf("DbgHelp Version %d.%d.%d\n", dbghelpVersion.MajorVersion, dbghelpVersion.MinorVersion, dbghelpVersion.Revision);
}
HANDLE hProcess = GetCurrentProcess();
DWORD symOptions = dbghelp.SymGetOptions();
symOptions |= SYMOPT_LOAD_LINES;
symOptions |= SYMOPT_FAIL_CRITICAL_ERRORS;
symOptions |= SYMOPT_DEFERRED_LOAD;
symOptions = dbghelp.SymSetOptions( symOptions );
debug(PRINTF) printf("Search paths: %s\n", generateSearchPath().ptr);
if (!dbghelp.SymInitialize(hProcess, generateSearchPath().ptr, TRUE))
return;
dbghelp.SymRegisterCallback64(hProcess, &FixupDebugHeader, 0);
initialized = true;
}
|