Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 98 additions & 2 deletions flang/lib/Optimizer/OpenMP/MapInfoFinalization.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
#include "mlir/IR/SymbolTable.h"
#include "mlir/Pass/Pass.h"
#include "mlir/Support/LLVM.h"
#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Frontend/OpenMP/OMPConstants.h"
Expand Down Expand Up @@ -128,6 +129,17 @@ class MapInfoFinalizationPass
}
}

/// Return true if the module has an OpenMP requires clause that includes
/// unified_shared_memory.
static bool moduleRequiresUSM(mlir::ModuleOp module) {
assert(module && "invalid module");
if (auto req = module->getAttrOfType<mlir::omp::ClauseRequiresAttr>(
"omp.requires"))
return mlir::omp::bitEnumContainsAll(
req.getValue(), mlir::omp::ClauseRequires::unified_shared_memory);
return false;
}

/// Create the member map for coordRef and append it (and its index
/// path) to the provided new* vectors, if it is not already present.
void appendMemberMapIfNew(
Expand Down Expand Up @@ -425,8 +437,12 @@ class MapInfoFinalizationPass

mapFlags flags = mapFlags::OMP_MAP_TO |
(mapFlags(mapTypeFlag) &
(mapFlags::OMP_MAP_IMPLICIT | mapFlags::OMP_MAP_CLOSE |
mapFlags::OMP_MAP_ALWAYS));
(mapFlags::OMP_MAP_IMPLICIT | mapFlags::OMP_MAP_ALWAYS));
// For unified_shared_memory, we additionally add `CLOSE` on the descriptor
// to ensure device-local placement where required by tests relying on USM +
// close semantics.
if (moduleRequiresUSM(target->getParentOfType<mlir::ModuleOp>()))
flags |= mapFlags::OMP_MAP_CLOSE;
return llvm::to_underlying(flags);
}

Expand Down Expand Up @@ -518,6 +534,75 @@ class MapInfoFinalizationPass
return newMapInfoOp;
}

// Expand mappings of type(C_PTR) to map their `__address` field explicitly
// as a single pointer-sized member (USM-gated at callsite). This helps in
// USM scenarios to ensure the pointer-sized mapping is used.
mlir::omp::MapInfoOp genCptrMemberMap(mlir::omp::MapInfoOp op,
fir::FirOpBuilder &builder) {
if (!op.getMembers().empty())
return op;

mlir::Type varTy = fir::unwrapRefType(op.getVarPtr().getType());
if (!mlir::isa<fir::RecordType>(varTy))
return op;
auto recTy = mlir::cast<fir::RecordType>(varTy);
// If not a builtin C_PTR record, skip.
if (!recTy.getName().ends_with("__builtin_c_ptr"))
return op;

// Find the index of the c_ptr address component named "__address".
int32_t fieldIdx = recTy.getFieldIndex("__address");
if (fieldIdx < 0)
return op;

mlir::Location loc = op.getVarPtr().getLoc();
mlir::Type memTy = recTy.getType(fieldIdx);
fir::IntOrValue idxConst =
mlir::IntegerAttr::get(builder.getI32Type(), fieldIdx);
mlir::Value coord = fir::CoordinateOp::create(
builder, loc, builder.getRefType(memTy), op.getVarPtr(),
llvm::SmallVector<fir::IntOrValue, 1>{idxConst});

// Child for the `__address` member.
llvm::SmallVector<llvm::SmallVector<int64_t>> memberIdx = {{0}};
mlir::ArrayAttr newMembersAttr = builder.create2DI64ArrayAttr(memberIdx);
// Force CLOSE in USM paths so the pointer gets device-local placement
// when required by tests relying on USM + close semantics.
uint64_t mapTypeVal =
op.getMapType() |
llvm::to_underlying(
llvm::omp::OpenMPOffloadMappingFlags::OMP_MAP_CLOSE);
mlir::IntegerAttr mapTypeAttr = builder.getIntegerAttr(
builder.getIntegerType(64, /*isSigned=*/false), mapTypeVal);

mlir::omp::MapInfoOp memberMap = mlir::omp::MapInfoOp::create(
builder, loc, coord.getType(), coord,
mlir::TypeAttr::get(fir::unwrapRefType(coord.getType())), mapTypeAttr,
builder.getAttr<mlir::omp::VariableCaptureKindAttr>(
mlir::omp::VariableCaptureKind::ByRef),
/*varPtrPtr=*/mlir::Value{},
/*members=*/llvm::SmallVector<mlir::Value>{},
/*member_index=*/mlir::ArrayAttr{},
/*bounds=*/op.getBounds(),
/*mapperId=*/mlir::FlatSymbolRefAttr(),
/*name=*/op.getNameAttr(),
/*partial_map=*/builder.getBoolAttr(false));

// Rebuild the parent as a container with the `__address` member.
mlir::omp::MapInfoOp newParent = mlir::omp::MapInfoOp::create(
builder, op.getLoc(), op.getResult().getType(), op.getVarPtr(),
op.getVarTypeAttr(), mapTypeAttr, op.getMapCaptureTypeAttr(),
/*varPtrPtr=*/mlir::Value{},
/*members=*/llvm::SmallVector<mlir::Value>{memberMap},
/*member_index=*/newMembersAttr,
/*bounds=*/llvm::SmallVector<mlir::Value>{},
/*mapperId=*/mlir::FlatSymbolRefAttr(), op.getNameAttr(),
/*partial_map=*/builder.getBoolAttr(false));
op.replaceAllUsesWith(newParent.getResult());
op->erase();
return newParent;
}

