@kungfu-tech/libnode-win32-x64 22.22.3-kf.0 → 22.22.3-kf.1

package/dist/node/include/tracing/agent.h

@@ -0,0 +1,195 @@
+#ifndef SRC_TRACING_AGENT_H_
+#define SRC_TRACING_AGENT_H_
+
+#include "libplatform/v8-tracing.h"
+#include "uv.h"
+#include "util.h"
+#include "node_mutex.h"
+
+#include <list>
+#include <set>
+#include <string>
+#include <unordered_map>
+
+namespace v8 {
+class ConvertableToTraceFormat;
+class TracingController;
+}  // namespace v8
+
+namespace node {
+namespace tracing {
+
+using v8::platform::tracing::TraceConfig;
+using v8::platform::tracing::TraceObject;
+
+class Agent;
+
+class AsyncTraceWriter {
+ public:
+  virtual ~AsyncTraceWriter() = default;
+  virtual void AppendTraceEvent(TraceObject* trace_event) = 0;
+  virtual void Flush(bool blocking) = 0;
+  virtual void InitializeOnThread(uv_loop_t* loop) {}
+};
+
+class TracingController : public v8::platform::tracing::TracingController {
+ public:
+  TracingController() : v8::platform::tracing::TracingController() {}
+
+  int64_t CurrentTimestampMicroseconds() override {
+    return uv_hrtime() / 1000;
+  }
+  void AddMetadataEvent(
+      const unsigned char* category_group_enabled,
+      const char* name,
+      int num_args,
+      const char** arg_names,
+      const unsigned char* arg_types,
+      const uint64_t* arg_values,
+      std::unique_ptr<v8::ConvertableToTraceFormat>* convertable_values,
+      unsigned int flags);
+};
+
+class AgentWriterHandle {
+ public:
+  inline AgentWriterHandle() = default;
+  inline ~AgentWriterHandle() { reset(); }
+
+  inline AgentWriterHandle(AgentWriterHandle&& other);
+  inline AgentWriterHandle& operator=(AgentWriterHandle&& other);
+  inline bool empty() const { return agent_ == nullptr; }
+  inline void reset();
+
+  inline void Enable(const std::set<std::string>& categories);
+  inline void Disable(const std::set<std::string>& categories);
+
+  inline bool IsDefaultHandle();
+
+  inline Agent* agent() { return agent_; }
+
+  inline v8::TracingController* GetTracingController();
+
+  AgentWriterHandle(const AgentWriterHandle& other) = delete;
+  AgentWriterHandle& operator=(const AgentWriterHandle& other) = delete;
+
+ private:
+  inline AgentWriterHandle(Agent* agent, int id) : agent_(agent), id_(id) {}
+
+  Agent* agent_ = nullptr;
+  int id_ = 0;
+
+  friend class Agent;
+};
+
+class Agent {
+ public:
+  Agent();
+  ~Agent();
+
+  TracingController* GetTracingController() {
+    TracingController* controller = tracing_controller_.get();
+    CHECK_NOT_NULL(controller);
+    return controller;
+  }
+
+  enum UseDefaultCategoryMode {
+    kUseDefaultCategories,
+    kIgnoreDefaultCategories
+  };
+
+  // Destroying the handle disconnects the client
+  AgentWriterHandle AddClient(const std::set<std::string>& categories,
+                              std::unique_ptr<AsyncTraceWriter> writer,
+                              enum UseDefaultCategoryMode mode);
+  // A handle that is only used for managing the default categories
+  // (which can then implicitly be used through using `USE_DEFAULT_CATEGORIES`
+  // when adding a client later).
+  AgentWriterHandle DefaultHandle();
+
+  // Returns a comma-separated list of enabled categories.
+  std::string GetEnabledCategories() const;
+
+  // Writes to all writers registered through AddClient().
+  void AppendTraceEvent(TraceObject* trace_event);
+
+  void AddMetadataEvent(std::unique_ptr<TraceObject> event);
+  // Flushes all writers registered through AddClient().
+  void Flush(bool blocking);
+
+  TraceConfig* CreateTraceConfig() const;
+
+ private:
+  friend class AgentWriterHandle;
+
+  void InitializeWritersOnThread();
+
+  void Start();
+  void StopTracing();
+  void Disconnect(int client);
+
+  void Enable(int id, const std::set<std::string>& categories);
+  void Disable(int id, const std::set<std::string>& categories);
+
+  uv_thread_t thread_;
+  uv_loop_t tracing_loop_;
+
+  bool started_ = false;
+  class ScopedSuspendTracing;
+
+  // Each individual Writer has one id.
+  int next_writer_id_ = 1;
+  enum { kDefaultHandleId = -1 };
+  // These maps store the original arguments to AddClient(), by id.
+  std::unordered_map<int, std::multiset<std::string>> categories_;
+  std::unordered_map<int, std::unique_ptr<AsyncTraceWriter>> writers_;
+  std::unique_ptr<TracingController> tracing_controller_;
+
+  // Variables related to initializing per-event-loop properties of individual
+  // writers, such as libuv handles.
+  Mutex initialize_writer_mutex_;
+  ConditionVariable initialize_writer_condvar_;
+  uv_async_t initialize_writer_async_;
+  std::set<AsyncTraceWriter*> to_be_initialized_;
+
+  Mutex metadata_events_mutex_;
+  std::list<std::unique_ptr<TraceObject>> metadata_events_;
+};
+
+void AgentWriterHandle::reset() {
+  if (agent_ != nullptr)
+    agent_->Disconnect(id_);
+  agent_ = nullptr;
+}
+
+AgentWriterHandle& AgentWriterHandle::operator=(AgentWriterHandle&& other) {
+  reset();
+  agent_ = other.agent_;
+  id_ = other.id_;
+  other.agent_ = nullptr;
+  return *this;
+}
+
+AgentWriterHandle::AgentWriterHandle(AgentWriterHandle&& other) {
+  *this = std::move(other);
+}
+
+void AgentWriterHandle::Enable(const std::set<std::string>& categories) {
+  if (agent_ != nullptr) agent_->Enable(id_, categories);
+}
+
+void AgentWriterHandle::Disable(const std::set<std::string>& categories) {
+  if (agent_ != nullptr) agent_->Disable(id_, categories);
+}
+
+bool AgentWriterHandle::IsDefaultHandle() {
+  return agent_ != nullptr && id_ == Agent::kDefaultHandleId;
+}
+
+inline v8::TracingController* AgentWriterHandle::GetTracingController() {
+  return agent_ != nullptr ? agent_->GetTracingController() : nullptr;
+}
+
+}  // namespace tracing
+}  // namespace node
+
+#endif  // SRC_TRACING_AGENT_H_

