LCOV - code coverage report
Current view: top level - util - log.cpp (source / functions) Hit Total Coverage
Test: gjs- Code Coverage Lines: 26 123 21.1 %
Date: 2022-09-21 03:31:25 Functions: 3 6 50.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 26 132 19.7 %

           Branch data     Line data    Source code
       1                 :            : /* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
       2                 :            : // SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
       3                 :            : // SPDX-FileCopyrightText: 2008 litl, LLC
       4                 :            : 
       5                 :            : #include <atomic>  // for atomic_bool
       6                 :            : #include <memory>  // for unique_ptr
       7                 :            : #include <string>  // for string
       8                 :            : #include <type_traits>  // for remove_reference<>::type
       9                 :            : 
      10                 :            : #include <errno.h>
      11                 :            : #include <fcntl.h>  // for SEEK_END
      12                 :            : #include <stdarg.h>
      13                 :            : #include <stdio.h>   // for FILE, fprintf, fflush, fopen, fputs, fseek
      14                 :            : #include <string.h>  // for strchr, strcmp
      15                 :            : #include "gjs/jsapi-util.h"
      16                 :            : 
      17                 :            : #ifdef _WIN32
      18                 :            : # include <io.h>
      19                 :            : # include <process.h>
      20                 :            : # ifndef F_OK
      21                 :            : #  define F_OK 0
      22                 :            : # endif
      23                 :            : #else
      24                 :            : #    include <unistd.h>  // for getpid
      25                 :            : #endif
      26                 :            : 
      27                 :            : #include <vector>
      28                 :            : 
      29                 :            : #include <glib.h>
      30                 :            : 
      31                 :            : #include "util/log.h"
      32                 :            : #include "util/misc.h"
      33                 :            : 
      34                 :            : static std::atomic_bool s_initialized = ATOMIC_VAR_INIT(false);
      35                 :            : static bool s_debug_log_enabled = false;
      36                 :            : static bool s_print_thread = false;
      37                 :            : static std::unique_ptr<LogFile> s_log_file;
      38                 :            : static GjsAutoPointer<GTimer, GTimer, g_timer_destroy> s_timer;
      39                 :            : static std::vector<bool> s_enabled_topics;
      40                 :            : 
      41                 :          0 : static const char* topic_to_prefix(GjsDebugTopic topic) {
      42   [ #  #  #  #  :          0 :     switch (topic) {
          #  #  #  #  #  
          #  #  #  #  #  
          #  #  #  #  #  
                      # ]
      43                 :          0 :         case GJS_DEBUG_GI_USAGE:
      44                 :          0 :             return "JS GI USE";
      45                 :          0 :         case GJS_DEBUG_MEMORY:
      46                 :          0 :             return "JS MEMORY";
      47                 :          0 :         case GJS_DEBUG_CONTEXT:
      48                 :          0 :             return "JS CTX";
      49                 :          0 :         case GJS_DEBUG_IMPORTER:
      50                 :          0 :             return "JS IMPORT";
      51                 :          0 :         case GJS_DEBUG_NATIVE:
      52                 :          0 :             return "JS NATIVE";
      53                 :          0 :         case GJS_DEBUG_CAIRO:
      54                 :          0 :             return "JS CAIRO";
      55                 :          0 :         case GJS_DEBUG_KEEP_ALIVE:
      56                 :          0 :             return "JS KP ALV";
      57                 :          0 :         case GJS_DEBUG_GREPO:
      58                 :          0 :             return "JS G REPO";
      59                 :          0 :         case GJS_DEBUG_GNAMESPACE:
      60                 :          0 :             return "JS G NS";
      61                 :          0 :         case GJS_DEBUG_GOBJECT:
      62                 :          0 :             return "JS G OBJ";
      63                 :          0 :         case GJS_DEBUG_GFUNCTION:
      64                 :          0 :             return "JS G FUNC";
      65                 :          0 :         case GJS_DEBUG_GFUNDAMENTAL:
      66                 :          0 :             return "JS G FNDMTL";
      67                 :          0 :         case GJS_DEBUG_GCLOSURE:
      68                 :          0 :             return "JS G CLSR";
      69                 :          0 :         case GJS_DEBUG_GBOXED:
      70                 :          0 :             return "JS G BXD";
      71                 :          0 :         case GJS_DEBUG_GENUM:
      72                 :          0 :             return "JS G ENUM";
      73                 :          0 :         case GJS_DEBUG_GPARAM:
      74                 :          0 :             return "JS G PRM";
      75                 :          0 :         case GJS_DEBUG_GERROR:
      76                 :          0 :             return "JS G ERR";
      77                 :          0 :         case GJS_DEBUG_GINTERFACE:
      78                 :          0 :             return "JS G IFACE";
      79                 :          0 :         case GJS_DEBUG_GTYPE:
      80                 :          0 :             return "JS GTYPE";
      81                 :          0 :         default:
      82                 :          0 :             return "???";
      83                 :            :     }
      84                 :            : }
      85                 :            : 
      86                 :          0 : static GjsDebugTopic prefix_to_topic(const char* prefix) {
      87         [ #  # ]:          0 :     for (unsigned i = 0; i < GJS_DEBUG_LAST; i++) {
      88                 :          0 :         auto topic = static_cast<GjsDebugTopic>(i);
      89         [ #  # ]:          0 :         if (g_str_equal(topic_to_prefix(topic), prefix))
      90                 :          0 :             return topic;
      91                 :            :     }
      92                 :            : 
      93                 :          0 :     return GJS_DEBUG_LAST;
      94                 :            : }
      95                 :            : 
      96                 :        221 : void gjs_log_init() {
      97                 :        221 :     bool expected = false;
      98         [ +  + ]:        221 :     if (!s_initialized.compare_exchange_strong(expected, true))
      99                 :         43 :         return;
     100                 :            : 
     101   [ +  -  -  + ]:        178 :     if (gjs_environment_variable_is_set("GJS_DEBUG_TIMESTAMP"))
     102   [ #  #  #  # ]:          0 :         s_timer = g_timer_new();
     103                 :            : 
     104         [ +  - ]:        178 :     s_print_thread = gjs_environment_variable_is_set("GJS_DEBUG_THREAD");
     105                 :            : 
     106         [ +  - ]:        178 :     const char* debug_output = g_getenv("GJS_DEBUG_OUTPUT");
     107   [ +  -  +  -  :        178 :     if (debug_output && g_str_equal(debug_output, "stderr")) {
             +  -  +  - ]
     108                 :        178 :         s_debug_log_enabled = true;
     109         [ #  # ]:          0 :     } else if (debug_output) {
     110                 :          0 :         std::string log_file;
     111                 :            :         char* c;
     112                 :            : 
     113                 :            :         /* Allow debug-%u.log for per-pid logfiles as otherwise log
     114                 :            :          * messages from multiple processes can overwrite each other.
     115                 :            :          *
     116                 :            :          * (printf below should be safe as we check '%u' is the only format
     117                 :            :          * string)
     118                 :            :          */
     119                 :          0 :         c = strchr(const_cast<char*>(debug_output), '%');
     120   [ #  #  #  #  :          0 :         if (c && c[1] == 'u' && !strchr(c + 1, '%')) {
                   #  # ]
     121                 :          0 :             GjsAutoChar file_name;
     122                 :            : #if defined(__clang__) || __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
     123                 :            :             _Pragma("GCC diagnostic push")
     124                 :            :                 _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
     125                 :            : #endif
     126   [ #  #  #  # ]:          0 :                     file_name = g_strdup_printf(debug_output, getpid());
     127                 :            : #if defined(__clang__) || __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
     128                 :            :             _Pragma("GCC diagnostic pop")
     129                 :            : #endif
     130         [ #  # ]:          0 :                 log_file = file_name.get();
     131                 :          0 :         } else {
     132         [ #  # ]:          0 :             log_file = debug_output;
     133                 :            :         }
     134                 :            : 
     135                 :            :         /* avoid truncating in case we're using shared logfile */
     136         [ #  # ]:          0 :         s_log_file = std::make_unique<LogFile>(log_file.c_str());
     137         [ #  # ]:          0 :         if (s_log_file->has_error()) {
     138         [ #  # ]:          0 :             fprintf(stderr, "Failed to open log file `%s': %s\n",
     139         [ #  # ]:          0 :                     log_file.c_str(), g_strerror(errno));
     140                 :            :         }
     141                 :            : 
     142                 :          0 :         s_debug_log_enabled = true;
     143                 :          0 :     }
     144                 :            : 
     145         [ +  + ]:        178 :     if (!s_log_file)
     146         [ +  - ]:         43 :         s_log_file = std::make_unique<LogFile>(nullptr, stderr);
     147                 :            : 
     148         [ +  - ]:        178 :     if (s_debug_log_enabled) {
     149         [ +  - ]:        178 :         auto* topics = g_getenv("GJS_DEBUG_TOPICS");
     150         [ +  - ]:        178 :         s_enabled_topics = std::vector<bool>(GJS_DEBUG_LAST, topics == nullptr);
     151         [ +  - ]:        178 :         if (topics) {
     152         [ +  - ]:        178 :             GjsAutoStrv prefixes(g_strsplit(topics, ";", -1));
     153         [ -  + ]:        178 :             for (unsigned i = 0; prefixes[i] != NULL; i++) {
     154         [ #  # ]:          0 :                 GjsDebugTopic topic = prefix_to_topic(prefixes[i]);
     155         [ #  # ]:          0 :                 s_enabled_topics[topic] = topic != GJS_DEBUG_LAST;
     156                 :            :             }
     157                 :        178 :         }
     158                 :            :     }
     159                 :            : }
     160                 :            : 
     161                 :        178 : void gjs_log_cleanup() {
     162                 :        178 :     bool expected = true;
     163         [ -  + ]:        178 :     if (!s_initialized.compare_exchange_strong(expected, false))
     164                 :          0 :         return;
     165                 :            : 
     166         [ +  - ]:        178 :     s_timer = nullptr;
     167                 :        178 :     s_enabled_topics.clear();
     168                 :            : }
     169                 :            : 
     170                 :            : #define PREFIX_LENGTH 12
     171                 :            : 
     172                 :            : static void
     173                 :          0 : write_to_stream(FILE       *logfp,
     174                 :            :                 const char *prefix,
     175                 :            :                 const char *s)
     176                 :            : {
     177                 :            :     /* seek to end to avoid truncating in case we're using shared logfile */
     178                 :          0 :     (void)fseek(logfp, 0, SEEK_END);
     179                 :            : 
     180                 :          0 :     fprintf(logfp, "%*s: %s", PREFIX_LENGTH, prefix, s);
     181         [ #  # ]:          0 :     if (!g_str_has_suffix(s, "\n"))
     182                 :          0 :         fputs("\n", logfp);
     183                 :          0 :     fflush(logfp);
     184                 :          0 : }
     185                 :            : 
     186                 :            : void
     187                 :      39814 : gjs_debug(GjsDebugTopic topic,
     188                 :            :           const char   *format,
     189                 :            :           ...)
     190                 :            : {
     191                 :            :     va_list args;
     192                 :            :     char *s;
     193                 :            : 
     194   [ +  +  +  -  :      39814 :     if (!s_debug_log_enabled || !s_enabled_topics[topic])
             +  -  +  - ]
     195                 :      39814 :         return;
     196                 :            : 
     197                 :          0 :     va_start (args, format);
     198         [ #  # ]:          0 :     s = g_strdup_vprintf (format, args);
     199                 :          0 :     va_end (args);
     200                 :            : 
     201         [ #  # ]:          0 :     if (s_timer) {
     202                 :            :         static gdouble previous = 0.0;
     203         [ #  # ]:          0 :         gdouble total = g_timer_elapsed(s_timer, NULL) * 1000.0;
     204                 :          0 :         gdouble since = total - previous;
     205                 :            :         const char *ts_suffix;
     206                 :            :         char *s2;
     207                 :            : 
     208         [ #  # ]:          0 :         if (since > 50.0) {
     209                 :          0 :             ts_suffix = "!!  ";
     210         [ #  # ]:          0 :         } else if (since > 100.0) {
     211                 :          0 :             ts_suffix = "!!! ";
     212         [ #  # ]:          0 :         } else if (since > 200.0) {
     213                 :          0 :             ts_suffix = "!!!!";
     214                 :            :         } else {
     215                 :          0 :             ts_suffix = "    ";
     216                 :            :         }
     217                 :            : 
     218         [ #  # ]:          0 :         s2 = g_strdup_printf("%g %s%s",
     219                 :            :                              total, ts_suffix, s);
     220         [ #  # ]:          0 :         g_free(s);
     221                 :          0 :         s = s2;
     222                 :            : 
     223                 :          0 :         previous = total;
     224                 :            :     }
     225                 :            : 
     226         [ #  # ]:          0 :     if (s_print_thread) {
     227   [ #  #  #  # ]:          0 :         char *s2 = g_strdup_printf("(thread %p) %s", g_thread_self(), s);
     228         [ #  # ]:          0 :         g_free(s);
     229                 :          0 :         s = s2;
     230                 :            :     }
     231                 :            : 
     232         [ #  # ]:          0 :     write_to_stream(s_log_file->fp(), topic_to_prefix(topic), s);
     233                 :            : 
     234         [ #  # ]:          0 :     g_free(s);
     235                 :            : }

Generated by: LCOV version 1.14