ImageTool: Add debug symbols path argument

We need to have the ability to put custom path with binary containing debug symbols into ImageTool, because currently it uses the path to stripped binary without debug symbols Signed-off-by: Savva Mitrofanov <[email protected]>
acidanthera · Aug 30, 2023 · 87db423 · 87db423
1 parent 0d546b9
commit 87db423
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/BaseTools/Conf/build_rule.template b/BaseTools/Conf/build_rule.template
@@ -362,7 +362,7 @@
         $(CP) ${src} $(DEBUG_DIR)(+)$(MODULE_NAME).strip
         $(OBJCOPY) $(OBJCOPY_STRIPFLAG) $(DEBUG_DIR)(+)$(MODULE_NAME).strip
 
-        ImageTool GenImage -c PE -x -t $(MODULE_TYPE) -o ${dst} $(DEBUG_DIR)(+)$(MODULE_NAME).strip
+        ImageTool GenImage -c PE -x -t $(MODULE_TYPE) -d ${src} -o ${dst} $(DEBUG_DIR)(+)$(MODULE_NAME).strip
 
         $(CP) ${dst} $(DEBUG_DIR)
         $(CP) ${dst} $(BIN_DIR)(+)$(MODULE_NAME_GUID).efi

diff --git a/BaseTools/ImageTool/ImageTool.c b/BaseTools/ImageTool/ImageTool.c
@@ -347,6 +347,7 @@ RETURN_STATUS
 GenExecutable (
   IN const char  *OutputFileName,
   IN const char  *InputFileName,
+  IN const char  *SymbolsPath OPTIONAL,
   IN const char  *FormatName,
   IN const char  *TypeName,
   IN const char  *BaseAddress,
@@ -397,6 +398,10 @@ GenExecutable (
     return RETURN_ABORTED;
   }
 
+  if (SymbolsPath == NULL) {
+    SymbolsPath = InputFileName;
+  }
+
   OutputFile = ToolImageEmit (
                  &OutputFileSize,
                  InputFile,
@@ -405,7 +410,7 @@ GenExecutable (
                  Type,
                  BaseAddress != NULL,
                  NewBaseAddress,
-                 InputFileName,
+                 SymbolsPath,
                  Xip,
                  Strip,
                  FixedAddress
@@ -429,6 +434,7 @@ int main (int argc, const char *argv[])
   UINT32         NumOfFiles;
   const char     *OutputName;
   const char     *InputName;
+  const char     *SymbolsPath;
   const char     *FormatName;
   const char     *TypeName;
   const char     *BaseAddress;
@@ -450,13 +456,14 @@ int main (int argc, const char *argv[])
   if (strcmp (argv[1], "GenImage") == 0) {
     if (argc < 5) {
       fprintf (stderr, "ImageTool: Command arguments are missing\n");
-      fprintf (stderr, "    Usage: ImageTool GenImage [-c Format] [-t ModuleType] [-b BaseAddress] [-x] [-s] [-f] -o OutputFile InputFile\n");
+      fprintf (stderr, "    Usage: ImageTool GenImage [-c Format] [-t ModuleType] [-b BaseAddress] [-d SymbolsPath] [-x] [-s] [-f] -o OutputFile InputFile\n");
       DEBUG_RAISE ();
       return -1;
     }
 
     OutputName   = NULL;
     InputName    = NULL;
+    SymbolsPath  = NULL;
     FormatName   = NULL;
     TypeName     = NULL;
     BaseAddress  = NULL;
@@ -496,6 +503,14 @@ int main (int argc, const char *argv[])
         }
 
         BaseAddress = argv[ArgIndex];
+      } else if (strcmp (argv[ArgIndex], "-d") == 0) {
+        ++ArgIndex;
+        if (ArgIndex == argc) {
+          fprintf (stderr, "Must specify an argument to -d\n");
+          return -1;
+        }
+
+        SymbolsPath = argv[ArgIndex];
       } else if (strcmp (argv[ArgIndex], "-x") == 0) {
         Xip = true;
       } else if (strcmp (argv[ArgIndex], "-s") == 0) {
@@ -525,6 +540,7 @@ int main (int argc, const char *argv[])
     Status = GenExecutable (
       OutputName,
       InputName,
+      SymbolsPath,
       FormatName,
       TypeName,
       BaseAddress,