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

GATFileCPI.c Go to the documentation of this file. /** @file GATFileCPI.c * Main file for the GATFileCPI class. * * A GATFileCPI encapsulates all the methods that a GATFile capability * provider provides. * * @date Thu Sep 18 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATFileCPI.c,v 1.25 2004/04/02 12:31:57 hartmutkaiser Exp $ * * Copyright (C) Tom Goodale * Copyright (C) Hartmut Kaiser * This file is part of the GAT Engine. * Contributed by Tom Goodale <goodale@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/GATFileCPI.c,v 1.25 2004/04/02 12:31:57 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATFileCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATFileCPI_S { /* CPI data (type local data) */ void *data; GATFileCPI_Adaptor_Destroy destroy; /* CPI instance data */ GATFileCPI_Adaptor_ServiceActions service_actions; GATFileCPI_Adaptor_CreateInstance create_instance; GATFileCPI_Adaptor_DestroyInstance destroy_instance; GATFileCPI_Adaptor_CloneInstance clone_instance; GATFileCPI_Adaptor_EqualsInstance equals_instance; /* CPI serialisation */ GATFileCPI_Adaptor_Serialise serialise; GATFileCPI_Adaptor_DeSerialise deserialise; /* CPI functionality */ GATFileCPI_Adaptor_Copy copy; GATFileCPI_Adaptor_Move move; GATFileCPI_Adaptor_Delete remove; GATFileCPI_Adaptor_IsReadable isreadable; GATFileCPI_Adaptor_IsWritable iswritable; GATFileCPI_Adaptor_GetLength length; GATFileCPI_Adaptor_LastWriteTime lastwritetime; /* CPI monitoring support */ GATFileCPI_Adaptor_GetMetrics get_metrics; GATFileCPI_Adaptor_GetMetricEvent get_metric_event; }; /* Static function prototypes */ static GATBool GATFileCPI_IsValidData_V1(GATFileCPI_Data *data); /* File scope variables */ /* External functions */ /** GATFileCPI_Create * The GATFileCPI constructor. * This is the constructor for GATFileCPI objects. * * @param version Version of the GATFileCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATFileCPI */ GATFileCPI GATFileCPI_Create(unsigned long int version, GATFileCPI_Data *data) { GATFileCPI new_cpi = NULL; if (version <= GATFILECPI_VERSION) { if (version == GATFILECPI_VERSION && GATTrue == GATFileCPI_IsValidData_V1(data)) { new_cpi = (GATFileCPI)malloc(sizeof(struct GATFileCPI_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->serialise = data->serialise; new_cpi->deserialise = data->deserialise; new_cpi->copy = data->copy; new_cpi->move = data->move; new_cpi->remove = data->remove; new_cpi->isreadable = data->isreadable; new_cpi->iswritable = data->iswritable; new_cpi->length = data->length; new_cpi->lastwritetime = data->lastwritetime; 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 == GATFILECPI_VERSION2 && GATFileCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ } return new_cpi; } /** GATFileCPI_Destroy * @brief The GATFileCPI destructor. * * This is the destructor for GATFileCPI objects. * * @param this An old GATFileCPI */ void GATFileCPI_Destroy(GATFileCPI *cpi) { if(NULL != cpi && NULL != *cpi) { (*cpi)->destroy((*cpi)->data); free(*cpi); *cpi = NULL; } } /** GATFileCPI_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 GATFileCPI_CreateInstance(GATFileCPI cpi, GATFileCPI_Instance *data) { return cpi->create_instance(cpi->data, data); } /** GATFileCPI_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 GATFileCPI_DestroyInstance(GATFileCPI cpi, GATFileCPI_Instance *data) { cpi->destroy_instance(cpi->data, data); } /** GATFileCPI_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 GATFileCPI_EqualsInstance(GATFileCPI cpi, GATFileCPI_Instance const *lhs, GATFileCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATFileCPI_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 GATFileCPI_CloneInstance(GATFileCPI cpi, GATFileCPI_Instance const *data, GATFileCPI_Instance *new_data) { return cpi->clone_instance(cpi->data, data, new_data); } /** GATFileCPI_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. * @param clear_dirty If the clear_dirty parameter is set to GATTrue, the * internal dirty flag of this object is to be reset. * * @return An error code. */ GATResult GATFileCPI_Serialise(GATFileCPI cpi, GATFileCPI_Instance const *data, GATObject stream, GATBool clear_dirty) { return cpi->serialise(cpi->data, data, stream, clear_dirty); } /** GATFileCPI_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 GATFileCPI_DeSerialise(GATFileCPI cpi, GATObject stream, GATFileCPI_Instance *data) { return cpi->deserialise(cpi->data, stream, data); } /** GATFileCPI_Copy * @brief Copy a file from one location to another. * * Calls the adaptor to copy a file from one place to another. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param targetLocation Location to copy file to. * * @return An error code. */ GATResult GATFileCPI_Copy(GATFileCPI cpi, GATFileCPI_Instance const *data, GATLocation_const targetLocation, GATFileMode mode) { return cpi->copy(cpi->data, data, targetLocation, mode); } /** GATFileCPI_Move * @brief Move a file from one location to another. * * Calls the adaptor to move a file from one place to another. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param targetLocation Location to move the file to. * * @return An error code. */ GATResult GATFileCPI_Move(GATFileCPI cpi, GATFileCPI_Instance const *data, GATLocation_const targetLocation, GATFileMode mode) { return cpi->move(cpi->data, data, targetLocation, mode); } /** GATFileCPI_Delete * @brief Delete a file. * * Calls the adaptor to delete a file. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATFileCPI_Delete(GATFileCPI file, GATFileCPI_Instance const *data) { return file->remove(file->data, data); } /** GATFileCPI_IsReadable * @brief Check the file attributes for the readable flag * * The function GATFile_IsReadable calls the adaptor which checks the file * attributes of the given file and returns, whether it is readable. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return If the inspected file is readable, the function returns * @c #GAT_SUCCESS, if it is not readable, @c #GAT_FALSE is returned. * Otherwise the function returns any of the possible errorcodes. */ GATResult GATFileCPI_IsReadable(GATFileCPI cpi, GATFileCPI_Instance const *data) { return cpi->isreadable(cpi->data, data); } /** GATFileCPI_IsWritable * @brief Check the file attributes for the writable flag * * The function GATFileCPI_IsWritable calls the adaptor which checks the file * attributes of the given file and returns, whether it is writable. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return If the inspected file is writable, the function returns * @c #GAT_SUCCESS, if it is not writable, @c #GAT_FALSE is returned. * Otherwise the function returns any of the possible errorcodes. */ GATResult GATFileCPI_IsWritable(GATFileCPI cpi, GATFileCPI_Instance const *data) { return cpi->iswritable(cpi->data, data); } /** GATFileCPI_GetLength * @brief Returns the size of the given file * * The function GATFile_GetLength returns the file size of the given size * measured in bytes. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return The size of the given file measured in bytes. If an error occurs, * the function returns (unsigned long)(-1). */ GATResult GATFileCPI_GetLength(GATFileCPI cpi, GATFileCPI_Instance const *data, unsigned long *length) { return cpi->length(cpi->data, data, length); } /** GATFileCPI_LastWriteTime * @brief Returns the time of last modification of the given file * * The function GATFile_LastWriteTime returns the time of last modification of * the inspected file. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return The time of the last modification of the file. If an error occurs, * the function will return 0 (zero). */ GATResult GATFileCPI_LastWriteTime(GATFileCPI cpi, GATFileCPI_Instance const *data, GATTime *lw_time) { return cpi->lastwritetime(cpi->data, data, lw_time); } /** GATFileCPI_GetMetrics * * The function GATFileCPI_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 GATFileCPI_GetMetrics(GATFileCPI cpi, GATFileCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATFileCPI_GetMetricEvent * * The function GATFileCPI_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 GATFileCPI_GetMetricEvent(GATFileCPI cpi, GATFileCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /* Local functions */ static GATBool GATFileCPI_IsValidData_V1(GATFileCPI_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->serialise && NULL != data->deserialise && NULL != data->copy && NULL != data->move && NULL != data->remove && NULL != data->isreadable && NULL != data->iswritable && NULL != data->length && NULL != data->lastwritetime && NULL != data->get_metrics && NULL != data->get_metric_event ) ? GATTrue : GATFalse; }