feat: Finish reassign_blocks

Finishing adding support for CLI option to reassign blocks on a SCSI device

Author: vonericsen

include/openseachest_util_options.h

@@ -2493,6 +2493,18 @@ extern "C"
     }
 #define SCSI_DEFECTS_LONG_OPTS SCSI_DEFECTS_LONG_OPT, SCSI_DEFECTS_MODE_LONG_OPTS
 
+// Reallocate Blocks Options
+#define SCSI_REALLOCATE_BLOCKS_LIST       scsiReallocateBlocksList
+#define SCSI_REALLOCATE_BLOCKS_LIST_LENGTH scsiReallocateBlocksListLength
+#define SCSI_REALLOCATE_BLOCKS_LIST_VARS \
+    ptrErrorLBA SCSI_REALLOCATE_BLOCKS_LIST = M_NULLPTR; \
+    uint32_t SCSI_REALLOCATE_BLOCKS_LIST_LENGTH = UINT32_C(0);
+#define SCSI_REALLOCATE_BLOCKS_LIST_LONG_OPT_STRING "reallocateBlocks"
+#define SCSI_REALLOCATE_BLOCKS_LIST_LONG_OPT                                                                                 \
+    {                                                                                                                  \
+        SCSI_REALLOCATE_BLOCKS_LIST_LONG_OPT_STRING, required_argument, M_NULLPTR, 0                                  \
+    }
+
 // logTransferLength
 #define LOG_TRANSFER_LENGTH_BYTES logTransferLengthBytes
 #define LOG_TRANSFER_LENGTH_BYTES_VAR                                                                                  \
@@ -3645,20 +3657,15 @@ extern "C"
 
     void print_Elevated_Privileges_Text(void);
 
-    //-----------------------------------------------------------------------------
-    //
-    //  print_Final_newline()
-    //
-    //! \brief   Description:  This function prints out a single newline character. This is meant to be used with
-    //! atexit() for a newline space before returning to the command prompt.
-    //
-    //  Entry:
-    //!
-    //  Exit:
+    //! \fn void atexit_Print_Final_newline(void)
+    //! \brief Prints a final newline for the program and flushes stderr and stdout. Used in atexit().
+    //! \see https://wiki.sei.cmu.edu/confluence/display/c/FIO23-C.+Do+not+exit+with+unflushed+data+in+stdout+or+stderr
+    void atexit_Print_Final_newline(void);
 
-    //
-    //-----------------------------------------------------------------------------
-    void print_Final_newline(void);
+    M_DEPRECATED_REASON("Use atexit_Print_Final_newline instead.") M_INLINE void print_Final_newline(void)
+    {
+        atexit_Print_Final_newline();
+    }
 
     //-----------------------------------------------------------------------------
     //
@@ -3677,7 +3684,12 @@ extern "C"
     //-----------------------------------------------------------------------------
     void print_Scan_Help(bool shortHelp, const char* helpdeviceHandleExample);
 
-    void print_Agressive_Scan_Help(bool shortHelp);
+    void print_Aggressive_Scan_Help(bool shortHelp);
+
+    M_DEPRECATED_REASON("Use print_Aggressive_Scan_Help instead. This one is misspelled.") M_INLINE void print_Agressive_Scan_Help(bool shortHelp)
+    {
+        print_Aggressive_Scan_Help(shortHelp);
+    }
 
     //-----------------------------------------------------------------------------
     //
@@ -4850,6 +4862,8 @@ extern "C"
 
     void print_SCSI_Defects_Format_Help(bool shortHelp);
 
+    void print_Reallocate_LBAs_Help(bool shortHelp);
+
     void print_Log_Transfer_Length_Help(bool shortHelp);
 
     void print_Log_Length_Help(bool shortHelp);

src/openseachest_util_options.c

