Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 1 | #include "config.h" |
Gunnar Mills | b0ce996 | 2018-09-07 13:39:10 -0500 | [diff] [blame] | 2 | |
| 3 | #include "image_manager.hpp" |
| 4 | |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 5 | #include "version.hpp" |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 6 | #include "watch.hpp" |
Gunnar Mills | b0ce996 | 2018-09-07 13:39:10 -0500 | [diff] [blame] | 7 | |
| 8 | #include <stdio.h> |
| 9 | #include <stdlib.h> |
| 10 | #include <sys/stat.h> |
| 11 | #include <sys/wait.h> |
| 12 | #include <unistd.h> |
| 13 | |
| 14 | #include <algorithm> |
| 15 | #include <cstring> |
| 16 | #include <elog-errors.hpp> |
| 17 | #include <experimental/filesystem> |
| 18 | #include <phosphor-logging/elog.hpp> |
| 19 | #include <phosphor-logging/log.hpp> |
| 20 | #include <string> |
Adriana Kobylak | 43699ca | 2018-10-17 14:56:29 -0500 | [diff] [blame] | 21 | #include <xyz/openbmc_project/Software/Image/error.hpp> |
Gunnar Mills | e91d321 | 2017-04-19 15:42:47 -0500 | [diff] [blame] | 22 | |
| 23 | namespace phosphor |
| 24 | { |
| 25 | namespace software |
| 26 | { |
| 27 | namespace manager |
| 28 | { |
| 29 | |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 30 | using namespace phosphor::logging; |
Adriana Kobylak | 43699ca | 2018-10-17 14:56:29 -0500 | [diff] [blame] | 31 | using namespace sdbusplus::xyz::openbmc_project::Software::Image::Error; |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 32 | namespace Software = phosphor::logging::xyz::openbmc_project::Software; |
Adriana Kobylak | 43699ca | 2018-10-17 14:56:29 -0500 | [diff] [blame] | 33 | using ManifestFail = Software::Image::ManifestFileFailure; |
| 34 | using UnTarFail = Software::Image::UnTarFailure; |
| 35 | using InternalFail = Software::Image::InternalFailure; |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 36 | namespace fs = std::experimental::filesystem; |
| 37 | |
| 38 | struct RemovablePath |
| 39 | { |
| 40 | fs::path path; |
| 41 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 42 | RemovablePath(const fs::path& path) : path(path) |
| 43 | { |
| 44 | } |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 45 | ~RemovablePath() |
| 46 | { |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 47 | if (!path.empty()) |
Adriana Kobylak | 2b2cd9f | 2018-02-12 16:20:13 -0600 | [diff] [blame] | 48 | { |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 49 | std::error_code ec; |
| 50 | fs::remove_all(path, ec); |
Adriana Kobylak | 2b2cd9f | 2018-02-12 16:20:13 -0600 | [diff] [blame] | 51 | } |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 52 | } |
| 53 | }; |
| 54 | |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 55 | int Manager::processImage(const std::string& tarFilePath) |
Gunnar Mills | e91d321 | 2017-04-19 15:42:47 -0500 | [diff] [blame] | 56 | { |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 57 | if (!fs::is_regular_file(tarFilePath)) |
| 58 | { |
| 59 | log<level::ERR>("Error tarball does not exist", |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 60 | entry("FILENAME=%s", tarFilePath.c_str())); |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 61 | report<ManifestFileFailure>(ManifestFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 62 | return -1; |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 63 | } |
| 64 | RemovablePath tarPathRemove(tarFilePath); |
| 65 | fs::path tmpDirPath(std::string{IMG_UPLOAD_DIR}); |
| 66 | tmpDirPath /= "imageXXXXXX"; |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 67 | auto tmpDir = tmpDirPath.string(); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 68 | |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 69 | // Create a tmp dir to extract tarball. |
| 70 | if (!mkdtemp(tmpDir.data())) |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 71 | { |
Gunnar Mills | 601bbf0 | 2017-10-25 13:46:11 -0500 | [diff] [blame] | 72 | log<level::ERR>("Error occurred during mkdtemp", |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 73 | entry("ERRNO=%d", errno)); |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 74 | report<InternalFailure>(InternalFail::FAIL("mkdtemp")); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 75 | return -1; |
| 76 | } |
| 77 | |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 78 | tmpDirPath = tmpDir; |
| 79 | RemovablePath tmpDirToRemove(tmpDirPath); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 80 | fs::path manifestPath = tmpDirPath; |
| 81 | manifestPath /= MANIFEST_FILE_NAME; |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 82 | |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 83 | // Untar tarball into the tmp dir |
| 84 | auto rc = unTar(tarFilePath, tmpDirPath.string()); |
| 85 | if (rc < 0) |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 86 | { |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 87 | log<level::ERR>("Error occurred during untar"); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 88 | return -1; |
| 89 | } |
| 90 | |
| 91 | // Verify the manifest file |
| 92 | if (!fs::is_regular_file(manifestPath)) |
| 93 | { |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 94 | log<level::ERR>("Error No manifest file", |
| 95 | entry("FILENAME=%s", tarFilePath.c_str())); |
| 96 | report<ManifestFileFailure>(ManifestFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 97 | return -1; |
| 98 | } |
| 99 | |
| 100 | // Get version |
| 101 | auto version = Version::getValue(manifestPath.string(), "version"); |
| 102 | if (version.empty()) |
| 103 | { |
| 104 | log<level::ERR>("Error unable to read version from manifest file"); |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 105 | report<ManifestFileFailure>(ManifestFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 106 | return -1; |
| 107 | } |
| 108 | |
Vijay Khemka | b7c062e | 2019-09-18 17:15:57 -0700 | [diff] [blame^] | 109 | // Get running machine name |
| 110 | std::string currMachine = Version::getBMCMachine(OS_RELEASE_FILE); |
| 111 | if (currMachine.empty()) |
| 112 | { |
| 113 | log<level::ERR>("Failed to read machine name from osRelease", |
| 114 | entry("FILENAME=%s", OS_RELEASE_FILE)); |
| 115 | return -1; |
| 116 | } |
| 117 | |
| 118 | // Get machine name for image to be upgraded |
| 119 | std::string machineStr = |
| 120 | Version::getValue(manifestPath.string(), "MachineName"); |
| 121 | if (!machineStr.empty()) |
| 122 | { |
| 123 | if (machineStr != currMachine) |
| 124 | { |
| 125 | log<level::ERR>("BMC upgrade: Machine name doesn't match", |
| 126 | entry("CURR_MACHINE=%s", currMachine.c_str()), |
| 127 | entry("NEW_MACHINE=%s", machineStr.c_str())); |
| 128 | return -1; |
| 129 | } |
| 130 | } |
| 131 | else |
| 132 | { |
| 133 | log<level::WARNING>("No machine name in Manifest file"); |
| 134 | } |
| 135 | |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 136 | // Get purpose |
| 137 | auto purposeString = Version::getValue(manifestPath.string(), "purpose"); |
| 138 | if (purposeString.empty()) |
| 139 | { |
| 140 | log<level::ERR>("Error unable to read purpose from manifest file"); |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 141 | report<ManifestFileFailure>(ManifestFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 142 | return -1; |
| 143 | } |
| 144 | |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 145 | auto purpose = Version::VersionPurpose::Unknown; |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 146 | try |
| 147 | { |
Leonel Gonzalez | 9a8d14c | 2017-06-22 11:42:24 -0500 | [diff] [blame] | 148 | purpose = Version::convertVersionPurposeFromString(purposeString); |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 149 | } |
| 150 | catch (const sdbusplus::exception::InvalidEnumString& e) |
| 151 | { |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 152 | log<level::ERR>("Error: Failed to convert manifest purpose to enum." |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 153 | " Setting to Unknown."); |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 154 | } |
| 155 | |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 156 | // Compute id |
| 157 | auto id = Version::getId(version); |
| 158 | |
| 159 | fs::path imageDirPath = std::string{IMG_UPLOAD_DIR}; |
| 160 | imageDirPath /= id; |
| 161 | |
Gunnar Mills | f576bca | 2017-05-18 13:40:39 -0500 | [diff] [blame] | 162 | if (fs::exists(imageDirPath)) |
| 163 | { |
| 164 | fs::remove_all(imageDirPath); |
| 165 | } |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 166 | |
Lei YU | 5d93028 | 2019-03-08 16:41:51 +0800 | [diff] [blame] | 167 | // Rename the temp dir to image dir |
| 168 | fs::rename(tmpDirPath, imageDirPath); |
| 169 | |
| 170 | // Clear the path, so it does not attemp to remove a non-existing path |
| 171 | tmpDirToRemove.path.clear(); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 172 | |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 173 | // Create Version object |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 174 | auto objPath = std::string{SOFTWARE_OBJPATH} + '/' + id; |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 175 | |
Saqib Khan | d377ba1 | 2017-10-16 14:32:30 -0500 | [diff] [blame] | 176 | if (versions.find(id) == versions.end()) |
| 177 | { |
Saqib Khan | ee13e83 | 2017-10-23 12:53:11 -0500 | [diff] [blame] | 178 | auto versionPtr = std::make_unique<Version>( |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 179 | bus, objPath, version, purpose, imageDirPath.string(), |
| 180 | std::bind(&Manager::erase, this, std::placeholders::_1)); |
Saqib Khan | ee13e83 | 2017-10-23 12:53:11 -0500 | [diff] [blame] | 181 | versionPtr->deleteObject = |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 182 | std::make_unique<phosphor::software::manager::Delete>(bus, objPath, |
| 183 | *versionPtr); |
Saqib Khan | ee13e83 | 2017-10-23 12:53:11 -0500 | [diff] [blame] | 184 | versions.insert(std::make_pair(id, std::move(versionPtr))); |
Saqib Khan | d377ba1 | 2017-10-16 14:32:30 -0500 | [diff] [blame] | 185 | } |
| 186 | else |
| 187 | { |
| 188 | log<level::INFO>("Software Object with the same version already exists", |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 189 | entry("VERSION_ID=%s", id.c_str())); |
Saqib Khan | d377ba1 | 2017-10-16 14:32:30 -0500 | [diff] [blame] | 190 | } |
Gunnar Mills | e91d321 | 2017-04-19 15:42:47 -0500 | [diff] [blame] | 191 | return 0; |
| 192 | } |
| 193 | |
Leonel Gonzalez | 50d559c | 2017-07-07 14:38:25 -0500 | [diff] [blame] | 194 | void Manager::erase(std::string entryId) |
| 195 | { |
| 196 | auto it = versions.find(entryId); |
| 197 | if (it == versions.end()) |
| 198 | { |
| 199 | return; |
| 200 | } |
Eddie James | 6d87371 | 2017-09-01 11:29:07 -0500 | [diff] [blame] | 201 | |
| 202 | if (it->second->isFunctional()) |
| 203 | { |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 204 | log<level::ERR>(("Error: Version " + entryId + |
| 205 | " is currently running on the BMC." |
| 206 | " Unable to remove.") |
| 207 | .c_str()); |
Eddie James | 6d87371 | 2017-09-01 11:29:07 -0500 | [diff] [blame] | 208 | return; |
| 209 | } |
| 210 | |
Leonel Gonzalez | 50d559c | 2017-07-07 14:38:25 -0500 | [diff] [blame] | 211 | // Delete image dir |
| 212 | fs::path imageDirPath = (*(it->second)).path(); |
| 213 | if (fs::exists(imageDirPath)) |
| 214 | { |
| 215 | fs::remove_all(imageDirPath); |
| 216 | } |
| 217 | this->versions.erase(entryId); |
| 218 | } |
| 219 | |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 220 | int Manager::unTar(const std::string& tarFilePath, |
| 221 | const std::string& extractDirPath) |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 222 | { |
| 223 | if (tarFilePath.empty()) |
| 224 | { |
| 225 | log<level::ERR>("Error TarFilePath is empty"); |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 226 | report<UnTarFailure>(UnTarFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 227 | return -1; |
| 228 | } |
| 229 | if (extractDirPath.empty()) |
| 230 | { |
| 231 | log<level::ERR>("Error ExtractDirPath is empty"); |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 232 | report<UnTarFailure>(UnTarFail::PATH(extractDirPath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 233 | return -1; |
| 234 | } |
| 235 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 236 | log<level::INFO>("Untaring", entry("FILENAME=%s", tarFilePath.c_str()), |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 237 | entry("EXTRACTIONDIR=%s", extractDirPath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 238 | int status = 0; |
| 239 | pid_t pid = fork(); |
| 240 | |
| 241 | if (pid == 0) |
| 242 | { |
| 243 | // child process |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 244 | execl("/bin/tar", "tar", "-xf", tarFilePath.c_str(), "-C", |
| 245 | extractDirPath.c_str(), (char*)0); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 246 | // execl only returns on fail |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 247 | log<level::ERR>("Failed to execute untar file", |
| 248 | entry("FILENAME=%s", tarFilePath.c_str())); |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 249 | report<UnTarFailure>(UnTarFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 250 | return -1; |
| 251 | } |
| 252 | else if (pid > 0) |
| 253 | { |
| 254 | waitpid(pid, &status, 0); |
Adriana Kobylak | 596466b | 2018-02-13 14:48:53 -0600 | [diff] [blame] | 255 | if (WEXITSTATUS(status)) |
| 256 | { |
| 257 | log<level::ERR>("Failed to untar file", |
| 258 | entry("FILENAME=%s", tarFilePath.c_str())); |
| 259 | report<UnTarFailure>(UnTarFail::PATH(tarFilePath.c_str())); |
| 260 | return -1; |
| 261 | } |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 262 | } |
| 263 | else |
| 264 | { |
| 265 | log<level::ERR>("fork() failed."); |
Gunnar Mills | b30cadd | 2017-10-06 16:07:32 -0500 | [diff] [blame] | 266 | report<UnTarFailure>(UnTarFail::PATH(tarFilePath.c_str())); |
Gunnar Mills | 19e4ce5 | 2017-04-27 11:24:19 -0500 | [diff] [blame] | 267 | return -1; |
| 268 | } |
| 269 | |
| 270 | return 0; |
| 271 | } |
Gunnar Mills | 3027bba | 2017-04-27 15:49:03 -0500 | [diff] [blame] | 272 | |
Gunnar Mills | e91d321 | 2017-04-19 15:42:47 -0500 | [diff] [blame] | 273 | } // namespace manager |
| 274 | } // namespace software |
Gunnar Mills | fa34e02 | 2018-09-04 10:05:45 -0500 | [diff] [blame] | 275 | } // namespace phosphor |