A brief file description. More...

#include "libts.h"

Include dependency graph for P_CacheInternal.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	CacheVC
struct	CacheRemoveCont
struct	Cache
Defines
#define	ALTERNATES 1
#define	MAX_CACHE_VCS_PER_THREAD 500
#define	INTEGRAL_FRAGS 4
#define	DDebug if (0) dummy_debug
#define	AIO_SOFT_FAILURE -100000
#define	WRITER_RETRY_DELAY HRTIME_MSECONDS(50)
#define	CACHE_TRY_LOCK(_l, _m, _t) MUTEX_TRY_LOCK(_l, _m, _t)
#define	VC_LOCK_RETRY_EVENT()
#define	VC_SCHED_LOCK_RETRY()
#define	CONT_SCHED_LOCK_RETRY_RET(_c)
#define	CONT_SCHED_LOCK_RETRY(_c) _c->mutex->thread_holding->schedule_in_local(_c, HRTIME_MSECONDS(cache_config_mutex_retry_delay))
#define	VC_SCHED_WRITER_RETRY()
#define	GLOBAL_CACHE_SET_DYN_STAT(x, y) RecSetGlobalRawStatSum(cache_rsb, (x), (y))
#define	CACHE_SET_DYN_STAT(x, y)
#define	CACHE_INCREMENT_DYN_STAT(x)
#define	CACHE_DECREMENT_DYN_STAT(x)
#define	CACHE_VOL_SUM_DYN_STAT(x, y) RecIncrRawStat(vol->cache_vol->vol_rsb, mutex->thread_holding, (int) (x), (int64_t) y);
#define	CACHE_SUM_DYN_STAT(x, y)
#define	CACHE_SUM_DYN_STAT_THREAD(x, y)
#define	GLOBAL_CACHE_SUM_GLOBAL_DYN_STAT(x, y) RecIncrGlobalRawStatSum(cache_rsb,(x),(y))
#define	CACHE_SUM_GLOBAL_DYN_STAT(x, y)
#define	CACHE_CLEAR_DYN_STAT(x)
#define	CACHE_STAT_ACTIVE 0
#define	CACHE_STAT_SUCCESS 1
#define	CACHE_STAT_FAILURE 2
#define	PUSH_HANDLER(_x)
#define	POP_HANDLER
#define	CACHE_DEBUG_INCREMENT_DYN_STAT(_x)
#define	CACHE_DEBUG_SUM_DYN_STAT(_x, _y)
Enumerations
enum	{ cache_bytes_used_stat, cache_bytes_total_stat, cache_ram_cache_bytes_stat, cache_ram_cache_bytes_total_stat, cache_direntries_total_stat, cache_direntries_used_stat, cache_ram_cache_hits_stat, cache_ram_cache_misses_stat, cache_pread_count_stat, cache_percent_full_stat, cache_lookup_active_stat, cache_lookup_success_stat, cache_lookup_failure_stat, cache_read_active_stat, cache_read_success_stat, cache_read_failure_stat, cache_write_active_stat, cache_write_success_stat, cache_write_failure_stat, cache_write_backlog_failure_stat, cache_update_active_stat, cache_update_success_stat, cache_update_failure_stat, cache_remove_active_stat, cache_remove_success_stat, cache_remove_failure_stat, cache_evacuate_active_stat, cache_evacuate_success_stat, cache_evacuate_failure_stat, cache_scan_active_stat, cache_scan_success_stat, cache_scan_failure_stat, cache_directory_collision_count_stat, cache_single_fragment_document_count_stat, cache_two_fragment_document_count_stat, cache_three_plus_plus_fragment_document_count_stat, cache_read_busy_success_stat, cache_read_busy_failure_stat, cache_gc_bytes_evacuated_stat, cache_gc_frags_evacuated_stat, cache_write_bytes_stat, cache_hdr_vector_marshal_stat, cache_hdr_marshal_stat, cache_hdr_marshal_bytes_stat, cache_stat_count }
Functions
CacheVC *	new_DocEvacuator (int nbytes, Vol *d)
TS_INLINE CacheVC *	new_CacheVC (Continuation *cont)
TS_INLINE int	free_CacheVC (CacheVC *cont)
TS_INLINE int	dir_delete_lock (CacheKey key, Vol d, ProxyMutex m, Dir del)
TS_INLINE int	dir_insert_lock (CacheKey key, Vol d, Dir to_part, ProxyMutex m)
TS_INLINE int	dir_overwrite_lock (CacheKey key, Vol d, Dir to_part, ProxyMutex m, Dir *overwrite, bool must_overwrite=true)
void TS_INLINE	rand_CacheKey (CacheKey next_key, ProxyMutex mutex)
void TS_INLINE	next_CacheKey (CacheKey next_key, CacheKey key)
void TS_INLINE	prev_CacheKey (CacheKey prev_key, CacheKey key)
TS_INLINE unsigned int	next_rand (unsigned int *p)
TS_INLINE CacheRemoveCont *	new_CacheRemoveCont ()
TS_INLINE void	free_CacheRemoveCont (CacheRemoveCont *cache_rm)
int64_t	cache_bytes_used (void)
int64_t	cache_bytes_total (void)
TS_INLINE unsigned int	cache_hash (INK_MD5 &md5)
TS_INLINE Cache *	local_cache ()
Variables
RecRawStatBlock *	cache_rsb
int	cache_config_dir_sync_frequency
int	cache_config_http_max_alts
int	cache_config_permit_pinning
int	cache_config_select_alternate
int	cache_config_vary_on_user_agent
int	cache_config_max_doc_size
int	cache_config_min_average_object_size
int	cache_config_agg_write_backlog
int	cache_config_enable_checksum
int	cache_config_alt_rewrite_max_size
int	cache_config_read_while_writer
int	cache_clustering_enabled
int	cache_config_ram_cache_compress
int	cache_config_ram_cache_compress_percent
int	cache_config_ram_cache_use_seen_filter
int	cache_config_hit_evacuate_percent
int	cache_config_hit_evacuate_size_limit
int	cache_config_force_sector_size
int	cache_config_target_fragment_size
int	cache_config_mutex_retry_delay
ClassAllocator< CacheVC >	cacheVConnectionAllocator
CacheKey	zero_key
CacheSync *	cacheDirSync
uint8_t	CacheKey_next_table []
uint8_t	CacheKey_prev_table []
ClassAllocator< CacheRemoveCont >	cacheRemoveContAllocator
Cache *	theCache
Cache *	theStreamCache
inkcoreapi Cache *	caches [NUM_CACHE_FRAG_TYPES]

