1 // 2 // Copyright (C) 2015 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 #ifndef UPDATE_ENGINE_CROS_BOOT_CONTROL_CHROMEOS_H_ 18 #define UPDATE_ENGINE_CROS_BOOT_CONTROL_CHROMEOS_H_ 19 20 #include <memory> 21 #include <string> 22 23 #include <base/callback.h> 24 #include <gtest/gtest_prod.h> // for FRIEND_TEST 25 26 #include "update_engine/common/boot_control_interface.h" 27 #include "update_engine/common/dynamic_partition_control_interface.h" 28 29 namespace chromeos_update_engine { 30 31 // The Chrome OS implementation of the BootControlInterface. This interface 32 // assumes the partition names and numbers used in Chrome OS devices. 33 class BootControlChromeOS : public BootControlInterface { 34 public: 35 BootControlChromeOS() = default; 36 ~BootControlChromeOS() = default; 37 38 // Initialize the BootControl instance loading the constant values. Returns 39 // whether the operation succeeded. In case of failure, normally meaning 40 // some critical failure such as we couldn't determine the slot that we 41 // booted from, the implementation will pretend that there's only one slot and 42 // therefore A/B updates are disabled. 43 bool Init(); 44 45 // BootControlInterface overrides. 46 unsigned int GetNumSlots() const override; 47 BootControlInterface::Slot GetCurrentSlot() const override; 48 bool GetPartitionDevice(const std::string& partition_name, 49 BootControlInterface::Slot slot, 50 bool not_in_payload, 51 std::string* device, 52 bool* is_dynamic) const override; 53 bool GetPartitionDevice(const std::string& partition_name, 54 BootControlInterface::Slot slot, 55 std::string* device) const override; 56 bool IsSlotBootable(BootControlInterface::Slot slot) const override; 57 bool MarkSlotUnbootable(BootControlInterface::Slot slot) override; 58 bool SetActiveBootSlot(BootControlInterface::Slot slot) override; 59 bool MarkBootSuccessfulAsync(base::Callback<void(bool)> callback) override; 60 bool IsSlotMarkedSuccessful(BootControlInterface::Slot slot) const override; 61 DynamicPartitionControlInterface* GetDynamicPartitionControl() override; 62 63 private: 64 friend class BootControlChromeOSTest; 65 FRIEND_TEST(BootControlChromeOSTest, SysfsBlockDeviceTest); 66 FRIEND_TEST(BootControlChromeOSTest, GetPartitionNumberTest); 67 FRIEND_TEST(BootControlChromeOSTest, ParseDlcPartitionNameTest); 68 69 // Returns the sysfs block device for a root block device. For example, 70 // SysfsBlockDevice("/dev/sda") returns "/sys/block/sda". Returns an empty 71 // string if the input device is not of the "/dev/xyz" form. 72 static std::string SysfsBlockDevice(const std::string& device); 73 74 // Returns true if the root |device| (e.g., "/dev/sdb") is known to be 75 // removable, false otherwise. 76 static bool IsRemovableDevice(const std::string& device); 77 78 // Return the hard-coded partition number used in Chrome OS for the passed 79 // |partition_name| and |slot|. In case of invalid data, returns -1. 80 int GetPartitionNumber(const std::string partition_name, 81 BootControlInterface::Slot slot) const; 82 83 // Extracts DLC module ID and package ID from partition name. The structure of 84 // the partition name is dlc/<dlc-id>/<dlc-package>. For example: 85 // dlc/fake-dlc/fake-package 86 bool ParseDlcPartitionName(const std::string partition_name, 87 std::string* dlc_id, 88 std::string* dlc_package) const; 89 90 // Cached values for GetNumSlots() and GetCurrentSlot(). 91 BootControlInterface::Slot num_slots_{1}; 92 BootControlInterface::Slot current_slot_{BootControlInterface::kInvalidSlot}; 93 94 // The block device of the disk we booted from, without the partition number. 95 std::string boot_disk_name_; 96 97 std::unique_ptr<DynamicPartitionControlInterface> dynamic_partition_control_; 98 99 DISALLOW_COPY_AND_ASSIGN(BootControlChromeOS); 100 }; 101 102 } // namespace chromeos_update_engine 103 104 #endif // UPDATE_ENGINE_CROS_BOOT_CONTROL_CHROMEOS_H_ 105