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
|
/*
* Copyright (C) 2017-2020 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "shared/test/unit_test/helpers/memory_management.h"
#include "gtest/gtest.h"
#include <atomic>
#include <cassert>
#include <cinttypes>
#include <cstdlib>
#include <cstring>
#include <exception>
#include <iostream>
#include <new>
#if defined(__linux__)
#include <cstdio>
#include <dlfcn.h>
#include <execinfo.h>
#elif defined(_WIN32)
#include <Windows.h>
#include <DbgHelp.h>
#endif
namespace MemoryManagement {
size_t failingAllocation = -1;
std::atomic<size_t> numAllocations(0);
std::atomic<size_t> indexAllocation(0);
std::atomic<size_t> indexDeallocation(0);
bool logTraces = false;
bool fastLeakDetectionEnabled = false;
AllocationEvent eventsAllocated[maxEvents];
AllocationEvent eventsDeallocated[maxEvents];
void *fastEventsAllocated[maxEvents];
void *fastEventsDeallocated[maxEvents];
std::atomic<int> fastEventsAllocatedCount(0);
std::atomic<int> fastEventsDeallocatedCount(0);
std::atomic<int> fastLeaksDetectionMode(LeakDetectionMode::STANDARD);
size_t breakOnAllocationEvent = -1;
size_t breakOnDeallocationEvent = -1;
bool detailedAllocationLoggingActive = false;
// limit size of single allocation in ULT
const size_t maxAllowedAllocationSize = 128 * 1024 * 1024 + 4096;
static void onAllocationEvent() {
/*
//switch to true to turn on dillignet breakpoint setting place
bool setBreakPointHereForLeaks = false;
if (setBreakPointHereForLeaks) {
if (breakOnAllocationEvent == indexAllocation.load()) {
//set breakpoint on line below
setBreakPointHereForLeaks = false;
}
}*/
}
static void onDeallocationEvent(void *) {
/*
//switch to true to turn on dillignet breakpoint setting place
bool setBreakPointHereForLeaks = false;
if (setBreakPointHereForLeaks) {
if (breakOnDeallocationEvent == indexDeallocation.load()) {
//set breakpoint on line below
setBreakPointHereForLeaks = false;
}
}*/
}
void (*deleteCallback)(void *) = onDeallocationEvent;
template <AllocationEvent::EventType typeValid, AllocationEvent::EventType typeFail>
static void *allocate(size_t size) {
onAllocationEvent();
if (size > maxAllowedAllocationSize) {
return nullptr;
}
if (!fastLeakDetectionEnabled) {
return malloc(size);
}
void *p;
if (detailedAllocationLoggingActive) {
auto indexAllocation = MemoryManagement::indexAllocation.fetch_add(1);
indexAllocation %= maxEvents;
auto &eventAllocation = eventsAllocated[indexAllocation];
eventAllocation.size = size;
while ((p = malloc(size)) == nullptr) {
eventAllocation.address = p;
eventAllocation.event = typeFail;
throw std::bad_alloc();
}
eventAllocation.address = p;
eventAllocation.event = typeValid;
#if defined(__linux__)
eventAllocation.frames = logTraces ? backtrace(eventAllocation.callstack, AllocationEvent::CallStackSize) : 0;
#elif defined(_WIN32)
eventAllocation.frames = logTraces ? CaptureStackBackTrace(0, AllocationEvent::CallStackSize, eventAllocation.callstack, NULL) : 0;
#else
eventAllocation.frames = 0;
#endif
eventAllocation.fastLeakDetectionEnabled = fastLeakDetectionEnabled;
numAllocations++;
} else {
p = malloc(size);
}
if (fastLeakDetectionEnabled && p && fastLeaksDetectionMode == LeakDetectionMode::STANDARD) {
auto currentIndex = fastEventsAllocatedCount++;
fastEventsAllocated[currentIndex] = p;
assert(currentIndex <= fastEvents);
}
return p;
}
template <AllocationEvent::EventType typeValid, AllocationEvent::EventType typeFail>
static void *allocate(size_t size, const std::nothrow_t &) {
onAllocationEvent();
if (size > maxAllowedAllocationSize) {
return nullptr;
}
if (!fastLeakDetectionEnabled) {
return malloc(size);
}
void *p;
if (detailedAllocationLoggingActive) {
auto indexAllocation = MemoryManagement::indexAllocation.fetch_add(1);
indexAllocation %= maxEvents;
p = indexAllocation == failingAllocation
? nullptr
: malloc(size);
auto &eventAllocation = eventsAllocated[indexAllocation];
eventAllocation.event = p
? typeValid
: typeFail;
eventAllocation.address = p;
eventAllocation.size = size;
#if defined(__linux__)
eventAllocation.frames = logTraces ? backtrace(eventAllocation.callstack, AllocationEvent::CallStackSize) : 0;
#elif defined(_WIN32)
eventAllocation.frames = logTraces ? CaptureStackBackTrace(0, AllocationEvent::CallStackSize, eventAllocation.callstack, NULL) : 0;
#else
eventAllocation.frames = 0;
#endif
eventAllocation.fastLeakDetectionEnabled = fastLeakDetectionEnabled;
numAllocations += p ? 1 : 0;
} else {
p = malloc(size);
}
if (fastLeakDetectionEnabled && p && fastLeaksDetectionMode == LeakDetectionMode::STANDARD) {
auto currentIndex = fastEventsAllocatedCount++;
fastEventsAllocated[currentIndex] = p;
assert(currentIndex <= fastEvents);
}
return p;
}
template <AllocationEvent::EventType typeValid>
static void deallocate(void *p) {
deleteCallback(p);
if (!fastLeakDetectionEnabled) {
free(p);
return;
}
if (p) {
if (detailedAllocationLoggingActive) {
auto indexDeallocation = MemoryManagement::indexDeallocation.fetch_add(1);
indexDeallocation %= maxEvents;
--numAllocations;
auto &eventDeallocation = eventsDeallocated[indexDeallocation];
eventDeallocation.event = typeValid;
eventDeallocation.address = p;
eventDeallocation.size = -1;
#if defined(__linux__)
eventDeallocation.frames = logTraces ? backtrace(eventDeallocation.callstack, AllocationEvent::CallStackSize) : 0;
#elif defined(_WIN32)
eventDeallocation.frames = logTraces ? CaptureStackBackTrace(0, AllocationEvent::CallStackSize, eventDeallocation.callstack, NULL) : 0;
#else
eventDeallocation.frames = 0;
#endif
eventDeallocation.fastLeakDetectionEnabled = fastLeakDetectionEnabled;
}
free(p);
if (fastLeakDetectionEnabled && p && fastLeaksDetectionMode == LeakDetectionMode::STANDARD) {
auto currentIndex = fastEventsDeallocatedCount++;
fastEventsDeallocated[currentIndex] = p;
assert(currentIndex <= fastEvents);
}
}
}
int detectLeaks() {
int indexLeak = -1;
for (int allocationIndex = 0u; allocationIndex < fastEventsAllocatedCount; allocationIndex++) {
auto &eventAllocation = fastEventsAllocated[allocationIndex];
int deallocationIndex = 0u;
for (; deallocationIndex < fastEventsDeallocatedCount; deallocationIndex++) {
if (fastEventsDeallocated[deallocationIndex] == nullptr) {
continue;
}
if (fastEventsDeallocated[deallocationIndex] == eventAllocation) {
fastEventsDeallocated[deallocationIndex] = nullptr;
break;
}
}
if (deallocationIndex == fastEventsDeallocatedCount) {
indexLeak = allocationIndex;
break;
}
}
return indexLeak;
}
size_t enumerateLeak(size_t indexAllocationTop, size_t indexDeallocationTop, bool lookFromBack, bool requireCallStack) {
using MemoryManagement::AllocationEvent;
using MemoryManagement::eventsAllocated;
using MemoryManagement::eventsDeallocated;
static auto start = MemoryManagement::invalidLeakIndex;
auto newIndex = start == MemoryManagement::invalidLeakIndex ? 0 : start;
bool potentialLeak = false;
auto potentialLeakIndex = newIndex;
for (; newIndex < indexAllocationTop; ++newIndex) {
auto currentIndex = lookFromBack ? indexAllocationTop - newIndex - 1 : newIndex;
auto &eventAllocation = eventsAllocated[currentIndex];
if (requireCallStack && eventAllocation.frames == 0) {
continue;
}
if (eventAllocation.event != AllocationEvent::EVENT_UNKNOWN) {
// Should be some sort of allocation
size_t deleteIndex = 0;
for (; deleteIndex < indexDeallocationTop; ++deleteIndex) {
auto &eventDeallocation = eventsDeallocated[deleteIndex];
if (eventDeallocation.address == eventAllocation.address &&
eventDeallocation.event != AllocationEvent::EVENT_UNKNOWN) {
//this memory was once freed, now it is allocated but not freed
if (requireCallStack && eventDeallocation.frames == 0) {
potentialLeak = true;
potentialLeakIndex = currentIndex;
continue;
}
// Clear the NEW and DELETE event.
eventAllocation.event = AllocationEvent::EVENT_UNKNOWN;
eventDeallocation.event = AllocationEvent::EVENT_UNKNOWN;
potentialLeak = false;
// Found a corresponding match
break;
}
}
if (potentialLeak) {
return potentialLeakIndex;
}
if (deleteIndex == indexDeallocationTop) {
start = newIndex + 1;
return currentIndex;
}
}
}
start = MemoryManagement::invalidLeakIndex;
return start;
}
std::string printCallStack(const MemoryManagement::AllocationEvent &event) {
std::string result = "";
printf("printCallStack.%d\n", event.frames);
if (!MemoryManagement::captureCallStacks) {
printf("for detailed stack information turn on captureCallStacks in memory_management.h\n");
}
if (event.frames > 0) {
#if defined(__linux__)
char **bt = backtrace_symbols(event.callstack, event.frames);
char *demangled;
int status;
char output[1024];
Dl_info info;
result += "\n";
for (int i = 0; i < event.frames; ++i) {
dladdr(event.callstack[i], &info);
if (info.dli_sname) {
demangled = nullptr;
status = -1;
if (info.dli_sname[0] == '_') {
demangled = abi::__cxa_demangle(info.dli_sname, nullptr, 0, &status);
}
snprintf(output, sizeof(output), "%-3d %*p %s + %zd\n",
(event.frames - i - 1), (int)(sizeof(void *) + 2), event.callstack[i],
status == 0 ? demangled : info.dli_sname == 0 ? bt[i] : info.dli_sname,
(char *)event.callstack[i] - (char *)info.dli_saddr);
free(demangled);
} else {
snprintf(output, sizeof(output), "%-3d %*p %s\n",
(event.frames - i - 1), (int)(sizeof(void *) + 2), event.callstack[i], bt[i]);
}
result += std::string(output);
}
result += "\n";
free(bt);
#elif defined(_WIN32)
SYMBOL_INFO *symbol;
HANDLE process;
process = GetCurrentProcess();
SymInitialize(process, NULL, TRUE);
symbol = (SYMBOL_INFO *)calloc(sizeof(SYMBOL_INFO) + 256 * sizeof(char), 1);
symbol->MaxNameLen = 255;
symbol->SizeOfStruct = sizeof(SYMBOL_INFO);
for (int i = 0; i < event.frames; i++) {
SymFromAddr(process, (DWORD64)(event.callstack[i]), 0, symbol);
printf("%i: %s - 0x%0" PRIx64 "\n", event.frames - i - 1, symbol->Name, symbol->Address);
}
free(symbol);
#endif
}
return result;
}
} // namespace MemoryManagement
using MemoryManagement::allocate;
using MemoryManagement::AllocationEvent;
using MemoryManagement::deallocate;
#if defined(_WIN32)
#pragma warning(disable : 4290)
#endif
void *operator new(size_t size) {
return allocate<AllocationEvent::EVENT_NEW, AllocationEvent::EVENT_NEW_FAIL>(size);
}
void *operator new(size_t size, const std::nothrow_t &) noexcept {
return allocate<AllocationEvent::EVENT_NEW_NOTHROW, AllocationEvent::EVENT_NEW_NOTHROW_FAIL>(size, std::nothrow);
}
void *operator new[](size_t size) {
return allocate<AllocationEvent::EVENT_NEW_ARRAY, AllocationEvent::EVENT_NEW_ARRAY_FAIL>(size);
}
void *operator new[](size_t size, const std::nothrow_t &t) noexcept {
return allocate<AllocationEvent::EVENT_NEW_ARRAY_NOTHROW, AllocationEvent::EVENT_NEW_ARRAY_NOTHROW_FAIL>(size, std::nothrow);
}
void operator delete(void *p) noexcept {
deallocate<AllocationEvent::EVENT_DELETE>(p);
}
void operator delete[](void *p) noexcept {
deallocate<AllocationEvent::EVENT_DELETE_ARRAY>(p);
}
void operator delete(void *p, size_t size) noexcept {
deallocate<AllocationEvent::EVENT_DELETE>(p);
}
void operator delete[](void *p, size_t size) noexcept {
deallocate<AllocationEvent::EVENT_DELETE_ARRAY>(p);
}
|