Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 1 | // Copyright (c) 2010 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_DELTA_PERFORMER_H__ |
| 6 | #define CHROMEOS_PLATFORM_UPDATE_ENGINE_DELTA_PERFORMER_H__ |
| 7 | |
| 8 | #include <inttypes.h> |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 9 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 10 | #include <vector> |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 11 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 12 | #include <google/protobuf/repeated_field.h> |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 13 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 14 | #include "update_engine/file_writer.h" |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 15 | #include "update_engine/omaha_hash_calculator.h" |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 16 | #include "update_engine/update_metadata.pb.h" |
| 17 | |
| 18 | namespace chromeos_update_engine { |
| 19 | |
Darin Petkov | 73058b4 | 2010-10-06 16:32:19 -0700 | [diff] [blame] | 20 | class PrefsInterface; |
| 21 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 22 | // This class performs the actions in a delta update synchronously. The delta |
| 23 | // update itself should be passed in in chunks as it is received. |
| 24 | |
| 25 | class DeltaPerformer : public FileWriter { |
| 26 | public: |
Darin Petkov | 73058b4 | 2010-10-06 16:32:19 -0700 | [diff] [blame] | 27 | DeltaPerformer(PrefsInterface* prefs) |
| 28 | : prefs_(prefs), |
| 29 | fd_(-1), |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 30 | kernel_fd_(-1), |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 31 | manifest_valid_(false), |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 32 | next_operation_num_(0), |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 33 | buffer_offset_(0), |
Darin Petkov | 0406e40 | 2010-10-06 21:33:11 -0700 | [diff] [blame^] | 34 | last_updated_buffer_offset_(kuint64max), |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 35 | block_size_(0) {} |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 36 | |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 37 | // Opens the kernel. Should be called before or after Open(), but before |
| 38 | // Write(). The kernel file will be close()d when Close() is called. |
| 39 | bool OpenKernel(const char* kernel_path); |
| 40 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 41 | // flags and mode ignored. Once Close()d, a DeltaPerformer can't be |
| 42 | // Open()ed again. |
| 43 | int Open(const char* path, int flags, mode_t mode); |
| 44 | |
| 45 | // Wrapper around write. Returns bytes written on success or |
| 46 | // -errno on error. |
Andrew de los Reyes | 0cca421 | 2010-04-29 14:00:58 -0700 | [diff] [blame] | 47 | ssize_t Write(const void* bytes, size_t count); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 48 | |
| 49 | // Wrapper around close. Returns 0 on success or -errno on error. |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 50 | // Closes both 'path' given to Open() and the kernel path. |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 51 | int Close(); |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 52 | |
| 53 | // Verifies the downloaded payload against the signed hash included in the |
| 54 | // payload and returns true on success, false on failure. This method should |
| 55 | // be called after closing the stream. Note this method returns true if the |
| 56 | // public key is unavailable; it returns false if the public key is available |
| 57 | // but the delta payload doesn't include a signature. If |public_key_path| is |
| 58 | // an empty string, uses the default public key path. |
| 59 | bool VerifyPayload(const std::string& public_key_path); |
| 60 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 61 | // Converts an ordered collection of Extent objects which contain data of |
| 62 | // length full_length to a comma-separated string. For each Extent, the |
| 63 | // string will have the start offset and then the length in bytes. |
| 64 | // The length value of the last extent in the string may be short, since |
| 65 | // the full length of all extents in the string is capped to full_length. |
| 66 | // Also, an extent starting at kSparseHole, appears as -1 in the string. |
| 67 | // For example, if the Extents are {1, 1}, {4, 2}, {kSparseHole, 1}, |
| 68 | // {0, 1}, block_size is 4096, and full_length is 5 * block_size - 13, |
| 69 | // the resulting string will be: "4096:4096,16384:8192,-1:4096,0:4083" |
| 70 | static bool ExtentsToBsdiffPositionsString( |
| 71 | const google::protobuf::RepeatedPtrField<Extent>& extents, |
| 72 | uint64_t block_size, |
| 73 | uint64_t full_length, |
| 74 | std::string* positions_string); |
| 75 | |
Darin Petkov | 0406e40 | 2010-10-06 21:33:11 -0700 | [diff] [blame^] | 76 | // Returns true if a previous update attempt can be continued based on the |
| 77 | // persistent preferences and the new update check response hash. |
| 78 | static bool CanResumeUpdate(PrefsInterface* prefs, |
| 79 | std::string update_check_response_hash); |
| 80 | |
| 81 | // Resets the persistent update progress state to indicate that an update |
| 82 | // can't be resumed. Returns true on success, false otherwise. |
| 83 | static bool ResetUpdateProgress(PrefsInterface* prefs); |
| 84 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 85 | private: |
| 86 | // Returns true if enough of the delta file has been passed via Write() |
| 87 | // to be able to perform a given install operation. |
| 88 | bool CanPerformInstallOperation( |
| 89 | const DeltaArchiveManifest_InstallOperation& operation); |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 90 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 91 | // Returns true on success. |
| 92 | bool PerformInstallOperation( |
| 93 | const DeltaArchiveManifest_InstallOperation& operation); |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 94 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 95 | // These perform a specific type of operation and return true on success. |
| 96 | bool PerformReplaceOperation( |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 97 | const DeltaArchiveManifest_InstallOperation& operation, |
| 98 | bool is_kernel_partition); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 99 | bool PerformMoveOperation( |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 100 | const DeltaArchiveManifest_InstallOperation& operation, |
| 101 | bool is_kernel_partition); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 102 | bool PerformBsdiffOperation( |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 103 | const DeltaArchiveManifest_InstallOperation& operation, |
| 104 | bool is_kernel_partition); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 105 | |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 106 | // Returns true if the payload signature message has been extracted from |
| 107 | // |operation|, false otherwise. |
| 108 | bool ExtractSignatureMessage( |
| 109 | const DeltaArchiveManifest_InstallOperation& operation); |
| 110 | |
| 111 | // Discard |count| bytes from the beginning of buffer_. If |do_hash| is true, |
| 112 | // updates the hash calculator with these bytes before discarding them. |
| 113 | void DiscardBufferHeadBytes(size_t count, bool do_hash); |
| 114 | |
Darin Petkov | 0406e40 | 2010-10-06 21:33:11 -0700 | [diff] [blame^] | 115 | // Checkpoints the update progress into persistent storage to allow this |
| 116 | // update attempt to be resumed after reboot. |
Darin Petkov | 73058b4 | 2010-10-06 16:32:19 -0700 | [diff] [blame] | 117 | bool CheckpointUpdateProgress(); |
| 118 | |
| 119 | // Update Engine preference store. |
| 120 | PrefsInterface* prefs_; |
| 121 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 122 | // File descriptor of open device. |
| 123 | int fd_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 124 | |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 125 | // File descriptor of the kernel device |
| 126 | int kernel_fd_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 127 | |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 128 | std::string path_; // Path that fd_ refers to. |
| 129 | std::string kernel_path_; // Path that kernel_fd_ refers to. |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 130 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 131 | DeltaArchiveManifest manifest_; |
| 132 | bool manifest_valid_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 133 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 134 | // Index of the next operation to perform in the manifest. |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 135 | int next_operation_num_; |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 136 | |
| 137 | // buffer_ is a window of the data that's been downloaded. At first, |
| 138 | // it contains the beginning of the download, but after the protobuf |
| 139 | // has been downloaded and parsed, it contains a sliding window of |
| 140 | // data blobs. |
| 141 | std::vector<char> buffer_; |
| 142 | // Offset of buffer_ in the binary blobs section of the update. |
| 143 | uint64_t buffer_offset_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 144 | |
Darin Petkov | 0406e40 | 2010-10-06 21:33:11 -0700 | [diff] [blame^] | 145 | // Last |buffer_offset_| value updated as part of the progress update. |
| 146 | uint64_t last_updated_buffer_offset_; |
| 147 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 148 | // The block size (parsed from the manifest). |
| 149 | uint32_t block_size_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame] | 150 | |
| 151 | // Calculate the payload hash to verify against the signed hash. |
| 152 | OmahaHashCalculator hash_calculator_; |
| 153 | |
| 154 | // Signatures message blob extracted directly from the payload. |
| 155 | std::vector<char> signatures_message_data_; |
| 156 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 157 | DISALLOW_COPY_AND_ASSIGN(DeltaPerformer); |
| 158 | }; |
| 159 | |
| 160 | } // namespace chromeos_update_engine |
| 161 | |
| 162 | #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_DELTA_PERFORMER_H__ |