Merge branch 'master' into feature/shred-speedup

Reviewed-on: #92
Co-authored-by: localhorst <localhorst@mosad.xyz>
Co-committed-by: localhorst <localhorst@mosad.xyz>

README.md

@@ -16,9 +16,9 @@ Use [Etcher](https://www.balena.io/etcher/#download) or `dd` to create an bootab
 ## Screenshot 
 ![Screenshot of reHDD with multiple drives in different states](https://git.mosad.xyz/localhorst/reHDD/raw/commit/c40dfe2cbb8f86490b49caf82db70a10015f06f9/doc/screenshot.png "Screenshot")
 
-## Debian Build Notes
+## openSUSE Build Notes
 
-* `apt-get install ncurses-dev git make g++`
+* `zypper install ncurses-devel git make gcc-c++`
 * `git submodule init`
 * `git submodule update`
 * `make release`
@@ -28,16 +28,8 @@ Use [Etcher](https://www.balena.io/etcher/#download) or `dd` to create an bootab
 Just install [reHDDPrinter](https://git.mosad.xyz/localhorst/reHDDPrinter).
 No further settings needed.
 
-## Create Standalone with Debian 11
-
-Instructions how to create a standalone machine that boots directly to reHDD. This is aimed for production use, like several drives a day shredding.
-* Start reHDD after boot without login (as a tty1 shell)
-* Start dmesg after boot without login (as a tty2 shell)
-* Start htop after boot without login (as a tty3 shell)
-* Upload reHDD log every 12h if wanted
-
 ### Software requirements
-* `apt-get install hwinfo smartmontools curl htop sudo`
+* `zypper install hwinfo smartmontools curl htop sudo`
 
 ### Installation
 
@@ -56,7 +48,7 @@ git submodule update
 
 If you want to upload the logs, edit `scripts/reHDDLogUploader.bash` with your nextcloud token
 
-Add your system drive in `/root/reHDD/ignoreDrives.conf` like:
+Add ignored drives in `/root/reHDD/ignoreDrives.conf` like:
 ```e102f49d```
 Get the first 8 Bytes from your UUID via `blkid /dev/sdX`
 

include/reHDD.h

@@ -8,7 +8,7 @@
 #ifndef REHDD_H_
 #define REHDD_H_
 
-#define REHDD_VERSION "V1.2.1"
+#define REHDD_VERSION "V1.3.0"
 
 // Drive handling Settings
 #define WORSE_HOURS 19200    // mark drive if at this limit or beyond
@@ -90,10 +90,12 @@ private:
     static void filterInvalidDrives(list<Drive> *plistDrives);
     static void filterNewDrives(list<Drive> *plistOldDrives, list<Drive> *plistNewDrives);
     static void addSMARTData(list<Drive> *plistDrives);
+    static void printAllDrives(list<Drive> *plistDrives);
+    static void printDrive(Drive *const pDrive);
     static void ThreadScanDevices();
     static void ThreadUserInput();
     static void ThreadShred(Drive *const pDrive);
-    static void ThreadDelete();
+    static void ThreadDelete(Drive *const pDrive);
     static void ThreadCheckFrozenDrives();
     static void handleArrowKey(TUI::UserInput userInput);
     static void handleEnter();

include/shred.h

@@ -19,6 +19,7 @@
 
 #define CHUNK_SIZE 1024 * 1024 * 32 // amount of bytes that are overwritten at once --> 32MB
 #define TFNG_DATA_SIZE CHUNK_SIZE   // amount of bytes used by tfng
+#define O_DIRECT_PAGE_SIZE 4096     // needed page size for O_DIRECT
 
 // #define DEMO_DRIVE_SIZE 1024*1024*256L // 256MB
 // #define DEMO_DRIVE_SIZE 1024*1024*1024L // 1GB
@@ -38,8 +39,8 @@ public:
 private:
     fileDescriptor randomSrcFileDiscr;
     fileDescriptor driveFileDiscr;
-    unsigned char caTfngData[TFNG_DATA_SIZE];
+    unsigned char *caTfngData;
-    unsigned char caReadBuffer[CHUNK_SIZE];
+    unsigned char *caReadBuffer;
     unsigned long ulDriveByteSize;
     unsigned long ulDriveByteOverallCount = 0; // all bytes shredded in all iterations + checking -> used for progress calculation
     double d32Percent = 0.0;

include/tui.h

@@ -32,6 +32,8 @@ public:
         Enter,
         ESC,
         Terminate,
+        Print,
+        PrintAll,
         Undefined
     };
     struct MenuState

src/reHDD.cpp

@@ -216,34 +216,84 @@ void reHDD::ThreadUserInput()
             sleep(5);     // sleep 5 sec
             std::exit(1); // Terminates main, doesn't wait for threads
             break;
+        case TUI::UserInput::Print:
+            // cout << "Print" << endl;
+            if (tmpSelectedDrive != nullptr)
+            {
+                printDrive(tmpSelectedDrive);
+            }
+            ui->updateTUI(&listDrives, u16SelectedEntry);
+            break;
+        case TUI::UserInput::PrintAll:
+            // cout << "PrintAll" << endl;
+            printAllDrives(&listDrives);
+            ui->updateTUI(&listDrives, u16SelectedEntry);
+            break;
         default:
             break;
         }
     }
 }
 
