[REFACTOR] Move support related code to include/tvm/support (apache#4716

) * [REFACTOR] Move support related code to include/tvm/support - tvm/logging.h -> tvm/support/logging.h - remove tvm/base.h, move with into tvm/support/with.h * src/common -> src/support
dpankratz · Jan 15, 2020 · 49d3144 · 49d3144
1 parent b0b51f2
commit 49d3144
Show file tree

Hide file tree

Showing 53 changed files with 160 additions and 168 deletions.
diff --git a/apps/cpp_rpc/rpc_env.cc b/apps/cpp_rpc/rpc_env.cc
@@ -164,7 +164,7 @@ void LinuxShared(const std::string output,
     }
     cmd += " " + options;
     std::string err_msg;
-    auto executed_status = common::Execute(cmd, &err_msg);
+    auto executed_status = support::Execute(cmd, &err_msg);
     if (executed_status) {
       LOG(FATAL) << err_msg;
     }
@@ -195,22 +195,22 @@ void CreateShared(const std::string output, const std::vector<std::string> &file
  */
 Module Load(std::string *fileIn, const std::string fmt) {
   std::string file = *fileIn;
-  if (common::EndsWith(file, ".so")) {
+  if (support::EndsWith(file, ".so")) {
       return Module::LoadFromFile(file, fmt);
   }
 
   #if defined(__linux__) || defined(__ANDROID__)
     std::string file_name = file + ".so";
-    if (common::EndsWith(file, ".o")) {
+    if (support::EndsWith(file, ".o")) {
       std::vector<std::string> files;
       files.push_back(file);
       CreateShared(file_name, files);
-    } else if (common::EndsWith(file, ".tar")) {
+    } else if (support::EndsWith(file, ".tar")) {
       std::string tmp_dir = "./rpc/tmp/";
       mkdir(&tmp_dir[0], 0777);
       std::string cmd = "tar -C " + tmp_dir + " -zxf " + file;
       std::string err_msg;
-      int executed_status = common::Execute(cmd, &err_msg);
+      int executed_status = support::Execute(cmd, &err_msg);
       if (executed_status) {
         LOG(FATAL) << err_msg;
       }

diff --git a/apps/cpp_rpc/rpc_server.cc b/apps/cpp_rpc/rpc_server.cc
@@ -122,8 +122,8 @@ class RPCServer {
   void ListenLoopProc() {
     TrackerClient tracker(tracker_addr_, key_, custom_addr_);
     while (true) {
-      common::TCPSocket conn;
-      common::SockAddr addr("0.0.0.0", 0);
+      support::TCPSocket conn;
+      support::SockAddr addr("0.0.0.0", 0);
       std::string opts;
       try {
         // step 1: setup tracker and report to tracker
@@ -221,8 +221,8 @@ class RPCServer {
    * \param ping_period Timeout for select call waiting
    */
   void AcceptConnection(TrackerClient* tracker,
-                        common::TCPSocket* conn_sock,
-                        common::SockAddr* addr,
+                        support::TCPSocket* conn_sock,
+                        support::SockAddr* addr,
                         std::string* opts,
                         int ping_period = 2) {
     std::set <std::string> old_keyset;
@@ -233,7 +233,7 @@ class RPCServer {
 
     while (true) {
       tracker->WaitConnectionAndUpdateKey(listen_sock_, my_port_, ping_period, &matchkey);
-      common::TCPSocket conn = listen_sock_.Accept(addr);
+      support::TCPSocket conn = listen_sock_.Accept(addr);
 
       int code = kRPCMagic;
       CHECK_EQ(conn.RecvAll(&code, sizeof(code)), sizeof(code));
@@ -289,7 +289,7 @@ class RPCServer {
    * \param sock The socket information
    * \param addr The socket address information
    */
-  void ServerLoopProc(common::TCPSocket sock, common::SockAddr addr) {
+  void ServerLoopProc(support::TCPSocket sock, support::SockAddr addr) {
       // Server loop
       auto env = RPCEnv();
       RPCServerLoop(sock.sockfd);
@@ -308,7 +308,7 @@ class RPCServer {
 
     if (opts.find(option) == 0) {
       cmd = opts.substr(opts.find_last_of(option) + 1);
-      CHECK(common::IsNumber(cmd)) << "Timeout is not valid";
+      CHECK(support::IsNumber(cmd)) << "Timeout is not valid";
       return std::stoi(cmd);
     }
     return 0;
@@ -321,8 +321,8 @@ class RPCServer {
   std::string tracker_addr_;
   std::string key_;
   std::string custom_addr_;
-  common::TCPSocket listen_sock_;
-  common::TCPSocket tracker_sock_;
+  support::TCPSocket listen_sock_;
+  support::TCPSocket tracker_sock_;
 };
 
 /*!

diff --git a/apps/cpp_rpc/rpc_tracker_client.h b/apps/cpp_rpc/rpc_tracker_client.h
@@ -132,15 +132,15 @@ class TrackerClient {
    * \param ping_period Select wait time.
    * \param matchkey Random match key output.
   */
-  void WaitConnectionAndUpdateKey(common::TCPSocket listen_sock,
+  void WaitConnectionAndUpdateKey(support::TCPSocket listen_sock,
                                   int port,
                                   int ping_period,
                                   std::string *matchkey) {
     int unmatch_period_count = 0;
     int unmatch_timeout = 4;
     while (true) {
       if (!tracker_sock_.IsClosed()) {
-        common::PollHelper poller;
+        support::PollHelper poller;
         poller.WatchRead(listen_sock.sockfd);
         poller.Poll(ping_period * 1000);
         if (!poller.CheckRead(listen_sock.sockfd)) {
@@ -189,11 +189,11 @@ class TrackerClient {
    * \param retry_period Number of seconds before we retry again.
    * \return TCPSocket The socket information if connect is success.
    */
-  common::TCPSocket ConnectWithRetry(int timeout = 60, int retry_period = 5) {
+  support::TCPSocket ConnectWithRetry(int timeout = 60, int retry_period = 5) {
     auto tbegin = std::chrono::system_clock::now();
     while (true) {
-      common::SockAddr addr(tracker_addr_);
-      common::TCPSocket sock;
+      support::SockAddr addr(tracker_addr_);
+      support::TCPSocket sock;
       sock.Create();
       LOG(INFO) << "Tracker connecting to " << addr.AsString();
       if (sock.Connect(addr)) {
@@ -235,7 +235,7 @@ class TrackerClient {
   std::string tracker_addr_;
   std::string key_;
   std::string custom_addr_;
-  common::TCPSocket tracker_sock_;
+  support::TCPSocket tracker_sock_;
   std::set <std::string> old_keyset_;
   std::mt19937 gen_;
   std::uniform_real_distribution<float> dis_;

diff --git a/include/tvm/arithmetic.h b/include/tvm/arithmetic.h
@@ -24,6 +24,8 @@
 #ifndef TVM_ARITHMETIC_H_
 #define TVM_ARITHMETIC_H_
 
+#include <tvm/support/with.h>
+
 #include <vector>
 #include <unordered_map>
 #include <memory>

diff --git a/include/tvm/buffer.h b/include/tvm/buffer.h
@@ -26,7 +26,6 @@
 
 #include <string>
 
-#include "base.h"
 #include "expr.h"
 #include "expr_operator.h"
 #include "tvm/node/container.h"

diff --git a/include/tvm/codegen.h b/include/tvm/codegen.h
@@ -25,7 +25,6 @@
 #define TVM_CODEGEN_H_
 
 #include <string>
-#include "base.h"
 #include "expr.h"
 #include "lowered_func.h"
 #include "runtime/packed_func.h"

diff --git a/include/tvm/data_layout.h b/include/tvm/data_layout.h
@@ -25,7 +25,7 @@
 #ifndef TVM_DATA_LAYOUT_H_
 #define TVM_DATA_LAYOUT_H_
 
-#include <tvm/base.h>
+
 #include <tvm/expr.h>
 
 #include <string>

diff --git a/include/tvm/expr.h b/include/tvm/expr.h
@@ -29,7 +29,6 @@
 #include <algorithm>
 #include <unordered_map>
 #include <iostream>
-#include "base.h"
 #include "node/node.h"
 #include "node/container.h"
 #include "node/functor.h"

diff --git a/include/tvm/ir.h b/include/tvm/ir.h
@@ -29,7 +29,6 @@
 #include <string>
 #include <vector>
 #include <utility>
-#include "base.h"
 #include "expr.h"
 #include "runtime/util.h"
 

diff --git a/include/tvm/ir/op.h b/include/tvm/ir/op.h
@@ -391,6 +391,14 @@ class OpMap {
   const GenericOpMap& map_;
 };
 
+#define TVM_STRINGIZE_DETAIL(x) #x
+#define TVM_STRINGIZE(x) TVM_STRINGIZE_DETAIL(x)
+#define TVM_DESCRIBE(...) describe(__VA_ARGS__ "\n\nFrom:" __FILE__ ":" TVM_STRINGIZE(__LINE__))
+/*!
+ * \brief Macro to include current line as string
+ */
+#define TVM_ADD_FILELINE "\n\nDefined in " __FILE__ ":L" TVM_STRINGIZE(__LINE__)
+
 // internal macros to make
 #define TVM_OP_REGISTER_VAR_DEF \
   static DMLC_ATTRIBUTE_UNUSED ::tvm::OpRegistry& __make_##Op

diff --git a/include/tvm/ir/transform.h b/include/tvm/ir/transform.h
@@ -56,7 +56,7 @@
 #ifndef TVM_IR_TRANSFORM_H_
 #define TVM_IR_TRANSFORM_H_
 
-#include <tvm/base.h>
+#include <tvm/support/with.h>
 #include <tvm/node/container.h>
 #include <tvm/ir/error.h>
 #include <tvm/ir/module.h>

diff --git a/include/tvm/lowered_func.h b/include/tvm/lowered_func.h
@@ -27,7 +27,6 @@
 
 #include <string>
 
-#include "base.h"
 #include "expr.h"
 #include "tensor.h"
 #include "tvm/node/container.h"

diff --git a/include/tvm/packed_func_ext.h b/include/tvm/packed_func_ext.h
@@ -30,7 +30,6 @@
 #include <limits>
 #include <type_traits>
 
-#include "base.h"
 #include "expr.h"
 #include "tensor.h"
 #include "runtime/packed_func.h"

diff --git a/include/tvm/schedule.h b/include/tvm/schedule.h
@@ -27,7 +27,6 @@
 
 #include <string>
 #include <unordered_map>
-#include "base.h"
 #include "expr.h"
 #include "tensor.h"
 #include "tensor_intrin.h"

diff --git a/include/tvm/schedule_pass.h b/include/tvm/schedule_pass.h
@@ -28,7 +28,6 @@
 #ifndef TVM_SCHEDULE_PASS_H_
 #define TVM_SCHEDULE_PASS_H_
 
-#include "base.h"
 #include "schedule.h"
 
 namespace tvm {

diff --git a/include/tvm/logging.h → include/tvm/support/logging.h b/include/tvm/logging.h → include/tvm/support/logging.h
@@ -18,11 +18,11 @@
  */
 
 /*!
- * \file tvm/logging.h
+ * \file tvm/support/logging.h
  * \brief logging utilities on top of dmlc-core
  */
-#ifndef TVM_LOGGING_H_
-#define TVM_LOGGING_H_
+#ifndef TVM_SUPPORT_LOGGING_H_
+#define TVM_SUPPORT_LOGGING_H_
 
 // a technique that enables overriding macro names on the number of parameters. This is used
 // to define other macros below
@@ -114,4 +114,4 @@
 #define COND_CHECK_2(quit_on_assert, x) COND_CHECK_3(quit_on_assert, x, return false)
 #define COND_LOG_2(quit_on_assert, x) COND_LOG_3(quit_on_assert, x, return false)
 
-#endif   // TVM_LOGGING_H_
+#endif   // TVM_SUPPORT_LOGGING_H_
diff --git a/include/tvm/base.h → include/tvm/support/with.h b/include/tvm/base.h → include/tvm/support/with.h
@@ -18,11 +18,12 @@
  */
 
 /*!
- * \file tvm/base.h
- * \brief Base utilities
+ * \file tvm/support/with.h
+ * \brief RAII wrapper function to enter and exit a context object
+ *        similar to python's with syntax.
  */
-#ifndef TVM_BASE_H_
-#define TVM_BASE_H_
+#ifndef TVM_SUPPORT_WITH_H_
+#define TVM_SUPPORT_WITH_H_
 
 #include <dmlc/logging.h>
 #include <utility>
@@ -73,14 +74,5 @@ class With {
   ContextType ctx_;
 };
 
-#define TVM_STRINGIZE_DETAIL(x) #x
-#define TVM_STRINGIZE(x) TVM_STRINGIZE_DETAIL(x)
-#define TVM_DESCRIBE(...) describe(__VA_ARGS__ "\n\nFrom:" __FILE__ ":" TVM_STRINGIZE(__LINE__))
-/*!
- * \brief Macro to include current line as string
- */
-#define TVM_ADD_FILELINE "\n\nDefined in " __FILE__ ":L" TVM_STRINGIZE(__LINE__)
-
-
 }  // namespace tvm
-#endif  // TVM_BASE_H_
+#endif  // TVM_SUPPORT_WITH_H_
diff --git a/include/tvm/target_info.h b/include/tvm/target_info.h
@@ -25,7 +25,6 @@
 #define TVM_TARGET_INFO_H_
 
 #include <string>
-#include "base.h"
 #include "expr.h"
 
 namespace tvm {

diff --git a/include/tvm/tensor.h b/include/tvm/tensor.h
@@ -30,7 +30,6 @@
 #include <utility>
 #include <type_traits>
 
-#include "base.h"
 #include "expr.h"
 #include "expr_operator.h"
 #include "arithmetic.h"

diff --git a/src/README.md b/src/README.md
@@ -21,7 +21,7 @@ Header files in include are public APIs that share across modules.
 There can be internal header files within each module that sit in src.
 
 ## Modules
-- common: Internal common utilities.
+- support: Internal support utilities.
 - runtime: Minimum runtime related codes.
 - node: base infra for IR/AST nodes that is dialect independent.
 - api: API function registration.

diff --git a/src/codegen/codegen_cuda.cc b/src/codegen/codegen_cuda.cc
@@ -20,7 +20,7 @@
 /*!
  * \file codegen_cuda.cc
  */
-#include <tvm/base.h>
+
 #include <tvm/runtime/registry.h>
 #include <tvm/packed_func_ext.h>
 #include <cmath>

diff --git a/src/codegen/llvm/llvm_common.cc b/src/codegen/llvm/llvm_common.cc
@@ -6,9 +6,9 @@
  * 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
@@ -22,7 +22,7 @@
  */
 #ifdef TVM_LLVM_VERSION
 
-#include <tvm/base.h>
+#include <dmlc/logging.h>
 #include <atomic>
 #include <mutex>
 #include <memory>

diff --git a/src/codegen/opt/build_cuda_on.cc b/src/codegen/opt/build_cuda_on.cc
@@ -27,7 +27,7 @@
 #include <sys/stat.h>
 #endif
 #include <cuda_runtime.h>
-#include <tvm/base.h>
+
 #include <nvrtc.h>
 #include <cstdlib>
 

diff --git a/src/lang/expr.cc b/src/lang/expr.cc
@@ -20,7 +20,7 @@
 /*!
  * \file expr.cc
  */
-#include <tvm/base.h>
+
 #include <tvm/expr.h>
 #include <tvm/ir.h>
 #include <tvm/expr_operator.h>

diff --git a/src/lang/expr_operator.cc b/src/lang/expr_operator.cc
@@ -20,7 +20,7 @@
 /*!
  * \file expr_operator.cc
  */
-#include <tvm/base.h>
+
 #include <tvm/ir.h>
 #include <tvm/expr_operator.h>
 #include <cmath>

diff --git a/src/lang/ir.cc b/src/lang/ir.cc
@@ -20,7 +20,7 @@
 /*!
  * \file ir.cc
  */
-#include <tvm/base.h>
+
 #include <tvm/expr.h>
 #include <tvm/ir.h>
 #include <tvm/ir_pass.h>