[PIR] remove log simply na me mechnism from phi to common.

Author: winter-wang

paddle/common/enforce.cc

@@ -0,0 +1,102 @@
+/* Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
+
+Licensed 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. */
+
+#include "paddle/common/enforce.h"
+
+#include <map>
+#include <string>
+#include <vector>
+
+REGISTER_LOG_SIMPLY_STR(std::string, std::string);
+
+namespace {
+class StrSizeCmp {
+ public:
+  bool operator()(const std::string& lhs, const std::string& rhs) const {
+    return lhs.size() > rhs.size();
+  }
+};
+
+using LogSimplyStrMap = std::map<std::string, std::string, StrSizeCmp>;
+
+LogSimplyStrMap& GetLogStrSimplyMap() {
+  static LogSimplyStrMap str_simply_map;
+  return str_simply_map;
+}
+
+std::string SimplifyDemangleStr(std::string str) {
+  auto& str_map = GetLogStrSimplyMap();
+  for (auto& value : str_map) {
+    size_t start_pos = 0;
+    while ((start_pos = str.find(value.first, start_pos)) !=
+           std::string::npos) {
+      str.replace(start_pos, value.first.length(), value.second);
+      start_pos += value.second.length();
+    }
+  }
+  return str;
+}
+}  // namespace
+
+namespace common {
+namespace enforce {
+
+bool RegisterLogSimplyStr(const std::string& type_name,
+                          const std::string& simply_name) {
+  return GetLogStrSimplyMap()
+      .emplace(std::make_pair(type_name, simply_name))
+      .second;
+}
+
+std::string GetCurrentTraceBackString(bool for_signal) {
+  std::ostringstream sout;
+
+  if (!for_signal) {
+    sout << "\n\n--------------------------------------\n";
+    sout << "C++ Traceback (most recent call last):";
+    sout << "\n--------------------------------------\n";
+  }
+#if !defined(_WIN32) && !defined(PADDLE_WITH_MUSL)
+  static constexpr int TRACE_STACK_LIMIT = 100;
+
+  std::array<void*, TRACE_STACK_LIMIT> call_stack;
+  auto size = backtrace(call_stack.data(), TRACE_STACK_LIMIT);
+  auto symbols = backtrace_symbols(call_stack.data(), size);
+  Dl_info info;
+  int idx = 0;
+  // `for_signal` used to remove the stack trace introduced by
+  // obtaining the error stack trace when the signal error occurred,
+  // that is not related to the signal error self, remove it to
+  // avoid misleading users and developers
+  int end_idx = for_signal ? 2 : 0;
+  for (int i = size - 1; i >= end_idx; --i) {
+    if (dladdr(call_stack[i], &info) && info.dli_sname) {
+      auto demangled = common::demangle(info.dli_sname);
+      std::string path(info.dli_fname);
+      // C++ traceback info are from core.so
+      if (path.substr(path.length() - 3).compare(".so") == 0) {
+        sout << paddle::string::Sprintf(
+            "%-3d %s\n", idx++, SimplifyDemangleStr(demangled));
+      }
+    }
+  }
+  free(symbols);  // NOLINT
+#else
+  sout << "Not support stack backtrace yet.\n";
+#endif
+  return sout.str();
+}
+
+}  // namespace enforce
+}  // namespace common

paddle/common/enforce.h

@@ -31,6 +31,7 @@
 
 #include "paddle/common/errors.h"
 #include "paddle/common/macros.h"
+#include "paddle/utils/test_macros.h"
 
 #if !defined(_WIN32) && !defined(PADDLE_WITH_MUSL)
 #include <execinfo.h>
@@ -40,10 +41,20 @@
 #define GLOG_NO_ABBREVIATED_SEVERITIES
 #include "paddle/utils/string/printf.h"
 #include "paddle/utils/string/to_string.h"
