quic: refactoring node_quic_util to inline

PR-URL: #207
Reviewed-By: #207

Author: jasnell

node.gyp

@@ -853,14 +853,14 @@
             'src/node_quic_socket.h',
             'src/node_quic_stream.h',
             'src/node_quic_util.h',
+            'src/node_quic_util-inl.h',
             'src/node_quic_state.h',
             'src/node_quic_default_application.h',
             'src/node_quic_http3_application.h',
             'src/node_quic_crypto.cc',
             'src/node_quic_session.cc',
             'src/node_quic_socket.cc',
             'src/node_quic_stream.cc',
-            'src/node_quic_util.cc',
             'src/node_quic.cc',
             'src/node_quic_default_application.cc',
             'src/node_quic_http3_application.cc'

src/node_quic.cc

@@ -10,7 +10,7 @@
 #include "node_quic_socket.h"
 #include "node_quic_stream.h"
 #include "node_quic_state.h"
-#include "node_quic_util.h"
+#include "node_quic_util-inl.h"
 
 #include <memory>
 #include <utility>

src/node_quic_crypto.cc

@@ -3,7 +3,7 @@
 #include "node_crypto.h"
 #include "node_crypto_common.h"
 #include "node_quic_session-inl.h"
-#include "node_quic_util.h"
+#include "node_quic_util-inl.h"
 #include "node_url.h"
 #include "string_bytes.h"
 #include "v8.h"

src/node_quic_default_application.cc

@@ -2,6 +2,7 @@
 #include "node_quic_default_application.h"
 #include "node_quic_session-inl.h"
 #include "node_quic_stream.h"
