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