parallel_log.hpp

Go to the documentation of this file.

/*
 * Copyright 2008,2009,2010,2011,2012 Stephan Ossowski, Korbinian Schneeberger,
 * Felix Ott, Joerg Hagmann, Alf Scotland, Sebastian Bender
 * 
 * This file is part of SHORE.
 * 
 * SHORE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * SHORE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with SHORE.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef SHORE_PARALLEL_PARALLEL_LOG_HPP__
#define SHORE_PARALLEL_PARALLEL_LOG_HPP__

#include <iostream>
#include <deque>
#include <stdexcept>
#include <map>
#include <vector>

#include <boost/thread/thread.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <boost/thread/condition.hpp>

#ifdef WITH_MPI
#include <boost/thread.hpp>
#include <boost/serialization/string.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/archive/text_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#endif // WITH_MPI

#include "shore/processing/pipeline.hpp"
#include "shore/stream/streams.hpp"
#include "shore/base/memops.hpp"

namespace shore {

class parallel_log
{
 private:

        typedef boost::recursive_mutex mutex_type;
        typedef boost::recursive_mutex::scoped_lock lock_type;
        typedef std::map<std::string,mutex_type *> mutexmap_t;

        std::string m_filename;

 #ifdef WITH_MPI
        // serialization for passing around as MPI message
        friend class boost::serialization::access;

        template<class Archive>
        void serialize(Archive& ar,const unsigned int version)
        {
                ar&m_filename;
        }
 #endif // WITH_MPI

 public:

        parallel_log(const std::string &fn="stderr");
        parallel_log(const parallel_log &other);
        parallel_log &operator=(const parallel_log &other);

        void set_file(const std::string &fn);
        const std::string &get_file() const;
        std::string get_dir() const;

        class log_lock;

        log_lock lock() const;

        class log_lock
        {
         private:

                friend class parallel_log;

                static mutex_type m_mastermutex;
                static mutexmap_t m_mutexmap;
                static shore::ptrkeeper m_cleaner;

                std::string m_filename;
                int m_threadid;
                mutex_type *m_mutex;
                lock_type *m_lock;
                shore::ostreams m_os;


                void init();

                void activate();

                log_lock(const std::string &logfile);

                log_lock(const log_lock &other);

         public:

                ~log_lock();

                std::ostream &out;
        };
};

} // namespace shore

#endif // SHORE_PARALLEL_PARALLEL_LOG_HPP__