public inbox for binutils@sourceware.org
 help / color / mirror / Atom feed
* [COMMITTED] libsframe: fix sframe_find_fre for pltN entries
@ 2023-06-09 19:28 Indu Bhagat
  2023-06-09 19:28 ` [COMMITTED] libsframe: testsuite: add sframe_find_fre tests " Indu Bhagat
  0 siblings, 1 reply; 3+ messages in thread
From: Indu Bhagat @ 2023-06-09 19:28 UTC (permalink / raw)
  To: binutils; +Cc: Indu Bhagat

To find SFrame stack trace information from an FDE of type
SFRAME_FDE_TYPE_PCMASK, sframe_find_fre () was doing an operation
like,
  (start_ip_offset & 0xff) >= (pc & 0xff), etc.

This is buggy and needs correction.  The mask 0xff should be 0xf (to
work for a pltN entry of size say, 16 bytes).

At this time, the size of the pltN entry is implicitly assumed to be 16
bytes by libsframe.  In next version of the SFrame format, we can encode
this information explicitly in the SFrame FDE.

For now, we should fix the code to at least behave correctly for the
generated code and the generated SFrame stack trace information for the
pltN entries on x86_64.

libsframe/
	* sframe.c (sframe_find_fre): Correct the bitmask used for
	SFrame FDEs of type SFRAME_FDE_TYPE_PCMASK.
---
 libsframe/sframe.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/libsframe/sframe.c b/libsframe/sframe.c
index a5f4a7f6519..7308a45ce88 100644
--- a/libsframe/sframe.c
+++ b/libsframe/sframe.c
@@ -1066,7 +1066,7 @@ sframe_find_fre (sframe_decoder_ctx *ctx, int32_t pc,
   /* FIXME - the bitmask should be picked per ABI or encoded in the format
      somehow. For AMD64, the pltN entry stub is 16 bytes. */
   if (fde_type == SFRAME_FDE_TYPE_PCMASK)
-    bitmask = 0xff;
+    bitmask = 0xf;
 
   fres = ctx->sfd_fres + fdep->sfde_func_start_fre_off;
   func_start_addr = fdep->sfde_func_start_address;
-- 
2.39.2


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [COMMITTED] libsframe: testsuite: add sframe_find_fre tests for pltN entries
  2023-06-09 19:28 [COMMITTED] libsframe: fix sframe_find_fre for pltN entries Indu Bhagat
@ 2023-06-09 19:28 ` Indu Bhagat
  0 siblings, 0 replies; 3+ messages in thread
From: Indu Bhagat @ 2023-06-09 19:28 UTC (permalink / raw)
  To: binutils; +Cc: Indu Bhagat

Add a new test plt-findfre-1 to ensure lookup of SFrame stack trace
information for pltN entries is correct.

In this test, a dummy SFrame FDE of type SFRAME_FDE_TYPE_PCMASK is
created.  The size of the 'function code block' covered by the SFrame
FDE is equivalent to 5 pltN entries of 16 bytes each.

The test first looks up SFrame FREs for some addresses in the first pltN
entry, followed by lookups for some addresses in the fourth pltN entry.

libsframe/
	* Makefile.in: Regenerated.
	* testsuite/libsframe.find/find.exp: Add new test.
	* testsuite/libsframe.find/local.mk: Likewise.
	* testsuite/libsframe.find/plt-findfre-1.c: New test.
---
 libsframe/Makefile.in                         |  42 +++++-
 libsframe/testsuite/libsframe.find/find.exp   |   5 +
 libsframe/testsuite/libsframe.find/local.mk   |   6 +-
 .../testsuite/libsframe.find/plt-findfre-1.c  | 127 ++++++++++++++++++
 4 files changed, 175 insertions(+), 5 deletions(-)
 create mode 100644 libsframe/testsuite/libsframe.find/plt-findfre-1.c

diff --git a/libsframe/Makefile.in b/libsframe/Makefile.in
index 405bc04263d..c6a4cd56a9e 100644
--- a/libsframe/Makefile.in
+++ b/libsframe/Makefile.in
@@ -116,7 +116,8 @@ check_PROGRAMS = $(am__EXEEXT_1)
 @HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.decode/frecnt-2 \
 @HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.encode/encode-1 \
 @HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/findfre-1 \
-@HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/findfunc-1
+@HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/findfunc-1 \
+@HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/plt-findfre-1
 subdir = .
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
 am__aclocal_m4_deps = $(top_srcdir)/../bfd/acinclude.m4 \
@@ -186,7 +187,8 @@ am__v_lt_1 =
 @HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.decode/frecnt-2$(EXEEXT) \
 @HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.encode/encode-1$(EXEEXT) \
 @HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/findfre-1$(EXEEXT) \
-@HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/findfunc-1$(EXEEXT)
+@HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/findfunc-1$(EXEEXT) \
+@HAVE_COMPAT_DEJAGNU_TRUE@	testsuite/libsframe.find/plt-findfre-1$(EXEEXT)
 am__dirstamp = $(am__leading_dot)dirstamp
 am_testsuite_libsframe_decode_be_flipping_OBJECTS = testsuite/libsframe.decode/testsuite_libsframe_decode_be_flipping-be-flipping.$(OBJEXT)
 testsuite_libsframe_decode_be_flipping_OBJECTS =  \
@@ -218,6 +220,11 @@ testsuite_libsframe_find_findfunc_1_OBJECTS =  \
 	$(am_testsuite_libsframe_find_findfunc_1_OBJECTS)
 testsuite_libsframe_find_findfunc_1_DEPENDENCIES =  \
 	${top_builddir}/libsframe.la
+am_testsuite_libsframe_find_plt_findfre_1_OBJECTS = testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.$(OBJEXT)
+testsuite_libsframe_find_plt_findfre_1_OBJECTS =  \
+	$(am_testsuite_libsframe_find_plt_findfre_1_OBJECTS)
+testsuite_libsframe_find_plt_findfre_1_DEPENDENCIES =  \
+	${top_builddir}/libsframe.la
 AM_V_P = $(am__v_P_@AM_V@)
 am__v_P_ = $(am__v_P_@AM_DEFAULT_V@)
 am__v_P_0 = false
@@ -258,14 +265,16 @@ SOURCES = $(libsframe_la_SOURCES) \
 	$(testsuite_libsframe_decode_frecnt_2_SOURCES) \
 	$(testsuite_libsframe_encode_encode_1_SOURCES) \
 	$(testsuite_libsframe_find_findfre_1_SOURCES) \
-	$(testsuite_libsframe_find_findfunc_1_SOURCES)
+	$(testsuite_libsframe_find_findfunc_1_SOURCES) \
+	$(testsuite_libsframe_find_plt_findfre_1_SOURCES)
 DIST_SOURCES = $(libsframe_la_SOURCES) \
 	$(testsuite_libsframe_decode_be_flipping_SOURCES) \
 	$(testsuite_libsframe_decode_frecnt_1_SOURCES) \
 	$(testsuite_libsframe_decode_frecnt_2_SOURCES) \
 	$(testsuite_libsframe_encode_encode_1_SOURCES) \
 	$(testsuite_libsframe_find_findfre_1_SOURCES) \
-	$(testsuite_libsframe_find_findfunc_1_SOURCES)
+	$(testsuite_libsframe_find_findfunc_1_SOURCES) \
+	$(testsuite_libsframe_find_plt_findfre_1_SOURCES)
 AM_V_DVIPS = $(am__v_DVIPS_@AM_V@)
 am__v_DVIPS_ = $(am__v_DVIPS_@AM_DEFAULT_V@)
 am__v_DVIPS_0 = @echo "  DVIPS   " $@;
@@ -540,6 +549,9 @@ testsuite_libsframe_find_findfre_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
 testsuite_libsframe_find_findfunc_1_SOURCES = testsuite/libsframe.find/findfunc-1.c
 testsuite_libsframe_find_findfunc_1_LDADD = ${top_builddir}/libsframe.la
 testsuite_libsframe_find_findfunc_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
