runtime.c 53.5 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

Damien's avatar
Damien committed
27
28
29
30
#include <stdio.h>
#include <string.h>
#include <assert.h>

31
#include "py/mpstate.h"
32
33
34
#include "py/nlr.h"
#include "py/parsenum.h"
#include "py/compile.h"
35
#include "py/objstr.h"
36
37
38
39
40
41
42
43
44
45
#include "py/objtuple.h"
#include "py/objlist.h"
#include "py/objmodule.h"
#include "py/objgenerator.h"
#include "py/smallint.h"
#include "py/runtime0.h"
#include "py/runtime.h"
#include "py/builtin.h"
#include "py/stackctrl.h"
#include "py/gc.h"
46

47
#if 0 // print debugging info
48
#define DEBUG_PRINT (1)
49
#define DEBUG_printf DEBUG_printf
50
#define DEBUG_OP_printf(...) DEBUG_printf(__VA_ARGS__)
51
#else // don't print debugging info
52
53
#define DEBUG_printf(...) (void)0
#define DEBUG_OP_printf(...) (void)0
54
#endif
Damien's avatar
Damien committed
55

56
57
const mp_obj_module_t mp_module___main__ = {
    .base = { &mp_type_module },
58
    .globals = (mp_obj_dict_t*)&MP_STATE_VM(dict_main),
59
60
};

Damien George's avatar
Damien George committed
61
void mp_init(void) {
62
    qstr_init();
63

64
    // no pending exceptions to start with
65
    MP_STATE_VM(mp_pending_exception) = MP_OBJ_NULL;
66

67
68
69
70
#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
    mp_init_emergency_exception_buf();
#endif

71
    // call port specific initialization if any
72
73
74
75
#ifdef MICROPY_PORT_INIT_FUNC
    MICROPY_PORT_INIT_FUNC;
#endif

76
    // optimization disabled by default
77
    MP_STATE_VM(mp_optimise_value) = 0;
78

79
80
    // init global module stuff
    mp_module_init();
81

82
    // initialise the __main__ module
83
    mp_obj_dict_init(&MP_STATE_VM(dict_main), 1);
84
    mp_obj_dict_store(MP_OBJ_FROM_PTR(&MP_STATE_VM(dict_main)), MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR___main__));
85
86

    // locals = globals for outer module (see Objects/frameobject.c/PyFrame_New())
87
    MP_STATE_CTX(dict_locals) = MP_STATE_CTX(dict_globals) = &MP_STATE_VM(dict_main);
88
89
90

    #if MICROPY_CAN_OVERRIDE_BUILTINS
    // start with no extensions to builtins
91
    MP_STATE_VM(mp_module_builtins_override_dict) = NULL;
92
    #endif
93
94
95
96
97
98

    #if MICROPY_PY_THREAD_GIL
    mp_thread_mutex_init(&MP_STATE_VM(gil_mutex));
    #endif

    MP_THREAD_GIL_ENTER();
Damien's avatar
Damien committed
99
100
}

Damien George's avatar
Damien George committed
101
void mp_deinit(void) {
102
    //mp_obj_dict_free(&dict_main);
103
    mp_module_deinit();
stijn's avatar
stijn committed
104
105
106
107
108

    // call port specific deinitialization if any 
#ifdef MICROPY_PORT_INIT_FUNC
    MICROPY_PORT_DEINIT_FUNC;
#endif
Damien's avatar
Damien committed
109
110
}

111
mp_obj_t mp_load_name(qstr qst) {
Damien's avatar
Damien committed
112
    // logic: search locals, globals, builtins
113
    DEBUG_OP_printf("load name %s\n", qstr_str(qst));
114
    // If we're at the outer scope (locals == globals), dispatch to load_global right away
115
    if (MP_STATE_CTX(dict_locals) != MP_STATE_CTX(dict_globals)) {
116
        mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_CTX(dict_locals)->map, MP_OBJ_NEW_QSTR(qst), MP_MAP_LOOKUP);
117
118
119
        if (elem != NULL) {
            return elem->value;
        }
Damien's avatar
Damien committed
120
    }
121
    return mp_load_global(qst);
Damien's avatar
Damien committed
122
123
}

124
mp_obj_t mp_load_global(qstr qst) {
125
    // logic: search globals, builtins
126
127
    DEBUG_OP_printf("load global %s\n", qstr_str(qst));
    mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_CTX(dict_globals)->map, MP_OBJ_NEW_QSTR(qst), MP_MAP_LOOKUP);
128
    if (elem == NULL) {
129
        #if MICROPY_CAN_OVERRIDE_BUILTINS
130
        if (MP_STATE_VM(mp_module_builtins_override_dict) != NULL) {
131
            // lookup in additional dynamic table of builtins first
132
            elem = mp_map_lookup(&MP_STATE_VM(mp_module_builtins_override_dict)->map, MP_OBJ_NEW_QSTR(qst), MP_MAP_LOOKUP);
133
134
135
136
137
            if (elem != NULL) {
                return elem->value;
            }
        }
        #endif
138
        elem = mp_map_lookup((mp_map_t*)&mp_module_builtins_globals.map, MP_OBJ_NEW_QSTR(qst), MP_MAP_LOOKUP);
139
        if (elem == NULL) {
140
141
142
143
144
            if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
                nlr_raise(mp_obj_new_exception_msg(&mp_type_NameError,
                    "name not defined"));
            } else {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_NameError,
145
                    "name '%q' is not defined", qst));
146
            }
