Cycles: Add support of Glog logging
authorSergey Sharybin <sergey.vfx@gmail.com>
Mon, 8 Sep 2014 12:01:24 +0000 (18:01 +0600)
committerSergey Sharybin <sergey.vfx@gmail.com>
Thu, 25 Sep 2014 11:08:32 +0000 (17:08 +0600)
This commit makes it possible to use Glog library for the debug logging.
For now only possible when using CMake and in order to use the logging
the WITH_CYCLES_LOGGING configuration variable is to be enabled.

When this option is not enabled or when using Scons there's no difference
in Cycles behavior at all, when using logging and no output to the console
impact is gonna to be minimal.

This is done in order to make it possible to have debug logging persistent
in code (without need to add it when troubleshooting some bug and removing
it afterwards).

For now actual logging is not placed yet, only all the functions needed for
the logging are written and so.

CMakeLists.txt
extern/libmv/CMakeLists.txt
intern/cycles/CMakeLists.txt
intern/cycles/blender/CCL_api.h
intern/cycles/blender/CMakeLists.txt
intern/cycles/blender/blender_logging.cpp [new file with mode: 0644]
intern/cycles/util/CMakeLists.txt
intern/cycles/util/util_logging.cpp [new file with mode: 0644]
intern/cycles/util/util_logging.h [new file with mode: 0644]
source/creator/CMakeLists.txt
source/creator/creator.c

index 1dd972196fe46a88fd25c48527a8b12faef913de..2cabeb69e4bd43b754151468e507ff418d5e62fd 100644 (file)
@@ -280,6 +280,7 @@ option(WITH_CYCLES_CUDA_BINARIES    "Build cycles CUDA binaries" OFF)
 set(CYCLES_CUDA_BINARIES_ARCH sm_20 sm_21 sm_30 sm_35 sm_50 CACHE STRING "CUDA architectures to build binaries for")
 mark_as_advanced(CYCLES_CUDA_BINARIES_ARCH)
 unset(PLATFORM_DEFAULT)
+option(WITH_CYCLES_LOGGING     "Build cycles with logging support" OFF)
 
 # LLVM
 option(WITH_LLVM                                       "Use LLVM" OFF)
index d482819c2cec4655729e1eb35dffc65c0408865c..6a4a61ea7799956cf41db934f935b71dbf41df86 100644 (file)
@@ -240,7 +240,7 @@ if(WITH_LIBMV)
 endif()
 
 # make GLog a separate target, so it can be used for gtest as well.
