source: trunk/processor/head.m4 @ 878

dnl {{{ === program start ========================================
divert(0)
#include <string.h>
#include <stdio.h>

#include "php.h"
#include "zend_extensions.h"
#include "zend_compile.h"
#include "zend_API.h"
#include "zend_ini.h"

#include "xcache.h"
#include "align.h"
#include "const_string.h"
#include "processor.h"
#include "stack.h"
#include "xcache_globals.h"

#if defined(HARDENING_PATCH_HASH_PROTECT) && HARDENING_PATCH_HASH_PROTECT
extern unsigned int zend_hash_canary;
#endif

define(`SIZEOF_zend_uint', `sizeof(zend_uint)')
define(`COUNTOF_zend_uint', `1')
define(`SIZEOF_int', `sizeof(int)')
define(`COUNTOF_int', `1')
define(`SIZEOF_zend_function', `sizeof(zend_function)')
define(`COUNTOF_zend_function', `1')
define(`SIZEOF_zval_ptr', `sizeof(zval_ptr)')
define(`COUNTOF_zval_ptr', `1')
define(`SIZEOF_zval_ptr_nullable', `sizeof(zval_ptr_nullable)')
define(`COUNTOF_zval_ptr_nullable', `1')
define(`SIZEOF_zend_trait_alias_ptr', `sizeof(zend_trait_alias)')
define(`COUNTOF_zend_trait_alias_ptr', `1')
define(`SIZEOF_zend_trait_precedence_ptr', `sizeof(zend_trait_precedence)')
define(`COUNTOF_zend_trait_precedence_ptr', `1')
define(`SIZEOF_xc_entry_name_t', `sizeof(xc_entry_name_t)')
define(`COUNTOF_xc_entry_name_t', `1')
define(`SIZEOF_xc_ztstring', `sizeof(xc_ztstring)')
define(`COUNTOF_xc_ztstring', `1')

ifdef(`XCACHE_ENABLE_TEST', `
#undef NDEBUG
#include <assert.h>
m4_errprint(`AUTOCHECK INFO: runtime autocheck Enabled (debug build)')
', `
m4_errprint(`AUTOCHECK INFO: runtime autocheck Disabled (optimized build)')
')
ifdef(`DEBUG_SIZE', `static int xc_totalsize = 0;')

sinclude(builddir`/structinfo.m4')

#ifndef NDEBUG
#   undef inline
#define inline
#endif

typedef zval *zval_ptr;
typedef zval *zval_ptr_nullable;
typedef char *xc_ztstring;
#ifdef ZEND_ENGINE_2_4
typedef zend_trait_alias *zend_trait_alias_ptr;
typedef zend_trait_precedence *zend_trait_precedence_ptr;
#endif

typedef zend_uchar xc_zval_data_type;
typedef int xc_op_type;
typedef zend_uchar xc_opcode;
#ifdef IS_UNICODE
typedef UChar zstr_uchar;
#endif
typedef char  zstr_char;

#define MAX_DUP_STR_LEN 256
dnl }}}
/* export: typedef struct _xc_processor_t xc_processor_t; :export {{{ */
struct _xc_processor_t {
    char *p;
    zend_uint size;
    HashTable strings;
    HashTable zvalptrs;
    zend_bool reference; /* enable if to deal with reference */
    zend_bool have_references;
    const xc_entry_php_t *entry_php_src;
    const xc_entry_php_t *entry_php_dst;
    const xc_entry_data_php_t *php_src;
    const xc_entry_data_php_t *php_dst;
    const xc_cache_t          *cache;
    const zend_class_entry *cache_ce;
    zend_uint cache_class_index;

    const zend_op_array    *active_op_array_src;
    zend_op_array          *active_op_array_dst;
    const zend_class_entry *active_class_entry_src;
    zend_class_entry       *active_class_entry_dst;
    zend_uint                 active_class_index;
    zend_uint                 active_op_array_index;
    const xc_op_array_info_t *active_op_array_infos_src;

    zend_bool readonly_protection; /* wheather it's present */
IFAUTOCHECK(xc_stack_t allocsizes;)
};
/* }}} */
/* {{{ memsetptr */
IFAUTOCHECK(`dnl
static void *memsetptr(void *mem, void *content, size_t n)
{
    void **p = (void **) mem;
    void **end = (void **) ((char *) mem + n);
    while (p < end - sizeof(content)) {
        *p = content;
        p += sizeof(content);
    }
    if (p < end) {
        memset(p, -1, end - p);
    }
    return mem;
}
')
/* }}} */
#ifdef HAVE_XCACHE_DPRINT
static void xc_dprint_indent(int indent) /* {{{ */
{
    int i;
    for (i = 0; i < indent; i ++) {
        fprintf(stderr, "  ");
    }
}
/* }}} */
static void xc_dprint_str_len(const char *str, int len) /* {{{ */
{
    const unsigned char *p = (const unsigned char *) str;
    int i;
    for (i = 0; i < len; i ++) {
        if (p[i] < 32 || p[i] == 127) {
            fprintf(stderr, "\\%03o", (unsigned int) p[i]);
        }
        else {
            fputc(p[i], stderr);
        }
    }
}
/* }}} */
#endif
/* {{{ xc_zstrlen_char */
static inline int xc_zstrlen_char(const_zstr s)
{
    return strlen(ZSTR_S(s));
}
/* }}} */
#ifdef IS_UNICODE
/* {{{ xc_zstrlen_uchar */
static inline int xc_zstrlen_uchar(zstr s)
{
    return u_strlen(ZSTR_U(s));
}
/* }}} */
/* {{{ xc_zstrlen */
static inline int xc_zstrlen(int type, const_zstr s)
{
    return type == IS_UNICODE ? xc_zstrlen_uchar(s) : xc_zstrlen_char(s);
}
/* }}} */
#else
/* {{{ xc_zstrlen */
#define xc_zstrlen(dummy, s) xc_zstrlen_char(s)
/* }}} */
#endif
/* {{{ xc_calc_string_n */
REDEF(`PROCESSOR_TYPE', `calc')
#undef C_RELAYLINE
#define C_RELAYLINE
IFAUTOCHECK(`
#undef C_RELAYLINE
#define C_RELAYLINE , __LINE__
')
static inline void xc_calc_string_n(xc_processor_t *processor, zend_uchar type, const_zstr str, long size IFAUTOCHECK(`, int relayline')) {
    pushdef(`__LINE__', `relayline')
    int realsize = UNISW(size, (type == IS_UNICODE) ? UBYTES(size) : size);
    long dummy = 1;

    if (realsize > MAX_DUP_STR_LEN) {
        ALLOC(, char, realsize)
    }
    else if (zend_u_hash_add(&processor->strings, type, str, size, (void *) &dummy, sizeof(dummy), NULL) == SUCCESS) {
        /* new string */
        ALLOC(, char, realsize)
    } 
    IFAUTOCHECK(`
        else {
            dnl fprintf(stderr, "dupstr %s\n", ZSTR_S(str));
        }
    ')
    popdef(`__LINE__')
}
/* }}} */
/* {{{ xc_store_string_n */
REDEF(`PROCESSOR_TYPE', `store')
static inline zstr xc_store_string_n(xc_processor_t *processor, zend_uchar type, const_zstr str, long size IFAUTOCHECK(`, int relayline')) {
    pushdef(`__LINE__', `relayline')
    int realsize = UNISW(size, (type == IS_UNICODE) ? UBYTES(size) : size);
    zstr ret, *pret;

    if (realsize > MAX_DUP_STR_LEN) {
        ALLOC(ZSTR_V(ret), char, realsize)
        memcpy(ZSTR_V(ret), ZSTR_V(str), realsize);
        return ret;
    }

    if (zend_u_hash_find(&processor->strings, type, str, size, (void **) &pret) == SUCCESS) {
        return *pret;
    }

    /* new string */
    ALLOC(ZSTR_V(ret), char, realsize)
    memcpy(ZSTR_V(ret), ZSTR_V(str), realsize);
    zend_u_hash_add(&processor->strings, type, str, size, (void *) &ret, sizeof(zstr), NULL);
    return ret;

    popdef(`__LINE__')
}
/* }}} */
/* {{{ xc_get_class_num
 * return class_index + 1
 */
static zend_ulong xc_get_class_num(xc_processor_t *processor, zend_class_entry *ce) {
    zend_ulong i;
    const xc_entry_data_php_t *php = processor->php_src;
    zend_class_entry *ceptr;

    if (processor->cache_ce == ce) {
        return processor->cache_class_index + 1;
    }
    for (i = 0; i < php->classinfo_cnt; i ++) {
        ceptr = CestToCePtr(php->classinfos[i].cest);
        if (ZCEP_REFCOUNT_PTR(ceptr) == ZCEP_REFCOUNT_PTR(ce)) {
            processor->cache_ce = ceptr;
            processor->cache_class_index = i;
            return i + 1;
        }
    }
    assert(0);
    return (zend_ulong) -1;
}
define(`xc_get_class_num', `xc_get_class_numNOTDEFINED')
/* }}} */
/* {{{ xc_get_class */
#ifdef ZEND_ENGINE_2
static zend_class_entry *xc_get_class(xc_processor_t *processor, zend_ulong class_num) {
    /* must be parent or currrent class */
    assert(class_num <= processor->active_class_index + 1);
    return CestToCePtr(processor->php_dst->classinfos[class_num - 1].cest);
}
#endif
define(`xc_get_class', `xc_get_classNOTDEFINED')
/* }}} */
#ifdef ZEND_ENGINE_2
/* fix method on store */
static void xc_fix_method(xc_processor_t *processor, zend_op_array *dst TSRMLS_DC) /* {{{ */
{
    zend_function *zf = (zend_function *) dst;
    zend_class_entry *ce = processor->active_class_entry_dst;
    const zend_class_entry *srcce = processor->active_class_entry_src;

    /* Fixing up the default functions for objects here since
     * we need to compare with the newly allocated functions
     *
     * caveat: a sub-class method can have the same name as the
     * parent~s constructor and create problems.
     */

    if (zf->common.fn_flags & ZEND_ACC_CTOR) {
        if (!ce->constructor) {
            ce->constructor = zf;
        }
    }
    else if (zf->common.fn_flags & ZEND_ACC_DTOR) {
        ce->destructor = zf;
    }
    else if (zf->common.fn_flags & ZEND_ACC_CLONE) {
        ce->clone = zf;
    }
    else {
    pushdef(`SET_IF_SAME_NAMEs', `
        SET_IF_SAME_NAME(__get);
        SET_IF_SAME_NAME(__set);
#ifdef ZEND_ENGINE_2_1
        SET_IF_SAME_NAME(__unset);
        SET_IF_SAME_NAME(__isset);
#endif
        SET_IF_SAME_NAME(__call);
#ifdef ZEND_CALLSTATIC_FUNC_NAME
        SET_IF_SAME_NAME(__callstatic);
#endif
#if defined(ZEND_ENGINE_2_2) || PHP_MAJOR_VERSION >= 6
        SET_IF_SAME_NAME(__tostring);
#endif
    ')
#ifdef IS_UNICODE
        if (UG(unicode)) {
#define SET_IF_SAME_NAME(member) \
            do { \
                if (srcce->member && u_strcmp(ZSTR_U(zf->common.function_name), ZSTR_U(srcce->member->common.function_name)) == 0) { \
                    ce->member = zf; \
                } \
            } \
            while(0)

            SET_IF_SAME_NAMEs()
#undef SET_IF_SAME_NAME
        }
        else
#endif
        do {
#define SET_IF_SAME_NAME(member) \
            do { \
                if (srcce->member && strcmp(ZSTR_S(zf->common.function_name), ZSTR_S(srcce->member->common.function_name)) == 0) { \
                    ce->member = zf; \
                } \
            } \
            while(0)

            SET_IF_SAME_NAMEs()
#undef SET_IF_SAME_NAME
        } while (0);

    popdef(`SET_IF_SAME_NAMEs')

    }
}
/* }}} */
#endif
/* {{{ call op_array ctor handler */
extern zend_bool xc_have_op_array_ctor;
static void xc_zend_extension_op_array_ctor_handler(zend_extension *extension, zend_op_array *op_array TSRMLS_DC)
{
    if (extension->op_array_ctor) {
        extension->op_array_ctor(op_array);
    }
}
/* }}} */
/* {{{ field name checker */
IFAUTOCHECK(`dnl
static int xc_check_names(const char *file, int line, const char *functionName, const char **assert_names, int assert_names_count, HashTable *done_names)
{
    int errors = 0;
    if (assert_names_count) {
        int i;
        Bucket *b;

        for (i = 0; i < assert_names_count; ++i) {
            if (!zend_u_hash_exists(done_names, IS_STRING, assert_names[i], strlen(assert_names[i]) + 1)) {
                fprintf(stderr
                    , "missing field at %s `#'%d %s`' : %s\n"
                    , file, line, functionName
                    , assert_names[i]
                    );
                ++errors;
            }
        }

        for (b = done_names->pListHead; b != NULL; b = b->pListNext) {
            int known = 0;
            int i;
            for (i = 0; i < assert_names_count; ++i) {
                if (strcmp(assert_names[i], BUCKET_KEY_S(b)) == 0) {
                    known = 1;
                    break;
                }
            }
            if (!known) {
                fprintf(stderr
                    , "unknown field at %s `#'%d %s`' : %s\n"
                    , file, line, functionName
                    , BUCKET_KEY_S(b)
                    );
                ++errors;
            }
        }
    }
    return errors;
}
')
/* }}} */
dnl ================ export API
define(`DEFINE_STORE_API', `
/* export: $1 *xc_processor_store_$1(xc_cache_t *cache, $1 *src TSRMLS_DC); :export {{{ */
$1 *xc_processor_store_$1(xc_cache_t *cache, $1 *src TSRMLS_DC) {
    $1 *dst;
    xc_processor_t processor;

    memset(&processor, 0, sizeof(processor));
    processor.reference = 1;
    processor.cache = cache;

    IFAUTOCHECK(`xc_stack_init(&processor.allocsizes);')

    /* calc size */ {
        zend_hash_init(&processor.strings, 0, NULL, NULL, 0);
        if (processor.reference) {
            zend_hash_init(&processor.zvalptrs, 0, NULL, NULL, 0);
        }

        processor.size = 0;
        /* allocate */
        processor.size = ALIGN(processor.size + sizeof(src[0]));

        xc_calc_$1(&processor, src TSRMLS_CC);
        if (processor.reference) {
            zend_hash_destroy(&processor.zvalptrs);
        }
        zend_hash_destroy(&processor.strings);
    }
    src->ifelse(
        `$1', `xc_entry_data_php_t', `',
        `', `', entry.)size = processor.size;
    ifelse(
        `$1', `xc_entry_var_t', `src->have_references = processor.have_references;',
        `$1', `xc_entry_data_php_t', `src->have_references = processor.have_references;'
    )

    IFAUTOCHECK(`xc_stack_reverse(&processor.allocsizes);')
    /* store {{{ */
    {
        IFAUTOCHECK(`char *oldp;')
        zend_hash_init(&processor.strings, 0, NULL, NULL, 0);
        if (processor.reference) {
            zend_hash_init(&processor.zvalptrs, 0, NULL, NULL, 0);
        }

        /* mem :) */
        processor.p = (char *) processor.cache->mem->handlers->malloc(processor.cache->mem, processor.size);
        if (processor.p == NULL) {
            dst = NULL;
            goto err_alloc;
        }
        IFAUTOCHECK(`oldp = processor.p;')
        assert(processor.p == (char *) ALIGN(processor.p));

        /* allocate */
        dst = ($1 *) processor.p;
        processor.p = (char *) ALIGN(processor.p + sizeof(dst[0]));

        xc_store_$1(&processor, dst, src TSRMLS_CC);
        IFAUTOCHECK(` {
            int real = processor.p - oldp;
            int should = processor.size;
            if (real != processor.size) {
                fprintf(stderr, "real %d - should %d = %d\n", real, should, real - should);
                abort();
            }
        }')
err_alloc:
        if (processor.reference) {
            zend_hash_destroy(&processor.zvalptrs);
        }
        zend_hash_destroy(&processor.strings);
    }
    /* }}} */

    IFAUTOCHECK(`xc_stack_destroy(&processor.allocsizes);')

    return dst;
}
/* }}} */
')
DEFINE_STORE_API(`xc_entry_var_t')
DEFINE_STORE_API(`xc_entry_php_t')
DEFINE_STORE_API(`xc_entry_data_php_t')
/* export: xc_entry_php_t *xc_processor_restore_xc_entry_php_t(xc_entry_php_t *dst, const xc_entry_php_t *src TSRMLS_DC); :export {{{ */
xc_entry_php_t *xc_processor_restore_xc_entry_php_t(xc_entry_php_t *dst, const xc_entry_php_t *src TSRMLS_DC) {
    xc_processor_t processor;

    memset(&processor, 0, sizeof(processor));
    xc_restore_xc_entry_php_t(&processor, dst, src TSRMLS_CC);

    return dst;
}
/* }}} */
/* export: xc_entry_data_php_t *xc_processor_restore_xc_entry_data_php_t(const xc_entry_php_t *entry_php, xc_entry_data_php_t *dst, const xc_entry_data_php_t *src, zend_bool readonly_protection TSRMLS_DC); :export {{{ */
xc_entry_data_php_t *xc_processor_restore_xc_entry_data_php_t(const xc_entry_php_t *entry_php, xc_entry_data_php_t *dst, const xc_entry_data_php_t *src, zend_bool readonly_protection TSRMLS_DC) {
    xc_processor_t processor;

    memset(&processor, 0, sizeof(processor));
    processor.readonly_protection = readonly_protection;
    /* this function is used for php data only */
    if (src->have_references) {
        processor.reference = 1;
    }
    processor.entry_php_src = entry_php;

    if (processor.reference) {
        zend_hash_init(&processor.zvalptrs, 0, NULL, NULL, 0);
    }
    xc_restore_xc_entry_data_php_t(&processor, dst, src TSRMLS_CC);
    if (processor.reference) {
        zend_hash_destroy(&processor.zvalptrs);
    }
    return dst;
}
/* }}} */
/* export: xc_entry_var_t *xc_processor_restore_xc_entry_var_t(xc_entry_var_t *dst, const xc_entry_var_t *src TSRMLS_DC); :export {{{ */
xc_entry_var_t *xc_processor_restore_xc_entry_var_t(xc_entry_var_t *dst, const xc_entry_var_t *src TSRMLS_DC) {
    xc_processor_t processor;

    memset(&processor, 0, sizeof(processor));
    xc_restore_xc_entry_var_t(&processor, dst, src TSRMLS_CC);

    return dst;
}
/* }}} */
/* export: zval *xc_processor_restore_zval(zval *dst, const zval *src, zend_bool have_references TSRMLS_DC); :export {{{ */
zval *xc_processor_restore_zval(zval *dst, const zval *src, zend_bool have_references TSRMLS_DC) {
    xc_processor_t processor;

    memset(&processor, 0, sizeof(processor));
    processor.reference = have_references;

    if (processor.reference) {
        zend_hash_init(&processor.zvalptrs, 0, NULL, NULL, 0);
        dnl fprintf(stderr, "mark[%p] = %p\n", src, dst);
        zend_hash_add(&processor.zvalptrs, (char *)src, sizeof(src), (void*)&dst, sizeof(dst), NULL);
    }
    xc_restore_zval(&processor, dst, src TSRMLS_CC);
    if (processor.reference) {
        zend_hash_destroy(&processor.zvalptrs);
    }

    return dst;
}
/* }}} */
/* export: void xc_dprint(xc_entry_php_t *src, int indent TSRMLS_DC); :export {{{ */
#ifdef HAVE_XCACHE_DPRINT
void xc_dprint(xc_entry_php_t *src, int indent TSRMLS_DC) {
    IFDPRINT(`INDENT()`'fprintf(stderr, "xc_entry_php_t:src");')
    xc_dprint_xc_entry_php_t(src, indent TSRMLS_CC);
}
#endif
/* }}} */