1 // 2 // Copyright (C) 2020 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_VABC_PARTITION_WRITER_H_ 18 #define UPDATE_ENGINE_VABC_PARTITION_WRITER_H_ 19 20 #include <map> 21 #include <memory> 22 #include <string> 23 #include <vector> 24 25 #include <libsnapshot/cow_writer.h> 26 27 #include "update_engine/payload_consumer/extent_map.h" 28 #include "update_engine/payload_consumer/install_operation_executor.h" 29 #include "update_engine/payload_consumer/install_plan.h" 30 #include "update_engine/payload_consumer/partition_writer_interface.h" 31 #include "update_engine/payload_consumer/verified_source_fd.h" 32 #include "update_engine/payload_generator/extent_ranges.h" 33 34 namespace chromeos_update_engine { 35 class VABCPartitionWriter final : public PartitionWriterInterface { 36 public: 37 static bool ProcessSourceCopyOperation( 38 const InstallOperation& operation, 39 const size_t block_size, 40 const ExtentRanges& copy_blocks, 41 const FileDescriptorPtr& source_fd, 42 android::snapshot::ICowWriter* cow_writer, 43 bool sequence_op_supported); 44 45 VABCPartitionWriter(const PartitionUpdate& partition_update, 46 const InstallPlan::Partition& install_part, 47 DynamicPartitionControlInterface* dynamic_control, 48 size_t block_size); 49 [[nodiscard]] bool Init(const InstallPlan* install_plan, 50 bool source_may_exist, 51 size_t next_op_index) override; 52 ~VABCPartitionWriter() override; 53 54 // Only ZERO and SOURCE_COPY InstallOperations are treated special by VABC 55 // Partition Writer. These operations correspond to COW_ZERO and COW_COPY. All 56 // other operations just get converted to COW_REPLACE. 57 [[nodiscard]] bool PerformZeroOrDiscardOperation( 58 const InstallOperation& operation) override; 59 [[nodiscard]] bool PerformSourceCopyOperation( 60 const InstallOperation& operation, ErrorCode* error) override; 61 62 [[nodiscard]] bool PerformReplaceOperation(const InstallOperation& operation, 63 const void* data, 64 size_t count) override; 65 66 [[nodiscard]] bool PerformDiffOperation(const InstallOperation& operation, 67 ErrorCode* error, 68 const void* data, 69 size_t count) override; 70 71 void CheckpointUpdateProgress(size_t next_op_index) override; 72 73 [[nodiscard]] bool FinishedInstallOps() override; 74 int Close() override; 75 // Send merge sequence data to cow writer 76 static bool WriteMergeSequence( 77 const ::google::protobuf::RepeatedPtrField<CowMergeOperation>& merge_ops, 78 android::snapshot::ICowWriter* cow_writer); 79 80 private: 81 [[nodiscard]] bool DoesDeviceSupportsXor(); IsXorEnabled()82 bool IsXorEnabled() const noexcept { return xor_map_.size() > 0; } 83 [[nodiscard]] bool WriteAllCopyOps(); 84 std::unique_ptr<android::snapshot::ICowWriter> cow_writer_; 85 86 [[nodiscard]] std::unique_ptr<ExtentWriter> CreateBaseExtentWriter(); 87 88 const PartitionUpdate& partition_update_; 89 const InstallPlan::Partition& install_part_; 90 DynamicPartitionControlInterface* const dynamic_control_; 91 // Path to source partition 92 const std::string source_path_; 93 94 const size_t block_size_; 95 InstallOperationExecutor executor_; 96 VerifiedSourceFd verified_source_fd_; 97 ExtentMap<const CowMergeOperation*, ExtentLess> xor_map_; 98 ExtentRanges copy_blocks_; 99 }; 100 101 } // namespace chromeos_update_engine 102 103 #endif 104