libsframe: add the SFrame library

libsframe is a library that allows you to:
- decode a .sframe section
- probe and inspect a .sframe section
- encode (and eventually write) a .sframe section.

This library is currently being used by the linker, readelf, objdump.
This library will also be used by the SFrame unwinder which is still
to be upstream'd.

The file include/sframe-api.h defines the user-facing APIs for decoding,
encoding and probing .sframe sections. A set of error codes together
with their error message strings are also defined.

Endian flipping is performed automatically at read and write time, if
cross-endianness is detected.

ChangeLog:

	* Makefile.def: Add libsframe as new module with its
	dependencies.
	* Makefile.in: Regenerated.
	* binutils/Makefile.am: Add libsframe.
	* binutils/Makefile.in: Regenerated.
	* configure: Regenerated
	* configure.ac: Add libsframe to host_libs.
	* libsframe/Makefile.am: New file.
	* libsframe/Makefile.in: New file.
	* libsframe/aclocal.m4: New file.
	* libsframe/config.h.in: New file.
	* libsframe/configure: New file.
	* libsframe/configure.ac: New file.
	* libsframe/sframe-error.c: New file.
	* libsframe/sframe-impl.h: New file.
	* libsframe/sframe.c: New file.

include/ChangeLog:

	* sframe-api.h: New file.

testsuite/ChangeLog:

	* libsframe/testsuite/Makefile.am: New file.
	* libsframe/testsuite/Makefile.in: Regenerated.
	* libsframe/testsuite/libsframe.decode/Makefile.am: New
	  file.
	* libsframe/testsuite/libsframe.decode/Makefile.in:
	  Regenerated.
	* libsframe/testsuite/libsframe.decode/decode.exp: New file.
	* libsframe/testsuite/libsframe.encode/Makefile.am:
	  Likewise.
	* libsframe/testsuite/libsframe.encode/Makefile.in:
	  Regenerated.
	* libsframe/testsuite/libsframe.encode/encode.exp: New file.
	* libsframe/testsuite/libsframe.encode/encode-1.c: Likewise.
	* libsframe/testsuite/libsframe.decode/be-flipping.c: Likewise.
	* libsframe/testsuite/libsframe.decode/frecnt-1.c: Likewise.
	* libsframe/testsuite/libsframe.decode/frecnt-2.c: Likewise.
	* libsframe/testsuite/libsframe.decode/DATA-BE: New file.
	* libsframe/testsuite/libsframe.decode/DATA1: Likewise.
	* libsframe/testsuite/libsframe.decode/DATA2: Likewise.

8 files changed, 384 insertions, 0 deletions

