phpdbg.h

/*
 +----------------------------------------------------------------------+
 | Copyright (c) The PHP Group |
 +----------------------------------------------------------------------+
 | This source file is subject to version 3.01 of the PHP license, |
 | that is bundled with this package in the file LICENSE, and is |
 | available through the world-wide-web at the following url: |
 | https://www.php.net/license/3_01.txt |
 | If you did not receive a copy of the PHP license and are unable to |
 | obtain it through the world-wide-web, please send a note to |
 | license@php.net so we can mail you a copy immediately. |
 +----------------------------------------------------------------------+
 | Authors: Felipe Pena <felipe@php.net> |
 | Authors: Joe Watkins <joe.watkins@live.co.uk> |
 | Authors: Bob Weinand <bwoebi@php.net> |
 +----------------------------------------------------------------------+
*/

#ifndefPHPDBG_H
#definePHPDBG_H

#ifdefPHP_WIN32
# definePHPDBG_API __declspec(dllexport)
#elif defined(__GNUC__) &&__GNUC__ >= 4
# definePHPDBG_API __attribute__ ((visibility("default")))
#else
# definePHPDBG_API
#endif

#include<stdint.h>
#include<stddef.h>
#include"php.h"
#include"php_globals.h"
#include"php_variables.h"
#include"php_getopt.h"
#include"zend_builtin_functions.h"
#include"zend_extensions.h"
#include"zend_modules.h"
#include"zend_globals.h"
#include"zend_ini_scanner.h"
#include"zend_stream.h"
#include"zend_signal.h"
#if !defined(_WIN32) && !defined(ZEND_SIGNALS)
# include<signal.h>
#elif defined(PHP_WIN32)
# include"win32/signal.h"
#endif
#include"SAPI.h"
#include<fcntl.h>
#include<sys/types.h>
#if defined(_WIN32) && !defined(__MINGW32__)
# include<windows.h>
# include"config.w32.h"
# undef strcasecmp
# undef strncasecmp
# definestrcasecmp _stricmp
# definestrncasecmp _strnicmp
#else
# include<php_config.h>
#endif
#ifndefO_BINARY
# defineO_BINARY 0
#endif
#include"php_main.h"

#ifdefZTS
# include"TSRM.h"
#endif

#undef zend_hash_str_add
#ifdefPHP_WIN32
#definezend_hash_str_add(...) \
 zend_hash_str_add(__VA_ARGS__)
#else
#definezend_hash_str_add_tmp(ht, key, len, pData) \
 zend_hash_str_add(ht, key, len, pData)
#definezend_hash_str_add(...) zend_hash_str_add_tmp(__VA_ARGS__)
#endif

#ifdefHAVE_PHPDBG_READLINE
# ifdefHAVE_LIBREADLINE
# include<readline/readline.h>
# include<readline/history.h>
# endif
# ifdefHAVE_LIBEDIT
# include<editline/readline.h>
# endif
#endif

/* {{{ strings */
#definePHPDBG_NAME "phpdbg"
#definePHPDBG_AUTHORS "Felipe Pena, Joe Watkins and Bob Weinand" /* Ordered by last name */
#definePHPDBG_ISSUES "https://github.com/php/php-src/issues"
#definePHPDBG_VERSION PHP_VERSION
#definePHPDBG_INIT_FILENAME ".phpdbginit"
#definePHPDBG_DEFAULT_PROMPT "prompt>"
/* }}} */

#ifdefZTS
# definePHPDBG_G(v) ZEND_TSRMG(phpdbg_globals_id, zend_phpdbg_globals *, v)
#else
# definePHPDBG_G(v) (phpdbg_globals.v)
#endif

#include"phpdbg_sigsafe.h"
#include"phpdbg_out.h"
#include"phpdbg_lexer.h"
#include"phpdbg_cmd.h"
#include"phpdbg_utils.h"
#include"phpdbg_btree.h"
#include"phpdbg_watch.h"
#include"phpdbg_bp.h"

intphpdbg_do_parse(phpdbg_param_t*stack, char*input);

#definePHPDBG_NEXT 2
#definePHPDBG_UNTIL 3
#definePHPDBG_FINISH 4
#definePHPDBG_LEAVE 5

/*
 BEGIN: DO NOT CHANGE DO NOT CHANGE DO NOT CHANGE
*/

/* {{{ flags */
#definePHPDBG_HAS_FILE_BP (1ULL<<1)
#definePHPDBG_HAS_PENDING_FILE_BP (1ULL<<2)
#definePHPDBG_HAS_SYM_BP (1ULL<<3)
#definePHPDBG_HAS_OPLINE_BP (1ULL<<4)
#definePHPDBG_HAS_METHOD_BP (1ULL<<5)
#definePHPDBG_HAS_COND_BP (1ULL<<6)
#definePHPDBG_HAS_OPCODE_BP (1ULL<<7)
#definePHPDBG_HAS_FUNCTION_OPLINE_BP (1ULL<<8)
#definePHPDBG_HAS_METHOD_OPLINE_BP (1ULL<<9)
#definePHPDBG_HAS_FILE_OPLINE_BP (1ULL<<10) /* }}} */

