1 //
2 // Copyright (C) 2021 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 #include <memory>
18
19 #include <unistd.h>
20
21 #include <android-base/file.h>
22 #include <gtest/gtest.h>
23 #include <libsnapshot/mock_snapshot_writer.h>
24
25 #include "common/utils.h"
26 #include "update_engine/payload_consumer/extent_map.h"
27 #include "update_engine/payload_consumer/file_descriptor.h"
28 #include "update_engine/payload_consumer/xor_extent_writer.h"
29 #include "update_engine/payload_generator/delta_diff_generator.h"
30 #include "update_engine/payload_generator/extent_ranges.h"
31 #include "update_engine/payload_generator/merge_sequence_generator.h"
32 #include "update_engine/update_metadata.pb.h"
33
34 namespace chromeos_update_engine {
35
36 using testing::_;
37 using testing::Args;
38 using testing::Return;
39
40 class XorExtentWriterTest : public ::testing::Test {
41 public:
42 static constexpr size_t NUM_BLOCKS = 50;
SetUp()43 void SetUp() override {
44 ASSERT_EQ(ftruncate64(source_part_.fd, kBlockSize * NUM_BLOCKS), 0);
45 ASSERT_EQ(ftruncate64(target_part_.fd, kBlockSize * NUM_BLOCKS), 0);
46
47 // Fill source part with 1s, as we are computing XOR between source and
48 // target data later.
49 ASSERT_EQ(lseek(source_part_.fd, 0, SEEK_SET), 0);
50 brillo::Blob buffer(kBlockSize);
51 std::fill(buffer.begin(), buffer.end(), 1);
52 for (size_t i = 0; i < NUM_BLOCKS; i++) {
53 ASSERT_EQ(write(source_part_.fd, buffer.data(), buffer.size()),
54 static_cast<ssize_t>(buffer.size()));
55 }
56 ASSERT_EQ(fsync(source_part_.fd), 0);
57 ASSERT_EQ(fsync(target_part_.fd), 0);
58 ASSERT_TRUE(source_fd_->Open(source_part_.path, O_RDONLY | O_CREAT, 0644));
59 }
60 InstallOperation op_;
61 FileDescriptorPtr source_fd_ = std::make_shared<EintrSafeFileDescriptor>();
62 ExtentMap<const CowMergeOperation*> xor_map_;
63 android::snapshot::MockSnapshotWriter cow_writer_;
64 TemporaryFile source_part_;
65 TemporaryFile target_part_;
66 };
67
68 MATCHER_P2(BytesEqual,
69 bytes,
70 size,
71 "Check if args match expected value byte for byte") {
72 return std::get<1>(arg) == size && std::get<0>(arg) != nullptr &&
73 memcmp(std::get<0>(arg), bytes, size) == 0;
74 }
75
TEST_F(XorExtentWriterTest,StreamTest)76 TEST_F(XorExtentWriterTest, StreamTest) {
77 constexpr auto COW_XOR = CowMergeOperation::COW_XOR;
78 ON_CALL(cow_writer_, EmitXorBlocks(_, _, _, _, _))
79 .WillByDefault(Return(true));
80 const auto op1 = CreateCowMergeOperation(
81 ExtentForRange(5, 2), ExtentForRange(5, 2), COW_XOR);
82 ASSERT_TRUE(xor_map_.AddExtent(op1.dst_extent(), &op1));
83 *op_.add_src_extents() = op1.src_extent();
84 *op_.add_dst_extents() = op1.dst_extent();
85
86 const auto op2 = CreateCowMergeOperation(
87 ExtentForRange(45, 2), ExtentForRange(456, 2), COW_XOR);
88 ASSERT_TRUE(xor_map_.AddExtent(op2.dst_extent(), &op2));
89 *op_.add_src_extents() = ExtentForRange(45, 3);
90 *op_.add_dst_extents() = ExtentForRange(455, 3);
91
92 const auto op3 = CreateCowMergeOperation(
93 ExtentForRange(12, 2), ExtentForRange(321, 2), COW_XOR, 777);
94 ASSERT_TRUE(xor_map_.AddExtent(op3.dst_extent(), &op3));
95 *op_.add_src_extents() = ExtentForRange(12, 4);
96 *op_.add_dst_extents() = ExtentForRange(320, 4);
97 XORExtentWriter writer_{
98 op_, source_fd_, &cow_writer_, xor_map_, NUM_BLOCKS * kBlockSize};
99
100 // OTA op:
101 // [5-6] => [5-6], [45-47] => [455-457], [12-15] => [320-323]
102
103 // merge op:
104 // [5-6] => [5-6], [45-46] => [456-457], [12-13] => [321-322]
105
106 // Expected result:
107 // [5-7], [45-47], [12-14] should be XOR blocks
108 // [320], [323], [455] should be regular replace blocks
109
110 auto zeros = utils::GetReadonlyZeroBlock(kBlockSize * 10);
111 EXPECT_CALL(cow_writer_,
112 EmitRawBlocks(455, zeros->data() + 2 * kBlockSize, kBlockSize))
113 .With(Args<1, 2>(BytesEqual(zeros->data(), kBlockSize)))
114 .WillOnce(Return(true));
115 EXPECT_CALL(cow_writer_,
116 EmitRawBlocks(320, zeros->data() + 5 * kBlockSize, kBlockSize))
117 .With(Args<1, 2>(BytesEqual(zeros->data(), kBlockSize)))
118 .WillOnce(Return(true));
119 EXPECT_CALL(cow_writer_,
120 EmitRawBlocks(323, zeros->data() + 8 * kBlockSize, kBlockSize))
121 .With(Args<1, 2>(BytesEqual(zeros->data(), kBlockSize)))
122 .WillOnce(Return(true));
123
124 EXPECT_CALL(cow_writer_, EmitXorBlocks(5, _, kBlockSize * 2, 5, 0))
125 .WillOnce(Return(true));
126 EXPECT_CALL(cow_writer_, EmitXorBlocks(456, _, kBlockSize * 2, 45, 0))
127 .WillOnce(Return(true));
128 EXPECT_CALL(cow_writer_, EmitXorBlocks(321, _, kBlockSize * 2, 12, 777))
129 .WillOnce(Return(true));
130
131 ASSERT_TRUE(writer_.Init(op_.dst_extents(), kBlockSize));
132 ASSERT_TRUE(writer_.Write(zeros->data(), 9 * kBlockSize));
133 }
134
TEST_F(XorExtentWriterTest,SubsetExtentTest)135 TEST_F(XorExtentWriterTest, SubsetExtentTest) {
136 constexpr auto COW_XOR = CowMergeOperation::COW_XOR;
137 ON_CALL(cow_writer_, EmitXorBlocks(_, _, _, _, _))
138 .WillByDefault(Return(true));
139
140 const auto op3 = CreateCowMergeOperation(
141 ExtentForRange(12, 4), ExtentForRange(320, 4), COW_XOR, 777);
142 ASSERT_TRUE(xor_map_.AddExtent(op3.dst_extent(), &op3));
143
144 *op_.add_src_extents() = ExtentForRange(12, 3);
145 *op_.add_dst_extents() = ExtentForRange(320, 3);
146 *op_.add_src_extents() = ExtentForRange(20, 3);
147 *op_.add_dst_extents() = ExtentForRange(420, 3);
148 *op_.add_src_extents() = ExtentForRange(15, 1);
149 *op_.add_dst_extents() = ExtentForRange(323, 1);
150 XORExtentWriter writer_{
151 op_, source_fd_, &cow_writer_, xor_map_, NUM_BLOCKS * kBlockSize};
152
153 // OTA op:
154 // [12-14] => [320-322], [20-22] => [420-422], [15-16] => [323-324]
155
156 // merge op:
157 // [12-16] => [321-322]
158
159 // Expected result:
160 // [12-16] should be XOR blocks
161 // [420-422] should be regular replace blocks
162
163 auto zeros = utils::GetReadonlyZeroBlock(kBlockSize * 7);
164 EXPECT_CALL(
165 cow_writer_,
166 EmitRawBlocks(420, zeros->data() + 3 * kBlockSize, kBlockSize * 3))
167 .WillOnce(Return(true));
168
169 EXPECT_CALL(cow_writer_, EmitXorBlocks(320, _, kBlockSize * 3, 12, 777))
170 .WillOnce(Return(true));
171 EXPECT_CALL(cow_writer_, EmitXorBlocks(323, _, kBlockSize, 15, 777))
172 .WillOnce(Return(true));
173
174 ASSERT_TRUE(writer_.Init(op_.dst_extents(), kBlockSize));
175 ASSERT_TRUE(writer_.Write(zeros->data(), zeros->size()));
176 }
177
TEST_F(XorExtentWriterTest,LastBlockTest)178 TEST_F(XorExtentWriterTest, LastBlockTest) {
179 constexpr auto COW_XOR = CowMergeOperation::COW_XOR;
180 ON_CALL(cow_writer_, EmitXorBlocks(_, _, _, _, _))
181 .WillByDefault(Return(true));
182
183 const auto op3 = CreateCowMergeOperation(
184 ExtentForRange(NUM_BLOCKS - 1, 1), ExtentForRange(2, 1), COW_XOR, 777);
185 ASSERT_TRUE(xor_map_.AddExtent(op3.dst_extent(), &op3));
186
187 *op_.add_src_extents() = ExtentForRange(12, 3);
188 *op_.add_dst_extents() = ExtentForRange(320, 3);
189
190 *op_.add_src_extents() = ExtentForRange(20, 3);
191 *op_.add_dst_extents() = ExtentForRange(420, 3);
192
193 *op_.add_src_extents() = ExtentForRange(NUM_BLOCKS - 3, 3);
194 *op_.add_dst_extents() = ExtentForRange(2, 3);
195 XORExtentWriter writer_{
196 op_, source_fd_, &cow_writer_, xor_map_, NUM_BLOCKS * kBlockSize};
197
198 // OTA op:
199 // [12-14] => [320-322], [20-22] => [420-422], [NUM_BLOCKS-3] => [2-5]
200
201 // merge op:
202 // [NUM_BLOCKS-1] => [2-3]
203
204 // Expected result:
205 // [12-16] should be REPLACE blocks
206 // [420-422] should be REPLACE blocks
207 // [2-4] should be REPLACE blocks
208
209 auto zeros = utils::GetReadonlyZeroBlock(kBlockSize * 9);
210 EXPECT_CALL(cow_writer_, EmitRawBlocks(320, zeros->data(), kBlockSize * 3))
211 .WillOnce(Return(true));
212 EXPECT_CALL(
213 cow_writer_,
214 EmitRawBlocks(420, zeros->data() + 3 * kBlockSize, kBlockSize * 3))
215 .WillOnce(Return(true));
216
217 EXPECT_CALL(cow_writer_,
218 EmitRawBlocks(2, zeros->data() + 6 * kBlockSize, kBlockSize))
219 .WillOnce(Return(true));
220 EXPECT_CALL(cow_writer_,
221 EmitRawBlocks(3, zeros->data() + 7 * kBlockSize, kBlockSize * 2))
222 .WillOnce(Return(true));
223
224 ASSERT_TRUE(writer_.Init(op_.dst_extents(), kBlockSize));
225 ASSERT_TRUE(writer_.Write(zeros->data(), zeros->size()));
226 }
227
228 } // namespace chromeos_update_engine
229