trace.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_SCHEDULE_TRACE_H_
#define TVM_TIR_SCHEDULE_TRACE_H_
 
#include <tvm/tir/schedule/instruction.h>
 
namespace tvm {
namespace tir {
 
// Forward declaration
class Trace;
 
using FTraceDecisionProvider =
    ffi::TypedFunction<Any(const Instruction& inst, const ffi::Array<Any>& inputs,
                           const ffi::Array<Any>& attrs, const Any& decision)>;
 
class TraceNode : public runtime::Object {
 public:
  ffi::Array<Instruction> insts;
  ffi::Map<Instruction, Any> decisions;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TraceNode>()
        .def_ro("insts", &TraceNode::insts)
        .def_ro("decisions", &TraceNode::decisions);
  }
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.Trace", TraceNode, runtime::Object);
 
 public:
  Any GetDecision(const Instruction& inst) const;
  void Append(Instruction inst);
  void Append(Instruction inst, Any decision);
  ffi::Optional<Instruction> Pop();
  void ApplyToSchedule(Schedule sch, bool remove_postproc,
                       FTraceDecisionProvider decision_provider = nullptr) const;
  ObjectRef AsJSON(bool remove_postproc) const;
  ffi::Array<ffi::String> AsPython(bool remove_postproc) const;
  Trace WithDecision(Instruction inst, Any decision, bool remove_postproc) const;
  Trace Simplified(bool remove_postproc) const;
};
 
class Trace : public runtime::ObjectRef {
 public:
  Trace();
  explicit Trace(ffi::Array<Instruction> insts, ffi::Map<Instruction, Any> decisions);
  static void ApplyJSONToSchedule(ObjectRef json, Schedule sch);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Trace, runtime::ObjectRef, TraceNode);
};
 
}  // namespace tir
}  // namespace tvm
 
#endif  // TVM_TIR_SCHEDULE_TRACE_H_