solver.h

/* ************************************************************************
 * Copyright 2013 Advanced Micro Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ************************************************************************/


#ifndef SOLVER_H_
#define SOLVER_H_

#include <defbool.h>

#include <cltypes.h>
#include <kerngen.h>
#include <clkern.h>
#include <clBLAS.h>
#include <kernel_extra.h>

struct Kernel;

// OpenCL solver ID
typedef int solver_id_t;


typedef enum SolverFlags {
    SF_WSPACE_1D = 0x01,
    SF_WSPACE_2D = 0x02,
    SF_TOP_INPUT_SQUARE_BLOCKS = 0x04
} SolverFlags;

typedef enum PatternPerformance{
    PPERF_NOT_SUPPORTED = -1,
    PPERF_POOR = 0,
    PPERF_AVERAGE,
    PPERF_GOOD,
    PPERF_BEST
} PatternPerformance;

typedef enum CheckCalcPGran{
    PGRAN_CHECK = 0,
    PGRAN_CALC
} CheckCalcPGran;

typedef ssize_t
(*SolverKgen)(
   char *buf,
   size_t buflen,
   const SubproblemDim *subdims,
   const PGranularity *pgran,
   void *extra);

typedef struct SolverOps {
    SolverKgen genKernel;

    void (*assignKargs)(KernelArg*, const void* args, const void *extra);

    bool (*isFitToLDS)(
        SubproblemDim *dims,
        DataType,
        cl_ulong ldsSize,
        const void *args);

    int (*getPatternPerf)(
        unsigned int kflags,
        const void *args);

    DecompositionAxis (*innerDecompositionAxis)(const void *args);

    void (*calcThreads)(
        size_t threads[2],
        const SubproblemDim *subdims,
        const PGranularity *pgran,
        const void *args,
        const void *extra);

    void (*imgPackMode)(
        const void *extra,
        const SubproblemDim *subdims,
        int dataID,
        unsigned int *rate,
        clblasOrder *order);

    SolverFlags (*getFlags)(void);

    void (*fixupArgs)(void *args, SubproblemDim* pSubDims, void *extra);

    int ( *getDefaultDecomp)(
        PGranularity *pgran,
        SubproblemDim *subdims,
        unsigned int subdimsNum,
        void *pArgs);

    bool (*checkCalcDecomp)(
        PGranularity *pgran,
        SubproblemDim *subdims,
        unsigned int subdimsNum,
        DataType dtype,
        int check);


    /*
     SetBuildOptions
    */
    void (*setBuildOptions)( char *buildOptsStr, const void *args);

    /*
     * selectVectorization
    */
    KernelExtraFlags (*selectVectorization)( void *kargs, unsigned int vlen);
} SolverOps;

#endif /* SOLVER_H_ */