third_party/WebKit/Source/platform/EventTracer.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef EventTracer_h
  32 #define EventTracer_h
  33
  34 #include "platform/PlatformExport.h"
  35 #include "wtf/RefCounted.h"
  36 #include "wtf/RefPtr.h"
  37 #include "wtf/text/WTFString.h"
  38
  39 #include <stdint.h>
  40
  41 // This will mark the trace event as disabled by default. The user will need
  42 // to explicitly enable the event.
  43 #define TRACE_DISABLED_BY_DEFAULT(name) "disabled-by-default-" name
  44
  45 namespace blink {
  46
  47 namespace TraceEvent {
  48 typedef uint64_t TraceEventHandle;
  49 typedef intptr_t TraceEventAPIAtomicWord;
  50
  51 class PLATFORM_EXPORT ConvertableToTraceFormat : public RefCounted<ConvertableToTraceFormat> {
  52 public:
  53     virtual String asTraceFormat() const = 0;
  54     virtual ~ConvertableToTraceFormat() { }
  55 };
  56
  57 }
  58
  59 // FIXME: Make these global variables thread-safe. Make a value update atomic.
  60 PLATFORM_EXPORT extern TraceEvent::TraceEventAPIAtomicWord* traceSamplingState[3];
  61
  62 class PLATFORM_EXPORT EventTracer {
  63 public:
  64     static void initialize();
  65     static const unsigned char* getTraceCategoryEnabledFlag(const char*);
  66     static TraceEvent::TraceEventHandle addTraceEvent(char phase,
  67         const unsigned char* categoryEnabledFlag,
  68         const char* name,
  69         unsigned long long id,
  70         double timestamp,
  71         int numArgs,
  72         const char* argNames[],
  73         const unsigned char argTypes[],
  74         const unsigned long long argValues[],
  75         PassRefPtr<TraceEvent::ConvertableToTraceFormat>,
  76         PassRefPtr<TraceEvent::ConvertableToTraceFormat>,
  77         unsigned char flags);
  78     static TraceEvent::TraceEventHandle addTraceEvent(char phase,
  79         const unsigned char* categoryEnabledFlag,
  80         const char* name,
  81         unsigned long long id,
  82         double timestamp,
  83         int numArgs,
  84         const char* argNames[],
  85         const unsigned char argTypes[],
  86         const unsigned long long argValues[],
  87         unsigned char flags);
  88     static void updateTraceEventDuration(const unsigned char* categoryEnabledFlag, const char* name, TraceEvent::TraceEventHandle);
  89 };
  90
  91 } // namespace blink
  92
  93 #endif // EventTracer_h