CallStack.h revision 038ac694b36de2b081e62fcfb9b5f4a8c918c533
1cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project/* 2cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * 4cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * you may not use this file except in compliance with the License. 6cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * You may obtain a copy of the License at 7cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * 8cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * 10cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * See the License for the specific language governing permissions and 14cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project * limitations under the License. 15cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project */ 16cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 17cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project#ifndef ANDROID_CALLSTACK_H 18cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project#define ANDROID_CALLSTACK_H 19cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 20ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin#include <android/log.h> 21038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris#include <backtrace/backtrace.h> 22cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project#include <utils/String8.h> 23038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris#include <utils/Vector.h> 24cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 25ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin#include <stdint.h> 26ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin#include <sys/types.h> 27cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 28cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Projectnamespace android { 29cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 30ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkinclass Printer; 31ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin 32ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin// Collect/print the call stack (function, file, line) traces for a single thread. 33ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkinclass CallStack { 34cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Projectpublic: 35ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Create an empty call stack. No-op. 36cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project CallStack(); 37ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Create a callstack with the current thread's stack trace. 38ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Immediately dump it to logcat using the given logtag. 39038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris CallStack(const char* logtag, int32_t ignoreDepth=1); 40cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project ~CallStack(); 41cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 42ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Reset the stack frames (same as creating an empty call stack). 43038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris void clear() { mFrameLines.clear(); } 44cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 45ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Immediately collect the stack traces for the specified thread. 46038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris // The default is to dump the stack of the current call. 47038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris void update(int32_t ignoreDepth=1, pid_t tid=BACKTRACE_NO_TID); 48cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 49ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Dump a stack trace to the log using the supplied logtag. 50ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin void log(const char* logtag, 51ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin android_LogPriority priority = ANDROID_LOG_DEBUG, 52ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin const char* prefix = 0) const; 53cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 54ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Dump a stack trace to the specified file descriptor. 55ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin void dump(int fd, int indent = 0, const char* prefix = 0) const; 56ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin 57ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Return a string (possibly very long) containing the complete stack trace. 58cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project String8 toString(const char* prefix = 0) const; 59ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin 60ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Dump a serialized representation of the stack trace to the specified printer. 61ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin void print(Printer& printer) const; 62ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin 63ec79ef2e7b6b1d81266637ca0e002b5c0c5a789bIgor Murashkin // Get the count of stack frames that are in this call stack. 64038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris size_t size() const { return mFrameLines.size(); } 65cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 66cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Projectprivate: 67038ac694b36de2b081e62fcfb9b5f4a8c918c533Christopher Ferris Vector<String8> mFrameLines; 68cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project}; 69cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 70cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project}; // namespace android 71cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project 72cbb1011c95e0c25c29e40e203a6a31bccd029da3The Android Open Source Project#endif // ANDROID_CALLSTACK_H 73