+/**
+ * \brief   print all shredded drives
+ * \param	pointer of list <Drive>* plistDrives
+ * \return  void
+ */
+void reHDD::printAllDrives(list<Drive> *plistDrives)
+{
+    list<Drive>::iterator it;
+    mxDrives.lock();
+    for (it = plistDrives->begin(); it != plistDrives->end(); ++it)
+    {
+        Drive *pTmpDrive = iterator_to_pointer<Drive, std::list<Drive>::iterator>(it);
+        printDrive(pTmpDrive);
+    }
+    mxDrives.unlock();
+}
+
+/**
+ * \brief   print a shredded drives
+ * \param	pointer of a drive
+ * \return  void
+ */
+void reHDD::printDrive(Drive *const pDrive)
+{
+    if (pDrive->bWasShredded)
+    {
+#ifdef ZERO_CHECK
+        if (pDrive->bWasChecked && (pDrive->u32DriveChecksumAfterShredding != 0U))
+        {
+            return; // Drive was shredded&checked but checksum failed, don't print label
+        }
+#endif
+        Logger::logThis()->info("User print for: " + pDrive->getModelName() + "-" + pDrive->getSerial());
+        Printer::getPrinter()->print(pDrive);
+    }
+}
+
 void reHDD::ThreadShred(Drive *const pDrive)
 {
     if (pDrive != nullptr)
     {
         pDrive->setActionStartTimestamp();                         // save timestamp at start of shredding
-        Shred *pShredTask = new Shred();                       // create new shred task
+        Shred *pShredInstance = new Shred();                       // create new shred task
-        pShredTask->shredDrive(pDrive, &fdShredInformPipe[1]); // start new shred task
+        pShredInstance->shredDrive(pDrive, &fdShredInformPipe[1]); // start new shred task
-        delete pShredTask;                                     // delete shred task
+        delete pShredInstance;                                     // delete shred task
         ui->updateTUI(&listDrives, u16SelectedEntry);
     }
 }
 
-void reHDD::ThreadDelete()
+void reHDD::ThreadDelete(Drive *const pDrive)
 {
-    Drive *tmpSelectedDrive = getSelectedDrive();
+    if (pDrive != nullptr)
-    if (tmpSelectedDrive != nullptr)
     {
-        tmpSelectedDrive->setActionStartTimestamp();      // save timestamp at start of deleting
+        pDrive->state = Drive::TaskState::DELETE_ACTIVE;
-        Delete::deleteDrive(tmpSelectedDrive);            // blocking, no thread
+        pDrive->setActionStartTimestamp();      // save timestamp at start of deleting
-        tmpSelectedDrive->state = Drive::TaskState::NONE; // delete finished
+        Delete::deleteDrive(pDrive);            // blocking, no thread
-        tmpSelectedDrive->bWasDeleted = true;
+        pDrive->state = Drive::TaskState::NONE; // delete finished
-        Logger::logThis()->info("Finished delete for: " + tmpSelectedDrive->getModelName() + "-" + tmpSelectedDrive->getSerial());
+        pDrive->bWasDeleted = true;
+        Logger::logThis()->info("Finished delete for: " + pDrive->getModelName() + "-" + pDrive->getSerial());
         ui->updateTUI(&listDrives, u16SelectedEntry);
     }
 }
