objgenerator.c 8.16 KB
Newer Older
1
2
3
4
5
6
#include <stdlib.h>
#include <assert.h>

#include "nlr.h"
#include "misc.h"
#include "mpconfig.h"
7
#include "qstr.h"
8
#include "obj.h"
9
#include "map.h"
10
11
#include "runtime.h"
#include "bc.h"
12
#include "objgenerator.h"
13
14
15
16
17
18
19
20
21

/******************************************************************************/
/* generator wrapper                                                          */

typedef struct _mp_obj_gen_wrap_t {
    mp_obj_base_t base;
    mp_obj_t *fun;
} mp_obj_gen_wrap_t;

22
STATIC mp_obj_t gen_wrap_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
23
24
25
26
27
28
29
30
    mp_obj_gen_wrap_t *self = self_in;
    mp_obj_t self_fun = self->fun;
    assert(MP_OBJ_IS_TYPE(self_fun, &fun_bc_type));
    int bc_n_args;
    uint bc_n_state;
    const byte *bc_code;
    mp_obj_fun_bc_get(self_fun, &bc_n_args, &bc_n_state, &bc_code);
    if (n_args != bc_n_args) {
31
        nlr_jump(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "function takes %d positional arguments but %d were given", bc_n_args, n_args));
32
    }
33
    if (n_kw != 0) {
34
        nlr_jump(mp_obj_new_exception_msg(&mp_type_TypeError, "function does not take keyword arguments"));
35
    }
Damien George's avatar
Damien George committed
36

37
    return mp_obj_new_gen_instance(bc_code, bc_n_state, n_args, args);
38
39
40
}

const mp_obj_type_t gen_wrap_type = {
41
    { &mp_type_type },
42
    .name = MP_QSTR_generator,
43
    .call = gen_wrap_call,
44
45
};

46
mp_obj_t mp_obj_new_gen_wrap(mp_obj_t fun) {
47
48
49
50
51
52
53
54
55
56
57
    mp_obj_gen_wrap_t *o = m_new_obj(mp_obj_gen_wrap_t);
    o->base.type = &gen_wrap_type;
    o->fun = fun;
    return o;
}

/******************************************************************************/
/* generator instance                                                         */

typedef struct _mp_obj_gen_instance_t {
    mp_obj_base_t base;
58
    const byte *code_info;
59
60
    const byte *ip;
    mp_obj_t *sp;
61
    // bit 0 is saved currently_in_except_block value
62
    mp_exc_stack *exc_sp;
63
    uint n_state;
64
65
66
67
    // Variable-length
    mp_obj_t state[0];
    // Variable-length, never accessed by name, only as (void*)(state + n_state)
    mp_exc_stack exc_state[0];
68
69
} mp_obj_gen_instance_t;

70
void gen_instance_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
71
72
73
74
75
76
77
    print(env, "<generator object 'fun-name' at %p>", self_in);
}

mp_obj_t gen_instance_getiter(mp_obj_t self_in) {
    return self_in;
}

78
mp_vm_return_kind_t mp_obj_gen_resume(mp_obj_t self_in, mp_obj_t send_value, mp_obj_t throw_value, mp_obj_t *ret_val) {
79
    mp_obj_gen_instance_t *self = self_in;
80
    if (self->ip == 0) {
81
82
        *ret_val = MP_OBJ_NULL;
        return MP_VM_RETURN_NORMAL;
83
    }
84
85
    if (self->sp == self->state - 1) {
        if (send_value != mp_const_none) {
86
            nlr_jump(mp_obj_new_exception_msg(&mp_type_TypeError, "can't send non-None value to a just-started generator"));
87
88
89
90
        }
    } else {
        *self->sp = send_value;
    }
91
    mp_vm_return_kind_t ret_kind = mp_execute_byte_code_2(self->code_info, &self->ip,
92
93
        &self->state[self->n_state - 1], &self->sp, (mp_exc_stack*)(self->state + self->n_state),
        &self->exc_sp, throw_value);
94

95
    switch (ret_kind) {
96
97
98
99
100
101
102
        case MP_VM_RETURN_NORMAL:
            // Explicitly mark generator as completed. If we don't do this,
            // subsequent next() may re-execute statements after last yield
            // again and again, leading to side effects.
            // TODO: check how return with value behaves under such conditions
            // in CPython.
            self->ip = 0;
103
104
            *ret_val = *self->sp;
            break;
105
106

        case MP_VM_RETURN_YIELD:
107
108
            *ret_val = *self->sp;
            break;
109
110
111

        case MP_VM_RETURN_EXCEPTION:
            self->ip = 0;
112
113
            *ret_val = self->state[self->n_state - 1];
            break;
114
115
116

        default:
            assert(0);
117
118
            *ret_val = mp_const_none;
            break;
119
    }
120
121

    return ret_kind;
122
123
124
}

