[ConstantFolding] Fix wrong folding of intrinsic 'convert.from.fp16'.

[andreadb]

Summary

This patch fixes a wrong constant folding of intrinsic 'convert.from.fp16'.

Function 'ConstantFoldScalarCall' (in ConstantFolding.cpp) works under the wrong assumption that a call to 'convert.from.fp16' always returns a value of type 'float'.

However, intrinsic 'convert.from.fp16' can be 'overloaded'; for example, we can use 'convert.from.fp16.fp64' to convert from half to double; etc.

Before this patch, the following example would have triggered an assertion failure in opt (with '-constprop'):

define double @foo() {
  entry:
  %0 = call double @llvm.convert.from.fp16.f64(i16 0)
  ret double %0
}

in Value.cpp:325: void llvm::Value::replaceAllUsesWith(llvm::Value*): Assertion `New->getType() == getType() && "replaceAllUses of value with new value of different type!" failed.

This patch fixes the problem in ConstantFolding.cpp. When folding a call to convert.from.fp16, we perform a different kind of conversion based on the call return type.

Added test 'Transform/ConstProp/convert-from-fp16.ll'.

Please let me know if ok to submit.

Thanks!
-Andrea

[ab]

LGTM, thanks!

-Ahmed

lib/Analysis/ConstantFolding.cpp

1403

I swear I saw the same construct elsewhere, but I can't find it. Is there a good header where this could go?

test/Transforms/ConstProp/convert-from-fp16.ll

3–4

Since this means the code was untested before, what using a non-0 value? For the extension, the significand of the result should look the same, so we can get creative. (but there's no point in testing APFloat again; it's just that 0 is easy to get right the wrong way)

7

CHECK-LABEL?

[ab]

lib/Analysis/ConstantFolding.cpp

1403

Ah, there's Type::getFltSemantics, please use that instead of re-defining it.

[andreadb]

Thanks for the review!

lib/Analysis/ConstantFolding.cpp

1403

You are right!
I should have use getFltSemantics() from Type.h.
I will use it :-).

test/Transforms/ConstProp/convert-from-fp16.ll

3–4

Right, I can add more tests. My original test case had something like this:

%0 = call i16 @llvm.convert.to.fp16.f64(double 5.25)
%1 = call double @llvm.convert.from.fp16.f64(i16 %0)
ret double %1

I can add more tests like the above example.
I'll send a new patch soon.

7

I will add CHECK-LABELs.

[andreadb]

Hi Ahmed,
I updated the patch based on your previous feedback.

This patch is much simpler now. As you suggested, I also added extra tests for values different than zero.

Please let me know what you think.
Thanks!
-Andrea

[ab]

Better indeed, go ahead!

-Ahmed

lib/Analysis/ConstantFolding.cpp

1568

Nit: I'd put the Ty->getFltSemantics() here instead of in the variable, but I'm fine with both ways.

lib/Analysis/ConstantFolding.cpp

if (Ty->isDoubleTy())
     return Op->getValueAPF().convertToDouble();
 
   bool unused;
   APFloat APF = Op->getValueAPF();
   APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &unused);
   return APF.convertToDouble();
 }
 
+// Returns the floating point arithmetic semantic associated to type 'Ty'.
+// This helper function is used by 'ConstantFoldScalarCall' when
+// constant folding intrinsic calls to 'convert_from_fp16'.
+static const fltSemantics &getFloatingPointSemanticFromType(const Type *Ty) {
+  if (Ty->isHalfTy())
+    return APFloat::IEEEhalf;
+  else if (Ty->isFloatTy())
+    return APFloat::IEEEsingle;
+  else if (Ty->isDoubleTy())
+    return APFloat::IEEEdouble;
+  else if (Ty->isFP128Ty())
+    return APFloat::IEEEquad;
+  else if (Ty->isX86_FP80Ty())
+    return APFloat::x87DoubleExtended;
+  else if (Ty->isPPC_FP128Ty())
+    return APFloat::PPCDoubleDouble;
+  llvm_unreachable("Not a floating point type!");
+}
+
 static Constant *ConstantFoldScalarCall(StringRef Name, unsigned IntrinsicID,
                                         Type *Ty, ArrayRef<Constant *> Operands,
                                         const TargetLibraryInfo *TLI) {
   if (Operands.size() == 1) {
     if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
       if (IntrinsicID == Intrinsic::convert_to_fp16) {
         APFloat Val(Op->getValueAPF());
 
if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
       case Intrinsic::bswap:
         return ConstantInt::get(Ty->getContext(), Op->getValue().byteSwap());
       case Intrinsic::ctpop:
         return ConstantInt::get(Ty, Op->getValue().countPopulation());
       case Intrinsic::convert_from_fp16: {
         APFloat Val(APFloat::IEEEhalf, Op->getValue());
 
         bool lost = false;
+        
+        const fltSemantics &FPS = getFloatingPointSemanticFromType(Ty);
         APFloat::opStatus status =
-          Val.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &lost);
+          Val.convert(FPS, APFloat::rmNearestTiesToEven, &lost);
 
         // Conversion is always precise.
         (void)status;
         assert(status == APFloat::opOK && !lost &&
                "Precision lost during fp16 constfolding");
 
         return ConstantFP::get(Ty->getContext(), Val);
       }

test/Transforms/ConstProp/convert-from-fp16.ll

+; RUN: opt -constprop -S < %s | FileCheck %s
+
+; Verify that we don't crash with an assertion failure when constant folding
+; a call to intrinsic 'convert.from.fp16' if the return type is not 'float'.
+
+define float @fold_from_fp16_to_fp32() {
+; CHECK: ret float 0.000000e+00
+entry:
+  %0 = call float @llvm.convert.from.fp16.f32(i16 0)
+  ret float %0
+}
+
+define double @fold_from_fp16_to_fp64() {
+; CHECK: ret double 0.000000e+00
+entry:
+  %0 = call double @llvm.convert.from.fp16.f64(i16 0)
+  ret double %0
+}
+
+define x86_fp80 @fold_from_fp16_to_fp80() {
+; CHECK: ret x86_fp80 0xK00000000000000000000
+entry:
+  %0 = call x86_fp80 @llvm.convert.from.fp16.f80(i16 0)
+  ret x86_fp80 %0
+}
+
+define fp128 @fold_from_fp16_to_fp128() {
+; CHECK: ret fp128 0xL00000000000000000000000000000000
+entry:
+  %0 = call fp128 @llvm.convert.from.fp16.f128(i16 0)
+  ret fp128 %0
+}
+
+define ppc_fp128 @fold_from_fp16_to_ppcfp128() {
+; CHECK: ret ppc_fp128 0xM00000000000000000000000000000000
+entry:
+  %0 = call ppc_fp128 @llvm.convert.from.fp16.ppcf128(i16 0)
+  ret ppc_fp128 %0
+}
+
+declare float @llvm.convert.from.fp16.f32(i16)
+declare double @llvm.convert.from.fp16.f64(i16)
+declare x86_fp80 @llvm.convert.from.fp16.f80(i16)
+declare fp128 @llvm.convert.from.fp16.f128(i16)
+declare ppc_fp128 @llvm.convert.from.fp16.ppcf128(i16)