/*
 END: DO NOT CHANGE DO NOT CHANGE DO NOT CHANGE
*/

#definePHPDBG_IN_COND_BP (1ULL<<11)
#definePHPDBG_IN_EVAL (1ULL<<12)

#definePHPDBG_IS_STEPPING (1ULL<<13)
#definePHPDBG_STEP_OPCODE (1ULL<<14)
#definePHPDBG_IS_QUIET (1ULL<<15)
#definePHPDBG_IS_QUITTING (1ULL<<16)
#definePHPDBG_IS_COLOURED (1ULL<<17)
#definePHPDBG_IS_CLEANING (1ULL<<18)
#definePHPDBG_IS_RUNNING (1ULL<<19)

#definePHPDBG_IN_UNTIL (1ULL<<20)
#definePHPDBG_IN_FINISH (1ULL<<21)
#definePHPDBG_IN_LEAVE (1ULL<<22)

#definePHPDBG_IS_REGISTERED (1ULL<<23)
#definePHPDBG_IS_STEPONEVAL (1ULL<<24)
#definePHPDBG_IS_INITIALIZING (1ULL<<25)
#definePHPDBG_IS_SIGNALED (1ULL<<26)
#definePHPDBG_IS_INTERACTIVE (1ULL<<27)
#definePHPDBG_PREVENT_INTERACTIVE (1ULL<<28)
#definePHPDBG_IS_BP_ENABLED (1ULL<<29)
#definePHPDBG_SHOW_REFCOUNTS (1ULL<<30)
#definePHPDBG_IN_SIGNAL_HANDLER (1ULL<<31)
#definePHPDBG_DISCARD_OUTPUT (1ULL<<32)
#definePHPDBG_HAS_PAGINATION (1ULL<<33)

#definePHPDBG_SEEK_MASK (PHPDBG_IN_UNTIL | PHPDBG_IN_FINISH | PHPDBG_IN_LEAVE)
#definePHPDBG_BP_RESOLVE_MASK (PHPDBG_HAS_FUNCTION_OPLINE_BP | PHPDBG_HAS_METHOD_OPLINE_BP | PHPDBG_HAS_FILE_OPLINE_BP)
#definePHPDBG_BP_MASK (PHPDBG_HAS_FILE_BP | PHPDBG_HAS_SYM_BP | PHPDBG_HAS_METHOD_BP | PHPDBG_HAS_OPLINE_BP | PHPDBG_HAS_COND_BP | PHPDBG_HAS_OPCODE_BP | PHPDBG_HAS_FUNCTION_OPLINE_BP | PHPDBG_HAS_METHOD_OPLINE_BP | PHPDBG_HAS_FILE_OPLINE_BP)
#definePHPDBG_IS_STOPPING (PHPDBG_IS_QUITTING | PHPDBG_IS_CLEANING)

#definePHPDBG_PRESERVE_FLAGS_MASK \
 (PHPDBG_SHOW_REFCOUNTS | \
 PHPDBG_IS_STEPONEVAL | \
 PHPDBG_IS_BP_ENABLED | \
 PHPDBG_STEP_OPCODE | \
 PHPDBG_IS_QUIET | \
 PHPDBG_IS_COLOURED | \
 PHPDBG_HAS_PAGINATION)

#ifndef_WIN32
# definePHPDBG_DEFAULT_FLAGS (PHPDBG_IS_QUIET | PHPDBG_IS_COLOURED | PHPDBG_IS_BP_ENABLED | PHPDBG_HAS_PAGINATION)
#else
# definePHPDBG_DEFAULT_FLAGS (PHPDBG_IS_QUIET | PHPDBG_IS_BP_ENABLED | PHPDBG_HAS_PAGINATION)
#endif/* }}} */

/* {{{ output descriptors */
#definePHPDBG_STDIN 0
#definePHPDBG_STDOUT 1
#definePHPDBG_STDERR 2
#definePHPDBG_IO_FDS 3 /* }}} */

#definephpdbg_try_access \
 { \
 ZEND_DIAGNOSTIC_IGNORED_START("-Wshadow") \
 JMP_BUF *__orig_bailout = PHPDBG_G(sigsegv_bailout); \
 JMP_BUF __bailout; \
 ZEND_DIAGNOSTIC_IGNORED_END \
 \
 PHPDBG_G(sigsegv_bailout) = &__bailout; \
 if (SETJMP(__bailout) == 0) {
#definephpdbg_catch_access \
 } else { \
 PHPDBG_G(sigsegv_bailout) = __orig_bailout;
#definephpdbg_end_try_access() \
 } \
 PHPDBG_G(sigsegv_bailout) = __orig_bailout; \
 }


