File: SymbolInfo.cpp

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (176 lines) | stat: -rw-r--r-- 4,896 bytes parent folder | download
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
//===--- ImageInspectionWin32.cpp - Win32 image inspection ----------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#include "SymbolInfo.h"

#if defined(_WIN32) && !defined(__CYGWIN__)
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include <Windows.h>
#include <DbgHelp.h>
#include <psapi.h>
#elif SWIFT_STDLIB_HAS_DLADDR
#include <dlfcn.h>
#endif

#include "swift/Runtime/Win32.h"

#include "ImageInspection.h"

using namespace swift;

const char *SymbolInfo::getFilename() const {
#if defined(_WIN32) && !defined(__CYGWIN__)
  return _moduleFileName;
#elif SWIFT_STDLIB_HAS_DLADDR
  return _info.dli_fname;
#else
  return nullptr;
#endif
}

const void *SymbolInfo::getBaseAddress() const {
#if defined(_WIN32) && !defined(__CYGWIN__)
  return _moduleBaseAddress;
#elif SWIFT_STDLIB_HAS_DLADDR
  return _info.dli_fbase;
#else
  return nullptr;
#endif
}

const char *SymbolInfo::getSymbolName() const {
#if defined(_WIN32) && !defined(__CYGWIN__)
  return _symbolName;
#elif SWIFT_STDLIB_HAS_DLADDR
  return _info.dli_sname;
#else
  return nullptr;
#endif
}

const void *SymbolInfo::getSymbolAddress() const {
#if defined(_WIN32) && !defined(__CYGWIN__)
  return _symbolAddress;
#elif SWIFT_STDLIB_HAS_DLADDR
  return _info.dli_saddr;
#else
  return nullptr;
#endif
}

#if defined(_WIN32) && !defined(__CYGWIN__)
struct Win32ModuleInfo {
  const char *name;
  const void *base;
};

// Get the filename and base of the module that contains the specified
// address.  N.B. This returns a `malloc`-ed copy of the filename in the
// Win32ModuleInfo struct; you are responsible for freeing that.
static Win32ModuleInfo moduleInfoFromAddress(const void *address) {
  HMODULE hModule;
  if (GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
                        | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
                         (LPCTSTR)address,
                         &hModule)) {
    MODULEINFO mi;

    if (!GetModuleInformation(GetCurrentProcess(), hModule,
                              &mi, sizeof(mi))) {
      ZeroMemory(&mi, sizeof(mi));
    }

    WCHAR wszBuffer[256];
    LPWSTR pwszFileName = wszBuffer;
    DWORD dwCapacity = sizeof(wszBuffer) / sizeof(*wszBuffer);
    DWORD dwRet = GetModuleFileNameW(hModule, pwszFileName, dwCapacity);

    if (dwRet == dwCapacity) {
      dwCapacity = 512;

      pwszFileName = (LPWSTR)::malloc(sizeof(WCHAR) * dwCapacity);
      while (true) {
        dwRet = GetModuleFileNameW(hModule, pwszFileName, dwCapacity);
        if (dwRet != dwCapacity)
          break;

        dwCapacity *= 2;

        pwszFileName = (LPWSTR)::realloc(pwszFileName,
                                         sizeof(WCHAR) * dwCapacity);
      }
    }

    if (dwRet == 0) {
      if (pwszFileName != wszBuffer)
        ::free(pwszFileName);

      return { ::strdup("<unknown>"), mi.lpBaseOfDll };
    }

    const char *result = _swift_win32_copyUTF8FromWide(pwszFileName);

    if (pwszFileName != wszBuffer)
      ::free((void *)pwszFileName);

    return { result, mi.lpBaseOfDll };
  } else {
    return { ::strdup("<unknown>"), nullptr };
  }
}
#endif

std::optional<SymbolInfo> SymbolInfo::lookup(const void *address) {
#if defined(__wasm__)
  // Currently, Wasm doesn't have a standard stable ABI for exporting address <->
  // symbol table, it's work in progress. Also, there is no API to access such
  // information from Wasm binary side. It's accessible only from host VM.
  // See https://github.com/WebAssembly/tool-conventions/blob/main/DynamicLinking.md
#elif defined(_WIN32) && !defined(__CYGWIN__)
  Win32ModuleInfo moduleInfo = moduleInfoFromAddress(address);
  SYMBOL_INFO_PACKAGE package;
  BOOL bRet;

  package.si.SizeOfStruct = sizeof(SYMBOL_INFO);
  package.si.MaxNameLen = MAX_SYM_NAME;

  _swift_win32_withDbgHelpLibrary([&] (HANDLE hProcess) {
    if (!hProcess) {
      bRet = false;
      return;
    }

    bRet = SymFromAddr(hProcess, reinterpret_cast<const DWORD64>(address),
                       nullptr, &package.si);
  });

  if (bRet) {
    return SymbolInfo((const void *)package.si.Address,
                      ::strdup(package.si.Name),
                      moduleInfo.name,
                      moduleInfo.base);
  } else {
    return SymbolInfo(address,
                      nullptr,
                      moduleInfo.name,
                      moduleInfo.base);
  }
#elif SWIFT_STDLIB_HAS_DLADDR
  SymbolInfo info;
  if (dladdr(address, &info._info)) {
    return info;
  }
#endif

  return {};
}