ostore.archive
Class ArchiveObjBucket

java.lang.Object
  |
  +--ostore.archive.ArchiveObjBucket

public class ArchiveObjBucket

extends Object

The ArchiveObjBucket is a hashtable bucket that stores the necessary references to archive or recoalesce a DataObject.

Version:

$Id: ArchiveObjBucket.java,v 1.15 2003/11/17 23:52:43 emilong Exp $

Author:

Hakim Weatherspoon

See Also:

GenerateChkptStage

Constructor Summary

ArchiveObjBucket()
Default constructor

ArchiveObjBucket(NodeId selfNodeId)
Constructor.

ArchiveObjBucket(SecureHash reqVersion, int numFrags, int inverseR, int erasureT, NodeId selfNodeId, HandleStore store)
Constructor.

ArchiveObjBucket(SecureHash reqVersion, int offset, int length, NodeId selfNodeId, HandleStore store)
Constructor.

Method Summary

void	addObjSize(int size) addObjSize add the obj size to the total size of the archival or recoalescing process.
SecureHash	get(SecureHash key) get returns an entry from the block map that matches the key.
Map	getBlkBuckets() getBlkBuckets returns the block map.
Map	getBlockIds() getBlockIds returns a map of fhash's created from the GenerateFragsStage.
int	getBlockSize() getBlockSize returns the block size used for each block, except the topblock can be larger or smaller.
SecureHash	getChkpt() getChkpt returns the guid of the checkpoint.
long	getCodeHandlerTimeSquareSum() getCodeTimeSquareSum return total square sum time coding the current object.
long	getCodeHandlerTimeSum() getCodeTimeSum return total sum time coding the current object.
long	getCodeMethodTimeSquareSum() getCodeTimeSquareSum return total square sum time coding the current object.
long	getCodeMethodTimeSum() getCodeTimeSum return total sum time coding the current object.
long	getCodeTime() getCodeTime return total coding time of the current object.
long	getCodeTimeCount() getCodeTimeCount return total count of times summed together.
long	getCodeTimeSquareSum() getCodeTimeSquareSum return total square sum time coding the current object.
long	getCodeTimeSum() getCodeTimeSum return total sum time coding the current object.
long	getCodeTotalTimeSquareSum() getCodeTimeSquareSum return total square sum time coding the current object.
long	getCodeTotalTimeSum() getCodeTimeSum return total sum time coding the current object.
long	getCodeVHashTreeTimeSquareSum() getCodeTimeSquareSum return total square sum time coding the current object.
long	getCodeVHashTreeTimeSum() getCodeTimeSum return total sum time coding the current object.
boolean	getCommit()
Map	getDisseminateBucket() getDisseminateBucket returns a map of dissemination buckets to disseminate.
Map	getDisseminateGuid() getDisseminateGuid returns a map of guid's for dissemination buckets to disseminate and their block types.
long	getEndTime() getEndTime return the endTime of the archiving or recoalescing process.
int	getErasureType() getErasureType returns the type of erasure code to use.
HandleStore	getHandleStore() getHandleStore returns the handleStore that stores all the handles for blocks being archived.
int	getInverseRate() getInverseRate returns the inverse rate of encoding.
int	getLength() getLength returns the number of data bytes to read.
Object	getModifiedVHash(SecureHash key) getModifiedVHash returns the Object (i.e. pending block) associated with guid.
Map	getModifiedVHashes() getModifiedVHashes returns a map of modified vhashes.
int	getNumFragments() getNumFragments returns the number of fragments to generate for each block.
int	getNumPendingBlk() getNumPendingBlk returns number of pending blocks.
int	getOffset() getOffset returns the position in data byte sequence to start reconstruction.
Object	getPendingBlk(SecureHash guid) getPendingBlk returns the Object (i.e. pending block) associated with guid.
Iterator	getPendingBlks() getPendingBlks returns the GUIDs of the blks which have been requested, but which have yet to be encoded or recoalesced
SecureHash	getReqVersion() getReqVersion returns the guid of the requested obj.
long	getStartTime() getStartTime return the startTime of the archiving or recoalescing process.
CacheableIdentity	getTopBlockId()
int	getTotalBlockSizes() getTotalBlockSizes returns the total size of all VerifiableBlocks being archived or reconstructed.
int	getTotalDisseminateSizes() getTotalDisseminateSizes returns the total disseminate size of all VerifiableBlocks being archived or reconstructed.
int	getTotalErasureBlockSizes() getTotalErasureBlockSizes returns the total Erasure size of all VerifiableBlocks being archived or reconstructed.
int	getTotalObjSizes() getTotalObjSizes returns the total size of object that includes all VerifiableBlocks being archived or reconstructed.
long	getType(SecureHash guid) getType returns type of block associated with guid.
SecureHash	getVGuid()
void	incrCodeHandlerTimeSquareSum(long timeSq) incrCodeTimeSquareSum increment the total squared sum time coding the current object.
void	incrCodeHandlerTimeSum(long time) incrCodeTimeSum increment the total sum time coding the current object.
void	incrCodeMethodTimeSquareSum(long timeSq) incrCodeTimeSquareSum increment the total squared sum time coding the current object.
void	incrCodeMethodTimeSum(long time) incrCodeTimeSum increment the total sum time coding the current object.
void	incrCodeTimeCount() incrCodeTimeCount increment the total count of coding times summed by one.
void	incrCodeTimeCount(long count) incrCodeTimeCount increment the total count of times summed together by count.
void	incrCodeTimeSquareSum(long timeSq) incrCodeTimeSquareSum increment the total squared sum time coding the current object.
void	incrCodeTimeSum(long time) incrCodeTimeSum increment the total sum time coding the current object.
void	incrCodeTotalTimeSquareSum(long timeSq) incrCodeTimeSquareSum increment the total squared sum time coding the current object.
void	incrCodeTotalTimeSum(long time) incrCodeTimeSum increment the total sum time coding the current object.
void	incrCodeVHashTreeTimeSquareSum(long timeSq) incrCodeTimeSquareSum increment the total squared sum time coding the current object.
void	incrCodeVHashTreeTimeSum(long time) incrCodeTimeSum increment the total sum time coding the current object.
void	incrTotalBlockSizes(int size) incrTotalBlockSizes add the size to the total block size of the archival or recoalescing process.
void	incrTotalDisseminateSizes(int size) incrTotalDisseminateSizes add the size to the total disseminate size of the archival or recoalescing process.
void	incrTotalErasureBlockSizes(int size) incrTotalErasureBlockSizes add the size to the total erasure block of the archival or recoalescing process.
Object	removePendingBlk(SecureHash guid) removePendingBlk removes the block associated with the block GUID from the list of pending blks.
long	removeType(SecureHash guid) removeType removes the block type associated with the block GUID.
void	reset() reset state and incorporate specified parameters.
void	reset(SecureHash reqVersion, int numFrags, int inverseR, int erasureT, NodeId selfNodeId, HandleStore store) reset state and incorporate specified parameters.
SecureHash	set(SecureHash chkptGuid, SecureHash vGuid) set adds a recoalesced obj to the growing obj hash table.
Object	setBlockId(Object blkVHash, Object fhash) setDisseminateGuid adds a map entry of fhash associated to blkVHash of block just archived.
void	setBlockSize(int size) setBlockSize sets the block size used for each block, except the topblock can be larger or smaller.
void	setChkpt(SecureHash chkpt) getChkpt sets the guid of the checkpoint.
void	setCommit(boolean commit)
Object	setDisseminateBucket(Object guid, DisseminatableBucket db) setDisseminateBucket adds a map entry of blkVHash to Dissemination Bucket.
Object	setDisseminateGuid(Object guid, Object type) setDisseminateGuid adds a map entry of Guid of Dissemination Bucket to disseminate and that block type.
void	setEndTime(long time) setEndTime set the endTime of the archiving or recoalescing process.
Object	setModifiedVHash(Object key, Object element) sets a map entry of a modified blocks vhash and corresponding guid or Collection of interested blocks.
Object	setPendingBlk(SecureHash guid, Object ancestor) setPendingBlk adds an entry block GUID=>parent block to the list of pending blks.
void	setReqVersion(SecureHash reqVersion) getReqVersion sets the guid of the requested obj.
void	setStartTime(long time) setStartTime set the startTime of the archiving or recoalescing process.
void	setTopBlockId(CacheableIdentity topBlockId)
long	setType(SecureHash guid, long type) setType add type of block associated with guid.
void	setVGuid(SecureHash vguid)
int	sizeType() sizeType returns the size of the the type map.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveObjBucket

public ArchiveObjBucket()

Default constructor

ArchiveObjBucket

public ArchiveObjBucket(NodeId selfNodeId)

Constructor. Construct ArchiveObjBucket from specified parameters.

Parameters:

selfNodeId - NodeId of local machine. needed for current time.

ArchiveObjBucket

public ArchiveObjBucket(SecureHash reqVersion,
                        int numFrags,
                        int inverseR,
                        int erasureT,
                        NodeId selfNodeId,
                        HandleStore store)

Constructor. Construct ArchiveObjBucket from specified parameters.

Parameters:

reqVersion - Guid of requested version, a.k.a. V-GUID.

numFrags - number of fragments generated for block.

inverseR - inverse rate of encoding.

erasureT - type of erasure code to use.

selfNodeId - NodeId of local machine. needed for current time.

ArchiveObjBucket

public ArchiveObjBucket(SecureHash reqVersion,
                        int offset,
                        int length,
                        NodeId selfNodeId,
                        HandleStore store)

Constructor. Construct ArchiveObjBucket from specified parameters.

Parameters:

reqVersion - Guid of requested version, a.k.a. V-GUID.

length - number of data bytes to read. Set to -1 if want all bytes.

offset - position in data byte sequence to start reconstruction.

selfNodeId - NodeId of local machine. needed for current time.

