bes  Updated for version 3.17.4
BESUncompressCache Class Reference
Inheritance diagram for BESUncompressCache:
Inheritance graph

Public Member Functions

virtual bool cache_too_big (unsigned long long current_size) const
 look at the cache size; is it too large? Look at the cache size and see if it is too big. More...
 
virtual bool create_and_lock (const string &target, int &fd)
 Create a file in the cache and lock it for write access. If the file does not exist, make it, open it for read-write access and get an exclusive lock on it. The locking operation blocks, although that should never happen. More...
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void exclusive_to_shared_lock (int fd)
 Transfer from an exclusive lock to a shared lock. If the file has an exclusive write lock on it, change that to a shared read lock. This is an atomic operation. If the call to fcntl(2) is protected by locking the cache, a dead lock will result given typical use of this class. This method exists to help with the situation where one process has the cache locked and is blocking on a shared read lock for a file that a second process has locked exclusively (for writing). By changing the exclusive lock to a shared lock, the first process can get its shared lock and then release the cache. More...
 
virtual string get_cache_file_name (const string &src, bool mangle=true)
 Build the name of file that will holds the uncompressed data from 'src' in the cache. More...
 
virtual unsigned long long get_cache_size ()
 Get the cache size. Read the size information from the cache info file and return it. This methods locks the cache. More...
 
virtual bool get_read_lock (const string &target, int &fd)
 Get a read-only lock on the file if it exists. More...
 
const string getCacheDirectory ()
 
const string getCacheFilePrefix ()
 
virtual bool getExclusiveLock (string file_name, int &ref_fd)
 
virtual void lock_cache_read ()
 
virtual void lock_cache_write ()
 
virtual void purge_file (const string &file)
 Purge a single file from the cache. More...
 
virtual void unlock_and_close (const string &target)
 
virtual void unlock_cache ()
 
virtual void update_and_purge (const string &new_file)
 Purge files from the cache. More...
 
virtual unsigned long long update_cache_info (const string &target)
 Update the cache info file to include 'target'. More...
 

Static Public Member Functions

static bool dir_exists (const string &dir)
 
static BESUncompressCacheget_instance (const string &bes_catalog_root_dir, const string &cache_dir, const string &prefix, unsigned long long size)
 
static BESUncompressCacheget_instance ()
 

Static Public Attributes

static const string DIR_KEY = "BES.UncompressCache.dir"
 
static const string PREFIX_KEY = "BES.UncompressCache.prefix"
 
static const string SIZE_KEY = "BES.UncompressCache.size"
 

Protected Member Functions

 BESUncompressCache (const string &data_root_dir, const string &cache_dir, const string &prefix, unsigned long long size)
 
void initialize (const string &cache_dir, const string &prefix, unsigned long long size)
 

Protected Attributes

string d_cache_dir
 
unsigned long long d_max_cache_size_in_bytes
 How many bytes can the cache hold before we have to purge.
 
string d_prefix
 
unsigned long long d_target_size
 

Detailed Description

Definition at line 26 of file BESUncompressCache.h.

Member Function Documentation

◆ cache_too_big()

bool BESFileLockingCache::cache_too_big ( unsigned long long  current_size) const
virtualinherited
Returns
True if the size is too big, false otherwise.

Definition at line 742 of file BESFileLockingCache.cc.

References BESFileLockingCache::d_max_cache_size_in_bytes.

◆ create_and_lock()

