libsframe: testsuite: add tests for sframe_get_funcdesc_with_addr API

sframe_get_funcdesc_with_addr API is currently used internally by the
sframe_find_fre ().

In this test, we create three dummy SFrame FDEs with 4 FREs each.  Then,
we use few negative tests to lookup FREs with PCs not in the range of
PCs covered by the FDEs, ensuring graceful return from
sframe_get_funcdesc_with_addr in all cases.  Some positive tests are
also added that exercise further scenarios as well.

libsframe/
	* Makefile.in: Regenerated.
	* testsuite/libsframe.find/find.exp: Include new test.
	* testsuite/libsframe.find/findfunc-1.c: New Test.
	* testsuite/libsframe.find/local.mk: Include new test.

3 files changed, 214 insertions, 1 deletions

diff --git a/libsframe/testsuite/libsframe.find/find.exp b/libsframe/testsuite/libsframe.find/find.exp
index 463d94a..05ac02b 100644
--- a/libsframe/testsuite/libsframe.find/find.exp
+++ b/libsframe/testsuite/libsframe.find/find.exp
@@ -24,9 +24,14 @@ load_lib dejagnu.exp
 if [string equal $COMPAT_DEJAGNU "no"] {
     verbose -log "SFrame testsuite needs perhaps a more recent DejaGnu"
     unsupported findfre-1
+    unsupported findfunc-1
     return;
 }
 
 if { [host_execute "testsuite/libsframe.find/findfre-1"] ne "" } {
     fail "findfre-1"
 }
