DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (d8847129d134)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
/* -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=2 sw=2 tw=80 et:
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef TimelineMarker_h__
#define TimelineMarker_h__

#include "nsString.h"
#include "GeckoProfiler.h"
#include "mozilla/dom/ProfileTimelineMarkerBinding.h"
#include "nsContentUtils.h"
#include "jsapi.h"

class nsDocShell;

// Objects of this type can be added to the timeline.  The class can
// also be subclassed to let a given marker creator provide custom
// details.
class TimelineMarker
{
public:
  TimelineMarker(nsDocShell* aDocShell, const char* aName,
                 TracingMetadata aMetaData);

  TimelineMarker(nsDocShell* aDocShell, const char* aName,
                 TracingMetadata aMetaData,
                 const nsAString& aCause);

  virtual ~TimelineMarker();

  // Check whether two markers should be considered the same,
  // for the purpose of pairing start and end markers.  Normally
  // this definition suffices.
  virtual bool Equals(const TimelineMarker* other)
  {
    return strcmp(mName, other->mName) == 0;
  }

  // Add details specific to this marker type to aMarker.  The
  // standard elements have already been set.  This method is
  // called on both the starting and ending markers of a pair.
  // Ordinarily the ending marker doesn't need to do anything
  // here.
  virtual void AddDetails(mozilla::dom::ProfileTimelineMarker& aMarker)
  {
  }

  virtual void AddLayerRectangles(mozilla::dom::Sequence<mozilla::dom::ProfileTimelineLayerRect>&)
  {
    MOZ_ASSERT_UNREACHABLE("can only be called on layer markers");
  }

  const char* GetName() const
  {
    return mName;
  }

  TracingMetadata GetMetaData() const
  {
    return mMetaData;
  }

  DOMHighResTimeStamp GetTime() const
  {
    return mTime;
  }

  const nsString& GetCause() const
  {
    return mCause;
  }

  JSObject* GetStack()
  {
    if (mStackTrace) {
      return mStackTrace->get();
    }
    return nullptr;
  }

protected:

  void CaptureStack()
  {
    JSContext* ctx = nsContentUtils::GetCurrentJSContext();
    if (ctx) {
      JS::RootedObject stack(ctx);
      if (JS::CaptureCurrentStack(ctx, &stack)) {
        mStackTrace.emplace(ctx, stack.get());
      } else {
        JS_ClearPendingException(ctx);
      }
    }
  }

private:

  const char* mName;
  TracingMetadata mMetaData;
  DOMHighResTimeStamp mTime;
  nsString mCause;

  // While normally it is not a good idea to make a persistent root,
  // in this case changing nsDocShell to participate in cycle
  // collection was deemed too invasive, and the markers are only held
  // here temporarily to boot.
  mozilla::Maybe<JS::PersistentRooted<JSObject*>> mStackTrace;
};

#endif /* TimelineMarker_h__ */