[flang][NFC] Add TODOs for KIND = 2

[clementval]

Summary

Add TODO for KIND=2 so the user is notified correctly.

This patch is part of the upstreaming effort from fir-dev branch.

Co-authored-by: Peter Steinfeld <[e-mail]>

[jeanPerier]

LGTM

[PeteSteinfeld]

All builds and tests correctly, but it would be better to have calls to TODO() rather than fatal unsupported messages.

flang/lib/Optimizer/Builder/Runtime/Numeric.cpp

239

In other similar situations, we emit a TODO rather than a fatal unsupported message. This helps guarantee that we catch all such errors in the front end rather than in the runtime.

264

Same here.

291

And here.

328

And here.

355

And here.

381

And here.

406

And here.

[clementval]

flang/lib/Optimizer/Builder/Runtime/Numeric.cpp

239

But is this really a "TODO"? I don't think we plan to support more types here.

[PeteSteinfeld]

flang/lib/Optimizer/Builder/Runtime/Numeric.cpp

239

Sounds good. I'll approve.

flang/lib/Optimizer/Builder/Runtime/Numeric.cpp

 //===-- Numeric.cpp -- runtime API for numeric intrinsics -----------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "flang/Optimizer/Builder/Runtime/Numeric.h"
 #include "flang/Optimizer/Builder/BoxValue.h"
 #include "flang/Optimizer/Builder/Character.h"
 #include "flang/Optimizer/Builder/FIRBuilder.h"
 #include "flang/Optimizer/Builder/Runtime/RTBuilder.h"
+#include "flang/Optimizer/Builder/Todo.h"
 #include "flang/Runtime/numeric.h"
 #include "mlir/Dialect/Func/IR/FuncOps.h"
 
 using namespace Fortran::runtime;
 
 // The real*10 and real*16 placeholders below are used to force the
 // compilation of the real*10 and real*16 method names on systems that
 // may not have them in their runtime library. This can occur in the

 
 /// Generate call to Exponent instrinsic runtime routine.
 mlir::Value fir::runtime::genExponent(fir::FirOpBuilder &builder,
                                       mlir::Location loc, mlir::Type resultType,
                                       mlir::Value x) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
 
-  if (fltTy.isF32()) {
+  if (fltTy.isF16()) {
+    TODO(loc, "support for REAL with KIND = 2 in EXPONENT");
+  } else if (fltTy.isF32()) {
     if (resultType.isInteger(32))
       func = fir::runtime::getRuntimeFunc<mkRTKey(Exponent4_4)>(loc, builder);
     else if (resultType.isInteger(64))
       func = fir::runtime::getRuntimeFunc<mkRTKey(Exponent4_8)>(loc, builder);
   } else if (fltTy.isF64()) {
     if (resultType.isInteger(32))
       func = fir::runtime::getRuntimeFunc<mkRTKey(Exponent8_4)>(loc, builder);
     else if (resultType.isInteger(64))
       func = fir::runtime::getRuntimeFunc<mkRTKey(Exponent8_8)>(loc, builder);
   } else if (fltTy.isF80()) {
     if (resultType.isInteger(32))
       func = fir::runtime::getRuntimeFunc<ForcedExponent10_4>(loc, builder);
     else if (resultType.isInteger(64))
       func = fir::runtime::getRuntimeFunc<ForcedExponent10_8>(loc, builder);
   } else if (fltTy.isF128()) {
     if (resultType.isInteger(32))
       func = fir::runtime::getRuntimeFunc<ForcedExponent16_4>(loc, builder);
     else if (resultType.isInteger(64))
       func = fir::runtime::getRuntimeFunc<ForcedExponent16_8>(loc, builder);
   } else
-    fir::emitFatalError(loc, "unsupported real kind in Exponent lowering");
+    fir::emitFatalError(loc, "unsupported REAL KIND in EXPONENT");
 
   auto funcTy = func.getFunctionType();
   llvm::SmallVector<mlir::Value> args = {
       builder.createConvert(loc, funcTy.getInput(0), x)};
 
   return builder.create<fir::CallOp>(loc, func, args).getResult(0);
 }
 
 /// Generate call to Fraction instrinsic runtime routine.
 mlir::Value fir::runtime::genFraction(fir::FirOpBuilder &builder,
                                       mlir::Location loc, mlir::Value x) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
