[clang-tidy] clang-tidy modernize-use-constraints causes a segfault when used against boost::futures::wait_for_all

[tfinnegan937]

LLVM Version: 20.1.8
Source: Fedora 42 system repositories (dnf install clang-tidy)

Stack Trace:

[build] 1.	<eof> parser at end of file
[build] 2.	ASTMatcher: Processing 'modernize-use-constraints' against:
[build] 	FunctionTemplateDecl boost::wait_for_all : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:62:5, line:69:5>
[build] --- Bound Nodes Begin ---
[build]     function - { FunctionDecl boost::wait_for_all : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:63:5, line:69:5> }
[build]     functionTemplate - { FunctionTemplateDecl boost::wait_for_all : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:62:5, line:69:5> }
[build]     return - { DependentNameTypeLoc : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:63:5, col:57> }
[build] --- Bound Nodes End ---
[build]  #0 0x00007fdb5542914a llvm::sys::PrintStackTrace(llvm::raw_ostream&, int) (/lib64/libLLVM.so.20.1+0x22914a)
[build]  #1 0x00007fdb554260d4 llvm::sys::RunSignalHandlers() (/lib64/libLLVM.so.20.1+0x2260d4)
[build]  #2 0x00007fdb554298bb (/lib64/libLLVM.so.20.1+0x2298bb)
[build]  #3 0x00007fdb54c28bb0 __restore_rt (/lib64/libc.so.6+0x19bb0)
[build]  #4 0x00007fdb5dff2c6c clang::CastExpr::getSubExprAsWritten() (/lib64/libclang-cpp.so.20.1+0x5f2c6c)
[build]  #5 0x000055d63ef3018e (/usr/bin/clang-tidy+0x3ad18e)
[build]  #6 0x000055d63ef2feca (/usr/bin/clang-tidy+0x3aceca)
[build]  #7 0x000055d63ef2e78a clang::tidy::modernize::UseConstraintsCheck::check(clang::ast_matchers::MatchFinder::MatchResult const&) (/usr/bin/clang-tidy+0x3ab78a)
[build]  #8 0x00007fdb5e756db9 (/lib64/libclang-cpp.so.20.1+0xd56db9)
[build]  #9 0x00007fdb5e79587b clang::ast_matchers::internal::BoundNodesTreeBuilder::visitMatches(clang::ast_matchers::internal::BoundNodesTreeBuilder::Visitor*) (/lib64/libclang-cpp.so.20.1+0xd9587b)
[build] #10 0x00007fdb5e7565b3 (/lib64/libclang-cpp.so.20.1+0xd565b3)
[build] #11 0x00007fdb5e758393 (/lib64/libclang-cpp.so.20.1+0xd58393)
[build] #12 0x00007fdb5e75ab0b (/lib64/libclang-cpp.so.20.1+0xd5ab0b)
[build] #13 0x00007fdb5e7587cf (/lib64/libclang-cpp.so.20.1+0xd587cf)
[build] #14 0x00007fdb5e758b2b (/lib64/libclang-cpp.so.20.1+0xd58b2b)
[build] #15 0x00007fdb5e7583bf (/lib64/libclang-cpp.so.20.1+0xd583bf)
[build] #16 0x00007fdb5e71f7f9 clang::ast_matchers::MatchFinder::matchAST(clang::ASTContext&) (/lib64/libclang-cpp.so.20.1+0xd1f7f9)
[build] #17 0x00007fdb6035e1ac clang::MultiplexConsumer::HandleTranslationUnit(clang::ASTContext&) (/lib64/libclang-cpp.so.20.1+0x295e1ac)
[build] #18 0x00007fdb5dc12d39 clang::ParseAST(clang::Sema&, bool, bool) (/lib64/libclang-cpp.so.20.1+0x212d39)
[build] #19 0x00007fdb6031907f clang::FrontendAction::Execute() (/lib64/libclang-cpp.so.20.1+0x291907f)
[build] #20 0x00007fdb6027b8f4 clang::CompilerInstance::ExecuteAction(clang::FrontendAction&) (/lib64/libclang-cpp.so.20.1+0x287b8f4)
[build] #21 0x00007fdb60581105 clang::tooling::FrontendActionFactory::runInvocation(std::shared_ptr<clang::CompilerInvocation>, clang::FileManager*, std::shared_ptr<clang::PCHContainerOperations>, clang::DiagnosticConsumer*) (/lib64/libclang-cpp.so.20.1+0x2b81105)
[build] #22 0x000055d63f2b101c (/usr/bin/clang-tidy+0x72e01c)
[build] #23 0x00007fdb60580d7a clang::tooling::ToolInvocation::runInvocation(char const*, clang::driver::Compilation*, std::shared_ptr<clang::CompilerInvocation>, std::shared_ptr<clang::PCHContainerOperations>) (/lib64/libclang-cpp.so.20.1+0x2b80d7a)
[build] #24 0x00007fdb6057f625 clang::tooling::ToolInvocation::run() (/lib64/libclang-cpp.so.20.1+0x2b7f625)
[build] #25 0x00007fdb60583271 clang::tooling::ClangTool::run(clang::tooling::ToolAction*) (/lib64/libclang-cpp.so.20.1+0x2b83271)
[build] #26 0x000055d63f2aa3aa clang::tidy::runClangTidy(clang::tidy::ClangTidyContext&, clang::tooling::CompilationDatabase const&, llvm::ArrayRef<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>>, llvm::IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem>, bool, bool, llvm::StringRef) (/usr/bin/clang-tidy+0x7273aa)
[build] #27 0x000055d63eb91530 clang::tidy::clangTidyMain(int, char const**) (/usr/bin/clang-tidy+0xe530)
[build] #28 0x00007fdb54c12575 __libc_start_call_main (/lib64/libc.so.6+0x3575)
[build] #29 0x00007fdb54c12628 __libc_start_main@GLIBC_2.2.5 (/lib64/libc.so.6+0x3628)
[build] #30 0x000055d63eb8e475 _start (/usr/bin/clang-tidy+0xb475)
[build] Segmentation fault