147
148
149
        }
    }
    return elem->value;
Damien's avatar
Damien committed
150
151
}

Damien George's avatar
Damien George committed
152
mp_obj_t mp_load_build_class(void) {
Damien's avatar
Damien committed
153
    DEBUG_OP_printf("load_build_class\n");
154
    #if MICROPY_CAN_OVERRIDE_BUILTINS
155
    if (MP_STATE_VM(mp_module_builtins_override_dict) != NULL) {
156
        // lookup in additional dynamic table of builtins first
157
        mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_VM(mp_module_builtins_override_dict)->map, MP_OBJ_NEW_QSTR(MP_QSTR___build_class__), MP_MAP_LOOKUP);
158
159
160
161
162
        if (elem != NULL) {
            return elem->value;
        }
    }
    #endif
163
    return MP_OBJ_FROM_PTR(&mp_builtin___build_class___obj);
Damien's avatar
Damien committed
164
165
}

166
167
void mp_store_name(qstr qst, mp_obj_t obj) {
    DEBUG_OP_printf("store name %s <- %p\n", qstr_str(qst), obj);
168
    mp_obj_dict_store(MP_OBJ_FROM_PTR(MP_STATE_CTX(dict_locals)), MP_OBJ_NEW_QSTR(qst), obj);
169
170
}

171
172
173
void mp_delete_name(qstr qst) {
    DEBUG_OP_printf("delete name %s\n", qstr_str(qst));
    // TODO convert KeyError to NameError if qst not found
174
    mp_obj_dict_delete(MP_OBJ_FROM_PTR(MP_STATE_CTX(dict_locals)), MP_OBJ_NEW_QSTR(qst));
175
176
}

177
178
void mp_store_global(qstr qst, mp_obj_t obj) {
    DEBUG_OP_printf("store global %s <- %p\n", qstr_str(qst), obj);
179
    mp_obj_dict_store(MP_OBJ_FROM_PTR(MP_STATE_CTX(dict_globals)), MP_OBJ_NEW_QSTR(qst), obj);
Damien's avatar
Damien committed
180
181
}

182
183
184
void mp_delete_global(qstr qst) {
    DEBUG_OP_printf("delete global %s\n", qstr_str(qst));
    // TODO convert KeyError to NameError if qst not found
185
    mp_obj_dict_delete(MP_OBJ_FROM_PTR(MP_STATE_CTX(dict_globals)), MP_OBJ_NEW_QSTR(qst));
186
187
}

188
mp_obj_t mp_unary_op(mp_uint_t op, mp_obj_t arg) {
189
    DEBUG_OP_printf("unary " UINT_FMT " %p\n", op, arg);
190

191
192
193
194
    if (op == MP_UNARY_OP_NOT) {
        // "not x" is the negative of whether "x" is true per Python semantics
        return mp_obj_new_bool(mp_obj_is_true(arg) == 0);
    } else if (MP_OBJ_IS_SMALL_INT(arg)) {
195
        mp_int_t val = MP_OBJ_SMALL_INT_VALUE(arg);
Damien's avatar
Damien committed
196
        switch (op) {
Damien George's avatar
Damien George committed
197
            case MP_UNARY_OP_BOOL:
198
                return mp_obj_new_bool(val != 0);
199
200
            case MP_UNARY_OP_HASH:
                return arg;
Damien George's avatar
Damien George committed
201
            case MP_UNARY_OP_POSITIVE:
202
                return arg;
Damien George's avatar
Damien George committed
203
            case MP_UNARY_OP_NEGATIVE:
204
205
206
207
208
209
                // check for overflow
                if (val == MP_SMALL_INT_MIN) {
                    return mp_obj_new_int(-val);
                } else {
                    return MP_OBJ_NEW_SMALL_INT(-val);
                }
Damien George's avatar
Damien George committed
210
            case MP_UNARY_OP_INVERT:
211
212
213
214
                return MP_OBJ_NEW_SMALL_INT(~val);
            default:
                assert(0);
                return arg;
215
        }
216
217
218
    } else if (op == MP_UNARY_OP_HASH && MP_OBJ_IS_STR_OR_BYTES(arg)) {
        // fast path for hashing str/bytes
        GET_STR_HASH(arg, h);
219
220
221
222
        if (h == 0) {
            GET_STR_DATA_LEN(arg, data, len);
            h = qstr_compute_hash(data, len);
        }
223
        return MP_OBJ_NEW_SMALL_INT(h);
224
225
226
227
    } else {
        mp_obj_type_t *type = mp_obj_get_type(arg);
        if (type->unary_op != NULL) {
            mp_obj_t result = type->unary_op(op, arg);
228
            if (result != MP_OBJ_NULL) {
229
230
                return result;
            }
Damien's avatar
Damien committed
231
        }
232
233
234
235
236
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                "unsupported type for operator"));
        } else {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
237
238
                "unsupported type for %q: '%s'",
                mp_unary_op_method_name[op], mp_obj_get_type_str(arg)));
239
        }
Damien's avatar
Damien committed
240
    }
Damien's avatar
Damien committed
241
242
}