Method Detail

reset

public void reset(SecureHash reqVersion,
                  int numFrags,
                  int inverseR,
                  int erasureT,
                  NodeId selfNodeId,
                  HandleStore store)

reset state and incorporate specified parameters.

Parameters:

reqVersion - Guid of requested version, a.k.a. V-GUID.

numFrags - number of fragments generated for block.

inverseR - inverse rate of encoding.

erasureT - type of erasure code to use.

selfNodeId - NodeId of local machine. needed for current time.

reset

public void reset()

reset state and incorporate specified parameters.

getTopBlockId

public CacheableIdentity getTopBlockId()

setTopBlockId

public void setTopBlockId(CacheableIdentity topBlockId)

getVGuid

public SecureHash getVGuid()

setVGuid

public void setVGuid(SecureHash vguid)

getCommit

public boolean getCommit()

setCommit

public void setCommit(boolean commit)

sizeType

public int sizeType()

sizeType returns the size of the the type map.

Returns:

size of type map.

getBlockSize

public int getBlockSize()

getBlockSize returns the block size used for each block, except the topblock can be larger or smaller. This piece of information is either retrieved from the version metadata on archive or from a fragment on reconstruct.

Returns:

block size used for each block, except the topblock can be larger or smaller.

getNumFragments

public int getNumFragments()

getNumFragments returns the number of fragments to generate for each block.

Returns:

number of fragments to generate for each block.

getInverseRate

public int getInverseRate()

getInverseRate returns the inverse rate of encoding.

Returns:

the inverse rate of encoding.

getErasureType

public int getErasureType()

getErasureType returns the type of erasure code to use.

Returns:

the type of erasure code to use.

getOffset

public int getOffset()

getOffset returns the position in data byte sequence to start reconstruction.

Returns:

position in data byte sequence to start reconstruction.

getLength

public int getLength()

getLength returns the number of data bytes to read. Set to -1 if want all bytes.

Returns:

the number of data bytes to read. Set to -1 if want all bytes.

getHandleStore

public HandleStore getHandleStore()

getHandleStore returns the handleStore that stores all the handles for blocks being archived.

Returns:

the handleStore.

getTotalBlockSizes

public int getTotalBlockSizes()

getTotalBlockSizes returns the total size of all VerifiableBlocks being archived or reconstructed.

Returns:

total size of all VerifiableBlocks being archived or reconstructed.

getTotalErasureBlockSizes

public int getTotalErasureBlockSizes()

getTotalErasureBlockSizes returns the total Erasure size of all VerifiableBlocks being archived or reconstructed.

Returns:

total size of all Erasure VerifiableBlocks being archived or reconstructed.

