com.orientechnologies.orient.core.storage.cache.local

Class OWOWCache

java.lang.Object

com.orientechnologies.orient.core.storage.cache.OAbstractWriteCache

com.orientechnologies.orient.core.storage.cache.local.OWOWCache

All Implemented Interfaces:

OCachePointer.WritersListener, OWriteCache

public class OWOWCache
extends OAbstractWriteCache
implements OWriteCache, OCachePointer.WritersListener

Since:

7/23/13

Author:

Andrey Lomakin

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAGIC_NUMBER_WITH_CHECKSUM Marks pages which have a checksum stored.
static long	MAGIC_NUMBER_WITHOUT_CHECKSUM Marks pages which have no checksum stored.
static int	MIN_CACHE_SIZE
static String	NAME_ID_MAP_EXTENSION

Constructor Summary

Constructors

Constructor and Description
OWOWCache(boolean syncOnPageFlush, int pageSize, OByteBufferPool bufferPool, long groupTTL, OWriteAheadLog writeAheadLog, long pageFlushInterval, long writeCacheMaxSize, long cacheMaxSize, OLocalPaginatedStorage storageLocal, boolean checkMinSize, OClosableLinkedContainer<Long,OFileClassic> files, int id, OChecksumMode checksumMode)

Method Summary

Modifier and Type	Method and Description
void	addBackgroundExceptionListener(OBackgroundExceptionListener listener) Adds listener which is triggered if exception is cast inside background flush data thread.
long	addFile(String fileName)
long	addFile(String fileName, long fileId)
void	addLowDiskSpaceListener(OLowDiskSpaceListener listener)
void	addOnlyWriters(long fileId, long pageIndex)
void	addPageIsBrokenListener(OPageIsBrokenListener listener) Adds listener which is called by cache if corruption of file page is detected.
long	bookFileId(String fileName)
boolean	checkLowDiskSpace()
OPageDataVerificationError[]	checkStoredPages(OCommandOutputListener commandOutputListener)
long[]	close()
void	close(long fileId, boolean flush)
long[]	delete()
void	deleteFile(long fileId)
boolean	exists(long fileId)
boolean	exists(String fileName)
long	externalFileId(int fileId) Converts unique internal file id to external one.
long	fileIdByName(String fileName) Returns id associated with given file or value < 0 if such file does not exist.
boolean	fileIdsAreEqual(long firsId, long secondId)
String	fileNameById(long fileId)
Map<String,Long>	files()
void	flush()
void	flush(long fileId)
long	getCacheOverflowCount()
long	getExclusiveWriteCachePagesSize()
long	getExclusiveWriteCacheSize()
long	getFilledUpTo(long fileId)
int	getId()
OPerformanceStatisticManager	getPerformanceStatisticManager()
File	getRootDirectory() Directory which contains all files managed by write cache.
long	getWriteCacheSize()
int	internalFileId(long fileId) Returns internal file id which is unique and always the same for given file in contrary to external id which changes over close/open cycle of cache.
OCachePointer[]	load(long fileId, long startPageIndex, int pageCount, boolean addNewPages, OModifiableBoolean cacheHit, boolean verifyChecksums)
long	loadFile(String fileName) Registers new file in write cache and returns file id assigned to this file.
void	loadRegisteredFiles() Loads files already registered in storage.
void	makeFuzzyCheckpoint()
int	pageSize()
void	removeBackgroundExceptionListener(OBackgroundExceptionListener listener) Removes listener which is triggered if exception is cast inside background flush data thread.
void	removeLowDiskSpaceListener(OLowDiskSpaceListener listener)
void	removeOnlyWriters(long fileId, long pageIndex)
void	removePageIsBrokenListener(OPageIsBrokenListener listener) Removes listener which is called by cache if corruption of file page is detected.
void	renameFile(long fileId, String oldFileName, String newFileName)
String	restoreFileById(long fileId) Finds if there was file in write cache with given id which is deleted right now.
void	setChecksumMode(OChecksumMode checksumMode)
void	startFuzzyCheckpoints()
Future	store(long fileId, long pageIndex, OCachePointer dataPointer)
void	truncateFile(long fileId)
boolean	verifyPage(long fileId, long pageIndex)

Methods inherited from class com.orientechnologies.orient.core.storage.cache.OAbstractWriteCache

checkFileIdCompatibility, composeFileId, extractFileId, extractStorageId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_ID_MAP_EXTENSION

public static final String NAME_ID_MAP_EXTENSION

See Also:

Constant Field Values

MIN_CACHE_SIZE

public static final int MIN_CACHE_SIZE

See Also:

Constant Field Values

