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

GATFileStreamCPI.c Go to the documentation of this file. /** @file GATFileStreamCPI.c * Main .c for the GATFileStreamCPI class. * * A GATFileStreamCPI encapsulates all the methods that a GATFileStream capability * provider provides. * * @date $Date: 2004/04/02 12:31:57 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATFileStreamCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This fileStream 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/GATFileStreamCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATFileStreamCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATFileStreamCPI_S { /* CPI data (type local data) */ void *data; GATFileStreamCPI_Adaptor_Destroy destroy; GATFileStreamCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATFileStreamCPI_Adaptor_CreateInstance create_instance; GATFileStreamCPI_Adaptor_DestroyInstance destroy_instance; GATFileStreamCPI_Adaptor_CloneInstance clone_instance; GATFileStreamCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATFileStreamCPI_Adaptor_Read read; GATFileStreamCPI_Adaptor_Write write; GATFileStreamCPI_Adaptor_Seek seek; GATFileStreamCPI_Adaptor_Close close; /* CPI monitoring support */ GATFileStreamCPI_Adaptor_GetMetrics get_metrics; GATFileStreamCPI_Adaptor_GetMetricEvent get_metric_event; }; /* Static function prototypes */ static int GATFileStreamCPI_IsValidData_V1(GATFileStreamCPI_Data *data); /* File scope variables */ /* External functions */ /** GATFileStreamCPI_Create * The GATFileStreamCPI constructor. * This is the constructor for GATFileStreamCPI objects. * * @param version Version of the GATFileStreamCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATFileStreamCPI */ GATFileStreamCPI GATFileStreamCPI_Create(unsigned long int version, GATFileStreamCPI_Data *data) { GATFileStreamCPI new_cpi = NULL; if (version <= GATFILESTREAMCPI_VERSION) { if (version == GATFILESTREAMCPI_VERSION && GATTrue == GATFileStreamCPI_IsValidData_V1(data)) { new_cpi = (GATFileStreamCPI)malloc(sizeof(struct GATFileStreamCPI_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 == GATFILESTREAMCPI_VERSION2 && GATFileStreamCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ } return new_cpi; } /** GATFileStreamCPI_Destroy * @brief The GATFileStreamCPI destructor. * * This is the destructor for GATFileStreamCPI objects. * * @param this An old GATFileStreamCPI */ void GATFileStreamCPI_Destroy(GATFileStreamCPI *cpi) { if(NULL != cpi && NULL != *cpi) { (*cpi)->destroy((*cpi)->data); free(*cpi); *cpi = NULL; } } /** GATFileStreamCPI_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 * * @return An error code. */ GATResult GATFileStreamCPI_CreateInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data) { return cpi->create_instance(cpi->data, data); } /** GATFileStreamCPI_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 GATFileStreamCPI_DestroyInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data) { cpi->destroy_instance(cpi->data, data); } /** GATFileStreamCPI_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 GATFileStreamCPI_EqualsInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *lhs, GATFileStreamCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATFileStreamCPI_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 GATFileStreamCPI_CloneInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATFileStreamCPI_Instance *new_data) { return cpi->clone_instance(cpi->data, data, new_data); } /** GATFileStreamCPI_Read * @brief Read from this fileStream. * * Calls the adaptor to read from this fileStream. * * @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 GATFileStreamCPI_Read(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, void *buffer, GATuint32 size, GATuint32 *read_bytes) { return cpi->read(cpi->data, data, buffer, size, read_bytes); } /** GATFileStreamCPI_Write * @brief Write to this fileStream. * * Calls the adaptor to write to this fileStream. * * @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 GATFileStreamCPI_Write(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, void const *buffer, GATuint32 size, GATuint32 *written_bytes) { return cpi->write(cpi->data, data, buffer, size, written_bytes); } /** GATFileStreamCPI_Seek * @brief Seek on this fileStream. * * Calls the adaptor to seek on this fileStream. * * @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 GATFileStreamCPI_Seek(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATOrigin origin, GATint32 offset, GATuint32 *new_position) { return cpi->seek(cpi->data, data, origin, offset, new_position); } /** GATFileStreamCPI_Close * @brief Closes this fileStream. * * Calls the adaptor to close this fileStream. * * @param cpi The CPI object. * @param data The instance data of the attached CPI object * * @return An error code. */ GATResult GATFileStreamCPI_Close(GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data) { return cpi->close(cpi->data, data); } /** GATFileStreamCPI_GetMetrics * * The function GATFileStreamCPI_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 GATFileStreamCPI_GetMetrics(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATFileStreamCPI_GetMetricEvent * * The function GATFileStreamCPI_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 GATFileStreamCPI_GetMetricEvent(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /* Local functions */ static int GATFileStreamCPI_IsValidData_V1(GATFileStreamCPI_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; }