FIROpenACCUtils.h

//===- FIROpenACCUtils.h - FIR OpenACC Utilities ----------------*- 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
//
//===----------------------------------------------------------------------===//
//
// This file declares utility functions for FIR OpenACC support.
//
//===----------------------------------------------------------------------===//
 
#ifndef FORTRAN_OPTIMIZER_OPENACC_SUPPORT_FIROPENACCUTILS_H
#define FORTRAN_OPTIMIZER_OPENACC_SUPPORT_FIROPENACCUTILS_H
 
#include "mlir/Dialect/OpenACC/OpenACC.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/Operation.h"
#include "mlir/IR/Region.h"
#include "mlir/IR/Value.h"
#include <string>
 
namespace fir {
namespace acc {

std::string getVariableName(mlir::Value v, bool preferDemangledName = true);

std::string getRecipeName(mlir::acc::RecipeKind kind, mlir::Type type,
                          mlir::Value var = nullptr,
                          llvm::ArrayRef<mlir::Value> bounds = {},
                          mlir::acc::ReductionOperator reductionOp =
                              mlir::acc::ReductionOperator::AccNone);

bool areAllBoundsConstant(llvm::ArrayRef<mlir::Value> bounds);

mlir::SymbolRefAttr
createOrGetPrivateRecipe(mlir::OpBuilder &builder, mlir::Location loc,
                         mlir::Value var,
                         llvm::SmallVector<mlir::Value> &dataBoundOps);

mlir::SymbolRefAttr
createOrGetFirstprivateRecipe(mlir::OpBuilder &builder, mlir::Location loc,
                              mlir::Value var,
                              llvm::SmallVector<mlir::Value> &dataBoundOps);

mlir::SymbolRefAttr
createOrGetReductionRecipe(mlir::OpBuilder &builder, mlir::Location loc,
                           mlir::Value var, mlir::acc::ReductionOperator op,
                           llvm::SmallVector<mlir::Value> &dataBoundOps,
                           mlir::Attribute fastMathAttr = {});

mlir::Value getOriginalDef(mlir::Value value, bool stripDeclare = true);

bool isValidSymbolUse(mlir::Operation *user, mlir::SymbolRefAttr symbol,
                      mlir::Operation **definingOpPtr = nullptr);

bool isValidValueUse(mlir::Value val, mlir::Region &region);
 
} // namespace acc
} // namespace fir
 
#endif // FORTRAN_OPTIMIZER_OPENACC_SUPPORT_FIROPENACCUTILS_H