name_supply.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_IR_NAME_SUPPLY_H_
#define TVM_IR_NAME_SUPPLY_H_
 
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/expr.h>
 
#include <algorithm>
#include <cctype>
#include <string>
#include <unordered_map>
#include <utility>
 
namespace tvm {
 
class NameSupplyNode : public Object {
 public:
  NameSupplyNode() = default;
 
  NameSupplyNode(const ffi::String& prefix, std::unordered_map<std::string, int> name_map)
      : prefix_(prefix), name_map(std::move(name_map)) {}
 
  ffi::String FreshName(const ffi::String& name, bool add_prefix = true,
                        bool add_underscore = true);
 
  ffi::String ReserveName(const ffi::String& name, bool add_prefix = true);
 
  bool ContainsName(const ffi::String& name, bool add_prefix = true);
 
  // Prefix for all GlobalVar names. It can be empty.
  std::string prefix_;
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.NameSupply", NameSupplyNode, Object);
 
 private:
  ffi::String add_prefix_to_name(const ffi::String& name);
 
  std::string GetUniqueName(std::string name, bool add_underscore = true);
 
  std::unordered_map<std::string, int> name_map;
};
 
class NameSupply : public ObjectRef {
 public:
  TVM_DLL explicit NameSupply(const ffi::String& prefix = "",
                              std::unordered_map<std::string, int> name_map = {});
 
  template <typename Iter, typename Lambda>
  TVM_DLL explicit NameSupply(Iter begin, Iter end, Lambda f)
      : NameSupply("", GetNameMap(begin, end, f)) {}
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(NameSupply, ObjectRef, NameSupplyNode);
 
 private:
  template <typename Iter, typename Lambda>
  static std::unordered_map<std::string, int> GetNameMap(Iter begin, Iter end, Lambda f) {
    // static_assert is more reader-friendly than SFINAE when template specialization is not needed.
    static_assert(std::is_convertible<decltype(f(*begin)), std::string>::value,
                  "Lambda f must has a signature of [?](*it) -> string {}");
    std::unordered_map<std::string, int> name_map;
    for (auto it = begin; it != end; ++it) {
      const std::string& name = f(*it);
      const size_t idx_last_first_num = std::distance(
          std::find_if(name.rbegin(), name.rend(), [](char c) { return !std::isdigit(c); }),
          name.rend());
      // name = {O = others}{D = consecutive digits}
      // let O -> prefix;
      std::string prefix = name.substr(0, idx_last_first_num);
      ICHECK(prefix.size() > 0 && std::isalpha(prefix[0])) << "Invalid variable name: " << name;
      if (0 == name_map.count(prefix)) name_map[prefix] = 0;
      if (idx_last_first_num < name.size()) {  // has some digits.
                                               // let D's nearest natural number -> idx;
                                               // note: stoul("000123") = 123;
        name_map[prefix] = std::max(name_map[prefix], std::stoi(name.substr(idx_last_first_num)));
      }
    }
    return name_map;
  }
};
 
}  // namespace tvm
 
#endif  // TVM_IR_NAME_SUPPLY_H_