src/Scenery/FGTileLoader.cxx

   1 // FGTileLoader - Queue scenery tiles for loading.
   2 //
   3 // Written by Bernie Bright, started March 2001.
   4 //
   5 // Copyright (C) 2001  Bernard Bright - bbright@bigpond.net.au
   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 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <Main/globals.hxx>
  28 #include "FGTileLoader.hxx"
  29 #include "tileentry.hxx"
  30 #include "tilemgr.hxx"
  31
  32 extern ssgBranch *terrain;
  33 extern ssgBranch *ground;
  34
  35 /**
  36  *
  37  */
  38 FGTileLoader::FGTileLoader()
  39 {
  40 #ifdef ENABLE_THREADS
  41     // Create and start the loader threads.
  42     for (int i = 0; i < MAX_THREADS; ++i)
  43     {
  44         threads[i] = new LoaderThread(this);
  45         threads[i]->start();
  46     }
  47 #endif // ENABLE_THREADS
  48 }
  49
  50 /**
  51  * Terminate all threads.
  52  */
  53 FGTileLoader::~FGTileLoader()
  54 {
  55 #ifdef ENABLE_THREADS
  56     // Wake up its time to die.
  57     // queue_cond.broadcast();
  58
  59     for (int i = 0; i < MAX_THREADS; ++i)
  60     {
  61         threads[i]->cancel();
  62         threads[i]->join();
  63     }
  64 #endif // ENABLE_THREADS
  65 }
  66
  67
  68 #if 0 // we don't ever want to do this I don't think
  69 /**
  70  *
  71  */
  72 void FGTileLoader::reinit() {
  73     while ( !tile_load_queue.empty() ) {
  74         tile_load_queue.pop();
  75     }
  76 }
  77 #endif
  78
  79
  80 /**
  81  *
  82  */
  83 void
  84 FGTileLoader::add( FGTileEntry* tile )
  85 {
  86     /**
  87      * Initialise tile_path here and not in ctor to avoid problems
  88      * with the initialastion order of global objects.
  89      */
  90     static bool beenhere = false;
  91     if (!beenhere)
  92     {
  93         if ( globals->get_fg_scenery() != (string)"" ) {
  94             tile_path.set( globals->get_fg_scenery() );
  95         } else {
  96             tile_path.set( globals->get_fg_root() );
  97             tile_path.append( "Scenery" );
  98         }
  99         beenhere = true;
 100     }
 101
 102     tile_load_queue.push( tile );
 103 }
 104
 105 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 106 /**
 107  *
 108  */
 109 void
 110 FGTileLoader::remove( FGTileEntry* tile )
 111 {
 112     tile_free_queue.push( tile );
 113 }
 114 #endif
 115
 116 /**
 117  *
 118  */
 119 void
 120 FGTileLoader::update()
 121 {
 122 #ifdef ENABLE_THREADS
 123     // send a signal to the pager thread that it is allowed to load
 124     // another tile
 125     mutex.lock();
 126     frame_cond.signal();
 127     mutex.unlock();
 128 #else
 129     if ( !tile_load_queue.empty() ) {
 130         // cout << "loading next tile ..." << endl;
 131         // load the next tile in the queue
 132         FGTileEntry* tile = tile_load_queue.front();
 133         tile_load_queue.pop();
 134         tile->load( tile_path, true );
 135         FGTileMgr::ready_to_attach( tile );
 136     }
 137
 138 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 139     if ( !tile_free_queue.empty() ) {
 140         // cout << "freeing next tile ..." << endl;
 141         // free the next tile in the queue
 142         FGTileEntry* tile = tile_free_queue.front();
 143         tile_free_queue.pop();
 144         tile->free_tile();
 145         delete tile;
 146     }
 147 #endif
 148
 149 #endif // ENABLE_THREADS
 150 }
 151
 152
 153 #ifdef ENABLE_THREADS
 154 /**
 155  *
 156  */
 157 void
 158 FGTileLoader::LoaderThread::run()
 159 {
 160     pthread_cleanup_push( cleanup_handler, loader );
 161     while ( true ) {
 162         // Wait for a load request to be placed in the queue.
 163         FGTileEntry* tile = loader->tile_load_queue.pop();
 164
 165         // Wait for the next frame signal before we load a tile from the queue
 166         loader->mutex.lock();
 167         loader->frame_cond.wait( loader->mutex );
 168         loader->mutex.unlock();
 169
 170         set_cancel( SGThread::CANCEL_DISABLE );
 171         tile->load( loader->tile_path, true );
 172         set_cancel( SGThread::CANCEL_DEFERRED );
 173
 174         FGTileMgr::ready_to_attach( tile );
 175
 176 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 177         // Handle and pending removals
 178         while ( !loader->tile_free_queue.empty() ) {
 179             // cout << "freeing next tile ..." << endl;
 180             // free the next tile in the queue
 181             FGTileEntry* tile = loader->tile_free_queue.pop();
 182             tile->free_tile();
 183             delete tile;
 184         }
 185 #endif
 186
 187     }
 188     pthread_cleanup_pop(1);
 189 }
 190
 191 /**
 192  * Ensure mutex is unlocked.
 193  */
 194 void
 195 cleanup_handler( void* arg )
 196 {
 197     FGTileLoader* loader = (FGTileLoader*) arg;
 198     loader->mutex.unlock();
 199 }
 200 #endif // ENABLE_THREADS