voidphpdbg_register_file_handles(void);

typedefstruct_phpdbg_oplog_entryphpdbg_oplog_entry;
struct_phpdbg_oplog_entry {
phpdbg_oplog_entry*next;
zend_string*function_name;
zend_class_entry*scope;
zend_string*filename;
zend_op*opcodes;
zend_op*op;
};

typedefstruct_phpdbg_oplog_listphpdbg_oplog_list;
struct_phpdbg_oplog_list {
phpdbg_oplog_list*prev;
phpdbg_oplog_entrystart; /* Only "next" member used. */
};


/* {{{ structs */
ZEND_BEGIN_MODULE_GLOBALS(phpdbg)
HashTablebp[PHPDBG_BREAK_TABLES]; /* break points */
HashTableregistered; /* registered */
HashTableseek; /* seek oplines */
zend_execute_data*seek_ex; /* call frame of oplines to seek to */
zend_object*handled_exception; /* last handled exception (prevent multiple handling of same exception) */
phpdbg_frame_tframe; /* frame */
uint32_tlast_line; /* last executed line */

char*cur_command; /* current command */
phpdbg_lexer_datalexer; /* lexer data */
phpdbg_param_t*parser_stack; /* param stack during lexer / parser phase */

#ifndef_WIN32
structsigactionold_sigsegv_signal; /* segv signal handler */
#endif
#ifdefHAVE_USERFAULTFD_WRITEFAULT
intwatch_userfaultfd; /* userfaultfd(2) handler, 0 if unused */
pthread_twatch_userfault_thread; /* thread for watch fault handling */
#endif
phpdbg_btreewatchpoint_tree; /* tree with watchpoints */
phpdbg_btreewatch_HashTables; /* tree with original dtors of watchpoints */
HashTablewatch_elements; /* user defined watch elements */
HashTablewatch_collisions; /* collision table to check if multiple watches share the same recursive watchpoint */
HashTablewatch_recreation; /* watch elements pending recreation of their respective watchpoints */
HashTablewatch_free; /* pointers to watch for being freed */
HashTable*watchlist_mem; /* triggered watchpoints */
HashTable*original_watchlist_mem; /* the original allocation for watchlist_mem, used when watchlist_mem has changed temporarily */
HashTable*watchlist_mem_backup; /* triggered watchpoints backup table while iterating over it */
boolwatchpoint_hit; /* a watchpoint was hit */
void (*original_free_function)(void*ZEND_FILE_LINE_DCZEND_FILE_LINE_ORIG_DC); /* the original AG(mm_heap)->_free function */
phpdbg_watch_element*watch_tmp; /* temporary pointer for a watch element */

char*exec; /* file to execute */
size_texec_len; /* size of exec */
zend_op_array*ops; /* op_array */
zvalretval; /* return value */
intbp_count; /* breakpoint count */
intvmret; /* return from last opcode handler execution */
boolin_execution; /* in execution? */
boolunclean_eval; /* do not check for memory leaks when we needed to bail out during eval */

zend_op_array*(*compile_file)(zend_file_handle*file_handle, inttype);
zend_op_array*(*init_compile_file)(zend_file_handle*file_handle, inttype);
zend_op_array*(*compile_string)(zend_string*source_string, constchar*filename, zend_compile_positionposition);
HashTablefile_sources;

zend_arena*oplog_arena; /* arena for storing oplog */
phpdbg_oplog_list*oplog_list; /* list of oplog starts */
phpdbg_oplog_entry*oplog_cur; /* current oplog entry */

struct {
intfd;
 } io[PHPDBG_IO_FDS]; /* io */
ssize_t (*php_stdiop_write)(php_stream*, constchar*, size_t);
struct {
boolactive;
inttype;
intfd;
char*msg;
intmsglen;
 } err_buf; /* error buffer */
zend_ulongreq_id; /* "request id" to keep track of commands */

char*prompt[2]; /* prompt */
constphpdbg_color_t*colors[PHPDBG_COLORS]; /* colors */
char*buffer; /* buffer */
boollast_was_newline; /* check if we don't need to output a newline upon next phpdbg_error or phpdbg_notice */

FILE*stdin_file; /* FILE pointer to stdin source file */
constphp_stream_wrapper*orig_url_wrap_php;

charinput_buffer[PHPDBG_MAX_CMD]; /* stdin input buffer */
intinput_buflen; /* length of stdin input buffer */
phpdbg_signal_safe_memsigsafe_mem; /* memory to use in async safe environment (only once!) */

JMP_BUF*sigsegv_bailout; /* bailout address for accessibility probing */

uint64_tflags; /* phpdbg flags */

char*sapi_name_ptr; /* store sapi name to free it if necessary to not leak memory */
zend_ulonglines; /* max number of lines to display */
ZEND_END_MODULE_GLOBALS(phpdbg) /* }}} */

#endif/* PHPDBG_H */