@@ -368,7 +418,7 @@ void reHDD::searchDrives(std::list<Drive> *plistDrives)
 }
 
 /**
- * \brief   filter out drives that are listed in "ignoreDrives.conf"
+ * \brief   filter out drives that are listed in "ignoreDrives.conf", loop devices, and optical drives
  * \param   pointer of list <Drive>* plistDrives
  * \return  void
  */
@@ -378,11 +428,17 @@ void reHDD::filterIgnoredDrives(list<Drive> *plistDrives)
     if (getSystemDrive(systemDrivePath))
     {
         // Logger::logThis()->info("Found system drive: " + systemDrivePath);
-
+        list<Drive>::iterator it = plistDrives->begin();
-        list<Drive>::iterator it;
+        while (it != plistDrives->end())
-        for (it = plistDrives->begin(); it != plistDrives->end(); ++it)
         {
-            if (it->getPath().find(systemDrivePath) != std::string::npos) // compare found system drive and current drive
+            string driveName = it->getPath();
+            // Remove /dev/ prefix
+            if (driveName.find("/dev/") == 0)
+            {
+                driveName = driveName.substr(5); // Skip "/dev/"
+            }
+
+            if (systemDrivePath.find(driveName) != std::string::npos) // compare found system drive and current drive
             {
                 // system drive found --> ignore this drive
 #ifdef LOG_LEVEL_HIGH
@@ -390,59 +446,123 @@ void reHDD::filterIgnoredDrives(list<Drive> *plistDrives)
 #endif
                 it = plistDrives->erase(it);
             }
+            else
+            {
+                ++it;
+            }
         }
     }
 
