Skip to content

Commit

Permalink
[InstrumentationRuntime] Refactor the API (Part 2/N) (NFCI)
Browse files Browse the repository at this point in the history 
Factor out some common logic used to find the runtime library in a list
of modules.

Differential Revision: https://reviews.llvm.org/D23150

llvm-svn: 278368
  • Loading branch information
@vedantk
vedantk committed Aug 11, 2016
1 parent a4fa2e2 commit 1c23c14
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 89 deletions.
17 changes: 15 additions & 2 deletions lldb/include/lldb/Target/InstrumentationRuntime.h
View file
Expand Up @@ -87,15 +87,28 @@ class InstrumentationRuntime :
m_is_active = IsActive;
}

/// Return a regular expression which can be used to identify a valid version of the runtime library.
virtual const RegularExpression &
GetPatternForRuntimeLibrary() = 0;

/// Check whether \p module_sp corresponds to a valid runtime library.
virtual bool
CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) = 0;

/// Register a breakpoint in the runtime library and perform any other necessary initialization. The runtime library
/// is guaranteed to be loaded.
virtual void
Activate() = 0;

public:

static void
ModulesDidLoad(lldb_private::ModuleList &module_list, Process *process, InstrumentationRuntimeCollection &runtimes);

/// Look for the instrumentation runtime in \p module_list. Register and activate the runtime if this hasn't already
/// been done.
virtual void
ModulesDidLoad(lldb_private::ModuleList &module_list) = 0;
void
ModulesDidLoad(lldb_private::ModuleList &module_list);

bool
IsActive() const
Expand Down
46 changes: 10 additions & 36 deletions lldb/source/Plugins/InstrumentationRuntime/AddressSanitizer/AddressSanitizerRuntime.cpp
View file
Expand Up @@ -12,7 +12,6 @@
#include "lldb/Breakpoint/StoppointCallbackContext.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Core/Module.h"
#include "lldb/Core/ModuleList.h"
#include "lldb/Core/RegularExpression.h"
#include "lldb/Core/PluginInterface.h"
#include "lldb/Core/PluginManager.h"
Expand Down Expand Up @@ -68,46 +67,21 @@ AddressSanitizerRuntime::~AddressSanitizerRuntime()
Deactivate();
}

bool ModuleContainsASanRuntime(Module * module)
const RegularExpression &
AddressSanitizerRuntime::GetPatternForRuntimeLibrary()
{
const Symbol* symbol = module->FindFirstSymbolWithNameAndType(
ConstString("__asan_get_alloc_stack"),
lldb::eSymbolTypeAny);

return symbol != nullptr;
// FIXME: This shouldn't include the "dylib" suffix.
static RegularExpression regex("libclang_rt.asan_(.*)_dynamic\\.dylib");
return regex;
}

void
AddressSanitizerRuntime::ModulesDidLoad(lldb_private::ModuleList &module_list)
bool
AddressSanitizerRuntime::CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp)
{
if (IsActive())
return;

if (GetRuntimeModuleSP()) {
Activate();
return;
}
const Symbol *symbol =
module_sp->FindFirstSymbolWithNameAndType(ConstString("__asan_get_alloc_stack"), lldb::eSymbolTypeAny);

std::lock_guard<std::recursive_mutex> guard(module_list.GetMutex());
const size_t num_modules = module_list.GetSize();
for (size_t i = 0; i < num_modules; ++i)
{
Module *module_pointer = module_list.GetModulePointerAtIndexUnlocked(i);
const FileSpec & file_spec = module_pointer->GetFileSpec();
if (! file_spec)
continue;

static RegularExpression g_asan_runtime_regex("libclang_rt.asan_(.*)_dynamic\\.dylib");
if (g_asan_runtime_regex.Execute (file_spec.GetFilename().GetCString()) || module_pointer->IsExecutable())
{
if (ModuleContainsASanRuntime(module_pointer))
{
SetRuntimeModuleSP(module_pointer->shared_from_this());
Activate();
return;
}
}
}
return symbol != nullptr;
}

#define RETRIEVE_REPORT_DATA_FUNCTION_TIMEOUT_USEC 2*1000*1000
Expand Down
13 changes: 8 additions & 5 deletions lldb/source/Plugins/InstrumentationRuntime/AddressSanitizer/AddressSanitizerRuntime.h
View file
Expand Up @@ -56,15 +56,18 @@ class AddressSanitizerRuntime : public lldb_private::InstrumentationRuntime
return 1;
}

void
ModulesDidLoad(lldb_private::ModuleList &module_list) override;

private:
AddressSanitizerRuntime(const lldb::ProcessSP &process_sp) : lldb_private::InstrumentationRuntime(process_sp) {}

const RegularExpression &
GetPatternForRuntimeLibrary() override;

bool
CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override;

void
Activate();
Activate() override;

void
Deactivate();