I'm using boost version 1.87.0, built from source. My code does not call wait_for_all anywhere, so I think it's choking while parsing the boost/threads or boost/asio headers.

[llvmbot]

@llvm/issue-subscribers-clang-tidy

Author: None (tfinnegan937)

LLVM Version: 20.1.8 Source: Fedora 42 system repositories (dnf install clang-tidy)

Stack Trace:

[build] 1.	<eof> parser at end of file
[build] 2.	ASTMatcher: Processing 'modernize-use-constraints' against:
[build] 	FunctionTemplateDecl boost::wait_for_all : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:62:5, line:69:5>
[build] --- Bound Nodes Begin ---
[build]     function - { FunctionDecl boost::wait_for_all : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:63:5, line:69:5> }
[build]     functionTemplate - { FunctionTemplateDecl boost::wait_for_all : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:62:5, line:69:5> }
[build]     return - { DependentNameTypeLoc : </home/tfinnegan/Projects/worldstate-engine/external/boost/libs/thread/include/boost/thread/futures/wait_for_all.hpp:63:5, col:57> }
[build] --- Bound Nodes End ---
[build]  #<!-- -->0 0x00007fdb5542914a llvm::sys::PrintStackTrace(llvm::raw_ostream&amp;, int) (/lib64/libLLVM.so.20.1+0x22914a)
[build]  #<!-- -->1 0x00007fdb554260d4 llvm::sys::RunSignalHandlers() (/lib64/libLLVM.so.20.1+0x2260d4)
[build]  #<!-- -->2 0x00007fdb554298bb (/lib64/libLLVM.so.20.1+0x2298bb)
[build]  #<!-- -->3 0x00007fdb54c28bb0 __restore_rt (/lib64/libc.so.6+0x19bb0)
[build]  #<!-- -->4 0x00007fdb5dff2c6c clang::CastExpr::getSubExprAsWritten() (/lib64/libclang-cpp.so.20.1+0x5f2c6c)
[build]  #<!-- -->5 0x000055d63ef3018e (/usr/bin/clang-tidy+0x3ad18e)
[build]  #<!-- -->6 0x000055d63ef2feca (/usr/bin/clang-tidy+0x3aceca)
[build]  #<!-- -->7 0x000055d63ef2e78a clang::tidy::modernize::UseConstraintsCheck::check(clang::ast_matchers::MatchFinder::MatchResult const&amp;) (/usr/bin/clang-tidy+0x3ab78a)
[build]  #<!-- -->8 0x00007fdb5e756db9 (/lib64/libclang-cpp.so.20.1+0xd56db9)
[build]  #<!-- -->9 0x00007fdb5e79587b clang::ast_matchers::internal::BoundNodesTreeBuilder::visitMatches(clang::ast_matchers::internal::BoundNodesTreeBuilder::Visitor*) (/lib64/libclang-cpp.so.20.1+0xd9587b)
[build] #<!-- -->10 0x00007fdb5e7565b3 (/lib64/libclang-cpp.so.20.1+0xd565b3)
[build] #<!-- -->11 0x00007fdb5e758393 (/lib64/libclang-cpp.so.20.1+0xd58393)
[build] #<!-- -->12 0x00007fdb5e75ab0b (/lib64/libclang-cpp.so.20.1+0xd5ab0b)
[build] #<!-- -->13 0x00007fdb5e7587cf (/lib64/libclang-cpp.so.20.1+0xd587cf)
[build] #<!-- -->14 0x00007fdb5e758b2b (/lib64/libclang-cpp.so.20.1+0xd58b2b)
[build] #<!-- -->15 0x00007fdb5e7583bf (/lib64/libclang-cpp.so.20.1+0xd583bf)
[build] #<!-- -->16 0x00007fdb5e71f7f9 clang::ast_matchers::MatchFinder::matchAST(clang::ASTContext&amp;) (/lib64/libclang-cpp.so.20.1+0xd1f7f9)
[build] #<!-- -->17 0x00007fdb6035e1ac clang::MultiplexConsumer::HandleTranslationUnit(clang::ASTContext&amp;) (/lib64/libclang-cpp.so.20.1+0x295e1ac)
[build] #<!-- -->18 0x00007fdb5dc12d39 clang::ParseAST(clang::Sema&amp;, bool, bool) (/lib64/libclang-cpp.so.20.1+0x212d39)
[build] #<!-- -->19 0x00007fdb6031907f clang::FrontendAction::Execute() (/lib64/libclang-cpp.so.20.1+0x291907f)
[build] #<!-- -->20 0x00007fdb6027b8f4 clang::CompilerInstance::ExecuteAction(clang::FrontendAction&amp;) (/lib64/libclang-cpp.so.20.1+0x287b8f4)
[build] #<!-- -->21 0x00007fdb60581105 clang::tooling::FrontendActionFactory::runInvocation(std::shared_ptr&lt;clang::CompilerInvocation&gt;, clang::FileManager*, std::shared_ptr&lt;clang::PCHContainerOperations&gt;, clang::DiagnosticConsumer*) (/lib64/libclang-cpp.so.20.1+0x2b81105)
[build] #<!-- -->22 0x000055d63f2b101c (/usr/bin/clang-tidy+0x72e01c)
[build] #<!-- -->23 0x00007fdb60580d7a clang::tooling::ToolInvocation::runInvocation(char const*, clang::driver::Compilation*, std::shared_ptr&lt;clang::CompilerInvocation&gt;, std::shared_ptr&lt;clang::PCHContainerOperations&gt;) (/lib64/libclang-cpp.so.20.1+0x2b80d7a)
[build] #<!-- -->24 0x00007fdb6057f625 clang::tooling::ToolInvocation::run() (/lib64/libclang-cpp.so.20.1+0x2b7f625)
[build] #<!-- -->25 0x00007fdb60583271 clang::tooling::ClangTool::run(clang::tooling::ToolAction*) (/lib64/libclang-cpp.so.20.1+0x2b83271)
[build] #<!-- -->26 0x000055d63f2aa3aa clang::tidy::runClangTidy(clang::tidy::ClangTidyContext&amp;, clang::tooling::CompilationDatabase const&amp;, llvm::ArrayRef&lt;std::__cxx11::basic_string&lt;char, std::char_traits&lt;char&gt;, std::allocator&lt;char&gt;&gt;&gt;, llvm::IntrusiveRefCntPtr&lt;llvm::vfs::OverlayFileSystem&gt;, bool, bool, llvm::StringRef) (/usr/bin/clang-tidy+0x7273aa)
[build] #<!-- -->27 0x000055d63eb91530 clang::tidy::clangTidyMain(int, char const**) (/usr/bin/clang-tidy+0xe530)
[build] #<!-- -->28 0x00007fdb54c12575 __libc_start_call_main (/lib64/libc.so.6+0x3575)
[build] #<!-- -->29 0x00007fdb54c12628 __libc_start_main@<!-- -->GLIBC_2.2.5 (/lib64/libc.so.6+0x3628)
[build] #<!-- -->30 0x000055d63eb8e475 _start (/usr/bin/clang-tidy+0xb475)
[build] Segmentation fault

