1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*!A cross-platform build utility based on Lua
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright (C) 2015-present, Xmake Open Source Community.
*
* @author ruki
* @file format.c
*
*/
/* //////////////////////////////////////////////////////////////////////////////////////
* trace
*/
#define TB_TRACE_MODULE_NAME "format"
#define TB_TRACE_MODULE_DEBUG (0)
/* //////////////////////////////////////////////////////////////////////////////////////
* includes
*/
#include "prefix.h"
/* //////////////////////////////////////////////////////////////////////////////////////
* private implementation
*/
/* check PE by validating DOS header (MZ/ZM) and PE signature at e_lfanew
*
* note: unlike ELF/Mach-O/AR, PE needs an additional read/peek to locate the PE signature.
*/
static tb_bool_t xm_binutils_format_is_pe(tb_stream_ref_t istream, tb_byte_t* first8) {
tb_assert_and_check_return_val(istream && first8, tb_false);
tb_bool_t ok = tb_false;
do {
// fast reject: DOS magic
tb_check_break((first8[0] == 'M' && first8[1] == 'Z') || (first8[0] == 'Z' && first8[1] == 'M'));
// ensure we can read enough for DOS stub + PE signature
tb_hong_t size = tb_stream_size(istream);
if (size > 0 && size < XM_BINUTILS_PE_DOS_STUB_MIN_SIZE + 4) {
break;
}
// peek a bounded prefix to locate e_lfanew and PE\\0\\0 signature
tb_size_t max_peek = 4096;
if (size > 0) {
max_peek = (tb_size_t)tb_min((tb_hize_t)max_peek, (tb_hize_t)size);
}
tb_byte_t* p = tb_null;
if (!tb_stream_peek(istream, &p, max_peek)) {
break;
}
// e_lfanew points to PE signature offset
tb_uint32_t e_lfanew = tb_bits_get_u32_le(p + XM_BINUTILS_PE_DOS_ELFANEW_OFFSET);
tb_check_break(e_lfanew >= XM_BINUTILS_PE_DOS_STUB_MIN_SIZE);
tb_check_break((tb_size_t)e_lfanew + 4 <= max_peek);
tb_check_break(size <= 0 || (tb_hize_t)e_lfanew + 4 <= (tb_hize_t)size);
tb_byte_t const* signature = p + (tb_size_t)e_lfanew;
ok = (signature[0] == 'P' && signature[1] == 'E' && signature[2] == 0 && signature[3] == 0);
} while (0);
return ok;
}
// quick header checks from the first 8 bytes
static __tb_inline__ tb_bool_t xm_binutils_format_is_ar(tb_byte_t const* first8) {
return first8[0] == '!' && first8[1] == '<' && first8[2] == 'a' &&
first8[3] == 'r' && first8[4] == 'c' && first8[5] == 'h' &&
(first8[6] == '>' || first8[6] == '\n') &&
(first8[7] == '\n' || first8[7] == '\r');
}
static __tb_inline__ tb_bool_t xm_binutils_format_is_shebang(tb_byte_t const* first2) {
return first2[0] == '#' && first2[1] == '!';
}
static __tb_inline__ tb_bool_t xm_binutils_format_is_ape(tb_byte_t const* first8) {
return first8[0] == 'M' && first8[1] == 'Z' &&
first8[2] == 'q' && first8[3] == 'F' &&
first8[4] == 'p' && first8[5] == 'D';
}
static __tb_inline__ tb_bool_t xm_binutils_format_is_wasm(tb_byte_t const* first8) {
return first8[0] == 0x00 && first8[1] == 0x61 && first8[2] == 0x73 && first8[3] == 0x6d;
}
static __tb_inline__ tb_bool_t xm_binutils_format_is_elf(tb_byte_t const* first8) {
return first8[0] == 0x7f && first8[1] == 'E' && first8[2] == 'L' && first8[3] == 'F';
}
static __tb_inline__ tb_bool_t xm_binutils_format_is_macho(tb_byte_t const* first8) {
return (first8[0] == 0xfe && first8[1] == 0xed && first8[2] == 0xfa && (first8[3] == 0xce || first8[3] == 0xcf)) ||
(first8[0] == 0xce && first8[1] == 0xfa && first8[2] == 0xed && first8[3] == 0xfe) ||
(first8[0] == 0xcf && first8[1] == 0xfa && first8[2] == 0xed && first8[3] == 0xfe);
}
static __tb_inline__ tb_bool_t xm_binutils_format_is_coff(tb_byte_t const* first8) {
tb_uint16_t machine = tb_bits_get_u16_le(first8);
if (machine == 0x0000) {
tb_uint16_t machine2 = tb_bits_get_u16_le(first8 + 2);
if (machine2 == 0xffff) {
return tb_true;
}
}
return machine == XM_BINUTILS_COFF_MACHINE_I386 ||
machine == XM_BINUTILS_COFF_MACHINE_AMD64 ||
machine == XM_BINUTILS_COFF_MACHINE_ARM ||
machine == XM_BINUTILS_COFF_MACHINE_ARM64;
}
/* //////////////////////////////////////////////////////////////////////////////////////
* implementation
*/
/* detect object file format from stream
*
* @param istream the input stream
* @return XM_BINUTILS_FORMAT_COFF, XM_BINUTILS_FORMAT_ELF, XM_BINUTILS_FORMAT_MACHO,
* XM_BINUTILS_FORMAT_AR, XM_BINUTILS_FORMAT_PE, XM_BINUTILS_FORMAT_UNKNOWN, or -1 on error
*/
tb_int_t xm_binutils_format_detect(tb_stream_ref_t istream) {
tb_assert_and_check_return_val(istream, -1);
tb_assert_and_check_return_val(tb_stream_offset(istream) == 0, -1);
tb_int_t format = -1;
do {
tb_byte_t* p2 = tb_null;
if (!tb_stream_peek(istream, &p2, 2)) {
tb_hong_t size = tb_stream_size(istream);
if (size > 0 && size < 2) {
format = XM_BINUTILS_FORMAT_UNKNOWN;
}
break;
}
if (xm_binutils_format_is_shebang(p2)) {
format = XM_BINUTILS_FORMAT_SHEBANG;
break;
}
tb_byte_t* p = tb_null;
if (!tb_stream_peek(istream, &p, 8)) {
tb_hong_t size = tb_stream_size(istream);
if (size > 0 && size < 8) {
format = XM_BINUTILS_FORMAT_UNKNOWN;
}
break;
}
if (xm_binutils_format_is_ar(p)) {
format = XM_BINUTILS_FORMAT_AR;
break;
}
if (xm_binutils_format_is_ape(p)) {
format = XM_BINUTILS_FORMAT_APE;
break;
}
if (xm_binutils_format_is_wasm(p)) {
format = XM_BINUTILS_FORMAT_WASM;
break;
}
if (xm_binutils_format_is_elf(p)) {
format = XM_BINUTILS_FORMAT_ELF;
break;
}
if (xm_binutils_format_is_macho(p)) {
format = XM_BINUTILS_FORMAT_MACHO;
break;
}
if (xm_binutils_format_is_pe(istream, p)) {
format = XM_BINUTILS_FORMAT_PE;
break;
}
if (xm_binutils_format_is_coff(p)) {
format = XM_BINUTILS_FORMAT_COFF;
break;
}
format = XM_BINUTILS_FORMAT_UNKNOWN;
} while (0);
return format;
}
/* //////////////////////////////////////////////////////////////////////////////////////
* lua implementation
*/
/* get binary file format (auto-detect format)
*
* local format, errors = binutils.format(filepath)
*/
tb_int_t xm_binutils_format(lua_State *lua) {
tb_assert_and_check_return_val(lua, 0);
// get the binary file path
tb_char_t const *binaryfile = luaL_checkstring(lua, 1);
tb_check_return_val(binaryfile, 0);
// open file
tb_stream_ref_t istream = tb_stream_init_from_file(binaryfile, TB_FILE_MODE_RO);
if (!istream) {
lua_pushnil(lua);
lua_pushfstring(lua, "open %s failed", binaryfile);
return 2;
}
tb_bool_t ok = tb_false;
do {
if (!tb_stream_open(istream)) {
lua_pushnil(lua);
lua_pushfstring(lua, "open %s failed", binaryfile);
break;
}
tb_int_t format = xm_binutils_format_detect(istream);
if (format < 0) {
lua_pushnil(lua);
lua_pushliteral(lua, "cannot detect file format");
break;
}
switch (format) {
case XM_BINUTILS_FORMAT_COFF: lua_pushliteral(lua, "coff"); break;
case XM_BINUTILS_FORMAT_ELF: lua_pushliteral(lua, "elf"); break;
case XM_BINUTILS_FORMAT_MACHO: lua_pushliteral(lua, "macho"); break;
case XM_BINUTILS_FORMAT_AR: lua_pushliteral(lua, "ar"); break;
case XM_BINUTILS_FORMAT_PE: lua_pushliteral(lua, "pe"); break;
case XM_BINUTILS_FORMAT_SHEBANG: lua_pushliteral(lua, "shebang"); break;
case XM_BINUTILS_FORMAT_APE: lua_pushliteral(lua, "ape"); break;
case XM_BINUTILS_FORMAT_WASM: lua_pushliteral(lua, "wasm"); break;
default: lua_pushliteral(lua, "unknown"); break;
}
ok = tb_true;
} while (0);
if (istream) {
tb_stream_exit(istream);
}
return ok ? 1 : 2;
}
|
