raddebugger/src/dwarf/dwarf_writer.h

// Copyright (c) Epic Games Tools
// Licensed under the MIT license (https://opensource.org/license/mit/)

#ifndef DWARF_WRITER_H
#define DWARF_WRITER_H

////////////////////////////////

typedef enum
{
  DW_IntEnc_Null,
  DW_IntEnc_1Byte,
  DW_IntEnc_2Byte,
  DW_IntEnc_4Byte,
  DW_IntEnc_LEB128,
} DW_IntEnc;

////////////////////////////////

typedef enum
{
  DW_WriterFormKind_Null,
  DW_WriterFormKind_Flag,
  DW_WriterFormKind_SInt,
  DW_WriterFormKind_UInt,
  DW_WriterFormKind_Address,
  DW_WriterFormKind_Ref,
  DW_WriterFormKind_LinePtr,
  DW_WriterFormKind_MacPtr,
  DW_WriterFormKind_RngListPtr,
  DW_WriterFormKind_Data,
  DW_WriterFormKind_Block,
  DW_WriterFormKind_String,
  DW_WriterFormKind_ExprLoc,
  DW_WriterFormKind_Implicit,
} DW_WriterFormKind;

typedef struct DW_WriterForm
{
  DW_WriterFormKind kind;
  union {
    B8      flag;
    S64     sint;
    U64     uint;
    U64     address;
    S64     implicit;
    union {
      struct {
        struct DW_WriterTag *ref;
        void                *line_ptr;
        void                *mac_ptr;
        void                *rng_list_ptr;
      };
      struct {
        U64 ref_offset;
        U64 line_offset;
        U64 mac_ptr_offset;
        U64 rng_list_offset;
      };
    };
    String8 data;
    String8 block;
    String8 string;
    String8 exprloc;
  };
} DW_WriterForm;

typedef struct DW_WriterAttrib
{
  DW_AttribKindEnum kind;
  struct {
    DW_WriterForm form;
  } writer;
  struct {
    DW_Form form;
  } reader;
  struct DW_WriterAttrib *next;
} DW_WriterAttrib;

typedef struct DW_WriterTag
{
  DW_TagKindEnum       kind;
  struct DW_WriterTag *next;
  struct DW_WriterTag *parent;
  struct DW_WriterTag *first_child;
  struct DW_WriterTag *last_child;
  U64                  attrib_count;
  U64                  abbrev_id;
  U64                  info_off;
  DW_WriterAttrib     *first_attrib;
  DW_WriterAttrib     *last_attrib;
} DW_WriterTag;

typedef struct DW_WriterTagChunk
{
  U64                       count;
  U64                       max;
  DW_WriterTag             *v;
  struct DW_WriterTagChunk *next;
} DW_WriterTagChunk;

typedef struct DW_WriterTagChunkList
{
  U64 chunk_count;
  U64 total_count;
  DW_WriterTagChunk *first;
  DW_WriterTagChunk *last;
} DW_WriterTagChunkList;

typedef struct DW_WriterAttribChunk
{
  U64 count;
  U64 max;
  DW_WriterAttrib *v;
  struct DW_WriterAttribChunk *next;
} DW_WriterAttribChunk;

typedef struct DW_WriterAttribChunkList
{
  U64 chunk_count;
  U64 total_count;
  DW_WriterAttribChunk *first;
  DW_WriterAttribChunk *last;
} DW_WriterAttribChunkList;

typedef struct DW_WriterFixup
{
  struct DW_WriterAttrib *attrib;
  U8                     *value;
} DW_WriterFixup;

typedef struct DW_WriterFixupNode
{
  DW_WriterFixup             v;
  struct DW_WriterFixupNode *next;
} DW_WriterFixupNode;

typedef struct DW_WriterFixupList
{
  U64                 count;
  DW_WriterFixupNode *first;
  DW_WriterFixupNode *last;
} DW_WriterFixupList;

typedef struct DW_WriterSection
{
  void       *length;
  String8List srl;
} DW_WriterSection;