Detailed Description

A brief file description.

License

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file P_CacheInternal.h.

Define Documentation

#define AIO_SOFT_FAILURE -100000

Definition at line 59 of file P_CacheInternal.h.

#define ALTERNATES 1

Definition at line 39 of file P_CacheInternal.h.

#define CACHE_CLEAR_DYN_STAT ( x )

Value:

do { \
        RecSetRawStatSum(cache_rsb, (x), 0); \
        RecSetRawStatCount(cache_rsb, (x), 0); \
        RecSetRawStatSum(vol->cache_vol->vol_rsb, (x), 0); \
        RecSetRawStatCount(vol->cache_vol->vol_rsb, (x), 0); \
} while (0);

Definition at line 202 of file P_CacheInternal.h.

#define CACHE_DEBUG_INCREMENT_DYN_STAT ( _x )

Definition at line 1005 of file P_CacheInternal.h.

Referenced by agg_copy(), and CacheVC::handleRead().

#define CACHE_DEBUG_SUM_DYN_STAT	(	_x,
		_y
	)

Definition at line 1006 of file P_CacheInternal.h.

Referenced by agg_copy().

#define CACHE_DECREMENT_DYN_STAT ( x )

Value:

RecIncrRawStat(cache_rsb, mutex->thread_holding, (int) (x), -1); \
        RecIncrRawStat(vol->cache_vol->vol_rsb, mutex->thread_holding, (int) (x), -1);

Definition at line 180 of file P_CacheInternal.h.

Referenced by free_CacheVC().

#define CACHE_INCREMENT_DYN_STAT ( x )

Value:

RecIncrRawStat(cache_rsb, mutex->thread_holding, (int) (x), 1); \
        RecIncrRawStat(vol->cache_vol->vol_rsb, mutex->thread_holding, (int) (x), 1);

