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