com.orientechnologies.orient.core.storage.impl.memory

Class ODirectMemoryOnlyDiskCache

java.lang.Object

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

com.orientechnologies.orient.core.storage.impl.memory.ODirectMemoryOnlyDiskCache

All Implemented Interfaces:

OReadCache, OWriteCache

public class ODirectMemoryOnlyDiskCache
extends OAbstractWriteCache
implements OReadCache, OWriteCache

Since:

6/24/14

Author:

Andrey Lomakin (a.lomakin-at-orientechnologies.com)

Constructor Summary

Constructors

Constructor and Description
ODirectMemoryOnlyDiskCache(int pageSize, int id, OPerformanceStatisticManager performanceStatisticManager)

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)
long	addFile(String fileName, long fileId, OWriteCache writeCache)
long	addFile(String fileName, OWriteCache writeCache)
void	addLowDiskSpaceListener(OLowDiskSpaceListener listener)
void	addPageIsBrokenListener(OPageIsBrokenListener listener) Not implemented because has no sense
OCacheEntry	allocateNewPage(long fileId, OWriteCache writeCache, boolean verifyChecksums)
long	bookFileId(String fileName)
boolean	checkLowDiskSpace()
OPageDataVerificationError[]	checkStoredPages(OCommandOutputListener commandOutputListener)
void	clear()
long[]	close()
void	close(long fileId, boolean flush)
void	closeFile(long fileId, boolean flush, OWriteCache writeCache)
void	closeStorage(OWriteCache writeCache) Closes all files inside of write cache and flushes all associated data.
long[]	delete()
void	deleteFile(long fileId)
void	deleteFile(long fileId, OWriteCache writeCache)
void	deleteStorage(OWriteCache writeCache)
boolean	exists(long fileId)
boolean	exists(String name)
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	getExclusiveWriteCachePagesSize()
long	getFilledUpTo(long fileId)
int	getId()
OPerformanceStatisticManager	getPerformanceStatisticManager()
File	getRootDirectory() Directory which contains all files managed by write cache.
long	getUsedMemory()
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.
OCacheEntry	load(long fileId, long pageIndex, boolean checkPinnedPages, OWriteCache writeCache, int pageCount, boolean verifyChecksums)
OCachePointer[]	load(long fileId, long startPageIndex, int pageCount, boolean addNewPages, OModifiableBoolean cacheHit, boolean verifyChecksums)
void	loadCacheState(OWriteCache writeCache) Load state of cache from file system if possible.
long	loadFile(long fileId, OWriteCache writeCache)
long	loadFile(String fileName) Registers new file in write cache and returns file id assigned to this file.
long	loadFile(String fileName, long fileId, OWriteCache writeCache)
long	loadFile(String fileName, OWriteCache writeCache)
void	makeFuzzyCheckpoint()
int	pageSize()
void	pinPage(OCacheEntry cacheEntry)
void	release(OCacheEntry cacheEntry, OWriteCache writeCache)
void	removeBackgroundExceptionListener(OBackgroundExceptionListener listener) Removes listener which is triggered if exception is cast inside background flush data thread.
void	removeLowDiskSpaceListener(OLowDiskSpaceListener listener)
void	removePageIsBrokenListener(OPageIsBrokenListener listener) Not implemented because has no sense
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	startFuzzyCheckpoints()
Future	store(long fileId, long pageIndex, OCachePointer dataPointer)
void	storeCacheState(OWriteCache writeCache) Stores state of cache inside file if possible.
void	truncateFile(long fileId)
void	truncateFile(long fileId, OWriteCache writeCache)
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

Constructor Detail

ODirectMemoryOnlyDiskCache

public ODirectMemoryOnlyDiskCache(int pageSize,
                                  int id,
                                  OPerformanceStatisticManager performanceStatisticManager)

Method Detail

getPerformanceStatisticManager

public OPerformanceStatisticManager getPerformanceStatisticManager()

Specified by:

getPerformanceStatisticManager in interface OWriteCache

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.

addFile

public long addFile(String fileName,
                    OWriteCache writeCache)

Specified by:

addFile in interface OReadCache

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()

bookFileId

public long bookFileId(String fileName)

Specified by:

bookFileId in interface OWriteCache

loadFile

public long loadFile(String fileName,
                     OWriteCache writeCache)

loadFile

public long loadFile(long fileId,
                     OWriteCache writeCache)

loadFile

public long loadFile(String fileName,
                     long fileId,
                     OWriteCache writeCache)

addFile

public long addFile(String fileName,
                    long fileId,
                    OWriteCache writeCache)

Specified by:

addFile in interface OReadCache

load

public OCacheEntry load(long fileId,
                        long pageIndex,
                        boolean checkPinnedPages,
                        OWriteCache writeCache,
                        int pageCount,
                        boolean verifyChecksums)

Specified by:

load in interface OReadCache

pinPage

public void pinPage(OCacheEntry cacheEntry)

Specified by:

pinPage in interface OReadCache

allocateNewPage

public OCacheEntry allocateNewPage(long fileId,
                                   OWriteCache writeCache,
                                   boolean verifyChecksums)

Specified by:

allocateNewPage in interface OReadCache

release

public void release(OCacheEntry cacheEntry,
                    OWriteCache writeCache)

Specified by:

release in interface OReadCache

getFilledUpTo

public long getFilledUpTo(long fileId)

Specified by:

getFilledUpTo in interface OWriteCache

flush

public void flush(long fileId)

Specified by:

flush in interface OWriteCache

close

public void close(long fileId,
                  boolean flush)

Specified by:

close in interface OWriteCache

deleteFile

public void deleteFile(long fileId)

Specified by:

deleteFile in interface OWriteCache

verifyPage

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

Specified by:

verifyPage in interface OWriteCache

Throws:

IOException

renameFile

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

Specified by:

renameFile in interface OWriteCache

truncateFile

public void truncateFile(long fileId)

Specified by:

truncateFile in interface OWriteCache

flush

public void flush()

Specified by:

flush in interface OWriteCache

close

public long[] close()

Specified by:

close in interface OWriteCache

clear

public void clear()

Specified by:

clear in interface OReadCache

delete

public long[] delete()

Specified by:

delete in interface OWriteCache

deleteStorage

public void deleteStorage(OWriteCache writeCache)
                   throws IOException

Specified by:

deleteStorage in interface OReadCache

Throws:

IOException

closeStorage

public void closeStorage(OWriteCache writeCache)
                  throws IOException

Closes all files inside of write cache and flushes all associated data.

Specified by:

closeStorage in interface OReadCache

Parameters:

writeCache - Write cache to close.

Throws:

IOException

loadCacheState

public void loadCacheState(OWriteCache writeCache)

Load state of cache from file system if possible.

Specified by:

loadCacheState in interface OReadCache

Parameters:

writeCache - Write cache is used to load pages back into cache if possible.

storeCacheState

public void storeCacheState(OWriteCache writeCache)

Stores state of cache inside file if possible.

Specified by:

storeCacheState in interface OReadCache

Parameters:

writeCache - Write cache which manages files cache state of which is going to be stored.

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

checkStoredPages

public OPageDataVerificationError[] checkStoredPages(OCommandOutputListener commandOutputListener)

Specified by:

checkStoredPages in interface OWriteCache

exists

public boolean exists(String name)

Specified by:

exists in interface OWriteCache

exists

public boolean exists(long fileId)

Specified by:

exists in interface OWriteCache

fileNameById

public String fileNameById(long fileId)

Specified by:

fileNameById in interface OWriteCache

getUsedMemory

public long getUsedMemory()

Specified by:

getUsedMemory in interface OReadCache

startFuzzyCheckpoints

public void startFuzzyCheckpoints()

Specified by:

startFuzzyCheckpoints in interface OWriteCache

checkLowDiskSpace

public boolean checkLowDiskSpace()

Specified by:

checkLowDiskSpace in interface OWriteCache

makeFuzzyCheckpoint

public void makeFuzzyCheckpoint()

Specified by:

makeFuzzyCheckpoint 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)

Not implemented because has no sense

Specified by:

addPageIsBrokenListener in interface OWriteCache

removePageIsBrokenListener

public void removePageIsBrokenListener(OPageIsBrokenListener listener)

Not implemented because has no sense

Specified by:

removePageIsBrokenListener in interface OWriteCache

loadFile

public long loadFile(String fileName)

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

addFile

public long addFile(String fileName)

Specified by:

addFile in interface OWriteCache

addFile

public long addFile(String fileName,
                    long fileId)

Specified by:

addFile in interface OWriteCache

store

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

Specified by:

store in interface OWriteCache

load

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

Specified by:

load in interface OWriteCache

getExclusiveWriteCachePagesSize

public long getExclusiveWriteCachePagesSize()

Specified by:

getExclusiveWriteCachePagesSize in interface OWriteCache

truncateFile

public void truncateFile(long fileId,
                         OWriteCache writeCache)
                  throws IOException

Specified by:

truncateFile in interface OReadCache

Throws:

IOException

getId

public int getId()

Specified by:

getId in interface OWriteCache

files

public Map<String,Long> files()

Specified by:

files in interface OWriteCache

pageSize

public int pageSize()

Specified by:

pageSize in interface OWriteCache

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

fileIdsAreEqual

public boolean fileIdsAreEqual(long firsId,
                               long secondId)

Specified by:

fileIdsAreEqual in interface OWriteCache

closeFile

public void closeFile(long fileId,
                      boolean flush,
                      OWriteCache writeCache)
               throws IOException

Specified by:

closeFile in interface OReadCache

Throws:

IOException

deleteFile

public void deleteFile(long fileId,
                       OWriteCache writeCache)
                throws IOException

Specified by:

deleteFile in interface OReadCache

Throws:

IOException