Skip to content

Commit b534e1b

Browse files
dpgeorgedpgeorge
committed
py: Use variable length encoded uints in more places in bytecode.
Code-info size, block name, source name, n_state and n_exc_stack now use variable length encoded uints. This saves 7-9 bytes per bytecode function for most functions.
1 parent dda4646 commit b534e1b

File tree

8 files changed

+329
-244
lines changed

8 files changed

+329
-244
lines changed

‎py/bc.c‎

Lines changed: 239 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
/*
2+
* This file is part of the Micro Python project, http://micropython.org/
3+
*
4+
* The MIT License (MIT)
5+
*
6+
* Copyright (c) 2014 Damien P. George
7+
* Copyright (c) 2014 Paul Sokolovsky
8+
*
9+
* Permission is hereby granted, free of charge, to any person obtaining a copy
10+
* of this software and associated documentation files (the "Software"), to deal
11+
* in the Software without restriction, including without limitation the rights
12+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13+
* copies of the Software, and to permit persons to whom the Software is
14+
* furnished to do so, subject to the following conditions:
15+
*
16+
* The above copyright notice and this permission notice shall be included in
17+
* all copies or substantial portions of the Software.
18+
*
19+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
* THE SOFTWARE.
26+
*/
27+
28+
#include <stdbool.h>
29+
#include <string.h>
30+
#include <assert.h>
31+
32+
#include "mpconfig.h"
33+
#include "nlr.h"
34+
#include "misc.h"
35+
#include "qstr.h"
36+
#include "obj.h"
37+
#include "objtuple.h"
38+
#include "objfun.h"
39+
#include "runtime0.h"
40+
#include "runtime.h"
41+
#include "bc.h"
42+
#include "stackctrl.h"
43+
44+
#if 0 // print debugging info
45+
#define DEBUG_PRINT (1)
46+
#else // don't print debugging info
47+
#define DEBUG_printf(...) (void)0
48+
#endif
49+
50+
mp_uint_t mp_decode_uint(const byte **ptr) {
51+
mp_uint_t unum = 0;
52+
byte val;
53+
const byte *p = *ptr;
54+
do {
55+
val = *p++;
56+
unum = (unum << 7) | (val & 0x7f);
57+
} while ((val & 0x80) != 0);
58+
*ptr = p;
59+
return unum;
60+
}
61+
62+
STATIC NORETURN void fun_pos_args_mismatch(mp_obj_fun_bc_t *f, mp_uint_t expected, mp_uint_t given) {
63+
#if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE
64+
// Generic message, to be reused for other argument issues
65+
nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
66+
"argument num/types mismatch"));
67+
#elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_NORMAL
68+
nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
69+
"function takes %d positional arguments but %d were given", expected, given));
70+
#elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
71+
nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
72+
"%s() takes %d positional arguments but %d were given",
73+
mp_obj_fun_get_name(f), expected, given));
74+
#endif
75+
}
76+
77+
#if DEBUG_PRINT
78+
STATIC void dump_args(const mp_obj_t *a, int sz) {
79+
DEBUG_printf("%p: ", a);
80+
for (int i = 0; i < sz; i++) {
81+
DEBUG_printf("%p ", a[i]);
82+
}
83+
DEBUG_printf("\n");
84+
}
85+
#else
86+
#define dump_args(...) (void)0
87+
#endif
88+
89+
// code_state should have ->ip filled in (pointing past code info block),
90+
// as well as ->n_state.
91+
void mp_setup_code_state(mp_code_state *code_state, mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
92+
// This function is pretty complicated. It's main aim is to be efficient in speed and RAM
93+
// usage for the common case of positional only args.
94+
mp_obj_fun_bc_t *self = self_in;
95+
mp_uint_t n_state = code_state->n_state;
96+
const byte *ip = code_state->ip;
97+
98+
code_state->code_info = self->bytecode;
99+
code_state->sp = &code_state->state[0] - 1;
100+
code_state->exc_sp = (mp_exc_stack_t*)(code_state->state + n_state) - 1;
101+
102+
// zero out the local stack to begin with
103+
memset(code_state->state, 0, n_state * sizeof(*code_state->state));
104+
105+
const mp_obj_t *kwargs = args + n_args;
106+
107+
// var_pos_kw_args points to the stack where the var-args tuple, and var-kw dict, should go (if they are needed)
108+
mp_obj_t *var_pos_kw_args = &code_state->state[n_state - 1 - self->n_pos_args - self->n_kwonly_args];
109+
110+
// check positional arguments
111+
112+
if (n_args > self->n_pos_args) {
113+
// given more than enough arguments
114+
if (!self->takes_var_args) {
115+
fun_pos_args_mismatch(self, self->n_pos_args, n_args);
116+
}
117+
// put extra arguments in varargs tuple
118+
*var_pos_kw_args-- = mp_obj_new_tuple(n_args - self->n_pos_args, args + self->n_pos_args);
119+
n_args = self->n_pos_args;
120+
} else {
121+
if (self->takes_var_args) {
122+
DEBUG_printf("passing empty tuple as *args\n");
123+
*var_pos_kw_args-- = mp_const_empty_tuple;
124+
}
125+
// Apply processing and check below only if we don't have kwargs,
126+
// otherwise, kw handling code below has own extensive checks.
127+
if (n_kw == 0 && !self->has_def_kw_args) {
128+
if (n_args >= self->n_pos_args - self->n_def_args) {
129+
// given enough arguments, but may need to use some default arguments
130+
for (mp_uint_t i = n_args; i < self->n_pos_args; i++) {
131+
code_state->state[n_state - 1 - i] = self->extra_args[i - (self->n_pos_args - self->n_def_args)];
132+
}
133+
} else {
134+
fun_pos_args_mismatch(self, self->n_pos_args - self->n_def_args, n_args);
135+
}
136+
}
137+
}
138+
139+
// copy positional args into state
140+
for (mp_uint_t i = 0; i < n_args; i++) {
141+
code_state->state[n_state - 1 - i] = args[i];
142+
}
143+
144+
// check keyword arguments
145+
146+
if (n_kw != 0 || self->has_def_kw_args) {
147+
DEBUG_printf("Initial args: ");
148+
dump_args(code_state->state + n_state - self->n_pos_args - self->n_kwonly_args, self->n_pos_args + self->n_kwonly_args);
149+
150+
mp_obj_t dict = MP_OBJ_NULL;
151+
if (self->takes_kw_args) {
152+
dict = mp_obj_new_dict(n_kw); // TODO: better go conservative with 0?
153+
*var_pos_kw_args = dict;
154+
}
155+
156+
for (mp_uint_t i = 0; i < n_kw; i++) {
157+
qstr arg_name = MP_OBJ_QSTR_VALUE(kwargs[2 * i]);
158+
for (mp_uint_t j = 0; j < self->n_pos_args + self->n_kwonly_args; j++) {
159+
if (arg_name == self->args[j]) {
160+
if (code_state->state[n_state - 1 - j] != MP_OBJ_NULL) {
161+
nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
162+
"function got multiple values for argument '%s'", qstr_str(arg_name)));
163+
}
164+
code_state->state[n_state - 1 - j] = kwargs[2 * i + 1];
165+
goto continue2;
166+
}
167+
}
168+
// Didn't find name match with positional args
169+
if (!self->takes_kw_args) {
170+
nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "function does not take keyword arguments"));
171+
}
172+
mp_obj_dict_store(dict, kwargs[2 * i], kwargs[2 * i + 1]);
173+
continue2:;
174+
}
175+
176+
DEBUG_printf("Args with kws flattened: ");
177+
dump_args(code_state->state + n_state - self->n_pos_args - self->n_kwonly_args, self->n_pos_args + self->n_kwonly_args);
178+
179+
// fill in defaults for positional args
180+
mp_obj_t *d = &code_state->state[n_state - self->n_pos_args];
181+
mp_obj_t *s = &self->extra_args[self->n_def_args - 1];
182+
for (int i = self->n_def_args; i > 0; i--, d++, s--) {
183+
if (*d == MP_OBJ_NULL) {
184+
*d = *s;
185+
}
186+
}
187+
188+
DEBUG_printf("Args after filling default positional: ");
189+
dump_args(code_state->state + n_state - self->n_pos_args - self->n_kwonly_args, self->n_pos_args + self->n_kwonly_args);
190+
191+
// Check that all mandatory positional args are specified
192+
while (d < &code_state->state[n_state]) {
193+
if (*d++ == MP_OBJ_NULL) {
194+
nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
195+
"function missing required positional argument #%d", &code_state->state[n_state] - d));
196+
}
197+
}
198+
199+
// Check that all mandatory keyword args are specified
200+
// Fill in default kw args if we have them
201+
for (mp_uint_t i = 0; i < self->n_kwonly_args; i++) {
202+
if (code_state->state[n_state - 1 - self->n_pos_args - i] == MP_OBJ_NULL) {
203+
mp_map_elem_t *elem = NULL;
204+
if (self->has_def_kw_args) {
205+
elem = mp_map_lookup(&((mp_obj_dict_t*)self->extra_args[self->n_def_args])->map, MP_OBJ_NEW_QSTR(self->args[self->n_pos_args + i]), MP_MAP_LOOKUP);
206+
}
207+
if (elem != NULL) {
208+
code_state->state[n_state - 1 - self->n_pos_args - i] = elem->value;
209+
} else {
210+
nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
211+
"function missing required keyword argument '%s'", qstr_str(self->args[self->n_pos_args + i])));
212+
}
213+
}
214+
}
215+
216+
} else {
217+
// no keyword arguments given
218+
if (self->n_kwonly_args != 0) {
219+
nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
220+
"function missing keyword-only argument"));
221+
}
222+
if (self->takes_kw_args) {
223+
*var_pos_kw_args = mp_obj_new_dict(0);
224+
}
225+
}
226+
227+
// bytecode prelude: initialise closed over variables
228+
for (mp_uint_t n_local = *ip++; n_local > 0; n_local--) {
229+
mp_uint_t local_num = *ip++;
230+
code_state->state[n_state - 1 - local_num] = mp_obj_new_cell(code_state->state[n_state - 1 - local_num]);
231+
}
232+
233+
// now that we skipped over the prelude, set the ip for the VM
234+
code_state->ip = ip;
235+
236+
DEBUG_printf("Calling: n_pos_args=%d, n_kwonly_args=%d\n", self->n_pos_args, self->n_kwonly_args);
237+
dump_args(code_state->state + n_state - self->n_pos_args - self->n_kwonly_args, self->n_pos_args + self->n_kwonly_args);
238+
dump_args(code_state->state, n_state);
239+
}

‎py/bc.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ typedef struct _mp_code_state {
4949
//mp_exc_stack_t exc_state[0];
5050
} mp_code_state;
5151

52+
mp_uint_t mp_decode_uint(const byte **ptr);
53+
5254
mp_vm_return_kind_t mp_execute_bytecode(mp_code_state *code_state, volatile mp_obj_t inject_exc);
5355
void mp_setup_code_state(mp_code_state *code_state, mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args);
5456
void mp_bytecode_print(const void *descr, const byte *code, int len);

0 commit comments

Comments
 (0)