From 065f3808156c92d957fc1ad2a2a37e147ee628f4 Mon Sep 17 00:00:00 2001
From: Joe Sylve <joe.sylve@gmail.com>
Date: Thu, 2 Sep 2021 19:09:15 +0000
Subject: [PATCH] debug/dwarf: check for DWARFv4 AttrDataBitOffset value

AttrBitOffset is deprecated (but reserved) in DWARFv4.  This fix adds
logic to check the new AttrDataBitOffset attribute if AttrBitOffset
attribute is not present.

Fixes #46784

Change-Id: I7406dcaa4c98e95df72361fd4462c39e6be8879d
GitHub-Last-Rev: 5aa10d04910a09538320b4de8fbd8a1f5fd8c17d
GitHub-Pull-Request: golang/go#46790
Reviewed-on: https://go-review.googlesource.com/c/go/+/328709
Run-TryBot: Than McIntosh <thanm@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Trust: Michael Knyszek <mknyszek@google.com>
---
 src/debug/dwarf/testdata/typedef.c      |   1 +
 src/debug/dwarf/testdata/typedef.macho4 | Bin 0 -> 6220 bytes
 src/debug/dwarf/type.go                 |   9 ++++-
 src/debug/dwarf/type_test.go            |  51 ++++++++++++++++++++++++
 4 files changed, 59 insertions(+), 2 deletions(-)
 create mode 100644 src/debug/dwarf/testdata/typedef.macho4

diff --git a/src/debug/dwarf/testdata/typedef.c b/src/debug/dwarf/testdata/typedef.c
index 4780a0b2ba..3e7e008621 100644
--- a/src/debug/dwarf/testdata/typedef.c
+++ b/src/debug/dwarf/testdata/typedef.c
@@ -8,6 +8,7 @@ gcc -gdwarf-2 -m64 -c typedef.c && gcc -gdwarf-2 -m64 -o typedef.elf typedef.o
 
 OS X Mach-O:
 gcc -gdwarf-2 -m64 -c typedef.c -o typedef.macho
+gcc -gdwarf-4 -m64 -c typedef.c -o typedef.macho4
 */
 #include <complex.h>
 