243
mp_obj_t mp_binary_op(mp_uint_t op, mp_obj_t lhs, mp_obj_t rhs) {
244
    DEBUG_OP_printf("binary " UINT_FMT " %p %p\n", op, lhs, rhs);
245
246
247
248
249
250
251
252
253
254

    // TODO correctly distinguish inplace operators for mutable objects
    // lookup logic that CPython uses for +=:
    //   check for implemented +=
    //   then check for implemented +
    //   then check for implemented seq.inplace_concat
    //   then check for implemented seq.concat
    //   then fail
    // note that list does not implement + or +=, so that inplace_concat is reached first for +=

255
    // deal with is
Damien George's avatar
Damien George committed
256
    if (op == MP_BINARY_OP_IS) {
257
        return mp_obj_new_bool(lhs == rhs);
258
259
    }

260
    // deal with == and != for all types
Damien George's avatar
Damien George committed
261
    if (op == MP_BINARY_OP_EQUAL || op == MP_BINARY_OP_NOT_EQUAL) {
262
        if (mp_obj_equal(lhs, rhs)) {
Damien George's avatar
Damien George committed
263
            if (op == MP_BINARY_OP_EQUAL) {
264
265
266
267
268
                return mp_const_true;
            } else {
                return mp_const_false;
            }
        } else {
Damien George's avatar
Damien George committed
269
            if (op == MP_BINARY_OP_EQUAL) {
270
271
272
273
274
275
276
277
                return mp_const_false;
            } else {
                return mp_const_true;
            }
        }
    }

    // deal with exception_match for all types
Damien George's avatar
Damien George committed
278
    if (op == MP_BINARY_OP_EXCEPTION_MATCH) {
279
280
        // rhs must be issubclass(rhs, BaseException)
        if (mp_obj_is_exception_type(rhs)) {
281
            if (mp_obj_exception_match(lhs, rhs)) {
282
283
284
285
                return mp_const_true;
            } else {
                return mp_const_false;
            }
286
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_tuple)) {
287
            mp_obj_tuple_t *tuple = MP_OBJ_TO_PTR(rhs);
288
289
290
291
292
293
294
295
296
297
            for (mp_uint_t i = 0; i < tuple->len; i++) {
                rhs = tuple->items[i];
                if (!mp_obj_is_exception_type(rhs)) {
                    goto unsupported_op;
                }
                if (mp_obj_exception_match(lhs, rhs)) {
                    return mp_const_true;
                }
            }
            return mp_const_false;
298
        }
299
        goto unsupported_op;
300
301
    }

