config.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_CONFIG_H_
#define TVM_SCRIPT_PRINTER_CONFIG_H_
 
#include <tvm/ffi/any.h>
#include <tvm/ffi/container/array.h>
#include <tvm/ffi/container/map.h>
#include <tvm/ffi/reflection/access_path.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ffi/string.h>
#include <tvm/ir/cast.h>
#include <tvm/ir/node_functor.h>
#include <tvm/runtime/data_type.h>
 
#include <string>
 
namespace tvm {
 
class PrinterConfigNode : public ffi::Object {
 public:
  ffi::Array<ffi::String> binding_names = {};
  bool show_meta = false;
  ffi::String ir_prefix = "I";
  ffi::String tir_prefix = "T";
  ffi::String tir_import_module = "tir";
  ffi::String tirx_prefix = "Tx";
  DataType buffer_dtype = DataType::Float(32);
  ffi::String relax_prefix = "R";
  ffi::String module_alias = "cls";
  DataType int_dtype = DataType::Int(32);
  DataType float_dtype = DataType::Void();
  bool verbose_expr = false;
  int indent_spaces = 4;
  bool print_line_numbers = false;
  int num_context_lines = -1;
  bool syntax_sugar = true;
  bool show_object_address = false;
 
  /* \brief ffi::Object path to be underlined */
  ffi::Array<ffi::reflection::AccessPath> path_to_underline;
  ffi::Map<ffi::reflection::AccessPath, ffi::String> path_to_annotate;
  ffi::Array<ffi::ObjectRef> obj_to_underline = ffi::Array<ffi::ObjectRef>();
  ffi::Map<ffi::ObjectRef, ffi::String> obj_to_annotate = ffi::Map<ffi::ObjectRef, ffi::String>();
 
  ffi::Map<ffi::String, ffi::Any> extra_config;
 
  template <typename T>
  T GetExtraConfig(const ffi::String& key, T fallback) const {
    auto it = extra_config.find(key);
    if (it == extra_config.end()) return fallback;
    return Downcast<T>((*it).second);
  }
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PrinterConfigNode>()
        .def_ro("binding_names", &PrinterConfigNode::binding_names)
        .def_ro("show_meta", &PrinterConfigNode::show_meta)
        .def_ro("ir_prefix", &PrinterConfigNode::ir_prefix)
        .def_ro("module_alias", &PrinterConfigNode::module_alias)
        .def_ro("int_dtype", &PrinterConfigNode::int_dtype)
        .def_ro("float_dtype", &PrinterConfigNode::float_dtype)
        .def_ro("verbose_expr", &PrinterConfigNode::verbose_expr)
        .def_ro("indent_spaces", &PrinterConfigNode::indent_spaces)
        .def_ro("print_line_numbers", &PrinterConfigNode::print_line_numbers)
        .def_ro("num_context_lines", &PrinterConfigNode::num_context_lines)
        .def_ro("syntax_sugar", &PrinterConfigNode::syntax_sugar)
        .def_ro("show_object_address", &PrinterConfigNode::show_object_address)
        .def_ro("path_to_underline", &PrinterConfigNode::path_to_underline)
        .def_ro("path_to_annotate", &PrinterConfigNode::path_to_annotate)
        .def_ro("obj_to_underline", &PrinterConfigNode::obj_to_underline)
        .def_ro("obj_to_annotate", &PrinterConfigNode::obj_to_annotate)
        .def_ro("extra_config", &PrinterConfigNode::extra_config);
  }
 
  ffi::Array<ffi::String> GetBuiltinKeywords();
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("script.PrinterConfig", PrinterConfigNode, ffi::Object);
};
 
class TVM_DLL PrinterConfig : public ffi::ObjectRef {
 public:
  explicit PrinterConfig(
      ffi::Map<ffi::String, ffi::Any> config_dict = ffi::Map<ffi::String, ffi::Any>());
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(PrinterConfig, ffi::ObjectRef, PrinterConfigNode);
};
 
class TVMScriptPrinter {
 public:
  /* Convert the object to TVMScript format */
  TVM_DLL static std::string Script(const ffi::ObjectRef& node,
                                    const ffi::Optional<PrinterConfig>& cfg);
  // Allow registration to be printer.
  using FType = NodeFunctor<std::string(const ffi::ObjectRef&, const PrinterConfig&)>;
  TVM_DLL static FType& vtable();
};
 
#define TVM_OBJECT_ENABLE_SCRIPT_PRINTER()                                              \
  std::string Script(const ffi::Optional<PrinterConfig>& config = std::nullopt) const { \
    return TVMScriptPrinter::Script(ffi::GetRef<ffi::ObjectRef>(this),                  \
                                    config.value_or(PrinterConfig()));                  \
  }
 
TVM_DLL std::string RedirectedReprPrinterMethod(const ffi::ObjectRef& obj);
 
#define TVM_REGISTER_SCRIPT_AS_REPR(ObjectType, Method)                                        \
  TVM_FFI_STATIC_INIT_BLOCK() {                                                                \
    namespace refl = tvm::ffi::reflection;                                                     \
    refl::TypeAttrDef<ObjectType>().def(refl::type_attr::kRepr,                                \
                                        [](ffi::ObjectRef obj, ffi::Function) -> ffi::String { \
                                          return RedirectedReprPrinterMethod(obj);             \
                                        });                                                    \
  }                                                                                            \
  TVM_STATIC_IR_FUNCTOR(TVMScriptPrinter, vtable).set_dispatch<ObjectType>(Method)
 
}  // namespace tvm
#endif  // TVM_SCRIPT_PRINTER_CONFIG_H_