[Attributor] Deduce attributes for non-exact functions

[bbn]

Summary

This patch is based on D63312 and D63319. For now we create shallow wrappers for all functions that are IPO amendable.
See also this github issue.

[bbn]

Updated createShallowWrapper() function

[lebedev.ri]

Tests missnig

[bbn]

• Added tests
• Added noinline attribute to call site to prevent the internal function being inlined

[jdoerfert]

llvm/test/Transforms/Attributor/wrapper.ll

2

run it with the new pass manager as well -passes=attributor and verify we set the norecurse attribute on the wrapped functions.

17

add the name of the function, even if it is @0 or something. Here and above at the call site.

[bbn]

llvm/test/Transforms/Attributor/wrapper.ll

2

did you mean -passes=attributor-cgscc ?

[bbn]

• update tests

[jdoerfert]

Two nits, otherwise LGTM.

llvm/lib/Transforms/IPO/Attributor.cpp

62

NumAttrsRequiredDeepWrapper is not used, or is it?

llvm/test/Transforms/Attributor/wrapper.ll

2

Yes, sorry for the confusion.

6

Add a CHECK-NOT: Function Attrs before this line.

[jdoerfert]

Adjust the commit title please.

[bbn]

• added some CHECK-NOT to tests
• deleted unused statistic

[jdoerfert]

Apologies for the delay, can you rebase this and provide me with "Firstname Lastname <email>" from you so I can attribute it to you?

[bbn]

Rebased patch.

[bbn]

In D76404#1956336, @jdoerfert wrote:

Apologies for the delay, can you rebase this and provide me with "Firstname Lastname <email>" from you so I can attribute it to you?

"Luofan Chen <[e-mail]>"

Thanks!

llvm/lib/Transforms/IPO/Attributor.cpp

 using namespace llvm;
 
 #define DEBUG_TYPE "attributor"
 
 STATISTIC(NumFnWithExactDefinition,
           "Number of function with exact definitions");
 STATISTIC(NumFnWithoutExactDefinition,
           "Number of function without exact definitions");
+STATISTIC(NumFnShallowWrapperCreated, "Number of shallow wrappers created");
 STATISTIC(NumAttributesTimedOut,
           "Number of abstract attributes timed out before fixpoint");
 STATISTIC(NumAttributesValidFixpoint,
           "Number of abstract attributes in a valid fixpoint state");
 STATISTIC(NumAttributesManifested,
           "Number of abstract attributes manifested in IR");
 STATISTIC(NumAttributesFixedDueToRequiredDependences,
           "Number of abstract attributes fixed due to required dependences");
 
 // Some helper macros to deal with statistics tracking.
static cl::opt<unsigned> DepRecInterval(
     cl::init(4));
 
 static cl::opt<bool> EnableHeapToStack("enable-heap-to-stack-conversion",
                                        cl::init(true), cl::Hidden);
 
 static cl::opt<int> MaxHeapToStackSize("max-heap-to-stack-size", cl::init(128),
                                        cl::Hidden);
 
+static cl::opt<bool>
+    AllowShallowWrappers("attributor-allow-shallow-wrappers", cl::Hidden,
+                         cl::desc("Allow the Attributor to create shallow "
+                                  "wrappers for non-exact definitions."),
+                         cl::init(false));
+
 /// Logic operators for the change status enum class.
 ///
 ///{
 ChangeStatus llvm::operator|(ChangeStatus l, ChangeStatus r) {
   return l == ChangeStatus::CHANGED ? l : r;
 }
 ChangeStatus llvm::operator&(ChangeStatus l, ChangeStatus r) {
   return l == ChangeStatus::UNCHANGED ? l : r;
else
     AttrList = getAssociatedFunction()->getAttributes();
 
   bool HasAttr = AttrList.hasAttribute(getAttrIdx(), AK);
   if (HasAttr)
     Attrs.push_back(AttrList.getAttribute(getAttrIdx(), AK));
   return HasAttr;
 }
 
