1 /*
2 * Copyright (C) 2017 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 #include "reboot.h"
18
19 #include <dirent.h>
20 #include <fcntl.h>
21 #include <linux/fs.h>
22 #include <linux/loop.h>
23 #include <mntent.h>
24 #include <semaphore.h>
25 #include <stdlib.h>
26 #include <sys/cdefs.h>
27 #include <sys/ioctl.h>
28 #include <sys/mount.h>
29 #include <sys/stat.h>
30 #include <sys/swap.h>
31 #include <sys/syscall.h>
32 #include <sys/types.h>
33 #include <sys/wait.h>
34
35 #include <chrono>
36 #include <memory>
37 #include <set>
38 #include <thread>
39 #include <vector>
40
41 #include <InitProperties.sysprop.h>
42 #include <android-base/chrono_utils.h>
43 #include <android-base/file.h>
44 #include <android-base/logging.h>
45 #include <android-base/macros.h>
46 #include <android-base/properties.h>
47 #include <android-base/scopeguard.h>
48 #include <android-base/strings.h>
49 #include <android-base/unique_fd.h>
50 #include <bootloader_message/bootloader_message.h>
51 #include <cutils/android_reboot.h>
52 #include <fs_mgr.h>
53 #include <logwrap/logwrap.h>
54 #include <private/android_filesystem_config.h>
55 #include <selinux/selinux.h>
56
57 #include "action.h"
58 #include "action_manager.h"
59 #include "builtin_arguments.h"
60 #include "init.h"
61 #include "mount_namespace.h"
62 #include "property_service.h"
63 #include "reboot_utils.h"
64 #include "service.h"
65 #include "service_list.h"
66 #include "sigchld_handler.h"
67 #include "util.h"
68
69 using namespace std::literals;
70
71 using android::base::boot_clock;
72 using android::base::GetBoolProperty;
73 using android::base::GetUintProperty;
74 using android::base::SetProperty;
75 using android::base::Split;
76 using android::base::Timer;
77 using android::base::unique_fd;
78 using android::base::WaitForProperty;
79 using android::base::WriteStringToFile;
80
81 namespace android {
82 namespace init {
83
84 static bool shutting_down = false;
85
86 static const std::set<std::string> kDebuggingServices{"tombstoned", "logd", "adbd", "console"};
87
GetDebuggingServices(bool only_post_data)88 static std::vector<Service*> GetDebuggingServices(bool only_post_data) {
89 std::vector<Service*> ret;
90 ret.reserve(kDebuggingServices.size());
91 for (const auto& s : ServiceList::GetInstance()) {
92 if (kDebuggingServices.count(s->name()) && (!only_post_data || s->is_post_data())) {
93 ret.push_back(s.get());
94 }
95 }
96 return ret;
97 }
98
PersistRebootReason(const char * reason,bool write_to_property)99 static void PersistRebootReason(const char* reason, bool write_to_property) {
100 if (write_to_property) {
101 SetProperty(LAST_REBOOT_REASON_PROPERTY, reason);
102 }
103 auto fd = unique_fd(TEMP_FAILURE_RETRY(open(
104 LAST_REBOOT_REASON_FILE, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0666)));
105 if (!fd.ok()) {
106 PLOG(ERROR) << "Could not open '" << LAST_REBOOT_REASON_FILE
107 << "' to persist reboot reason";
108 return;
109 }
110 WriteStringToFd(reason, fd);
111 fsync(fd.get());
112 }
113
114 // represents umount status during reboot / shutdown.
115 enum UmountStat {
116 /* umount succeeded. */
117 UMOUNT_STAT_SUCCESS = 0,
118 /* umount was not run. */
119 UMOUNT_STAT_SKIPPED = 1,
120 /* umount failed with timeout. */
121 UMOUNT_STAT_TIMEOUT = 2,
122 /* could not run due to error */
123 UMOUNT_STAT_ERROR = 3,
124 /* not used by init but reserved for other part to use this to represent the
125 the state where umount status before reboot is not found / available. */
126 UMOUNT_STAT_NOT_AVAILABLE = 4,
127 };
128
129 // Utility for struct mntent
130 class MountEntry {
131 public:
MountEntry(const mntent & entry)132 explicit MountEntry(const mntent& entry)
133 : mnt_fsname_(entry.mnt_fsname),
134 mnt_dir_(entry.mnt_dir),
135 mnt_type_(entry.mnt_type),
136 mnt_opts_(entry.mnt_opts) {}
137
Umount(bool force)138 bool Umount(bool force) {
139 LOG(INFO) << "Unmounting " << mnt_fsname_ << ":" << mnt_dir_ << " opts " << mnt_opts_;
140 int r = umount2(mnt_dir_.c_str(), force ? MNT_FORCE : 0);
141 if (r == 0) {
142 LOG(INFO) << "Umounted " << mnt_fsname_ << ":" << mnt_dir_ << " opts " << mnt_opts_;
143 return true;
144 } else {
145 PLOG(WARNING) << "Cannot umount " << mnt_fsname_ << ":" << mnt_dir_ << " opts "
146 << mnt_opts_;
147 return false;
148 }
149 }
150
DoFsck()151 void DoFsck() {
152 int st;
153 if (IsF2Fs()) {
154 const char* f2fs_argv[] = {
155 "/system/bin/fsck.f2fs",
156 "-a",
157 mnt_fsname_.c_str(),
158 };
159 logwrap_fork_execvp(arraysize(f2fs_argv), f2fs_argv, &st, false, LOG_KLOG, true,
160 nullptr);
161 } else if (IsExt4()) {
162 const char* ext4_argv[] = {
163 "/system/bin/e2fsck",
164 "-y",
165 mnt_fsname_.c_str(),
166 };
167 logwrap_fork_execvp(arraysize(ext4_argv), ext4_argv, &st, false, LOG_KLOG, true,
168 nullptr);
169 }
170 }
171
IsBlockDevice(const struct mntent & mntent)172 static bool IsBlockDevice(const struct mntent& mntent) {
173 return android::base::StartsWith(mntent.mnt_fsname, "/dev/block");
174 }
175
IsEmulatedDevice(const struct mntent & mntent)176 static bool IsEmulatedDevice(const struct mntent& mntent) {
177 return android::base::StartsWith(mntent.mnt_fsname, "/data/");
178 }
179
180 private:
IsF2Fs() const181 bool IsF2Fs() const { return mnt_type_ == "f2fs"; }
182
IsExt4() const183 bool IsExt4() const { return mnt_type_ == "ext4"; }
184
185 std::string mnt_fsname_;
186 std::string mnt_dir_;
187 std::string mnt_type_;
188 std::string mnt_opts_;
189 };
190
191 // Turn off backlight while we are performing power down cleanup activities.
TurnOffBacklight()192 static void TurnOffBacklight() {
193 Service* service = ServiceList::GetInstance().FindService("blank_screen");
194 if (service == nullptr) {
195 LOG(WARNING) << "cannot find blank_screen in TurnOffBacklight";
196 return;
197 }
198 if (auto result = service->Start(); !result.ok()) {
199 LOG(WARNING) << "Could not start blank_screen service: " << result.error();
200 }
201 }
202
CallVdc(const std::string & system,const std::string & cmd)203 static Result<void> CallVdc(const std::string& system, const std::string& cmd) {
204 LOG(INFO) << "Calling /system/bin/vdc " << system << " " << cmd;
205 const char* vdc_argv[] = {"/system/bin/vdc", system.c_str(), cmd.c_str()};
206 int status;
207 if (logwrap_fork_execvp(arraysize(vdc_argv), vdc_argv, &status, false, LOG_KLOG, true,
208 nullptr) != 0) {
209 return ErrnoError() << "Failed to call '/system/bin/vdc " << system << " " << cmd << "'";
210 }
211 if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
212 return {};
213 }
214 return Error() << "'/system/bin/vdc " << system << " " << cmd << "' failed : " << status;
215 }
216
LogShutdownTime(UmountStat stat,Timer * t)217 static void LogShutdownTime(UmountStat stat, Timer* t) {
218 LOG(WARNING) << "powerctl_shutdown_time_ms:" << std::to_string(t->duration().count()) << ":"
219 << stat;
220 }
221
IsDataMounted()222 static bool IsDataMounted() {
223 std::unique_ptr<std::FILE, int (*)(std::FILE*)> fp(setmntent("/proc/mounts", "re"), endmntent);
224 if (fp == nullptr) {
225 PLOG(ERROR) << "Failed to open /proc/mounts";
226 return false;
227 }
228 mntent* mentry;
229 while ((mentry = getmntent(fp.get())) != nullptr) {
230 if (mentry->mnt_dir == "/data"s) {
231 return true;
232 }
233 }
234 return false;
235 }
236
237 // Find all read+write block devices and emulated devices in /proc/mounts and add them to
238 // the correpsponding list.
FindPartitionsToUmount(std::vector<MountEntry> * block_dev_partitions,std::vector<MountEntry> * emulated_partitions,bool dump)239 static bool FindPartitionsToUmount(std::vector<MountEntry>* block_dev_partitions,
240 std::vector<MountEntry>* emulated_partitions, bool dump) {
241 std::unique_ptr<std::FILE, int (*)(std::FILE*)> fp(setmntent("/proc/mounts", "re"), endmntent);
242 if (fp == nullptr) {
243 PLOG(ERROR) << "Failed to open /proc/mounts";
244 return false;
245 }
246 mntent* mentry;
247 while ((mentry = getmntent(fp.get())) != nullptr) {
248 if (dump) {
249 LOG(INFO) << "mount entry " << mentry->mnt_fsname << ":" << mentry->mnt_dir << " opts "
250 << mentry->mnt_opts << " type " << mentry->mnt_type;
251 } else if (MountEntry::IsBlockDevice(*mentry) && hasmntopt(mentry, "rw")) {
252 std::string mount_dir(mentry->mnt_dir);
253 // These are R/O partitions changed to R/W after adb remount.
254 // Do not umount them as shutdown critical services may rely on them.
255 if (mount_dir != "/" && mount_dir != "/system" && mount_dir != "/vendor" &&
256 mount_dir != "/oem") {
257 block_dev_partitions->emplace(block_dev_partitions->begin(), *mentry);
258 }
259 } else if (MountEntry::IsEmulatedDevice(*mentry)) {
260 emulated_partitions->emplace(emulated_partitions->begin(), *mentry);
261 }
262 }
263 return true;
264 }
265
DumpUmountDebuggingInfo()266 static void DumpUmountDebuggingInfo() {
267 int status;
268 if (!security_getenforce()) {
269 LOG(INFO) << "Run lsof";
270 const char* lsof_argv[] = {"/system/bin/lsof"};
271 logwrap_fork_execvp(arraysize(lsof_argv), lsof_argv, &status, false, LOG_KLOG, true,
272 nullptr);
273 }
274 FindPartitionsToUmount(nullptr, nullptr, true);
275 // dump current CPU stack traces and uninterruptible tasks
276 WriteStringToFile("l", PROC_SYSRQ);
277 WriteStringToFile("w", PROC_SYSRQ);
278 }
279
UmountPartitions(std::chrono::milliseconds timeout)280 static UmountStat UmountPartitions(std::chrono::milliseconds timeout) {
281 Timer t;
282 /* data partition needs all pending writes to be completed and all emulated partitions
283 * umounted.If the current waiting is not good enough, give
284 * up and leave it to e2fsck after reboot to fix it.
285 */
286 while (true) {
287 std::vector<MountEntry> block_devices;
288 std::vector<MountEntry> emulated_devices;
289 if (!FindPartitionsToUmount(&block_devices, &emulated_devices, false)) {
290 return UMOUNT_STAT_ERROR;
291 }
292 if (block_devices.size() == 0) {
293 return UMOUNT_STAT_SUCCESS;
294 }
295 bool unmount_done = true;
296 if (emulated_devices.size() > 0) {
297 for (auto& entry : emulated_devices) {
298 if (!entry.Umount(false)) unmount_done = false;
299 }
300 if (unmount_done) {
301 sync();
302 }
303 }
304 for (auto& entry : block_devices) {
305 if (!entry.Umount(timeout == 0ms)) unmount_done = false;
306 }
307 if (unmount_done) {
308 return UMOUNT_STAT_SUCCESS;
309 }
310 if ((timeout < t.duration())) { // try umount at least once
311 return UMOUNT_STAT_TIMEOUT;
312 }
313 std::this_thread::sleep_for(100ms);
314 }
315 }
316
KillAllProcesses()317 static void KillAllProcesses() {
318 WriteStringToFile("i", PROC_SYSRQ);
319 }
320
321 // Create reboot/shutdwon monitor thread
RebootMonitorThread(unsigned int cmd,const std::string & reboot_target,sem_t * reboot_semaphore,std::chrono::milliseconds shutdown_timeout,bool * reboot_monitor_run)322 void RebootMonitorThread(unsigned int cmd, const std::string& reboot_target,
323 sem_t* reboot_semaphore, std::chrono::milliseconds shutdown_timeout,
324 bool* reboot_monitor_run) {
325 unsigned int remaining_shutdown_time = 0;
326
327 // 300 seconds more than the timeout passed to the thread as there is a final Umount pass
328 // after the timeout is reached.
329 constexpr unsigned int shutdown_watchdog_timeout_default = 300;
330 auto shutdown_watchdog_timeout = android::base::GetUintProperty(
331 "ro.build.shutdown.watchdog.timeout", shutdown_watchdog_timeout_default);
332 remaining_shutdown_time = shutdown_watchdog_timeout + shutdown_timeout.count() / 1000;
333
334 while (*reboot_monitor_run == true) {
335 if (TEMP_FAILURE_RETRY(sem_wait(reboot_semaphore)) == -1) {
336 LOG(ERROR) << "sem_wait failed and exit RebootMonitorThread()";
337 return;
338 }
339
340 timespec shutdown_timeout_timespec;
341 if (clock_gettime(CLOCK_MONOTONIC, &shutdown_timeout_timespec) == -1) {
342 LOG(ERROR) << "clock_gettime() fail! exit RebootMonitorThread()";
343 return;
344 }
345
346 // If there are some remaining shutdown time left from previous round, we use
347 // remaining time here.
348 shutdown_timeout_timespec.tv_sec += remaining_shutdown_time;
349
350 LOG(INFO) << "shutdown_timeout_timespec.tv_sec: " << shutdown_timeout_timespec.tv_sec;
351
352 int sem_return = 0;
353 while ((sem_return = sem_timedwait_monotonic_np(reboot_semaphore,
354 &shutdown_timeout_timespec)) == -1 &&
355 errno == EINTR) {
356 }
357
358 if (sem_return == -1) {
359 LOG(ERROR) << "Reboot thread timed out";
360
361 if (android::base::GetBoolProperty("ro.debuggable", false) == true) {
362 if (false) {
363 // SEPolicy will block debuggerd from running and this is intentional.
364 // But these lines are left to be enabled during debugging.
365 LOG(INFO) << "Try to dump init process call trace:";
366 const char* vdc_argv[] = {"/system/bin/debuggerd", "-b", "1"};
367 int status;
368 logwrap_fork_execvp(arraysize(vdc_argv), vdc_argv, &status, false, LOG_KLOG,
369 true, nullptr);
370 }
371 LOG(INFO) << "Show stack for all active CPU:";
372 WriteStringToFile("l", PROC_SYSRQ);
373
374 LOG(INFO) << "Show tasks that are in disk sleep(uninterruptable sleep), which are "
375 "like "
376 "blocked in mutex or hardware register access:";
377 WriteStringToFile("w", PROC_SYSRQ);
378 }
379
380 // In shutdown case,notify kernel to sync and umount fs to read-only before shutdown.
381 if (cmd == ANDROID_RB_POWEROFF || cmd == ANDROID_RB_THERMOFF) {
382 WriteStringToFile("s", PROC_SYSRQ);
383
384 WriteStringToFile("u", PROC_SYSRQ);
385
386 RebootSystem(cmd, reboot_target);
387 }
388
389 LOG(ERROR) << "Trigger crash at last!";
390 WriteStringToFile("c", PROC_SYSRQ);
391 } else {
392 timespec current_time_timespec;
393
394 if (clock_gettime(CLOCK_MONOTONIC, ¤t_time_timespec) == -1) {
395 LOG(ERROR) << "clock_gettime() fail! exit RebootMonitorThread()";
396 return;
397 }
398
399 remaining_shutdown_time =
400 shutdown_timeout_timespec.tv_sec - current_time_timespec.tv_sec;
401
402 LOG(INFO) << "remaining_shutdown_time: " << remaining_shutdown_time;
403 }
404 }
405 }
406
407 /* Try umounting all emulated file systems R/W block device cfile systems.
408 * This will just try umount and give it up if it fails.
409 * For fs like ext4, this is ok as file system will be marked as unclean shutdown
410 * and necessary check can be done at the next reboot.
411 * For safer shutdown, caller needs to make sure that
412 * all processes / emulated partition for the target fs are all cleaned-up.
413 *
414 * return true when umount was successful. false when timed out.
415 */
TryUmountAndFsck(unsigned int cmd,bool run_fsck,std::chrono::milliseconds timeout,sem_t * reboot_semaphore)416 static UmountStat TryUmountAndFsck(unsigned int cmd, bool run_fsck,
417 std::chrono::milliseconds timeout, sem_t* reboot_semaphore) {
418 Timer t;
419 std::vector<MountEntry> block_devices;
420 std::vector<MountEntry> emulated_devices;
421
422 if (run_fsck && !FindPartitionsToUmount(&block_devices, &emulated_devices, false)) {
423 return UMOUNT_STAT_ERROR;
424 }
425
426 UmountStat stat = UmountPartitions(timeout - t.duration());
427 if (stat != UMOUNT_STAT_SUCCESS) {
428 LOG(INFO) << "umount timeout, last resort, kill all and try";
429 if (DUMP_ON_UMOUNT_FAILURE) DumpUmountDebuggingInfo();
430 KillAllProcesses();
431 // even if it succeeds, still it is timeout and do not run fsck with all processes killed
432 UmountStat st = UmountPartitions(0ms);
433 if ((st != UMOUNT_STAT_SUCCESS) && DUMP_ON_UMOUNT_FAILURE) DumpUmountDebuggingInfo();
434 }
435
436 if (stat == UMOUNT_STAT_SUCCESS && run_fsck) {
437 LOG(INFO) << "Pause reboot monitor thread before fsck";
438 sem_post(reboot_semaphore);
439
440 // fsck part is excluded from timeout check. It only runs for user initiated shutdown
441 // and should not affect reboot time.
442 for (auto& entry : block_devices) {
443 entry.DoFsck();
444 }
445
446 LOG(INFO) << "Resume reboot monitor thread after fsck";
447 sem_post(reboot_semaphore);
448 }
449 return stat;
450 }
451
452 // zram is able to use backing device on top of a loopback device.
453 // In order to unmount /data successfully, we have to kill the loopback device first
454 #define ZRAM_DEVICE "/dev/block/zram0"
455 #define ZRAM_RESET "/sys/block/zram0/reset"
456 #define ZRAM_BACK_DEV "/sys/block/zram0/backing_dev"
KillZramBackingDevice()457 static Result<void> KillZramBackingDevice() {
458 if (access(ZRAM_BACK_DEV, F_OK) != 0 && errno == ENOENT) {
459 LOG(INFO) << "No zram backing device configured";
460 return {};
461 }
462 std::string backing_dev;
463 if (!android::base::ReadFileToString(ZRAM_BACK_DEV, &backing_dev)) {
464 return ErrnoError() << "Failed to read " << ZRAM_BACK_DEV;
465 }
466
467 // cut the last "\n"
468 backing_dev.erase(backing_dev.length() - 1);
469
470 // shutdown zram handle
471 Timer swap_timer;
472 LOG(INFO) << "swapoff() start...";
473 if (swapoff(ZRAM_DEVICE) == -1) {
474 return ErrnoError() << "zram_backing_dev: swapoff (" << backing_dev << ")"
475 << " failed";
476 }
477 LOG(INFO) << "swapoff() took " << swap_timer;;
478
479 if (!WriteStringToFile("1", ZRAM_RESET)) {
480 return Error() << "zram_backing_dev: reset (" << backing_dev << ")"
481 << " failed";
482 }
483
484 if (!android::base::StartsWith(backing_dev, "/dev/block/loop")) {
485 LOG(INFO) << backing_dev << " is not a loop device. Exiting early";
486 return {};
487 }
488
489 // clear loopback device
490 unique_fd loop(TEMP_FAILURE_RETRY(open(backing_dev.c_str(), O_RDWR | O_CLOEXEC)));
491 if (loop.get() < 0) {
492 return ErrnoError() << "zram_backing_dev: open(" << backing_dev << ")"
493 << " failed";
494 }
495
496 if (ioctl(loop.get(), LOOP_CLR_FD, 0) < 0) {
497 return ErrnoError() << "zram_backing_dev: loop_clear (" << backing_dev << ")"
498 << " failed";
499 }
500 LOG(INFO) << "zram_backing_dev: `" << backing_dev << "` is cleared successfully.";
501 return {};
502 }
503
504 // Stops given services, waits for them to be stopped for |timeout| ms.
505 // If terminate is true, then SIGTERM is sent to services, otherwise SIGKILL is sent.
StopServices(const std::vector<Service * > & services,std::chrono::milliseconds timeout,bool terminate)506 static void StopServices(const std::vector<Service*>& services, std::chrono::milliseconds timeout,
507 bool terminate) {
508 LOG(INFO) << "Stopping " << services.size() << " services by sending "
509 << (terminate ? "SIGTERM" : "SIGKILL");
510 std::vector<pid_t> pids;
511 pids.reserve(services.size());
512 for (const auto& s : services) {
513 if (s->pid() > 0) {
514 pids.push_back(s->pid());
515 }
516 if (terminate) {
517 s->Terminate();
518 } else {
519 s->Stop();
520 }
521 }
522 if (timeout > 0ms) {
523 WaitToBeReaped(pids, timeout);
524 } else {
525 // Even if we don't to wait for services to stop, we still optimistically reap zombies.
526 ReapAnyOutstandingChildren();
527 }
528 }
529
530 // Like StopServices, but also logs all the services that failed to stop after the provided timeout.
531 // Returns number of violators.
StopServicesAndLogViolations(const std::vector<Service * > & services,std::chrono::milliseconds timeout,bool terminate)532 static int StopServicesAndLogViolations(const std::vector<Service*>& services,
533 std::chrono::milliseconds timeout, bool terminate) {
534 StopServices(services, timeout, terminate);
535 int still_running = 0;
536 for (const auto& s : services) {
537 if (s->IsRunning()) {
538 LOG(ERROR) << "[service-misbehaving] : service '" << s->name() << "' is still running "
539 << timeout.count() << "ms after receiving "
540 << (terminate ? "SIGTERM" : "SIGKILL");
541 still_running++;
542 }
543 }
544 return still_running;
545 }
546
UnmountAllApexes()547 static Result<void> UnmountAllApexes() {
548 const char* args[] = {"/system/bin/apexd", "--unmount-all"};
549 int status;
550 if (logwrap_fork_execvp(arraysize(args), args, &status, false, LOG_KLOG, true, nullptr) != 0) {
551 return ErrnoError() << "Failed to call '/system/bin/apexd --unmount-all'";
552 }
553 if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
554 return {};
555 }
556 return Error() << "'/system/bin/apexd --unmount-all' failed : " << status;
557 }
558
559 //* Reboot / shutdown the system.
560 // cmd ANDROID_RB_* as defined in android_reboot.h
561 // reason Reason string like "reboot", "shutdown,userrequested"
562 // reboot_target Reboot target string like "bootloader". Otherwise, it should be an empty string.
563 // run_fsck Whether to run fsck after umount is done.
564 //
DoReboot(unsigned int cmd,const std::string & reason,const std::string & reboot_target,bool run_fsck)565 static void DoReboot(unsigned int cmd, const std::string& reason, const std::string& reboot_target,
566 bool run_fsck) {
567 Timer t;
568 LOG(INFO) << "Reboot start, reason: " << reason << ", reboot_target: " << reboot_target;
569
570 bool is_thermal_shutdown = cmd == ANDROID_RB_THERMOFF;
571
572 auto shutdown_timeout = 0ms;
573 if (!SHUTDOWN_ZERO_TIMEOUT) {
574 constexpr unsigned int shutdown_timeout_default = 6;
575 constexpr unsigned int max_thermal_shutdown_timeout = 3;
576 auto shutdown_timeout_final = android::base::GetUintProperty("ro.build.shutdown_timeout",
577 shutdown_timeout_default);
578 if (is_thermal_shutdown && shutdown_timeout_final > max_thermal_shutdown_timeout) {
579 shutdown_timeout_final = max_thermal_shutdown_timeout;
580 }
581 shutdown_timeout = std::chrono::seconds(shutdown_timeout_final);
582 }
583 LOG(INFO) << "Shutdown timeout: " << shutdown_timeout.count() << " ms";
584
585 sem_t reboot_semaphore;
586 if (sem_init(&reboot_semaphore, false, 0) == -1) {
587 // These should never fail, but if they do, skip the graceful reboot and reboot immediately.
588 LOG(ERROR) << "sem_init() fail and RebootSystem() return!";
589 RebootSystem(cmd, reboot_target);
590 }
591
592 // Start a thread to monitor init shutdown process
593 LOG(INFO) << "Create reboot monitor thread.";
594 bool reboot_monitor_run = true;
595 std::thread reboot_monitor_thread(&RebootMonitorThread, cmd, reboot_target, &reboot_semaphore,
596 shutdown_timeout, &reboot_monitor_run);
597 reboot_monitor_thread.detach();
598
599 // Start reboot monitor thread
600 sem_post(&reboot_semaphore);
601
602 // Ensure last reboot reason is reduced to canonical
603 // alias reported in bootloader or system boot reason.
604 size_t skip = 0;
605 std::vector<std::string> reasons = Split(reason, ",");
606 if (reasons.size() >= 2 && reasons[0] == "reboot" &&
607 (reasons[1] == "recovery" || reasons[1] == "bootloader" || reasons[1] == "cold" ||
608 reasons[1] == "hard" || reasons[1] == "warm")) {
609 skip = strlen("reboot,");
610 }
611 PersistRebootReason(reason.c_str() + skip, true);
612
613 // If /data isn't mounted then we can skip the extra reboot steps below, since we don't need to
614 // worry about unmounting it.
615 if (!IsDataMounted()) {
616 sync();
617 RebootSystem(cmd, reboot_target);
618 abort();
619 }
620
621 // watchdogd is a vendor specific component but should be alive to complete shutdown safely.
622 const std::set<std::string> to_starts{"watchdogd"};
623 std::vector<Service*> stop_first;
624 stop_first.reserve(ServiceList::GetInstance().services().size());
625 for (const auto& s : ServiceList::GetInstance()) {
626 if (kDebuggingServices.count(s->name())) {
627 // keep debugging tools until non critical ones are all gone.
628 s->SetShutdownCritical();
629 } else if (to_starts.count(s->name())) {
630 if (auto result = s->Start(); !result.ok()) {
631 LOG(ERROR) << "Could not start shutdown 'to_start' service '" << s->name()
632 << "': " << result.error();
633 }
634 s->SetShutdownCritical();
635 } else if (s->IsShutdownCritical()) {
636 // Start shutdown critical service if not started.
637 if (auto result = s->Start(); !result.ok()) {
638 LOG(ERROR) << "Could not start shutdown critical service '" << s->name()
639 << "': " << result.error();
640 }
641 } else {
642 stop_first.push_back(s.get());
643 }
644 }
645
646 // remaining operations (specifically fsck) may take a substantial duration
647 if (cmd == ANDROID_RB_POWEROFF || is_thermal_shutdown) {
648 TurnOffBacklight();
649 }
650
651 Service* boot_anim = ServiceList::GetInstance().FindService("bootanim");
652 Service* surface_flinger = ServiceList::GetInstance().FindService("surfaceflinger");
653 if (boot_anim != nullptr && surface_flinger != nullptr && surface_flinger->IsRunning()) {
654 bool do_shutdown_animation = GetBoolProperty("ro.init.shutdown_animation", false);
655
656 if (do_shutdown_animation) {
657 SetProperty("service.bootanim.exit", "0");
658 // Could be in the middle of animation. Stop and start so that it can pick
659 // up the right mode.
660 boot_anim->Stop();
661 }
662
663 for (const auto& service : ServiceList::GetInstance()) {
664 if (service->classnames().count("animation") == 0) {
665 continue;
666 }
667
668 // start all animation classes if stopped.
669 if (do_shutdown_animation) {
670 service->Start();
671 }
672 service->SetShutdownCritical(); // will not check animation class separately
673 }
674
675 if (do_shutdown_animation) {
676 boot_anim->Start();
677 surface_flinger->SetShutdownCritical();
678 boot_anim->SetShutdownCritical();
679 }
680 }
681
682 // optional shutdown step
683 // 1. terminate all services except shutdown critical ones. wait for delay to finish
684 if (shutdown_timeout > 0ms) {
685 StopServicesAndLogViolations(stop_first, shutdown_timeout / 2, true /* SIGTERM */);
686 }
687 // Send SIGKILL to ones that didn't terminate cleanly.
688 StopServicesAndLogViolations(stop_first, 0ms, false /* SIGKILL */);
689 SubcontextTerminate();
690 // Reap subcontext pids.
691 ReapAnyOutstandingChildren();
692
693 // 3. send volume shutdown to vold
694 Service* vold_service = ServiceList::GetInstance().FindService("vold");
695 if (vold_service != nullptr && vold_service->IsRunning()) {
696 CallVdc("volume", "shutdown");
697 vold_service->Stop();
698 } else {
699 LOG(INFO) << "vold not running, skipping vold shutdown";
700 }
701 // logcat stopped here
702 StopServices(GetDebuggingServices(false /* only_post_data */), 0ms, false /* SIGKILL */);
703 // 4. sync, try umount, and optionally run fsck for user shutdown
704 {
705 Timer sync_timer;
706 LOG(INFO) << "sync() before umount...";
707 sync();
708 LOG(INFO) << "sync() before umount took" << sync_timer;
709 }
710 // 5. drop caches and disable zram backing device, if exist
711 KillZramBackingDevice();
712
713 LOG(INFO) << "Ready to unmount apexes. So far shutdown sequence took " << t;
714 // 6. unmount active apexes, otherwise they might prevent clean unmount of /data.
715 if (auto ret = UnmountAllApexes(); !ret.ok()) {
716 LOG(ERROR) << ret.error();
717 }
718 UmountStat stat =
719 TryUmountAndFsck(cmd, run_fsck, shutdown_timeout - t.duration(), &reboot_semaphore);
720 // Follow what linux shutdown is doing: one more sync with little bit delay
721 {
722 Timer sync_timer;
723 LOG(INFO) << "sync() after umount...";
724 sync();
725 LOG(INFO) << "sync() after umount took" << sync_timer;
726 }
727 if (!is_thermal_shutdown) std::this_thread::sleep_for(100ms);
728 LogShutdownTime(stat, &t);
729
730 // Send signal to terminate reboot monitor thread.
731 reboot_monitor_run = false;
732 sem_post(&reboot_semaphore);
733
734 // Reboot regardless of umount status. If umount fails, fsck after reboot will fix it.
735 RebootSystem(cmd, reboot_target);
736 abort();
737 }
738
EnterShutdown()739 static void EnterShutdown() {
740 LOG(INFO) << "Entering shutdown mode";
741 shutting_down = true;
742 // Skip wait for prop if it is in progress
743 ResetWaitForProp();
744 // Clear EXEC flag if there is one pending
745 for (const auto& s : ServiceList::GetInstance()) {
746 s->UnSetExec();
747 }
748 }
749
LeaveShutdown()750 static void LeaveShutdown() {
751 LOG(INFO) << "Leaving shutdown mode";
752 shutting_down = false;
753 StartSendingMessages();
754 }
755
GetMillisProperty(const std::string & name,std::chrono::milliseconds default_value)756 static std::chrono::milliseconds GetMillisProperty(const std::string& name,
757 std::chrono::milliseconds default_value) {
758 auto value = GetUintProperty(name, static_cast<uint64_t>(default_value.count()));
759 return std::chrono::milliseconds(std::move(value));
760 }
761
DoUserspaceReboot()762 static Result<void> DoUserspaceReboot() {
763 LOG(INFO) << "Userspace reboot initiated";
764 // An ugly way to pass a more precise reason on why fallback to hard reboot was triggered.
765 std::string sub_reason = "";
766 auto guard = android::base::make_scope_guard([&sub_reason] {
767 // Leave shutdown so that we can handle a full reboot.
768 LeaveShutdown();
769 trigger_shutdown("reboot,userspace_failed,shutdown_aborted," + sub_reason);
770 });
771 // Triggering userspace-reboot-requested will result in a bunch of setprop
772 // actions. We should make sure, that all of them are propagated before
773 // proceeding with userspace reboot. Synchronously setting sys.init.userspace_reboot.in_progress
774 // property is not perfect, but it should do the trick.
775 if (!android::sysprop::InitProperties::userspace_reboot_in_progress(true)) {
776 sub_reason = "setprop";
777 return Error() << "Failed to set sys.init.userspace_reboot.in_progress property";
778 }
779 EnterShutdown();
780 if (!SetProperty("sys.powerctl", "")) {
781 sub_reason = "resetprop";
782 return Error() << "Failed to reset sys.powerctl property";
783 }
784 std::vector<Service*> stop_first;
785 // Remember the services that were enabled. We will need to manually enable them again otherwise
786 // triggers like class_start won't restart them.
787 std::vector<Service*> were_enabled;
788 stop_first.reserve(ServiceList::GetInstance().services().size());
789 for (const auto& s : ServiceList::GetInstance().services_in_shutdown_order()) {
790 if (s->is_post_data() && !kDebuggingServices.count(s->name())) {
791 stop_first.push_back(s);
792 }
793 if (s->is_post_data() && s->IsEnabled()) {
794 were_enabled.push_back(s);
795 }
796 }
797 {
798 Timer sync_timer;
799 LOG(INFO) << "sync() before terminating services...";
800 sync();
801 LOG(INFO) << "sync() took " << sync_timer;
802 }
803 auto sigterm_timeout = GetMillisProperty("init.userspace_reboot.sigterm.timeoutmillis", 5s);
804 auto sigkill_timeout = GetMillisProperty("init.userspace_reboot.sigkill.timeoutmillis", 10s);
805 LOG(INFO) << "Timeout to terminate services: " << sigterm_timeout.count() << "ms "
806 << "Timeout to kill services: " << sigkill_timeout.count() << "ms";
807 StopServicesAndLogViolations(stop_first, sigterm_timeout, true /* SIGTERM */);
808 if (int r = StopServicesAndLogViolations(stop_first, sigkill_timeout, false /* SIGKILL */);
809 r > 0) {
810 sub_reason = "sigkill";
811 // TODO(b/135984674): store information about offending services for debugging.
812 return Error() << r << " post-data services are still running";
813 }
814 if (auto result = KillZramBackingDevice(); !result.ok()) {
815 sub_reason = "zram";
816 return result;
817 }
818 if (auto result = CallVdc("volume", "reset"); !result.ok()) {
819 sub_reason = "vold_reset";
820 return result;
821 }
822 if (int r = StopServicesAndLogViolations(GetDebuggingServices(true /* only_post_data */),
823 sigkill_timeout, false /* SIGKILL */);
824 r > 0) {
825 sub_reason = "sigkill_debug";
826 // TODO(b/135984674): store information about offending services for debugging.
827 return Error() << r << " debugging services are still running";
828 }
829 {
830 Timer sync_timer;
831 LOG(INFO) << "sync() after stopping services...";
832 sync();
833 LOG(INFO) << "sync() took " << sync_timer;
834 }
835 if (auto result = UnmountAllApexes(); !result.ok()) {
836 sub_reason = "apex";
837 return result;
838 }
839 if (!SwitchToMountNamespaceIfNeeded(NS_BOOTSTRAP)) {
840 sub_reason = "ns_switch";
841 return Error() << "Failed to switch to bootstrap namespace";
842 }
843 // Remove services that were defined in an APEX.
844 ServiceList::GetInstance().RemoveServiceIf([](const std::unique_ptr<Service>& s) -> bool {
845 if (s->is_from_apex()) {
846 LOG(INFO) << "Removing service '" << s->name() << "' because it's defined in an APEX";
847 return true;
848 }
849 return false;
850 });
851 // Re-enable services
852 for (const auto& s : were_enabled) {
853 LOG(INFO) << "Re-enabling service '" << s->name() << "'";
854 s->Enable();
855 }
856 ServiceList::GetInstance().ResetState();
857 LeaveShutdown();
858 ActionManager::GetInstance().QueueEventTrigger("userspace-reboot-resume");
859 guard.Disable(); // Go on with userspace reboot.
860 return {};
861 }
862
UserspaceRebootWatchdogThread()863 static void UserspaceRebootWatchdogThread() {
864 auto started_timeout = GetMillisProperty("init.userspace_reboot.started.timeoutmillis", 10s);
865 if (!WaitForProperty("sys.init.userspace_reboot.in_progress", "1", started_timeout)) {
866 LOG(ERROR) << "Userspace reboot didn't start in " << started_timeout.count()
867 << "ms. Switching to full reboot";
868 // Init might be wedged, don't try to write reboot reason into a persistent property and do
869 // a dirty reboot.
870 PersistRebootReason("userspace_failed,watchdog_triggered,failed_to_start", false);
871 RebootSystem(ANDROID_RB_RESTART2, "userspace_failed,watchdog_triggered,failed_to_start");
872 }
873 LOG(INFO) << "Starting userspace reboot watchdog";
874 auto watchdog_timeout = GetMillisProperty("init.userspace_reboot.watchdog.timeoutmillis", 5min);
875 LOG(INFO) << "UserspaceRebootWatchdog timeout: " << watchdog_timeout.count() << "ms";
876 if (!WaitForProperty("sys.boot_completed", "1", watchdog_timeout)) {
877 LOG(ERROR) << "Failed to boot in " << watchdog_timeout.count()
878 << "ms. Switching to full reboot";
879 // In this case device is in a boot loop. Only way to recover is to do dirty reboot.
880 // Since init might be wedged, don't try to write reboot reason into a persistent property.
881 PersistRebootReason("userspace_failed,watchdog_triggered,failed_to_boot", false);
882 RebootSystem(ANDROID_RB_RESTART2, "userspace_failed,watchdog_triggered,failed_to_boot");
883 }
884 LOG(INFO) << "Device booted, stopping userspace reboot watchdog";
885 }
886
HandleUserspaceReboot()887 static void HandleUserspaceReboot() {
888 if (!android::sysprop::InitProperties::is_userspace_reboot_supported().value_or(false)) {
889 LOG(ERROR) << "Attempted a userspace reboot on a device that doesn't support it";
890 return;
891 }
892 // Spinnig up a separate thread will fail the setns call later in the boot sequence.
893 // Fork a new process to monitor userspace reboot while we are investigating a better solution.
894 pid_t pid = fork();
895 if (pid < 0) {
896 PLOG(ERROR) << "Failed to fork process for userspace reboot watchdog. Switching to full "
897 << "reboot";
898 trigger_shutdown("reboot,userspace_failed,watchdog_fork");
899 return;
900 }
901 if (pid == 0) {
902 // Child
903 UserspaceRebootWatchdogThread();
904 _exit(EXIT_SUCCESS);
905 }
906 LOG(INFO) << "Clearing queue and starting userspace-reboot-requested trigger";
907 auto& am = ActionManager::GetInstance();
908 am.ClearQueue();
909 am.QueueEventTrigger("userspace-reboot-requested");
910 auto handler = [](const BuiltinArguments&) { return DoUserspaceReboot(); };
911 am.QueueBuiltinAction(handler, "userspace-reboot");
912 }
913
914 /**
915 * Check if "command" field is set in bootloader message.
916 *
917 * If "command" field is broken (contains non-printable characters prior to
918 * terminating zero), it will be zeroed.
919 *
920 * @param[in,out] boot Bootloader message (BCB) structure
921 * @return true if "command" field is already set, and false if it's empty
922 */
CommandIsPresent(bootloader_message * boot)923 static bool CommandIsPresent(bootloader_message* boot) {
924 if (boot->command[0] == '\0')
925 return false;
926
927 for (size_t i = 0; i < arraysize(boot->command); ++i) {
928 if (boot->command[i] == '\0')
929 return true;
930 if (!isprint(boot->command[i]))
931 break;
932 }
933
934 memset(boot->command, 0, sizeof(boot->command));
935 return false;
936 }
937
HandlePowerctlMessage(const std::string & command)938 void HandlePowerctlMessage(const std::string& command) {
939 unsigned int cmd = 0;
940 std::vector<std::string> cmd_params = Split(command, ",");
941 std::string reboot_target = "";
942 bool run_fsck = false;
943 bool command_invalid = false;
944 bool userspace_reboot = false;
945
946 if (cmd_params[0] == "shutdown") {
947 cmd = ANDROID_RB_POWEROFF;
948 if (cmd_params.size() >= 2) {
949 if (cmd_params[1] == "userrequested") {
950 // The shutdown reason is PowerManager.SHUTDOWN_USER_REQUESTED.
951 // Run fsck once the file system is remounted in read-only mode.
952 run_fsck = true;
953 } else if (cmd_params[1] == "thermal") {
954 // Turn off sources of heat immediately.
955 TurnOffBacklight();
956 // run_fsck is false to avoid delay
957 cmd = ANDROID_RB_THERMOFF;
958 }
959 }
960 } else if (cmd_params[0] == "reboot") {
961 cmd = ANDROID_RB_RESTART2;
962 if (cmd_params.size() >= 2) {
963 reboot_target = cmd_params[1];
964 if (reboot_target == "userspace") {
965 LOG(INFO) << "Userspace reboot requested";
966 userspace_reboot = true;
967 }
968 // adb reboot fastboot should boot into bootloader for devices not
969 // supporting logical partitions.
970 if (reboot_target == "fastboot" &&
971 !android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
972 reboot_target = "bootloader";
973 }
974 // When rebooting to the bootloader notify the bootloader writing
975 // also the BCB.
976 if (reboot_target == "bootloader") {
977 std::string err;
978 if (!write_reboot_bootloader(&err)) {
979 LOG(ERROR) << "reboot-bootloader: Error writing "
980 "bootloader_message: "
981 << err;
982 }
983 } else if (reboot_target == "recovery") {
984 bootloader_message boot = {};
985 if (std::string err; !read_bootloader_message(&boot, &err)) {
986 LOG(ERROR) << "Failed to read bootloader message: " << err;
987 }
988 // Update the boot command field if it's empty, and preserve
989 // the other arguments in the bootloader message.
990 if (!CommandIsPresent(&boot)) {
991 strlcpy(boot.command, "boot-recovery", sizeof(boot.command));
992 if (std::string err; !write_bootloader_message(boot, &err)) {
993 LOG(ERROR) << "Failed to set bootloader message: " << err;
994 return;
995 }
996 }
997 } else if (reboot_target == "sideload" || reboot_target == "sideload-auto-reboot" ||
998 reboot_target == "fastboot") {
999 std::string arg = reboot_target == "sideload-auto-reboot" ? "sideload_auto_reboot"
1000 : reboot_target;
1001 const std::vector<std::string> options = {
1002 "--" + arg,
1003 };
1004 std::string err;
1005 if (!write_bootloader_message(options, &err)) {
1006 LOG(ERROR) << "Failed to set bootloader message: " << err;
1007 return;
1008 }
1009 reboot_target = "recovery";
1010 }
1011
1012 // If there are additional parameter, pass them along
1013 for (size_t i = 2; (cmd_params.size() > i) && cmd_params[i].size(); ++i) {
1014 reboot_target += "," + cmd_params[i];
1015 }
1016 }
1017 } else {
1018 command_invalid = true;
1019 }
1020 if (command_invalid) {
1021 LOG(ERROR) << "powerctl: unrecognized command '" << command << "'";
1022 return;
1023 }
1024
1025 // We do not want to process any messages (queue'ing triggers, shutdown messages, control
1026 // messages, etc) from properties during reboot.
1027 StopSendingMessages();
1028
1029 if (userspace_reboot) {
1030 HandleUserspaceReboot();
1031 return;
1032 }
1033
1034 LOG(INFO) << "Clear action queue and start shutdown trigger";
1035 ActionManager::GetInstance().ClearQueue();
1036 // Queue shutdown trigger first
1037 ActionManager::GetInstance().QueueEventTrigger("shutdown");
1038 // Queue built-in shutdown_done
1039 auto shutdown_handler = [cmd, command, reboot_target, run_fsck](const BuiltinArguments&) {
1040 DoReboot(cmd, command, reboot_target, run_fsck);
1041 return Result<void>{};
1042 };
1043 ActionManager::GetInstance().QueueBuiltinAction(shutdown_handler, "shutdown_done");
1044
1045 EnterShutdown();
1046 }
1047
IsShuttingDown()1048 bool IsShuttingDown() {
1049 return shutting_down;
1050 }
1051
1052 } // namespace init
1053 } // namespace android
1054