-    list<tuple<string>> vtlIgnoredDevices; // store drives from ignore file
+    // Filter out loop devices (loop0, loop1, etc.)
-    ifstream input("ignoreDrives.conf");   // read ignore file
+    list<Drive>::iterator it = plistDrives->begin();
+    while (it != plistDrives->end())
+    {
+        string driveName = it->getPath();
+        if (driveName.find("/dev/") == 0)
+        {
+            driveName = driveName.substr(5);
+        }
+
+        if (driveName.find("loop") == 0)
+        {
+#ifdef LOG_LEVEL_HIGH
+            Logger::logThis()->info("loop device found --> ignore this drive: " + it->getPath());
+#endif
+            it = plistDrives->erase(it);
+        }
+        else
+        {
+            ++it;
+        }
+    }
+
+    // Filter out optical drives (sr0, sr1, cdrom, dvd, etc.)
+    it = plistDrives->begin();
+    while (it != plistDrives->end())
+    {
+        string driveName = it->getPath();
+        if (driveName.find("/dev/") == 0)
+        {
+            driveName = driveName.substr(5);
+        }
+
+        if (driveName.find("sr") == 0 ||
+            driveName.find("cdrom") == 0 ||
+            driveName.find("dvd") == 0 ||
+            driveName.find("cdrw") == 0)
+        {
+#ifdef LOG_LEVEL_HIGH
+            Logger::logThis()->info("optical drive found --> ignore this drive: " + it->getPath());
+#endif
+            it = plistDrives->erase(it);
+        }
+        else
+        {
+            ++it;
+        }
+    }
+
+    // Read ignored drives from config file
+    list<tuple<string>> vtlIgnoredDevices;
+    ifstream input("ignoreDrives.conf");
 
     for (string sLine; getline(input, sLine);)
     {
-        // Logger::logThis()->info("read uuid: " + sLine);
+        // Skip empty lines and comments
-        vtlIgnoredDevices.emplace_back(sLine); // add found path and uuid from ignore file to vector
+        if (!sLine.empty() && sLine[0] != '#')
+        {
+            vtlIgnoredDevices.emplace_back(sLine);
         }
-    // loop through found entries in ignore file
+    }
+
+    // Loop through found entries in ignore file
     for (auto row : vtlIgnoredDevices)
     {
-        list<Drive>::iterator it;
+        it = plistDrives->begin();
-        for (it = plistDrives->begin(); it != plistDrives->end(); ++it)
+        while (it != plistDrives->end())
         {
             string sUUID;
             char *cLine = NULL;
             size_t len = 0;
             string sCMD = "blkid ";
             sCMD.append(it->getPath());
-            // cout << "cmd: " << sCMD << endl;
+
-            FILE *outputfileBlkid = popen(sCMD.c_str(), "r"); // get UUID from drive
+            FILE *outputfileBlkid = popen(sCMD.c_str(), "r");
             if (outputfileBlkid == NULL)
             {
-                exit(EXIT_FAILURE);
+                Logger::logThis()->error("Failed to execute blkid for: " + it->getPath());
+                ++it;
+                continue;
             }
 
-            while ((getline(&cLine, &len, outputfileBlkid)) != -1) // parse UUID from blkid
+            while ((getline(&cLine, &len, outputfileBlkid)) != -1)
             {
                 size_t ptuuidPos = string(cLine).find("PTUUID");
                 if (ptuuidPos != string::npos)
                 {
                     string sBlkidOut = string(cLine);
                     sBlkidOut.erase(0, ptuuidPos + 8);
+                    if (sBlkidOut.length() >= 8)
+                    {
                         sBlkidOut.erase(8, sBlkidOut.length());
+                    }
                     sUUID = sBlkidOut;
-                    // cout << "blkid uuid:" << sUUID << endl;
                 }
             }
             free(cLine);
             pclose(outputfileBlkid);
-            // cout << "blkid uuid:" << sUUID << endl;
 
-            if (!get<0>(row).compare(sUUID)) // compare uuid from ignore file and uuid from drive
+            if (!get<0>(row).compare(sUUID))
             {
-                // same uuid found than in ignore file --> ignore this drive
 #ifdef LOG_LEVEL_HIGH
-                Logger::logThis()->info("same uuid found than in ignore file --> ignore this drive: " + it->getPath());
+                Logger::logThis()->info("same uuid found in ignore file --> ignore this drive: " + it->getPath());
 #endif
                 it = plistDrives->erase(it);
             }
+            else
+            {
+                ++it;
+            }
         }
     }
 }
@@ -486,7 +606,6 @@ void reHDD::startShredAllDrives(list<Drive> *plistDrives)
             address << (void const *)&(*pTmpDrive);
             Logger::logThis()->info("Started shred (all) for: " + pTmpDrive->getModelName() + "-" + pTmpDrive->getSerial() + " @" + address.str());
 #endif
-            pTmpDrive->state = Drive::TaskState::SHRED_ACTIVE;
             thread(ThreadShred, pTmpDrive).detach();
         }
     }
@@ -638,17 +757,13 @@ void reHDD::handleEnter()
         if (tmpSelectedDrive->state == Drive::TaskState::SHRED_SELECTED)
         {
             Logger::logThis()->info("Started shred/check for: " + tmpSelectedDrive->getModelName() + "-" + tmpSelectedDrive->getSerial());
-            tmpSelectedDrive->state = Drive::TaskState::SHRED_ACTIVE;
-            // task for drive is running --> don't show  more task option
             thread(ThreadShred, tmpSelectedDrive).detach();
         }
 
         if (tmpSelectedDrive->state == Drive::TaskState::DELETE_SELECTED)
         {
             Logger::logThis()->info("Started delete for: " + tmpSelectedDrive->getModelName() + "-" + tmpSelectedDrive->getSerial());
-            tmpSelectedDrive->state = Drive::TaskState::DELETE_ACTIVE;
+            thread(ThreadDelete, tmpSelectedDrive).detach();
-            // task for drive is running --> don't show  more task options
-            thread(ThreadDelete).detach();
         }
     }
 }
