diff options
Diffstat (limited to 'include/utils/CallStack.h')
| -rw-r--r-- | include/utils/CallStack.h | 55 |
1 files changed, 37 insertions, 18 deletions
diff --git a/include/utils/CallStack.h b/include/utils/CallStack.h index 61dc832..2056751 100644 --- a/include/utils/CallStack.h +++ b/include/utils/CallStack.h @@ -17,50 +17,72 @@ #ifndef ANDROID_CALLSTACK_H #define ANDROID_CALLSTACK_H -#include <stdint.h> -#include <sys/types.h> - +#include <android/log.h> #include <utils/String8.h> #include <corkscrew/backtrace.h> -// --------------------------------------------------------------------------- +#include <stdint.h> +#include <sys/types.h> namespace android { -class CallStack -{ +class Printer; + +// Collect/print the call stack (function, file, line) traces for a single thread. +class CallStack { public: enum { - MAX_DEPTH = 31 + // Prune the lowest-most stack frames until we have at most MAX_DEPTH. + MAX_DEPTH = 31, + // Placeholder for specifying the current thread when updating the stack. + CURRENT_THREAD = -1, }; + // Create an empty call stack. No-op. CallStack(); + // Create a callstack with the current thread's stack trace. + // Immediately dump it to logcat using the given logtag. CallStack(const char* logtag, int32_t ignoreDepth=1, int32_t maxDepth=MAX_DEPTH); + // Copy the existing callstack (no other side effects). CallStack(const CallStack& rhs); ~CallStack(); + // Copy the existing callstack (no other side effects). CallStack& operator = (const CallStack& rhs); - + + // Compare call stacks by their backtrace frame memory. bool operator == (const CallStack& rhs) const; bool operator != (const CallStack& rhs) const; bool operator < (const CallStack& rhs) const; bool operator >= (const CallStack& rhs) const; bool operator > (const CallStack& rhs) const; bool operator <= (const CallStack& rhs) const; - + + // Get the PC address for the stack frame specified by index. const void* operator [] (int index) const; - + + // Reset the stack frames (same as creating an empty call stack). void clear(); - void update(int32_t ignoreDepth=1, int32_t maxDepth=MAX_DEPTH); + // Immediately collect the stack traces for the specified thread. + void update(int32_t ignoreDepth=1, int32_t maxDepth=MAX_DEPTH, pid_t tid=CURRENT_THREAD); - // Dump a stack trace to the log using the supplied logtag - void dump(const char* logtag, const char* prefix = 0) const; + // Dump a stack trace to the log using the supplied logtag. + void log(const char* logtag, + android_LogPriority priority = ANDROID_LOG_DEBUG, + const char* prefix = 0) const; - // Return a string (possibly very long) containing the complete stack trace + // Dump a stack trace to the specified file descriptor. + void dump(int fd, int indent = 0, const char* prefix = 0) const; + + // Return a string (possibly very long) containing the complete stack trace. String8 toString(const char* prefix = 0) const; - + + // Dump a serialized representation of the stack trace to the specified printer. + void print(Printer& printer) const; + + // Get the count of stack frames that are in this call stack. size_t size() const { return mCount; } private: @@ -70,7 +92,4 @@ private: }; // namespace android - -// --------------------------------------------------------------------------- - #endif // ANDROID_CALLSTACK_H |