/* * Copyright (C) 2016 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include #include #include #include using android::sp; using android::hardware::hidl_string; using android::hardware::Return; using android::hardware::boot::V1_0::BoolResult; using android::hardware::boot::V1_0::CommandResult; using android::hardware::boot::V1_0::Slot; using android::hardware::boot::V1_1::IBootControl; using android::hardware::boot::V1_1::MergeStatus; namespace V1_0 = android::hardware::boot::V1_0; namespace V1_1 = android::hardware::boot::V1_1; namespace V1_2 = android::hardware::boot::V1_2; enum BootCtlVersion { BOOTCTL_V1_0, BOOTCTL_V1_1, BOOTCTL_V1_2 }; static void usage(FILE* where, BootCtlVersion bootVersion, int /* argc */, char* argv[]) { fprintf(where, "%s - command-line wrapper for the boot HAL.\n" "\n" "Usage:\n" " %s COMMAND\n" "\n" "Commands:\n" " hal-info - Show info about boot_control HAL used.\n" " get-number-slots - Prints number of slots.\n" " get-current-slot - Prints currently running SLOT.\n" " mark-boot-successful - Mark current slot as GOOD.\n" " get-active-boot-slot - Prints the SLOT to load on next boot.\n" " set-active-boot-slot SLOT - On next boot, load and execute SLOT.\n" " set-slot-as-unbootable SLOT - Mark SLOT as invalid.\n" " is-slot-bootable SLOT - Returns 0 only if SLOT is bootable.\n" " is-slot-marked-successful SLOT - Returns 0 only if SLOT is marked GOOD.\n" " get-suffix SLOT - Prints suffix for SLOT.\n", argv[0], argv[0]); if (bootVersion >= BOOTCTL_V1_1) { fprintf(where, " set-snapshot-merge-status STAT - Sets whether a snapshot-merge of any dynamic\n" " partition is in progress. Valid STAT values\n" " are: none, unknown, snapshotted, merging,\n" " or cancelled.\n" " get-snapshot-merge-status - Prints the current snapshot-merge status.\n"); } fprintf(where, "\n" "SLOT parameter is the zero-based slot-number.\n"); } static int do_hal_info(const sp module) { module->interfaceDescriptor([&](const auto& descriptor) { fprintf(stdout, "HAL Version: %s\n", descriptor.c_str()); }); return EX_OK; } static int do_get_number_slots(sp module) { uint32_t numSlots = module->getNumberSlots(); fprintf(stdout, "%u\n", numSlots); return EX_OK; } static int do_get_current_slot(sp module) { Slot curSlot = module->getCurrentSlot(); fprintf(stdout, "%u\n", curSlot); return EX_OK; } static std::function generate_callback(CommandResult* crp) { return [=](CommandResult cr) { *crp = cr; }; } static int handle_return(const Return& ret, CommandResult cr, const char* errStr) { if (!ret.isOk()) { fprintf(stderr, errStr, ret.description().c_str()); return EX_SOFTWARE; } else if (!cr.success) { fprintf(stderr, errStr, cr.errMsg.c_str()); return EX_SOFTWARE; } return EX_OK; } static int do_mark_boot_successful(sp module) { CommandResult cr; Return ret = module->markBootSuccessful(generate_callback(&cr)); return handle_return(ret, cr, "Error marking as having booted successfully: %s\n"); } static int do_get_active_boot_slot(sp module) { uint32_t slot = module->getActiveBootSlot(); fprintf(stdout, "%u\n", slot); return EX_OK; } static int do_set_active_boot_slot(sp module, Slot slot_number) { CommandResult cr; Return ret = module->setActiveBootSlot(slot_number, generate_callback(&cr)); return handle_return(ret, cr, "Error setting active boot slot: %s\n"); } static int do_set_slot_as_unbootable(sp module, Slot slot_number) { CommandResult cr; Return ret = module->setSlotAsUnbootable(slot_number, generate_callback(&cr)); return handle_return(ret, cr, "Error setting slot as unbootable: %s\n"); } static int handle_return(const Return& ret, const char* errStr) { if (!ret.isOk()) { fprintf(stderr, errStr, ret.description().c_str()); return EX_SOFTWARE; } else if (ret == BoolResult::INVALID_SLOT) { fprintf(stderr, errStr, "Invalid slot"); return EX_SOFTWARE; } else if (ret == BoolResult::TRUE) { return EX_OK; } return EX_SOFTWARE; } static int do_is_slot_bootable(sp module, Slot slot_number) { Return ret = module->isSlotBootable(slot_number); return handle_return(ret, "Error calling isSlotBootable(): %s\n"); } static int do_is_slot_marked_successful(sp module, Slot slot_number) { Return ret = module->isSlotMarkedSuccessful(slot_number); return handle_return(ret, "Error calling isSlotMarkedSuccessful(): %s\n"); } std::optional stringToMergeStatus(const std::string& status) { if (status == "cancelled") return MergeStatus::CANCELLED; if (status == "merging") return MergeStatus::MERGING; if (status == "none") return MergeStatus::NONE; if (status == "snapshotted") return MergeStatus::SNAPSHOTTED; if (status == "unknown") return MergeStatus::UNKNOWN; return {}; } static int do_set_snapshot_merge_status(sp module, BootCtlVersion bootVersion, int argc, char* argv[]) { if (argc != 3) { usage(stderr, bootVersion, argc, argv); exit(EX_USAGE); return -1; } auto status = stringToMergeStatus(argv[2]); if (!status.has_value()) { usage(stderr, bootVersion, argc, argv); exit(EX_USAGE); return -1; } if (!module->setSnapshotMergeStatus(status.value())) { return EX_SOFTWARE; } return EX_OK; } std::ostream& operator<<(std::ostream& os, MergeStatus state) { switch (state) { case MergeStatus::CANCELLED: return os << "cancelled"; case MergeStatus::MERGING: return os << "merging"; case MergeStatus::NONE: return os << "none"; case MergeStatus::SNAPSHOTTED: return os << "snapshotted"; case MergeStatus::UNKNOWN: return os << "unknown"; default: return os; } } static int do_get_snapshot_merge_status(sp module) { MergeStatus ret = module->getSnapshotMergeStatus(); std::stringstream ss; ss << ret; fprintf(stdout, "%s\n", ss.str().c_str()); return EX_OK; } static int do_get_suffix(sp module, Slot slot_number) { std::function cb = [](hidl_string suffix) { fprintf(stdout, "%s\n", suffix.c_str()); }; Return ret = module->getSuffix(slot_number, cb); if (!ret.isOk()) { fprintf(stderr, "Error calling getSuffix(): %s\n", ret.description().c_str()); return EX_SOFTWARE; } return EX_OK; } static uint32_t parse_slot(BootCtlVersion bootVersion, int pos, int argc, char* argv[]) { if (pos > argc - 1) { usage(stderr, bootVersion, argc, argv); exit(EX_USAGE); return -1; } errno = 0; uint64_t ret = strtoul(argv[pos], NULL, 10); if (errno != 0 || ret > UINT_MAX) { usage(stderr, bootVersion, argc, argv); exit(EX_USAGE); return -1; } return (uint32_t)ret; } int main(int argc, char* argv[]) { sp v1_0_module; sp v1_1_module; sp v1_2_module; BootCtlVersion bootVersion = BOOTCTL_V1_0; v1_0_module = V1_0::IBootControl::getService(); if (v1_0_module == nullptr) { fprintf(stderr, "Error getting bootctrl v1.0 module.\n"); return EX_SOFTWARE; } v1_1_module = V1_1::IBootControl::castFrom(v1_0_module); if (v1_1_module != nullptr) { bootVersion = BOOTCTL_V1_1; } v1_2_module = V1_2::IBootControl::castFrom(v1_0_module); if (v1_2_module != nullptr) { bootVersion = BOOTCTL_V1_2; } if (argc < 2) { usage(stderr, bootVersion, argc, argv); return EX_USAGE; } // Functions present from version 1.0 if (strcmp(argv[1], "hal-info") == 0) { return do_hal_info(v1_0_module); } else if (strcmp(argv[1], "get-number-slots") == 0) { return do_get_number_slots(v1_0_module); } else if (strcmp(argv[1], "get-current-slot") == 0) { return do_get_current_slot(v1_0_module); } else if (strcmp(argv[1], "mark-boot-successful") == 0) { return do_mark_boot_successful(v1_0_module); } else if (strcmp(argv[1], "set-active-boot-slot") == 0) { return do_set_active_boot_slot(v1_0_module, parse_slot(bootVersion, 2, argc, argv)); } else if (strcmp(argv[1], "set-slot-as-unbootable") == 0) { return do_set_slot_as_unbootable(v1_0_module, parse_slot(bootVersion, 2, argc, argv)); } else if (strcmp(argv[1], "is-slot-bootable") == 0) { return do_is_slot_bootable(v1_0_module, parse_slot(bootVersion, 2, argc, argv)); } else if (strcmp(argv[1], "is-slot-marked-successful") == 0) { return do_is_slot_marked_successful(v1_0_module, parse_slot(bootVersion, 2, argc, argv)); } else if (strcmp(argv[1], "get-suffix") == 0) { return do_get_suffix(v1_0_module, parse_slot(bootVersion, 2, argc, argv)); } // Functions present from version 1.1 if (strcmp(argv[1], "set-snapshot-merge-status") == 0 || strcmp(argv[1], "get-snapshot-merge-status") == 0) { if (v1_1_module == nullptr) { fprintf(stderr, "Error getting bootctrl v1.1 module.\n"); return EX_SOFTWARE; } if (strcmp(argv[1], "set-snapshot-merge-status") == 0) { return do_set_snapshot_merge_status(v1_1_module, bootVersion, argc, argv); } else if (strcmp(argv[1], "get-snapshot-merge-status") == 0) { return do_get_snapshot_merge_status(v1_1_module); } } if (strcmp(argv[1], "get-active-boot-slot") == 0) { if (v1_2_module == nullptr) { fprintf(stderr, "Error getting bootctrl v1.2 module.\n"); return EX_SOFTWARE; } return do_get_active_boot_slot(v1_2_module); } // Parameter not matched, print usage usage(stderr, bootVersion, argc, argv); return EX_USAGE; }