typedef struct DW_Writer
{
  Arena                   *arena;
  DW_WriterTag            *root;
  DW_WriterTag            *current;
  Arch                     arch;
  DW_Format                format;
  DW_Version               version;
  DW_CompUnitKind          cu_kind;
  U64                      address_size;
  U64                      abbrev_base_info_off;
  DW_WriterFixupList       fixups;
  HashTable               *abbrev_id_map;
  DW_WriterSection         sections[DW_Section_Count];
  DW_WriterAttribChunkList attrib_chunk_list;
  DW_WriterTagChunkList    tag_chunk_list;
} DW_Writer;

////////////////////////////////

internal DW_IntEnc dw_int_enc_from_sint(S64 v);
internal DW_IntEnc dw_int_enc_from_uint(U64 v);

internal U64 dw_size_from_sint(S64 v);
internal U64 dw_size_from_uint(U64 v);

internal void dw_serial_push_form(Arena *arena, String8List *srl, DW_Format format, DW_Version version, U8 address_size, DW_FormKind form_kind, DW_Form form);

////////////////////////////////

internal DW_Writer * dw_writer_begin(DW_Format format, DW_Version version, DW_CompUnitKind cu_kind, Arch arch);
internal void        dw_writer_end(DW_Writer **writer_ptr);

internal DW_WriterTag * dw_writer_tag_begin(DW_Writer *writer, DW_TagKind kind);
internal void           dw_writer_tag_end(DW_Writer *writer);

internal DW_WriterAttrib * dw_writer_push_attrib             (DW_Writer *writer, DW_AttribKind kind, DW_WriterForm form        );
internal DW_WriterAttrib * dw_writer_push_attrib_address     (DW_Writer *writer, DW_AttribKind kind, U64           address     );
internal DW_WriterAttrib * dw_writer_push_attrib_block       (DW_Writer *writer, DW_AttribKind kind, String8       block       );
internal DW_WriterAttrib * dw_writer_push_attrib_data        (DW_Writer *writer, DW_AttribKind kind, String8       data        );
internal DW_WriterAttrib * dw_writer_push_attrib_string      (DW_Writer *writer, DW_AttribKind kind, String8       string      );
internal DW_WriterAttrib * dw_writer_push_attrib_flag        (DW_Writer *writer, DW_AttribKind kind, B8            flag        );
internal DW_WriterAttrib * dw_writer_push_attrib_sint        (DW_Writer *writer, DW_AttribKind kind, S64           sint        );
internal DW_WriterAttrib * dw_writer_push_attrib_uint        (DW_Writer *writer, DW_AttribKind kind, U64           uint        );
internal DW_WriterAttrib * dw_writer_push_attrib_enum        (DW_Writer *writer, DW_AttribKind kind, S64           e           );
internal DW_WriterAttrib * dw_writer_push_attrib_ref         (DW_Writer *writer, DW_AttribKind kind, DW_WriterTag *ref         );
internal DW_WriterAttrib * dw_writer_push_attrib_exprloc     (DW_Writer *writer, DW_AttribKind kind, String8       exprloc     );
internal DW_WriterAttrib * dw_writer_push_attrib_line_ptr    (DW_Writer *writer, DW_AttribKind kind, void *        line_ptr    );
internal DW_WriterAttrib * dw_writer_push_attrib_mac_ptr     (DW_Writer *writer, DW_AttribKind kind, void *        mac_ptr     );
internal DW_WriterAttrib * dw_writer_push_attrib_rng_list_ptr(DW_Writer *writer, DW_AttribKind kind, void *        rng_list_ptr);
internal DW_WriterAttrib * dw_writer_push_attrib_implicit    (DW_Writer *writer, DW_AttribKind kind, S64           implicit    );

internal void dw_writer_emit(DW_Writer *writer);
#ifdef OBJ_H
internal void dw_writer_emit_to_obj(DW_Writer *writer, OBJ *obj);
#endif

#endif // DWARF_WRITER_H