objfun.c 19 KB
Newer Older
xbe's avatar
xbe committed
1
#include <stdbool.h>
2
3
4
#include <stdlib.h>
#include <string.h>
#include <assert.h>
5
6
7
8
#ifdef __MINGW32__
// For alloca()
#include <malloc.h>
#endif
9
10
11
12

#include "nlr.h"
#include "misc.h"
#include "mpconfig.h"
13
#include "qstr.h"
14
#include "obj.h"
15
#include "objtuple.h"
Paul Sokolovsky's avatar
Paul Sokolovsky committed
16
#include "objfun.h"
Damien George's avatar
Damien George committed
17
#include "runtime0.h"
18
19
20
#include "runtime.h"
#include "bc.h"

21
22
23
#if 0 // print debugging info
#define DEBUG_PRINT (1)
#else // don't print debugging info
24
#define DEBUG_printf(...) (void)0
25
26
#endif

27
28
29
30
31
/******************************************************************************/
/* native functions                                                           */

// mp_obj_fun_native_t defined in obj.h

32
33
34
35
36
37
38
39
40
41
STATIC mp_obj_t fun_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
    switch (op) {
        case MP_BINARY_OP_EQUAL:
            // These objects can be equal only if it's the same underlying structure,
            // we don't even need to check for 2nd arg type.
            return MP_BOOL(lhs_in == rhs_in);
    }
    return NULL;
}

42
STATIC mp_obj_t fun_native_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
43
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_fun_native));
44
    mp_obj_fun_native_t *self = self_in;
45

46
    // check number of arguments
47
    mp_arg_check_num(n_args, n_kw, self->n_args_min, self->n_args_max, self->is_kw);
48

49
    if (self->is_kw) {
50
51
        // function allows keywords

52
53
54
        // we create a map directly from the given args array
        mp_map_t kw_args;
        mp_map_init_fixed_table(&kw_args, n_kw, args + n_args);
55

56
        return ((mp_fun_kw_t)self->fun)(n_args, args, &kw_args);
57

58
    } else if (self->n_args_min <= 3 && self->n_args_min == self->n_args_max) {
59
60
61
62
63
64
65
66
67
68
69
        // function requires a fixed number of arguments

        // dispatch function call
        switch (self->n_args_min) {
            case 0:
                return ((mp_fun_0_t)self->fun)();

            case 1:
                return ((mp_fun_1_t)self->fun)(args[0]);

            case 2:
70
                return ((mp_fun_2_t)self->fun)(args[0], args[1]);
71

72
            case 3:
73
                return ((mp_fun_3_t)self->fun)(args[0], args[1], args[2]);
74

75
76
77
78
79
80
            default:
                assert(0);
                return mp_const_none;
        }

    } else {
81
        // function takes a variable number of arguments, but no keywords
82

83
        return ((mp_fun_var_t)self->fun)(n_args, args);
84
85
86
    }
}

87
const mp_obj_type_t mp_type_fun_native = {
88
    { &mp_type_type },
89
    .name = MP_QSTR_function,
90
    .call = fun_native_call,
91
    .binary_op = fun_binary_op,
92
93
};

94
// fun must have the correct signature for n_args fixed arguments
Damien George's avatar
Damien George committed
95
mp_obj_t mp_make_function_n(int n_args, void *fun) {
96
    mp_obj_fun_native_t *o = m_new_obj(mp_obj_fun_native_t);
97
    o->base.type = &mp_type_fun_native;
98
    o->is_kw = false;
99
100
    o->n_args_min = n_args;
    o->n_args_max = n_args;
101
102
103
104
    o->fun = fun;
    return o;
}

Damien George's avatar
Damien George committed
105
mp_obj_t mp_make_function_var(int n_args_min, mp_fun_var_t fun) {
106
    mp_obj_fun_native_t *o = m_new_obj(mp_obj_fun_native_t);
107
    o->base.type = &mp_type_fun_native;
108
    o->is_kw = false;
109
    o->n_args_min = n_args_min;
110
    o->n_args_max = MP_OBJ_FUN_ARGS_MAX;
111
112
113
114
115
    o->fun = fun;
    return o;
}