+
+if { [host_execute "testsuite/libsframe.find/findfunc-1"] ne "" } {
+    fail "findfunc-1"
+}
diff --git a/libsframe/testsuite/libsframe.find/findfunc-1.c b/libsframe/testsuite/libsframe.find/findfunc-1.c
new file mode 100644
index 0000000..292e818
--- /dev/null
+++ b/libsframe/testsuite/libsframe.find/findfunc-1.c
@@ -0,0 +1,204 @@
+/* findfunc-1.c -- Test for sframe_get_funcdesc_with_addr in libsframe.
+
+   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/>.  */
+
+/* sframe_get_funcdesc_with_addr is a core API in the libsframe library, which
+   is used to find an FDE given a PC.  It is used by sframe_find_fre ().  The
+   latter is the mainstay for an SFrame based stack tracer.
+
+   The tests in here stress the sframe_get_funcdesc_with_addr API via calls to
+   the sframe_find_fre ().  */
+
+#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_fde1 (sframe_encoder_ctx *encode, int idx)
+{
+  int i, err;
+  /* A contiguous block containing 4 FREs.  */
+  sframe_frame_row_entry fres[]
+    = { {0x0, {0x1, 0, 0}, 0x3},
+	{0x1, {0x2, 0xf0, 0}, 0x5},
+	{0x10, {0x3, 0xf0, 0}, 0x4},
+	{0x38, {0x8, 0xf0, 0}, 0x5}
+      };
+
+  unsigned char finfo = sframe_fde_create_func_info (SFRAME_FRE_TYPE_ADDR1,
+						     SFRAME_FDE_TYPE_PCINC);
+  err = sframe_encoder_add_funcdesc (encode, 0xfffff03e, 0x40, finfo, 4);
+  if (err == -1)
+    return err;
+
+  for (i = 0; i < 4; i++)
+    if (sframe_encoder_add_fre (encode, idx,fres+i) == SFRAME_ERR)
+      return -1;
+
+  return 0;
+}
+
+static int
+add_fde2 (sframe_encoder_ctx *encode, int idx)
+{
+  int i, err;
+  /* A contiguous block containing 4 FREs.  */
+  sframe_frame_row_entry fres[]
+    = { {0x0, {0x10, 0, 0}, 0x3},
+	{0x10, {0x12, 0xf0, 0}, 0x5},
+	{0x14, {0x14, 0xf0, 0}, 0x4},
+	{0x20, {0x15, 0xf0, 0}, 0x5}
+      };
+
+  unsigned char finfo = sframe_fde_create_func_info (SFRAME_FRE_TYPE_ADDR1,
+						     SFRAME_FDE_TYPE_PCINC);
+  err = sframe_encoder_add_funcdesc (encode, 0xfffff08e, 0x60, finfo, 4);
+  if (err == -1)
+    return err;
+
+  for (i = 0; i < 4; i++)
+    if (sframe_encoder_add_fre (encode, idx, fres+i) == SFRAME_ERR)
+      return -1;
+
+  return 0;
+}
+
+static int
+add_fde3 (sframe_encoder_ctx *encode, int idx)
+{
+  int i, err;
+  /* A contiguous block containing 4 FREs.  */
+  sframe_frame_row_entry fres[]
+    = { {0x0, {0x16, 0, 0}, 0x3},
+	{0x1, {0x17, 0xf0, 0}, 0x5},
+	{0x10, {0x18, 0xf0, 0}, 0x4},
+	{0x38, {0x19, 0xf0, 0}, 0x5}
+      };
+
+  unsigned char finfo = sframe_fde_create_func_info (SFRAME_FRE_TYPE_ADDR1,
+						     SFRAME_FDE_TYPE_PCINC);
+  err = sframe_encoder_add_funcdesc (encode, 0xfffff10e, 0x40, finfo, 4);
+  if (err == -1)
+    return err;
+
+  for (i = 0; i < 4; i++)
+    if (sframe_encoder_add_fre (encode, idx,fres+i) == SFRAME_ERR)
+      return -1;
+
+  return 0;
+}
+
+int main (void)
+{
+  sframe_encoder_ctx *encode;
+  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)
+
+  encode = sframe_encode (SFRAME_VERSION, 0,
+			  SFRAME_ABI_AMD64_ENDIAN_LITTLE,
+			  SFRAME_CFA_FIXED_FP_INVALID,
+			  -8, /* Fixed RA offset for AMD64.  */
+			  &err);
+
+  /* Add FDE at index 0.  */
+  err = add_fde1 (encode, 0);
+  TEST ("findfunc-1: Adding FDE1", err == 0);
+
+  /* Add FDE at index 1.  */
+  err = add_fde2 (encode, 1);
+  TEST ("findfunc-1: Adding FDE2", err == 0);
+
+  /* Add FDE at index 2.  */
+  err = add_fde3 (encode, 2);
+  TEST ("findfunc-1: Adding FDE3", err == 0);
+
+  fde_cnt = sframe_encoder_get_num_fidx (encode);
+  TEST ("findfunc-1: Test FDE count", fde_cnt == 3);
+
+  sframe_buf = sframe_encoder_write (encode, &sf_size, &err);
+  TEST ("findfunc-1: Encoder write", err == 0);
+
+  dctx = sframe_decode (sframe_buf, sf_size, &err);
+  TEST("findfunc-1: Decoder setup", dctx != NULL);
+
+  /* Following negative tests check that libsframe APIs
+     (sframe_get_funcdesc_with_addr, sframe_find_fre) work
+     well for PCs not covered by the FDEs.  */
+
+  /* Search with PC less than the first FDE's start addr.  */
+  err = sframe_find_fre (dctx, (0xfffff03e - 0x15), &frep);
+  TEST("findfunc-1: test-1: Find FRE for PC not in range",
+       (err == SFRAME_ERR));
+
+  /* Search with a PC between func1's last PC and func2's first PC.  */
+  err = sframe_find_fre (dctx, (0xfffff03e + 0x40 + 0x1), &frep);
+  TEST("findfunc-1: test-2: Find FRE for PC not in range",
+       (err == SFRAME_ERR));
+
+  /* Search for a PC between func2's last PC and func3's first PC.  */
+  err = sframe_find_fre (dctx, (0xfffff08e + 0x60 + 0x3), &frep);
+  TEST("findfunc-1: test-3: Find FRE for PC not in range",
+       (err == SFRAME_ERR));
+
+  /* Search for a PC beyond the last func, i.e., > func3's last PC.  */
+  err = sframe_find_fre (dctx, (0xfffff10e + 0x40 + 0x10), &frep);
+  TEST("findfunc-1: test-4: Find FRE for PC not in range",
+       (err == SFRAME_ERR));
+
+  /* And some positive tests... */
+
+  /* Find an FRE for PC in FDE1.  */
+  err = sframe_find_fre (dctx, (0xfffff03e + 0x9), &frep);
+  TEST("findfunc-1: Find FRE in FDE1",
+       ((err == 0) && (sframe_fre_get_cfa_offset(dctx, &frep, &err) == 0x2)));
+
+  /* Find an FRE for PC in FDE2.  */
+  err = sframe_find_fre (dctx, (0xfffff08e + 0x11), &frep);
+  TEST("findfunc-1: Find FRE in FDE2",
+       ((err == 0) && (sframe_fre_get_cfa_offset(dctx, &frep, &err) == 0x12)));
+
+  /* Find an FRE for PC in FDE3.  */
+  err = sframe_find_fre (dctx, (0xfffff10e + 0x10), &frep);
+  TEST("findfunc-1: Find FRE in FDE3",
+       ((err == 0) && (sframe_fre_get_cfa_offset(dctx, &frep, &err) == 0x18)));
+
+  sframe_encoder_free (&encode);
+  sframe_decoder_free (&dctx);
+
+  return 0;
+}
diff --git a/libsframe/testsuite/libsframe.find/local.mk b/libsframe/testsuite/libsframe.find/local.mk
index 9943520..e8e4fa8 100644
--- a/libsframe/testsuite/libsframe.find/local.mk
+++ b/libsframe/testsuite/libsframe.find/local.mk
@@ -1,7 +1,11 @@
 if HAVE_COMPAT_DEJAGNU
-  check_PROGRAMS += %D%/findfre-1
+  check_PROGRAMS += %D%/findfre-1 %D%/findfunc-1
 endif
 
 %C%_findfre_1_SOURCES = %D%/findfre-1.c
 %C%_findfre_1_LDADD = ${top_builddir}/libsframe.la
 %C%_findfre_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
+
+%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