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.
This commit is contained in:
Weimin Pan
2022-11-15 15:06:59 -08:00
committed by Indu Bhagat
parent dc56ee029e
commit 19e559f1c9
30 changed files with 21577 additions and 7 deletions

View File

@ -0,0 +1,177 @@
/* encode-1.c -- Test for encoder 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 <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, 0x3, {0x8, 0, 0}},
{0x1, 0x5, {0x10, 0xf0, 0}},
{0x4, 0x4, {0x10, 0xf0, 0}},
{0x1a, 0x5, {0x8, 0xf0, 0}}
};
unsigned char finfo = sframe_fde_func_info (SFRAME_FRE_TYPE_ADDR1,
SFRAME_FDE_TYPE_PCINC);
err = sframe_encoder_add_funcdesc (encode, 0xfffff03e, 0x1b, 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, 0x3, {0x8, 0, 0}},
{0x1, 0x5, {0x10, 0xf0, 0}},
{0x4, 0x4, {0x10, 0xf0, 0}},
{0xf, 0x5, {0x8, 0xf0, 0}}
};
unsigned char finfo = sframe_fde_func_info (SFRAME_FRE_TYPE_ADDR1,
SFRAME_FDE_TYPE_PCINC);
err = sframe_encoder_add_funcdesc (encode, 0xfffff059, 0x10, 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;
}
/*
* SFrame info from the following source (2 fdes, 4 fres in each fde):
* static int cnt;
* int foo() { return ++cnt; }
* int main() { return foo(); }
*/
#define DATA "DATA2"
static int
data_match (char *sframe_buf, size_t sz)
{
FILE *fp;
struct stat st;
char *sf_buf;
size_t sf_size;
int diffs;
fp = fopen (DATA, "r");
if (fp == NULL)
return 0;
if (fstat (fileno (fp), &st) < 0)
{
perror ("fstat");
fclose (fp);
return 0;
}
sf_buf = malloc (st.st_size);
if (sf_buf == NULL)
{
perror ("malloc");
return 0;
}
sf_size = fread (sf_buf, 1, st.st_size, fp);
fclose (fp);
if (sf_size == 0 || sf_buf == NULL)
{
fprintf (stderr, "Encode: Read section failed\n");
return 0;
}
if (sf_size != sz)
return 0;
diffs = memcmp (sf_buf, sframe_buf, sz);
free (sf_buf);
return diffs == 0;
}
int main (void)
{
sframe_encoder_ctx *encode;
sframe_frame_row_entry frep;
char *sframe_buf;
size_t sf_size;
int err = 0;
unsigned int fde_cnt = 0;
int match_p = 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);
fde_cnt = sframe_encoder_get_num_fidx (encode);
TEST ("encode-1: Encoder FDE count", fde_cnt == 0);
err = sframe_encoder_add_fre (encode, 1, &frep);
TEST ("encode-1: Encoder update workflow", err == SFRAME_ERR);
err = add_fde1 (encode, 0);
TEST ("encode-1: Encoder adding FDE1", err == 0);
err = add_fde2 (encode, 1);
TEST ("encode-1: Encoder adding FDE2", err == 0);
fde_cnt = sframe_encoder_get_num_fidx (encode);
TEST ("encode-1: Encoder FDE count", fde_cnt == 2);
sframe_buf = sframe_encoder_write (encode, &sf_size, &err);
TEST ("encode-1: Encoder write", err == 0);
match_p = data_match (sframe_buf, sf_size);
TEST ("encode-1: Encode buffer match", match_p == 1);
sframe_encoder_free (&encode);
return 0;
}

View File

@ -0,0 +1,37 @@
# 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 encode-1
return 0;
}
catch "exec ln -s $srcdir/libsframe.decode/DATA2 ." status
if { [host_execute "testsuite/libsframe.encode/encode-1"] ne "" } {
fail "encode-1"
}
catch "exec rm DATA2" status

View File

@ -0,0 +1,7 @@
if HAVE_COMPAT_DEJAGNU
check_PROGRAMS += %D%/encode-1
endif
%C%_encode_1_SOURCES = %D%/encode-1.c
%C%_encode_1_LDADD = ${top_builddir}/libsframe.la
%C%_encode_1_CPPFLAGS = -I${top_srcdir}/../include -Wall