src/background.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  * Copyright (c) 2015, Rob Norris <rw_norris@hotmail.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  */
  22
  23 #include <gtk/gtk.h>
  24 #include <glib/gi18n.h>
  25
  26 #include "background.h"
  27 #include "settings.h"
  28 #include "util.h"
  29 #include "math.h"
  30 #include "uibuilder.h"
  31 #include "globals.h"
  32 #include "preferences.h"
  33
  34 static GThreadPool *thread_pool_remote = NULL;
  35 static GThreadPool *thread_pool_local = NULL;
  36 #ifdef HAVE_LIBMAPNIK
  37 static GThreadPool *thread_pool_local_mapnik = NULL;
  38 #endif
  39 static gboolean stop_all_threads = FALSE;
  40
  41 // A single store of background items for all Windows
  42 // Must always be accessed in the main thread
  43 static GtkListStore *bgstore = NULL;
  44
  45 G_LOCK_DEFINE_STATIC(window_list);
  46 // Still only actually updating the statusbar though
  47 static GSList *windows_to_update = NULL;
  48
  49 static gint bgitemcount = 0;
  50
  51 #define VIK_BG_NUM_ARGS 7
  52
  53 enum
  54 {
  55   TITLE_COLUMN = 0,
  56   PROGRESS_COLUMN,
  57   DATA_COLUMN,
  58   N_COLUMNS,
  59 };
  60
  61 void a_background_update_status ( VikWindow *vw, gpointer data )
  62 {
  63   static gchar buf[20];
  64   g_snprintf(buf, sizeof(buf), _("%d items"), bgitemcount);
  65   vik_window_statusbar_update ( vw, buf, VIK_STATUSBAR_ITEMS );
  66 }
  67
  68 // NB can be called from any thread
  69 static void background_thread_update ()
  70 {
  71   G_LOCK(window_list);
  72   g_slist_foreach ( windows_to_update, (GFunc) a_background_update_status, NULL );
  73   G_UNLOCK(window_list);
  74 }
  75
  76 typedef struct {
  77   GtkTreeIter *iter;
  78   gdouble percent;
  79 } progress_t;
  80
  81 // In main thread
  82 static gboolean idle_progress_update ( gpointer user_data )
  83 {
  84   progress_t *progress = user_data;
  85   if ( bgstore )
  86     gtk_list_store_set ( GTK_LIST_STORE(bgstore), progress->iter, PROGRESS_COLUMN, progress->percent, -1 );
  87   g_free ( progress );
  88   return FALSE;
  89 }
  90
  91 /**
  92  * a_background_thread_progress:
  93  * @callbackdata: Thread data
  94  * @fraction:     The value should be between 0.0 and 1.0 indicating percentage of the task complete
  95  *
  96  * Called from other threads
  97  *
  98  * Returns a non zero number if the thread should be terminated
  99  */
 100 int a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
 101 {
 102   gpointer *args = (gpointer *) callbackdata;
 103   int res = a_background_testcancel ( callbackdata );
 104   if (args[5] != NULL) {
 105     gdouble myfraction = fabs(fraction);
 106     if ( myfraction > 1.0 )
 107       myfraction = 1.0;
 108     progress_t *progress = g_malloc0 ( sizeof(progress_t) );
 109     progress->percent = myfraction * 100;
 110     progress->iter = (GtkTreeIter*)args[5];
 111     gdk_threads_add_idle ( idle_progress_update, progress );
 112   }
 113
 114   args[6] = GINT_TO_POINTER(GPOINTER_TO_INT(args[6])-1);
 115   bgitemcount--;
 116   background_thread_update();
 117   return res;
 118 }
 119
 120 static void thread_die ( gpointer args[VIK_BG_NUM_ARGS] )
 121 {
 122   vik_thr_free_func userdata_free_func = args[3];
 123
 124   if ( userdata_free_func != NULL )
 125     userdata_free_func ( args[2] );
 126
 127   if ( GPOINTER_TO_INT(args[6]) )
 128   {
 129     bgitemcount -= GPOINTER_TO_INT(args[6]);
 130     background_thread_update ();
 131   }
 132
 133   g_free ( args );
 134 }
 135
 136 // Called from other threads
 137 // Returns a non zero number if the thread should be terminated
 138 int a_background_testcancel ( gpointer callbackdata )
 139 {
 140   gpointer *args = (gpointer *) callbackdata;
 141   if ( stop_all_threads )
 142     return -1;
 143   if ( args && args[0] )
 144   {
 145     vik_thr_free_func cleanup = args[4];
 146     if ( cleanup )
 147       cleanup ( args[2] );
 148     return -1;
 149   }
 150   return 0;
 151 }
 152
 153 typedef struct {
 154   GtkTreeIter *iter;
 155 } remove_t;
 156
 157 // Called from the main thread
 158 static gboolean idle_remove ( gpointer user_data )
 159 {
 160   remove_t *remove = user_data;
 161   if ( bgstore )
 162     gtk_list_store_remove ( bgstore, remove->iter );
 163   g_free ( remove->iter );
 164   return FALSE;
 165 }
 166
 167 // Called from other threads
 168 static void thread_helper ( gpointer args[VIK_BG_NUM_ARGS], gpointer user_data )
 169 {
 170   /* unpack args */
 171   vik_thr_func func = args[1];
 172   gpointer userdata = args[2];
 173
 174   g_debug(__FUNCTION__);
 175
 176   func ( userdata, args );
 177
 178   if ( ! args[0] ) {
 179     remove_t *remove = g_malloc0 ( sizeof(remove_t) );
 180     remove->iter = args[5];
 181     gdk_threads_add_idle ( idle_remove, remove );
 182   }
 183   thread_die ( args );
 184 }
 185
 186 /**
 187  * a_background_thread:
 188  * @bp:      Which pool this thread should run in
 189  * @parent:
 190  * @message:
 191  * @func: worker function
 192  * @userdata:
 193  * @userdata_free_func: free function for userdata
 194  * @userdata_cancel_cleanup_func:
 195  * @number_items:
 196  *
 197  * Function to enlist new background function.
 198  */
 199 void a_background_thread ( Background_Pool_Type bp, GtkWindow *parent, const gchar *message, vik_thr_func func, gpointer userdata, vik_thr_free_func userdata_free_func, vik_thr_free_func userdata_cancel_cleanup_func, gint number_items )
 200 {
 201   GtkTreeIter *piter = g_malloc ( sizeof ( GtkTreeIter ) );
 202   gpointer *args = g_malloc ( sizeof(gpointer) * VIK_BG_NUM_ARGS );
 203
 204   g_debug(__FUNCTION__);
 205
 206   args[0] = GINT_TO_POINTER(0);
 207   args[1] = func;
 208   args[2] = userdata;
 209   args[3] = userdata_free_func;
 210   args[4] = userdata_cancel_cleanup_func;
 211   args[5] = piter;
 212   args[6] = GINT_TO_POINTER(number_items);
 213
 214   bgitemcount += number_items;
 215
 216   gtk_list_store_append ( bgstore, piter );
 217   gtk_list_store_set ( bgstore, piter,
 218                        TITLE_COLUMN, message,
 219                        PROGRESS_COLUMN, 0.0,
 220                        DATA_COLUMN, args,
 221                        -1 );
 222
 223   /* run the thread in the background */
 224   if ( bp == BACKGROUND_POOL_REMOTE )
 225     g_thread_pool_push( thread_pool_remote, args, NULL );
 226 #ifdef HAVE_LIBMAPNIK
 227   else if ( bp == BACKGROUND_POOL_LOCAL_MAPNIK )
 228     g_thread_pool_push( thread_pool_local_mapnik, args, NULL );
 229 #endif
 230   else
 231     g_thread_pool_push( thread_pool_local, args, NULL );
 232 }
 233
 234 // In main thread
 235 static void cancel_job_with_iter ( GtkTreeIter *piter )
 236 {
 237     gpointer *args;
 238
 239     g_debug(__FUNCTION__);
 240
 241     gtk_tree_model_get( GTK_TREE_MODEL(bgstore), piter, DATA_COLUMN, &args, -1 );
 242
 243     /* we know args still exists because it is free _after_ the list item is destroyed */
 244     /* need MUTEX ? */
 245     args[0] = GINT_TO_POINTER(1); /* set killswitch */
 246
 247     gtk_list_store_remove ( bgstore, piter );
 248     g_free ( piter );
 249     args[5] = NULL;
 250 }
 251
 252 // In main thread
 253 static void bgwindow_response (GtkDialog *dialog, gint response_id, GtkTreeView *bgtreeview )
 254 {
 255   switch ( response_id ) {
 256   case GTK_RESPONSE_DELETE_EVENT:
 257     // Delibrate fall through
 258   case GTK_RESPONSE_CLOSE:
 259     gtk_widget_destroy ( GTK_WIDGET(dialog) );
 260     break;
 261   case 1: // Delete / Cancel selected item
 262     {
 263       GtkTreeIter iter;
 264       if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection(bgtreeview), NULL, &iter ) )
 265         cancel_job_with_iter ( &iter );
 266       background_thread_update();
 267     }
 268     break;
 269   case 2: // Clear All jobs
 270     {
 271       GtkTreeIter iter;
 272       while ( gtk_tree_model_get_iter_first ( GTK_TREE_MODEL(bgstore), &iter ) )
 273         cancel_job_with_iter ( &iter );
 274       background_thread_update();
 275     }
 276     default: break;
 277   }
 278 }
 279
 280 #define VIK_SETTINGS_BACKGROUND_MAX_THREADS "background_max_threads"
 281 #define VIK_SETTINGS_BACKGROUND_MAX_THREADS_LOCAL "background_max_threads_local"
 282
 283 #ifdef HAVE_LIBMAPNIK
 284 VikLayerParamScale params_threads[] = { {1, 64, 1, 0} }; // 64 threads should be enough for anyone...
 285 // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
 286 static VikLayerParam prefs_mapnik[] = {
 287   { VIK_LAYER_NUM_TYPES, "mapnik.background_max_threads_local_mapnik", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Threads:"), VIK_LAYER_WIDGET_SPINBUTTON, params_threads, NULL,
 288     N_("Number of threads to use for Mapnik tasks. You need to restart Viking for a change to this value to be used"), NULL, NULL, NULL },
 289 };
 290 #endif
 291
 292 /**
 293  * a_background_init:
 294  *
 295  * Just setup any preferences.
 296  */
 297 void a_background_init ()
 298 {
 299 #ifdef HAVE_LIBMAPNIK
 300   VikLayerParamData tmp;
 301   // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
 302   tmp.u = 1; // Default to 1 thread due to potential crashing issues
 303   a_preferences_register(&prefs_mapnik[0], tmp, "mapnik");
 304 #endif
 305 }
 306
 307 /**
 308  * a_background_post_init:
 309  *
 310  * Initialize background feature.
 311  */
 312 void a_background_post_init()
 313 {
 314   // initialize thread pools
 315   gint max_threads = 10;  /* limit maximum number of threads running at one time */
 316   gint maxt;
 317   if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS, &maxt ) )
 318     max_threads = maxt;
 319
 320   thread_pool_remote = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
 321
 322   if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS_LOCAL, &maxt ) )
 323     max_threads = maxt;
 324   else {
 325     guint cpus = util_get_number_of_cpus ();
 326     max_threads = cpus > 1 ? cpus-1 : 1; // Don't use all available CPUs!
 327   }
 328
 329   thread_pool_local = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
 330
 331 #ifdef HAVE_LIBMAPNIK
 332   // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
 333   guint mapnik_threads = a_preferences_get("mapnik.background_max_threads_local_mapnik")->u;
 334   thread_pool_local_mapnik = g_thread_pool_new ( (GFunc) thread_helper, NULL, mapnik_threads, FALSE, NULL );
 335 #endif
 336
 337   bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
 338 }
 339
 340 /**
 341  * a_background_show_window:
 342  *
 343  * Display the background window.
 344  */
 345 void a_background_show_window ()
 346 {
 347   GtkWidget *bgwindow = NULL;
 348   GtkWidget *bgtreeview = NULL;
 349   GtkCellRenderer *renderer;
 350   GtkTreeViewColumn *column;
 351   GtkWidget *scrolled_window;
 352
 353   /* store & treeview */
 354   bgtreeview = gtk_tree_view_new_with_model ( GTK_TREE_MODEL(bgstore) );
 355   gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (bgtreeview), TRUE);
 356   gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (bgtreeview)),
 357                                GTK_SELECTION_SINGLE);
 358
 359   /* add columns */
 360   renderer = gtk_cell_renderer_text_new ();
 361   column = gtk_tree_view_column_new_with_attributes ( _("Job"), renderer, "text", TITLE_COLUMN, NULL );
 362   gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
 363
 364   renderer = gtk_cell_renderer_progress_new ();
 365   column = gtk_tree_view_column_new_with_attributes ( _("Progress"), renderer, "value", PROGRESS_COLUMN, NULL );
 366   gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
 367
 368   /* setup window */
 369   scrolled_window = gtk_scrolled_window_new ( NULL, NULL );
 370   gtk_container_add ( GTK_CONTAINER(scrolled_window), bgtreeview );
 371   gtk_scrolled_window_set_policy ( GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
 372
 373   bgwindow = gtk_dialog_new_with_buttons ( _("Viking Background Jobs"), NULL, 0, GTK_STOCK_CLOSE, GTK_RESPONSE_CLOSE, GTK_STOCK_DELETE, 1, GTK_STOCK_CLEAR, 2, NULL );
 374   gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
 375   GtkWidget *response_w = NULL;
 376 #if GTK_CHECK_VERSION (2, 20, 0)
 377   response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
 378 #endif
 379   gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(bgwindow))), scrolled_window, TRUE, TRUE, 0 );
 380   gtk_window_set_default_size ( GTK_WINDOW(bgwindow), 400, 400 );
 381   if ( response_w )
 382     gtk_widget_grab_focus ( response_w );
 383
 384   g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), GTK_TREE_VIEW(bgtreeview) );
 385
 386   gtk_widget_show_all ( bgwindow );
 387
 388   gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_CLOSE );
 389 }
 390
 391 /**
 392  * a_background_uninit:
 393  *
 394  * Uninitialize background feature.
 395  */
 396 void a_background_uninit()
 397 {
 398   stop_all_threads = TRUE;
 399   // Don't wait for these threads to complete - i.e. end now.
 400   g_thread_pool_free ( thread_pool_remote, TRUE, FALSE );
 401   g_thread_pool_free ( thread_pool_local, TRUE, FALSE );
 402 #ifdef HAVE_LIBMAPNIK
 403   g_thread_pool_free ( thread_pool_local_mapnik, TRUE, FALSE );
 404 #endif
 405   gtk_list_store_clear ( bgstore );
 406   g_object_unref ( bgstore );
 407   bgstore = NULL;
 408 }
 409
 410 void a_background_add_window (VikWindow *vw)
 411 {
 412   G_LOCK(window_list);
 413   windows_to_update = g_slist_prepend(windows_to_update,vw);
 414   G_UNLOCK(window_list);
 415 }
 416
 417 void a_background_remove_window (VikWindow *vw)
 418 {
 419   G_LOCK(window_list);
 420   windows_to_update = g_slist_remove(windows_to_update,vw);
 421   G_UNLOCK(window_list);
 422 }