-#include "paddle/utils/test_macros.h"
 #include "paddle/utils/variant.h"
 
 namespace common {
+#ifdef __GNUC__
+inline std::string demangle(std::string name) {
+  int status = -4;  // some arbitrary value to eliminate the compiler warning
+  std::unique_ptr<char, void (*)(void*)> res{
+      abi::__cxa_demangle(name.c_str(), NULL, NULL, &status), std::free};
+  return (status == 0) ? res.get() : name;
+}
+#else
+inline std::string demangle(std::string name) { return name; }
+#endif
+
 class CommonNotMetException : public std::exception {
  public:
   explicit CommonNotMetException(const std::string& str) : err_str_(str) {}
@@ -53,9 +64,7 @@ class CommonNotMetException : public std::exception {
  private:
   std::string err_str_;
 };
-}  // namespace common
 
-namespace common {
 namespace enforce {
 
 /** HELPER MACROS AND FUNCTIONS **/
@@ -161,6 +170,20 @@ using CommonType2 = typename std::add_lvalue_reference<
 #define COMMON_ENFORCE_LE(__VAL0, __VAL1, ...) \
   __COMMON_BINARY_COMPARE(__VAL0, __VAL1, <=, >, __VA_ARGS__)
 
+TEST_API bool RegisterLogSimplyStr(const std::string& type,
+                                   const std::string& simply);
+TEST_API std::string GetCurrentTraceBackString(bool for_signal = false);
+template <typename T>
+class LogSimplyStrRegistrar {
+ public:
+  static bool success;
+};
+
+#define REGISTER_LOG_SIMPLY_STR(Type, simply_name)               \
+  template <>                                                    \
+  bool ::common::enforce::LogSimplyStrRegistrar<Type>::success = \
+      ::common::enforce::RegisterLogSimplyStr(                   \
+          ::common::demangle(typeid(Type).name()), #simply_name);
 }  // namespace enforce
 }  // namespace common
 
@@ -172,53 +195,10 @@ inline bool is_error(const T& stat) {
 }
 
 namespace pir {
-
-#ifdef __GNUC__
-inline std::string demangle(std::string name) {
-  int status = -4;  // some arbitrary value to eliminate the compiler warning
-  std::unique_ptr<char, void (*)(void*)> res{
-      abi::__cxa_demangle(name.c_str(), NULL, NULL, &status), std::free};
-  return (status == 0) ? res.get() : name;
-}
-#else
-inline std::string demangle(std::string name) { return name; }
-#endif
-
-static std::string GetCurrentTraceBackString() {
-  std::ostringstream sout;
-  sout << "\n\n--------------------------------------\n";
-  sout << "C++ Traceback (most recent call last):";
-  sout << "\n--------------------------------------\n";
-#if !defined(_WIN32) && !defined(PADDLE_WITH_MUSL)
-  static constexpr int TRACE_STACK_LIMIT = 100;
-
-  void* call_stack[TRACE_STACK_LIMIT];
-  auto size = backtrace(call_stack, TRACE_STACK_LIMIT);
-  auto symbols = backtrace_symbols(call_stack, size);
-  Dl_info info;
-  int idx = 0;
-  int end_idx = 0;
-  for (int i = size - 1; i >= end_idx; --i) {
-    if (dladdr(call_stack[i], &info) && info.dli_sname) {
-      auto demangled = demangle(info.dli_sname);
-      std::string path(info.dli_fname);
-      // C++ traceback info are from core.so
-      if (path.substr(path.length() - 3).compare(".so") == 0) {
-        sout << idx++ << " " << demangled << "\n";
-      }
-    }
-  }
-  free(symbols);
-#else
-  sout << "Not support stack backtrace yet.\n";
-#endif
-  return sout.str();
-}
-
 class IrNotMetException : public std::exception {
  public:
   explicit IrNotMetException(const std::string& str)
-      : err_str_(str + GetCurrentTraceBackString()) {}
+      : err_str_(str + ::common::enforce::GetCurrentTraceBackString()) {}
 
   const char* what() const noexcept override { return err_str_.c_str(); }
 

paddle/fluid/framework/CMakeLists.txt

@@ -947,7 +947,7 @@ cc_library(
        imperative_flag
        layer)
 
-cc_library(type_info SRCS type_info.cc)
+cc_library(type_info SRCS type_info.cc type_defs.cc)
 target_link_libraries(type_info pir op_dialect)
 add_dependencies(type_info framework_proto auto_parallel_proto xxhash)
 if(WITH_MKLDNN)

paddle/fluid/framework/type_defs.cc

@@ -0,0 +1,22 @@
+/* Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
+
+Licensed 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. */
+
+#include "paddle/fluid/framework/type_defs.h"
+
+#include "paddle/common/enforce.h"
+
+REGISTER_LOG_SIMPLY_STR(paddle::framework::AttributeMap,
+                        paddle::framework::AttributeMap);
+REGISTER_LOG_SIMPLY_STR(paddle::framework::Attribute,
+                        paddle::framework::Attribute);

paddle/fluid/imperative/CMakeLists.txt

@@ -4,7 +4,7 @@ cc_library(
   DEPS phi common)
 cc_library(
   var_helper
-  SRCS var_helper.cc
+  SRCS var_helper.cc type_defs.cc
   DEPS tensor phi common)
 if(WITH_XPU)
   cc_library(

paddle/fluid/imperative/type_defs.cc

@@ -0,0 +1,24 @@
+/* Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
+
+Licensed 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. */
+
+#include "paddle/fluid/imperative/type_defs.h"
+
+#include "paddle/common/enforce.h"
+
+REGISTER_LOG_SIMPLY_STR(paddle::imperative::NameTensorMap,
+                        paddle::imperative::NameTensorMap);
+REGISTER_LOG_SIMPLY_STR(paddle::imperative::NameVarBaseMap,
+                        paddle::imperative::NameVarBaseMap);
+REGISTER_LOG_SIMPLY_STR(paddle::imperative::NameVariableWrapperMap,
+                        paddle::imperative::NameVariableWrapperMap);

paddle/fluid/memory/stats.h

@@ -77,8 +77,7 @@ class Stat : public StatBase {
     thread_local_stat->current += increment;
 
     VLOG(8) << string::split_string(
-                   phi::enforce::demangle(typeid(*thread_local_stat).name()),
-                   "::")
+                   common::demangle(typeid(*thread_local_stat).name()), "::")
                    .back()
             << ": Update current_value with " << increment
             << ", after update, current value = " << GetCurrentValue();
@@ -91,8 +90,7 @@ class Stat : public StatBase {
              !peak_value_.compare_exchange_weak(prev_value, current_value)) {
       }
       VLOG(8) << string::split_string(
-                     phi::enforce::demangle(typeid(*thread_local_stat).name()),
-                     "::")
+                     common::demangle(typeid(*thread_local_stat).name()), "::")
                      .back()
               << ": Update current_value with " << increment
               << ", after update, peak_value = " << peak_value_.load()

paddle/fluid/platform/enforce.h

@@ -108,6 +108,7 @@ PHI_DECLARE_int32(call_stack_level);
 namespace paddle {
 namespace platform {
 using namespace ::phi::enforce;  // NOLINT
+using ::common::demangle;
 
 /** HELPER MACROS AND FUNCTIONS **/
 

paddle/fluid/platform/init.cc

@@ -51,6 +51,7 @@ limitations under the License. */
 #include "paddle/fluid/platform/device/ipu/ipu_info.h"
 #endif
 
+#include "paddle/common/enforce.h"
 #include "paddle/fluid/memory/allocation/allocator_facade.h"
 #include "paddle/fluid/memory/memory.h"
 #include "paddle/fluid/platform/flags.h"
@@ -310,7 +311,8 @@ void SignalHandle(const char *data, int size) {
       sout << "\n\n--------------------------------------\n";
       sout << "C++ Traceback (most recent call last):";
       sout << "\n--------------------------------------\n";
-      auto traceback = platform::GetCurrentTraceBackString(/*for_signal=*/true);
+      auto traceback =
+          ::common::enforce::GetCurrentTraceBackString(/*for_signal=*/true);
       if (traceback.empty()) {
         sout
             << "No stack trace in paddle, may be caused by external reasons.\n";