// min and max are inclusive
Damien George's avatar
Damien George committed
116
mp_obj_t mp_make_function_var_between(int n_args_min, int n_args_max, mp_fun_var_t fun) {
117
    mp_obj_fun_native_t *o = m_new_obj(mp_obj_fun_native_t);
118
    o->base.type = &mp_type_fun_native;
119
    o->is_kw = false;
120
121
122
123
124
125
126
127
128
    o->n_args_min = n_args_min;
    o->n_args_max = n_args_max;
    o->fun = fun;
    return o;
}

/******************************************************************************/
/* byte code functions                                                        */

129
const char *mp_obj_code_get_name(const byte *code_info) {
130
131
132
133
    qstr block_name = code_info[8] | (code_info[9] << 8) | (code_info[10] << 16) | (code_info[11] << 24);
    return qstr_str(block_name);
}

134
135
136
137
138
const char *mp_obj_fun_get_name(mp_obj_fun_bc_t *o) {
    const byte *code_info = o->bytecode;
    return mp_obj_code_get_name(code_info);
}

139
140
141
142
143
144
145
#if MICROPY_CPYTHON_COMPAT
STATIC void fun_bc_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o_in, mp_print_kind_t kind) {
    mp_obj_fun_bc_t *o = o_in;
    print(env, "<function %s at 0x%x>", mp_obj_fun_get_name(o), o);
}
#endif

146
#if DEBUG_PRINT
147
STATIC void dump_args(const mp_obj_t *a, int sz) {
148
149
150
151
152
153
    DEBUG_printf("%p: ", a);
    for (int i = 0; i < sz; i++) {
        DEBUG_printf("%p ", a[i]);
    }
    DEBUG_printf("\n");
}
154
155
156
#else
#define dump_args(...) (void)0
#endif
157

158
STATIC NORETURN void fun_pos_args_mismatch(mp_obj_fun_bc_t *f, uint expected, uint given) {
159
160
161
162
163
#if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE
    // Generic message, to be reused for other argument issues
    nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
        "argument num/types mismatch"));
#elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_NORMAL
164
165
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
        "function takes %d positional arguments but %d were given", expected, given));
166
167
168
169
170
#elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
        "%s() takes %d positional arguments but %d were given",
        mp_obj_fun_get_name(f), expected, given));
#endif
171
172
}

173
174
175
176
177
178
179
180
181
182
183
184
// If it's possible to call a function without allocating new argument array,
// this function returns true, together with pointers to 2 subarrays to be used
// as arguments. Otherwise, it returns false. It is expected that this fucntion
// will be accompanied by another, mp_obj_fun_prepare_full_args(), which will
// instead take pointer to full-length out-array, and will fill it in. Rationale
// being that a caller can try this function and if it succeeds, the function call
// can be made without allocating extra memory. Otherwise, caller can allocate memory
// and try "full" function. These functions are expected to be refactoring of
// code in fun_bc_call() and evenrually replace it.
bool mp_obj_fun_prepare_simple_args(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args,
                            uint *out_args1_len, const mp_obj_t **out_args1, uint *out_args2_len, const mp_obj_t **out_args2) {
    mp_obj_fun_bc_t *self = self_in;
Paul Sokolovsky's avatar
Paul Sokolovsky committed
185
186
    DEBUG_printf("mp_obj_fun_prepare_simple_args: given: %d pos, %d kw, expected: %d pos (%d default)\n",
        n_args, n_kw, self->n_pos_args, self->n_def_args);
187
188

    assert(n_kw == 0);
189
    assert(self->n_kwonly_args == 0);
190
191
192
193
194
195
    assert(self->takes_var_args == 0);
    assert(self->takes_kw_args == 0);

    mp_obj_t *extra_args = self->extra_args + self->n_def_args;
    uint n_extra_args = 0;

196
197
    if (n_args > self->n_pos_args) {
        goto arg_error;
198
    } else {
199
200
201
202
203
204
        if (n_args >= self->n_pos_args - self->n_def_args) {
            extra_args -= self->n_pos_args - n_args;
            n_extra_args += self->n_pos_args - n_args;
        } else {
            fun_pos_args_mismatch(self, self->n_pos_args - self->n_def_args, n_args);
        }
205
206
207
208
209
210
211
212
    }
    *out_args1 = args;
    *out_args1_len = n_args;
    *out_args2 = extra_args;
    *out_args2_len = n_extra_args;
    return true;

arg_error:
213
    fun_pos_args_mismatch(self, self->n_pos_args, n_args);
214
215
}

