ir_docsifier.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_SCRIPT_PRINTER_IR_DOCSIFIER_H_
#define TVM_SCRIPT_PRINTER_IR_DOCSIFIER_H_

#include <tvm/node/node.h>
#include <tvm/runtime/logging.h>
#include <tvm/script/printer/doc.h>
#include <tvm/script/printer/frame.h>
#include <tvm/script/printer/traced_object.h>
#include <tvm/script/printer/traced_object_functor.h>
#include <tvm/script/printer/var_table.h>
#include <tvm/support/with.h>

namespace tvm {
namespace script {
namespace printer {

using WithCtx = With<ContextManager>;

class IRDocsifierNode : public Object {
 public:
  VarTable vars;
  Array<Frame> frames;
  Array<String> dispatch_tokens;
  Map<String, String> ir_prefix;

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("vars", &vars);
    v->Visit("frames", &frames);
    v->Visit("dispatch_tokens", &dispatch_tokens);
    v->Visit("ir_prefix", &ir_prefix);
  }

  static constexpr const char* _type_key = "script.printer.IRDocsifier";
  TVM_DECLARE_FINAL_OBJECT_INFO(IRDocsifierNode, Object);

 public:
  template <class TDoc>
  TDoc AsDoc(const TracedObject<ObjectRef>& obj) const {
    auto result = Downcast<TDoc>(AsDocImpl(obj));
    result->source_paths.push_back(obj.GetPath());
    return result;
  }

  ExprDoc AsExprDoc(const TracedObject<ObjectRef>& obj) { return AsDoc<ExprDoc>(obj); }

  WithCtx WithDispatchToken(const String& token) {
    this->dispatch_tokens.push_back(token);
    return WithCtx(nullptr, [this]() { this->dispatch_tokens.pop_back(); });
  }

  WithCtx WithFrame(const Frame& frame) {
    frame->EnterWithScope();
    this->frames.push_back(frame);
    return WithCtx(nullptr, [this, pushed_frame = frame]() {
      Frame last_frame = this->frames.back();
      ICHECK_EQ(last_frame, pushed_frame);
      this->frames.pop_back();
      last_frame->ExitWithScope();
    });
  }

  template <typename FrameType>
  Optional<FrameType> GetFrame() const {
    for (auto it = frames.rbegin(); it != frames.rend(); ++it) {
      if (const auto* f = (*it).as<typename FrameType::ContainerType>()) {
        return GetRef<FrameType>(f);
      }
    }
    return NullOpt;
  }

 private:
  Doc AsDocImpl(const TracedObject<ObjectRef>& obj) const;
};

class IRDocsifier : public ObjectRef {
 public:
  explicit IRDocsifier(Map<String, String> ir_prefix);

  using FType = TracedObjectFunctor<printer::Doc, IRDocsifier>;
  TVM_DLL static FType& vtable();

  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(IRDocsifier, ObjectRef, IRDocsifierNode);
};

class RootNodeContainerNode : public Object {
 public:
  ObjectRef root_node;

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

  static constexpr const char* _type_key = "script.printer.RootNodeContainer";
  TVM_DECLARE_FINAL_OBJECT_INFO(RootNodeContainerNode, Object);
};

class RootNodeContainer : public ObjectRef {
 public:
  explicit RootNodeContainer(ObjectRef root_node);
  TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS(RootNodeContainer, ObjectRef, RootNodeContainerNode);
};

}  // namespace printer
}  // namespace script
}  // namespace tvm

#endif  // TVM_SCRIPT_PRINTER_IR_DOCSIFIER_H_