mono/utils/mono-logger.c

   1 #include <string.h>
   2 #include <stdlib.h>
   3 #include <stdio.h>
   4 #include <glib.h>
   5
   6 #include "mono-compiler.h"
   7 #include "mono-logger-internals.h"
   8
   9 typedef struct {
  10         GLogLevelFlags  level;
  11         MonoTraceMask   mask;
  12 } MonoLogLevelEntry;
  13
  14 GLogLevelFlags mono_internal_current_level      = INT_MAX;
  15 MonoTraceMask  mono_internal_current_mask       = MONO_TRACE_ALL;
  16 gboolean mono_trace_log_header                  = FALSE;
  17
  18 static GQueue           *level_stack            = NULL;
  19 static const char       *mono_log_domain        = "Mono";
  20 static MonoPrintCallback print_callback, printerr_callback;
  21
  22 static MonoLogCallParm logCallback = {
  23         .opener = NULL,
  24         .writer = NULL,
  25         .closer = NULL,
  26         .header = FALSE
  27 };
  28
  29 typedef struct {
  30    MonoLogCallback legacy_callback;
  31    gpointer user_data;
  32 } UserSuppliedLoggerUserData;
  33
  34 /**
  35  * mono_trace_init:
  36  *
  37  * Initializes the mono tracer.
  38  */
  39 void
  40 mono_trace_init (void)
  41 {
  42         if(level_stack == NULL) {
  43                 mono_internal_current_level = G_LOG_LEVEL_ERROR;
  44                 level_stack = g_queue_new();
  45
  46                 mono_trace_set_mask_string(g_getenv("MONO_LOG_MASK"));
  47                 mono_trace_set_level_string(g_getenv("MONO_LOG_LEVEL"));
  48                 mono_trace_set_logheader_string(g_getenv("MONO_LOG_HEADER"));
  49                 mono_trace_set_logdest_string(g_getenv("MONO_LOG_DEST"));
  50         }
  51 }
  52
  53 /**
  54  * mono_trace_cleanup:
  55  *
  56  * Releases the mono tracer.
  57  */
  58 void
  59 mono_trace_cleanup (void)
  60 {
  61         if(level_stack != NULL) {
  62                 while(!g_queue_is_empty (level_stack)) {
  63                         g_free (g_queue_pop_head (level_stack));
  64                 }
  65
  66                 logCallback.closer();
  67                 g_queue_free (level_stack);
  68                 level_stack = NULL;
  69         }
  70 }
  71
  72 /**
  73  * mono_tracev:
  74  *
  75  *      @level: Verbose level of the specified message
  76  *      @mask: Type of the specified message
  77  *
  78  * Traces a new message, depending on the current logging level
  79  * and trace mask.
  80  */
  81 void
  82 mono_tracev_inner (GLogLevelFlags level, MonoTraceMask mask, const char *format, va_list args)
  83 {
  84         char *log_message;
  85         if (level_stack == NULL) {
  86                 mono_trace_init ();
  87                 if(level > mono_internal_current_level || !(mask & mono_internal_current_mask))
  88                         return;
  89         }
  90
  91         g_assert (logCallback.opener); // mono_trace_init should have provided us with one!
  92
  93         if (g_vasprintf (&log_message, format, args) < 0)
  94                 return;
  95         logCallback.writer (mono_log_domain, level, logCallback.header, log_message);
  96         g_free (log_message);
  97 }
  98
  99 /**
 100  * mono_trace_set_level:
 101  *
 102  *      @level: Verbose level to set
 103  *
 104  * Sets the current logging level. Every subsequent call to
 105  * mono_trace will check the visibility of a message against this
 106  * value.
 107  */
 108 void
 109 mono_trace_set_level (GLogLevelFlags level)
 110 {
 111         if(level_stack == NULL)
 112                 mono_trace_init();
 113
 114         mono_internal_current_level = level;
 115 }
 116
 117 /**
 118  * mono_trace_set_mask:
 119  *
 120  *      @mask: Mask of visible message types.
 121  *
 122  * Sets the current logging level. Every subsequent call to
 123  * mono_trace will check the visibility of a message against this
 124  * value.
 125  */
 126 void
 127 mono_trace_set_mask (MonoTraceMask mask)
 128 {
 129         if(level_stack == NULL)
 130                 mono_trace_init();
 131
 132         mono_internal_current_mask = mask;
 133 }
 134
 135 /**
 136  * mono_trace_set_logdest:
 137  *
 138  *      @dest: Destination for logging
 139  *
 140  * Sets the current logging destination. This can be a file or, if supported,
 141  * syslog.
 142  */
 143 void
 144 mono_trace_set_logdest_string (const char *dest)
 145 {
 146         MonoLogCallParm logger;
 147
 148         if(level_stack == NULL)
 149                 mono_trace_init();
 150
 151 #if PLATFORM_ANDROID
 152         logger.opener = mono_log_open_logcat;
 153         logger.writer = mono_log_write_logcat;
 154         logger.closer = mono_log_close_logcat;
 155         logger.dest   = (char*) dest;
 156 #else
 157         if ((dest == NULL) || (strcmp("syslog", dest) != 0)) {
 158                 logger.opener = mono_log_open_logfile;
 159                 logger.writer = mono_log_write_logfile;
 160                 logger.closer = mono_log_close_logfile;
 161                 logger.dest   = (char *) dest;
 162         } else {
 163                 logger.opener = mono_log_open_syslog;
 164                 logger.writer = mono_log_write_syslog;
 165                 logger.closer = mono_log_close_syslog;
 166                 logger.dest   = (char *) dest;
 167         }
 168 #endif
 169         mono_trace_set_log_handler_internal(&logger, NULL);
 170 }
 171
 172 /**
 173  * mono_trace_set_logheader:
 174  *
 175  *      @head: Whether we want pid/date/time header on log messages
 176  *
 177  * Sets the current logging header option.
 178  */
 179 void
 180 mono_trace_set_logheader_string(const char *head)
 181 {
 182         if (head == NULL) {
 183                 mono_trace_log_header = FALSE;
 184         } else {
 185                 mono_trace_log_header = TRUE;
 186         }
 187 }
 188
 189 /**
 190  * mono_trace_push:
 191  *
 192  *      @level: Verbose level to set
 193  *      @mask: Mask of visible message types.
 194  *
 195  * Saves the current values of level and mask then calls mono_trace_set
 196  * with the specified new values.
 197  */
 198 void
 199 mono_trace_push (GLogLevelFlags level, MonoTraceMask mask)
 200 {
 201         if(level_stack == NULL)
 202                 g_error("%s: cannot use mono_trace_push without calling mono_trace_init first.", __func__);
 203         else {
 204                 MonoLogLevelEntry *entry = (MonoLogLevelEntry *) g_malloc(sizeof(MonoLogLevelEntry));
 205                 entry->level    = mono_internal_current_level;
 206                 entry->mask             = mono_internal_current_mask;
 207
 208                 g_queue_push_head (level_stack, (gpointer)entry);
 209
 210                 /* Set the new level and mask
 211                  */
 212                 mono_internal_current_level = level;
 213                 mono_internal_current_mask  = mask;
 214         }
 215 }
 216
 217 /**
 218  * mono_trace_pop:
 219  *
 220  * Restores level and mask values saved from a previous call to mono_trace_push.
 221  */
 222 void
 223 mono_trace_pop (void)
 224 {
 225         if(level_stack == NULL)
 226                 g_error("%s: cannot use mono_trace_pop without calling mono_trace_init first.", __func__);
 227         else {
 228                 if(!g_queue_is_empty (level_stack)) {
 229                         MonoLogLevelEntry *entry = (MonoLogLevelEntry*)g_queue_pop_head (level_stack);
 230
 231                         /*      Restore previous level and mask
 232                          */
 233                         mono_internal_current_level = entry->level;
 234                         mono_internal_current_mask  = entry->mask;
 235
 236                         g_free (entry);
 237                 }
 238         }
 239 }
 240
 241
 242 void
 243 mono_trace_set_level_string (const char *value)
 244 {
 245         int i = 0;
 246         const char *valid_vals[] = {"error", "critical", "warning", "message", "info", "debug", NULL};
 247         const GLogLevelFlags valid_ids[] = {G_LOG_LEVEL_ERROR, G_LOG_LEVEL_CRITICAL, G_LOG_LEVEL_WARNING,
 248                                                                                 G_LOG_LEVEL_MESSAGE, G_LOG_LEVEL_INFO, G_LOG_LEVEL_DEBUG };
 249
 250         if(!value)
 251                 return;
 252
 253         while(valid_vals[i]) {
 254                 if(!strcmp(valid_vals[i], value)){
 255                         mono_trace_set_level(valid_ids[i]);
 256                         return;
 257                 }
 258                 i++;
 259         }
 260
 261         if(*value)
 262                 g_print("Unknown trace loglevel: %s\n", value);
 263 }
 264
 265 void
 266 mono_trace_set_mask_string (const char *value)
 267 {
 268         int i;
 269         const char *tok;
 270         guint32 flags = 0;
 271
 272         const char *valid_flags[] = {"asm", "type", "dll", "gc", "cfg", "aot", "security", "threadpool", "io-threadpool", "io-layer", "w32handle", "all", NULL};
 273         const MonoTraceMask     valid_masks[] = {MONO_TRACE_ASSEMBLY, MONO_TRACE_TYPE, MONO_TRACE_DLLIMPORT,
 274                                                  MONO_TRACE_GC, MONO_TRACE_CONFIG, MONO_TRACE_AOT, MONO_TRACE_SECURITY,
 275                                                  MONO_TRACE_THREADPOOL, MONO_TRACE_IO_THREADPOOL, MONO_TRACE_IO_LAYER,
 276                                                  MONO_TRACE_W32HANDLE, MONO_TRACE_ALL };
 277
 278         if(!value)
 279                 return;
 280
 281         tok = value;
 282
 283         while (*tok) {
 284                 if (*tok == ',') {
 285                         tok++;
 286                         continue;
 287                 }
 288                 for (i = 0; valid_flags[i]; i++) {
 289                         int len = strlen (valid_flags[i]);
 290                         if (strncmp (tok, valid_flags[i], len) == 0 && (tok[len] == 0 || tok[len] == ',')) {
 291                                 flags |= valid_masks[i];
 292                                 tok += len;
 293                                 break;
 294                         }
 295                 }
 296                 if (!valid_flags[i]) {
 297                         g_print("Unknown trace flag: %s\n", tok);
 298                         break;
 299                 }
 300         }
 301
 302         mono_trace_set_mask ((MonoTraceMask) flags);
 303 }
 304
 305 /*
 306  * mono_trace_is_traced:
 307  *
 308  *   Returns whenever a message with @level and @mask will be printed or not.
 309  */
 310 gboolean
 311 mono_trace_is_traced (GLogLevelFlags level, MonoTraceMask mask)
 312 {
 313         return (level <= mono_internal_current_level && mask & mono_internal_current_mask);
 314 }
 315
 316 /**
 317  * log_level_get_name
 318  * @log_level severity level
 319  *
 320  * Convert log level into a string for legacy log handlers
 321  */
 322 static const char *
 323 log_level_get_name (GLogLevelFlags log_level)
 324 {
 325         switch (log_level & G_LOG_LEVEL_MASK) {
 326         case G_LOG_LEVEL_ERROR: return "error";
 327         case G_LOG_LEVEL_CRITICAL: return "critical";
 328         case G_LOG_LEVEL_WARNING: return "warning";
 329         case G_LOG_LEVEL_MESSAGE: return "message";
 330         case G_LOG_LEVEL_INFO: return "info";
 331         case G_LOG_LEVEL_DEBUG: return "debug";
 332         default: return "unknown";
 333         }
 334 }
 335
 336 /**
 337  * callback_adapter
 338  *
 339  *  @log_domain Message prefix
 340  *  @log_level Severity
 341  *  @message Message to be written
 342  *  @fatal Fatal flag - write then abort
 343  *  @user_data Argument passed to @callback
 344  *
 345  * This adapts the old callback writer exposed by MonoCallback to the newer method of
 346  * logging. We ignore the header request as legacy handlers never had headers.
 347  */
 348 static void
 349 callback_adapter (const char *domain, GLogLevelFlags level, mono_bool fatal, const char *message)
 350 {
 351         UserSuppliedLoggerUserData *ll =logCallback.user_data;
 352
 353         ll->legacy_callback (domain, log_level_get_name(level), message, fatal, ll->user_data);
 354 }
 355
 356 static void
 357 eglib_log_adapter (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
 358 {
 359         UserSuppliedLoggerUserData *ll = logCallback.user_data;
 360
 361         ll->legacy_callback (log_domain, log_level_get_name (log_level), message, log_level & G_LOG_LEVEL_ERROR, ll->user_data);
 362 }
 363
 364 /**
 365  * legacy_opener
 366  *
 367  * Dummy routine for older style loggers
 368  */
 369 static void
 370 legacy_opener(const char *path, void *user_data)
 371 {
 372   /* nothing to do */
 373 }
 374
 375 /**
 376  * legacy_closer
 377  *
 378  * Cleanup routine for older style loggers
 379  */
 380 static void
 381 legacy_closer(void)
 382 {
 383         if (logCallback.user_data != NULL) {
 384                 g_free (logCallback.user_data); /* This is a UserSuppliedLoggerUserData struct */
 385                 logCallback.opener = NULL;
 386                 logCallback.writer = NULL;
 387                 logCallback.closer = NULL;
 388                 logCallback.user_data = NULL;
 389                 logCallback.header = FALSE;
 390         }
 391 }
 392
 393 /**
 394  *   mono_trace_set_log_handler:
 395  *
 396  *  @callback The callback that will replace the default logging handler
 397  *  @user_data Argument passed to @callback
 398  *
 399  * The log handler replaces the default runtime logger. All logging requests with be routed to it.
 400  * If the fatal argument in the callback is true, the callback must abort the current process. The runtime expects that
 401  * execution will not resume after a fatal error.
 402  */
 403 void
 404 mono_trace_set_log_handler (MonoLogCallback callback, void *user_data)
 405 {
 406         g_assert (callback);
 407
 408         if (logCallback.closer != NULL)
 409                 logCallback.closer();
 410         UserSuppliedLoggerUserData *ll = g_malloc (sizeof (UserSuppliedLoggerUserData));
 411         ll->legacy_callback = callback;
 412         ll->user_data = user_data;
 413         logCallback.opener = legacy_opener;
 414         logCallback.writer = callback_adapter;
 415         logCallback.closer = legacy_closer;
 416         logCallback.user_data = ll;
 417         logCallback.dest = NULL;
 418
 419         g_log_set_default_handler (eglib_log_adapter, user_data);
 420 }
 421
 422 static void
 423 structured_log_adapter (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
 424 {
 425         logCallback.writer (log_domain, log_level, logCallback.header, message);
 426 }
 427
 428 /**
 429  * mono_trace_set_log_handler_internal:
 430  *
 431  *  @callback The callback that will replace the default logging handler
 432  *  @user_data Argument passed to @callback
 433  *
 434  * The log handler replaces the default runtime logger. All logging requests with be routed to it.
 435  * If the fatal argument in the callback is true, the callback must abort the current process. The runtime expects that
 436  * execution will not resume after a fatal error.
 437  */
 438 void
 439 mono_trace_set_log_handler_internal (MonoLogCallParm *callback, void *user_data)
 440 {
 441         g_assert (callback);
 442         if (logCallback.closer != NULL)
 443                 logCallback.closer();
 444         logCallback.opener = callback->opener;
 445         logCallback.writer = callback->writer;
 446         logCallback.closer = callback->closer;
 447         logCallback.header = mono_trace_log_header;
 448         logCallback.dest   = callback->dest;
 449         logCallback.opener (logCallback.dest, user_data);
 450
 451         g_log_set_default_handler (structured_log_adapter, user_data);
 452 }
 453
 454 static void
 455 print_handler (const char *string)
 456 {
 457         print_callback (string, TRUE);
 458 }
 459
 460 static void
 461 printerr_handler (const char *string)
 462 {
 463         printerr_callback (string, FALSE);
 464 }
 465
 466 /**
 467  * mono_trace_set_print_handler:
 468  *
 469  * @callback The callback that will replace the default runtime behavior for stdout output.
 470  *
 471  * The print handler replaces the default runtime stdout output handler. This is used by free form output done by the runtime.
 472  *
 473  */
 474 void
 475 mono_trace_set_print_handler (MonoPrintCallback callback)
 476 {
 477         g_assert (callback);
 478         print_callback = callback;
 479         g_set_print_handler (print_handler);
 480 }
 481
 482 /**
 483  * mono_trace_set_printerr_handler:
 484  *
 485  * @callback The callback that will replace the default runtime behavior for stderr output.
 486  *
 487  * The print handler replaces the default runtime stderr output handler. This is used by free form output done by the runtime.
 488  *
 489  */
 490 void
 491 mono_trace_set_printerr_handler (MonoPrintCallback callback)
 492 {
 493         g_assert (callback);
 494         printerr_callback = callback;
 495         g_set_printerr_handler (printerr_handler);
 496 }