1 //
2 // Copyright (C) 2015 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_GENERATOR_ANNOTATED_OPERATION_H_
18 #define UPDATE_ENGINE_PAYLOAD_GENERATOR_ANNOTATED_OPERATION_H_
19 
20 #include <ostream>  // NOLINT(readability/streams)
21 #include <string>
22 #include <vector>
23 
24 #include <brillo/secure_blob.h>
25 
26 #include "update_engine/payload_generator/blob_file_writer.h"
27 #include "update_engine/update_metadata.pb.h"
28 
29 namespace chromeos_update_engine {
30 
31 struct AnnotatedOperation {
32   // The name given to the operation, for logging and debugging purposes only.
33   // This normally includes the path to the file and the chunk used, if any.
34   std::string name;
35 
36   // The InstallOperation, as defined by the protobuf.
37   InstallOperation op;
38 
39   // Array of blocks which should be converted to XOR during OTA install.
40   // All elements in this array should have |merge_op.type() == COW_XOR|.
41   // This information is typically derived from BSDIFF patch data.
42   std::vector<CowMergeOperation> xor_ops;
43 
44   // Writes |blob| to the end of |blob_file|. It sets the data_offset and
45   // data_length in AnnotatedOperation to match the offset and size of |blob|
46   // in |blob_file|.
47   bool SetOperationBlob(const brillo::Blob& blob, BlobFileWriter* blob_file);
48 };
49 
50 // For logging purposes.
51 std::ostream& operator<<(std::ostream& os, const AnnotatedOperation& aop);
52 
53 }  // namespace chromeos_update_engine
54 
55 #endif  // UPDATE_ENGINE_PAYLOAD_GENERATOR_ANNOTATED_OPERATION_H_
56