4

我一直在寻找解决线程安全日志记录问题的各种方法,但我还没有看到像这样的东西,所以我不知道它是否有点糟糕,因为我是 C++ 的一个完整的新手,线程和 iostream。它似乎适用于我已经完成的基本测试。

基本上我有一个 Log 类(创意,我知道......),它为标准操纵器设置了 operator<<,所以我可以愉快地传递我想要的任何东西。

但是,我知道类似:

std::cout << "Threads" << " will" << " mess" << " with" << "this." << std::endl;

当多个线程写入 cout (或 Log ostream 指向的任何地方)时,可能会交错。因此,我创建了一些特定于 Log 类的操纵器,让我可以这样做:

Log::log << lock << "Write" << " what" << " I" << " want" << std::endl << unlock;

我只是想知道这是否是一个天生糟糕的想法,记住我愿意接受 Log 类的用户需要接受“锁定”和“解锁”的约束。我考虑过让'std::endl'自动解锁,但这似乎会让人更头疼......我认为无论如何都应该在测试中出现无纪律的使用,但如果有人能看到一种方法来使这种使用导致编译-时间错误,那会很好。

对于让我的代码更简洁的任何建议,我也将不胜感激。

这是用于演示目的的类的精简版;整个事情还有更多的构造函数采用文件名之类的东西,因此与问题无关。

#include <iostream>
#include <thread>
#include <fstream>

class Log{
public:
  //Constructors
  Log(std::ostream & os);
  // Destructor
  ~Log();
  // Input Functions
  Log & operator<<(const std::string & msg);
  Log & operator<<(const int & msg);
  Log & operator<<(std::ostream & (*man)(std::ostream &)); // Handles manipulators like endl.
  Log & operator<<(std::ios_base & (*man)(std::ios_base &)); // Handles manipulators like hex.
  Log & operator<<(Log & (*man)(Log &)); // Handles custom Log manipulators like lock and unlock.
  friend Log & lock(Log & log); // Locks the Log for threadsafe output.
  friend Log & unlock(Log & log); // Unlocks the Log once threadsafe output is complete.
private:
  std::fstream logFile;
  std::ostream & logStream;
  std::mutex guard;
};

// Log class manipulators.
Log & lock(Log & log); // Locks the Log for threadsafe output.
Log & unlock(Log & log); // Unlocks the Log once threadsafe output is complete.

void threadUnsafeTask(int * input, Log * log);
void threadSafeTask(int * input, Log * log);

int main(){
  int one(1), two(2);
  Log log(std::cout);
  std::thread first(threadUnsafeTask, &one, &log);
  std::thread second(threadUnsafeTask, &two, &log);
  first.join();
  second.join();
  std::thread third(threadSafeTask, &one, &log);
  std::thread fourth(threadSafeTask, &two, &log);
  third.join();
  fourth.join();
  return 0;
}

void threadUnsafeTask(int * input, Log * log){
  *log << "Executing" << " thread '" << *input << "', " << "expecting " << "interruptions " << "frequently." << std::endl;
}

void threadSafeTask(int * input, Log * log){
  *log << lock << "Executing" << " thread '" << *input << "', " << "not expecting " << "interruptions." << std::endl << unlock;
}

// Constructors (Most left out as irrelevant)
Log::Log(std::ostream & os): logFile(), logStream(logFile), guard(){
  logStream.rdbuf(os.rdbuf());
}

// Destructor
Log::~Log(){
  logFile.close();
}

// Output Operators
Log & Log::operator<<(const std::string & msg){
  logStream << msg;
  return *this;
}

Log & Log::operator<<(const int & msg){
  logStream << msg;
  return *this;
}

Log & Log::operator<<(std::ostream & (*man)(std::ostream &)){
  logStream << man;
  return *this;
}

Log & Log::operator<<(std::ios_base & (*man)(std::ios_base &)){
  logStream << man;
  return *this;
}

Log & Log::operator<<(Log & (*man)(Log &)){
  man(*this);
  return *this;
}

// Manipulator functions.
Log & lock(Log & log){
  log.guard.lock();
  return log;
}

Log & unlock(Log & log){
  log.guard.unlock();
  return log;
}

它适用于我在 Ubuntu 12.04 g++ 上,编译为:

g++ LogThreadTest.cpp -o log -std=c++0x -lpthread

与制作定制机械手相关的部分从这里被无耻地抄袭,但不要因为我无能的复制面而责怪他们。

4

3 回答 3

4

这是个坏主意。想象一下:

void foo()
{
    throw std::exception();
}

log << lock << "Write" << foo() << " I" << " want" << std::endl << unlock;
                          ^
                          exception!

