Skip to content

Commit

Permalink
Add msan custom mapping options.
Browse files Browse the repository at this point in the history 
Similarly to https://reviews.llvm.org/D18865 this adds options to provide custom mapping for msan.
As discussed in http://lists.llvm.org/pipermail/llvm-dev/2018-February/121339.html

Patch by vit9696(at)avp.su.

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

llvm-svn: 328830
  • Loading branch information
@eugenis
eugenis committed Mar 29, 2018
1 parent cb668d8 commit 50635da
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 49 deletions.
131 changes: 82 additions & 49 deletions llvm/lib/Transforms/Instrumentation/MemorySanitizer.cpp
View file
Expand Up @@ -234,6 +234,24 @@ static cl::opt<bool> ClWithComdat("msan-with-comdat",
cl::desc("Place MSan constructors in comdat sections"),
cl::Hidden, cl::init(false));

// These options allow to specify custom memory map parameters
// See MemoryMapParams for details.
static cl::opt<unsigned long long> ClAndMask("msan-and-mask",
cl::desc("Define custom MSan AndMask"),
cl::Hidden, cl::init(0));

static cl::opt<unsigned long long> ClXorMask("msan-xor-mask",
cl::desc("Define custom MSan XorMask"),
cl::Hidden, cl::init(0));

static cl::opt<unsigned long long> ClShadowBase("msan-shadow-base",
cl::desc("Define custom MSan ShadowBase"),
cl::Hidden, cl::init(0));

static cl::opt<unsigned long long> ClOriginBase("msan-origin-base",
cl::desc("Define custom MSan OriginBase"),
cl::Hidden, cl::init(0));

static const char *const kMsanModuleCtorName = "msan.module_ctor";
static const char *const kMsanInitName = "__msan_init";