Definition at line 176 of file P_CacheInternal.h.

Referenced by free_CacheVC(), CacheVC::handleWrite(), Cache::lookup(), new_DocEvacuator(), Cache::open_read(), Vol::open_write(), Cache::open_write(), CacheVC::openReadFromWriter(), CacheVC::openReadFromWriterFailure(), CacheVC::openReadStartEarliest(), CacheVC::openReadStartHead(), CacheVC::openWriteCloseDir(), CacheVC::openWriteStartBegin(), Cache::remove(), and CacheVC::removeEvent().

#define CACHE_SET_DYN_STAT	(	x,
		y
	)

Value:

RecSetGlobalRawStatSum(cache_rsb, (x), (y)) \
        RecSetGlobalRawStatSum(vol->cache_vol->vol_rsb, (x), (y))

Definition at line 172 of file P_CacheInternal.h.

#define CACHE_STAT_ACTIVE 0

Definition at line 376 of file P_CacheInternal.h.

Referenced by free_CacheVC(), Cache::lookup(), new_DocEvacuator(), Cache::open_read(), Cache::open_write(), and Cache::remove().

#define CACHE_STAT_FAILURE 2

Definition at line 378 of file P_CacheInternal.h.

Referenced by CacheVC::handleWrite(), Cache::open_write(), and CacheVC::openWriteStartBegin().

#define CACHE_STAT_SUCCESS 1

Definition at line 377 of file P_CacheInternal.h.

Referenced by free_CacheVC().

#define CACHE_SUM_DYN_STAT	(	x,
		y
	)

Value:

RecIncrRawStat(cache_rsb, mutex->thread_holding, (int) (x), (int64_t) (y)); \
        RecIncrRawStat(vol->cache_vol->vol_rsb, mutex->thread_holding, (int) (x), (int64_t) (y));

Definition at line 187 of file P_CacheInternal.h.

#define CACHE_SUM_DYN_STAT_THREAD	(	x,
		y
	)

Value:

RecIncrRawStat(cache_rsb, this_ethread(), (int) (x), (int64_t) (y)); \
        RecIncrRawStat(vol->cache_vol->vol_rsb, this_ethread(), (int) (x), (int64_t) (y));

Definition at line 191 of file P_CacheInternal.h.

Referenced by RamCacheCLFUS::compress_entries(), RamCacheCLFUS::destroy(), RamCacheLRU::get(), RamCacheCLFUS::get(), RamCacheLRU::put(), RamCacheCLFUS::put(), RamCacheLRU::remove(), and RamCacheCLFUS::requeue_victims().

#define CACHE_SUM_GLOBAL_DYN_STAT	(	x,
		y
	)

Value:

RecIncrGlobalRawStatSum(cache_rsb,(x),(y)) \
        RecIncrGlobalRawStatSum(vol->cache_vol->vol_rsb,(x),(y))

Definition at line 198 of file P_CacheInternal.h.

#define CACHE_TRY_LOCK	(	_l,
		_m,
		_t
	)		MUTEX_TRY_LOCK(_l, _m, _t)

Definition at line 64 of file P_CacheInternal.h.

Referenced by Vol::aggWriteDone(), Vol::begin_read_lock(), Vol::close_read_lock(), Vol::close_write_lock(), CacheVC::derefRead(), dir_delete_lock(), dir_insert_lock(), dir_overwrite_lock(), CacheVC::handleWriteLock(), CacheSync::mainEvent(), Cache::open_read(), Vol::open_write_lock(), CacheVC::openReadClose(), CacheVC::openReadFromWriter(), CacheVC::openReadMain(), CacheVC::openReadReadDone(), CacheVC::openReadStartEarliest(), CacheVC::openReadStartHead(), CacheVC::openWriteCloseDataDone(), CacheVC::openWriteCloseDir(), CacheVC::openWriteCloseHeadDone(), CacheVC::openWriteOverwrite(), CacheVC::openWriteWriteDone(), Cache::remove(), CacheVC::scanObject(), CacheVC::scanOpenWrite(), CacheVC::scanUpdateDone(), ShowCacheInternal::showSegSegment(), ShowCacheInternal::showVolEvacuations(), ShowCacheInternal::showVolVolumes(), and OpenDir::signal_readers().