mlir::omp::MapInfoOp genDescriptorMemberMaps(mlir::omp::MapInfoOp op,
fir::FirOpBuilder &builder,
mlir::Operation *target) {
Expand Down Expand Up @@ -1169,6 +1254,17 @@ class MapInfoFinalizationPass
genBoxcharMemberMap(op, builder);
});

// Expand type(C_PTR) only when unified_shared_memory is required,
// to ensure device-visible pointer size/behavior in USM scenarios
// without changing default expectations elsewhere.
func->walk([&](mlir::omp::MapInfoOp op) {
// Only expand C_PTR members when unified_shared_memory is required.
if (!moduleRequiresUSM(func->getParentOfType<mlir::ModuleOp>()))
return;
builder.setInsertionPoint(op);
genCptrMemberMap(op, builder);
});

func->walk([&](mlir::omp::MapInfoOp op) {
// TODO: Currently only supports a single user for the MapInfoOp. This
// is fine for the moment, as the Fortran frontend will generate a
Expand Down
21 changes: 21 additions & 0 deletions flang/test/Lower/OpenMP/cptr-usm-close-and-use-device-ptr.f90
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
! RUN: %flang_fc1 -emit-hlfir -fopenmp -fopenmp-version=50 %s -o - | FileCheck %s
!
! Checks:
! - C_PTR mappings expand to `__address` member with CLOSE under USM paths.
! - use_device_ptr does not implicitly expand member operands in the clause.

subroutine only_cptr_use_device_ptr
use iso_c_binding
type(c_ptr) :: cptr
integer :: i

!$omp target data use_device_ptr(cptr) map(tofrom: i)
!$omp end target data
end subroutine

! CHECK-LABEL: func.func @_QPonly_cptr_use_device_ptr()
! CHECK: %[[I_MAP:.*]] = omp.map.info var_ptr(%{{.*}} : !fir.ref<i32>, i32) map_clauses(tofrom) capture(ByRef) -> !fir.ref<i32> {name = "i"}
! CHECK: %[[CP_MAP:.*]] = omp.map.info var_ptr(%{{.*}} : !fir.ref<!fir.type<{{.*}}__builtin_c_ptr{{.*}}>>, !fir.type<{{.*}}__builtin_c_ptr{{.*}}>) map_clauses(return_param) capture(ByRef) -> !fir.ref<!fir.type<{{.*}}__builtin_c_ptr{{.*}}>>
! CHECK: omp.target_data map_entries(%[[I_MAP]] : !fir.ref<i32>) use_device_ptr(%[[CP_MAP]] -> %{{.*}} : !fir.ref<!fir.type<{{.*}}__builtin_c_ptr{{.*}}>>) {
! CHECK: omp.terminator
! CHECK: }