Fennel: LinearViewSegment Class Reference (original) (raw)

LinearViewSegment is an implementation of Segment in terms of an underlying Segment, which must support the get/setPageSuccessor interface. More...

#include <[LinearViewSegment.h](LinearViewSegment%5F8h-source.html)>

Inheritance diagram for LinearViewSegment:

List of all members.

Public Types
enum AllocationOrder { RANDOM_ALLOCATION, ASCENDING_ALLOCATION, CONSECUTIVE_ALLOCATION, LINEAR_ALLOCATION }
Enumeration of the possible orderings of PageIds returned from allocatePageId. More...
Public Member Functions
virtual ~LinearViewSegment ()
PageId getFirstPageId () const
**Returns:**the starting PageId in the underlying segment
virtual BlockId translatePageId (PageId)
Maps from a PageId in this segment to a BlockId.
virtual PageId translateBlockId (BlockId)
Maps from a BlockId to a PageId in this segment.
virtual PageId allocatePageId (PageOwnerId ownerId)
Allocates a page without locking it into memory.
virtual void deallocatePageRange (PageId startPageId, PageId endPageId)
Deallocates a range of pages allocated from this segment.
virtual bool isPageIdAllocated (PageId pageId)
Tests whether a PageId is allocated.
virtual BlockNum getAllocatedSizeInPages ()
**Returns:**number of pages allocated from this segment
virtual PageId getPageSuccessor (PageId pageId)
Determines the successor of a given PageId.
virtual void setPageSuccessor (PageId pageId, PageId successorId)
Sets the successor of a given PageId.
virtual AllocationOrder getAllocationOrder () const
**Returns:**the AllocationOrder for this segment
virtual PageId updatePage (PageId pageId, bool needsTranslation=false)
Determines whether a page can be updated in-place, and if so, prepares the page for update.
SharedSegment const & getDelegateSegment () const
virtual BlockNum getNumPagesOccupiedHighWater ()
Returns the max number of pages occupied by this segment instance.
virtual BlockNum getNumPagesExtended ()
**Returns:**the number of incremental pages added to this instance of the segment
virtual bool ensureAllocatedSize (BlockNum nPages)
Allocates pages as needed to make getAllocatedSizeInPages() meet a lower bound.
virtual void delegatedCheckpoint (Segment &delegatingSegment, CheckpointType checkpointType)
Helper for DelegatingSegment.
virtual void notifyPageMap (CachePage &page)
Receives notification from CacheImpl as soon as a page is mapped, before any I/O is initiated to retrieve the page contents.
virtual void notifyPageUnmap (CachePage &page)
Receives notification from CacheImpl just before a page is unmapped.
virtual void notifyAfterPageRead (CachePage &page)
Receives notification from CacheImpl after a page read completes.
virtual void notifyPageDirty (CachePage &page, bool bDataValid)
Receives notification from CacheImpl the first time a page becomes dirty after it has been mapped (but before the contents have changed).
virtual void notifyBeforePageFlush (CachePage &page)
Receives notification from CacheImpl just before a dirty page is flushed to disk.
virtual void notifyAfterPageFlush (CachePage &page)
Receives notification from CacheImpl when a page flush completes successfully.
virtual bool canFlushPage (CachePage &page)
Informs CacheImpl whether a dirty page can safely be flushed to disk.
SharedCache getCache () const
**Returns:**the Cache for this Segment
uint getFullPageSize () const
**Returns:**the full size of pages stored in this segment; this is the same as the size of underlying cache pages
uint getUsablePageSize () const
**Returns:**the full size of pages stored in this segment minus the size for any footer information stored at the end of each page
virtual void initForUse ()
Performs additional initialization required on the segment after it has been properly formatted.
SharedSegment getTracingSegment ()
**Returns:**tracing segment associated with this segment if tracing is turned on; otherwise, returns the segment itself
void setTracingSegment (WeakSegment pTracingSegmentInit)
Sets the tracing segment associated with this segment.
void checkpoint (CheckpointType checkpointType=CHECKPOINT_FLUSH_ALL)
Checkpoints this segment.
virtual MappedPageListener * getMappedPageListener (BlockId blockId)
Returns the mapped page listener corresponding to a page.
virtual bool isWriteVersioned ()
**Returns:**true if the segment supports versioning
virtual MappedPageListener * getTracingListener ()
Retrieves the tracing wrapper corresponding to this listener if tracing is turned on.
virtual MappedPageListener * notifyAfterPageCheckpointFlush (CachePage &page)
Receives notification that a page has been flushed during a checkpoint.
bool isClosed () const
**Returns:**whether the object has been closed
void close ()
Closes this object, releasing any unallocated resources.
Static Public Member Functions
static PageId getLinearPageId (BlockNum iPage)
Constructs a linear PageId based on a linear page number.
static BlockNum getLinearBlockNum (PageId pageId)
Obtains the linear page number from a linear PageId.
Protected Types
typedef std::hash_map< PageId, PageId > PageMap
typedef PageMap::const_iterator PageMapConstIter
Protected Member Functions
void setUsablePageSize (uint)
PConstBuffer getReadableFooter (CachePage &page)
PBuffer getWritableFooter (CachePage &page)
PageId getLinearPageSuccessor (PageId pageId)
An implementation of getPageSuccessor suitable for LINEAR_ALLOCATION.
void setLinearPageSuccessor (PageId pageId, PageId successorId)
An implementation of setPageSuccessor suitable for LINEAR_ALLOCATION.
bool isLinearPageIdAllocated (PageId pageId)
An implementation of isPageIdAllocated suitable for LINEAR_ALLOCATION when deallocation holes are disallowed.
Protected Attributes
SharedCache pCache
Cache managing pages of this segment.
WeakSegment pTracingSegment
The tracing segment associated with this segment, if tracing is turned on.
bool needsClose
Private Member Functions
LinearViewSegment (SharedSegment delegateSegment, PageId firstPageId)
Private Attributes
std::vector< PageId > pageTable
Friends
class SegmentFactory

