1 /*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 * Copyright (c) 2014-2017 Paul Sokolovsky
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 * THE SOFTWARE.
26 */
27
28 #include "py/builtin.h"
29 #include "py/objlist.h"
30 #include "py/objtuple.h"
31 #include "py/objstr.h"
32 #include "py/objint.h"
33 #include "py/objtype.h"
34 #include "py/stream.h"
35 #include "py/smallint.h"
36 #include "py/runtime.h"
37 #include "py/persistentcode.h"
38
39 #if MICROPY_PY_SYS_SETTRACE
40 #include "py/objmodule.h"
41 #include "py/profile.h"
42 #endif
43
44 #if MICROPY_PY_SYS
45
46 // defined per port; type of these is irrelevant, just need pointer
47 extern struct _mp_dummy_t mp_sys_stdin_obj;
48 extern struct _mp_dummy_t mp_sys_stdout_obj;
49 extern struct _mp_dummy_t mp_sys_stderr_obj;
50
51 #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
52 const mp_print_t mp_sys_stdout_print = {&mp_sys_stdout_obj, mp_stream_write_adaptor};
53 #endif
54
55 // version - Python language version that this implementation conforms to, as a string
56 STATIC const MP_DEFINE_STR_OBJ(mp_sys_version_obj, "3.4.0");
57
58 // version_info - Python language version that this implementation conforms to, as a tuple of ints
59 #define I(n) MP_OBJ_NEW_SMALL_INT(n)
60 // TODO: CPython is now at 5-element array, but save 2 els so far...
61 STATIC const mp_obj_tuple_t mp_sys_version_info_obj = {{&mp_type_tuple}, 3, {I(3), I(4), I(0)}};
62
63 // sys.implementation object
64 // this holds the MicroPython version
65 STATIC const mp_obj_tuple_t mp_sys_implementation_version_info_obj = {
66 {&mp_type_tuple},
67 3,
68 { I(MICROPY_VERSION_MAJOR), I(MICROPY_VERSION_MINOR), I(MICROPY_VERSION_MICRO) }
69 };
70 #if MICROPY_PERSISTENT_CODE_LOAD
71 #define SYS_IMPLEMENTATION_ELEMS \
72 MP_ROM_QSTR(MP_QSTR_micropython), \
73 MP_ROM_PTR(&mp_sys_implementation_version_info_obj), \
74 MP_ROM_INT(MPY_FILE_HEADER_INT)
75 #else
76 #define SYS_IMPLEMENTATION_ELEMS \
77 MP_ROM_QSTR(MP_QSTR_micropython), \
78 MP_ROM_PTR(&mp_sys_implementation_version_info_obj)
79 #endif
80 #if MICROPY_PY_ATTRTUPLE
81 STATIC const qstr impl_fields[] = {
82 MP_QSTR_name,
83 MP_QSTR_version,
84 #if MICROPY_PERSISTENT_CODE_LOAD
85 MP_QSTR_mpy,
86 #endif
87 };
88 STATIC MP_DEFINE_ATTRTUPLE(
89 mp_sys_implementation_obj,
90 impl_fields,
91 2 + MICROPY_PERSISTENT_CODE_LOAD,
92 SYS_IMPLEMENTATION_ELEMS
93 );
94 #else
95 STATIC const mp_rom_obj_tuple_t mp_sys_implementation_obj = {
96 {&mp_type_tuple},
97 2 + MICROPY_PERSISTENT_CODE_LOAD,
98 {
99 SYS_IMPLEMENTATION_ELEMS
100 }
101 };
102 #endif
103
104 #undef I
105
106 #ifdef MICROPY_PY_SYS_PLATFORM
107 // platform - the platform that MicroPython is running on
108 STATIC const MP_DEFINE_STR_OBJ(mp_sys_platform_obj, MICROPY_PY_SYS_PLATFORM);
109 #endif
110
111 // exit([retval]): raise SystemExit, with optional argument given to the exception
mp_sys_exit(size_t n_args,const mp_obj_t * args)112 STATIC mp_obj_t mp_sys_exit(size_t n_args, const mp_obj_t *args) {
113 if (n_args == 0) {
114 mp_raise_type(&mp_type_SystemExit);
115 } else {
116 mp_raise_type_arg(&mp_type_SystemExit, args[0]);
117 }
118 }
119 MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_sys_exit_obj, 0, 1, mp_sys_exit);
120
mp_sys_print_exception(size_t n_args,const mp_obj_t * args)121 STATIC mp_obj_t mp_sys_print_exception(size_t n_args, const mp_obj_t *args) {
122 #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
123 void *stream_obj = &mp_sys_stdout_obj;
124 if (n_args > 1) {
125 mp_get_stream_raise(args[1], MP_STREAM_OP_WRITE);
126 stream_obj = MP_OBJ_TO_PTR(args[1]);
127 }
128
129 mp_print_t print = {stream_obj, mp_stream_write_adaptor};
130 mp_obj_print_exception(&print, args[0]);
131 #else
132 (void)n_args;
133 mp_obj_print_exception(&mp_plat_print, args[0]);
134 #endif
135
136 return mp_const_none;
137 }
138 MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_sys_print_exception_obj, 1, 2, mp_sys_print_exception);
139
140 #if MICROPY_PY_SYS_EXC_INFO
mp_sys_exc_info(void)141 STATIC mp_obj_t mp_sys_exc_info(void) {
142 mp_obj_t cur_exc = MP_OBJ_FROM_PTR(MP_STATE_VM(cur_exception));
143 mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(3, NULL));
144
145 if (cur_exc == MP_OBJ_NULL) {
146 t->items[0] = mp_const_none;
147 t->items[1] = mp_const_none;
148 t->items[2] = mp_const_none;
149 return MP_OBJ_FROM_PTR(t);
150 }
151
152 t->items[0] = MP_OBJ_FROM_PTR(mp_obj_get_type(cur_exc));
153 t->items[1] = cur_exc;
154 t->items[2] = mp_const_none;
155 return MP_OBJ_FROM_PTR(t);
156 }
157 MP_DEFINE_CONST_FUN_OBJ_0(mp_sys_exc_info_obj, mp_sys_exc_info);
158 #endif
159
160 #if MICROPY_PY_SYS_GETSIZEOF
mp_sys_getsizeof(mp_obj_t obj)161 STATIC mp_obj_t mp_sys_getsizeof(mp_obj_t obj) {
162 return mp_unary_op(MP_UNARY_OP_SIZEOF, obj);
163 }
164 STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_sys_getsizeof_obj, mp_sys_getsizeof);
165 #endif
166
167 #if MICROPY_PY_SYS_ATEXIT
168 // atexit(callback): Callback is called when sys.exit is called.
mp_sys_atexit(mp_obj_t obj)169 STATIC mp_obj_t mp_sys_atexit(mp_obj_t obj) {
170 mp_obj_t old = MP_STATE_VM(sys_exitfunc);
171 MP_STATE_VM(sys_exitfunc) = obj;
172 return old;
173 }
174 STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_sys_atexit_obj, mp_sys_atexit);
175 #endif
176
177 #if MICROPY_PY_SYS_SETTRACE
178 // settrace(tracefunc): Set the system’s trace function.
mp_sys_settrace(mp_obj_t obj)179 STATIC mp_obj_t mp_sys_settrace(mp_obj_t obj) {
180 return mp_prof_settrace(obj);
181 }
182 MP_DEFINE_CONST_FUN_OBJ_1(mp_sys_settrace_obj, mp_sys_settrace);
183 #endif // MICROPY_PY_SYS_SETTRACE
184
185 STATIC const mp_rom_map_elem_t mp_module_sys_globals_table[] = {
186 { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_sys) },
187
188 { MP_ROM_QSTR(MP_QSTR_path), MP_ROM_PTR(&MP_STATE_VM(mp_sys_path_obj)) },
189 { MP_ROM_QSTR(MP_QSTR_argv), MP_ROM_PTR(&MP_STATE_VM(mp_sys_argv_obj)) },
190 { MP_ROM_QSTR(MP_QSTR_version), MP_ROM_PTR(&mp_sys_version_obj) },
191 { MP_ROM_QSTR(MP_QSTR_version_info), MP_ROM_PTR(&mp_sys_version_info_obj) },
192 { MP_ROM_QSTR(MP_QSTR_implementation), MP_ROM_PTR(&mp_sys_implementation_obj) },
193 #ifdef MICROPY_PY_SYS_PLATFORM
194 { MP_ROM_QSTR(MP_QSTR_platform), MP_ROM_PTR(&mp_sys_platform_obj) },
195 #endif
196 #if MP_ENDIANNESS_LITTLE
197 { MP_ROM_QSTR(MP_QSTR_byteorder), MP_ROM_QSTR(MP_QSTR_little) },
198 #else
199 { MP_ROM_QSTR(MP_QSTR_byteorder), MP_ROM_QSTR(MP_QSTR_big) },
200 #endif
201
202 #if MICROPY_PY_SYS_MAXSIZE
203 #if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE
204 // Maximum mp_int_t value is not representable as small int, so we have
205 // little choice but to use MP_SMALL_INT_MAX. Apps also should be careful
206 // to not try to compare sys.maxsize to some literal number (as this
207 // number might not fit in available int size), but instead count number
208 // of "one" bits in sys.maxsize.
209 { MP_ROM_QSTR(MP_QSTR_maxsize), MP_ROM_INT(MP_SMALL_INT_MAX) },
210 #else
211 { MP_ROM_QSTR(MP_QSTR_maxsize), MP_ROM_PTR(&mp_sys_maxsize_obj) },
212 #endif
213 #endif
214
215 #if MICROPY_PY_SYS_EXIT
216 { MP_ROM_QSTR(MP_QSTR_exit), MP_ROM_PTR(&mp_sys_exit_obj) },
217 #endif
218
219 #if MICROPY_PY_SYS_SETTRACE
220 { MP_ROM_QSTR(MP_QSTR_settrace), MP_ROM_PTR(&mp_sys_settrace_obj) },
221 #endif
222
223 #if MICROPY_PY_SYS_STDFILES
224 { MP_ROM_QSTR(MP_QSTR_stdin), MP_ROM_PTR(&mp_sys_stdin_obj) },
225 { MP_ROM_QSTR(MP_QSTR_stdout), MP_ROM_PTR(&mp_sys_stdout_obj) },
226 { MP_ROM_QSTR(MP_QSTR_stderr), MP_ROM_PTR(&mp_sys_stderr_obj) },
227 #endif
228
229 #if MICROPY_PY_SYS_MODULES
230 { MP_ROM_QSTR(MP_QSTR_modules), MP_ROM_PTR(&MP_STATE_VM(mp_loaded_modules_dict)) },
231 #endif
232 #if MICROPY_PY_SYS_EXC_INFO
233 { MP_ROM_QSTR(MP_QSTR_exc_info), MP_ROM_PTR(&mp_sys_exc_info_obj) },
234 #endif
235 #if MICROPY_PY_SYS_GETSIZEOF
236 { MP_ROM_QSTR(MP_QSTR_getsizeof), MP_ROM_PTR(&mp_sys_getsizeof_obj) },
237 #endif
238
239 /*
240 * Extensions to CPython
241 */
242
243 { MP_ROM_QSTR(MP_QSTR_print_exception), MP_ROM_PTR(&mp_sys_print_exception_obj) },
244 #if MICROPY_PY_SYS_ATEXIT
245 { MP_ROM_QSTR(MP_QSTR_atexit), MP_ROM_PTR(&mp_sys_atexit_obj) },
246 #endif
247 };
248
249 STATIC MP_DEFINE_CONST_DICT(mp_module_sys_globals, mp_module_sys_globals_table);
250
251 const mp_obj_module_t mp_module_sys = {
252 .base = { &mp_type_module },
253 .globals = (mp_obj_dict_t *)&mp_module_sys_globals,
254 };
255
256 #endif
257