302
    if (MP_OBJ_IS_SMALL_INT(lhs)) {
303
        mp_int_t lhs_val = MP_OBJ_SMALL_INT_VALUE(lhs);
304
        if (MP_OBJ_IS_SMALL_INT(rhs)) {
305
            mp_int_t rhs_val = MP_OBJ_SMALL_INT_VALUE(rhs);
306
307
308
            // This is a binary operation: lhs_val op rhs_val
            // We need to be careful to handle overflow; see CERT INT32-C
            // Operations that can overflow:
309
310
            //      +       result always fits in mp_int_t, then handled by SMALL_INT check
            //      -       result always fits in mp_int_t, then handled by SMALL_INT check
311
            //      *       checked explicitly
312
313
            //      /       if lhs=MIN and rhs=-1; result always fits in mp_int_t, then handled by SMALL_INT check
            //      %       if lhs=MIN and rhs=-1; result always fits in mp_int_t, then handled by SMALL_INT check
314
            //      <<      checked explicitly
315
            switch (op) {
Damien George's avatar
Damien George committed
316
317
318
319
320
321
322
323
                case MP_BINARY_OP_OR:
                case MP_BINARY_OP_INPLACE_OR: lhs_val |= rhs_val; break;
                case MP_BINARY_OP_XOR:
                case MP_BINARY_OP_INPLACE_XOR: lhs_val ^= rhs_val; break;
                case MP_BINARY_OP_AND:
                case MP_BINARY_OP_INPLACE_AND: lhs_val &= rhs_val; break;
                case MP_BINARY_OP_LSHIFT:
                case MP_BINARY_OP_INPLACE_LSHIFT: {
324
325
                    if (rhs_val < 0) {
                        // negative shift not allowed
326
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative shift count"));
327
                    } else if (rhs_val >= (mp_int_t)BITS_PER_WORD || lhs_val > (MP_SMALL_INT_MAX >> rhs_val) || lhs_val < (MP_SMALL_INT_MIN >> rhs_val)) {
328
329
330
331
332
333
334
335
336
                        // left-shift will overflow, so use higher precision integer
                        lhs = mp_obj_new_int_from_ll(lhs_val);
                        goto generic_binary_op;
                    } else {
                        // use standard precision
                        lhs_val <<= rhs_val;
                    }
                    break;
                }
Damien George's avatar
Damien George committed
337
338
                case MP_BINARY_OP_RSHIFT:
                case MP_BINARY_OP_INPLACE_RSHIFT:
339
340
                    if (rhs_val < 0) {
                        // negative shift not allowed
341
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative shift count"));
342
343
                    } else {
                        // standard precision is enough for right-shift
344
                        if (rhs_val >= (mp_int_t)BITS_PER_WORD) {
345
346
347
348
                            // Shifting to big amounts is underfined behavior
                            // in C and is CPU-dependent; propagate sign bit.
                            rhs_val = BITS_PER_WORD - 1;
                        }
349
350
351
                        lhs_val >>= rhs_val;
                    }
                    break;
Damien George's avatar
Damien George committed
352
353
354
355
356
357
                case MP_BINARY_OP_ADD:
                case MP_BINARY_OP_INPLACE_ADD: lhs_val += rhs_val; break;
                case MP_BINARY_OP_SUBTRACT:
                case MP_BINARY_OP_INPLACE_SUBTRACT: lhs_val -= rhs_val; break;
                case MP_BINARY_OP_MULTIPLY:
                case MP_BINARY_OP_INPLACE_MULTIPLY: {
358

359
                    // If long long type exists and is larger than mp_int_t, then
360
                    // we can use the following code to perform overflow-checked multiplication.
361
                    // Otherwise (eg in x64 case) we must use mp_small_int_mul_overflow.
362
363
364
365
366
367
368
369
                    #if 0
                    // compute result using long long precision
                    long long res = (long long)lhs_val * (long long)rhs_val;
                    if (res > MP_SMALL_INT_MAX || res < MP_SMALL_INT_MIN) {
                        // result overflowed SMALL_INT, so return higher precision integer
                        return mp_obj_new_int_from_ll(res);
                    } else {
                        // use standard precision
370
                        lhs_val = (mp_int_t)res;
371
372
373
                    }
                    #endif

374
375
376
377
378
379
380
381
                    if (mp_small_int_mul_overflow(lhs_val, rhs_val)) {
                        // use higher precision
                        lhs = mp_obj_new_int_from_ll(lhs_val);
                        goto generic_binary_op;
                    } else {
                        // use standard precision
                        return MP_OBJ_NEW_SMALL_INT(lhs_val * rhs_val);
                    }
382
383
                    break;
                }
Damien George's avatar
Damien George committed
384
385
                case MP_BINARY_OP_FLOOR_DIVIDE:
                case MP_BINARY_OP_INPLACE_FLOOR_DIVIDE:
386
387
388
                    if (rhs_val == 0) {
                        goto zero_division;
                    }
389
                    lhs_val = mp_small_int_floor_divide(lhs_val, rhs_val);
390
                    break;
391

392
                #if MICROPY_PY_BUILTINS_FLOAT
Damien George's avatar
Damien George committed
393
                case MP_BINARY_OP_TRUE_DIVIDE:
394
395
                case MP_BINARY_OP_INPLACE_TRUE_DIVIDE:
                    if (rhs_val == 0) {
396
                        goto zero_division;
397
398
                    }
                    return mp_obj_new_float((mp_float_t)lhs_val / (mp_float_t)rhs_val);
399
                #endif
400

Damien George's avatar
Damien George committed
401
                case MP_BINARY_OP_MODULO:
402
                case MP_BINARY_OP_INPLACE_MODULO: {
403
404
405
                    if (rhs_val == 0) {
                        goto zero_division;
                    }
406
                    lhs_val = mp_small_int_modulo(lhs_val, rhs_val);
407
408
                    break;
                }
409

Damien George's avatar
Damien George committed
410
411
                case MP_BINARY_OP_POWER:
                case MP_BINARY_OP_INPLACE_POWER:
412
                    if (rhs_val < 0) {
413
                        #if MICROPY_PY_BUILTINS_FLOAT
414
415
416
                        lhs = mp_obj_new_float(lhs_val);
                        goto generic_binary_op;
                        #else
417
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative power with no float support"));
418
419
                        #endif
                    } else {
420
                        mp_int_t ans = 1;
421
422
                        while (rhs_val > 0) {
                            if (rhs_val & 1) {
423
                                if (mp_small_int_mul_overflow(ans, lhs_val)) {
424
425
                                    goto power_overflow;
                                }
426
                                ans *= lhs_val;
427
428
429
                            }
                            if (rhs_val == 1) {
                                break;
430
431
                            }
                            rhs_val /= 2;
432
                            if (mp_small_int_mul_overflow(lhs_val, lhs_val)) {
433
434
                                goto power_overflow;
                            }
435
                            lhs_val *= lhs_val;
436
                        }
437
                        lhs_val = ans;
438
                    }
439
                    break;
440
441
442
443
444
445

                power_overflow:
                    // use higher precision
                    lhs = mp_obj_new_int_from_ll(MP_OBJ_SMALL_INT_VALUE(lhs));
                    goto generic_binary_op;

446
447
448
449
450
                case MP_BINARY_OP_DIVMOD: {
                    if (rhs_val == 0) {
                        goto zero_division;
                    }
                    // to reduce stack usage we don't pass a temp array of the 2 items
451
                    mp_obj_tuple_t *tuple = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
452
453
                    tuple->items[0] = MP_OBJ_NEW_SMALL_INT(mp_small_int_floor_divide(lhs_val, rhs_val));
                    tuple->items[1] = MP_OBJ_NEW_SMALL_INT(mp_small_int_modulo(lhs_val, rhs_val));
454
                    return MP_OBJ_FROM_PTR(tuple);
455
456
                }

457
458
459
460
                case MP_BINARY_OP_LESS: return mp_obj_new_bool(lhs_val < rhs_val); break;
                case MP_BINARY_OP_MORE: return mp_obj_new_bool(lhs_val > rhs_val); break;
                case MP_BINARY_OP_LESS_EQUAL: return mp_obj_new_bool(lhs_val <= rhs_val); break;
                case MP_BINARY_OP_MORE_EQUAL: return mp_obj_new_bool(lhs_val >= rhs_val); break;
461

462
463
                default:
                    goto unsupported_op;
464
            }
465
            // TODO: We just should make mp_obj_new_int() inline and use that
466
            if (MP_SMALL_INT_FITS(lhs_val)) {
467
                return MP_OBJ_NEW_SMALL_INT(lhs_val);
468
469
            } else {
                return mp_obj_new_int(lhs_val);
470
            }
471
#if MICROPY_PY_BUILTINS_FLOAT
472
        } else if (mp_obj_is_float(rhs)) {
473
474
475
476
477
478
            mp_obj_t res = mp_obj_float_binary_op(op, lhs_val, rhs);
            if (res == MP_OBJ_NULL) {
                goto unsupported_op;
            } else {
                return res;
            }
479
#if MICROPY_PY_BUILTINS_COMPLEX
480
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_complex)) {
481
482
483
484
485
486
            mp_obj_t res = mp_obj_complex_binary_op(op, lhs_val, 0, rhs);
            if (res == MP_OBJ_NULL) {
                goto unsupported_op;
            } else {
                return res;
            }
487
#endif
488
#endif
489
        }
