Skip to content

Enhance TLI detection of __size_returning_new lib funcs. #102391

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
merged 4 commits into from
Aug 13, 2024
Merged

Enhance TLI detection of __size_returning_new lib funcs. #102391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c87dba4
Enhance TLI detection of __size_returning_new lib funcs.
Aug 7, 2024
2310ebd
clang format.
Aug 9, 2024
47dfde7
Address comments.
Aug 9, 2024
0d97e84
clang format.
Aug 9, 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
8 changes: 4 additions & 4 deletions llvm/include/llvm/Analysis/TargetLibraryInfo.def
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,22 +365,22 @@ TLI_DEFINE_SIG_INTERNAL(Ptr, Long, Long, Ptr, Bool)
/// __sized_ptr_t __size_returning_new(size_t size)
TLI_DEFINE_ENUM_INTERNAL(size_returning_new)
TLI_DEFINE_STRING_INTERNAL("__size_returning_new")
TLI_DEFINE_SIG_INTERNAL(Struct, Long)
TLI_DEFINE_SIG_INTERNAL(/* Checked manually. */)

/// __sized_ptr_t __size_returning_new_hot_cold(size_t, __hot_cold_t)
TLI_DEFINE_ENUM_INTERNAL(size_returning_new_hot_cold)
TLI_DEFINE_STRING_INTERNAL("__size_returning_new_hot_cold")
TLI_DEFINE_SIG_INTERNAL(Struct, Long, Bool)
TLI_DEFINE_SIG_INTERNAL(/* Checked manually. */)

/// __sized_ptr_t __size_returning_new_aligned(size_t, std::align_val_t)
TLI_DEFINE_ENUM_INTERNAL(size_returning_new_aligned)
TLI_DEFINE_STRING_INTERNAL("__size_returning_new_aligned")
TLI_DEFINE_SIG_INTERNAL(Struct, Long, Long)
TLI_DEFINE_SIG_INTERNAL(/* Checked manually. */)

/// __sized_ptr_t __size_returning_new_aligned(size_t, std::align_val_t, __hot_cold_t)
TLI_DEFINE_ENUM_INTERNAL(size_returning_new_aligned_hot_cold)
TLI_DEFINE_STRING_INTERNAL("__size_returning_new_aligned_hot_cold")
TLI_DEFINE_SIG_INTERNAL(Struct, Long, Long, Bool)
TLI_DEFINE_SIG_INTERNAL(/* Checked manually. */)

/// double __acos_finite(double x);
TLI_DEFINE_ENUM_INTERNAL(acos_finite)
Expand Down
51 changes: 50 additions & 1 deletion llvm/lib/Analysis/TargetLibraryInfo.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1049,6 +1049,49 @@ static bool matchType(FuncArgTypeID ArgTy, const Type *Ty, unsigned IntBits,
llvm_unreachable("Invalid type");
}

static bool isValidProtoForSizeReturningNew(const FunctionType &FTy, LibFunc F,
const Module &M,
int SizeTSizeBits) {
switch (F) {
case LibFunc_size_returning_new: {
if (FTy.getNumParams() != 1 ||
!FTy.getParamType(0)->isIntegerTy(SizeTSizeBits)) {
return false;
}
} break;
case LibFunc_size_returning_new_hot_cold: {
if (FTy.getNumParams() != 2 ||
!FTy.getParamType(0)->isIntegerTy(SizeTSizeBits) ||
!FTy.getParamType(1)->isIntegerTy(8)) {
return false;
}
} break;
case LibFunc_size_returning_new_aligned: {
if (FTy.getNumParams() != 2 ||
!FTy.getParamType(0)->isIntegerTy(SizeTSizeBits) ||
!FTy.getParamType(1)->isIntegerTy(SizeTSizeBits)) {
return false;
}
} break;
case LibFunc_size_returning_new_aligned_hot_cold:
if (FTy.getNumParams() != 3 ||
!FTy.getParamType(0)->isIntegerTy(SizeTSizeBits) ||
!FTy.getParamType(1)->isIntegerTy(SizeTSizeBits) ||
!FTy.getParamType(2)->isIntegerTy(8)) {
return false;
}
break;
default:
return false;
}

auto &Context = M.getContext();
PointerType *PtrTy = PointerType::get(Context, 0);
StructType *SizedPtrTy = StructType::get(
Context, {PtrTy, Type::getIntNTy(Context, SizeTSizeBits)});
return FTy.getReturnType() == SizedPtrTy;
}