#define CACHE_VOL_SUM_DYN_STAT	(	x,
		y
	)		RecIncrRawStat(vol->cache_vol->vol_rsb, mutex->thread_holding, (int) (x), (int64_t) y);

Definition at line 184 of file P_CacheInternal.h.

Referenced by CacheProcessor::cacheInitialized().

#define CONT_SCHED_LOCK_RETRY ( _c ) _c->mutex->thread_holding->schedule_in_local(_c, HRTIME_MSECONDS(cache_config_mutex_retry_delay))

Definition at line 92 of file P_CacheInternal.h.

Referenced by Cache::open_read(), Cache::open_write(), register_ShowCache(), register_ShowCacheInternal(), ShowCacheInternal::showSegSegment(), and ShowCacheInternal::showVolEvacuations().

#define CONT_SCHED_LOCK_RETRY_RET ( _c )

Value:

do { \
    _c->mutex->thread_holding->schedule_in_local(_c, HRTIME_MSECONDS(cache_config_mutex_retry_delay)); \
    return EVENT_CONT; \
  } while (0)

Definition at line 86 of file P_CacheInternal.h.

Referenced by ShowCacheInternal::showEvacuations(), ShowCacheInternal::showSegments(), ShowCacheInternal::showSegSegment(), ShowCacheInternal::showVolEvacuations(), ShowCacheInternal::showVolumes(), and ShowCacheInternal::showVolVolumes().

#define DDebug if (0) dummy_debug

Definition at line 56 of file P_CacheInternal.h.

Referenced by Vol::aggWrite(), Vol::aggWriteDone(), RamCacheCLFUS::compress_entries(), RamCacheCLFUS::destroy(), dir_insert(), dir_lookaside_cleanup(), dir_lookaside_fixup(), dir_lookaside_insert(), dir_lookaside_probe(), dir_lookaside_remove(), dir_overwrite(), dir_probe(), CacheVC::do_io_close(), Vol::evac_range(), Vol::evacuate_cleanup_blocks(), evacuate_fragments(), CacheVC::evacuateDocDone(), Vol::evacuateDocReadDone(), CacheVC::evacuateReadHead(), Vol::force_evacuate_head(), RamCacheLRU::get(), RamCacheCLFUS::get(), RamCacheLRU::init(), RamCacheCLFUS::init(), CacheVC::openReadChooseWriter(), CacheVC::openReadFromWriter(), CacheVC::openReadFromWriterMain(), CacheVC::openReadMain(), CacheVC::openReadReadDone(), CacheVC::openReadStartEarliest(), CacheVC::openReadStartHead(), CacheVC::openWriteCloseDir(), CacheVC::openWriteWriteDone(), RamCacheLRU::put(), RamCacheCLFUS::put(), CacheVC::reenable(), CacheVC::reenable_re(), RamCacheLRU::remove(), RamCacheLRU::resize_hashtable(), RamCacheCLFUS::resize_hashtable(), Vol::scan_for_pinned_documents(), RamCacheCLFUS::tick(), and RamCacheCLFUS::victimize().

#define GLOBAL_CACHE_SET_DYN_STAT	(	x,
		y
	)		RecSetGlobalRawStatSum(cache_rsb, (x), (y))

Definition at line 169 of file P_CacheInternal.h.

Referenced by CacheProcessor::cacheInitialized().

#define GLOBAL_CACHE_SUM_GLOBAL_DYN_STAT	(	x,
		y
	)		RecIncrGlobalRawStatSum(cache_rsb,(x),(y))

Definition at line 195 of file P_CacheInternal.h.

#define INTEGRAL_FRAGS 4

Definition at line 45 of file P_CacheInternal.h.

#define MAX_CACHE_VCS_PER_THREAD 500

Definition at line 43 of file P_CacheInternal.h.

#define POP_HANDLER

Value:

do {                                          \
    handler = save_handler;                                       \
    ink_assert(handler != (ContinuationHandler)(&CacheVC::dead)); \
  } while (0)

Definition at line 519 of file P_CacheInternal.h.

#define PUSH_HANDLER ( _x )

Value:

