sart.h

Go to the documentation of this file.

/*
 *  SeART (Semantic Aware Real-Time scheduler)
 *  Copyright (C) 2010  Ali Paikan, Antonio Sgorbissa
 *          Università degli Studi di Genova
 *          Via Opera Pia 13, 16145,
 *          Genova, Italy.
 *
 *  This program 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Ali Paikan <ali.paikan@gmail.com>
 *
 */

#ifndef SeART_H_
#define SeART_H_

#ifdef __cplusplus
extern "C" {
#endif


#include "srterrno.h"
#include "srttypes.h"

typedef struct{
    char* quality_indicator;
    u_int quality_value;
    SRT_FREQUENCY freq_constraint;
    float freq_value;
}srt_data_attr;


typedef struct{
    bool constraint_hard;
    bool constraint_forced;
    bool constraint_disabled;
    SRT_FREQUENCY freq_constraint;
    float freq_value;
}srt_task_attr;


typedef struct{
    bool disabled;
    u_int prominence;
    SRT_POLICY policy;
    SRT_FREQUENCY freq_constraint;
    float freq_value; 
}srt_job_attr;


typedef bool (*schd_checker)(const float u, const u_int n);


/*
 *  SeART common system calls
 */

/******************************
 *  DATA
 ******************************/
SRT_DATA* srt_data_create(const char* label, const char* kind);

srt_status srt_data_set_attr(SRT_DATA* data, srt_data_attr attr);

srt_status srt_data_get_attr(SRT_DATA* data, srt_data_attr* pattr);



/******************************
 *  RESOURCE
 ******************************/
SRT_RESOURCE* srt_res_create(const char* label, bool available);

srt_status srt_res_add_provision(SRT_RESOURCE *res, SRT_DATA *data);

srt_status srt_res_set_attr(SRT_RESOURCE *res, bool available);




/******************************
 *  JOB
 ******************************/
SRT_JOB* srt_job_create(const char* label, SRT_POLICY policy );

srt_status srt_job_add_data(SRT_JOB* job, SRT_DATA* data );

srt_status srt_job_remove_data(SRT_JOB* job, SRT_DATA* data);


srt_status srt_job_add_task(SRT_JOB* job, SRT_TASK* task );

srt_status srt_job_remove_task(SRT_JOB* job, SRT_TASK* task );


srt_status srt_job_set_attr(SRT_JOB* job, srt_job_attr attr);

srt_status srt_job_get_attr(SRT_JOB* job, srt_job_attr* pattr);




/******************************
 *  Disjunction
 ******************************/
SRT_DISJUNCTION* srt_disj_create(const char* label);

srt_status srt_disj_add_data(SRT_DISJUNCTION* disj, SRT_DATA* data);

srt_status srt_disj_add_disj(SRT_DISJUNCTION* disj, SRT_DISJUNCTION* disj2);

srt_status srt_disj_add_conj(SRT_DISJUNCTION* disj, SRT_CONJUNCTION* conj);




/******************************
 *  Conjunction
 ******************************/
SRT_CONJUNCTION* srt_conj_create(const char* label);

srt_status srt_conj_add_data(SRT_CONJUNCTION* conj, SRT_DATA* data);

srt_status srt_conj_add_disj(SRT_CONJUNCTION* conj, SRT_DISJUNCTION* disj);

srt_status srt_conj_add_conj(SRT_CONJUNCTION* conj, SRT_CONJUNCTION* conj2);




/******************************
 *  Task
 ******************************/
SRT_TASK* srt_task_create(const char* label, u_int consumption);

srt_status srt_task_set_attr(SRT_TASK* task, srt_task_attr attr);

srt_status srt_task_get_attr(SRT_TASK* task, srt_task_attr* pattr);

srt_status srt_task_add_disj_input(SRT_TASK* task, SRT_DISJUNCTION* disj);

srt_status srt_task_add_conj_input(SRT_TASK* task, SRT_CONJUNCTION* conj);

srt_status srt_task_add_data_input(SRT_TASK* task, SRT_DATA* data);

srt_status srt_task_add_output(SRT_TASK* task, SRT_DATA* data);

srt_status srt_task_set_descriptor(SRT_TASK* task, void* descriptor);


void* srt_get_entity_by_name(const char* name );


/******************************
 *  Ontology/RDF
 ******************************/

#ifdef WITH_RDF

srt_status srt_kb_from_rdf(const char * filename);

#endif



/******************************
 *  SeART
 ******************************/
srt_status srt_init( void );

srt_status srt_finish( void );

srt_status srt_chek_kb( void );

srt_status srt_test_solution( void );


srt_status srt_set_maxreason_time( long max_time );


srt_status srt_switch_context( void* os_data );


srt_status srt_set_sched_checker( schd_checker check_func );


/******************************
 *  SeART utilities
 ******************************/
srt_status srt_export_kb2dot( const char* filename );



#ifdef __cplusplus
}
#endif


#endif /* SeART_H_ */