-
-  if (fltTy.isF32())
+  if (fltTy.isF16())
+    TODO(loc, "support for REAL with KIND = 2 in FRACTION");
+  else if (fltTy.isF32())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Fraction4)>(loc, builder);
   else if (fltTy.isF64())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Fraction8)>(loc, builder);
   else if (fltTy.isF80())
     func = fir::runtime::getRuntimeFunc<ForcedFraction10>(loc, builder);
   else if (fltTy.isF128())
     func = fir::runtime::getRuntimeFunc<ForcedFraction16>(loc, builder);
   else
-    fir::emitFatalError(loc, "unsupported real kind in Fraction lowering");
+    fir::emitFatalError(loc, "unsupported real kind in FRACTION");
 
   auto funcTy = func.getFunctionType();
   llvm::SmallVector<mlir::Value> args = {
       builder.createConvert(loc, funcTy.getInput(0), x)};
 
   return builder.create<fir::CallOp>(loc, func, args).getResult(0);
 }
 
 /// Generate call to Nearest intrinsic runtime routine.
 mlir::Value fir::runtime::genNearest(fir::FirOpBuilder &builder,
                                      mlir::Location loc, mlir::Value x,
                                      mlir::Value s) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
 
-  if (fltTy.isF32())
+  if (fltTy.isF16())
+    TODO(loc, "support for REAL with KIND = 2 in NEAREST");
+  else if (fltTy.isF32())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Nearest4)>(loc, builder);
   else if (fltTy.isF64())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Nearest8)>(loc, builder);
   else if (fltTy.isF80())
     func = fir::runtime::getRuntimeFunc<ForcedNearest10>(loc, builder);
   else if (fltTy.isF128())
     func = fir::runtime::getRuntimeFunc<ForcedNearest16>(loc, builder);
   else
-    fir::emitFatalError(loc, "unsupported REAL kind in Nearest lowering");
+    fir::emitFatalError(loc, "unsupported REAL kind in NEAREST");
 
   auto funcTy = func.getFunctionType();
 
   mlir::Type sTy = s.getType();
   mlir::Value zero = builder.createRealZeroConstant(loc, sTy);
   auto cmp = builder.create<mlir::arith::CmpFOp>(
       loc, mlir::arith::CmpFPredicate::OGT, s, zero);
 

 }
 
 /// Generate call to RRSpacing intrinsic runtime routine.
 mlir::Value fir::runtime::genRRSpacing(fir::FirOpBuilder &builder,
                                        mlir::Location loc, mlir::Value x) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
 
-  if (fltTy.isF32())
+  if (fltTy.isF16())
+    TODO(loc, "support for REAL with KIND = 2 in RRSPACING");
+  else if (fltTy.isF32())
     func = fir::runtime::getRuntimeFunc<mkRTKey(RRSpacing4)>(loc, builder);
   else if (fltTy.isF64())
     func = fir::runtime::getRuntimeFunc<mkRTKey(RRSpacing8)>(loc, builder);
   else if (fltTy.isF80())
     func = fir::runtime::getRuntimeFunc<ForcedRRSpacing10>(loc, builder);
   else if (fltTy.isF128())
     func = fir::runtime::getRuntimeFunc<ForcedRRSpacing16>(loc, builder);
   else
-    fir::emitFatalError(loc, "unsupported real kind in RRSpacing lowering");
+    fir::emitFatalError(loc, "unsupported real kind in RRSPACING");
 
   auto funcTy = func.getFunctionType();
   llvm::SmallVector<mlir::Value> args = {
       builder.createConvert(loc, funcTy.getInput(0), x)};
 
   return builder.create<fir::CallOp>(loc, func, args).getResult(0);
 }
 
 /// Generate call to Scale intrinsic runtime routine.
 mlir::Value fir::runtime::genScale(fir::FirOpBuilder &builder,
                                    mlir::Location loc, mlir::Value x,
                                    mlir::Value i) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
 
