ThreadMonitor.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_THREADMONITOR_H_
#define _MIRA_THREADMONITOR_H_

#include <map>
#include <vector>

#include <platform/Platform.h>
#include <utils/Singleton.h>
#include <utils/Time.h>

#include <thread/Thread.h>
#include <thread/ThreadID.h>

#include <serialization/adapters/std/vector>

namespace mira {


class MIRA_BASE_EXPORT ThreadMonitor :
    public LazySingleton<ThreadMonitor>
{
public:

    ThreadMonitor();

    virtual ~ThreadMonitor();


public:

    void addThisThread(const std::string& pName);

    void removeThisThread();

    void removeThread(const boost::thread& pThread);

    void removeThread(const boost::thread::id& pThreadID);

    void removeThread(ThreadID pThreadID);


public:

    struct BasicThreadIdentity
    {
        template<typename Reflector>
        void reflect(Reflector& r)
        {
            r.property("ID", id, "The native thread id (number)");
            r.property("Name", name, "The thread's name");
        }

        ThreadID          id;   
        std::string       name; 
    };

    struct ThreadIdentity : public BasicThreadIdentity
    {
        boost::thread::id bid;  
    };

    struct ThreadInfoBase
    {
        template<typename Reflector>
        void reflect(Reflector& r)
        {
            r.property("CreateTime", create_time, "Thread creation time, UTC");
            r.property("UserTime", user_time, "Time spent in user mode");
            r.property("KernelTime", kernel_time, "Time spent in kernel mode");
        }

        Time      create_time;    
        Duration  user_time;      
        Duration  kernel_time;    
    };

    template<typename TID>
    struct ThreadInfoTempl : public ThreadInfoBase
    {
        ThreadInfoTempl() = default;

        template<typename OtherTID>
        ThreadInfoTempl(const ThreadInfoTempl<OtherTID>& other)
            : ThreadInfoBase(other), known(other.known), identity(other.identity)
        {}

        template<typename Reflector>
        void reflect(Reflector& r)
        {
            r.property("Known", known, "Thread is registered to the ThreadMonitor?");
            r.property("Identity", identity, "Thread identity info");
            r.template reflectBase<ThreadInfoBase>(*this);
        }

        bool      known = false;  
        TID       identity;       
    };

    using BasicThreadInfo = ThreadInfoTempl<BasicThreadIdentity>;
    using BasicThreadInfoVector = std::vector<BasicThreadInfo>;

    using ThreadInfo = ThreadInfoTempl<ThreadIdentity>;
    using ThreadInfoVector = std::vector<ThreadInfo>;

public:
    ThreadInfoVector getThreadInformation();

    BasicThreadInfoVector getBasicThreadInformation();


private:
    typedef std::map<ThreadID, ThreadIdentity> ThreadMap;

    boost::mutex mThreadsMutex;
    ThreadMap mThreads;
};


}

#endif