1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#ifndef SECTIONS_H
#define SECTIONS_H
#include "Reporter.h"
#include <stdarg.h>
#include <map>
#include <android/os/IIncidentDumpCallback.h>
#include <utils/String16.h>
#include <utils/String8.h>
#include <utils/Vector.h>
namespace android {
namespace os {
namespace incidentd {
const int64_t REMOTE_CALL_TIMEOUT_MS = 30 * 1000; // 30 seconds
/**
* Base class for sections
*/
class Section {
public:
const int id;
const int64_t timeoutMs; // each section must have a timeout
String8 name;
Section(int id, int64_t timeoutMs = REMOTE_CALL_TIMEOUT_MS);
virtual ~Section();
virtual status_t Execute(ReportWriter* writer) const = 0;
};
/**
* Section that reads in a file.
*/
class FileSection : public Section {
public:
FileSection(int id, const char* filename,
int64_t timeoutMs = 5000 /* 5 seconds */);
virtual ~FileSection();
virtual status_t Execute(ReportWriter* writer) const;
private:
const char* mFilename;
bool mIsSysfs; // sysfs files are pollable but return POLLERR by default, handle it separately
};
/**
* Section that reads in a file and gzips the content.
*/
class GZipSection : public Section {
public:
GZipSection(int id, const char* filename, ...);
virtual ~GZipSection();
virtual status_t Execute(ReportWriter* writer) const;
private:
// It looks up the content from multiple files and stops when the first one is available.
const char** mFilenames;
};
/**
* Base class for sections that call a command that might need a timeout.
*/
class WorkerThreadSection : public Section {
public:
WorkerThreadSection(int id, int64_t timeoutMs = REMOTE_CALL_TIMEOUT_MS);
virtual ~WorkerThreadSection();
virtual status_t Execute(ReportWriter* writer) const;
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const = 0;
};
/**
* Section that forks and execs a command, and puts stdout as the section.
*/
class CommandSection : public Section {
public:
CommandSection(int id, int64_t timeoutMs, const char* command, ...);
CommandSection(int id, const char* command, ...);
virtual ~CommandSection();
virtual status_t Execute(ReportWriter* writer) const;
private:
const char** mCommand;
};
/**
* Section that calls protobuf dumpsys on a system service, usually
* "dumpsys [service_name] --proto".
*/
class DumpsysSection : public WorkerThreadSection {
public:
DumpsysSection(int id, const char* service, ...);
virtual ~DumpsysSection();
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const;
private:
String16 mService;
Vector<String16> mArgs;
};
/**
* Section that calls text dumpsys on a system service, usually "dumpsys [service_name]".
*/
class TextDumpsysSection : public WorkerThreadSection {
public:
TextDumpsysSection(int id, const char* service, ...);
virtual ~TextDumpsysSection();
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const;
private:
String16 mService;
Vector<String16> mArgs;
};
/**
* Section that calls dumpsys on a system service.
*/
class SystemPropertyDumpsysSection : public WorkerThreadSection {
public:
SystemPropertyDumpsysSection(int id, const char* service, ...);
virtual ~SystemPropertyDumpsysSection();
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const;
private:
String16 mService;
Vector<String16> mArgs;
};
/**
* Section that reads from logd.
*/
class LogSection : public WorkerThreadSection {
// global last log retrieved timestamp for each log_id_t.
static map<log_id_t, log_time> gLastLogsRetrieved;
// log mode: read only & non blocking.
const static int logModeBase = ANDROID_LOG_RDONLY | ANDROID_LOG_NONBLOCK;
public:
LogSection(int id, const char* logID, ...);
virtual ~LogSection();
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const;
private:
log_id_t mLogID;
bool mBinary;
int mLogMode;
};
/**
* Section that gets data from tombstoned.
*/
class TombstoneSection : public WorkerThreadSection {
public:
TombstoneSection(int id, const char* type, int64_t timeoutMs = 120000 /* 2 minutes */);
virtual ~TombstoneSection();
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const;
private:
std::string mType;
};
/**
* Section that gets data from a registered dump callback.
*/
class BringYourOwnSection : public WorkerThreadSection {
public:
const uid_t uid;
BringYourOwnSection(int id, const char* customName, const uid_t callingUid,
const sp<IIncidentDumpCallback>& callback);
virtual ~BringYourOwnSection();
virtual status_t BlockingCall(unique_fd& pipeWriteFd) const;
private:
const sp<IIncidentDumpCallback>& mCallback;
};
/**
* These sections will not be generated when doing an 'all' report, either
* for size, speed of collection, or privacy.
*/
bool section_requires_specific_mention(int sectionId);
} // namespace incidentd
} // namespace os
} // namespace android
#endif // SECTIONS_H
|
