Branch data     Line data    Source code

       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                 :            :  *
       8                 :            :  * Permission is hereby granted, free of charge, to any person obtaining a copy
       9                 :            :  * of this software and associated documentation files (the "Software"), to deal
      10                 :            :  * in the Software without restriction, including without limitation the rights
      11                 :            :  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      12                 :            :  * copies of the Software, and to permit persons to whom the Software is
      13                 :            :  * furnished to do so, subject to the following conditions:
      14                 :            :  *
      15                 :            :  * The above copyright notice and this permission notice shall be included in
      16                 :            :  * all copies or substantial portions of the Software.
      17                 :            :  *
      18                 :            :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      19                 :            :  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      20                 :            :  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      21                 :            :  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      22                 :            :  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      23                 :            :  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      24                 :            :  * THE SOFTWARE.
      25                 :            :  */
      26                 :            : #ifndef MICROPY_INCLUDED_PY_OBJFUN_H
      27                 :            : #define MICROPY_INCLUDED_PY_OBJFUN_H
      28                 :            : 
      29                 :            : #include "py/bc.h"
      30                 :            : #include "py/obj.h"
      31                 :            : 
      32                 :            : typedef struct _mp_obj_fun_bc_t {
      33                 :            :     mp_obj_base_t base;
      34                 :            :     const mp_module_context_t *context;         // context within which this function was defined
      35                 :            :     struct _mp_raw_code_t *const *child_table;  // table of children
      36                 :            :     const byte *bytecode;                       // bytecode for the function
      37                 :            :     #if MICROPY_PY_SYS_SETTRACE
      38                 :            :     const struct _mp_raw_code_t *rc;
      39                 :            :     #endif
      40                 :            :     // the following extra_args array is allocated space to take (in order):
      41                 :            :     //  - values of positional default args (if any)
      42                 :            :     //  - a single slot for default kw args dict (if it has them)
      43                 :            :     mp_obj_t extra_args[];
      44                 :            : } mp_obj_fun_bc_t;
      45                 :            : 
      46                 :            : typedef struct _mp_obj_fun_asm_t {
      47                 :            :     mp_obj_base_t base;
      48                 :            :     size_t n_args;
      49                 :            :     const void *fun_data; // GC must be able to trace this pointer
      50                 :            :     mp_uint_t type_sig;
      51                 :            : } mp_obj_fun_asm_t;
      52                 :            : 
      53                 :            : mp_obj_t mp_obj_new_fun_bc(const mp_obj_t *def_args, const byte *code, const mp_module_context_t *cm, struct _mp_raw_code_t *const *raw_code_table);
      54                 :            : void mp_obj_fun_bc_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest);
      55                 :            : 
      56                 :            : #if MICROPY_EMIT_NATIVE
      57                 :            : 
      58                 :       8635 : static inline mp_obj_t mp_obj_new_fun_native(const mp_obj_t *def_args, const void *fun_data, const mp_module_context_t *mc, struct _mp_raw_code_t *const *child_table) {
      59                 :       8635 :     mp_obj_fun_bc_t *o = (mp_obj_fun_bc_t *)MP_OBJ_TO_PTR(mp_obj_new_fun_bc(def_args, (const byte *)fun_data, mc, child_table));
      60                 :       8635 :     o->base.type = &mp_type_fun_native;
      61         [ +  + ]:       8635 :     return MP_OBJ_FROM_PTR(o);
      62                 :            : }
      63                 :            : 
      64                 :        420 : static inline mp_obj_t mp_obj_new_fun_viper(const void *fun_data, const mp_module_context_t *mc, struct _mp_raw_code_t *const *child_table) {
      65                 :        420 :     mp_obj_fun_bc_t *o = mp_obj_malloc(mp_obj_fun_bc_t, &mp_type_fun_viper);
      66                 :        420 :     o->bytecode = (const byte *)fun_data;
      67                 :        420 :     o->context = mc;
      68                 :        420 :     o->child_table = child_table;
      69                 :        420 :     return MP_OBJ_FROM_PTR(o);
      70                 :            : }
      71                 :            : 
      72                 :    1065029 : static inline const uint8_t *mp_obj_fun_native_get_prelude_ptr(const mp_obj_fun_bc_t *fun_native) {
      73                 :            :     // Obtain a pointer to the start of the function prelude, based on prelude_ptr_index.
      74                 :    1065029 :     uintptr_t prelude_ptr_index = ((uintptr_t *)fun_native->bytecode)[0];
      75                 :    1065029 :     const uint8_t *prelude_ptr;
      76         [ +  + ]:    1065029 :     if (prelude_ptr_index == 0) {
      77                 :    1063223 :         prelude_ptr = (const uint8_t *)fun_native->child_table;
      78                 :            :     } else {
      79                 :       1806 :         prelude_ptr = (const uint8_t *)fun_native->child_table[prelude_ptr_index];
      80                 :            :     }
      81                 :    1064995 :     return prelude_ptr;
      82                 :            : }
      83                 :            : 
      84                 :    1062277 : static inline void *mp_obj_fun_native_get_function_start(const mp_obj_fun_bc_t *fun_native) {
      85                 :            :     // Obtain a pointer to the start of the function executable machine code.
      86                 :    1062277 :     return MICROPY_MAKE_POINTER_CALLABLE((void *)(fun_native->bytecode + sizeof(uintptr_t)));
      87                 :            : }
      88                 :            : 
      89                 :       1359 : static inline void *mp_obj_fun_native_get_generator_start(const mp_obj_fun_bc_t *fun_native) {
      90                 :            :     // Obtain a pointer to the start of the generator executable machine code.
      91                 :       1359 :     uintptr_t start_offset = ((uintptr_t *)fun_native->bytecode)[1];
      92                 :       1359 :     return MICROPY_MAKE_POINTER_CALLABLE((void *)(fun_native->bytecode + start_offset));
      93                 :            : }
      94                 :            : 
      95                 :     184549 : static inline void *mp_obj_fun_native_get_generator_resume(const mp_obj_fun_bc_t *fun_native) {
      96                 :            :     // Obtain a pointer to the resume location of the generator executable machine code.
      97                 :     184549 :     return MICROPY_MAKE_POINTER_CALLABLE((void *)&((uintptr_t *)fun_native->bytecode)[2]);
      98                 :            : }
      99                 :            : 
     100                 :            : #endif
     101                 :            : 
     102                 :            : #if MICROPY_EMIT_INLINE_ASM
     103                 :            : static inline mp_obj_t mp_obj_new_fun_asm(size_t n_args, const void *fun_data, mp_uint_t type_sig) {
     104                 :            :     mp_obj_fun_asm_t *o = (mp_obj_fun_asm_t *)mp_obj_malloc(mp_obj_fun_asm_t, &mp_type_fun_asm);
     105                 :            :     o->n_args = n_args;
     106                 :            :     o->fun_data = (const byte *)fun_data;
     107                 :            :     o->type_sig = type_sig;
     108                 :            :     return MP_OBJ_FROM_PTR(o);
     109                 :            : }
     110                 :            : #endif
     111                 :            : 
     112                 :            : #endif // MICROPY_INCLUDED_PY_OBJFUN_H