/**
 * @file sccf.h
 * @brief scc format (sccf) 头文件
 *
 * SCCF是一个极简的可执行可链接文件格式, 专注于内部链接处理,
 * 同时提供外部符号导入/导出的抽象接口。
 */

#ifndef __SCC_FORMAT_H__
#define __SCC_FORMAT_H__

#include <stdint.h>

#define sccf_byte_t uint8_t
#define sccf_enum_t uint32_t
#define sccf_size_t uint64_t
#define sccf_isize_t int64_t

/** SCCF魔数 */
#define SCCF_MAGIC "SCCFmt\0\0"

/** SCCF版本号 */
#define SCCF_VERSION 1

/** 架构类型 */
typedef enum {
    SCCF_ARCH_UNKNOWN = 0, ///< 未知占位符架构
    SCCF_ARCH_RISCV32 = 1, ///< RISC-V 32位 小端
    SCCF_ARCH_RISCV64 = 2, ///< RISC-V 64位 小端
    SCCF_ARCH_X86 = 3,     ///< x86 小端
    SCCF_ARCH_AMD64 = 4,   ///< AMD64 小端
} sccf_arch_t;

/** 文件标志位 */
typedef enum {
    SCCF_TYPE_FLAG_EXECUTABLE = 0x01,  ///< 可执行文件
    SCCF_TYPE_FLAG_RELOCATABLE = 0x02, ///< 可重定位文件
    SCCF_TYPE_FLAG_EXE_RELOC = 0x03,   ///< 内部链接后的可执行文件
} sccf_type_flags_t;

/** 符号类型 */
typedef enum {
    SCCF_SYM_TYPE_UNDEF = 0,  ///< 未定义
    SCCF_SYM_TYPE_FUNC = 1,   ///< 函数
    SCCF_SYM_TYPE_DATA = 2,   ///< 数据
    SCCF_SYM_TYPE_EXTERN = 3, ///< 外部符号
} sccf_sym_type_t;

/** 符号绑定类型 */
typedef enum {
    SCCF_SYM_BIND_LOCAL = 0,  ///< 局部符号
    SCCF_SYM_BIND_GLOBAL = 1, ///< 全局符号
    SCCF_SYM_BIND_WEAK = 2,   ///< 弱引用
} sccf_sym_bind_t;

/** 符号可见性 */
typedef enum {
    SCCF_SYM_VIS_DEFAULT = 0,   ///< 默认可见性
    SCCF_SYM_VIS_HIDDEN = 1,    ///< 隐藏
    SCCF_SYM_VIS_PROTECTED = 2, ///< 受保护
} sccf_sym_vis_t;

/** 段类型 */
typedef enum {
    SCCF_SECT_NONE = 0,        ///< 无
    SCCF_SECT_CODE = 1,        ///< 代码段
    SCCF_SECT_DATA = 2,        ///< 数据段
    SCCF_SECT_RODATA = 3,      ///< 只读数据段
    SCCF_SECT_UNINIT_DATA = 4, ///< BSS段(未初始化数据)
    SCCF_SECT_SYMTAB = 5,      ///< 符号表
    SCCF_SECT_STRTAB = 6,      ///< 字符串表
    SCCF_SECT_RELOCS = 7,      ///< 重定位表
} sccf_sect_type_t;

/** 重定位类型 */
typedef enum {
    SCCF_RELOC_TYPE_EMPTY = 0, ///< 空展位符
    SCCF_RELOC_TYPE_ABS = 1,   ///< 绝对地址
    SCCF_RELOC_TYPE_REL = 2,   ///< 相对地址
} sccf_reloc_type_t;

/**
 * @brief SCCF文件头
 */
typedef struct sccf_header {
    sccf_byte_t magic[8];        ///< 魔数: "SCCFmt\0\0"
    sccf_enum_t type;            ///< 类型
    sccf_enum_t version;         ///< 版本号
    sccf_enum_t arch;            ///< 架构
    sccf_size_t entry_point;     ///< 入口点在代码段的相对地址
    sccf_size_t sect_header_num; ///< 节头数量
    sccf_size_t reserved[4];     ///< 保留字段, 可置零
} sccf_header_t;

/**
 * @brief SCCF段
 */
typedef struct {
    sccf_byte_t name[8];        ///< 段名称 仅供展示 eg. emoji or ".text"
    sccf_enum_t sccf_sect_type; ///< 段类型 (内部实际区分的方式)
    sccf_size_t size;           ///< 段数据实际的大小
    sccf_size_t data_size;      ///< 段数据的有效数据大小
    sccf_size_t addralign;      ///< 内存对齐要求 (字节对齐, 如 1,2,4,8,...)
    sccf_size_t info;           ///< 段信息 (如条目数,链接索引等)
    sccf_size_t reserved[2];    ///< 保留
} sccf_sect_header_t;

/**
 * @brief SCCF符号表
 */
typedef struct {
    sccf_size_t name_offset;      ///< 符号名称在字符串表中的偏移量
    sccf_enum_t sccf_sym_type;    ///< 符号类型
    sccf_enum_t sccf_sym_bind;    ///< 符号绑定类型
    sccf_enum_t sccf_sym_vis;     ///< 符号可见性
    sccf_enum_t sccf_sect_type;   ///< 该符号的段类型
    sccf_size_t sccf_sect_offset; ///< 该符号在段中的偏移量
    sccf_size_t sccf_sym_size;    ///< 该符号选中的大小
} sccf_sym_t;

/**
 * @brief SCCF重定向条目
 */
typedef struct {
    sccf_enum_t reloc_type; ///< 重定位类型
    sccf_enum_t sect_type;  ///< 需要重定位的段类型(代码段/数据段)
    sccf_size_t sym_idx;    ///< 符号索引(重定向指向的符号)
    sccf_size_t offset;     ///< 在段中的偏移量(用于重定向的地址)
    sccf_isize_t addend;    ///< 加数(用于获取相对位置时PC的额外值)
} sccf_reloc_t;

/**
 * @brief sccf 格式结构(可选 填充到某种自定义的对齐
 * 默认启用sect_datas的64bytes对齐规则)
 *
 * @warning 其中sccf_sect_header_t的顺序必须和sccf_sect_data_t一致,
 * 但是不规定sect_headers内部的顺序下面顺序仅供参考
 *
 * sccf_header_t header;
 * sccf_sect_header_t sect_headers[header.sect_header_num] = {
 *     [0] = text_section,
 *     [1] = data_section,
 *     [2] = strtab_section,
 *     [3] = symtab_section,
 *     [4] = reloc_section,
 *     [5-...] = other_section,
 * };
 * sccf_sect_data_t sect_datas[header.sect_header_num][...] = {
 *     [0] = text_section_data,
 *     [1] = data_section_data,
 *     [2] = strtab_section_data,
 *     [3] = symtab_section_data,
 *     [4] = reloc_section_data,
 *     [5-...] = other_section_data,
 * };
 */

#endif /* __SCC_FORMAT_H__ */