bool TargetLibraryInfoImpl::isValidProtoForLibFunc(const FunctionType &FTy,
LibFunc F,
const Module &M) const {
Expand Down Expand Up @@ -1099,7 +1142,13 @@ bool TargetLibraryInfoImpl::isValidProtoForLibFunc(const FunctionType &FTy,

return false;
}

// Special handling of __size_returning_new functions that return a struct
// of type {void*, size_t}.
case LibFunc_size_returning_new:
case LibFunc_size_returning_new_hot_cold:
case LibFunc_size_returning_new_aligned:
case LibFunc_size_returning_new_aligned_hot_cold:
return isValidProtoForSizeReturningNew(FTy, F, M, getSizeTSize(M));
default:
break;
}
Expand Down
33 changes: 29 additions & 4 deletions llvm/unittests/Analysis/TargetLibraryInfoTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

#include "llvm/Analysis/TargetLibraryInfo.h"
#include "llvm/AsmParser/Parser.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/Support/SourceMgr.h"
Expand Down Expand Up @@ -81,6 +82,29 @@ TEST_F(TargetLibraryInfoTest, InvalidProto) {
}
}

TEST_F(TargetLibraryInfoTest, SizeReturningNewInvalidProto) {
parseAssembly(
"target datalayout = \"p:64:64:64\"\n"
";; Invalid additional params \n"
"declare {i8*, i64} @__size_returning_new(i64, i64)\n"
";; Invalid params types \n"
"declare {i8*, i64} @__size_returning_new_hot_cold(i64, i32)\n"
";; Invalid return struct types \n"
"declare {i8*, i8} @__size_returning_new_aligned(i64, i64)\n"
";; Invalid return type \n"
"declare i8* @__size_returning_new_aligned_hot_cold(i64, i64, i8)\n");

for (const LibFunc LF :
{LibFunc_size_returning_new, LibFunc_size_returning_new_aligned,
LibFunc_size_returning_new_hot_cold,
LibFunc_size_returning_new_aligned_hot_cold}) {
TLII.setAvailable(LF);
Function *F = M->getFunction(TLI.getName(LF));
ASSERT_NE(F, nullptr);
EXPECT_FALSE(isLibFunc(F, LF));
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please also add some negative tests with incorrect signature?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rewrote this test to only check invalid signatures since the test below should cover the correct match for the struct return type.

}

// Check that we do accept know-correct prototypes.
TEST_F(TargetLibraryInfoTest, ValidProto) {
parseAssembly(
Expand Down Expand Up @@ -472,10 +496,11 @@ TEST_F(TargetLibraryInfoTest, ValidProto) {
"declare i8* @_ZnwmSt11align_val_tRKSt9nothrow_t(i64, i64, %struct*)\n"
"declare i8* @_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t(i64, i64, "
"%struct*, i8)\n"
"declare %struct @__size_returning_new(i64)\n"
"declare %struct @__size_returning_new_hot_cold(i64, i8)\n"
"declare %struct @__size_returning_new_aligned(i64, i64)\n"
"declare %struct @__size_returning_new_aligned_hot_cold(i64, i64, i8)\n"
"declare {i8*, i64} @__size_returning_new(i64)\n"
"declare {i8*, i64} @__size_returning_new_hot_cold(i64, i8)\n"
"declare {i8*, i64} @__size_returning_new_aligned(i64, i64)\n"
"declare {i8*, i64} @__size_returning_new_aligned_hot_cold(i64, i64, "
"i8)\n"

"declare void @\"??3@YAXPEAX@Z\"(i8*)\n"
"declare void @\"??3@YAXPEAXAEBUnothrow_t@std@@@Z\"(i8*, %struct*)\n"
Expand Down