1 // 2 // Copyright (C) 2016 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_UPDATE_ATTEMPTER_ANDROID_H_ 18 #define UPDATE_ENGINE_UPDATE_ATTEMPTER_ANDROID_H_ 19 20 #include <stdint.h> 21 22 #include <memory> 23 #include <string> 24 #include <vector> 25 26 #include <base/time/time.h> 27 28 #include "update_engine/client_library/include/update_engine/update_status.h" 29 #include "update_engine/common/action_processor.h" 30 #include "update_engine/common/boot_control_interface.h" 31 #include "update_engine/common/clock.h" 32 #include "update_engine/common/hardware_interface.h" 33 #include "update_engine/common/prefs_interface.h" 34 #include "update_engine/daemon_state_interface.h" 35 #include "update_engine/metrics_reporter_interface.h" 36 #include "update_engine/metrics_utils.h" 37 #include "update_engine/network_selector_interface.h" 38 #include "update_engine/payload_consumer/download_action.h" 39 #include "update_engine/payload_consumer/postinstall_runner_action.h" 40 #include "update_engine/service_delegate_android_interface.h" 41 #include "update_engine/service_observer_interface.h" 42 43 namespace chromeos_update_engine { 44 45 class UpdateAttempterAndroid 46 : public ServiceDelegateAndroidInterface, 47 public ActionProcessorDelegate, 48 public DownloadActionDelegate, 49 public PostinstallRunnerAction::DelegateInterface { 50 public: 51 using UpdateStatus = update_engine::UpdateStatus; 52 53 UpdateAttempterAndroid(DaemonStateInterface* daemon_state, 54 PrefsInterface* prefs, 55 BootControlInterface* boot_control_, 56 HardwareInterface* hardware_); 57 ~UpdateAttempterAndroid() override; 58 59 // Further initialization to be done post construction. 60 void Init(); 61 62 // ServiceDelegateAndroidInterface overrides. 63 bool ApplyPayload(const std::string& payload_url, 64 int64_t payload_offset, 65 int64_t payload_size, 66 const std::vector<std::string>& key_value_pair_headers, 67 brillo::ErrorPtr* error) override; 68 bool SuspendUpdate(brillo::ErrorPtr* error) override; 69 bool ResumeUpdate(brillo::ErrorPtr* error) override; 70 bool CancelUpdate(brillo::ErrorPtr* error) override; 71 bool ResetStatus(brillo::ErrorPtr* error) override; 72 bool VerifyPayloadApplicable(const std::string& metadata_filename, 73 brillo::ErrorPtr* error) override; 74 75 // ActionProcessorDelegate methods: 76 void ProcessingDone(const ActionProcessor* processor, 77 ErrorCode code) override; 78 void ProcessingStopped(const ActionProcessor* processor) override; 79 void ActionCompleted(ActionProcessor* processor, 80 AbstractAction* action, 81 ErrorCode code) override; 82 83 // DownloadActionDelegate overrides. 84 void BytesReceived(uint64_t bytes_progressed, 85 uint64_t bytes_received, 86 uint64_t total) override; 87 bool ShouldCancel(ErrorCode* cancel_reason) override; 88 void DownloadComplete() override; 89 90 // PostinstallRunnerAction::DelegateInterface 91 void ProgressUpdate(double progress) override; 92 93 private: 94 friend class UpdateAttempterAndroidTest; 95 96 // Schedules an event loop callback to start the action processor. This is 97 // scheduled asynchronously to unblock the event loop. 98 void ScheduleProcessingStart(); 99 100 // Notifies an update request completed with the given error |code| to all 101 // observers. 102 void TerminateUpdateAndNotify(ErrorCode error_code); 103 104 // Sets the status to the given |status| and notifies a status update to 105 // all observers. 106 void SetStatusAndNotify(UpdateStatus status); 107 108 // Helper method to construct the sequence of actions to be performed for 109 // applying an update using a given HttpFetcher. The ownership of |fetcher| is 110 // passed to this function. 111 void BuildUpdateActions(HttpFetcher* fetcher); 112 113 // Writes to the processing completed marker. Does nothing if 114 // |update_completed_marker_| is empty. 115 bool WriteUpdateCompletedMarker(); 116 117 // Returns whether an update was completed in the current boot. 118 bool UpdateCompletedOnThisBoot(); 119 120 // Prefs to use for metrics report 121 // |kPrefsPayloadAttemptNumber|: number of update attempts for the current 122 // payload_id. 123 // |KprefsNumReboots|: number of reboots when applying the current update. 124 // |kPrefsSystemUpdatedMarker|: end timestamp of the last successful update. 125 // |kPrefsUpdateTimestampStart|: start timestamp in monotonic time of the 126 // current update. 127 // |kPrefsUpdateBootTimestampStart|: start timestamp in boot time of 128 // the current update. 129 // |kPrefsCurrentBytesDownloaded|: number of bytes downloaded for the current 130 // payload_id. 131 // |kPrefsTotalBytesDownloaded|: number of bytes downloaded in total since 132 // the last successful update. 133 134 // Metrics report function to call: 135 // |ReportUpdateAttemptMetrics| 136 // |ReportSuccessfulUpdateMetrics| 137 // Prefs to update: 138 // |kPrefsSystemUpdatedMarker| 139 void CollectAndReportUpdateMetricsOnUpdateFinished(ErrorCode error_code); 140 141 // Metrics report function to call: 142 // |ReportAbnormallyTerminatedUpdateAttemptMetrics| 143 // |ReportTimeToRebootMetrics| 144 // Prefs to update: 145 // |kPrefsBootId|, |kPrefsPreviousVersion| 146 void UpdatePrefsAndReportUpdateMetricsOnReboot(); 147 148 // Prefs to update: 149 // |kPrefsPayloadAttemptNumber|, |kPrefsUpdateTimestampStart|, 150 // |kPrefsUpdateBootTimestampStart| 151 void UpdatePrefsOnUpdateStart(bool is_resume); 152 153 // Prefs to delete: 154 // |kPrefsNumReboots|, |kPrefsCurrentBytesDownloaded| 155 // |kPrefsSystemUpdatedMarker|, |kPrefsUpdateTimestampStart|, 156 // |kPrefsUpdateBootTimestampStart| 157 void ClearMetricsPrefs(); 158 159 DaemonStateInterface* daemon_state_; 160 161 // DaemonStateAndroid pointers. 162 PrefsInterface* prefs_; 163 BootControlInterface* boot_control_; 164 HardwareInterface* hardware_; 165 166 // Last status notification timestamp used for throttling. Use monotonic 167 // TimeTicks to ensure that notifications are sent even if the system clock is 168 // set back in the middle of an update. 169 base::TimeTicks last_notify_time_; 170 171 // Only direct proxy supported. 172 DirectProxyResolver proxy_resolver_; 173 174 // The processor for running Actions. 175 std::unique_ptr<ActionProcessor> processor_; 176 177 // The InstallPlan used during the ongoing update. 178 InstallPlan install_plan_; 179 180 // For status: 181 UpdateStatus status_{UpdateStatus::IDLE}; 182 double download_progress_{0.0}; 183 184 // The offset in the payload file where the CrAU part starts. 185 int64_t base_offset_{0}; 186 187 // Helper class to select the network to use during the update. 188 std::unique_ptr<NetworkSelectorInterface> network_selector_; 189 190 std::unique_ptr<ClockInterface> clock_; 191 192 std::unique_ptr<MetricsReporterInterface> metrics_reporter_; 193 194 DISALLOW_COPY_AND_ASSIGN(UpdateAttempterAndroid); 195 }; 196 197 } // namespace chromeos_update_engine 198 199 #endif // UPDATE_ENGINE_UPDATE_ATTEMPTER_ANDROID_H_ 200