1 /* 2 * Copyright 2018 Google Inc. 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 #include "updater.hpp" 18 19 #include "firmware_handler.hpp" 20 #include "status.hpp" 21 #include "tool_errors.hpp" 22 #include "util.hpp" 23 24 #include <algorithm> 25 #include <blobs-ipmid/blobs.hpp> 26 #include <cstring> 27 #include <ipmiblob/blob_errors.hpp> 28 #include <memory> 29 #include <string> 30 #include <thread> 31 #include <vector> 32 33 namespace host_tool 34 { 35 36 bool UpdateHandler::checkAvailable(const std::string& goalFirmware) 37 { 38 std::vector<std::string> blobs = blob->getBlobList(); 39 40 auto blobInst = std::find_if( 41 blobs.begin(), blobs.end(), [&goalFirmware](const std::string& iter) { 42 /* Running into weird scenarios where the string comparison doesn't 43 * work. TODO: revisit. 44 */ 45 return (0 == std::memcmp(goalFirmware.c_str(), iter.c_str(), 46 goalFirmware.length())); 47 // return (goalFirmware.compare(iter)); 48 }); 49 if (blobInst == blobs.end()) 50 { 51 std::fprintf(stderr, "%s not found\n", goalFirmware.c_str()); 52 return false; 53 } 54 55 /* Call stat on /flash/image (or /flash/tarball) and check if data interface 56 * is supported. 57 */ 58 ipmiblob::StatResponse stat; 59 60 try 61 { 62 stat = blob->getStat(goalFirmware); 63 } 64 catch (const ipmiblob::BlobException& b) 65 { 66 std::fprintf(stderr, "Received exception '%s' on getStat\n", b.what()); 67 return false; 68 } 69 70 auto supported = handler->supportedType(); 71 if ((stat.blob_state & supported) == 0) 72 { 73 std::fprintf(stderr, "data interface selected not supported.\n"); 74 return false; 75 } 76 77 return true; 78 } 79 80 void UpdateHandler::sendFile(const std::string& target, const std::string& path) 81 { 82 std::uint16_t session; 83 auto supported = handler->supportedType(); 84 85 try 86 { 87 session = blob->openBlob( 88 target, static_cast<std::uint16_t>(supported) | 89 static_cast<std::uint16_t>(blobs::OpenFlags::write)); 90 } 91 catch (const ipmiblob::BlobException& b) 92 { 93 throw ToolException("blob exception received: " + 94 std::string(b.what())); 95 } 96 97 if (!handler->sendContents(path, session)) 98 { 99 /* Need to close the session on failure, or it's stuck open (until the 100 * blob handler timeout is implemented, and even then, why make it wait. 101 */ 102 blob->closeBlob(session); 103 throw ToolException("Failed to send contents of " + path); 104 } 105 106 blob->closeBlob(session); 107 } 108 109 /* Poll an open verification session. Handling closing the session is not yet 110 * owned by this method. */ 111 bool pollStatus(std::uint16_t session, ipmiblob::BlobInterface* blob) 112 { 113 using namespace std::chrono_literals; 114 115 static constexpr auto verificationSleep = 5s; 116 ipmi_flash::ActionStatus result = ipmi_flash::ActionStatus::unknown; 117 118 try 119 { 120 static constexpr int commandAttempts = 20; 121 int attempts = 0; 122 bool exitLoop = false; 123 124 /* Reach back the current status from the verification service output. 125 */ 126 while (attempts++ < commandAttempts) 127 { 128 ipmiblob::StatResponse resp = blob->getStat(session); 129 130 if (resp.metadata.size() != sizeof(std::uint8_t)) 131 { 132 /* TODO: How do we want to handle the verification failures, 133 * because closing the session to the verify blob has a special 134 * as-of-yet not fully defined behavior. 135 */ 136 std::fprintf(stderr, "Received invalid metadata response!!!\n"); 137 } 138 139 result = static_cast<ipmi_flash::ActionStatus>(resp.metadata[0]); 140 141 switch (result) 142 { 143 case ipmi_flash::ActionStatus::failed: 144 std::fprintf(stderr, "failed\n"); 145 exitLoop = true; 146 break; 147 case ipmi_flash::ActionStatus::unknown: 148 std::fprintf(stderr, "other\n"); 149 break; 150 case ipmi_flash::ActionStatus::running: 151 std::fprintf(stderr, "running\n"); 152 break; 153 case ipmi_flash::ActionStatus::success: 154 std::fprintf(stderr, "success\n"); 155 exitLoop = true; 156 break; 157 default: 158 std::fprintf(stderr, "wat\n"); 159 } 160 161 if (exitLoop) 162 { 163 break; 164 } 165 std::this_thread::sleep_for(verificationSleep); 166 } 167 } 168 catch (const ipmiblob::BlobException& b) 169 { 170 throw ToolException("blob exception received: " + 171 std::string(b.what())); 172 } 173 174 /* TODO: If this is reached and it's not success, it may be worth just 175 * throwing a ToolException with a timeout message specifying the final 176 * read's value. 177 * 178 * TODO: Given that excepting from certain points leaves the BMC update 179 * state machine in an inconsistent state, we need to carefully evaluate 180 * which exceptions from the lower layers allow one to try and delete the 181 * blobs to rollback the state and progress. 182 */ 183 return (result == ipmi_flash::ActionStatus::success); 184 } 185 186 bool UpdateHandler::verifyFile(const std::string& target) 187 { 188 std::uint16_t session; 189 bool success = false; 190 191 try 192 { 193 session = blob->openBlob( 194 target, static_cast<std::uint16_t>(blobs::OpenFlags::write)); 195 } 196 catch (const ipmiblob::BlobException& b) 197 { 198 throw ToolException("blob exception received: " + 199 std::string(b.what())); 200 } 201 202 std::fprintf( 203 stderr, 204 "Committing to verification file to trigger verification service\n"); 205 206 try 207 { 208 blob->commit(session, {}); 209 } 210 catch (const ipmiblob::BlobException& b) 211 { 212 throw ToolException("blob exception received: " + 213 std::string(b.what())); 214 } 215 216 std::fprintf(stderr, 217 "Calling stat on verification session to check status\n"); 218 219 if (pollStatus(session, blob)) 220 { 221 std::fprintf(stderr, "Verification returned success\n"); 222 success = true; 223 } 224 else 225 { 226 std::fprintf(stderr, "Verification returned non-success (could still " 227 "be running (unlikely))\n"); 228 } 229 230 blob->closeBlob(session); 231 return (success == true); 232 } 233 234 void updaterMain(UpdateHandler* updater, const std::string& imagePath, 235 const std::string& signaturePath) 236 { 237 /* TODO(venture): Add optional parameter to specify the flash type, default 238 * to legacy for now. 239 */ 240 bool goalSupported = 241 updater->checkAvailable(ipmi_flash::staticLayoutBlobId); 242 if (!goalSupported) 243 { 244 throw ToolException("Goal firmware or interface not supported"); 245 } 246 247 /* Yay, our data handler is supported. */ 248 249 /* Send over the firmware image. */ 250 std::fprintf(stderr, "Sending over the firmware image.\n"); 251 updater->sendFile(ipmi_flash::staticLayoutBlobId, imagePath); 252 253 /* Send over the hash contents. */ 254 std::fprintf(stderr, "Sending over the hash file.\n"); 255 updater->sendFile(ipmi_flash::hashBlobId, signaturePath); 256 257 /* Trigger the verification by opening and committing the verify file. */ 258 std::fprintf(stderr, "Opening the verification file\n"); 259 if (updater->verifyFile(ipmi_flash::verifyBlobId)) 260 { 261 std::fprintf(stderr, "succeeded\n"); 262 } 263 else 264 { 265 std::fprintf(stderr, "failed\n"); 266 throw ToolException("Verification failed"); 267 } 268 269 /* Trigger the update by opening and committing the update file. */ 270 std::fprintf(stderr, "Opening the update file\n"); 271 if (updater->verifyFile(ipmi_flash::updateBlobId)) 272 { 273 std::fprintf(stderr, "succeeded\n"); 274 } 275 else 276 { 277 /* Depending on the update mechanism used, this may be uninteresting. 278 * For instance, for the static layout, we use the reboot update 279 * mechanism. Which doesn't always lead to a successful return before 280 * the BMC starts shutting down services. 281 */ 282 std::fprintf(stderr, "failed\n"); 283 throw ToolException("Update failed"); 284 } 285 } 286 287 } // namespace host_tool 288