Expand Down Expand Up @@ -449,6 +467,10 @@ class MemorySanitizer : public FunctionPass {
/// \brief Memory map parameters used in application-to-shadow calculation.
const MemoryMapParams *MapParams;

/// \brief Custom memory map parameters used when -msan-shadow-base or
// -msan-origin-base is provided.
MemoryMapParams CustomMapParams;

MDNode *ColdCallWeights;

/// \brief Branch weights for origin store.
Expand Down Expand Up @@ -576,55 +598,66 @@ void MemorySanitizer::initializeCallbacks(Module &M) {
bool MemorySanitizer::doInitialization(Module &M) {
auto &DL = M.getDataLayout();

Triple TargetTriple(M.getTargetTriple());
switch (TargetTriple.getOS()) {
case Triple::FreeBSD:
switch (TargetTriple.getArch()) {
case Triple::x86_64:
MapParams = FreeBSD_X86_MemoryMapParams.bits64;
break;
case Triple::x86:
MapParams = FreeBSD_X86_MemoryMapParams.bits32;
break;
default:
report_fatal_error("unsupported architecture");
}
break;
case Triple::NetBSD:
switch (TargetTriple.getArch()) {
case Triple::x86_64:
MapParams = NetBSD_X86_MemoryMapParams.bits64;
break;
default:
report_fatal_error("unsupported architecture");
}
break;
case Triple::Linux:
switch (TargetTriple.getArch()) {
case Triple::x86_64:
MapParams = Linux_X86_MemoryMapParams.bits64;
break;
case Triple::x86:
MapParams = Linux_X86_MemoryMapParams.bits32;
break;
case Triple::mips64:
case Triple::mips64el:
MapParams = Linux_MIPS_MemoryMapParams.bits64;
break;
case Triple::ppc64:
case Triple::ppc64le:
MapParams = Linux_PowerPC_MemoryMapParams.bits64;
break;
case Triple::aarch64:
case Triple::aarch64_be:
MapParams = Linux_ARM_MemoryMapParams.bits64;
break;
default:
report_fatal_error("unsupported architecture");
}
break;
default:
report_fatal_error("unsupported operating system");
bool ShadowPassed = ClShadowBase.getNumOccurrences() > 0;
bool OriginPassed = ClOriginBase.getNumOccurrences() > 0;
// Check the overrides first
if (ShadowPassed || OriginPassed) {
CustomMapParams.AndMask = ClAndMask;
CustomMapParams.XorMask = ClXorMask;
CustomMapParams.ShadowBase = ClShadowBase;
CustomMapParams.OriginBase = ClOriginBase;
MapParams = &CustomMapParams;
} else {
Triple TargetTriple(M.getTargetTriple());
switch (TargetTriple.getOS()) {
case Triple::FreeBSD:
switch (TargetTriple.getArch()) {
case Triple::x86_64:
MapParams = FreeBSD_X86_MemoryMapParams.bits64;
break;
case Triple::x86:
MapParams = FreeBSD_X86_MemoryMapParams.bits32;
break;
default:
report_fatal_error("unsupported architecture");
}
break;
case Triple::NetBSD:
switch (TargetTriple.getArch()) {
case Triple::x86_64:
MapParams = NetBSD_X86_MemoryMapParams.bits64;
break;
default:
report_fatal_error("unsupported architecture");
}
break;
case Triple::Linux:
switch (TargetTriple.getArch()) {
case Triple::x86_64:
MapParams = Linux_X86_MemoryMapParams.bits64;
break;
case Triple::x86:
MapParams = Linux_X86_MemoryMapParams.bits32;
break;
case Triple::mips64:
case Triple::mips64el:
MapParams = Linux_MIPS_MemoryMapParams.bits64;
break;
case Triple::ppc64:
case Triple::ppc64le:
MapParams = Linux_PowerPC_MemoryMapParams.bits64;
break;
case Triple::aarch64:
case Triple::aarch64_be:
MapParams = Linux_ARM_MemoryMapParams.bits64;
break;
default:
report_fatal_error("unsupported architecture");
}
break;
default:
report_fatal_error("unsupported operating system");
}
}

C = &(M.getContext());
Expand Down
43 changes: 43 additions & 0 deletions llvm/test/Instrumentation/MemorySanitizer/manual-shadow.ll
View file
@@ -0,0 +1,43 @@
; Test that the msan layout customization options work as expected
;
; RUN: opt < %s -msan -msan-shadow-base 3735928559 -S | FileCheck --check-prefix=CHECK-BASE %s
; RUN: opt < %s -msan -msan-shadow-base 3735928559 -msan-and-mask 4294901760 -S | FileCheck --check-prefix=CHECK-AND %s
; RUN: opt < %s -msan -msan-shadow-base 3735928559 -msan-xor-mask 48879 -S | FileCheck --check-prefix=CHECK-XOR %s
; RUN: opt < %s -msan -msan-shadow-base 3735928559 -msan-xor-mask 48879 -msan-and-mask 4294901760 -S | FileCheck --check-prefix=CHECK-XOR-AND %s
; RUN: opt < %s -msan -msan-track-origins 1 -msan-origin-base 1777777 -S | FileCheck --check-prefix=CHECK-ORIGIN-BASE %s

target triple = "x86_64-unknown-linux-gnu"

define i32 @read_value(i32* %a) sanitize_memory {
entry:
%tmp1 = load i32, i32* %a, align 4
ret i32 %tmp1
}
; CHECK-BASE-LABEL: @read_value
; CHECK-BASE-NOT: ret i32
; CHECK-BASE: add{{.*}}3735928559
; CHECK-BASE: ret i32

; CHECK-AND-LABEL: @read_value
; CHECK-AND-NOT: ret i32
; CHECK-AND: and{{.*}}-4294901761
; CHECK-AND-NEXT: add{{.*}}3735928559
; CHECK-AND: ret i32

; CHECK-XOR-LABEL: @read_value
; CHECK-XOR-NOT: ret i32
; CHECK-XOR: xor{{.*}}48879
; CHECK-XOR-NEXT: add{{.*}}3735928559
; CHECK-XOR: ret i32

; CHECK-XOR-AND-LABEL: @read_value
; CHECK-XOR-AND-NOT: ret i32
; CHECK-XOR-AND: and{{.*}}-4294901761
; CHECK-XOR-AND-NEXT: xor{{.*}}48879
; CHECK-XOR-AND-NEXT: add{{.*}}3735928559
; CHECK-XOR-AND: ret i32

; CHECK-ORIGIN-BASE-LABEL: @read_value
; CHECK-ORIGIN-BASE-NOT: ret i32
; CHECK-ORIGIN-BASE: add{{.*}}1777777
; CHECK-ORIGIN-BASE: ret i32

0 comments on commit 50635da

Please sign in to comment.