Merge pull request 'Add support for nvme' (#61) from feature/nvme_support into master

Reviewed-on: #61

astyle.sh

@@ -1,17 +0,0 @@
-#! /bin/bash
-
-echo starting astyle for $PWD
-
-astyle --style=gnu src/*.cpp
-rm -f src/*.orig
-
-astyle --style=gnu src/logger/*.cpp
-rm -f src/logger/*.orig
-
-astyle --style=gnu include/*.h
-rm -f include/*.orig
-
-astyle --style=gnu include/logger/*.h
-rm -f include//logger/*.orig
-
-echo finished astyle for $PWD

include/delete.h

@@ -13,13 +13,11 @@
 class Delete
 {
 protected:
-
 public:
     static void deleteDrive(Drive *drive);
 
 private:
     Delete(void);
-
 };
 
 #endif // DELETE_H_

include/drive.h

@@ -14,7 +14,9 @@ class Drive
 {
 
 public:
-    enum TaskState {NONE,
+    enum TaskState
+    {
+        NONE,
         SHRED_SELECTED,
         SHRED_ACTIVE, // shred iterations active
         CHECK_ACTIVE, // optional checking active
@@ -60,7 +62,6 @@ private:
     void setTimestamp();
 
 protected:
-
 public:
     Drive(string path)
     {
@@ -101,7 +102,6 @@ public:
 
     void calculateTaskDuration();
     time_t getTaskDuration();
-
 };
 
 #endif // DRIVE_H_

include/logger/logger.h

@@ -68,7 +68,6 @@ private:
     ~Logger();
 
 public:
-
     void info(string s);
     void warning(string s);
     void error(string s);

include/printer.h

@@ -39,11 +39,9 @@ typedef struct
     t_driveData driveData;
 } t_msgQueueData;
 
-
 class Printer
 {
 protected:
-
 public:
     static Printer *getPrinter();
     void print(Drive *drive);
@@ -54,7 +52,5 @@ private:
     int msqid;
     Printer();
     ~Printer();
-
-
 };
 #endif // PRINTER_H_

include/reHDD.h

@@ -8,7 +8,7 @@
 #ifndef REHDD_H_
 #define REHDD_H_
 
-#define REHDD_VERSION "bV1.1.0"
+#define REHDD_VERSION "V1.1.1"
 
 // Drive handling Settings
 #define WORSE_HOURS 19200    // mark drive if at this limit or beyond
@@ -20,9 +20,9 @@
 
 // Logger Settings
 #define LOG_PATH "./reHDD.log"
-#define DESCRIPTION "reHDD - Copyright Hendrik Schutter 2022"
+#define DESCRIPTION "reHDD - Copyright Hendrik Schutter 2024"
 #define DEVICE_ID "generic"
-#define SOFTWARE_VERSION  "alpha"
+#define SOFTWARE_VERSION REHDD_VERSION
 #define HARDWARE_VERSION "generic"
 
 // #define LOG_LEVEL_HIGH  //log everything, like drive scan thread
@@ -69,7 +69,8 @@ using namespace std;
 
 extern Logger *logging;
 
-template <typename T, typename I> T* iterator_to_pointer(I i)
+template <typename T, typename I>
+T *iterator_to_pointer(I i)
 {
     return (&(*i));
 }
@@ -77,18 +78,17 @@ template <typename T, typename I> T* iterator_to_pointer(I i)
 class reHDD
 {
 protected:
-
 public:
     reHDD(void);
     static void app_logic();
 
 private:
-
     static void searchDrives(list<Drive> *plistDrives);
     static void printDrives(list<Drive> *plistDrives);
     static void startShredAllDrives(list<Drive> *plistDrives);
     static void updateShredMetrics(list<Drive> *plistDrives);
     static void filterIgnoredDrives(list<Drive> *plistDrives);
+    static void filterInvalidDrives(list<Drive> *plistDrives);
     static void filterNewDrives(list<Drive> *plistOldDrives, list<Drive> *plistNewDrives);
     static void addSMARTData(list<Drive> *plistDrives);
     static void ThreadScanDevices();

include/shred.h

@@ -17,7 +17,6 @@
 #include <unistd.h>
 #include <string.h>
 
-
 #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
 
@@ -31,9 +30,7 @@ typedef int fileDescriptor;
 class Shred
 {
 protected:
-
 public:
-
     Shred();
     ~Shred();
     int shredDrive(Drive *drive, int *ipSignalFd);
@@ -53,7 +50,6 @@ private:
     unsigned long getDriveSizeInBytes(fileDescriptor file);
     unsigned int uiCalcChecksum(fileDescriptor file, Drive *drive, int *ipSignalFd);
     void cleanup();
-
 };
 
 #endif // SHRED_H_

include/smart.h

@@ -13,13 +13,13 @@
 class SMART
 {
 protected:
-
 public:
     static void readSMARTData(Drive *drive);
 
 private:
     SMART(void);
 
+    static uint8_t parseExitStatus(string sLine);
     static void parseModelFamily(string sLine);
     static void parseModelName(string sLine);
     static void parseSerial(string sLine);

include/tui.h

@@ -20,10 +20,19 @@
 class TUI
 {
 protected:
-
 public:
-
+    enum UserInput
-    enum UserInput { UpKey, DownKey, Abort, Shred, ShredAll, Delete, Enter, ESC, Undefined};
+    {
+        UpKey,
+        DownKey,
+        Abort,
+        Shred,
+        ShredAll,
+        Delete,
+        Enter,
+        ESC,
+        Undefined
+    };
     struct MenuState
     {
         bool bAbort;

makefile

@@ -10,9 +10,9 @@ SRC_PATH = src
 # Space-separated pkg-config libraries used by this project
 LIBS = lib
 # General compiler flags
-COMPILE_FLAGS = -std=c++17 -Wall -Wextra -g
+COMPILE_FLAGS = -std=c++23 -Wall -Wextra -g
 # Additional release-specific flags
-RCOMPILE_FLAGS = -D NDEBUG -O3
+RCOMPILE_FLAGS = -D NDEBUG -Ofast
 # Additional debug-specific flags
 DCOMPILE_FLAGS = -D DEBUG
 # Add additional include paths

src/drive.cpp

@@ -98,7 +98,8 @@ string Drive::sPowerCyclesToText()
 
 string Drive::sTemperatureToText()
 {
-    return to_string(getTemperature())+" C";;
+    return to_string(getTemperature()) + " C";
+    ;
 }
 
 void Drive::setTaskPercentage(double d32TaskPercentage)
@@ -114,7 +115,6 @@ double Drive::getTaskPercentage(void)
     return this->d32TaskPercentage;
 }
 
-
 /**
  * \brief   set S.M.A.R.T. values in model
  * \param	string modelFamily

src/logger/logger.cpp

@@ -5,7 +5,6 @@
  * @date    04.09.2020
  */
 
-
 #include "../../include/reHDD.h" //for logger settings
 #include "../../include/logger/logger.h"
 
@@ -153,7 +152,6 @@ string Logger::getMacAddress()
     if (ioctl(s, SIOCGIFHWADDR, &ifr) < 0)
     {
         strcpy(ifr.ifr_name, "eno1");
-
     }
 
     unsigned char *hwaddr = (unsigned char *)ifr.ifr_hwaddr.sa_data;
@@ -229,5 +227,3 @@ Logger* Logger::logThis()
         return single; // return existing obj
     }
 }
