Endless thread safe timeline recorder

runtime/vm/timeline.h

 // Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef VM_TIMELINE_H_
 #define VM_TIMELINE_H_
 
 #include "vm/bitfield.h"
 
 namespace dart {
 
 class JSONStream;
 class Object;
 class RawArray;
 class Thread;
 class TimelineEvent;
+class TimelineEventBlock;
 class TimelineEventRecorder;
 class TimelineStream;
 
 // You should get a |TimelineEvent| from a |TimelineStream|.
 class TimelineEvent {
  public:
   // Keep in sync with StateBits below.
   enum EventType {
     kNone,
     kDuration,
@@ skipping 212 matching lines @@
     }
     event_->DurationEnd();
     event_->Complete();
   }
 
  private:
   TimelineEvent* event_;
 };
 
 
+// A block of |TimelineEvent|s. Not thread safe.
+class TimelineEventBlock {
+ public:
+  static const intptr_t kBlockSize = 64;
+
+  TimelineEventBlock();
+
+  TimelineEventBlock* next() const {
+    return next_;
+  }
+  void set_next(TimelineEventBlock* next) {
+    next_ = next;
+  }
+
+  intptr_t length() const {
+    return length_;
+  }
+
+  bool IsFull() const {
+    return length_ == kBlockSize;
+  }
+
+  TimelineEvent* At(intptr_t index) {
+    ASSERT(index >= 0);
+    ASSERT(index < kBlockSize);
+    return &events_[index];
+  }
+
+ protected:
+  TimelineEvent* StartEvent();
+
+  TimelineEvent events_[kBlockSize];
+  TimelineEventBlock* next_;
+  intptr_t length_;
+
+  friend class TimelineEventEndlessRecorder;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(TimelineEventBlock);
+};
+
+
 // Recorder of |TimelineEvent|s.
 class TimelineEventRecorder {
  public:
   TimelineEventRecorder();
   virtual ~TimelineEventRecorder() {}
 
   // Interface method(s) which must be implemented.
-  virtual void PrintJSON(JSONStream* js) const = 0;
+  virtual void PrintJSON(JSONStream* js) = 0;
+
+  // Override if recorder uses blocks.
+  virtual TimelineEventBlock* GetNewBlock() {
+    return NULL;
+  }
 
   void WriteTo(const char* directory);
 
  protected:
   // Interface method(s) which must be implemented.
   virtual void VisitObjectPointers(ObjectPointerVisitor* visitor) = 0;
   virtual TimelineEvent* StartEvent(const Object& object) = 0;
   virtual TimelineEvent* StartEvent() = 0;
   virtual void CompleteEvent(TimelineEvent* event) = 0;
 
   // Utility method(s).
   void PrintJSONMeta(JSONArray* array) const;
 
   friend class TimelineStream;
   friend class Isolate;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(TimelineEventRecorder);
 };
 
 
 // A recorder that stores events in a ring buffer of fixed capacity.
+// This recorder does track Dart objects.
 class TimelineEventRingRecorder : public TimelineEventRecorder {
  public:
   static const intptr_t kDefaultCapacity = 8192;
 
   static intptr_t SizeForCapacity(intptr_t capacity);
 
   explicit TimelineEventRingRecorder(intptr_t capacity = kDefaultCapacity);
   ~TimelineEventRingRecorder();
 
-  void PrintJSON(JSONStream* js) const;
+  void PrintJSON(JSONStream* js);
 
  protected:
   void VisitObjectPointers(ObjectPointerVisitor* visitor);
   TimelineEvent* StartEvent(const Object& object);
   TimelineEvent* StartEvent();
   void CompleteEvent(TimelineEvent* event);
 
   void PrintJSONEvents(JSONArray* array) const;
 
   intptr_t GetNextIndex();
 
   // events_[i] and event_objects_[i] are indexed together.
   TimelineEvent* events_;
   RawArray* event_objects_;
   uintptr_t cursor_;
   intptr_t capacity_;
 };
 
 
 // An abstract recorder that calls |StreamEvent| whenever an event is complete.
 // This recorder does not track Dart objects.
 class TimelineEventStreamingRecorder : public TimelineEventRecorder {
  public:
   TimelineEventStreamingRecorder();
   ~TimelineEventStreamingRecorder();
 
-  void PrintJSON(JSONStream* js) const;
+  void PrintJSON(JSONStream* js);
 
   // Called when |event| is ready to be streamed. It is unsafe to keep a
   // reference to |event| as it may be freed as soon as this function returns.
   virtual void StreamEvent(TimelineEvent* event) = 0;
 
  protected:
   void VisitObjectPointers(ObjectPointerVisitor* visitor);
   TimelineEvent* StartEvent(const Object& object);
   TimelineEvent* StartEvent();
   void CompleteEvent(TimelineEvent* event);
 };
 
+
+// A recorder that stores events in chains of blocks of events.
+// This recorder does not track Dart objects.
+// NOTE: This recorder will continue to allocate blocks until it exhausts
+// memory.
+class TimelineEventEndlessRecorder : public TimelineEventRecorder {
+ public:
+  TimelineEventEndlessRecorder();
+
+  // Acquire a new block of events.
+  // Takes a lock.
+  // Recorder owns the block and it should be filled by only one thread.
+  TimelineEventBlock* GetNewBlock();
+
+  // It is expected that this function is only called when an isolate is
+  // shutting itself down.
+  // NOTE: Calling this while threads are filling in their blocks is not safe
+  // and there are no checks in place to ensure that doesn't happen.
+  // TODO(koda): Add isolate count to |ThreadRegistry| and verify that it is 1.
+  void PrintJSON(JSONStream* js);
+
+ protected:
+  void VisitObjectPointers(ObjectPointerVisitor* visitor);
+  TimelineEvent* StartEvent(const Object& object);
+  TimelineEvent* StartEvent();
+  void CompleteEvent(TimelineEvent* event);
+
+  TimelineEventBlock* GetNewBlockLocked();
+  void PrintJSONEvents(JSONArray* array) const;
+
+  Mutex lock_;
+  TimelineEventBlock* head_;
+};
+
 }  // namespace dart
 
 #endif  // VM_TIMELINE_H_