php-src/phpdbg_print.c

/*
   +----------------------------------------------------------------------+
   | PHP Version 5                                                        |
   +----------------------------------------------------------------------+
   | Copyright (c) 1997-2013 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:           |
   | http://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>                        |
   +----------------------------------------------------------------------+
*/

#include "phpdbg.h"
#include "phpdbg_print.h"
#include "phpdbg_utils.h"
#include "phpdbg_opcode.h"

ZEND_EXTERN_MODULE_GLOBALS(phpdbg);

PHPDBG_PRINT(opline) /* {{{ */
{
	if (EG(in_execution) && EG(current_execute_data)) {
	    phpdbg_print_opline(
	        EG(current_execute_data), 1 TSRMLS_CC);
	} else {
		phpdbg_error("Not Executing!");
	}

	return SUCCESS;
} /* }}} */

static inline void phpdbg_print_function_helper(zend_function *method TSRMLS_DC) {
    switch (method->type) {
        case ZEND_USER_FUNCTION: {
            zend_op_array* op_array = &method->op_array;

            if (op_array) {
                zend_op     *opline = &op_array->opcodes[0];
                zend_uint   opcode = 0,
                            end =  op_array->last-1;

                if (method->common.scope) {
                    phpdbg_writeln(
                        "\t#%d-%d %s::%s() %s",
                        op_array->line_start, op_array->line_end,
                        method->common.scope->name, 
                        method->common.function_name,
                        op_array->filename ? op_array->filename : "unknown");
                } else {
                    phpdbg_writeln(
                        "\t#%d-%d %s() %s",
                        op_array->line_start, op_array->line_end,
                        method->common.function_name,
                        op_array->filename ? op_array->filename : "unknown");
                }
                
                
                do {
                    const char *decode = phpdbg_decode_opcode(opline->opcode);
                    if (decode != NULL) {
                        phpdbg_writeln(
                            "\t\t#%lu\t%p %s", opline->lineno, opline, decode); 
                    } else phpdbg_error("\tFailed to decode opline @ %ld", opline);
                    
                    opline++;
                } while (++opcode < end);
            }
        } break;
        
        default: {
            if (method->common.scope) {
                phpdbg_writeln(
                    "\tInternal %s::%s()", method->common.scope->name, method->common.function_name);
            } else {
                phpdbg_writeln(
                    "\tInternal %s()", method->common.function_name);
            }
        }
     }
}

PHPDBG_PRINT(class) /* {{{ */
{
    zend_class_entry **ce;
    
	if (param->type == STR_PARAM) {
	    if (zend_lookup_class(param->str, param->len, &ce TSRMLS_CC) == SUCCESS) {
	        phpdbg_notice(
	            "%s %s: %s", 
	            ((*ce)->type == ZEND_USER_CLASS) ? 
	                "User" : "Internal",
	            ((*ce)->ce_flags & ZEND_ACC_INTERFACE) ? 
	                "Interface" :
	                    ((*ce)->ce_flags & ZEND_ACC_ABSTRACT) ?
	                        "Abstract Class" :
	                            "Class", 
	            (*ce)->name);
	        
	        phpdbg_writeln("Methods (%d):", zend_hash_num_elements(&(*ce)->function_table));
	        if (zend_hash_num_elements(&(*ce)->function_table)) {
	            HashPosition position;
	            zend_function *method;
	            
	            for (zend_hash_internal_pointer_reset_ex(&(*ce)->function_table, &position);
	                 zend_hash_get_current_data_ex(&(*ce)->function_table, (void**) &method, &position) == SUCCESS;
	                 zend_hash_move_forward_ex(&(*ce)->function_table, &position)) {
	                 phpdbg_print_function_helper(method TSRMLS_CC);
	            }
	        }
	    } else {
	        phpdbg_error(
	            "Cannot find class %s", param->str);
	        return FAILURE;
	    }
	} else {
		phpdbg_error(
		    "Unsupported parameter type (%s) for command", phpdbg_get_param_type(param TSRMLS_CC));
		return FAILURE;
	}

	return SUCCESS;
} /* }}} */

PHPDBG_PRINT(method) /* {{{ */
{
    int result = SUCCESS;
    
    if (param->type == METHOD_PARAM) {
        zend_class_entry **ce;
        
        if (zend_lookup_class(param->method.class, strlen(param->method.class), &ce TSRMLS_CC) == SUCCESS) {
            zend_function *fbc;
            char *lcname = zend_str_tolower_dup(param->method.name, strlen(param->method.name));

            if (zend_hash_find(&(*ce)->function_table, lcname, strlen(lcname)+1, (void**)&fbc) == SUCCESS) {
                phpdbg_notice(
                    "%s Method %s", 
                    (fbc->type == ZEND_USER_FUNCTION) ? "User" : "Internal", 
                    fbc->common.function_name);
                    
		        phpdbg_print_function_helper(fbc TSRMLS_CC);
            } else {
                phpdbg_error(
                    "The method %s could not be found", param->method.name);
                result = FAILURE;
            }
            
            efree(lcname);
        } else {
            phpdbg_error(
                "Failed to find the requested class %s", param->method.class);
            result = FAILURE;
        }
    } else {
        phpdbg_error(
            "Unsupported parameter type (%s) for command", phpdbg_get_param_type(param TSRMLS_CC));
        result = FAILURE;
    }
    
    return result;
} /* }}} */

PHPDBG_PRINT(func) /* {{{ */
{
    int result = SUCCESS;
    
    if (param->type == STR_PARAM) {
        HashTable *func_table = EG(function_table);
		zend_function* fbc;
        const char *func_name = param->str;
        size_t func_name_len = param->len;
        char *lcname; 
        /* search active scope if begins with period */
        if (func_name[0] == '.') {
           if (EG(scope)) {
               func_name++;
               func_name_len--;

               func_table = &EG(scope)->function_table;
           } else {
               phpdbg_error("No active class");
               return FAILURE;
           }
        } else if (!EG(function_table)) {
			phpdbg_error(
			    "No function table loaded");
			return FAILURE;
		} else {
		    func_table = EG(function_table);
		}
		
        lcname  = zend_str_tolower_dup(func_name, func_name_len);
        
		if (zend_hash_find(func_table, lcname, strlen(lcname)+1, (void**)&fbc) == SUCCESS) {
		    phpdbg_notice(
	            "%s %s %s",
	            (fbc->type == ZEND_USER_FUNCTION) ? "User" : "Internal", 
	            (fbc->common.scope) ? "Method" : "Function",
	            fbc->common.function_name);
	            
			phpdbg_print_function_helper(fbc TSRMLS_CC);
		} else {
			phpdbg_error(
			    "Function %s not found", func_name);
			result = FAILURE;
		}
		
		efree(lcname);
		
    } else {
        phpdbg_error(
            "Unsupported parameter type (%s) for command", phpdbg_get_param_type(param TSRMLS_CC));
        result = FAILURE;
    }

    return result;
} /* }}} */