1 // 2 // Copyright (C) 2018 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_PAYLOAD_CONSUMER_VERITY_WRITER_INTERFACE_H_ 18 #define UPDATE_ENGINE_PAYLOAD_CONSUMER_VERITY_WRITER_INTERFACE_H_ 19 20 #include <cstdint> 21 #include <memory> 22 23 #include <android-base/macros.h> 24 25 #include "common/utils.h" 26 #include "payload_consumer/file_descriptor.h" 27 #include "update_engine/payload_consumer/install_plan.h" 28 29 namespace chromeos_update_engine { 30 31 class VerityWriterInterface { 32 public: 33 virtual ~VerityWriterInterface() = default; 34 35 virtual bool Init(const InstallPlan::Partition& partition) = 0; 36 // Update partition data at [offset : offset + size) stored in |buffer|. 37 // Data not in |hash_tree_data_extent| or |fec_data_extent| is ignored. 38 // Will write verity data to the target partition once all the necessary 39 // blocks has passed. 40 virtual bool Update(uint64_t offset, const uint8_t* buffer, size_t size) = 0; 41 42 // Deprecated function -> use IncrementalFinalize to allow verity writes to be 43 // interrupted. left for backwards compatibility Finalize(FileDescriptor * read_fd,FileDescriptor * write_fd)44 virtual bool Finalize(FileDescriptor* read_fd, FileDescriptor* write_fd) { 45 while (!FECFinished()) { 46 TEST_AND_RETURN_FALSE(IncrementalFinalize(read_fd, write_fd)); 47 } 48 return true; 49 } 50 51 // Write hash tree && FEC data to underlying fd, if they are present 52 virtual bool IncrementalFinalize(FileDescriptor* read_fd, 53 FileDescriptor* write_fd) = 0; 54 55 // Returns true once FEC data is finished writing 56 virtual bool FECFinished() const = 0; 57 58 // Gets progress report on FEC write 59 virtual double GetProgress() = 0; 60 61 protected: 62 VerityWriterInterface() = default; 63 64 private: 65 DISALLOW_COPY_AND_ASSIGN(VerityWriterInterface); 66 }; 67 68 namespace verity_writer { 69 std::unique_ptr<VerityWriterInterface> CreateVerityWriter(); 70 } 71 72 } // namespace chromeos_update_engine 73 74 #endif // UPDATE_ENGINE_PAYLOAD_CONSUMER_VERITY_WRITER_INTERFACE_H_ 75