bool BESFileLockingCache::create_and_lock ( const string &  target,
int &  fd 
)
virtualinherited
Parameters
targetThe name of the file to make/open/lock
fdValue-result param that holds the file descriptor of the opened file
Returns
True if the operation was successful, false otherwise. This method will return false if the file already existed (the file won't be locked and the descriptor reference is undefined - but likely -1).
Exceptions
BESBESInternalErrororif any error except EEXIST is returned by open(2) or if fcntl(2) returns an error.

Definition at line 563 of file BESFileLockingCache.cc.

References BESFileLockingCache::lock_cache_write(), and BESFileLockingCache::unlock_cache().

◆ dir_exists()

bool BESFileLockingCache::dir_exists ( const string &  dir)
staticinherited

Does the directory exist?

Parameters
dirThe pathname to test.
Returns
True if the directory exists, false otherwise

Definition at line 980 of file BESFileLockingCache.cc.

◆ dump()

void BESFileLockingCache::dump ( ostream &  strm) const
virtualinherited

Displays the pointer value of this instance along with information about this cache.

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Definition at line 994 of file BESFileLockingCache.cc.

References BESFileLockingCache::d_max_cache_size_in_bytes.

◆ exclusive_to_shared_lock()

void BESFileLockingCache::exclusive_to_shared_lock ( int  fd)
virtualinherited
Parameters
fdThe file descriptor that is exclusively locked and which, on exit, will have a shared lock.

Definition at line 592 of file BESFileLockingCache.cc.

◆ get_cache_file_name()

string BESUncompressCache::get_cache_file_name ( const string &  src,
bool  mangle = true 
)
virtual

Overrides the generic file name generator in BESFileLocking cache. Because this is the uncompress cache, we know that our job is to simply decompress the file and hand it off to the appropriate response handler for the associated file type. Since the state of file's "compressedness" is determined in ALL cases by suffix on the file name (or resource ID if you wish) we know that in addition to building the generic name we want to remove the compression suffix so that the resulting name/id (unmangled if previously mangled) will correctly match the BES TypeMatch regex system.

Note
How names are mangled: 'src' is the full name of the file to be cached.The file name passed has an extension on the end that will be stripped once the file is cached. For example, if the full path to the file name is /usr/lib/data/fnoc1.nc.gz then the resulting file name will be #<prefix>#usr#lib#data#fnoc1.nc.
Parameters
srcThe source name to cache
mangleif True, assume the name is a file pathname and mangle it. If false, do not mangle the name (assume the caller has sent a suitable string) but do turn the string into a pathname located in the cache directory with the cache prefix. the 'mangle' param is true by default.

Reimplemented from BESFileLockingCache.

Definition at line 118 of file BESUncompressCache.cc.

References BESFileLockingCache::dir_exists(), BESFileLockingCache::get_cache_file_name(), get_instance(), and BESError::get_message().

◆ get_cache_size()

unsigned long long BESFileLockingCache::get_cache_size ( )
virtualinherited
Returns
The size of the cache.

Definition at line 754 of file BESFileLockingCache.cc.

References BESFileLockingCache::lock_cache_read(), and BESFileLockingCache::unlock_cache().

◆ get_instance()

BESUncompressCache * BESUncompressCache::get_instance ( )
static

Get the default instance of the GatewayCache object. This will read "TheBESKeys" looking for the values of SUBDIR_KEY, PREFIX_KEY, an SIZE_KEY to initialize the cache.

Definition at line 192 of file BESUncompressCache.cc.

References BESUtil::assemblePath(), and BESError::get_message().

◆ get_read_lock()

bool BESFileLockingCache::get_read_lock ( const string &  target,
int &  fd 
)
virtualinherited

Try to get a read-only lock on the file, blocking until we can get it. If the file does not exist, return false.

Note
If this code returns false, that means the file did not exist in the cache at the time of the test. by the time the caller gets the result, the file may have been added to the cache by another process.
Parameters
srcsrc file that will be cached eventually
targeta value-result parameter set to the resulting cached file
Returns
true if the file is in the cache and has been locked, false if the file is/was not in the cache.
Exceptions
Errorif the attempt to get the (shared) lock failed for any reason other than that the file does/did not exist.

Definition at line 535 of file BESFileLockingCache.cc.

References BESFileLockingCache::lock_cache_read(), and BESFileLockingCache::unlock_cache().

◆ getExclusiveLock()

bool BESFileLockingCache::getExclusiveLock ( string  file_name,
int &  ref_fd 
)
virtualinherited

Get an exclusive read/write lock on an existing file.

Parameters
file_nameThe name of the file.
ref_fpif successful, the file descriptor of the file on which we have an exclusive read/write lock.
Returns
If the file does not exist, return immediately indicating failure (false), otherwise block until an exclusive read/write lock can be obtained and then return true.
Exceptions
Erroris thrown to indicate a number of untoward events.

Definition at line 253 of file BESFileLockingCache.cc.

References BESUtil::assemblePath(), BESFileLockingCache::d_max_cache_size_in_bytes, and BESFileLockingCache::unlock_cache().

◆ lock_cache_read()

void BESFileLockingCache::lock_cache_read ( )
virtualinherited

Get a shared lock on the 'cache info' file.

Definition at line 631 of file BESFileLockingCache.cc.

◆ lock_cache_write()

void BESFileLockingCache::lock_cache_write ( )
virtualinherited

Get an exclusive lock on the 'cache info' file. The 'cache info' file is used to control certain cache actions, ensuring that they are atomic. These include making sure that the create_and_lock() and read_and_lock() operations are atomic as well as the purge and related operations.

Note
This is intended to be used internally only but might be useful in some settings.

Definition at line 616 of file BESFileLockingCache.cc.

◆ purge_file()

void BESFileLockingCache::purge_file ( const string &  file)
virtualinherited

Purge a single file from the cache. The file might be old, etc., and need to be removed. Don't use this to shrink the cache when it gets too big, use update_and_purge() instead since that file optimizes accesses to the cache control file for several changes in a row.

Todo:
This is a new feature; add to BESCache3
Parameters
fileThe name of the file to purge.

Definition at line 922 of file BESFileLockingCache.cc.

References BESFileLockingCache::get_cache_size(), BESFileLockingCache::getExclusiveLock(), BESFileLockingCache::lock_cache_write(), and BESFileLockingCache::unlock_cache().

◆ unlock_and_close()

void BESFileLockingCache::unlock_and_close ( const string &  file_name)
virtualinherited

Unlock the named file.

This does not do any name mangling; it just closes and unlocks whatever is named (or throws BESBESInternalErroror if the file cannot be closed). If the file was opened more than once, all descriptors are closed. If you need to close a specific descriptor, use the other version of unlock_and_close().

Note
This method assumes that the file was opened/locked using one of read_and_lock() or create_and_lock(). Those methods record the name/file- descriptor pairs so that the files can be properly closed and locks released.
Parameters
file_nameThe name of the file to unlock.
Exceptions
BESBESInternalErroror

Definition at line 675 of file BESFileLockingCache.cc.

◆ unlock_cache()

void BESFileLockingCache::unlock_cache ( )
virtualinherited

Unlock the cache info file.

Note
This is intended to be used internally only bt might be useful in some settings.

Definition at line 648 of file BESFileLockingCache.cc.

◆ update_and_purge()

void BESFileLockingCache::update_and_purge ( const string &  new_file)
virtualinherited

Purge files, oldest to newest, if the current size of the cache exceeds the size of the cache specified in the constructor. This method uses an exclusive lock on the cache for the duration of the purge process.

Parameters
new_fileThe name of a file this process just added to the cache. Using fcntl(2) locking there is no way this process can detect its own lock, so the shared read lock on the new file won't keep this process from deleting it (but will keep other processes from deleting it).

Definition at line 835 of file BESFileLockingCache.cc.

References BESFileLockingCache::cache_too_big(), BESFileLockingCache::lock_cache_write(), and BESFileLockingCache::unlock_cache().

◆ update_cache_info()

unsigned long long BESFileLockingCache::update_cache_info ( const string &  target)
virtualinherited

Add the size of the named file to the total cache size recorded in the cache info file. The cache info file is exclusively locked by this method for its duration. This updates the cache info file and returns the new size.

Parameters
targetThe name of the file
Returns
The new size of the cache

Definition at line 699 of file BESFileLockingCache.cc.

References BESFileLockingCache::lock_cache_write(), and BESFileLockingCache::unlock_cache().


The documentation for this class was generated from the following files: