Panda3D
Public Member Functions | Protected Member Functions | Protected Attributes | Friends

AdaptiveLruPage Class Reference

One atomic piece that may be managed by a AdaptiveLru chain. More...

#include "adaptiveLru.h"

Inheritance diagram for AdaptiveLruPage:
AdaptiveLruPageDynamicList AdaptiveLruPageStaticList LinkedListNode LinkedListNode IndexBufferContext TextureContext VertexBufferContext DXIndexBufferContext8 DXIndexBufferContext9 DXTextureContext8 DXTextureContext9 TinyTextureContext DXVertexBufferContext8 DXVertexBufferContext9

List of all members.

Public Member Functions

 AdaptiveLruPage (size_t lru_size)
 AdaptiveLruPage (const AdaptiveLruPage &copy)
void dequeue_lru ()
 Removes the page from its AdaptiveLru.
void enqueue_lru (AdaptiveLru *lru)
 Adds the page to the LRU for the first time, or marks it recently-accessed if it has already been added.
virtual void evict_lru ()
 Evicts the page from the LRU.
AdaptiveLruget_lru () const
 Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU.
size_t get_lru_size () const
 Returns the size of this page as reported to the LRU, presumably in bytes.
unsigned int get_num_frames () const
 Returns the number of frames since the page was first added to its LRU.
unsigned int get_num_inactive_frames () const
 Returns the number of frames since the page was last accessed on its LRU.
void mark_used_lru () const
 To be called when the page is used; this will move it to the tail of the AdaptiveLru queue it is already on.
void mark_used_lru (AdaptiveLru *lru)
 To be called when the page is used; this will move it to the tail of the specified AdaptiveLru queue.
void operator= (const AdaptiveLruPage &copy)
virtual void output (ostream &out) const
void set_lru_size (size_t lru_size)
 Specifies the size of this page, presumably in bytes, although any unit is possible.
virtual void write (ostream &out, int indent_level) const

Protected Member Functions

void insert_after (LinkedListNode *node)
 Adds a LinkedListNode record after the indicated node in the doubly-linked list.
void insert_after (LinkedListNode *node)
 Adds a LinkedListNode record after the indicated node in the doubly-linked list.
void insert_before (LinkedListNode *node)
 Adds a LinkedListNode record before the indicated node in the doubly-linked list.
void insert_before (LinkedListNode *node)
 Adds a LinkedListNode record before the indicated node in the doubly-linked list.
bool is_on_list () const
 Returns true if the node is member of any list, false if it has been removed or never added.
bool is_on_list () const
 Returns true if the node is member of any list, false if it has been removed or never added.
void remove_from_list ()
 Removes a LinkedListNode record from the doubly-linked list.
void remove_from_list ()
 Removes a LinkedListNode record from the doubly-linked list.
void take_list_from (LinkedListNode *other_root)
 Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.
void take_list_from (LinkedListNode *other_root)
 Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Protected Attributes

LinkedListNode_next
LinkedListNode_next
LinkedListNode_prev
LinkedListNode_prev

Friends

class AdaptiveLru

Detailed Description

One atomic piece that may be managed by a AdaptiveLru chain.

To use this class, inherit from it and override evict_lru().

This class multiply inherits from two classes which in turn both inherit from LinkedListNode. This is just a sneaky C++ trick to allow this class to inherit from LinkedListNode twice, so that pages can be stored on two different linked lists simultaneously. The AdaptiveLru class depends on this; it maintains its pages in two different lists, one grouped by priority, and one in order by next partial update needs.

Definition at line 145 of file adaptiveLru.h.


Member Function Documentation

void AdaptiveLruPage::dequeue_lru ( ) [inline]
void AdaptiveLruPage::enqueue_lru ( AdaptiveLru lru)
void AdaptiveLruPage::evict_lru ( ) [virtual]

Evicts the page from the LRU.

Called internally when the LRU determines that it is full. May also be called externally when necessary to explicitly evict the page.

It is legal for this method to either evict the page as requested, do nothing (in which case the eviction will be requested again at the next epoch), or requeue itself on the tail of the queue (in which case the eviction will be requested again much later).