216
STATIC mp_obj_t fun_bc_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
217
218
219
220
221
    // This function is pretty complicated.  It's main aim is to be efficient in speed and RAM
    // usage for the common case of positional only args.
    //
    // extra_args layout: def_args, var_arg tuple, kwonly args, var_kw dict

222
223
    DEBUG_printf("Input n_args: %d, n_kw: %d\n", n_args, n_kw);
    DEBUG_printf("Input pos args: ");
224
    dump_args(args, n_args);
225
226
    DEBUG_printf("Input kw args: ");
    dump_args(args + n_args, n_kw * 2);
227
    mp_obj_fun_bc_t *self = self_in;
228
    DEBUG_printf("Func n_def_args: %d\n", self->n_def_args);
229

230
    const mp_obj_t *kwargs = args + n_args;
Damien George's avatar
Damien George committed
231
232
233
    mp_obj_t *extra_args = self->extra_args + self->n_def_args;
    uint n_extra_args = 0;

234
235
    // check positional arguments

236
    if (n_args > self->n_pos_args) {
Damien George's avatar
Damien George committed
237
238
        // given more than enough arguments
        if (!self->takes_var_args) {
239
            fun_pos_args_mismatch(self, self->n_pos_args, n_args);
Damien George's avatar
Damien George committed
240
241
        }
        // put extra arguments in varargs tuple
242
        *extra_args = mp_obj_new_tuple(n_args - self->n_pos_args, args + self->n_pos_args);
Damien George's avatar
Damien George committed
243
        n_extra_args = 1;
244
        n_args = self->n_pos_args;
245
    } else {
Damien George's avatar
Damien George committed
246
        if (self->takes_var_args) {
247
            DEBUG_printf("passing empty tuple as *args\n");
Damien George's avatar
Damien George committed
248
249
250
            *extra_args = mp_const_empty_tuple;
            n_extra_args = 1;
        }
251
252
253
        // Apply processing and check below only if we don't have kwargs,
        // otherwise, kw handling code below has own extensive checks.
        if (n_kw == 0) {
254
            if (n_args >= self->n_pos_args - self->n_def_args) {
255
                // given enough arguments, but may need to use some default arguments
256
257
                extra_args -= self->n_pos_args - n_args;
                n_extra_args += self->n_pos_args - n_args;
258
            } else {
259
                fun_pos_args_mismatch(self, self->n_pos_args - self->n_def_args, n_args);
260
261
            }
        }
262
    }
Damien George's avatar
Damien George committed
263

264
265
    // check keyword arguments

