postproc.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_META_SCHEDULE_POSTPROC_H_
#define TVM_META_SCHEDULE_POSTPROC_H_

#include <tvm/node/reflection.h>
#include <tvm/runtime/object.h>
#include <tvm/runtime/packed_func.h>
#include <tvm/tir/schedule/schedule.h>

namespace tvm {
namespace meta_schedule {

class TuneContext;
class Postproc;

class PostprocNode : public runtime::Object {
 public:
  virtual ~PostprocNode() = default;

  void VisitAttrs(tvm::AttrVisitor* v) {}

  virtual void InitializeWithTuneContext(const TuneContext& context) = 0;

  virtual bool Apply(const tir::Schedule& sch) = 0;

  virtual Postproc Clone() const = 0;

  static constexpr const char* _type_key = "meta_schedule.Postproc";
  TVM_DECLARE_BASE_OBJECT_INFO(PostprocNode, Object);
};

class Postproc : public runtime::ObjectRef {
 public:
  using FInitializeWithTuneContext = runtime::TypedPackedFunc<void(const TuneContext&)>;
  using FApply = runtime::TypedPackedFunc<bool(const tir::Schedule&)>;
  using FClone = runtime::TypedPackedFunc<Postproc()>;
  using FAsString = runtime::TypedPackedFunc<String()>;
  TVM_DLL static Postproc PyPostproc(FInitializeWithTuneContext f_initialize_with_tune_context,  //
                                     FApply f_apply,                                             //
                                     FClone f_clone,                                             //
                                     FAsString f_as_string);
  TVM_DLL static Postproc DisallowDynamicLoop();
  TVM_DLL static Postproc DisallowAsyncStridedMemCopy();
  TVM_DLL static Postproc RewriteCooperativeFetch();
  TVM_DLL static Postproc RewriteParallelVectorizeUnroll();
  TVM_DLL static Postproc RewriteReductionBlock();
  TVM_DLL static Postproc RewriteUnboundBlock(int max_threadblocks);
  TVM_DLL static Postproc RewriteTensorize(bool vectorize_init_loop = false);
  TVM_DLL static Postproc VerifyGPUCode();
  TVM_DLL static Postproc VerifyVTCMLimit();
  TVM_DLL static Postproc RewriteLayout();
  TVM_DLL static Array<Postproc, void> DefaultLLVM();
  TVM_DLL static Array<Postproc, void> DefaultCPUTensorization();
  TVM_DLL static Array<Postproc, void> DefaultCUDA();
  TVM_DLL static Array<Postproc, void> DefaultCUDATensorCore();
  TVM_DLL static Array<Postproc, void> DefaultHexagon();
  TVM_DLL static Array<Postproc, void> DefaultMicro();

  TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS(Postproc, ObjectRef, PostprocNode);
};

class PyPostprocNode : public PostprocNode {
 public:
  using FInitializeWithTuneContext = Postproc::FInitializeWithTuneContext;
  using FApply = Postproc::FApply;
  using FClone = Postproc::FClone;
  using FAsString = Postproc::FAsString;
  FInitializeWithTuneContext f_initialize_with_tune_context;
  FApply f_apply;
  FClone f_clone;
  FAsString f_as_string;

  void VisitAttrs(tvm::AttrVisitor* v) {
    // `f_initialize_with_tune_context` is not visited
    // `f_apply` is not visited
    // `f_clone` is not visited
    // `f_as_string` is not visited
  }

  void InitializeWithTuneContext(const TuneContext& context) final;
  bool Apply(const tir::Schedule& sch) final;
  Postproc Clone() const final;

  static constexpr const char* _type_key = "meta_schedule.PyPostproc";
  TVM_DECLARE_FINAL_OBJECT_INFO(PyPostprocNode, PostprocNode);
};

}  // namespace meta_schedule
}  // namespace tvm

#endif  // TVM_META_SCHEDULE_POSTPROC_H_