include/mlir/Dialect/SCF/IR/DeviceMappingInterface.td

//===- DeviceMappingInterface.td - Device mapping interfaces*- tablegen -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Defines the interfaces for the device mapping specification for the loops.
//
//===----------------------------------------------------------------------===//

#ifndef MLIR_DEVICEMAPPINGINTERFACE
#define MLIR_DEVICEMAPPINGINTERFACE

include "mlir/IR/OpBase.td"

//===----------------------------------------------------------------------===//
// Attribute interfaces
//===----------------------------------------------------------------------===//

def DeviceMappingAttrInterface : AttrInterface<"DeviceMappingAttrInterface"> {
  let cppNamespace = "::mlir";
  let description = [{
    Attribute interface describing how to map a region to a processing unit.

    It is intended to be a generic mechanism for binding regions to execution
    units of an actual or virtual device. Each device first expresses its own
    mappings, and those mappings must implement this interface. These mappings
    can be used by the device-specific code generators and the desired regions
    can be connected to the given processing unit.

    Currently, `scf.forall` uses this interface to express the mapping
    of the loops it contains to the GPU's parallelism units such as threads and
    thread blocks.
  }];

 let methods = [
    InterfaceMethod<
      /*desc=*/"Return mapping as an integer from the attribute.",
      /*retTy=*/"int64_t",
      /*methodName=*/"getMappingId",
      /*args=*/(ins)
    >,
    InterfaceMethod<
      /*desc=*/"Return true if the attribute specifies a linear mapping",
      /*retTy=*/"bool",
      /*methodName=*/"isLinearMapping",
      /*args=*/(ins)
    >,
    InterfaceMethod<
      /*desc=*/[{
        Return the [0..n) relative index of the attribute depending on its group.
        This can be used to index into a contiguous array.
      }],
      /*retTy=*/"int64_t",
      /*methodName=*/"getRelativeIndex", 
      /*args=*/(ins)
    >
  ];
}

def DeviceMappingArrayAttr :
  TypedArrayAttrBase<DeviceMappingAttrInterface,
  "Device Mapping array attribute"> { }

#endif // MLIR_DEVICEMAPPINGINTERFACE