490
    }
491

492
    /* deal with `in`
493
494
     *
     * NOTE `a in b` is `b.__contains__(a)`, hence why the generic dispatch
Damien George's avatar
Damien George committed
495
     * needs to go below with swapped arguments
496
     */
Damien George's avatar
Damien George committed
497
    if (op == MP_BINARY_OP_IN) {
498
499
500
        mp_obj_type_t *type = mp_obj_get_type(rhs);
        if (type->binary_op != NULL) {
            mp_obj_t res = type->binary_op(op, rhs, lhs);
501
            if (res != MP_OBJ_NULL) {
502
                return res;
John R. Lenton's avatar
John R. Lenton committed
503
            }
504
505
506
        }
        if (type->getiter != NULL) {
            /* second attempt, walk the iterator */
Damien George's avatar
Damien George committed
507
            mp_obj_t iter = mp_getiter(rhs);
508
            mp_obj_t next;
509
            while ((next = mp_iternext(iter)) != MP_OBJ_STOP_ITERATION) {
510
                if (mp_obj_equal(next, lhs)) {
511
                    return mp_const_true;
John R. Lenton's avatar
John R. Lenton committed
512
                }
513
            }
514
            return mp_const_false;
515
516
        }

517
518
519
520
521
522
523
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                "object not iterable"));
        } else {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                "'%s' object is not iterable", mp_obj_get_type_str(rhs)));
        }
524
525
    }

526
    // generic binary_op supplied by type
527
528
529
    mp_obj_type_t *type;
generic_binary_op:
    type = mp_obj_get_type(lhs);
530
531
    if (type->binary_op != NULL) {
        mp_obj_t result = type->binary_op(op, lhs, rhs);
532
        if (result != MP_OBJ_NULL) {
533
            return result;
Damien's avatar
Damien committed
534
535
        }
    }
536

537
538
    // TODO implement dispatch for reverse binary ops

539
unsupported_op:
540
541
542
543
544
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
            "unsupported type for operator"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
545
546
            "unsupported types for %q: '%s', '%s'",
            mp_binary_op_method_name[op], mp_obj_get_type_str(lhs), mp_obj_get_type_str(rhs)));
547
    }
548
549

zero_division:
550
    nlr_raise(mp_obj_new_exception_msg(&mp_type_ZeroDivisionError, "division by zero"));
Damien's avatar
Damien committed
551
552
}

Damien George's avatar
Damien George committed
553
554
mp_obj_t mp_call_function_0(mp_obj_t fun) {
    return mp_call_function_n_kw(fun, 0, 0, NULL);
555
556
}

Damien George's avatar
Damien George committed
557
558
mp_obj_t mp_call_function_1(mp_obj_t fun, mp_obj_t arg) {
    return mp_call_function_n_kw(fun, 1, 0, &arg);
559
560
}

Damien George's avatar
Damien George committed
561
mp_obj_t mp_call_function_2(mp_obj_t fun, mp_obj_t arg1, mp_obj_t arg2) {
562
    mp_obj_t args[2];
563
564
    args[0] = arg1;
    args[1] = arg2;
Damien George's avatar
Damien George committed
565
    return mp_call_function_n_kw(fun, 2, 0, args);
566
567
}

568
// args contains, eg: arg0  arg1  key0  value0  key1  value1
569
mp_obj_t mp_call_function_n_kw(mp_obj_t fun_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
570
571
    // TODO improve this: fun object can specify its type and we parse here the arguments,
    // passing to the function arrays of fixed and keyword arguments
572

573
    DEBUG_OP_printf("calling function %p(n_args=" UINT_FMT ", n_kw=" UINT_FMT ", args=%p)\n", fun_in, n_args, n_kw, args);
574

575
576
577
578
579
    // get the type
    mp_obj_type_t *type = mp_obj_get_type(fun_in);

    // do the call
    if (type->call != NULL) {
580
        return type->call(fun_in, n_args, n_kw, args);
581
    }
582

583
584
585
586
587
588
589
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
            "object not callable"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
            "'%s' object is not callable", mp_obj_get_type_str(fun_in)));
    }
590
591
}

592
593
// args contains: fun  self/NULL  arg(0)  ...  arg(n_args-2)  arg(n_args-1)  kw_key(0)  kw_val(0)  ... kw_key(n_kw-1)  kw_val(n_kw-1)
// if n_args==0 and n_kw==0 then there are only fun and self/NULL
594
mp_obj_t mp_call_method_n_kw(mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
595
    DEBUG_OP_printf("call method (fun=%p, self=%p, n_args=" UINT_FMT ", n_kw=" UINT_FMT ", args=%p)\n", args[0], args[1], n_args, n_kw, args);
596
    int adjust = (args[1] == MP_OBJ_NULL) ? 0 : 1;
Damien George's avatar
Damien George committed
597
    return mp_call_function_n_kw(args[0], n_args + adjust, n_kw, args + 2 - adjust);
598
599
}

