blob: 39912f0e5f78e1d337fbf2af0556e0fcc567af72 [file] [log] [blame]
James Hawkinsabd73e62016-01-19 15:10:38 -08001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17// The bootstat command provides options to persist boot events with the current
18// timestamp, dump the persisted events, and log all events to EventLog to be
19// uploaded to Android log storage via Tron.
20
James Hawkinsa4a1a4a2016-02-09 15:32:38 -080021#include <getopt.h>
Mark Salyzynb304f6d2017-08-04 13:35:51 -070022#include <sys/klog.h>
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -070023#include <unistd.h>
Mark Salyzynff2dcd92016-09-28 15:54:45 -070024
James Hawkinse78ea772017-03-24 11:43:02 -070025#include <chrono>
James Hawkins0660b302016-03-08 16:18:15 -080026#include <cmath>
James Hawkinsabd73e62016-01-19 15:10:38 -080027#include <cstddef>
28#include <cstdio>
James Hawkins500d7152016-02-16 15:05:54 -080029#include <ctime>
James Hawkinsa4a1a4a2016-02-09 15:32:38 -080030#include <map>
James Hawkinsabd73e62016-01-19 15:10:38 -080031#include <memory>
Mark Salyzyn25900dd2018-03-16 09:05:59 -070032#include <regex>
James Hawkinsabd73e62016-01-19 15:10:38 -080033#include <string>
Mark Salyzyn853bb802018-03-16 08:44:56 -070034#include <utility>
James Hawkinsbe46fd12017-02-02 16:21:25 -080035#include <vector>
Mark Salyzynff2dcd92016-09-28 15:54:45 -070036
James Hawkinse78ea772017-03-24 11:43:02 -070037#include <android-base/chrono_utils.h>
Mark Salyzynb304f6d2017-08-04 13:35:51 -070038#include <android-base/file.h>
James Hawkinseabe08b2016-01-19 16:54:35 -080039#include <android-base/logging.h>
James Hawkins4dded612016-07-28 11:50:23 -070040#include <android-base/parseint.h>
Luis Hector Chavez583d34c2018-04-12 15:25:15 -070041#include <android-base/properties.h>
James Hawkinsbe46fd12017-02-02 16:21:25 -080042#include <android-base/strings.h>
James Hawkinse78ea772017-03-24 11:43:02 -070043#include <android/log.h>
Mark Salyzynb304f6d2017-08-04 13:35:51 -070044#include <cutils/android_reboot.h>
James Hawkinsa4a1a4a2016-02-09 15:32:38 -080045#include <cutils/properties.h>
Mark Salyzynb304f6d2017-08-04 13:35:51 -070046#include <log/logcat.h>
James Hawkins9aec9262017-01-31 11:42:24 -080047#include <metricslogger/metrics_logger.h>
Tej Singh4eacd382018-01-25 17:59:57 -080048#include <statslog.h>
Mark Salyzynff2dcd92016-09-28 15:54:45 -070049
James Hawkinsabd73e62016-01-19 15:10:38 -080050#include "boot_event_record_store.h"
James Hawkinsabd73e62016-01-19 15:10:38 -080051
52namespace {
53
James Hawkinsabd73e62016-01-19 15:10:38 -080054// Scans the boot event record store for record files and logs each boot event
55// via EventLog.
56void LogBootEvents() {
57 BootEventRecordStore boot_event_store;
58
59 auto events = boot_event_store.GetAllBootEvents();
60 for (auto i = events.cbegin(); i != events.cend(); ++i) {
James Hawkins9aec9262017-01-31 11:42:24 -080061 android::metricslogger::LogHistogram(i->first, i->second);
James Hawkinsabd73e62016-01-19 15:10:38 -080062 }
63}
64
James Hawkinsc6275582016-03-22 10:47:44 -070065// Records the named boot |event| to the record store. If |value| is non-empty
66// and is a proper string representation of an integer value, the converted
67// integer value is associated with the boot event.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -070068void RecordBootEventFromCommandLine(const std::string& event, const std::string& value_str) {
James Hawkinsc6275582016-03-22 10:47:44 -070069 BootEventRecordStore boot_event_store;
70 if (!value_str.empty()) {
71 int32_t value = 0;
Elliott Hughesda46b392016-10-11 17:09:00 -070072 if (android::base::ParseInt(value_str, &value)) {
James Hawkins4dded612016-07-28 11:50:23 -070073 boot_event_store.AddBootEventWithValue(event, value);
74 }
James Hawkinsc6275582016-03-22 10:47:44 -070075 } else {
76 boot_event_store.AddBootEvent(event);
77 }
78}
79
James Hawkinsabd73e62016-01-19 15:10:38 -080080void PrintBootEvents() {
81 printf("Boot events:\n");
82 printf("------------\n");
83
84 BootEventRecordStore boot_event_store;
85 auto events = boot_event_store.GetAllBootEvents();
86 for (auto i = events.cbegin(); i != events.cend(); ++i) {
87 printf("%s\t%d\n", i->first.c_str(), i->second);
88 }
89}
90
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -070091void ShowHelp(const char* cmd) {
James Hawkinsabd73e62016-01-19 15:10:38 -080092 fprintf(stderr, "Usage: %s [options]\n", cmd);
93 fprintf(stderr,
94 "options include:\n"
Yongqin Liu78b2b942017-07-07 13:26:49 +080095 " -h, --help Show this help\n"
96 " -l, --log Log all metrics to logstorage\n"
97 " -p, --print Dump the boot event records to the console\n"
98 " -r, --record Record the timestamp of a named boot event\n"
99 " --value Optional value to associate with the boot event\n"
100 " --record_boot_complete Record metrics related to the time for the device boot\n"
101 " --record_boot_reason Record the reason why the device booted\n"
James Hawkins53684ea2016-02-23 16:18:19 -0800102 " --record_time_since_factory_reset Record the time since the device was reset\n");
James Hawkinsabd73e62016-01-19 15:10:38 -0800103}
104
105// Constructs a readable, printable string from the givencommand line
106// arguments.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700107std::string GetCommandLine(int argc, char** argv) {
James Hawkinsabd73e62016-01-19 15:10:38 -0800108 std::string cmd;
109 for (int i = 0; i < argc; ++i) {
110 cmd += argv[i];
111 cmd += " ";
112 }
113
114 return cmd;
115}
116
James Hawkinsa4a1a4a2016-02-09 15:32:38 -0800117// Convenience wrapper over the property API that returns an
118// std::string.
119std::string GetProperty(const char* key) {
120 std::vector<char> temp(PROPERTY_VALUE_MAX);
121 const int len = property_get(key, &temp[0], nullptr);
122 if (len < 0) {
123 return "";
124 }
125 return std::string(&temp[0], len);
126}
127
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700128void SetProperty(const char* key, const std::string& val) {
129 property_set(key, val.c_str());
130}
131
132void SetProperty(const char* key, const char* val) {
133 property_set(key, val);
134}
135
James Hawkins25f71222017-10-10 16:37:05 -0700136constexpr int32_t kEmptyBootReason = 0;
James Hawkins6f74c0b2016-02-12 15:49:16 -0800137constexpr int32_t kUnknownBootReason = 1;
138
James Hawkinsa4a1a4a2016-02-09 15:32:38 -0800139// A mapping from boot reason string, as read from the ro.boot.bootreason
140// system property, to a unique integer ID. Viewers of log data dashboards for
141// the boot_reason metric may refer to this mapping to discern the histogram
142// values.
James Hawkins6f74c0b2016-02-12 15:49:16 -0800143const std::map<std::string, int32_t> kBootReasonMap = {
James Hawkins25f71222017-10-10 16:37:05 -0700144 {"empty", kEmptyBootReason},
Mark Salyzyn2b820532018-03-16 08:53:34 -0700145 {"__BOOTSTAT_UNKNOWN__", kUnknownBootReason},
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700146 {"normal", 2},
147 {"recovery", 3},
148 {"reboot", 4},
149 {"PowerKey", 5},
150 {"hard_reset", 6},
151 {"kernel_panic", 7},
152 {"rpm_err", 8},
153 {"hw_reset", 9},
154 {"tz_err", 10},
155 {"adsp_err", 11},
156 {"modem_err", 12},
157 {"mba_err", 13},
158 {"Watchdog", 14},
159 {"Panic", 15},
160 {"power_key", 16},
161 {"power_on", 17},
162 {"Reboot", 18},
163 {"rtc", 19},
164 {"edl", 20},
165 {"oem_pon1", 21},
166 {"oem_powerkey", 22},
167 {"oem_unknown_reset", 23},
168 {"srto: HWWDT reset SC", 24},
169 {"srto: HWWDT reset platform", 25},
170 {"srto: bootloader", 26},
171 {"srto: kernel panic", 27},
172 {"srto: kernel watchdog reset", 28},
173 {"srto: normal", 29},
174 {"srto: reboot", 30},
175 {"srto: reboot-bootloader", 31},
176 {"srto: security watchdog reset", 32},
177 {"srto: wakesrc", 33},
178 {"srto: watchdog", 34},
179 {"srto:1-1", 35},
180 {"srto:omap_hsmm", 36},
181 {"srto:phy0", 37},
182 {"srto:rtc0", 38},
183 {"srto:touchpad", 39},
184 {"watchdog", 40},
185 {"watchdogr", 41},
186 {"wdog_bark", 42},
187 {"wdog_bite", 43},
188 {"wdog_reset", 44},
189 {"shutdown,", 45}, // Trailing comma is intentional.
190 {"shutdown,userrequested", 46},
191 {"reboot,bootloader", 47},
192 {"reboot,cold", 48},
193 {"reboot,recovery", 49},
194 {"thermal_shutdown", 50},
195 {"s3_wakeup", 51},
196 {"kernel_panic,sysrq", 52},
197 {"kernel_panic,NULL", 53},
Mark Salyzyn853bb802018-03-16 08:44:56 -0700198 {"kernel_panic,null", 53},
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700199 {"kernel_panic,BUG", 54},
Mark Salyzyn853bb802018-03-16 08:44:56 -0700200 {"kernel_panic,bug", 54},
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700201 {"bootloader", 55},
202 {"cold", 56},
203 {"hard", 57},
204 {"warm", 58},
Mark Salyzyn2b820532018-03-16 08:53:34 -0700205 // {"recovery", 59}, // Duplicate of enum 3 above. Immediate reuse possible.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700206 {"thermal-shutdown", 60},
207 {"shutdown,thermal", 61},
208 {"shutdown,battery", 62},
209 {"reboot,ota", 63},
210 {"reboot,factory_reset", 64},
211 {"reboot,", 65},
212 {"reboot,shell", 66},
213 {"reboot,adb", 67},
Mark Salyzyn9033bf52017-09-21 11:30:29 -0700214 {"reboot,userrequested", 68},
Mark Salyzyn161b8622017-09-26 08:26:12 -0700215 {"shutdown,container", 69}, // Host OS asking Android Container to shutdown
Mark Salyzyn243fa292017-10-11 09:02:04 -0700216 {"cold,powerkey", 70},
217 {"warm,s3_wakeup", 71},
218 {"hard,hw_reset", 72},
219 {"shutdown,suspend", 73}, // Suspend to RAM
220 {"shutdown,hibernate", 74}, // Suspend to DISK
James Hawkins34073b52017-10-17 15:53:27 -0700221 {"power_on_key", 75},
222 {"reboot_by_key", 76},
223 {"wdt_by_pass_pwk", 77},
224 {"reboot_longkey", 78},
225 {"powerkey", 79},
226 {"usb", 80},
227 {"wdt", 81},
228 {"tool_by_pass_pwk", 82},
229 {"2sec_reboot", 83},
230 {"reboot,by_key", 84},
231 {"reboot,longkey", 85},
Mark Salyzyncabbe4f2017-10-23 13:52:39 -0700232 {"reboot,2sec", 86},
Mark Salyzync89f9da2017-10-24 15:35:34 -0700233 {"shutdown,thermal,battery", 87},
Mark Salyzyn72a8ea32017-10-25 09:23:19 -0700234 {"reboot,its_just_so_hard", 88}, // produced by boot_reason_test
235 {"reboot,Its Just So Hard", 89}, // produced by boot_reason_test
Mark Salyzyn75046892018-05-03 13:11:15 -0700236 {"reboot,rescueparty", 90},
James Hawkins74b17582017-11-20 14:13:41 -0800237 {"charge", 91},
238 {"oem_tz_crash", 92},
239 {"uvlo", 93},
240 {"oem_ps_hold", 94},
241 {"abnormal_reset", 95},
242 {"oemerr_unknown", 96},
243 {"reboot_fastboot_mode", 97},
James Hawkins5f85f832017-11-29 14:30:06 -0800244 {"watchdog_apps_bite", 98},
245 {"xpu_err", 99},
246 {"power_on_usb", 100},
James Hawkinsf4444f02017-11-30 15:01:40 -0800247 {"watchdog_rpm", 101},
248 {"watchdog_nonsec", 102},
249 {"watchdog_apps_bark", 103},
250 {"reboot_dmverity_corrupted", 104},
James Hawkins00433a22017-12-04 14:20:21 -0800251 {"reboot_smpl", 105},
252 {"watchdog_sdi_apps_reset", 106},
253 {"smpl", 107},
254 {"oem_modem_failed_to_powerup", 108},
James Hawkinse2c27242017-12-18 13:40:27 -0800255 {"reboot_normal", 109},
256 {"oem_lpass_cfg", 110},
257 {"oem_xpu_ns_error", 111},
258 {"power_key_press", 112},
259 {"hardware_reset", 113},
260 {"reboot_by_powerkey", 114},
261 {"reboot_verity", 115},
262 {"oem_rpm_undef_error", 116},
263 {"oem_crash_on_the_lk", 117},
264 {"oem_rpm_reset", 118},
265 {"oem_lpass_cfg", 119},
266 {"oem_xpu_ns_error", 120},
267 {"factory_cable", 121},
268 {"oem_ar6320_failed_to_powerup", 122},
269 {"watchdog_rpm_bite", 123},
270 {"power_on_cable", 124},
271 {"reboot_unknown", 125},
272 {"wireless_charger", 126},
273 {"0x776655ff", 127},
274 {"oem_thermal_bite_reset", 128},
275 {"charger", 129},
276 {"pon1", 130},
277 {"unknown", 131},
278 {"reboot_rtc", 132},
279 {"cold_boot", 133},
280 {"hard_rst", 134},
James Hawkinsb607dae2018-01-05 14:42:55 -0800281 {"power-on", 135},
282 {"oem_adsp_resetting_the_soc", 136},
283 {"kpdpwr", 137},
284 {"oem_modem_timeout_waiting", 138},
285 {"usb_chg", 139},
286 {"warm_reset_0x02", 140},
287 {"warm_reset_0x80", 141},
288 {"pon_reason_0xb0", 142},
289 {"reboot_download", 143},
James Hawkins79a4ee22018-01-26 14:31:04 -0800290 {"reboot_recovery_mode", 144},
291 {"oem_sdi_err_fatal", 145},
292 {"pmic_watchdog", 146},
293 {"software_master", 147},
Mark Salyzyn8aa36c62018-03-16 11:00:14 -0700294 {"cold,charger", 148},
295 {"cold,rtc", 149},
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700296 {"cold,rtc,2sec", 150},
297 {"reboot,tool", 151},
298 {"reboot,wdt", 152},
299 {"reboot,unknown", 153},
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700300 {"kernel_panic,audit", 154},
301 {"kernel_panic,atomic", 155},
302 {"kernel_panic,hung", 156},
303 {"kernel_panic,hung,rcu", 157},
304 {"kernel_panic,init", 158},
305 {"kernel_panic,oom", 159},
306 {"kernel_panic,stack", 160},
Mark Salyzynafd66f22018-03-19 15:16:29 -0700307 {"kernel_panic,sysrq,livelock,alarm", 161}, // llkd
308 {"kernel_panic,sysrq,livelock,driver", 162}, // llkd
309 {"kernel_panic,sysrq,livelock,zombie", 163}, // llkd
James Hawkinsa4a1a4a2016-02-09 15:32:38 -0800310};
311
312// Converts a string value representing the reason the system booted to an
313// integer representation. This is necessary for logging the boot_reason metric
314// via Tron, which does not accept non-integer buckets in histograms.
315int32_t BootReasonStrToEnum(const std::string& boot_reason) {
James Hawkinsa4a1a4a2016-02-09 15:32:38 -0800316 auto mapping = kBootReasonMap.find(boot_reason);
317 if (mapping != kBootReasonMap.end()) {
318 return mapping->second;
319 }
320
James Hawkins25f71222017-10-10 16:37:05 -0700321 if (boot_reason.empty()) {
322 return kEmptyBootReason;
323 }
324
James Hawkinsa4a1a4a2016-02-09 15:32:38 -0800325 LOG(INFO) << "Unknown boot reason: " << boot_reason;
326 return kUnknownBootReason;
327}
328
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700329// Canonical list of supported primary reboot reasons.
330const std::vector<const std::string> knownReasons = {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700331 // clang-format off
332 // kernel
333 "watchdog",
334 "kernel_panic",
335 // strong
336 "recovery", // Should not happen from ro.boot.bootreason
337 "bootloader", // Should not happen from ro.boot.bootreason
338 // blunt
339 "cold",
340 "hard",
341 "warm",
Mark Salyzyn62909822017-10-09 09:27:16 -0700342 // super blunt
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700343 "shutdown", // Can not happen from ro.boot.bootreason
344 "reboot", // Default catch-all for anything unknown
345 // clang-format on
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700346};
347
348// Returns true if the supplied reason prefix is considered detailed enough.
349bool isStrongRebootReason(const std::string& r) {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700350 for (auto& s : knownReasons) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700351 if (s == "cold") break;
352 // Prefix defined as terminated by a nul or comma (,).
Elliott Hughes579e6822017-12-20 09:41:00 -0800353 if (android::base::StartsWith(r, s) && ((r.length() == s.length()) || (r[s.length()] == ','))) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700354 return true;
355 }
356 }
357 return false;
358}
359
360// Returns true if the supplied reason prefix is associated with the kernel.
361bool isKernelRebootReason(const std::string& r) {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700362 for (auto& s : knownReasons) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700363 if (s == "recovery") break;
364 // Prefix defined as terminated by a nul or comma (,).
Elliott Hughes579e6822017-12-20 09:41:00 -0800365 if (android::base::StartsWith(r, s) && ((r.length() == s.length()) || (r[s.length()] == ','))) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700366 return true;
367 }
368 }
369 return false;
370}
371
372// Returns true if the supplied reason prefix is considered known.
373bool isKnownRebootReason(const std::string& r) {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700374 for (auto& s : knownReasons) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700375 // Prefix defined as terminated by a nul or comma (,).
Elliott Hughes579e6822017-12-20 09:41:00 -0800376 if (android::base::StartsWith(r, s) && ((r.length() == s.length()) || (r[s.length()] == ','))) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700377 return true;
378 }
379 }
380 return false;
381}
382
383// If the reboot reason should be improved, report true if is too blunt.
384bool isBluntRebootReason(const std::string& r) {
385 if (isStrongRebootReason(r)) return false;
386
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700387 if (!isKnownRebootReason(r)) return true; // Can not support unknown as detail
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700388
389 size_t pos = 0;
390 while ((pos = r.find(',', pos)) != std::string::npos) {
391 ++pos;
392 std::string next(r.substr(pos));
393 if (next.length() == 0) break;
394 if (next[0] == ',') continue;
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700395 if (!isKnownRebootReason(next)) return false; // Unknown subreason is good.
396 if (isStrongRebootReason(next)) return false; // eg: reboot,reboot
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700397 }
398 return true;
399}
400
Mark Salyzyn64610892017-09-18 10:41:14 -0700401bool readPstoreConsole(std::string& console) {
402 if (android::base::ReadFileToString("/sys/fs/pstore/console-ramoops-0", &console)) {
403 return true;
404 }
405 return android::base::ReadFileToString("/sys/fs/pstore/console-ramoops", &console);
406}
407
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700408// Implement a variant of std::string::rfind that is resilient to errors in
409// the data stream being inspected.
410class pstoreConsole {
411 private:
412 const size_t kBitErrorRate = 8; // number of bits per error
413 const std::string& console;
414
415 // Number of bits that differ between the two arguments l and r.
416 // Returns zero if the values for l and r are identical.
417 size_t numError(uint8_t l, uint8_t r) const { return std::bitset<8>(l ^ r).count(); }
418
419 // A string comparison function, reports the number of errors discovered
420 // in the match to a maximum of the bitLength / kBitErrorRate, at that
421 // point returning npos to indicate match is too poor.
422 //
423 // Since called in rfind which works backwards, expect cache locality will
424 // help if we check in reverse here as well for performance.
425 //
426 // Assumption: l (from console.c_str() + pos) is long enough to house
427 // _r.length(), checked in rfind caller below.
428 //
429 size_t numError(size_t pos, const std::string& _r) const {
430 const char* l = console.c_str() + pos;
431 const char* r = _r.c_str();
432 size_t n = _r.length();
433 const uint8_t* le = reinterpret_cast<const uint8_t*>(l) + n;
434 const uint8_t* re = reinterpret_cast<const uint8_t*>(r) + n;
435 size_t count = 0;
436 n = 0;
437 do {
438 // individual character bit error rate > threshold + slop
439 size_t num = numError(*--le, *--re);
440 if (num > ((8 + kBitErrorRate) / kBitErrorRate)) return std::string::npos;
441 // total bit error rate > threshold + slop
442 count += num;
443 ++n;
444 if (count > ((n * 8 + kBitErrorRate - (n > 2)) / kBitErrorRate)) {
445 return std::string::npos;
446 }
447 } while (le != reinterpret_cast<const uint8_t*>(l));
448 return count;
449 }
450
451 public:
452 explicit pstoreConsole(const std::string& console) : console(console) {}
453 // scope of argument must be equal to or greater than scope of pstoreConsole
454 explicit pstoreConsole(const std::string&& console) = delete;
455 explicit pstoreConsole(std::string&& console) = delete;
456
457 // Our implementation of rfind, use exact match first, then resort to fuzzy.
458 size_t rfind(const std::string& needle) const {
459 size_t pos = console.rfind(needle); // exact match?
460 if (pos != std::string::npos) return pos;
461
462 // Check to make sure needle fits in console string.
463 pos = console.length();
464 if (needle.length() > pos) return std::string::npos;
465 pos -= needle.length();
466 // fuzzy match to maximum kBitErrorRate
Ivan Lozano44d3cac2017-11-07 13:13:55 -0800467 for (;;) {
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700468 if (numError(pos, needle) != std::string::npos) return pos;
Ivan Lozano44d3cac2017-11-07 13:13:55 -0800469 if (pos == 0) break;
470 --pos;
471 }
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700472 return std::string::npos;
473 }
474
475 // Our implementation of find, use only fuzzy match.
476 size_t find(const std::string& needle, size_t start = 0) const {
477 // Check to make sure needle fits in console string.
478 if (needle.length() > console.length()) return std::string::npos;
479 const size_t last_pos = console.length() - needle.length();
480 // fuzzy match to maximum kBitErrorRate
481 for (size_t pos = start; pos <= last_pos; ++pos) {
482 if (numError(pos, needle) != std::string::npos) return pos;
483 }
484 return std::string::npos;
485 }
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700486
487 operator const std::string&() const { return console; }
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700488};
489
490// If bit error match to needle, correct it.
491// Return true if any corrections were discovered and applied.
Mark Salyzyn1e7d1c72018-03-16 08:57:20 -0700492bool correctForBitError(std::string& reason, const std::string& needle) {
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700493 bool corrected = false;
494 if (reason.length() < needle.length()) return corrected;
495 const pstoreConsole console(reason);
496 const size_t last_pos = reason.length() - needle.length();
497 for (size_t pos = 0; pos <= last_pos; pos += needle.length()) {
498 pos = console.find(needle, pos);
499 if (pos == std::string::npos) break;
500
501 // exact match has no malice
502 if (needle == reason.substr(pos, needle.length())) continue;
503
504 corrected = true;
505 reason = reason.substr(0, pos) + needle + reason.substr(pos + needle.length());
506 }
507 return corrected;
508}
509
Mark Salyzyn1e7d1c72018-03-16 08:57:20 -0700510// If bit error match to needle, correct it.
511// Return true if any corrections were discovered and applied.
512// Try again if we can replace underline with spaces.
513bool correctForBitErrorOrUnderline(std::string& reason, const std::string& needle) {
514 bool corrected = correctForBitError(reason, needle);
515 std::string _needle(needle);
516 std::transform(_needle.begin(), _needle.end(), _needle.begin(),
517 [](char c) { return (c == '_') ? ' ' : c; });
518 if (needle != _needle) {
519 corrected |= correctForBitError(reason, _needle);
520 }
521 return corrected;
522}
523
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700524// Converts a string value representing the reason the system booted to a
525// string complying with Android system standard reason.
526void transformReason(std::string& reason) {
527 std::transform(reason.begin(), reason.end(), reason.begin(), ::tolower);
528 std::transform(reason.begin(), reason.end(), reason.begin(),
529 [](char c) { return ::isblank(c) ? '_' : c; });
530 std::transform(reason.begin(), reason.end(), reason.begin(),
531 [](char c) { return ::isprint(c) ? c : '?'; });
532}
533
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700534// Check subreasons for reboot,<subreason> kernel_panic,sysrq,<subreason> or
535// kernel_panic,<subreason>.
536//
537// If quoted flag is set, pull out and correct single quoted ('), newline (\n)
538// or unprintable character terminated subreason, pos is supplied just beyond
539// first quote. if quoted false, pull out and correct newline (\n) or
540// unprintable character terminated subreason.
541//
542// Heuristics to find termination is painted into a corner:
543
544// single bit error for quote ' that we can block. It is acceptable for
545// the others 7, g in reason. 2/9 chance will miss the terminating quote,
546// but there is always the terminating newline that usually immediately
547// follows to fortify our chances.
548bool likely_single_quote(char c) {
549 switch (static_cast<uint8_t>(c)) {
550 case '\'': // '\''
551 case '\'' ^ 0x01: // '&'
552 case '\'' ^ 0x02: // '%'
553 case '\'' ^ 0x04: // '#'
554 case '\'' ^ 0x08: // '/'
555 return true;
556 case '\'' ^ 0x10: // '7'
557 break;
558 case '\'' ^ 0x20: // '\a' (unprintable)
559 return true;
560 case '\'' ^ 0x40: // 'g'
561 break;
562 case '\'' ^ 0x80: // 0xA7 (unprintable)
563 return true;
564 }
565 return false;
566}
567
568// ::isprint(c) and likely_space() will prevent us from being called for
569// fundamentally printable entries, except for '\r' and '\b'.
570//
571// Except for * and J, single bit errors for \n, all others are non-
572// printable so easy catch. It is _acceptable_ for *, J or j to exist in
573// the reason string, so 2/9 chance we will miss the terminating newline.
574//
575// NB: J might not be acceptable, except if at the beginning or preceded
576// with a space, '(' or any of the quotes and their BER aliases.
577// NB: * might not be acceptable, except if at the beginning or preceded
578// with a space, another *, or any of the quotes or their BER aliases.
579//
580// To reduce the chances to closer to 1/9 is too complicated for the gain.
581bool likely_newline(char c) {
582 switch (static_cast<uint8_t>(c)) {
583 case '\n': // '\n' (unprintable)
584 case '\n' ^ 0x01: // '\r' (unprintable)
585 case '\n' ^ 0x02: // '\b' (unprintable)
586 case '\n' ^ 0x04: // 0x0E (unprintable)
587 case '\n' ^ 0x08: // 0x02 (unprintable)
588 case '\n' ^ 0x10: // 0x1A (unprintable)
589 return true;
590 case '\n' ^ 0x20: // '*'
591 case '\n' ^ 0x40: // 'J'
592 break;
593 case '\n' ^ 0x80: // 0x8A (unprintable)
594 return true;
595 }
596 return false;
597}
598
599// ::isprint(c) will prevent us from being called for all the printable
600// matches below. If we let unprintables through because of this, they
601// get converted to underscore (_) by the validation phase.
602bool likely_space(char c) {
603 switch (static_cast<uint8_t>(c)) {
604 case ' ': // ' '
605 case ' ' ^ 0x01: // '!'
606 case ' ' ^ 0x02: // '"'
607 case ' ' ^ 0x04: // '$'
608 case ' ' ^ 0x08: // '('
609 case ' ' ^ 0x10: // '0'
610 case ' ' ^ 0x20: // '\0' (unprintable)
611 case ' ' ^ 0x40: // 'P'
612 case ' ' ^ 0x80: // 0xA0 (unprintable)
613 case '\t': // '\t'
614 case '\t' ^ 0x01: // '\b' (unprintable) (likely_newline counters)
615 case '\t' ^ 0x02: // '\v' (unprintable)
616 case '\t' ^ 0x04: // '\r' (unprintable) (likely_newline counters)
617 case '\t' ^ 0x08: // 0x01 (unprintable)
618 case '\t' ^ 0x10: // 0x19 (unprintable)
619 case '\t' ^ 0x20: // ')'
620 case '\t' ^ 0x40: // '1'
621 case '\t' ^ 0x80: // 0x89 (unprintable)
622 return true;
623 }
624 return false;
625}
626
627std::string getSubreason(const std::string& content, size_t pos, bool quoted) {
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700628 static constexpr size_t max_reason_length = 256;
629
630 std::string subReason(content.substr(pos, max_reason_length));
631 // Correct against any known strings that Bit Error Match
632 for (const auto& s : knownReasons) {
633 correctForBitErrorOrUnderline(subReason, s);
634 }
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700635 std::string terminator(quoted ? "'" : "");
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700636 for (const auto& m : kBootReasonMap) {
637 if (m.first.length() <= strlen("cold")) continue; // too short?
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700638 if (correctForBitErrorOrUnderline(subReason, m.first + terminator)) continue;
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700639 if (m.first.length() <= strlen("reboot,cold")) continue; // short?
640 if (android::base::StartsWith(m.first, "reboot,")) {
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700641 correctForBitErrorOrUnderline(subReason, m.first.substr(strlen("reboot,")) + terminator);
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700642 } else if (android::base::StartsWith(m.first, "kernel_panic,sysrq,")) {
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700643 correctForBitErrorOrUnderline(subReason,
644 m.first.substr(strlen("kernel_panic,sysrq,")) + terminator);
645 } else if (android::base::StartsWith(m.first, "kernel_panic,")) {
646 correctForBitErrorOrUnderline(subReason, m.first.substr(strlen("kernel_panic,")) + terminator);
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700647 }
648 }
649 for (pos = 0; pos < subReason.length(); ++pos) {
650 char c = subReason[pos];
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700651 if (!(::isprint(c) || likely_space(c)) || likely_newline(c) ||
652 (quoted && likely_single_quote(c))) {
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700653 subReason.erase(pos);
654 break;
655 }
656 }
657 transformReason(subReason);
658 return subReason;
659}
660
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700661bool addKernelPanicSubReason(const pstoreConsole& console, std::string& ret) {
Mark Salyzyn64610892017-09-18 10:41:14 -0700662 // Check for kernel panic types to refine information
Mark Salyzyn853bb802018-03-16 08:44:56 -0700663 if ((console.rfind("SysRq : Trigger a crash") != std::string::npos) ||
664 (console.rfind("PC is at sysrq_handle_crash+") != std::string::npos)) {
Mark Salyzyn64610892017-09-18 10:41:14 -0700665 ret = "kernel_panic,sysrq";
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700666 // Invented for Android to allow daemons that specifically trigger sysrq
667 // to communicate more accurate boot subreasons via last console messages.
668 static constexpr char sysrqSubreason[] = "SysRq : Trigger a crash : '";
669 auto pos = console.rfind(sysrqSubreason);
670 if (pos != std::string::npos) {
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700671 ret += "," + getSubreason(console, pos + strlen(sysrqSubreason), /* quoted */ true);
Mark Salyzyn39cc3e72018-03-19 15:16:29 -0700672 }
Mark Salyzyn64610892017-09-18 10:41:14 -0700673 return true;
674 }
675 if (console.rfind("Unable to handle kernel NULL pointer dereference at virtual address") !=
676 std::string::npos) {
Mark Salyzyn853bb802018-03-16 08:44:56 -0700677 ret = "kernel_panic,null";
Mark Salyzyn64610892017-09-18 10:41:14 -0700678 return true;
679 }
680 if (console.rfind("Kernel BUG at ") != std::string::npos) {
Mark Salyzyn853bb802018-03-16 08:44:56 -0700681 ret = "kernel_panic,bug";
Mark Salyzyn64610892017-09-18 10:41:14 -0700682 return true;
683 }
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700684
685 std::string panic("Kernel panic - not syncing: ");
686 auto pos = console.rfind(panic);
687 if (pos != std::string::npos) {
688 static const std::vector<std::pair<const std::string, const std::string>> panicReasons = {
689 {"Out of memory", "oom"},
690 {"out of memory", "oom"},
691 {"Oh boy, that early out of memory", "oom"}, // omg
692 {"BUG!", "bug"},
693 {"hung_task: blocked tasks", "hung"},
694 {"audit: ", "audit"},
695 {"scheduling while atomic", "atomic"},
696 {"Attempted to kill init!", "init"},
697 {"Requested init", "init"},
698 {"No working init", "init"},
699 {"Could not decompress init", "init"},
700 {"RCU Stall", "hung,rcu"},
701 {"stack-protector", "stack"},
702 {"kernel stack overflow", "stack"},
703 {"Corrupt kernel stack", "stack"},
704 {"low stack detected", "stack"},
705 {"corrupted stack end", "stack"},
706 };
707
708 ret = "kernel_panic";
709 for (auto& s : panicReasons) {
710 if (console.find(panic + s.first, pos) != std::string::npos) {
711 ret += "," + s.second;
712 return true;
713 }
714 }
715 auto reason = getSubreason(console, pos + panic.length(), /* newline */ false);
716 if (reason.length() > 3) {
717 ret += "," + reason;
718 }
719 return true;
720 }
Mark Salyzyn64610892017-09-18 10:41:14 -0700721 return false;
722}
723
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700724bool addKernelPanicSubReason(const std::string& content, std::string& ret) {
725 return addKernelPanicSubReason(pstoreConsole(content), ret);
726}
727
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700728const char system_reboot_reason_property[] = "sys.boot.reason";
729const char last_reboot_reason_property[] = LAST_REBOOT_REASON_PROPERTY;
730const char bootloader_reboot_reason_property[] = "ro.boot.bootreason";
731
732// Scrub, Sanitize, Standardize and Enhance the boot reason string supplied.
733std::string BootReasonStrToReason(const std::string& boot_reason) {
734 std::string ret(GetProperty(system_reboot_reason_property));
735 std::string reason(boot_reason);
736 // If sys.boot.reason == ro.boot.bootreason, let's re-evaluate
737 if (reason == ret) ret = "";
738
Mark Salyzyn88d692c2017-09-20 08:37:46 -0700739 transformReason(reason);
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700740
741 // Is the current system boot reason sys.boot.reason valid?
742 if (!isKnownRebootReason(ret)) ret = "";
743
744 if (ret == "") {
745 // Is the bootloader boot reason ro.boot.bootreason known?
746 std::vector<std::string> words(android::base::Split(reason, ",_-"));
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700747 for (auto& s : knownReasons) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700748 std::string blunt;
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700749 for (auto& r : words) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700750 if (r == s) {
751 if (isBluntRebootReason(s)) {
752 blunt = s;
753 } else {
754 ret = s;
755 break;
756 }
757 }
758 }
759 if (ret == "") ret = blunt;
760 if (ret != "") break;
761 }
762 }
763
764 if (ret == "") {
765 // A series of checks to take some officially unsupported reasons
766 // reported by the bootloader and find some logical and canonical
767 // sense. In an ideal world, we would require those bootloaders
Mark Salyzyn25900dd2018-03-16 09:05:59 -0700768 // to behave and follow our CTS standards.
769 //
770 // first member is the output
771 // second member is an unanchored regex for an alias
772 //
Mark Salyzyn28193282018-03-16 09:05:59 -0700773 // If output has a prefix of <bang> '!', we do not use it as a
774 // match needle (and drop the <bang> prefix when landing in output),
775 // otherwise look for it as well. This helps keep the scale of the
Mark Salyzyn25900dd2018-03-16 09:05:59 -0700776 // following table smaller.
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700777 static const std::vector<std::pair<const std::string, const std::string>> aliasReasons = {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700778 {"watchdog", "wdog"},
Mark Salyzyn25900dd2018-03-16 09:05:59 -0700779 {"cold,powerkey", "powerkey|power_key|PowerKey"},
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700780 {"kernel_panic", "panic"},
781 {"shutdown,thermal", "thermal"},
782 {"warm,s3_wakeup", "s3_wakeup"},
783 {"hard,hw_reset", "hw_reset"},
Mark Salyzyn8aa36c62018-03-16 11:00:14 -0700784 {"cold,charger", "usb"},
785 {"cold,rtc", "rtc"},
Mark Salyzyncabbe4f2017-10-23 13:52:39 -0700786 {"reboot,2sec", "2sec_reboot"},
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700787 {"bootloader", ""},
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700788 };
789
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700790 for (auto& s : aliasReasons) {
Mark Salyzyn28193282018-03-16 09:05:59 -0700791 size_t firstHasNot = s.first[0] == '!';
792 if (!firstHasNot && (reason.find(s.first) != std::string::npos)) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700793 ret = s.first;
794 break;
795 }
Mark Salyzyn25900dd2018-03-16 09:05:59 -0700796 if (s.second.size() && std::regex_search(reason, std::regex(s.second))) {
Mark Salyzyn28193282018-03-16 09:05:59 -0700797 ret = s.first.substr(firstHasNot);
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700798 break;
799 }
800 }
801 }
802
803 // If watchdog is the reason, see if there is a security angle?
804 if (ret == "watchdog") {
805 if (reason.find("sec") != std::string::npos) {
806 ret += ",security";
807 }
808 }
809
Mark Salyzyn64610892017-09-18 10:41:14 -0700810 if (ret == "kernel_panic") {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700811 // Check to see if last klog has some refinement hints.
812 std::string content;
Mark Salyzyn64610892017-09-18 10:41:14 -0700813 if (readPstoreConsole(content)) {
814 addKernelPanicSubReason(content, ret);
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700815 }
Mark Salyzyn64610892017-09-18 10:41:14 -0700816 } else if (isBluntRebootReason(ret)) {
817 // Check the other available reason resources if the reason is still blunt.
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700818
Mark Salyzyn64610892017-09-18 10:41:14 -0700819 // Check to see if last klog has some refinement hints.
820 std::string content;
821 if (readPstoreConsole(content)) {
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700822 const pstoreConsole console(content);
Mark Salyzyn64610892017-09-18 10:41:14 -0700823 // The toybox reboot command used directly (unlikely)? But also
824 // catches init's response to Android's more controlled reboot command.
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700825 if (console.rfind("reboot: Power down") != std::string::npos) {
Mark Salyzyn64610892017-09-18 10:41:14 -0700826 ret = "shutdown"; // Still too blunt, but more accurate.
827 // ToDo: init should record the shutdown reason to kernel messages ala:
828 // init: shutdown system with command 'last_reboot_reason'
829 // so that if pstore has persistence we can get some details
830 // that could be missing in last_reboot_reason_property.
831 }
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700832
Mark Salyzyn64610892017-09-18 10:41:14 -0700833 static const char cmd[] = "reboot: Restarting system with command '";
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700834 size_t pos = console.rfind(cmd);
Mark Salyzyn64610892017-09-18 10:41:14 -0700835 if (pos != std::string::npos) {
Mark Salyzyn3f48fa92018-03-22 08:41:22 -0700836 std::string subReason(getSubreason(content, pos + strlen(cmd), /* quoted */ true));
Mark Salyzyn64610892017-09-18 10:41:14 -0700837 if (subReason != "") { // Will not land "reboot" as that is too blunt.
838 if (isKernelRebootReason(subReason)) {
839 ret = "reboot," + subReason; // User space can't talk kernel reasons.
Mark Salyzyndafced92017-09-20 08:37:46 -0700840 } else if (isKnownRebootReason(subReason)) {
Mark Salyzyn64610892017-09-18 10:41:14 -0700841 ret = subReason;
Mark Salyzyndafced92017-09-20 08:37:46 -0700842 } else {
843 ret = "reboot," + subReason; // legitimize unknown reasons
Mark Salyzyn64610892017-09-18 10:41:14 -0700844 }
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700845 }
846 }
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700847
Mark Salyzyn64610892017-09-18 10:41:14 -0700848 // Check for kernel panics, allowed to override reboot command.
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700849 if (!addKernelPanicSubReason(console, ret) &&
Mark Salyzyn64610892017-09-18 10:41:14 -0700850 // check for long-press power down
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700851 ((console.rfind("Power held for ") != std::string::npos) ||
852 (console.rfind("charger: [") != std::string::npos))) {
Mark Salyzyn64610892017-09-18 10:41:14 -0700853 ret = "cold";
854 }
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700855 }
856
857 // The following battery test should migrate to a default system health HAL
858
859 // Let us not worry if the reboot command was issued, for the cases of
860 // reboot -p, reboot <no reason>, reboot cold, reboot warm and reboot hard.
861 // Same for bootloader and ro.boot.bootreasons of this set, but a dead
862 // battery could conceivably lead to these, so worthy of override.
863 if (isBluntRebootReason(ret)) {
864 // Heuristic to determine if shutdown possibly because of a dead battery?
865 // Really a hail-mary pass to find it in last klog content ...
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700866 static const int battery_dead_threshold = 2; // percent
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700867 static const char battery[] = "healthd: battery l=";
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700868 const pstoreConsole console(content);
869 size_t pos = console.rfind(battery); // last one
Mark Salyzyna16e4372017-09-20 08:36:12 -0700870 std::string digits;
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700871 if (pos != std::string::npos) {
Mark Salyzyn747c0e62017-09-20 08:37:46 -0700872 digits = content.substr(pos + strlen(battery), strlen("100 "));
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700873 // correct common errors
Mark Salyzyn1e7d1c72018-03-16 08:57:20 -0700874 correctForBitError(digits, "100 ");
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700875 if (digits[0] == '!') digits[0] = '1';
876 if (digits[1] == '!') digits[1] = '1';
Mark Salyzyna16e4372017-09-20 08:36:12 -0700877 }
Mark Salyzyn747c0e62017-09-20 08:37:46 -0700878 const char* endptr = digits.c_str();
879 unsigned level = 0;
880 while (::isdigit(*endptr)) {
881 level *= 10;
882 level += *endptr++ - '0';
883 // make sure no leading zeros, except zero itself, and range check.
884 if ((level == 0) || (level > 100)) break;
885 }
Mark Salyzyn293cb3b2017-09-20 08:37:46 -0700886 // example bit error rate issues for 10%
887 // 'l=10 ' no bits in error
888 // 'l=00 ' single bit error (fails above)
889 // 'l=1 ' single bit error
890 // 'l=0 ' double bit error
891 // There are others, not typically critical because of 2%
892 // battery_dead_threshold. KISS check, make sure second
893 // character after digit sequence is not a space.
894 if ((level <= 100) && (endptr != digits.c_str()) && (endptr[0] == ' ') && (endptr[1] != ' ')) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700895 LOG(INFO) << "Battery level at shutdown " << level << "%";
896 if (level <= battery_dead_threshold) {
897 ret = "shutdown,battery";
898 }
Mark Salyzyna16e4372017-09-20 08:36:12 -0700899 } else { // Most likely
900 digits = ""; // reset digits
901
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700902 // Content buffer no longer will have console data. Beware if more
903 // checks added below, that depend on parsing console content.
904 content = "";
905
906 LOG(DEBUG) << "Can not find last low battery in last console messages";
907 android_logcat_context ctx = create_android_logcat();
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700908 FILE* fp = android_logcat_popen(&ctx, "logcat -b kernel -v brief -d");
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700909 if (fp != nullptr) {
910 android::base::ReadFdToString(fileno(fp), &content);
911 }
912 android_logcat_pclose(&ctx, fp);
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700913 static const char logcat_battery[] = "W/healthd ( 0): battery l=";
914 const char* match = logcat_battery;
915
916 if (content == "") {
917 // Service logd.klog not running, go to smaller buffer in the kernel.
918 int rc = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
919 if (rc > 0) {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700920 ssize_t len = rc + 1024; // 1K Margin should it grow between calls.
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700921 std::unique_ptr<char[]> buf(new char[len]);
922 rc = klogctl(KLOG_READ_ALL, buf.get(), len);
923 if (rc < len) {
924 len = rc + 1;
925 }
926 buf[--len] = '\0';
927 content = buf.get();
928 }
929 match = battery;
930 }
931
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -0700932 pos = content.find(match); // The first one it finds.
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700933 if (pos != std::string::npos) {
Mark Salyzyn747c0e62017-09-20 08:37:46 -0700934 digits = content.substr(pos + strlen(match), strlen("100 "));
Mark Salyzyna16e4372017-09-20 08:36:12 -0700935 }
Mark Salyzyn747c0e62017-09-20 08:37:46 -0700936 endptr = digits.c_str();
937 level = 0;
938 while (::isdigit(*endptr)) {
939 level *= 10;
940 level += *endptr++ - '0';
941 // make sure no leading zeros, except zero itself, and range check.
942 if ((level == 0) || (level > 100)) break;
943 }
Mark Salyzyna16e4372017-09-20 08:36:12 -0700944 if ((level <= 100) && (endptr != digits.c_str()) && (*endptr == ' ')) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700945 LOG(INFO) << "Battery level at startup " << level << "%";
946 if (level <= battery_dead_threshold) {
947 ret = "shutdown,battery";
948 }
949 } else {
950 LOG(DEBUG) << "Can not find first battery level in dmesg or logcat";
951 }
952 }
953 }
954
955 // Is there a controlled shutdown hint in last_reboot_reason_property?
956 if (isBluntRebootReason(ret)) {
957 // Content buffer no longer will have console data. Beware if more
958 // checks added below, that depend on parsing console content.
959 content = GetProperty(last_reboot_reason_property);
Mark Salyzyn88d692c2017-09-20 08:37:46 -0700960 transformReason(content);
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700961
Mark Salyzyn62909822017-10-09 09:27:16 -0700962 // Anything in last is better than 'super-blunt' reboot or shutdown.
963 if ((ret == "") || (ret == "reboot") || (ret == "shutdown") || !isBluntRebootReason(content)) {
964 ret = content;
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700965 }
966 }
967
968 // Other System Health HAL reasons?
969
970 // ToDo: /proc/sys/kernel/boot_reason needs a HAL interface to
971 // possibly offer hardware-specific clues from the PMIC.
972 }
973
974 // If unknown left over from above, make it "reboot,<boot_reason>"
975 if (ret == "") {
976 ret = "reboot";
977 if (android::base::StartsWith(reason, "reboot")) {
978 reason = reason.substr(strlen("reboot"));
Mark Salyzyn0af71a52017-10-05 13:58:04 -0700979 while ((reason[0] == ',') || (reason[0] == '_')) {
Mark Salyzynb304f6d2017-08-04 13:35:51 -0700980 reason = reason.substr(1);
981 }
982 }
983 if (reason != "") {
984 ret += ",";
985 ret += reason;
986 }
987 }
988
989 LOG(INFO) << "Canonical boot reason: " << ret;
990 if (isKernelRebootReason(ret) && (GetProperty(last_reboot_reason_property) != "")) {
991 // Rewrite as it must be old news, kernel reasons trump user space.
992 SetProperty(last_reboot_reason_property, ret);
993 }
994 return ret;
995}
996
James Hawkinsb9cf7712016-04-08 15:32:19 -0700997// Returns the appropriate metric key prefix for the boot_complete metric such
998// that boot metrics after a system update are labeled as ota_boot_complete;
999// otherwise, they are labeled as boot_complete. This method encapsulates the
1000// bookkeeping required to track when a system update has occurred by storing
1001// the UTC timestamp of the system build date and comparing against the current
1002// system build date.
1003std::string CalculateBootCompletePrefix() {
1004 static const std::string kBuildDateKey = "build_date";
1005 std::string boot_complete_prefix = "boot_complete";
1006
1007 std::string build_date_str = GetProperty("ro.build.date.utc");
James Hawkins4dded612016-07-28 11:50:23 -07001008 int32_t build_date;
Elliott Hughesda46b392016-10-11 17:09:00 -07001009 if (!android::base::ParseInt(build_date_str, &build_date)) {
James Hawkins4dded612016-07-28 11:50:23 -07001010 return std::string();
1011 }
James Hawkinsb9cf7712016-04-08 15:32:19 -07001012
1013 BootEventRecordStore boot_event_store;
1014 BootEventRecordStore::BootEventRecord record;
James Hawkins0bc4ad42017-05-30 15:03:15 -07001015 if (!boot_event_store.GetBootEvent(kBuildDateKey, &record)) {
1016 boot_complete_prefix = "factory_reset_" + boot_complete_prefix;
1017 boot_event_store.AddBootEventWithValue(kBuildDateKey, build_date);
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001018 LOG(INFO) << "Canonical boot reason: reboot,factory_reset";
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001019 SetProperty(system_reboot_reason_property, "reboot,factory_reset");
James Hawkins0bc4ad42017-05-30 15:03:15 -07001020 } else if (build_date != record.second) {
James Hawkinsb9cf7712016-04-08 15:32:19 -07001021 boot_complete_prefix = "ota_" + boot_complete_prefix;
1022 boot_event_store.AddBootEventWithValue(kBuildDateKey, build_date);
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001023 LOG(INFO) << "Canonical boot reason: reboot,ota";
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001024 SetProperty(system_reboot_reason_property, "reboot,ota");
James Hawkinsb9cf7712016-04-08 15:32:19 -07001025 }
1026
1027 return boot_complete_prefix;
1028}
1029
James Hawkinsef0a0902017-01-06 14:38:23 -08001030// Records the value of a given ro.boottime.init property in milliseconds.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001031void RecordInitBootTimeProp(BootEventRecordStore* boot_event_store, const char* property) {
James Hawkinsef0a0902017-01-06 14:38:23 -08001032 std::string value = GetProperty(property);
1033
James Hawkins27c05222017-01-26 11:55:44 -08001034 int32_t time_in_ms;
1035 if (android::base::ParseInt(value, &time_in_ms)) {
James Hawkinsef0a0902017-01-06 14:38:23 -08001036 boot_event_store->AddBootEventWithValue(property, time_in_ms);
1037 }
1038}
1039
James Hawkins1bfcaec2017-05-19 14:27:27 -07001040// A map from bootloader timing stage to the time that stage took during boot.
1041typedef std::map<std::string, int32_t> BootloaderTimingMap;
1042
1043// Returns a mapping from bootloader stage names to the time those stages
1044// took to boot.
1045const BootloaderTimingMap GetBootLoaderTimings() {
1046 BootloaderTimingMap timings;
1047
1048 // |ro.boot.boottime| is of the form 'stage1:time1,...,stageN:timeN',
1049 // where timeN is in milliseconds.
James Hawkinsbe46fd12017-02-02 16:21:25 -08001050 std::string value = GetProperty("ro.boot.boottime");
James Hawkins6b5c5aa2017-02-16 11:53:03 -08001051 if (value.empty()) {
1052 // ro.boot.boottime is not reported on all devices.
James Hawkins1bfcaec2017-05-19 14:27:27 -07001053 return BootloaderTimingMap();
James Hawkins6b5c5aa2017-02-16 11:53:03 -08001054 }
James Hawkinsbe46fd12017-02-02 16:21:25 -08001055
1056 auto stages = android::base::Split(value, ",");
James Hawkins1bfcaec2017-05-19 14:27:27 -07001057 for (const auto& stageTiming : stages) {
James Hawkinsbe46fd12017-02-02 16:21:25 -08001058 // |stageTiming| is of the form 'stage:time'.
1059 auto stageTimingValues = android::base::Split(stageTiming, ":");
James Hawkins0bc4ad42017-05-30 15:03:15 -07001060 DCHECK_EQ(2U, stageTimingValues.size());
James Hawkinsbe46fd12017-02-02 16:21:25 -08001061
1062 std::string stageName = stageTimingValues[0];
1063 int32_t time_ms;
1064 if (android::base::ParseInt(stageTimingValues[1], &time_ms)) {
James Hawkins1bfcaec2017-05-19 14:27:27 -07001065 timings[stageName] = time_ms;
James Hawkinsbe46fd12017-02-02 16:21:25 -08001066 }
1067 }
James Hawkins6b5c5aa2017-02-16 11:53:03 -08001068
James Hawkins1bfcaec2017-05-19 14:27:27 -07001069 return timings;
1070}
1071
Tej Singh4eacd382018-01-25 17:59:57 -08001072// Returns the total bootloader boot time from the ro.boot.boottime system property.
1073int32_t GetBootloaderTime(const BootloaderTimingMap& bootloader_timings) {
1074 int32_t total_time = 0;
1075 for (const auto& timing : bootloader_timings) {
1076 total_time += timing.second;
1077 }
1078
1079 return total_time;
1080}
1081
James Hawkins1bfcaec2017-05-19 14:27:27 -07001082// Parses and records the set of bootloader stages and associated boot times
1083// from the ro.boot.boottime system property.
1084void RecordBootloaderTimings(BootEventRecordStore* boot_event_store,
1085 const BootloaderTimingMap& bootloader_timings) {
1086 int32_t total_time = 0;
1087 for (const auto& timing : bootloader_timings) {
1088 total_time += timing.second;
1089 boot_event_store->AddBootEventWithValue("boottime.bootloader." + timing.first, timing.second);
1090 }
1091
James Hawkins6b5c5aa2017-02-16 11:53:03 -08001092 boot_event_store->AddBootEventWithValue("boottime.bootloader.total", total_time);
James Hawkinsbe46fd12017-02-02 16:21:25 -08001093}
1094
Tej Singh4eacd382018-01-25 17:59:57 -08001095// Returns the closest estimation to the absolute device boot time, i.e.,
James Hawkins1bfcaec2017-05-19 14:27:27 -07001096// from power on to boot_complete, including bootloader times.
Tej Singh4eacd382018-01-25 17:59:57 -08001097std::chrono::milliseconds GetAbsoluteBootTime(const BootloaderTimingMap& bootloader_timings,
1098 std::chrono::milliseconds uptime) {
James Hawkins1bfcaec2017-05-19 14:27:27 -07001099 int32_t bootloader_time_ms = 0;
1100
1101 for (const auto& timing : bootloader_timings) {
1102 if (timing.first.compare("SW") != 0) {
1103 bootloader_time_ms += timing.second;
1104 }
1105 }
1106
1107 auto bootloader_duration = std::chrono::milliseconds(bootloader_time_ms);
Tej Singh4eacd382018-01-25 17:59:57 -08001108 return bootloader_duration + uptime;
1109}
1110
1111// Records the closest estimation to the absolute device boot time in seconds.
1112// i.e. from power on to boot_complete, including bootloader times.
1113void RecordAbsoluteBootTime(BootEventRecordStore* boot_event_store,
1114 std::chrono::milliseconds absolute_total) {
1115 auto absolute_total_sec = std::chrono::duration_cast<std::chrono::seconds>(absolute_total);
1116 boot_event_store->AddBootEventWithValue("absolute_boot_time", absolute_total_sec.count());
1117}
1118
1119// Logs the total boot time and reason to statsd.
1120void LogBootInfoToStatsd(std::chrono::milliseconds end_time,
1121 std::chrono::milliseconds total_duration, int32_t bootloader_duration_ms,
1122 double time_since_last_boot_sec) {
1123 const std::string reason(GetProperty(bootloader_reboot_reason_property));
1124
1125 if (reason.empty()) {
1126 android::util::stats_write(android::util::BOOT_SEQUENCE_REPORTED, "<EMPTY>", "<EMPTY>",
1127 end_time.count(), total_duration.count(),
1128 (int64_t)bootloader_duration_ms,
1129 (int64_t)time_since_last_boot_sec * 1000);
1130 return;
1131 }
1132
Tej Singhfe3e7622018-02-06 15:57:38 -08001133 const std::string system_reason(GetProperty(system_reboot_reason_property));
Tej Singh4eacd382018-01-25 17:59:57 -08001134 android::util::stats_write(android::util::BOOT_SEQUENCE_REPORTED, reason.c_str(),
1135 system_reason.c_str(), end_time.count(), total_duration.count(),
1136 (int64_t)bootloader_duration_ms,
1137 (int64_t)time_since_last_boot_sec * 1000);
James Hawkins1bfcaec2017-05-19 14:27:27 -07001138}
1139
Tej Singhfe3e7622018-02-06 15:57:38 -08001140void SetSystemBootReason() {
1141 const std::string bootloader_boot_reason(GetProperty(bootloader_reboot_reason_property));
1142 const std::string system_boot_reason(BootReasonStrToReason(bootloader_boot_reason));
1143 // Record the scrubbed system_boot_reason to the property
1144 SetProperty(system_reboot_reason_property, system_boot_reason);
1145}
1146
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001147// Gets the boot time offset. This is useful when Android is running in a
1148// container, because the boot_clock is not reset when Android reboots.
1149std::chrono::nanoseconds GetBootTimeOffset() {
1150 static const int64_t boottime_offset =
1151 android::base::GetIntProperty<int64_t>("ro.boot.boottime_offset", 0);
1152 return std::chrono::nanoseconds(boottime_offset);
1153}
1154
1155// Returns the current uptime, accounting for any offset in the CLOCK_BOOTTIME
1156// clock.
1157android::base::boot_clock::duration GetUptime() {
1158 return android::base::boot_clock::now().time_since_epoch() - GetBootTimeOffset();
1159}
1160
James Hawkinsc08e9962016-03-11 14:59:50 -08001161// Records several metrics related to the time it takes to boot the device,
1162// including disambiguating boot time on encrypted or non-encrypted devices.
1163void RecordBootComplete() {
1164 BootEventRecordStore boot_event_store;
James Hawkinsb9cf7712016-04-08 15:32:19 -07001165 BootEventRecordStore::BootEventRecord record;
James Hawkins2d8b3e62016-04-14 14:13:20 -07001166
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001167 auto uptime_ns = GetUptime();
1168 auto uptime_s = std::chrono::duration_cast<std::chrono::seconds>(uptime_ns);
James Hawkins2d8b3e62016-04-14 14:13:20 -07001169 time_t current_time_utc = time(nullptr);
Tej Singh4eacd382018-01-25 17:59:57 -08001170 time_t time_since_last_boot = 0;
James Hawkins2d8b3e62016-04-14 14:13:20 -07001171
1172 if (boot_event_store.GetBootEvent("last_boot_time_utc", &record)) {
1173 time_t last_boot_time_utc = record.second;
Tej Singh4eacd382018-01-25 17:59:57 -08001174 time_since_last_boot = difftime(current_time_utc, last_boot_time_utc);
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001175 boot_event_store.AddBootEventWithValue("time_since_last_boot", time_since_last_boot);
James Hawkins2d8b3e62016-04-14 14:13:20 -07001176 }
1177
1178 boot_event_store.AddBootEventWithValue("last_boot_time_utc", current_time_utc);
James Hawkinsc08e9962016-03-11 14:59:50 -08001179
James Hawkinsb9cf7712016-04-08 15:32:19 -07001180 // The boot_complete metric has two variants: boot_complete and
1181 // ota_boot_complete. The latter signifies that the device is booting after
1182 // a system update.
1183 std::string boot_complete_prefix = CalculateBootCompletePrefix();
James Hawkins4dded612016-07-28 11:50:23 -07001184 if (boot_complete_prefix.empty()) {
1185 // The system is hosed because the build date property could not be read.
1186 return;
1187 }
James Hawkinsc08e9962016-03-11 14:59:50 -08001188
1189 // post_decrypt_time_elapsed is only logged on encrypted devices.
1190 if (boot_event_store.GetBootEvent("post_decrypt_time_elapsed", &record)) {
1191 // Log the amount of time elapsed until the device is decrypted, which
1192 // includes the variable amount of time the user takes to enter the
1193 // decryption password.
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001194 boot_event_store.AddBootEventWithValue("boot_decryption_complete", uptime_s.count());
James Hawkinsc08e9962016-03-11 14:59:50 -08001195
1196 // Subtract the decryption time to normalize the boot cycle timing.
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001197 std::chrono::seconds boot_complete = std::chrono::seconds(uptime_s.count() - record.second);
James Hawkinsb9cf7712016-04-08 15:32:19 -07001198 boot_event_store.AddBootEventWithValue(boot_complete_prefix + "_post_decrypt",
James Hawkinse78ea772017-03-24 11:43:02 -07001199 boot_complete.count());
James Hawkinsc08e9962016-03-11 14:59:50 -08001200 } else {
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001201 boot_event_store.AddBootEventWithValue(boot_complete_prefix + "_no_encryption",
1202 uptime_s.count());
James Hawkinsc08e9962016-03-11 14:59:50 -08001203 }
1204
1205 // Record the total time from device startup to boot complete, regardless of
1206 // encryption state.
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001207 boot_event_store.AddBootEventWithValue(boot_complete_prefix, uptime_s.count());
James Hawkinsef0a0902017-01-06 14:38:23 -08001208
1209 RecordInitBootTimeProp(&boot_event_store, "ro.boottime.init");
1210 RecordInitBootTimeProp(&boot_event_store, "ro.boottime.init.selinux");
1211 RecordInitBootTimeProp(&boot_event_store, "ro.boottime.init.cold_boot_wait");
James Hawkinsbe46fd12017-02-02 16:21:25 -08001212
James Hawkins1bfcaec2017-05-19 14:27:27 -07001213 const BootloaderTimingMap bootloader_timings = GetBootLoaderTimings();
Tej Singh4eacd382018-01-25 17:59:57 -08001214 int32_t bootloader_boot_duration = GetBootloaderTime(bootloader_timings);
James Hawkins1bfcaec2017-05-19 14:27:27 -07001215 RecordBootloaderTimings(&boot_event_store, bootloader_timings);
1216
Luis Hector Chavez583d34c2018-04-12 15:25:15 -07001217 auto uptime_ms = std::chrono::duration_cast<std::chrono::milliseconds>(uptime_ns);
Tej Singh4eacd382018-01-25 17:59:57 -08001218 auto absolute_boot_time = GetAbsoluteBootTime(bootloader_timings, uptime_ms);
1219 RecordAbsoluteBootTime(&boot_event_store, absolute_boot_time);
1220
1221 auto boot_end_time_point = std::chrono::system_clock::now().time_since_epoch();
1222 auto boot_end_time = std::chrono::duration_cast<std::chrono::milliseconds>(boot_end_time_point);
1223
1224 LogBootInfoToStatsd(boot_end_time, absolute_boot_time, bootloader_boot_duration,
1225 time_since_last_boot);
James Hawkinsc08e9962016-03-11 14:59:50 -08001226}
1227
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001228// Records the boot_reason metric by querying the ro.boot.bootreason system
1229// property.
1230void RecordBootReason() {
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001231 const std::string reason(GetProperty(bootloader_reboot_reason_property));
James Hawkins25f71222017-10-10 16:37:05 -07001232
1233 if (reason.empty()) {
1234 // Log an empty boot reason value as '<EMPTY>' to ensure the value is intentional
1235 // (and not corruption anywhere else in the reporting pipeline).
1236 android::metricslogger::LogMultiAction(android::metricslogger::ACTION_BOOT,
1237 android::metricslogger::FIELD_PLATFORM_REASON, "<EMPTY>");
1238 } else {
1239 android::metricslogger::LogMultiAction(android::metricslogger::ACTION_BOOT,
1240 android::metricslogger::FIELD_PLATFORM_REASON, reason);
1241 }
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001242
1243 // Log the raw bootloader_boot_reason property value.
1244 int32_t boot_reason = BootReasonStrToEnum(reason);
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001245 BootEventRecordStore boot_event_store;
1246 boot_event_store.AddBootEventWithValue("boot_reason", boot_reason);
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001247
1248 // Log the scrubbed system_boot_reason.
Tej Singhfe3e7622018-02-06 15:57:38 -08001249 const std::string system_reason(GetProperty(system_reboot_reason_property));
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001250 int32_t system_boot_reason = BootReasonStrToEnum(system_reason);
1251 boot_event_store.AddBootEventWithValue("system_boot_reason", system_boot_reason);
1252
Mark Salyzynb304f6d2017-08-04 13:35:51 -07001253 if (reason == "") {
1254 SetProperty(bootloader_reboot_reason_property, system_reason);
1255 }
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001256}
1257
James Hawkins500d7152016-02-16 15:05:54 -08001258// Records two metrics related to the user resetting a device: the time at
1259// which the device is reset, and the time since the user last reset the
1260// device. The former is only set once per-factory reset.
1261void RecordFactoryReset() {
1262 BootEventRecordStore boot_event_store;
1263 BootEventRecordStore::BootEventRecord record;
1264
1265 time_t current_time_utc = time(nullptr);
1266
James Hawkins0660b302016-03-08 16:18:15 -08001267 if (current_time_utc < 0) {
1268 // UMA does not display negative values in buckets, so convert to positive.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001269 android::metricslogger::LogHistogram("factory_reset_current_time_failure",
1270 std::abs(current_time_utc));
James Hawkinsfff95ba2016-03-29 16:13:49 -07001271
James Hawkins9aec9262017-01-31 11:42:24 -08001272 // Logging via BootEventRecordStore to see if using android::metricslogger::LogHistogram
James Hawkinsfff95ba2016-03-29 16:13:49 -07001273 // is losing records somehow.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001274 boot_event_store.AddBootEventWithValue("factory_reset_current_time_failure",
1275 std::abs(current_time_utc));
James Hawkins0660b302016-03-08 16:18:15 -08001276 return;
1277 } else {
James Hawkins9aec9262017-01-31 11:42:24 -08001278 android::metricslogger::LogHistogram("factory_reset_current_time", current_time_utc);
James Hawkinsfff95ba2016-03-29 16:13:49 -07001279
James Hawkins9aec9262017-01-31 11:42:24 -08001280 // Logging via BootEventRecordStore to see if using android::metricslogger::LogHistogram
James Hawkinsfff95ba2016-03-29 16:13:49 -07001281 // is losing records somehow.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001282 boot_event_store.AddBootEventWithValue("factory_reset_current_time", current_time_utc);
James Hawkins0660b302016-03-08 16:18:15 -08001283 }
1284
James Hawkins500d7152016-02-16 15:05:54 -08001285 // The factory_reset boot event does not exist after the device is reset, so
1286 // use this signal to mark the time of the factory reset.
1287 if (!boot_event_store.GetBootEvent("factory_reset", &record)) {
1288 boot_event_store.AddBootEventWithValue("factory_reset", current_time_utc);
James Hawkins3bf9b142016-03-03 14:50:24 -08001289
1290 // Don't log the time_since_factory_reset until some time has elapsed.
1291 // The data is not meaningful yet and skews the histogram buckets.
James Hawkins500d7152016-02-16 15:05:54 -08001292 return;
1293 }
1294
1295 // Calculate and record the difference in time between now and the
1296 // factory_reset time.
1297 time_t factory_reset_utc = record.second;
James Hawkins9aec9262017-01-31 11:42:24 -08001298 android::metricslogger::LogHistogram("factory_reset_record_value", factory_reset_utc);
James Hawkinsfff95ba2016-03-29 16:13:49 -07001299
James Hawkins9aec9262017-01-31 11:42:24 -08001300 // Logging via BootEventRecordStore to see if using android::metricslogger::LogHistogram
James Hawkinsfff95ba2016-03-29 16:13:49 -07001301 // is losing records somehow.
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001302 boot_event_store.AddBootEventWithValue("factory_reset_record_value", factory_reset_utc);
James Hawkinsfff95ba2016-03-29 16:13:49 -07001303
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001304 time_t time_since_factory_reset = difftime(current_time_utc, factory_reset_utc);
1305 boot_event_store.AddBootEventWithValue("time_since_factory_reset", time_since_factory_reset);
James Hawkins500d7152016-02-16 15:05:54 -08001306}
1307
James Hawkinsabd73e62016-01-19 15:10:38 -08001308} // namespace
1309
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001310int main(int argc, char** argv) {
James Hawkinsabd73e62016-01-19 15:10:38 -08001311 android::base::InitLogging(argv);
1312
1313 const std::string cmd_line = GetCommandLine(argc, argv);
1314 LOG(INFO) << "Service started: " << cmd_line;
1315
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001316 int option_index = 0;
James Hawkinsc6275582016-03-22 10:47:44 -07001317 static const char value_str[] = "value";
Tej Singhfe3e7622018-02-06 15:57:38 -08001318 static const char system_boot_reason_str[] = "set_system_boot_reason";
James Hawkinsc08e9962016-03-11 14:59:50 -08001319 static const char boot_complete_str[] = "record_boot_complete";
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001320 static const char boot_reason_str[] = "record_boot_reason";
James Hawkins53684ea2016-02-23 16:18:19 -08001321 static const char factory_reset_str[] = "record_time_since_factory_reset";
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001322 static const struct option long_options[] = {
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001323 // clang-format off
Tej Singhfe3e7622018-02-06 15:57:38 -08001324 { "help", no_argument, NULL, 'h' },
1325 { "log", no_argument, NULL, 'l' },
1326 { "print", no_argument, NULL, 'p' },
1327 { "record", required_argument, NULL, 'r' },
1328 { value_str, required_argument, NULL, 0 },
1329 { system_boot_reason_str, no_argument, NULL, 0 },
1330 { boot_complete_str, no_argument, NULL, 0 },
1331 { boot_reason_str, no_argument, NULL, 0 },
1332 { factory_reset_str, no_argument, NULL, 0 },
1333 { NULL, 0, NULL, 0 }
Mark Salyzyn14b1e6d2017-09-18 10:41:14 -07001334 // clang-format on
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001335 };
1336
James Hawkinsc6275582016-03-22 10:47:44 -07001337 std::string boot_event;
1338 std::string value;
James Hawkinsabd73e62016-01-19 15:10:38 -08001339 int opt = 0;
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001340 while ((opt = getopt_long(argc, argv, "hlpr:", long_options, &option_index)) != -1) {
James Hawkinsabd73e62016-01-19 15:10:38 -08001341 switch (opt) {
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001342 // This case handles long options which have no single-character mapping.
1343 case 0: {
1344 const std::string option_name = long_options[option_index].name;
James Hawkinsc6275582016-03-22 10:47:44 -07001345 if (option_name == value_str) {
1346 // |optarg| is an external variable set by getopt representing
1347 // the option argument.
1348 value = optarg;
Tej Singhfe3e7622018-02-06 15:57:38 -08001349 } else if (option_name == system_boot_reason_str) {
1350 SetSystemBootReason();
James Hawkinsc6275582016-03-22 10:47:44 -07001351 } else if (option_name == boot_complete_str) {
James Hawkinsc08e9962016-03-11 14:59:50 -08001352 RecordBootComplete();
1353 } else if (option_name == boot_reason_str) {
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001354 RecordBootReason();
James Hawkins500d7152016-02-16 15:05:54 -08001355 } else if (option_name == factory_reset_str) {
1356 RecordFactoryReset();
James Hawkinsa4a1a4a2016-02-09 15:32:38 -08001357 } else {
1358 LOG(ERROR) << "Invalid option: " << option_name;
1359 }
1360 break;
1361 }
1362
James Hawkinsabd73e62016-01-19 15:10:38 -08001363 case 'h': {
1364 ShowHelp(argv[0]);
1365 break;
1366 }
1367
1368 case 'l': {
1369 LogBootEvents();
1370 break;
1371 }
1372
1373 case 'p': {
1374 PrintBootEvents();
1375 break;
1376 }
1377
1378 case 'r': {
1379 // |optarg| is an external variable set by getopt representing
1380 // the option argument.
James Hawkinsc6275582016-03-22 10:47:44 -07001381 boot_event = optarg;
James Hawkinsabd73e62016-01-19 15:10:38 -08001382 break;
1383 }
1384
1385 default: {
1386 DCHECK_EQ(opt, '?');
1387
1388 // |optopt| is an external variable set by getopt representing
1389 // the value of the invalid option.
1390 LOG(ERROR) << "Invalid option: " << optopt;
1391 ShowHelp(argv[0]);
1392 return EXIT_FAILURE;
1393 }
1394 }
1395 }
1396
James Hawkinsc6275582016-03-22 10:47:44 -07001397 if (!boot_event.empty()) {
1398 RecordBootEventFromCommandLine(boot_event, value);
1399 }
1400
James Hawkinsabd73e62016-01-19 15:10:38 -08001401 return 0;
1402}