blob: 0f886053fb9ef48874c36b3bde6291edc5cf87bd [file] [log] [blame]
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001/* system/debuggerd/utility.h
2**
3** Copyright 2008, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9** http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
Jeff Brown13e715b2011-10-21 12:14:56 -070018#ifndef _DEBUGGERD_UTILITY_H
19#define _DEBUGGERD_UTILITY_H
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080020
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080021#include <stdbool.h>
Pavel Chupinc6c194c2013-11-21 23:17:20 +040022#include <sys/types.h>
Jeff Brown053b8652012-06-06 16:25:03 -070023
24typedef struct {
25 /* tombstone file descriptor */
26 int tfd;
Christopher Tateded2e5a2013-03-19 13:12:23 -070027 /* Activity Manager socket file descriptor */
28 int amfd;
29 /* if true, does not log anything to the Android logcat or Activity Manager */
Jeff Brown053b8652012-06-06 16:25:03 -070030 bool quiet;
31} log_t;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080032
Christopher Tate7716aef2013-04-02 14:00:27 -070033/* Log information onto the tombstone. scopeFlags is a bitmask of the flags defined
34 * here. */
35void _LOG(log_t* log, int scopeFlags, const char *fmt, ...)
Jeff Brown13e715b2011-10-21 12:14:56 -070036 __attribute__ ((format(printf, 3, 4)));
Andy McFadden136dcc52011-09-22 16:37:06 -070037
Christopher Tate7716aef2013-04-02 14:00:27 -070038/* The message pertains specifically to the faulting thread / process */
39#define SCOPE_AT_FAULT (1 << 0)
40/* The message contains sensitive information such as RAM contents */
41#define SCOPE_SENSITIVE (1 << 1)
42
43#define IS_AT_FAULT(x) (((x) & SCOPE_AT_FAULT) != 0)
44#define IS_SENSITIVE(x) (((x) & SCOPE_SENSITIVE) != 0)
45
46/* Further helpful macros */
47#define LOG(fmt...) _LOG(NULL, SCOPE_AT_FAULT, fmt)
David 'Digit' Turner2c259912011-01-26 15:11:04 +010048
49/* Set to 1 for normal debug traces */
Bruce Beare84924902010-10-13 14:21:30 -070050#if 0
Christopher Tate7716aef2013-04-02 14:00:27 -070051#define XLOG(fmt...) _LOG(NULL, SCOPE_AT_FAULT, fmt)
Bruce Beare84924902010-10-13 14:21:30 -070052#else
53#define XLOG(fmt...) do {} while(0)
54#endif
55
David 'Digit' Turner2c259912011-01-26 15:11:04 +010056/* Set to 1 for chatty debug traces. Includes all resolved dynamic symbols */
57#if 0
Christopher Tate7716aef2013-04-02 14:00:27 -070058#define XLOG2(fmt...) _LOG(NULL, SCOPE_AT_FAULT, fmt)
David 'Digit' Turner2c259912011-01-26 15:11:04 +010059#else
60#define XLOG2(fmt...) do {} while(0)
61#endif
62
Jeff Brown053b8652012-06-06 16:25:03 -070063int wait_for_signal(pid_t tid, int* total_sleep_time_usec);
64void wait_for_stop(pid_t tid, int* total_sleep_time_usec);
Jeff Brown13e715b2011-10-21 12:14:56 -070065
Kévin PETIT4bb47722013-12-18 16:44:24 +000066void dump_memory(log_t* log, pid_t tid, uintptr_t addr, int scope_flags);
67
Jeff Brown13e715b2011-10-21 12:14:56 -070068#endif // _DEBUGGERD_UTILITY_H