-  if (fltTy.isF32())
+  if (fltTy.isF16())
+    TODO(loc, "support for REAL with KIND = 2 in SCALE");
+  else if (fltTy.isF32())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Scale4)>(loc, builder);
   else if (fltTy.isF64())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Scale8)>(loc, builder);
   else if (fltTy.isF80())
     func = fir::runtime::getRuntimeFunc<ForcedScale10>(loc, builder);
   else if (fltTy.isF128())
     func = fir::runtime::getRuntimeFunc<ForcedScale16>(loc, builder);
   else
-    fir::emitFatalError(loc, "unsupported REAL kind in Scale lowering");
+    fir::emitFatalError(loc, "unsupported REAL kind in SCALE");
 
   auto funcTy = func.getFunctionType();
   auto args = fir::runtime::createArguments(builder, loc, funcTy, x, i);
 
   return builder.create<fir::CallOp>(loc, func, args).getResult(0);
 }
 
 /// Generate call to Set_exponent instrinsic runtime routine.
 mlir::Value fir::runtime::genSetExponent(fir::FirOpBuilder &builder,
                                          mlir::Location loc, mlir::Value x,
                                          mlir::Value i) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
 
-  if (fltTy.isF32())
+  if (fltTy.isF16())
+    TODO(loc, "support for REAL with KIND = 2 in FRACTION");
+  else if (fltTy.isF32())
     func = fir::runtime::getRuntimeFunc<mkRTKey(SetExponent4)>(loc, builder);
   else if (fltTy.isF64())
     func = fir::runtime::getRuntimeFunc<mkRTKey(SetExponent8)>(loc, builder);
   else if (fltTy.isF80())
     func = fir::runtime::getRuntimeFunc<ForcedSetExponent10>(loc, builder);
   else if (fltTy.isF128())
     func = fir::runtime::getRuntimeFunc<ForcedSetExponent16>(loc, builder);
   else
-    fir::emitFatalError(loc, "unsupported real kind in Fraction lowering");
+    fir::emitFatalError(loc, "unsupported real kind in FRACTION");
 
   auto funcTy = func.getFunctionType();
   auto args = fir::runtime::createArguments(builder, loc, funcTy, x, i);
 
   return builder.create<fir::CallOp>(loc, func, args).getResult(0);
 }
 
 /// Generate call to Spacing intrinsic runtime routine.
 mlir::Value fir::runtime::genSpacing(fir::FirOpBuilder &builder,
                                      mlir::Location loc, mlir::Value x) {
   mlir::func::FuncOp func;
   mlir::Type fltTy = x.getType();
 
-  if (fltTy.isF32())
+  if (fltTy.isF16())
+    TODO(loc, "support for REAL with KIND = 2 in SPACING");
+  else if (fltTy.isF32())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Spacing4)>(loc, builder);
   else if (fltTy.isF64())
     func = fir::runtime::getRuntimeFunc<mkRTKey(Spacing8)>(loc, builder);
   else if (fltTy.isF80())
     func = fir::runtime::getRuntimeFunc<ForcedSpacing10>(loc, builder);
   else if (fltTy.isF128())
     func = fir::runtime::getRuntimeFunc<ForcedSpacing16>(loc, builder);
   else
-    fir::emitFatalError(loc, "unsupported real kind in Spacing lowering");
+    fir::emitFatalError(loc, "unsupported real kind in SPACING");
 
   auto funcTy = func.getFunctionType();
   llvm::SmallVector<mlir::Value> args = {
       builder.createConvert(loc, funcTy.getInput(0), x)};
 
   return builder.create<fir::CallOp>(loc, func, args).getResult(0);
 }