Home | History | Annotate | Download | only in platform
      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 WebCore {
     46 
     47 namespace TraceEvent {
     48 typedef uint64_t TraceEventHandle;
     49 
     50 class PLATFORM_EXPORT ConvertableToTraceFormat : public RefCounted<ConvertableToTraceFormat> {
     51 public:
     52     virtual String asTraceFormat() const = 0;
     53     virtual ~ConvertableToTraceFormat() { }
     54 };
     55 
     56 }
     57 
     58 // FIXME: Make these global variables thread-safe. Make a value update atomic.
     59 PLATFORM_EXPORT extern long* traceSamplingState[3];
     60 
     61 class PLATFORM_EXPORT EventTracer {
     62 public:
     63     static void initialize();
     64     static const unsigned char* getTraceCategoryEnabledFlag(const char*);
     65     static TraceEvent::TraceEventHandle addTraceEvent(char phase,
     66         const unsigned char* categoryEnabledFlag,
     67         const char* name,
     68         unsigned long long id,
     69         int numArgs,
     70         const char* argNames[],
     71         const unsigned char argTypes[],
     72         const unsigned long long argValues[],
     73         WebCore::TraceEvent::ConvertableToTraceFormat*[],
     74         unsigned char flags);
     75     static TraceEvent::TraceEventHandle addTraceEvent(char phase,
     76         const unsigned char* categoryEnabledFlag,
     77         const char* name,
     78         unsigned long long id,
     79         int numArgs,
     80         const char* argNames[],
     81         const unsigned char argTypes[],
     82         const unsigned long long argValues[],
     83         unsigned char flags);
     84     static void updateTraceEventDuration(const unsigned char* categoryEnabledFlag, const char* name, TraceEvent::TraceEventHandle);
     85 };
     86 
     87 } // namespace WebCore
     88 
     89 #endif // EventTracer_h
     90