MAGIC_NUMBER_WITH_CHECKSUM

public static final long MAGIC_NUMBER_WITH_CHECKSUM

Marks pages which have a checksum stored.

See Also:

Constant Field Values

MAGIC_NUMBER_WITHOUT_CHECKSUM

public static final long MAGIC_NUMBER_WITHOUT_CHECKSUM

Marks pages which have no checksum stored.

See Also:

Constant Field Values

Constructor Detail

OWOWCache

public OWOWCache(boolean syncOnPageFlush,
                 int pageSize,
                 OByteBufferPool bufferPool,
                 long groupTTL,
                 OWriteAheadLog writeAheadLog,
                 long pageFlushInterval,
                 long writeCacheMaxSize,
                 long cacheMaxSize,
                 OLocalPaginatedStorage storageLocal,
                 boolean checkMinSize,
                 OClosableLinkedContainer<Long,OFileClassic> files,
                 int id,
                 OChecksumMode checksumMode)

Method Detail

loadRegisteredFiles

public void loadRegisteredFiles()
                         throws IOException

Loads files already registered in storage. Has to be called before usage of this cache

Throws:

IOException

addBackgroundExceptionListener

public void addBackgroundExceptionListener(OBackgroundExceptionListener listener)

Adds listener which is triggered if exception is cast inside background flush data thread.

Specified by:

addBackgroundExceptionListener in interface OWriteCache

Parameters:

listener - Listener to trigger

removeBackgroundExceptionListener

public void removeBackgroundExceptionListener(OBackgroundExceptionListener listener)

Removes listener which is triggered if exception is cast inside background flush data thread.

Specified by:

removeBackgroundExceptionListener in interface OWriteCache

Parameters:

listener - Listener to remove

getRootDirectory

public File getRootDirectory()

Directory which contains all files managed by write cache.

Specified by:

getRootDirectory in interface OWriteCache

Returns:

Directory which contains all files managed by write cache or null in case of in memory database.

getPerformanceStatisticManager

public OPerformanceStatisticManager getPerformanceStatisticManager()

Specified by:

getPerformanceStatisticManager in interface OWriteCache

startFuzzyCheckpoints

public void startFuzzyCheckpoints()

Specified by:

startFuzzyCheckpoints in interface OWriteCache

addLowDiskSpaceListener

public void addLowDiskSpaceListener(OLowDiskSpaceListener listener)

Specified by:

addLowDiskSpaceListener in interface OWriteCache

removeLowDiskSpaceListener

public void removeLowDiskSpaceListener(OLowDiskSpaceListener listener)

Specified by:

removeLowDiskSpaceListener in interface OWriteCache

addPageIsBrokenListener

public void addPageIsBrokenListener(OPageIsBrokenListener listener)

Description copied from interface: OWriteCache

Adds listener which is called by cache if corruption of file page is detected.

Specified by:

addPageIsBrokenListener in interface OWriteCache

removePageIsBrokenListener

public void removePageIsBrokenListener(OPageIsBrokenListener listener)

Description copied from interface: OWriteCache

Removes listener which is called by cache if corruption of file page is detected.

Specified by:

removePageIsBrokenListener in interface OWriteCache

bookFileId

public long bookFileId(String fileName)
                throws IOException

Specified by:

bookFileId in interface OWriteCache

Throws:

IOException

pageSize

public int pageSize()

Specified by:

pageSize in interface OWriteCache

fileIdsAreEqual

public boolean fileIdsAreEqual(long firsId,
                               long secondId)

Specified by:

fileIdsAreEqual in interface OWriteCache

loadFile

public long loadFile(String fileName)
              throws IOException

Description copied from interface: OWriteCache

Registers new file in write cache and returns file id assigned to this file. File id consist of two parts:

1. Internal id is permanent and can not be changed during life of storage OWriteCache.internalFileId(long)
2. Write cache id which is changed between storage open/close cycles

If file with the same name is deleted and then new file is created this file with have the same internal id.

Specified by:

loadFile in interface OWriteCache

Parameters:

fileName - Name of file to register inside storage.

Returns:

Id of registered file

Throws:

IOException

addFile

public long addFile(String fileName)
             throws IOException

Specified by:

addFile in interface OWriteCache

Throws:

IOException

fileIdByName

public long fileIdByName(String fileName)

Description copied from interface: OWriteCache

Returns id associated with given file or value < 0 if such file does not exist.

Specified by:

fileIdByName in interface OWriteCache

Parameters:

fileName - File name id of which has to be returned.

Returns:

id associated with given file or value < 0 if such file does not exist.

internalFileId

public int internalFileId(long fileId)

