1/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) SatoshiLabs
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
27#ifndef MICROPY_INCLUDED_PY_PROFILING_H
28#define MICROPY_INCLUDED_PY_PROFILING_H
29
30#include "py/emitglue.h"
31
32#if MICROPY_PY_SYS_SETTRACE
33
34#define mp_prof_is_executing MP_STATE_THREAD(prof_callback_is_executing)
35
36typedef struct _mp_obj_code_t {
37 mp_obj_base_t base;
38 const mp_raw_code_t *rc;
39 mp_obj_dict_t *dict_locals;
40 mp_obj_t lnotab;
41} mp_obj_code_t;
42
43typedef struct _mp_obj_frame_t {
44 mp_obj_base_t base;
45 const mp_code_state_t *code_state;
46 struct _mp_obj_frame_t *back;
47 mp_obj_t callback;
48 mp_obj_code_t *code;
49 mp_uint_t lasti;
50 mp_uint_t lineno;
51 bool trace_opcodes;
52} mp_obj_frame_t;
53
54void mp_prof_extract_prelude(const byte *bytecode, mp_bytecode_prelude_t *prelude);
55
56mp_obj_t mp_obj_new_code(const mp_raw_code_t *rc);
57mp_obj_t mp_obj_new_frame(const mp_code_state_t *code_state);
58
59// This is the implementation for the sys.settrace
60mp_obj_t mp_prof_settrace(mp_obj_t callback);
61
62mp_obj_t mp_prof_frame_enter(mp_code_state_t *code_state);
63mp_obj_t mp_prof_frame_update(const mp_code_state_t *code_state);
64
65// For every VM instruction tick this function deduces events from the state
66mp_obj_t mp_prof_instr_tick(mp_code_state_t *code_state, bool is_exception);
67
68// This section is for debugging the settrace feature itself, and is not intended
69// to be included in production/release builds.
70#define MICROPY_PROF_INSTR_DEBUG_PRINT_ENABLE 0
71#if MICROPY_PROF_INSTR_DEBUG_PRINT_ENABLE
72void mp_prof_print_instr(const byte *ip, mp_code_state_t *code_state);
73#define MP_PROF_INSTR_DEBUG_PRINT(current_ip) mp_prof_print_instr((current_ip), code_state)
74#else
75#define MP_PROF_INSTR_DEBUG_PRINT(current_ip)
76#endif
77
78#endif // MICROPY_PY_SYS_SETTRACE
79#endif // MICROPY_INCLUDED_PY_PROFILING_H
80