getTotalDisseminateSizes

public int getTotalDisseminateSizes()

getTotalDisseminateSizes returns the total disseminate size of all VerifiableBlocks being archived or reconstructed.

Returns:

total disseminate size of all VerifiableBlocks being archived or reconstructed.

getTotalObjSizes

public int getTotalObjSizes()

getTotalObjSizes returns the total size of object that includes all VerifiableBlocks being archived or reconstructed.

Returns:

total size of object that includes VerifiableBlocks being archived or reconstructed.

getReqVersion

public SecureHash getReqVersion()

getReqVersion returns the guid of the requested obj.

Returns:

the guid of the requested obj.

getChkpt

public SecureHash getChkpt()

getChkpt returns the guid of the checkpoint.

Returns:

the guid of the checkpoint.

get

public SecureHash get(SecureHash key)

get returns an entry from the block map that matches the key.

Parameters:

key - guid of block.

Returns:

an entry from the block map that mathes the key.

getBlkBuckets

public Map getBlkBuckets()

getBlkBuckets returns the block map.

Returns:

the block map.

getPendingBlks

public Iterator getPendingBlks()

getPendingBlks returns the GUIDs of the blks which have been requested, but which have yet to be encoded or recoalesced

Returns:

the GUIDs of the blks which have been requested, but which have yet to be encoded or recoalesced.

getPendingBlk

public Object getPendingBlk(SecureHash guid)

getPendingBlk returns the Object (i.e. pending block) associated with guid.

Parameters:

guid - guid of pending block.

Returns:

an Object (i.e. pending block) associated with guid.

getNumPendingBlk

public int getNumPendingBlk()

getNumPendingBlk returns number of pending blocks.

Returns:

the number of pending blocks that have not completed being archived or recoalesced.

getType

public long getType(SecureHash guid)

getType returns type of block associated with guid. (e.g. DataObject, Btree.InteriorNode, or DataObject.DataBlock).

Returns:

type of block associated with guid.

getDisseminateGuid

public Map getDisseminateGuid()

getDisseminateGuid returns a map of guid's for dissemination buckets to disseminate and their block types.

Returns:

the map of guid's for dissemination buckets to disseminate and their types.

getDisseminateBucket

public Map getDisseminateBucket()

getDisseminateBucket returns a map of dissemination buckets to disseminate.

Returns:

the map of dissemination buckets to disseminate.

getBlockIds

public Map getBlockIds()

getBlockIds returns a map of fhash's created from the GenerateFragsStage.

Returns:

the map of fhash's created from the GenerateFragsStage.

getModifiedVHashes

public Map getModifiedVHashes()

getModifiedVHashes returns a map of modified vhashes. Map associates vhashes to there respective guid or vhashes to a Collection of interested blocks.

Returns:

the map of vhahes of modified blocks.

getModifiedVHash

public Object getModifiedVHash(SecureHash key)

getModifiedVHash returns the Object (i.e. pending block) associated with guid.

Parameters:

key - vhash of modified block.

Returns:

an Object associated with vhash. That is, a guid or a Collection of interested blocks.

addObjSize

public void addObjSize(int size)

addObjSize add the obj size to the total size of the archival or recoalescing process.

Parameters:

size - to be added to total size. and their types.

setBlockSize

public void setBlockSize(int size)

setBlockSize sets the block size used for each block, except the topblock can be larger or smaller. This piece of information is either retrieved from the version metadata on archive or from a fragment on reconstruct.

Parameters:

size - block size used for each block, except the topblock can be larger or smaller.

setReqVersion

public void setReqVersion(SecureHash reqVersion)

getReqVersion sets the guid of the requested obj.

Returns:

the guid of the requested obj.

setChkpt

public void setChkpt(SecureHash chkpt)

getChkpt sets the guid of the checkpoint.

Returns:

the guid of the checkpoint.

set

public SecureHash set(SecureHash chkptGuid,
                      SecureHash vGuid)

set adds a recoalesced obj to the growing obj hash table.

Parameters:

chkptGuid - guid of last checkpoint.

vGuid - version guid (i.e. V-GUID) that was just recoalesced

Returns:

guid of last checkpoint associated with version guid (i.e. V-GUID)