STATIC mp_obj_t gen_resume_and_raise(mp_obj_t self_in, mp_obj_t send_value, mp_obj_t throw_value) {
125
126
    mp_obj_t ret;
    switch (mp_obj_gen_resume(self_in, send_value, throw_value, &ret)) {
127
128
129
        case MP_VM_RETURN_NORMAL:
            // Optimize return w/o value in case generator is used in for loop
            if (ret == mp_const_none) {
130
                return MP_OBJ_NULL;
131
            } else {
132
                nlr_jump(mp_obj_new_exception_args(&mp_type_StopIteration, 1, &ret));
133
134
135
            }

        case MP_VM_RETURN_YIELD:
136
            return ret;
137
138

        case MP_VM_RETURN_EXCEPTION:
139
            nlr_jump(ret);
140

141
142
143
        default:
            assert(0);
            return mp_const_none;
144
145
    }
}
146
147

mp_obj_t gen_instance_iternext(mp_obj_t self_in) {
148
    return gen_resume_and_raise(self_in, mp_const_none, MP_OBJ_NULL);
149
150
}

151
STATIC mp_obj_t gen_instance_send(mp_obj_t self_in, mp_obj_t send_value) {
152
    mp_obj_t ret = gen_resume_and_raise(self_in, send_value, MP_OBJ_NULL);
153
    if (ret == MP_OBJ_NULL) {
154
155
156
        nlr_jump(mp_obj_new_exception(&mp_type_StopIteration));
    } else {
        return ret;
157
    }
158
}
159

160
STATIC MP_DEFINE_CONST_FUN_OBJ_2(gen_instance_send_obj, gen_instance_send);
161

162
STATIC mp_obj_t gen_instance_throw(uint n_args, const mp_obj_t *args) {
163
    mp_obj_t ret = gen_resume_and_raise(args[0], mp_const_none, n_args == 2 ? args[1] : args[2]);
164
    if (ret == MP_OBJ_NULL) {
165
166
167
168
169
170
171
172
        nlr_jump(mp_obj_new_exception(&mp_type_StopIteration));
    } else {
        return ret;
    }
}

STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(gen_instance_throw_obj, 2, 4, gen_instance_throw);

173
STATIC mp_obj_t gen_instance_close(mp_obj_t self_in) {
174
175
176
177
    mp_obj_t ret;
    switch (mp_obj_gen_resume(self_in, mp_const_none, (mp_obj_t)&mp_type_GeneratorExit, &ret)) {
        case MP_VM_RETURN_YIELD:
            nlr_jump(mp_obj_new_exception_msg(&mp_type_RuntimeError, "generator ignored GeneratorExit"));
178

179
180
181
182
183
184
185
186
187
188
189
        // Swallow StopIteration & GeneratorExit (== successful close), and re-raise any other
        case MP_VM_RETURN_EXCEPTION:
            // ret should always be an instance of an exception class
            if (mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_GeneratorExit) ||
                mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_StopIteration)) {
                return mp_const_none;
            }
            nlr_jump(ret);

        default:
            // The only choice left is MP_VM_RETURN_NORMAL which is successful close
190
191
192
193
194
            return mp_const_none;
    }
}

STATIC MP_DEFINE_CONST_FUN_OBJ_1(gen_instance_close_obj, gen_instance_close);
195

196
197
198
199
STATIC const mp_map_elem_t gen_instance_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t)&gen_instance_close_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_send), (mp_obj_t)&gen_instance_send_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_throw), (mp_obj_t)&gen_instance_throw_obj },
200
};
201

202
203
STATIC MP_DEFINE_CONST_DICT(gen_instance_locals_dict, gen_instance_locals_dict_table);

204
const mp_obj_type_t gen_instance_type = {
205
    { &mp_type_type },
206
    .name = MP_QSTR_generator,
207
208
209
    .print = gen_instance_print,
    .getiter = gen_instance_getiter,
    .iternext = gen_instance_iternext,
210
    .locals_dict = (mp_obj_t)&gen_instance_locals_dict,
211
212
};

213
mp_obj_t mp_obj_new_gen_instance(const byte *bytecode, uint n_state, int n_args, const mp_obj_t *args) {
214
215
    // TODO: 4 is hardcoded number from vm.c, calc exc stack size instead.
    mp_obj_gen_instance_t *o = m_new_obj_var(mp_obj_gen_instance_t, byte, n_state * sizeof(mp_obj_t) + 4 * sizeof(mp_exc_stack));
216
    o->base.type = &gen_instance_type;
217
    o->code_info = bytecode;
218
    o->ip = bytecode;
219
    o->sp = &o->state[0] - 1; // sp points to top of stack, which starts off 1 below the state
220
    o->exc_sp = (mp_exc_stack*)(o->state + n_state) - 1;
221
    o->n_state = n_state;
222

223
    // copy args to end of state array, in reverse (that's how mp_execute_byte_code_2 needs it)
224
    for (int i = 0; i < n_args; i++) {
225
        o->state[n_state - 1 - i] = args[i];
226
227
228
229
230
231
    }

    // TODO
    // prelude for making cells (closed over variables)
    // for now we just make sure there are no cells variables
    // need to work out how to implement closed over variables in generators
232
233
234
235

    // get code info size
    machine_uint_t code_info_size = bytecode[0] | (bytecode[1] << 8) | (bytecode[2] << 16) | (bytecode[3] << 24);
    o->ip += code_info_size;
236
237
238
    assert(o->ip[0] == 0);
    o->ip += 1;

239
240
    return o;
}