266
    if (n_kw != 0) {
267
268
269
270
271
        // We cannot use dynamically-sized array here, because GCC indeed
        // deallocates it on leaving defining scope (unlike most static stack allocs).
        // So, we have 2 choices: allocate it unconditionally at the top of function
        // (wastes stack), or use alloca which is guaranteed to dealloc on func exit.
        //mp_obj_t flat_args[self->n_args];
272
273
        mp_obj_t *flat_args = alloca((self->n_pos_args + self->n_kwonly_args) * sizeof(mp_obj_t));
        for (int i = self->n_pos_args + self->n_kwonly_args - 1; i >= 0; i--) {
274
275
276
277
            flat_args[i] = MP_OBJ_NULL;
        }
        memcpy(flat_args, args, sizeof(*args) * n_args);
        DEBUG_printf("Initial args: ");
278
        dump_args(flat_args, self->n_pos_args + self->n_kwonly_args);
279
280
281
282

        mp_obj_t dict = MP_OBJ_NULL;
        if (self->takes_kw_args) {
            dict = mp_obj_new_dict(n_kw); // TODO: better go conservative with 0?
283
284
        }
        for (uint i = 0; i < n_kw; i++) {
285
            qstr arg_name = MP_OBJ_QSTR_VALUE(kwargs[2 * i]);
286
            for (uint j = 0; j < self->n_pos_args + self->n_kwonly_args; j++) {
287
288
                if (arg_name == self->args[j]) {
                    if (flat_args[j] != MP_OBJ_NULL) {
289
                        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
290
291
292
293
294
295
296
297
                            "function got multiple values for argument '%s'", qstr_str(arg_name)));
                    }
                    flat_args[j] = kwargs[2 * i + 1];
                    goto continue2;
                }
            }
            // Didn't find name match with positional args
            if (!self->takes_kw_args) {
298
                nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "function does not take keyword arguments"));
299
            }
300
            mp_obj_dict_store(dict, kwargs[2 * i], kwargs[2 * i + 1]);
301
302
303
continue2:;
        }
        DEBUG_printf("Args with kws flattened: ");
304
        dump_args(flat_args, self->n_pos_args + self->n_kwonly_args);
305

306
307
        // Now fill in defaults for positional args
        mp_obj_t *d = &flat_args[self->n_pos_args - 1];
308
        mp_obj_t *s = &self->extra_args[self->n_def_args - 1];
309
        for (int i = self->n_def_args; i > 0; i--, d--, s--) {
310
            if (*d == MP_OBJ_NULL) {
311
                *d = *s;
312
313
314
            }
        }
        DEBUG_printf("Args after filling defaults: ");
315
        dump_args(flat_args, self->n_pos_args + self->n_kwonly_args);
316

317
        // Check that all mandatory positional args are specified
318
319
        while (d >= flat_args) {
            if (*d-- == MP_OBJ_NULL) {
320
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
321
322
323
324
                    "function missing required positional argument #%d", d - flat_args));
            }
        }

325
326
327
328
329
330
331
332
        // Check that all mandatory keyword args are specified
        for (int i = 0; i < self->n_kwonly_args; i++) {
            if (flat_args[self->n_pos_args + i] == MP_OBJ_NULL) {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                    "function missing required keyword argument '%s'", qstr_str(self->args[self->n_pos_args + i])));
            }
        }

333
        args = flat_args;
334
        n_args = self->n_pos_args + self->n_kwonly_args;
335
336
337
338

        if (self->takes_kw_args) {
            extra_args[n_extra_args] = dict;
            n_extra_args += 1;
339
340
341
        }
    } else {
        // no keyword arguments given
342
343
344
345
        if (self->n_kwonly_args != 0) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                "function missing keyword-only argument"));
        }
346
347
348
349
        if (self->takes_kw_args) {
            extra_args[n_extra_args] = mp_obj_new_dict(0);
            n_extra_args += 1;
        }
350
    }
351

352
    mp_obj_dict_t *old_globals = mp_globals_get();
Damien George's avatar
Damien George committed
353
    mp_globals_set(self->globals);
354
    mp_obj_t result;
355
356
357
    DEBUG_printf("Calling: args=%p, n_args=%d, extra_args=%p, n_extra_args=%d\n", args, n_args, extra_args, n_extra_args);
    dump_args(args, n_args);
    dump_args(extra_args, n_extra_args);
358
    mp_vm_return_kind_t vm_return_kind = mp_execute_byte_code(self->bytecode, args, n_args, extra_args, n_extra_args, &result);
Damien George's avatar
Damien George committed
359
    mp_globals_set(old_globals);