setPendingBlk

public Object setPendingBlk(SecureHash guid,
                            Object ancestor)

setPendingBlk adds an entry block GUID=>parent block to the list of pending blks. If block GUID is top block, then block GUID equals parent block GUID.

Parameters:

guid - guid of pending block.

ancestor - parent block.

Returns:

parent block associated with block GUID.

setDisseminateGuid

public Object setDisseminateGuid(Object guid,
                                 Object type)

setDisseminateGuid adds a map entry of Guid of Dissemination Bucket to disseminate and that block type.

Parameters:

guid - guid of Dissemination Bucket to disseminate.

type - type of block.

Returns:

type of block associated with guid od Dissemination Bucket to disseminate.

setDisseminateBucket

public Object setDisseminateBucket(Object guid,
                                   DisseminatableBucket db)

setDisseminateBucket adds a map entry of blkVHash to Dissemination Bucket.

Parameters:

guid - guid of Dissemination Bucket to disseminate.

db - DisseminatableBucket.

Returns:

DisseminatableBucket of block associated with guid to disseminate.

setBlockId

public Object setBlockId(Object blkVHash,
                         Object fhash)

setDisseminateGuid adds a map entry of fhash associated to blkVHash of block just archived.

Parameters:

blkVHash - vhash of block.

fhash - fhash used to generate guid.

Returns:

fhash of block associated with blockVHash just archived.

setModifiedVHash

public Object setModifiedVHash(Object key,
                               Object element)

sets a map entry of a modified blocks vhash and corresponding guid or Collection of interested blocks.

Parameters:

key - vhash of modified block.

element - Either corresponding guid or corresponding Collection of interested blocks.

Returns:

element that was associated with key before insert.

setType

public long setType(SecureHash guid,
                    long type)

setType add type of block associated with guid.

Parameters:

guid - guid of block.

type - type of block.

Returns:

type of block associated with guid.

removePendingBlk

public Object removePendingBlk(SecureHash guid)

removePendingBlk removes the block associated with the block GUID from the list of pending blks.

Parameters:

guid - guid of block.

Returns:

the block just removed from list of pending blks matching block guid.

removeType

public long removeType(SecureHash guid)

removeType removes the block type associated with the block GUID.

Parameters:

guid - guid of block.

Returns:

type of block associated with guid just removed.

incrTotalBlockSizes

public void incrTotalBlockSizes(int size)

incrTotalBlockSizes add the size to the total block size of the archival or recoalescing process.

Parameters:

size - size to to be added to total block size.

incrTotalErasureBlockSizes

public void incrTotalErasureBlockSizes(int size)

incrTotalErasureBlockSizes add the size to the total erasure block of the archival or recoalescing process.

Parameters:

size - size to to be added to total erasure block size.

incrTotalDisseminateSizes

public void incrTotalDisseminateSizes(int size)

incrTotalDisseminateSizes add the size to the total disseminate size of the archival or recoalescing process.

Parameters:

size - size to to be added to total disseminate size.

getStartTime

public long getStartTime()

getStartTime return the startTime of the archiving or recoalescing process.

Returns:

the startTime of the archiving or recoalescing process.

getEndTime

public long getEndTime()

getEndTime return the endTime of the archiving or recoalescing process.

Returns:

the endTime of the archiving or recoalescing process.

getCodeTimeSum

public long getCodeTimeSum()

getCodeTimeSum return total sum time coding the current object.

Returns:

the total sum time coding the current object.

getCodeTimeSquareSum

public long getCodeTimeSquareSum()

getCodeTimeSquareSum return total square sum time coding the current object.

Returns:

the total square sum time coding the current object.

getCodeVHashTreeTimeSum

public long getCodeVHashTreeTimeSum()

getCodeTimeSum return total sum time coding the current object.

Returns:

the total sum time coding the current object.

getCodeVHashTreeTimeSquareSum

public long getCodeVHashTreeTimeSquareSum()

getCodeTimeSquareSum return total square sum time coding the current object.

Returns:

the total square sum time coding the current object.

getCodeMethodTimeSum

public long getCodeMethodTimeSum()

getCodeTimeSum return total sum time coding the current object.

Returns:

the total sum time coding the current object.

getCodeMethodTimeSquareSum

