source: trunk/xcache.c @ 503

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

constinfos cannot be fast copied

  • 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 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 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 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_find(CG(auto_globals), aginfo->type, aginfo->key, aginfo->key_len+1, (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    }                                                         \
1090} while(0)
1091
1092#ifdef HAVE_XCACHE_CONSTANT
1093        b = EG(zend_constants)->pListHead; COPY_H(xc_constinfo_t, constinfos, constinfo_cnt, constant, zend_constant);
1094#endif
1095        b = CG(function_table)->pListHead; COPY_H(xc_funcinfo_t,  funcinfos,  funcinfo_cnt,  func,     zend_function);
1096        b = CG(class_table)->pListHead;    COPY_H(xc_classinfo_t, classinfos, classinfo_cnt, cest,     xc_cest_t);
1097
1098#undef COPY_H
1099
1100        /* for ZE1, cest need to be fixed inside store */
1101
1102#ifdef ZEND_ENGINE_2_1
1103        /* scan for acatived auto globals */
1104        i = 0;
1105        for (b = CG(auto_globals)->pListHead; b != NULL; b = b->pListNext) {
1106            zend_auto_global *auto_global = (zend_auto_global *) b->pData;
1107            /* check if actived */
1108            if (auto_global->auto_global_callback && !auto_global->armed) {
1109                xc_autoglobal_t *data = &php->autoglobals[i];
1110
1111                assert(i < php->autoglobal_cnt);
1112                i ++;
1113                UNISW(NOTHING, data->type = b->key.type;)
1114                if (UNISW(1, b->key.type == IS_STRING)) {
1115                    ZSTR_S(data->key)     = BUCKET_KEY_S(b);
1116                }
1117                else {
1118                    ZSTR_U(data->key)     = BUCKET_KEY_U(b);
1119                }
1120                data->key_len = b->nKeyLength - 1;
1121            }
1122        }
1123#endif
1124    }
1125    /* }}} */
1126#ifdef E_STRICT
1127    php->compilererrors = ((xc_sandbox_t *) XG(sandbox))->compilererrors;
1128    php->compilererror_cnt = ((xc_sandbox_t *) XG(sandbox))->compilererror_cnt;
1129#endif
1130    /* {{{ find inherited classes that should be early-binding */
1131    php->have_early_binding = 0;
1132    for (i = 0; i < php->classinfo_cnt; i ++) {
1133        php->classinfos[i].oplineno = -1;
1134    }
1135
1136    xc_undo_pass_two(php->op_array TSRMLS_CC);
1137    xc_foreach_early_binding_class(php->op_array, xc_cache_early_binding_class_cb, (void *) php TSRMLS_CC);
1138    xc_redo_pass_two(php->op_array TSRMLS_CC);
1139    /* }}} */
1140
1141    return op_array;
1142
1143err_alloc:
1144    xc_free_php(php TSRMLS_CC);
1145
1146err_bailout:
1147err_op_array:
1148
1149    if (catched) {
1150        zend_bailout();
1151    }
1152
1153    return op_array;
1154}
1155/* }}} */
1156static zend_op_array *xc_compile_restore(xc_entry_t *stored_xce, zend_file_handle *h TSRMLS_DC) /* {{{ */
1157{
1158    zend_op_array *op_array;
1159    xc_entry_t xce;
1160    xc_entry_data_php_t php;
1161    zend_bool catched;
1162
1163    CG(in_compilation)    = 1;
1164    CG(compiled_filename) = stored_xce->name.str.val;
1165    CG(zend_lineno)       = 0;
1166    TRACE("restoring %s", stored_xce->name.str.val);
1167    xc_processor_restore_xc_entry_t(&xce, stored_xce TSRMLS_CC);
1168    xc_processor_restore_xc_entry_data_php_t(&php, xce.data.php, xc_readonly_protection TSRMLS_CC);
1169    xce.data.php = &php;
1170#ifdef SHOW_DPRINT
1171    xc_dprint(&xce, 0 TSRMLS_CC);
1172#endif
1173
1174    catched = 0;
1175    zend_try {
1176        op_array = xc_entry_install(&xce, h TSRMLS_CC);
1177    } zend_catch {
1178        catched = 1;
1179    } zend_end_try();
1180
1181    if (php.constinfos) {
1182        efree(php.constinfos);
1183    }
1184    if (php.funcinfos) {
1185        efree(php.funcinfos);
1186    }
1187    if (php.classinfos) {
1188        efree(php.classinfos);
1189    }
1190
1191    if (catched) {
1192        zend_bailout();
1193    }
1194    CG(in_compilation)    = 0;
1195    CG(compiled_filename) = NULL;
1196    TRACE("restored  %s", stored_xce->name.str.val);
1197    return op_array;
1198}
1199/* }}} */
1200static zend_op_array *xc_check_initial_compile_file(zend_file_handle *h, int type TSRMLS_DC) /* {{{ */
1201{
1202    XG(initial_compile_file_called) = 1;
1203    return origin_compile_file(h, type TSRMLS_CC);
1204}
1205/* }}} */
1206static zend_op_array *xc_compile_file(zend_file_handle *h, int type TSRMLS_DC) /* {{{ */
1207{
1208    zend_op_array *op_array;
1209    xc_entry_t xce, *stored_xce;
1210    xc_entry_data_php_t php, *stored_php;
1211    xc_cache_t *cache;
1212    zend_bool gaveup = 0;
1213    zend_bool catched = 0;
1214    zend_bool newlycompiled;
1215    char *filename;
1216    char opened_path_buffer[MAXPATHLEN];
1217    xc_sandbox_t sandbox;
1218
1219    assert(xc_initized);
1220
1221    TRACE("type = %d\n", h->type);
1222    if (!XG(cacher)) {
1223        op_array = old_compile_file(h, type TSRMLS_CC);
1224        return op_array;
1225    }
1226
1227    /* {{{ entry_init_key */
1228    filename = h->opened_path ? h->opened_path : h->filename;
1229    xce.data.php = &php;
1230    if (xc_entry_init_key_php(&xce, filename, opened_path_buffer TSRMLS_CC) != SUCCESS) {
1231        TRACE("failed to init key for %s", filename);
1232        return old_compile_file(h, type TSRMLS_CC);
1233    }
1234    cache = xce.cache;
1235    /* }}} */
1236
1237    /* stale clogs precheck */
1238    if (cache->compiling) {
1239        cache->clogs ++;
1240        return old_compile_file(h, type TSRMLS_CC);
1241    }
1242    /* {{{ entry_lookup/hit/md5_init/php_lookup */
1243    stored_xce = NULL;
1244    stored_php = NULL;
1245    ENTER_LOCK_EX(cache) {
1246        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
1247        if (stored_xce) {
1248            cache->hits ++;
1249
1250            TRACE("hit %s, holding", stored_xce->name.str.val);
1251            xc_entry_hold_php_dmz(stored_xce TSRMLS_CC);
1252        }
1253        else {
1254            cache->misses ++;
1255            TRACE("miss %s", xce.name.str.val);
1256
1257            if (xc_entry_init_key_php_md5(&php, &xce TSRMLS_CC) != SUCCESS) {
1258                gaveup = 1;
1259                break;
1260            }
1261
1262            stored_php = xc_php_find_dmz(&php TSRMLS_CC);
1263
1264            /* miss but compiling */
1265            if (!stored_php) {
1266                if (cache->compiling) {
1267                    TRACE("%s", "miss but compiling");
1268                    cache->clogs ++;
1269                    gaveup = 1;
1270                    break;
1271                }
1272                TRACE("%s", "php_lookup miss");
1273            }
1274            else {
1275                TRACE("%s", "php_lookup hit");
1276            }
1277
1278            cache->compiling = XG(request_time);
1279        }
1280    } LEAVE_LOCK_EX(cache);
1281
1282    if (catched) {
1283        cache->compiling = 0;
1284        zend_bailout();
1285    }
1286
1287    /* hit */
1288    if (stored_xce) {
1289        return xc_compile_restore(stored_xce, h TSRMLS_CC);
1290    }
1291
1292    /* gaveup */
1293    if (gaveup) {
1294        return old_compile_file(h, type TSRMLS_CC);
1295    }
1296    /* }}} */
1297    op_array = NULL;
1298    /* {{{ compile */
1299    if (stored_php) {
1300        newlycompiled = 0;
1301        xce.data.php = stored_php;
1302    }
1303    else {
1304        newlycompiled = 1;
1305
1306        /* make compile inside sandbox */
1307        xc_sandbox_init(&sandbox, filename TSRMLS_CC);
1308
1309#ifdef HAVE_XCACHE_CONSTANT
1310        php.constinfos  = NULL;
1311#endif
1312        php.funcinfos   = NULL;
1313        php.classinfos  = NULL;
1314#ifdef ZEND_ENGINE_2_1
1315        php.autoglobals = NULL;
1316#endif
1317        zend_try {
1318            op_array = xc_compile_php(&php, h, type TSRMLS_CC);
1319        } zend_catch {
1320            catched = 1;
1321        } zend_end_try();
1322
1323        if (catched || !op_array) {
1324            goto err_aftersandbox;
1325        }
1326
1327        /* not cachable */
1328        if (!php.op_array) {
1329            cache->compiling = 0;
1330            /* it's not cachable, but don't scare the users with high misses */
1331            cache->misses --;
1332            xc_sandbox_free(&sandbox, XC_InstallNoBinding TSRMLS_CC);
1333            return op_array;
1334        }
1335
1336        xce.data.php = &php;
1337    }
1338    /* }}} */
1339#ifdef HAVE_INODE
1340    /* {{{ path name fix
1341     * inode enabled entry hash/compare on name
1342     * do not update to its name to real pathname
1343     * WARNING: this code is required to be after compile
1344     */
1345    if (xce.inode) {
1346        filename = h->opened_path ? h->opened_path : h->filename;
1347        if (xce.name.str.val != filename) {
1348            xce.name.str.val = filename;
1349            xce.name.str.len = strlen(filename);
1350        }
1351    }
1352    /* }}} */
1353#endif
1354#ifdef SHOW_DPRINT
1355    xc_dprint(&xce, 0 TSRMLS_CC);
1356#endif
1357    stored_xce = NULL;
1358    ENTER_LOCK_EX(cache) { /* {{{ php_store/entry_store */
1359        /* php_store */
1360        if (newlycompiled) {
1361            stored_php = xc_php_store_dmz(&php TSRMLS_CC);
1362            if (!stored_php) {
1363                /* error */
1364                break;
1365            }
1366        }
1367        /* entry_store */
1368        xc_php_addref_dmz(stored_php);
1369        stored_xce = xc_entry_store_dmz(&xce TSRMLS_CC);
1370        if (stored_xce) {
1371            stored_xce->data.php = stored_php;
1372        }
1373        else {
1374            /* error */
1375            xc_php_release_dmz(stored_php);
1376        }
1377    } LEAVE_LOCK_EX(cache);
1378    /* }}} */
1379    TRACE("%s", stored_xce ? "stored" : "store failed");
1380
1381    cache->compiling = 0;
1382    if (catched) {
1383        goto err_aftersandbox;
1384    }
1385
1386    if (newlycompiled) {
1387        xc_free_php(&php TSRMLS_CC);
1388    }
1389
1390    if (stored_xce) {
1391        if (op_array) {
1392#ifdef ZEND_ENGINE_2
1393            destroy_op_array(op_array TSRMLS_CC);
1394#else
1395            destroy_op_array(op_array);
1396#endif
1397            efree(op_array);
1398            h = NULL;
1399        }
1400        if (newlycompiled) {
1401            xc_sandbox_free(&sandbox, XC_NoInstall TSRMLS_CC);
1402        }
1403        return xc_compile_restore(stored_xce, h TSRMLS_CC);
1404    }
1405    else {
1406        if (newlycompiled) {
1407            zend_op_array *old_active_op_array = CG(active_op_array);
1408            /* install it */
1409            CG(active_op_array) = op_array;
1410            xc_sandbox_free(&sandbox, XC_Install TSRMLS_CC);
1411            CG(active_op_array) = old_active_op_array;
1412        }
1413    }
1414    return op_array;
1415
1416err_aftersandbox:
1417    if (newlycompiled) {
1418        xc_free_php(&php TSRMLS_CC);
1419        xc_sandbox_free(&sandbox, XC_NoInstall TSRMLS_CC);
1420    }
1421
1422    if (catched) {
1423        cache->compiling = 0;
1424        cache->errors ++;
1425        zend_bailout();
1426    }
1427    return op_array;
1428}
1429/* }}} */
1430
1431/* gdb helper functions, but N/A for coredump */
1432int xc_is_rw(const void *p) /* {{{ */
1433{
1434    xc_shm_t *shm;
1435    int i;
1436    if (!xc_initized) {
1437        return 0;
1438    }
1439    for (i = 0; i < xc_php_hcache.size; i ++) {
1440        shm = xc_php_caches[i]->shm;
1441        if (shm->handlers->is_readwrite(shm, p)) {
1442            return 1;
1443        }
1444    }
1445    for (i = 0; i < xc_var_hcache.size; i ++) {
1446        shm = xc_var_caches[i]->shm;
1447        if (shm->handlers->is_readwrite(shm, p)) {
1448            return 1;
1449        }
1450    }
1451    return 0;
1452}
1453/* }}} */
1454int xc_is_ro(const void *p) /* {{{ */
1455{
1456    xc_shm_t *shm;
1457    int i;
1458    if (!xc_initized) {
1459        return 0;
1460    }
1461    for (i = 0; i < xc_php_hcache.size; i ++) {
1462        shm = xc_php_caches[i]->shm;
1463        if (shm->handlers->is_readonly(shm, p)) {
1464            return 1;
1465        }
1466    }
1467    for (i = 0; i < xc_var_hcache.size; i ++) {
1468        shm = xc_var_caches[i]->shm;
1469        if (shm->handlers->is_readonly(shm, p)) {
1470            return 1;
1471        }
1472    }
1473    return 0;
1474}
1475/* }}} */
1476int xc_is_shm(const void *p) /* {{{ */
1477{
1478    return xc_is_ro(p) || xc_is_rw(p);
1479}
1480/* }}} */
1481
1482/* {{{ xc_gc_op_array_t */
1483typedef struct {
1484    zend_uint num_args;
1485    zend_arg_info *arg_info;
1486} xc_gc_op_array_t;
1487/* }}} */
1488void xc_gc_add_op_array(zend_op_array *op_array TSRMLS_DC) /* {{{ */
1489{
1490    xc_gc_op_array_t gc_op_array;
1491    gc_op_array.num_args = op_array->num_args;
1492    gc_op_array.arg_info = op_array->arg_info;
1493    zend_hash_next_index_insert(&XG(gc_op_arrays), (void *) &gc_op_array, sizeof(gc_op_array), NULL);
1494}
1495/* }}} */
1496static void xc_gc_op_array(void *pDest) /* {{{ */
1497{
1498    xc_gc_op_array_t *op_array = (xc_gc_op_array_t *) pDest;
1499    zend_uint i;
1500    if (op_array->arg_info) {
1501        for (i = 0; i < op_array->num_args; i++) {
1502            efree((char *) ZSTR_V(op_array->arg_info[i].name));
1503            if (ZSTR_V(op_array->arg_info[i].class_name)) {
1504                efree((char *) ZSTR_V(op_array->arg_info[i].class_name));
1505            }
1506        }
1507        efree(op_array->arg_info);
1508    }
1509}
1510/* }}} */
1511
1512/* module helper function */
1513static int xc_init_constant(int module_number TSRMLS_DC) /* {{{ */
1514{
1515    typedef struct {
1516        const char *prefix;
1517        zend_uchar (*getsize)();
1518        const char *(*get)(zend_uchar i);
1519    } xc_meminfo_t;
1520    xc_meminfo_t nameinfos[] = {
1521        { "",        xc_get_op_type_count,   xc_get_op_type   },
1522        { "",        xc_get_data_type_count, xc_get_data_type },
1523        { "",        xc_get_opcode_count,    xc_get_opcode    },
1524        { "OPSPEC_", xc_get_op_spec_count,   xc_get_op_spec   },
1525        { NULL, NULL, NULL }
1526    };
1527    xc_meminfo_t* p;
1528    zend_uchar i, count;
1529    char const_name[96];
1530    int const_name_len;
1531    int undefdone = 0;
1532
1533    for (p = nameinfos; p->getsize; p ++) {
1534        count = p->getsize();
1535        for (i = 0; i < count; i ++) {
1536            const char *name = p->get(i);
1537            if (!name) continue;
1538            if (strcmp(name, "UNDEF") == 0) {
1539                if (undefdone) continue;
1540                undefdone = 1;
1541            }
1542            const_name_len = snprintf(const_name, sizeof(const_name), "XC_%s%s", p->prefix, name);
1543            zend_register_long_constant(const_name, const_name_len+1, i, CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1544        }
1545    }
1546
1547    zend_register_long_constant(ZEND_STRS("XC_SIZEOF_TEMP_VARIABLE"), sizeof(temp_variable), CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1548    zend_register_long_constant(ZEND_STRS("XC_TYPE_PHP"), XC_TYPE_PHP, CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1549    zend_register_long_constant(ZEND_STRS("XC_TYPE_VAR"), XC_TYPE_VAR, CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1550    zend_register_stringl_constant(ZEND_STRS("XCACHE_VERSION"), ZEND_STRL(XCACHE_VERSION), CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1551    zend_register_stringl_constant(ZEND_STRS("XCACHE_MODULES"), ZEND_STRL(XCACHE_MODULES), CONST_CS | CONST_PERSISTENT, module_number TSRMLS_CC);
1552    return 0;
1553}
1554/* }}} */
1555static xc_shm_t *xc_cache_destroy(xc_cache_t **caches, xc_hash_t *hcache) /* {{{ */
1556{
1557    int i;
1558    xc_cache_t *cache;
1559    xc_shm_t *shm;
1560
1561    if (!caches) {
1562        return NULL;
1563    }
1564    shm = NULL;
1565    for (i = 0; i < hcache->size; i ++) {
1566        cache = caches[i];
1567        if (cache) {
1568            if (cache->lck) {
1569                xc_lock_destroy(cache->lck);
1570            }
1571            /* do NOT free
1572            if (cache->entries) {
1573                cache->mem->handlers->free(cache->mem, cache->entries);
1574            }
1575            cache->mem->handlers->free(cache->mem, cache);
1576            */
1577            shm = cache->shm;
1578            shm->handlers->memdestroy(cache->mem);
1579        }
1580    }
1581    free(caches);
1582    return shm;
1583}
1584/* }}} */
1585static 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) /* {{{ */
1586{
1587    xc_cache_t **caches = NULL, *cache;
1588    xc_mem_t *mem;
1589    time_t now = time(NULL);
1590    int i;
1591    xc_memsize_t memsize;
1592
1593    memsize = shmsize / hcache->size;
1594
1595    /* Don't let it break out of mem after ALIGNed
1596     * This is important for
1597     * Simply loop until it fit our need
1598     */
1599    while (ALIGN(memsize) * hcache->size > shmsize && ALIGN(memsize) != memsize) {
1600        if (memsize < ALIGN(1)) {
1601            CHECK(NULL, "cache too small");
1602        }
1603        memsize --;
1604    }
1605
1606    CHECK(caches = calloc(hcache->size, sizeof(xc_cache_t *)), "caches OOM");
1607
1608    for (i = 0; i < hcache->size; i ++) {
1609        CHECK(mem            = shm->handlers->meminit(shm, memsize), "Failed init memory allocator");
1610        CHECK(cache          = mem->handlers->calloc(mem, 1, sizeof(xc_cache_t)), "cache OOM");
1611        CHECK(cache->entries = mem->handlers->calloc(mem, hentry->size, sizeof(xc_entry_t*)), "entries OOM");
1612        if (hphp) {
1613            CHECK(cache->phps= mem->handlers->calloc(mem, hphp->size, sizeof(xc_entry_data_php_t*)), "phps OOM");
1614        }
1615        CHECK(cache->lck     = xc_lock_init(NULL), "can't create lock");
1616
1617        cache->hcache  = hcache;
1618        cache->hentry  = hentry;
1619        cache->hphp    = hphp;
1620        cache->shm     = shm;
1621        cache->mem     = mem;
1622        cache->cacheid = i;
1623        cache->last_gc_deletes = now;
1624        cache->last_gc_expires = now;
1625        caches[i] = cache;
1626    }
1627    return caches;
1628
1629err:
1630    if (caches) {
1631        xc_cache_destroy(caches, hcache);
1632    }
1633    return NULL;
1634}
1635/* }}} */
1636static void xc_destroy() /* {{{ */
1637{
1638    xc_shm_t *shm = NULL;
1639
1640    if (old_compile_file) {
1641        zend_compile_file = old_compile_file;
1642        old_compile_file = NULL;
1643    }
1644
1645    if (origin_compile_file) {
1646        zend_compile_file = origin_compile_file;
1647        origin_compile_file = NULL;
1648    }
1649
1650    if (xc_php_caches) {
1651        shm = xc_cache_destroy(xc_php_caches, &xc_php_hcache);
1652        xc_php_caches = NULL;
1653    }
1654
1655    if (xc_var_caches) {
1656        shm = xc_cache_destroy(xc_var_caches, &xc_var_hcache);
1657        xc_var_caches = NULL;
1658    }
1659
1660    if (shm) {
1661        xc_shm_destroy(shm);
1662    }
1663
1664    xc_initized = 0;
1665}
1666/* }}} */
1667static int xc_init(int module_number TSRMLS_DC) /* {{{ */
1668{
1669    xc_shm_t *shm;
1670    xc_shmsize_t shmsize = ALIGN(xc_php_size) + ALIGN(xc_var_size);
1671
1672    xc_php_caches = xc_var_caches = NULL;
1673    shm = NULL;
1674
1675    if (shmsize < (size_t) xc_php_size || shmsize < (size_t) xc_var_size) {
1676        zend_error(E_ERROR, "XCache: neither xcache.size nor xcache.var_size can be negative");
1677        goto err;
1678    }
1679
1680    if (xc_php_size || xc_var_size) {
1681        CHECK(shm = xc_shm_init(xc_shm_scheme, shmsize, xc_readonly_protection, xc_mmap_path, NULL), "Cannot create shm");
1682        if (!shm->handlers->can_readonly(shm)) {
1683            xc_readonly_protection = 0;
1684        }
1685
1686        if (xc_php_size) {
1687            old_compile_file = zend_compile_file;
1688            zend_compile_file = xc_compile_file;
1689
1690            CHECK(xc_php_caches = xc_cache_init(shm, &xc_php_hcache, &xc_php_hentry, &xc_php_hentry, xc_php_size), "failed init opcode cache");
1691        }
1692
1693        if (xc_var_size) {
1694            CHECK(xc_var_caches = xc_cache_init(shm, &xc_var_hcache, &xc_var_hentry, NULL, xc_var_size), "failed init variable cache");
1695        }
1696    }
1697    return SUCCESS;
1698
1699err:
1700    if (xc_php_caches || xc_var_caches) {
1701        xc_destroy();
1702        /* shm destroied in xc_destroy() */
1703    }
1704    else if (shm) {
1705        xc_destroy();
1706        xc_shm_destroy(shm);
1707    }
1708    return 0;
1709}
1710/* }}} */
1711static void xc_request_init(TSRMLS_D) /* {{{ */
1712{
1713    int i;
1714
1715    if (!XG(internal_table_copied)) {
1716        zend_function tmp_func;
1717        xc_cest_t tmp_cest;
1718
1719        zend_hash_destroy(&XG(internal_function_table));
1720        zend_hash_destroy(&XG(internal_class_table));
1721
1722        zend_hash_init_ex(&XG(internal_function_table), 100, NULL, CG(function_table)->pDestructor, 1, 0);
1723        zend_hash_init_ex(&XG(internal_class_table),    10,  NULL, CG(class_table)->pDestructor,    1, 0);
1724
1725        zend_hash_copy(&XG(internal_function_table), CG(function_table), (copy_ctor_func_t) function_add_ref, &tmp_func, sizeof(tmp_func));
1726        zend_hash_copy(&XG(internal_class_table), CG(class_table), (copy_ctor_func_t) xc_zend_class_add_ref, &tmp_cest, sizeof(tmp_cest));
1727
1728        XG(internal_table_copied) = 1;
1729    }
1730    if (xc_php_hcache.size && !XG(php_holds)) {
1731        XG(php_holds) = calloc(xc_php_hcache.size, sizeof(xc_stack_t));
1732        for (i = 0; i < xc_php_hcache.size; i ++) {
1733            xc_stack_init(&XG(php_holds[i]));
1734        }
1735    }
1736
1737    if (xc_initized && xc_var_hcache.size && !XG(var_holds)) {
1738        XG(var_holds) = calloc(xc_var_hcache.size, sizeof(xc_stack_t));
1739        for (i = 0; i < xc_var_hcache.size; i ++) {
1740            xc_stack_init(&XG(var_holds[i]));
1741        }
1742    }
1743
1744    zend_hash_init(&XG(gc_op_arrays), 32, NULL, xc_gc_op_array, 0);
1745
1746#if PHP_API_VERSION <= 20041225
1747    XG(request_time) = time(NULL);
1748#else
1749    XG(request_time) = sapi_get_request_time(TSRMLS_C);
1750#endif
1751
1752#ifdef HAVE_XCACHE_COVERAGER
1753    xc_coverager_request_init(TSRMLS_C);
1754#endif
1755}
1756/* }}} */
1757static void xc_request_shutdown(TSRMLS_D) /* {{{ */
1758{
1759    xc_entry_unholds(TSRMLS_C);
1760    zend_hash_destroy(&XG(gc_op_arrays));
1761    xc_gc_expires_php(TSRMLS_C);
1762    xc_gc_expires_var(TSRMLS_C);
1763    xc_gc_deletes(TSRMLS_C);
1764#ifdef HAVE_XCACHE_COVERAGER
1765    xc_coverager_request_shutdown(TSRMLS_C);
1766#endif
1767}
1768/* }}} */
1769/* {{{ PHP_GINIT_FUNCTION(xcache) */
1770static
1771#ifdef PHP_GINIT_FUNCTION
1772PHP_GINIT_FUNCTION(xcache)
1773#else
1774void xc_init_globals(zend_xcache_globals* xcache_globals TSRMLS_DC)
1775#endif
1776{
1777    memset(xcache_globals, 0, sizeof(zend_xcache_globals));
1778
1779    zend_hash_init_ex(&xcache_globals->internal_function_table, 1, NULL, NULL, 1, 0);
1780    zend_hash_init_ex(&xcache_globals->internal_class_table,    1, NULL, NULL, 1, 0);
1781}
1782/* }}} */
1783/* {{{ PHP_GSHUTDOWN_FUNCTION(xcache) */
1784static
1785#ifdef PHP_GSHUTDOWN_FUNCTION
1786PHP_GSHUTDOWN_FUNCTION(xcache)
1787#else
1788void xc_shutdown_globals(zend_xcache_globals* xcache_globals TSRMLS_DC)
1789#endif
1790{
1791    int i;
1792
1793    if (xcache_globals->php_holds != NULL) {
1794        for (i = 0; i < xc_php_hcache.size; i ++) {
1795            xc_stack_destroy(&xcache_globals->php_holds[i]);
1796        }
1797        free(xcache_globals->php_holds);
1798        xcache_globals->php_holds = NULL;
1799    }
1800
1801    if (xcache_globals->var_holds != NULL) {
1802        for (i = 0; i < xc_var_hcache.size; i ++) {
1803            xc_stack_destroy(&xcache_globals->var_holds[i]);
1804        }
1805        free(xcache_globals->var_holds);
1806        xcache_globals->var_holds = NULL;
1807    }
1808
1809    if (xcache_globals->internal_table_copied) {
1810        zend_hash_destroy(&xcache_globals->internal_function_table);
1811        zend_hash_destroy(&xcache_globals->internal_class_table);
1812    }
1813}
1814/* }}} */
1815
1816/* user functions */
1817static int xcache_admin_auth_check(TSRMLS_D) /* {{{ */
1818{
1819    zval **server = NULL;
1820    zval **user = NULL;
1821    zval **pass = NULL;
1822    char *admin_user = NULL;
1823    char *admin_pass = NULL;
1824    HashTable *ht;
1825
1826    if (cfg_get_string("xcache.admin.user", &admin_user) == FAILURE || !admin_user[0]) {
1827        admin_user = NULL;
1828    }
1829    if (cfg_get_string("xcache.admin.pass", &admin_pass) == FAILURE || !admin_pass[0]) {
1830        admin_pass = NULL;
1831    }
1832
1833    if (admin_user == NULL || admin_pass == NULL) {
1834        php_error_docref(NULL TSRMLS_CC, E_ERROR, "xcache.admin.user and xcache.admin.pass is required");
1835        zend_bailout();
1836    }
1837    if (strlen(admin_pass) != 32) {
1838        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));
1839        zend_bailout();
1840    }
1841
1842#ifdef ZEND_ENGINE_2_1
1843    zend_is_auto_global("_SERVER", sizeof("_SERVER") - 1 TSRMLS_CC);
1844#endif
1845    if (zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **) &server) != SUCCESS || Z_TYPE_PP(server) != IS_ARRAY) {
1846        php_error_docref(NULL TSRMLS_CC, E_ERROR, "_SERVER is corrupted");
1847        zend_bailout();
1848    }
1849    ht = HASH_OF((*server));
1850
1851    if (zend_hash_find(ht, "PHP_AUTH_USER", sizeof("PHP_AUTH_USER"), (void **) &user) == FAILURE) {
1852        user = NULL;
1853    }
1854    else if (Z_TYPE_PP(user) != IS_STRING) {
1855        user = NULL;
1856    }
1857
1858    if (zend_hash_find(ht, "PHP_AUTH_PW", sizeof("PHP_AUTH_PW"), (void **) &pass) == FAILURE) {
1859        pass = NULL;
1860    }
1861    else if (Z_TYPE_PP(pass) != IS_STRING) {
1862        pass = NULL;
1863    }
1864
1865    if (user != NULL && pass != NULL && strcmp(admin_user, Z_STRVAL_PP(user)) == 0) {
1866        PHP_MD5_CTX context;
1867        char md5str[33];
1868        unsigned char digest[16];
1869
1870        PHP_MD5Init(&context);
1871        PHP_MD5Update(&context, (unsigned char *) Z_STRVAL_PP(pass), Z_STRLEN_PP(pass));
1872        PHP_MD5Final(digest, &context);
1873
1874        md5str[0] = '\0';
1875        make_digest(md5str, digest);
1876        if (strcmp(admin_pass, md5str) == 0) {
1877            return 1;
1878        }
1879    }
1880
1881#define STR "WWW-authenticate: Basic Realm=\"XCache Administration\""
1882    sapi_add_header_ex(STR, sizeof(STR) - 1, 1, 1 TSRMLS_CC);
1883#undef STR
1884#define STR "HTTP/1.0 401 Unauthorized"
1885    sapi_add_header_ex(STR, sizeof(STR) - 1, 1, 1 TSRMLS_CC);
1886#undef STR
1887    ZEND_PUTS("XCache Auth Failed. User and Password is case sense\n");
1888
1889    zend_bailout();
1890    return 0;
1891}
1892/* }}} */
1893/* {{{ xcache_admin_operate */
1894typedef enum { XC_OP_COUNT, XC_OP_INFO, XC_OP_LIST, XC_OP_CLEAR } xcache_op_type;
1895static void xcache_admin_operate(xcache_op_type optype, INTERNAL_FUNCTION_PARAMETERS)
1896{
1897    long type;
1898    int size;
1899    xc_cache_t **caches, *cache;
1900    long id = 0;
1901
1902    xcache_admin_auth_check(TSRMLS_C);
1903
1904    if (!xc_initized) {
1905        RETURN_NULL();
1906    }
1907
1908    if (optype == XC_OP_COUNT) {
1909        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &type) == FAILURE) {
1910            return;
1911        }
1912    }
1913    else if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ll", &type, &id) == FAILURE) {
1914        return;
1915    }
1916
1917    switch (type) {
1918        case XC_TYPE_PHP:
1919            size = xc_php_hcache.size;
1920            caches = xc_php_caches;
1921            break;
1922
1923        case XC_TYPE_VAR:
1924            size = xc_var_hcache.size;
1925            caches = xc_var_caches;
1926            break;
1927
1928        default:
1929            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Unknown type %ld", type);
1930            RETURN_FALSE;
1931    }
1932
1933    switch (optype) {
1934        case XC_OP_COUNT:
1935            RETURN_LONG(size)
1936            break;
1937
1938        case XC_OP_INFO:
1939        case XC_OP_LIST:
1940            if (id < 0 || id >= size) {
1941                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cache not exists");
1942                RETURN_FALSE;
1943            }
1944
1945            array_init(return_value);
1946
1947            cache = caches[id];
1948            ENTER_LOCK(cache) {
1949                if (optype == XC_OP_INFO) {
1950                    xc_fillinfo_dmz(type, cache, return_value TSRMLS_CC);
1951                }
1952                else {
1953                    xc_filllist_dmz(cache, return_value TSRMLS_CC);
1954                }
1955            } LEAVE_LOCK(cache);
1956            break;
1957        case XC_OP_CLEAR:
1958            {
1959                xc_entry_t *e, *next;
1960                int i, c;
1961
1962                if (id < 0 || id >= size) {
1963                    php_error_docref(NULL TSRMLS_CC, E_WARNING, "Cache not exists");
1964                    RETURN_FALSE;
1965                }
1966
1967                cache = caches[id];
1968                ENTER_LOCK(cache) {
1969                    for (i = 0, c = cache->hentry->size; i < c; i ++) {
1970                        for (e = cache->entries[i]; e; e = next) {
1971                            next = e->next;
1972                            xc_entry_remove_dmz(e TSRMLS_CC);
1973                        }
1974                        cache->entries[i] = NULL;
1975                    }
1976                } LEAVE_LOCK(cache);
1977                xc_gc_deletes(TSRMLS_C);
1978            }
1979            break;
1980
1981        default:
1982            assert(0);
1983    }
1984}
1985/* }}} */
1986/* {{{ proto int xcache_count(int type)
1987   Return count of cache on specified cache type */
1988PHP_FUNCTION(xcache_count)
1989{
1990    xcache_admin_operate(XC_OP_COUNT, INTERNAL_FUNCTION_PARAM_PASSTHRU);
1991}
1992/* }}} */
1993/* {{{ proto array xcache_info(int type, int id)
1994   Get cache info by id on specified cache type */
1995PHP_FUNCTION(xcache_info)
1996{
1997    xcache_admin_operate(XC_OP_INFO, INTERNAL_FUNCTION_PARAM_PASSTHRU);
1998}
1999/* }}} */
2000/* {{{ proto array xcache_list(int type, int id)
2001   Get cache entries list by id on specified cache type */
2002PHP_FUNCTION(xcache_list)
2003{
2004    xcache_admin_operate(XC_OP_LIST, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2005}
2006/* }}} */
2007/* {{{ proto array xcache_clear_cache(int type, int id)
2008   Clear cache by id on specified cache type */
2009PHP_FUNCTION(xcache_clear_cache)
2010{
2011    xcache_admin_operate(XC_OP_CLEAR, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2012}
2013/* }}} */
2014
2015#define VAR_DISABLED_WARNING() do { \
2016        php_error_docref(NULL TSRMLS_CC, E_WARNING, "xcache.var_size is either 0 or too small to enable var data caching"); \
2017} while (0)
2018
2019static int xc_entry_init_key_var(xc_entry_t *xce, zval *name TSRMLS_DC) /* {{{ */
2020{
2021    xc_hash_value_t hv;
2022    int cacheid;
2023
2024    switch (Z_TYPE_P(name)) {
2025#ifdef IS_UNICODE
2026        case IS_UNICODE:
2027#endif
2028        case IS_STRING:
2029            break;
2030        default:
2031#ifdef IS_UNICODE
2032            convert_to_text(name);
2033#else
2034            convert_to_string(name);
2035#endif
2036    }
2037#ifdef IS_UNICODE
2038    xce->name_type = name->type;
2039#endif
2040    xce->name = name->value;
2041
2042    hv = xc_entry_hash_var(xce TSRMLS_CC);
2043
2044    cacheid = (hv & xc_var_hcache.mask);
2045    xce->cache = xc_var_caches[cacheid];
2046    hv >>= xc_var_hcache.bits;
2047    xce->hvalue = (hv & xc_var_hentry.mask);
2048
2049    xce->type = XC_TYPE_VAR;
2050    return SUCCESS;
2051}
2052/* }}} */
2053/* {{{ proto mixed xcache_get(string name)
2054   Get cached data by specified name */
2055PHP_FUNCTION(xcache_get)
2056{
2057    xc_entry_t xce, *stored_xce;
2058    xc_entry_data_var_t var;
2059    zval *name;
2060    int found = 0;
2061
2062    if (!xc_var_caches) {
2063        VAR_DISABLED_WARNING();
2064        RETURN_NULL();
2065    }
2066
2067    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &name) == FAILURE) {
2068        return;
2069    }
2070    xce.data.var = &var;
2071    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2072
2073    ENTER_LOCK(xce.cache) {
2074        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2075        if (stored_xce) {
2076            if (!VAR_ENTRY_EXPIRED(stored_xce)) {
2077                found = 1;
2078                xc_processor_restore_zval(return_value, stored_xce->data.var->value, stored_xce->data.var->have_references TSRMLS_CC);
2079                /* return */
2080                break;
2081            }
2082            else {
2083                xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2084            }
2085        }
2086
2087        RETVAL_NULL();
2088    } LEAVE_LOCK(xce.cache);
2089    if (found) {
2090        xce.cache->hits ++;
2091    }
2092    else {
2093        xce.cache->misses ++;
2094    }
2095}
2096/* }}} */
2097/* {{{ proto bool  xcache_set(string name, mixed value [, int ttl])
2098   Store data to cache by specified name */
2099PHP_FUNCTION(xcache_set)
2100{
2101    xc_entry_t xce, *stored_xce;
2102    xc_entry_data_var_t var;
2103    zval *name;
2104    zval *value;
2105
2106    if (!xc_var_caches) {
2107        VAR_DISABLED_WARNING();
2108        RETURN_NULL();
2109    }
2110
2111    xce.ttl = XG(var_ttl);
2112    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zz|l", &name, &value, &xce.ttl) == FAILURE) {
2113        return;
2114    }
2115
2116    /* max ttl */
2117    if (xc_var_maxttl && (!xce.ttl || xce.ttl > xc_var_maxttl)) {
2118        xce.ttl = xc_var_maxttl;
2119    }
2120
2121    xce.data.var = &var;
2122    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2123
2124    ENTER_LOCK(xce.cache) {
2125        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2126        if (stored_xce) {
2127            xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2128        }
2129        var.value = value;
2130        RETVAL_BOOL(xc_entry_store_dmz(&xce TSRMLS_CC) != NULL ? 1 : 0);
2131    } LEAVE_LOCK(xce.cache);
2132}
2133/* }}} */
2134/* {{{ proto bool  xcache_isset(string name)
2135   Check if an entry exists in cache by specified name */
2136PHP_FUNCTION(xcache_isset)
2137{
2138    xc_entry_t xce, *stored_xce;
2139    xc_entry_data_var_t var;
2140    zval *name;
2141    int found = 0;
2142
2143    if (!xc_var_caches) {
2144        VAR_DISABLED_WARNING();
2145        RETURN_FALSE;
2146    }
2147
2148    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &name) == FAILURE) {
2149        return;
2150    }
2151    xce.data.var = &var;
2152    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2153
2154    ENTER_LOCK(xce.cache) {
2155        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2156        if (stored_xce) {
2157            if (!VAR_ENTRY_EXPIRED(stored_xce)) {
2158                found = 1;
2159                RETVAL_TRUE;
2160                /* return */
2161                break;
2162            }
2163            else {
2164                xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2165            }
2166        }
2167
2168        RETVAL_FALSE;
2169    } LEAVE_LOCK(xce.cache);
2170    if (found) {
2171        xce.cache->hits ++;
2172    }
2173    else {
2174        xce.cache->misses ++;
2175    }
2176}
2177/* }}} */
2178/* {{{ proto bool  xcache_unset(string name)
2179   Unset existing data in cache by specified name */
2180PHP_FUNCTION(xcache_unset)
2181{
2182    xc_entry_t xce, *stored_xce;
2183    xc_entry_data_var_t var;
2184    zval *name;
2185
2186    if (!xc_var_caches) {
2187        VAR_DISABLED_WARNING();
2188        RETURN_FALSE;
2189    }
2190
2191    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &name) == FAILURE) {
2192        return;
2193    }
2194    xce.data.var = &var;
2195    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2196
2197    ENTER_LOCK(xce.cache) {
2198        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2199        if (stored_xce) {
2200            xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2201            RETVAL_TRUE;
2202        }
2203        else {
2204            RETVAL_FALSE;
2205        }
2206    } LEAVE_LOCK(xce.cache);
2207}
2208/* }}} */
2209static inline void xc_var_inc_dec(int inc, INTERNAL_FUNCTION_PARAMETERS) /* {{{ */
2210{
2211    xc_entry_t xce, *stored_xce;
2212    xc_entry_data_var_t var, *stored_var;
2213    zval *name;
2214    long count = 1;
2215    long value = 0;
2216    zval oldzval;
2217
2218    if (!xc_var_caches) {
2219        VAR_DISABLED_WARNING();
2220        RETURN_NULL();
2221    }
2222
2223    xce.ttl = XG(var_ttl);
2224    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|ll", &name, &count, &xce.ttl) == FAILURE) {
2225        return;
2226    }
2227
2228    /* max ttl */
2229    if (xc_var_maxttl && (!xce.ttl || xce.ttl > xc_var_maxttl)) {
2230        xce.ttl = xc_var_maxttl;
2231    }
2232
2233    xce.data.var = &var;
2234    xc_entry_init_key_var(&xce, name TSRMLS_CC);
2235
2236    ENTER_LOCK(xce.cache) {
2237        stored_xce = xc_entry_find_dmz(&xce TSRMLS_CC);
2238        if (stored_xce) {
2239            TRACE("incdec: gotxce %s", xce.name.str.val);
2240            /* timeout */
2241            if (VAR_ENTRY_EXPIRED(stored_xce)) {
2242                TRACE("%s", "incdec: expired");
2243                xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2244                stored_xce = NULL;
2245            }
2246            else {
2247                /* do it in place */
2248                stored_var = stored_xce->data.var;
2249                if (Z_TYPE_P(stored_var->value) == IS_LONG) {
2250                    zval *zv;
2251                    stored_xce->ctime = XG(request_time);
2252                    stored_xce->ttl   = xce.ttl;
2253                    TRACE("%s", "incdec: islong");
2254                    value = Z_LVAL_P(stored_var->value);
2255                    value += (inc == 1 ? count : - count);
2256                    RETVAL_LONG(value);
2257
2258                    zv = (zval *) xce.cache->shm->handlers->to_readwrite(xce.cache->shm, (char *) stored_var->value);
2259                    Z_LVAL_P(zv) = value;
2260                    break; /* leave lock */
2261                }
2262                else {
2263                    TRACE("%s", "incdec: notlong");
2264                    xc_processor_restore_zval(&oldzval, stored_xce->data.var->value, stored_xce->data.var->have_references TSRMLS_CC);
2265                    convert_to_long(&oldzval);
2266                    value = Z_LVAL(oldzval);
2267                    zval_dtor(&oldzval);
2268                }
2269            }
2270        }
2271        else {
2272            TRACE("incdec: %s not found", xce.name.str.val);
2273        }
2274
2275        value += (inc == 1 ? count : - count);
2276        RETVAL_LONG(value);
2277        var.value = return_value;
2278
2279        if (stored_xce) {
2280            xce.atime = stored_xce->atime;
2281            xce.ctime = stored_xce->ctime;
2282            xce.hits  = stored_xce->hits;
2283            xc_entry_remove_dmz(stored_xce TSRMLS_CC);
2284        }
2285        xc_entry_store_dmz(&xce TSRMLS_CC);
2286
2287    } LEAVE_LOCK(xce.cache);
2288}
2289/* }}} */
2290/* {{{ proto int xcache_inc(string name [, int value [, int ttl]])
2291   Increase an int counter in cache by specified name, create it if not exists */
2292PHP_FUNCTION(xcache_inc)
2293{
2294    xc_var_inc_dec(1, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2295}
2296/* }}} */
2297/* {{{ proto int xcache_dec(string name [, int value [, int ttl]])
2298   Decrease an int counter in cache by specified name, create it if not exists */
2299PHP_FUNCTION(xcache_dec)
2300{
2301    xc_var_inc_dec(-1, INTERNAL_FUNCTION_PARAM_PASSTHRU);
2302}
2303/* }}} */
2304/* {{{ proto string xcache_asm(string filename)
2305 */
2306#ifdef HAVE_XCACHE_ASSEMBLER
2307PHP_FUNCTION(xcache_asm)
2308{
2309}
2310#endif
2311/* }}} */
2312#ifdef HAVE_XCACHE_DISASSEMBLER
2313/* {{{ proto array  xcache_dasm_file(string filename)
2314   Disassemble file into opcode array by filename */
2315PHP_FUNCTION(xcache_dasm_file)
2316{
2317    char *filename;
2318    int filename_len;
2319
2320    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &filename, &filename_len) == FAILURE) {
2321        return;
2322    }
2323    if (!filename_len) RETURN_FALSE;
2324
2325    xc_dasm_file(return_value, filename TSRMLS_CC);
2326}
2327/* }}} */
2328/* {{{ proto array  xcache_dasm_string(string code)
2329   Disassemble php code into opcode array */
2330PHP_FUNCTION(xcache_dasm_string)
2331{
2332    zval *code;
2333
2334    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &code) == FAILURE) {
2335        return;
2336    }
2337    xc_dasm_string(return_value, code TSRMLS_CC);
2338}
2339/* }}} */
2340#endif
2341/* {{{ proto string xcache_encode(string filename)
2342   Encode php file into XCache opcode encoded format */
2343#ifdef HAVE_XCACHE_ENCODER
2344PHP_FUNCTION(xcache_encode)
2345{
2346}
2347#endif
2348/* }}} */
2349/* {{{ proto bool xcache_decode_file(string filename)
2350   Decode(load) opcode from XCache encoded format file */
2351#ifdef HAVE_XCACHE_DECODER
2352PHP_FUNCTION(xcache_decode_file)
2353{
2354}
2355#endif
2356/* }}} */
2357/* {{{ proto bool xcache_decode_string(string data)
2358   Decode(load) opcode from XCache encoded format data */
2359#ifdef HAVE_XCACHE_DECODER
2360PHP_FUNCTION(xcache_decode_string)
2361{
2362}
2363#endif
2364/* }}} */
2365/* {{{ xc_call_getter */
2366typedef const char *(xc_name_getter_t)(zend_uchar type);
2367static void xc_call_getter(xc_name_getter_t getter, int count, INTERNAL_FUNCTION_PARAMETERS)
2368{
2369    long spec;
2370    const char *name;
2371
2372    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &spec) == FAILURE) {
2373        return;
2374    }
2375    if (spec >= 0 && spec < count) {
2376        name = getter((zend_uchar) spec);
2377        if (name) {
2378            /* RETURN_STRING */
2379            int len = strlen(name);
2380            return_value->value.str.len = len;
2381            return_value->value.str.val = estrndup(name, len);
2382            return_value->type = IS_STRING; 
2383            return;
2384        }
2385    }
2386    RETURN_NULL();
2387}
2388/* }}} */
2389/* {{{ proto string xcache_get_op_type(int op_type) */
2390PHP_FUNCTION(xcache_get_op_type)
2391{
2392    xc_call_getter(xc_get_op_type, xc_get_op_type_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2393}
2394/* }}} */
2395/* {{{ proto string xcache_get_data_type(int type) */
2396PHP_FUNCTION(xcache_get_data_type)
2397{
2398    xc_call_getter(xc_get_data_type, xc_get_data_type_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2399}
2400/* }}} */
2401/* {{{ proto string xcache_get_opcode(int opcode) */
2402PHP_FUNCTION(xcache_get_opcode)
2403{
2404    xc_call_getter(xc_get_opcode, xc_get_opcode_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2405}
2406/* }}} */
2407/* {{{ proto string xcache_get_op_spec(int op_type) */
2408PHP_FUNCTION(xcache_get_op_spec)
2409{
2410    xc_call_getter(xc_get_op_spec, xc_get_op_spec_count(), INTERNAL_FUNCTION_PARAM_PASSTHRU);
2411}
2412/* }}} */
2413#ifdef HAVE_XCACHE_OPCODE_SPEC_DEF
2414/* {{{ proto string xcache_get_opcode_spec(int opcode) */
2415PHP_FUNCTION(xcache_get_opcode_spec)
2416{
2417    long spec;
2418    const xc_opcode_spec_t *opspec;
2419
2420    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &spec) == FAILURE) {
2421        return;
2422    }
2423    if ((zend_uchar) spec <= xc_get_opcode_spec_count()) {
2424        opspec = xc_get_opcode_spec((zend_uchar) spec);
2425        if (opspec) {
2426            array_init(return_value);
2427            add_assoc_long_ex(return_value, ZEND_STRS("ext"), opspec->ext);
2428            add_assoc_long_ex(return_value, ZEND_STRS("op1"), opspec->op1);
2429            add_assoc_long_ex(return_value, ZEND_STRS("op2"), opspec->op2);
2430            add_assoc_long_ex(return_value, ZEND_STRS("res"), opspec->res);
2431            return;
2432        }
2433    }
2434    RETURN_NULL();
2435}
2436/* }}} */
2437#endif
2438/* {{{ proto mixed xcache_get_special_value(zval value) */
2439PHP_FUNCTION(xcache_get_special_value)
2440{
2441    zval *value;
2442
2443    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &value) == FAILURE) {
2444        return;
2445    }
2446
2447    if (value->type == IS_CONSTANT) {
2448        *return_value = *value;
2449        zval_copy_ctor(return_value);
2450        return_value->type = UNISW(IS_STRING, UG(unicode) ? IS_UNICODE : IS_STRING);
2451        return;
2452    }
2453
2454    if (value->type == IS_CONSTANT_ARRAY) {
2455        *return_value = *value;
2456        zval_copy_ctor(return_value);
2457        return_value->type = IS_ARRAY;
2458        return;
2459    }
2460
2461    RETURN_NULL();
2462}
2463/* }}} */
2464/* {{{ proto string xcache_coredump(int op_type) */
2465PHP_FUNCTION(xcache_coredump)
2466{
2467    if (xc_test) {
2468        raise(SIGSEGV);
2469    }
2470    else {
2471        php_error_docref(NULL TSRMLS_CC, E_WARNING, "xcache.test must be enabled to test xcache_coredump()");
2472    }
2473}
2474/* }}} */
2475/* {{{ proto string xcache_is_autoglobal(string name) */
2476PHP_FUNCTION(xcache_is_autoglobal)
2477{
2478    char *name;
2479    int name_len;
2480
2481    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &name, &name_len) == FAILURE) {
2482        return;
2483    }
2484
2485    RETURN_BOOL(zend_hash_exists(CG(auto_globals), name, name_len + 1));
2486}
2487/* }}} */
2488static function_entry xcache_functions[] = /* {{{ */
2489{
2490    PHP_FE(xcache_count,             NULL)
2491    PHP_FE(xcache_info,              NULL)
2492    PHP_FE(xcache_list,              NULL)
2493    PHP_FE(xcache_clear_cache,       NULL)
2494    PHP_FE(xcache_coredump,          NULL)
2495#ifdef HAVE_XCACHE_ASSEMBLER
2496    PHP_FE(xcache_asm,               NULL)
2497#endif
2498#ifdef HAVE_XCACHE_DISASSEMBLER
2499    PHP_FE(xcache_dasm_file,         NULL)
2500    PHP_FE(xcache_dasm_string,       NULL)
2501#endif
2502#ifdef HAVE_XCACHE_ENCODER
2503    PHP_FE(xcache_encode,            NULL)
2504#endif
2505#ifdef HAVE_XCACHE_DECODER
2506    PHP_FE(xcache_decode_file,       NULL)
2507    PHP_FE(xcache_decode_string,     NULL)
2508#endif
2509#ifdef HAVE_XCACHE_COVERAGER
2510    PHP_FE(xcache_coverager_decode,  NULL)
2511    PHP_FE(xcache_coverager_start,   NULL)
2512    PHP_FE(xcache_coverager_stop,    NULL)
2513    PHP_FE(xcache_coverager_get,     NULL)
2514#endif
2515    PHP_FE(xcache_get_special_value, NULL)
2516    PHP_FE(xcache_get_op_type,       NULL)
2517    PHP_FE(xcache_get_data_type,     NULL)
2518    PHP_FE(xcache_get_opcode,        NULL)
2519#ifdef HAVE_XCACHE_OPCODE_SPEC_DEF
2520    PHP_FE(xcache_get_opcode_spec,   NULL)
2521#endif
2522    PHP_FE(xcache_is_autoglobal,     NULL)
2523    PHP_FE(xcache_inc,               NULL)
2524    PHP_FE(xcache_dec,               NULL)
2525    PHP_FE(xcache_get,               NULL)
2526    PHP_FE(xcache_set,               NULL)
2527    PHP_FE(xcache_isset,             NULL)
2528    PHP_FE(xcache_unset,             NULL)
2529    {NULL, NULL,                     NULL}
2530};
2531/* }}} */
2532
2533/* old signal handlers {{{ */
2534typedef void (*xc_sighandler_t)(int);
2535#define FOREACH_SIG(sig) static xc_sighandler_t old_##sig##_handler = NULL
2536#include "foreachcoresig.h"
2537#undef FOREACH_SIG
2538/* }}} */
2539static void xcache_signal_handler(int sig);
2540static void xcache_restore_signal_handler() /* {{{ */
2541{
2542#define FOREACH_SIG(sig) do { \
2543    if (old_##sig##_handler != xcache_signal_handler) { \
2544        signal(sig, old_##sig##_handler); \
2545    } \
2546    else { \
2547        signal(sig, SIG_DFL); \
2548    } \
2549} while (0)
2550#include "foreachcoresig.h"
2551#undef FOREACH_SIG
2552}
2553/* }}} */
2554static void xcache_init_signal_handler() /* {{{ */
2555{
2556#define FOREACH_SIG(sig) \
2557    old_##sig##_handler = signal(sig, xcache_signal_handler)
2558#include "foreachcoresig.h"
2559#undef FOREACH_SIG
2560}
2561/* }}} */
2562static void xcache_signal_handler(int sig) /* {{{ */
2563{
2564    xcache_restore_signal_handler();
2565    if (xc_coredump_dir && xc_coredump_dir[0]) {
2566        chdir(xc_coredump_dir);
2567    }
2568    raise(sig);
2569}
2570/* }}} */
2571
2572/* {{{ PHP_INI */
2573
2574static PHP_INI_MH(xc_OnUpdateDummy)
2575{
2576    return SUCCESS;
2577}
2578
2579static PHP_INI_MH(xc_OnUpdateULong)
2580{
2581    zend_ulong *p = (zend_ulong *) mh_arg1;
2582
2583    *p = (zend_ulong) atoi(new_value);
2584    return SUCCESS;
2585}
2586
2587static PHP_INI_MH(xc_OnUpdateBool)
2588{
2589    zend_bool *p = (zend_bool *)mh_arg1;
2590
2591    if (strncasecmp("on", new_value, sizeof("on"))) {
2592        *p = (zend_bool) atoi(new_value);
2593    }
2594    else {
2595        *p = (zend_bool) 1;
2596    }
2597    return SUCCESS;
2598}
2599
2600static PHP_INI_MH(xc_OnUpdateString)
2601{
2602    char **p = (char**)mh_arg1;
2603    if (*p) {
2604        pefree(*p, 1);
2605    }
2606    *p = pemalloc(strlen(new_value) + 1, 1);
2607    strcpy(*p, new_value);
2608    return SUCCESS;
2609}
2610
2611#ifndef ZEND_ENGINE_2
2612#define OnUpdateLong OnUpdateInt
2613#endif
2614
2615#ifdef ZEND_WIN32
2616#   define DEFAULT_PATH "xcache"
2617#else
2618#   define DEFAULT_PATH "/dev/zero"
2619#endif
2620PHP_INI_BEGIN()
2621    PHP_INI_ENTRY1     ("xcache.mmap_path",     DEFAULT_PATH, PHP_INI_SYSTEM, xc_OnUpdateString,   &xc_mmap_path)
2622    PHP_INI_ENTRY1     ("xcache.coredump_directory",      "", PHP_INI_SYSTEM, xc_OnUpdateString,   &xc_coredump_dir)
2623    PHP_INI_ENTRY1     ("xcache.test",                   "0", PHP_INI_SYSTEM, xc_OnUpdateBool,     &xc_test)
2624    PHP_INI_ENTRY1     ("xcache.readonly_protection",    "0", PHP_INI_SYSTEM, xc_OnUpdateBool,     &xc_readonly_protection)
2625    /* opcode cache */
2626    PHP_INI_ENTRY1     ("xcache.size",                   "0", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2627    PHP_INI_ENTRY1     ("xcache.count",                  "1", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2628    PHP_INI_ENTRY1     ("xcache.slots",                 "8K", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2629    PHP_INI_ENTRY1     ("xcache.shm_scheme",          "mmap", PHP_INI_SYSTEM, xc_OnUpdateString,   &xc_shm_scheme)
2630    PHP_INI_ENTRY1     ("xcache.ttl",                    "0", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_php_ttl)
2631    PHP_INI_ENTRY1     ("xcache.gc_interval",            "0", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_php_gc_interval)
2632    /* var cache */
2633    PHP_INI_ENTRY1     ("xcache.var_size",               "0", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2634    PHP_INI_ENTRY1     ("xcache.var_count",              "1", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2635    PHP_INI_ENTRY1     ("xcache.var_slots",             "8K", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2636    PHP_INI_ENTRY1     ("xcache.var_maxttl",             "0", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_var_maxttl)
2637    PHP_INI_ENTRY1     ("xcache.var_gc_interval",      "120", PHP_INI_SYSTEM, xc_OnUpdateULong,    &xc_var_gc_interval)
2638
2639    STD_PHP_INI_BOOLEAN("xcache.cacher",                 "1", PHP_INI_ALL,    OnUpdateBool,        cacher,            zend_xcache_globals, xcache_globals)
2640    STD_PHP_INI_BOOLEAN("xcache.stat",                   "1", PHP_INI_ALL,    OnUpdateBool,        stat,              zend_xcache_globals, xcache_globals)
2641    STD_PHP_INI_BOOLEAN("xcache.experimental",           "0", PHP_INI_ALL,    OnUpdateBool,        experimental,      zend_xcache_globals, xcache_globals)
2642#ifdef HAVE_XCACHE_OPTIMIZER
2643    STD_PHP_INI_BOOLEAN("xcache.optimizer",              "0", PHP_INI_ALL,    OnUpdateBool,        optimizer,         zend_xcache_globals, xcache_globals)
2644#endif
2645    STD_PHP_INI_ENTRY  ("xcache.var_ttl",                "0", PHP_INI_ALL,    OnUpdateLong,        var_ttl,           zend_xcache_globals, xcache_globals)
2646#ifdef HAVE_XCACHE_COVERAGER
2647    STD_PHP_INI_BOOLEAN("xcache.coverager"      ,        "0", PHP_INI_ALL,    OnUpdateBool,        coverager,         zend_xcache_globals, xcache_globals)
2648    PHP_INI_ENTRY1     ("xcache.coveragedump_directory",  "", PHP_INI_SYSTEM, xc_OnUpdateDummy,    NULL)
2649#endif
2650PHP_INI_END()
2651/* }}} */
2652/* {{{ PHP_MINFO_FUNCTION(xcache) */
2653static PHP_MINFO_FUNCTION(xcache)
2654{
2655    char buf[100];
2656    char *ptr;
2657    int left, len;
2658    xc_shm_scheme_t *scheme;
2659    char *covdumpdir;
2660
2661    php_info_print_table_start();
2662    php_info_print_table_header(2, "XCache Support", "enabled");
2663    php_info_print_table_row(2, "Version", XCACHE_VERSION);
2664    php_info_print_table_row(2, "Modules Built", XCACHE_MODULES);
2665    php_info_print_table_row(2, "Readonly Protection", xc_readonly_protection ? "enabled" : "N/A");
2666
2667    if (xc_php_size) {
2668        ptr = _php_math_number_format(xc_php_size, 0, '.', ',');
2669        snprintf(buf, sizeof(buf), "enabled, %s bytes, %d split(s), with %d slots each", ptr, xc_php_hcache.size, xc_php_hentry.size);
2670        php_info_print_table_row(2, "Opcode Cache", buf);
2671        efree(ptr);
2672    }
2673    else {
2674        php_info_print_table_row(2, "Opcode Cache", "disabled");
2675    }
2676    if (xc_var_size) {
2677        ptr = _php_math_number_format(xc_var_size, 0, '.', ',');
2678        snprintf(buf, sizeof(buf), "enabled, %s bytes, %d split(s), with %d slots each", ptr, xc_var_hcache.size, xc_var_hentry.size);
2679        php_info_print_table_row(2, "Variable Cache", buf);
2680        efree(ptr);
2681    }
2682    else {
2683        php_info_print_table_row(2, "Variable Cache", "disabled");
2684    }
2685
2686    left = sizeof(buf);
2687    ptr = buf;
2688    buf[0] = '\0';
2689    for (scheme = xc_shm_scheme_first(); scheme; scheme = xc_shm_scheme_next(scheme)) {
2690        len = snprintf(ptr, left, ptr == buf ? "%s" : ", %s", xc_shm_scheme_name(scheme));
2691        left -= len;
2692        ptr += len;
2693    }
2694    php_info_print_table_row(2, "Shared Memory Schemes", buf);
2695
2696#ifdef HAVE_XCACHE_COVERAGER
2697    if (cfg_get_string("xcache.coveragedump_directory", &covdumpdir) != SUCCESS || !covdumpdir[0]) {
2698        covdumpdir = NULL;
2699    }
2700    php_info_print_table_row(2, "Coverage Auto Dumper", XG(coverager) && covdumpdir ? "enabled" : "disabled");
2701#endif
2702    php_info_print_table_end();
2703
2704    DISPLAY_INI_ENTRIES();
2705}
2706/* }}} */
2707/* {{{ extension startup */
2708static void xc_zend_extension_register(zend_extension *new_extension, DL_HANDLE handle)
2709{
2710    zend_extension extension;
2711
2712    extension = *new_extension;
2713    extension.handle = handle;
2714
2715    zend_extension_dispatch_message(ZEND_EXTMSG_NEW_EXTENSION, &extension);
2716
2717    zend_llist_prepend_element(&zend_extensions, &extension);
2718    TRACE("%s", "registered");
2719}
2720
2721static zend_llist_element *xc_llist_get_element_by_zend_extension(zend_llist *l, const char *extension_name)
2722{
2723    zend_llist_element *element;
2724
2725    for (element = zend_extensions.head; element; element = element->next) {
2726        zend_extension *extension = (zend_extension *) element->data;
2727
2728        if (!strcmp(extension->name, extension_name)) {
2729            return element;
2730        }
2731    }
2732    return NULL;
2733}
2734
2735static void xc_llist_prepend(zend_llist *l, zend_llist_element *element)
2736{
2737    element->next = l->head;
2738    element->prev = NULL;
2739    if (l->head) {
2740        l->head->prev = element;
2741    }
2742    else {
2743        l->tail = element;
2744    }
2745    l->head = element;
2746    ++l->count;
2747}
2748
2749static void xc_llist_unlink(zend_llist *l, zend_llist_element *element)
2750{
2751    if ((element)->prev) {
2752        (element)->prev->next = (element)->next;
2753    }
2754    else {
2755        (l)->head = (element)->next;
2756    }
2757
2758    if ((element)->next) {
2759        (element)->next->prev = (element)->prev;
2760    }
2761    else {
2762        (l)->tail = (element)->prev;
2763    }
2764
2765    --l->count;
2766}
2767
2768static int xc_zend_extension_startup(zend_extension *extension)
2769{
2770    if (extension->startup) {
2771        if (extension->startup(extension) != SUCCESS) {
2772            return FAILURE;
2773        }
2774    }
2775    return SUCCESS;
2776}
2777/* }}} */
2778static int xc_ptr_compare_func(void *p1, void *p2) /* {{{ */
2779{
2780    return p1 == p2;
2781}
2782/* }}} */
2783static int xc_zend_remove_extension(zend_extension *extension) /* {{{ */
2784{
2785    llist_dtor_func_t dtor;
2786
2787    assert(extension);
2788    dtor = zend_extensions.dtor; /* avoid dtor */
2789    zend_extensions.dtor = NULL;
2790    zend_llist_del_element(&zend_extensions, extension, xc_ptr_compare_func);
2791    zend_extensions.dtor = dtor;
2792    return SUCCESS;
2793}
2794/* }}} */
2795static int xc_config_hash(xc_hash_t *p, char *name, char *default_value) /* {{{ */
2796{
2797    int bits, size;
2798    char *value;
2799
2800    if (cfg_get_string(name, &value) != SUCCESS) {
2801        value = default_value;
2802    }
2803
2804    p->size = zend_atoi(value, strlen(value));
2805    for (size = 1, bits = 1; size < p->size; bits ++, size <<= 1) {
2806        /* empty body */
2807    }
2808    p->size = size;
2809    p->bits = bits;
2810    p->mask = size - 1;
2811
2812    return SUCCESS;
2813}
2814/* }}} */
2815static int xc_config_long(zend_ulong *p, char *name, char *default_value) /* {{{ */
2816{
2817    char *value;
2818
2819    if (cfg_get_string(name, &value) != SUCCESS) {
2820        value = default_value;
2821    }
2822
2823    *p = zend_atoi(value, strlen(value));
2824    return SUCCESS;
2825}
2826/* }}} */
2827/* {{{ PHP_MINIT_FUNCTION(xcache) */
2828static PHP_MINIT_FUNCTION(xcache)
2829{
2830    char *env;
2831    zend_extension *ext;
2832    zend_llist_position lpos;
2833
2834    xc_module_gotup = 1;
2835    if (!xc_zend_extension_gotup) {
2836        xc_zend_extension_register(&zend_extension_entry, 0);
2837        xc_zend_extension_startup(&zend_extension_entry);
2838        xc_zend_extension_faked = 1;
2839    }
2840
2841    ext = zend_get_extension("Zend Optimizer");
2842    if (ext) {
2843        /* zend_optimizer.optimization_level>0 is not compatible with other cacher, disabling */
2844        ext->op_array_handler = NULL;
2845    }
2846    /* cache if there's an op_array_ctor */
2847    for (ext = zend_llist_get_first_ex(&zend_extensions, &lpos);
2848            ext;
2849            ext = zend_llist_get_next_ex(&zend_extensions, &lpos)) {
2850        if (ext->op_array_ctor) {
2851            xc_have_op_array_ctor = 1;
2852            break;
2853        }
2854    }
2855
2856
2857#ifndef PHP_GINIT
2858    ZEND_INIT_MODULE_GLOBALS(xcache, xc_init_globals, xc_shutdown_globals);
2859#endif
2860    REGISTER_INI_ENTRIES();
2861
2862    if (strcmp(sapi_module.name, "cli") == 0) {
2863        if ((env = getenv("XCACHE_TEST")) != NULL) {
2864            zend_alter_ini_entry("xcache.test", sizeof("xcache.test"), env, strlen(env) + 1, PHP_INI_SYSTEM, PHP_INI_STAGE_STARTUP);
2865        }
2866        if (!xc_test) {
2867            /* disable cache for cli except for test */
2868            xc_php_size = xc_var_size = 0;
2869        }
2870    }
2871
2872    xc_config_long(&xc_php_size,       "xcache.size",        "0");
2873    xc_config_hash(&xc_php_hcache,     "xcache.count",       "1");
2874    xc_config_hash(&xc_php_hentry,     "xcache.slots",      "8K");
2875
2876    xc_config_long(&xc_var_size,       "xcache.var_size",    "0");
2877    xc_config_hash(&xc_var_hcache,     "xcache.var_count",   "1");
2878    xc_config_hash(&xc_var_hentry,     "xcache.var_slots",  "8K");
2879
2880    if (xc_php_size <= 0) {
2881        xc_php_size = xc_php_hcache.size = 0;
2882    }
2883    if (xc_var_size <= 0) {
2884        xc_var_size = xc_var_hcache.size = 0;
2885    }
2886
2887    if (xc_coredump_dir && xc_coredump_dir[0]) {
2888        xcache_init_signal_handler();
2889    }
2890
2891    xc_init_constant(module_number TSRMLS_CC);
2892    xc_shm_init_modules();
2893
2894    if ((xc_php_size || xc_var_size) && xc_mmap_path && xc_mmap_path[0]) {
2895        if (xc_init(module_number TSRMLS_CC) != SUCCESS) {
2896            zend_error(E_ERROR, "XCache: Cannot init");
2897            goto err_init;
2898        }
2899        xc_initized = 1;
2900    }
2901
2902#ifdef HAVE_XCACHE_COVERAGER
2903    xc_coverager_init(module_number TSRMLS_CC);
2904#endif
2905
2906    return SUCCESS;
2907
2908err_init:
2909    return FAILURE;
2910}
2911/* }}} */
2912/* {{{ PHP_MSHUTDOWN_FUNCTION(xcache) */
2913static PHP_MSHUTDOWN_FUNCTION(xcache)
2914{
2915    if (xc_initized) {
2916        xc_destroy();
2917    }
2918    if (xc_mmap_path) {
2919        pefree(xc_mmap_path, 1);
2920        xc_mmap_path = NULL;
2921    }
2922    if (xc_shm_scheme) {
2923        pefree(xc_shm_scheme, 1);
2924        xc_shm_scheme = NULL;
2925    }
2926
2927#ifdef HAVE_XCACHE_COVERAGER
2928    xc_coverager_destroy();
2929#endif
2930
2931    if (xc_coredump_dir && xc_coredump_dir[0]) {
2932        xcache_restore_signal_handler();
2933    }
2934    if (xc_coredump_dir) {
2935        pefree(xc_coredump_dir, 1);
2936        xc_coredump_dir = NULL;
2937    }
2938#ifndef PHP_GINIT
2939#   ifdef ZTS
2940    ts_free_id(xcache_globals_id);
2941#   else
2942    xc_shutdown_globals(&xcache_globals TSRMLS_CC);
2943#   endif
2944#endif
2945
2946    if (xc_zend_extension_faked) {
2947        zend_extension *ext = zend_get_extension(XCACHE_NAME);
2948        if (ext->shutdown) {
2949            ext->shutdown(ext);
2950        }
2951        xc_zend_remove_extension(ext);
2952    }
2953    UNREGISTER_INI_ENTRIES();
2954
2955    xc_module_gotup = 0;
2956    xc_zend_extension_gotup = 0;
2957    xc_zend_extension_faked = 0;
2958
2959    return SUCCESS;
2960}
2961/* }}} */
2962/* {{{ PHP_RINIT_FUNCTION(xcache) */
2963static PHP_RINIT_FUNCTION(xcache)
2964{
2965    xc_request_init(TSRMLS_C);
2966    return SUCCESS;
2967}
2968/* }}} */
2969/* {{{ PHP_RSHUTDOWN_FUNCTION(xcache) */
2970#ifndef ZEND_ENGINE_2
2971static PHP_RSHUTDOWN_FUNCTION(xcache)
2972#else
2973static ZEND_MODULE_POST_ZEND_DEACTIVATE_D(xcache)
2974#endif
2975{
2976#ifdef ZEND_ENGINE_2
2977    TSRMLS_FETCH();
2978#endif
2979
2980    xc_request_shutdown(TSRMLS_C);
2981    return SUCCESS;
2982}
2983/* }}} */
2984/* {{{ module dependencies */
2985#if ZEND_MODULE_API_NO >= 20050922
2986static const zend_module_dep xcache_module_deps[] = {
2987    ZEND_MOD_REQUIRED("standard")
2988    ZEND_MOD_CONFLICTS("apc")
2989    ZEND_MOD_CONFLICTS("eAccelerator")
2990    ZEND_MOD_CONFLICTS("Turck MMCache")
2991    {NULL, NULL, NULL}
2992};
2993#endif
2994/* }}} */ 
2995/* {{{ module definition structure */
2996
2997zend_module_entry xcache_module_entry = {
2998#if ZEND_MODULE_API_NO >= 20050922
2999    STANDARD_MODULE_HEADER_EX,
3000    NULL,
3001    xcache_module_deps,
3002#else
3003    STANDARD_MODULE_HEADER,
3004#endif
3005    XCACHE_NAME,
3006    xcache_functions,
3007    PHP_MINIT(xcache),
3008    PHP_MSHUTDOWN(xcache),
3009    PHP_RINIT(xcache),
3010#ifndef ZEND_ENGINE_2
3011    PHP_RSHUTDOWN(xcache),
3012#else
3013    NULL,
3014#endif
3015    PHP_MINFO(xcache),
3016    XCACHE_VERSION,
3017#ifdef PHP_GINIT
3018    PHP_MODULE_GLOBALS(xcache),
3019    PHP_GINIT(xcache),
3020    PHP_GSHUTDOWN(xcache),
3021#endif
3022#ifdef ZEND_ENGINE_2
3023    ZEND_MODULE_POST_ZEND_DEACTIVATE_N(xcache),
3024#else
3025    NULL,
3026    NULL,
3027#endif
3028    STANDARD_MODULE_PROPERTIES_EX
3029};
3030
3031#ifdef COMPILE_DL_XCACHE
3032ZEND_GET_MODULE(xcache)
3033#endif
3034/* }}} */
3035static startup_func_t xc_last_ext_startup;
3036static int xc_zend_startup_last(zend_extension *extension) /* {{{ */
3037{
3038    /* restore */
3039    extension->startup = xc_last_ext_startup;
3040    if (extension->startup) {
3041        if (extension->startup(extension) != SUCCESS) {
3042            return FAILURE;
3043        }
3044    }
3045    assert(xc_llist_zend_extension);
3046    xc_llist_prepend(&zend_extensions, xc_llist_zend_extension);
3047    if (!xc_module_gotup) {
3048        return zend_startup_module(&xcache_module_entry);
3049    }
3050    return SUCCESS;
3051}
3052/* }}} */
3053ZEND_DLEXPORT int xcache_zend_startup(zend_extension *extension) /* {{{ */
3054{
3055    xc_zend_extension_gotup = 1;
3056
3057    if (!origin_compile_file) {
3058        origin_compile_file = zend_compile_file;
3059        zend_compile_file = xc_check_initial_compile_file;
3060    }
3061
3062    if (zend_llist_count(&zend_extensions) > 1) {
3063        zend_llist_position lpos;
3064        zend_extension *ext;
3065
3066        xc_llist_zend_extension = xc_llist_get_element_by_zend_extension(&zend_extensions, XCACHE_NAME);
3067        xc_llist_unlink(&zend_extensions, xc_llist_zend_extension);
3068
3069        ext = (zend_extension *) zend_llist_get_last_ex(&zend_extensions, &lpos);
3070        assert(ext && ext != xc_llist_zend_extension);
3071        xc_last_ext_startup = ext->startup;
3072        ext->startup = xc_zend_startup_last;
3073    }
3074    else if (!xc_module_gotup) {
3075        return zend_startup_module(&xcache_module_entry);
3076    }
3077    return SUCCESS;
3078}
3079/* }}} */
3080ZEND_DLEXPORT void xcache_zend_shutdown(zend_extension *extension) /* {{{ */
3081{
3082    /* empty */
3083}
3084/* }}} */
3085ZEND_DLEXPORT void xcache_statement_handler(zend_op_array *op_array) /* {{{ */
3086{
3087#ifdef HAVE_XCACHE_COVERAGER
3088    xc_coverager_handle_ext_stmt(op_array, ZEND_EXT_STMT);
3089#endif
3090}
3091/* }}} */
3092ZEND_DLEXPORT void xcache_fcall_begin_handler(zend_op_array *op_array) /* {{{ */
3093{
3094#if 0
3095    xc_coverager_handle_ext_stmt(op_array, ZEND_EXT_FCALL_BEGIN);
3096#endif
3097}
3098/* }}} */
3099ZEND_DLEXPORT void xcache_fcall_end_handler(zend_op_array *op_array) /* {{{ */
3100{
3101#if 0
3102    xc_coverager_handle_ext_stmt(op_array, ZEND_EXT_FCALL_END);
3103#endif
3104}
3105/* }}} */
3106/* {{{ zend extension definition structure */
3107ZEND_DLEXPORT zend_extension zend_extension_entry = {
3108    XCACHE_NAME,
3109    XCACHE_VERSION,
3110    XCACHE_AUTHOR,
3111    XCACHE_URL,
3112    XCACHE_COPYRIGHT,
3113    xcache_zend_startup,
3114    xcache_zend_shutdown,
3115    NULL,           /* activate_func_t */
3116    NULL,           /* deactivate_func_t */
3117    NULL,           /* message_handler_func_t */
3118#ifdef HAVE_XCACHE_OPTIMIZER
3119    xc_optimizer_op_array_handler,
3120#else
3121    NULL,           /* op_array_handler_func_t */
3122#endif
3123    xcache_statement_handler,
3124    xcache_fcall_begin_handler,
3125    xcache_fcall_end_handler,
3126    NULL,           /* op_array_ctor_func_t */
3127    NULL,           /* op_array_dtor_func_t */
3128    STANDARD_ZEND_EXTENSION_PROPERTIES
3129};
3130
3131#ifndef ZEND_EXT_API
3132#   define ZEND_EXT_API ZEND_DLEXPORT
3133#endif
3134#if COMPILE_DL_XCACHE
3135ZEND_EXTENSION();
3136#endif
3137/* }}} */
Note: See TracBrowser for help on using the repository browser.