360

361
362
363
    if (vm_return_kind == MP_VM_RETURN_NORMAL) {
        return result;
    } else { // MP_VM_RETURN_EXCEPTION
364
        nlr_raise(result);
365
    }
366
367
}

368
const mp_obj_type_t mp_type_fun_bc = {
369
    { &mp_type_type },
370
    .name = MP_QSTR_function,
371
372
373
#if MICROPY_CPYTHON_COMPAT
    .print = fun_bc_print,
#endif
374
    .call = fun_bc_call,
375
    .binary_op = fun_binary_op,
376
377
};

378
mp_obj_t mp_obj_new_fun_bc(uint scope_flags, qstr *args, uint n_pos_args, uint n_kwonly_args, mp_obj_t def_args_in, const byte *code) {
Damien George's avatar
Damien George committed
379
380
    uint n_def_args = 0;
    uint n_extra_args = 0;
381
382
    mp_obj_tuple_t *def_args = def_args_in;
    if (def_args != MP_OBJ_NULL) {
383
        assert(MP_OBJ_IS_TYPE(def_args, &mp_type_tuple));
384
        n_def_args = def_args->len;
Damien George's avatar
Damien George committed
385
386
387
388
        n_extra_args = def_args->len;
    }
    if ((scope_flags & MP_SCOPE_FLAG_VARARGS) != 0) {
        n_extra_args += 1;
389
    }
390
391
392
    if ((scope_flags & MP_SCOPE_FLAG_VARKEYWORDS) != 0) {
        n_extra_args += 1;
    }
Damien George's avatar
Damien George committed
393
    mp_obj_fun_bc_t *o = m_new_obj_var(mp_obj_fun_bc_t, mp_obj_t, n_extra_args);
394
    o->base.type = &mp_type_fun_bc;
Damien George's avatar
Damien George committed
395
    o->globals = mp_globals_get();
396
    o->args = args;
397
398
    o->n_pos_args = n_pos_args;
    o->n_kwonly_args = n_kwonly_args;
399
    o->n_def_args = n_def_args;
Damien George's avatar
Damien George committed
400
401
    o->takes_var_args = (scope_flags & MP_SCOPE_FLAG_VARARGS) != 0;
    o->takes_kw_args = (scope_flags & MP_SCOPE_FLAG_VARKEYWORDS) != 0;
402
    o->bytecode = code;
403
    memset(o->extra_args, 0, n_extra_args * sizeof(mp_obj_t));
404
    if (def_args != MP_OBJ_NULL) {
Damien George's avatar
Damien George committed
405
        memcpy(o->extra_args, def_args->items, n_def_args * sizeof(mp_obj_t));
406
    }
407
408
409
410
411
412
    if ((scope_flags & MP_SCOPE_FLAG_VARARGS) != 0) {
        o->extra_args[n_def_args] = MP_OBJ_NULL;
    }
    if ((scope_flags & MP_SCOPE_FLAG_VARARGS) != 0) {
        o->extra_args[n_extra_args - 1] = MP_OBJ_NULL;
    }
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
    return o;
}

/******************************************************************************/
/* inline assembler functions                                                 */

typedef struct _mp_obj_fun_asm_t {
    mp_obj_base_t base;
    int n_args;
    void *fun;
} mp_obj_fun_asm_t;

typedef machine_uint_t (*inline_asm_fun_0_t)();
typedef machine_uint_t (*inline_asm_fun_1_t)(machine_uint_t);
typedef machine_uint_t (*inline_asm_fun_2_t)(machine_uint_t, machine_uint_t);
typedef machine_uint_t (*inline_asm_fun_3_t)(machine_uint_t, machine_uint_t, machine_uint_t);

