From 2122ff64c6ef776d37592a7fc3f4029cdef46fe2 Mon Sep 17 00:00:00 2001
From: George Rimar <grimar@accesssoftek.com>
Date: Fri, 5 May 2017 10:52:39 +0000
Subject: [PATCH] [llvm-dwarfdump] - Print an error message if section
 decompression failed.

llvm-dwarfdump currently prints no message if decompression fails
for some reason. I noticed that during work on one of LLD patches
where LLD produced an broken output. It was a bit confusing to see
no output for section dumped and no any error message at all.

Patch adds error message for such cases.

Differential revision: https://reviews.llvm.org/D32865

llvm-svn: 302221
---
 llvm/include/llvm/DebugInfo/DWARF/DWARFContext.h   |   3 ++
 llvm/lib/DebugInfo/DWARF/DWARFContext.cpp          |  35 +++++++++++++++------
 .../dwarfdump-decompression-error.elf-x86-64       | Bin 0 -> 7096 bytes
 .../DebugInfo/dwarfdump-decompression-error.test   |  15 +++++++++
 4 files changed, 43 insertions(+), 10 deletions(-)
 create mode 100644 llvm/test/DebugInfo/Inputs/dwarfdump-decompression-error.elf-x86-64
 create mode 100644 llvm/test/DebugInfo/dwarfdump-decompression-error.test

