runtime-support.h

/* Copyright (c) 2013, Rice University

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1.  Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
2.  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.
3.  Neither the name of Rice University
     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 THE COPYRIGHT
OWNER OR CONTRIBUTORS 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 RUNTIME_IMPL_H_
#define RUNTIME_IMPL_H_

#include "hclib.h"
#include "rt-hclib-def.h"

//
// Runtime life-cycle management
//

void runtime_init(int * argc, char ** argv);

void runtime_finalize();

/*
 * @brief Retrieve the async task being currently executed
 */
async_task_t * get_current_async();



//
// Task conversion
//

struct ddt_st;

async_task_t * rt_ddt_to_async_task(struct ddt_st * ddt);

struct ddt_st * rt_async_task_to_ddt(async_task_t * async_task);


//
// Task allocation
//

async_task_t * rt_allocate_async_task();
void rt_deallocate_async_task(async_task_t * async_task);

forasync1D_task_t * rt_allocate_forasync1D_task();
forasync2D_task_t * rt_allocate_forasync2D_task();
forasync3D_task_t * rt_allocate_forasync3D_task();

async_task_t * rt_allocate_ddt(struct ddf_st ** ddf_list);


//
// Finish allocation
//

finish_t * rt_allocate_finish();

void rt_deallocate_finish(finish_t *);


//
// Scheduling
//

void rt_schedule_async(async_task_t * async);

void rt_finish_reached_zero(finish_t * finish);

void rt_help_finish(finish_t * finish);


//
// Worker info
//

int rt_get_nb_workers();

int rt_get_worker_id();

#endif /* RUNTIME_IMPL_H_ */