llvm-project/mlir/lib/Target/LLVMIR/LoopAnnotationTranslation.h
Christian Ulmann 87a0479538 [mlir][llvm] Fuse access_group & loop export (NFC)
This commit moves the access group translation into the
LoopAnnotationTranslation class as these two metadata kinds only appear
together.

Drops the access group cleanup from `ModuleTranslation::forgetMapping`
as this is only used on function regions. Access groups only appear in the
region of a global metadata operation and will thus not be cleaned here.

Analogous to https://reviews.llvm.org/D143577

Reviewed By: gysit

Differential Revision: https://reviews.llvm.org/D144253
2023-02-17 15:31:21 +01:00

78 lines
3.0 KiB
C++

//===- LoopAnnotationTranslation.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
//
//===----------------------------------------------------------------------===//
//
// This file implements the translation between an MLIR loop annotations and
// the corresponding LLVMIR metadata representation.
//
//===----------------------------------------------------------------------===//
#ifndef MLIR_LIB_TARGET_LLVMIR_LOOPANNOTATIONTRANSLATION_H_
#define MLIR_LIB_TARGET_LLVMIR_LOOPANNOTATIONTRANSLATION_H_
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
#include "mlir/Target/LLVMIR/ModuleTranslation.h"
namespace mlir {
namespace LLVM {
namespace detail {
/// A helper class that converts LoopAnnotationAttrs and AccessGroupMetadataOps
/// into a corresponding llvm::MDNodes.
class LoopAnnotationTranslation {
public:
LoopAnnotationTranslation(Operation *mlirModule, llvm::Module &llvmModule)
: mlirModule(mlirModule), llvmModule(llvmModule) {}
llvm::MDNode *translateLoopAnnotation(LoopAnnotationAttr attr, Operation *op);
/// Traverses the global access group metadata operation in the `mlirModule`
/// and creates corresponding LLVM metadata nodes.
LogicalResult createAccessGroupMetadata();
/// Returns the LLVM metadata corresponding to a symbol reference to an mlir
/// LLVM dialect access group operation.
llvm::MDNode *getAccessGroup(Operation *op,
SymbolRefAttr accessGroupRef) const;
/// Returns the LLVM metadata corresponding to a list of symbol reference to
/// an mlir LLVM dialect access group operation. Returns nullptr if
/// `accessGroupRefs` is null or empty.
llvm::MDNode *getAccessGroups(Operation *op, ArrayAttr accessGroupRefs) const;
private:
/// Returns the LLVM metadata corresponding to a llvm loop metadata attribute.
llvm::MDNode *lookupLoopMetadata(Attribute options) const {
return loopMetadataMapping.lookup(options);
}
void mapLoopMetadata(Attribute options, llvm::MDNode *metadata) {
auto result = loopMetadataMapping.try_emplace(options, metadata);
(void)result;
assert(result.second &&
"attempting to map loop options that was already mapped");
}
/// Mapping from an attribute describing loop metadata to its LLVM metadata.
/// The metadata is attached to Latch block branches with this attribute.
DenseMap<Attribute, llvm::MDNode *> loopMetadataMapping;
/// Mapping from an access group metadata operation to its LLVM metadata.
/// This map is populated on module entry and is used to annotate loops (as
/// identified via their branches) and contained memory accesses.
DenseMap<Operation *, llvm::MDNode *> accessGroupMetadataMapping;
Operation *mlirModule;
llvm::Module &llvmModule;
};
} // namespace detail
} // namespace LLVM
} // namespace mlir
#endif // MLIR_LIB_TARGET_LLVMIR_LOOPANNOTATIONTRANSLATION_H_