transform.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef TVM_RELAX_TRANSFORM_H_
#define TVM_RELAX_TRANSFORM_H_
 
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/transform.h>
#include <tvm/relax/dataflow_pattern.h>
#include <tvm/relax/expr.h>
#include <tvm/tirx/function.h>
#include <tvm/tirx/index_map.h>
 
namespace tvm {
namespace relax {
namespace transform {
 
using Pass = tvm::transform::Pass;
using PassInfo = tvm::transform::PassInfo;
using PassContext = tvm::transform::PassContext;
using Function = tvm::relax::Function;
using DataflowBlock = tvm::relax::DataflowBlock;
using tvm::transform::CreateModulePass;
using LayoutCb = ffi::TypedFunction<ffi::Map<ffi::String, ffi::Array<ffi::String>>(Call)>;
 
TVM_DLL Pass CreateFunctionPass(std::function<Function(Function, IRModule, PassContext)> pass_func,
                                int opt_level, ffi::String name,
                                tvm::ffi::Array<ffi::String> required, bool traceable = false);
 
TVM_DLL Pass CreateDataflowBlockPass(
    std::function<DataflowBlock(DataflowBlock, IRModule, PassContext)> pass_func, int opt_level,
    ffi::String name, tvm::ffi::Array<ffi::String> required, bool traceable = false);
 
TVM_DLL Pass LambdaLift();
 
TVM_DLL Pass ToNonDataflow();
 
TVM_DLL Pass RemovePurityChecking();
 
TVM_DLL Pass CallTIRRewrite();
 
TVM_DLL Pass RewriteDataflowReshape();
 
TVM_DLL Pass StaticPlanBlockMemory();
 
TVM_DLL Pass AttachGlobalSymbol();
 
TVM_DLL Pass Normalize();
 
TVM_DLL Pass NormalizeGlobalVar();
 
TVM_DLL Pass CanonicalizeBindings();
 
TVM_DLL Pass EliminateCommonSubexpr(bool call_only = false);
 
TVM_DLL Pass BindParams(ffi::String func_name, ffi::Map<Any, ffi::ObjectRef> params);
 
TVM_DLL Pass
BindSymbolicVars(ffi::Map<ffi::Variant<tirx::PrimVar, ffi::String>, PrimExpr> binding_map,
                 ffi::Optional<ffi::String> func_name = std::nullopt);
 
TVM_DLL Pass FoldConstant();
 
TVM_DLL Pass LegalizeOps(ffi::Optional<ffi::Map<ffi::String, ffi::Function>> cmap,
                         ffi::Optional<ffi::Array<ffi::String>> skip_ops,
                         bool enable_warning = false);
 
TVM_DLL Pass RealizeVDevice();
 
TVM_DLL Pass AttachAttrLayoutFreeBuffers();
 
TVM_DLL Pass SplitLayoutRewritePreproc();
 
TVM_DLL Pass
LiftTransformParams(ffi::Variant<bool, ffi::Array<ffi::String>> shared_transform = false);
 
TVM_DLL Pass UpdateVDevice(VDevice new_vdevice, int64_t index);
 
TVM_DLL Pass ExpandTupleArguments();
 
TVM_DLL Pass RemoveUnusedParameters();
 
TVM_DLL Pass RemoveUnusedOutputs();
 
TVM_DLL Pass AnnotateTIROpPattern();
 
TVM_DLL Pass FuseOps(int fuse_opt_level = -1);
 
class FusionPatternNode : public ffi::Object {
 public:
  ffi::String name;
 
  DFPattern pattern;
 
  ffi::Map<ffi::String, DFPattern> annotation_patterns;
 
  ffi::Optional<ffi::Function> check;
 
  ffi::Optional<ffi::Function> attrs_getter;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<FusionPatternNode>()
        .def_ro("name", &FusionPatternNode::name)
        .def_ro("pattern", &FusionPatternNode::pattern)
        .def_ro("annotation_patterns", &FusionPatternNode::annotation_patterns)
        .def_ro("check", &FusionPatternNode::check)
        .def_ro("attrs_getter", &FusionPatternNode::attrs_getter);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.transform.FusionPattern", FusionPatternNode,
                                    ffi::Object);
};
 
class FusionPattern : public ffi::ObjectRef {
 public:
  FusionPattern(ffi::String name, DFPattern pattern,
                ffi::Map<ffi::String, DFPattern> annotation_patterns,
                ffi::Optional<ffi::Function> check, ffi::Optional<ffi::Function> attrs_getter);
 
