blob: 895c03cc23613533e941df11e1fe091a49bb137c [file] [log] [blame]
Damiend99b0522013-12-21 18:17:45 +00001#include <stdlib.h>
Damiend99b0522013-12-21 18:17:45 +00002#include <assert.h>
3
4#include "nlr.h"
5#include "misc.h"
6#include "mpconfig.h"
Damien George55baff42014-01-21 21:40:13 +00007#include "qstr.h"
Damiend99b0522013-12-21 18:17:45 +00008#include "obj.h"
9#include "runtime.h"
10#include "bc.h"
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +020011#include "objgenerator.h"
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +030012#include "objfun.h"
Damiend99b0522013-12-21 18:17:45 +000013
14/******************************************************************************/
15/* generator wrapper */
16
17typedef struct _mp_obj_gen_wrap_t {
18 mp_obj_base_t base;
Damiend99b0522013-12-21 18:17:45 +000019 mp_obj_t *fun;
20} mp_obj_gen_wrap_t;
21
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +030022mp_obj_t mp_obj_new_gen_instance(mp_obj_dict_t *globals, const byte *bytecode, uint n_args, const mp_obj_t *args,
23 uint n_args2, const mp_obj_t *args2);
Paul Sokolovsky7fafb282014-03-30 20:21:28 +030024
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +020025STATIC mp_obj_t gen_wrap_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
Damiend99b0522013-12-21 18:17:45 +000026 mp_obj_gen_wrap_t *self = self_in;
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +030027 mp_obj_fun_bc_t *self_fun = (mp_obj_fun_bc_t*)self->fun;
Damien George3e1a5c12014-03-29 13:43:38 +000028 assert(MP_OBJ_IS_TYPE(self_fun, &mp_type_fun_bc));
Damien George6baf76e2013-12-30 22:32:17 +000029
Paul Sokolovsky7fafb282014-03-30 20:21:28 +030030 const mp_obj_t *args1, *args2;
31 uint len1, len2;
Damien George0997af92014-03-30 21:55:28 +010032 if (!mp_obj_fun_prepare_simple_args(self_fun, n_args, n_kw, args, &len1, &args1, &len2, &args2)) {
33 assert(0);
34 }
Paul Sokolovsky7fafb282014-03-30 20:21:28 +030035
Damien Georgede7c4252014-04-17 19:16:11 +010036 return mp_obj_new_gen_instance(self_fun->globals, self_fun->bytecode, len1, args1, len2, args2);
Damiend99b0522013-12-21 18:17:45 +000037}
38
Damien George3e1a5c12014-03-29 13:43:38 +000039const mp_obj_type_t mp_type_gen_wrap = {
Damien Georgec5966122014-02-15 16:10:44 +000040 { &mp_type_type },
Damien Georgea71c83a2014-02-15 11:34:50 +000041 .name = MP_QSTR_generator,
Damien George20006db2014-01-18 14:10:48 +000042 .call = gen_wrap_call,
Damiend99b0522013-12-21 18:17:45 +000043};
44
Damien Georged0691cc2014-01-29 20:30:52 +000045mp_obj_t mp_obj_new_gen_wrap(mp_obj_t fun) {
Damiend99b0522013-12-21 18:17:45 +000046 mp_obj_gen_wrap_t *o = m_new_obj(mp_obj_gen_wrap_t);
Damien George3e1a5c12014-03-29 13:43:38 +000047 o->base.type = &mp_type_gen_wrap;
Damiend99b0522013-12-21 18:17:45 +000048 o->fun = fun;
49 return o;
50}
51
52/******************************************************************************/
53/* generator instance */
54
55typedef struct _mp_obj_gen_instance_t {
56 mp_obj_base_t base;
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +030057 mp_obj_dict_t *globals;
Damien George08335002014-01-18 23:24:36 +000058 const byte *code_info;
Damiend99b0522013-12-21 18:17:45 +000059 const byte *ip;
60 mp_obj_t *sp;
Paul Sokolovsky8dc768b2014-03-22 22:53:53 +020061 // bit 0 is saved currently_in_except_block value
Damien George89f94b52014-03-30 00:57:09 +000062 mp_exc_stack_t *exc_sp;
Damien George20006db2014-01-18 14:10:48 +000063 uint n_state;
Paul Sokolovsky8dc768b2014-03-22 22:53:53 +020064 // Variable-length
65 mp_obj_t state[0];
66 // Variable-length, never accessed by name, only as (void*)(state + n_state)
Damien George89f94b52014-03-30 00:57:09 +000067 mp_exc_stack_t exc_state[0];
Damiend99b0522013-12-21 18:17:45 +000068} mp_obj_gen_instance_t;
69
Paul Sokolovsky76d982e2014-01-13 19:19:16 +020070void gen_instance_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
Damiend99b0522013-12-21 18:17:45 +000071 print(env, "<generator object 'fun-name' at %p>", self_in);
72}
73
74mp_obj_t gen_instance_getiter(mp_obj_t self_in) {
75 return self_in;
76}
77
Damien George69b3ba02014-03-26 19:33:23 +000078mp_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) {
Paul Sokolovskyaaff7162014-03-30 02:32:30 +020079 assert(MP_OBJ_IS_TYPE(self_in, &mp_type_gen_instance));
Damiend99b0522013-12-21 18:17:45 +000080 mp_obj_gen_instance_t *self = self_in;
Paul Sokolovsky14d28be2014-01-27 01:01:37 +020081 if (self->ip == 0) {
Damien Georgeea8d06c2014-04-17 23:19:36 +010082 *ret_val = MP_OBJ_STOP_ITERATION;
Damien George69b3ba02014-03-26 19:33:23 +000083 return MP_VM_RETURN_NORMAL;
Paul Sokolovsky14d28be2014-01-27 01:01:37 +020084 }
Paul Sokolovskybf38e2a2014-01-26 20:50:11 +020085 if (self->sp == self->state - 1) {
86 if (send_value != mp_const_none) {
Damien Georgeea13f402014-04-05 18:32:08 +010087 nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "can't send non-None value to a just-started generator"));
Paul Sokolovskybf38e2a2014-01-26 20:50:11 +020088 }
89 } else {
90 *self->sp = send_value;
91 }
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +030092 mp_obj_dict_t *old_globals = mp_globals_get();
93 mp_globals_set(self->globals);
Damien George69b3ba02014-03-26 19:33:23 +000094 mp_vm_return_kind_t ret_kind = mp_execute_byte_code_2(self->code_info, &self->ip,
Damien George89f94b52014-03-30 00:57:09 +000095 &self->state[self->n_state - 1], &self->sp, (mp_exc_stack_t*)(self->state + self->n_state),
Paul Sokolovsky48caa092014-03-22 17:50:12 +020096 &self->exc_sp, throw_value);
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +030097 mp_globals_set(old_globals);
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +020098
Damien George69b3ba02014-03-26 19:33:23 +000099 switch (ret_kind) {
Damien Georgec8f78bc2014-02-15 22:55:00 +0000100 case MP_VM_RETURN_NORMAL:
101 // Explicitly mark generator as completed. If we don't do this,
102 // subsequent next() may re-execute statements after last yield
103 // again and again, leading to side effects.
104 // TODO: check how return with value behaves under such conditions
105 // in CPython.
106 self->ip = 0;
Damien George69b3ba02014-03-26 19:33:23 +0000107 *ret_val = *self->sp;
108 break;
Damien Georgec8f78bc2014-02-15 22:55:00 +0000109
110 case MP_VM_RETURN_YIELD:
Damien George69b3ba02014-03-26 19:33:23 +0000111 *ret_val = *self->sp;
112 break;
Damien Georgec8f78bc2014-02-15 22:55:00 +0000113
114 case MP_VM_RETURN_EXCEPTION:
Paul Sokolovsky61fd20f2014-03-22 16:44:58 +0200115 self->ip = 0;
Damien George69b3ba02014-03-26 19:33:23 +0000116 *ret_val = self->state[self->n_state - 1];
117 break;
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200118
119 default:
120 assert(0);
Damien George69b3ba02014-03-26 19:33:23 +0000121 *ret_val = mp_const_none;
122 break;
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200123 }
Damien George69b3ba02014-03-26 19:33:23 +0000124
125 return ret_kind;
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200126}
127
128STATIC mp_obj_t gen_resume_and_raise(mp_obj_t self_in, mp_obj_t send_value, mp_obj_t throw_value) {
Damien George69b3ba02014-03-26 19:33:23 +0000129 mp_obj_t ret;
130 switch (mp_obj_gen_resume(self_in, send_value, throw_value, &ret)) {
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200131 case MP_VM_RETURN_NORMAL:
132 // Optimize return w/o value in case generator is used in for loop
Damien Georgeea8d06c2014-04-17 23:19:36 +0100133 if (ret == mp_const_none || ret == MP_OBJ_STOP_ITERATION) {
134 return MP_OBJ_STOP_ITERATION;
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200135 } else {
Damien Georgeea13f402014-04-05 18:32:08 +0100136 nlr_raise(mp_obj_new_exception_args(&mp_type_StopIteration, 1, &ret));
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200137 }
138
139 case MP_VM_RETURN_YIELD:
Paul Sokolovsky817e76a2014-03-31 04:09:53 +0300140 if (throw_value != MP_OBJ_NULL && mp_obj_is_subclass_fast(mp_obj_get_type(throw_value), &mp_type_GeneratorExit)) {
Damien Georgeea13f402014-04-05 18:32:08 +0100141 nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "generator ignored GeneratorExit"));
Paul Sokolovsky817e76a2014-03-31 04:09:53 +0300142 }
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200143 return ret;
144
145 case MP_VM_RETURN_EXCEPTION:
Damien Georgeea8d06c2014-04-17 23:19:36 +0100146 // TODO: Optimization of returning MP_OBJ_STOP_ITERATION is really part
Paul Sokolovskyf39d3b92014-03-30 23:14:55 +0300147 // of mp_iternext() protocol, but this function is called by other methods
Damien Georgeea8d06c2014-04-17 23:19:36 +0100148 // too, which may not handled MP_OBJ_STOP_ITERATION.
Paul Sokolovskyf39d3b92014-03-30 23:14:55 +0300149 if (mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_StopIteration)) {
Damien Georgeea8d06c2014-04-17 23:19:36 +0100150 return MP_OBJ_STOP_ITERATION;
Paul Sokolovskyf39d3b92014-03-30 23:14:55 +0300151 } else {
Damien Georgeea13f402014-04-05 18:32:08 +0100152 nlr_raise(ret);
Paul Sokolovskyf39d3b92014-03-30 23:14:55 +0300153 }
Paul Sokolovsky61fd20f2014-03-22 16:44:58 +0200154
Damien Georgec8f78bc2014-02-15 22:55:00 +0000155 default:
Damien Georgec8f78bc2014-02-15 22:55:00 +0000156 assert(0);
157 return mp_const_none;
Damiend99b0522013-12-21 18:17:45 +0000158 }
159}
Paul Sokolovskybf38e2a2014-01-26 20:50:11 +0200160
161mp_obj_t gen_instance_iternext(mp_obj_t self_in) {
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200162 return gen_resume_and_raise(self_in, mp_const_none, MP_OBJ_NULL);
Paul Sokolovskybf38e2a2014-01-26 20:50:11 +0200163}
164
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +0200165STATIC mp_obj_t gen_instance_send(mp_obj_t self_in, mp_obj_t send_value) {
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200166 mp_obj_t ret = gen_resume_and_raise(self_in, send_value, MP_OBJ_NULL);
Damien Georgeea8d06c2014-04-17 23:19:36 +0100167 if (ret == MP_OBJ_STOP_ITERATION) {
Damien Georgeea13f402014-04-05 18:32:08 +0100168 nlr_raise(mp_obj_new_exception(&mp_type_StopIteration));
Damien Georgec5966122014-02-15 16:10:44 +0000169 } else {
170 return ret;
Paul Sokolovsky14d28be2014-01-27 01:01:37 +0200171 }
Paul Sokolovsky14d28be2014-01-27 01:01:37 +0200172}
Damien Georgec5966122014-02-15 16:10:44 +0000173
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +0200174STATIC MP_DEFINE_CONST_FUN_OBJ_2(gen_instance_send_obj, gen_instance_send);
Paul Sokolovsky14d28be2014-01-27 01:01:37 +0200175
Paul Sokolovsky9a54a222014-03-30 13:13:12 +0300176STATIC mp_obj_t gen_instance_close(mp_obj_t self_in);
Paul Sokolovsky48caa092014-03-22 17:50:12 +0200177STATIC mp_obj_t gen_instance_throw(uint n_args, const mp_obj_t *args) {
Paul Sokolovsky9a54a222014-03-30 13:13:12 +0300178 mp_obj_t exc = (n_args == 2) ? args[1] : args[2];
Damien Georged17926d2014-03-30 13:35:08 +0100179 exc = mp_make_raise_obj(exc);
Paul Sokolovsky9a54a222014-03-30 13:13:12 +0300180
181 mp_obj_t ret = gen_resume_and_raise(args[0], mp_const_none, exc);
Damien Georgeea8d06c2014-04-17 23:19:36 +0100182 if (ret == MP_OBJ_STOP_ITERATION) {
Damien Georgeea13f402014-04-05 18:32:08 +0100183 nlr_raise(mp_obj_new_exception(&mp_type_StopIteration));
Paul Sokolovsky48caa092014-03-22 17:50:12 +0200184 } else {
185 return ret;
186 }
187}
188
189STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(gen_instance_throw_obj, 2, 4, gen_instance_throw);
190
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200191STATIC mp_obj_t gen_instance_close(mp_obj_t self_in) {
Damien George69b3ba02014-03-26 19:33:23 +0000192 mp_obj_t ret;
Damien George07ddab52014-03-29 13:15:08 +0000193 switch (mp_obj_gen_resume(self_in, mp_const_none, (mp_obj_t)&mp_const_GeneratorExit_obj, &ret)) {
Damien George69b3ba02014-03-26 19:33:23 +0000194 case MP_VM_RETURN_YIELD:
Damien Georgeea13f402014-04-05 18:32:08 +0100195 nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "generator ignored GeneratorExit"));
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200196
Damien George69b3ba02014-03-26 19:33:23 +0000197 // Swallow StopIteration & GeneratorExit (== successful close), and re-raise any other
198 case MP_VM_RETURN_EXCEPTION:
199 // ret should always be an instance of an exception class
200 if (mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_GeneratorExit) ||
201 mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_StopIteration)) {
202 return mp_const_none;
203 }
Damien Georgeea13f402014-04-05 18:32:08 +0100204 nlr_raise(ret);
Damien George69b3ba02014-03-26 19:33:23 +0000205
206 default:
207 // The only choice left is MP_VM_RETURN_NORMAL which is successful close
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200208 return mp_const_none;
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200209 }
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200210}
211
212STATIC MP_DEFINE_CONST_FUN_OBJ_1(gen_instance_close_obj, gen_instance_close);
Paul Sokolovsky48caa092014-03-22 17:50:12 +0200213
Damien George9b196cd2014-03-26 21:47:19 +0000214STATIC const mp_map_elem_t gen_instance_locals_dict_table[] = {
215 { MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t)&gen_instance_close_obj },
216 { MP_OBJ_NEW_QSTR(MP_QSTR_send), (mp_obj_t)&gen_instance_send_obj },
217 { MP_OBJ_NEW_QSTR(MP_QSTR_throw), (mp_obj_t)&gen_instance_throw_obj },
Paul Sokolovskybf38e2a2014-01-26 20:50:11 +0200218};
Damiend99b0522013-12-21 18:17:45 +0000219
Damien George9b196cd2014-03-26 21:47:19 +0000220STATIC MP_DEFINE_CONST_DICT(gen_instance_locals_dict, gen_instance_locals_dict_table);
221
Damien George3e1a5c12014-03-29 13:43:38 +0000222const mp_obj_type_t mp_type_gen_instance = {
Damien Georgec5966122014-02-15 16:10:44 +0000223 { &mp_type_type },
Damien Georgea71c83a2014-02-15 11:34:50 +0000224 .name = MP_QSTR_generator,
Damien George97209d32014-01-07 15:58:30 +0000225 .print = gen_instance_print,
226 .getiter = gen_instance_getiter,
227 .iternext = gen_instance_iternext,
Damien George9b196cd2014-03-26 21:47:19 +0000228 .locals_dict = (mp_obj_t)&gen_instance_locals_dict,
Damiend99b0522013-12-21 18:17:45 +0000229};
230
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +0300231mp_obj_t mp_obj_new_gen_instance(mp_obj_dict_t *globals, const byte *bytecode, uint n_args, const mp_obj_t *args,
232 uint n_args2, const mp_obj_t *args2) {
Paul Sokolovsky6ae237d2014-03-30 02:33:08 +0200233 const byte *code_info = bytecode;
Damien George8dcc0c72014-03-27 10:55:21 +0000234 // get code info size, and skip the line number table
235 machine_uint_t code_info_size = bytecode[0] | (bytecode[1] << 8) | (bytecode[2] << 16) | (bytecode[3] << 24);
236 bytecode += code_info_size;
237
Damien Georgebee17b02014-03-27 11:07:04 +0000238 // bytecode prelude: get state size and exception stack size
239 machine_uint_t n_state = bytecode[0] | (bytecode[1] << 8);
240 machine_uint_t n_exc_stack = bytecode[2] | (bytecode[3] << 8);
241 bytecode += 4;
Damien George8dcc0c72014-03-27 10:55:21 +0000242
Damien George13d67392014-04-09 19:01:45 +0100243 // allocate the generator object, with room for local stack and exception stack
Damien George89f94b52014-03-30 00:57:09 +0000244 mp_obj_gen_instance_t *o = m_new_obj_var(mp_obj_gen_instance_t, byte, n_state * sizeof(mp_obj_t) + n_exc_stack * sizeof(mp_exc_stack_t));
Damien George3e1a5c12014-03-29 13:43:38 +0000245 o->base.type = &mp_type_gen_instance;
Paul Sokolovskyb7e90ea2014-04-17 05:49:47 +0300246 o->globals = globals;
Paul Sokolovsky6ae237d2014-03-30 02:33:08 +0200247 o->code_info = code_info;
Damien George20006db2014-01-18 14:10:48 +0000248 o->sp = &o->state[0] - 1; // sp points to top of stack, which starts off 1 below the state
Damien George89f94b52014-03-30 00:57:09 +0000249 o->exc_sp = (mp_exc_stack_t*)(o->state + n_state) - 1;
Damien George20006db2014-01-18 14:10:48 +0000250 o->n_state = n_state;
Damien George0ff88392014-01-02 20:57:05 +0000251
Damien George20006db2014-01-18 14:10:48 +0000252 // copy args to end of state array, in reverse (that's how mp_execute_byte_code_2 needs it)
Paul Sokolovsky7fafb282014-03-30 20:21:28 +0300253 for (uint i = 0; i < n_args; i++) {
Damien George20006db2014-01-18 14:10:48 +0000254 o->state[n_state - 1 - i] = args[i];
Damien George0ff88392014-01-02 20:57:05 +0000255 }
Paul Sokolovsky7fafb282014-03-30 20:21:28 +0300256 for (uint i = 0; i < n_args2; i++) {
257 o->state[n_state - 1 - n_args - i] = args2[i];
258 }
Damien George0ff88392014-01-02 20:57:05 +0000259
Damien Georged99944a2014-04-09 19:53:31 +0100260 // set rest of state to MP_OBJ_NULL
261 for (uint i = 0; i < n_state - n_args - n_args2; i++) {
262 o->state[i] = MP_OBJ_NULL;
263 }
264
Damien George13d67392014-04-09 19:01:45 +0100265 // bytecode prelude: initialise closed over variables
266 for (uint n_local = *bytecode++; n_local > 0; n_local--) {
267 uint local_num = *bytecode++;
Damien Georged99944a2014-04-09 19:53:31 +0100268 o->state[n_state - 1 - local_num] = mp_obj_new_cell(o->state[n_state - 1 - local_num]);
Damien George13d67392014-04-09 19:01:45 +0100269 }
270
271 // set ip to start of actual byte code
272 o->ip = bytecode;
273
Damiend99b0522013-12-21 18:17:45 +0000274 return o;
275}