xref: /aosp_15_r20/system/update_engine/payload_consumer/extent_writer.h (revision 5a9231315b4521097b8dc3750bc806fcafe0c72f)
1 //
2 // Copyright (C) 2009 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_EXTENT_WRITER_H_
18 #define UPDATE_ENGINE_PAYLOAD_CONSUMER_EXTENT_WRITER_H_
19 
20 #include <memory>
21 #include <utility>
22 
23 #include <base/logging.h>
24 #include <brillo/secure_blob.h>
25 
26 #include "update_engine/payload_consumer/file_descriptor.h"
27 #include "update_engine/update_metadata.pb.h"
28 
29 // ExtentWriter is an abstract class which synchronously writes to a given
30 // file descriptor at the extents given.
31 
32 namespace chromeos_update_engine {
33 
34 class ExtentWriter {
35  public:
36   ExtentWriter() = default;
37   virtual ~ExtentWriter() = default;
38 
39   // Returns true on success.
40   virtual bool Init(const google::protobuf::RepeatedPtrField<Extent>& extents,
41                     uint32_t block_size) = 0;
42 
43   // Returns true on success.
44   virtual bool Write(const void* bytes, size_t count) = 0;
45 };
46 
47 // DirectExtentWriter is probably the simplest ExtentWriter implementation.
48 // It writes the data directly into the extents.
49 
50 class DirectExtentWriter : public ExtentWriter {
51  public:
DirectExtentWriter(FileDescriptorPtr fd)52   explicit DirectExtentWriter(FileDescriptorPtr fd) : fd_(fd) {}
53   ~DirectExtentWriter() override = default;
54 
Init(const google::protobuf::RepeatedPtrField<Extent> & extents,uint32_t block_size)55   bool Init(const google::protobuf::RepeatedPtrField<Extent>& extents,
56             uint32_t block_size) override {
57     block_size_ = block_size;
58     extents_ = extents;
59     cur_extent_ = extents_.begin();
60     return true;
61   }
62   bool Write(const void* bytes, size_t count) override;
63 
64  private:
65   FileDescriptorPtr fd_{nullptr};
66 
67   size_t block_size_{0};
68   // Bytes written into |cur_extent_| thus far.
69   uint64_t extent_bytes_written_{0};
70   google::protobuf::RepeatedPtrField<Extent> extents_;
71   // The next call to write should correspond to |cur_extents_|.
72   google::protobuf::RepeatedPtrField<Extent>::iterator cur_extent_;
73 };
74 
75 }  // namespace chromeos_update_engine
76 
77 #endif  // UPDATE_ENGINE_PAYLOAD_CONSUMER_EXTENT_WRITER_H_
78