[fir] Update fir.alloca op

[clementval]

Summary

Add pinned attributes and speicifc builders.

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

Coming from PR: https://github.com/flang-compiler/f18-llvm-project/pull/1065

Co-authored-by: Kiran Chandramohan <[e-mail]>

[kiranchandramohan]

The pinned attribute helps mark those allocas in OpenMP regions that should not be hoisted out by an alloca hoisting pass.

LGTM.

[clementval]

Thansk for the review Kiran. Patch pushed with you as the initial author.

[mehdi_amini]

flang/include/flang/Optimizer/Dialect/FIROps.td

282

Could the doc for the op be updated?

[clementval]

flang/include/flang/Optimizer/Dialect/FIROps.td

282

Added in D110877

flang/include/flang/Optimizer/Dialect/FIROps.td

let description = [{
     convert these large stack allocations to heap allocations regardless of
     whether the procedure is recursive or not.
   }];
 
   let arguments = (ins
     TypeAttr:$in_type,
     OptionalAttr<StrAttr>:$uniq_name,
     OptionalAttr<StrAttr>:$bindc_name,
+    UnitAttr:$pinned,
     Variadic<AnyIntegerType>:$typeparams,
     Variadic<AnyIntegerType>:$shape
   );
 
   let results = (outs fir_ReferenceType);
 
   let parser =
       "return parseAllocatableOp(wrapAllocaResultType, parser, result);";
   let printer = "printAllocatableOp(p, (*this));";
 
   let builders = [
     OpBuilder<(ins "mlir::Type":$inType, "llvm::StringRef":$uniqName,
       "llvm::StringRef":$bindcName, CArg<"mlir::ValueRange", "{}">:$typeparams,
        CArg<"mlir::ValueRange", "{}">:$shape,
        CArg<"llvm::ArrayRef<mlir::NamedAttribute>", "{}">:$attributes)>,
      OpBuilder<(ins "mlir::Type":$inType, "llvm::StringRef":$uniqName,
+       "llvm::StringRef":$bindcName, "bool":$pinned,
        CArg<"mlir::ValueRange", "{}">:$typeparams,
        CArg<"mlir::ValueRange", "{}">:$shape,
        CArg<"llvm::ArrayRef<mlir::NamedAttribute>", "{}">:$attributes)>,
-    OpBuilder<(ins "mlir::Type":$in_type,
+       OpBuilder<(ins "mlir::Type":$inType, "llvm::StringRef":$uniqName,
+       CArg<"mlir::ValueRange", "{}">:$typeparams,
+       CArg<"mlir::ValueRange", "{}">:$shape,
+       CArg<"llvm::ArrayRef<mlir::NamedAttribute>", "{}">:$attributes)>,
+     OpBuilder<(ins "mlir::Type":$inType, "llvm::StringRef":$uniqName,
+       "bool":$pinned, CArg<"mlir::ValueRange", "{}">:$typeparams,
+       CArg<"mlir::ValueRange", "{}">:$shape,
+       CArg<"llvm::ArrayRef<mlir::NamedAttribute>", "{}">:$attributes)>,
+     OpBuilder<(ins "mlir::Type":$inType, "bool":$pinned,
+       CArg<"mlir::ValueRange", "{}">:$typeparams,
+       CArg<"mlir::ValueRange", "{}">:$shape,
+       CArg<"llvm::ArrayRef<mlir::NamedAttribute>", "{}">:$attributes)>,
+     OpBuilder<(ins "mlir::Type":$inType,
        CArg<"mlir::ValueRange", "{}">:$typeparams,
        CArg<"mlir::ValueRange", "{}">:$shape,
        CArg<"llvm::ArrayRef<mlir::NamedAttribute>", "{}">:$attributes)>];
 
   let verifier = [{ return ::verify(*this); }];
 
   let extraClassDeclaration = [{
     mlir::Type getAllocatedType();
     bool hasLenParams() { return !typeparams().empty(); }
     bool hasShapeOperands() { return !shape().empty(); }
     unsigned numLenParams() { return typeparams().size(); }

flang/lib/Optimizer/Dialect/FIROps.cpp

 
 void fir::AllocaOp::build(mlir::OpBuilder &builder,
                           mlir::OperationState &result, mlir::Type inType,
                           llvm::StringRef uniqName, mlir::ValueRange typeparams,
                           mlir::ValueRange shape,
                           llvm::ArrayRef<mlir::NamedAttribute> attributes) {
   auto nameAttr = builder.getStringAttr(uniqName);
   build(builder, result, wrapAllocaResultType(inType), inType, nameAttr, {},
-        typeparams, shape);
+        /*pinned=*/false, typeparams, shape);
+  result.addAttributes(attributes);
+}
+
+void fir::AllocaOp::build(mlir::OpBuilder &builder,
+                          mlir::OperationState &result, mlir::Type inType,
+                          llvm::StringRef uniqName, bool pinned,
+                          mlir::ValueRange typeparams, mlir::ValueRange shape,
+                          llvm::ArrayRef<mlir::NamedAttribute> attributes) {
+  auto nameAttr = builder.getStringAttr(uniqName);
+  build(builder, result, wrapAllocaResultType(inType), inType, nameAttr, {},
+        pinned, typeparams, shape);
   result.addAttributes(attributes);
 }
 
 void fir::AllocaOp::build(mlir::OpBuilder &builder,
                           mlir::OperationState &result, mlir::Type inType,
                           llvm::StringRef uniqName, llvm::StringRef bindcName,
                           mlir::ValueRange typeparams, mlir::ValueRange shape,
                           llvm::ArrayRef<mlir::NamedAttribute> attributes) {
   auto nameAttr =
       uniqName.empty() ? mlir::StringAttr{} : builder.getStringAttr(uniqName);
   auto bindcAttr =
       bindcName.empty() ? mlir::StringAttr{} : builder.getStringAttr(bindcName);
   build(builder, result, wrapAllocaResultType(inType), inType, nameAttr,
-        bindcAttr, typeparams, shape);
+        bindcAttr, /*pinned=*/false, typeparams, shape);
+  result.addAttributes(attributes);
+}
+
+void fir::AllocaOp::build(mlir::OpBuilder &builder,
+                          mlir::OperationState &result, mlir::Type inType,
+                          llvm::StringRef uniqName, llvm::StringRef bindcName,
+                          bool pinned, mlir::ValueRange typeparams,
+                          mlir::ValueRange shape,
+                          llvm::ArrayRef<mlir::NamedAttribute> attributes) {
+  auto nameAttr =
+      uniqName.empty() ? mlir::StringAttr{} : builder.getStringAttr(uniqName);
+  auto bindcAttr =
+      bindcName.empty() ? mlir::StringAttr{} : builder.getStringAttr(bindcName);
+  build(builder, result, wrapAllocaResultType(inType), inType, nameAttr,
+        bindcAttr, pinned, typeparams, shape);
   result.addAttributes(attributes);
 }
 
 void fir::AllocaOp::build(mlir::OpBuilder &builder,
                           mlir::OperationState &result, mlir::Type inType,
                           mlir::ValueRange typeparams, mlir::ValueRange shape,
                           llvm::ArrayRef<mlir::NamedAttribute> attributes) {
   build(builder, result, wrapAllocaResultType(inType), inType, {}, {},
+        /*pinned=*/false, typeparams, shape);
+  result.addAttributes(attributes);
+}
+
+void fir::AllocaOp::build(mlir::OpBuilder &builder,
+                          mlir::OperationState &result, mlir::Type inType,
+                          bool pinned, mlir::ValueRange typeparams,
+                          mlir::ValueRange shape,
+                          llvm::ArrayRef<mlir::NamedAttribute> attributes) {
+  build(builder, result, wrapAllocaResultType(inType), inType, {}, {}, pinned,
         typeparams, shape);
   result.addAttributes(attributes);
 }
 
 static mlir::LogicalResult verify(fir::AllocaOp &op) {
   llvm::SmallVector<llvm::StringRef> visited;
   if (verifyInType(op.getInType(), visited, op.numShapeOperands()))
     return op.emitOpError("invalid type for allocation");