@@ -709,14 +824,23 @@ bool reHDD::getSystemDrive(string &systemDrive)
             continue;
         }
 
-        // Logger::logThis()->info(currentLine);
+        // Extract drive name from line (removing tree characters)
-
         if ((cLine[0U] != '|') && (cLine[0U] != '`'))
         {
             systemDrive = currentLine;
-            systemDrive.erase(std::remove(systemDrive.begin(), systemDrive.end(), '\n'), systemDrive.end()); // remove newline
+
-            systemDrive.erase(std::remove(systemDrive.begin(), systemDrive.end(), ' '), systemDrive.end());  // remove spaces
+            // Find the actual drive name (after tree characters like └─, ├─)
-            // Logger::logThis()->info("Drive found: " + systemDrive);
+            size_t lastAlpha = 0;
+            for (size_t i = 0; i < systemDrive.length(); i++)
+            {
+                if (isalpha(systemDrive[i]))
+                {
+                    lastAlpha = i;
+                    break;
+                }
+            }
+
+            systemDrive = systemDrive.substr(lastAlpha);
         }
 
         if (currentLine.ends_with(" /boot/efi\n"s))
@@ -739,5 +863,17 @@ bool reHDD::getSystemDrive(string &systemDrive)
     }
     pclose(outputfileHwinfo);
 
+    // Remove mountpoint (everything after first space)
+    size_t spacePos = systemDrive.find(' ');
+    if (spacePos != std::string::npos)
+    {
+        systemDrive = systemDrive.substr(0, spacePos);
+    }
+
+    // Remove all unwanted characters
+    systemDrive.erase(std::remove(systemDrive.begin(), systemDrive.end(), '\n'), systemDrive.end());
+    systemDrive.erase(std::remove(systemDrive.begin(), systemDrive.end(), '/'), systemDrive.end());
+    systemDrive.erase(std::remove(systemDrive.begin(), systemDrive.end(), '\r'), systemDrive.end());
+
     return systemDriveFound;
 }

src/shred.cpp

