Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATResourceCPI.c Go to the documentation of this file. /** @file GATResourceCPI.c * Source file for the GATResourceCPI class. * * @date Sat Oct 25 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceCPI.c,v 1.9 2004/04/02 12:31:58 hartmutkaiser Exp $ * * Copyright (C) Hartmut Kaiser * This file is part of the GAT Engine. * Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>. * * Use, modification and distribution is subject to the Gridlab Software * License. (See accompanying file GLlicense.txt or copy at * http://www.gridlab.org/GLlicense.txt) */ static const char *rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceCPI.c,v 1.9 2004/04/02 12:31:58 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATErrors.h" #include "GATResourceCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATResourceCPI_S { /* CPI data (type local data) */ void *data; GATResourceCPI_Adaptor_Destroy destroy; GATResourceCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATResourceCPI_Adaptor_CreateInstance create_instance; GATResourceCPI_Adaptor_DestroyInstance destroy_instance; GATResourceCPI_Adaptor_CloneInstance clone_instance; GATResourceCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATResourceCPI_Adaptor_GetResourceDescription get_resource_description; GATResourceCPI_Adaptor_GetReservation get_reservation; /* CPI monitoring support */ GATResourceCPI_Adaptor_GetMetrics get_metrics; GATResourceCPI_Adaptor_GetMetricEvent get_metric_event; /* CPI serialisation */ GATResourceCPI_Adaptor_Serialise serialise; GATResourceCPI_Adaptor_DeSerialise deserialise; }; /* Static function prototypes */ static GATBool GATResourceCPI_IsValidData_V1(GATResourceCPI_Data *data); /* File scope variables */ /* External functions */ /** GATResourceCPI_Create * The GATResourceCPI constructor. * new_cpi is the constructor for GATResourceCPI objects. * * @param version Version of the GATResourceCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATResourceCPI */ GATResourceCPI GATResourceCPI_Create(unsigned long int version, GATResourceCPI_Data *data) { GATResourceCPI new_cpi = NULL; if (version <= GATRESOURCECPI_VERSION) { if (version == GATRESOURCECPI_VERSION && GATTrue == GATResourceCPI_IsValidData_V1(data)) { new_cpi = (GATResourceCPI)malloc(sizeof(*new_cpi)); if(NULL != new_cpi) { new_cpi->data = data->data; new_cpi->destroy = data->destroy; new_cpi->service_actions = data->service_actions; new_cpi->destroy_instance = data->destroy_instance; new_cpi->create_instance = data->create_instance; new_cpi->equals_instance = data->equals_instance; new_cpi->clone_instance = data->clone_instance; new_cpi->get_resource_description = data->get_resource_description; new_cpi->get_reservation = data->get_reservation; new_cpi->get_metrics = data->get_metrics; new_cpi->get_metric_event = data->get_metric_event; new_cpi->serialise = data->serialise; new_cpi->deserialise = data->deserialise; } } /* add functionality for newer versions here else if (version == GATRESOURCECPI_VERSION2 && GATResourceCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ new_cpi = NULL; } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ new_cpi = NULL; } return new_cpi; } /** GATResourceCPI_Destroy * @brief The GATResourceCPI destructor. * * This is the destructor for GATResourceCPI objects. * * @param this An old GATResourceCPI */ void GATResourceCPI_Destroy(GATResourceCPI *object) { if(NULL != object && NULL != *object) { /* call the adapter supplied destroy function */ (*object)->destroy((*object)->data); free(*object); *object = NULL; } } /** GATResourceCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param context a GATContext * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATResourceCPI_CreateInstance(GATResourceCPI cpi, GATResourceCPI_Instance *instance_data, void *initialisation_data) { return cpi->create_instance(cpi->data, instance_data, initialisation_data); } /** GATResourceCPI_DestroyInstance * @brief Create a new CPI object instance * * Calls the adaptor to destroy a CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object */ void GATResourceCPI_DestroyInstance(GATResourceCPI cpi, GATResourceCPI_Instance *instance_data) { cpi->destroy_instance(cpi->data, instance_data); } /** GATResourceCPI_EqualsInstance * @brief Compares two CPI object instances. * * Calls the adaptor to compare two CPI object instances. * * @param this The CPI object. * @param lhs The instance data of the left CPI object * @param rhs The instance data of the right CPI object * @param isequal The pointer to the variable, where the result is to be * returned to. * * @return An error code. */ GATResult GATResourceCPI_EqualsInstance(GATResourceCPI cpi, GATResourceCPI_Instance const *lhs, GATResourceCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATResourceCPI_CloneInstance * @brief Clones a CPI object instance. * * Calls the adaptor to clone a CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to clone. * @param new_instance_data The new instance data is to be returned here. * * @return An error code. */ GATResult GATResourceCPI_CloneInstance(GATResourceCPI cpi, GATResourceCPI_Instance const *instance_data, GATResourceCPI_Instance *new_instance_data) { return cpi->clone_instance(cpi->data, instance_data, new_instance_data); } /* CPI specific API */ /** GATResourceCPI_GetResourceDescription * @brief Returns the associated resource description. * * The function GATResourceCPI_GetResourceDescription calls the adaptor to * get the resource description associated with this GATResource. * * @param this The CPI object. * @param instance_data The instance data of the CPI object. * @param description The pointer to the variable, which receives the * resulting resource description. * * @return An error code. */ GATResult GATResourceCPI_GetResourceDescription(GATResourceCPI cpi, GATResourceCPI_Instance const *instance_data, GATResourceDescription_const *description) { return cpi->get_resource_description(cpi->data, instance_data, description); } /** GATResourceCPI_GetReservation * @brief Returns the associated reservation. * * The function GATResourceCPI_GetReservation calls the adaptor to get the * reservation associated with this GATResource. * * @param this The CPI object. * @param instance_data The instance data of the CPI object. * @param reservation The pointer to a variable, which receives the resulting * reservation. * * @return An error code. */ GATResult GATResourceCPI_GetReservation(GATResourceCPI cpi, GATResourceCPI_Instance const *instance_data, GATReservation_const *reservation) { return cpi->get_reservation(cpi->data, instance_data, reservation); } /** GATResourceCPI_GetMetrics * * The function GATResourceCPI_GetMetrics returns the list of metrics supported * by this adaptor. * * @param cpi The CPI object. * @param instance_data The instance data of the attached CPI object * @param The pointer to the variable, which receives the resulting list of * metrics. * * @return An error code. */ GATResult GATResourceCPI_GetMetrics(GATResourceCPI cpi, GATResourceCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATResourceCPI_GetMetricEvent * * The function GATResourceCPI_GetMetricEvent returns the metric event, which is * associated with the given metric. * * @param cpi The CPI object. * @param instance_data The instance data of the attached CPI object * @param metric The continuous metric, for which the metric event is to be * returned. * @param event The pointer to the variable, which receives the resulting * metric event. * * @return An error code. */ GATResult GATResourceCPI_GetMetricEvent(GATResourceCPI cpi, GATResourceCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /** GATResourceCPI_Serialise * @brief Serialise the instance data. * * Calls the adaptor to serialise the instance data. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param stream The stream to use be used for serialisation. * * @return An error code. */ GATResult GATResourceCPI_Serialise(GATResourceCPI cpi, GATResourceCPI_Instance const *data, GATObject stream, GATBool clear_dirty) { return cpi->serialise(cpi->data, data, stream, clear_dirty); } /** GATResourceCPI_DeSerialise * @brief De-serialise the instance data * * Call the adaptor to de-serialise the instance data. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param instance_data The pointer to a variable, which contains the client * data of the new object. The member instance data of this object * may receive the pointer to the new instance data of the CPI object. * * @return An error code. */ GATResult GATResourceCPI_DeSerialise(GATResourceCPI cpi, GATObject stream, GATResourceCPI_Instance *data) { return cpi->deserialise(cpi->data, stream, data); } /* Local functions */ static GATBool GATResourceCPI_IsValidData_V1(GATResourceCPI_Data *data) { return ( NULL != data->get_metrics && NULL != data->get_metric_event && // NULL != data->service_actions && NULL != data->serialise && NULL != data->deserialise && NULL != data->get_resource_description && NULL != data->get_reservation && NULL != data->destroy && NULL != data->create_instance && NULL != data->destroy_instance && NULL != data->clone_instance && NULL != data->equals_instance ) ? GATTrue : GATFalse; }