mono/eglib/goutput.c

   1 /*
   2  * Output and debugging functions
   3  *
   4  * Author:
   5  *   Miguel de Icaza (miguel@novell.com)
   6  *
   7  * (C) 2006 Novell, Inc.
   8  * Copyright 2011 Xamarin Inc.
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining
  11  * a copy of this software and associated documentation files (the
  12  * "Software"), to deal in the Software without restriction, including
  13  * without limitation the rights to use, copy, modify, merge, publish,
  14  * distribute, sublicense, and/or sell copies of the Software, and to
  15  * permit persons to whom the Software is furnished to do so, subject to
  16  * the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be
  19  * included in all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28  */
  29 #include <config.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <glib.h>
  33
  34 /* The current fatal levels, error is always fatal */
  35 static GLogLevelFlags fatal = G_LOG_LEVEL_ERROR;
  36 static GLogFunc default_log_func;
  37 static gpointer default_log_func_user_data;
  38 static GPrintFunc stdout_handler, stderr_handler;
  39
  40 static void default_stdout_handler (const gchar *string);
  41 static void default_stderr_handler (const gchar *string);
  42
  43 static GAbortFunc internal_abort_func;
  44
  45 void
  46 g_assertion_disable_global (GAbortFunc abort_func)
  47 {
  48         internal_abort_func = abort_func;
  49 }
  50
  51 void
  52 g_assert_abort (void)
  53 {
  54         if (internal_abort_func)
  55                 internal_abort_func ();
  56         else
  57                 abort ();
  58 }
  59
  60 gint
  61 g_printv (const gchar *format, va_list args)
  62 {
  63         char *msg;
  64         int ret;
  65
  66         ret = g_vasprintf (&msg, format, args);
  67         if (ret < 0)
  68                 return -1;
  69
  70         if (!stdout_handler)
  71                 stdout_handler = default_stdout_handler;
  72
  73         stdout_handler (msg);
  74         g_free (msg);
  75
  76         return ret;
  77 }
  78
  79 void
  80 g_print (const gchar *format, ...)
  81 {
  82         va_list args;
  83         va_start (args, format);
  84         g_printv (format, args);
  85         va_end (args);
  86 }
  87
  88 gint
  89 g_printf (gchar const *format, ...)
  90 {
  91         va_list args;
  92         gint ret;
  93
  94         va_start (args, format);
  95         ret = g_printv (format, args);
  96         va_end (args);
  97
  98         return ret;
  99 }
 100
 101 void
 102 g_printerr (const gchar *format, ...)
 103 {
 104         char *msg;
 105         va_list args;
 106
 107         va_start (args, format);
 108         if (g_vasprintf (&msg, format, args) < 0) {
 109                 va_end (args);
 110                 return;
 111         }
 112         va_end (args);
 113
 114         if (!stderr_handler)
 115                 stderr_handler = default_stderr_handler;
 116
 117         stderr_handler (msg);
 118         g_free (msg);
 119 }
 120
 121 GLogLevelFlags
 122 g_log_set_always_fatal (GLogLevelFlags fatal_mask)
 123 {
 124         GLogLevelFlags old_fatal = fatal;
 125
 126         fatal |= fatal_mask;
 127
 128         return old_fatal;
 129 }
 130
 131 GLogLevelFlags
 132 g_log_set_fatal_mask (const gchar *log_domain, GLogLevelFlags fatal_mask)
 133 {
 134         /*
 135          * Mono does not use a G_LOG_DOMAIN currently, so we just assume things are fatal
 136          * if we decide to set G_LOG_DOMAIN (we probably should) we should implement
 137          * this.
 138          */
 139         return fatal_mask;
 140 }
 141
 142 #define g_logstr monoeg_g_logstr
 143 #define g_logv_nofree monoeg_g_logv_nofree
 144
 145 static void
 146 g_logstr (const gchar *log_domain, GLogLevelFlags log_level, const gchar *msg)
 147 {
 148         if (!default_log_func)
 149                 default_log_func = g_log_default_handler;
 150
 151         default_log_func (log_domain, log_level, msg, default_log_func_user_data);
 152 }
 153
 154 static gchar*
 155 g_logv_nofree (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, va_list args)
 156 {
 157         char *msg;
 158
 159         if (internal_abort_func) {
 160                 g_async_safe_vprintf (format, args);
 161                 return NULL;
 162         } else if (g_vasprintf (&msg, format, args) < 0) {
 163                 return NULL;
 164         }
 165
 166         g_logstr (log_domain, log_level, msg);
 167         return msg;
 168 }
 169
 170 void
 171 g_logv (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, va_list args)
 172 {
 173         g_free (g_logv_nofree (log_domain, log_level, format, args));
 174 }
 175
 176 void
 177 g_log (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, ...)
 178 {
 179         va_list args;
 180
 181         va_start (args, format);
 182         g_logv (log_domain, log_level, format, args);
 183         va_end (args);
 184 }
 185
 186 static char *failure_assertion = NULL;
 187
 188 const char *
 189 g_get_assertion_message (void)
 190 {
 191         return failure_assertion;
 192 }
 193
 194 void
 195 g_assertion_message (const gchar *format, ...)
 196 {
 197         va_list args;
 198
 199         va_start (args, format);
 200
 201         failure_assertion = g_logv_nofree (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
 202
 203         va_end (args);
 204         exit (0);
 205 }
 206
 207 // Emscriptem emulates varargs, and fails to stack pack multiple outgoing varargs areas,
 208 // so this function serves to remove varargs in its caller and conserve stack.
 209 void
 210 mono_assertion_message_disabled (const char *file, int line)
 211 {
 212         mono_assertion_message (file, line, "<disabled>");
 213 }
 214
 215 // Emscriptem emulates varargs, and fails to stack pack multiple outgoing varargs areas,
 216 // so this function serves to remove varargs in its caller and conserve stack.
 217 void
 218 mono_assertion_message (const char *file, int line, const char *condition)
 219 {
 220         g_assertion_message ("* Assertion at %s:%d, condition `%s' not met\n", file, line, condition);
 221 }
 222
 223 // Emscriptem emulates varargs, and fails to stack pack multiple outgoing varargs areas,
 224 // so this function serves to remove varargs in its caller and conserve stack.
 225 void
 226 mono_assertion_message_unreachable (const char *file, int line)
 227 {
 228         g_assertion_message ("* Assertion: should not be reached at %s:%d\n", file, line);
 229 }
 230
 231 #if HOST_ANDROID
 232 #include <android/log.h>
 233
 234 static android_LogPriority
 235 to_android_priority (GLogLevelFlags log_level)
 236 {
 237         switch (log_level & G_LOG_LEVEL_MASK)
 238         {
 239                 case G_LOG_LEVEL_ERROR:     return ANDROID_LOG_FATAL;
 240                 case G_LOG_LEVEL_CRITICAL:  return ANDROID_LOG_ERROR;
 241                 case G_LOG_LEVEL_WARNING:   return ANDROID_LOG_WARN;
 242                 case G_LOG_LEVEL_MESSAGE:   return ANDROID_LOG_INFO;
 243                 case G_LOG_LEVEL_INFO:      return ANDROID_LOG_DEBUG;
 244                 case G_LOG_LEVEL_DEBUG:     return ANDROID_LOG_VERBOSE;
 245         }
 246         return ANDROID_LOG_UNKNOWN;
 247 }
 248
 249 #define LOG_MESSAGE_MAX_LEN 4096
 250
 251 static void
 252 android_log_line (gint log_priority, const gchar *log_domain, const gchar *log_message, gint log_len)
 253 {
 254         gchar log_buf [LOG_MESSAGE_MAX_LEN];
 255
 256         g_assert (log_len <= LOG_MESSAGE_MAX_LEN - 1);
 257
 258         /* If line is longer than LOG_MESSAGE_MAX_LEN - 1, then we simply cut it out. This is consistent with the previous behavior. */
 259         strncpy (log_buf, log_message, log_len);
 260         log_buf [log_len] = '\0';
 261
 262         __android_log_write (log_priority, log_domain, log_buf);
 263 }
 264
 265 static void
 266 android_log (gint log_priority, const gchar *log_domain, const gchar *log_message)
 267 {
 268         gint log_message_len, log_message_p_len;
 269         const gchar *log_message_p;
 270
 271         log_message_len = strlen (log_message);
 272         if (log_message_len <= LOG_MESSAGE_MAX_LEN) {
 273                 __android_log_write (log_priority, log_domain, log_message);
 274                 return;
 275         }
 276
 277         for (log_message_p = log_message; log_message_p < log_message + log_message_len;) {
 278                 const gchar *p = strstr (log_message_p, "\n");
 279                 if (p == NULL) {
 280                         /* There is no more "\n". */
 281                         android_log_line (log_priority, log_domain, log_message_p, LOG_MESSAGE_MAX_LEN - 1);
 282                         break;
 283                 }
 284
 285                 log_message_p_len = p - log_message_p;
 286                 if (log_message_p_len > LOG_MESSAGE_MAX_LEN - 1)
 287                         log_message_p_len = LOG_MESSAGE_MAX_LEN - 1;
 288
 289                 android_log_line (log_priority, log_domain, log_message_p, log_message_p_len);
 290
 291                 /* Set `log_message_p` to the character right after "\n" */
 292                 log_message_p = p + 1;
 293         }
 294 }
 295
 296 void
 297 g_log_default_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer unused_data)
 298 {
 299         android_log (to_android_priority (log_level), log_domain, message);
 300         if (log_level & fatal)
 301                 g_assert_abort ();
 302 }
 303
 304 static void
 305 default_stdout_handler (const gchar *message)
 306 {
 307         /* TODO: provide a proper app name */
 308         android_log (ANDROID_LOG_ERROR, "mono", message);
 309 }
 310
 311 static void
 312 default_stderr_handler (const gchar *message)
 313 {
 314         /* TODO: provide a proper app name */
 315         android_log (ANDROID_LOG_ERROR, "mono", message);
 316 }
 317
 318
 319 #elif defined(HOST_IOS)
 320 #include <asl.h>
 321
 322 static int
 323 to_asl_priority (GLogLevelFlags log_level)
 324 {
 325         switch (log_level & G_LOG_LEVEL_MASK)
 326         {
 327                 case G_LOG_LEVEL_ERROR:     return ASL_LEVEL_CRIT;
 328                 case G_LOG_LEVEL_CRITICAL:  return ASL_LEVEL_ERR;
 329                 case G_LOG_LEVEL_WARNING:   return ASL_LEVEL_WARNING;
 330                 case G_LOG_LEVEL_MESSAGE:   return ASL_LEVEL_NOTICE;
 331                 case G_LOG_LEVEL_INFO:      return ASL_LEVEL_INFO;
 332                 case G_LOG_LEVEL_DEBUG:     return ASL_LEVEL_DEBUG;
 333         }
 334         return ASL_LEVEL_ERR;
 335 }
 336
 337 void
 338 g_log_default_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer unused_data)
 339 {
 340         asl_log (NULL, NULL, to_asl_priority (log_level), "%s", message);
 341         if (log_level & fatal)
 342                 g_assert_abort ();
 343 }
 344
 345 static void
 346 default_stdout_handler (const gchar *message)
 347 {
 348         asl_log (NULL, NULL, ASL_LEVEL_WARNING, "%s", message);
 349 }
 350
 351 static void
 352 default_stderr_handler (const gchar *message)
 353 {
 354         asl_log (NULL, NULL, ASL_LEVEL_WARNING, "%s", message);
 355 }
 356
 357 #else
 358
 359 void
 360 g_log_default_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer unused_data)
 361 {
 362         FILE *target = stdout;
 363
 364         fprintf (target, "%s%s%s\n",
 365                 log_domain != NULL ? log_domain : "",
 366                 log_domain != NULL ? ": " : "",
 367                 message);
 368
 369         if (log_level & fatal) {
 370                 fflush (stdout);
 371                 fflush (stderr);
 372                 g_assert_abort ();
 373         }
 374 }
 375
 376 static void
 377 default_stdout_handler (const gchar *string)
 378 {
 379         fprintf (stdout, "%s", string);
 380 }
 381
 382 static void
 383 default_stderr_handler (const gchar *string)
 384 {
 385         fprintf (stderr, "%s", string);
 386 }
 387
 388 #endif
 389
 390 GLogFunc
 391 g_log_set_default_handler (GLogFunc log_func, gpointer user_data)
 392 {
 393         GLogFunc old = default_log_func;
 394         default_log_func = log_func;
 395         default_log_func_user_data = user_data;
 396         return old;
 397 }
 398
 399 GPrintFunc
 400 g_set_print_handler (GPrintFunc func)
 401 {
 402         GPrintFunc old = stdout_handler;
 403         stdout_handler = func;
 404         return old;
 405 }
 406
 407 GPrintFunc
 408 g_set_printerr_handler (GPrintFunc func)
 409 {
 410         GPrintFunc old = stderr_handler;
 411         stderr_handler = func;
 412         return old;
 413 }
 414