@@ -21,10 +21,30 @@ const static char *randomsrc = (char *)"/dev/urandom";
 
 Shred::Shred()
 {
+    // Allocate aligned buffers for O_DIRECT
+    if (posix_memalign((void **)&caTfngData, O_DIRECT_PAGE_SIZE, TFNG_DATA_SIZE) != 0)
+    {
+        Logger::logThis()->error("Failed to allocate aligned buffer for tfng data");
+        caTfngData = nullptr;
+    }
+
+    if (posix_memalign((void **)&caReadBuffer, O_DIRECT_PAGE_SIZE, CHUNK_SIZE) != 0)
+    {
+        Logger::logThis()->error("Failed to allocate aligned buffer for read buffer");
+        caReadBuffer = nullptr;
+    }
 }
 
 Shred::~Shred()
 {
+    if (caTfngData != nullptr)
+    {
+        free(caTfngData);
+    }
+    if (caReadBuffer != nullptr)
+    {
+        free(caReadBuffer);
+    }
 }
 
 /**
@@ -38,14 +58,20 @@ int Shred::shredDrive(Drive *drive, int *ipSignalFd)
     address << (void const *)&(*drive);
     Logger::logThis()->info("Shred-Task started - Drive: " + drive->getModelName() + "-" + drive->getSerial() + " @" + address.str());
     drive->bWasShredStarted = true; // Mark drive as partly shredded
+    drive->bWasShredded = false;
+    drive->setTaskPercentage(0.0);
+    drive->u32DriveChecksumAfterShredding = UINT32_MAX;
+    drive->state = Drive::TaskState::SHRED_ACTIVE;
+
+    if ((caTfngData == nullptr) || (caReadBuffer == nullptr))
+    {
+        Logger::logThis()->error("Shred-Task: Aligned memory not available! - Drive: " + drive->getSerial());
+        return -1;
+    }
 
 #ifdef DRYRUN
-    for (int i = 0; i <= 500; i++)
+    for (int i = 0; i <= 100; i++)
     {
-        if (drive->state.load() != Drive::TaskState::SHRED_ACTIVE)
-        {
-            return 0;
-        }
         drive->setTaskPercentage(i + 0.05);
         write(*ipSignalFd, "A", 1);
         usleep(20000);
@@ -69,7 +95,13 @@ int Shred::shredDrive(Drive *drive, int *ipSignalFd)
     }
 
     // open disk
+    driveFileDiscr = open(cpDrivePath, O_RDWR | O_LARGEFILE | O_DIRECT);
+    if (driveFileDiscr == -1 && errno == EINVAL)
+    {
         driveFileDiscr = open(cpDrivePath, O_RDWR | O_LARGEFILE);
+        Logger::logThis()->warning("O_DIRECT not supported, using standard I/O - Drive: " + drive->getSerial());
+    }
+
     if (driveFileDiscr == -1)
     {
         std::string errorMsg(strerror(errno));
@@ -204,9 +236,8 @@ int Shred::shredDrive(Drive *drive, int *ipSignalFd)
         Logger::logThis()->info("Shred-Task: Checksum zero: " + to_string(drive->u32DriveChecksumAfterShredding) + " - Drive: " + drive->getSerial());
     }
 #endif
-#endif
-
     cleanup();
+#endif
 
     if ((drive->state.load() == Drive::TaskState::SHRED_ACTIVE) || (drive->state.load() == Drive::TaskState::CHECK_SUCCESSFUL) || (drive->state == Drive::TaskState::CHECK_FAILED))
     {

src/tui.cpp

@@ -259,6 +259,12 @@ enum TUI::UserInput TUI::readUserInput()
     case 'T':
         return TUI::UserInput::Terminate;
         break;
+    case 'p':
+        return TUI::UserInput::Print;
+        break;
+    case 'P':
+        return TUI::UserInput::PrintAll;
+        break;
     default:
         return TUI::UserInput::Undefined;
         break;
@@ -348,7 +354,7 @@ WINDOW *TUI::overwriteDetailViewWindow(int iXSize, int iYSize, int iXStart)
 
     string sLine01 = "reHDD - hard drive refurbishing tool";
     string sLine02 = "Version: " + string(REHDD_VERSION);
-    string sLine03 = "Available under GPL 3.0";
+    string sLine03 = "Free software under the GNU GPL 3.0";
     string sLine04 = "https://git.mosad.xyz/localhorst/reHDD";
     string sLine05 = "Delete: Wipe format table - this is NOT secure";
     string sLine06 = "Shred: Overwrite drive " + to_string(SHRED_ITERATIONS) + " iterations - this is secure";
@@ -466,7 +472,7 @@ WINDOW *TUI::createSystemStats(int iXSize, int iYSize, int iXStart, int iYStart)
     sLine03.append(__DATE__);
     sLine03.append(" ");
     sLine03.append(__TIME__);
-    string sLine04 = "Available under GPL 3.0";
+    string sLine04 = "Free software under the GNU GPL 3.0";
     string sLine05 = "https://git.mosad.xyz/localhorst/reHDD";
 
     uint16_t u16Line = 2;
@@ -493,7 +499,7 @@ WINDOW *TUI::createMenuView(int iXSize, int iYSize, int iXStart, int iYStart, st
 
     centerTitle(newWindow, "Controls");
 
-    uint16_t u16Line = 4;
+    uint16_t u16Line = 2;
 
     if (menustate.bAbort)
     {
@@ -514,7 +520,11 @@ WINDOW *TUI::createMenuView(int iXSize, int iYSize, int iXStart, int iYStart, st
         u16Line++;
     }
 
-    string sLineTmp = "Press T for terminating reHDD";
+    string sLineTmp = "Press p for Print (P for all drives)";
+    mvwaddstr(newWindow, u16Line++, (iXSize / 2) - (sLineTmp.size() / 2), sLineTmp.c_str());
+    u16Line++;
+
+    sLineTmp = "Press T for terminating reHDD";
     mvwaddstr(newWindow, u16Line++, (iXSize / 2) - (sLineTmp.size() / 2), sLineTmp.c_str());
 
     return newWindow;