1a6e3b99dSJohn Edward Broadbent #include "util.hpp" 2a6e3b99dSJohn Edward Broadbent 3*d32b9667SJohn Wedig #include "getConfig.hpp" 4*d32b9667SJohn Wedig 5a6e3b99dSJohn Edward Broadbent #include <linux/fs.h> 6a6e3b99dSJohn Edward Broadbent 7a6e3b99dSJohn Edward Broadbent #include <phosphor-logging/lg2.hpp> 8a6e3b99dSJohn Edward Broadbent #include <stdplus/fd/create.hpp> 9a6e3b99dSJohn Edward Broadbent #include <stdplus/fd/managed.hpp> 10a6e3b99dSJohn Edward Broadbent #include <stdplus/handle/managed.hpp> 11a6e3b99dSJohn Edward Broadbent #include <xyz/openbmc_project/Common/error.hpp> 12a6e3b99dSJohn Edward Broadbent 13*d32b9667SJohn Wedig #include <filesystem> 145d799bb9SJohn Edward Broadbent #include <fstream> 155d799bb9SJohn Edward Broadbent #include <iostream> 165d799bb9SJohn Edward Broadbent #include <string> 17a6e3b99dSJohn Edward Broadbent 18a6e3b99dSJohn Edward Broadbent namespace estoraged 19a6e3b99dSJohn Edward Broadbent { 20a6e3b99dSJohn Edward Broadbent namespace util 21a6e3b99dSJohn Edward Broadbent { 22a6e3b99dSJohn Edward Broadbent using ::sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure; 23a6e3b99dSJohn Edward Broadbent using ::stdplus::fd::ManagedFd; 24a6e3b99dSJohn Edward Broadbent 255d799bb9SJohn Edward Broadbent uint64_t findSizeOfBlockDevice(const std::string& devPath) 26a6e3b99dSJohn Edward Broadbent { 27a6e3b99dSJohn Edward Broadbent ManagedFd fd; 28a6e3b99dSJohn Edward Broadbent uint64_t bytes = 0; 29a6e3b99dSJohn Edward Broadbent try 30a6e3b99dSJohn Edward Broadbent { 31a6e3b99dSJohn Edward Broadbent // open block dev 32a6e3b99dSJohn Edward Broadbent fd = stdplus::fd::open(devPath, stdplus::fd::OpenAccess::ReadOnly); 33a6e3b99dSJohn Edward Broadbent // get block size 34a6e3b99dSJohn Edward Broadbent fd.ioctl(BLKGETSIZE64, &bytes); 35a6e3b99dSJohn Edward Broadbent } 36a6e3b99dSJohn Edward Broadbent catch (...) 37a6e3b99dSJohn Edward Broadbent { 38a6e3b99dSJohn Edward Broadbent lg2::error("erase unable to open blockdev", "REDFISH_MESSAGE_ID", 39a6e3b99dSJohn Edward Broadbent std::string("OpenBMC.0.1.DriveEraseFailure"), 40a6e3b99dSJohn Edward Broadbent "REDFISH_MESSAGE_ARGS", std::to_string(fd.get())); 41a6e3b99dSJohn Edward Broadbent throw InternalFailure(); 42a6e3b99dSJohn Edward Broadbent } 43a6e3b99dSJohn Edward Broadbent return bytes; 44a6e3b99dSJohn Edward Broadbent } 45a6e3b99dSJohn Edward Broadbent 465d799bb9SJohn Edward Broadbent uint8_t findPredictedMediaLifeLeftPercent(const std::string& sysfsPath) 475d799bb9SJohn Edward Broadbent { 485d799bb9SJohn Edward Broadbent // The eMMC spec defines two estimates for the life span of the device 495d799bb9SJohn Edward Broadbent // in the extended CSD field 269 and 268, named estimate A and estimate B. 505d799bb9SJohn Edward Broadbent // Linux exposes the values in the /life_time node. 515d799bb9SJohn Edward Broadbent // estimate A is for A type memory 525d799bb9SJohn Edward Broadbent // estimate B is for B type memory 535d799bb9SJohn Edward Broadbent // 545d799bb9SJohn Edward Broadbent // the estimate are encoded as such 555d799bb9SJohn Edward Broadbent // 0x01 <=> 0% - 10% device life time used 565d799bb9SJohn Edward Broadbent // 0x02 <=> 10% -20% device life time used 575d799bb9SJohn Edward Broadbent // ... 585d799bb9SJohn Edward Broadbent // 0x0A <=> 90% - 100% device life time used 595d799bb9SJohn Edward Broadbent // 0x0B <=> Exceeded its maximum estimated device life time 605d799bb9SJohn Edward Broadbent 615d799bb9SJohn Edward Broadbent uint16_t estA = 0, estB = 0; 625d799bb9SJohn Edward Broadbent std::ifstream lifeTimeFile; 635d799bb9SJohn Edward Broadbent try 645d799bb9SJohn Edward Broadbent { 655d799bb9SJohn Edward Broadbent lifeTimeFile.open(sysfsPath + "/life_time", std::ios_base::in); 665d799bb9SJohn Edward Broadbent lifeTimeFile >> std::hex >> estA; 675d799bb9SJohn Edward Broadbent lifeTimeFile >> std::hex >> estB; 685d799bb9SJohn Edward Broadbent if ((estA == 0) || (estA > 11) || (estB == 0) || (estB > 11)) 695d799bb9SJohn Edward Broadbent { 705d799bb9SJohn Edward Broadbent throw InternalFailure(); 715d799bb9SJohn Edward Broadbent } 725d799bb9SJohn Edward Broadbent } 735d799bb9SJohn Edward Broadbent catch (...) 745d799bb9SJohn Edward Broadbent { 755d799bb9SJohn Edward Broadbent lg2::error("Unable to read sysfs", "REDFISH_MESSAGE_ID", 765d799bb9SJohn Edward Broadbent std::string("OpenBMC.0.1.DriveEraseFailure")); 775d799bb9SJohn Edward Broadbent lifeTimeFile.close(); 785d799bb9SJohn Edward Broadbent return 255; 795d799bb9SJohn Edward Broadbent } 805d799bb9SJohn Edward Broadbent lifeTimeFile.close(); 815d799bb9SJohn Edward Broadbent // we are returning lowest LifeLeftPercent 825d799bb9SJohn Edward Broadbent uint8_t maxLifeUsed = 0; 835d799bb9SJohn Edward Broadbent if (estA > estB) 845d799bb9SJohn Edward Broadbent { 855d799bb9SJohn Edward Broadbent maxLifeUsed = estA; 865d799bb9SJohn Edward Broadbent } 875d799bb9SJohn Edward Broadbent else 885d799bb9SJohn Edward Broadbent { 895d799bb9SJohn Edward Broadbent maxLifeUsed = estB; 905d799bb9SJohn Edward Broadbent } 915d799bb9SJohn Edward Broadbent 925d799bb9SJohn Edward Broadbent return static_cast<uint8_t>(11 - maxLifeUsed) * 10; 935d799bb9SJohn Edward Broadbent } 945d799bb9SJohn Edward Broadbent 95*d32b9667SJohn Wedig bool findDevice(const StorageData& data, const std::filesystem::path& searchDir, 96*d32b9667SJohn Wedig std::filesystem::path& deviceFile, 97*d32b9667SJohn Wedig std::filesystem::path& sysfsDir, std::string& luksName) 98*d32b9667SJohn Wedig { 99*d32b9667SJohn Wedig /* Check what type of storage device this is. */ 100*d32b9667SJohn Wedig estoraged::BasicVariantType typeVariant; 101*d32b9667SJohn Wedig try 102*d32b9667SJohn Wedig { 103*d32b9667SJohn Wedig /* The EntityManager config should have this property set. */ 104*d32b9667SJohn Wedig typeVariant = data.at("Type"); 105*d32b9667SJohn Wedig } 106*d32b9667SJohn Wedig catch (const boost::container::out_of_range& e) 107*d32b9667SJohn Wedig { 108*d32b9667SJohn Wedig lg2::error("Could not read device type", "REDFISH_MESSAGE_ID", 109*d32b9667SJohn Wedig std::string("OpenBMC.0.1.FindDeviceFail")); 110*d32b9667SJohn Wedig return false; 111*d32b9667SJohn Wedig } 112*d32b9667SJohn Wedig 113*d32b9667SJohn Wedig /* 114*d32b9667SJohn Wedig * Currently, we only support eMMC, so report an error for any other device 115*d32b9667SJohn Wedig * types. 116*d32b9667SJohn Wedig */ 117*d32b9667SJohn Wedig std::string type = std::get<std::string>(typeVariant); 118*d32b9667SJohn Wedig if (type.compare("EmmcDevice") != 0) 119*d32b9667SJohn Wedig { 120*d32b9667SJohn Wedig lg2::error("Unsupported device type {TYPE}", "TYPE", type, 121*d32b9667SJohn Wedig "REDFISH_MESSAGE_ID", 122*d32b9667SJohn Wedig std::string("OpenBMC.0.1.FindDeviceFail")); 123*d32b9667SJohn Wedig return false; 124*d32b9667SJohn Wedig } 125*d32b9667SJohn Wedig 126*d32b9667SJohn Wedig /* Look for the eMMC in the specified searchDir directory. */ 127*d32b9667SJohn Wedig for (auto const& dirEntry : std::filesystem::directory_iterator{searchDir}) 128*d32b9667SJohn Wedig { 129*d32b9667SJohn Wedig std::filesystem::path curDevice(dirEntry.path().filename()); 130*d32b9667SJohn Wedig if (curDevice.string().starts_with("mmcblk")) 131*d32b9667SJohn Wedig { 132*d32b9667SJohn Wedig sysfsDir = dirEntry.path(); 133*d32b9667SJohn Wedig sysfsDir /= "device"; 134*d32b9667SJohn Wedig 135*d32b9667SJohn Wedig deviceFile = "/dev"; 136*d32b9667SJohn Wedig deviceFile /= curDevice; 137*d32b9667SJohn Wedig 138*d32b9667SJohn Wedig luksName = "luks-" + curDevice.string(); 139*d32b9667SJohn Wedig return true; 140*d32b9667SJohn Wedig } 141*d32b9667SJohn Wedig } 142*d32b9667SJohn Wedig 143*d32b9667SJohn Wedig /* Device wasn't found. */ 144*d32b9667SJohn Wedig return false; 145*d32b9667SJohn Wedig } 146*d32b9667SJohn Wedig 147a6e3b99dSJohn Edward Broadbent } // namespace util 148a6e3b99dSJohn Edward Broadbent 149a6e3b99dSJohn Edward Broadbent } // namespace estoraged 150