ltt/branches/poly/lttv/lttv/main.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Michel Dagenais
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License Version 2 as
   6  * published by the Free Software Foundation;
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16  * MA 02111-1307, USA.
  17  */
  18
  19
  20 #include <lttv/hook.h>
  21 #include <lttv/module.h>
  22 #include <lttv/lttv.h>
  23 #include <lttv/iattribute.h>
  24 #include <lttv/attribute.h>
  25 #include <lttv/option.h>
  26 #include <lttv/traceset.h>
  27 #include <ltt/trace.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30
  31
  32 /* The main program maintains a few central data structures and relies
  33    on modules for the rest. These data structures may be accessed by modules
  34    through an exported API */
  35
  36 static LttvIAttribute *attributes;
  37
  38 static LttvHooks
  39   *before_options,
  40   *after_options,
  41   *before_main,
  42   *after_main;
  43
  44 static char
  45   *a_module,
  46   *a_module_path;
  47
  48 static gboolean
  49   a_verbose,
  50   a_debug,
  51   a_fatal;
  52
  53 gboolean lttv_profile_memory;
  54
  55 int lttv_argc;
  56
  57 char **lttv_argv;
  58
  59 static void lttv_module_option(void *hook_data);
  60
  61 static void lttv_module_path_option(void *hook_data);
  62
  63 static void lttv_verbose(void *hook_data);
  64
  65 static void lttv_debug(void *hook_data);
  66
  67 static void lttv_fatal(void *hook_data);
  68
  69 static void lttv_help(void *hook_data);
  70
  71 /* This is the handler to specify when we dont need all the debugging
  72    messages. It receives the message and does nothing. */
  73
  74 void ignore_and_drop_message(const gchar *log_domain, GLogLevelFlags log_level,
  75     const gchar *message, gpointer user_data) {
  76 }
  77
  78
  79 /* Since everything is done in modules, the main program only takes care
  80    of the infrastructure. */
  81
  82 int main(int argc, char **argv) {
  83
  84   int i;
  85
  86   char
  87     *profile_memory_short_option = "-M",
  88     *profile_memory_long_option = "--memory";
  89
  90   gboolean profile_memory = FALSE;
  91
  92   LttvAttributeValue value;
  93
  94   lttv_argc = argc;
  95   lttv_argv = argv;
  96
  97   /* Before anything else, check if memory profiling is requested */
  98
  99   for(i = 1 ; i < argc ; i++) {
 100     if(*(argv[i]) != '-') break;
 101     if(strcmp(argv[i], profile_memory_short_option) == 0 ||
 102        strcmp(argv[i], profile_memory_long_option) == 0) {
 103       g_mem_set_vtable(glib_mem_profiler_table);
 104       g_message("Memory summary before main");
 105       g_mem_profile();
 106       profile_memory = TRUE;
 107       break;
 108     }
 109   }
 110
 111
 112   /* Initialize glib and by default ignore info and debug messages */
 113
 114   g_type_init();
 115   //g_type_init_with_debug_flags (G_TYPE_DEBUG_OBJECTS | G_TYPE_DEBUG_SIGNALS);
 116   g_log_set_handler(NULL, G_LOG_LEVEL_INFO, ignore_and_drop_message, NULL);
 117   g_log_set_handler(NULL, G_LOG_LEVEL_DEBUG, ignore_and_drop_message, NULL);
 118
 119
 120   /* Have an attributes subtree to store hooks to be registered by modules. */
 121
 122   attributes = LTTV_IATTRIBUTE(g_object_new(LTTV_ATTRIBUTE_TYPE, NULL));
 123
 124   before_options = lttv_hooks_new();
 125   after_options = lttv_hooks_new();
 126   before_main = lttv_hooks_new();
 127   after_main = lttv_hooks_new();
 128
 129
 130   /* Create a number of hooks lists */
 131
 132   g_assert(lttv_iattribute_find_by_path(attributes, "hooks/options/before",
 133       LTTV_POINTER, &value));
 134   *(value.v_pointer) = before_options;
 135   g_assert(lttv_iattribute_find_by_path(attributes, "hooks/options/after",
 136       LTTV_POINTER, &value));
 137   *(value.v_pointer) = after_options;
 138   g_assert(lttv_iattribute_find_by_path(attributes, "hooks/main/before",
 139       LTTV_POINTER, &value));
 140   *(value.v_pointer) = before_main;
 141   g_assert(lttv_iattribute_find_by_path(attributes, "hooks/main/after",
 142       LTTV_POINTER, &value));
 143   *(value.v_pointer) = after_main;
 144
 145
 146   /* Initialize the command line options processing */
 147
 148   GError *error = NULL;
 149
 150   LttvModule *module_module = lttv_module_require("module", &error);
 151   if(error != NULL) g_error("%s", error->message);
 152   LttvModule *module_option = lttv_module_require("option", &error);
 153   if(error != NULL) g_error("%s", error->message);
 154
 155   /* Initialize the module loading */
 156
 157   lttv_library_path_add(PACKAGE_PLUGIN_DIR);
 158
 159
 160   /* Add some built-in options */
 161
 162   lttv_option_add("module",'m', "load a module", "name of module to load",
 163       LTTV_OPT_STRING, &a_module, lttv_module_option, NULL);
 164
 165   lttv_option_add("modules-path", 'L',
 166       "add a directory to the module search path",
 167       "directory to add to the path", LTTV_OPT_STRING, &a_module_path,
 168       lttv_module_path_option, NULL);
 169
 170   lttv_option_add("help",'h', "basic help", "none",
 171       LTTV_OPT_NONE, NULL, lttv_help, NULL);
 172
 173   a_verbose = FALSE;
 174   lttv_option_add("verbose",'v', "print information messages", "none",
 175       LTTV_OPT_NONE, NULL, lttv_verbose, NULL);
 176
 177   a_debug = FALSE;
 178   lttv_option_add("debug",'d', "print debugging messages", "none",
 179       LTTV_OPT_NONE, NULL, lttv_debug, NULL);
 180
 181   a_fatal = FALSE;
 182   lttv_option_add("fatal",'f', "make critical messages fatal",
 183                   "none",
 184       LTTV_OPT_NONE, NULL, lttv_fatal, NULL);
 185
 186   lttv_profile_memory = FALSE;
 187   lttv_option_add(profile_memory_long_option + 2,
 188       profile_memory_short_option[1], "print memory information", "none",
 189       LTTV_OPT_NONE, &lttv_profile_memory, NULL, NULL);
 190
 191
 192   /* Process the options */
 193
 194   lttv_hooks_call(before_options, NULL);
 195   lttv_option_parse(argc, argv);
 196   lttv_hooks_call(after_options, NULL);
 197
 198
 199   /* Memory profiling to be useful must be activated as early as possible */
 200
 201   if(profile_memory != lttv_profile_memory)
 202     g_error("Memory profiling options must appear before other options");
 203
 204
 205   /* Do the main work */
 206
 207   lttv_hooks_call(before_main, NULL);
 208   lttv_hooks_call(after_main, NULL);
 209
 210
 211   /* Clean up everything */
 212
 213   lttv_module_release(module_option);
 214   lttv_module_release(module_module);
 215
 216   lttv_hooks_destroy(before_options);
 217   lttv_hooks_destroy(after_options);
 218   lttv_hooks_destroy(before_main);
 219   lttv_hooks_destroy(after_main);
 220   g_object_unref(attributes);
 221
 222   if(profile_memory) {
 223     g_message("Memory summary after main");
 224     g_mem_profile();
 225   }
 226   return 0;
 227 }
 228
 229
 230 LttvAttribute *lttv_global_attributes()
 231 {
 232   return (LttvAttribute*)attributes;
 233 }
 234
 235
 236 void lttv_module_option(void *hook_data)
 237 {
 238   GError *error = NULL;
 239
 240   lttv_module_require(a_module, &error);
 241   if(error != NULL) g_error("%s", error->message);
 242 }
 243
 244
 245 void lttv_module_path_option(void *hook_data)
 246 {
 247   lttv_library_path_add(a_module_path);
 248 }
 249
 250
 251 void lttv_verbose(void *hook_data)
 252 {
 253   g_log_set_handler(NULL, G_LOG_LEVEL_INFO, g_log_default_handler, NULL);
 254   g_info("Logging set to include INFO level messages");
 255 }
 256
 257 void lttv_debug(void *hook_data)
 258 {
 259   g_log_set_handler(NULL, G_LOG_LEVEL_DEBUG, g_log_default_handler, NULL);
 260   g_info("Logging set to include DEBUG level messages");
 261 }
 262
 263 void lttv_fatal(void *hook_data)
 264 {
 265   //g_log_set_always_fatal(G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
 266   g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
 267   g_info("Critical log from glib will abort execution");
 268 }
 269
 270 void lttv_help(void *hook_data)
 271 {
 272         printf("Linux Trace Toolkit Visualizer\n");
 273         printf("\n");
 274         lttv_option_show_help();
 275         printf("\n");
 276 }
 277
 278 /*
 279
 280 - Define formally traceset/trace in the GUI for the user and decide how
 281    trace/traceset sharing goes in the application.
 282
 283 - Use appropriately the new functions in time.h
 284
 285 - remove the separate tracefiles (control/per cpu) arrays/loops in context.
 286
 287 - split processTrace into context.c and processTrace.c
 288
 289 - check spelling conventions.
 290
 291 - get all the copyright notices.
 292
 293 - remove all the warnings.
 294
 295 - get all the .h files properly doxygen commented to produce useful documents.
 296
 297 - have an intro/architecture document.
 298
 299 - write a tutorial */