package/dist/node/include/tracing/node_trace_buffer.h

@@ -0,0 +1,83 @@
+#ifndef SRC_TRACING_NODE_TRACE_BUFFER_H_
+#define SRC_TRACING_NODE_TRACE_BUFFER_H_
+
+#include "tracing/agent.h"
+#include "node_mutex.h"
+#include "libplatform/v8-tracing.h"
+
+#include <atomic>
+
+namespace node {
+namespace tracing {
+
+using v8::platform::tracing::TraceBuffer;
+using v8::platform::tracing::TraceBufferChunk;
+using v8::platform::tracing::TraceObject;
+
+// forward declaration
+class NodeTraceBuffer;
+
+class InternalTraceBuffer {
+ public:
+  InternalTraceBuffer(size_t max_chunks, uint32_t id, Agent* agent);
+
+  TraceObject* AddTraceEvent(uint64_t* handle);
+  TraceObject* GetEventByHandle(uint64_t handle);
+  void Flush(bool blocking);
+  bool IsFull() const {
+    return total_chunks_ == max_chunks_ && chunks_[total_chunks_ - 1]->IsFull();
+  }
+  bool IsFlushing() const {
+    return flushing_;
+  }
+
+ private:
+  uint64_t MakeHandle(size_t chunk_index, uint32_t chunk_seq,
+                      size_t event_index) const;
+  void ExtractHandle(uint64_t handle, uint32_t* buffer_id, size_t* chunk_index,
+                     uint32_t* chunk_seq, size_t* event_index) const;
+  size_t Capacity() const { return max_chunks_ * TraceBufferChunk::kChunkSize; }
+
+  Mutex mutex_;
+  bool flushing_;
+  size_t max_chunks_;
+  Agent* agent_;
+  std::vector<std::unique_ptr<TraceBufferChunk>> chunks_;
+  size_t total_chunks_ = 0;
+  uint32_t current_chunk_seq_ = 1;
+  uint32_t id_;
+};
+
+class NodeTraceBuffer : public TraceBuffer {
+ public:
+  NodeTraceBuffer(size_t max_chunks, Agent* agent, uv_loop_t* tracing_loop);
+  ~NodeTraceBuffer() override;
+
+  TraceObject* AddTraceEvent(uint64_t* handle) override;
+  TraceObject* GetEventByHandle(uint64_t handle) override;
+  bool Flush() override;
+
+  static const size_t kBufferChunks = 1024;
+
+ private:
+  bool TryLoadAvailableBuffer();
+  static void NonBlockingFlushSignalCb(uv_async_t* signal);
+  static void ExitSignalCb(uv_async_t* signal);
+
+  uv_loop_t* tracing_loop_;
+  uv_async_t flush_signal_;
+  uv_async_t exit_signal_;
+  bool exited_ = false;
+  // Used exclusively for exit logic.
+  Mutex exit_mutex_;
+  // Used to wait until async handles have been closed.
+  ConditionVariable exit_cond_;
+  std::atomic<InternalTraceBuffer*> current_buf_;
+  InternalTraceBuffer buffer1_;
+  InternalTraceBuffer buffer2_;
+};
+
+}  // namespace tracing
+}  // namespace node
+
+#endif  // SRC_TRACING_NODE_TRACE_BUFFER_H_

