phpdbg_watch.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_WATCH_H
#definePHPDBG_WATCH_H

#include"phpdbg_cmd.h"

#ifdef_WIN32
# include"phpdbg_win.h"
#endif

#definePHPDBG_WATCH(name) PHPDBG_COMMAND(watch_##name)

/**
 * Printer Forward Declarations
 */
PHPDBG_WATCH(array);
PHPDBG_WATCH(delete);
PHPDBG_WATCH(recursive);

externconstphpdbg_command_tphpdbg_watch_commands[];

/* Watchpoint functions/typedefs */

/* References are managed through their parent zval *, being a simple WATCH_ON_ZVAL and eventually WATCH_ON_REFCOUNTED */
typedefenum {
WATCH_ON_ZVAL,
WATCH_ON_HASHTABLE,
WATCH_ON_REFCOUNTED,
WATCH_ON_STR,
WATCH_ON_HASHDATA,
WATCH_ON_BUCKET,
} phpdbg_watchtype;


#definePHPDBG_WATCH_SIMPLE 0x01
#definePHPDBG_WATCH_RECURSIVE 0x02
#definePHPDBG_WATCH_ARRAY 0x04
#definePHPDBG_WATCH_OBJECT 0x08
#definePHPDBG_WATCH_NORMAL (PHPDBG_WATCH_SIMPLE | PHPDBG_WATCH_RECURSIVE)
#definePHPDBG_WATCH_IMPLICIT 0x10
#definePHPDBG_WATCH_RECURSIVE_ROOT 0x20

typedefstruct_phpdbg_watch_collisionphpdbg_watch_collision;

typedefstruct_phpdbg_watchpoint_t {
union {
zval*zv;
zend_refcounted*ref;
Bucket*bucket;
void*ptr;
 } addr;
size_tsize;
phpdbg_watchtypetype;
zend_refcounted*ref; /* key to fetch the collision on parents */
HashTableelements;
phpdbg_watch_collision*coll; /* only present on *children* */
union {
zvalzv;
Bucketbucket;
zend_refcountedref;
HashTableht;
zend_string*str;
 } backup;
} phpdbg_watchpoint_t;

struct_phpdbg_watch_collision {
phpdbg_watchpoint_tref;
phpdbg_watchpoint_treference;
HashTableparents;
};

typedefstruct_phpdbg_watch_element {
uint32_tid;
phpdbg_watchpoint_t*watch;
charflags;
struct_phpdbg_watch_element*child; /* always set for implicit watches */
struct_phpdbg_watch_element*parent;
HashTablechild_container; /* children of this watch element for recursive array elements */
HashTable*parent_container; /* container of the value */
zend_string*name_in_parent;
zend_string*str;
union {
zvalzv;
zend_refcountedref;
HashTableht;
 } backup; /* backup for when watchpoint gets dissociated */
} phpdbg_watch_element;

typedefstruct {
/* to watch rehashes (yes, this is not *perfect*, but good enough for everything in PHP...) */
phpdbg_watchpoint_thash_watch; /* must be first element */
HashTable*ht;
HashTablewatches; /* contains phpdbg_watch_element */
} phpdbg_watch_ht_info;

voidphpdbg_setup_watchpoints(void);
voidphpdbg_destroy_watchpoints(void);
voidphpdbg_purge_watchpoint_tree(void);

#ifndef_WIN32
intphpdbg_watchpoint_segfault_handler(siginfo_t*info, void*context);
#else
intphpdbg_watchpoint_segfault_handler(void*addr);
#endif

voidphpdbg_create_addr_watchpoint(void*addr, size_tsize, phpdbg_watchpoint_t*watch);
voidphpdbg_create_zval_watchpoint(zval*zv, phpdbg_watchpoint_t*watch);

intphpdbg_delete_var_watchpoint(char*input, size_tlen);
intphpdbg_create_var_watchpoint(char*input, size_tlen);

intphpdbg_print_changed_zvals(void);

voidphpdbg_list_watchpoints(void);

voidphpdbg_watch_efree(void*ptrZEND_FILE_LINE_DCZEND_FILE_LINE_ORIG_DC);


staticlongphpdbg_pagesize;

staticzend_always_inlinevoid*phpdbg_get_page_boundary(void*addr) {
return (void*) ((size_t) addr& ~(phpdbg_pagesize-1));
}

staticzend_always_inlinesize_tphpdbg_get_total_page_size(void*addr, size_tsize) {
return (size_t) phpdbg_get_page_boundary((void*) ((size_t) addr+size-1)) - (size_t) phpdbg_get_page_boundary(addr) +phpdbg_pagesize;
}

#endif