Fix Logger under MSVC iostream libraries
authorMarco Costalba <mcostalba@gmail.com>
Tue, 20 Mar 2012 19:50:24 +0000 (20:50 +0100)
committerMarco Costalba <mcostalba@gmail.com>
Tue, 20 Mar 2012 20:46:08 +0000 (21:46 +0100)
We need splitted Tie classes because MSVC stream library
takes a lock on buffer both on reading and on writing and
this causes an hang because, while searching, the I/O
thread is locked on getline() and when main thread is
trying to std::cout() something it blocks on the same
lock waiting for I/O thread getting some input and
releasing the lock.

The solution is to use separated streambuf objects for
cin and cout.

Signed-off-by: Marco Costalba <mcostalba@gmail.com>
src/misc.cpp

index bdb2cc27c4d31372165ebfff8e073f535c913064..8bc413f47be9657217ce0151a0604702f3b100c0 100644 (file)
@@ -106,16 +106,42 @@ void dbg_print() {
 
 
 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
-/// cout.rdbuf() with this one that tees cin and cout to a file stream. We can
-/// toggle the logging of std::cout and std:cin at runtime while preserving i/o
-/// functionality and without changing a single line of code!
+/// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
+/// can toggle the logging of std::cout and std:cin at runtime while preserving
+/// usual i/o functionality and without changing a single line of code!
 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
 
-class Logger: public streambuf {
+class Logger {
 
-  Logger() : cinbuf(cin.rdbuf()), coutbuf(cout.rdbuf()) {}
+  Logger() : in(cin.rdbuf(), file), out(cout.rdbuf(), file) {}
   ~Logger() { start(false); }
 
+  struct Tie: public streambuf { // MSVC requires splitted streambuf for cin and cout
+
+    Tie(streambuf* b, ofstream& f) : buf(b), file(f) {}
+
+    int sync() { return file.rdbuf()->pubsync(), buf->pubsync(); }
+    int overflow(int c) { return log(buf->sputc((char)c), "<< "); }
+    int underflow() { return buf->sgetc(); }
+    int uflow() { return log(buf->sbumpc(), ">> "); }
+
+    int log(int c, const char* prefix) {
+
+      static int last = '\n';
+
+      if (last == '\n')
+          file.rdbuf()->sputn(prefix, 3);
+
+      return last = file.rdbuf()->sputc((char)c);
+    }
+
+    streambuf* buf;
+    ofstream& file;
+  };
+
+  ofstream file;
+  Tie in, out;
+
 public:
   static void start(bool b) {
 
@@ -124,40 +150,20 @@ public:
     if (b && !l.file.is_open())
     {
         l.file.open("io_log.txt", ifstream::out | ifstream::app);
-        cin.rdbuf(&l);
-        cout.rdbuf(&l);
+        cin.rdbuf(&l.in);
+        cout.rdbuf(&l.out);
     }
     else if (!b && l.file.is_open())
     {
-        cout.rdbuf(l.coutbuf);
-        cin.rdbuf(l.cinbuf);
+        cout.rdbuf(l.out.buf);
+        cin.rdbuf(l.in.buf);
         l.file.close();
     }
   }
-
-private:
-  int sync() { return file.rdbuf()->pubsync(), coutbuf->pubsync(); }
-  int overflow(int c) { return log(coutbuf->sputc((char)c), "<< ") ; }
-  int underflow() { return cinbuf->sgetc(); }
-  int uflow() { return log(cinbuf->sbumpc(), ">> "); }
-
-  int log(int c, const char* prefix) {
-
-    static int last = '\n';
-
-    if (last == '\n')
-        file.rdbuf()->sputn(prefix, 3);
-
-    return last = file.rdbuf()->sputc((char)c);
-  }
-
-private:
-  ofstream file;
-  streambuf *cinbuf, *coutbuf;
 };
 
 
-/// Trampoline helper to avoid moving Logger to misc.h header
+/// Trampoline helper to avoid moving Logger to misc.h
 void start_logger(bool b) { Logger::start(b); }