Add TSan and UBSan to sanitize options (#2315)

* Add TSan and UBSan to sanitize options

* Add TSan and UBSan flag tests

* Add TSan and UBSan to docs

* use "UndefinedBehavior" instead of "Undefined" for UBSan

* add compiler support notes for sanitizers to docs

* Register TSan and UBSan flags in init

* Add TSan and UBSan to linker flags

* Properly share GCC sanitizer tables with Clang

Author: JakeIsMeh

src/_premake_init.lua

@@ -805,6 +805,8 @@
 		allowed = {
 			"Address",
 			"Fuzzer",              -- Visual Studio 2022+ only
+			"Thread",
+			"UndefinedBehavior",
 		}
 	}
 

src/tools/clang.lua

@@ -66,7 +66,9 @@
 		unsignedchar = gcc.shared.unsignedchar,
 		omitframepointer = gcc.shared.omitframepointer,
 		compileas = gcc.shared.compileas,
-		sanitize = gcc.shared.sanitize,
+		sanitize = table.merge(gcc.shared.sanitize, {
+			Fuzzer = "-fsanitize=fuzzer",
+		}),
 		visibility = gcc.shared.visibility,
 		inlinesvisibility = gcc.shared.inlinesvisibility
 	}
@@ -118,9 +120,6 @@
 --
 
 	clang.cxxflags = table.merge(gcc.cxxflags, {
-		sanitize = {
-			Fuzzer = "-fsanitize=fuzzer",
-		},
 	})
 
 	function clang.getcxxflags(cfg)
@@ -254,9 +253,9 @@
 			end,
 		},
 		linker = gcc.ldflags.linker,
-		sanitize = {
-			Address = "-fsanitize=address",
-		},
+		sanitize = table.merge(gcc.ldflags.sanitize, {
+			Fuzzer = "-fsanitize=fuzzer",
+		}),
 		system = {
 			wii = "$(MACHDEP)",
 		}

src/tools/gcc.lua

@@ -147,6 +147,8 @@
 		},
 		sanitize = {
 			Address = "-fsanitize=address",
+			Thread = "-fsanitize=thread",
+			UndefinedBehavior = "-fsanitize=undefined",
 		},
 		visibility = {
 			Default = "-fvisibility=default",
@@ -494,6 +496,8 @@
 		},
 		sanitize = {
 			Address = "-fsanitize=address",
+			Thread = "-fsanitize=thread",
+			UndefinedBehavior = "-fsanitize=undefined",
 		},
 		system = {
 			wii = "$(MACHDEP)",

tests/tools/test_clang.lua

@@ -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

tests/tools/test_gcc.lua

@@ -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.
 --

website/docs/sanitize.md

@@ -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 ###