600
601
602
603
604
// This function only needs to be exposed externally when in stackless mode.
#if !MICROPY_STACKLESS
STATIC
#endif
void mp_call_prepare_args_n_kw_var(bool have_self, mp_uint_t n_args_n_kw, const mp_obj_t *args, mp_call_args_t *out_args) {
605
606
607
608
609
610
611
    mp_obj_t fun = *args++;
    mp_obj_t self = MP_OBJ_NULL;
    if (have_self) {
        self = *args++; // may be MP_OBJ_NULL
    }
    uint n_args = n_args_n_kw & 0xff;
    uint n_kw = (n_args_n_kw >> 8) & 0xff;
612
613
    mp_obj_t pos_seq = args[n_args + 2 * n_kw]; // may be MP_OBJ_NULL
    mp_obj_t kw_dict = args[n_args + 2 * n_kw + 1]; // may be MP_OBJ_NULL
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646

    DEBUG_OP_printf("call method var (fun=%p, self=%p, n_args=%u, n_kw=%u, args=%p, seq=%p, dict=%p)\n", fun, self, n_args, n_kw, args, pos_seq, kw_dict);

    // We need to create the following array of objects:
    //     args[0 .. n_args]  unpacked(pos_seq)  args[n_args .. n_args + 2 * n_kw]  unpacked(kw_dict)
    // TODO: optimize one day to avoid constructing new arg array? Will be hard.

    // The new args array
    mp_obj_t *args2;
    uint args2_alloc;
    uint args2_len = 0;

    // Try to get a hint for the size of the kw_dict
    uint kw_dict_len = 0;
    if (kw_dict != MP_OBJ_NULL && MP_OBJ_IS_TYPE(kw_dict, &mp_type_dict)) {
        kw_dict_len = mp_obj_dict_len(kw_dict);
    }

    // Extract the pos_seq sequence to the new args array.
    // Note that it can be arbitrary iterator.
    if (pos_seq == MP_OBJ_NULL) {
        // no sequence

        // allocate memory for the new array of args
        args2_alloc = 1 + n_args + 2 * (n_kw + kw_dict_len);
        args2 = m_new(mp_obj_t, args2_alloc);

        // copy the self
        if (self != MP_OBJ_NULL) {
            args2[args2_len++] = self;
        }

        // copy the fixed pos args
647
        mp_seq_copy(args2 + args2_len, args, n_args, mp_obj_t);
648
649
650
651
652
653
        args2_len += n_args;

    } else if (MP_OBJ_IS_TYPE(pos_seq, &mp_type_tuple) || MP_OBJ_IS_TYPE(pos_seq, &mp_type_list)) {
        // optimise the case of a tuple and list

        // get the items
654
        mp_uint_t len;
655
656
657
658
659
660
661
662
663
664
665
666
667
        mp_obj_t *items;
        mp_obj_get_array(pos_seq, &len, &items);

        // allocate memory for the new array of args
        args2_alloc = 1 + n_args + len + 2 * (n_kw + kw_dict_len);
        args2 = m_new(mp_obj_t, args2_alloc);

        // copy the self
        if (self != MP_OBJ_NULL) {
            args2[args2_len++] = self;
        }

        // copy the fixed and variable position args
668
        mp_seq_cat(args2 + args2_len, args, n_args, items, len, mp_obj_t);
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
        args2_len += n_args + len;

    } else {
        // generic iterator

        // allocate memory for the new array of args
        args2_alloc = 1 + n_args + 2 * (n_kw + kw_dict_len) + 3;
        args2 = m_new(mp_obj_t, args2_alloc);

        // copy the self
        if (self != MP_OBJ_NULL) {
            args2[args2_len++] = self;
        }

        // copy the fixed position args
684
        mp_seq_copy(args2 + args2_len, args, n_args, mp_obj_t);
685
        args2_len += n_args;
686
687
688
689

        // extract the variable position args from the iterator
        mp_obj_t iterable = mp_getiter(pos_seq);
        mp_obj_t item;
690
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
691
692
693
694
695
696
697
698
699
700
701
702
            if (args2_len >= args2_alloc) {
                args2 = m_renew(mp_obj_t, args2, args2_alloc, args2_alloc * 2);
                args2_alloc *= 2;
            }
            args2[args2_len++] = item;
        }
    }

    // The size of the args2 array now is the number of positional args.
    uint pos_args_len = args2_len;

    // Copy the fixed kw args.
703
    mp_seq_copy(args2 + args2_len, args + n_args, 2 * n_kw, mp_obj_t);
