Panda3D
Public Member Functions | Friends | List of all members
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 DXIndexBufferContext9 DXTextureContext9 DXVertexBufferContext9

Public Member Functions

 AdaptiveLruPage (size_t lru_size)
 
 AdaptiveLruPage (const AdaptiveLruPage &copy)
 
void dequeue_lru ()
 Removes the page from its AdaptiveLru. More...
 
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. More...
 
virtual void evict_lru ()
 Evicts the page from the LRU. More...
 
AdaptiveLruget_lru () const
 Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU. More...
 
size_t get_lru_size () const
 Returns the size of this page as reported to the LRU, presumably in bytes. More...
 
unsigned int get_num_frames () const
 Returns the number of frames since the page was first added to its LRU. More...
 
unsigned int get_num_inactive_frames () const
 Returns the number of frames since the page was last accessed on its LRU. More...
 
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. More...
 
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. More...
 
void operator= (const AdaptiveLruPage &copy)
 
virtual void output (std::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. More...
 
virtual void write (std::ostream &out, int indent_level) const
 

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 135 of file adaptiveLru.h.

Member Function Documentation

◆ dequeue_lru()

void AdaptiveLruPage::dequeue_lru ( )
inline

◆ enqueue_lru()

void AdaptiveLruPage::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.

If lru is NULL, it means to remove this page from its LRU.

Definition at line 175 of file adaptiveLru.cxx.

References AdaptiveLru::do_access_page(), and AdaptiveLru::do_remove_page().

Referenced by dequeue_lru(), and mark_used_lru().

◆ evict_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 DXVertexBufferContext9, DXIndexBufferContext9, and DXTextureContext9.

Definition at line 513 of file adaptiveLru.cxx.

References dequeue_lru().

◆ get_lru()

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 128 of file adaptiveLru.I.

◆ get_lru_size()

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 167 of file adaptiveLru.I.

◆ get_num_frames()

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 538 of file adaptiveLru.cxx.

◆ get_num_inactive_frames()

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 550 of file adaptiveLru.cxx.

◆ mark_used_lru() [1/2]

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 148 of file adaptiveLru.I.

Referenced by DXTextureContext9::evict_lru().

◆ mark_used_lru() [2/2]

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 159 of file adaptiveLru.I.

References enqueue_lru().

◆ set_lru_size()

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 176 of file adaptiveLru.I.

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


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