Reimplemented in DXIndexBufferContext8, DXTextureContext8, DXVertexBufferContext8, DXIndexBufferContext9, DXTextureContext9, DXVertexBufferContext9, and TinyTextureContext.

Definition at line 557 of file adaptiveLru.cxx.

References dequeue_lru().

Referenced by AdaptiveLru::do_evict_to().

AdaptiveLru * AdaptiveLruPage::get_lru ( ) const [inline]

Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU.

Definition at line 161 of file adaptiveLru.I.

size_t AdaptiveLruPage::get_lru_size ( ) const [inline]

Returns the size of this page as reported to the LRU, presumably in bytes.

Definition at line 209 of file adaptiveLru.I.

unsigned int AdaptiveLruPage::get_num_frames ( ) const

Returns the number of frames since the page was first added to its LRU.

Returns 0 if it does not have an LRU.

Definition at line 589 of file adaptiveLru.cxx.

unsigned int AdaptiveLruPage::get_num_inactive_frames ( ) const

Returns the number of frames since the page was last accessed on its LRU.

Returns 0 if it does not have an LRU.

Definition at line 604 of file adaptiveLru.cxx.

void LinkedListNode::insert_after ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record after the indicated node in the doubly-linked list.

Definition at line 108 of file linkedListNode.I.

void LinkedListNode::insert_after ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record after the indicated node in the doubly-linked list.

Definition at line 108 of file linkedListNode.I.

void LinkedListNode::insert_before ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record before the indicated node in the doubly-linked list.

Definition at line 91 of file linkedListNode.I.

Referenced by SimpleAllocator::do_alloc(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void LinkedListNode::insert_before ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record before the indicated node in the doubly-linked list.

Definition at line 91 of file linkedListNode.I.

Referenced by SimpleAllocator::do_alloc(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

bool LinkedListNode::is_on_list ( ) const [inline, protected, inherited]

Returns true if the node is member of any list, false if it has been removed or never added.

The head of a list generally appears to to always be a member of itself.

Definition at line 62 of file linkedListNode.I.

bool LinkedListNode::is_on_list ( ) const [inline, protected, inherited]

Returns true if the node is member of any list, false if it has been removed or never added.

The head of a list generally appears to to always be a member of itself.

Definition at line 62 of file linkedListNode.I.

void AdaptiveLruPage::mark_used_lru ( ) const [inline]

To be called when the page is used; this will move it to the tail of the AdaptiveLru queue it is already on.

This method is const because it's not technically modifying the contents of the page itself.

Definition at line 185 of file adaptiveLru.I.

Referenced by DXTextureContext8::evict_lru(), and DXTextureContext9::evict_lru().

void AdaptiveLruPage::mark_used_lru ( AdaptiveLru lru) [inline]

To be called when the page is used; this will move it to the tail of the specified AdaptiveLru queue.

Definition at line 198 of file adaptiveLru.I.

References enqueue_lru().

void LinkedListNode::remove_from_list ( ) [inline, protected, inherited]

Removes a LinkedListNode record from the doubly-linked list.

Definition at line 73 of file linkedListNode.I.

Referenced by SimpleLruPage::dequeue_lru(), SimpleAllocatorBlock::do_free(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void LinkedListNode::remove_from_list ( ) [inline, protected, inherited]

Removes a LinkedListNode record from the doubly-linked list.

Definition at line 73 of file linkedListNode.I.

Referenced by SimpleLruPage::dequeue_lru(), SimpleAllocatorBlock::do_free(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void AdaptiveLruPage::set_lru_size ( size_t  lru_size) [inline]

Specifies the size of this page, presumably in bytes, although any unit is possible.

Definition at line 220 of file adaptiveLru.I.

Referenced by VertexBufferContext::update_data_size_bytes(), IndexBufferContext::update_data_size_bytes(), and TextureContext::update_data_size_bytes().

void LinkedListNode::take_list_from ( LinkedListNode other_root) [inline, protected, inherited]

Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Definition at line 127 of file linkedListNode.I.

Referenced by BufferContextChain::take_from().

void LinkedListNode::take_list_from ( LinkedListNode other_root) [inline, protected, inherited]

Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Definition at line 127 of file linkedListNode.I.

Referenced by BufferContextChain::take_from().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations