1f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis/* 2f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * Copyright (C) 2012 The Android Open Source Project 3f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * 4f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * Licensed under the Apache License, Version 2.0 (the "License"); 5f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * you may not use this file except in compliance with the License. 6f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * You may obtain a copy of the License at 7f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * 8f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * http://www.apache.org/licenses/LICENSE-2.0 9f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * 10f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * Unless required by applicable law or agreed to in writing, software 11f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * distributed under the License is distributed on an "AS IS" BASIS, 12f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * See the License for the specific language governing permissions and 14f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis * limitations under the License. 15f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis */ 16f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 17f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#ifndef ANDROID_TRACE_H 18f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#define ANDROID_TRACE_H 19f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 20f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <fcntl.h> 21f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <stdint.h> 22f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <stdio.h> 23f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <string.h> 24f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <sys/stat.h> 25f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <sys/types.h> 26f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <unistd.h> 27f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 28f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <cutils/compiler.h> 29f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#include <utils/threads.h> 30f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 31f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// The ATRACE_TAG macro can be defined before including this header to trace 32f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// using one of the tags defined below. It must be defined to one of the 33f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// following ATRACE_TAG_* macros. The trace tag is used to filter tracing in 34f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// userland to avoid some of the runtime cost of tracing when it is not desired. 35f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// 36f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// Defining ATRACE_TAG to be ATRACE_TAG_ALWAYS will result in the tracing always 37f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// being enabled - this should ONLY be done for debug code, as userland tracing 38f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// has a performance cost even when the trace is not being recorded. Defining 39f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// ATRACE_TAG to be ATRACE_TAG_NEVER or leaving ATRACE_TAG undefined will result 40f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// in the tracing always being disabled. 4145b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown// 4245b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown// These tags must be kept in sync with frameworks/base/core/java/android/os/Trace.java. 431cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_NEVER 0 // The "never" tag is never enabled. 441cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_ALWAYS (1<<0) // The "always" tag is always enabled. 451cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_GRAPHICS (1<<1) 461cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_INPUT (1<<2) 471cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_VIEW (1<<3) 481cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_WEBVIEW (1<<4) 491cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_WINDOW_MANAGER (1<<5) 501cb93ba130241dbb70b81a1fa4d2704386c6dae8Dianne Hackborn#define ATRACE_TAG_ACTIVITY_MANAGER (1<<6) 51081c80c2e0f97fb50595b138271d14892aea1b4aAndy Stadler#define ATRACE_TAG_SYNC_MANAGER (1<<7) 525b38a1dfe8e90734fc878ef47df1bd967480a946Glenn Kasten#define ATRACE_TAG_AUDIO (1<<8) 53b194ec926bf3fb3c546244b135f602ceb3a0a6b0Jamie Gennis#define ATRACE_TAG_VIDEO (1<<9) 541737e57a861326e96f3de19090975564f98a8fdaEino-Ville Talvala#define ATRACE_TAG_CAMERA (1<<10) 551737e57a861326e96f3de19090975564f98a8fdaEino-Ville Talvala#define ATRACE_TAG_LAST ATRACE_TAG_CAMERA 56f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 5745b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown#define ATRACE_TAG_VALID_MASK ((ATRACE_TAG_LAST - 1) | ATRACE_TAG_LAST) 58f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 59f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#ifndef ATRACE_TAG 60f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#define ATRACE_TAG ATRACE_TAG_NEVER 61f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#elif ATRACE_TAG > ATRACE_TAG_LAST 62f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#error ATRACE_TAG must be defined to be one of the tags defined in utils/Trace.h 63f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#endif 64f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 65f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// ATRACE_CALL traces the beginning and end of the current function. To trace 66f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// the correct start and end times this macro should be the first line of the 67f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// function body. 68f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#define ATRACE_CALL() android::ScopedTrace ___tracer(ATRACE_TAG, __FUNCTION__) 69f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 7016928bfeca8858a0acae6942fc68c14a040b92ffRomain Guy// ATRACE_NAME traces the beginning and end of the current function. To trace 7116928bfeca8858a0acae6942fc68c14a040b92ffRomain Guy// the correct start and end times this macro should be the first line of the 7216928bfeca8858a0acae6942fc68c14a040b92ffRomain Guy// function body. 7316928bfeca8858a0acae6942fc68c14a040b92ffRomain Guy#define ATRACE_NAME(name) android::ScopedTrace ___tracer(ATRACE_TAG, name) 7416928bfeca8858a0acae6942fc68c14a040b92ffRomain Guy 75f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// ATRACE_INT traces a named integer value. This can be used to track how the 76f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis// value changes over time in a trace. 77f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#define ATRACE_INT(name, value) android::Tracer::traceCounter(ATRACE_TAG, name, value) 78f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 7945b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown// ATRACE_ENABLED returns true if the trace tag is enabled. It can be used as a 8045b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown// guard condition around more expensive trace calculations. 8145b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown#define ATRACE_ENABLED() android::Tracer::isTagEnabled(ATRACE_TAG) 8245b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown 83f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennisnamespace android { 84f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 85f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennisclass Tracer { 86f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 87f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennispublic: 88f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 8945b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown static uint64_t getEnabledTags() { 9045b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown initIfNeeded(); 9145b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown return sEnabledTags; 9245b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown } 9345b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown 9445b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown static inline bool isTagEnabled(uint64_t tag) { 9545b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown initIfNeeded(); 9645b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown return sEnabledTags & tag; 9745b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown } 9845b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown 99f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static inline void traceCounter(uint64_t tag, const char* name, 100f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis int32_t value) { 10145b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown if (CC_UNLIKELY(isTagEnabled(tag))) { 102f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis char buf[1024]; 103f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis snprintf(buf, 1024, "C|%d|%s|%d", getpid(), name, value); 10445b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown write(sTraceFD, buf, strlen(buf)); 105f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 106f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 107f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 108f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static inline void traceBegin(uint64_t tag, const char* name) { 10945b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown if (CC_UNLIKELY(isTagEnabled(tag))) { 110f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis char buf[1024]; 111f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis size_t len = snprintf(buf, 1024, "B|%d|%s", getpid(), name); 11245b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown write(sTraceFD, buf, len); 113f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 114f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 115f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 116f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static inline void traceEnd(uint64_t tag) { 11745b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown if (CC_UNLIKELY(isTagEnabled(tag))) { 118f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis char buf = 'E'; 11945b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown write(sTraceFD, &buf, 1); 120f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 121f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 122f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 123f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennisprivate: 124f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 12545b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown static inline void initIfNeeded() { 12645b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown if (!android_atomic_acquire_load(&sIsReady)) { 12745b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown init(); 12845b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown } 129f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 130f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 131555f89d8df316cdc5a25dbedb8614c2ac7a5e0a9Dianne Hackborn static void changeCallback(); 132555f89d8df316cdc5a25dbedb8614c2ac7a5e0a9Dianne Hackborn 133f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // init opens the trace marker file for writing and reads the 134f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // atrace.tags.enableflags system property. It does this only the first 135f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // time it is run, using sMutex for synchronization. 136f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static void init(); 137f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 138555f89d8df316cdc5a25dbedb8614c2ac7a5e0a9Dianne Hackborn // retrieve the current value of the system property. 139555f89d8df316cdc5a25dbedb8614c2ac7a5e0a9Dianne Hackborn static void loadSystemProperty(); 140555f89d8df316cdc5a25dbedb8614c2ac7a5e0a9Dianne Hackborn 141f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // sIsReady is a boolean value indicating whether a call to init() has 142f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // completed in this process. It is initialized to 0 and set to 1 when the 143f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // first init() call completes. It is set to 1 even if a failure occurred 144f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // in init (e.g. the trace marker file couldn't be opened). 145f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // 146f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // This should be checked by all tracing functions using an atomic acquire 147f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // load operation before calling init(). This check avoids the need to lock 148f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // a mutex each time a trace function gets called. 149f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static volatile int32_t sIsReady; 150f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 151f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // sTraceFD is the file descriptor used to write to the kernel's trace 152f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // buffer. It is initialized to -1 and set to an open file descriptor in 153f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // init() while a lock on sMutex is held. 154f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // 155f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // This should only be used by a trace function after init() has 156f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // successfully completed. 157f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static int sTraceFD; 158f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 159f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // sEnabledTags is the set of tag bits for which tracing is currently 160f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // enabled. It is initialized to 0 and set based on the 161f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // atrace.tags.enableflags system property in init() while a lock on sMutex 162f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // is held. 163f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // 164f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // This should only be used by a trace function after init() has 165f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // successfully completed. 16645b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown // 16745b80c69ad8057fde0c0a76f7da3a2183a2aab96Jeff Brown // This value is only ever non-zero when tracing is initialized and sTraceFD is not -1. 168f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static uint64_t sEnabledTags; 169f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 170f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis // sMutex is used to protect the execution of init(). 171f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis static Mutex sMutex; 172f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis}; 173f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 174f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennisclass ScopedTrace { 175f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 176f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennispublic: 177f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis inline ScopedTrace(uint64_t tag, const char* name) : 178f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis mTag(tag) { 179f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis Tracer::traceBegin(mTag, name); 180f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 181f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 182f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis inline ~ScopedTrace() { 183f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis Tracer::traceEnd(mTag); 184f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis } 185f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 186f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennisprivate: 187f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 188f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis uint64_t mTag; 189f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis}; 190f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 191f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis}; // namespace android 192f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis 193f64b1ca000e0a5bb176f4e53f568e48dd1ecc71aJamie Gennis#endif // ANDROID_TRACE_H 194