I'm using boost version 1.87.0, built from source. My code does not call wait_for_all anywhere, so I think it's choking while parsing the boost/threads or boost/asio headers.

[localspook]

Reproducer:

template <class T, T val> struct integral_constant {
  static const T value = val;
};

typedef integral_constant<bool, false> false_type;

template <bool B, class T = void> struct enable_if_c {
  typedef T type;
};

template <class T> struct enable_if_c<false, T> {};

template <class Cond, class T = void>
struct enable_if : public enable_if_c<Cond::value, T> {};

template <typename T> struct is_future_type : false_type {};

template <typename F1>
typename enable_if<is_future_type<F1>, void>::type wait_for_all(F1 &) {}

It trips this assert:

llvm-project/clang/include/clang/AST/TemplateBase.h

Lines 584 to 587 in aee4f2b

	Expr *getSourceExpression() const {
	assert(Argument.getKind() == TemplateArgument::Expression);
	return LocInfo.getAsExpr();
	}

Seemingly because boost::enable_if, unlike std::enable_if, takes a type parameter, not a bool. The boost equivalent to std::enable_if is that boost:enable_if_c you can see above. To fix this, we could:

1. restrict the check to just std::enable_if;
2. add an option that is a list of std::enable_if-like traits; or
3. add extra logic to handle this "type-based" enable_if.

[vbvictor]

Thank you for the reduction!
Could we check that parameter is bool inside enable_if right here so we would not crash anymore, that will be kind-of No.3

llvm-project/clang-tools-extra/clang-tidy/modernize/UseConstraintsCheck.cpp

Lines 78 to 81 in c9b6242

	const TemplateDecl *TD =
	Specialization->getTemplateName().getAsTemplateDecl();
	if (!TD || TD->getName() != "enable_if")
	return std::nullopt;

CC @ccotter