mruby 3.3.0
mruby is the lightweight implementation of the Ruby language
Loading...
Searching...
No Matches
dump.h
Go to the documentation of this file.
1
7#ifndef MRUBY_DUMP_H
8#define MRUBY_DUMP_H
9
10#include <mruby.h>
11#include <mruby/irep.h>
12#include "common.h"
13
18
19/* flags for mrb_dump_irep{,_binary,_cfunc,_cstruct} */
20#define MRB_DUMP_DEBUG_INFO 1
21#define MRB_DUMP_STATIC 2
22#define DUMP_DEBUG_INFO MRB_DUMP_DEBUG_INFO /* deprecated */
23
24#ifndef MRB_NO_STDIO
25MRB_API mrb_value mrb_load_irep_file(mrb_state*,FILE*);
26MRB_API mrb_value mrb_load_irep_file_cxt(mrb_state*, FILE*, mrb_ccontext*);
27mrb_irep *mrb_read_irep_file(mrb_state*, FILE*);
28int mrb_dump_irep_binary(mrb_state*, const mrb_irep*, uint8_t, FILE*);
29#endif
30/* avoid mrb_read_irep(); use mrb_read_irep_buf() instead (may cause buffer overflow) */
31MRB_API mrb_irep *mrb_read_irep(mrb_state*, const uint8_t*);
32MRB_API mrb_irep *mrb_read_irep_buf(mrb_state*, const void*, size_t);
33
34/* dump/load error code
35 *
36 * NOTE: MRB_DUMP_GENERAL_FAILURE is caused by
37 * unspecified issues like malloc failed.
38 */
39#define MRB_DUMP_OK 0
40#define MRB_DUMP_GENERAL_FAILURE (-1)
41#define MRB_DUMP_WRITE_FAULT (-2)
42#define MRB_DUMP_READ_FAULT (-3)
43#define MRB_DUMP_INVALID_FILE_HEADER (-4)
44#define MRB_DUMP_INVALID_IREP (-5)
45#define MRB_DUMP_INVALID_ARGUMENT (-6)
46
47/* null symbol length */
48#define MRB_DUMP_NULL_SYM_LEN 0xFFFF
49
50/* Rite Binary File header */
51#define RITE_BINARY_IDENT "RITE"
52/* Binary Format Version Major:Minor */
53/* Major: Incompatible to prior versions */
54/* Minor: Upper-compatible to prior versions */
55#define RITE_BINARY_MAJOR_VER "03"
56#define RITE_BINARY_MINOR_VER "00"
57#define RITE_BINARY_FORMAT_VER RITE_BINARY_MAJOR_VER RITE_BINARY_MINOR_VER
58#define RITE_COMPILER_NAME "MATZ"
59#define RITE_COMPILER_VERSION "0000"
60
61#define RITE_VM_VER "0300"
62
63#define RITE_BINARY_EOF "END\0"
64#define RITE_SECTION_IREP_IDENT "IREP"
65#define RITE_SECTION_DEBUG_IDENT "DBG\0"
66#define RITE_SECTION_LV_IDENT "LVAR"
67
68#define MRB_DUMP_DEFAULT_STR_LEN 128
69#define MRB_DUMP_ALIGNMENT sizeof(uint32_t)
70
71/* binary header */
73 uint8_t binary_ident[4]; /* Binary Identifier */
74 uint8_t major_version[2]; /* Binary Format Major Version */
75 uint8_t minor_version[2]; /* Binary Format Minor Version */
76 uint8_t binary_size[4]; /* Binary Size */
77 uint8_t compiler_name[4]; /* Compiler name */
78 uint8_t compiler_version[4];
79};
80
81/* section header */
82#define RITE_SECTION_HEADER \
83 uint8_t section_ident[4]; \
84 uint8_t section_size[4]
85
87 RITE_SECTION_HEADER;
88};
89
91 RITE_SECTION_HEADER;
92
93 uint8_t rite_version[4]; /* Rite Instruction Specification Version */
94};
95
97 RITE_SECTION_HEADER;
98};
99
101 RITE_SECTION_HEADER;
102};
103
104#define RITE_LV_NULL_MARK UINT16_MAX
105
107 RITE_SECTION_HEADER;
108};
109
110static inline size_t
111uint8_to_bin(uint8_t s, uint8_t *bin)
112{
113 *bin = s;
114 return sizeof(uint8_t);
115}
116
117static inline size_t
118uint16_to_bin(uint16_t s, uint8_t *bin)
119{
120 *bin++ = (s >> 8) & 0xff;
121 *bin = s & 0xff;
122 return sizeof(uint16_t);
123}
124
125static inline size_t
126uint32_to_bin(uint32_t l, uint8_t *bin)
127{
128 *bin++ = (l >> 24) & 0xff;
129 *bin++ = (l >> 16) & 0xff;
130 *bin++ = (l >> 8) & 0xff;
131 *bin = l & 0xff;
132 return sizeof(uint32_t);
133}
134
135static inline uint32_t
136bin_to_uint32(const uint8_t *bin)
137{
138 return (uint32_t)bin[0] << 24 |
139 (uint32_t)bin[1] << 16 |
140 (uint32_t)bin[2] << 8 |
141 (uint32_t)bin[3];
142}
143
144static inline uint16_t
145bin_to_uint16(const uint8_t *bin)
146{
147 return (uint16_t)bin[0] << 8 |
148 (uint16_t)bin[1];
149}
150
151static inline uint8_t
152bin_to_uint8(const uint8_t *bin)
153{
154 return (uint8_t)bin[0];
155}
156
158
159#endif /* MRUBY_DUMP_H */
mruby common platform definition"
#define MRB_END_DECL
End declarations in C mode.
Definition common.h:28
#define MRB_BEGIN_DECL
Start declarations in C mode.
Definition common.h:26
#define MRB_API
Declare a public mruby API function.
Definition common.h:79
mrb_irep structure
Definition compile.h:21
Definition irep.h:55
Definition mruby.h:256
Definition boxing_nan.h:40
Definition dump.h:72
Definition dump.h:96
Definition dump.h:86
Definition dump.h:90
Definition dump.h:100