Kernel.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 KERNEL_H_INCLUDED
#define KERNEL_H_INCLUDED
 
#include "aquagpusph/sphPrerequisites.hpp"
 
#include <vector>
#if __APPLE__
#include <OpenCL/cl.h>
#else
#include <CL/cl.h>
#endif
#include "Tool.hpp"
 
namespace Aqua {
namespace CalcServer {

void
sync_user_event(cl_event user_event, cl_event event);

class EventProfile : public Aqua::CalcServer::Profile
{
  public:
        EventProfile(const std::string name, Tool* tool)
          : Profile(name, tool)
        {
        }

        ~EventProfile() {}

        void start(cl_event event);

        void end(cl_event event);

        void sample();
 
  private:
        cl_event _start;

        cl_event _end;
};

class ArgSetter : public Aqua::CalcServer::Named
{
        class Arg;
 
  public:
        ArgSetter(const std::string name,
                  cl_kernel kernel,
                  std::vector<InputOutput::Variable*> vars);

        ~ArgSetter() {}

        inline cl_kernel getKernel() const { return _kernel; }

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

        inline std::vector<Arg> getArgs() const { return _args; }

        void execute();
 
  private:
        cl_kernel _kernel;

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

        std::vector<Arg> _args;
};

class ArgSetter::Arg
{
  public:
        Arg()
          : _size(0)
          , _value(NULL)
          , _event(NULL)
        {
        }

        Arg(const Arg& arg)
          : _size(0)
          , _value(NULL)
          , _event(NULL)
        {
                set(arg.size(), arg.value(), arg.event());
        }

        ~Arg()
        {
                if (_value)
                        free(_value);
        }

        inline size_t size() const { return _size; }

        inline const void* value() const { return _value; }

        inline cl_event event() const { return _event; }

        bool operator==(InputOutput::Variable* var);

        inline bool operator!=(InputOutput::Variable* var)
        {
                return !(*this == var);
        }

        inline void operator=(const Arg& arg)
        {
                set(arg.size(), arg.value(), arg.event());
        }

        inline void operator=(InputOutput::Variable* var)
        {
                try {
                        // We can read asynchronously as long as == operator already waited
                        // for the variable writing when required
                        set(var->typesize(), var->get_async(), var->getWritingEvent());
                } catch (...) {
                        std::stringstream msg;
                        msg << "From variable " << var->name() << std::endl;
                        LOG0(L_DEBUG, msg.str());
                        throw;
                }
        }
 
  protected:
        inline void set(const size_t s, const void* v, const cl_event e)
        {
                if (_size != s) {
                        if (_value)
                                free(_value);
                        _size = s;
                        _value = malloc(_size);
                        if (!_value) {
                                std::stringstream msg;
                                msg << "Failure allocating " << _size << " bytes" << std::endl;
                                LOG(L_ERROR, msg.str());
                                throw std::bad_alloc();
                        }
                }
                memcpy(_value, v, s);
                _event = e;
        }
 
  private:
        size_t _size;

        void* _value;

        cl_event _event;
};

class Kernel : public Aqua::CalcServer::Tool
{
  public:
        Kernel(const std::string tool_name,
               const std::string kernel_path,
               const std::string entry_point = "entry",
               const std::string n = "",
               bool once = false);

        virtual ~Kernel();

        void setup();

        const std::string path() { return (const std::string)_path; }

        size_t workGroupSize() const { return _work_group_size; }

        size_t globalWorkSize() const { return _global_work_size; }
 
  protected:
        cl_event _execute(const std::vector<cl_event> events);

        void make(const std::string entry_point = "entry",
                  const std::string flags = "",
                  const std::string header = "");

        void variables();

        void computeGlobalWorkSize();
 
  private:
        std::string _path;

        std::string _entry_point;

        std::string _n;

        cl_kernel _kernel;

        size_t _work_group_size;

        size_t _global_work_size;

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

        ArgSetter* _args_setter;
};
 
}
} // namespace
 
#endif // KERNEL_H_INCLUDED