diff --git a/llvm/include/llvm/DebugInfo/DWARF/DWARFContext.h b/llvm/include/llvm/DebugInfo/DWARF/DWARFContext.h
index b9f3425..d42c477 100644
--- a/llvm/include/llvm/DebugInfo/DWARF/DWARFContext.h
+++ b/llvm/include/llvm/DebugInfo/DWARF/DWARFContext.h
@@ -310,6 +310,9 @@ class DWARFContextInMemory : public DWARFContext {
 
   StringRef *MapSectionToMember(StringRef Name);
 
+  Error maybeDecompress(const object::SectionRef &Sec, StringRef Name,
+                        StringRef &Data);
+
 public:
   DWARFContextInMemory(const object::ObjectFile &Obj,
     const LoadedObjectInfo *L = nullptr);
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFContext.cpp b/llvm/lib/DebugInfo/DWARF/DWARFContext.cpp
index 179d6af..246899a 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFContext.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFContext.cpp
@@ -957,6 +957,26 @@ static bool isRelocScattered(const object::ObjectFile &Obj,
   return MachObj->isRelocationScattered(RelocInfo);
 }
 
+Error DWARFContextInMemory::maybeDecompress(const SectionRef &Sec,
+                                            StringRef Name, StringRef &Data) {
+  if (!Decompressor::isCompressed(Sec))
+    return Error::success();
+
+  Expected<Decompressor> Decompressor =
+      Decompressor::create(Name, Data, IsLittleEndian, AddressSize == 8);
+  if (!Decompressor)
+    return Decompressor.takeError();
+
+  SmallString<32> Out;
+  if (auto Err = Decompressor->decompress(Out))
+    return Err;
+
+  UncompressedSections.emplace_back(std::move(Out));
+  Data = UncompressedSections.back();
+
+  return Error::success();
+}
+
 DWARFContextInMemory::DWARFContextInMemory(const object::ObjectFile &Obj,
     const LoadedObjectInfo *L)
     : IsLittleEndian(Obj.isLittleEndian()),
@@ -980,16 +1000,11 @@ DWARFContextInMemory::DWARFContextInMemory(const object::ObjectFile &Obj,
     if (!L || !L->getLoadedSectionContents(*RelocatedSection,data))
       Section.getContents(data);
 
-    if (Decompressor::isCompressed(Section)) {
-      Expected<Decompressor> Decompressor =
-          Decompressor::create(name, data, IsLittleEndian, AddressSize == 8);
-      if (!Decompressor)
-        continue;
-      SmallString<32> Out;
-      if (auto Err = Decompressor->decompress(Out))
-        continue;
-      UncompressedSections.emplace_back(std::move(Out));
-      data = UncompressedSections.back();
+    if (auto Err = maybeDecompress(Section, name, data)) {
+      errs() << "error: failed to decompress '" + name + "', " +
+                    toString(std::move(Err))
+             << '\n';
+      continue;
     }
 
     // Compressed sections names in GNU style starts from ".z",
diff --git a/llvm/test/DebugInfo/Inputs/dwarfdump-decompression-error.elf-x86-64 b/llvm/test/DebugInfo/Inputs/dwarfdump-decompression-error.elf-x86-64
new file mode 100644
index 0000000000000000000000000000000000000000..ba352f51123d5cfc94808025c2870fdf25914e64
GIT binary patch
literal 7096
zcmcgwZ)_CT5ud&FKXPzB^Vfh|t_i44z=r_`Ob}tuV6%=4xWp7!jk7-At?iS1ch=or
zVydKdN)yEj6k1hkRpkTy)(@2u<x8VBq99sOs#FT<A0ag#ECMP`prryum8x)^c{_97
zdp_C^l{(Vy%>3TWym^23z5Q12Kwro(Kqv%H18K9Sr6B(e@XzH+Wvm;Tz=Fph1`UYR
z<7253;=UyO0*4mf#C9g~I+8;Sge+fR-sWo{oWrQxsJ;cVSoHY;N(f0fV2(uOPenGD
z+YO_rk?!+W&LbxIupg=9GR%I%Y%lynPE5G8kJ?608^>!4S*Ve25##6!T=fOwgEzf2
z$@dw!UuU64y3f0m1|VGgzJh+7B3t}t7UkltQ<<@yU0bKp9aEWHX{KYQduPYau6QvY
z->&i}J8I&=!^f0|^hZo-ei@BrrQ1;EE@6vm7DhENl`4f_Kq*$y0s`ijqI7nG<B;qW
zy=1|2vdK&ik%??R$A|+52l{*VJKN*i<4<A$KO+OPp?svhrFEGlRJMhyXm1)-67^lM
z4L0MAhzHwapS;~<zfpguE(Z3i7rgpgo6*2N`Rk@jDh!mLypBcXO*in}yum_=^hqlG
z>wFn$(>th-pY^Q)w%zHUyZXF6cildD<L=;4|CI~#IMVi&i_?l-Igaes&(ZJxc=Lt>
z0LR`P#mwxz>OFVUTk|eOqEwcR{EEQxys{g)<lCPo?3n$^-`K&v_`tO1?%Ee`?X!)`
z_SFa8s!D|LLIe>1*}c0lUns3PX3yQc^-WCVa{ZSPF-9(_dhQ{!U_9Qu;XA5HWH$2Y
z95EFa<5bGXGI2cd)x=ymaV#-3aC*~aBZkSH?jZhb|J-N&bAKFo{HE&Ti=Ugf&O9iW
z?N{%3v2A~r_ycpF49tCY03(!Feq^7#WZ1huEqy`*@b!_zbBU3}^9kqD*@Zgq;kc-H
zJVXYLva#OW(}~&E<MSL=@e=Y=$On+8u!Zj-e+l_*<hPM`;RINTGLi9(qhQQLjrB_#
zo6Z`IQNr8s=|=x2$bhM~J-|jRC;Mxkm&-A-jYRt*t<N-vUu>F%ee3o-v18+-1dG4P
z^_i+ZQ1h1jX<mfMu#RSDB>GyYj+WuFhPno1XpC<noHB3<pVu)zmw=u~^h~HH()wMq
zHxfHt*Ar<!Rc}W+Uu&=<-6tClMXW-kI}zzjMA~~IF|<Sbo=B6*=MU)qHpU6A6ADQ*
zi1`r3n9G_GzEqV0befiuma%?=?bos{`|*0#r5)>7A8Z&^67>O*l-KzxSRqSEG`2+N
zLKeRLJ)HP($RY-hs5g!qbJdq9x3a#9xiIQnqE1{+MA8RhFXKh~1<@LxK`Xaca9~~X
z7JuB76p4=AoF`yDWZ@eCr=ilNKku@BEo4#g|Bd9kr&l=6?b7js`}aQ;Ysat0<FQ@w
zZE;$5|CLPIaYNQ3I}>}ottM_(#y#j{;umbVrhR>7UR2vRK&}2Xp|LU!)%G}wHQH^$
zlFGPO+dop7|J8UH25ZJy3ez?5WtH<;b({#udaA~o;V!SUYCKvwS5)II&|Yr^Atjsm
z<(BmsEHq&S$hxe?SK_&8Gzcl#gjFEl-C&^!t1IiP8eap0yzZ*;R-n(CPA151Qe9$#
z>>@fYyN!;^E~DdgT3Jjcd~q>|hzT1O;W)!_cK)NR7tlT#f@ScwHtrF|=QaFGjLW_&
z@phqL;BF@UL-i5$;bYVouPowJuk7PwOLPJsqsF-Z2=Q9^Q$4ltpQt!3U^Q4MRZ}hd
zx0K29Mf2(c;s$<=^m+9@+w1f5BZV)X=YLmm7SFeOY`}8t2Relj$v(dq@fhyv`aE2P
zcocEzXXS*iW))}gdTdj;SS|2997m6DBOY5Yt4PNYZwak|VQv1W35SLCF5kr>;?yoW
zRuZYR0P<hr6UBKlsl`dK{j6!B1%RAwP9jeBdV9~XJ)KL4!s-q11H>s$-Tq}|Ut>Q^
z6}+NX8Xu3RAng|1iA>RR3yzm{Qd9YyTf{SeI`2$O<;Rj!PTI>CicYdL1F3v=ddl_O
zbbROTT{~(UIpdjJ#z__m$rFy7^9m<mypYVgPP&xMo<Ns?=AfllW$L*_FP@s7M!UYF
zi9@|k@8JWEgIbkk8k_@PJDfPwzrVUf-B}RA@1WCba|HXqQE(0p9O+36I7j;Wp6wlS
zh7vsky%bg5bW+8V${8Fto%E6dFI<2uD|qF>o<S@BHiWiSS0gMd=AFr8E<NRf(|-i5
z(wUr7D!Q2RLT%I-)W?cN4#U^1p+oz*!CP=#{WamAVD$0kVXrV8W<^Jti$3$_z0~OF
zXcCNaU-bR!p^ZytyWjkcvE_r`&BDNW>)YSE8h)ee<F@hDfBN9P<qZvR`exl*MvJj2
zvLb9o)<;^5<&9B1V};_dZ><@5D!eD$zk)!k^@lyU`<ojf9DX`%Qj)Y4hSU~p82^ea
z0|N;md<>`zt4eQ4NSb3j6KX_5{~V5IuQHxVW}<usCtK<VB5{!U{;=aXj(lwY=FQu>
z{9{n8BkPrN?%oME=N2+4RFj3&<X->w9qX8Yt&{nzyS0=Z+e#@Gx9;fdUPxAr3dD;i
zvR-lwxmWP{q)3?@E}ChG=klH#PxSP6c*zNfPbQ0#5Ko`Tp`*{e0>meBrT7bOp_s|%
zsuTyy3hq>r99Wv3@*u9}NF2rZL>^VooxwLPEi}rjc^Y>oc`;3<F^FistG}vz50SBk
zWHyt+>hm5&#^h+e$8jD)9G7+$mn&lKSZM-XlDP@o2UyMI#`7X4$Hofo3!>rw3|C~e
zv_-*A^2hFfdDDr3W|4d!AY`G2#DIQsAlo24h6>#Y#9z*}^1mn+G)7tWae=p?KzAJR
zw?Y<bfahSvD)$)illz9~v?yrKiocwbhZ(T_Fscs9UHn@a--n#;MB;xgWT8g)EyXJL
zDqr*aN@U^(@u547_{+Kb8Uqb%EcuF^@F6UxJCf-0Aqx?@FDV8wpDoItVMw7svBe)u
z%P-=Kp0rcy*V|9$B`WLjy(;JZ)*Ak+(MI=w5i#mlX{X$aJK0}9sY)JP9ncgG`pf-c
zko{v~$ULg?mr)P;%ROV7{Uu)sqwB9}{<GYFv+O@c!2=}q3v>#FVEuA$xxo#U`>@#S
z?f*XeFJ}X}-`r(G-ClIzKW2X!fBC;E|6RMJV&>u}@J}^=xi7Wzj|V#E1xfF}cd(Go
z^xR#QdzJj3*6nruJo+{V{N?^N$P-Gp*Y)3`FPTdHa-Np|+#hoO+?>k%m2rFpeaS@p
z<v!QW73uYfF8ueJzx-F}WP=!%2TA;d)44uaznq%~*+BA?7~&`TbrcAb{N;Q)%7(f<
zcZaycUr-{fvx4}7__t`d_zS;_<st`7J2`PZu5L>gM}=vLj<WwiFsRrDurNC7F{$`x
z>`&i^AnCSiAL9Qp`|k-lqpbUHdWe6FJI>bpwPwP0_SgGqlKqcr{!+hiGLx|nn*M_Q
u>An{vO;zoYy(4Hh!-=-?I(!rhx8WoC%XfwLw_5d|rA-0poK~Tx!oLCjc<yij

literal 0
HcmV?d00001

diff --git a/llvm/test/DebugInfo/dwarfdump-decompression-error.test b/llvm/test/DebugInfo/dwarfdump-decompression-error.test
new file mode 100644
index 0000000..1848331
--- /dev/null
+++ b/llvm/test/DebugInfo/dwarfdump-decompression-error.test
@@ -0,0 +1,15 @@
+REQUIRES: zlib
+
+// dwarfdump-decompression-error.elf-x86-64 is prepared using following
+// source code and invocation:
+// test.cpp:
+// int main() { return 0; }
+//
+// gcc test.cpp -o out -g -Wl,--compress-debug-sections,zlib
+//
+// After that result object was modified manually. One random byte in compressed
+// content of .debug_info section was changed to 0xff. That breaks normal 
+// decompression flow in runtime.
+RUN: llvm-dwarfdump %p/Inputs/dwarfdump-decompression-error.elf-x86-64 2>&1 | FileCheck %s
+
+CHECK: error: failed to decompress '.debug_info', zlib error: Z_DATA_ERROR
-- 
2.7.4