diff --git a/libsframe/testsuite/libsframe.decode/DATA-BE b/libsframe/testsuite/libsframe.decode/DATA-BE
new file mode 100644
index 0000000..3e19ff4
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/DATA-BE
diff --git a/libsframe/testsuite/libsframe.decode/DATA1 b/libsframe/testsuite/libsframe.decode/DATA1
new file mode 100644
index 0000000..2b3ef8e
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/DATA1
diff --git a/libsframe/testsuite/libsframe.decode/DATA2 b/libsframe/testsuite/libsframe.decode/DATA2
new file mode 100644
index 0000000..68fc2d2
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/DATA2
diff --git a/libsframe/testsuite/libsframe.decode/be-flipping.c b/libsframe/testsuite/libsframe.decode/be-flipping.c
new file mode 100644
index 0000000..d915f9b
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/be-flipping.c
@@ -0,0 +1,115 @@
+/* be-flipping.c -- Test for handling different endianness in libsframe.
+
+   Copyright (C) 2022 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 <stdio.h>
+#include <stdlib.h>
+#include <sys/stat.h>
+
+#include "sframe-api.h"
+
+/* DejaGnu should not use gnulib's vsnprintf replacement here.  */
+#undef vsnprintf
+#include <dejagnu.h>
+
+/* SFrame info from the following source (1 fde 5 fres):
+   static int cnt;
+   extern void foo (void);
+
+   int bar()
+   {
+     cnt++;
+     if (cnt == 3)
+       foo();
+    return (cnt);
+  }
+  gcc -mbig-endian -Wa,--gsframe -c -O3 t.c
+  objcopy --dump-section .sframe=DATA-BE t.o
+ */
+#define DATA	"DATA-BE"
+
+int
+main (void)
+{
+  sframe_decoder_ctx *dctx = NULL;
+  uint32_t nfres, fsize;
+  int32_t fstart;
+  unsigned char finfo;
+  int err = 0;
+  FILE *fp;
+  struct stat st;
+  char *sf_buf;
+  size_t sf_size;
+
+#define TEST(name, cond)                                                      \
+  do                                                                          \
+    {                                                                         \
+      if (cond)                                                               \
+	pass (name);                                                          \
+      else                                                                    \
+	fail (name);                                                          \
+    }                                                                         \
+    while (0)
+
+  /* Test setup.  */
+  fp = fopen (DATA, "r");
+  if (fp == NULL)
+    goto setup_fail;
+  if (fstat (fileno (fp), &st) < 0)
+    {
+      perror ("fstat");
+      fclose (fp);
+      goto setup_fail;
+    }
+  sf_buf = malloc (st.st_size);
+  if (sf_buf == NULL)
+    {
+      perror ("malloc");
+      goto setup_fail;
+    }
+  sf_size = fread (sf_buf, 1, st.st_size, fp);
+  fclose (fp);
+  if (sf_size == 0)
+    {
+      fprintf (stderr, "Decode: Read buffer failed\n");
+      goto setup_fail;
+    }
+
+  /* Execute tests.  */
+
+  /* Call to sframe_decode will endian flip the input buffer (big-endian) if
+     the host running the test is a little-endian system.  This endian-flipped
+     copy of the buffer is kept internally in dctx.  */
+  dctx = sframe_decode (sf_buf, sf_size, &err);
+  TEST ("be-flipping: Decoder setup", dctx != NULL);
+
+  unsigned int fde_cnt = sframe_decoder_get_num_fidx (dctx);
+  TEST ("be-flipping: Decoder FDE count", fde_cnt == 1);
+
+  err = sframe_decoder_get_funcdesc (dctx, 0, &nfres, &fsize, &fstart, &finfo);
+  TEST ("be-flipping: Decoder get FDE", err == 0);
+  TEST ("be-flipping: Decoder FRE count", nfres == 5);
+      
+  sframe_decoder_free (&dctx);
+  return 0;
+
+setup_fail:
+  sframe_decoder_free (&dctx);
+  fail ("be-flipping: Test setup");
+  return 1;
+}
diff --git a/libsframe/testsuite/libsframe.decode/decode.exp b/libsframe/testsuite/libsframe.decode/decode.exp
new file mode 100644
index 0000000..0d85994
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/decode.exp
@@ -0,0 +1,50 @@
+# Copyright (C) 2022 Free Software Foundation, Inc.
+#
+# This file is part of the GNU Binutils.
+#
+# 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, write to the Free Software
+# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
+# MA 02110-1301, USA.
+#
+
+load_lib dejagnu.exp
+
+# Run the tests only if compatible dejagnu gcc pair is found
+if [string equal $COMPAT_DEJAGNU "no"] {
+    verbose -log "SFrame testsuite needs perhaps a more recent DejaGnu"
+    unsupported be-flipping
+    unsupported frecnt-1
+    unsupported frecnt-2
+    return;
+}
+
+catch "exec ln -s $srcdir/libsframe.decode/DATA1 ." status
+catch "exec ln -s $srcdir/libsframe.decode/DATA2 ." status
+catch "exec ln -s $srcdir/libsframe.decode/DATA-BE ." status
+
+if { [host_execute "testsuite/libsframe.decode/be-flipping"] ne "" } {
+    fail "be-flipping"
+}
+
+if { [host_execute "testsuite/libsframe.decode/frecnt-1"] ne "" } {
+    fail "frecnt-1"
+}
+
+if { [host_execute "testsuite/libsframe.decode/frecnt-2"] ne "" } {
+    fail "frecnt-2"
+}
+
+catch "exec rm DATA1" status
+catch "exec rm DATA2" status
+catch "exec rm DATA-BE" status
diff --git a/libsframe/testsuite/libsframe.decode/frecnt-1.c b/libsframe/testsuite/libsframe.decode/frecnt-1.c
new file mode 100644
index 0000000..49861ed
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/frecnt-1.c
@@ -0,0 +1,99 @@
+/* frecnt-1.c -- Test for decoder in libsframe.
+
+   Copyright (C) 2022 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 <stdio.h>
+#include <stdlib.h>
+#include <sys/stat.h>
+
+#include "sframe-api.h"
+
+/* DejaGnu should not use gnulib's vsnprintf replacement here.  */
+#undef vsnprintf
+#include <dejagnu.h>
+
+/*
+ * SFrame info from the following source (1 fde 4 fres):
+ * static int cnt;
+ * int main() { cnt++; return (cnt); }
+ */
+#define DATA	"DATA1"
+
+int
+main (void)
+{
+  sframe_decoder_ctx *dctx = NULL;
+  uint32_t nfres, fsize;
+  int32_t fstart;
+  unsigned char finfo;
+  int err = 0;
+  FILE *fp;
+  struct stat st;
+  char *sf_buf;
+  size_t sf_size;
+
+#define TEST(name, cond)                                                      \
+  do                                                                          \
+    {                                                                         \
+      if (cond)                                                               \
+	pass (name);                                                          \
+      else                                                                    \
+	fail (name);                                                          \
+    }                                                                         \
+    while (0)
+
+  /* Test Setup.  */
+  fp = fopen (DATA, "r");
+  if (fp == NULL)
+    goto setup_fail;
+  if (fstat (fileno (fp), &st) < 0)
+    {
+      perror ("fstat");
+      fclose (fp);
+      goto setup_fail;
+    }
+  sf_buf = malloc (st.st_size);
+  if (sf_buf == NULL)
+    {
+      perror ("malloc");
+      goto setup_fail;
+    }
+
+  /* Execute tests.  */
+  sf_size = fread (sf_buf, 1, st.st_size, fp);
+  fclose (fp);
+  TEST ("frecnt-1: Read data", sf_size != 0);
+
+  dctx = sframe_decode (sf_buf, sf_size, &err);
+  TEST ("frecnt-1: Decoder setup", dctx != NULL);
+
+  unsigned int fde_cnt = sframe_decoder_get_num_fidx (dctx);
+  TEST ("frecnt-1: Decoder FDE count", fde_cnt == 1);
+
+  err = sframe_decoder_get_funcdesc (dctx, 0, &nfres, &fsize, &fstart, &finfo);
+  TEST ("frecnt-1: Decoder get FDE", err == 0);
+  TEST ("frecnt-1: Decoder FRE count", nfres == 4);
+
+  sframe_decoder_free (&dctx);
+  return 0;
+
+setup_fail:
+  sframe_decoder_free (&dctx);
+  fail ("frecnt-1: Test setup");
+  return 1;
+}
diff --git a/libsframe/testsuite/libsframe.decode/frecnt-2.c b/libsframe/testsuite/libsframe.decode/frecnt-2.c
new file mode 100644
index 0000000..7c140d8
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/frecnt-2.c
@@ -0,0 +1,104 @@
+/* frecnt-2.c -- Test for decoder in libsframe.
+
+   Copyright (C) 2022 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 <stdio.h>
+#include <stdlib.h>
+#include <sys/stat.h>
+
+#include "sframe-api.h"
+
+/* DejaGnu should not use gnulib's vsnprintf replacement here.  */
+#undef vsnprintf
+#include <dejagnu.h>
+
+/*
+ * SFrame info from the following source (2 fde 8 fres):
+ * static int cnt;
+ * int foo() { return ++cnt; }
+ * int main() { return foo(); }
+ */
+#define DATA	"DATA2"
+
+int
+main (void)
+{
+  sframe_decoder_ctx *dctx = NULL;
+  uint32_t nfres, fsize;
+  int32_t fstart;
+  unsigned char finfo;
+  unsigned int i;
+  int err = 0;
+  FILE *fp;
+  struct stat st;
+  char *sf_buf;
+  size_t sf_size;
+
+#define TEST(name, cond)                                                      \
+  do                                                                          \
+    {                                                                         \
+      if (cond)                                                               \
+	pass (name);                                                          \
+      else                                                                    \
+	fail (name);                                                          \
+    }                                                                         \
+    while (0)
+
+  fp = fopen (DATA, "r");
+  if (fp == NULL)
+    goto setup_fail;
+  if (fstat (fileno (fp), &st) < 0)
+    {
+      perror ("fstat");
+      fclose (fp);
+      goto setup_fail;
+    }
+  sf_buf = malloc (st.st_size);
+  if (sf_buf == NULL)
+    {
+      perror ("malloc");
+      goto setup_fail;
+    }
+
+  /* Execute tests.  */
+  sf_size = fread (sf_buf, 1, st.st_size, fp);
+  fclose (fp);
+  TEST ("frecnt-2: Read data", sf_size != 0);
+
+  dctx = sframe_decode (sf_buf, sf_size, &err);
+  TEST ("frecnt-2: Decode setup", dctx != NULL);
+
+  unsigned int fde_cnt = sframe_decoder_get_num_fidx (dctx);
+  TEST ("frecnt-2: Decode FDE count", fde_cnt == 2);
+
+  for (i = 0; i < fde_cnt; ++i)
+    {
+      err = sframe_decoder_get_funcdesc (dctx, i, &nfres, &fsize, &fstart,
+					 &finfo);
+      TEST ("frecnt-2: Decode get FDE", err == 0);
+      TEST ("frecnt-2: Decode get FRE", nfres == 4);
+    }
+
+  sframe_decoder_free (&dctx);
+  return 0;
+
+setup_fail:
+  sframe_decoder_free (&dctx);
+  fail ("frecnt-2: Test setup");
+  return 1;
+}
diff --git a/libsframe/testsuite/libsframe.decode/local.mk b/libsframe/testsuite/libsframe.decode/local.mk
new file mode 100644
index 0000000..0e4279b
--- /dev/null
+++ b/libsframe/testsuite/libsframe.decode/local.mk
@@ -0,0 +1,16 @@
+check_PROGRAMS =
+if HAVE_COMPAT_DEJAGNU
+  check_PROGRAMS += %D%/be-flipping %D%/frecnt-1 %D%/frecnt-2
+endif
+
+%C%_be_flipping_SOURCES = %D%/be-flipping.c
+%C%_be_flipping_LDADD = ${top_builddir}/libsframe.la
+%C%_be_flipping_CPPFLAGS = -I${top_srcdir}/../include -Wall
+
+%C%_frecnt_1_SOURCES = %D%/frecnt-1.c
+%C%_frecnt_1_LDADD = ${top_builddir}/libsframe.la
+%C%_frecnt_1_CPPFLAGS = -I${top_srcdir}/../include -Wall
+
+%C%_frecnt_2_SOURCES = %D%/frecnt-2.c
+%C%_frecnt_2_LDADD = ${top_builddir}/libsframe.la 
+%C%_frecnt_2_CPPFLAGS = -I${top_srcdir}/../include -Wall