package/dist/node/include/tracing/node_trace_writer.h

@@ -0,0 +1,75 @@
+#ifndef SRC_TRACING_NODE_TRACE_WRITER_H_
+#define SRC_TRACING_NODE_TRACE_WRITER_H_
+
+#include <sstream>
+#include <queue>
+
+#include "libplatform/v8-tracing.h"
+#include "tracing/agent.h"
+#include "uv.h"
+
+namespace node {
+namespace tracing {
+
+using v8::platform::tracing::TraceObject;
+using v8::platform::tracing::TraceWriter;
+
+class NodeTraceWriter : public AsyncTraceWriter {
+ public:
+  explicit NodeTraceWriter(const std::string& log_file_pattern);
+  ~NodeTraceWriter() override;
+
+  void InitializeOnThread(uv_loop_t* loop) override;
+  void AppendTraceEvent(TraceObject* trace_event) override;
+  void Flush(bool blocking) override;
+
+  static const int kTracesPerFile = 1 << 19;
+
+ private:
+  struct WriteRequest {
+    std::string str;
+    int highest_request_id;
+  };
+
+  void AfterWrite();
+  void StartWrite(uv_buf_t buf);
+  void OpenNewFileForStreaming();
+  void WriteToFile(std::string&& str, int highest_request_id);
+  void WriteSuffix();
+  void FlushPrivate();
+  static void ExitSignalCb(uv_async_t* signal);
+
+  uv_loop_t* tracing_loop_ = nullptr;
+  // Triggers callback to initiate writing the contents of stream_ to disk.
+  uv_async_t flush_signal_;
+  // Triggers callback to close async objects, ending the tracing thread.
+  uv_async_t exit_signal_;
+  // Prevents concurrent R/W on state related to serialized trace data
+  // before it's written to disk, namely stream_ and total_traces_
+  // as well as json_trace_writer_.
+  Mutex stream_mutex_;
+  // Prevents concurrent R/W on state related to write requests.
+  // If both mutexes are locked, request_mutex_ has to be locked first.
+  Mutex request_mutex_;
+  // Allows blocking calls to Flush() to wait on a condition for
+  // trace events to be written to disk.
+  ConditionVariable request_cond_;
+  // Used to wait until async handles have been closed.
+  ConditionVariable exit_cond_;
+  int fd_ = -1;
+  uv_fs_t write_req_;
+  std::queue<WriteRequest> write_req_queue_;
+  int num_write_requests_ = 0;
+  int highest_request_id_completed_ = 0;
+  int total_traces_ = 0;
+  int file_num_ = 0;
+  std::string log_file_pattern_;
+  std::ostringstream stream_;
+  std::unique_ptr<TraceWriter> json_trace_writer_;
+  bool exited_ = false;
+};
+
+}  // namespace tracing
+}  // namespace node
+
+#endif  // SRC_TRACING_NODE_TRACE_WRITER_H_