-if(WITH_LIBMV OR WITH_GTESTS)
+if(WITH_LIBMV OR WITH_GTESTS OR WITH_CYCLES_LOGGING)
        # We compile GLog together with GFlag so we don't worry about
        # adding extra lib to linker.
        set(GLOG_SRC
index ccf6aac945e81bc35fb0ae16583d081a0218fd4b..bfd29dcf606bcebc10c423333b54c3eae92946c7 100644 (file)
@@ -128,6 +128,24 @@ add_definitions(
        -DWITH_MULTI
 )
 
+if(WITH_CYCLES_LOGGING)
+       add_definitions(-DWITH_CYCLES_LOGGING)
+       add_definitions(-DGOOGLE_GLOG_DLL_DECL=)
+       if(WIN32)
+               include_directories(
+                       SYSTEM
+                       ../../extern/libmv/third_party/glog/src/windows
+                       ../../extern/libmv/third_party/gflags
+               )
+       else()
+               include_directories(
+                       SYSTEM
+                       ../../extern/libmv/third_party/glog/src
+                       ../../extern/libmv/third_party/gflags
+               )
+       endif()
+endif()
+
 include_directories(
        SYSTEM
        ${BOOST_INCLUDE_DIR}
index 2772b9ac8a7c0b29478a5f1c2ba26f3619803d59..cfd0c3ef2644f67710e7ef1e83a6e10219aa5fa0 100644 (file)
@@ -36,6 +36,10 @@ CCLDeviceInfo *CCL_compute_device_list(int device_type);
 
 void *CCL_python_module_init(void);
 
+void CCL_init_logging(const char *argv0);
+void CCL_start_debug_logging(void);
+void CCL_logging_verbosity_set(int verbosity);
+
 #ifdef __cplusplus
 }
 #endif
index 548aac85af907d0771a0cfde773e175e941d044a..13ac0be0562ced68acc438db3b35f472221c01db 100644 (file)
@@ -25,6 +25,7 @@ set(SRC
        blender_object.cpp
        blender_particles.cpp
        blender_curves.cpp
+       blender_logging.cpp
        blender_python.cpp
        blender_session.cpp
        blender_shader.cpp
diff --git a/intern/cycles/blender/blender_logging.cpp b/intern/cycles/blender/blender_logging.cpp
new file mode 100644 (file)
index 0000000..d3f1acc
--- /dev/null
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2011-2014 Blender Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License
+ */
+
+#include "CCL_api.h"
+
+#include <stdio.h>
+
+#include "util_logging.h"
+
+#ifdef _MSC_VER
+#  define snprintf _snprintf
+#endif
+
+void CCL_init_logging(const char *argv0)
+{
+#ifdef WITH_CYCLES_LOGGING
+       /* Make it so FATAL messages are always print into console. */
+       char severity_fatal[32];
+       snprintf(severity_fatal, sizeof(severity_fatal), "%d",
+                google::GLOG_FATAL);
+
+       google::InitGoogleLogging(argv0);
+       google::SetCommandLineOption("logtostderr", "1");
+       google::SetCommandLineOption("v", "0");
+       google::SetCommandLineOption("stderrthreshold", severity_fatal);
+       google::SetCommandLineOption("minloglevel", severity_fatal);
+#else
+       (void) argv0;
+#endif
+}
+
+void CCL_start_debug_logging(void)
+{
+#ifdef WITH_CYCLES_LOGGING
+       google::SetCommandLineOption("logtostderr", "1");
+       google::SetCommandLineOption("v", "2");
+       google::SetCommandLineOption("stderrthreshold", "1");
+       google::SetCommandLineOption("minloglevel", "0");
+#endif
+}
+
+void CCL_logging_verbosity_set(int verbosity)
+{
+#ifdef WITH_CYCLES_LOGGING
+       char val[10];
+       snprintf(val, sizeof(val), "%d", verbosity);
+
+       google::SetCommandLineOption("v", val);
+#else
+       (void) verbosity;
+#endif
+}
index d9b97a7f6b02f4e79a2e4d7b5350812eeada90b8..6120e7e84569d434a7c96ad687114c2309bdf4c1 100644 (file)
@@ -11,6 +11,7 @@ set(INC_SYS
 set(SRC
        util_cache.cpp
        util_dynlib.cpp
+       util_logging.cpp
        util_md5.cpp
        util_path.cpp
        util_string.cpp
@@ -40,6 +41,7 @@ set(SRC_HEADERS
        util_hash.h
        util_image.h
        util_list.h
+       util_logging.h
        util_map.h
        util_math.h
        util_md5.h
diff --git a/intern/cycles/util/util_logging.cpp b/intern/cycles/util/util_logging.cpp
new file mode 100644 (file)
index 0000000..0722f16
--- /dev/null
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2011-2014 Blender Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License
+ */
+
+#include <util_logging.h>
+
+#include "util_math.h"
+
+CCL_NAMESPACE_BEGIN
+
+std::ostream& operator <<(std::ostream &os,
+                          const float3 &value)
+{
+       os << "(" << value.x
+          << ", " << value.y
+          << ", " << value.z
+          << ")";
+       return os;
+}
+
+CCL_NAMESPACE_END
diff --git a/intern/cycles/util/util_logging.h b/intern/cycles/util/util_logging.h
new file mode 100644 (file)
index 0000000..2bd0fac
--- /dev/null
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2011-2014 Blender Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License
+ */
+
+#ifndef __UTIL_LOGGING_H__
+#define __UTIL_LOGGING_H__
+
+#if defined(WITH_CYCLES_LOGGING) && !defined(__KERNEL_GPU__)
+#  include <glog/logging.h>
+#else
+#  include <iostream>
+#endif
+
+CCL_NAMESPACE_BEGIN
+
+#if !defined(WITH_CYCLES_LOGGING) || defined(__KERNEL_GPU__)
+class StubStream : public std::ostream {
+ public:
+       StubStream () { }
+};
+
+class LogMessageVoidify {
+public:
+       LogMessageVoidify() { }
+       void operator&(::std::ostream&) { }
+};
+
+#  define LOG_SUPPRESS() (true) ? (void) 0 : LogMessageVoidify() & StubStream()
+#  define LOG(severity) LOG_SUPPRESS()
+#  define VLOG(severity) LOG_SUPPRESS()
+
+#endif
+
+class float3;
+
+std::ostream& operator <<(std::ostream &os,
+                          const float3 &value);
+
+CCL_NAMESPACE_END
+
+#endif /* __UTIL_LOGGING_H__ */
index 6ed87f6596cf59ed9fe37865609cb334fe09d4f2..35cbff3334249397d25829b4469208c1f370c93c 100644 (file)
@@ -48,6 +48,11 @@ if(WITH_LIBMV)
        add_definitions(-DWITH_LIBMV)
 endif()
 
+if(WITH_CYCLES AND WITH_CYCLES_LOGGING)
+       blender_include_dirs(../../intern/cycles/blender)
+       add_definitions(-DWITH_CYCLES_LOGGING)
+endif()
+
 if(WITH_CODEC_FFMPEG)
        add_definitions(-DWITH_FFMPEG)
 endif()
index 3937ae181430ce320854fa03e9ea3ebef91f3e1b..3511c9dc2cbff2cbf4c2fec81a0dd4ac449fc3b3 100644 (file)
 #  include "libmv-capi.h"
 #endif
 
+#ifdef WITH_CYCLES_LOGGING
+#  include "CCL_api.h"
+#endif
+
 /* from buildinfo.c */
 #ifdef BUILD_DATE
 extern char build_date[];
@@ -308,6 +312,9 @@ static int print_help(int UNUSED(argc), const char **UNUSED(argv), void *data)
        BLI_argsPrintArgDoc(ba, "--debug-handlers");
 #ifdef WITH_LIBMV
        BLI_argsPrintArgDoc(ba, "--debug-libmv");
+#endif
+#ifdef WITH_CYCLES_LOGGING
+       BLI_argsPrintArgDoc(ba, "--debug-cycles");
 #endif
        BLI_argsPrintArgDoc(ba, "--debug-memory");
        BLI_argsPrintArgDoc(ba, "--debug-jobs");
@@ -450,6 +457,15 @@ static int debug_mode_libmv(int UNUSED(argc), const char **UNUSED(argv), void *U
 }
 #endif
 
+#ifdef WITH_CYCLES_LOGGING
+static int debug_mode_cycles(int UNUSED(argc), const char **UNUSED(argv),
+                             void *UNUSED(data))
+{
+       CCL_start_debug_logging();
+       return 0;
+}
+#endif
+
 static int debug_mode_memory(int UNUSED(argc), const char **UNUSED(argv), void *UNUSED(data))
 {
        MEM_set_memory_debug();
@@ -887,6 +903,8 @@ static int set_verbosity(int argc, const char **argv, void *UNUSED(data))
 
 #ifdef WITH_LIBMV
                libmv_setLoggingVerbosity(level);
+#elif defined(WITH_CYCLES_LOGGING)
+               CCL_logging_verbosity_set(level);
 #else
                (void)level;
 #endif
@@ -1418,6 +1436,9 @@ static void setupArguments(bContext *C, bArgs *ba, SYS_SystemHandle *syshandle)
 
 #ifdef WITH_LIBMV
        BLI_argsAdd(ba, 1, NULL, "--debug-libmv", "\n\tEnable debug messages from libmv library", debug_mode_libmv, NULL);
+#endif
+#ifdef WITH_CYCLES_LOGGING
+       BLI_argsAdd(ba, 1, NULL, "--debug-cycles", "\n\tEnable debug messages from Cycles", debug_mode_cycles, NULL);
 #endif
        BLI_argsAdd(ba, 1, NULL, "--debug-memory", "\n\tEnable fully guarded memory allocation and debugging", debug_mode_memory, NULL);
 
@@ -1583,6 +1604,8 @@ int main(
 
 #ifdef WITH_LIBMV
        libmv_initLogging(argv[0]);
+#elif defined(WITH_CYCLES_DEBUG)
+       CCL_init_logging(argv[0]);
 #endif
 
        setCallbacks();