source: trunk/xcache.c @ 506

Last change on this file since 506 was 506, checked in by moo, 7 years ago

optimized function_table/class_table by caching hash value

  • Property svn:eol-style set to native
File size: 79.7 KB
Line 
1
2#if 0
3#define DEBUG
4#endif
5
6#if 0
7#define SHOW_DPRINT
8#endif
9
10/* {{{ macros */
11#include <stdlib.h>
12#include <stdio.h>
13#include <string.h>
14
15#include <signal.h>
16
17#include "php.h"
18#include "ext/standard/info.h"
19#include "ext/standard/md5.h"
20#include "ext/standard/php_math.h"
21#include "zend_extensions.h"
22#include "SAPI.h"
23
24#include "xcache.h"
25#include "optimizer.h"
26#include "coverager.h"
27#include "disassembler.h"
28#include "align.h"
29#include "stack.h"
30#include "xcache_globals.h"
31#include "processor.h"
32#include "const_string.h"
33#include "opcode_spec.h"
34#include "utils.h"
35
36#define VAR_ENTRY_EXPIRED(pentry) ((pentry)->ttl && XG(request_time) > pentry->ctime + (pentry)->ttl)
37#define CHECK(x, e) do { if ((x) == NULL) { zend_error(E_ERROR, "XCache: " e); goto err; } } while (0)
38#define LOCK(x) xc_lock(x->lck)
39#define UNLOCK(x) xc_unlock(x->lck)
40
41#define ENTER_LOCK_EX(x) \
42    xc_lock(x->lck); \
43    zend_try { \
44        do
45#define LEAVE_LOCK_EX(x) \
46        while (0); \
47    } zend_catch { \
48        catched = 1; \
49    } zend_end_try(); \
50    xc_unlock(x->lck)
51
52#define ENTER_LOCK(x) do { \
53    int catched = 0; \
54    ENTER_LOCK_EX(x)
55#define LEAVE_LOCK(x) \
56    LEAVE_LOCK_EX(x); \
57    if (catched) { \
58        zend_bailout(); \
59    } \
60} while(0)
61
62/* }}} */
63
64/* {{{ globals */
65static char *xc_shm_scheme = NULL;
66static char *xc_mmap_path = NULL;
67static char *xc_coredump_dir = NULL;
68
69static xc_hash_t xc_php_hcache = {0};
70static xc_hash_t xc_php_hentry = {0};
71static xc_hash_t xc_var_hcache = {0};
72static xc_hash_t xc_var_hentry = {0};
73
74static zend_ulong xc_php_ttl    = 0;
75static zend_ulong xc_var_maxttl = 0;
76
77enum { xc_deletes_gc_interval = 120 };
78static zend_ulong xc_php_gc_interval = 0;
79static zend_ulong xc_var_gc_interval = 0;
80
81/* total size */
82static zend_ulong xc_php_size  = 0;
83static zend_ulong xc_var_size  = 0;
84
85static xc_cache_t **xc_php_caches = NULL;
86static xc_cache_t **xc_var_caches = NULL;
87
88static zend_bool xc_initized = 0;
89static zend_compile_file_t *origin_compile_file = NULL;
90static zend_compile_file_t *old_compile_file = NULL;
91static zend_llist_element  *xc_llist_zend_extension = NULL;
92
93static zend_bool xc_test = 0;
94static zend_bool xc_readonly_protection = 0;
95
96zend_bool xc_have_op_array_ctor = 0;
97
98static zend_bool xc_module_gotup = 0;
99static zend_bool xc_zend_extension_gotup = 0;
100static zend_bool xc_zend_extension_faked = 0;
101#if !COMPILE_DL_XCACHE
102#   define zend_extension_entry xcache_zend_extension_entry
103#endif
104ZEND_DLEXPORT zend_extension zend_extension_entry;
105ZEND_DECLARE_MODULE_GLOBALS(xcache);
106/* }}} */
107
108/* any function in *_dmz is only safe be called within locked(single thread) area */
109
110static void xc_php_add_dmz(xc_entry_data_php_t *php) /* {{{ */
111{
112    xc_entry_data_php_t **head = &(php->cache->phps[php->hvalue]);
113    php->next = *head;
114    *head = php;
115    php->cache->phps_count ++;
116}
117/* }}} */
118static xc_entry_data_php_t *xc_php_store_dmz(xc_entry_data_php_t *php TSRMLS_DC) /* {{{ */
119{
120    xc_entry_data_php_t *stored_php;
121
122    php->hits     = 0;
123    php->refcount = 0;
124    stored_php = xc_processor_store_xc_entry_data_php_t(php TSRMLS_CC);
125    if (stored_php) {
126        xc_php_add_dmz(stored_php);
127        return stored_php;
128    }
129    else {
130        php->cache->ooms ++;
131        return NULL;
132    }
133}
134/* }}} */
135static xc_entry_data_php_t *xc_php_find_dmz(xc_entry_data_php_t *php TSRMLS_DC) /* {{{ */
136{
137    xc_entry_data_php_t *p;
138    for (p = php->cache->phps[php->hvalue]; p; p = p->next) {
139        if (memcmp(php->md5, p->md5, sizeof(php->md5)) == 0) {
140            p->hits ++;
141            return p;
142        }
143    }
144    return NULL;
145}
146/* }}} */
147static void xc_php_free_dmz(xc_entry_data_php_t *php) /* {{{ */
148{
149    php->cache->mem->handlers->free(php->cache->mem, (xc_entry_data_php_t *)php);
150}
151/* }}} */
152static void xc_php_addref_dmz(xc_entry_data_php_t *php) /* {{{ */
153{
154    php->refcount ++;
155}
156/* }}} */
157static void xc_php_release_dmz(xc_entry_data_php_t *php) /* {{{ */
158{
159    if (-- php->refcount == 0) {
160        xc_entry_data_php_t **pp = &(php->cache->phps[php->hvalue]);
161        xc_entry_data_php_t *p;
162        for (p = *pp; p; pp = &(p->next), p = p->next) {
163            if (memcmp(php->md5, p->md5, sizeof(php->md5)) == 0) {
164                /* unlink */
165                *pp = p->next;
166                xc_php_free_dmz(php);
167                return;
168            }
169        }
170        assert(0);
171    }
172}
173/* }}} */
174
175static inline int xc_entry_equal_dmz(xc_entry_t *a, xc_entry_t *b) /* {{{ */
176{
177    /* this function isn't required but can be in dmz */
178
179    if (a->type != b->type) {
180        return 0;
181    }
182    switch (a->type) {
183        case XC_TYPE_PHP:
184#ifdef HAVE_INODE
185            do {
186                if (a->inode) {
187                    return a->inode == b->inode
188                        && a->device == b->device;
189                }
190            } while(0);
191#endif
192            /* fall */
193
194        case XC_TYPE_VAR:
195            do {
196#ifdef IS_UNICODE
197                if (a->name_type == IS_UNICODE) {
198                    if (a->name.ustr.len != b->name.ustr.len) {
199                        return 0;
200                    }
201                    return memcmp(a->name.ustr.val, b->name.ustr.val, (a->name.ustr.len + 1) * sizeof(UChar)) == 0;
202                }
203                else {
204                    return memcmp(a->name.str.val, b->name.str.val, a->name.str.len + 1) == 0;
205                }
206#else
207                return memcmp(a->name.str.val, b->name.str.val, a->name.str.len + 1) == 0;
208#endif
209
210            } while(0);
211        default:
212            assert(0);
213    }
214    return 0;
215}
216/* }}} */
217static void xc_entry_add_dmz(xc_entry_t *xce) /* {{{ */
218{
219    xc_entry_t **head = &(xce->cache->entries[xce->hvalue]);
220    xce->next = *head;
221    *head = xce;
222    xce->cache->entries_count ++;
223}
224/* }}} */
225static xc_entry_t *xc_entry_store_dmz(xc_entry_t *xce TSRMLS_DC) /* {{{ */
226{
227    xc_entry_t *stored_xce;
228
229    xce->hits  = 0;
230    xce->ctime = XG(request_time);
231    xce->atime = XG(request_time);
232    stored_xce = xc_processor_store_xc_entry_t(xce TSRMLS_CC);
233    if (stored_xce) {
234        xc_entry_add_dmz(stored_xce);
235        return stored_xce;
236    }
237    else {
238        xce->cache->ooms ++;
239        return NULL;
240    }
241}
242/* }}} */
243static void xc_entry_free_real_dmz(volatile xc_entry_t *xce) /* {{{ */
244{
245    if (xce->type == XC_TYPE_PHP) {
246        xc_php_release_dmz(xce->data.php);
247    }
248    xce->cache->mem->handlers->free(xce->cache->mem, (xc_entry_t *)xce);
249}
250/* }}} */
251static void xc_entry_free_dmz(xc_entry_t *xce TSRMLS_DC) /* {{{ */
252{
253    xce->cache->entries_count --;
254    if (xce->refcount == 0) {
255        xc_entry_free_real_dmz(xce);
256    }
257    else {
258        xce->next = xce->cache->deletes;
259        xce->cache->deletes = xce;
260        xce->dtime = XG(request_time);
261        xce->cache->deletes_count ++;
262    }
263    return;
264}
265/* }}} */
266static void xc_entry_remove_dmz(xc_entry_t *xce TSRMLS_DC) /* {{{ */
267{
268    xc_entry_t **pp = &(xce->cache->entries[xce->hvalue]);
269    xc_entry_t *p;
270    for (p = *pp; p; pp = &(p->next), p = p->next) {
271        if (xc_entry_equal_dmz(xce, p)) {
272            /* unlink */
273            *pp = p->next;
274            xc_entry_free_dmz(xce TSRMLS_CC);
275            return;
276        }
277    }
278    assert(0);
279}
280/* }}} */
281static xc_entry_t *xc_entry_find_dmz(xc_entry_t *xce TSRMLS_DC) /* {{{ */
282{
283    xc_entry_t *p;
284    for (p = xce->cache->entries[xce->hvalue]; p; p = p->next) {
285        if (xc_entry_equal_dmz(xce, p)) {
286            if (p->type == XC_TYPE_VAR || /* PHP */ p->mtime == xce->mtime) {
287                p->hits ++;
288                p->atime = XG(request_time);
289                return p;
290            }
291            else {
292                xc_entry_remove_dmz(p TSRMLS_CC);
293                return NULL;
294            }
295        }
296    }
297    return NULL;
298}
299/* }}} */
300static void xc_entry_hold_php_dmz(xc_entry_t *xce TSRMLS_DC) /* {{{ */
301{
302    TRACE("hold %s", xce->name.str.val);
303    xce->refcount ++;
304    xc_stack_push(&XG(php_holds)[xce->cache->cacheid], (void *)xce);
305}
306/* }}} */
307#if 0
308static void xc_entry_hold_var_dmz(xc_entry_t *xce TSRMLS_DC) /* {{{ */
309{
310    xce->refcount ++;
311    xc_stack_push(&XG(var_holds)[xce->cache->cacheid], (void *)xce);
312}
313/* }}} */
314#endif
315
316/* helper function that loop through each entry */
317#define XC_ENTRY_APPLY_FUNC(name) int name(xc_entry_t *entry TSRMLS_DC)
318typedef XC_ENTRY_APPLY_FUNC((*cache_apply_dmz_func_t));
319static void xc_entry_apply_dmz(xc_cache_t *cache, cache_apply_dmz_func_t apply_func TSRMLS_DC) /* {{{ */
320{
321    xc_entry_t *p, **pp;
322    int i, c;
323
324    for (i = 0, c = cache->hentry->size; i < c; i ++) {
325        pp = &(cache->entries[i]);
326        for (p = *pp; p; p = *pp) {
327            if (apply_func(p TSRMLS_CC)) {
328                /* unlink */
329                *pp = p->next;
330                xc_entry_free_dmz(p TSRMLS_CC);
331            }
332            else {
333                pp = &(p->next);
334            }
335        }
336    }
337}
338/* }}} */
339
340#define XC_CACHE_APPLY_FUNC(name) void name(xc_cache_t *cache TSRMLS_DC)
341/* call graph:
342 * xc_gc_expires_php -> xc_gc_expires_one -> xc_entry_apply_dmz -> xc_gc_expires_php_entry_dmz
343 * xc_gc_expires_var -> xc_gc_expires_one -> xc_entry_apply_dmz -> xc_gc_expires_var_entry_dmz
344 */
345static XC_ENTRY_APPLY_FUNC(xc_gc_expires_php_entry_dmz) /* {{{ */
346{
347    TRACE("ttl %lu, %lu %lu", (zend_ulong) XG(request_time), (zend_ulong) entry->atime, xc_php_ttl);
348    if (XG(request_time) > entry->atime + xc_php_ttl) {
349        return 1;
350    }
351    return 0;
352}
353/* }}} */
354static XC_ENTRY_APPLY_FUNC(xc_gc_expires_var_entry_dmz) /* {{{ */
355{
356    if (VAR_ENTRY_EXPIRED(entry)) {
357        return 1;
358    }
359    return 0;
360}
361/* }}} */
362static void xc_gc_expires_one(xc_cache_t *cache, zend_ulong gc_interval, cache_apply_dmz_func_t apply_func TSRMLS_DC) /* {{{ */
363{
364    TRACE("interval %lu, %lu %lu", (zend_ulong) XG(request_time), (zend_ulong) cache->last_gc_expires, gc_interval);
365    if (XG(request_time) - cache->last_gc_expires >= gc_interval) {
366        ENTER_LOCK(cache) {
367            if (XG(request_time) - cache->last_gc_expires >= gc_interval) {
368                cache->last_gc_expires = XG(request_time);
369                xc_entry_apply_dmz(cache, apply_func TSRMLS_CC);
370            }
371        } LEAVE_LOCK(cache);
372    }
373}
374/* }}} */
375static void xc_gc_expires_php(TSRMLS_D) /* {{{ */
376{
377    int i, c;
378
379    if (!xc_php_ttl || !xc_php_gc_interval) {
380        return;
381    }
382
383    for (i = 0, c = xc_php_hcache.size; i < c; i ++) {
384        xc_gc_expires_one(xc_php_caches[i], xc_php_gc_interval, xc_gc_expires_php_entry_dmz TSRMLS_CC);
385    }
386}
387/* }}} */
388static void xc_gc_expires_var(TSRMLS_D) /* {{{ */
389{
390    int i, c;
391
392    if (!xc_var_gc_interval) {
393        return;
394    }
395
396    for (i = 0, c = xc_var_hcache.size; i < c; i ++) {
397        xc_gc_expires_one(xc_var_caches[i], xc_var_gc_interval, xc_gc_expires_var_entry_dmz TSRMLS_CC);
398    }
399}
400/* }}} */
401
402static XC_CACHE_APPLY_FUNC(xc_gc_delete_dmz) /* {{{ */
403{
404    xc_entry_t *p, **pp;
405
406    pp = &cache->deletes;
407    for (p = *pp; p; p = *pp) {
408        if (XG(request_time) - p->dtime > 3600) {
409            p->refcount = 0;
410            /* issue warning here */
411        }
412        if (p->refcount == 0) {
413            /* unlink */
414            *pp = p->next;
415            cache->deletes_count --;
416            xc_entry_free_real_dmz(p);
417        }
418        else {
419            pp = &(p->next);
420        }
421    }
422}
423/* }}} */
424static XC_CACHE_APPLY_FUNC(xc_gc_deletes_one) /* {{{ */
425{
426    if (cache->deletes && XG(request_time) - cache->last_gc_deletes > xc_deletes_gc_interval) {
427        ENTER_LOCK(cache) {
428            if (cache->deletes && XG(request_time) - cache->last_gc_deletes > xc_deletes_gc_interval) {
429                cache->last_gc_deletes = XG(request_time);
430                xc_gc_delete_dmz(cache TSRMLS_CC);
431            }
432        } LEAVE_LOCK(cache);
433    }
434}
435/* }}} */
436static void xc_gc_deletes(TSRMLS_D) /* {{{ */
437{
438    int i, c;
439
440    for (i = 0, c = xc_php_hcache.size; i < c; i ++) {
441        xc_gc_deletes_one(xc_php_caches[i] TSRMLS_CC);
442    }
443
444    for (i = 0, c = xc_var_hcache.size; i < c; i ++) {
445        xc_gc_deletes_one(xc_var_caches[i] TSRMLS_CC);
446    }
447}
448/* }}} */
449
450/* helper functions for user functions */
451static void xc_fillinfo_dmz(int cachetype, xc_cache_t *cache, zval *return_value TSRMLS_DC) /* {{{ */
452{
453    zval *blocks;
454    const xc_block_t *b;
455#ifndef NDEBUG
456    xc_memsize_t avail = 0;
457#endif
458    xc_mem_t *mem = cache->mem;
459    const xc_mem_handlers_t *handlers = mem->handlers;
460    zend_ulong interval;
461    if (cachetype == XC_TYPE_PHP) {
462        interval = xc_php_ttl ? xc_php_gc_interval : 0;
463    }
464    else {
465        interval = xc_var_gc_interval;
466    }
467
468    add_assoc_long_ex(return_value, ZEND_STRS("slots"),     cache->hentry->size);
469    add_assoc_long_ex(return_value, ZEND_STRS("compiling"), cache->compiling);
470    add_assoc_long_ex(return_value, ZEND_STRS("misses"),    cache->misses);
471    add_assoc_long_ex(return_value, ZEND_STRS("hits"),      cache->hits);
472    add_assoc_long_ex(return_value, ZEND_STRS("clogs"),     cache->clogs);
473    add_assoc_long_ex(return_value, ZEND_STRS("ooms"),      cache->ooms);
474    add_assoc_long_ex(return_value, ZEND_STRS("errors"),    cache->errors);
475
476    add_assoc_long_ex(return_value, ZEND_STRS("cached"),    cache->entries_count);
477    add_assoc_long_ex(return_value, ZEND_STRS("deleted"),   cache->deletes_count);
478    if (interval) {
479        time_t gc = (cache->last_gc_expires + interval) - XG(request_time);
480        add_assoc_long_ex(return_value, ZEND_STRS("gc"),    gc > 0 ? gc : 0);
481    }
482    else {
483        add_assoc_null_ex(return_value, ZEND_STRS("gc"));
484    }
485
486    MAKE_STD_ZVAL(blocks);
487    array_init(blocks);
488
489    add_assoc_long_ex(return_value, ZEND_STRS("size"),  handlers->size(mem));
490    add_assoc_long_ex(return_value, ZEND_STRS("avail"), handlers->avail(mem));
491    add_assoc_bool_ex(return_value, ZEND_STRS("can_readonly"), xc_readonly_protection);
492
493    for (b = handlers->freeblock_first(mem); b; b = handlers->freeblock_next(b)) {
494        zval *bi;
495
496        MAKE_STD_ZVAL(bi);
497        array_init(bi);
498
499        add_assoc_long_ex(bi, ZEND_STRS("size"),   handlers->block_size(b));
500        add_assoc_long_ex(bi, ZEND_STRS("offset"), handlers->block_offset(mem, b));
501        add_next_index_zval(blocks, bi);
502#ifndef NDEBUG
503        avail += handlers->block_size(b);
504#endif
505    }
506    add_assoc_zval_ex(return_value, ZEND_STRS("free_blocks"), blocks);
507    assert(avail == handlers->avail(mem));
508}
509/* }}} */
510static void xc_fillentry_dmz(xc_entry_t *entry, int del, zval *list TSRMLS_DC) /* {{{ */
511{
512    zval* ei;
513    xc_entry_data_php_t *php;
514    xc_entry_data_var_t *var;
515
516    ALLOC_INIT_ZVAL(ei);
517    array_init(ei);
518
519    add_assoc_long_ex(ei, ZEND_STRS("refcount"), entry->refcount);
520    add_assoc_long_ex(ei, ZEND_STRS("hits"),     entry->hits);
521    add_assoc_long_ex(ei, ZEND_STRS("ctime"),    entry->ctime);
522    add_assoc_long_ex(ei, ZEND_STRS("atime"),    entry->atime);
523    add_assoc_long_ex(ei, ZEND_STRS("hvalue"),   entry->hvalue);
524    if (del) {
525        add_assoc_long_ex(ei, ZEND_STRS("dtime"), entry->dtime);
526    }
527#ifdef IS_UNICODE
528    do {
529        zval *zv;
530        ALLOC_INIT_ZVAL(zv);
531        switch (entry->name_type) {
532            case IS_UNICODE:
533                    ZVAL_UNICODEL(zv, entry->name.ustr.val, entry->name.ustr.len, 1);
534                break;
535            case IS_STRING:
536                ZVAL_STRINGL(zv, entry->name.str.val, entry->name.str.len, 1);
537                break;
538            default:
539                assert(0);
540        }
541        zv->type = entry->name_type;
542        add_assoc_zval_ex(ei, ZEND_STRS("name"), zv);
543    } while (0);
544#else
545    add_assoc_stringl_ex(ei, ZEND_STRS("name"), entry->name.str.val, entry->name.str.len, 1);
546#endif
547    switch (entry->type) {
548        case XC_TYPE_PHP:
549            php = entry->data.php;
550            add_assoc_long_ex(ei, ZEND_STRS("size"),          entry->size + php->size);
551            add_assoc_long_ex(ei, ZEND_STRS("phprefcount"),   php->refcount);
552            add_assoc_long_ex(ei, ZEND_STRS("sourcesize"),    php->sourcesize);
553#ifdef HAVE_INODE
554            add_assoc_long_ex(ei, ZEND_STRS("device"),        entry->device);
555            add_assoc_long_ex(ei, ZEND_STRS("inode"),         entry->inode);
556#endif
557            add_assoc_long_ex(ei, ZEND_STRS("mtime"),         entry->mtime);
558
559#ifdef HAVE_XCACHE_CONSTANT
560            add_assoc_long_ex(ei, ZEND_STRS("constinfo_cnt"), php->constinfo_cnt);
561#endif
562            add_assoc_long_ex(ei, ZEND_STRS("function_cnt"),  php->funcinfo_cnt);
563            add_assoc_long_ex(ei, ZEND_STRS("class_cnt"),     php->classinfo_cnt);
564#ifdef ZEND_ENGINE_2_1
565            add_assoc_long_ex(ei, ZEND_STRS("autoglobal_cnt"),php->autoglobal_cnt);
566#endif
567            break;
568
569        case XC_TYPE_VAR:
570            var = entry->data.var;
571            add_assoc_long_ex(ei, ZEND_STRS("size"),          entry->size);
572            break;
573
574        default:
575            assert(0);
576    }
577
578    add_next_index_zval(list, ei);
579}
580/* }}} */
581static void xc_filllist_dmz(xc_cache_t *cache, zval *return_value TSRMLS_DC) /* {{{ */
582{
583    zval* list;
584    int i, c;
585    xc_entry_t *e;
586
587    ALLOC_INIT_ZVAL(list);
588    array_init(list);
589
590    for (i = 0, c = cache->hentry->size; i < c; i ++) {
591        for (e = cache->entries[i]; e; e = e->next) {
592            xc_fillentry_dmz(e, 0, list TSRMLS_CC);
593        }
594    }
595    add_assoc_zval(return_value, "cache_list", list);
596
597    ALLOC_INIT_ZVAL(list);
598    array_init(list);
599    for (e = cache->deletes; e; e = e->next) {
600        xc_fillentry_dmz(e, 1, list TSRMLS_CC);
601    }
602    add_assoc_zval(return_value, "deleted_list", list);
603}
604/* }}} */
605
606static zend_op_array *xc_entry_install(xc_entry_t *xce, zend_file_handle *h TSRMLS_DC) /* {{{ */
607{
608    zend_uint i;
609    xc_entry_data_php_t *p = xce->data.php;
610    zend_op_array *old_active_op_array = CG(active_op_array);
611#ifndef ZEND_ENGINE_2
612    ALLOCA_FLAG(use_heap)
613    /* new ptr which is stored inside CG(class_table) */
614    xc_cest_t **new_cest_ptrs = (xc_cest_t **)my_do_alloca(sizeof(xc_cest_t*) * p->classinfo_cnt, use_heap);
615#endif
616
617    CG(active_op_array) = p->op_array;
618
619#ifdef HAVE_XCACHE_CONSTANT
620    /* install constant */
621    for (i = 0; i < p->constinfo_cnt; i ++) {
622        xc_constinfo_t *ci = &p->constinfos[i];
623        xc_install_constant(xce->name.str.val, &ci->constant,
624                UNISW(0, ci->type), ci->key, ci->key_size, ci->h TSRMLS_CC);
625    }
626#endif
627
628    /* install function */
629    for (i = 0; i < p->funcinfo_cnt; i ++) {
630        xc_funcinfo_t  *fi = &p->funcinfos[i];
631        xc_install_function(xce->name.str.val, &fi->func,
632                UNISW(0, fi->type), fi->key, fi->key_size, fi->h TSRMLS_CC);
633    }
634
635    /* install class */
636    for (i = 0; i < p->classinfo_cnt; i ++) {
637        xc_classinfo_t *ci = &p->classinfos[i];
638#ifndef ZEND_ENGINE_2
639        zend_class_entry *ce = CestToCePtr(ci->cest);
640        /* fix pointer to the be which inside class_table */
641        if (ce->parent) {
642            zend_uint class_idx = (/* class_num */ (int) (long) ce->parent) - 1;
643            assert(class_idx < i);
644            ci->cest.parent = new_cest_ptrs[class_idx];
645        }
646        new_cest_ptrs[i] =
647#endif
648        xc_install_class(xce->name.str.val, &ci->cest, ci->oplineno,
649                UNISW(0, ci->type), ci->key, ci->key_size, ci->h TSRMLS_CC);
650    }
651
652#ifdef ZEND_ENGINE_2_1
653    /* trigger auto_globals jit */
654    for (i = 0; i < p->autoglobal_cnt; i ++) {
655        xc_autoglobal_t *aginfo = &p->autoglobals[i];
656        /*
657        zend_auto_global *auto_global;
658        if (zend_u_hash_quick_find(CG(auto_globals), aginfo->type, aginfo->key, aginfo->key_len+1, aginfo->h, (void **) &auto_global)==SUCCESS) {
659            if (auto_global->armed) {
660                auto_global->armed = auto_global->auto_global_callback(auto_global->name, auto_global->name_len TSRMLS_CC);
661            }
662        }
663        */
664        zend_u_is_auto_global(aginfo->type, aginfo->key, aginfo->key_len TSRMLS_CC);
665    }
666#endif
667#ifdef E_STRICT
668    /* restore trigger errors */
669    for (i = 0; i < p->compilererror_cnt; i ++) {
670        xc_compilererror_t *error = &p->compilererrors[i];
671        CG(zend_lineno) = error->lineno;
672        zend_error(E_STRICT, "%s", error->error);
673    }
674    CG(zend_lineno) = 0;
675#endif
676
677    i = 1;
678    zend_hash_add(&EG(included_files), xce->name.str.val, xce->name.str.len+1, (void *)&i, sizeof(int), NULL);
679    if (h) {
680        zend_llist_add_element(&CG(open_files), h);
681    }
682
683#ifndef ZEND_ENGINE_2
684    my_free_alloca(new_cest_ptrs, use_heap);
685#endif
686    CG(active_op_array) = old_active_op_array;
687    return p->op_array;
688}
689/* }}} */
690
691static inline void xc_entry_unholds_real(xc_stack_t *holds, xc_cache_t **caches, int cachecount TSRMLS_DC) /* {{{ */
692{
693    int i;
694    xc_stack_t *s;
695    xc_cache_t *cache;
696    xc_entry_t *xce;
697
698    for (i = 0; i < cachecount; i ++) {
699        s = &holds[i];
700        TRACE("holded %d", xc_stack_count(s));
701        if (xc_stack_count(s)) {
702            cache = ((xc_entry_t *)xc_stack_top(s))->cache;
703            ENTER_LOCK(cache) {
704                while (xc_stack_count(s)) {
705                    xce = (xc_entry_t*) xc_stack_pop(s);
706                    TRACE("unhold %s", xce->name.str.val);
707                    xce->refcount --;
708                    assert(xce->refcount >= 0);
709                }
710            } LEAVE_LOCK(cache);
711        }
712    }
713}
714/* }}} */
715static void xc_entry_unholds(TSRMLS_D) /* {{{ */
716{
717    xc_entry_unholds_real(XG(php_holds), xc_php_caches, xc_php_hcache.size TSRMLS_CC);
718    xc_entry_unholds_real(XG(var_holds), xc_var_caches, xc_var_hcache.size TSRMLS_CC);
719}
720/* }}} */
721static int xc_stat(const char *filename, const char *include_path, struct stat *pbuf TSRMLS_DC) /* {{{ */
722{
723    char filepath[MAXPATHLEN];
724    char *paths, *path;
725    char *tokbuf;
726    int size = strlen(include_path) + 1;
727    char tokens[] = { DEFAULT_DIR_SEPARATOR, '\0' };
728    ALLOCA_FLAG(use_heap)
729
730    paths = (char *)my_do_alloca(size, use_heap);
731    memcpy(paths, include_path, size);
732
733    for (path = php_strtok_r(paths, tokens, &tokbuf); path; path = php_strtok_r(NULL, tokens, &tokbuf)) {
734        if (snprintf(filepath, sizeof(filepath), "%s/%s", path, filename) >= MAXPATHLEN - 1) {
735            continue;
736        }
737        if (VCWD_STAT(filepath, pbuf) == 0) {
738            my_free_alloca(paths, use_heap);
739            return SUCCESS;
740        }
741    }
742
743    my_free_alloca(paths, use_heap);
744
745    return FAILURE;
746}
747/* }}} */
748
749#define HASH(i) (i)
750#define HASH_USTR_L(t, s, l) HASH(zend_u_inline_hash_func(t, s, (l + 1) * sizeof(UChar)))
751#define HASH_STR_S(s, l) HASH(zend_inline_hash_func(s, l))
752#define HASH_STR_L(s, l) HASH_STR_S(s, l + 1)
753#define HASH_STR(s) HASH_STR_L(s, strlen(s) + 1)
754#define HASH_NUM(n) HASH(n)
755static inline xc_hash_value_t xc_hash_fold(xc_hash_value_t hvalue, const xc_hash_t *hasher) /* {{{ fold hash bits as needed */
756{
757    xc_hash_value_t folded = 0;
758    while (hvalue) {
759        folded ^= (hvalue & hasher->mask);
760        hvalue >>= hasher->bits;
761    }
762    return folded;
763}
764/* }}} */
765static inline xc_hash_value_t xc_entry_hash_name(xc_entry_t *xce TSRMLS_DC) /* {{{ */
766{
767    return UNISW(NOTHING, UG(unicode) ? HASH_USTR_L(xce->name_type, xce->name.uni.val, xce->name.uni.len) :)
768        HASH_STR_L(xce->name.str.val, xce->name.str.len);
769}
770/* }}} */
771#define xc_entry_hash_var xc_entry_hash_name
772static inline xc_hash_value_t xc_entry_hash_php(xc_entry_t *xce TSRMLS_DC) /* {{{ */
773{
774#ifdef HAVE_INODE
775    if (xce->inode) {
776        return HASH(xce->device + xce->inode);
777    }
778#endif
779    return xc_entry_hash_name(xce TSRMLS_CC);
780}
781/* }}} */
782static int xc_entry_init_key_php(xc_entry_t *xce, char *filename, char *opened_path_buffer TSRMLS_DC) /* {{{ */
783{
784    struct stat buf, *pbuf;
785    xc_hash_value_t hv;
786    int cacheid;
787    xc_entry_data_php_t *php;
788    char *ptr;
789    time_t delta;
790
791    if (!filename || !SG(request_info).path_translated) {
792        return FAILURE;
793    }
794
795    if (strstr(filename, "://") != NULL) {
796        return FAILURE;
797    }
798
799    php = xce->data.php;
800
801    if (XG(stat)) {
802        if (strcmp(SG(request_info).path_translated, filename) == 0) {
803            /* sapi has already done this stat() for us */
804            pbuf = sapi_get_stat(TSRMLS_C);
805            if (pbuf) {
806                goto stat_done;
807            }
808        }
809
810        /* absolute path */
811        pbuf = &buf;
812        if (IS_ABSOLUTE_PATH(filename, strlen(filename))) {
813            if (VCWD_STAT(filename, pbuf) != 0) {
814                return FAILURE;
815            }
816            goto stat_done;
817        }
818
819        /* relative path */
820        if (*filename == '.' && (IS_SLASH(filename[1]) || filename[1] == '.')) {
821            ptr = filename + 1;
822            if (*ptr == '.') {
823                while (*(++ptr) == '.');
824                if (!IS_SLASH(*ptr)) {
825                    goto not_relative_path;
826                }   
827            }
828
829            if (VCWD_STAT(filename, pbuf) != 0) {
830                return FAILURE;
831            }
832            goto stat_done;
833        }
834not_relative_path:
835
836        /* use include_path */
837        if (xc_stat(filename, PG(include_path), pbuf TSRMLS_CC) != SUCCESS) {
838            return FAILURE;
839        }
840
841        /* fall */
842
843stat_done:
844        delta = XG(request_time) - pbuf->st_mtime;
845        if (abs(delta) < 2 && !xc_test) {
846            return FAILURE;
847        }
848
849        xce->mtime        = pbuf->st_mtime;
850#ifdef HAVE_INODE
851        xce->device       = pbuf->st_dev;
852        xce->inode        = pbuf->st_ino;
853#endif
854        php->sourcesize   = pbuf->st_size;
855    }
856    else { /* XG(inode) */
857        xce->mtime        = 0;
858#ifdef HAVE_INODE
859        xce->device       = 0;
860        xce->inode        = 0;
861#endif
862        php->sourcesize   = 0;
863    }
864
865#ifdef HAVE_INODE
866    if (!xce->inode)
867#endif
868    {
869        /* hash on filename, let's expand it to real path */
870        filename = expand_filepath(filename, opened_path_buffer TSRMLS_CC);
871        if (filename == NULL) {
872            return FAILURE;
873        }
874    }
875
876    UNISW(NOTHING, xce->name_type = IS_STRING;)
877    xce->name.str.val = filename;
878    xce->name.str.len = strlen(filename);
879
880    hv = xc_entry_hash_php(xce TSRMLS_CC);
881    cacheid = xc_hash_fold(hv, &xc_php_hcache);
882    xce->cache = xc_php_caches[cacheid];
883    xce->hvalue = xc_hash_fold(hv, &xc_php_hentry);
884
885    xce->type = XC_TYPE_PHP;
886    return SUCCESS;
887}
888/* }}} */
889static inline xc_hash_value_t xc_php_hash_md5(xc_entry_data_php_t *php TSRMLS_DC) /* {{{ */
890{
891    return HASH_STR_S(php->md5, sizeof(php->md5));
892}
893/* }}} */
894static int xc_entry_init_key_php_md5(xc_entry_data_php_t *php, xc_entry_t *xce TSRMLS_DC) /* {{{ */
895{
896    unsigned char   buf[1024];
897    PHP_MD5_CTX     context;
898    int             n;
899    php_stream     *stream;
900    xc_hash_value_t hv;
901    ulong           old_rsid = EG(regular_list).nNextFreeElement;
902
903    stream = php_stream_open_wrapper(xce->name.str.val, "rb", USE_PATH | REPORT_ERRORS | ENFORCE_SAFE_MODE | STREAM_DISABLE_OPEN_BASEDIR, NULL);
904    if (!stream) {
905        return FAILURE;
906    }
907
908    PHP_MD5Init(&context);
909    while ((n = php_stream_read(stream, (char *) buf, sizeof(buf))) > 0) {
910        PHP_MD5Update(&context, buf, n);
911    }
912    PHP_MD5Final((unsigned char *) php->md5, &context);
913
914    php_stream_close(stream);
915    if (EG(regular_list).nNextFreeElement == old_rsid + 1) {
916        EG(regular_list).nNextFreeElement = old_rsid;
917    }
918
919    if (n < 0) {
920        return FAILURE;
921    }
922
923    hv = xc_php_hash_md5(php TSRMLS_CC);
924    php->cache  = xce->cache;
925    php->hvalue = (hv & php->cache->hphp->mask);
926#ifdef DEBUG
927    {
928        char md5str[33];
929        make_digest(md5str, (unsigned char *) php->md5);
930        TRACE("md5 %s", md5str);
931    }
932#endif
933
934    return SUCCESS;
935}
936/* }}} */
937static void xc_cache_early_binding_class_cb(zend_op *opline, int oplineno, void *data TSRMLS_DC) /* {{{ */
938{
939    char *class_name;
940    int i, class_len;
941    xc_cest_t cest;
942    xc_entry_data_php_t *php = (xc_entry_data_php_t *) data;
943
944    class_name = opline->op1.u.constant.value.str.val;
945    class_len  = opline->op1.u.constant.value.str.len;
946    if (zend_hash_find(CG(class_table), class_name, class_len, (void **) &cest) == FAILURE) {
947        assert(0);
948    }
949    TRACE("got ZEND_DECLARE_INHERITED_CLASS: %s", class_name + 1);
950    /* let's see which class */
951    for (i = 0; i < php->classinfo_cnt; i ++) {
952        if (memcmp(ZSTR_S(php->classinfos[i].key), class_name, class_len) == 0) {
953            php->classinfos[i].oplineno = oplineno;
954            php->have_early_binding = 1;
955            break;
956        }
957    }
958
959    if (i == php->classinfo_cnt) {
960        assert(0);
961    }
962}
963/* }}} */
964static void xc_free_php(xc_entry_data_php_t *php TSRMLS_DC) /* {{{ */
965{
966#define X_FREE(var) do {\
967    if (php->var) { \
968        efree(php->var); \
969    } \
970} while (0)
971
972#ifdef ZEND_ENGINE_2_1
973    X_FREE(autoglobals);
974#endif
975    X_FREE(classinfos);
976    X_FREE(funcinfos);
977#ifdef HAVE_XCACHE_CONSTANT
978    X_FREE(constinfos);
979#endif
980#undef X_FREE
981}
982/* }}} */
983static zend_op_array *xc_compile_php(xc_entry_data_php_t *php, zend_file_handle *h, int type TSRMLS_DC) /* {{{ */
984{
985    zend_op_array *op_array;
986    int old_constinfo_cnt, old_funcinfo_cnt, old_classinfo_cnt;
987    int i;
988    zend_bool catched = 0;
989
990    /* {{{ compile */
991    TRACE("compiling %s", h->opened_path ? h->opened_path : h->filename);
992
993    old_classinfo_cnt = zend_hash_num_elements(CG(class_table));
994    old_funcinfo_cnt  = zend_hash_num_elements(CG(function_table));
995    old_constinfo_cnt = zend_hash_num_elements(EG(zend_constants));
996
997    php->op_array = NULL;
998    XG(initial_compile_file_called) = 0;
999    zend_try {
1000        op_array = old_compile_file(h, type TSRMLS_CC);
1001    } zend_catch {
1002        catched = 1;
1003    } zend_end_try();
1004
1005    if (catched) {
1006        goto err_bailout;
1007    }
1008
1009    if (op_array == NULL) {
1010        goto err_op_array;
1011    }
1012
1013    if (!XG(initial_compile_file_called)) {
1014        return op_array;
1015    }
1016
1017    /* }}} */
1018    /* {{{ prepare */
1019    php->op_array      = op_array;
1020
1021#ifdef HAVE_XCACHE_CONSTANT
1022    php->constinfo_cnt  = zend_hash_num_elements(EG(zend_constants)) - old_constinfo_cnt;
1023#endif
1024    php->funcinfo_cnt   = zend_hash_num_elements(CG(function_table)) - old_funcinfo_cnt;
1025    php->classinfo_cnt  = zend_hash_num_elements(CG(class_table))    - old_classinfo_cnt;
1026#ifdef ZEND_ENGINE_2_1
1027    /* {{{ count php->autoglobal_cnt */ {
1028        Bucket *b;
1029
1030        php->autoglobal_cnt = 0;
1031        for (b = CG(auto_globals)->pListHead; b != NULL; b = b->pListNext) {
1032            zend_auto_global *auto_global = (zend_auto_global *) b->pData;
1033            /* check if actived */
1034            if (auto_global->auto_global_callback && !auto_global->armed) {
1035                php->autoglobal_cnt ++;
1036            }
1037        }
1038    }
1039    /* }}} */
1040#endif
1041
1042#define X_ALLOC_N(var, cnt) do {     \
1043    if (php->cnt) {                  \
1044        ECALLOC_N(php->var, php->cnt); \
1045        if (!php->var) {             \
1046            goto err_alloc;          \
1047        }                            \
1048    }                                \
1049    else {                           \
1050        php->var = NULL;             \
1051    }                                \
1052} while (0)
1053
1054#ifdef HAVE_XCACHE_CONSTANT
1055    X_ALLOC_N(constinfos,  constinfo_cnt);
1056#endif
1057    X_ALLOC_N(funcinfos,   funcinfo_cnt);
1058    X_ALLOC_N(classinfos,  classinfo_cnt);
1059#ifdef ZEND_ENGINE_2_1
1060    X_ALLOC_N(autoglobals, autoglobal_cnt);
1061#endif
1062#undef X_ALLOC
1063    /* }}} */
1064    /* {{{ shallow copy, pointers only */ {
1065        Bucket *b;
1066        unsigned int i;
1067        unsigned int j;
1068
1069#define COPY_H(vartype, var, cnt, name, datatype) do {        \
1070    for (i = 0, j = 0; b; i ++, b = b->pListNext) {           \
1071        vartype *data = &php->var[j];                         \
1072                                                              \
1073        if (i < old_##cnt) {                                  \
1074            continue;                                         \
1075        }                                                     \
1076        j ++;                                                 \
1077                                                              \
1078        assert(i < old_##cnt + php->cnt);                     \
1079        assert(b->pData);                                     \
1080        memcpy(&data->name, b->pData, sizeof(datatype));      \
1081        UNISW(NOTHING, data->type = b->key.type;)             \
1082        if (UNISW(1, b->key.type == IS_STRING)) {             \
1083            ZSTR_S(data->key)      = BUCKET_KEY_S(b);         \
1084        }                                                     \
1085        else {                                                \
1086            ZSTR_U(data->key)      = BUCKET_KEY_U(b);         \
1087        }                                                     \
1088        data->key_size   = b->nKeyLength;                     \
1089        data->h          = b->h;                              \
1090    }                                                         \
1091} while(0)
1092
1093#ifdef HAVE_XCACHE_CONSTANT
1094        b = EG(zend_constants)->pListHead; COPY_H(xc_constinfo_t, constinfos, constinfo_cnt, constant, zend_constant);
1095#endif
1096        b = CG(function_table)->pListHead; COPY_H(xc_funcinfo_t,  funcinfos,  funcinfo_cnt,  func,     zend_function);
1097        b = CG(class_table)->pListHead;    COPY_H(xc_classinfo_t, classinfos, classinfo_cnt, cest,     xc_cest_t);
1098
1099#undef COPY_H
1100
1101        /* for ZE1, cest need to be fixed inside store */
1102
1103#ifdef ZEND_ENGINE_2_1
1104        /* scan for acatived auto globals */
1105        i = 0;
1106        for (b = CG(auto_globals)->pListHead; b != NULL; b = b->pListNext) {
1107            zend_auto_global *auto_global = (zend_auto_global *) b->pData;
1108            /* check if actived */
1109            if (auto_global->auto_global_callback && !auto_global->armed) {
1110                xc_autoglobal_t *data = &php->autoglobals[i];
1111
1112                assert(i < php->autoglobal_cnt);
1113                i ++;
1114                UNISW(NOTHING, data->type = b->key.type;)
1115                if (UNISW(1, b->key.type == IS_STRING)) {
1116                    ZSTR_S(data->key)     = BUCKET_KEY_S(b);
1117                }
1118                else {
1119                    ZSTR_U(data->key)     = BUCKET_KEY_U(b);
1120                }
1121                data->key_len = b->nKeyLength - 1;
1122                data->h       = b->h;
1123            }
1124        }
1125#endif
1126    }
1127    /* }}} */
1128#ifdef E_STRICT
1129    php->compilererrors = ((xc_sandbox_t *) XG(sandbox))->compilererrors;
1130    php->compilererror_cnt = ((xc_sandbox_t *) XG(sandbox))->compilererror_cnt;
1131#endif
1132    /* {{{ find inherited classes that should be early-binding */
1133    php->have_early_binding = 0;
1134    for (i = 0; i < php->classinfo_cnt; i ++) {
1135        php->classinfos[i].oplineno = -1;
1136    }
1137
1138    xc_undo_pass_two(php->op_array TSRMLS_CC);
1139    xc_foreach_early_binding_class(php->op_array, xc_cache_early_binding_class_cb, (void *) php TSRMLS_CC);
1140    xc_redo_pass_two(php->op_array TSRMLS_CC);
1141    /* }}} */
1142
1143    return op_array;
1144
1145err_alloc:
1146    xc_free_php(php TSRMLS_CC);
1147
1148err_bailout:
1149err_op_array:
1150
1151    if (catched) {
1152        zend_bailout();
1153    }
1154
1155    return op_array;
1156}
1157/* }}} */
1158static zend_op_array *xc_compile_restore(xc_entry_t *stored_xce, zend_file_handle *h TSRMLS_DC) /* {{{ */
1159{
1160    zend_op_array *op_array;
1161    xc_entry_t xce;
1162    xc_entry_data_php_t php;
1163    zend_bool catched;
1164
1165    CG(in_compilation)    = 1;
1166    CG(compiled_filename) = stored_xce->name.str.val;
1167    CG(zend_lineno)       = 0;
1168    TRACE("restoring %s", stored_xce->name.str.val);
1169    xc_processor_restore_xc_entry_t(&xce, stored_xce TSRMLS_CC);
1170    xc_processor_restore_xc_entry_data_php_t(&php, xce.data.php, xc_readonly_protection TSRMLS_CC);
1171    xce.data.php = &php;
1172#ifdef SHOW_DPRINT
1173    xc_dprint(&xce, 0 TSRMLS_CC);
1174#endif
1175
1176    catched = 0;
1177    zend_try {
1178        op_array = xc_entry_install(&xce, h TSRMLS_CC);
1179    } zend_catch {
1180        catched = 1;
1181    } zend_end_try();
1182
1183    if (php.constinfos) {
1184        efree(php.constinfos);
1185    }
1186    if (php.funcinfos) {
1187        efree(php.funcinfos);
1188    }
1189    if (php.classinfos) {
1190        efree(php.classinfos);
1191    }
1192
1193    if (catched) {
1194        zend_bailout();
1195    }
1196    CG(in_compilation)    = 0;
1197    CG(compiled_filename) = NULL;
1198    TRACE("restored  %s", stored_xce->name.str.val);
1199    return op_array;
1200}
1201/* }}} */
1202static zend_op_array *xc_check_initial_compile_file(zend_file_handle *h, int type TSRMLS_DC) /* {{{ */
1203{
1204    XG(initial_compile_file_called) = 1;
1205    return origin_compile_file(h, type TSRMLS_CC);
1206}
1207/* }}} */
1208static zend_op_array *xc_compile_file(zend_file_handle *h, int type TSRMLS_DC) /* {{{ */
1209{
1210    zend_op_array *op_array;
1211    xc_entry_t xce, *stored_xce;
1212    xc_entry_data_php_t php, *stored_php;
1213    xc_cache_t *cache;
1214    zend_bool gaveup = 0;
1215    zend_bool catched = 0;
1216    zend_bool newlycompiled;
1217    char *filename;
1218    char opened_path_buffer[MAXPATHLEN];
1219    xc_sandbox_t sandbox;
1220
1221    assert(xc_initized);
1222
1223    TRACE("type = %d\n", h->type);
1224    if (!XG(cacher)) {
1225        op_array = old_compile_file(h, type TSRMLS_CC);
1226        return op_array;
1227    }
1228
1229    /* {{{ entry_init_key */
1230    filename = h->opened_path ? h->opened_path : h->filename;
1231    xce.data.php = &php;
1232    if (xc_entry_init_key_php(&xce, filename, opened_path_buffer TSRMLS_CC) != SUCCESS) {
1233        TRACE("failed to init key for %s", filename);
1234        return old_compile_file(h, type TSRMLS_CC);
1235    }
1236    cache = xce.cache;
1237    /* }}} */
1238
1239    /* stale clogs precheck */
1240    if (cache->compiling) {
1241        cache->clogs ++;
1242        return old_compile_file(h, type TSRMLS_CC);
1243    }
1244    /* {{{ entry_lookup/hit/md5_init/php_lookup */
1245    stored_xce = NULL;
1246    stored_php = NULL;
1247    ENTER_LOCK_EX(cache) {
1248        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
1249        if (stored_xce) {
1250            cache->hits ++;
1251
1252            TRACE("hit %s, holding", stored_xce->name.str.val);
1253            xc_entry_hold_php_dmz(stored_xce TSRMLS_CC);
1254        }
1255        else {
1256            cache->misses ++;
1257            TRACE("miss %s", xce.name.str.val);
1258
1259            if (xc_entry_init_key_php_md5(&php, &xce TSRMLS_CC) != SUCCESS) {
1260                gaveup = 1;
1261                break;
1262            }
1263
1264            stored_php = xc_php_find_dmz(&php TSRMLS_CC);
1265
1266            /* miss but compiling */
1267            if (!stored_php) {
1268                if (cache->compiling) {
1269                    TRACE("%s", "miss but compiling");
1270                    cache->clogs ++;
1271                    gaveup = 1;
1272                    break;
1273                }
1274                TRACE("%s", "php_lookup miss");
1275            }
1276            else {
1277                TRACE("%s", "php_lookup hit");
1278            }
1279
1280            cache->compiling = XG(request_time);
1281        }
1282    } LEAVE_LOCK_EX(cache);
1283
1284    if (catched) {
1285        cache->compiling = 0;
1286        zend_bailout();
1287    }
1288
1289    /* hit */
1290    if (stored_xce) {
1291        return xc_compile_restore(stored_xce, h TSRMLS_CC);
1292    }
1293
1294    /* gaveup */
1295    if (gaveup) {
1296        return old_compile_file(h, type TSRMLS_CC);
1297    }
1298    /* }}} */
1299    op_array = NULL;
1300    /* {{{ compile */
1301    if (stored_php) {
1302        newlycompiled = 0;
1303        xce.data.php = stored_php;
1304    }
1305    else {
1306        newlycompiled = 1;
1307
1308        /* make compile inside sandbox */
1309        xc_sandbox_init(&sandbox, filename TSRMLS_CC);
1310
1311#ifdef HAVE_XCACHE_CONSTANT
1312        php.constinfos  = NULL;
1313#endif
1314        php.funcinfos   = NULL;
1315        php.classinfos  = NULL;
1316#ifdef ZEND_ENGINE_2_1
1317        php.autoglobals = NULL;
1318#endif
1319        zend_try {
1320            op_array = xc_compile_php(&php, h, type TSRMLS_CC);
1321        } zend_catch {
1322            catched = 1;
1323        } zend_end_try();
1324
1325        if (catched || !op_array) {
1326            goto err_aftersandbox;
1327        }
1328
1329        /* not cachable */
1330        if (!php.op_array) {
1331            cache->compiling = 0;
1332            /* it's not cachable, but don't scare the users with high misses */
1333            cache->misses --;
1334            xc_sandbox_free(&sandbox, XC_InstallNoBinding TSRMLS_CC);
1335            return op_array;
1336        }
1337
1338        xce.data.php = &php;
1339    }
1340    /* }}} */
1341#ifdef HAVE_INODE
1342    /* {{{ path name fix
1343     * inode enabled entry hash/compare on name
1344     * do not update to its name to real pathname
1345     * WARNING: this code is required to be after compile
1346     */
1347    if (xce.inode) {
1348        filename = h->opened_path ? h->opened_path : h->filename;
1349        if (xce.name.str.val != filename) {
1350            xce.name.str.val = filename;
1351            xce.name.str.len = strlen(filename);
1352        }
1353    }
1354    /* }}} */
1355#endif
1356#ifdef SHOW_DPRINT
1357    xc_dprint(&xce, 0 TSRMLS_CC);
1358#endif
1359    stored_xce = NULL;
1360    ENTER_LOCK_EX(cache) { /* {{{ php_store/entry_store */
1361        /* php_store */
1362        if (newlycompiled) {
1363            stored_php = xc_php_store_dmz(&php TSRMLS_CC);
1364            if (!stored_php) {
1365                /* error */
1366                break;
1367            }
1368        }
1369        /* entry_store */
1370        xc_php_addref_dmz(stored_php);
1371        stored_xce = xc_entry_store_dmz(&xce TSRMLS_CC);
1372        if (stored_xce) {
1373            stored_xce->data.php = stored_php;
1374        }
1375        else {
1376            /* error */
1377            xc_php_release_dmz(stored_php);
1378        }
1379    } LEAVE_LOCK_EX(cache);
1380    /* }}} */
1381    TRACE("%s", stored_xce ? "stored" : "store failed");
1382
1383    cache->compiling = 0;
1384    if (catched) {
1385        goto err_aftersandbox;
1386    }
1387
1388    if (newlycompiled) {
1389        xc_free_php(&php TSRMLS_CC);
1390    }
1391
1392    if (stored_xce) {
1393        if (op_array) {
1394#ifdef ZEND_ENGINE_2
1395            destroy_op_array(op_array TSRMLS_CC);
1396#else
1397            destroy_op_array(op_array);
1398#endif
1399            efree(op_array);
1400            h = NULL;
1401        }
1402        if (newlycompiled) {
1403            xc_sandbox_free(&sandbox, XC_NoInstall TSRMLS_CC);
1404        }
1405        return xc_compile_restore(stored_xce, h TSRMLS_CC);
1406    }
1407    else {
1408        if (newlycompiled) {
1409            zend_op_array *old_active_op_array = CG(active_op_array);
1410            /* install it */
1411            CG(active_op_array) = op_array;
1412            xc_sandbox_free(&sandbox, XC_Install TSRMLS_CC);
1413            CG(active_op_array) = old_active_op_array;
1414        }
1415    }
1416    return op_array;
1417
1418err_aftersandbox:
1419    if (newlycompiled) {
1420        xc_free_php(&php TSRMLS_CC);
1421        xc_sandbox_free(&sandbox, XC_NoInstall TSRMLS_CC);
1422    }
1423
1424    if (catched) {
1425        cache->compiling = 0;
1426        cache->errors ++;
1427        zend_bailout();
1428    }
1429    return op_array;
1430}
1431/* }}} */
1432
1433/* gdb helper functions, but N/A for coredump */
1434int xc_is_rw(const void *p) /* {{{ */
1435{
1436    xc_shm_t *shm;
1437    int i;
1438    if (!xc_initized) {
1439        return 0;
1440    }
1441    for (i = 0; i < xc_php_hcache.size; i ++) {
1442        shm = xc_php_caches[i]->shm;
1443        if (shm->handlers->is_readwrite(shm, p)) {
1444            return 1;
1445        }
1446    }
1447    for (i = 0; i < xc_var_hcache.size; i ++) {
1448        shm = xc_var_caches[i]->shm;
1449        if (shm->handlers->is_readwrite(shm, p)) {
1450            return 1;
1451        }
1452    }
1453    return 0;
1454}
1455/* }}} */
1456int xc_is_ro(const void *p) /* {{{ */
1457{
1458    xc_shm_t *shm;
1459    int i;
1460    if (!xc_initized) {
1461        return 0;
1462    }
1463    for (i = 0; i < xc_php_hcache.size; i ++) {
1464        shm = xc_php_caches[i]->shm;
1465        if (shm->handlers->is_readonly(shm, p)) {
1466            return 1;
1467        }
1468    }
1469    for (i = 0; i < xc_var_hcache.size; i ++) {
1470        shm = xc_var_caches[i]->shm;
1471        if (shm->handlers->is_readonly(shm, p)) {
1472            return 1;
1473        }
1474    }
1475    return 0;
1476}
1477/* }}} */
1478int xc_is_shm(const void *p) /* {{{ */
1479{
1480    return xc_is_ro(p) || xc_is_rw(p);
1481}
1482/* }}} */
1483
1484/* {{{ xc_gc_op_array_t */
1485typedef struct {
1486    zend_uint num_args;
1487    zend_arg_info *arg_info;
1488} xc_gc_op_array_t;
1489/* }}} */
1490void xc_gc_add_op_array(zend_op_array *op_array TSRMLS_DC) /* {{{ */
1491{
1492    xc_gc_op_array_t gc_op_array;
1493    gc_op_array.num_args = op_array->num_args;
1494    gc_op_array.arg_info = op_array->arg_info;
1495    zend_hash_next_index_insert(&XG(gc_op_arrays), (void *) &gc_op_array, sizeof(gc_op_array), NULL);
1496}
1497/* }}} */
1498static void xc_gc_op_array(void *pDest) /* {{{ */
1499{
1500    xc_gc_op_array_t *op_array = (xc_gc_op_array_t *) pDest;
1501    zend_uint i;
1502    if (op_array->arg_info) {
1503        for (i = 0; i < op_array->num_args; i++) {
1504            efree((char *) ZSTR_V(op_array->arg_info[i].name));
1505            if (ZSTR_V(op_array->arg_info[i].class_name)) {
1506                efree((char *) ZSTR_V(op_array->arg_info[i].class_name));
1507            }
1508        }
1509        efree(op_array->arg_info);
1510    }
1511}
1512/* }}} */
1513
1514/* module helper function */
1515static int xc_init_constant(int module_number TSRMLS_DC) /* {{{ */
1516{
1517    typedef struct {
1518        const char *prefix;
1519        zend_uchar (*getsize)();
1520        const char *(*get)(zend_uchar i);
1521    } xc_meminfo_t;
1522    xc_meminfo_t nameinfos[] = {
1523        { "",        xc_get_op_type_count,   xc_get_op_type   },
1524        { "",        xc_get_data_type_count, xc_get_data_type },
1525        { "",        xc_get_opcode_count,    xc_get_opcode    },
1526        { "OPSPEC_", xc_get_op_spec_count,   xc_get_op_spec   },
1527        { NULL, NULL, NULL }
1528    };
1529    xc_meminfo_t* p;
1530    zend_uchar i, count;
1531    char const_name[96];
1532    int const_name_len;
1533    int undefdone = 0;
1534
1535    for (p = nameinfos; p->getsize; p ++) {
1536        count = p->getsize();
1537        for (i = 0; i < count; i ++) {
1538            const char *name = p->get(i);
1539            if (!name) continue;
1540            if (strcmp(name, "UNDEF") == 0) {
1541                if (undefdone) continue;
1542                undefdone = 1;
1543            }
1544            const_name_len = snprintf(const_name, sizeof(const_name), "XC_%s%s", p->prefix, name);
1545            zend_register_long_constant(const_name, const_name_len+1, i, CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1546        }
1547    }
1548
1549    zend_register_long_constant(ZEND_STRS("XC_SIZEOF_TEMP_VARIABLE"), sizeof(temp_variable), CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1550    zend_register_long_constant(ZEND_STRS("XC_TYPE_PHP"), XC_TYPE_PHP, CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1551    zend_register_long_constant(ZEND_STRS("XC_TYPE_VAR"), XC_TYPE_VAR, CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1552    zend_register_stringl_constant(ZEND_STRS("XCACHE_VERSION"), ZEND_STRL(XCACHE_VERSION), CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1553    zend_register_stringl_constant(ZEND_STRS("XCACHE_MODULES"), ZEND_STRL(XCACHE_MODULES), CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1554    return 0;
1555}
1556/* }}} */
1557static xc_shm_t *xc_cache_destroy(xc_cache_t **caches, xc_hash_t *hcache) /* {{{ */
1558{
1559    int i;
1560    xc_cache_t *cache;
1561    xc_shm_t *shm;
1562
1563    if (!caches) {
1564        return NULL;
1565    }
1566    shm = NULL;
1567    for (i = 0; i < hcache->size; i ++) {
1568        cache = caches[i];
1569        if (cache) {
1570            if (cache->lck) {
1571                xc_lock_destroy(cache->lck);
1572            }
1573            /* do NOT free
1574            if (cache->entries) {
1575                cache->mem->handlers->free(cache->mem, cache->entries);
1576            }
1577            cache->mem->handlers->free(cache->mem, cache);
1578            */
1579            shm = cache->shm;
1580            shm->handlers->memdestroy(cache->mem);
1581        }
1582    }
1583    free(caches);
1584    return shm;
1585}
1586/* }}} */
1587static xc_cache_t **xc_cache_init(xc_shm_t *shm, xc_hash_t *hcache, xc_hash_t *hentry, xc_hash_t *hphp, xc_shmsize_t shmsize) /* {{{ */
1588{
1589    xc_cache_t **caches = NULL, *cache;
1590    xc_mem_t *mem;
1591    time_t now = time(NULL);
1592    int i;
1593    xc_memsize_t memsize;
1594
1595    memsize = shmsize / hcache->size;
1596
1597    /* Don't let it break out of mem after ALIGNed
1598     * This is important for
1599     * Simply loop until it fit our need
1600     */
1601    while (ALIGN(memsize) * hcache->size > shmsize && ALIGN(memsize) != memsize) {
1602        if (memsize < ALIGN(1)) {
1603            CHECK(NULL, "cache too small");
1604        }
1605        memsize --;
1606    }
1607
1608    CHECK(caches = calloc(hcache->size, sizeof(xc_cache_t *)), "caches OOM");
1609
1610    for (i = 0; i < hcache->size; i ++) {
1611        CHECK(mem            = shm->handlers->meminit(shm, memsize), "Failed init memory allocator");
1612        CHECK(cache          = mem->handlers->calloc(mem, 1, sizeof(xc_cache_t)), "cache OOM");
1613        CHECK(cache->entries = mem->handlers->calloc(mem, hentry->size, sizeof(xc_entry_t*)), "entries OOM");
1614        if (hphp) {
1615            CHECK(cache->phps= mem->handlers->calloc(mem, hphp->size, sizeof(xc_entry_data_php_t*)), "phps OOM");
1616        }
1617        CHECK(cache->lck     = xc_lock_init(NULL), "can't create lock");
1618
1619        cache->hcache  = hcache;
1620        cache->hentry  = hentry;
1621        cache->hphp    = hphp;
1622        cache->shm     = shm;
1623        cache->mem     = mem;
1624        cache->cacheid = i;
1625        cache->last_gc_deletes = now;
1626        cache->last_gc_expires = now;
1627        caches[i] = cache;
1628    }
1629    return caches;
1630
1631err:
1632    if (caches) {
1633        xc_cache_destroy(caches, hcache);
1634    }
1635    return NULL;
1636}
1637/* }}} */
1638static void xc_destroy() /* {{{ */
1639{
1640    xc_shm_t *shm = NULL;
1641
1642    if (old_compile_file) {
1643        zend_compile_file = old_compile_file;
1644        old_compile_file = NULL;
1645    }
1646
1647    if (origin_compile_file) {
1648        zend_compile_file = origin_compile_file;
1649        origin_compile_file = NULL;
1650    }
1651
1652    if (xc_php_caches) {
1653        shm = xc_cache_destroy(xc_php_caches, &xc_php_hcache);
1654        xc_php_caches = NULL;
1655    }
1656
1657    if (xc_var_caches) {
1658        shm = xc_cache_destroy(xc_var_caches, &xc_var_hcache);
1659        xc_var_caches = NULL;
1660    }
1661
1662    if (shm) {
1663        xc_shm_destroy(shm);
1664    }
1665
1666    xc_initized = 0;
1667}
1668/* }}} */
1669static int xc_init(int module_number TSRMLS_DC) /* {{{ */
1670{
1671    xc_shm_t *shm;
1672    xc_shmsize_t shmsize = ALIGN(xc_php_size) + ALIGN(xc_var_size);
1673
1674    xc_php_caches = xc_var_caches = NULL;
1675    shm = NULL;
1676
1677    if (shmsize < (size_t) xc_php_size || shmsize < (size_t) xc_var_size) {
1678        zend_error(E_ERROR, "XCache: neither xcache.size nor xcache.var_size can be negative");
1679        goto err;
1680    }
1681
1682    if (xc_php_size || xc_var_size) {
1683        CHECK(shm = xc_shm_init(xc_shm_scheme, shmsize, xc_readonly_protection, xc_mmap_path, NULL), "Cannot create shm");
1684        if (!shm->handlers->can_readonly(shm)) {
1685            xc_readonly_protection = 0;
1686        }
1687
1688        if (xc_php_size) {
1689            old_compile_file = zend_compile_file;
1690            zend_compile_file = xc_compile_file;
1691
1692            CHECK(xc_php_caches = xc_cache_init(shm, &xc_php_hcache, &xc_php_hentry, &xc_php_hentry, xc_php_size), "failed init opcode cache");
1693        }
1694
1695        if (xc_var_size) {
1696            CHECK(xc_var_caches = xc_cache_init(shm, &xc_var_hcache, &xc_var_hentry, NULL, xc_var_size), "failed init variable cache");
1697        }
1698    }
1699    return SUCCESS;
1700
1701err:
1702    if (xc_php_caches || xc_var_caches) {
1703        xc_destroy();
1704        /* shm destroied in xc_destroy() */
1705    }
1706    else if (shm) {
1707        xc_destroy();
1708        xc_shm_destroy(shm);
1709    }
1710    return 0;
1711}
1712/* }}} */
1713static void xc_request_init(TSRMLS_D) /* {{{ */
1714{
1715    int i;
1716
1717    if (!XG(internal_table_copied)) {
1718        zend_function tmp_func;
1719        xc_cest_t tmp_cest;
1720
1721        zend_hash_destroy(&XG(internal_function_table));
1722        zend_hash_destroy(&XG(internal_class_table));
1723
1724        zend_hash_init_ex(&XG(internal_function_table), 100, NULL, NULL, 1, 0);
1725        zend_hash_init_ex(&XG(internal_class_table),    10,  NULL, NULL, 1, 0);
1726
1727        zend_hash_copy(&XG(internal_function_table), CG(function_table), NULL, &tmp_func, sizeof(tmp_func));
1728        zend_hash_copy(&XG(internal_class_table), CG(class_table), NULL, &tmp_cest, sizeof(tmp_cest));
1729
1730        XG(internal_table_copied) = 1;
1731    }
1732    if (xc_php_hcache.size && !XG(php_holds)) {
1733        XG(php_holds) = calloc(xc_php_hcache.size, sizeof(xc_stack_t));
1734        for (i = 0; i < xc_php_hcache.size; i ++) {
1735            xc_stack_init(&XG(php_holds[i]));
1736        }
1737    }
1738
1739    if (xc_initized && xc_var_hcache.size && !XG(var_holds)) {
1740        XG(var_holds) = calloc(xc_var_hcache.size, sizeof(xc_stack_t));
1741        for (i = 0; i < xc_var_hcache.size; i ++) {
1742            xc_stack_init(&XG(var_holds[i]));
1743        }
1744    }
1745
1746    zend_hash_init(&XG(gc_op_arrays), 32, NULL, xc_gc_op_array, 0);
1747
1748#if PHP_API_VERSION <= 20041225
1749    XG(request_time) = time(NULL);
1750#else
1751    XG(request_time) = sapi_get_request_time(TSRMLS_C);
1752#endif
1753
1754#ifdef HAVE_XCACHE_COVERAGER
1755    xc_coverager_request_init(TSRMLS_C);
1756#endif
1757}
1758/* }}} */
1759static void xc_request_shutdown(TSRMLS_D) /* {{{ */
1760{
1761    xc_entry_unholds(TSRMLS_C);
1762    zend_hash_destroy(&XG(gc_op_arrays));
1763    xc_gc_expires_php(TSRMLS_C);
1764    xc_gc_expires_var(TSRMLS_C);
1765    xc_gc_deletes(TSRMLS_C);
1766#ifdef HAVE_XCACHE_COVERAGER
1767    xc_coverager_request_shutdown(TSRMLS_C);
1768#endif
1769}
1770/* }}} */
1771/* {{{ PHP_GINIT_FUNCTION(xcache) */
1772static
1773#ifdef PHP_GINIT_FUNCTION
1774PHP_GINIT_FUNCTION(xcache)
1775#else
1776void xc_init_globals(zend_xcache_globals* xcache_globals TSRMLS_DC)
1777#endif
1778{
1779    memset(xcache_globals, 0, sizeof(zend_xcache_globals));
1780
1781    zend_hash_init_ex(&xcache_globals->internal_function_table, 1, NULL, NULL, 1, 0);
1782    zend_hash_init_ex(&xcache_globals->internal_class_table,    1, NULL, NULL, 1, 0);
1783}
1784/* }}} */
1785/* {{{ PHP_GSHUTDOWN_FUNCTION(xcache) */
1786static
1787#ifdef PHP_GSHUTDOWN_FUNCTION
1788PHP_GSHUTDOWN_FUNCTION(xcache)
1789#else
1790void xc_shutdown_globals(zend_xcache_globals* xcache_globals TSRMLS_DC)
1791#endif
1792{
1793    int i;
1794
1795    if (xcache_globals->php_holds != NULL) {
1796        for (i = 0; i < xc_php_hcache.size; i ++) {
1797            xc_stack_destroy(&xcache_globals->php_holds[i]);
1798        }
1799        free(xcache_globals->php_holds);
1800        xcache_globals->php_holds = NULL;
1801    }
1802
1803    if (xcache_globals->var_holds != NULL) {
1804        for (i = 0; i < xc_var_hcache.size; i ++) {
1805            xc_stack_destroy(&xcache_globals->var_holds[i]);
1806        }
1807        free(xcache_globals->var_holds);
1808        xcache_globals->var_holds = NULL;
1809    }
1810
1811    if (xcache_globals->internal_table_copied) {
1812        zend_hash_destroy(&xcache_globals->internal_function_table);
1813        zend_hash_destroy(&xcache_globals->internal_class_table);
1814    }
1815}
1816/* }}} */
1817
1818/* user functions */
1819static int xcache_admin_auth_check(TSRMLS_D) /* {{{ */
1820{
1821    zval **server = NULL;
1822    zval **user = NULL;
1823    zval **pass = NULL;
1824    char *admin_user = NULL;
1825    char *admin_pass = NULL;
1826    HashTable *ht;
1827
1828    if (cfg_get_string("xcache.admin.user", &admin_user) == FAILURE || !admin_user[0]) {
1829        admin_user = NULL;
1830    }
1831    if (cfg_get_string("xcache.admin.pass", &admin_pass) == FAILURE || !admin_pass[0]) {
1832        admin_pass = NULL;
1833    }
1834
1835    if (admin_user == NULL || admin_pass == NULL) {
1836        php_error_docref(NULL TSRMLS_CC, E_ERROR, "xcache.admin.user and xcache.admin.pass is required");
1837        zend_bailout();
1838    }
1839    if (strlen(admin_pass) != 32) {
1840        php_error_docref(NULL TSRMLS_CC, E_ERROR, "unexpect %lu bytes of xcache.admin.pass, expected 32 bytes, the password after md5()", (unsigned long) strlen(admin_pass));
1841        zend_bailout();
1842    }
1843
1844#ifdef ZEND_ENGINE_2_1
1845    zend_is_auto_global("_SERVER", sizeof("_SERVER") - 1 TSRMLS_CC);
1846#endif
1847    if (zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **) &server) != SUCCESS || Z_TYPE_PP(server) != IS_ARRAY) {
1848        php_error_docref(NULL TSRMLS_CC, E_ERROR, "_SERVER is corrupted");
1849        zend_bailout();
1850    }
1851    ht = HASH_OF((*server));
1852
1853    if (zend_hash_find(ht, "PHP_AUTH_USER", sizeof("PHP_AUTH_USER"), (void **) &user) == FAILURE) {
1854        user = NULL;
1855    }
1856    else if (Z_TYPE_PP(user) != IS_STRING) {
1857        user = NULL;
1858    }
1859
1860    if (zend_hash_find(ht, "PHP_AUTH_PW", sizeof("PHP_AUTH_PW"), (void **) &pass) == FAILURE) {
1861        pass = NULL;
1862    }
1863    else if (Z_TYPE_PP(pass) != IS_STRING) {
1864        pass = NULL;
1865    }
1866
1867    if (user != NULL && pass != NULL && strcmp(admin_user, Z_STRVAL_PP(user)) == 0) {
1868        PHP_MD5_CTX context;
1869        char md5str[33];
1870        unsigned char digest[16];
1871
1872        PHP_MD5Init(&context);
1873        PHP_MD5Update(&context, (unsigned char *) Z_STRVAL_PP(pass), Z_STRLEN_PP(pass));
1874        PHP_MD5Final(digest, &context);
1875
1876        md5str[0] = '\0';
1877        make_digest(md5str, digest);
1878        if (strcmp(admin_pass, md5str) == 0) {
1879            return 1;
1880        }
1881    }
1882
1883#define STR "WWW-authenticate: Basic Realm=\"XCache Administration\""
1884    sapi_add_header_ex(STR, sizeof(STR) - 1, 1, 1 TSRMLS_CC);
1885#undef STR
1886#define STR "HTTP/1.0 401 Unauthorized"
1887    sapi_add_header_ex(STR, sizeof(STR) - 1, 1, 1 TSRMLS_CC);
1888#undef STR
1889    ZEND_PUTS("XCache Auth Failed. User and Password is case sense\n");
1890
1891    zend_bailout();
1892    return 0;
1893}
1894/* }}} */
1895/* {{{ xcache_admin_operate */
1896typedef enum { XC_OP_COUNT, XC_OP_INFO, XC_OP_LIST, XC_OP_CLEAR } xcache_op_type;
1897static void xcache_admin_operate(xcache_op_type optype, INTERNAL_FUNCTION_PARAMETERS)
1898{
1899    long type;
1900    int size;
1901    xc_cache_t **caches, *cache;
1902    long id = 0;
1903
1904    xcache_admin_auth_check(TSRMLS_C);
1905
1906    if (!xc_initized) {
1907        RETURN_NULL();
1908    }
1909
1910    if (optype == XC_OP_COUNT) {
1911        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &type) == FAILURE) {
1912            return;
1913        }
1914    }
1915    else if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ll", &type, &id) == FAILURE) {
1916        return;
1917    }
1918
1919    switch (type) {
1920        case XC_TYPE_PHP:
1921            size = xc_php_hcache.size;
1922            caches = xc_php_caches;
1923            break;
1924
1925        case XC_TYPE_VAR:
1926            size = xc_var_hcache.size;
1927            caches = xc_var_caches;
1928            break;
1929
1930        default:
1931            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Unknown type %ld", type);
1932            RETURN_FALSE;
1933    }
1934
1935    switch (optype) {
1936        case XC_OP_COUNT:
1937            RETURN_LONG(size)
1938            break;
1939
1940        case XC_OP_INFO:
1941        case XC_OP_LIST:
1942            if (id < 0 || id >= size) {
1943                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cache not exists");
1944                RETURN_FALSE;
1945            }
1946
1947            array_init(return_value);
1948
1949            cache = caches[id];
1950            ENTER_LOCK(cache) {
1951                if (optype == XC_OP_INFO) {
1952                    xc_fillinfo_dmz(type, cache, return_value TSRMLS_CC);
1953                }
1954                else {
1955                    xc_filllist_dmz(cache, return_value TSRMLS_CC);
1956                }
1957            } LEAVE_LOCK(cache);
1958            break;
1959        case XC_OP_CLEAR:
1960            {
1961                xc_entry_t *e, *next;
1962                int i, c;
1963
1964                if (id < 0 || id >= size) {
1965                    php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cache not exists");
1966                    RETURN_FALSE;
1967                }
1968
1969                cache = caches[id];
1970                ENTER_LOCK(cache) {
1971                    for (i = 0, c = cache->hentry->size; i < c; i ++) {
1972                        for (e = cache->entries[i]; e; e = next) {
1973                            next = e->next;
1974                            xc_entry_remove_dmz(e TSRMLS_CC);
1975                        }
1976                        cache->entries[i] = NULL;
1977                    }
1978                } LEAVE_LOCK(cache);
1979                xc_gc_deletes(TSRMLS_C);
1980            }
1981            break;
1982
1983        default:
1984            assert(0);
1985    }
1986}
1987/* }}} */
1988/* {{{ proto int xcache_count(int type)
1989   Return count of cache on specified cache type */
1990PHP_FUNCTION(xcache_count)
1991{
1992    xcache_admin_operate(XC_OP_COUNT, INTERNAL_FUNCTION_PARAM_PASSTHRU);
1993}
1994/* }}} */
1995/* {{{ proto array xcache_info(int type, int id)
1996   Get cache info by id on specified cache type */
1997PHP_FUNCTION(xcache_info)
1998{
1999    xcache_admin_operate(XC_OP_INFO, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2000}
2001/* }}} */
2002/* {{{ proto array xcache_list(int type, int id)
2003   Get cache entries list by id on specified cache type */
2004PHP_FUNCTION(xcache_list)
2005{
2006    xcache_admin_operate(XC_OP_LIST, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2007}
2008/* }}} */
2009/* {{{ proto array xcache_clear_cache(int type, int id)
2010   Clear cache by id on specified cache type */
2011PHP_FUNCTION(xcache_clear_cache)
2012{
2013    xcache_admin_operate(XC_OP_CLEAR, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2014}
2015/* }}} */
2016
2017#define VAR_DISABLED_WARNING() do { \
2018        php_error_docref(NULL TSRMLS_CC, E_WARNING, "xcache.var_size is either 0 or too small to enable var data caching"); \
2019} while (0)
2020
2021static int xc_entry_init_key_var(xc_entry_t *xce, zval *name TSRMLS_DC) /* {{{ */
2022{
2023    xc_hash_value_t hv;
2024    int cacheid;
2025
2026    switch (Z_TYPE_P(name)) {
2027#ifdef IS_UNICODE
2028        case IS_UNICODE:
2029#endif
2030        case IS_STRING:
2031            break;
2032        default:
2033#ifdef IS_UNICODE
2034            convert_to_text(name);
2035#else
2036            convert_to_string(name);
2037#endif
2038    }
2039#ifdef IS_UNICODE
2040    xce->name_type = name->type;
2041#endif
2042    xce->name = name->value;
2043
2044    hv = xc_entry_hash_var(xce TSRMLS_CC);
2045
2046    cacheid = (hv & xc_var_hcache.mask);
2047    xce->cache = xc_var_caches[cacheid];
2048    hv >>= xc_var_hcache.bits;
2049    xce->hvalue = (hv & xc_var_hentry.mask);
2050
2051    xce->type = XC_TYPE_VAR;
2052    return SUCCESS;
2053}
2054/* }}} */
2055/* {{{ proto mixed xcache_get(string name)
2056   Get cached data by specified name */
2057PHP_FUNCTION(xcache_get)
2058{
2059    xc_entry_t xce, *stored_xce;
2060    xc_entry_data_var_t var;
2061    zval *name;
2062    int found = 0;
2063
2064    if (!xc_var_caches) {
2065        VAR_DISABLED_WARNING();
2066        RETURN_NULL();
2067    }
2068
2069    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &name) == FAILURE) {
2070        return;
2071    }
2072    xce.data.var = &var;
2073    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2074
2075    ENTER_LOCK(xce.cache) {
2076        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2077        if (stored_xce) {
2078            if (!VAR_ENTRY_EXPIRED(stored_xce)) {
2079                found = 1;
2080                xc_processor_restore_zval(return_value, stored_xce->data.var->value, stored_xce->data.var->have_references TSRMLS_CC);
2081                /* return */
2082                break;
2083            }
2084            else {
2085                xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2086            }
2087        }
2088
2089        RETVAL_NULL();
2090    } LEAVE_LOCK(xce.cache);
2091    if (found) {
2092        xce.cache->hits ++;
2093    }
2094    else {
2095        xce.cache->misses ++;
2096    }
2097}
2098/* }}} */
2099/* {{{ proto bool  xcache_set(string name, mixed value [, int ttl])
2100   Store data to cache by specified name */
2101PHP_FUNCTION(xcache_set)
2102{
2103    xc_entry_t xce, *stored_xce;
2104    xc_entry_data_var_t var;
2105    zval *name;
2106    zval *value;
2107
2108    if (!xc_var_caches) {
2109        VAR_DISABLED_WARNING();
2110        RETURN_NULL();
2111    }
2112
2113    xce.ttl = XG(var_ttl);
2114    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zz|l", &name, &value, &xce.ttl) == FAILURE) {
2115        return;
2116    }
2117
2118    /* max ttl */
2119    if (xc_var_maxttl && (!xce.ttl || xce.ttl > xc_var_maxttl)) {
2120        xce.ttl = xc_var_maxttl;
2121    }
2122
2123    xce.data.var = &var;
2124    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2125
2126    ENTER_LOCK(xce.cache) {
2127        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2128        if (stored_xce) {
2129            xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2130        }
2131        var.value = value;
2132        RETVAL_BOOL(xc_entry_store_dmz(&xce TSRMLS_CC) != NULL ? 1 : 0);
2133    } LEAVE_LOCK(xce.cache);
2134}
2135/* }}} */
2136/* {{{ proto bool  xcache_isset(string name)
2137   Check if an entry exists in cache by specified name */
2138PHP_FUNCTION(xcache_isset)
2139{
2140    xc_entry_t xce, *stored_xce;
2141    xc_entry_data_var_t var;
2142    zval *name;
2143    int found = 0;
2144
2145    if (!xc_var_caches) {
2146        VAR_DISABLED_WARNING();
2147        RETURN_FALSE;
2148    }
2149
2150    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &name) == FAILURE) {
2151        return;
2152    }
2153    xce.data.var = &var;
2154    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2155
2156    ENTER_LOCK(xce.cache) {
2157        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2158        if (stored_xce) {
2159            if (!VAR_ENTRY_EXPIRED(stored_xce)) {
2160                found = 1;
2161                RETVAL_TRUE;
2162                /* return */
2163                break;
2164            }
2165            else {
2166                xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2167            }
2168        }
2169
2170        RETVAL_FALSE;
2171    } LEAVE_LOCK(xce.cache);
2172    if (found) {
2173        xce.cache->hits ++;
2174    }
2175    else {
2176        xce.cache->misses ++;
2177    }
2178}
2179/* }}} */
2180/* {{{ proto bool  xcache_unset(string name)
2181   Unset existing data in cache by specified name */
2182PHP_FUNCTION(xcache_unset)
2183{
2184    xc_entry_t xce, *stored_xce;
2185    xc_entry_data_var_t var;
2186    zval *name;
2187
2188    if (!xc_var_caches) {
2189        VAR_DISABLED_WARNING();
2190        RETURN_FALSE;
2191    }
2192
2193    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &name) == FAILURE) {
2194        return;
2195    }
2196    xce.data.var = &var;
2197    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2198
2199    ENTER_LOCK(xce.cache) {
2200        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2201        if (stored_xce) {
2202            xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2203            RETVAL_TRUE;
2204        }
2205        else {
2206            RETVAL_FALSE;
2207        }
2208    } LEAVE_LOCK(xce.cache);
2209}
2210/* }}} */
2211static inline void xc_var_inc_dec(int inc, INTERNAL_FUNCTION_PARAMETERS) /* {{{ */
2212{
2213    xc_entry_t xce, *stored_xce;
2214    xc_entry_data_var_t var, *stored_var;
2215    zval *name;
2216    long count = 1;
2217    long value = 0;
2218    zval oldzval;
2219
2220    if (!xc_var_caches) {
2221        VAR_DISABLED_WARNING();
2222        RETURN_NULL();
2223    }
2224
2225    xce.ttl = XG(var_ttl);
2226    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|ll", &name, &count, &xce.ttl) == FAILURE) {
2227        return;
2228    }
2229
2230    /* max ttl */
2231    if (xc_var_maxttl && (!xce.ttl || xce.ttl > xc_var_maxttl)) {
2232        xce.ttl = xc_var_maxttl;
2233    }
2234
2235    xce.data.var = &var;
2236    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2237
2238    ENTER_LOCK(xce.cache) {
2239        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2240        if (stored_xce) {
2241            TRACE("incdec: gotxce %s", xce.name.str.val);
2242            /* timeout */
2243            if (VAR_ENTRY_EXPIRED(stored_xce)) {
2244                TRACE("%s", "incdec: expired");
2245                xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2246                stored_xce = NULL;
2247            }
2248            else {
2249                /* do it in place */
2250                stored_var = stored_xce->data.var;
2251                if (Z_TYPE_P(stored_var->value) == IS_LONG) {
2252                    zval *zv;
2253                    stored_xce->ctime = XG(request_time);
2254                    stored_xce->ttl   = xce.ttl;
2255                    TRACE("%s", "incdec: islong");
2256                    value = Z_LVAL_P(stored_var->value);
2257                    value += (inc == 1 ? count : - count);
2258                    RETVAL_LONG(value);
2259
2260                    zv = (zval *) xce.cache->shm->handlers->to_readwrite(xce.cache->shm, (char *) stored_var->value);
2261                    Z_LVAL_P(zv) = value;
2262                    break; /* leave lock */
2263                }
2264                else {
2265                    TRACE("%s", "incdec: notlong");
2266                    xc_processor_restore_zval(&oldzval, stored_xce->data.var->value, stored_xce->data.var->have_references TSRMLS_CC);
2267                    convert_to_long(&oldzval);
2268                    value = Z_LVAL(oldzval);
2269                    zval_dtor(&oldzval);
2270                }
2271            }
2272        }
2273        else {
2274            TRACE("incdec: %s not found", xce.name.str.val);
2275        }
2276
2277        value += (inc == 1 ? count : - count);
2278        RETVAL_LONG(value);
2279        var.value = return_value;
2280
2281        if (stored_xce) {
2282            xce.atime = stored_xce->atime;
2283            xce.ctime = stored_xce->ctime;
2284            xce.hits  = stored_xce->hits;
2285            xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2286        }
2287        xc_entry_store_dmz(&xce TSRMLS_CC);
2288
2289    } LEAVE_LOCK(xce.cache);
2290}
2291/* }}} */
2292/* {{{ proto int xcache_inc(string name [, int value [, int ttl]])
2293   Increase an int counter in cache by specified name, create it if not exists */
2294PHP_FUNCTION(xcache_inc)
2295{
2296    xc_var_inc_dec(1, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2297}
2298/* }}} */
2299/* {{{ proto int xcache_dec(string name [, int value [, int ttl]])
2300   Decrease an int counter in cache by specified name, create it if not exists */
2301PHP_FUNCTION(xcache_dec)
2302{
2303    xc_var_inc_dec(-1, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2304}
2305/* }}} */
2306/* {{{ proto string xcache_asm(string filename)
2307 */
2308#ifdef HAVE_XCACHE_ASSEMBLER
2309PHP_FUNCTION(xcache_asm)
2310{
2311}
2312#endif
2313/* }}} */
2314#ifdef HAVE_XCACHE_DISASSEMBLER
2315/* {{{ proto array  xcache_dasm_file(string filename)
2316   Disassemble file into opcode array by filename */
2317PHP_FUNCTION(xcache_dasm_file)
2318{
2319    char *filename;
2320    int filename_len;
2321
2322    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &filename, &filename_len) == FAILURE) {
2323        return;
2324    }
2325    if (!filename_len) RETURN_FALSE;
2326
2327    xc_dasm_file(return_value, filename TSRMLS_CC);
2328}
2329/* }}} */
2330/* {{{ proto array  xcache_dasm_string(string code)
2331   Disassemble php code into opcode array */
2332PHP_FUNCTION(xcache_dasm_string)
2333{
2334    zval *code;
2335
2336    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &code) == FAILURE) {
2337        return;
2338    }
2339    xc_dasm_string(return_value, code TSRMLS_CC);
2340}
2341/* }}} */
2342#endif
2343/* {{{ proto string xcache_encode(string filename)
2344   Encode php file into XCache opcode encoded format */
2345#ifdef HAVE_XCACHE_ENCODER
2346PHP_FUNCTION(xcache_encode)
2347{
2348}
2349#endif
2350/* }}} */
2351/* {{{ proto bool xcache_decode_file(string filename)
2352   Decode(load) opcode from XCache encoded format file */
2353#ifdef HAVE_XCACHE_DECODER
2354PHP_FUNCTION(xcache_decode_file)
2355{
2356}
2357#endif
2358/* }}} */
2359/* {{{ proto bool xcache_decode_string(string data)
2360   Decode(load) opcode from XCache encoded format data */
2361#ifdef HAVE_XCACHE_DECODER
2362PHP_FUNCTION(xcache_decode_string)
2363{
2364}
2365#endif
2366/* }}} */
2367/* {{{ xc_call_getter */
2368typedef const char *(xc_name_getter_t)(zend_uchar type);
2369static void xc_call_getter(xc_name_getter_t getter, int count, INTERNAL_FUNCTION_PARAMETERS)
2370{
2371    long spec;
2372    const char *name;
2373
2374    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &spec) == FAILURE) {
2375        return;
2376    }
2377    if (spec >= 0 && spec < count) {
2378        name = getter((zend_uchar) spec);
2379        if (name) {
2380            /* RETURN_STRING */
2381            int len = strlen(name);
2382            return_value->value.str.len = len;
2383            return_value->value.str.val = estrndup(name, len);
2384            return_value->type = IS_STRING; 
2385            return;
2386        }
2387    }
2388    RETURN_NULL();
2389}
2390/* }}} */
2391/* {{{ proto string xcache_get_op_type(int op_type) */
2392PHP_FUNCTION(xcache_get_op_type)
2393{
2394    xc_call_getter(xc_get_op_type, xc_get_op_type_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2395}
2396/* }}} */
2397/* {{{ proto string xcache_get_data_type(int type) */
2398PHP_FUNCTION(xcache_get_data_type)
2399{
2400    xc_call_getter(xc_get_data_type, xc_get_data_type_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2401}
2402/* }}} */
2403/* {{{ proto string xcache_get_opcode(int opcode) */
2404PHP_FUNCTION(xcache_get_opcode)
2405{
2406    xc_call_getter(xc_get_opcode, xc_get_opcode_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2407}
2408/* }}} */
2409/* {{{ proto string xcache_get_op_spec(int op_type) */
2410PHP_FUNCTION(xcache_get_op_spec)
2411{
2412    xc_call_getter(xc_get_op_spec, xc_get_op_spec_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2413}
2414/* }}} */
2415#ifdef HAVE_XCACHE_OPCODE_SPEC_DEF
2416/* {{{ proto string xcache_get_opcode_spec(int opcode) */
2417PHP_FUNCTION(xcache_get_opcode_spec)
2418{
2419    long spec;
2420    const xc_opcode_spec_t *opspec;
2421
2422    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &spec) == FAILURE) {
2423        return;
2424    }
2425    if ((zend_uchar) spec <= xc_get_opcode_spec_count()) {
2426        opspec = xc_get_opcode_spec((zend_uchar) spec);
2427        if (opspec) {
2428            array_init(return_value);
2429            add_assoc_long_ex(return_value, ZEND_STRS("ext"), opspec->ext);
2430            add_assoc_long_ex(return_value, ZEND_STRS("op1"), opspec->op1);
2431            add_assoc_long_ex(return_value, ZEND_STRS("op2"), opspec->op2);
2432            add_assoc_long_ex(return_value, ZEND_STRS("res"), opspec->res);
2433            return;
2434        }
2435    }
2436    RETURN_NULL();
2437}
2438/* }}} */
2439#endif
2440/* {{{ proto mixed xcache_get_special_value(zval value) */
2441PHP_FUNCTION(xcache_get_special_value)
2442{
2443    zval *value;
2444
2445    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &value) == FAILURE) {
2446        return;
2447    }
2448
2449    if (value->type == IS_CONSTANT) {
2450        *return_value = *value;
2451        zval_copy_ctor(return_value);
2452        return_value->type = UNISW(IS_STRING, UG(unicode) ? IS_UNICODE : IS_STRING);
2453        return;
2454    }
2455
2456    if (value->type == IS_CONSTANT_ARRAY) {
2457        *return_value = *value;
2458        zval_copy_ctor(return_value);
2459        return_value->type = IS_ARRAY;
2460        return;
2461    }
2462
2463    RETURN_NULL();
2464}
2465/* }}} */
2466/* {{{ proto string xcache_coredump(int op_type) */
2467PHP_FUNCTION(xcache_coredump)
2468{
2469    if (xc_test) {
2470        raise(SIGSEGV);
2471    }
2472    else {
2473        php_error_docref(NULL TSRMLS_CC, E_WARNING, "xcache.test must be enabled to test xcache_coredump()");
2474    }
2475}
2476/* }}} */
2477/* {{{ proto string xcache_is_autoglobal(string name) */
2478PHP_FUNCTION(xcache_is_autoglobal)
2479{
2480    char *name;
2481    int name_len;
2482
2483    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &name, &name_len) == FAILURE) {
2484        return;
2485    }
2486
2487    RETURN_BOOL(zend_hash_exists(CG(auto_globals), name, name_len + 1));
2488}
2489/* }}} */
2490static function_entry xcache_functions[] = /* {{{ */
2491{
2492    PHP_FE(xcache_count,             NULL)
2493    PHP_FE(xcache_info,              NULL)
2494    PHP_FE(xcache_list,              NULL)
2495    PHP_FE(xcache_clear_cache,       NULL)
2496    PHP_FE(xcache_coredump,          NULL)
2497#ifdef HAVE_XCACHE_ASSEMBLER
2498    PHP_FE(xcache_asm,               NULL)
2499#endif
2500#ifdef HAVE_XCACHE_DISASSEMBLER
2501    PHP_FE(xcache_dasm_file,         NULL)
2502    PHP_FE(xcache_dasm_string,       NULL)
2503#endif
2504#ifdef HAVE_XCACHE_ENCODER
2505    PHP_FE(xcache_encode,            NULL)
2506#endif
2507#ifdef HAVE_XCACHE_DECODER
2508    PHP_FE(xcache_decode_file,       NULL)
2509    PHP_FE(xcache_decode_string,     NULL)
2510#endif
2511#ifdef HAVE_XCACHE_COVERAGER
2512    PHP_FE(xcache_coverager_decode,  NULL)
2513    PHP_FE(xcache_coverager_start,   NULL)
2514    PHP_FE(xcache_coverager_stop,    NULL)
2515    PHP_FE(xcache_coverager_get,     NULL)
2516#endif
2517    PHP_FE(xcache_get_special_value, NULL)
2518    PHP_FE(xcache_get_op_type,       NULL)
2519    PHP_FE(xcache_get_data_type,     NULL)
2520    PHP_FE(xcache_get_opcode,        NULL)
2521#ifdef HAVE_XCACHE_OPCODE_SPEC_DEF
2522    PHP_FE(xcache_get_opcode_spec,   NULL)
2523#endif
2524    PHP_FE(xcache_is_autoglobal,     NULL)
2525    PHP_FE(xcache_inc,               NULL)
2526    PHP_FE(xcache_dec,               NULL)
2527    PHP_FE(xcache_get,               NULL)
2528    PHP_FE(xcache_set,               NULL)
2529    PHP_FE(xcache_isset,             NULL)
2530    PHP_FE(xcache_unset,             NULL)
2531    {NULL, NULL,                     NULL}
2532};
2533/* }}} */
2534
2535/* old signal handlers {{{ */
2536typedef void (*xc_sighandler_t)(int);
2537#define FOREACH_SIG(sig) static xc_sighandler_t old_##sig##_handler = NULL
2538#include "foreachcoresig.h"
2539#undef FOREACH_SIG
2540/* }}} */
2541static void xcache_signal_handler(int sig);
2542static void xcache_restore_signal_handler() /* {{{ */
2543{
2544#define FOREACH_SIG(sig) do { \
2545    if (old_##sig##_handler != xcache_signal_handler) { \
2546        signal(sig, old_##sig##_handler); \
2547    } \
2548    else { \
2549        signal(sig, SIG_DFL); \
2550    } \
2551} while (0)
2552#include "foreachcoresig.h"
2553#undef FOREACH_SIG
2554}
2555/* }}} */
2556static void xcache_init_signal_handler() /* {{{ */
2557{
2558#define FOREACH_SIG(sig) \
2559    old_##sig##_handler = signal(sig, xcache_signal_handler)
2560#include "foreachcoresig.h"
2561#undef FOREACH_SIG
2562}
2563/* }}} */
2564static void xcache_signal_handler(int sig) /* {{{ */
2565{
2566    xcache_restore_signal_handler();
2567    if (xc_coredump_dir && xc_coredump_dir[0]) {
2568        chdir(xc_coredump_dir);
2569    }
2570    raise(sig);
2571}
2572/* }}} */
2573
2574/* {{{ PHP_INI */
2575
2576static PHP_INI_MH(xc_OnUpdateDummy)
2577{
2578    return SUCCESS;
2579}
2580
2581static PHP_INI_MH(xc_OnUpdateULong)
2582{
2583    zend_ulong *p = (zend_ulong *) mh_arg1;
2584
2585    *p = (zend_ulong) atoi(new_value);
2586    return SUCCESS;
2587}
2588
2589static PHP_INI_MH(xc_OnUpdateBool)
2590{
2591    zend_bool *p = (zend_bool *)mh_arg1;
2592
2593    if (strncasecmp("on", new_value, sizeof("on"))) {
2594        *p = (zend_bool) atoi(new_value);
2595    }
2596    else {
2597        *p = (zend_bool) 1;
2598    }
2599    return SUCCESS;
2600}
2601
2602static PHP_INI_MH(xc_OnUpdateString)
2603{
2604    char **p = (char**)mh_arg1;
2605    if (*p) {
2606        pefree(*p, 1);
2607    }
2608    *p = pemalloc(strlen(new_value) + 1, 1);
2609    strcpy(*p, new_value);
2610    return SUCCESS;
2611}
2612
2613#ifndef ZEND_ENGINE_2
2614#define OnUpdateLong OnUpdateInt
2615#endif
2616
2617#ifdef ZEND_WIN32
2618#   define DEFAULT_PATH "xcache"
2619#else
2620#   define DEFAULT_PATH "/dev/zero"
2621#endif
2622PHP_INI_BEGIN()
2623    PHP_INI_ENTRY1     ("xcache.mmap_path",     DEFAULT_PATH, PHP_INI_SYSTEM, xc_OnUpdateString,   &xc_mmap_path)
2624    PHP_INI_ENTRY1     ("xcache.coredump_directory",      "", PHP_INI_SYSTEM, xc_OnUpdateString,   &xc_coredump_dir)
2625    PHP_INI_ENTRY1     ("xcache.test",                   "0", PHP_INI_SYSTEM, xc_OnUpdateBool,     &xc_test)
2626    PHP_INI_ENTRY1     ("xcache.readonly_protection",    "0", PHP_INI_SYSTEM, xc_OnUpdateBool,     &xc_readonly_protection)
2627    /* opcode cache */
2628    PHP_INI_ENTRY1     ("xcache.size",                   "0", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2629    PHP_INI_ENTRY1     ("xcache.count",                  "1", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2630    PHP_INI_ENTRY1     ("xcache.slots",                 "8K", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2631    PHP_INI_ENTRY1     ("xcache.shm_scheme",          "mmap", PHP_INI_SYSTEM, xc_OnUpdateString,   &xc_shm_scheme)
2632    PHP_INI_ENTRY1     ("xcache.ttl",                    "0", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_php_ttl)
2633    PHP_INI_ENTRY1     ("xcache.gc_interval",            "0", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_php_gc_interval)
2634    /* var cache */
2635    PHP_INI_ENTRY1     ("xcache.var_size",               "0", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2636    PHP_INI_ENTRY1     ("xcache.var_count",              "1", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2637    PHP_INI_ENTRY1     ("xcache.var_slots",             "8K", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2638    PHP_INI_ENTRY1     ("xcache.var_maxttl",             "0", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_var_maxttl)
2639    PHP_INI_ENTRY1     ("xcache.var_gc_interval",      "120", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_var_gc_interval)
2640
2641    STD_PHP_INI_BOOLEAN("xcache.cacher",                 "1", PHP_INI_ALL,    OnUpdateBool,        cacher,            zend_xcache_globals, xcache_globals)
2642    STD_PHP_INI_BOOLEAN("xcache.stat",                   "1", PHP_INI_ALL,    OnUpdateBool,        stat,              zend_xcache_globals, xcache_globals)
2643    STD_PHP_INI_BOOLEAN("xcache.experimental",           "0", PHP_INI_ALL,    OnUpdateBool,        experimental,      zend_xcache_globals, xcache_globals)
2644#ifdef HAVE_XCACHE_OPTIMIZER
2645    STD_PHP_INI_BOOLEAN("xcache.optimizer",              "0", PHP_INI_ALL,    OnUpdateBool,        optimizer,         zend_xcache_globals, xcache_globals)
2646#endif
2647    STD_PHP_INI_ENTRY  ("xcache.var_ttl",                "0", PHP_INI_ALL,    OnUpdateLong,        var_ttl,           zend_xcache_globals, xcache_globals)
2648#ifdef HAVE_XCACHE_COVERAGER
2649    STD_PHP_INI_BOOLEAN("xcache.coverager"      ,        "0", PHP_INI_ALL,    OnUpdateBool,        coverager,         zend_xcache_globals, xcache_globals)
2650    PHP_INI_ENTRY1     ("xcache.coveragedump_directory",  "", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2651#endif
2652PHP_INI_END()
2653/* }}} */
2654/* {{{ PHP_MINFO_FUNCTION(xcache) */
2655static PHP_MINFO_FUNCTION(xcache)
2656{
2657    char buf[100];
2658    char *ptr;
2659    int left, len;
2660    xc_shm_scheme_t *scheme;
2661    char *covdumpdir;
2662
2663    php_info_print_table_start();
2664    php_info_print_table_header(2, "XCache Support", "enabled");
2665    php_info_print_table_row(2, "Version", XCACHE_VERSION);
2666    php_info_print_table_row(2, "Modules Built", XCACHE_MODULES);
2667    php_info_print_table_row(2, "Readonly Protection", xc_readonly_protection ? "enabled" : "N/A");
2668
2669    if (xc_php_size) {
2670        ptr = _php_math_number_format(xc_php_size, 0, '.', ',');
2671        snprintf(buf, sizeof(buf), "enabled, %s bytes, %d split(s), with %d slots each", ptr, xc_php_hcache.size, xc_php_hentry.size);
2672        php_info_print_table_row(2, "Opcode Cache", buf);
2673        efree(ptr);
2674    }
2675    else {
2676        php_info_print_table_row(2, "Opcode Cache", "disabled");
2677    }
2678    if (xc_var_size) {
2679        ptr = _php_math_number_format(xc_var_size, 0, '.', ',');
2680        snprintf(buf, sizeof(buf), "enabled, %s bytes, %d split(s), with %d slots each", ptr, xc_var_hcache.size, xc_var_hentry.size);
2681        php_info_print_table_row(2, "Variable Cache", buf);
2682        efree(ptr);
2683    }
2684    else {
2685        php_info_print_table_row(2, "Variable Cache", "disabled");
2686    }
2687
2688    left = sizeof(buf);
2689    ptr = buf;
2690    buf[0] = '\0';
2691    for (scheme = xc_shm_scheme_first(); scheme; scheme = xc_shm_scheme_next(scheme)) {
2692        len = snprintf(ptr, left, ptr == buf ? "%s" : ", %s", xc_shm_scheme_name(scheme));
2693        left -= len;
2694        ptr += len;
2695    }
2696    php_info_print_table_row(2, "Shared Memory Schemes", buf);
2697
2698#ifdef HAVE_XCACHE_COVERAGER
2699    if (cfg_get_string("xcache.coveragedump_directory", &covdumpdir) != SUCCESS || !covdumpdir[0]) {
2700        covdumpdir = NULL;
2701    }
2702    php_info_print_table_row(2, "Coverage Auto Dumper", XG(coverager) && covdumpdir ? "enabled" : "disabled");
2703#endif
2704    php_info_print_table_end();
2705
2706    DISPLAY_INI_ENTRIES();
2707}
2708/* }}} */
2709/* {{{ extension startup */
2710static void xc_zend_extension_register(zend_extension *new_extension, DL_HANDLE handle)
2711{
2712    zend_extension extension;
2713
2714    extension = *new_extension;
2715    extension.handle = handle;
2716
2717    zend_extension_dispatch_message(ZEND_EXTMSG_NEW_EXTENSION, &extension);
2718
2719    zend_llist_prepend_element(&zend_extensions, &extension);
2720    TRACE("%s", "registered");
2721}
2722
2723static zend_llist_element *xc_llist_get_element_by_zend_extension(zend_llist *l, const char *extension_name)
2724{
2725    zend_llist_element *element;
2726
2727    for (element = zend_extensions.head; element; element = element->next) {
2728        zend_extension *extension = (zend_extension *) element->data;
2729
2730        if (!strcmp(extension->name, extension_name)) {
2731            return element;
2732        }
2733    }
2734    return NULL;
2735}
2736
2737static void xc_llist_prepend(zend_llist *l, zend_llist_element *element)
2738{
2739    element->next = l->head;
2740    element->prev = NULL;
2741    if (l->head) {
2742        l->head->prev = element;
2743    }
2744    else {
2745        l->tail = element;
2746    }
2747    l->head = element;
2748    ++l->count;
2749}
2750
2751static void xc_llist_unlink(zend_llist *l, zend_llist_element *element)
2752{
2753    if ((element)->prev) {
2754        (element)->prev->next = (element)->next;
2755    }
2756    else {
2757        (l)->head = (element)->next;
2758    }
2759
2760    if ((element)->next) {
2761        (element)->next->prev = (element)->prev;
2762    }
2763    else {
2764        (l)->tail = (element)->prev;
2765    }
2766
2767    --l->count;
2768}
2769
2770static int xc_zend_extension_startup(zend_extension *extension)
2771{
2772    if (extension->startup) {
2773        if (extension->startup(extension) != SUCCESS) {
2774            return FAILURE;
2775        }
2776    }
2777    return SUCCESS;
2778}
2779/* }}} */
2780static int xc_ptr_compare_func(void *p1, void *p2) /* {{{ */
2781{
2782    return p1 == p2;
2783}
2784/* }}} */
2785static int xc_zend_remove_extension(zend_extension *extension) /* {{{ */
2786{
2787    llist_dtor_func_t dtor;
2788
2789    assert(extension);
2790    dtor = zend_extensions.dtor; /* avoid dtor */
2791    zend_extensions.dtor = NULL;
2792    zend_llist_del_element(&zend_extensions, extension, xc_ptr_compare_func);
2793    zend_extensions.dtor = dtor;
2794    return SUCCESS;
2795}
2796/* }}} */
2797static int xc_config_hash(xc_hash_t *p, char *name, char *default_value) /* {{{ */
2798{
2799    int bits, size;
2800    char *value;
2801
2802    if (cfg_get_string(name, &value) != SUCCESS) {
2803        value = default_value;
2804    }
2805
2806    p->size = zend_atoi(value, strlen(value));
2807    for (size = 1, bits = 1; size < p->size; bits ++, size <<= 1) {
2808        /* empty body */
2809    }
2810    p->size = size;
2811    p->bits = bits;
2812    p->mask = size - 1;
2813
2814    return SUCCESS;
2815}
2816/* }}} */
2817static int xc_config_long(zend_ulong *p, char *name, char *default_value) /* {{{ */
2818{
2819    char *value;
2820
2821    if (cfg_get_string(name, &value) != SUCCESS) {
2822        value = default_value;
2823    }
2824
2825    *p = zend_atoi(value, strlen(value));
2826    return SUCCESS;
2827}
2828/* }}} */
2829/* {{{ PHP_MINIT_FUNCTION(xcache) */
2830static PHP_MINIT_FUNCTION(xcache)
2831{
2832    char *env;
2833    zend_extension *ext;
2834    zend_llist_position lpos;
2835
2836    xc_module_gotup = 1;
2837    if (!xc_zend_extension_gotup) {
2838        xc_zend_extension_register(&zend_extension_entry, 0);
2839        xc_zend_extension_startup(&zend_extension_entry);
2840        xc_zend_extension_faked = 1;
2841    }
2842
2843    ext = zend_get_extension("Zend Optimizer");
2844    if (ext) {
2845        /* zend_optimizer.optimization_level>0 is not compatible with other cacher, disabling */
2846        ext->op_array_handler = NULL;
2847    }
2848    /* cache if there's an op_array_ctor */
2849    for (ext = zend_llist_get_first_ex(&zend_extensions, &lpos);
2850            ext;
2851            ext = zend_llist_get_next_ex(&zend_extensions, &lpos)) {
2852        if (ext->op_array_ctor) {
2853            xc_have_op_array_ctor = 1;
2854            break;
2855        }
2856    }
2857
2858
2859#ifndef PHP_GINIT
2860    ZEND_INIT_MODULE_GLOBALS(xcache, xc_init_globals, xc_shutdown_globals);
2861#endif
2862    REGISTER_INI_ENTRIES();
2863
2864    if (strcmp(sapi_module.name, "cli") == 0) {
2865        if ((env = getenv("XCACHE_TEST")) != NULL) {
2866            zend_alter_ini_entry("xcache.test", sizeof("xcache.test"), env, strlen(env) + 1, PHP_INI_SYSTEM, PHP_INI_STAGE_STARTUP);
2867        }
2868        if (!xc_test) {
2869            /* disable cache for cli except for test */
2870            xc_php_size = xc_var_size = 0;
2871        }
2872    }
2873
2874    xc_config_long(&xc_php_size,       "xcache.size",        "0");
2875    xc_config_hash(&xc_php_hcache,     "xcache.count",       "1");
2876    xc_config_hash(&xc_php_hentry,     "xcache.slots",      "8K");
2877
2878    xc_config_long(&xc_var_size,       "xcache.var_size",    "0");
2879    xc_config_hash(&xc_var_hcache,     "xcache.var_count",   "1");
2880    xc_config_hash(&xc_var_hentry,     "xcache.var_slots",  "8K");
2881
2882    if (xc_php_size <= 0) {
2883        xc_php_size = xc_php_hcache.size = 0;
2884    }
2885    if (xc_var_size <= 0) {
2886        xc_var_size = xc_var_hcache.size = 0;
2887    }
2888
2889    if (xc_coredump_dir && xc_coredump_dir[0]) {
2890        xcache_init_signal_handler();
2891    }
2892
2893    xc_init_constant(module_number TSRMLS_CC);
2894    xc_shm_init_modules();
2895
2896    if ((xc_php_size || xc_var_size) && xc_mmap_path && xc_mmap_path[0]) {
2897        if (xc_init(module_number TSRMLS_CC) != SUCCESS) {
2898            zend_error(E_ERROR, "XCache: Cannot init");
2899            goto err_init;
2900        }
2901        xc_initized = 1;
2902    }
2903
2904#ifdef HAVE_XCACHE_COVERAGER
2905    xc_coverager_init(module_number TSRMLS_CC);
2906#endif
2907
2908    return SUCCESS;
2909
2910err_init:
2911    return FAILURE;
2912}
2913/* }}} */
2914/* {{{ PHP_MSHUTDOWN_FUNCTION(xcache) */
2915static PHP_MSHUTDOWN_FUNCTION(xcache)
2916{
2917    if (xc_initized) {
2918        xc_destroy();
2919    }
2920    if (xc_mmap_path) {
2921        pefree(xc_mmap_path, 1);
2922        xc_mmap_path = NULL;
2923    }
2924    if (xc_shm_scheme) {
2925        pefree(xc_shm_scheme, 1);
2926        xc_shm_scheme = NULL;
2927    }
2928
2929#ifdef HAVE_XCACHE_COVERAGER
2930    xc_coverager_destroy();
2931#endif
2932
2933    if (xc_coredump_dir && xc_coredump_dir[0]) {
2934        xcache_restore_signal_handler();
2935    }
2936    if (xc_coredump_dir) {
2937        pefree(xc_coredump_dir, 1);
2938        xc_coredump_dir = NULL;
2939    }
2940#ifndef PHP_GINIT
2941#   ifdef ZTS
2942    ts_free_id(xcache_globals_id);
2943#   else
2944    xc_shutdown_globals(&xcache_globals TSRMLS_CC);
2945#   endif
2946#endif
2947
2948    if (xc_zend_extension_faked) {
2949        zend_extension *ext = zend_get_extension(XCACHE_NAME);
2950        if (ext->shutdown) {
2951            ext->shutdown(ext);
2952        }
2953        xc_zend_remove_extension(ext);
2954    }
2955    UNREGISTER_INI_ENTRIES();
2956
2957    xc_module_gotup = 0;
2958    xc_zend_extension_gotup = 0;
2959    xc_zend_extension_faked = 0;
2960
2961    return SUCCESS;
2962}
2963/* }}} */
2964/* {{{ PHP_RINIT_FUNCTION(xcache) */
2965static PHP_RINIT_FUNCTION(xcache)
2966{
2967    xc_request_init(TSRMLS_C);
2968    return SUCCESS;
2969}
2970/* }}} */
2971/* {{{ PHP_RSHUTDOWN_FUNCTION(xcache) */
2972#ifndef ZEND_ENGINE_2
2973static PHP_RSHUTDOWN_FUNCTION(xcache)
2974#else
2975static ZEND_MODULE_POST_ZEND_DEACTIVATE_D(xcache)
2976#endif
2977{
2978#ifdef ZEND_ENGINE_2
2979    TSRMLS_FETCH();
2980#endif
2981
2982    xc_request_shutdown(TSRMLS_C);
2983    return SUCCESS;
2984}
2985/* }}} */
2986/* {{{ module dependencies */
2987#if ZEND_MODULE_API_NO >= 20050922
2988static const zend_module_dep xcache_module_deps[] = {
2989    ZEND_MOD_REQUIRED("standard")
2990    ZEND_MOD_CONFLICTS("apc")
2991    ZEND_MOD_CONFLICTS("eAccelerator")
2992    ZEND_MOD_CONFLICTS("Turck MMCache")
2993    {NULL, NULL, NULL}
2994};
2995#endif
2996/* }}} */ 
2997/* {{{ module definition structure */
2998
2999zend_module_entry xcache_module_entry = {
3000#if ZEND_MODULE_API_NO >= 20050922
3001    STANDARD_MODULE_HEADER_EX,
3002    NULL,
3003    xcache_module_deps,
3004#else
3005    STANDARD_MODULE_HEADER,
3006#endif
3007    XCACHE_NAME,
3008    xcache_functions,
3009    PHP_MINIT(xcache),
3010    PHP_MSHUTDOWN(xcache),
3011    PHP_RINIT(xcache),
3012#ifndef ZEND_ENGINE_2
3013    PHP_RSHUTDOWN(xcache),
3014#else
3015    NULL,
3016#endif
3017    PHP_MINFO(xcache),
3018    XCACHE_VERSION,
3019#ifdef PHP_GINIT
3020    PHP_MODULE_GLOBALS(xcache),
3021    PHP_GINIT(xcache),
3022    PHP_GSHUTDOWN(xcache),
3023#endif
3024#ifdef ZEND_ENGINE_2
3025    ZEND_MODULE_POST_ZEND_DEACTIVATE_N(xcache),
3026#else
3027    NULL,
3028    NULL,
3029#endif
3030    STANDARD_MODULE_PROPERTIES_EX
3031};
3032
3033#ifdef COMPILE_DL_XCACHE
3034ZEND_GET_MODULE(xcache)
3035#endif
3036/* }}} */
3037static startup_func_t xc_last_ext_startup;
3038static int xc_zend_startup_last(zend_extension *extension) /* {{{ */
3039{
3040    /* restore */
3041    extension->startup = xc_last_ext_startup;
3042    if (extension->startup) {
3043        if (extension->startup(extension) != SUCCESS) {
3044            return FAILURE;
3045        }
3046    }
3047    assert(xc_llist_zend_extension);
3048    xc_llist_prepend(&zend_extensions, xc_llist_zend_extension);
3049    if (!xc_module_gotup) {
3050        return zend_startup_module(&xcache_module_entry);
3051    }
3052    return SUCCESS;
3053}
3054/* }}} */
3055ZEND_DLEXPORT int xcache_zend_startup(zend_extension *extension) /* {{{ */
3056{
3057    xc_zend_extension_gotup = 1;
3058
3059    if (!origin_compile_file) {
3060        origin_compile_file = zend_compile_file;
3061        zend_compile_file = xc_check_initial_compile_file;
3062    }
3063
3064    if (zend_llist_count(&zend_extensions) > 1) {
3065        zend_llist_position lpos;
3066        zend_extension *ext;
3067
3068        xc_llist_zend_extension = xc_llist_get_element_by_zend_extension(&zend_extensions, XCACHE_NAME);
3069        xc_llist_unlink(&zend_extensions, xc_llist_zend_extension);
3070
3071        ext = (zend_extension *) zend_llist_get_last_ex(&zend_extensions, &lpos);
3072        assert(ext && ext != xc_llist_zend_extension);
3073        xc_last_ext_startup = ext->startup;
3074        ext->startup = xc_zend_startup_last;
3075    }
3076    else if (!xc_module_gotup) {
3077        return zend_startup_module(&xcache_module_entry);
3078    }
3079    return SUCCESS;
3080}
3081/* }}} */
3082ZEND_DLEXPORT void xcache_zend_shutdown(zend_extension *extension) /* {{{ */
3083{
3084    /* empty */
3085}
3086/* }}} */
3087ZEND_DLEXPORT void xcache_statement_handler(zend_op_array *op_array) /* {{{ */
3088{
3089#ifdef HAVE_XCACHE_COVERAGER
3090    xc_coverager_handle_ext_stmt(op_array, ZEND_EXT_STMT);
3091#endif
3092}
3093/* }}} */
3094ZEND_DLEXPORT void xcache_fcall_begin_handler(zend_op_array *op_array) /* {{{ */
3095{
3096#if 0
3097    xc_coverager_handle_ext_stmt(op_array, ZEND_EXT_FCALL_BEGIN);
3098#endif
3099}
3100/* }}} */
3101ZEND_DLEXPORT void xcache_fcall_end_handler(zend_op_array *op_array) /* {{{ */
3102{
3103#if 0
3104    xc_coverager_handle_ext_stmt(op_array, ZEND_EXT_FCALL_END);
3105#endif
3106}
3107/* }}} */
3108/* {{{ zend extension definition structure */
3109ZEND_DLEXPORT zend_extension zend_extension_entry = {
3110    XCACHE_NAME,
3111    XCACHE_VERSION,
3112    XCACHE_AUTHOR,
3113    XCACHE_URL,
3114    XCACHE_COPYRIGHT,
3115    xcache_zend_startup,
3116    xcache_zend_shutdown,
3117    NULL,           /* activate_func_t */
3118    NULL,           /* deactivate_func_t */
3119    NULL,           /* message_handler_func_t */
3120#ifdef HAVE_XCACHE_OPTIMIZER
3121    xc_optimizer_op_array_handler,
3122#else
3123    NULL,           /* op_array_handler_func_t */
3124#endif
3125    xcache_statement_handler,
3126    xcache_fcall_begin_handler,
3127    xcache_fcall_end_handler,
3128    NULL,           /* op_array_ctor_func_t */
3129    NULL,           /* op_array_dtor_func_t */
3130    STANDARD_ZEND_EXTENSION_PROPERTIES
3131};
3132
3133#ifndef ZEND_EXT_API
3134#   define ZEND_EXT_API ZEND_DLEXPORT
3135#endif
3136#if COMPILE_DL_XCACHE
3137ZEND_EXTENSION();
3138#endif
3139/* }}} */
Note: See TracBrowser for help on using the repository browser.