[PATCH] readelf: support zstd compressed debug sections [PR 29640]

[Alan Modra]

On Fri, Oct 14, 2022 at 09:58:41PM +1030, Alan Modra wrote:
> So we have a zlib-gabi .debug_info section that increases in size with
> zstd, so much so that it's better to leave the section uncompressed.
> Things go horribly wrong due to leaving compress_status as
> COMPRESS_SECTION_NONE.  The section is read again off disk using the
> uncompressed size.  So you get the zlib section again with some
> garbage at the end.
> 
> Also, if the section is to be left uncompressed, the input
> SHF_COMPRESSED flag needs to be reset otherwise it is copied to
> output.
> 
> I'm not ready to commit this, just thought I'd post the results of a
> bit of debugging.

And if I'd run the testsuite before posting, I may have posted a
better patch..  Using COMPRESS_SECTION_DONE led to .debug -> .zdebug
renaming of sections, so it appears we want another compress_status
that says the final section contents are in sec->contents.

diff --git a/bfd/bfd-in2.h b/bfd/bfd-in2.h
index 25e1806e689..4f4658021c6 100644
--- a/bfd/bfd-in2.h
+++ b/bfd/bfd-in2.h
@@ -974,11 +974,12 @@ typedef struct bfd_section
   unsigned int gc_mark : 1;
 
   /* Section compression status.  */
-  unsigned int compress_status : 2;
+  unsigned int compress_status : 3;
 #define COMPRESS_SECTION_NONE    0
 #define COMPRESS_SECTION_DONE    1
 #define DECOMPRESS_SECTION_ZLIB  2
 #define DECOMPRESS_SECTION_ZSTD  3
+#define DECOMPRESS_SECTION_DONE  4
 
   /* The following flags are used by the ELF linker. */
 
diff --git a/bfd/compress.c b/bfd/compress.c
index 364df14142b..94bc5412a89 100644
--- a/bfd/compress.c
+++ b/bfd/compress.c
@@ -151,7 +151,7 @@ bfd_compress_section_contents (bfd *abfd, sec_ptr sec)
 	  free (input_buffer);
 	  bfd_set_section_alignment (sec, uncompressed_alignment_pow);
 	  sec->contents = buffer;
-	  sec->compress_status = COMPRESS_SECTION_DONE;
+	  sec->compress_status = DECOMPRESS_SECTION_DONE;
 	  sec->size = uncompressed_size;
 	  input_buffer = buffer;
 	}
@@ -206,7 +206,8 @@ bfd_compress_section_contents (bfd *abfd, sec_ptr sec)
   if (compressed_size >= uncompressed_size)
     {
       memcpy (buffer, input_buffer, uncompressed_size);
-      sec->compress_status = COMPRESS_SECTION_NONE;
+      elf_section_flags (sec) &= ~SHF_COMPRESSED;
+      sec->compress_status = DECOMPRESS_SECTION_DONE;
     }
   else
     {
@@ -361,6 +362,7 @@ bfd_get_full_section_contents (bfd *abfd, sec_ptr sec, bfd_byte **ptr)
       return true;
 
     case COMPRESS_SECTION_DONE:
+    case DECOMPRESS_SECTION_DONE:
       if (sec->contents == NULL)
 	return false;
       if (p == NULL)
diff --git a/bfd/section.c b/bfd/section.c
index 614570e976e..52cf7e042cd 100644
--- a/bfd/section.c
+++ b/bfd/section.c
@@ -389,11 +389,12 @@ CODE_FRAGMENT
 .  unsigned int gc_mark : 1;
 .
 .  {* Section compression status.  *}
-.  unsigned int compress_status : 2;
+.  unsigned int compress_status : 3;
 .#define COMPRESS_SECTION_NONE    0
 .#define COMPRESS_SECTION_DONE    1
 .#define DECOMPRESS_SECTION_ZLIB  2
 .#define DECOMPRESS_SECTION_ZSTD  3
+.#define DECOMPRESS_SECTION_DONE  4
 .
 .  {* The following flags are used by the ELF linker. *}
 .


-- 
Alan Modra
Australia Development Lab, IBM