-
-

src/printer.cpp

@@ -58,12 +58,13 @@ void Printer::print(Drive* drive)
     if (-1 == msgsnd(this->msqid, &msgQueueData, sizeof(t_msgQueueData) - sizeof(long), 0))
     {
         Logger::logThis()->error("Printer: Send mgs queue failed!");
-        }else{
+    }
+    else
+    {
         Logger::logThis()->info("Printer: print triggered - Drive: " + drive->getSerial());
     }
 }
 
-
 /**
  * \brief   return a instance of the printer
  * \return  printer obj

src/reHDD.cpp

@@ -107,6 +107,7 @@ void reHDD::ThreadScanDevices()
         searchDrives(&listNewDrives);        // search for new drives and store them in list
         filterIgnoredDrives(&listNewDrives); // filter out ignored drives
         addSMARTData(&listNewDrives);        // add S.M.A.R.T. Data to the drives
+        filterInvalidDrives(&listNewDrives); // filter out drives that report zero capacity
         mxDrives.unlock();
         write(fdNewDrivesInformPipe[1], "A", 1);
         sleep(5); // sleep 5 sec
@@ -305,7 +306,7 @@ void reHDD::searchDrives(list <Drive>* plistDrives)
     char *cLine = NULL;
     size_t len = 0;
 
-    FILE* outputfileHwinfo = popen("lsblk -I 8 -d -o NAME", "r");
+    FILE *outputfileHwinfo = popen("lsblk -e 11 -d -o NAME", "r");
 
     if (outputfileHwinfo == NULL)
     {
@@ -321,7 +322,16 @@ void reHDD::searchDrives(list <Drive>* plistDrives)
             tmpDrive->state = Drive::NONE;
             tmpDrive->bIsOffline = false;
             plistDrives->push_back(*tmpDrive);
-                    //Logger::logThis()->info("drive found: " + tmpDrive->getPath());
+            // Logger::logThis()->info("SATA drive found: " + tmpDrive->getPath());
+        }
+
+        if (string(cLine).length() == 8)
+        {
+            Drive *tmpDrive = new Drive("/dev/" + string(cLine).substr(0, 7));
+            tmpDrive->state = Drive::NONE;
+            tmpDrive->bIsOffline = false;
+            plistDrives->push_back(*tmpDrive);
+            // Logger::logThis()->info("NVME drive found: " + tmpDrive->getPath());
         }
     }
     pclose(outputfileHwinfo);
@@ -387,6 +397,27 @@ void reHDD::filterIgnoredDrives(list <Drive>* plistDrives)
     }
 }
 
+/**
+ * \brief   filter out drives that are not indented for processing
+ * \param	pointer of list <Drive>* plistDrives
+ * \return  void
+ */
+void reHDD::filterInvalidDrives(list<Drive> *plistDrives)
+{
+    list<Drive>::iterator it;
+    for (it = plistDrives->begin(); it != plistDrives->end(); ++it)
+    {
+        if (it->getCapacity() == 0U)
+        {
+#ifdef LOG_LEVEL_HIGH
+            Logger::logThis()->info("Drive reports zero capacity --> ignore this drive: " + it->getPath());
+#endif
+            it = plistDrives->erase(it);
+            it--;
+        }
+    }
+}
+
 /**
  * \brief   start shred for all drives
  * \param	pointer of list <Drive>* plistDrives
@@ -574,6 +605,3 @@ void reHDD::handleAbort()
         }
     }
 }
-
-
-

src/shred.cpp

@@ -8,7 +8,8 @@
 #include "../include/reHDD.h"
 
 #ifdef __cplusplus
-extern "C" {
+extern "C"
+{
 #endif
 #include "../tfnoisegen/tfprng.h"
 #ifdef __cplusplus
@@ -89,7 +90,8 @@ int Shred::shredDrive(Drive* drive, int* ipSignalFd)
     tfng_prng_seedkey(ucKey);
 
     this->ulDriveByteSize = getDriveSizeInBytes(driveFileDiscr);
-    drive->sShredSpeed.chronoShredTimestamp = std::chrono::system_clock::now();; //set inital timestamp for speed metric
+    drive->sShredSpeed.chronoShredTimestamp = std::chrono::system_clock::now();
+    ;                                                  // set inital timestamp for speed metric
     drive->sShredSpeed.ulSpeedMetricBytesWritten = 0U; // uses to calculate speed metric
 
 #ifdef LOG_LEVEL_HIGH

src/smart.cpp

@@ -32,19 +32,25 @@ void SMART::readSMARTData(Drive* drive)
     powerCycle = 0U;
     temperature = 0U;
 
-    size_t len = 0; //lenght of found line
+    string sSmartctlCommands[] = {" --json -a ", " --json -d sntjmicron -a ", " --json -d sntasmedia -a ", " --json -d sntrealtek -a "};
-    char* cLine = NULL; //found line
 
-    string sCMD = ("smartctl --json -a ");
+    for (string sSmartctlCommand : sSmartctlCommands)
+    {
+        string sCMD = ("smartctl");
+        sCMD.append(sSmartctlCommand);
         sCMD.append(drive->getPath());
         const char *cpComand = sCMD.c_str();
 
         FILE *outputfileSmart = popen(cpComand, "r");
+        size_t len = 0;     // length of found line
+        char *cLine = NULL; // found line
+        uint8_t status = 255;
 
         while ((getline(&cLine, &len, outputfileSmart)) != -1)
         {
             string sLine = string(cLine);
 
+            status = SMART::parseExitStatus(sLine);
             SMART::parseModelFamily(sLine);
             SMART::parseModelName(sLine);
             SMART::parseSerial(sLine);
@@ -54,10 +60,37 @@ void SMART::readSMARTData(Drive* drive)
             SMART::parsePowerCycle(sLine);
             SMART::parseTemperature(sLine);
         }
+
         pclose(outputfileSmart);
+
+        if (status == 0U)
+        {
+            // Found S.M.A.R.T. data with this command
+            break;
+        }
+    }
+
     drive->setDriveSMARTData(modelFamily, modelName, serial, capacity, errorCount, powerOnHours, powerCycle, temperature); // wirte data in drive
 }
 
+/**
+ * \brief   parse ExitStatus
+ * \param	string output line of smartctl
+ * \return  uint_8 exit status
+ */
+uint8_t SMART::parseExitStatus(string sLine)
+{
+    uint8_t exitStatus = -1;
+    string search("\"exit_status\": ");
+    size_t found = sLine.find(search);
+    if (found != string::npos)
+    {
+        sLine.erase(0, sLine.find(": ") + 1);
+        exitStatus = stol(sLine);
+    }
+    return exitStatus;
+}
+
 /**
  * \brief   parse ModelFamiliy
  * \param	string output line of smartctl
@@ -157,7 +190,6 @@ void SMART::parsePowerOnHours(string sLine)
         sLine.erase(0, sLine.find(": ") + 2);
         sLine.erase(sLine.length() - 1, 1);
         powerOnHours = stol(sLine);
-
     }
 }
 
@@ -175,7 +207,6 @@ void SMART::parsePowerCycle(string sLine)
         sLine.erase(0, sLine.find(": ") + 2);
         sLine.erase(sLine.length() - 2, 2);
         powerCycle = stol(sLine);
-
     }
 }
 
@@ -194,7 +225,7 @@ void SMART::parseTemperature(string sLine)
         sLine.erase(sLine.length() - 1, 2);
         if (sLine == "{")
         {
-                    temperature = 0U; // this drive doesn't support temperatur
+            temperature = 0U; // this drive doesn't support temperature
         }
         else
         {

src/tui.cpp

@@ -11,7 +11,6 @@ static std::mutex mxUIrefresh;
 
 TUI::TUI(void)
 {
-
 }
 
 /**