Description copied from interface: OWriteCache

Returns internal file id which is unique and always the same for given file in contrary to external id which changes over close/open cycle of cache.

Specified by:

internalFileId in interface OWriteCache

Parameters:

fileId - External file id.

Returns:

Internal file id.

externalFileId

public long externalFileId(int fileId)

Description copied from interface: OWriteCache

Converts unique internal file id to external one. External id is combination of internal id and write cache id, which changes every time when cache is closed and opened again.

Specified by:

externalFileId in interface OWriteCache

Parameters:

fileId - Internal file id.

Returns:

External file id.

See Also:

OWriteCache.internalFileId(long), OWriteCache.getId()

addFile

public long addFile(String fileName,
                    long fileId)
             throws IOException

Specified by:

addFile in interface OWriteCache

Throws:

IOException

checkLowDiskSpace

public boolean checkLowDiskSpace()

Specified by:

checkLowDiskSpace in interface OWriteCache

makeFuzzyCheckpoint

public void makeFuzzyCheckpoint()

Specified by:

makeFuzzyCheckpoint in interface OWriteCache

exists

public boolean exists(String fileName)

Specified by:

exists in interface OWriteCache

exists

public boolean exists(long fileId)

Specified by:

exists in interface OWriteCache

store

public Future store(long fileId,
                    long pageIndex,
                    OCachePointer dataPointer)

Specified by:

store in interface OWriteCache

files

public Map<String,Long> files()

Specified by:

files in interface OWriteCache

load

public OCachePointer[] load(long fileId,
                            long startPageIndex,
                            int pageCount,
                            boolean addNewPages,
                            OModifiableBoolean cacheHit,
                            boolean verifyChecksums)
                     throws IOException

Specified by:

load in interface OWriteCache

Throws:

IOException

verifyPage

public boolean verifyPage(long fileId,
                          long pageIndex)
                   throws IOException

Specified by:

verifyPage in interface OWriteCache

Throws:

IOException

addOnlyWriters

public void addOnlyWriters(long fileId,
                           long pageIndex)

Specified by:

addOnlyWriters in interface OCachePointer.WritersListener

removeOnlyWriters

public void removeOnlyWriters(long fileId,
                              long pageIndex)

Specified by:

removeOnlyWriters in interface OCachePointer.WritersListener

flush

public void flush(long fileId)

Specified by:

flush in interface OWriteCache

flush

public void flush()

Specified by:

flush in interface OWriteCache

getFilledUpTo

public long getFilledUpTo(long fileId)
                   throws IOException

Specified by:

getFilledUpTo in interface OWriteCache

Throws:

IOException

getExclusiveWriteCachePagesSize

public long getExclusiveWriteCachePagesSize()

Specified by:

getExclusiveWriteCachePagesSize in interface OWriteCache

deleteFile

public void deleteFile(long fileId)
                throws IOException

Specified by:

deleteFile in interface OWriteCache

Throws:

IOException

truncateFile

public void truncateFile(long fileId)
                  throws IOException

Specified by:

truncateFile in interface OWriteCache

Throws:

IOException

renameFile

public void renameFile(long fileId,
                       String oldFileName,
                       String newFileName)
                throws IOException

Specified by:

renameFile in interface OWriteCache

Throws:

IOException

close

public long[] close()
             throws IOException

Specified by:

close in interface OWriteCache

Throws:

IOException

close

public void close(long fileId,
                  boolean flush)
           throws IOException

Specified by:

close in interface OWriteCache

Throws:

IOException

restoreFileById

public String restoreFileById(long fileId)
                       throws IOException

Description copied from interface: OWriteCache

Finds if there was file in write cache with given id which is deleted right now. If such file exists it creates new file with the same name at it was in deleted file.

Specified by:

restoreFileById in interface OWriteCache

Parameters:

fileId - If of file which should be restored

Returns:

Name of restored file or null if such name does not exist

Throws:

IOException

checkStoredPages

public OPageDataVerificationError[] checkStoredPages(OCommandOutputListener commandOutputListener)

Specified by:

checkStoredPages in interface OWriteCache

delete

public long[] delete()
              throws IOException

Specified by:

delete in interface OWriteCache

Throws:

IOException

fileNameById

public String fileNameById(long fileId)

Specified by:

fileNameById in interface OWriteCache

getId

public int getId()

Specified by:

getId in interface OWriteCache

getCacheOverflowCount

public long getCacheOverflowCount()

getWriteCacheSize

public long getWriteCacheSize()

getExclusiveWriteCacheSize

public long getExclusiveWriteCacheSize()

setChecksumMode

public void setChecksumMode(OChecksumMode checksumMode)