@@ -126,7 +126,7 @@ void print_Elevated_Privileges_Text(void)
 #    elif defined(__DragonFly__)
     print_str("In DragonFlyBSD, put sudo before the command. This may require inputting your login password.\n");
     print_str("In DragonFlyBSD, log in to a root terminal (su), then execute the command. This requires the root "
-           "password.\n");
+              "password.\n");
 #    elif defined(__FreeBSD__)
     print_str("In FreeBSD, put sudo before the command. This may require inputting your login password.\n");
     print_str(
@@ -257,7 +257,7 @@ void utility_Full_Version_Info(const char* utilityName,
 
 // This function is used in at_exit() only.
 // It will flush stdout and stderr after printing one final newline character.
-void print_Final_newline(void)
+void atexit_Print_Final_newline(void)
 {
     print_str("\n");
     // Flushing stdout and stderr
@@ -373,7 +373,7 @@ void print_Scan_Help(bool shortHelp, const char* helpdeviceHandleExample)
     }
 }
 
-void print_Agressive_Scan_Help(bool shortHelp)
+void print_Aggressive_Scan_Help(bool shortHelp)
 {
     printf("\t-%c, --%s\n", AGRESSIVE_SCAN_SHORT_OPT, AGRESSIVE_SCAN_LONG_OPT_STRING);
     if (!shortHelp)
@@ -3824,6 +3824,19 @@ void print_SCSI_Defects_Format_Help(bool shortHelp)
     }
 }
 
+void print_Reallocate_LBAs_Help(bool shortHelp)
+{
+    printf("\t--%s [address,address,...]\t(SAS Only)\n", SCSI_REALLOCATE_BLOCKS_LIST_LONG_OPT_STRING);
+    if (!shortHelp)
+    {
+        print_str("\t\tThis option will reallocate the specified LBAs on a SCSI device.\n");
+        print_str("\t\tMultiple LBAs can be specified by separating them with commas.\n");
+        print_str("\t\tFor SATA and NVMe devices, this will be passed to a SCSI translator\n");
+        print_str("\t\twhich will handle all translation of this command.\n");
+        print_str("\t\tEx: --reallocate-blocks 123456,234567,345678\n\n");
+    }
+}
+
 void print_Show_Concurrent_Position_Ranges_Help(bool shortHelp)
 {
     printf("\t--%s\n", SHOW_CONCURRENT_RANGES_LONG_OPT_STRING);

subprojects/opensea-operations

@@ -147,7 +147,7 @@ int main(int argc, char* argv[])
         CAPACITY_MODEL_NUMBER_MAPPING_LONG_OPT,
         CHANGE_ID_STRING_LONG_OPT,
         SAT_INFO_LONG_OPT,
-        
+
         SCAN_LONG_OPT,
         NO_BANNER_OPT,
         AGRESSIVE_SCAN_LONG_OPT,
@@ -709,7 +709,7 @@ int main(int argc, char* argv[])
         }
     }
 
-    if (0 != atexit(print_Final_newline))
+    if (0 != atexit(atexit_Print_Final_newline))
     {
         perror("Registering final newline print");
     }
@@ -2519,7 +2519,7 @@ void utility_Usage(bool shortUsage)
     // Common (across utilities) - alphabetized
     print_Scan_Help(shortUsage, deviceHandleExample);
     print_Scan_Flags_Help(shortUsage);
-    print_Agressive_Scan_Help(shortUsage);
+    print_Aggressive_Scan_Help(shortUsage);
     print_Device_Help(shortUsage, deviceHandleExample);
     print_Device_Information_Help(shortUsage);
     print_Low_Level_Info_Help(shortUsage);

subprojects/opensea-transport

@@ -149,7 +149,7 @@ int main(int argc, char* argv[])
         CAPACITY_MODEL_NUMBER_MAPPING_LONG_OPT,
         CHANGE_ID_STRING_LONG_OPT,
         SAT_INFO_LONG_OPT,
-        
+
         SCAN_LONG_OPT,
         AGRESSIVE_SCAN_LONG_OPT,
         SCAN_FLAGS_LONG_OPT,
@@ -1523,7 +1523,7 @@ int main(int argc, char* argv[])
         }
     }
 
-    if (0 != atexit(print_Final_newline))
+    if (0 != atexit(atexit_Print_Final_newline))
     {
         perror("Registering final newline print");
     }
@@ -4692,7 +4692,7 @@ void utility_Usage(bool shortUsage)
     print_Device_Information_Help(shortUsage);
     print_Low_Level_Info_Help(shortUsage);
     print_Scan_Help(shortUsage, deviceHandleExample);
-    print_Agressive_Scan_Help(shortUsage);
+    print_Aggressive_Scan_Help(shortUsage);
     print_SAT_Info_Help(shortUsage);
     print_Test_Unit_Ready_Help(shortUsage);
     print_Fast_Discovery_Help(shortUsage);