Skip to content

Commit e8fe4de

Browse files
MaskRayMaskRay
authored
[CodeGen] -fsanitize=alignment: add cl::opt sanitize-alignment-builtin to disable memcpy instrumentation (#69240)
Deploying #67766 to a large internal codebase uncovers many bugs (many are probably benign but need cleaning up). There are also issues in high-profile open-source projects like v8. Add a cl::opt to disable builtin instrumentation for -fsanitize=alignment to help large codebase users. In the long term, this cl::opt option may still be useful to debug -fsanitize=alignment instrumentation on builtins, so we probably want to keep it around.
1 parent 8a70102 commit e8fe4de

File tree

2 files changed

+37
-15
lines changed

2 files changed

+37
-15
lines changed

‎clang/lib/CodeGen/CGBuiltin.cpp‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ using namespace clang;
6666
using namespace CodeGen;
6767
using namespace llvm;
6868

69+
static llvm::cl::opt<bool> ClSanitizeAlignmentBuiltin(
70+
"sanitize-alignment-builtin", llvm::cl::Hidden,
71+
llvm::cl::desc("Instrument builtin functions for -fsanitize=alignment"),
72+
llvm::cl::init(true));
73+
6974
static void initializeAlloca(CodeGenFunction &CGF, AllocaInst *AI, Value *Size,
7075
Align AlignmentInBytes) {
7176
ConstantInt *Byte;
@@ -2801,7 +2806,7 @@ RValue CodeGenFunction::EmitBuiltinExpr(const GlobalDecl GD, unsigned BuiltinID,
28012806
EmitNonNullArgCheck(RValue::get(Val), Arg->getType(), Arg->getExprLoc(), FD,
28022807
ParmNum);
28032808

2804-
if (SanOpts.has(SanitizerKind::Alignment)) {
2809+
if (SanOpts.has(SanitizerKind::Alignment) && ClSanitizeAlignmentBuiltin) {
28052810
SanitizerSet SkippedChecks;
28062811
SkippedChecks.set(SanitizerKind::All);
28072812
SkippedChecks.clear(SanitizerKind::Alignment);

‎clang/test/CodeGen/catch-undef-behavior.c‎

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
// RUN: %clang_cc1 -fsanitize=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -emit-llvm %s -o - -triple x86_64-linux-gnu | FileCheck %s --check-prefix=CHECK-COMMON --check-prefix=CHECK-UBSAN
2-
// RUN: %clang_cc1 -fsanitize-trap=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -emit-llvm %s -o - -triple x86_64-linux-gnu | FileCheck %s --check-prefix=CHECK-COMMON --check-prefix=CHECK-TRAP
1+
// RUN: %clang_cc1 -fsanitize=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -emit-llvm %s -o - -triple x86_64-linux-gnu | FileCheck %s --check-prefixes=CHECK-COMMON,CHECK-UBSAN,CHECK-ALIGNMENT-BUILTIN
2+
// RUN: %clang_cc1 -fsanitize-trap=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -emit-llvm %s -o - -triple x86_64-linux-gnu | FileCheck %s --check-prefixes=CHECK-COMMON,CHECK-ALIGNMENT-BUILTIN,CHECK-TRAP
33
// RUN: %clang_cc1 -fsanitize=signed-integer-overflow -emit-llvm %s -o - -triple x86_64-linux-gnu | FileCheck %s --check-prefix=CHECK-OVERFLOW
4+
/// A variant of CHECK-UBSAN with -sanitize-alignment-builtin disabled
5+
// RUN: %clang_cc1 -fsanitize=alignment,null,object-size,shift-base,shift-exponent,return,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -fsanitize-recover=alignment,null,object-size,shift-base,shift-exponent,signed-integer-overflow,vla-bound,float-cast-overflow,integer-divide-by-zero,bool,returns-nonnull-attribute,nonnull-attribute -emit-llvm %s -o - -triple x86_64-linux-gnu -mllvm -sanitize-alignment-builtin=0 | FileCheck %s --check-prefixes=CHECK-COMMON,CHECK-UBSAN-NO-ALIGNMENT-BUILTIN
46

57
// CHECK-UBSAN: @[[INT:.*]] = private unnamed_addr constant { i16, i16, [6 x i8] } { i16 0, i16 11, [6 x i8] c"'int'\00" }
68

@@ -363,11 +365,13 @@ extern void *memcpy(void *, const void *, unsigned long) __attribute__((nonnull(
363365
void call_memcpy_nonnull(void *p, void *q, int sz) {
364366
// CHECK-COMMON: icmp ne ptr {{.*}}, null
365367
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg
368+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg
366369
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
367370
// CHECK-COMMON-NOT: call
368371

369372
// CHECK-COMMON: icmp ne ptr {{.*}}, null
370373
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg
374+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg
371375
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
372376
// CHECK-COMMON-NOT: call
373377

@@ -379,18 +383,23 @@ void call_memcpy_nonnull(void *p, void *q, int sz) {
379383
void call_memcpy(long *p, short *q, int sz) {
380384
// CHECK-COMMON: icmp ne ptr {{.*}}, null
381385
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg(
386+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg(
382387
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
383-
// CHECK-COMMON: and i64 %[[#]], 7, !nosanitize
384-
// CHECK-COMMON: icmp eq i64 %[[#]], 0, !nosanitize
388+
// CHECK-ALIGNMENT-BUILTIN: and i64 %[[#]], 7, !nosanitize
389+
// CHECK-ALIGNMENT-BUILTIN: icmp eq i64 %[[#]], 0, !nosanitize
385390
// CHECK-UBSAN: call void @__ubsan_handle_type_mismatch_v1(ptr @[[LINE_1600]]
391+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN-NOT: call void @__ubsan_handle_type_mismatch_v1(
386392
// CHECK-TRAP: call void @llvm.ubsantrap(i8 22)
387393

388394
// CHECK-COMMON: icmp ne ptr {{.*}}, null
389395
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg(
396+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg(
397+
// CHECK-UBSAN-DISABLE-BUILTIN: call
390398
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
391-
// CHECK-COMMON: and i64 %[[#]], 1, !nosanitize
392-
// CHECK-COMMON: icmp eq i64 %[[#]], 0, !nosanitize
399+
// CHECK-ALIGNMENT-BUILTIN: and i64 %[[#]], 1, !nosanitize
400+
// CHECK-ALIGNMENT-BUILTIN: icmp eq i64 %[[#]], 0, !nosanitize
393401
// CHECK-UBSAN: call void @__ubsan_handle_type_mismatch_v1(
402+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN-NOT: call
394403
// CHECK-TRAP: call void @llvm.ubsantrap(i8 22)
395404

396405
// CHECK-COMMON: call void @llvm.memcpy.p0.p0.i64(ptr align 8 %0, ptr align 2 %1, i64 %conv, i1 false)
@@ -405,14 +414,16 @@ void call_memcpy(long *p, short *q, int sz) {
405414

406415
// CHECK-COMMON-LABEL: define{{.*}} void @call_memcpy_inline(
407416
void call_memcpy_inline(long *p, short *q) {
408-
// CHECK-COMMON: and i64 %[[#]], 7, !nosanitize
409-
// CHECK-COMMON: icmp eq i64 %[[#]], 0, !nosanitize
417+
// CHECK-ALIGNMENT-BUILTIN: and i64 %[[#]], 7, !nosanitize
418+
// CHECK-ALIGNMENT-BUILTIN: icmp eq i64 %[[#]], 0, !nosanitize
410419
// CHECK-UBSAN: call void @__ubsan_handle_type_mismatch_v1(
420+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN-NOT: call
411421
// CHECK-TRAP: call void @llvm.ubsantrap(i8 22)
412422

413-
// CHECK-COMMON: and i64 %[[#]], 1, !nosanitize
414-
// CHECK-COMMON: icmp eq i64 %[[#]], 0, !nosanitize
423+
// CHECK-ALIGNMENT-BUILTIN: and i64 %[[#]], 1, !nosanitize
424+
// CHECK-ALIGNMENT-BUILTIN: icmp eq i64 %[[#]], 0, !nosanitize
415425
// CHECK-UBSAN: call void @__ubsan_handle_type_mismatch_v1(
426+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN-NOT: call
416427
// CHECK-TRAP: call void @llvm.ubsantrap(i8 22)
417428

418429
// CHECK-COMMON: call void @llvm.memcpy.inline.p0.p0.i64(ptr align 8 %0, ptr align 2 %1, i64 2, i1 false)
@@ -425,10 +436,12 @@ extern void *memmove(void *, const void *, unsigned long) __attribute__((nonnull
425436
void call_memmove_nonnull(void *p, void *q, int sz) {
426437
// CHECK-COMMON: icmp ne ptr {{.*}}, null
427438
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg
439+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg(
428440
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
429441

430442
// CHECK-COMMON: icmp ne ptr {{.*}}, null
431443
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg
444+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg(
432445
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
433446
memmove(p, q, sz);
434447
}
@@ -437,18 +450,22 @@ void call_memmove_nonnull(void *p, void *q, int sz) {
437450
void call_memmove(long *p, short *q, int sz) {
438451
// CHECK-COMMON: icmp ne ptr {{.*}}, null
439452
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg(
453+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg(
440454
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
441-
// CHECK-COMMON: and i64 %[[#]], 7, !nosanitize
442-
// CHECK-COMMON: icmp eq i64 %[[#]], 0, !nosanitize
455+
// CHECK-ALIGNMENT-BUILTIN: and i64 %[[#]], 7, !nosanitize
456+
// CHECK-ALIGNMENT-BUILTIN: icmp eq i64 %[[#]], 0, !nosanitize
443457
// CHECK-UBSAN: call void @__ubsan_handle_type_mismatch_v1(
458+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN-NOT: call
444459
// CHECK-TRAP: call void @llvm.ubsantrap(i8 22)
445460

446461
// CHECK-COMMON: icmp ne ptr {{.*}}, null
447462
// CHECK-UBSAN: call void @__ubsan_handle_nonnull_arg(
463+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN: call void @__ubsan_handle_nonnull_arg(
448464
// CHECK-TRAP: call void @llvm.ubsantrap(i8 16)
449-
// CHECK-COMMON: and i64 %[[#]], 1, !nosanitize
450-
// CHECK-COMMON: icmp eq i64 %[[#]], 0, !nosanitize
465+
// CHECK-ALIGNMENT-BUILTIN: and i64 %[[#]], 1, !nosanitize
466+
// CHECK-ALIGNMENT-BUILTIN: icmp eq i64 %[[#]], 0, !nosanitize
451467
// CHECK-UBSAN: call void @__ubsan_handle_type_mismatch_v1(
468+
// CHECK-UBSAN-NO-ALIGNMENT-BUILTIN-NOT: call
452469
// CHECK-TRAP: call void @llvm.ubsantrap(i8 22)
453470

454471
// CHECK-COMMON: call void @llvm.memmove.p0.p0.i64(ptr align 8 %0, ptr align 2 %1, i64 %conv, i1 false)

0 commit comments

Comments
 (0)