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
225
226
227
228
229
|
//
// Copyright (C) 2020 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.
//
#define LOG_TAG "profcollectd_scheduler"
#include "scheduler.h"
#include <fstream>
#include <vector>
#include <android-base/logging.h>
#include "compress.h"
#include "config_utils.h"
#include "hwtrace_provider.h"
#include "json/json.h"
#include "json/writer.h"
namespace fs = std::filesystem;
namespace android {
namespace profcollectd {
// Default option values.
static constexpr config_t CONFIG_BUILD_FINGERPRINT = {"build_fingerprint", "unknown"};
static constexpr config_t CONFIG_COLLECTION_INTERVAL_SEC = {"collection_interval", "600"};
static constexpr config_t CONFIG_SAMPLING_PERIOD_SEC = {"sampling_period", "0.5"};
static constexpr config_t CONFIG_BINARY_FILTER = {"binary_filter", ""};
static const fs::path OUT_ROOT_DIR("/data/misc/profcollectd");
static const fs::path TRACE_DIR(OUT_ROOT_DIR / "trace");
static const fs::path OUTPUT_DIR(OUT_ROOT_DIR / "output");
static const fs::path REPORT_FILE(OUT_ROOT_DIR / "report.zip");
// Hwtrace provider registry
extern std::unique_ptr<HwtraceProvider> REGISTER_SIMPLEPERF_ETM_PROVIDER();
namespace {
void ClearDir(const fs::path& path) {
if (fs::exists(path)) {
for (const auto& entry : fs::directory_iterator(path)) {
fs::remove_all(entry);
}
}
}
bool ClearOnConfigChange(const ProfcollectdScheduler::Config& config) {
const fs::path configFile = OUTPUT_DIR / "config.json";
ProfcollectdScheduler::Config oldConfig{};
// Read old config, if exists.
if (fs::exists(configFile)) {
std::ifstream ifs(configFile);
ifs >> oldConfig;
}
if (oldConfig != config) {
LOG(INFO) << "Clearing profiles due to config change.";
ClearDir(TRACE_DIR);
ClearDir(OUTPUT_DIR);
// Write new config.
std::ofstream ofs(configFile);
ofs << config;
return true;
}
return false;
}
void PeriodicCollectionWorker(std::future<void> terminationSignal, ProfcollectdScheduler& scheduler,
std::chrono::seconds& interval) {
do {
scheduler.TraceOnce("periodic");
} while ((terminationSignal.wait_for(interval)) == std::future_status::timeout);
}
} // namespace
ProfcollectdScheduler::ProfcollectdScheduler() {
ReadConfig();
// Load a registered hardware trace provider.
if ((hwtracer = REGISTER_SIMPLEPERF_ETM_PROVIDER())) {
LOG(INFO) << "ETM provider registered.";
} else {
LOG(ERROR) << "No hardware trace provider available.";
}
}
OptError ProfcollectdScheduler::ReadConfig() {
if (workerThread != nullptr) {
static std::string errmsg = "Terminate the collection before refreshing config.";
return errmsg;
}
const std::lock_guard<std::mutex> lock(mu);
config.buildFingerprint = getBuildFingerprint();
config.collectionInterval =
std::chrono::seconds(getConfigFlagInt(CONFIG_COLLECTION_INTERVAL_SEC));
config.samplingPeriod =
std::chrono::duration<float>(getConfigFlagFloat(CONFIG_SAMPLING_PERIOD_SEC));
config.binaryFilter = getConfigFlag(CONFIG_BINARY_FILTER);
ClearOnConfigChange(config);
return std::nullopt;
}
OptError ProfcollectdScheduler::ScheduleCollection() {
if (workerThread != nullptr) {
static std::string errmsg = "Collection is already scheduled.";
return errmsg;
}
workerThread =
std::make_unique<std::thread>(PeriodicCollectionWorker, terminate.get_future(),
std::ref(*this), std::ref(config.collectionInterval));
return std::nullopt;
}
OptError ProfcollectdScheduler::TerminateCollection() {
if (workerThread == nullptr) {
static std::string errmsg = "Collection is not scheduled.";
return errmsg;
}
terminate.set_value();
workerThread->join();
workerThread = nullptr;
terminate = std::promise<void>(); // Reset promise.
return std::nullopt;
}
OptError ProfcollectdScheduler::TraceOnce(const std::string& tag) {
if (!hwtracer) {
return "No trace provider registered.";
}
const std::lock_guard<std::mutex> lock(mu);
bool success = hwtracer->Trace(TRACE_DIR, tag, config.samplingPeriod);
if (!success) {
static std::string errmsg = "Trace failed";
return errmsg;
}
return std::nullopt;
}
OptError ProfcollectdScheduler::ProcessProfile() {
if (!hwtracer) {
return "No trace provider registered.";
}
const std::lock_guard<std::mutex> lock(mu);
bool success = hwtracer->Process(TRACE_DIR, OUTPUT_DIR, config.binaryFilter);
if (!success) {
static std::string errmsg = "Process profiles failed";
return errmsg;
}
return std::nullopt;
}
OptError ProfcollectdScheduler::CreateProfileReport() {
auto processFailureMsg = ProcessProfile();
if (processFailureMsg) {
return processFailureMsg;
}
std::vector<fs::path> profiles;
if (fs::exists(OUTPUT_DIR)) {
profiles.insert(profiles.begin(), fs::directory_iterator(OUTPUT_DIR), fs::directory_iterator());
}
bool success = CompressFiles(REPORT_FILE, profiles);
if (!success) {
static std::string errmsg = "Compress files failed";
return errmsg;
}
return std::nullopt;
}
OptError ProfcollectdScheduler::GetSupportedProvider(std::string& provider) {
provider = hwtracer ? hwtracer->GetName() : "";
return std::nullopt;
}
std::ostream& operator<<(std::ostream& os, const ProfcollectdScheduler::Config& config) {
Json::Value root;
const auto writer = std::make_unique<Json::StyledStreamWriter>();
root[CONFIG_BUILD_FINGERPRINT.name] = config.buildFingerprint;
root[CONFIG_COLLECTION_INTERVAL_SEC.name] = config.collectionInterval.count();
root[CONFIG_SAMPLING_PERIOD_SEC.name] = config.samplingPeriod.count();
root[CONFIG_BINARY_FILTER.name] = config.binaryFilter.c_str();
writer->write(os, root);
return os;
}
std::istream& operator>>(std::istream& is, ProfcollectdScheduler::Config& config) {
Json::Value root;
const auto reader = std::make_unique<Json::Reader>();
bool success = reader->parse(is, root);
if (!success) {
return is;
}
config.buildFingerprint = root[CONFIG_BUILD_FINGERPRINT.name].asString();
config.collectionInterval =
std::chrono::seconds(root[CONFIG_COLLECTION_INTERVAL_SEC.name].asInt64());
config.samplingPeriod =
std::chrono::duration<float>(root[CONFIG_SAMPLING_PERIOD_SEC.name].asFloat());
config.binaryFilter = root[CONFIG_BINARY_FILTER.name].asString();
return is;
}
} // namespace profcollectd
} // namespace android
|
