llvm-project/clang/test/Modules/safe_buffers_optout.cpp
Matt 8c22f569b3
[Fix] Speedup -Wunsafe-buffer-usage when using clang modules. (#127161)
Each piece of code should have analysis run on it precisely once.
However, if you build a module, and then build another module depending
on it, the header file of the module you depend on will have
`-Wunsafe-buffer-usage` run on it twice. This normally isn't a huge
issue, but in the case of using the standard library as a module, simply
adding the line `#include <cstddef>` increases compile times by 900ms
(from 100ms to 1 second) on my machine. I believe this is because the
standard library has massive modules, of which only a small part is used
(the AST is ~700k lines), and because if what I've been told is correct,
the AST is lazily generated, and `-Wunsafe-buffer-usage` forces it to be
evaluated every time.

See https://issues.chromium.org/issues/351909443 for details and
benchmarks.
2025-04-15 10:17:03 +08:00

140 lines
4.6 KiB
C++

// RUN: rm -rf %t
// RUN: mkdir -p %t
// RUN: split-file %s %t
// RUN: %clang_cc1 -fmodules -fimplicit-module-maps -emit-module -fmodule-name=safe_buffers_test_base -x c++ %t/safe_buffers_test.modulemap -std=c++20\
// RUN: -o %t/safe_buffers_test_base.pcm -Wunsafe-buffer-usage
// RUN: %clang_cc1 -fmodules -fimplicit-module-maps -emit-module -fmodule-name=safe_buffers_test_textual -x c++ %t/safe_buffers_test.modulemap -std=c++20\
// RUN: -o %t/safe_buffers_test_textual.pcm -Wunsafe-buffer-usage
// RUN: %clang_cc1 -fmodules -fimplicit-module-maps -emit-module -fmodule-name=safe_buffers_test_optout -x c++ %t/safe_buffers_test.modulemap -std=c++20\
// RUN: -fmodule-file=%t/safe_buffers_test_base.pcm -fmodule-file=%t/safe_buffers_test_textual.pcm \
// RUN: -o %t/safe_buffers_test_optout.pcm -Wunsafe-buffer-usage
// RUN: %clang_cc1 -fmodules -fimplicit-module-maps -fmodule-file=%t/safe_buffers_test_optout.pcm -I %t -std=c++20 -Wunsafe-buffer-usage\
// RUN: -verify %t/safe_buffers_optout-explicit.cpp
// RUN: %clang_cc1 -fmodules -fimplicit-module-maps -verify -fmodules-cache-path=%t -fmodule-map-file=%t/safe_buffers_test.modulemap -I%t\
// RUN: -x c++ -std=c++20 -Wunsafe-buffer-usage %t/safe_buffers_optout-implicit.cpp
//--- safe_buffers_test.modulemap
module safe_buffers_test_base {
header "base.h"
}
module safe_buffers_test_textual {
textual header "textual.h"
}
module safe_buffers_test_optout {
explicit module test_sub1 { header "test_sub1.h" }
explicit module test_sub2 { header "test_sub2.h" }
use safe_buffers_test_base
}
//--- base.h
#ifdef __cplusplus
int base(int *p) {
int x = p[5];
#pragma clang unsafe_buffer_usage begin
int y = p[5];
#pragma clang unsafe_buffer_usage end
return x + y;
}
#endif
//--- test_sub1.h
#include "base.h"
#ifdef __cplusplus
int sub1(int *p) {
int x = p[5];
#pragma clang unsafe_buffer_usage begin
int y = p[5];
#pragma clang unsafe_buffer_usage end
return x + y + base(p);
}
template <typename T>
T sub1_T(T *p) {
T x = p[5];
#pragma clang unsafe_buffer_usage begin
T y = p[5];
#pragma clang unsafe_buffer_usage end
return x + y;
}
#endif
//--- test_sub2.h
#include "base.h"
#ifdef __cplusplus
int sub2(int *p) {
int x = p[5];
#pragma clang unsafe_buffer_usage begin
int y = p[5];
#pragma clang unsafe_buffer_usage end
return x + y + base(p);
}
#endif
//--- textual.h
#ifdef __cplusplus
int textual(int *p) {
int x = p[5];
int y = p[5];
return x + y;
}
#endif
//--- safe_buffers_optout-explicit.cpp
#include "test_sub1.h"
#include "test_sub2.h"
// Testing safe buffers opt-out region serialization with modules: this
// file loads 2 submodules from top-level module
// `safe_buffers_test_optout`, which uses another top-level module
// `safe_buffers_test_base`. (So the module dependencies form a DAG.)
// No expected warnings from base.h, test_sub1, or test_sub2 because they are
// in seperate modules, and the explicit commands that builds them have no
// `-Wunsafe-buffer-usage`.
int foo(int * p) {
int x = p[5]; // expected-warning{{unsafe buffer access}} expected-note{{pass -fsafe-buffer-usage-suggestions to receive code hardening suggestions}}
#pragma clang unsafe_buffer_usage begin
int y = p[5];
#pragma clang unsafe_buffer_usage end
sub1_T(p); // instantiate template
return sub1(p) + sub2(p);
}
#pragma clang unsafe_buffer_usage begin
#include "textual.h" // This header is textually included (i.e., it is in the same TU as %s), so warnings are suppressed
#pragma clang unsafe_buffer_usage end
//--- safe_buffers_optout-implicit.cpp
#include "test_sub1.h"
#include "test_sub2.h"
// Testing safe buffers opt-out region serialization with modules: this
// file loads 2 submodules from top-level module
// `safe_buffers_test_optout`, which uses another top-level module
// `safe_buffers_test_base`. (So the module dependencies form a DAG.)
// No expected warnings from base.h, test_sub1, or test_sub2 because they are
// in seperate modules, and the explicit commands that builds them have no
// `-Wunsafe-buffer-usage`.
int foo(int * p) {
int x = p[5]; // expected-warning{{unsafe buffer access}} expected-note{{pass -fsafe-buffer-usage-suggestions to receive code hardening suggestions}}
#pragma clang unsafe_buffer_usage begin
int y = p[5];
#pragma clang unsafe_buffer_usage end
sub1_T(p); // instantiate template
return sub1(p) + sub2(p);
}
#pragma clang unsafe_buffer_usage begin
#include "textual.h" // This header is textually included (i.e., it is in the same TU as %s), so warnings are suppressed
#pragma clang unsafe_buffer_usage end