+++ /dev/null
-/*
- +----------------------------------------------------------------------+
- | APC |
- +----------------------------------------------------------------------+
- | Copyright (c) 2008 The PHP Group |
- +----------------------------------------------------------------------+
- | This source file is subject to version 3.01 of the PHP license, |
- | that is bundled with this package in the file LICENSE, and is |
- | available through the world-wide-web at the following url: |
- | http://www.php.net/license/3_01.txt. |
- | If you did not receive a copy of the PHP license and are unable to |
- | obtain it through the world-wide-web, please send a note to |
- | license@php.net so we can mail you a copy immediately. |
- +----------------------------------------------------------------------+
- | Authors: Daniel Cowgill <dcowgill@communityconnect.com> |
- | Rasmus Lerdorf <rasmus@php.net> |
- +----------------------------------------------------------------------+
-
- This software was contributed to PHP by Community Connect Inc. in 2002
- and revised in 2005 by Yahoo! Inc. to add support for PHP 5.1.
- Future revisions and derivatives of this source code must acknowledge
- Community Connect Inc. as the original contributor of this module by
- leaving this note intact in the source code.
-
- All other licensing and usage conditions are those of the PHP Group.
-
- */
-
-/* $Id: apc_cache.h,v 3.46.2.4 2008/05/11 18:57:00 rasmus Exp $ */
-
-#ifndef APC_CACHE_H
-#define APC_CACHE_H
-
-/*
- * This module defines the shared memory file cache. Basically all of the
- * logic for storing and retrieving cache entries lives here.
- */
-
-#include "apc.h"
-#include "apc_compile.h"
-#include "apc_lock.h"
-
-#define APC_CACHE_ENTRY_FILE 1
-#define APC_CACHE_ENTRY_USER 2
-
-#define APC_CACHE_KEY_FILE 1
-#define APC_CACHE_KEY_USER 2
-#define APC_CACHE_KEY_FPFILE 3
-
-/* {{{ struct definition: apc_cache_key_t */
-#define T apc_cache_t*
-typedef struct apc_cache_t apc_cache_t; /* opaque cache type */
-
-typedef union _apc_cache_key_data_t {
- struct {
- dev_t device; /* the filesystem device */
- ino_t inode; /* the filesystem inode */
- } file;
- struct {
- const char *identifier;
- int identifier_len;
- } user;
- struct {
- const char *fullpath;
- int fullpath_len;
- } fpfile;
-} apc_cache_key_data_t;
-
-typedef struct apc_cache_key_t apc_cache_key_t;
-struct apc_cache_key_t {
- apc_cache_key_data_t data;
- time_t mtime; /* the mtime of this cached entry */
- unsigned char type;
-};
-/* }}} */
-
-/* {{{ struct definition: apc_cache_entry_t */
-typedef union _apc_cache_entry_value_t {
- struct {
- char *filename; /* absolute path to source file */
- zend_op_array* op_array; /* op_array allocated in shared memory */
- apc_function_t* functions; /* array of apc_function_t's */
- apc_class_t* classes; /* array of apc_class_t's */
- } file;
- struct {
- char *info;
- int info_len;
- zval *val;
- unsigned int ttl;
- } user;
-} apc_cache_entry_value_t;
-
-typedef struct apc_cache_entry_t apc_cache_entry_t;
-struct apc_cache_entry_t {
- apc_cache_entry_value_t data;
- unsigned char type;
- int ref_count;
- size_t mem_size;
-};
-/* }}} */
-
-/*
- * apc_cache_create creates the shared memory compiler cache. This function
- * should be called just once (ideally in the web server parent process, e.g.
- * in apache), otherwise you will end up with multiple caches (which won't
- * necessarily break anything). Returns a pointer to the cache object.
- *
- * size_hint is a "hint" at the total number of source files that will be
- * cached. It determines the physical size of the hash table. Passing 0 for
- * this argument will use a reasonable default value.
- *
- * gc_ttl is the maximum time a cache entry may speed on the garbage
- * collection list. This is basically a work around for the inherent
- * unreliability of our reference counting mechanism (see apc_cache_release).
- *
- * ttl is the maximum time a cache entry can idle in a slot in case the slot
- * is needed. This helps in cleaning up the cache and ensuring that entries
- * hit frequently stay cached and ones not hit very often eventually disappear.
- */
-extern T apc_cache_create(int size_hint, int gc_ttl, int ttl);
-
-/*
- * apc_cache_destroy releases any OS resources associated with a cache object.
- * Under apache, this function can be safely called by the child processes
- * when they exit.
- */
-extern void apc_cache_destroy(T cache);
-
-/*
- * apc_cache_clear empties a cache. This can safely be called at any time,
- * even while other server processes are executing cached source files.
- */
-extern void apc_cache_clear(T cache);
-
-/*
- * apc_cache_insert adds an entry to the cache, using a filename as a key.
- * Internally, the filename is translated to a canonical representation, so
- * that relative and absolute filenames will map to a single key. Returns
- * non-zero if the file was successfully inserted, 0 otherwise. If 0 is
- * returned, the caller must free the cache entry by calling
- * apc_cache_free_entry (see below).
- *
- * key is the value created by apc_cache_make_file_key for file keys.
- *
- * value is a cache entry returned by apc_cache_make_entry (see below).
- */
-extern int apc_cache_insert(T cache, apc_cache_key_t key,
- apc_cache_entry_t* value, time_t t);
-
-extern int apc_cache_user_insert(T cache, apc_cache_key_t key,
- apc_cache_entry_t* value, time_t t, int exclusive TSRMLS_DC);
-
-/*
- * apc_cache_find searches for a cache entry by filename, and returns a
- * pointer to the entry if found, NULL otherwise.
- *
- * key is a value created by apc_cache_make_file_key for file keys.
- */
-extern apc_cache_entry_t* apc_cache_find(T cache, apc_cache_key_t key, time_t t);
-
-/*
- * apc_cache_user_find searches for a cache entry by its hashed identifier,
- * and returns a pointer to the entry if found, NULL otherwise.
- *
- */
-extern apc_cache_entry_t* apc_cache_user_find(T cache, char* strkey, int keylen, time_t t);
-
-/*
- * apc_cache_user_delete finds an entry in the user cache and deletes it.
- */
-extern int apc_cache_user_delete(apc_cache_t* cache, char *strkey, int keylen);
-
-/* apc_cach_fetch_zval takes a zval in the cache and reconstructs a runtime
- * zval from it.
- *
- */
-zval* apc_cache_fetch_zval(zval* dst, const zval* src, apc_malloc_t allocate, apc_free_t deallocate);
-
-/*
- * apc_cache_release decrements the reference count associated with a cache
- * entry. Calling apc_cache_find automatically increments the reference count,
- * and this function must be called post-execution to return the count to its
- * original value. Failing to do so will prevent the entry from being
- * garbage-collected.
- *
- * entry is the cache entry whose ref count you want to decrement.
- */
-extern void apc_cache_release(T cache, apc_cache_entry_t* entry);
-
-/*
- * apc_cache_make_file_key creates a key object given a relative or absolute
- * filename and an optional list of auxillary paths to search. include_path is
- * searched if the filename cannot be found relative to the current working
- * directory.
- *
- * key points to caller-allocated storage (must not be null).
- *
- * filename is the path to the source file.
- *
- * include_path is a colon-separated list of directories to search.
- *
- * and finally we pass in the current request time so we can avoid
- * caching files with a current mtime which tends to indicate that
- * they are still being written to.
- */
-extern int apc_cache_make_file_key(apc_cache_key_t* key,
- const char* filename,
- const char* include_path,
- time_t t
- TSRMLS_DC);
-
-/*
- * apc_cache_make_file_entry creates an apc_cache_entry_t object given a filename
- * and the compilation results returned by the PHP compiler.
- */
-extern apc_cache_entry_t* apc_cache_make_file_entry(const char* filename,
- zend_op_array* op_array,
- apc_function_t* functions,
- apc_class_t* classes);
-/*
- * apc_cache_make_user_entry creates an apc_cache_entry_t object given an info string
- * and the zval to be stored.
- */
-extern apc_cache_entry_t* apc_cache_make_user_entry(const char* info, int info_len, const zval *val, const unsigned int ttl);
-
-extern int apc_cache_make_user_key(apc_cache_key_t* key, char* identifier, int identifier_len, const time_t t);
-
-/*
- * Frees all memory associated with an object returned by apc_cache_make_entry
- * (see above).
- */
-extern void apc_cache_free_entry(apc_cache_entry_t* entry);
-
-/* {{{ struct definition: apc_cache_link_data_t */
-typedef union _apc_cache_link_data_t {
- struct {
- char *filename;
- dev_t device;
- ino_t inode;
- } file;
- struct {
- char *info;
- unsigned int ttl;
- } user;
-} apc_cache_link_data_t;
-/* }}} */
-
-/* {{{ struct definition: apc_cache_link_t */
-typedef struct apc_cache_link_t apc_cache_link_t;
-struct apc_cache_link_t {
- apc_cache_link_data_t data;
- unsigned char type;
- int num_hits;
- time_t mtime;
- time_t creation_time;
- time_t deletion_time;
- time_t access_time;
- int ref_count;
- size_t mem_size;
- apc_cache_link_t* next;
-};
-/* }}} */
-
-/* {{{ struct definition: apc_cache_info_t */
-typedef struct apc_cache_info_t apc_cache_info_t;
-struct apc_cache_info_t {
- int num_slots;
- int num_hits;
- int num_misses;
- int ttl;
- apc_cache_link_t* list;
- apc_cache_link_t* deleted_list;
- time_t start_time;
- int expunges;
- int num_entries;
- int num_inserts;
- size_t mem_size;
-};
-/* }}} */
-
-/* {{{ struct definition: slot_t */
-typedef struct slot_t slot_t;
-struct slot_t {
- apc_cache_key_t key; /* slot key */
- apc_cache_entry_t* value; /* slot value */
- slot_t* next; /* next slot in linked list */
- int num_hits; /* number of hits to this bucket */
- time_t creation_time; /* time slot was initialized */
- time_t deletion_time; /* time slot was removed from cache */
- time_t access_time; /* time slot was last accessed */
-};
-/* }}} */
-
-/* {{{ struct definition: cache_header_t
- Any values that must be shared among processes should go in here. */
-typedef struct cache_header_t cache_header_t;
-struct cache_header_t {
- apc_lck_t lock; /* read/write lock (exclusive blocking cache lock) */
- apc_lck_t wrlock; /* write lock (non-blocking used to prevent cache slams) */
- int num_hits; /* total successful hits in cache */
- int num_misses; /* total unsuccessful hits in cache */
- int num_inserts; /* total successful inserts in cache */
- slot_t* deleted_list; /* linked list of to-be-deleted slots */
- time_t start_time; /* time the above counters were reset */
- int expunges; /* total number of expunges */
- zend_bool busy; /* Flag to tell clients when we are busy cleaning the cache */
- int num_entries; /* Statistic on the number of entries */
- size_t mem_size; /* Statistic on the memory size used by this cache */
-};
-/* }}} */
-
-/* {{{ struct definition: apc_cache_t */
-struct apc_cache_t {
- void* shmaddr; /* process (local) address of shared cache */
- cache_header_t* header; /* cache header (stored in SHM) */
- slot_t** slots; /* array of cache slots (stored in SHM) */
- int num_slots; /* number of slots in cache */
- int gc_ttl; /* maximum time on GC list for a slot */
- int ttl; /* if slot is needed and entry's access time is older than this ttl, remove it */
-};
-/* }}} */
-
-extern apc_cache_info_t* apc_cache_info(T cache, zend_bool limited);
-extern void apc_cache_free_info(apc_cache_info_t* info);
-extern void apc_cache_expunge(apc_cache_t* cache, time_t t);
-extern void apc_cache_unlock(apc_cache_t* cache);
-extern zend_bool apc_cache_busy(apc_cache_t* cache);
-extern zend_bool apc_cache_write_lock(apc_cache_t* cache);
-extern void apc_cache_write_unlock(apc_cache_t* cache);
-
-#undef T
-#endif
-
-/*
- * Local variables:
- * tab-width: 4
- * c-basic-offset: 4
- * End:
- * vim600: expandtab sw=4 ts=4 sts=4 fdm=marker
- * vim<600: expandtab sw=4 ts=4 sts=4
- */
projects / php5-apc.git / blobdiff