1fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot/* 2fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * Copyright (C) 2014 Google Inc. All rights reserved. 3fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * 4fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * Use of this source code is governed by a BSD-style license that can be 5fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * found in the LICENSE file. 6fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot */ 7fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 8fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot#ifndef SkEventTracer_DEFINED 9fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot#define SkEventTracer_DEFINED 10fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 11fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot// The class in this header defines the interface between Skia's internal 12fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot// tracing macros and an external entity (e.g., Chrome) that will consume them. 13fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot// Such an entity should subclass SkEventTracer and provide an instance of 14fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot// that event to SkEventTracer::SetInstance. 15fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 16fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot// If you're looking for the tracing macros to instrument Skia itself, those 17fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot// live in src/core/SkTraceEvent.h 18fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 19fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot#include "SkTypes.h" 20fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 21fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robotclass SK_API SkEventTracer { 22fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robotpublic: 23fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 24fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot typedef uint64_t Handle; 25fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 26fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot /** 27fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * If this is the first call to SetInstance or GetInstance then the passed instance is 28fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * installed and true is returned. Otherwise, false is returned. In either case ownership of the 29fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * tracer is transferred and it will be deleted when no longer needed. 30fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot */ 31fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot static bool SetInstance(SkEventTracer*); 32fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 33fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot /** 34fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * Gets the event tracer. If this is the first call to SetInstance or GetIntance then a default 35fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot * event tracer is installed and returned. 36fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot */ 37fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot static SkEventTracer* GetInstance(); 38fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 39fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot virtual ~SkEventTracer() { } 40fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 41fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // The pointer returned from GetCategoryGroupEnabled() points to a 42fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // value with zero or more of the following bits. Used in this class only. 43fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // The TRACE_EVENT macros should only use the value as a bool. 44fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // These values must be in sync with macro values in trace_event.h in chromium. 45fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot enum CategoryGroupEnabledFlags { 46fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // Category group enabled for the recording mode. 47fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot kEnabledForRecording_CategoryGroupEnabledFlags = 1 << 0, 48fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // Category group enabled for the monitoring mode. 49fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot kEnabledForMonitoring_CategoryGroupEnabledFlags = 1 << 1, 50fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot // Category group enabled by SetEventCallbackEnabled(). 51fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot kEnabledForEventCallback_CategoryGroupEnabledFlags = 1 << 2, 52fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot }; 53fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 54fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot virtual const uint8_t* getCategoryGroupEnabled(const char* name) = 0; 55fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot virtual const char* getCategoryGroupName(const uint8_t* categoryEnabledFlag) = 0; 56fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 57fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot virtual SkEventTracer::Handle 58fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot addTraceEvent(char phase, 59fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot const uint8_t* categoryEnabledFlag, 60fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot const char* name, 61fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot uint64_t id, 62fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot int32_t numArgs, 63fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot const char** argNames, 64fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot const uint8_t* argTypes, 65fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot const uint64_t* argValues, 66fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot uint8_t flags) = 0; 67fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 68fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot virtual void 69fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot updateTraceEventDuration(const uint8_t* categoryEnabledFlag, 70fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot const char* name, 71fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot SkEventTracer::Handle handle) = 0; 72fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot}; 73fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot 74fe17456d5e528078ce69b5f15cf7adf1fab963fandroid-build-team Robot#endif // SkEventTracer_DEFINED 75