analysis.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_TIR_ANALYSIS_H_
#define TVM_TIR_ANALYSIS_H_

#include <tvm/ir/module.h>
#include <tvm/ir/transform.h>
#include <tvm/tir/expr.h>
#include <tvm/tir/function.h>
#include <tvm/tir/op_attr_types.h>
#include <tvm/tir/stmt.h>

#include <optional>
#include <string>

namespace tvm {

namespace arith {
class Analyzer;
}

namespace tir {

struct ExprDeepEqual {
 public:
  TVM_DLL bool operator()(const PrimExpr& lhs, const PrimExpr& rhs) const;
};

template <class FLambda>
inline void VisitPrimFuncs(const IRModule& mod, FLambda fvisit) {
  for (const auto& kv : mod->functions) {
    const BaseFunc& base_func = kv.second;
    if (const auto* prim_func = base_func.as<PrimFuncNode>()) {
      fvisit(prim_func);
    }
  }
}

TVM_DLL double EstimateTIRFlops(const Stmt& stmt);

TVM_DLL double EstimateTIRFlops(const IRModule& mod);

TVM_DLL Array<Var> UndefinedVars(const Stmt& stmt, const Array<Var>& defs);

TVM_DLL Array<Var> UndefinedVars(const PrimExpr& expr);

TVM_DLL Array<Var> UndefinedVars(const PrimExpr& expr, const Array<Var>& defs);

TVM_DLL CallEffectKind SideEffect(const PrimExpr& expr);

TVM_DLL bool UsesVar(const Stmt& stmt, std::function<bool(const VarNode*)> vset_contains);

TVM_DLL bool UsesVar(const PrimExpr& expr, std::function<bool(const VarNode*)> vset_contains);

TVM_DLL bool VerifySSA(const PrimFunc& func);

TVM_DLL bool VerifyMemory(const PrimFunc& func);

TVM_DLL bool VerifyGPUCode(const PrimFunc& func, Map<String, PrimExpr> constraints);

TVM_DLL bool VerifyVTCMLimit(const PrimFunc& func, Integer limit);

TVM_DLL Array<Array<BufferRegion>> GetBlockAccessRegion(const Block& block,
                                                        const Map<Var, Buffer>& buffer_var_map);

TVM_DLL Array<Array<BufferRegion>> GetBlockReadWriteRegion(const Block& block,
                                                           const Map<Var, Buffer>& buffer_var_map);

struct MemCpyDetails {
  BufferRegion source;
  BufferRegion dest;
};

TVM_DLL std::optional<MemCpyDetails> IdentifyMemCpy(const For& loop, arith::Analyzer* analyzer);

TVM_DLL size_t CalculateExprComplexity(const PrimExpr& expr);

TVM_DLL size_t CalculateConstantBytes(const PrimFunc& func, const Integer& constant_byte_alignment);

TVM_DLL size_t CalculateWorkspaceBytes(const PrimFunc& func,
                                       const Integer& workspace_byte_alignment);

TVM_DLL tvm::Map<String, Integer> CalculateAllocatedBytes(const PrimFunc& func);

TVM_DLL Map<Buffer, Optional<Stmt>> DetectBufferAccessLCA(const PrimFunc& func);

TVM_DLL bool VerifyWellFormed(const PrimFunc& func, bool assert_mode = true);

const PrimFuncNode* FindEntryFunc(const IRModule& mod, GlobalVar* result_g_var);

const tir::BlockNode* FindAnchorBlock(const IRModule& mod);

// Pass variants of verification analysis
// directly throws RuntimeError when verification fails.
namespace transform {

using tvm::transform::Pass;
using tvm::transform::PassContext;

TVM_DLL Pass VerifySSA();

TVM_DLL Pass VerifyMemory();

TVM_DLL Pass VerifyGPUCode(Map<String, PrimExpr> constraints);

TVM_DLL Pass VerifyVTCMLimit(const Integer& limit);

TVM_DLL Pass OOBChecker();

}  // namespace transform
}  // namespace tir
}  // namespace tvm
#endif  // TVM_TIR_ANALYSIS_H_