profiler.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program 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 Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
#include "irrlichttypes.h"
#include <cassert>
#include <string>
#include <map>
#include <ostream>
 
#include "threading/mutex_auto_lock.h"
#include "util/timetaker.h"
#include "util/numeric.h"      // paging()
 
// Global profiler
class Profiler;
extern Profiler *g_profiler;
 
/*
    Time profiler
*/
 
class Profiler
{
public:
    Profiler();
 
    void add(const std::string &name, float value);
    void avg(const std::string &name, float value);
    void clear();
 
    float getValue(const std::string &name) const;
    int getAvgCount(const std::string &name) const;
    u64 getElapsedMs() const;
 
    typedef std::map<std::string, float> GraphValues;
 
    // Returns the line count
    int print(std::ostream &o, u32 page = 1, u32 pagecount = 1);
    void getPage(GraphValues &o, u32 page, u32 pagecount);
 
 
    void graphAdd(const std::string &id, float value)
    {
        MutexAutoLock lock(m_mutex);
        std::map<std::string, float>::iterator i =
                m_graphvalues.find(id);
        if(i == m_graphvalues.end())
            m_graphvalues[id] = value;
        else
            i->second += value;
    }
    void graphGet(GraphValues &result)
    {
        MutexAutoLock lock(m_mutex);
        result = m_graphvalues;
        m_graphvalues.clear();
    }
 
    void remove(const std::string& name)
    {
        MutexAutoLock lock(m_mutex);
        m_avgcounts.erase(name);
        m_data.erase(name);
    }
 
private:
    std::mutex m_mutex;
    std::map<std::string, float> m_data;
    std::map<std::string, int> m_avgcounts;
    std::map<std::string, float> m_graphvalues;
    u64 m_start_time;
};
 
enum ScopeProfilerType{
    SPT_ADD,
    SPT_AVG,
    SPT_GRAPH_ADD
};
 
class ScopeProfiler
{
public:
    ScopeProfiler(Profiler *profiler, const std::string &name,
            ScopeProfilerType type = SPT_ADD);
    ~ScopeProfiler();
private:
    Profiler *m_profiler = nullptr;
    std::string m_name;
    TimeTaker *m_timer = nullptr;
    enum ScopeProfilerType m_type;
};