diff --git a/src/debug/dwarf/testdata/typedef.macho4 b/src/debug/dwarf/testdata/typedef.macho4
new file mode 100644
index 0000000000000000000000000000000000000000..093ff37ea1802b31805e711e5acf4c3eb8d3f7b5
GIT binary patch
literal 6220
zcmb7I32+?6744o~tyWrTw7M)CAFP87HV{dx!<HbitynhlfpAFz1O|rDY9uYJcEuj@
zfhZK`G9*+&D2U@E#DQ>xlsS{amBIyq1PBQ+M_dJoNfk#Z2Mo9hLIDOl@AdRb!(u9=
zYyb87|KB|`Jw3m7-$!p9Efzxh1Q^H<Y9ot)&}M=5u=8`;4V7+3KV#7HHgXD5h#;C}
zWu47gS9k5cRsDU_c3!K{3iIidF5(xHc^^v48gvG7!<IcTkaostcb?zTvwF%UpJx^?
z3T^mP$rNNLu30``JUNsiRG4p(&a<}24VcvOaIFydu^l&GCYx5Bh56C}1&eF-y?v_G
zwLQEbpFK8~aIB;~>SW+lnD65fH*%4V>N7o=T=ls5QUjO8*j<=!L75x0z!hR5td(hT
z+<a<&V|J`CUsplCU0*O?cFWjtuQ#FdeN#WzKm5;pvD7H$m9=uoP4VQQWv%a=z7!!2
z>-dNUyYNu?Xm-qS-wUV(*XxW}Luot>H^8z!y`IDRy;$LPixHhqn|v=u@;YUH{Uzc_
zm9g;tZP58v>YzLIqTBU3^J{|NOpv>5F`CbP6L}HD??hY;<iR>21|iwI0px9rB~^RD
zFQ}i}b<Mw`k36yJWBOnGn5>iw&FUhbxoyIH=V~)tH`}a~Rd@%C7U473R4<=(M(E6t
zftmR##2O6fp8?@Bi3(BFs<6NU_$~{DfE1sskYKG`Q+*2dsFEUOm)1&Jp;|#v#tSX4
zmOe97<R&u9)o3)@kfmbUEDv1{AUqAU;RUahNH0Xyd?a6r?rKgT6j}zgMx_n8X>02|
zW6ba)h;D9Q-6F)yDaT!}N4~1Sika?J@tQHc)fmQI!a?<@%0vUucF+zG+pVrpoV%Lw
zSFp1{a#;yisA|6T5dQPQo&`zMcM(L94HkHfn%_7GaTQ1|_e5<2;QJ1k|A%0Q*j?fK
z5k&D%!2+L<NyEU*_ONe-Cv-0W|C3-v=#}9>8AMUgsD<E&vcu#1Z~DFmHj}=Uf%y={
zhS3NSCh|3pFBAA9V9o5Q3fc%Op=ZfbFcIhm_xl5V6hUJnL@!9L^rYx#UkvOL_Eh_r
z&A1ATBs)Ex+W`2l1Dj+|UGNr&5?*@A9n|gy6F!^6-U>A!1NT4#rLh;{DUe*{NwyDw
z|L<UruxDneN+gWG!Fr#_YLD*`0R8}8#uwN#D`XskoC8~)<?)&iz<)Z}VS1fVTG9f&
zO!zoMqa1oSNOpN5dI9(^0jp%sm&)ftbV)heJOv8Zgq$NPPKC}Ca;}V2FuhG<o`1es
z590xlJTYi?LOxDC5)Aj}@%dd+RMNfbVL*5z8X<zkmCr#aXpso4g^rc55#nu-T;rMF
zy8!%0!7gRb!kSUq@+6Z3RAV*E1(^C&ekqL2=xAZbT2GdC0RB#}tC;1q+U*c4q&#{0
zDo^oTB|hELSGm|PrmyT&+{Wt>dm{%}=NVup2e=LFMh+02!FB#~s6lyp-5rGL?gBUJ
zc7tD8cQ5$l<j&jQxaU>OnD_5>CS31H_$Cv+5B4B>WpmB%A;Pl7<PEOF`!8FC`Aj}=
zNl*lyf>C4``yrayf3_zX>ofmKuouxQzf$um#7x<49)ujD^BKZ?Yf2BQL2|^;3=1FQ
z0(=a`L8BBCx}F`~p6oXP@c#nL<VDo@Zini=h4(=dfqKBcps@tvX#nyZPwaC5{4ar>
z!Pr{gD^T6ox1j0Ru(1)n*s+D&;E6T46V3v&7(2r^52_ox7@Cfaa7$N>TcJGfTlDSW
zf)O38k0P;zog9vgJLyb3m5fB2>Kp4@Ba0OJ<!Do5E9|DG`u4?wg~gyVR38%!jEu+Z
zEFv-u{jt=bQ;%Y+VPz_rb&}akL#H$DBvNBex?w}Y&JLy0qnU=Y?btcJ{q<uS@c8t0
zuAA!43|=m@C)I{?GniPzWhtj2la4hEr<72IY{TFtJ3Z8pbu!sOJ8KKONo1|DY}y)6
zVTd>?zj!h$NOrTWyJDDc){2eTX`z_if{sKgIV{K`%DEL#E;Eu!XGJcVi4P~8!H8?x
zOVBlxOU9VlN)1^<iIknS22;6#gd>z8v|%sRBYv*C-Ih<rIqQU+l$B9DrzWV!SNha!
zlx4T)<Hu9+LC(g7qm6|)`-L5i7UCS2F}Q$i1`fP`qgyQ0-?>;;Ol#wDu~}>pTTyX!
z^z?LGVD+xKaFx|}!G=|qCG2$C-s0Z9sav>pE3@&QPbG;?=Zms)!0pT>v4Ys;Dt5Hl
z#hqksl(3RcR5(q-X%<ckLixndlZa=sLa}i>A>8Ma<ax=C@&Upln|2(bSi%{~igbK<
z1QC49icQ^3_0Xeyw7emoeO|1B6V7Ilmv;1c&(?kJ*0d8JZ(%|Xte4A_=cpY|imu)c
zd?tk8k%l#<F4YAwDcpk(-dk1o@Qg@5lvDyml3*EL1!B$l!T1HD?7Z!vt)OzyN3c!E
zYwK>9I0C%_`gfs!4E+;OG3=v|LCDLl-Z^m$dI|JWPzb~l=mQWdEmk7<Fo-q~C(D{)
z1hg5n9kc^<Cuk4oNze<RgP;#ULGHI87Gf|3Yi%}e*0kqwuS4T_v`1*5al55Gq5D}^
z(Y}?PXxvh1@6rAIg3{(T&&JY-_C93^!EKcGd)lAhO4=s^XJgew`-rmOukB?7(O8*K
zeOcS8Jc2!<ZPp}Ii}m<wvxVKr{TPi^5c_{ihQ^A7YP<I5r<L}ko{y?5U_Yzv{5sL$
zpIIlz(EcAEu9=fTTytz3hU?8Iim=wW!dy&!PN3)49X};pa~zL3a5Pf?dz=6{8#E8Z
zz6j)e&_Yn-<o3`{UcRDYZo+wf(;E*z`Oe)>{3Dwj`Ffr8ZaNm}n0V!&@z}=9_YU0m
z(4{YQ-4>sluD`207P)aEGW*c?hk7a(-fs=GJYN6kf%BH{zGwg83&XeHd~dI~Zg1b-
zTiO=C^z^TrfBeqw?#RZkeptTg{_fxH`OAUj<r8o2y5r9uR<_=>)}FC*V*k%>p6D&Q
z^rYuYPrN8xHvXI4SMEO&loxOLC2r<}AXcYuf{ubJ@f;R_mV#KET?`rneFJn8=vSbJ
zK>I+ifc^st;^xf;@oV1!>H`gfwt}t$?E*ajdK~m3=n&`_s0wRwA&51~I?yGcD?qQ|
zo?$Ag)La0G#!8+Lm#KzSZ2^dt1|Sv<5d8i_u&L7xB#%3MOlT}|nTAy_pB|bjmmyg{
zYcEw)0AiJ)AywZ1V!@*!-YMqloepGyONjNZo`gD?0OI?o1Jxl25Kl!KQl%qI){+|H
zd5XDMeCu31HW6ZlsUcO=!eo`J19@Pg7tc`I>k$p{)S<m5HN;bmhFC_zQZ=RyREHu!
z{nK8f+KYv`zJ)yRFp%dU9XL}%Jk9C!s+xt#@>WAUm@$y2H65tRR6tx4+KbyMy?74N
z5bJ9~EW6>z#?uxdp2Ku5bw&lmL#qyCEln?$*LwD>hzYUS)sQ-H0AlH@19@zq7f%xS
z8-$Io2O*wk^oR@~#0pwNs=B2YAe{@AYTQfE81Si<-;?Cl9w9e}Ww@+3_yc$`;~da4
zZ*zw^c1*|Pr8C3dHddDFzX`>1`1sZCBc(io|1lsq2uONrSs*B_F=My+o)fajDE*UR
zz+XX8tbb?$35gxi{39*_`=EIZB>qA)PlF6X{uB2E-)58VI_6-W4v7%+b>xPNxf&9X
zSp$im`L>#fFdv1)9XE53*i+4QkofD$3_{}DZXUoaaE<1@kob$z%t7M2Z}R$3Cz#y7
z;i@j1vR>QJMFp8|7eT`GVXmt2uMe-?Q($v{_x7{y@Y-t%?9KxF%mTZqz+PNnM+)rj
z0-Lptcl;Fv_R<1d--oH|U0Bf1HRR35bCTB<mMYCGRjpb)Lr^7e2er{6TS|p&2^F$d
VDr7BG6l;doL`$(KwMGml{tH@xQ|$l%

literal 0
HcmV?d00001

diff --git a/src/debug/dwarf/type.go b/src/debug/dwarf/type.go
index eb5a666ed3..2e5a605174 100644
--- a/src/debug/dwarf/type.go
+++ b/src/debug/dwarf/type.go
@@ -516,7 +516,10 @@ func (d *Data) readType(name string, r typeReader, off Offset, typeCache map[Off
 		}).Basic()
 		t.Name = name
 		t.BitSize, _ = e.Val(AttrBitSize).(int64)
-		t.BitOffset, _ = e.Val(AttrBitOffset).(int64)
+		haveBitOffset := false
+		if t.BitOffset, haveBitOffset = e.Val(AttrBitOffset).(int64); !haveBitOffset {
+			t.BitOffset, _ = e.Val(AttrDataBitOffset).(int64)
+		}
 
 	case TagClassType, TagStructType, TagUnionType:
 		// Structure, union, or class type.  (DWARF v2 §5.5)
@@ -578,7 +581,9 @@ func (d *Data) readType(name string, r typeReader, off Offset, typeCache map[Off
 			haveBitOffset := false
 			f.Name, _ = kid.Val(AttrName).(string)
 			f.ByteSize, _ = kid.Val(AttrByteSize).(int64)
-			f.BitOffset, haveBitOffset = kid.Val(AttrBitOffset).(int64)
+			if f.BitOffset, haveBitOffset = kid.Val(AttrBitOffset).(int64); !haveBitOffset {
+				f.BitOffset, haveBitOffset = kid.Val(AttrDataBitOffset).(int64)
+			}
 			f.BitSize, _ = kid.Val(AttrBitSize).(int64)
 			t.Field = append(t.Field, f)
 
diff --git a/src/debug/dwarf/type_test.go b/src/debug/dwarf/type_test.go
index fda03fdbb0..431d0853e0 100644
--- a/src/debug/dwarf/type_test.go
+++ b/src/debug/dwarf/type_test.go
@@ -228,3 +228,54 @@ func TestUnsupportedTypes(t *testing.T) {
 		}
 	}
 }
+
+func TestBitOffsetsELF(t *testing.T) { testBitOffsets(t, elfData(t, "testdata/typedef.elf")) }
+
+func TestBitOffsetsMachO(t *testing.T) {
+	testBitOffsets(t, machoData(t, "testdata/typedef.macho"))
+}
+
+func TestBitOffsetsMachO4(t *testing.T) {
+	testBitOffsets(t, machoData(t, "testdata/typedef.macho4"))
+}
+
+func TestBitOffsetsELFDwarf4(t *testing.T) {
+	testBitOffsets(t, elfData(t, "testdata/typedef.elf4"))
+}
+
+func testBitOffsets(t *testing.T, d *Data) {
+	r := d.Reader()
+	for {
+		e, err := r.Next()
+		if err != nil {
+			t.Fatal("r.Next:", err)
+		}
+		if e == nil {
+			break
+		}
+
+		if e.Tag == TagStructType {
+			typ, err := d.Type(e.Offset)
+			if err != nil {
+				t.Fatal("d.Type:", err)
+			}
+
+			t1 := typ.(*StructType)
+
+			for _, field := range t1.Field {
+				// We're only testing for bitfields
+				if field.BitSize == 0 {
+					continue
+				}
+
+				// Ensure BitOffset is not zero
+				if field.BitOffset == 0 {
+					t.Errorf("bit offset of field %s in %s %s is not set", field.Name, t1.Kind, t1.StructName)
+				}
+			}
+		}
+		if e.Tag != TagCompileUnit {
+			r.SkipChildren()
+		}
+	}
+}