Expand Down
56 changes: 14 additions & 42 deletions lldb/source/Plugins/InstrumentationRuntime/ThreadSanitizer/ThreadSanitizerRuntime.cpp
View file
Expand Up @@ -12,7 +12,6 @@
#include "lldb/Breakpoint/StoppointCallbackContext.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Core/Module.h"
#include "lldb/Core/ModuleList.h"
#include "lldb/Core/RegularExpression.h"
#include "lldb/Core/PluginInterface.h"
#include "lldb/Core/PluginManager.h"
Expand Down Expand Up @@ -73,46 +72,6 @@ ThreadSanitizerRuntime::~ThreadSanitizerRuntime()
Deactivate();
}

static bool
ModuleContainsTSanRuntime(ModuleSP module_sp)
{
static ConstString g_tsan_get_current_report("__tsan_get_current_report");
const Symbol* symbol = module_sp->FindFirstSymbolWithNameAndType(g_tsan_get_current_report, lldb::eSymbolTypeAny);
return symbol != nullptr;
}

void
ThreadSanitizerRuntime::ModulesDidLoad(lldb_private::ModuleList &module_list)
{
if (IsActive())
return;

if (GetRuntimeModuleSP()) {
Activate();
return;
}

module_list.ForEach ([this](const lldb::ModuleSP module_sp) -> bool
{
const FileSpec & file_spec = module_sp->GetFileSpec();
if (! file_spec)
return true; // Keep iterating through modules

llvm::StringRef module_basename(file_spec.GetFilename().GetStringRef());
if (module_sp->IsExecutable() || module_basename.startswith("libclang_rt.tsan_"))
{
if (ModuleContainsTSanRuntime(module_sp))
{
SetRuntimeModuleSP(module_sp);
Activate();
return false; // Stop iterating
}
}

return true; // Keep iterating through modules
});
}

#define RETRIEVE_REPORT_DATA_FUNCTION_TIMEOUT_USEC 2*1000*1000

const char *
Expand Down Expand Up @@ -713,6 +672,20 @@ ThreadSanitizerRuntime::NotifyBreakpointHit(void *baton, StoppointCallbackContex
return false; // Let target run
}

const RegularExpression &
ThreadSanitizerRuntime::GetPatternForRuntimeLibrary() {
static RegularExpression regex("libclang_rt.tsan_");
return regex;
}

bool
ThreadSanitizerRuntime::CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp)
{
static ConstString g_tsan_get_current_report("__tsan_get_current_report");
const Symbol *symbol = module_sp->FindFirstSymbolWithNameAndType(g_tsan_get_current_report, lldb::eSymbolTypeAny);
return symbol != nullptr;
}

void
ThreadSanitizerRuntime::Activate()
{
Expand Down Expand Up @@ -768,7 +741,6 @@ ThreadSanitizerRuntime::Deactivate()
}
SetActive(false);
}

static std::string
GenerateThreadName(const std::string &path, StructuredData::Object *o, StructuredData::ObjectSP main_info) {
std::string result = "additional information";
Expand Down
11 changes: 7 additions & 4 deletions lldb/source/Plugins/InstrumentationRuntime/ThreadSanitizer/ThreadSanitizerRuntime.h
View file
Expand Up @@ -56,17 +56,20 @@ class ThreadSanitizerRuntime : public lldb_private::InstrumentationRuntime
return 1;
}

void
ModulesDidLoad(lldb_private::ModuleList &module_list) override;

lldb::ThreadCollectionSP
GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info) override;

private:
ThreadSanitizerRuntime(const lldb::ProcessSP &process_sp) : lldb_private::InstrumentationRuntime(process_sp) {}

const RegularExpression &
GetPatternForRuntimeLibrary() override;

bool
CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override;

void
Activate();
Activate() override;

void
Deactivate();
Expand Down
35 changes: 35 additions & 0 deletions lldb/source/Target/InstrumentationRuntime.cpp
View file
Expand Up @@ -13,7 +13,10 @@
// Project includes
#include "lldb/lldb-private.h"
#include "lldb/Target/Process.h"
#include "lldb/Core/Module.h"
#include "lldb/Core/ModuleList.h"
#include "lldb/Core/PluginManager.h"
#include "lldb/Core/RegularExpression.h"
#include "lldb/Target/InstrumentationRuntime.h"

using namespace lldb;
Expand All @@ -40,6 +43,38 @@ InstrumentationRuntime::ModulesDidLoad(lldb_private::ModuleList &module_list, ll
}
}

void
InstrumentationRuntime::ModulesDidLoad(lldb_private::ModuleList &module_list)
{
if (IsActive())
return;

if (GetRuntimeModuleSP())
{
Activate();
return;
}

module_list.ForEach([this](const lldb::ModuleSP module_sp) -> bool {
const FileSpec &file_spec = module_sp->GetFileSpec();
if (!file_spec)
return true; // Keep iterating.

const RegularExpression &runtime_regex = GetPatternForRuntimeLibrary();
if (runtime_regex.Execute(file_spec.GetFilename().GetCString()) || module_sp->IsExecutable())
{
if (CheckIfRuntimeIsValid(module_sp))
{
SetRuntimeModuleSP(module_sp);
Activate();
return false; // Stop iterating, we're done.
}
}

return true;
});
}

lldb::ThreadCollectionSP
InstrumentationRuntime::GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info)
{
Expand Down

0 comments on commit 1c23c14

Please sign in to comment.