+#include "node_quic_util-inl.h"
 #include <ngtcp2/ngtcp2.h>
 
 namespace node {

src/node_quic_http3_application.cc

@@ -4,7 +4,7 @@
 #include "node_quic_http3_application.h"
 #include "node_quic_session-inl.h"
 #include "node_quic_stream.h"
-#include "node_quic_util.h"
+#include "node_quic_util-inl.h"
 #include "node_http_common-inl.h"
 
 #include <nghttp3/nghttp3.h>

src/node_quic_session.cc

@@ -10,13 +10,14 @@
 #include "node_crypto.h"
 #include "node_internals.h"
 #include "node_mem-inl.h"
+#include "node_quic_buffer.h"
 #include "node_quic_crypto.h"
 #include "node_quic_session.h"  // NOLINT(build/include_inline)
 #include "node_quic_session-inl.h"
 #include "node_quic_socket.h"
 #include "node_quic_stream.h"
 #include "node_quic_state.h"
-#include "node_quic_util.h"
+#include "node_quic_util-inl.h"
 #include "node_quic_default_application.h"
 #include "node_quic_http3_application.h"
 #include "v8.h"

src/node_quic_session.h

@@ -11,6 +11,7 @@
 #include "node.h"
 #include "node_crypto.h"
 #include "node_mem.h"
+#include "node_quic_buffer.h"
 #include "node_quic_crypto.h"
 #include "node_quic_util.h"
 #include "v8.h"

src/node_quic_socket.cc

@@ -10,7 +10,7 @@
 #include "node_quic_crypto.h"
 #include "node_quic_session-inl.h"
 #include "node_quic_socket.h"
-#include "node_quic_util.h"
+#include "node_quic_util-inl.h"
 #include "req_wrap-inl.h"
 #include "util.h"
 #include "uv.h"

src/node_quic_stream.cc

@@ -8,7 +8,7 @@
 #include "node_quic_session-inl.h"
 #include "node_quic_stream.h"
 #include "node_quic_socket.h"
-#include "node_quic_util.h"
+#include "node_quic_util-inl.h"
 #include "v8.h"
 #include "uv.h"
 

src/node_quic_util.cc renamed to src/node_quic_util-inl.h

@@ -1,13 +1,63 @@
+#ifndef SRC_NODE_QUIC_UTIL_INL_H_
+#define SRC_NODE_QUIC_UTIL_INL_H_
+
 #include "node_internals.h"
 #include "node_quic_util.h"
 #include "env-inl.h"
+#include "string_bytes.h"
 #include "util-inl.h"
 #include "uv.h"
 
+#include <string>
+
 namespace node {
 
 namespace quic {
 
+std::string QuicCID::ToStr() const {
+  return std::string(cid_.data, cid_.data + cid_.datalen);
+}
+
+std::string QuicCID::ToHex() const {
+  MaybeStackBuffer<char, 64> dest;
+  dest.AllocateSufficientStorage(cid_.datalen * 2);
+  dest.SetLengthAndZeroTerminate(cid_.datalen * 2);
+  size_t written = StringBytes::hex_encode(
+      reinterpret_cast<const char*>(cid_.data),
+      cid_.datalen,
+      *dest,
+      dest.length());
+  return std::string(*dest, written);
+}
+
+
+Timer::Timer(Environment* env, std::function<void()> fn)
+  : env_(env),
+    fn_(fn) {
+  uv_timer_init(env_->event_loop(), &timer_);
+  timer_.data = this;
+}
+
+void Timer::Stop() {
+  if (stopped_)
+    return;
+  stopped_ = true;
+
+  if (timer_.data == this) {
+    uv_timer_stop(&timer_);
+    timer_.data = nullptr;
+  }
+}
+
+// If the timer is not currently active, interval must be either 0 or greater.
+// If the timer is already active, interval is ignored.
+void Timer::Update(uint64_t interval) {
+  if (stopped_)
+    return;
+  uv_timer_start(&timer_, OnTimeout, interval, interval);
+  uv_unref(reinterpret_cast<uv_handle_t*>(&timer_));
+}
+
 void Timer::Free(Timer* timer) {
   timer->env_->CloseHandle(
       reinterpret_cast<uv_handle_t*>(&timer->timer_),
@@ -112,3 +162,5 @@ const char* QuicError::GetFamilyName() {
 
 }  // namespace quic
 }  // namespace node
+
+#endif  // SRC_NODE_QUIC_UTIL_INL_H_

src/node_quic_util.h

@@ -4,8 +4,6 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include "node.h"
-#include "node_quic_buffer.h"
-#include "string_bytes.h"
 #include "uv.h"
 #include "v8.h"
 
@@ -80,18 +78,18 @@ enum QuicErrorFamily : int32_t {
 struct QuicError {
   int32_t family;
   uint64_t code;
-  QuicError(
+  inline QuicError(
       int32_t family_ = QUIC_ERROR_SESSION,
       int code_ = NGTCP2_NO_ERROR);
-  QuicError(
+  inline QuicError(
       int32_t family_ = QUIC_ERROR_SESSION,
       uint64_t code_ = NGTCP2_NO_ERROR);
-  QuicError(
+  inline QuicError(
       Environment* env,
       v8::Local<v8::Value> codeArg,
       v8::Local<v8::Value> familyArg = v8::Local<v8::Object>(),
       int32_t family_ = QUIC_ERROR_SESSION);
-  const char* GetFamilyName();
+  inline const char* GetFamilyName();
 };
 
 class SocketAddress {
@@ -269,8 +267,8 @@ class SocketAddress {
 
 struct QuicPath : public ngtcp2_path {
   QuicPath(
-    SocketAddress* local,
-    SocketAddress* remote) {
+      SocketAddress* local,
+      SocketAddress* remote) {
     ngtcp2_addr_init(&this->local, **local, local->Size(), nullptr);
     ngtcp2_addr_init(&this->remote, **remote, remote->Size(), nullptr);
   }
@@ -300,23 +298,9 @@ class QuicCID {
     str_ = std::string(cid_.data, cid_.data + cid_.datalen);
   }
 
-  std::string ToStr() const { return str_; }
-
-  std::string ToHex() const {
-    if (hex_.empty() && cid_.datalen > 0) {
-      size_t len = cid_.datalen * 2;
-      MaybeStackBuffer<char, 64> dest;
-      dest.AllocateSufficientStorage(len);
-      dest.SetLengthAndZeroTerminate(len);
-      size_t written = StringBytes::hex_encode(
-          reinterpret_cast<const char*>(cid_.data),
-          cid_.datalen,
-          *dest,
-          dest.length());
-      hex_ = std::string(*dest, written);
-    }
-    return hex_;
-  }
+  inline std::string ToStr() const;
+
+  inline std::string ToHex() const;
 
   const ngtcp2_cid* operator*() const { return &cid_; }
 
@@ -356,43 +340,24 @@ void IncrementStat(
 // reset the timer; Stop to halt the timer.
 class Timer final : public MemoryRetainer {
  public:
-  explicit Timer(Environment* env, std::function<void()> fn)
-    : env_(env),
-      fn_(fn) {
-    uv_timer_init(env_->event_loop(), &timer_);
-    timer_.data = this;
-  }
+  inline explicit Timer(Environment* env, std::function<void()> fn);
 
   // Stops the timer with the side effect of the timer no longer being usable.
   // It will be cleaned up and the Timer object will be destroyed.
-  void Stop() {
-    if (stopped_)
-      return;
-    stopped_ = true;
-
-    if (timer_.data == this) {
-      uv_timer_stop(&timer_);
-      timer_.data = nullptr;
-    }
-  }
+  inline void Stop();
 
   // If the timer is not currently active, interval must be either 0 or greater.
   // If the timer is already active, interval is ignored.
-  void Update(uint64_t interval) {
-    if (stopped_)
-      return;
-    uv_timer_start(&timer_, OnTimeout, interval, interval);
-    uv_unref(reinterpret_cast<uv_handle_t*>(&timer_));
-  }
+  inline void Update(uint64_t interval);
 
-  static void Free(Timer* timer);
+  static inline void Free(Timer* timer);
 
   SET_NO_MEMORY_INFO()
   SET_MEMORY_INFO_NAME(Timer)
   SET_SELF_SIZE(Timer)
 
  private:
-  static void OnTimeout(uv_timer_t* timer);
+  static inline void OnTimeout(uv_timer_t* timer);
 
   bool stopped_ = false;
   Environment* env_;
@@ -402,8 +367,8 @@ class Timer final : public MemoryRetainer {
 
 using TimerPointer = DeleteFnPtr<Timer, Timer::Free>;
 
-ngtcp2_crypto_level from_ossl_level(OSSL_ENCRYPTION_LEVEL ossl_level);
-const char* crypto_level_name(ngtcp2_crypto_level level);
+inline ngtcp2_crypto_level from_ossl_level(OSSL_ENCRYPTION_LEVEL ossl_level);
+inline const char* crypto_level_name(ngtcp2_crypto_level level);
 
 }  // namespace quic
 }  // namespace node