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