704
705
706
707
708
709
710
711
712
713
    args2_len += 2 * n_kw;

    // Extract (key,value) pairs from kw_dict dictionary and append to args2.
    // Note that it can be arbitrary iterator.
    if (kw_dict == MP_OBJ_NULL) {
        // pass
    } else if (MP_OBJ_IS_TYPE(kw_dict, &mp_type_dict)) {
        // dictionary
        mp_map_t *map = mp_obj_dict_get_map(kw_dict);
        assert(args2_len + 2 * map->used <= args2_alloc); // should have enough, since kw_dict_len is in this case hinted correctly above
714
715
        for (mp_uint_t i = 0; i < map->alloc; i++) {
            if (MP_MAP_SLOT_IS_FILLED(map, i)) {
716
717
718
719
720
721
                // the key must be a qstr, so intern it if it's a string
                mp_obj_t key = map->table[i].key;
                if (MP_OBJ_IS_TYPE(key, &mp_type_str)) {
                    key = mp_obj_str_intern(key);
                }
                args2[args2_len++] = key;
722
723
724
725
                args2[args2_len++] = map->table[i].value;
            }
        }
    } else {
726
727
728
729
730
731
732
        // generic mapping:
        // - call keys() to get an iterable of all keys in the mapping
        // - call __getitem__ for each key to get the corresponding value

        // get the keys iterable
        mp_obj_t dest[3];
        mp_load_method(kw_dict, MP_QSTR_keys, dest);
733
        mp_obj_t iterable = mp_getiter(mp_call_method_n_kw(0, 0, dest));
734
735
736
737

        mp_obj_t key;
        while ((key = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
            // expand size of args array if needed
738
739
740
741
742
743
744
745
            if (args2_len + 1 >= args2_alloc) {
                uint new_alloc = args2_alloc * 2;
                if (new_alloc < 4) {
                    new_alloc = 4;
                }
                args2 = m_renew(mp_obj_t, args2, args2_alloc, new_alloc);
                args2_alloc = new_alloc;
            }
746

747
748
749
750
            // the key must be a qstr, so intern it if it's a string
            if (MP_OBJ_IS_TYPE(key, &mp_type_str)) {
                key = mp_obj_str_intern(key);
            }
751
752
753
754
755
756
757

            // get the value corresponding to the key
            mp_load_method(kw_dict, MP_QSTR___getitem__, dest);
            dest[2] = key;
            mp_obj_t value = mp_call_method_n_kw(1, 0, dest);

            // store the key/value pair in the argument array
758
            args2[args2_len++] = key;
759
            args2[args2_len++] = value;
760
761
762
        }
    }

763
764
765
766
767
768
769
770
    out_args->fun = fun;
    out_args->args = args2;
    out_args->n_args = pos_args_len;
    out_args->n_kw = (args2_len - pos_args_len) / 2;
    out_args->n_alloc = args2_alloc;
}

mp_obj_t mp_call_method_n_kw_var(bool have_self, mp_uint_t n_args_n_kw, const mp_obj_t *args) {
771
    mp_call_args_t out_args;
772
773
774
775
    mp_call_prepare_args_n_kw_var(have_self, n_args_n_kw, args, &out_args);

    mp_obj_t res = mp_call_function_n_kw(out_args.fun, out_args.n_args, out_args.n_kw, out_args.args);
    m_del(mp_obj_t, out_args.args, out_args.n_alloc);
776
777
778
779

    return res;
}

780
// unpacked items are stored in reverse order into the array pointed to by items
781
void mp_unpack_sequence(mp_obj_t seq_in, mp_uint_t num, mp_obj_t *items) {
782
    mp_uint_t seq_len;
783
    if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(seq_in, &mp_type_list)) {
784
        mp_obj_t *seq_items;
785
        if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple)) {
786
787
788
            mp_obj_tuple_get(seq_in, &seq_len, &seq_items);
        } else {
            mp_obj_list_get(seq_in, &seq_len, &seq_items);
789
        }
790
        if (seq_len < num) {
791
            goto too_short;
792
        } else if (seq_len > num) {
793
            goto too_long;
794
        }
795
        for (mp_uint_t i = 0; i < num; i++) {
796
797
            items[i] = seq_items[num - 1 - i];
        }
798
    } else {
Damien George's avatar
Damien George committed
799
        mp_obj_t iterable = mp_getiter(seq_in);
800
801

        for (seq_len = 0; seq_len < num; seq_len++) {
Damien George's avatar
Damien George committed
802
            mp_obj_t el = mp_iternext(iterable);
803
            if (el == MP_OBJ_STOP_ITERATION) {
804
805
806
807
                goto too_short;
            }
            items[num - 1 - seq_len] = el;
        }
808
        if (mp_iternext(iterable) != MP_OBJ_STOP_ITERATION) {
809
810
            goto too_long;
        }
811
    }
812
813
814
    return;

too_short:
815
816
817
818
819
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
            "wrong number of values to unpack"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
820
            "need more than %d values to unpack", (int)seq_len));
821
    }
822
too_long:
823
824
825
826
827
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
            "wrong number of values to unpack"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
828
            "too many values to unpack (expected %d)", (int)num));
829
    }
830
831
}

832
// unpacked items are stored in reverse order into the array pointed to by items
833
834
835
void mp_unpack_ex(mp_obj_t seq_in, mp_uint_t num_in, mp_obj_t *items) {
    mp_uint_t num_left = num_in & 0xff;
    mp_uint_t num_right = (num_in >> 8) & 0xff;
836
    DEBUG_OP_printf("unpack ex " UINT_FMT " " UINT_FMT "\n", num_left, num_right);
837
    mp_uint_t seq_len;
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
    if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(seq_in, &mp_type_list)) {
        mp_obj_t *seq_items;
        if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple)) {
            mp_obj_tuple_get(seq_in, &seq_len, &seq_items);
        } else {
            if (num_left == 0 && num_right == 0) {
                // *a, = b # sets a to b if b is a list
                items[0] = seq_in;
                return;
            }
            mp_obj_list_get(seq_in, &seq_len, &seq_items);
        }
        if (seq_len < num_left + num_right) {
            goto too_short;
        }
853
        for (mp_uint_t i = 0; i < num_right; i++) {
854
855
856
            items[i] = seq_items[seq_len - 1 - i];
        }
        items[num_right] = mp_obj_new_list(seq_len - num_left - num_right, seq_items + num_left);
