src: add C++-style sprintf utility

Add an utility that handles C++-style strings and objects well. PR-URL: #31446Fixes: #28761Fixes: #31218 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Author: addaleax

node.gyp

@@ -609,6 +609,7 @@
 'src/connect_wrap.h',
 'src/connection_wrap.h',
 'src/debug_utils.h',
+'src/debug_utils-inl.h',
 'src/env.h',
 'src/env-inl.h',
 'src/handle_wrap.h',

src/debug_utils-inl.h

@@ -0,0 +1,90 @@
+#ifndef SRC_DEBUG_UTILS_INL_H_
+#defineSRC_DEBUG_UTILS_INL_H_
+
+#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#include"debug_utils.h"
+
+#include<type_traits>
+
+namespacenode{
+
+structToStringHelper{
+template <typename T>
+static std::string Convert(
+const T& value,
+std::string(T::* to_string)() const = &T::ToString){
+return (value.*to_string)();
+ }
+template <typename T,
+typename test_for_number = typename std::
+ enable_if<std::is_arithmetic<T>::value, bool>::type,
+typename dummy = bool>
+static std::string Convert(const T& value){returnstd::to_string(value)}
+static std::string Convert(constchar* value){return value}
+static std::string Convert(const std::string& value){return value}
+static std::string Convert(bool value){return value ? "true" : "false"}
+};
+
+template <typename T>
+std::string ToString(const T& value){
+returnToStringHelper::Convert(value);
+}
+
+inline std::string SPrintFImpl(constchar* format){
+constchar* p = strchr(format, '%');
+if (LIKELY(p == nullptr)) return format;
+CHECK_EQ(p[1], '%'); // Only '%%' allowed when there are no arguments.
+
+returnstd::string(format, p + 1) + SPrintFImpl(p + 2);
+}
+
+template <typename Arg, typename... Args>
+std::string COLD_NOINLINE SPrintFImpl( // NOLINT(runtime/string)
+constchar* format, Arg&& arg, Args&&... args){
+constchar* p = strchr(format, '%');
+CHECK_NOT_NULL(p); // If you hit this, you passed in too many arguments.
+ std::string ret(format, p);
+// Ignore long / size_t modifiers
+while (strchr("lz", *++p) != nullptr){}
+switch (*p){
+case'%':{
+return ret + '%' + SPrintFImpl(p + 1,
+ std::forward<Arg>(arg),
+ std::forward<Args>(args)...);
+ }
+default:{
+return ret + '%' + SPrintFImpl(p,
+ std::forward<Arg>(arg),
+ std::forward<Args>(args)...);
+ }
+case'd':
+case'i':
+case'u':
+case's': ret += ToString(arg); break;
+case'p':{
+CHECK(std::is_pointer<typename std::remove_reference<Arg>::type>::value);
+char out[20];
+int n = snprintf(out,
+sizeof(out),
+"%p",
+ *reinterpret_cast<constvoid* const*>(&arg));
+CHECK_GE(n, 0);
+ ret += out;
+break;
+ }
+ }
+return ret + SPrintFImpl(p + 1, std::forward<Args>(args)...);
+}
+
+template <typename... Args>
+std::string COLD_NOINLINE SPrintF( // NOLINT(runtime/string)
+constchar* format, Args&&... args){
+returnSPrintFImpl(format, std::forward<Args>(args)...);
+}
+
+} // namespace node
+
+#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#endif // SRC_DEBUG_UTILS_INL_H_

src/debug_utils.cc

@@ -1,4 +1,4 @@
-#include"debug_utils.h"
+#include"debug_utils-inl.h"// NOLINT(build/include)
 #include"env-inl.h"
 
 #ifdef __POSIX__

src/debug_utils.h

@@ -22,14 +22,26 @@
 
 namespacenode{
 
+template <typename T>
+inline std::string ToString(const T& value);
+
+// C++-style variant of sprintf() that:
+// - Returns an std::string
+// - Handles \0 bytes correctly
+// - Supports %p and %s. %d, %i and %u are aliases for %s.
+// - Accepts any class that has a ToString() method for stringification.
+template <typename... Args>
+inline std::string SPrintF(constchar* format, Args&&... args);
+
 template <typename... Args>
 inlinevoid FORCE_INLINE Debug(Environment* env,
  DebugCategory cat,
 constchar* format,
  Args&&... args){
 if (!UNLIKELY(env->debug_enabled(cat)))
 return;
-fprintf(stderr, format, std::forward<Args>(args)...);
+ std::string out = SPrintF(format, std::forward<Args>(args)...);
+fwrite(out.data(), out.size(), 1, stderr);
 }
 
 inlinevoid FORCE_INLINE Debug(Environment* env,

src/inspector_io.cc

@@ -4,7 +4,7 @@
 #include"inspector/main_thread_interface.h"
 #include"inspector/node_string.h"
 #include"base_object-inl.h"
-#include"debug_utils.h"
+#include"debug_utils-inl.h"
 #include"node.h"
 #include"node_crypto.h"
 #include"node_internals.h"

src/inspector_profiler.cc

@@ -1,6 +1,6 @@
 #include"inspector_profiler.h"
 #include"base_object-inl.h"
-#include"debug_utils.h"
+#include"debug_utils-inl.h"
 #include"diagnosticfilename-inl.h"
 #include"memory_tracker-inl.h"
 #include"node_file.h"

src/node.cc

@@ -23,7 +23,7 @@
 
 // ========== local headers ==========
 
-#include"debug_utils.h"
+#include"debug_utils-inl.h"
 #include"env-inl.h"
 #include"memory_tracker-inl.h"
 #include"node_binding.h"

src/node_http2.cc

@@ -1,5 +1,5 @@
 #include"aliased_buffer.h"
-#include"debug_utils.h"
+#include"debug_utils-inl.h"
 #include"memory_tracker-inl.h"
 #include"node.h"
 #include"node_buffer.h"
@@ -1967,7 +1967,7 @@ std::string Http2Stream::diagnostic_name() const{
 
 // Notify the Http2Stream that a new block of HEADERS is being processed.
 voidHttp2Stream::StartHeaders(nghttp2_headers_category category){
-Debug(this, "starting headers, category: %d", id_, category);
+Debug(this, "starting headers, category: %d", category);
 CHECK(!this->IsDestroyed());
  session_->DecrementCurrentSessionMemory(current_headers_length_);
  current_headers_length_ = 0;
@@ -2220,7 +2220,7 @@ int Http2Stream::DoWrite(WriteWrap* req_wrap,
  req_wrap->Done(UV_EOF);
 return0;
  }
-Debug(this, "queuing %d buffers to send", id_, nbufs);
+Debug(this, "queuing %d buffers to send", nbufs);
 for (size_t i = 0; i < nbufs; ++i){
 // Store the req_wrap on the last write info in the queue, so that it is
 // only marked as finished once all buffers associated with it are finished.

src/node_messaging.cc

@@ -1,7 +1,7 @@
 #include"node_messaging.h"
 
 #include"async_wrap-inl.h"
-#include"debug_utils.h"
+#include"debug_utils-inl.h"
 #include"memory_tracker-inl.h"
 #include"node_contextify.h"
 #include"node_buffer.h"

src/node_platform.cc

@@ -2,7 +2,7 @@
 #include"node_internals.h"
 
 #include"env-inl.h"
-#include"debug_utils.h"
+#include"debug_utils-inl.h"
 #include<algorithm>// find_if(), find(), move()
 #include<cmath>// llround()
 #include<memory>// unique_ptr(), shared_ptr(), make_shared()