Tool.hpp

Go to the documentation of this file.

/*
 *  This file is part of AQUAgpusph, a free CFD program based on SPH.
 *  Copyright (C) 2012  Jose Luis Cercos Pita <jl.cercos@upm.es>
 *
 *  AQUAgpusph 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.
 *
 *  AQUAgpusph 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 AQUAgpusph.  If not, see <http://www.gnu.org/licenses/>.
 */

 
#ifndef TOOL_H_INCLUDED
#define TOOL_H_INCLUDED
 
#include "aquagpusph/sphPrerequisites.hpp"
#include "aquagpusph/Variable.hpp"
#include "aquagpusph/AuxiliarMethods.hpp"
#include <math.h>
#include <vector>
#include <tuple>
#include <deque>
#include <algorithm>
#include <numeric>
 
#ifndef N_PROFILE_SAMPLES
#define N_PROFILE_SAMPLES 100
#endif
 
namespace Aqua {
namespace CalcServer {

class Named
{
  public:
        Named(const std::string name)
          : _name(name)
        {
        }

        ~Named() {}

        inline void name(const std::string tool_name) { _name = tool_name; };

        inline const std::string name() const { return _name; }
 
  private:
        std::string _name;
};
 
class Tool;

class Profile : public Aqua::CalcServer::Named
{
  public:
        Profile(const std::string name, Tool* tool)
          : Named(name)
          , _tool(tool)
          , _step(0)
        {
        }

        virtual ~Profile() {}

        void step();
 
  protected:
        void sample(cl_ulong start, cl_ulong end);
 
  private:
        Tool* _tool;

        cl_ulong _step;
};

class Profiler
{
  public:
        Profiler() {}

        ~Profiler()
        {
                for (auto i : _instances)
                        delete i;
        }

        inline std::vector<Profile*> substages() const { return _instances; }
 
  protected:
        inline void substages(std::vector<Profile*> instances)
        {
                _instances = instances;
        }
 
  private:
        std::vector<Profile*> _instances;
};

class DECLDIR Tool
  : public Aqua::CalcServer::Named
  , public Aqua::CalcServer::Profiler
{
  public:
        Tool(const std::string tool_name, bool once = false);

        virtual ~Tool();

        virtual void setup();

        virtual void execute();

        virtual inline Tool* next_tool() { return _next_tool; }

        inline Tool* prev_tool() const { return _prev_tool; }

        inline void prev_tool(Tool* tool) { _prev_tool = tool; }

        inline size_t allocatedMemory() const { return _allocated_memory; }

        inline unsigned int used_times() const { return _n_iters; }

        void addElapsedTime(float elapsed_time);

        inline float elapsedTime(bool averaged = true) const
        {
                if (!averaged)
                        return _elapsed_time;
                return _average_elapsed_time;
        }

        inline float elapsedTimeVariance() const
        {
                return _squared_elapsed_time - pow(_average_elapsed_time, 2);
        }

        inline float elapsedTimeDeviation() const
        {
                return sqrt(elapsedTimeVariance());
        }

        virtual inline int scope_modifier() const { return 0; }

        inline std::vector<InputOutput::Variable*> getInputDependencies() const
        {
                return _in_vars;
        }

        inline std::vector<InputOutput::Variable*> getOutputDependencies() const
        {
                return _out_vars;
        }

        inline std::tuple<std::vector<InputOutput::Variable*>,
                          std::vector<InputOutput::Variable*>>
        getDependencies() const
        {
                return { _in_vars, _out_vars };
        }

        inline cl_event getEvent() const { return _event; }

        inline void parent(Tool* tool) { _parent = tool; }

        inline Tool* parent() { return _parent; }
 
  protected:
        int id_in_pipeline() const;

        inline std::string varPrefix() const
        {
                return "__tid" + std::to_string(id_in_pipeline()) + "_";
        }

        void next_tool(Tool* tool) { _next_tool = tool; }

        void allocatedMemory(size_t mem_size) { _allocated_memory = mem_size; }

        virtual cl_event _execute(const UNUSED_PARAM std::vector<cl_event> events)
        {
                return NULL;
        }

        inline void setDependencies(std::vector<std::string> inputs,
                                    std::vector<std::string> outputs)
        {
                _in_vars = namesToVars(inputs);
                _out_vars = namesToVars(outputs);
        }

        inline void setDependencies(std::vector<InputOutput::Variable*> inputs,
                                    std::vector<InputOutput::Variable*> outputs)
        {
                _in_vars = inputs;
                _out_vars = outputs;
        }

        inline void setDependencies(std::vector<std::string> vars)
        {
                std::vector<std::string> inputs;
                setDependencies(inputs, vars);
        }

        inline void setInputDependencies(std::vector<std::string> vars)
        {
                _in_vars = namesToVars(vars);
        }

        inline void setInputDependencies(std::vector<InputOutput::Variable*> vars)
        {
                _in_vars = vars;
        }

        inline void setOutputDependencies(std::vector<std::string> vars)
        {
                _out_vars = namesToVars(vars);
        }

        inline void setOutputDependencies(std::vector<InputOutput::Variable*> vars)
        {
                _out_vars = vars;
        }

        inline void setDependencies(std::vector<InputOutput::Variable*> vars)
        {
                std::vector<InputOutput::Variable*> inputs;
                setDependencies(inputs, vars);
        }
 
        enum dep_events
        {
                in = 0x01,
                out = 0x02,
                all = 0x03
        };

        const std::vector<cl_event> getEvents(
                dep_events which = dep_events::all) const;

        static std::vector<cl_kernel> compile(const std::string source,
                                              const std::vector<std::string> names,
                                              const std::string flags = "");

        static cl_kernel compile_kernel(const std::string source,
                                        const std::string kernel_name,
                                        const std::string flags = "");
 
 
  private:
        std::vector<InputOutput::Variable*> namesToVars(
            const std::vector<std::string>& names) const;

        bool _once;

        Tool* _next_tool;

        Tool* _prev_tool;

        size_t _allocated_memory;

        size_t _n_iters;

        float _elapsed_time;

        float _average_elapsed_time;

        float _squared_elapsed_time;

        std::vector<InputOutput::Variable*> _in_vars;

        std::vector<InputOutput::Variable*> _out_vars;

        cl_event _event;

        Tool* _parent;
};
 
}
} // namespace
 
#endif // TOOL_H_INCLUDED