+testsuite_libsframe_find_plt_findfre_1_SOURCES = testsuite/libsframe.find/plt-findfre-1.c
+testsuite_libsframe_find_plt_findfre_1_LDADD = ${top_builddir}/libsframe.la
+testsuite_libsframe_find_plt_findfre_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
 all: config.h
 	$(MAKE) $(AM_MAKEFLAGS) all-am
 
@@ -712,6 +724,13 @@ testsuite/libsframe.find/testsuite_libsframe_find_findfunc_1-findfunc-1.$(OBJEXT
 testsuite/libsframe.find/findfunc-1$(EXEEXT): $(testsuite_libsframe_find_findfunc_1_OBJECTS) $(testsuite_libsframe_find_findfunc_1_DEPENDENCIES) $(EXTRA_testsuite_libsframe_find_findfunc_1_DEPENDENCIES) testsuite/libsframe.find/$(am__dirstamp)
 	@rm -f testsuite/libsframe.find/findfunc-1$(EXEEXT)
 	$(AM_V_CCLD)$(LINK) $(testsuite_libsframe_find_findfunc_1_OBJECTS) $(testsuite_libsframe_find_findfunc_1_LDADD) $(LIBS)
+testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.$(OBJEXT):  \
+	testsuite/libsframe.find/$(am__dirstamp) \
+	testsuite/libsframe.find/$(DEPDIR)/$(am__dirstamp)
+
+testsuite/libsframe.find/plt-findfre-1$(EXEEXT): $(testsuite_libsframe_find_plt_findfre_1_OBJECTS) $(testsuite_libsframe_find_plt_findfre_1_DEPENDENCIES) $(EXTRA_testsuite_libsframe_find_plt_findfre_1_DEPENDENCIES) testsuite/libsframe.find/$(am__dirstamp)
+	@rm -f testsuite/libsframe.find/plt-findfre-1$(EXEEXT)
+	$(AM_V_CCLD)$(LINK) $(testsuite_libsframe_find_plt_findfre_1_OBJECTS) $(testsuite_libsframe_find_plt_findfre_1_LDADD) $(LIBS)
 
 mostlyclean-compile:
 	-rm -f *.$(OBJEXT)
@@ -731,6 +750,7 @@ distclean-compile:
 @AMDEP_TRUE@@am__include@ @am__quote@testsuite/libsframe.encode/$(DEPDIR)/testsuite_libsframe_encode_encode_1-encode-1.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_findfre_1-findfre-1.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_findfunc_1-findfunc-1.Po@am__quote@
+@AMDEP_TRUE@@am__include@ @am__quote@testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Po@am__quote@
 
 .c.o:
 @am__fastdepCC_TRUE@	$(AM_V_CC)depbase=`echo $@ | sed 's|[^/]*$$|$(DEPDIR)/&|;s|\.o$$||'`;\
@@ -861,6 +881,20 @@ testsuite/libsframe.find/testsuite_libsframe_find_findfunc_1-findfunc-1.obj: tes
 @AMDEP_TRUE@@am__fastdepCC_FALSE@	DEPDIR=$(DEPDIR) $(CCDEPMODE) $(depcomp) @AMDEPBACKSLASH@
 @am__fastdepCC_FALSE@	$(AM_V_CC@am__nodep@)$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(testsuite_libsframe_find_findfunc_1_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -c -o testsuite/libsframe.find/testsuite_libsframe_find_findfunc_1-findfunc-1.obj `if test -f 'testsuite/libsframe.find/findfunc-1.c'; then $(CYGPATH_W) 'testsuite/libsframe.find/findfunc-1.c'; else $(CYGPATH_W) '$(srcdir)/testsuite/libsframe.find/findfunc-1.c'; fi`
 
+testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.o: testsuite/libsframe.find/plt-findfre-1.c
+@am__fastdepCC_TRUE@	$(AM_V_CC)$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(testsuite_libsframe_find_plt_findfre_1_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -MT testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.o -MD -MP -MF testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Tpo -c -o testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.o `test -f 'testsuite/libsframe.find/plt-findfre-1.c' || echo '$(srcdir)/'`testsuite/libsframe.find/plt-findfre-1.c
+@am__fastdepCC_TRUE@	$(AM_V_at)$(am__mv) testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Tpo testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Po
+@AMDEP_TRUE@@am__fastdepCC_FALSE@	$(AM_V_CC)source='testsuite/libsframe.find/plt-findfre-1.c' object='testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.o' libtool=no @AMDEPBACKSLASH@
+@AMDEP_TRUE@@am__fastdepCC_FALSE@	DEPDIR=$(DEPDIR) $(CCDEPMODE) $(depcomp) @AMDEPBACKSLASH@
+@am__fastdepCC_FALSE@	$(AM_V_CC@am__nodep@)$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(testsuite_libsframe_find_plt_findfre_1_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -c -o testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.o `test -f 'testsuite/libsframe.find/plt-findfre-1.c' || echo '$(srcdir)/'`testsuite/libsframe.find/plt-findfre-1.c
+
+testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.obj: testsuite/libsframe.find/plt-findfre-1.c
+@am__fastdepCC_TRUE@	$(AM_V_CC)$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(testsuite_libsframe_find_plt_findfre_1_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -MT testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.obj -MD -MP -MF testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Tpo -c -o testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.obj `if test -f 'testsuite/libsframe.find/plt-findfre-1.c'; then $(CYGPATH_W) 'testsuite/libsframe.find/plt-findfre-1.c'; else $(CYGPATH_W) '$(srcdir)/testsuite/libsframe.find/plt-findfre-1.c'; fi`
+@am__fastdepCC_TRUE@	$(AM_V_at)$(am__mv) testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Tpo testsuite/libsframe.find/$(DEPDIR)/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.Po
+@AMDEP_TRUE@@am__fastdepCC_FALSE@	$(AM_V_CC)source='testsuite/libsframe.find/plt-findfre-1.c' object='testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.obj' libtool=no @AMDEPBACKSLASH@
+@AMDEP_TRUE@@am__fastdepCC_FALSE@	DEPDIR=$(DEPDIR) $(CCDEPMODE) $(depcomp) @AMDEPBACKSLASH@
+@am__fastdepCC_FALSE@	$(AM_V_CC@am__nodep@)$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(testsuite_libsframe_find_plt_findfre_1_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -c -o testsuite/libsframe.find/testsuite_libsframe_find_plt_findfre_1-plt-findfre-1.obj `if test -f 'testsuite/libsframe.find/plt-findfre-1.c'; then $(CYGPATH_W) 'testsuite/libsframe.find/plt-findfre-1.c'; else $(CYGPATH_W) '$(srcdir)/testsuite/libsframe.find/plt-findfre-1.c'; fi`
+
 mostlyclean-libtool:
 	-rm -f *.lo
 
diff --git a/libsframe/testsuite/libsframe.find/find.exp b/libsframe/testsuite/libsframe.find/find.exp
index 05ac02ba60b..ce804907dd2 100644
--- a/libsframe/testsuite/libsframe.find/find.exp
+++ b/libsframe/testsuite/libsframe.find/find.exp
@@ -25,6 +25,7 @@ if [string equal $COMPAT_DEJAGNU "no"] {
     verbose -log "SFrame testsuite needs perhaps a more recent DejaGnu"
     unsupported findfre-1
     unsupported findfunc-1
+    unsupported plt-findfre-1
     return;
 }
 
@@ -35,3 +36,7 @@ if { [host_execute "testsuite/libsframe.find/findfre-1"] ne "" } {
 if { [host_execute "testsuite/libsframe.find/findfunc-1"] ne "" } {
     fail "findfunc-1"
 }
+
+if { [host_execute "testsuite/libsframe.find/plt-findfre-1"] ne "" } {
+    fail "plt-findfre-1"
+}
diff --git a/libsframe/testsuite/libsframe.find/local.mk b/libsframe/testsuite/libsframe.find/local.mk
index e8e4fa8091e..03206b134d6 100644
--- a/libsframe/testsuite/libsframe.find/local.mk
+++ b/libsframe/testsuite/libsframe.find/local.mk
@@ -1,5 +1,5 @@
 if HAVE_COMPAT_DEJAGNU
-  check_PROGRAMS += %D%/findfre-1 %D%/findfunc-1
+  check_PROGRAMS += %D%/findfre-1 %D%/findfunc-1 %D%/plt-findfre-1
 endif
 
 %C%_findfre_1_SOURCES = %D%/findfre-1.c
@@ -9,3 +9,7 @@ endif
 %C%_findfunc_1_SOURCES = %D%/findfunc-1.c
 %C%_findfunc_1_LDADD = ${top_builddir}/libsframe.la
 %C%_findfunc_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
+
+%C%_plt_findfre_1_SOURCES = %D%/plt-findfre-1.c
+%C%_plt_findfre_1_LDADD = ${top_builddir}/libsframe.la
+%C%_plt_findfre_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
diff --git a/libsframe/testsuite/libsframe.find/plt-findfre-1.c b/libsframe/testsuite/libsframe.find/plt-findfre-1.c
new file mode 100644
index 00000000000..f6f4fd73d70
--- /dev/null
+++ b/libsframe/testsuite/libsframe.find/plt-findfre-1.c
@@ -0,0 +1,127 @@
+/* plt-findfre-1.c -- Test for sframe_find_fre for SFRAME_FDE_TYPE_PCMASK.
+
+   Copyright (C) 2023 Free Software Foundation, Inc.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+#include "config.h"
+
+#include <stdlib.h>
+#include <string.h>
+#include <sys/stat.h>
+
+#include "sframe-api.h"
+
+/* DejaGnu should not use gnulib's vsnprintf replacement here.  */
+#undef vsnprintf
+#include <dejagnu.h>
+
+static int
+add_plt_fde1 (sframe_encoder_ctx *ectx, int idx)
+{
+  int i, err;
+  /* A contiguous block containing 3 FREs.  The start_ip_offset must remain
+     less than 16 bytes.  */
+  sframe_frame_row_entry fres[]
+    = { {0x0, {0x1, 0, 0}, 0x3},
+	{0x6, {0x2, 0xf0, 0}, 0x5},
+	{0xc, {0x3, 0xf0, 0}, 0x4}
+      };
+
+  unsigned char finfo = sframe_fde_create_func_info (SFRAME_FRE_TYPE_ADDR1,
+						     SFRAME_FDE_TYPE_PCMASK);
+  /* 5 pltN entries of 16 bytes each.  */
+  err = sframe_encoder_add_funcdesc (ectx, 0x1000, 16*5, finfo, 3);
+  if (err == -1)
+    return err;
+
+  for (i = 0; i < 3; i++)
+    if (sframe_encoder_add_fre (ectx, idx, fres+i) == SFRAME_ERR)
+      return -1;
+
+  return 0;
+}
+
+int main (void)
+{
+  sframe_encoder_ctx *ectx;
+  sframe_decoder_ctx *dctx;
+  sframe_frame_row_entry frep;
+  char *sframe_buf;
+  size_t sf_size;
+  int err = 0;
+  unsigned int fde_cnt = 0;
+
+#define TEST(name, cond)                                                      \
+  do                                                                          \
+    {                                                                         \
+      if (cond)                                                               \
+	pass (name);                                                          \
+      else                                                                    \
+	fail (name);                                                          \
+    }                                                                         \
+    while (0)
+
+  ectx = sframe_encode (SFRAME_VERSION, 0, SFRAME_ABI_AMD64_ENDIAN_LITTLE,
+			SFRAME_CFA_FIXED_FP_INVALID,
+			-8, /* Fixed RA offset for AMD64.  */
+			&err);
+
+  err = add_plt_fde1 (ectx, 0);
+  TEST ("plt-findfre-1: Adding FDE1 for plt", err == 0);
+
+  fde_cnt = sframe_encoder_get_num_fidx (ectx);
+  TEST ("plt-findfre-1: Test FDE count", fde_cnt == 1);
+
+  sframe_buf = sframe_encoder_write (ectx, &sf_size, &err);
+  TEST ("plt-findfre-1: Encoder write", err == 0);
+
+  dctx = sframe_decode (sframe_buf, sf_size, &err);
+  TEST("plt-findfre-1: Decoder setup", dctx != NULL);
+
+  /* Find the first FRE in PLT1.  */
+  err = sframe_find_fre (dctx, (0x1000 + 0x0), &frep);
+  TEST("plt-findfre-1: Find first FRE in PLT1",
+       ((err == 0) && (sframe_fre_get_cfa_offset (dctx, &frep, &err) == 0x1)));
+
+  /* Find the second FRE.  */
+  err = sframe_find_fre (dctx, (0x1000 + 0x6), &frep);
+  TEST("plt-findfre-1: Find second FRE in PLT1",
+       ((err == 0) && (sframe_fre_get_cfa_offset (dctx, &frep, &err) == 0x2)));
+
+  /* Find the last FRE.  */
+  err = sframe_find_fre (dctx, (0x1000 + 0xc), &frep);
+  TEST("plt-findfre-1: Find last FRE in PLT1",
+       ((err == 0) && (sframe_fre_get_cfa_offset (dctx, &frep, &err) == 0x3)));
+
+  /* Find the first FRE in PLT4.  */
+  err = sframe_find_fre (dctx, (0x1000 + 16*3 + 0x0), &frep);
+  TEST("plt-findfre-1: Find first FRE in PLT4",
+       ((err == 0) && (sframe_fre_get_cfa_offset (dctx, &frep, &err) == 0x1)));
+
+  /* Find the second FRE in PLT4.  */
+  err = sframe_find_fre (dctx, (0x1000 + 16*3 + 0x6), &frep);
+  TEST("plt-findfre-1: Find second FRE in PLT4",
+       ((err == 0) && (sframe_fre_get_cfa_offset (dctx, &frep, &err) == 0x2)));
+
+  /* Find the last FRE in PLT4.  */
+  err = sframe_find_fre (dctx, (0x1000 + 16*3 + 0xc), &frep);
+  TEST("plt-findfre-1: Find last FRE in PLT4",
+       ((err == 0) && (sframe_fre_get_cfa_offset (dctx, &frep, &err) == 0x3)));
+
+  sframe_encoder_free (&ectx);
+  sframe_decoder_free (&dctx);
+
+  return 0;
+}
-- 
2.39.2


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [COMMITTED] libsframe: fix sframe_find_fre for pltN entries
@ 2023-06-29 18:26 Indu Bhagat
  0 siblings, 0 replies; 3+ messages in thread
From: Indu Bhagat @ 2023-06-29 18:26 UTC (permalink / raw)
  To: binutils; +Cc: Indu Bhagat

For a toy application on x86_64, for example, following is the SFrame
stack trace information for the 3 pltN entries of 16 bytes each:

   func idx [1]: pc = 0x401030, size = 48 bytes
   STARTPC[m]      CFA       FP        RA
   0000000000000000  sp+8      u         u
   000000000000000b  sp+16     u         u

The data in first column is the start_ip_offset.  Also note that the FDE
is of type SFRAME_FDE_TYPE_PCMASK (denoted by the [m] on LHS).

Where each pltN (note: excluding plt0 entry) entry looks like:

  401030: jmp    *0x2fca(%rip)
  401036: push   $0x0
  40103b: jmp    401020<_init+0x20>

  401040: jmp    *0x2fc2(%rip)
  401046: push   $0x1
  40104b: jmp    401020<_init+0x20>

  401050: jmp    *0x2fba(%rip)
  401056: push   $0x2
  40105b: jmp    401020<_init+0x20>

Now, to find SFrame stack trace information from an FDE of type
SFRAME_FDE_TYPE_PCMASK, sframe_find_fre () was doing an operation
like,
  (start_ip_offset & 0xf) >= (pc & 0xf)

This works for pltN entry of size, say, less than 16 bytes.  But if the
pltN entries or similar code stubs (for which SFrame FDE of type
SFRAME_FDE_TYPE_PCMASK may be used), evolve to be of size > 16 bytes,
this will cease to work.

To match the range covered by the SFrame FRE, one should instead perform
a modulo operation.  The constant for the modulo operation must be the
size of the pltN entry.  Further, this constant should ideally be
encoded in the format, as it may be different for each ABI.

In SFrame Version 2 of the format, we will move towards encoding it
explicitly in the SFrame FDE.  For now, fix up the logic to at least
move towards modulo operation.

libsframe/
	* sframe.c (sframe_fre_check_range_p): New definition.
	(sframe_find_fre): Refactor a bit and use the new definition
	above.
include/
	* sframe.h (SFRAME_FDE_TYPE_PCMASK): Update comment.
libsframe/doc/
	* sframe-spec.texi: Fix the text for SFRAME_FDE_TYPE_PCMASK FDE
	type.
---
 include/sframe.h               |  4 +-
 libsframe/doc/sframe-spec.texi |  6 ++-
 libsframe/sframe.c             | 78 ++++++++++++++++++++++++----------
 3 files changed, 62 insertions(+), 26 deletions(-)

diff --git a/include/sframe.h b/include/sframe.h
index c3dbb3a4097..cdf275f69e4 100644
--- a/include/sframe.h
+++ b/include/sframe.h
@@ -117,8 +117,8 @@ extern "C"
 
 /* Unwinders perform a (PC >= FRE_START_ADDR) to look up a matching FRE.  */
 #define SFRAME_FDE_TYPE_PCINC   0
-/* Unwinders perform a (PC & FRE_START_ADDR_AS_MASK >= FRE_START_ADDR_AS_MASK)
-   to look up a matching FRE.  */
+/* Unwinders perform a (PC % REP_BLOCK_SIZE >= FRE_START_ADDR) to look up a
+   matching FRE.  */
 #define SFRAME_FDE_TYPE_PCMASK  1
 
 typedef struct sframe_preamble
diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index 5155410bdc8..a37a6f91414 100644
--- a/libsframe/doc/sframe-spec.texi
+++ b/libsframe/doc/sframe-spec.texi
@@ -451,8 +451,10 @@ entries and trampolines.
 
 @item SFRAME_FDE_TYPE_PCMASK
 @tab 1 @tab  Unwinders perform a @*
-(PC & FRE_START_ADDR_AS_MASK >= FRE_START_ADDR_AS_MASK)
-to look up a matching FRE.
+(PC % REP_BLOCK_SIZE @*
+ >= FRE_START_ADDR)
+to look up a matching FRE.  REP_BLOCK_SIZE is the size in bytes of the
+repeating block of program instructions.
 
 @end multitable
 
diff --git a/libsframe/sframe.c b/libsframe/sframe.c
index 29142436b84..fd966cfffd4 100644
--- a/libsframe/sframe.c
+++ b/libsframe/sframe.c
@@ -362,6 +362,53 @@ sframe_decoder_get_funcdesc_at_index (sframe_decoder_ctx *ctx,
   return fdep;
 }
 
+/* Check whether for the given FDEP, the SFrame Frame Row Entry identified via
+   the START_IP_OFFSET and the END_IP_OFFSET, provides the stack trace
+   information for the PC.  */
+
+static bool
+sframe_fre_check_range_p (sframe_func_desc_entry *fdep,
+			  int32_t start_ip_offset, int32_t end_ip_offset,
+			  int32_t pc)
+{
+  int32_t start_ip, end_ip;
+  int32_t func_start_addr;
+  uint32_t rep_block_size;
+  uint32_t fde_type;
+  int32_t masked_pc;
+  bool mask_p;
+  bool ret;
+
+  ret = false;
+  /* FIXME - the rep_block_size should be encoded in the format somehow.  For
+     AMD64, each pltN entry stub in .plt is 16 bytes.  */
+  rep_block_size = 16;
+
+  if (!fdep)
+    return ret;
+
+  func_start_addr = fdep->sfde_func_start_address;
+  fde_type = sframe_get_fde_type (fdep);
+  mask_p = (fde_type == SFRAME_FDE_TYPE_PCMASK);
+
+  if (!mask_p)
+    {
+      start_ip = start_ip_offset + func_start_addr;
+      end_ip = end_ip_offset + func_start_addr;
+      ret = ((start_ip <= pc) && (end_ip >= pc));
+    }
+  else
+    {
+      /* For FDEs for repetitive pattern of insns, we need to return the FRE
+	 where pc % rep_block_size is between start_ip_offset and
+	 end_ip_offset.  */
+      masked_pc = pc % rep_block_size;
+      ret = ((start_ip_offset <= masked_pc) && (end_ip_offset >= masked_pc));
+    }
+
+  return ret;
+}
+
 static int
 flip_fre (char *fp, uint32_t fre_type, size_t *fre_size)
 {
@@ -1056,19 +1103,14 @@ sframe_find_fre (sframe_decoder_ctx *ctx, int32_t pc,
 {
   sframe_frame_row_entry cur_fre;
   sframe_func_desc_entry *fdep;
-  uint32_t fre_type, fde_type;
-  uint32_t end_ip_offset, i;
-  int32_t start_ip, end_ip;
+  uint32_t fre_type, fde_type, i;
+  int32_t start_ip_offset;
   int32_t func_start_addr;
+  int32_t end_ip_offset;
   const char *fres;
   size_t size = 0;
   int err = 0;
-  /* For regular FDEs (i.e. fde_type SFRAME_FDE_TYPE_PCINC),
-     where the start address in the FRE is an offset from start pc,
-     use a bitmask with all bits set so that none of the address bits are
-     ignored.  In this case, we need to return the FRE where
-     (PC >= FRE_START_ADDR) */
-  uint64_t bitmask = 0xffffffff;
+  bool mask_p;
 
   if ((ctx == NULL) || (frep == NULL))
     return sframe_set_errno (&err, SFRAME_ERR_INVAL);
@@ -1080,14 +1122,7 @@ sframe_find_fre (sframe_decoder_ctx *ctx, int32_t pc,
 
   fre_type = sframe_get_fre_type (fdep);
   fde_type = sframe_get_fde_type (fdep);
-
-  /* For FDEs for repetitive pattern of insns, we need to return the FRE
-     such that (PC & FRE_START_ADDR_AS_MASK >= FRE_START_ADDR_AS_MASK).
-     so, update the bitmask to the start address.  */
-  /* FIXME - the bitmask should be picked per ABI or encoded in the format
-     somehow. For AMD64, the pltN entry stub is 16 bytes. */
-  if (fde_type == SFRAME_FDE_TYPE_PCMASK)
-    bitmask = 0xf;
+  mask_p = (fde_type == SFRAME_FDE_TYPE_PCMASK);
 
   fres = ctx->sfd_fres + fdep->sfde_func_start_fre_off;
   func_start_addr = fdep->sfde_func_start_address;
@@ -1098,15 +1133,14 @@ sframe_find_fre (sframe_decoder_ctx *ctx, int32_t pc,
      if (err)
        return sframe_set_errno (&err, SFRAME_ERR_FRE_INVAL);
 
-     start_ip = func_start_addr + cur_fre.fre_start_addr;
+     start_ip_offset = cur_fre.fre_start_addr;
      end_ip_offset = sframe_fre_get_end_ip_offset (fdep, i, fres + size);
-     end_ip = func_start_addr + end_ip_offset;
 
-     if ((start_ip & bitmask) > (pc & bitmask))
+     /* First FRE's start_ip must be more than pc for regular SFrame FDEs.  */
+     if (i == 0 && !mask_p && (start_ip_offset + func_start_addr) > pc)
        return sframe_set_errno (&err, SFRAME_ERR_FRE_INVAL);
 
-     if (((start_ip & bitmask) <= (pc & bitmask))
-	 && (end_ip & bitmask) >= (pc & bitmask))
+     if (sframe_fre_check_range_p (fdep, start_ip_offset, end_ip_offset, pc))
        {
 	 sframe_frame_row_entry_copy (frep, &cur_fre);
 	 return 0;
-- 
2.39.2


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2023-06-29 18:26 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-06-09 19:28 [COMMITTED] libsframe: fix sframe_find_fre for pltN entries Indu Bhagat
2023-06-09 19:28 ` [COMMITTED] libsframe: testsuite: add sframe_find_fre tests " Indu Bhagat
2023-06-29 18:26 [COMMITTED] libsframe: fix sframe_find_fre " Indu Bhagat

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).