/home/sebastian/gpudbms/trunk/hype-library/include/hype.h

Go to the documentation of this file.

/***********************************************************************************************************
Copyright (c) 2013, Sebastian Breß, Otto-von-Guericke University of Magdeburg, Germany. All rights reserved.

This program and accompanying materials are made available under the terms of the 
GNU LESSER GENERAL PUBLIC LICENSE - Version 3, http://www.gnu.org/licenses/lgpl-3.0.txt
 ***********************************************************************************************************/
#pragma once

#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>

#include <config/global_definitions.hpp>

//#define NDEBUG //uncomment for release version
#include <assert.h>

#ifdef __cplusplus
using namespace hype;
extern "C" {
#endif


    //enum C_ComputeDevice {CPU,GPU,FPGA,NP}; //CPU,GPU,FPGA, Network Processor

    /*#############################################################################*/
    /************************* Scheduling Decision ******************************/

    /*#############################################################################*/

    typedef struct C_SchedulingDecision {
        void* ptr; //=NULL;
    } C_SchedulingDecision;

    char* hype_SchedulingDecision_getAlgorithmName(C_SchedulingDecision* sched_dec);   
 
    ProcessingDeviceID hype_SchedulingDecision_getProcessingDeviceID(C_SchedulingDecision* sched_dec);   
    
    int hype_deleteSchedulingDecision(C_SchedulingDecision* sched_dec);

    /*#############################################################################*/
    /************************* Algorithm Specification ******************************/

    /*#############################################################################*/

    typedef struct C_AlgorithmSpecification {
        void* ptr;
    } C_AlgorithmSpecification;

    C_AlgorithmSpecification* hype_createAlgorithmSpecification(const char* alg_name,
            const char* op_name,
            StatisticalMethod stat_meth,
            RecomputationHeuristic recomp_heur,
            OptimizationCriterion opt_crit);

    int hype_deleteAlgorithmSpecification(C_AlgorithmSpecification* alg_spec);

    /*#############################################################################*/
    /************************* Device Specification ******************************/

    /*#############################################################################*/

    typedef struct C_DeviceSpecification {
        void* ptr;
    } C_DeviceSpecification;

    C_DeviceSpecification* hype_createDeviceSpecification(ProcessingDeviceID pd,
            ProcessingDeviceType pd_t,
            ProcessingDeviceMemoryID pd_m);

    int hype_deleteDeviceSpecification(C_DeviceSpecification* dev_spec);

    /*#############################################################################*/
    /************************* Operator Specification ******************************/

    /*#############################################################################*/


    typedef struct C_OperatorSpecification {
        void* ptr;
    } C_OperatorSpecification;

    C_OperatorSpecification* hype_create_OperatorSpecification(const char* operator_name,
            double* feature_vector,
            size_t feature_vector_length,
            ProcessingDeviceMemoryID location_of_input_data,
            ProcessingDeviceMemoryID location_for_output_data);

    int hype_deleteOperatorSpecification(C_OperatorSpecification* op_spec);

    /*#############################################################################*/
    /************************* Device Constraints *********************************/

    /*#############################################################################*/

    typedef struct C_DeviceConstraint {
        void* ptr;
    } C_DeviceConstraint;

    C_DeviceConstraint* hype_createDeviceConstraint(DeviceTypeConstraint dev_constr,
            ProcessingDeviceMemoryID pd_mem_constr);

    int hype_deleteDeviceConstraint(C_DeviceConstraint* dev_const);


    /*#############################################################################*/
    /************************* Scheduler functions *********************************/
    /*#############################################################################*/

    int hype_addAlgorithm(const C_AlgorithmSpecification* alg_spec, const C_DeviceSpecification* dev_spec);

    int hype_setOptimizationCriterion(const char* name_of_operation,
            const char* name_of_optimization_criterion);
    int hype_setStatisticalMethod(const char* name_of_algorithm,
            const char* name_of_statistical_method);
    int hype_setRecomputationHeuristic(const char* name_of_algorithm,
            const char* name_of_recomputation_strategy);
    C_SchedulingDecision* hype_getOptimalAlgorithm(const C_OperatorSpecification* op_spec, const C_DeviceConstraint* dev_constr);
    int hype_addObservation(const C_SchedulingDecision* sched_dec, const double measured_execution_time);
    /* \brief request an Estimated Execution Time from HyPE for an algorithm for a certain operator
     * \param op_spec OperatorSpecification, contains all available information about the operator to execute
     * \param alg_name algorithm name
     * \return estimated execution time
     */
    double hype_getEstimatedExecutionTime(const C_OperatorSpecification* op_spec, const char* alg_name);

    /*#############################################################################*/
    /************************* Util functions *********************************/
    /*#############################################################################*/
    uint64_t hype_getTimestamp();
    void hype_printStatus();

#ifdef __cplusplus
}
#endif