-// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+//----------------------------------------------------------------------
+// Copyright (C) 2006 - 2007 by the FRESCOR consortium:
//
// Universidad de Cantabria, SPAIN
// University of York, UK
// Scuola Superiore Sant'Anna, ITALY
// Kaiserslautern University, GERMANY
-// Univ. Politécnica Valencia, SPAIN
+// Univ. Politecnica Valencia, SPAIN
// Czech Technical University in Prague, CZECH REPUBLIC
// ENEA SWEDEN
// Thales Communication S.A. FRANCE
// Rapita Systems Ltd UK
// Evidence ITALY
//
-// See http://www.frescor.org for a link to partners' websites
+// See http://www.frescor.org
//
-// FRESCOR project (FP6/2005/IST/5-034026) is funded
+// The FRESCOR project (FP6/2005/IST/5-034026) is funded
// in part by the European Union Sixth Framework Programme
// The European Union is not liable of any use that may be
// made of this code.
// Universidad de Cantabria, SPAIN
// University of York, UK
//
-// FSF API web pages: http://marte.unican.es/fsf/docs
-// http://shark.sssup.it/contrib/first/docs/
-//
-// This file is part of FRSH API
-//
-// FRSH API 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, or (at your option)
-// any later version.
+// This file is part of FNA (Frescor Network Adaptation)
//
-// FRSH API 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.
+// FNA is free software; you can redistribute it and/or modify it
+// under terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2, or (at your option) any
+// later version. FNA 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 FNA; see file
+// COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
+// Cambridge, MA 02139, USA.
//
-// You should have received a copy of the GNU General Public License
-// distributed with FRSH API; see file COPYING. If not, write to the
-// Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-// 02111-1307, USA.
-//
-// As a special exception, if you include this header file into source
-// files to be compiled, this header file does not by itself cause
-// the resulting executable to be covered by the GNU General Public
-// License. This exception does not however invalidate any other
-// reasons why the executable file might be covered by the GNU General
-// Public License.
+// As a special exception, including FNA header files in a file,
+// instantiating FNA generics or templates, or linking other files
+// with FNA objects to produce an executable application, does not
+// by itself cause the resulting executable application to be covered
+// by the GNU General Public License. This exception does not
+// however invalidate any other reasons why the executable file might be
+// covered by the GNU Public License.
// -----------------------------------------------------------------------
//==============================================
#ifndef _FNA_H_
#define _FNA_H_
-#include "frsh_core_types.h" /* for frsh_resource_id_t, frsh_contract_t, etc */
-#include "fna_error.h" /* for ERROR constants */
-#include <stdint.h> /* for uint32_t, UINT32_MAX */
+/* for frsh_resource_id_t, frsh_contract_t, for frsh_network_address_t,
+ frsh_stream_id_t, ... */
+#include "frsh.h"
+/* for timespec */
+#include <time.h>
+/* for ERROR constants */
+// #include "fna_error.h"
+/* for uint32_t, UINT32_MAX */
+#include <stdint.h>
/**
* @defgroup fna FNA Private Interface
*
**/
+
//////////////////////////////////////////////////////////////////////
// INITIALIZATION
//////////////////////////////////////////////////////////////////////
* if the function has already been called before (with success) \n
*
**/
-int fna_init(const frsh_resource_id_t resource_id);
+typedef int fna_init_t(const frsh_resource_id_t resource_id);
/*@}*/
* @{
**/
+#ifndef FRSH_FORB
/**
* fna_vres_id_t
*
- * Internal virtual resource id. The type fna_vres_id_t is a pointer to void.
- * The FRSH layer will keep a map between the frsh_vres_id_t, this
- * pointer and the resource_id. This pointer could be used as the ID
- * itself using casting, or as internal pointer to any structure.
+ * Internal virtual resource id. In the current implementation it is a 16 bits
+ * value (up to 65536 vres) so it can be integrated easily with the
+ * frsh_vres_id_t type (see frsh_internal_data.h)
+ *
+ **/
+typedef uint16_t fna_vres_id_t;
+#else
+/**
+ * In FRSH_FORB implementation, we do not distinguish between vreses
+ * of different resources.
+ */
+typedef frsh_vres_id_t fna_vres_id_t;
+#endif
+
+typedef struct {
+ int size;
+ fna_vres_id_t vres[FRSH_MAX_GROUP_OPS];
+} fna_vres_group_t;
+
+/**
+ * frsh_group_change_mode_sync()
+ *
+ * This function performs a set of negotiation operations which can
+ * include: adding new contracts (neg), modifying existing vres (reneg)
+ * or cancelling existing vres (cancel).
+ *
+ * If one of the group operations has a NULL value, unless it causes an
+ * inconsistency the system will suppose that no operation of that
+ * type (neg, reneg or cancel) should be done.
+ *
+ * The virtual resources resulting from negotiations of new contracts are
+ * returned in the parameter 'new_vres' which must be provided by the user.
+ *
+ * If the on-line admission test is enabled, FRSH analizes the
+ * schedulability of the context that would result in the new
+ * contract situation with removed, changed and added contracts.
+ *
+ * A successful return code will mean that all contracts have been
+ * accepted and all required operations (creation, cancellation or
+ * update of vres) have been carried out to reach the new running
+ * context.
+ *
+ * If any of the contracts is not accepted a corresponding error shall be
+ * returned and no changes will be made to the previously running context.
+ *
+ * This call is a synchronous, potentially blocking operation. It
+ * returns when the system has rejected the contracts or accepted
+ * and made them effective.
+ *
+ * @param[in] contracts_to_neg List of new contracts to negotiate
+ * @param[in] contracts_to_reneg List of contracts to renegotiate
+ * @param[in] vres_to_reneg List of vres to renegotiate
+ * @param[in] vres_to_cancel List of vres to cancel
+ * @param[out] new_vres List of vres of new contracts.
+ *
+ * @return 0 if no error \n
+ * 0 if there are no errors (in this case it also means contract accepted) \n
+ * FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
+ * FNA_ERR_TOO_MANY_VRES: if there is no space for more vres \n
+ * FNA_ERR_CONTRACT_ID_ALREADY_EXISTS: contract_id is not unique \n
+ * FNA_ERR_CONTRACT_REJECTED: if the contract is not accepted \n
+ * FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
+ * FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
+ * FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-typedef void *fna_vres_id_t;
+typedef int fna_group_change_mode_sync_t
+ (const frsh_resource_id_t resource_id,
+ const frsh_contracts_group_t *contracts_to_neg,
+ const frsh_contracts_group_t *contracts_to_reneg,
+ const fna_vres_group_t *vres_to_reneg,
+ const fna_vres_group_t *vres_to_cancel,
+ fna_vres_group_t *new_vres);
/**
* fna_contract_negotiate()
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_contract_negotiate
+typedef int fna_contract_negotiate_t
(const frsh_resource_id_t resource_id,
const frsh_contract_t *contract,
fna_vres_id_t *vres);
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_contract_renegotiate_sync
+typedef int fna_contract_renegotiate_sync_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
const frsh_contract_t *new_contract);
* NULL nor a valid POSIX signal \n
*
**/
-int fna_contract_renegotiate_async
+typedef int fna_contract_renegotiate_async_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
const frsh_contract_t *new_contract,
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_vres_get_renegotiation_status
+typedef int fna_vres_get_renegotiation_status_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
frsh_renegotiation_status_t *renegotiation_status);
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_vres_destroy
+typedef int fna_vres_destroy_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres);
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_vres_get_contract
+typedef int fna_vres_get_contract_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
frsh_contract_t *contract);
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_vres_get_usage
+typedef int fna_vres_get_usage_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
struct timespec *usage);
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_vres_get_remaining_budget
+typedef int fna_vres_get_remaining_budget_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
struct timespec *remaining_budget);
* FNA_ERR_BAD_ARGUMENT: if both pointers are NULL \n
*
**/
-int fna_vres_get_budget_and_period
+typedef int fna_vres_get_budget_and_period_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
struct timespec *budget,
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_resource_get_capacity
+typedef int fna_resource_get_capacity_t
(const frsh_resource_id_t resource_id,
const int importance,
uint32_t *capacity);
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_resource_get_total_weight
+typedef int fna_resource_get_total_weight_t
(const frsh_resource_id_t resource_id,
const int importance,
int *total_weight);
* contract \n
*
**/
-int fna_vres_decrease_capacity
+typedef int fna_vres_decrease_capacity_t
(const frsh_resource_id_t resource_id,
const fna_vres_id_t vres,
const struct timespec new_budget,
* @{
**/
+typedef enum {
+ FRSH_SEND_ENDPOINT_TYPE,
+ FRSH_RECEIVE_ENDPOINT_TYPE
+} frsh_endpoint_type_t;
+
+typedef struct fna_endpoint_data {
+ frsh_endpoint_type_t endpoint_type; // send_endpoint or receive_endpoint
+ fna_vres_id_t vres; // only for send_endpoints
+ bool is_bound; // only for send_endpoints
+ frsh_network_address_t destination; // only for send_endpoints
+ frsh_resource_id_t resource_id;
+ frsh_stream_id_t stream_id;
+ frsh_protocol_info_t protocol_info;
+ frsh_endpoint_queueing_info_t queue_info;
+ union {
+ frsh_send_endpoint_protocol_info_t send;
+ frsh_receive_endpoint_protocol_info_t receive;
+ } endpoint_protocol_info;
+} fna_endpoint_data_t;
+
/**
* fna_send_sync()
*
* the queue is full (and does not have the policy FNA_QP_OLDEST) \n
*
**/
-int fna_send_sync
- (const fna_send_endpoint_t *endpoint,
+typedef int fna_send_sync_t
+ (const fna_endpoint_data_t *endpoint,
const void *msg,
const size_t size);
* the queue is full (and does not have the policy FNA_QP_OLDEST) \n
*
**/
-int fna_send_async
- (const fna_send_endpoint_t *endpoint,
+typedef int fna_send_async_t
+ (const fna_endpoint_data_t *endpoint,
const void *msg,
const size_t size);
* @param[out] buffer Buffer for storing the received message
* @param[in] buffer_size The size in bytes of this buffer
* @param[out] received_bytes The actual number of received bytes
+ * @param[out] from Address of the sender node
*
* @return
* 0 if there are no errors \n
* provided buffer. \n
*
**/
-int fna_receive_sync
- (const frsh_receive_endpoint_t *endpoint,
+typedef int fna_receive_sync_t
+ (const fna_endpoint_data_t *endpoint,
void *buffer,
const size_t buffer_size,
- size_t *received_bytes);
+ size_t *received_bytes,
+ frsh_network_address_t *from);
/**
* fna_receive_async()
* @param[out] buffer Buffer for storing the received message
* @param[in] buffer_size The size in bytes of this buffer
* @param[out] received_bytes The actual number of received bytes
+ * @param[out] from Address of the sender node
*
* @return
* 0 if there are no errors \n
* FNA_NO_MESSAGE: if no messages are available in the queue. \n
*
**/
-int fna_receive_async
- (const frsh_receive_endpoint_t *endpoint,
+typedef int fna_receive_async_t
+ (const fna_endpoint_data_t *endpoint,
void *buffer,
const size_t buffer_size,
- size_t *received_bytes);
+ size_t *received_bytes,
+ frsh_network_address_t *from);
/**
* fna_send_endpoint_get_status()
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_send_endpoint_get_status
- (const fna_send_endpoint_t *endpoint,
+typedef int fna_send_endpoint_get_status_t
+ (const fna_endpoint_data_t *endpoint,
int *number_of_pending_messages,
- frsh_endpoint_network_status *network_status,
+ frsh_endpoint_network_status_t *network_status,
frsh_protocol_status_t *protocol_status);
+/**
+ * fna_send_endpoint_bind_t()
+ *
+ * This operation is a called from frsh_send_endpoint_bind and binds send
+ * edpoint to vres.
+ *
+ * @param[in] endpoint the endpoint object.
+ * @param[in] vres The internal virtual resource id
+ *
+ * @return
+ * 0 if there are no errors \n
+ * FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
+ * FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
+ * FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
+ * FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
+ **/
+typedef
+int fna_send_endpoint_bind_t(fna_endpoint_data_t *endpoint, fna_vres_id_t vres);
+
+/**
+ * fna_send_endpoint_unbind_t()
+ *
+ * This operation is a called from frsh_send_endpoint_bind.
+ *
+ * @param[in] endpoint the endpoint object.
+ *
+ * @return
+ * 0 if there are no errors \n
+ * FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
+ * FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
+ * FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
+ * FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
+ **/
+typedef
+int fna_send_endpoint_unbind_t(fna_endpoint_data_t *endpoint);
+
+/**
+ * fna_send_endpoint_create_callback()
+ *
+ * This operation is a called from frsh_send_endpoint_create with a
+ * send_endpoint structure already filled.
+ *
+ * @param[in] endpoint the endpoint object.
+ *
+ * @return
+ * 0 if there are no errors \n
+ * FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
+ * FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
+ * FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
+ * FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
+ **/
+typedef int fna_send_endpoint_create_callback_t
+ (fna_endpoint_data_t *endpoint);
+
/**
* fna_receive_endpoint_create_callback()
*
* FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
**/
-int fna_receive_endpoint_create_callback
- (const frsh_receive_endpoint_t *endpoint);
+typedef int fna_receive_endpoint_create_callback_t
+ (fna_endpoint_data_t *endpoint);
+
+/**
+ * fna_endpoint_destroy()
+ *
+ * This operation is a called from frsh_send(receive)_endpoint_destroy.
+ *
+ * @param[in] endpoint the endpoint object.
+ *
+ * @return
+ * 0 if there are no errors \n
+ * FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
+ * FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
+ * FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
+ * FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
+ **/
+typedef int fna_endpoint_destroy_t
+ (fna_endpoint_data_t *endpoint);
/**
* fna_receive_endpoint_get_pending_messages
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_receive_endpoint_get_status
- (const frsh_receive_endpoint_t *endpoint,
+typedef int fna_receive_endpoint_get_status_t
+ (const fna_endpoint_data_t *endpoint,
int *number_of_pending_messages,
- frsh_endpoint_network_status *network_status,
+ frsh_endpoint_network_status_t *network_status,
frsh_protocol_status_t *protocol_status);
/*@}*/
* invalid \n
*
**/
-int fna_network_get_max_message_size
+typedef int fna_network_get_max_message_size_t
(const frsh_resource_id_t resource_id,
const frsh_network_address_t destination,
size_t *max_size);
* than zero \n
*
**/
-int fna_network_bytes_to_budget
+typedef int fna_network_bytes_to_budget_t
(const frsh_resource_id_t resource_id,
const size_t nbytes,
- struct timespec *budget);
+ frsh_rel_time_t *budget);
/**
* fna_network_budget_to_bytes()
* an invalid time value \n
*
**/
-int fna_network_budget_to_bytes
+typedef int fna_network_budget_to_bytes_t
(const frsh_resource_id_t resource_id,
- const struct timespec *budget,
+ const frsh_rel_time_t *budget,
size_t *nbytes);
/**
* FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
*
**/
-int fna_network_get_min_effective_budget
+typedef int fna_network_get_min_effective_budget_t
(const frsh_resource_id_t resource_id,
- struct timespec *budget);
+ frsh_rel_time_t *budget);
/*@}*/
+typedef struct {
+ fna_init_t *fna_init;
+ fna_group_change_mode_sync_t *fna_group_change_mode_sync;
+ fna_contract_negotiate_t *fna_contract_negotiate;
+ fna_contract_renegotiate_sync_t *fna_contract_renegotiate_sync;
+ fna_contract_renegotiate_async_t *fna_contract_renegotiate_async;
+ fna_vres_get_renegotiation_status_t *fna_vres_get_renegotiation_status;
+ fna_vres_destroy_t *fna_vres_destroy;
+ fna_vres_get_contract_t *fna_vres_get_contract;
+ fna_vres_get_usage_t *fna_vres_get_usage;
+ fna_vres_get_remaining_budget_t *fna_vres_get_remaining_budget;
+ fna_vres_get_budget_and_period_t *fna_vres_get_budget_and_period;
+ fna_resource_get_capacity_t *fna_resource_get_capacity;
+ fna_resource_get_total_weight_t *fna_resource_get_total_weight;
+ fna_vres_decrease_capacity_t *fna_vres_decrease_capacity;
+ fna_send_sync_t *fna_send_sync;
+ fna_send_async_t *fna_send_async;
+ fna_receive_sync_t *fna_receive_sync;
+ fna_receive_async_t *fna_receive_async;
+ fna_send_endpoint_get_status_t *fna_send_endpoint_get_status;
+ fna_send_endpoint_bind_t *fna_send_endpoint_bind;
+ fna_send_endpoint_unbind_t *fna_send_endpoint_unbind;
+ fna_endpoint_destroy_t *fna_endpoint_destroy;
+ fna_send_endpoint_create_callback_t *fna_send_endpoint_created;
+ fna_receive_endpoint_create_callback_t *fna_receive_endpoint_created;
+ fna_receive_endpoint_get_status_t *fna_receive_endpoint_get_status;
+ fna_network_get_max_message_size_t *fna_network_get_max_message_size;
+ fna_network_bytes_to_budget_t *fna_network_bytes_to_budget;
+ fna_network_budget_to_bytes_t *fna_network_budget_to_bytes;
+ fna_network_get_min_effective_budget_t *fna_network_get_min_eff_budget;
+} fna_operations_t;
+
#endif // _FNA_H_
projects / frescor / fna.git / blobdiff