* viking -- GPS Data and Topo Analyzer, Explorer, and Manager
*
* Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
+ * Copyright (c) 2015, Rob Norris <rw_norris@hotmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*/
#include <gtk/gtk.h>
-#include "vikstatus.h"
-#include "background.h"
-#include "gtkcellrendererprogress.h"
+#include <glib/gi18n.h>
-static GtkWidget *bgwindow = NULL;
-static GtkWidget *bgtreeview = NULL;
+#include "background.h"
+#include "settings.h"
+#include "util.h"
+#include "math.h"
+#include "uibuilder.h"
+#include "globals.h"
+#include "preferences.h"
+
+static GThreadPool *thread_pool_remote = NULL;
+static GThreadPool *thread_pool_local = NULL;
+#ifdef HAVE_LIBMAPNIK
+static GThreadPool *thread_pool_local_mapnik = NULL;
+#endif
+static gboolean stop_all_threads = FALSE;
+
+// A single store of background items for all Windows
+// Must always be accessed in the main thread
static GtkListStore *bgstore = NULL;
-static GSList *statusbars_to_update = NULL;
+G_LOCK_DEFINE_STATIC(window_list);
+// Still only actually updating the statusbar though
+static GSList *windows_to_update = NULL;
static gint bgitemcount = 0;
+#define VIK_BG_NUM_ARGS 7
+
enum
{
- TITLE_COLUMN,
+ TITLE_COLUMN = 0,
PROGRESS_COLUMN,
DATA_COLUMN,
N_COLUMNS,
};
-void a_background_update_status ( VikStatusbar *vs, gchar *str )
+void a_background_update_status ( VikWindow *vw, gpointer data )
{
- gdk_threads_enter ();
- vik_statusbar_set_message ( vs, 1, str );
- gdk_threads_leave ();
+ static gchar buf[20];
+ g_snprintf(buf, sizeof(buf), _("%d items"), bgitemcount);
+ vik_window_statusbar_update ( vw, buf, VIK_STATUSBAR_ITEMS );
}
+// NB can be called from any thread
static void background_thread_update ()
{
- static gchar buf[20];
- g_snprintf(buf, sizeof(buf), "%d items", bgitemcount);
- g_slist_foreach ( statusbars_to_update, (GFunc) a_background_update_status, buf );
+ G_LOCK(window_list);
+ g_slist_foreach ( windows_to_update, (GFunc) a_background_update_status, NULL );
+ G_UNLOCK(window_list);
}
-void a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
+typedef struct {
+ GtkTreeIter *iter;
+ gdouble percent;
+} progress_t;
+
+// In main thread
+static gboolean idle_progress_update ( gpointer user_data )
+{
+ progress_t *progress = user_data;
+ if ( bgstore )
+ gtk_list_store_set ( GTK_LIST_STORE(bgstore), progress->iter, PROGRESS_COLUMN, progress->percent, -1 );
+ g_free ( progress );
+ return FALSE;
+}
+
+/**
+ * a_background_thread_progress:
+ * @callbackdata: Thread data
+ * @fraction: The value should be between 0.0 and 1.0 indicating percentage of the task complete
+ *
+ * Called from other threads
+ *
+ * Returns a non zero number if the thread should be terminated
+ */
+int a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
{
gpointer *args = (gpointer *) callbackdata;
- a_background_testcancel ( callbackdata );
- gdk_threads_enter();
- gtk_list_store_set( GTK_LIST_STORE(bgstore), (GtkTreeIter *) args[5], PROGRESS_COLUMN, fraction, -1 );
- gdk_threads_leave();
+ int res = a_background_testcancel ( callbackdata );
+ if (args[5] != NULL) {
+ gdouble myfraction = fabs(fraction);
+ if ( myfraction > 1.0 )
+ myfraction = 1.0;
+ progress_t *progress = g_malloc0 ( sizeof(progress_t) );
+ progress->percent = myfraction * 100;
+ progress->iter = (GtkTreeIter*)args[5];
+ gdk_threads_add_idle ( idle_progress_update, progress );
+ }
args[6] = GINT_TO_POINTER(GPOINTER_TO_INT(args[6])-1);
bgitemcount--;
background_thread_update();
+ return res;
}
-static void thread_die ( gpointer args[6] )
+static void thread_die ( gpointer args[VIK_BG_NUM_ARGS] )
{
vik_thr_free_func userdata_free_func = args[3];
- userdata_free_func ( args[2] );
+ if ( userdata_free_func != NULL )
+ userdata_free_func ( args[2] );
if ( GPOINTER_TO_INT(args[6]) )
{
background_thread_update ();
}
- g_free ( args[5] ); /* free iter */
g_free ( args );
-
- g_thread_exit ( NULL );
}
-void a_background_testcancel ( gpointer callbackdata )
+// Called from other threads
+// Returns a non zero number if the thread should be terminated
+int a_background_testcancel ( gpointer callbackdata )
{
gpointer *args = (gpointer *) callbackdata;
- if ( args[0] )
+ if ( stop_all_threads )
+ return -1;
+ if ( args && args[0] )
{
vik_thr_free_func cleanup = args[4];
if ( cleanup )
cleanup ( args[2] );
- thread_die( args );
+ return -1;
}
+ return 0;
+}
+
+typedef struct {
+ GtkTreeIter *iter;
+} remove_t;
+
+// Called from the main thread
+static gboolean idle_remove ( gpointer user_data )
+{
+ remove_t *remove = user_data;
+ if ( bgstore )
+ gtk_list_store_remove ( bgstore, remove->iter );
+ g_free ( remove->iter );
+ return FALSE;
}
-void thread_helper ( gpointer args[6] )
+// Called from other threads
+static void thread_helper ( gpointer args[VIK_BG_NUM_ARGS], gpointer user_data )
{
/* unpack args */
vik_thr_func func = args[1];
gpointer userdata = args[2];
- func ( userdata, args );
+ g_debug(__FUNCTION__);
- gdk_threads_enter();
- if ( ! args[0] )
- gtk_list_store_remove ( bgstore, (GtkTreeIter *) args[5] );
- gdk_threads_leave();
+ func ( userdata, args );
+ if ( ! args[0] ) {
+ remove_t *remove = g_malloc0 ( sizeof(remove_t) );
+ remove->iter = args[5];
+ gdk_threads_add_idle ( idle_remove, remove );
+ }
thread_die ( args );
}
-void a_background_thread ( 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 )
+/**
+ * a_background_thread:
+ * @bp: Which pool this thread should run in
+ * @parent:
+ * @message:
+ * @func: worker function
+ * @userdata:
+ * @userdata_free_func: free function for userdata
+ * @userdata_cancel_cleanup_func:
+ * @number_items:
+ *
+ * Function to enlist new background function.
+ */
+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 )
{
GtkTreeIter *piter = g_malloc ( sizeof ( GtkTreeIter ) );
- gpointer *args = g_malloc ( sizeof(gpointer) * 7 );
+ gpointer *args = g_malloc ( sizeof(gpointer) * VIK_BG_NUM_ARGS );
+
+ g_debug(__FUNCTION__);
args[0] = GINT_TO_POINTER(0);
args[1] = func;
bgitemcount += number_items;
gtk_list_store_append ( bgstore, piter );
- gtk_list_store_set ( bgstore, piter, TITLE_COLUMN, message, PROGRESS_COLUMN, 0.0, DATA_COLUMN, args, -1 );
+ gtk_list_store_set ( bgstore, piter,
+ TITLE_COLUMN, message,
+ PROGRESS_COLUMN, 0.0,
+ DATA_COLUMN, args,
+ -1 );
/* run the thread in the background */
- g_thread_create( (GThreadFunc) thread_helper, args, FALSE, NULL );
-}
-
-void a_background_show_window ()
-{
- gtk_widget_show_all ( bgwindow );
+ if ( bp == BACKGROUND_POOL_REMOTE )
+ g_thread_pool_push( thread_pool_remote, args, NULL );
+#ifdef HAVE_LIBMAPNIK
+ else if ( bp == BACKGROUND_POOL_LOCAL_MAPNIK )
+ g_thread_pool_push( thread_pool_local_mapnik, args, NULL );
+#endif
+ else
+ g_thread_pool_push( thread_pool_local, args, NULL );
}
+// In main thread
static void cancel_job_with_iter ( GtkTreeIter *piter )
{
gpointer *args;
+
+ g_debug(__FUNCTION__);
+
gtk_tree_model_get( GTK_TREE_MODEL(bgstore), piter, DATA_COLUMN, &args, -1 );
/* we know args still exists because it is free _after_ the list item is destroyed */
args[0] = GINT_TO_POINTER(1); /* set killswitch */
gtk_list_store_remove ( bgstore, piter );
+ g_free ( piter );
+ args[5] = NULL;
}
-static void bgwindow_response (GtkDialog *dialog, gint arg1 )
+// In main thread
+static void bgwindow_response (GtkDialog *dialog, gint response_id, GtkTreeView *bgtreeview )
{
- /* note this function is a signal handler called back from the GTK main loop,
- * so GDK is already locked. We need to release the lock before calling
- * thread-safe routines
- */
- if ( arg1 == 1 ) /* cancel */
+ switch ( response_id ) {
+ case GTK_RESPONSE_DELETE_EVENT:
+ // Delibrate fall through
+ case GTK_RESPONSE_CLOSE:
+ gtk_widget_destroy ( GTK_WIDGET(dialog) );
+ break;
+ case 1: // Delete / Cancel selected item
{
GtkTreeIter iter;
- if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW(bgtreeview) ), NULL, &iter ) )
- cancel_job_with_iter ( &iter );
- gdk_threads_leave();
+ if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection(bgtreeview), NULL, &iter ) )
+ cancel_job_with_iter ( &iter );
background_thread_update();
- gdk_threads_enter();
}
- else if ( arg1 == 2 ) /* clear */
+ break;
+ case 2: // Clear All jobs
{
GtkTreeIter iter;
while ( gtk_tree_model_get_iter_first ( GTK_TREE_MODEL(bgstore), &iter ) )
- cancel_job_with_iter ( &iter );
- gdk_threads_leave();
+ cancel_job_with_iter ( &iter );
background_thread_update();
- gdk_threads_enter();
}
- else /* OK */
- gtk_widget_hide ( bgwindow );
+ default: break;
+ }
+}
+
+#define VIK_SETTINGS_BACKGROUND_MAX_THREADS "background_max_threads"
+#define VIK_SETTINGS_BACKGROUND_MAX_THREADS_LOCAL "background_max_threads_local"
+
+#ifdef HAVE_LIBMAPNIK
+VikLayerParamScale params_threads[] = { {1, 64, 1, 0} }; // 64 threads should be enough for anyone...
+// implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
+static VikLayerParam prefs_mapnik[] = {
+ { 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,
+ 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 },
+};
+#endif
+
+/**
+ * a_background_init:
+ *
+ * Just setup any preferences.
+ */
+void a_background_init ()
+{
+#ifdef HAVE_LIBMAPNIK
+ VikLayerParamData tmp;
+ // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
+ tmp.u = 1; // Default to 1 thread due to potential crashing issues
+ a_preferences_register(&prefs_mapnik[0], tmp, "mapnik");
+#endif
+}
+
+/**
+ * a_background_post_init:
+ *
+ * Initialize background feature.
+ */
+void a_background_post_init()
+{
+ // initialize thread pools
+ gint max_threads = 10; /* limit maximum number of threads running at one time */
+ gint maxt;
+ if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS, &maxt ) )
+ max_threads = maxt;
+
+ thread_pool_remote = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
+
+ if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS_LOCAL, &maxt ) )
+ max_threads = maxt;
+ else {
+ guint cpus = util_get_number_of_cpus ();
+ max_threads = cpus > 1 ? cpus-1 : 1; // Don't use all available CPUs!
+ }
+
+ thread_pool_local = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
+
+#ifdef HAVE_LIBMAPNIK
+ // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
+ guint mapnik_threads = a_preferences_get("mapnik.background_max_threads_local_mapnik")->u;
+ thread_pool_local_mapnik = g_thread_pool_new ( (GFunc) thread_helper, NULL, mapnik_threads, FALSE, NULL );
+#endif
+
+ bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
}
-void a_background_init()
+/**
+ * a_background_show_window:
+ *
+ * Display the background window.
+ */
+void a_background_show_window ()
{
+ GtkWidget *bgwindow = NULL;
+ GtkWidget *bgtreeview = NULL;
GtkCellRenderer *renderer;
GtkTreeViewColumn *column;
GtkWidget *scrolled_window;
/* store & treeview */
- bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
bgtreeview = gtk_tree_view_new_with_model ( GTK_TREE_MODEL(bgstore) );
gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (bgtreeview), TRUE);
gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (bgtreeview)),
/* add columns */
renderer = gtk_cell_renderer_text_new ();
- column = gtk_tree_view_column_new_with_attributes ( "Job", renderer, "text", TITLE_COLUMN, NULL );
+ column = gtk_tree_view_column_new_with_attributes ( _("Job"), renderer, "text", TITLE_COLUMN, NULL );
gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
renderer = gtk_cell_renderer_progress_new ();
- column = gtk_tree_view_column_new_with_attributes ( "Progress", renderer, "percentage", PROGRESS_COLUMN, NULL );
+ column = gtk_tree_view_column_new_with_attributes ( _("Progress"), renderer, "value", PROGRESS_COLUMN, NULL );
gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
/* setup window */
gtk_container_add ( GTK_CONTAINER(scrolled_window), bgtreeview );
gtk_scrolled_window_set_policy ( GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
- bgwindow = gtk_dialog_new_with_buttons ( "", NULL, 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_DELETE, 1, GTK_STOCK_CLEAR, 2, NULL );
- gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(bgwindow)->vbox), scrolled_window, TRUE, TRUE, 0 );
+ 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 );
+ gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
+ GtkWidget *response_w = NULL;
+#if GTK_CHECK_VERSION (2, 20, 0)
+ response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
+#endif
+ gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(bgwindow))), scrolled_window, TRUE, TRUE, 0 );
gtk_window_set_default_size ( GTK_WINDOW(bgwindow), 400, 400 );
- gtk_window_set_title ( GTK_WINDOW(bgwindow), "Viking Background Jobs" );
- /* don't destroy win */
- g_signal_connect ( G_OBJECT(bgwindow), "delete-event", G_CALLBACK(gtk_widget_hide_on_delete), NULL );
+ if ( response_w )
+ gtk_widget_grab_focus ( response_w );
+
+ g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), GTK_TREE_VIEW(bgtreeview) );
- g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), 0 );
+ gtk_widget_show_all ( bgwindow );
+ gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_CLOSE );
}
-void a_background_add_status(VikStatusbar *vs)
+/**
+ * a_background_uninit:
+ *
+ * Uninitialize background feature.
+ */
+void a_background_uninit()
{
- statusbars_to_update = g_slist_prepend(statusbars_to_update,vs);
+ stop_all_threads = TRUE;
+ // Don't wait for these threads to complete - i.e. end now.
+ g_thread_pool_free ( thread_pool_remote, TRUE, FALSE );
+ g_thread_pool_free ( thread_pool_local, TRUE, FALSE );
+#ifdef HAVE_LIBMAPNIK
+ g_thread_pool_free ( thread_pool_local_mapnik, TRUE, FALSE );
+#endif
+ gtk_list_store_clear ( bgstore );
+ g_object_unref ( bgstore );
+ bgstore = NULL;
}
-void a_background_remove_status(VikStatusbar *vs)
+void a_background_add_window (VikWindow *vw)
{
- statusbars_to_update = g_slist_remove(statusbars_to_update,vs);
+ G_LOCK(window_list);
+ windows_to_update = g_slist_prepend(windows_to_update,vw);
+ G_UNLOCK(window_list);
}
+void a_background_remove_window (VikWindow *vw)
+{
+ G_LOCK(window_list);
+ windows_to_update = g_slist_remove(windows_to_update,vw);
+ G_UNLOCK(window_list);
+}
projects / andy / viking.git / blobdiff