1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2007 FRESCOR consortium partners:
4 // Universidad de Cantabria, SPAIN
5 // University of York, UK
6 // Scuola Superiore Sant'Anna, ITALY
7 // Kaiserslautern University, GERMANY
8 // Univ. Politécnica Valencia, SPAIN
9 // Czech Technical University in Prague, CZECH REPUBLIC
11 // Thales Communication S.A. FRANCE
12 // Visual Tools S.A. SPAIN
13 // Rapita Systems Ltd UK
16 // See http://www.frescor.org for a link to partners' websites
18 // FRESCOR project (FP6/2005/IST/5-034026) is funded
19 // in part by the European Union Sixth Framework Programme
20 // The European Union is not liable of any use that may be
24 // based on previous work (FSF) done in the FIRST project
26 // Copyright (C) 2005 Mälardalen University, SWEDEN
27 // Scuola Superiore S.Anna, ITALY
28 // Universidad de Cantabria, SPAIN
29 // University of York, UK
31 // FSF API web pages: http://marte.unican.es/fsf/docs
32 // http://shark.sssup.it/contrib/first/docs/
34 // This file is part of FRSH API
36 // FRSH API is free software; you can redistribute it and/or modify
37 // it under the terms of the GNU General Public License as published by
38 // the Free Software Foundation; either version 2, or (at your option)
41 // FRSH API is distributed in the hope that it will be useful, but
42 // WITHOUT ANY WARRANTY; without even the implied warranty of
43 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
44 // General Public License for more details.
46 // You should have received a copy of the GNU General Public License
47 // distributed with FRSH API; see file COPYING. If not, write to the
48 // Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
51 // As a special exception, if you include this header file into source
52 // files to be compiled, this header file does not by itself cause
53 // the resulting executable to be covered by the GNU General Public
54 // License. This exception does not however invalidate any other
55 // reasons why the executable file might be covered by the GNU General
57 // -----------------------------------------------------------------------
59 //==============================================
60 // ******** ******* ******** ** **
61 // **///// /**////** **////// /** /**
62 // ** /** /** /** /** /**
63 // ******* /******* /********* /**********
64 // **//// /**///** ////////** /**//////**
65 // ** /** //** /** /** /**
66 // ** /** //** ******** /** /**
67 // // // // //////// // //
69 // FRSH(FRescor ScHeduler), pronounced "fresh"
70 //==============================================
73 #ifndef FRSH_CORE_TYPES_H_
74 #define FRSH_CORE_TYPES_H_
77 #include "frsh_configuration_parameters.h"
78 #include "frsh_opaque_types.h"
79 #include "frsh_shared_objects_types.h"
80 #include "frsh_spare_capacity_types.h"
82 #include "frsh_implementation_specific_types.h"
83 #include "frsh_hierarchical_types.h"
84 #include "frsh_distributed_types.h"
85 #include "frsh_error.h"
86 #include "frsh_fosa.h"
89 * @file frsh_core_types.h
99 /** Kind of workload expected in vres: bounded or indeterminate **/
102 FRSH_WT_INDETERMINATE = 1
105 #define FRSH_NULL_DEADLINE (struct timespec *)NULL
106 // #define FRSH_NULL_SIGNAL 0 /* Defined at frsh_adaption.h */
108 /** Negotiation status: In_progress, rejected, admitted, not_requested **/
109 typedef enum {FRSH_RS_IN_PROGRESS,
112 FRSH_RS_NOT_REQUESTED} frsh_renegotiation_status_t;
117 * Vres Id type, that identifies a vres created to manage a given
120 typedef unsigned int frsh_vres_id_t; // => 0
122 /** Contract ressource type: processor, network, memory **/
124 FRSH_RT_PROCESSOR = 0,
128 } frsh_resource_type_t;
130 /** Ressource Id: processor_id or network_id **/
131 /**********************************************/
132 typedef unsigned int frsh_resource_id_t;
134 /** Kind of contract: regular, background or dummy **/
137 FRSH_CT_BACKGROUND = 1,
139 } frsh_contract_type_t;
141 // The name of this constant has been updated to have the FRSH_ prefix
142 typedef char frsh_contract_label_t[FRSH_CONTRACT_LABEL_MAXLENGTH + 1];
145 * Contract parameters type; it is an opaque type (i.e. the internal
146 * structure of this data type is implementation dependent). The user
147 * can access and modify the parameters of a contract only with the
148 * proper functions, and should never access the data directly.
150 typedef FRSH_CONTRACT_T_OPAQUE frsh_contract_t;
156 frsh_vres_id_t vres[FRSH_MAX_N_VRES];
159 /** List of contracts to negotiate **/
162 frsh_contract_t* contracts[FRSH_MAX_N_VRES];
163 } frsh_contracts_group_t;
167 frsh_contract_label_t contract_labels[FRSH_MAX_N_VRES];
168 } frsh_contract_labels_group_t;
172 * An abstract synchronization object is defined by the application.
173 * This object can be used by an application to wait for an event to
174 * arrive by invoking the frsh_sychobj_wait() operation. It
175 * can also be used to signal the event either causing a waiting
176 * vres to wake up, or the event to be queued if no vres is
179 typedef FRSH_SYNCHOBJ_HANDLE_T_OPAQUE frsh_synchobj_handle_t;
185 #endif /* !FRSH_CORE_TYPES_H_ */