boot_control_android.h

//
// Copyright (C) 2015 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.
//

#ifndef UPDATE_ENGINE_BOOT_CONTROL_ANDROID_H_
#define UPDATE_ENGINE_BOOT_CONTROL_ANDROID_H_

#include <map>
#include <memory>
#include <string>

#include <android/hardware/boot/1.0/IBootControl.h>
#include <base/files/file_util.h>
#include <liblp/builder.h>

#include "update_engine/common/boot_control.h"
#include "update_engine/dynamic_partition_control_interface.h"

namespace chromeos_update_engine {

// The Android implementation of the BootControlInterface. This implementation
// uses the libhardware's boot_control HAL to access the bootloader.
class BootControlAndroid : public BootControlInterface {
 public:
  BootControlAndroid() = default;
  ~BootControlAndroid() = default;

  // Load boot_control HAL implementation using libhardware and
  // initializes it. Returns false if an error occurred.
  bool Init();

  // BootControlInterface overrides.
  unsigned int GetNumSlots() const override;
  BootControlInterface::Slot GetCurrentSlot() const override;
  bool GetPartitionDevice(const std::string& partition_name,
                          BootControlInterface::Slot slot,
                          std::string* device) const override;
  bool IsSlotBootable(BootControlInterface::Slot slot) const override;
  bool MarkSlotUnbootable(BootControlInterface::Slot slot) override;
  bool SetActiveBootSlot(BootControlInterface::Slot slot) override;
  bool MarkBootSuccessfulAsync(base::Callback<void(bool)> callback) override;
  bool InitPartitionMetadata(Slot slot,
                             const PartitionMetadata& partition_metadata,
                             bool update_metadata) override;
  void Cleanup() override;

 private:
  ::android::sp<::android::hardware::boot::V1_0::IBootControl> module_;
  std::unique_ptr<DynamicPartitionControlInterface> dynamic_control_;

  friend class BootControlAndroidTest;

  // Wrapper method of IBootControl::getSuffix().
  bool GetSuffix(Slot slot, std::string* out) const;

  enum class DynamicPartitionDeviceStatus {
    SUCCESS,
    ERROR,
    TRY_STATIC,
  };

  DynamicPartitionDeviceStatus GetDynamicPartitionDevice(
      const base::FilePath& device_dir,
      const std::string& partition_name_suffix,
      Slot slot,
      std::string* device) const;

  // Return true if |partition_name_suffix| is a block device of
  // super partition metadata slot |slot|.
  bool IsSuperBlockDevice(const base::FilePath& device_dir,
                          Slot slot,
                          const std::string& partition_name_suffix) const;

  // Whether the target partitions should be loaded as dynamic partitions. Set
  // by InitPartitionMetadata() per each update.
  bool is_target_dynamic_{false};

  DISALLOW_COPY_AND_ASSIGN(BootControlAndroid);
};

}  // namespace chromeos_update_engine

#endif  // UPDATE_ENGINE_BOOT_CONTROL_ANDROID_H_