Detailed Description

LinearViewSegment is an implementation of Segment in terms of an underlying Segment, which must support the get/setPageSuccessor interface.

See the design docs for more detail.

Deallocation of individual pages of a LinearViewSegment is not yet supported, but full truncation is.

Definition at line 44 of file LinearViewSegment.h.


Member Typedef Documentation


Member Enumeration Documentation

Enumeration of the possible orderings of PageIds returned from allocatePageId.

The enumeration is from weakest to strongest ordering, and should not be changed.

Enumerator:

RANDOM_ALLOCATION Random order.
ASCENDING_ALLOCATION Later calls always return greater PageIds, but not necessarily consecutively.
CONSECUTIVE_ALLOCATION PageIds are returned in consecutive ascending order of BlockNum; the DeviceId is always the same.
LINEAR_ALLOCATION PageIds are returned in consecutive ascending order starting with 0; all bytes of the PageId are used (no division into DeviceId/BlockNum), yielding maximum range.

Definition at line 105 of file Segment.h.


Constructor & Destructor Documentation

LinearViewSegment::LinearViewSegment ( SharedSegment delegateSegment,
PageId firstPageId
) [private]

| LinearViewSegment::~LinearViewSegment | ( | | ) | [virtual] | | -------------------------------------- | - | | - | ----------- |


Member Function Documentation

| PageId LinearViewSegment::getFirstPageId | ( | | ) | const | | ---------------------------------------- | - | | - | ----- |

| BlockId LinearViewSegment::translatePageId | ( | PageId | | ) | [virtual] | | ------------------------------------------ | - | ------ | | - | ----------- |

| PageId LinearViewSegment::translateBlockId | ( | BlockId | | ) | [virtual] | | ------------------------------------------ | - | ------- | | - | ----------- |

PageId LinearViewSegment::allocatePageId ( PageOwnerId ownerId ) [virtual]
void LinearViewSegment::deallocatePageRange ( PageId startPageId,
PageId endPageId
) [virtual]

Deallocates a range of pages allocated from this segment.