do {                                           \
    ink_assert(handler != (ContinuationHandler)(&CacheVC::dead));       \
    save_handler = handler; handler = (ContinuationHandler)(_x);        \
} while (0)

Definition at line 514 of file P_CacheInternal.h.

Referenced by CacheVC::do_read_call(), CacheVC::do_write_call(), CacheVC::do_write_lock(), and CacheVC::do_write_lock_call().

#define VC_LOCK_RETRY_EVENT ( )

Value:

do { \
    trigger = mutex->thread_holding->schedule_in_local(this, HRTIME_MSECONDS(cache_config_mutex_retry_delay), event); \
    return EVENT_CONT; \
  } while (0)

Definition at line 74 of file P_CacheInternal.h.

Referenced by CacheVC::openWriteCloseDataDone(), CacheVC::openWriteCloseHeadDone(), CacheVC::openWriteOverwrite(), and CacheVC::openWriteWriteDone().

#define VC_SCHED_LOCK_RETRY ( )

Value:

do { \
    trigger = mutex->thread_holding->schedule_in_local(this, HRTIME_MSECONDS(cache_config_mutex_retry_delay)); \
    return EVENT_CONT; \
  } while (0)

Definition at line 80 of file P_CacheInternal.h.

Referenced by CacheVC::handleReadDone(), CacheVC::openReadClose(), CacheVC::openReadFromWriter(), CacheVC::openReadMain(), CacheVC::openReadReadDone(), CacheVC::openReadStartEarliest(), CacheVC::openReadStartHead(), CacheVC::openWriteCloseDir(), CacheVC::openWriteStartBegin(), CacheVC::removeEvent(), and CacheVC::scanOpenWrite().

#define VC_SCHED_WRITER_RETRY ( )

Value:

do { \
    ink_assert(!trigger); \
    writer_lock_retry++; \
    ink_hrtime _t = WRITER_RETRY_DELAY; \
    if (writer_lock_retry > 2) \
      _t = WRITER_RETRY_DELAY * 2; \
    else if (writer_lock_retry > 5) \
      _t = WRITER_RETRY_DELAY * 10; \
    else if (writer_lock_retry > 10) \
      _t = WRITER_RETRY_DELAY * 100; \
    trigger = mutex->thread_holding->schedule_in_local(this, _t); \
    return EVENT_CONT; \
  } while (0)

Definition at line 95 of file P_CacheInternal.h.

Referenced by CacheVC::openReadFromWriter(), CacheVC::openReadMain(), and CacheVC::openReadReadDone().

#define WRITER_RETRY_DELAY HRTIME_MSECONDS(50)

Definition at line 61 of file P_CacheInternal.h.

Enumeration Type Documentation

anonymous enum

Enumerator:

cache_bytes_used_stat
cache_bytes_total_stat
cache_ram_cache_bytes_stat
cache_ram_cache_bytes_total_stat
cache_direntries_total_stat
cache_direntries_used_stat
cache_ram_cache_hits_stat
cache_ram_cache_misses_stat
cache_pread_count_stat
cache_percent_full_stat
cache_lookup_active_stat
cache_lookup_success_stat
cache_lookup_failure_stat
cache_read_active_stat
cache_read_success_stat
cache_read_failure_stat
cache_write_active_stat
cache_write_success_stat
cache_write_failure_stat
cache_write_backlog_failure_stat
cache_update_active_stat
cache_update_success_stat
cache_update_failure_stat
cache_remove_active_stat
cache_remove_success_stat
cache_remove_failure_stat
cache_evacuate_active_stat
cache_evacuate_success_stat
cache_evacuate_failure_stat
cache_scan_active_stat
cache_scan_success_stat
cache_scan_failure_stat
cache_directory_collision_count_stat
cache_single_fragment_document_count_stat
cache_two_fragment_document_count_stat
cache_three_plus_plus_fragment_document_count_stat
cache_read_busy_success_stat
cache_read_busy_failure_stat
cache_gc_bytes_evacuated_stat
cache_gc_frags_evacuated_stat
cache_write_bytes_stat
cache_hdr_vector_marshal_stat
cache_hdr_marshal_stat
cache_hdr_marshal_bytes_stat
cache_stat_count