[Piglit] [PATCH 10/13] util/log: Add logging module

[Chad Versace]

Add new header piglit-log.h which exposes the following functions:
    piglit_log_get_opt()
    piglit_log_set_opt()
    piglit_loge()
    piglit_logi()

This new module should help to reduce redundant logging boilerplate
found in many Piglit files.

Signed-off-by: Chad Versace <chad.versace at linux.intel.com>
---
 tests/util/CMakeLists.txt |   1 +
 tests/util/piglit-log.c   | 117 ++++++++++++++++++++++++++++++++++++++++++++++
 tests/util/piglit-log.h   |  67 ++++++++++++++++++++++++++
 tests/util/piglit-util.h  |   2 +
 4 files changed, 187 insertions(+)
 create mode 100644 tests/util/piglit-log.c
 create mode 100644 tests/util/piglit-log.h

diff --git a/tests/util/CMakeLists.txt b/tests/util/CMakeLists.txt
index e678d58..3a97daf 100644
--- a/tests/util/CMakeLists.txt
+++ b/tests/util/CMakeLists.txt
@@ -10,6 +10,7 @@ set(UTIL_INCLUDES
 	)
 
 set(UTIL_SOURCES
+	piglit-log.c
 	piglit-util.c
 	)
 
diff --git a/tests/util/piglit-log.c b/tests/util/piglit-log.c
new file mode 100644
index 0000000..1cf9b10
--- /dev/null
+++ b/tests/util/piglit-log.c
@@ -0,0 +1,117 @@
+/*
+ * Copyright 2014 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+#include <inttypes.h>
+#include <stdio.h>
+#include <stdarg.h>
+
+#include "piglit-log.h"
+#include "piglit-util.h"
+
+struct piglit_log_opt_list {
+	intptr_t val;
+	bool is_env_set;
+};
+
+/**
+ * Array of logging options, one entry for each value of enum piglit_log_opt.
+ */
+static struct piglit_log_opt_list opts[PIGLIT_LOG_OPT_MAX + 1];
+
+static void
+get_env_overrides(void)
+{
+	static bool once = true;
+	const char *env = NULL;
+
+	if (!once) {
+		return;
+	}
+	once = false;
+
+	env = getenv("PIGLIT_LOG_PRINT_TID");
+	if (env && !streq(env, "")) {
+		opts[PIGLIT_LOG_PRINT_TID].is_env_set = true;
+		opts[PIGLIT_LOG_PRINT_TID].val = atoi(env);
+	}
+}
+
+/** Is option out of bounds?  */
+static bool
+is_opt_oob(enum piglit_log_opt opt)
+{
+	return opt < 0 || opt > PIGLIT_LOG_OPT_MAX;
+}
+
+intptr_t
+piglit_log_get_opt(enum piglit_log_opt opt)
+{
+	get_env_overrides();
+
+	if (is_opt_oob(opt)) {
+		return 0;
+	}
+
+	return opts[opt].val;
+}
+
+void
+piglit_log_set_opt(enum piglit_log_opt opt, intptr_t value) {
+	get_env_overrides();
+
+	if (is_opt_oob(opt) || opts[opt].is_env_set) {
+		return;
+	}
+
+	opts[opt].val = value;
+}
+
+static void
+piglit_log_tagv(const char *tag, const char *fmt, va_list ap)
+{
+	printf("piglit");
+	if (piglit_log_get_opt(PIGLIT_LOG_PRINT_TID)) {
+		printf("(%"PRIu64")", piglit_gettid());
+	}
+	printf(": %s: ", tag);
+	vprintf(fmt, ap);
+	printf("\n");
+}
+
+void
+piglit_loge(const char *fmt, ...)
+{
+	va_list ap;
+	va_start(ap, fmt);
+	piglit_log_tagv("error", fmt, ap);
+	va_end(ap);
+}
+
+void
+piglit_logi(const char *fmt, ...)
+{
+	va_list ap;
+	va_start(ap, fmt);
+	piglit_log_tagv("info", fmt, ap);
+	va_end(ap);
+}
diff --git a/tests/util/piglit-log.h b/tests/util/piglit-log.h
new file mode 100644
index 0000000..13037be
--- /dev/null
+++ b/tests/util/piglit-log.h
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+#pragma once
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * \brief Piglit logging options
+ *
+ * Options can be set with the setter function piglit_log_set_opt() as well as
+ * environment variables.  For each option, the environment variable of the
+ * same name, if set to a non-empty value,  overrides any value set with the
+ * setter function.
+ */
+enum piglit_log_opt {
+	/**
+	 * Print thread id in log messages.
+	 * Option type: bool
+	 */
+	PIGLIT_LOG_PRINT_TID = 0,
+
+	/** Fake option. This is the maximum value of piglit_log_opt. */
+	PIGLIT_LOG_OPT_MAX = 0,
+};
+
+intptr_t
+piglit_log_get_opt(enum piglit_log_opt);
+
+void
+piglit_log_set_opt(enum piglit_log_opt opt, intptr_t value);
+
+/** Log an error.message. */
+void
+piglit_loge(const char *fmt, ...);
+
+/** Log an info message. */
+void
+piglit_logi(const char *fmt, ...);
+
+#ifdef __cplusplus
+} /* end extern "C" */
+#endif
diff --git a/tests/util/piglit-util.h b/tests/util/piglit-util.h
index 0f25d67..f6316a0 100644
--- a/tests/util/piglit-util.h
+++ b/tests/util/piglit-util.h
@@ -49,6 +49,8 @@ extern "C" {
 #include <math.h>
 #include <float.h>
 
+#include "piglit-log.h"
+
 #if defined(_MSC_VER)
 
 #define snprintf sprintf_s
-- 
1.8.5.3