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 = runtime::TypedPackedFunc<ObjectRef(
    const Instruction& inst, const Array<ObjectRef>& inputs, const Array<ObjectRef>& attrs,
    const Optional<ObjectRef>& decision)>;

class TraceNode : public runtime::Object {
 public:
  Array<Instruction> insts;
  Map<Instruction, ObjectRef> decisions;

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("insts", &insts);
    v->Visit("decisions", &decisions);
  }

  static constexpr const char* _type_key = "tir.Trace";
  TVM_DECLARE_FINAL_OBJECT_INFO(TraceNode, runtime::Object);

 public:
  Optional<ObjectRef> GetDecision(const Instruction& inst) const;
  void Append(Instruction inst);
  void Append(Instruction inst, ObjectRef decision);
  Optional<Instruction> Pop();
  void ApplyToSchedule(Schedule sch, bool remove_postproc,
                       FTraceDecisionProvider decision_provider = nullptr) const;
  ObjectRef AsJSON(bool remove_postproc) const;
  Array<String> AsPython(bool remove_postproc) const;
  Trace WithDecision(Instruction inst, ObjectRef decision, bool remove_postproc) const;
  Trace Simplified(bool remove_postproc) const;
};

class Trace : public runtime::ObjectRef {
 public:
  Trace();
  explicit Trace(Array<Instruction> insts, Map<Instruction, ObjectRef> decisions);
  static void ApplyJSONToSchedule(ObjectRef json, Schedule sch);

  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(Trace, runtime::ObjectRef, TraceNode);
};

}  // namespace tir
}  // namespace tvm

#endif  // TVM_TIR_SCHEDULE_TRACE_H_