  FusionPattern(ffi::String name, DFPattern pattern)
      : FusionPattern(name, pattern, {}, std::nullopt, std::nullopt) {}
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(FusionPattern, ffi::ObjectRef, FusionPatternNode);
};
 
class PatternCheckContextNode : public ffi::Object {
 public:
  Expr matched_expr;
 
  ffi::Map<ffi::String, Expr> annotated_expr;
 
  ffi::Map<Var, Expr> matched_bindings;
 
  ffi::Map<Var, ffi::Array<Var>> var_usages;
 
  ffi::Map<Expr, Var> value_to_bound_var;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PatternCheckContextNode>()
        .def_ro("matched_expr", &PatternCheckContextNode::matched_expr)
        .def_ro("annotated_expr", &PatternCheckContextNode::annotated_expr)
        .def_ro("matched_bindings", &PatternCheckContextNode::matched_bindings)
        .def_ro("var_usages", &PatternCheckContextNode::var_usages)
        .def_ro("value_to_bound_var", &PatternCheckContextNode::value_to_bound_var);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.transform.PatternCheckContext", PatternCheckContextNode,
                                    ffi::Object);
};
 
class PatternCheckContext : public ffi::ObjectRef {
 public:
  PatternCheckContext(Expr matched_expr, ffi::Map<ffi::String, Expr> annotated_expr,
                      ffi::Map<Var, Expr> matched_bindings,
                      ffi::Map<Var, ffi::Array<Var>> var_usages,
                      ffi::Map<Expr, Var> value_to_bound_var);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(PatternCheckContext, ffi::ObjectRef,
                                                PatternCheckContextNode);
};
 
TVM_DLL Pass Gradient(ffi::String func_name,
                      ffi::Optional<ffi::Array<Var>> require_grads = std::nullopt,
                      int target_index = 0);
 
TVM_DLL Pass FuseOpsByPattern(const tvm::ffi::Array<FusionPattern>& patterns,
                              bool bind_constants = true, bool annotate_codegen = false,
                              const tvm::ffi::Array<ffi::String>& entry_function_names = {});
 
TVM_DLL Pass MergeCompositeFunctions();
 
TVM_DLL Pass FuseTIR();
 
TVM_DLL Pass
RunCodegen(ffi::Optional<ffi::Map<ffi::String, ffi::Map<ffi::String, ffi::Any>>> target_options,
           ffi::Array<ffi::String> entry_functions);
 
TVM_DLL Pass DecomposeOpsForInference(ffi::Optional<ffi::String> func_name);
 
TVM_DLL Pass DecomposeOpsForTraining(ffi::Optional<ffi::String> func_name);
 
TVM_DLL Pass
AlterOpImpl(const ffi::Map<ffi::String, tirx::PrimFunc>& op_impl_map,
            const ffi::Map<ffi::String, ffi::Array<tirx::IndexMap>>& op_buffer_transforms);
 
TVM_DLL Pass ConvertLayout(ffi::Map<ffi::String, ffi::Array<ffi::String>> desired_layouts,
                           LayoutCb layout_cb);
 
TVM_DLL Pass ConvertToDataflow(int min_size = 2);
 
TVM_DLL Pass DeadCodeElimination(ffi::Array<ffi::String> entry_functions = {});
 
TVM_DLL Pass DataflowUseInplaceCalls();
 
TVM_DLL Pass ToMixedPrecision(
    DLDataType out_dtype, ffi::Optional<ffi::Array<ffi::String>> fp16_input_names = std::nullopt);
 
TVM_DLL Pass RewriteCUDAGraph();
 
TVM_DLL Pass SpecializePrimFuncBasedOnCallSite();
 
}  // namespace transform
}  // namespace relax
}  // namespace tvm
 
#endif  // TVM_RELAX_TRANSFORM_H_