Some segment implementations may impose restrictions on the range (e.g. individual pages only, entire segment truncation only, start-ranges, or end-ranges). The interpretation of the range may also vary by segment (e.g. for a LINEAR_ALLOCATION segment, it's a simple linear PageId range, while for a RANDOM_ALLOCATION segment, successors could be used).

Depending on the circumstances, it may be the responsibility of the segment to discard the corresponding blocks from the cache. The details vary by segment implementation.

Parameters:

startPageId inclusive start of PageId range to deallocate, or default NULL_PAGE_ID for beginning of segment
endPageId inclusive end of PageId range to deallocate, or default NULL_PAGE_ID for end of segment

Reimplemented from DelegatingSegment.

Definition at line 84 of file LinearViewSegment.cpp.

References NULL_PAGE_ID, and pageTable.

bool LinearViewSegment::isPageIdAllocated ( PageId pageId ) [virtual]

| BlockNum LinearViewSegment::getAllocatedSizeInPages | ( | | ) | [virtual] | | ------------------------------------------------------------------------------------------------------- | - | | - | ----------- |

PageId LinearViewSegment::getPageSuccessor ( PageId pageId ) [virtual]
void LinearViewSegment::setPageSuccessor ( PageId pageId,
PageId successorId
) [virtual]
PageId LinearViewSegment::updatePage ( PageId pageId,
bool needsTranslation = false
) [virtual]

| SharedSegment const& DelegatingSegment::getDelegateSegment | ( | | ) | const [inline, inherited] | | -------------------------------------------------------------------------------------------------------------------- | - | | - | --------------------------- |

| BlockNum DelegatingSegment::getNumPagesOccupiedHighWater | ( | | ) | [virtual, inherited] | | ------------------------------------------------------------------------------------------------------------ | - | | - | ---------------------- |

Returns the max number of pages occupied by this segment instance.

In other words, pages that are allocated but subsequently deallocated, are included in this count. Also, the count includes all pages used by the segment, including metadata pages.

Returns:

the max number of pages occupied by a segment

Implements Segment.

Reimplemented in RandomAllocationSegmentBase.

Definition at line 52 of file DelegatingSegment.cpp.

References DelegatingSegment::pDelegateSegment.

| BlockNum DelegatingSegment::getNumPagesExtended | ( | | ) | [virtual, inherited] | | --------------------------------------------------------------------------------------------------- | - | | - | ---------------------- |

bool DelegatingSegment::ensureAllocatedSize ( BlockNum nPages ) [virtual, inherited]
void DelegatingSegment::delegatedCheckpoint ( Segment & delegatingSegment,
CheckpointType checkpointType
) [virtual, inherited]
void DelegatingSegment::notifyPageMap ( CachePage & page ) [virtual, inherited]
void DelegatingSegment::notifyPageUnmap ( CachePage & page ) [virtual, inherited]
void DelegatingSegment::notifyAfterPageRead ( CachePage & page ) [virtual, inherited]
void DelegatingSegment::notifyPageDirty ( CachePage & page,
bool bDataValid
) [virtual, inherited]

Receives notification from CacheImpl the first time a page becomes dirty after it has been mapped (but before the contents have changed).

Allows some logging action to be taken; for example, making a backup copy of the unmodified page contents. Note that when called for a newly allocated page, the page contents are invalid. Because it is implied that the calling thread already has an exclusive lock on the page, no cache locks are held when called.

Parameters:

page the page being modified
bDataValid if true, the page data was already valid; if false, the data was invalid, but has now been marked valid since it's about to be written

Reimplemented from MappedPageListener.

Reimplemented in SnapshotRandomAllocationSegment, TracingSegment, VersionedSegment, and WALSegment.

Definition at line 122 of file DelegatingSegment.cpp.

References DelegatingSegment::pDelegateSegment.

Referenced by WALSegment::notifyPageDirty(), VersionedSegment::notifyPageDirty(), TracingSegment::notifyPageDirty(), and SnapshotRandomAllocationSegment::notifyPageDirty().

void DelegatingSegment::notifyBeforePageFlush ( CachePage & page ) [virtual, inherited]
void DelegatingSegment::notifyAfterPageFlush ( CachePage & page ) [virtual, inherited]
bool DelegatingSegment::canFlushPage ( CachePage & page ) [virtual, inherited]

| void Segment::setUsablePageSize | ( | uint | | ) | [protected, inherited] | | ------------------------------- | - | ----------------------------------------------------------------- | | - | ------------------------ |

PageId Segment::getLinearPageSuccessor ( PageId pageId ) [protected, inherited]
void Segment::setLinearPageSuccessor ( PageId pageId,
PageId successorId
) [protected, inherited]
bool Segment::isLinearPageIdAllocated ( PageId pageId ) [protected, inherited]

| SharedCache Segment::getCache | ( | | ) | const [inline, inherited] | | --------------------------------------------------------------------------------------- | - | | - | --------------------------- |

| uint Segment::getFullPageSize | ( | | ) | const [inherited] | | ------------------------------------------------------------------------------------------ | - | | - | ------------------- |

| uint Segment::getUsablePageSize | ( | | ) | const [inline, inherited] | | -------------------------------------------------------------------------------------------- | - | | - | --------------------------- |

| void Segment::initForUse | ( | | ) | [virtual, inherited] | | ------------------------ | - | | - | ---------------------- |

Returns:

tracing segment associated with this segment if tracing is turned on; otherwise, returns the segment itself

Definition at line 50 of file Segment.cpp.

References Segment::pTracingSegment.

Referenced by VersionedRandomAllocationSegment::allocateAllocNodes(), RandomAllocationSegment::allocateFromExtent(), RandomAllocationSegment::allocateFromNewExtent(), RandomAllocationSegment::allocatePageId(), VersionedRandomAllocationSegment::backupAllocationNodes(), VersionedRandomAllocationSegment::chainPageEntries(), SnapshotRandomAllocationSegment::commitChanges(), VersionedRandomAllocationSegment::copyPageEntryFromTemp(), VersionedRandomAllocationSegment::copyPageEntryToTemp(), RandomAllocationSegmentBase::deallocatePageId(), VersionedRandomAllocationSegment::findAllocPageIdForRead(), RandomAllocationSegmentBase::format(), RandomAllocationSegmentBase::formatPageExtentsTemplate(), RandomAllocationSegmentBase::freePageEntryTemplate(), RandomAllocationSegment::getExtAllocPageIdForRead(), VersionedRandomAllocationSegment::getOldestTxnId(), VersionedRandomAllocationSegment::getOldPageIds(), RandomAllocationSegmentBase::getPageEntryCopyTemplate(), RandomAllocationSegment::getSegAllocPageIdForRead(), VersionedRandomAllocationSegment::getTempAllocNodePage(), Segment::getTracingListener(), VersionedRandomAllocationSegment::locateDataPages(), VersionedRandomAllocationSegment::restoreFromBackup(), SnapshotRandomAllocationSegment::rollbackChanges(), RandomAllocationSegment::setPageSuccessor(), VersionedRandomAllocationSegment::updateExtentEntry(), and VersionedRandomAllocationSegment::validateFreePageCount().

00051 { 00052 SharedSegment sharedPtr = pTracingSegment.lock(); 00053 if (sharedPtr && sharedPtr.get()) { 00054 return sharedPtr; 00055 } else { 00056 return shared_from_this(); 00057 } 00058 }

void Segment::setTracingSegment ( WeakSegment pTracingSegmentInit ) [inherited]

Sets the tracing segment associated with this segment.

Parameters:

pTracingSegmentInit the tracing segment

Definition at line 60 of file Segment.cpp.

References Segment::pTracingSegment.

void Segment::checkpoint ( CheckpointType checkpointType = CHECKPOINT_FLUSH_ALL ) [inherited]
MappedPageListener * Segment::getMappedPageListener ( BlockId blockId ) [virtual, inherited]

| bool Segment::isWriteVersioned | ( | | ) | [virtual, inherited] | | ------------------------------ | - | | - | ---------------------- |

PageId Segment::getLinearPageId ( BlockNum iPage ) [inline, static, inherited]

Constructs a linear PageId based on a linear page number.

Definition at line 348 of file Segment.h.

Referenced by RandomAllocationSegmentBase::allocateFromLockedExtentTemplate(), ScratchSegment::allocatePageId(), allocatePageId(), LinearDeviceSegment::allocatePageId(), CircularSegment::allocatePageId(), RandomAllocationSegmentBase::getExtentAllocPageId(), VersionedRandomAllocationSegment::getOldPageIds(), RandomAllocationSegmentBase::getSegAllocPageId(), Database::init(), VersionedRandomAllocationSegment::locateDataPages(), SegmentTestBase::lockPage(), SegmentTestBase::prefetchPage(), SegPageIterTest::testBoundedIter(), SegPageEntryIterTest::testBoundedIter(), ScratchSegment::translateBlockId(), translateBlockId(), LinearDeviceSegment::translateBlockId(), CircularSegment::translateBlockId(), and CircularSegment::translatePageId().

00349 { 00350 return PageId(iPage); 00351 }

BlockNum Segment::getLinearBlockNum ( PageId pageId ) [inline, static, inherited]

Obtains the linear page number from a linear PageId.

Definition at line 353 of file Segment.h.

References opaqueToInt().

Referenced by CircularSegment::CircularSegment(), LinearDeviceSegment::deallocatePageRange(), CircularSegment::deallocatePageRange(), Segment::isLinearPageIdAllocated(), CircularSegment::isPageIdAllocated(), SegmentTestBase::lockPage(), SegInputStream::readPrevBuffer(), Segment::setLinearPageSuccessor(), RandomAllocationSegmentBase::splitPageId(), CircularSegment::translateBlockId(), ScratchSegment::translatePageId(), translatePageId(), LinearDeviceSegment::translatePageId(), CircularSegment::translatePageId(), and updatePage().

Receives notification that a page has been flushed during a checkpoint.

Also determines if the listener on the page needs to be reset.

Note that if the page listener is reset, that page may not be unmapped during a CHECKPOINT_FLUSH_AND_UNMAP checkpoint call.

This method should be called immediately after the page flush has completed while the checkpoint is still in progress.

Parameters:

page the page that was flushed

Returns:

NULL if the listener on the page does not need to be reset; otherwise, returns the listener that the page should be reset to

Reimplemented in SnapshotRandomAllocationSegment, and TracingSegment.

Definition at line 62 of file MappedPageListener.cpp.

00064 { 00065 return NULL; 00066 }

| bool ClosableObject::isClosed | ( | | ) | const [inline, inherited] | | ----------------------------- | - | | - | --------------------------- |

Returns:

whether the object has been closed

Definition at line 58 of file ClosableObject.h.

| void ClosableObject::close | ( | | ) | [inherited] | | -------------------------- | - | | - | ------------- |

Closes this object, releasing any unallocated resources.

Reimplemented in CollectExecStream, CorrelationJoinExecStream, LcsClusterAppendExecStream, and LcsClusterReplaceExecStream.

Definition at line 39 of file ClosableObject.cpp.

References ClosableObject::closeImpl(), and ClosableObject::needsClose.

Referenced by CacheImpl< PageT, VictimPolicyT >::allocatePages(), LcsRowScanBaseExecStream::closeImpl(), ExecStreamGraphImpl::closeImpl(), FlatFileBuffer::open(), ClosableObjectDestructor::operator()(), and Segment::~Segment().



Member Data Documentation

Cache managing pages of this segment.

Definition at line 62 of file Segment.h.

Referenced by VersionedRandomAllocationSegment::allocateAllocNodes(), RandomAllocationSegmentBase::allocateFromExtentTemplate(), RandomAllocationSegmentBase::allocateFromNewExtentTemplate(), RandomAllocationSegmentBase::allocatePageIdFromSegment(), VersionedRandomAllocationSegment::backupAllocationNodes(), VersionedRandomAllocationSegment::chainPageEntries(), VersionedRandomAllocationSegment::copyPageEntryFromTemp(), VersionedRandomAllocationSegment::copyPageEntryToTemp(), RandomAllocationSegmentBase::deallocatePageId(), VersionedRandomAllocationSegment::deallocateSinglePage(), VersionedRandomAllocationSegment::deferDeallocation(), VersionedSegment::delegatedCheckpoint(), SnapshotRandomAllocationSegment::delegatedCheckpoint(), Segment::delegatedCheckpoint(), RandomAllocationSegmentBase::format(), RandomAllocationSegmentBase::formatPageExtentsTemplate(), RandomAllocationSegmentBase::freePageEntryTemplate(), Segment::getCache(), Segment::getFullPageSize(), VersionedRandomAllocationSegment::getOldestTxnId(), VersionedRandomAllocationSegment::getOldPageIds(), RandomAllocationSegmentBase::getPageEntryCopyTemplate(), VersionedRandomAllocationSegment::getTempAllocNodePage(), VersionedRandomAllocationSegment::initPageEntry(), VersionedRandomAllocationSegment::locateDataPages(), VersionedSegment::notifyPageDirty(), VersionedSegment::recover(), VersionedRandomAllocationSegment::restoreFromBackup(), RandomAllocationSegmentBase::setPageSuccessorTemplate(), RandomAllocationSegmentBase::tallySegAllocNodePages(), VersionedRandomAllocationSegment::uncommittedDeallocation(), VersionedRandomAllocationSegment::updateExtentEntry(), VersionedRandomAllocationSegment::updatePageEntry(), VersionedRandomAllocationSegment::updateTempPageEntry(), and VersionedRandomAllocationSegment::validateFreePageCount().


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


Generated on Mon Jun 22 04:00:39 2009 for Fennel by doxygen 1.5.1