// convert a Micro Python object to a sensible value for inline asm
431
STATIC machine_uint_t convert_obj_for_inline_asm(mp_obj_t obj) {
432
433
434
435
436
437
438
439
440
    // TODO for byte_array, pass pointer to the array
    if (MP_OBJ_IS_SMALL_INT(obj)) {
        return MP_OBJ_SMALL_INT_VALUE(obj);
    } else if (obj == mp_const_none) {
        return 0;
    } else if (obj == mp_const_false) {
        return 0;
    } else if (obj == mp_const_true) {
        return 1;
441
    } else if (MP_OBJ_IS_STR(obj)) {
442
        // pointer to the string (it's probably constant though!)
443
444
        uint l;
        return (machine_uint_t)mp_obj_str_get_data(obj, &l);
445
446
447
    } else {
        mp_obj_type_t *type = mp_obj_get_type(obj);
        if (0) {
448
#if MICROPY_ENABLE_FLOAT
449
450
451
        } else if (type == &mp_type_float) {
            // convert float to int (could also pass in float registers)
            return (machine_int_t)mp_obj_float_get(obj);
452
#endif
453
454
455
456
457
458
459
460
461
462
463
464
465
        } else if (type == &mp_type_tuple) {
            // pointer to start of tuple (could pass length, but then could use len(x) for that)
            uint len;
            mp_obj_t *items;
            mp_obj_tuple_get(obj, &len, &items);
            return (machine_uint_t)items;
        } else if (type == &mp_type_list) {
            // pointer to start of list (could pass length, but then could use len(x) for that)
            uint len;
            mp_obj_t *items;
            mp_obj_list_get(obj, &len, &items);
            return (machine_uint_t)items;
        } else {
466
            mp_buffer_info_t bufinfo;
467
            if (mp_get_buffer(obj, &bufinfo, MP_BUFFER_WRITE)) {
468
469
470
471
472
473
                // supports the buffer protocol, return a pointer to the data
                return (machine_uint_t)bufinfo.buf;
            } else {
                // just pass along a pointer to the object
                return (machine_uint_t)obj;
            }
474
        }
475
476
477
478
    }
}

// convert a return value from inline asm to a sensible Micro Python object
479
STATIC mp_obj_t convert_val_from_inline_asm(machine_uint_t val) {
480
481
482
    return MP_OBJ_NEW_SMALL_INT(val);
}

483
STATIC mp_obj_t fun_asm_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
484
485
486
    mp_obj_fun_asm_t *self = self_in;

    if (n_args != self->n_args) {
487
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "function takes %d positional arguments but %d were given", self->n_args, n_args));
488
    }
489
    if (n_kw != 0) {
490
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "function does not take keyword arguments"));
491
    }
492
493
494
495
496
497
498

    machine_uint_t ret;
    if (n_args == 0) {
        ret = ((inline_asm_fun_0_t)self->fun)();
    } else if (n_args == 1) {
        ret = ((inline_asm_fun_1_t)self->fun)(convert_obj_for_inline_asm(args[0]));
    } else if (n_args == 2) {
499
        ret = ((inline_asm_fun_2_t)self->fun)(convert_obj_for_inline_asm(args[0]), convert_obj_for_inline_asm(args[1]));
500
    } else if (n_args == 3) {
501
        ret = ((inline_asm_fun_3_t)self->fun)(convert_obj_for_inline_asm(args[0]), convert_obj_for_inline_asm(args[1]), convert_obj_for_inline_asm(args[2]));
502
503
504
505
506
507
508
509
    } else {
        assert(0);
        ret = 0;
    }

    return convert_val_from_inline_asm(ret);
}

510
STATIC const mp_obj_type_t mp_type_fun_asm = {
511
    { &mp_type_type },
512
    .name = MP_QSTR_function,
513
    .call = fun_asm_call,
514
    .binary_op = fun_binary_op,
515
516
517
518
};

mp_obj_t mp_obj_new_fun_asm(uint n_args, void *fun) {
    mp_obj_fun_asm_t *o = m_new_obj(mp_obj_fun_asm_t);
519
    o->base.type = &mp_type_fun_asm;
520
521
522
523
    o->n_args = n_args;
    o->fun = fun;
    return o;
}