blob: c52673462f1f7c1361bf8a98c14fafa536bce1a0 [file] [log] [blame]
Doug Zongker9931f7f2009-06-10 14:11:53 -07001/*
2 * Copyright (C) 2009 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
Tao Bao0c7839a2016-10-10 15:48:37 -070017#include "updater/updater.h"
Tao Bao59dcb9c2016-10-03 18:06:46 -070018
Elliott Hughescd3c55a2015-01-29 20:50:08 -080019#include <string.h>
Tao Bao641fa972018-04-25 18:59:40 -070020#include <unistd.h>
Doug Zongker9931f7f2009-06-10 14:11:53 -070021
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070022#include <string>
23
Tao Bao039f2da2016-11-22 16:29:50 -080024#include <android-base/logging.h>
Tao Bao59dcb9c2016-10-03 18:06:46 -070025#include <android-base/strings.h>
Elliott Hughes4bbd5bf2016-04-01 18:24:39 -070026
Tianjie Xu27556d02019-05-22 14:48:35 -070027#include "edify/updater_runtime_interface.h"
Tianjie Xu1536db82019-05-14 10:54:43 -070028
Tianjie Xu58d59122019-05-03 01:05:04 -070029Updater::~Updater() {
30 if (package_handle_) {
31 CloseArchive(package_handle_);
32 }
Tao Bao039f2da2016-11-22 16:29:50 -080033}
34
Tianjie Xu1536db82019-05-14 10:54:43 -070035bool Updater::Init(int fd, const std::string_view package_filename, bool is_retry) {
Tao Bao039f2da2016-11-22 16:29:50 -080036 // Set up the pipe for sending commands back to the parent process.
Tianjie Xu58d59122019-05-03 01:05:04 -070037 cmd_pipe_.reset(fdopen(fd, "wb"));
38 if (!cmd_pipe_) {
39 LOG(ERROR) << "Failed to open the command pipe";
40 return false;
Tao Bao039f2da2016-11-22 16:29:50 -080041 }
Doug Zongker9931f7f2009-06-10 14:11:53 -070042
Tianjie Xu58d59122019-05-03 01:05:04 -070043 setlinebuf(cmd_pipe_.get());
44
Tianjie Xu1536db82019-05-14 10:54:43 -070045 if (!mapped_package_.MapFile(std::string(package_filename))) {
Tianjie Xu58d59122019-05-03 01:05:04 -070046 LOG(ERROR) << "failed to map package " << package_filename;
47 return false;
48 }
49 if (int open_err = OpenArchiveFromMemory(mapped_package_.addr, mapped_package_.length,
Tianjie Xu1536db82019-05-14 10:54:43 -070050 std::string(package_filename).c_str(), &package_handle_);
Tianjie Xu58d59122019-05-03 01:05:04 -070051 open_err != 0) {
52 LOG(ERROR) << "failed to open package " << package_filename << ": "
53 << ErrorCodeString(open_err);
54 return false;
55 }
56 if (!ReadEntryToString(package_handle_, SCRIPT_NAME, &updater_script_)) {
57 return false;
Tao Bao039f2da2016-11-22 16:29:50 -080058 }
Doug Zongker9931f7f2009-06-10 14:11:53 -070059
Tianjie Xu58d59122019-05-03 01:05:04 -070060 is_retry_ = is_retry;
61
Tianjie Xu58d59122019-05-03 01:05:04 -070062 return true;
63}
Doug Zongker9931f7f2009-06-10 14:11:53 -070064
Tianjie Xu58d59122019-05-03 01:05:04 -070065bool Updater::RunUpdate() {
Tianjie Xu1536db82019-05-14 10:54:43 -070066 CHECK(runtime_);
67
Tao Bao039f2da2016-11-22 16:29:50 -080068 // Parse the script.
Tianjie Xuc4447322017-03-06 14:44:59 -080069 std::unique_ptr<Expr> root;
Tao Bao039f2da2016-11-22 16:29:50 -080070 int error_count = 0;
Tianjie Xu58d59122019-05-03 01:05:04 -070071 int error = ParseString(updater_script_, &root, &error_count);
Tao Bao039f2da2016-11-22 16:29:50 -080072 if (error != 0 || error_count > 0) {
73 LOG(ERROR) << error_count << " parse errors";
Tianjie Xu58d59122019-05-03 01:05:04 -070074 return false;
Tao Bao039f2da2016-11-22 16:29:50 -080075 }
Doug Zongker9931f7f2009-06-10 14:11:53 -070076
Tao Bao039f2da2016-11-22 16:29:50 -080077 // Evaluate the parsed script.
Tianjie Xu58d59122019-05-03 01:05:04 -070078 State state(updater_script_, this);
79 state.is_retry = is_retry_;
Doug Zongker9931f7f2009-06-10 14:11:53 -070080
Tianjie Xu58d59122019-05-03 01:05:04 -070081 bool status = Evaluate(&state, root, &result_);
82 if (status) {
83 fprintf(cmd_pipe_.get(), "ui_print script succeeded: result was [%s]\n", result_.c_str());
84 // Even though the script doesn't abort, still log the cause code if result is empty.
85 if (result_.empty() && state.cause_code != kNoCause) {
86 fprintf(cmd_pipe_.get(), "log cause: %d\n", state.cause_code);
87 }
Tianjie Xu1536db82019-05-14 10:54:43 -070088 for (const auto& func : skipped_functions_) {
89 LOG(WARNING) << "Skipped executing function " << func;
90 }
Tianjie Xu58d59122019-05-03 01:05:04 -070091 return true;
92 }
Doug Zongkerd9c9d102009-06-12 12:24:39 -070093
Tianjie Xu58d59122019-05-03 01:05:04 -070094 ParseAndReportErrorCode(&state);
95 return false;
96}
Tianjie Xu7ce287d2016-05-31 09:29:49 -070097
Tianjie Xu1536db82019-05-14 10:54:43 -070098void Updater::WriteToCommandPipe(const std::string_view message, bool flush) const {
99 fprintf(cmd_pipe_.get(), "%s\n", std::string(message).c_str());
Tianjie Xu58d59122019-05-03 01:05:04 -0700100 if (flush) {
101 fflush(cmd_pipe_.get());
102 }
103}
104
Tianjie Xu1536db82019-05-14 10:54:43 -0700105void Updater::UiPrint(const std::string_view message) const {
Tianjie Xu58d59122019-05-03 01:05:04 -0700106 // "line1\nline2\n" will be split into 3 tokens: "line1", "line2" and "".
107 // so skip sending empty strings to ui.
Tianjie Xu1536db82019-05-14 10:54:43 -0700108 std::vector<std::string> lines = android::base::Split(std::string(message), "\n");
Tianjie Xu58d59122019-05-03 01:05:04 -0700109 for (const auto& line : lines) {
110 if (!line.empty()) {
111 fprintf(cmd_pipe_.get(), "ui_print %s\n", line.c_str());
Tao Bao039f2da2016-11-22 16:29:50 -0800112 }
113 }
114
Tianjie Xu58d59122019-05-03 01:05:04 -0700115 // on the updater side, we need to dump the contents to stderr (which has
116 // been redirected to the log file). because the recovery will only print
117 // the contents to screen when processing pipe command ui_print.
118 LOG(INFO) << message;
119}
Tao Bao039f2da2016-11-22 16:29:50 -0800120
Tianjie Xu1536db82019-05-14 10:54:43 -0700121std::string Updater::FindBlockDeviceName(const std::string_view name) const {
122 return runtime_->FindBlockDeviceName(name);
123}
124
Tianjie Xu58d59122019-05-03 01:05:04 -0700125void Updater::ParseAndReportErrorCode(State* state) {
126 CHECK(state);
127 if (state->errmsg.empty()) {
128 LOG(ERROR) << "script aborted (no error message)";
129 fprintf(cmd_pipe_.get(), "ui_print script aborted (no error message)\n");
Tao Bao039f2da2016-11-22 16:29:50 -0800130 } else {
Tianjie Xu58d59122019-05-03 01:05:04 -0700131 LOG(ERROR) << "script aborted: " << state->errmsg;
132 const std::vector<std::string> lines = android::base::Split(state->errmsg, "\n");
133 for (const std::string& line : lines) {
134 // Parse the error code in abort message.
135 // Example: "E30: This package is for bullhead devices."
136 if (!line.empty() && line[0] == 'E') {
137 if (sscanf(line.c_str(), "E%d: ", &state->error_code) != 1) {
138 LOG(ERROR) << "Failed to parse error code: [" << line << "]";
139 }
140 }
141 fprintf(cmd_pipe_.get(), "ui_print %s\n", line.c_str());
142 }
Tao Bao039f2da2016-11-22 16:29:50 -0800143 }
Doug Zongker9931f7f2009-06-10 14:11:53 -0700144
Tianjie Xu58d59122019-05-03 01:05:04 -0700145 // Installation has been aborted. Set the error code to kScriptExecutionFailure unless
146 // a more specific code has been set in errmsg.
147 if (state->error_code == kNoError) {
148 state->error_code = kScriptExecutionFailure;
149 }
150 fprintf(cmd_pipe_.get(), "log error: %d\n", state->error_code);
151 // Cause code should provide additional information about the abort.
152 if (state->cause_code != kNoCause) {
153 fprintf(cmd_pipe_.get(), "log cause: %d\n", state->cause_code);
154 if (state->cause_code == kPatchApplicationFailure) {
155 LOG(INFO) << "Patch application failed, retry update.";
156 fprintf(cmd_pipe_.get(), "retry_update\n");
157 } else if (state->cause_code == kEioFailure) {
158 LOG(INFO) << "Update failed due to EIO, retry update.";
159 fprintf(cmd_pipe_.get(), "retry_update\n");
160 }
161 }
162}
163
164bool Updater::ReadEntryToString(ZipArchiveHandle za, const std::string& entry_name,
165 std::string* content) {
Kelvin Zhang4f811302020-09-16 14:06:12 -0400166 ZipEntry64 entry;
Tianjie Xu58d59122019-05-03 01:05:04 -0700167 int find_err = FindEntry(za, entry_name, &entry);
168 if (find_err != 0) {
169 LOG(ERROR) << "failed to find " << entry_name
170 << " in the package: " << ErrorCodeString(find_err);
171 return false;
Tao Bao039f2da2016-11-22 16:29:50 -0800172 }
Kelvin Zhangd1ba38f2020-09-17 11:32:29 -0400173 if (entry.uncompressed_length > std::numeric_limits<size_t>::max()) {
174 LOG(ERROR) << "Failed to extract " << entry_name
175 << " because's uncompressed size exceeds size of address space. "
176 << entry.uncompressed_length;
177 return false;
178 }
Tianjie Xu58d59122019-05-03 01:05:04 -0700179 content->resize(entry.uncompressed_length);
180 int extract_err = ExtractToMemory(za, &entry, reinterpret_cast<uint8_t*>(&content->at(0)),
181 entry.uncompressed_length);
182 if (extract_err != 0) {
Tianjie Xuc1a5e262019-05-22 14:34:12 -0700183 LOG(ERROR) << "failed to read " << entry_name
184 << " from package: " << ErrorCodeString(extract_err);
Tianjie Xu58d59122019-05-03 01:05:04 -0700185 return false;
186 }
187
188 return true;
Doug Zongker9931f7f2009-06-10 14:11:53 -0700189}