full_update_generator.h revision aea4c1cea20dda7ae7e85fc8924a2d784f70d806 
1//
2// Copyright (C) 2010 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_FULL_UPDATE_GENERATOR_H_
18#define UPDATE_ENGINE_PAYLOAD_GENERATOR_FULL_UPDATE_GENERATOR_H_
19
20#include <string>
21#include <vector>
22
23#include <base/macros.h>
24
25#include "update_engine/payload_generator/blob_file_writer.h"
26#include "update_engine/payload_generator/operations_generator.h"
27#include "update_engine/payload_generator/payload_generation_config.h"
28
29namespace chromeos_update_engine {
30
31class FullUpdateGenerator : public OperationsGenerator {
32 public:
33  FullUpdateGenerator() = default;
34
35  // OperationsGenerator override.
36  // Creates a full update for the target image defined in |config|. |config|
37  // must be a valid payload generation configuration for a full payload.
38  // Populates |rootfs_ops| and |kernel_ops|, with data about the update
39  // operations, and writes relevant data to |data_file_fd|, updating
40  // |data_file_size| as it does.
41  bool GenerateOperations(
42      const PayloadGenerationConfig& config,
43      BlobFileWriter* blob_file,
44      std::vector<AnnotatedOperation>* rootfs_ops,
45      std::vector<AnnotatedOperation>* kernel_ops) override;
46
47  // Generates the list of operations to update inplace from the partition
48  // |old_part| to |new_part|. The |partition_size| should be at least
49  // |new_part.size| and any extra space there could be used as scratch space.
50  // The operations generated will not write more than |chunk_blocks| blocks.
51  // The new operations will create blobs in |data_file_fd| and update
52  // the file size pointed by |data_file_size| if needed.
53  // On success, stores the new operations in |aops| and returns true.
54  static bool GenerateOperationsForPartition(
55      const PartitionConfig& new_part,
56      size_t block_size,
57      size_t chunk_blocks,
58      BlobFileWriter* blob_file,
59      std::vector<AnnotatedOperation>* aops);
60
61 private:
62  DISALLOW_COPY_AND_ASSIGN(FullUpdateGenerator);
63};
64
65}  // namespace chromeos_update_engine
66
67#endif  // UPDATE_ENGINE_PAYLOAD_GENERATOR_FULL_UPDATE_GENERATOR_H_
68