Skip to content

Add TSan and UBSan to sanitize options #2315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickclark2016 merged 8 commits into from
Nov 11, 2024
Merged

Add TSan and UBSan to sanitize options #2315

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aa3974e
Add TSan and UBSan to sanitize options
JakeIsMeh Nov 2, 2024
16e83e2
Add TSan and UBSan flag tests
JakeIsMeh Nov 2, 2024
427ca61
Add TSan and UBSan to docs
JakeIsMeh Nov 2, 2024
508ddfd
use "UndefinedBehavior" instead of "Undefined" for UBSan
JakeIsMeh Nov 8, 2024
18d5f3c
add compiler support notes for sanitizers to docs
JakeIsMeh Nov 8, 2024
90696dc
Register TSan and UBSan flags in init
JakeIsMeh Nov 10, 2024
ff19f59
Add TSan and UBSan to linker flags
JakeIsMeh Nov 10, 2024
69bf538
Properly share GCC sanitizer tables with Clang
JakeIsMeh Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/_premake_init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1149,6 +1149,8 @@
allowed = {
"Address",
"Fuzzer", -- Visual Studio 2022+ only
"Thread",
"UndefinedBehavior",
}
}

Expand Down
2 changes: 2 additions & 0 deletions src/tools/gcc.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@
},
sanitize = {
Address = "-fsanitize=address",
Thread = "-fsanitize=thread",
UndefinedBehavior = "-fsanitize=undefined",
},
visibility = {
Default = "-fvisibility=default",
Expand Down
52 changes: 36 additions & 16 deletions tests/tools/test_clang.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,25 +110,45 @@
-- Check handling of linker flag.
--

function suite.ldflags_linker_lld()
linker "LLD"
prepare()
test.contains("-fuse-ld=lld", clang.getldflags(cfg))
end
function suite.ldflags_linker_lld()
linker "LLD"
prepare()
test.contains("-fuse-ld=lld", clang.getldflags(cfg))
end

--
-- Check the translation of CXXFLAGS.
--

function suite.onSanitizeAddress()
sanitize { "Address" }
prepare()
test.contains({ "-fsanitize=address" }, clang.getcxxflags(cfg))
test.contains({ "-fsanitize=address" }, clang.getldflags(cfg))
end
function suite.onSanitizeAddress()
sanitize { "Address" }
prepare()
test.contains({ "-fsanitize=address" }, clang.getcxxflags(cfg))
test.contains({ "-fsanitize=address" }, clang.getcflags(cfg))
test.contains({ "-fsanitize=address" }, clang.getldflags(cfg))
end

function suite.cxxflags_onSanitizeFuzzer()
sanitize { "Fuzzer" }
prepare()
test.contains({ "-fsanitize=fuzzer" }, clang.getcxxflags(cfg))
test.contains({ "-fsanitize=fuzzer" }, clang.getcflags(cfg))
test.contains({ "-fsanitize=fuzzer" }, clang.getldflags(cfg))
end

function suite.cxxflags_onSanitizeThread()
sanitize { "Thread" }
prepare()
test.contains({ "-fsanitize=thread" }, clang.getcxxflags(cfg))
test.contains({ "-fsanitize=thread" }, clang.getcflags(cfg))
test.contains({ "-fsanitize=thread" }, clang.getldflags(cfg))
end

function suite.cxxflags_onSanitizeFuzzer()
sanitize { "Fuzzer" }
prepare()
test.contains({ "-fsanitize=fuzzer" }, clang.getcxxflags(cfg))
end
-- UBSan
function suite.cxxflags_onSanitizeUndefined()
sanitize { "UndefinedBehavior" }
prepare()
test.contains({ "-fsanitize=undefined" }, clang.getcxxflags(cfg))
test.contains({ "-fsanitize=undefined" }, clang.getcflags(cfg))
test.contains({ "-fsanitize=undefined" }, clang.getldflags(cfg))
end
17 changes: 17 additions & 0 deletions tests/tools/test_gcc.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,23 @@
test.contains({ "-fsanitize=address" }, gcc.getldflags(cfg))
end

function suite.cxxflags_onSanitizeThread()
sanitize { "Thread" }
prepare()
test.contains({ "-fsanitize=thread" }, gcc.getcxxflags(cfg))
test.contains({ "-fsanitize=thread" }, gcc.getcflags(cfg))
test.contains({ "-fsanitize=thread" }, gcc.getldflags(cfg))
end

-- UBSan
function suite.cxxflags_onSanitizeUndefined()
sanitize { "UndefinedBehavior" }
prepare()
test.contains({ "-fsanitize=undefined" }, gcc.getcxxflags(cfg))
test.contains({ "-fsanitize=undefined" }, gcc.getcflags(cfg))
test.contains({ "-fsanitize=undefined" }, gcc.getldflags(cfg))
end

--
-- Check the basic translation of LDFLAGS for a Posix system.
--
Expand Down
10 changes: 6 additions & 4 deletions website/docs/sanitize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ sanitize { "value_list" }

`value_list` specifies the desired `fsanitize` options to enable.

| Value | Description |
|-------------|--------------------------------------------------------|
| Address | Enables compiler support for AddressSanitizer. | Visual Studio support starts with 2019 16.9 |
| Fuzzer | Enables support for LibFuzzer, a coverage-guided fuzzing library. | Visual Studio support starts with 2019 16.9 |
| Value | Description | Notes |
|-------------------|--------------------------------------------------------|---|
| Address | Enables compiler support for AddressSanitizer (ASan). | Visual Studio support starts with 2019 16.9 |
| Fuzzer | Enables support for LibFuzzer, a coverage-guided fuzzing library. | Unsupported with GCC. Visual Studio support starts with 2019 16.9 |
| Thread | Enables compiler support for ThreadSanitizer (TSan). | GCC & Clang only |
| UndefinedBehavior | Enables compiler support for UndefinedBehaviorSanitizer (UBSan). | GCC & Clang only |

### Applies To ###

Expand Down
Loading