Files
binutils-gdb/libsframe/sframe-impl.h
Indu Bhagat 3ae28d0776 libsframe: use sf_fde_tbl data structure internally for the decoder
Instead of the current sframe_func_desc_entry (on-disk format
representation) data structure.

The decoder context in libsframe, so far, has been internally directly
tied to the sframe_func_desc_entry (on-disk format representation) data
structure.  While this allows libsframe to avoid some operations, this
is not desirable anymore as the format evolves: we will need to support
reading in of older version(s) of SFrame FDE, as well as a newer on-disk
representations for SFrame FDE.

Use sf_fde_tbl internally in the decoder context.  Note that libsframe
already does _not_ use sframe_func_desc_entry in any external-facing,
user-visible APIs.

Note that this commit is simply preparatory in nature.  At the moment,
the 'sf_fde_tbl' internally uses the sframe_func_desc_entry (on-disk
format representation).  When need arises (as SFrame FDE evolves), we
may change sf_fde_tbl to use an alternative (but still libsframe
internal) definition of SFrame FDE.

lisbframe/
        * sframe-impl.h (sf_fde_tbl, sf_fre_tbl): Move definition before use.
	Use sf_fde_tbl instead of sframe_func_desc_entry in struct
        sframe_decoder_ctx.
        * sframe.c (sframe_fde_tbl_alloc): New internal definition.
        (sframe_fde_tbl_init): Likewise.
        (sframe_decoder_get_funcdesc_at_index): Adjust for sf_fde_tbl
	usage.
        (sframe_decoder_get_secrel_func_start_addr): Likewise.
        (sframe_fre_check_range_p): Likewise.
        (sframe_decode): Likewise.
        (sframe_get_funcdesc_with_addr_internal): Likewise.
2025-11-01 01:47:29 -07:00

72 lines
1.9 KiB
C

/* Implementation header.
Copyright (C) 2022-2025 Free Software Foundation, Inc.
This file is part of libsframe.
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/>. */
#ifndef _SFRAME_IMPL_H
#define _SFRAME_IMPL_H
#include "sframe-api.h"
#ifdef __cplusplus
extern "C"
{
#endif
#include <assert.h>
#define sframe_assert(expr) (assert (expr))
typedef struct sf_fde_tbl sf_fde_tbl;
typedef struct sf_fre_tbl sf_fre_tbl;
struct sframe_decoder_ctx
{
/* SFrame header. */
sframe_header sfd_header;
/* SFrame function desc entries table. */
sf_fde_tbl *sfd_funcdesc;
/* SFrame FRE table. */
char *sfd_fres;
/* Number of bytes needed for SFrame FREs. */
int sfd_fre_nbytes;
/* Reference to the internally malloc'd buffer, if any, for endian flipping
the original input buffer before decoding. */
void *sfd_buf;
};
struct sframe_encoder_ctx
{
/* SFrame header. */
sframe_header sfe_header;
/* SFrame function desc entries table. */
sf_fde_tbl *sfe_funcdesc;
/* SFrame FRE table. */
sf_fre_tbl *sfe_fres;
/* Number of bytes needed for SFrame FREs. */
uint32_t sfe_fre_nbytes;
/* SFrame output data buffer. */
char *sfe_data;
/* Size of the SFrame output data buffer. */
size_t sfe_data_size;
};
#ifdef __cplusplus
}
#endif
#endif /* _SFRAME_IMPL_H */