mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
add60865e0
Without the file renaming there are two jerry-debugger.c files. Thus when the jerry-core archive is created there are two objects in it with the same name. Generally this does not create any problems. However if the archive is extracted then the second object file will overwrite the first one which results in undefined reference linkage error. The jerry- prefix was removed from the file names and fixed the include oreders where it was needed. JerryScript-DCO-1.0-Signed-off-by: Peter Gal pgal.u-szeged@partner.samsung.com
326 lines
12 KiB
C
326 lines
12 KiB
C
/* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef DEBUGGER_H
|
|
#define DEBUGGER_H
|
|
|
|
#include "debugger-ws.h"
|
|
#include "ecma-globals.h"
|
|
|
|
#ifdef JERRY_DEBUGGER
|
|
|
|
/* JerryScript debugger protocol is a simplified version of RFC-6455 (WebSockets). */
|
|
|
|
/**
|
|
* Frequency of calling jerry_debugger_receive() by the VM.
|
|
*/
|
|
#define JERRY_DEBUGGER_MESSAGE_FREQUENCY 5
|
|
|
|
/**
|
|
* Limited resources available for the engine, so it is important to
|
|
* check the maximum buffer size. It needs to be between 64 and 256 bytes.
|
|
*/
|
|
#if JERRY_DEBUGGER_MAX_BUFFER_SIZE < 64 || JERRY_DEBUGGER_MAX_BUFFER_SIZE > 256
|
|
#error Please define the MAX_BUFFER_SIZE between 64 and 256 bytes.
|
|
#endif /* JERRY_DEBUGGER_MAX_BUFFER_SIZE < 64 || JERRY_DEBUGGER_MAX_BUFFER_SIZE > 256 */
|
|
|
|
/**
|
|
* Calculate the maximum number of items for a given type
|
|
* which can be transmitted by one message.
|
|
*/
|
|
#define JERRY_DEBUGGER_SEND_MAX(type) \
|
|
((JERRY_DEBUGGER_MAX_SEND_SIZE - sizeof (jerry_debugger_send_header_t) - 1) / sizeof (type))
|
|
|
|
/**
|
|
* Debugger operation modes:
|
|
*
|
|
* The debugger has two operation modes: run mode and breakpoint mode.
|
|
*
|
|
* In run mode the debugger server accepts only a limited number of message
|
|
* types from the debugger client (e.g. stop execution, set breakpoint).
|
|
*
|
|
* In breakpoint mode the JavaScript execution is stopped at a breakpoint and
|
|
* more message types are accepted (e.g. get backtrace, evaluate expression).
|
|
*
|
|
* Switching between modes:
|
|
*
|
|
* When the JavaScript execution stops at a breakpoint the server sends a
|
|
* JERRY_DEBUGGER_BREAKPOINT_HIT message to the client. The client can only
|
|
* issue breakpoint mode commands after this message is received.
|
|
*
|
|
* Certain breakpoint mode commands (e.g. continue) resumes the JavaScript
|
|
* execution and the client must not send any breakpoint mode messages
|
|
* until the JERRY_DEBUGGER_BREAKPOINT_HIT is received again.
|
|
*
|
|
* The debugger server starts in run mode but stops at the first available
|
|
* breakpoint.
|
|
*/
|
|
|
|
/**
|
|
* Debugger option flags.
|
|
*/
|
|
typedef enum
|
|
{
|
|
JERRY_DEBUGGER_CONNECTED = 1u << 0, /**< debugger is connected */
|
|
JERRY_DEBUGGER_BREAKPOINT_MODE = 1u << 1, /**< debugger waiting at a breakpoint */
|
|
JERRY_DEBUGGER_VM_STOP = 1u << 2, /**< stop at the next breakpoint regardless it is enabled */
|
|
JERRY_DEBUGGER_VM_IGNORE = 1u << 3, /**< ignore all breakpoints */
|
|
JERRY_DEBUGGER_VM_IGNORE_EXCEPTION = 1u << 4, /**< debugger stop at an exception */
|
|
} jerry_debugger_flags_t;
|
|
|
|
/**
|
|
* Types for the package.
|
|
*/
|
|
typedef enum
|
|
{
|
|
/* Messages sent by the server to client. */
|
|
JERRY_DEBUGGER_CONFIGURATION = 1, /**< debugger configuration */
|
|
JERRY_DEBUGGER_PARSE_ERROR = 2, /**< parse error */
|
|
JERRY_DEBUGGER_BYTE_CODE_CP = 3, /**< byte code compressed pointer */
|
|
JERRY_DEBUGGER_PARSE_FUNCTION = 4, /**< parsing a new function */
|
|
JERRY_DEBUGGER_BREAKPOINT_LIST = 5, /**< list of line offsets */
|
|
JERRY_DEBUGGER_BREAKPOINT_OFFSET_LIST = 6, /**< list of byte code offsets */
|
|
JERRY_DEBUGGER_SOURCE_CODE = 7, /**< source code fragment */
|
|
JERRY_DEBUGGER_SOURCE_CODE_END = 8, /**< source code last fragment */
|
|
JERRY_DEBUGGER_SOURCE_CODE_NAME = 9, /**< source code name fragment */
|
|
JERRY_DEBUGGER_SOURCE_CODE_NAME_END = 10, /**< source code name last fragment */
|
|
JERRY_DEBUGGER_FUNCTION_NAME = 11, /**< function name fragment */
|
|
JERRY_DEBUGGER_FUNCTION_NAME_END = 12, /**< function name last fragment */
|
|
JERRY_DEBUGGER_RELEASE_BYTE_CODE_CP = 13, /**< invalidate byte code compressed pointer */
|
|
JERRY_DEBUGGER_MEMSTATS_RECEIVE = 14, /**< memstats sent to the client*/
|
|
JERRY_DEBUGGER_BREAKPOINT_HIT = 15, /**< notify breakpoint hit */
|
|
JERRY_DEBUGGER_EXCEPTION_HIT = 16, /**< notify exception hit */
|
|
JERRY_DEBUGGER_EXCEPTION_STR = 17, /**< exception string fragment */
|
|
JERRY_DEBUGGER_EXCEPTION_STR_END = 18, /**< exception string last fragment */
|
|
JERRY_DEBUGGER_BACKTRACE = 19, /**< backtrace data */
|
|
JERRY_DEBUGGER_BACKTRACE_END = 20, /**< last backtrace data */
|
|
JERRY_DEBUGGER_EVAL_RESULT = 21, /**< eval result */
|
|
JERRY_DEBUGGER_EVAL_RESULT_END = 22, /**< last part of eval result */
|
|
JERRY_DEBUGGER_EVAL_ERROR = 23, /**< eval result when an error is occured */
|
|
JERRY_DEBUGGER_EVAL_ERROR_END = 24, /**< last part of eval result when an error is occured */
|
|
|
|
/* Messages sent by the client to server. */
|
|
|
|
/* The following messages are accepted in both run and breakpoint modes. */
|
|
JERRY_DEBUGGER_FREE_BYTE_CODE_CP = 1, /**< free byte code compressed pointer */
|
|
JERRY_DEBUGGER_UPDATE_BREAKPOINT = 2, /**< update breakpoint status */
|
|
JERRY_DEBUGGER_EXCEPTION_CONFIG = 3, /**< exception handler config */
|
|
JERRY_DEBUGGER_MEMSTATS = 4, /**< list memory statistics */
|
|
JERRY_DEBUGGER_STOP = 5, /**< stop execution */
|
|
/* The following messages are only available in breakpoint
|
|
* mode and they switch the engine to run mode. */
|
|
JERRY_DEBUGGER_CONTINUE = 6, /**< continue execution */
|
|
JERRY_DEBUGGER_STEP = 7, /**< next breakpoint, step into functions */
|
|
JERRY_DEBUGGER_NEXT = 8, /**< next breakpoint in the same context */
|
|
/* The following messages are only available in breakpoint
|
|
* mode and this mode is kept after the message is processed. */
|
|
JERRY_DEBUGGER_GET_BACKTRACE = 9, /**< get backtrace */
|
|
JERRY_DEBUGGER_EVAL = 10, /**< first message of evaluating a string */
|
|
JERRY_DEBUGGER_EVAL_PART = 11, /**< next message of evaluating a string */
|
|
} jerry_debugger_header_type_t;
|
|
|
|
/**
|
|
* Delayed free of byte code data.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint16_t size; /**< size of the byte code header divided by JMEM_ALIGNMENT */
|
|
jmem_cpointer_t prev_cp; /**< previous byte code data to be freed */
|
|
} jerry_debugger_byte_code_free_t;
|
|
|
|
/**
|
|
* Outgoing message: JerryScript configuration.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t max_message_size; /**< maximum incoming message size */
|
|
uint8_t cpointer_size; /**< size of compressed pointers */
|
|
uint8_t little_endian; /**< little endian machine */
|
|
} jerry_debugger_send_configuration_t;
|
|
|
|
/**
|
|
* Outgoing message: message without arguments.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
} jerry_debugger_send_type_t;
|
|
|
|
/**
|
|
* Incoming message: message without arguments.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
} jerry_debugger_receive_type_t;
|
|
|
|
/**
|
|
* Outgoing message: string (Source file name or function name).
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t string[JERRY_DEBUGGER_SEND_MAX (uint8_t)]; /**< string data */
|
|
} jerry_debugger_send_string_t;
|
|
|
|
/**
|
|
* Outgoing message: uint32 value.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t line[sizeof (uint32_t)]; /**< value data */
|
|
uint8_t column[sizeof (uint32_t)]; /**< value data */
|
|
} jerry_debugger_send_parse_function_t;
|
|
|
|
/**
|
|
* Outgoing message: byte code compressed pointer.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t byte_code_cp[sizeof (jmem_cpointer_t)]; /**< byte code compressed pointer */
|
|
} jerry_debugger_send_byte_code_cp_t;
|
|
|
|
/**
|
|
* Incoming message: byte code compressed pointer.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t byte_code_cp[sizeof (jmem_cpointer_t)]; /**< byte code compressed pointer */
|
|
} jerry_debugger_receive_byte_code_cp_t;
|
|
|
|
/**
|
|
* Incoming message: update (enable/disable) breakpoint status.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t is_set_breakpoint; /**< set or clear breakpoint */
|
|
uint8_t byte_code_cp[sizeof (jmem_cpointer_t)]; /**< byte code compressed pointer */
|
|
uint8_t offset[sizeof (uint32_t)]; /**< breakpoint offset */
|
|
} jerry_debugger_receive_update_breakpoint_t;
|
|
|
|
/**
|
|
* Outgoing message: send memory statistics
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t allocated_bytes[sizeof (uint32_t)]; /**< allocated bytes */
|
|
uint8_t byte_code_bytes[sizeof (uint32_t)]; /**< byte code bytes */
|
|
uint8_t string_bytes[sizeof (uint32_t)]; /**< string bytes */
|
|
uint8_t object_bytes[sizeof (uint32_t)]; /**< object bytes */
|
|
uint8_t property_bytes[sizeof (uint32_t)]; /**< property bytes */
|
|
} jerry_debugger_send_memstats_t;
|
|
|
|
/**
|
|
* Outgoing message: notify breakpoint hit.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t byte_code_cp[sizeof (jmem_cpointer_t)]; /**< byte code compressed pointer */
|
|
uint8_t offset[sizeof (uint32_t)]; /**< breakpoint offset */
|
|
} jerry_debugger_send_breakpoint_hit_t;
|
|
|
|
/**
|
|
* Stack frame descriptor for sending backtrace information.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t byte_code_cp[sizeof (jmem_cpointer_t)]; /**< byte code compressed pointer */
|
|
uint8_t offset[sizeof (uint32_t)]; /**< last breakpoint offset */
|
|
} jerry_debugger_frame_t;
|
|
|
|
/**
|
|
* Outgoing message: backtrace information.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_debugger_send_header_t header; /**< message header */
|
|
uint8_t type; /**< type of the message */
|
|
jerry_debugger_frame_t frames[JERRY_DEBUGGER_SEND_MAX (jerry_debugger_frame_t)]; /**< frames */
|
|
} jerry_debugger_send_backtrace_t;
|
|
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t enable; /**< non-zero: enable stop at exception */
|
|
} jerry_debugger_receive_exception_config_t;
|
|
|
|
/**
|
|
* Incoming message: get backtrace.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t max_depth[sizeof (uint32_t)]; /**< maximum depth (0 - unlimited) */
|
|
} jerry_debugger_receive_get_backtrace_t;
|
|
|
|
/**
|
|
* Incoming message: first message of evaluating expression.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
uint8_t eval_size[sizeof (uint32_t)]; /**< total size of the message */
|
|
} jerry_debugger_receive_eval_first_t;
|
|
|
|
/**
|
|
* Incoming message: next message of evaluating expression.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t type; /**< type of the message */
|
|
} jerry_debugger_receive_eval_part_t;
|
|
|
|
/**
|
|
* Data for evaluating expressions
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t eval_size; /**< total size of the eval string */
|
|
uint32_t eval_offset; /**< current offset in the eval string */
|
|
} jerry_debugger_eval_data_t;
|
|
|
|
void jerry_debugger_free_unreferenced_byte_code (void);
|
|
|
|
bool jerry_debugger_process_message (uint8_t *recv_buffer_p, uint32_t message_size,
|
|
bool *resume_exec_p, uint8_t *expected_message_p, void **message_data_p);
|
|
void jerry_debugger_breakpoint_hit (uint8_t message_type);
|
|
|
|
void jerry_debugger_send_type (jerry_debugger_header_type_t type);
|
|
bool jerry_debugger_send_configuration (uint8_t max_message_size);
|
|
void jerry_debugger_send_data (jerry_debugger_header_type_t type, const void *data, size_t size);
|
|
bool jerry_debugger_send_string (uint8_t message_type, const uint8_t *string_p, size_t string_length);
|
|
bool jerry_debugger_send_function_cp (jerry_debugger_header_type_t type, ecma_compiled_code_t *compiled_code_p);
|
|
bool jerry_debugger_send_parse_function (uint32_t line, uint32_t column);
|
|
void jerry_debugger_send_memstats (void);
|
|
bool jerry_debugger_send_exception_string (ecma_value_t exception_value);
|
|
|
|
#endif /* JERRY_DEBUGGER */
|
|
|
|
#endif /* DEBUGGER_H */
|