MemoryUtils.h

//===-- Optimizer/Transforms/MemoryUtils.h ----------------------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
//
//===----------------------------------------------------------------------===//
//
// This file defines a utility to replace fir.alloca by dynamic allocation and
// deallocation. The exact kind of dynamic allocation is left to be defined by
// the utility user via callbacks (could be fir.allocmem or custom runtime
// calls).
//
//===----------------------------------------------------------------------===//
 
#ifndef FORTRAN_OPTIMIZER_TRANSFORMS_MEMORYUTILS_H
#define FORTRAN_OPTIMIZER_TRANSFORMS_MEMORYUTILS_H
 
#include "flang/Optimizer/Dialect/FIROps.h"
 
namespace mlir {
class RewriterBase;
}
 
namespace fir {

using MustRewriteCallBack = llvm::function_ref<bool(fir::AllocaOp)>;

using AllocaRewriterCallBack = llvm::function_ref<mlir::Value(
    mlir::OpBuilder &, fir::AllocaOp, bool allocaDominatesDeallocLocations)>;
using DeallocCallBack =
    llvm::function_ref<void(mlir::Location, mlir::OpBuilder &, mlir::Value)>;

bool replaceAllocas(mlir::RewriterBase &rewriter, mlir::Operation *parentOp,
                    MustRewriteCallBack, AllocaRewriterCallBack,
                    DeallocCallBack);

fir::AllocMemOp createAllocMemFromAlloca(mlir::OpBuilder &builder,
                                         fir::AllocaOp alloca);

bool promoteDynamicVariableAllocasToCudaHeap(mlir::RewriterBase &rewriter,
                                             mlir::Operation *func);
 
} // namespace fir
 
#endif // FORTRAN_OPTIMIZER_TRANSFORMS_MEMORYUTILS_H