public long getCodeMethodTimeSquareSum()

getCodeTimeSquareSum return total square sum time coding the current object.

Returns:

the total square sum time coding the current object.

getCodeHandlerTimeSum

public long getCodeHandlerTimeSum()

getCodeTimeSum return total sum time coding the current object.

Returns:

the total sum time coding the current object.

getCodeHandlerTimeSquareSum

public long getCodeHandlerTimeSquareSum()

getCodeTimeSquareSum return total square sum time coding the current object.

Returns:

the total square sum time coding the current object.

getCodeTotalTimeSum

public long getCodeTotalTimeSum()

getCodeTimeSum return total sum time coding the current object.

Returns:

the total sum time coding the current object.

getCodeTotalTimeSquareSum

public long getCodeTotalTimeSquareSum()

getCodeTimeSquareSum return total square sum time coding the current object.

Returns:

the total square sum time coding the current object.

getCodeTimeCount

public long getCodeTimeCount()

getCodeTimeCount return total count of times summed together.

Returns:

the total count of times summed together.

getCodeTime

public long getCodeTime()

getCodeTime return total coding time of the current object.

Returns:

the total coding time of the current object.

incrCodeTimeCount

public void incrCodeTimeCount()

incrCodeTimeCount increment the total count of coding times summed by one.

incrCodeTimeCount

public void incrCodeTimeCount(long count)

incrCodeTimeCount increment the total count of times summed together by count.

Parameters:

count - increment amount to be added to the total count of times summed together.

incrCodeTimeSum

public void incrCodeTimeSum(long time)

incrCodeTimeSum increment the total sum time coding the current object.

Parameters:

time - time amount to increment the total sum time coding the current object.

incrCodeTimeSquareSum

public void incrCodeTimeSquareSum(long timeSq)

incrCodeTimeSquareSum increment the total squared sum time coding the current object.

Parameters:

timeSq - time amount to increment the total squared sum time coding the current object.

incrCodeVHashTreeTimeSum

public void incrCodeVHashTreeTimeSum(long time)

incrCodeTimeSum increment the total sum time coding the current object.

Parameters:

time - time amount to increment the total sum time coding the current object.

incrCodeVHashTreeTimeSquareSum

public void incrCodeVHashTreeTimeSquareSum(long timeSq)

incrCodeTimeSquareSum increment the total squared sum time coding the current object.

Parameters:

timeSq - time amount to increment the total squared sum time coding the current object.

incrCodeMethodTimeSum

public void incrCodeMethodTimeSum(long time)

incrCodeTimeSum increment the total sum time coding the current object.

Parameters:

time - time amount to increment the total sum time coding the current object.

incrCodeMethodTimeSquareSum

public void incrCodeMethodTimeSquareSum(long timeSq)

incrCodeTimeSquareSum increment the total squared sum time coding the current object.

Parameters:

timeSq - time amount to increment the total squared sum time coding the current object.

incrCodeHandlerTimeSum

public void incrCodeHandlerTimeSum(long time)

incrCodeTimeSum increment the total sum time coding the current object.

Parameters:

time - time amount to increment the total sum time coding the current object.

incrCodeHandlerTimeSquareSum

public void incrCodeHandlerTimeSquareSum(long timeSq)

incrCodeTimeSquareSum increment the total squared sum time coding the current object.

Parameters:

timeSq - time amount to increment the total squared sum time coding the current object.

incrCodeTotalTimeSum

public void incrCodeTotalTimeSum(long time)

incrCodeTimeSum increment the total sum time coding the current object.

Parameters:

time - time amount to increment the total sum time coding the current object.

incrCodeTotalTimeSquareSum

public void incrCodeTotalTimeSquareSum(long timeSq)

incrCodeTimeSquareSum increment the total squared sum time coding the current object.

Parameters:

timeSq - time amount to increment the total squared sum time coding the current object.

setStartTime

public void setStartTime(long time)

setStartTime set the startTime of the archiving or recoalescing process.

Parameters:

time - the startTime of the archiving or recoalescing process.

setEndTime

public void setEndTime(long time)

setEndTime set the endTime of the archiving or recoalescing process.

Parameters:

time - the endTime of the archiving or recoalescing process.