MultiImageFortran.h

//===-- Lower/MultiImageFortran.h -- image related lowering -----*- 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
//
//===----------------------------------------------------------------------===//
 
#ifndef FORTRAN_LOWER_MULTIIMAGEFORTRAN_H
#define FORTRAN_LOWER_MULTIIMAGEFORTRAN_H
 
#include "flang/Lower/AbstractConverter.h"
#include "flang/Optimizer/Builder/BoxValue.h"
#include "flang/Optimizer/Dialect/MIF/MIFOps.h"
 
namespace Fortran {
 
namespace parser {
struct ChangeTeamConstruct;
struct ChangeTeamStmt;
struct EndChangeTeamStmt;
struct FormTeamStmt;
} // namespace parser
 
namespace evaluate {
class CoarrayRef;
} // namespace evaluate
 
namespace lower {
 
class SymMap;
 
namespace pft {
struct Evaluation;
} // namespace pft
 
mlir::SmallVector<mlir::Value>
getCosubscripts(AbstractConverter &converter, mlir::Location loc,
                const Fortran::evaluate::CoarrayRef &expr);
 
//===----------------------------------------------------------------------===//
// Synchronization statements
//===----------------------------------------------------------------------===//
 
void genSyncAllStatement(AbstractConverter &, const parser::SyncAllStmt &);
 
void genSyncImagesStatement(AbstractConverter &,
                            const parser::SyncImagesStmt &);
void genSyncMemoryStatement(AbstractConverter &,
                            const parser::SyncMemoryStmt &);
void genSyncTeamStatement(AbstractConverter &, const parser::SyncTeamStmt &);
 
//===----------------------------------------------------------------------===//
// TEAM constructs
//===----------------------------------------------------------------------===//
 
void genChangeTeamConstruct(AbstractConverter &, pft::Evaluation &eval,
                            const parser::ChangeTeamConstruct &);
mif::ChangeTeamOp genChangeTeamStmt(AbstractConverter &, pft::Evaluation &eval,
                                    const parser::ChangeTeamStmt &);
void genEndChangeTeamStmt(AbstractConverter &, pft::Evaluation &eval,
                          const parser::EndChangeTeamStmt &);
void genFormTeamStatement(AbstractConverter &, pft::Evaluation &eval,
                          const parser::FormTeamStmt &);
 
//===----------------------------------------------------------------------===//
// COARRAY utils
//===----------------------------------------------------------------------===//
 
mlir::SmallVector<mlir::Value>
getCosubscripts(AbstractConverter &converter, mlir::Location loc,
                const evaluate::CoarrayRef &expr);
 
mlir::Value genLowerCoBounds(AbstractConverter &converter, mlir::Location loc,
                             const semantics::Symbol &sym);
 
mlir::Value genUpperCoBounds(AbstractConverter &converter, mlir::Location loc,
                             const semantics::Symbol &sym);
 
mlir::Value genAllocateCoarray(
    AbstractConverter &converter, mlir::Location loc,
    const semantics::Symbol &sym, mlir::Value addr,
    const std::optional<Fortran::parser::AllocateCoarraySpec> &allocSpec =
        std::nullopt,
    mlir::Value errMsg = {}, bool hasStat = false);
 
void genAllocateNonAllocatableSaveCoarray(AbstractConverter &converter,
                                          mlir::Location loc,
                                          const semantics::Symbol &sym,
                                          mlir::Value addr);
 
//===----------------------------------------------------------------------===//
// EVENT and NOTIFY statements
//===----------------------------------------------------------------------===//
 
void genNotifyWaitStatement(AbstractConverter &,
                            const parser::NotifyWaitStmt &);
void genEventPostStatement(AbstractConverter &, const parser::EventPostStmt &);
void genEventWaitStatement(AbstractConverter &, const parser::EventWaitStmt &);
 
//===----------------------------------------------------------------------===//
// COARRAY expressions
//===----------------------------------------------------------------------===//

class CoarrayExprHelper {
public:
  explicit CoarrayExprHelper(AbstractConverter &converter, mlir::Location loc,
                             SymMap &syms)
      : converter{converter}, symMap{syms}, loc{loc} {}
  CoarrayExprHelper(const CoarrayExprHelper &) = delete;

  fir::ExtendedValue genAddr(const evaluate::CoarrayRef &expr);

  fir::ExtendedValue genValue(const evaluate::CoarrayRef &expr);
 
private:
  AbstractConverter &converter;
  SymMap &symMap;
  mlir::Location loc;
};
 
} // namespace lower
} // namespace Fortran
 
#endif // FORTRAN_LOWER_MULTIIMAGEFORTRAN_H