luac_common.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
// SPDX-FileCopyrightText: 2021 Heersin <teablearcher@gmail.com>
 
// put common definition of luac
 
#ifndef BUILD_LUAC_COMMON_H
#define BUILD_LUAC_COMMON_H
 
#include <rz_bin.h>
#include <rz_lib.h>
#include <rz_list.h>
 
typedef ut32 LUA_INSTRUCTION;
 
/* Macros About Luac Format */
#define LUAC_MAGIC_OFFSET   0x00
#define LUAC_MAGIC_SIZE     4
#define LUAC_VERSION_OFFSET 0x04
#define LUAC_VERSION_SIZE   1
 
#define LUAC_MAGIC "\x1b\x4c\x75\x61"
 
/* Lua Constant Tag */
#define makevariant(t, v) ((t) | ((v) << 4))
 
#define LUA_TNIL     0
#define LUA_TBOOLEAN 1
#define LUA_TNUMBER  3
#define LUA_TSTRING  4
 
#define LUA_VNIL    makevariant(LUA_TNIL, 0)
#define LUA_VFALSE  makevariant(LUA_TBOOLEAN, 0)
#define LUA_VTRUE   makevariant(LUA_TBOOLEAN, 1)
#define LUA_VNUMINT makevariant(LUA_TNUMBER, 0) /* integer numbers */
#define LUA_VNUMFLT makevariant(LUA_TNUMBER, 1) /* float numbers */
#define LUA_VSHRSTR makevariant(LUA_TSTRING, 0) /* short strings */
#define LUA_VLNGSTR makevariant(LUA_TSTRING, 1) /* long strings */
 
typedef struct lua_proto_ex {
    ut64 offset; 
    ut64 size; 
 
    ut8 *proto_name; 
    int name_size; 
 
    ut64 line_defined; 
    ut64 lastline_defined; 
 
    ut8 num_params; 
    ut8 is_vararg; 
    ut8 max_stack_size; 
 
    /* Code of this proto */
    ut64 code_offset; 
    ut64 code_size; 
    ut64 code_skipped; 
 
    /* store constant entries */
    RzList *const_entries; 
    ut64 const_offset; 
    ut64 const_size; 
 
    /* store upvalue entries */
    RzList *upvalue_entries; 
    ut64 upvalue_offset; 
    ut64 upvalue_size; 
 
    /* store protos defined in this proto */
    RzList *proto_entries; 
    ut64 inner_proto_offset; 
    ut64 inner_proto_size; 
 
    /* store Debug info */
    ut64 debug_offset; 
    ut64 debug_size; 
    RzList *line_info_entries; 
    RzList *abs_line_info_entries; 
    RzList *local_var_info_entries; 
    RzList *dbg_upvalue_entries; 
 
} LuaProtoHeavy;
 
typedef LuaProtoHeavy LuaProto;
 
typedef struct lua_constant_entry {
    ut8 tag; 
    void *data; 
    int data_len; 
    ut64 offset; 
} LuaConstEntry;
 
typedef struct lua_upvalue_entry {
    /* attributes of upvalue */
    ut8 instack; 
    ut8 idx; 
    ut8 kind; 
    ut64 offset; 
} LuaUpvalueEntry;
 
typedef struct LuaProto LuaProtoEntry;
 
typedef struct lua_lineinfo_entry {
    ut32 info_data;
    ut64 offset;
} LuaLineinfoEntry;
 
typedef struct lua_abs_lineinfo_entry {
    int pc; 
    int line; 
    ut64 offset;
} LuaAbsLineinfoEntry;
 
typedef struct lua_local_var_entry {
    ut8 *varname; 
    int varname_len; 
    int start_pc; 
    int end_pc; 
    ut64 offset; 
} LuaLocalVarEntry;
 
typedef struct lua_dbg_upvalue_entry {
    ut8 *upvalue_name; 
    int name_len; 
    ut64 offset;
} LuaDbgUpvalueEntry;
 
typedef struct luac_bin_info {
    st32 major; 
    st32 minor; 
    RzList *section_list; 
    RzList *symbol_list; 
    RzList *entry_list; 
    RzList *string_list; 
    RzBinInfo *general_info; 
} LuacBinInfo;
 
/* ========================================================
 * Common Operation to Lua structures
 * Implemented in 'bin/format/luac/luac_common.c'
 * ======================================================== */
LuaDbgUpvalueEntry *lua_new_dbg_upvalue_entry();
LuaLocalVarEntry *lua_new_local_var_entry();
LuaAbsLineinfoEntry *lua_new_abs_lineinfo_entry();
LuaLineinfoEntry *lua_new_lineinfo_entry();
LuaUpvalueEntry *lua_new_upvalue_entry();
LuaConstEntry *lua_new_const_entry();
LuaProto *lua_new_proto_entry();
 
void lua_free_dbg_upvalue_entry(LuaDbgUpvalueEntry *);
void lua_free_local_var_entry(LuaLocalVarEntry *);
void lua_free_const_entry(LuaConstEntry *);
void lua_free_proto_entry(LuaProto *);
 
/* ========================================================
 * Common Operation to RzBinInfo
 * Implemented in 'bin/format/luac/luac_bin.c'
 * ======================================================== */
void luac_add_section(RzList *section_list, char *name, ut64 offset, ut32 size, bool is_func);
void luac_add_symbol(RzList *symbol_list, char *name, ut64 offset, ut64 size, const char *type);
void luac_add_entry(RzList *entry_list, ut64 offset, int entry_type);
void luac_add_string(RzList *string_list, char *string, ut64 offset, ut64 size);
 
LuacBinInfo *luac_build_info(LuaProto *proto);
void _luac_build_info(LuaProto *proto, LuacBinInfo *info);
 
/* ========================================================
 * Export version specified Api to bin_luac.c
 * Implemented in 'bin/format/luac/v[version]/bin_[version]
 * ======================================================== */
RzBinInfo *lua_parse_header_54(RzBinFile *bf, st32 major, st32 minor);
LuaProto *lua_parse_body_54(RzBuffer *buffer, ut64 offset, ut64 data_size);
 
RzBinInfo *lua_parse_header_53(RzBinFile *bf, st32 major, st32 minor);
LuaProto *lua_parse_body_53(RzBuffer *buffer, ut64 offset, ut64 data_size);
 
#define lua_check_error_offset(offset) \
    if ((offset) == 0) { \
        return 0; \
    }
#define lua_check_error_offset_proto(offset, proto) \
    if ((offset) == 0) { \
        lua_free_proto_entry((proto)); \
        return NULL; \
    }
#define lua_return_if_null(proto) \
    if ((proto) == NULL) { \
        return 0; \
    }
 
#endif // BUILD_LUAC_COMMON_H