src/Scenery/newcache.cxx

   1 // newcache.cxx -- routines to handle scenery tile caching
   2 //
   3 // Written by Curtis Olson, started December 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson  - curt@flightgear.org
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #ifdef HAVE_WINDOWS_H
  29 #  include <windows.h>
  30 #endif
  31
  32 #include <GL/glut.h>
  33 #include <GL/gl.h>
  34
  35 #include <plib/ssg.h>           // plib include
  36
  37 #include <simgear/bucket/newbucket.hxx>
  38 #include <simgear/debug/logstream.hxx>
  39 #include <simgear/misc/sg_path.hxx>
  40
  41 #include <Main/globals.hxx>
  42 #include <Main/viewer.hxx>
  43 #include <Scenery/scenery.hxx>  // for scenery.center
  44
  45 #include "newcache.hxx"
  46 #include "tileentry.hxx"
  47
  48
  49 SG_USING_NAMESPACE(std);
  50
  51
  52 // Constructor
  53 FGNewCache::FGNewCache( void ) :
  54     max_cache_size(100)
  55 {
  56     tile_cache.clear();
  57 }
  58
  59
  60 // Destructor
  61 FGNewCache::~FGNewCache( void ) {
  62 }
  63
  64
  65 // Free a tile cache entry
  66 void FGNewCache::entry_free( long cache_index ) {
  67     SG_LOG( SG_TERRAIN, SG_DEBUG, "FREEING CACHE ENTRY = " << cache_index );
  68     FGTileEntry *tile = tile_cache[cache_index];
  69     tile->disconnect_ssg_nodes();
  70
  71 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
  72     tile->sched_removal();
  73 #else
  74     tile->free_tile();
  75     delete tile;
  76 #endif
  77
  78     tile_cache.erase( cache_index );
  79 }
  80
  81
  82 // Initialize the tile cache subsystem
  83 void FGNewCache::init( void ) {
  84     SG_LOG( SG_TERRAIN, SG_INFO, "Initializing the tile cache." );
  85
  86     SG_LOG( SG_TERRAIN, SG_INFO, "  max cache size = "
  87             << max_cache_size );
  88     SG_LOG( SG_TERRAIN, SG_INFO, "  current cache size = "
  89             << tile_cache.size() );
  90
  91 #if 0 // don't clear the cache
  92     clear_cache();
  93 #endif
  94
  95     SG_LOG( SG_TERRAIN, SG_INFO, "  done with init()"  );
  96 }
  97
  98
  99 // Search for the specified "bucket" in the cache
 100 bool FGNewCache::exists( const SGBucket& b ) const {
 101     long tile_index = b.gen_index();
 102     const_tile_map_iterator it = tile_cache.find( tile_index );
 103
 104     return ( it != tile_cache.end() );
 105 }
 106
 107
 108 // Ensure at least one entry is free in the cache
 109 bool FGNewCache::make_space() {
 110     SG_LOG( SG_TERRAIN, SG_DEBUG, "Make space in cache" );
 111     SG_LOG( SG_TERRAIN, SG_DEBUG, "cache entries = " << tile_cache.size() );
 112     SG_LOG( SG_TERRAIN, SG_DEBUG, "max size = " << max_cache_size );
 113
 114     if ( (int)tile_cache.size() < max_cache_size ) {
 115         // space in the cache, return
 116         return true;
 117     }
 118
 119     while ( (int)tile_cache.size() >= max_cache_size ) {
 120         sgdVec3 abs_view_pos;
 121         float dist;
 122         double timestamp = 0.0;
 123         int max_index = -1;
 124         double min_time = 2419200000.0f;  // one month should be enough
 125         double max_time = 0;
 126
 127         // we need to free the furthest entry
 128         tile_map_iterator current = tile_cache.begin();
 129         tile_map_iterator end = tile_cache.end();
 130
 131         for ( ; current != end; ++current ) {
 132             long index = current->first;
 133             FGTileEntry *e = current->second;
 134             if ( e->is_loaded() && (e->get_pending_models() == 0) ) {
 135
 136                 timestamp = e->get_timestamp();
 137                 if ( timestamp < min_time ) {
 138                     max_index = index;
 139                     min_time = timestamp;
 140                 }
 141                 if ( timestamp > max_time ) {
 142                     max_time = timestamp;
 143                 }
 144
 145             } else {
 146                 SG_LOG( SG_TERRAIN, SG_INFO, "loaded = " << e->is_loaded()
 147                         << " pending models = " << e->get_pending_models()
 148                         << " time stamp = " << e->get_timestamp() );
 149             }
 150         }
 151
 152         // If we made it this far, then there were no open cache entries.
 153         // We will instead free the oldest cache entry and return true
 154
 155         SG_LOG( SG_TERRAIN, SG_INFO, "    min_time = " << min_time );
 156         SG_LOG( SG_TERRAIN, SG_INFO, "    index = " << max_index );
 157         SG_LOG( SG_TERRAIN, SG_INFO, "    max_time = " << max_time );
 158         if ( max_index >= 0 ) {
 159             entry_free( max_index );
 160             return true;
 161         } else {
 162             SG_LOG( SG_TERRAIN, SG_ALERT, "WHOOPS!!! can't make_space(), tile "
 163                     "cache is full, but no entries available for removal." );
 164             return false;
 165         }
 166     }
 167
 168     SG_LOG( SG_TERRAIN, SG_ALERT, "WHOOPS!!! Hit an unhandled condition in  "
 169             "FGNewCache::make_space()." );
 170     return false;
 171 }
 172
 173
 174 // Return the index of the oldest tile in the cache, return -1 if
 175 // nothing available to be removed.
 176 long FGNewCache::get_oldest_tile() {
 177     // we need to free the furthest entry
 178     long max_index = -1;
 179     double timestamp = 0.0;
 180     double min_time = 2419200000.0f; // one month should be enough
 181     double max_time = 0;
 182
 183     tile_map_iterator current = tile_cache.begin();
 184     tile_map_iterator end = tile_cache.end();
 185
 186     for ( ; current != end; ++current ) {
 187         long index = current->first;
 188         FGTileEntry *e = current->second;
 189         if ( e->is_loaded() && (e->get_pending_models() == 0) ) {
 190
 191             timestamp = e->get_timestamp();
 192             if ( timestamp < min_time ) {
 193                 max_index = index;
 194                 min_time = timestamp;
 195             }
 196             if ( timestamp > max_time ) {
 197                 max_time = timestamp;
 198             }
 199
 200         } else {
 201             SG_LOG( SG_TERRAIN, SG_DEBUG, "loaded = " << e->is_loaded()
 202                     << " pending models = " << e->get_pending_models()
 203                     << " time stamp = " << e->get_timestamp() );
 204         }
 205     }
 206
 207     SG_LOG( SG_TERRAIN, SG_INFO, "    min_time = " << min_time );
 208     SG_LOG( SG_TERRAIN, SG_INFO, "    index = " << max_index );
 209     SG_LOG( SG_TERRAIN, SG_INFO, "    max_time = " << max_time );
 210
 211     return max_index;
 212 }
 213
 214
 215 // Clear a cache entry, note that the cache only holds pointers
 216 // and this does not free the object which is pointed to.
 217 void FGNewCache::clear_entry( long cache_index ) {
 218     tile_cache.erase( cache_index );
 219 }
 220
 221
 222 // Clear all completely loaded tiles (ignores partially loaded tiles)
 223 void FGNewCache::clear_cache() {
 224
 225     tile_map_iterator current = tile_cache.begin();
 226     tile_map_iterator end = tile_cache.end();
 227
 228     for ( ; current != end; ++current ) {
 229         long index = current->first;
 230         SG_LOG( SG_TERRAIN, SG_DEBUG, "clearing " << index );
 231         FGTileEntry *e = current->second;
 232         if ( e->is_loaded() && (e->get_pending_models() == 0) ) {
 233             e->tile_bucket.make_bad();
 234             entry_free(index);
 235         }
 236     }
 237
 238     // and ... just in case we missed something ...
 239     globals->get_scenery()->get_terrain_branch()->removeAllKids();
 240 }
 241
 242
 243 /**
 244  * Create a new tile and schedule it for loading.
 245  */
 246 bool FGNewCache::insert_tile( FGTileEntry *e ) {
 247     // set time of insertion for tracking age of tiles...
 248     e->set_timestamp(globals->get_sim_time_sec());
 249     // clear out a distant entry in the cache if needed.
 250     if ( make_space() ) {
 251         // register it in the cache
 252         long tile_index = e->get_tile_bucket().gen_index();
 253         tile_cache[tile_index] = e;
 254
 255         return true;
 256     } else {
 257         // failed to find cache space
 258
 259         return false;
 260     }
 261 }
 262
 263 // Note this is the old version of FGNewCache::make_space(), currently disabled
 264 // It uses distance from a center point to determine tiles to be discarded...
 265 #if 0
 266 // Ensure at least one entry is free in the cache
 267 bool FGNewCache::make_space() {
 268     SG_LOG( SG_TERRAIN, SG_DEBUG, "Make space in cache" );
 269     SG_LOG( SG_TERRAIN, SG_DEBUG, "cache entries = " << tile_cache.size() );
 270     SG_LOG( SG_TERRAIN, SG_DEBUG, "max size = " << max_cache_size );
 271
 272     if ( (int)tile_cache.size() < max_cache_size ) {
 273         // space in the cache, return
 274         return true;
 275     }
 276
 277     while ( (int)tile_cache.size() >= max_cache_size ) {
 278         sgdVec3 abs_view_pos;
 279         float dist;
 280         float max_dist = 0.0;
 281         int max_index = -1;
 282
 283         // we need to free the furthest entry
 284         tile_map_iterator current = tile_cache.begin();
 285         tile_map_iterator end = tile_cache.end();
 286
 287         for ( ; current != end; ++current ) {
 288             long index = current->first;
 289             FGTileEntry *e = current->second;
 290
 291             if ( e->is_loaded() && (e->get_pending_models() == 0) ) {
 292                 // calculate approximate distance from view point
 293                 sgdCopyVec3( abs_view_pos,
 294                              globals->get_current_view()->get_absolute_view_pos() );
 295
 296                 SG_LOG( SG_TERRAIN, SG_DEBUG, "DIST Abs view pos = "
 297                         << abs_view_pos[0] << ","
 298                         << abs_view_pos[1] << ","
 299                         << abs_view_pos[2] );
 300                 SG_LOG( SG_TERRAIN, SG_DEBUG,
 301                         "    ref point = " << e->center );
 302
 303                 sgdVec3 center;
 304                 sgdSetVec3( center,
 305                             e->center.x(), e->center.y(), e->center.z() );
 306                 dist = sgdDistanceVec3( center, abs_view_pos );
 307
 308                 SG_LOG( SG_TERRAIN, SG_DEBUG, "    distance = " << dist );
 309
 310                 if ( dist > max_dist ) {
 311                     max_dist = dist;
 312                     max_index = index;
 313                 }
 314             } else {
 315                 SG_LOG( SG_TERRAIN, SG_INFO, "loaded = " << e->is_loaded()
 316                         << " pending models = " << e->get_pending_models() );
 317             }
 318         }
 319
 320         // If we made it this far, then there were no open cache entries.
 321         // We will instead free the furthest cache entry and return true
 322
 323         SG_LOG( SG_TERRAIN, SG_INFO, "    max_dist = " << max_dist );
 324         SG_LOG( SG_TERRAIN, SG_INFO, "    index = " << max_index );
 325         if ( max_index >= 0 ) {
 326             entry_free( max_index );
 327             return true;
 328         } else {
 329             SG_LOG( SG_TERRAIN, SG_ALERT, "WHOOPS!!! can't make_space(), tile "
 330                     "cache is full, but no entries available for removal." );
 331             return false;
 332         }
 333     }
 334
 335     SG_LOG( SG_TERRAIN, SG_ALERT, "WHOOPS!!! Hit an unhandled condition in  "
 336             "FGNewCache::make_space()." );
 337     return false;
 338 }
 339 #endif
 340
 341