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         gboolean retval;
  99
 100         LttvAttributeValue value;
 101
 102         lttv_argc = argc;
 103         lttv_argv = argv;
 104
 105         /* Before anything else, check if memory profiling is requested */
 106
 107         for(i = 1 ; i < argc ; i++) {
 108                 if(*(argv[i]) != '-') break;
 109                 if(strcmp(argv[i], profile_memory_short_option) == 0 ||
 110                          strcmp(argv[i], profile_memory_long_option) == 0) {
 111                         g_mem_set_vtable(glib_mem_profiler_table);
 112                         g_message("Memory summary before main");
 113                         g_mem_profile();
 114                         profile_memory = TRUE;
 115                         break;
 116                 }
 117         }
 118
 119
 120         /* Initialize glib and by default ignore info and debug messages */
 121
 122         g_type_init();
 123         //g_type_init_with_debug_flags (G_TYPE_DEBUG_OBJECTS | G_TYPE_DEBUG_SIGNALS);
 124         g_log_set_handler(NULL, G_LOG_LEVEL_INFO, ignore_and_drop_message, NULL);
 125         g_log_set_handler(NULL, G_LOG_LEVEL_DEBUG, ignore_and_drop_message, NULL);
 126
 127
 128         /* Have an attributes subtree to store hooks to be registered by modules. */
 129
 130         attributes = LTTV_IATTRIBUTE(g_object_new(LTTV_ATTRIBUTE_TYPE, NULL));
 131
 132         before_options = lttv_hooks_new();
 133         after_options = lttv_hooks_new();
 134         before_main = lttv_hooks_new();
 135         after_main = lttv_hooks_new();
 136
 137
 138         /* Create a number of hooks lists */
 139
 140         retval= lttv_iattribute_find_by_path(attributes, "hooks/options/before",
 141                         LTTV_POINTER, &value);
 142         g_assert(retval);
 143         *(value.v_pointer) = before_options;
 144         retval= lttv_iattribute_find_by_path(attributes, "hooks/options/after",
 145                         LTTV_POINTER, &value);
 146         g_assert(retval);
 147         *(value.v_pointer) = after_options;
 148         retval= lttv_iattribute_find_by_path(attributes, "hooks/main/before",
 149                         LTTV_POINTER, &value);
 150         g_assert(retval);
 151         *(value.v_pointer) = before_main;
 152         retval= lttv_iattribute_find_by_path(attributes, "hooks/main/after",
 153                         LTTV_POINTER, &value);
 154         g_assert(retval);
 155         *(value.v_pointer) = after_main;
 156
 157
 158         /* Initialize the command line options processing */
 159
 160         GError *error = NULL;
 161
 162         LttvModule *module_module = lttv_module_require("module", &error);
 163         if(error != NULL) g_error("%s", error->message);
 164         LttvModule *module_option = lttv_module_require("option", &error);
 165         if(error != NULL) g_error("%s", error->message);
 166
 167         /* Initialize the module loading */
 168
 169         lttv_library_path_add(PACKAGE_PLUGIN_DIR);
 170
 171
 172         /* Add some built-in options */
 173
 174         lttv_option_add("module",'m', "load a module", "name of module to load",
 175                         LTTV_OPT_STRING, &a_module, lttv_module_option, NULL);
 176
 177         lttv_option_add("modules-path", 'L',
 178                         "add a directory to the module search path",
 179                         "directory to add to the path", LTTV_OPT_STRING, &a_module_path,
 180                         lttv_module_path_option, NULL);
 181
 182         lttv_option_add("help",'h', "basic help", "none",
 183                         LTTV_OPT_NONE, NULL, lttv_help, NULL);
 184
 185         a_verbose = FALSE;
 186         lttv_option_add("verbose",'v', "print information messages", "none",
 187                         LTTV_OPT_NONE, NULL, lttv_verbose, NULL);
 188
 189         a_debug = FALSE;
 190         lttv_option_add("debug",'d', "print debugging messages", "none",
 191                         LTTV_OPT_NONE, NULL, lttv_debug, NULL);
 192
 193         /* use --edebug, -e conflicts with filter. Problem with option parsing when we
 194          * reparse the options with different number of arguments. */
 195         lttv_option_add("edebug",'e', "print event debugging", "none",
 196                         LTTV_OPT_NONE, NULL, lttv_event_debug, NULL);
 197
 198         a_fatal = FALSE;
 199         lttv_option_add("fatal",'f', "make critical messages fatal", "none",
 200                         LTTV_OPT_NONE, NULL, lttv_fatal, NULL);
 201
 202         lttv_profile_memory = FALSE;
 203         lttv_option_add(profile_memory_long_option + 2,
 204                         profile_memory_short_option[1], "print memory information", "none",
 205                         LTTV_OPT_NONE, &lttv_profile_memory, NULL, NULL);
 206
 207
 208         /* Process the options */
 209
 210         lttv_hooks_call(before_options, NULL);
 211         lttv_option_parse(argc, argv);
 212         lttv_hooks_call(after_options, NULL);
 213
 214
 215         /* Memory profiling to be useful must be activated as early as possible */
 216
 217         if(profile_memory != lttv_profile_memory)
 218                 g_error("Memory profiling options must appear before other options");
 219
 220
 221         /* Do the main work */
 222
 223         lttv_hooks_call(before_main, NULL);
 224         lttv_hooks_call(after_main, NULL);
 225
 226
 227         /* Clean up everything */
 228
 229         lttv_module_release(module_option);
 230         lttv_module_release(module_module);
 231
 232         lttv_hooks_destroy(before_options);
 233         lttv_hooks_destroy(after_options);
 234         lttv_hooks_destroy(before_main);
 235         lttv_hooks_destroy(after_main);
 236         g_object_unref(attributes);
 237
 238         if(profile_memory) {
 239                 g_message("Memory summary after main");
 240                 g_mem_profile();
 241         }
 242         return 0;
 243 }
 244
 245
 246 LttvAttribute *lttv_global_attributes()
 247 {
 248         return (LttvAttribute*)attributes;
 249 }
 250
 251
 252 void lttv_module_option(void *hook_data)
 253 {
 254         GError *error = NULL;
 255
 256         lttv_module_require(a_module, &error);
 257         if(error != NULL) g_error("%s", error->message);
 258 }
 259
 260
 261 void lttv_module_path_option(void *hook_data)
 262 {
 263         lttv_library_path_add(a_module_path);
 264 }
 265
 266
 267 void lttv_verbose(void *hook_data)
 268 {
 269         g_log_set_handler(NULL, G_LOG_LEVEL_INFO, g_log_default_handler, NULL);
 270         g_info("Logging set to include INFO level messages");
 271 }
 272
 273 void lttv_debug(void *hook_data)
 274 {
 275         g_log_set_handler(NULL, G_LOG_LEVEL_DEBUG, g_log_default_handler, NULL);
 276         g_info("Logging set to include DEBUG level messages");
 277 }
 278
 279 void lttv_event_debug(void *hook_data)
 280 {
 281         #warning lttv_event_debug does nothing
 282 #ifdef BABEL_CLEANUP
 283         ltt_event_debug(1);
 284 #endif
 285         g_info("Output event detailed debug");
 286 }
 287
 288 void lttv_fatal(void *hook_data)
 289 {
 290         g_log_set_always_fatal(G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
 291         //g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
 292         g_info("Critical log from glib will abort execution");
 293 }
 294
 295 void lttv_help(void *hook_data)
 296 {
 297         printf("Linux Trace Toolkit Visualizer " VERSION "\n");
 298         printf("\n");
 299         lttv_option_show_help();
 300         printf("\n");
 301 }
 302
 303 /*
 304
 305 - Define formally traceset/trace in the GUI for the user and decide how
 306   trace/traceset sharing goes in the application.
 307
 308 - Use appropriately the new functions in time.h
 309
 310 - remove the separate tracefiles (control/per cpu) arrays/loops in context.
 311
 312 - split processTrace into context.c and processTrace.c
 313
 314 - check spelling conventions.
 315
 316 - get all the copyright notices.
 317
 318 - remove all the warnings.
 319
 320 - get all the .h files properly doxygen commented to produce useful documents.
 321
 322 - have an intro/architecture document.
 323
 324 - write a tutorial */