src/egl/main/egllog.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   5  * Copyright 2010 LunarG, Inc.
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26  * DEALINGS IN THE SOFTWARE.
  27  *
  28  **************************************************************************/
  29
  30
  31 /**
  32  * Logging facility for debug/info messages.
  33  * _EGL_FATAL messages are printed to stderr
  34  * The EGL_LOG_LEVEL var controls the output of other warning/info/debug msgs.
  35  */
  36
  37
  38 #include <stdarg.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include <strings.h>
  43 #include "c11/threads.h"
  44 #include "util/macros.h"
  45 #include "util/u_string.h"
  46
  47 #include "egllog.h"
  48
  49 #ifdef HAVE_ANDROID_PLATFORM
  50 #define LOG_TAG "EGL-MAIN"
  51 #if ANDROID_API_LEVEL >= 26
  52 #include <log/log.h>
  53 #else
  54 #include <cutils/log.h>
  55 #endif /* use log/log.h start from android 8 major version */
  56
  57 #endif /* HAVE_ANDROID_PLATFORM */
  58
  59 #define MAXSTRING 1000
  60 #define FALLBACK_LOG_LEVEL _EGL_WARNING
  61
  62
  63 static struct {
  64    mtx_t mutex;
  65
  66    EGLBoolean initialized;
  67    EGLint level;
  68 } logging = {
  69    .mutex = _MTX_INITIALIZER_NP,
  70    .initialized = EGL_FALSE,
  71    .level = FALLBACK_LOG_LEVEL,
  72 };
  73
  74 static const char *level_strings[] = {
  75    [_EGL_FATAL] = "fatal",
  76    [_EGL_WARNING]  = "warning",
  77    [_EGL_INFO] = "info",
  78    [_EGL_DEBUG] = "debug",
  79 };
  80
  81
  82 /**
  83  * The default logger.  It prints the message to stderr.
  84  */
  85 static void
  86 _eglDefaultLogger(EGLint level, const char *msg)
  87 {
  88 #ifdef HAVE_ANDROID_PLATFORM
  89    static const int egl2alog[] = {
  90       [_EGL_FATAL] = ANDROID_LOG_ERROR,
  91       [_EGL_WARNING]  = ANDROID_LOG_WARN,
  92       [_EGL_INFO] = ANDROID_LOG_INFO,
  93       [_EGL_DEBUG] = ANDROID_LOG_DEBUG,
  94    };
  95    LOG_PRI(egl2alog[level], LOG_TAG, "%s", msg);
  96 #else
  97    fprintf(stderr, "libEGL %s: %s\n", level_strings[level], msg);
  98 #endif /* HAVE_ANDROID_PLATFORM */
  99 }
 100
 101
 102 /**
 103  * Initialize the logging facility.
 104  */
 105 static void
 106 _eglInitLogger(void)
 107 {
 108    const char *log_env;
 109    EGLint i, level = -1;
 110
 111    if (logging.initialized)
 112       return;
 113
 114    log_env = getenv("EGL_LOG_LEVEL");
 115    if (log_env) {
 116       for (i = 0; i < ARRAY_SIZE(level_strings); i++) {
 117          if (strcasecmp(log_env, level_strings[i]) == 0) {
 118             level = i;
 119             break;
 120          }
 121       }
 122    }
 123
 124    logging.level = (level >= 0) ? level : FALLBACK_LOG_LEVEL;
 125    logging.initialized = EGL_TRUE;
 126
 127    /* it is fine to call _eglLog now */
 128    if (log_env && level < 0) {
 129       _eglLog(_EGL_WARNING,
 130               "Unrecognized EGL_LOG_LEVEL environment variable value. "
 131               "Expected one of \"fatal\", \"warning\", \"info\", \"debug\". "
 132               "Got \"%s\". Falling back to \"%s\".",
 133               log_env, level_strings[FALLBACK_LOG_LEVEL]);
 134    }
 135 }
 136
 137
 138 /**
 139  * Log a message with message logger.
 140  * \param level one of _EGL_FATAL, _EGL_WARNING, _EGL_INFO, _EGL_DEBUG.
 141  */
 142 void
 143 _eglLog(EGLint level, const char *fmtStr, ...)
 144 {
 145    va_list args;
 146    char msg[MAXSTRING];
 147    int ret;
 148
 149    /* one-time initialization; a little race here is fine */
 150    if (!logging.initialized)
 151       _eglInitLogger();
 152    if (level > logging.level || level < 0)
 153       return;
 154
 155    mtx_lock(&logging.mutex);
 156
 157    va_start(args, fmtStr);
 158    ret = vsnprintf(msg, MAXSTRING, fmtStr, args);
 159    if (ret < 0 || ret >= MAXSTRING)
 160       strcpy(msg, "<message truncated>");
 161    va_end(args);
 162
 163    _eglDefaultLogger(level, msg);
 164
 165    mtx_unlock(&logging.mutex);
 166
 167    if (level == _EGL_FATAL)
 168       exit(1); /* or abort()? */
 169 }