mono-logger.c 15 KB

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