kernel.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011, Denis Steckelmacher <steckdenis@yahoo.fr>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the copyright holder nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __KERNEL_H__
#define __KERNEL_H__

#include "object.h"

#include <CL/cl.h>

#include <vector>
#include <string>

namespace llvm
{
    class Function;
    class Module;
}

namespace Coal
{

class Program;
class DeviceInterface;
class DeviceKernel;

class Kernel : public Object
{
    public:
        Kernel(Program *program);
        ~Kernel();

        class Arg
        {
            public:
                enum File
                {
                    Private = 0,  
                    Global = 1,   
                    Local = 2,    
                    Constant = 3  
                };

                enum Kind
                {
                    Invalid,      
                    Int8,         
                    Int16,        
                    Int32,        
                    Int64,        
                    Float,        
                    Double,       
                    Buffer,       
                    Image2D,      
                    Image3D,      
                    Sampler       
                };

                Arg(unsigned short vec_dim, File file, Kind kind);
                ~Arg();

                void alloc();
                
                void loadData(const void *data);
                
                void setAllocAtKernelRuntime(size_t size);
                
                void refineKind(Kind kind);

                bool operator !=(const Arg &b);

                size_t valueSize() const;
                unsigned short vecDim() const;                 
                File file() const;                             
                Kind kind() const;                             
                bool defined() const;                          
                size_t allocAtKernelRuntime() const;           
                const void *value(unsigned short index) const; 
                const void *data() const;                      
            private:
                unsigned short p_vec_dim;
                File p_file;
                Kind p_kind;
                void *p_data;
                bool p_defined;
                size_t p_runtime_alloc;
        };

        cl_int addFunction(DeviceInterface *device, llvm::Function *function,
                           llvm::Module *module);

        llvm::Function *function(DeviceInterface *device) const;
        
        cl_int setArg(cl_uint index, size_t size, const void *value);

        unsigned int numArgs() const;             
        const Arg &arg(unsigned int index) const; 
        DeviceKernel *deviceDependentKernel(DeviceInterface *device) const;

        bool argsSpecified() const;               
        bool hasLocals() const;                   
        cl_int info(cl_kernel_info param_name,
                    size_t param_value_size,
                    void *param_value,
                    size_t *param_value_size_ret) const;

        cl_int workGroupInfo(DeviceInterface *device,
                             cl_kernel_work_group_info param_name,
                             size_t param_value_size,
                             void *param_value,
                             size_t *param_value_size_ret) const;

    private:
        std::string p_name;
        bool p_has_locals;

        struct DeviceDependent
        {
            DeviceInterface *device;
            DeviceKernel *kernel;
            llvm::Function *function;
            llvm::Module *module;
        };

        std::vector<DeviceDependent> p_device_dependent;
        std::vector<Arg> p_args;
        DeviceDependent null_dep;

        const DeviceDependent &deviceDependent(DeviceInterface *device) const;
        DeviceDependent &deviceDependent(DeviceInterface *device);
};

}

struct _cl_kernel : public Coal::Kernel
{};

#endif