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

GATPipeCPI.c Go to the documentation of this file. /** @file GATPipeCPI.c * Main .c for the GATPipeCPI class. * * A GATPipeCPI encapsulates all the methods that a GATPipe capability * provider provides. * * @date $Date: 2004/04/02 12:31:58 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATPipeCPI.c,v 1.6 2004/04/02 12:31:58 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This peep is part of the GAT Engine. * Contributed by Kelly Davis <kdavis@aei.mpg.de> and * 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/GATPipeCPI.c,v 1.6 2004/04/02 12:31:58 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATPipeCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATPipeCPI_S { /* CPI data (type local data) */ void *data; GATPipeCPI_Adaptor_Destroy destroy; GATPipeCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATPipeCPI_Adaptor_CreateInstance create_instance; GATPipeCPI_Adaptor_DestroyInstance destroy_instance; GATPipeCPI_Adaptor_CloneInstance clone_instance; GATPipeCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATPipeCPI_Adaptor_Read read; GATPipeCPI_Adaptor_Write write; GATPipeCPI_Adaptor_Seek seek; GATPipeCPI_Adaptor_Close close; /* CPI monitoring support */ GATPipeCPI_Adaptor_GetMetrics get_metrics; GATPipeCPI_Adaptor_GetMetricEvent get_metric_event; }; /* Static function prototypes */ static int GATPipeCPI_IsValidData_V1(GATPipeCPI_Data *data); /* File scope variables */ /* External functions */ /** GATPipeCPI_Create * The GATPipeCPI constructor. * This is the constructor for GATPipeCPI objects. * * @param version Version of the GATPipeCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATPipeCPI */ GATPipeCPI GATPipeCPI_Create(unsigned long int version, GATPipeCPI_Data *data) { GATPipeCPI new_cpi = NULL; if (version <= GATPIPECPI_VERSION) { if (version == GATPIPECPI_VERSION && GATPipeCPI_IsValidData_V1(data)) { new_cpi = (GATPipeCPI)malloc(sizeof(struct GATPipeCPI_S)); 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->read = data->read; new_cpi->write = data->write; new_cpi->seek = data->seek; new_cpi->close = data->close; new_cpi->get_metrics = data->get_metrics; new_cpi->get_metric_event = data->get_metric_event; } } /* add functionality for newer versions here else if (version == GATPIPECPI_VERSION2 && GATPipeCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ } return new_cpi; } /** GATPipeCPI_Destroy * @brief The GATPipeCPI destructor. * * This is the destructor for GATPipeCPI objects. * * @param this An old GATPipeCPI */ void GATPipeCPI_Destroy(GATPipeCPI *cpi) { if(NULL != cpi && NULL != *cpi) { (*cpi)->destroy((*cpi)->data); free(*cpi); *cpi = NULL; } } /** GATPipeCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param information Information required to create an instance * @return An error code. */ GATResult GATPipeCPI_CreateInstance(GATPipeCPI cpi, GATPipeCPI_Instance *data, void *information) { return cpi->create_instance(cpi->data, data, information); } /** GATPipeCPI_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 GATPipeCPI_DestroyInstance(GATPipeCPI cpi, GATPipeCPI_Instance *data) { cpi->destroy_instance(cpi->data, data); } /** GATPipeCPI_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 GATPipeCPI_EqualsInstance(GATPipeCPI cpi, GATPipeCPI_Instance const *lhs, GATPipeCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATPipeCPI_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 rhs The new instance data is to be returned here. * * @return An error code. */ GATResult GATPipeCPI_CloneInstance(GATPipeCPI cpi, GATPipeCPI_Instance const *data, GATPipeCPI_Instance *new_data) { return cpi->clone_instance(cpi->data, data, new_data); } /** GATPipeCPI_Read * @brief Read from this peep. * * Calls the adaptor to read from this peep. * * @param cpi The CPI object. * @param data The instance data of the attached CPI object * @param buffer The buffer to read into * @param size Size of data to read * @param read_bytes Number of bytes read * * @return An error code. */ GATResult GATPipeCPI_Read(GATPipeCPI cpi, GATPipeCPI_Instance const *data, void *buffer, GATuint32 size, GATuint32 *read_bytes) { return cpi->read(cpi->data, data, buffer, size, read_bytes); } /** GATPipeCPI_Write * @brief Write to this peep. * * Calls the adaptor to write to this peep. * * @param cpi The CPI object. * @param data The instance data of the attached CPI object * @param buffer The buffer to write from * @param size Size of data to write * @param read_bytes Number of bytes written * * @return An error code. */ GATResult GATPipeCPI_Write(GATPipeCPI cpi, GATPipeCPI_Instance const *data, void const *buffer, GATuint32 size, GATuint32 *written_bytes) { return cpi->write(cpi->data, data, buffer, size, written_bytes); } /** GATPipeCPI_Seek * @brief Seek on this peep. * * Calls the adaptor to seek on this peep. * * @param cpi The CPI object. * @param data The instance data of the attached CPI object * @param origin Where to seek from * @param offset Offset of seek * @param new_position New position * * @return An error code. */ GATResult GATPipeCPI_Seek(GATPipeCPI cpi, GATPipeCPI_Instance const *data, GATOrigin origin, GATint32 offset, GATuint32 *new_position) { return cpi->seek(cpi->data, data, origin, offset, new_position); } /** GATPipeCPI_Close * @brief Closes this peep. * * Calls the adaptor to close this peep. * * @param cpi The CPI object. * @param data The instance data of the attached CPI object * * @return An error code. */ GATResult GATPipeCPI_Close(GATPipeCPI cpi, GATPipeCPI_Instance const *data) { return cpi->close(cpi->data, data); } /** GATPipeCPI_GetMetrics * * The function GATPipeCPI_GetMetrics returns the list of metrics supported * by this adaptor. * * @param this 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 GATPipeCPI_GetMetrics(GATPipeCPI cpi, GATPipeCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATPipeCPI_GetMetricEvent * * The function GATPipeCPI_GetMetricEvent returns the metric event, which is * associated with the given metric. * * @param this 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 GATPipeCPI_GetMetricEvent(GATPipeCPI cpi, GATPipeCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /* Local functions */ static int GATPipeCPI_IsValidData_V1(GATPipeCPI_Data *data) { return ( NULL != data->destroy && // NULL != data->service_actions && NULL != data->destroy_instance && NULL != data->create_instance && NULL != data->clone_instance && NULL != data->equals_instance && NULL != data->read && NULL != data->write && NULL != data->seek && NULL != data->close && NULL != data->get_metrics && NULL != data->get_metric_event ) ? 1 : 0; }