-
 void IRPosition::verify() {
   switch (KindOrArgNo) {
   default:
     assert(KindOrArgNo >= 0 && "Expected argument or call site argument!");
     assert((isa<CallBase>(AnchorVal) || isa<Argument>(AnchorVal)) &&
            "Expected call base or argument for positive attribute index!");
     if (isa<Argument>(AnchorVal)) {
       assert(cast<Argument>(AnchorVal)->getArgNo() == unsigned(getArgNo()) &&
ChangeStatus manifest(Attributor &A) override {
     // of the privatizable type are loaded prior to the call and passed to the
     // new function version.
     Attributor::ArgumentReplacementInfo::ACSRepairCBTy ACSRepairCB =
         [=](const Attributor::ArgumentReplacementInfo &ARI,
             AbstractCallSite ACS, SmallVectorImpl<Value *> &NewArgOperands) {
           createReplacementValues(
               PrivatizableType.getValue(), ACS,
               ACS.getCallArgOperand(ARI.getReplacedArg().getArgNo()),
-                                  NewArgOperands);
         };
 
     // Collect the types that will replace the privatizable type in the function
     // signature.
     SmallVector<Type *, 16> ReplacementTypes;
     identifyReplacementTypes(PrivatizableType.getValue(), ReplacementTypes);
 
     // Register a rewrite of the argument.
errs() << "\n[Attributor] Fixpoint iteration done after: "
            << " iterations\n";
     llvm_unreachable("The fixpoint was not reached with exactly the number of "
                      "specified iterations!");
   }
 
   return ManifestChange;
 }
 
+/// Create a shallow wrapper for \p F such that \p F has internal linkage
+/// afterwards. It also sets the original \p F 's name to anonymous
+///
+/// A wrapper is a function with the same type (and attributes) as \p F
+/// that will only call \p F and return the result, if any.
+///
+/// Assuming the declaration of looks like:
+///   rty F(aty0 arg0, ..., atyN argN);
+///
+/// The wrapper will then look as follows:
+///   rty wrapper(aty0 arg0, ..., atyN argN) {
+///     return F(arg0, ..., argN);
+///   }
+///
+static void createShallowWrapper(Function &F) {
+  assert(AllowShallowWrappers &&
+         "Cannot create a wrapper if it is not allowed!");
+  assert(!F.isDeclaration() && "Cannot create a wrapper around a declaration!");
+
+  Module &M = *F.getParent();
+  LLVMContext &Ctx = M.getContext();
+  FunctionType *FnTy = F.getFunctionType();
+
+  Function *Wrapper =
+      Function::Create(FnTy, F.getLinkage(), F.getAddressSpace(), F.getName());
+  F.setName(""); // set the inside function anonymous
+  M.getFunctionList().insert(F.getIterator(), Wrapper);
+
+  F.setLinkage(GlobalValue::InternalLinkage);
+
+  F.replaceAllUsesWith(Wrapper);
+  assert(F.getNumUses() == 0 && "Uses remained after wrapper was created!");
+
+  // Move the COMDAT section to the wrapper.
+  // TODO: Check if we need to keep it for F as well.
+  Wrapper->setComdat(F.getComdat());
+  F.setComdat(nullptr);
+
+  // Copy all metadata and attributes but keep them on F as well.
+  SmallVector<std::pair<unsigned, MDNode *>, 1> MDs;
+  F.getAllMetadata(MDs);
+  for (auto MDIt : MDs)
+    Wrapper->addMetadata(MDIt.first, *MDIt.second);
+  Wrapper->setAttributes(F.getAttributes());
+
+  // Create the call in the wrapper.
+  BasicBlock *EntryBB = BasicBlock::Create(Ctx, "entry", Wrapper);
+
+  SmallVector<Value *, 8> Args;
+  auto FArgIt = F.arg_begin();
+  for (Argument &Arg : Wrapper->args()) {
+    Args.push_back(&Arg);
+    Arg.setName((FArgIt++)->getName());
+  }
+
+  CallInst *CI = CallInst::Create(&F, Args, "", EntryBB);
+  CI->setTailCall(true);
+  CI->addAttribute(AttributeList::FunctionIndex, Attribute::NoInline);
+  ReturnInst::Create(Ctx, CI->getType()->isVoidTy() ? nullptr : CI, EntryBB);
+
+  NumFnShallowWrapperCreated++;
+}
+
 bool Attributor::isValidFunctionSignatureRewrite(
     Argument &Arg, ArrayRef<Type *> ReplacementTypes) {
 
   auto CallSiteCanBeChanged = [](AbstractCallSite ACS) {
     // Forbid must-tail calls for now.
     return !ACS.isCallbackCall() && !ACS.getCallSite().isMustTailCall();
   };
 
static bool runAttributorOnFunctions(InformationCache &InfoCache,
 
   // Create an Attributor and initially empty information cache that is filled
   // while we identify default attribute opportunities.
   Attributor A(Functions, InfoCache, CGUpdater, DepRecInterval);
 
   for (Function *F : Functions)
     A.initializeInformationCache(*F);
 
+  // Create shallow wrappers for all functions that are not IPO amendable
+  if (AllowShallowWrappers)
+    for (Function *F : Functions)
+      if (!A.isFunctionIPOAmendable(*F))
+        createShallowWrapper(*F);
+
   for (Function *F : Functions) {
     if (F->hasExactDefinition())
       NumFnWithExactDefinition++;
     else
       NumFnWithoutExactDefinition++;
 
     // We look at internal functions only on-demand but if any use is not a
     // direct call or outside the current set of analyzed functions, we have to

llvm/test/Transforms/Attributor/wrapper.ll

+; RUN: opt -passes=attributor-cgscc -attributor-disable=false -attributor-annotate-decl-cs -attributor-allow-shallow-wrappers -S < %s | FileCheck %s --check-prefix=CHECK
+
+; TEST 1: simple test, without argument
+; A wrapper will be generated for this function, Check the wrapper first
+; CHECK-NOT: Function Attrs:
+; CHECK: define linkonce i32 @inner1()
+; CHECK: tail call i32 @0()
+; CHECK: ret
+;
+; Check the original function, which is wrapped and becomes anonymous
+; CHECK: Function Attrs: nofree norecurse nosync nounwind readnone willreturn
+; CHECK: define internal i32 @0()
+; CHECK: %a = alloca i32
+; CHECK: store i32 1, i32* %a
+; CHECK: %b = load i32, i32* %a
+; CHECK: ret i32 %b
+define linkonce i32 @inner1() {
+entry:
+  %a = alloca i32
+  store i32 1, i32* %a
+  %b = load i32, i32* %a
+  ret i32 %b
+}
+
+; Check for call
+; CHECK: define i32 @outer1
+; CHECK: call i32 @inner1
+; CHECK: ret
+define i32 @outer1() {
+entry:
+  %ret = call i32 @inner1()
+  ret i32 %ret
+}
+
+; TEST 2: with argument
+; CHECK-NOT: Function Attrs
+; CHECK: define linkonce i32 @inner2(i32 %a, i32 %b)
+; CHECK: tail call i32 @1(i32 %a, i32 %b)
+; CHECK: ret
+;
+; CHECK: Function Attrs: nofree norecurse nosync nounwind readnone willreturn
+; CHECK: define internal i32 @1(i32 %a, i32 %b)
+; CHECK: %c = add i32 %a, %b
+; CHECK: ret i32 %c
+define linkonce i32 @inner2(i32 %a, i32 %b) {
+entry:
+  %c = add i32 %a, %b
+  ret i32 %c
+}
+
+; CHECK: define i32 @outer2
+; CHECK: call i32 @inner2
+; CHECK: ret
+define i32 @outer2() {
+entry:
+  %ret = call i32 @inner2(i32 1, i32 2)
+  ret i32 %ret
+}
+
+; TEST 3: check nocurse
+; This function calls itself, there will be no attribute
+; CHECK-NOT: Function Attrs
+; CHECK: define linkonce i32 @inner3(i32 %0)
+; CHECK: tail call i32 @2(i32 %0)
+; CHECK: ret
+;
+; CHECK-NOT: Function Attrs:
+; CHECK: define internal i32 @2(i32 %0)
+define linkonce i32 @inner3(i32) {
+entry:
+  %1 = alloca i32
+  store i32 %0, i32* %1
+  br label %2
+2:
+  %3 = load i32, i32* %1
+  %4 = icmp slt i32 %3, 4
+  br i1 %4, label %5, label %9
+5:
+  %6 = load i32, i32* %1
+  %7 = add nsw i32 %6, 1
+  %8 = call i32 @inner3(i32 %7)
+  store i32 %8, i32* %1
+  br label %2
+9:
+  %10 = load i32, i32* %1
+  ret i32 %10
+}
+