这会让你Log锁定。这很糟糕,因为其他线程可能正在等待锁定。每当您忘记执行unlock. 您应该在这里使用 RAII:

// just providing a scope
{
    std::lock_guard<Log> lock(log);
    log << "Write" << foo() << " I" << " want" << std::endl;
}

您需要调整您的lockunlock方法以具有签名void lock()并使void unlock()它们成为该类的成员函数Log


另一方面,这相当笨重。请注意,在 C++11 中, usingstd::cout是线程安全的。所以你可以轻松做到

std::stringstream stream;
stream << "Write" << foo() << " I" << " want" << std::endl;
std::cout << stream.str();

这完全没有额外的锁。

于 2013-10-22T14:10:06.007 回答
3

您不需要显式传递锁操纵器,您可以使用哨兵(具有 RAII 语义,正如 Hans Passant 所说)

class Log{
public:
  Log(std::ostream & os);
  ~Log();

  class Sentry {
      Log &log_;
  public:
      Sentry(Log &l) log_(l) { log_.lock(); }
      ~Sentry() { log_.unlock(); }

      // Input Functions just forward to log_.logStream
      Sentry& operator<<(const std::string & msg);
      Sentry& operator<<(const int & msg);
      Sentry& operator<<(std::ostream & (*man)(std::ostream &)); // Handles manipulators like endl.
      Sentry& operator<<(std::ios_base & (*man)(std::ios_base &)); // Handles manipulators like hex.
    };

    template <typename T>
    Sentry operator<<(T t) { return Sentry(*this) << t; }
    void lock();
    void unlock();

private:
  std::fstream logFile;
  std::ostream & logStream;
  std::mutex guard;
};

现在,写

Log::log << "Write" << " what" << " I" << " want" << foo() << std::endl;

将要:

  1. 创建一个临时哨兵对象
    • 锁定 Log 对象
  2. ... 将每个operator<<调用转发到父 Log 实例 ...
  3. 然后在表达式末尾超出范围(或如果foo抛出)
    • 解锁 Log 对象

尽管这是安全的,但它也会产生很多争用(在格式化消息时,互斥锁的锁定时间比我通常想要的要长)。一种争用较低的方法是在完全不加锁的情况下将格式化写入本地存储(线程本地或作用域本地),然后持有足够长的锁以将其移动到共享日志队列中。

于 2013-10-22T14:16:46.620 回答
2

这不是一个非常好的主意,因为有人会unlock在某个时候致命地忘记它,导致所有线程在下一个日志中挂起。如果您正在记录的表达式之一抛出,还有一个问题。(它不应该发生,因为你不想在日志语句中有实际行为,并且不应该抛出没有任何行为的东西。但你永远不知道。)

记录日志的常用解决方案是使用一个特殊的临时对象,它在其构造函数中获取锁,并在析构函数中释放它(并且还执行刷新,并确保有一个尾随'\n')。这可以在 C++11 中非常优雅地完成,使用移动语义(因为您通常希望在函数中创建临时的实例,但其析构函数应该起作用的临时在函数之外);在 C++03 中,您需要允许复制,并确保它只是释放锁的最终副本。

粗略地说,您的Log课程看起来像:

struct LogData
{
    std::unique_lock<std::mutex> myLock
    std::ostream myStream;

    LogData( std::unique_lock<std::mutex>&& lock,
             std::streambuf* logStream )
        :  myLock( std::move( lock ) )
        ,  myStream( logStream )
    {
    }

    ~LogData()
    {
        myStream.flush();
    }
};

class Log
{
    LogData* myDest;
public:
    Log( LogData* dest )
        : myDest( dest )
    {
    }
    Log( Log&& other )
        : myDest( other.myDest )
    {
        other.myDest = nullptr;
    }
    ~Log()
    {
        if ( myDest ) {
            delete myDest;
        }
    }
    Log& operator=( Log const& other ) = delete;

    template <typename T>
    Log& operator<<( T const& obj )
    {
        if ( myDest != nullptr ) {
            myDest->myStream << obj;
        }
    }
};

(如果您的编译器没有移动语义,您将不得不以某种方式伪造它。如果最坏的情况发生,您可以只使 Log 的单指针成员可变,并将相同的代码放在具有传统的复制构造函数中签名。丑陋,但作为一种解决方法......)

在此解决方案中,您将有一个 function log,它返回此类的一个实例,该实例具有有效的LogData (动态分配的)或空指针,具体取决于日志记录是否处于活动状态。(可以通过使用LogData具有启动和结束日志记录功能的静态实例来避免动态分配,但这有点复杂。)

于 2013-10-22T14:38:09.387 回答