857
        for (mp_uint_t i = 0; i < num_left; i++) {
858
859
860
861
862
863
864
865
866
867
868
            items[num_right + 1 + i] = seq_items[num_left - 1 - i];
        }
    } else {
        // Generic iterable; this gets a bit messy: we unpack known left length to the
        // items destination array, then the rest to a dynamically created list.  Once the
        // iterable is exhausted, we take from this list for the right part of the items.
        // TODO Improve to waste less memory in the dynamically created list.
        mp_obj_t iterable = mp_getiter(seq_in);
        mp_obj_t item;
        for (seq_len = 0; seq_len < num_left; seq_len++) {
            item = mp_iternext(iterable);
869
            if (item == MP_OBJ_STOP_ITERATION) {
870
871
872
873
                goto too_short;
            }
            items[num_left + num_right + 1 - 1 - seq_len] = item;
        }
874
        mp_obj_list_t *rest = MP_OBJ_TO_PTR(mp_obj_new_list(0, NULL));
875
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
876
            mp_obj_list_append(MP_OBJ_FROM_PTR(rest), item);
877
        }
878
        if (rest->len < num_right) {
879
880
            goto too_short;
        }
881
        items[num_right] = MP_OBJ_FROM_PTR(rest);
882
        for (mp_uint_t i = 0; i < num_right; i++) {
883
            items[num_right - 1 - i] = rest->items[rest->len - num_right + i];
884
        }
885
        mp_obj_list_set_len(MP_OBJ_FROM_PTR(rest), rest->len - num_right);
886
887
888
889
    }
    return;

too_short:
890
891
892
893
894
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
            "wrong number of values to unpack"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
895
            "need more than %d values to unpack", (int)seq_len));
896
    }
897
898
}

899
mp_obj_t mp_load_attr(mp_obj_t base, qstr attr) {
900
    DEBUG_OP_printf("load attr %p.%s\n", base, qstr_str(attr));
901
    // use load_method
902
    mp_obj_t dest[2];
903
904
    mp_load_method(base, attr, dest);
    if (dest[1] == MP_OBJ_NULL) {
905
        // load_method returned just a normal attribute
906
        return dest[0];
907
908
909
    } else {
        // load_method returned a method, so build a bound method object
        return mp_obj_new_bound_meth(dest[0], dest[1]);
Damien's avatar
Damien committed
910
911
912
    }
}

913
914
915
916
917
918
919
920
921
922
923
924
#if MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG

// The following "checked fun" type is local to the mp_convert_member_lookup
// function, and serves to check that the first argument to a builtin function
// has the correct type.

typedef struct _mp_obj_checked_fun_t {
    mp_obj_base_t base;
    const mp_obj_type_t *type;
    mp_obj_t fun;
} mp_obj_checked_fun_t;

925
STATIC mp_obj_t checked_fun_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
926
    mp_obj_checked_fun_t *self = MP_OBJ_TO_PTR(self_in);
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
    if (n_args > 0) {
        const mp_obj_type_t *arg0_type = mp_obj_get_type(args[0]);
        if (arg0_type != self->type) {
            if (MICROPY_ERROR_REPORTING != MICROPY_ERROR_REPORTING_DETAILED) {
                nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                    "argument has wrong type"));
            } else {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                    "argument should be a '%q' not a '%q'", self->type->name, arg0_type->name));
            }
        }
    }
    return mp_call_function_n_kw(self->fun, n_args, n_kw, args);
}

STATIC const mp_obj_type_t mp_type_checked_fun = {
    { &mp_type_type },
    .name = MP_QSTR_function,
    .call = checked_fun_call,
};

STATIC mp_obj_t mp_obj_new_checked_fun(const mp_obj_type_t *type, mp_obj_t fun) {
    mp_obj_checked_fun_t *o = m_new_obj(mp_obj_checked_fun_t);
    o->base.type = &mp_type_checked_fun;
    o->type = type;
    o->fun = fun;
953
    return MP_OBJ_FROM_PTR(o);
954
955
956
957
}

#endif // MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG

958
959
960
961
962
963
964
// Given a member that was extracted from an instance, convert it correctly
// and put the result in the dest[] array for a possible method call.
// Conversion means dealing with static/class methods, callables, and values.
// see http://docs.python.org/3/howto/descriptor.html
void mp_convert_member_lookup(mp_obj_t self, const mp_obj_type_t *type, mp_obj_t member, mp_obj_t *dest) {
    if (MP_OBJ_IS_TYPE(member, &mp_type_staticmethod)) {
        // return just the function
965
        dest[0] = ((mp_obj_static_class_method_t*)MP_OBJ_TO_PTR(member))->fun;
966
967
    } else if (MP_OBJ_IS_TYPE(member, &mp_type_classmethod)) {
        // return a bound method, with self being the type of this object
968
969
970
971
972
        // this type should be the type of the original instance, not the base
        // type (which is what is passed in the 'type' argument to this function)
        if (self != MP_OBJ_NULL) {
            type = mp_obj_get_type(self);
        }
973
974
        dest[0] = ((mp_obj_static_class_method_t*)MP_OBJ_TO_PTR(member))->fun;
        dest[1] = MP_OBJ_FROM_PTR(type);
975
976
977
    } else if (MP_OBJ_IS_TYPE(member, &mp_type_type)) {
        // Don't try to bind types (even though they're callable)
        dest[0] = member;
978