TosaToLinalg.h

Go to the documentation of this file.

//===- TosaToLinalg.h - TOSA optimization pass declarations ---------------===//
//
// 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 the passes for the TOSA Linalg Dialect in MLIR.
//
//===----------------------------------------------------------------------===//
 
#ifndef MLIR_CONVERSION_TOSATOLINALG_TOSATOLINALG_H
#define MLIR_CONVERSION_TOSATOLINALG_TOSATOLINALG_H
 
#include "mlir/Dialect/Linalg/IR/Linalg.h"
#include "mlir/Dialect/Tosa/Transforms/Passes.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/Pass/Pass.h"
#include "llvm/ADT/DenseMap.h"
 
#include <optional>
#include <utility>
 
namespace mlir {
#define GEN_PASS_DECL_TOSATOLINALG
#define GEN_PASS_DECL_TOSATOLINALGNAMED
#include "mlir/Conversion/Passes.h.inc"
 
namespace tosa {
std::unique_ptr<Pass>
createTosaToLinalg(const TosaToLinalgOptions &options = TosaToLinalgOptions());
std::unique_ptr<Pass> createTosaToLinalgNamed(
    const TosaToLinalgNamedOptions &options = TosaToLinalgNamedOptions());
 
/// Populates passes to convert from TOSA to Linalg. At the end of
/// the pass, the function will only contain linalg ops or standard ops if the
/// pipeline succeeds.  The option to disable decompositions is available for
/// benchmarking performance improvements from the canonicalizations.
void addTosaToLinalgPasses(
    OpPassManager &pm, const TosaToLinalgOptions &options,
    const TosaToLinalgNamedOptions &tosaToLinalgNamedOptions =
        TosaToLinalgNamedOptions(),
    // Note: Default to 'none' level unless otherwise specified.
    std::optional<tosa::TosaValidationOptions> validationOptions =
        tosa::TosaValidationOptions{false, false},
    std::optional<TosaAttachTargetOptions> attachTargetOptions = std::nullopt);
 
/// Populates TOSA to linalg pipelines
/// Currently, this includes only the "tosa-to-linalg-pipeline".
void registerTosaToLinalgPipelines();
 
/// Populates conversion passes from TOSA dialect to Linalg dialect.
void populateTosaToLinalgConversionPatterns(
    const TypeConverter &converter, RewritePatternSet *patterns,
    const TosaToLinalgOptions &options = TosaToLinalgOptions());
 
/// Populates conversion passes from TOSA dialect to Linalg named operations.
void populateTosaToLinalgNamedConversionPatterns(
    const TypeConverter &converter, RewritePatternSet *patterns,
    const TosaToLinalgNamedOptions &options);
 
/// Returns the `linalg.elementwise` kind that the TosaToLinalgNamed conversion
/// lowers `op` to, or std::nullopt if `op` has no such counterpart.
std::optional<linalg::ElementwiseKind>
isConvertibleToLinalgElementwise(Operation *op);
 
/// Caches the `arith.constant index` values created for a set of dimension
/// indices so that broadcasting helpers can avoid emitting redundant
/// constants. Callers own the pool and reuse it across related queries.
using IndexPool = llvm::DenseMap<int64_t, Value>;
 
/// Compute the broadcasted runtime size of dimension `dim` of an elementwise
/// operation whose `operands` all share the same rank (TOSA's
/// `SameOperandsAndResultRank` and `ResultsBroadcastableShape` traits). The
/// returned size is either a static `IndexAttr` or an SSA `Value` holding the
/// runtime size, so dynamic dimensions (fixed rank, unknown size) are handled
/// correctly. The second element of the pair is the operand that solely
/// determines the size, or nullptr when it is inferred from several operands.
/// `indexPool` caches constant index values across calls.
std::pair<OpFoldResult, Value>
computeTargetSize(PatternRewriter &rewriter, Location loc, IndexPool &indexPool,
                  ValueRange operands, int64_t dim);
} // namespace tosa
} // namespace mlir
 
#endif // MLIR_CONVERSION_TOSATOLINALG_TOSATOLINALG_H