mirror of
https://github.com/MariaDB/server.git
synced 2025-01-22 23:04:20 +01:00
84 lines
4.1 KiB
C
84 lines
4.1 KiB
C
#ifndef CACHETABLE_H
|
|
#define CACHETABLE_H
|
|
|
|
#include <fcntl.h>
|
|
#include "brttypes.h"
|
|
|
|
/* Implement the cache table. */
|
|
|
|
typedef long long CACHEKEY;
|
|
typedef struct cachetable *CACHETABLE;
|
|
typedef struct cachefile *CACHEFILE;
|
|
|
|
/* Maintain a cache mapping from cachekeys to values (void*)
|
|
* Some of the keys can be pinned. Don't pin too many or for too long.
|
|
* If the cachetable is too full, it will call the flush_callback() function with the key, the value, and the otherargs
|
|
and then remove the key-value pair from the cache.
|
|
* The callback won't be any of the currently pinned keys.
|
|
* Also when flushing an object, the cachetable drops all references to it,
|
|
* so you may need to free() it.
|
|
* Note: The cachetable should use a common pool of memory, flushing things across cachetables.
|
|
* (The first implementation doesn't)
|
|
* If you pin something twice, you must unpin it twice.
|
|
* table_size is the initial size of the cache table hash table (in number of entries)
|
|
* size limit is the upper bound of the sum of size of the entries in the cache table (total number of bytes)
|
|
*/
|
|
int create_cachetable(CACHETABLE */*result*/, long size_limit, LSN initial_lsn, TOKULOGGER);
|
|
|
|
int cachetable_openf (CACHEFILE *,CACHETABLE, const char */*fname*/, int flags, mode_t mode);
|
|
|
|
typedef void (cachetable_flush_func_t)(CACHEFILE, CACHEKEY key, void*value, long size, BOOL write_me, BOOL keep_me, LSN modified_lsn, BOOL rename_p);
|
|
typedef cachetable_flush_func_t *CACHETABLE_FLUSH_FUNC_T;
|
|
|
|
/* If we are asked to fetch something, get it by calling this back. */
|
|
typedef int (cachetable_fetch_func_t)(CACHEFILE, CACHEKEY key, void **value, long *sizep, void *extraargs, LSN *written_lsn);
|
|
typedef cachetable_fetch_func_t *CACHETABLE_FETCH_FUNC_T;
|
|
|
|
/* Error if already present. On success, pin the value. */
|
|
int cachetable_put(CACHEFILE cf, CACHEKEY key, void* value, long size,
|
|
cachetable_flush_func_t flush_callback, cachetable_fetch_func_t fetch_callback, void *extraargs);
|
|
|
|
int cachetable_get_and_pin(CACHEFILE, CACHEKEY, void**/*value*/, long *sizep,
|
|
cachetable_flush_func_t flush_callback, cachetable_fetch_func_t fetch_callback, void *extraargs);
|
|
|
|
/* If the the item is already in memory, then return 0 and store it in the void**.
|
|
* If the item is not in memory, then return nonzero. */
|
|
int cachetable_maybe_get_and_pin (CACHEFILE, CACHEKEY, void**);
|
|
|
|
/* cachetable object state wrt external memory */
|
|
#define CACHETABLE_CLEAN 0
|
|
#define CACHETABLE_DIRTY 1
|
|
|
|
int cachetable_unpin(CACHEFILE, CACHEKEY, int dirty, long size); /* Note whether it is dirty when we unpin it. */
|
|
int cachetable_remove (CACHEFILE, CACHEKEY, int /*write_me*/); /* Removing something already present is OK. */
|
|
int cachetable_assert_all_unpinned (CACHETABLE);
|
|
int cachefile_count_pinned (CACHEFILE, int /*printthem*/ );
|
|
|
|
/* Rename whatever is at oldkey to be newkey. Requires that the object be pinned. */
|
|
int cachetable_rename (CACHEFILE cachefile, CACHEKEY oldkey, CACHEKEY newkey);
|
|
|
|
//int cachetable_fsync_all (CACHETABLE); /* Flush everything to disk, but keep it in cache. */
|
|
int cachetable_close (CACHETABLE*); /* Flushes everything to disk, and destroys the cachetable. */
|
|
|
|
int cachefile_close (CACHEFILE*);
|
|
//int cachefile_flush (CACHEFILE); /* Flush everything related to the VOID* to disk and free all memory. Don't destroy the cachetable. */
|
|
|
|
// Return on success (different from pread and pwrite)
|
|
//int cachefile_pwrite (CACHEFILE, const void *buf, size_t count, off_t offset);
|
|
//int cachefile_pread (CACHEFILE, void *buf, size_t count, off_t offset);
|
|
|
|
int cachefile_fd (CACHEFILE);
|
|
|
|
// Useful for debugging
|
|
void cachetable_print_state (CACHETABLE ct);
|
|
void cachetable_get_state(CACHETABLE ct, int *num_entries_ptr, int *hash_size_ptr, long *size_current_ptr, long *size_limit_ptr);
|
|
int cachetable_get_key_state(CACHETABLE ct, CACHEKEY key, void **value_ptr,
|
|
int *dirty_ptr, long long *pin_ptr, long *size_ptr);
|
|
|
|
void cachefile_verify (CACHEFILE cf); // Verify the whole cachetable that the CF is in. Slow.
|
|
void cachetable_verify (CACHETABLE t); // Slow...
|
|
|
|
TOKULOGGER cachefile_logger (CACHEFILE);
|
|
FILENUM cachefile_filenum (CACHEFILE);
|
|
|
|
#endif
|