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_TIR_TRANSFORM_H_
#define TVM_TIR_TRANSFORM_H_

#include <tvm/ir/transform.h>
#include <tvm/target/target.h>
#include <tvm/tir/expr.h>
#include <tvm/tir/function.h>

#include <string>
#include <vector>

namespace tvm {
namespace tir {
namespace transform {

using tvm::transform::Pass;
using tvm::transform::PassContext;
using tvm::transform::PassContextNode;
using tvm::transform::PassInfo;
using tvm::transform::PassInfoNode;
using tvm::transform::PassNode;
using tvm::transform::Sequential;

/*
 * \brief Create a function pass that optimizes PrimFuncs.
 *
 * \param pass_func The packed function that contains the optimization.
 * \param opt_level The optimization level of the function pass.
 * \param name The name of the function pass.
 * \param required The list of the passes that the function pass is dependent on.
 *
 * \return The created function pass.
 */
TVM_DLL Pass CreatePrimFuncPass(
    const runtime::TypedPackedFunc<PrimFunc(PrimFunc, IRModule, PassContext)>& pass_func,
    int opt_level, String name, tvm::Array<String> required);

TVM_DLL Pass InjectPrefetch();

// TODO(tvm-team): consolidate configs to the PassContext
TVM_DLL Pass StorageFlatten(int cache_line_size, bool create_bound_attribute = false);

TVM_DLL Pass InjectCopyIntrin(String pragma_key, runtime::PackedFunc fintrin);

TVM_DLL Pass CoProcSync();

TVM_DLL Pass LiftAttrScope(String attr_key);

TVM_DLL Pass LoopPartition();

TVM_DLL Pass VectorizeLoop(bool enable_vectorize = true);

TVM_DLL Pass InjectVirtualThread();

TVM_DLL Pass InjectDoubleBuffer();

TVM_DLL Pass StorageRewrite();

TVM_DLL Pass UnrollLoop();

TVM_DLL Pass RemoveNoOp();

TVM_DLL Pass RewriteUnsafeSelect();

TVM_DLL Pass Simplify();

TVM_DLL Pass InstrumentBoundCheckers();

TVM_DLL Pass MakePackedAPI(int num_unpacked_args);

TVM_DLL Pass MakeUnpackedAPI();

TVM_DLL Pass RemapThreadAxis(Map<String, IterVar> axis_map);

TVM_DLL Pass LowerCustomDatatypes();

TVM_DLL Pass DecorateDeviceScope();

TVM_DLL Pass SplitHostDevice();

TVM_DLL Pass SkipAssert();

TVM_DLL Pass ThreadSync(String storage_scope);

TVM_DLL Pass LowerThreadAllreduce();

TVM_DLL Pass InferFragment();

static constexpr const char* kDisableLowerTVMBuiltin = "disable_lower_builtin";

TVM_DLL Pass LowerTVMBuiltin();

TVM_DLL Pass LowerIntrin();

TVM_DLL Pass LowerWarpMemory();

TVM_DLL Pass LowerDeviceStorageAccessInfo();

TVM_DLL Pass CombineContextCall();

TVM_DLL Pass NarrowDataType(int target_bits);

TVM_DLL Pass BF16Legalize();

TVM_DLL Pass PointerValueTypeRewrite();

TVM_DLL Pass HoistIfThenElse();

TVM_DLL Pass HoistExpression();

TVM_DLL Pass LowerCrossThreadReduction();

TVM_DLL Pass LowerInitBlock();

TVM_DLL Pass PlanAndUpdateBufferAllocationLocation();

TVM_DLL Pass ConvertBlocksToOpaque();

TVM_DLL Pass CompactBufferAllocation();

TVM_DLL Pass LegalizePackedCalls();

TVM_DLL Pass LowerMatchBuffer();

TVM_DLL Pass FlattenBuffer();

/*
 * \brief Flatten the multi-dimensional read/write
 *  to two dimensional texture Load/Store and realize
 *  texture buffer allocations.
 *
 * \return The Pass
 */
TVM_DLL Pass TextureFlatten();

/*
 * \brief Lower VTCM allocations
 *
 * \return The Pass
 */
TVM_DLL Pass LowerVtcmAlloc();

TVM_DLL Pass CommonSubexprElimTIR(bool enable_cse_tir = true, bool identify_equiv_terms = false);

TVM_DLL Pass UnifyThreadBinding();

TVM_DLL Pass MergeDynamicSharedMemoryAllocations();

TVM_DLL Pass ConvertForLoopsToSerial();

TVM_DLL Pass UnifiedStaticMemoryPlanner();

TVM_DLL Pass InjectSoftwarePipeline();

TVM_DLL Pass BindParams(const Array<runtime::NDArray>& constants);

TVM_DLL Pass ExtractPrimFuncConstants();

TVM_DLL Pass RenormalizeSplitPattern();

TVM_DLL Pass BindTarget(Target target);

TVM_DLL Pass AnnotateEntryFunc();

TVM_DLL Pass Filter(runtime::TypedPackedFunc<bool(PrimFunc)> fcond);

TVM_DLL Pass InjectPTXAsyncCopy();

TVM_DLL Pass RemoveWeightLayoutRewriteBlock();

}  // namespace transform
}  // namespace tir
}  // namespace tvm

#endif  // TVM_TIR_TRANSFORM_H_