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

adaptor.c Go to the documentation of this file. /** @file adaptor.c * Main file for the logicalfile adaptor. * * Test adaptor to check the GATLogicalFile API. Provides a simple * file GATLogicalFileCPI implementation. * * @date Sun Oct 5 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/logicalfile/adaptor.c,v 1.20 2004/04/22 10:25:05 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/adaptors/logicalfile/adaptor.c,v 1.20 2004/04/22 10:25:05 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> #include <string.h> #include <sys/wait.h> #include <sys/stat.h> /* GAT Header Files */ #include <GATCPI.h> #include "GATUtil.h" #include "logical_filestore.h" /* Macros */ #define __countof(x) (sizeof(x)/sizeof(x[0])) /* Structures, unions and enums */ /* Static function prototypes */ static void logicalfile_adaptor_LogicalFileCPI_Destroy(void *data); /* instance specific functions */ static GATResult logicalfile_adaptor_LogicalFileCPI_ServiceActions(void *data, GATLogicalFileCPI_Instance *instance_data, GATTimePeriod_const timeout /* = 0 */); GATResult logicalfile_adaptor_LogicalFileCPI_CreateInstance(void *adaptor_data, GATLogicalFileCPI_Instance *data); void logicalfile_adaptor_LogicalFileCPI_DestroyInstance(void *adaptor_data, GATLogicalFileCPI_Instance *data); GATResult logicalfile_adaptor_LogicalFileCPI_CloneInstance(void *adaptor_data, GATLogicalFileCPI_Instance const *data, GATLogicalFileCPI_Instance *new_data); GATResult logicalfile_adaptor_LogicalFileCPI_EqualsInstance(void *adaptor_data, GATLogicalFileCPI_Instance const *lhs, GATLogicalFileCPI_Instance const *rhs, GATBool *isequal); /* Execute a GATLogicalFile add file operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_AddFile(void *adaptor_data, GATLogicalFileCPI_Instance *data, GATFile_const target); /* Execute a GATLogicalFile remove file operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_RemoveFile(void *adaptor_data, GATLogicalFileCPI_Instance *data, GATFile_const target); /* Execute a GATLogicalFile replicate file operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_Replicate(void *adaptor_data, GATLogicalFileCPI_Instance const *data, GATLocation_const target); /* Execute a GATLogicalFile get files operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_GetFiles(void *adaptor_data, GATLogicalFileCPI_Instance const *data, GATList_GATFile *target); /* Execute a GATLogicalFile remove operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_Remove(void *adaptor_data, GATLogicalFileCPI_Instance const *data); /* Serialisation functions */ static GATResult logicalfile_adaptor_LogicalFileCPI_Serialise(void *data, GATLogicalFileCPI_Instance const *instance_data, GATObject stream, GATBool clear_dirty); static GATResult logicalfile_adaptor_LogicalFileCPI_DeSerialise(void *data, GATObject stream, GATLogicalFileCPI_Instance *instance_data); /* Execute a GATLogicalFile get_metrics operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_GetMetrics(void *data, GATLogicalFileCPI_Instance const *instance_data, GATList_GATMetric *metrics); /* Execute a GATLogicalFile get_metric_event operation */ static GATResult logicalfile_adaptor_LogicalFileCPI_GetMetricEvent(void *data, GATLogicalFileCPI_Instance const *instance_data, GATMetric metric, GATMetricEvent *event); /* local helper functions */ static GATResult logicalfile_adaptor_FireReplicatedEvent(GATMonitorable_Impl monitorable, GATObject_const source, char const *name); /* File scope variables */ static GATStaticMetric metric_data[] = { /* fileops.file_copied event */ { "logicalfile.file_replicated", /* name */ GATMeasurementType_EventLike, /* type */ GATType_String, /* data type */ "", /* unit */ 0, /* parameter count */ 0 /* parameters */ }, }; /* symbolic constants for the metric positions inside the metric_data array */ #define METRIC_FILE_REPLICATED 0 /* External functions */ /** logicalfile_adaptor_register * Registers all CPIs this adaptor provides. * This function is invoked by the loader in the GATEngine when * an instance of this adaptor is loaded. Each instance has its * own private configuration table. * * For every CPI provided the adapter has to hand all the corresponding * function pointers to the engine to allow to be called back under certain * circumstances. Additionally the adaptor may allocate some private data for * every loaded instance. This data is handed back to the adaptor as the first * parameter to each of the subsequently called functions. * * @param registry The registry the adaptor should register its CPIs with. * @param system_config The system configuration table. * @param instance_config The configuration table for this instance. * @param token An arbitrary token used by the loader to identify this adaptor * instance * * @return An error code. */ GATResult logicalfile_adaptor_register(GATContext error_context, GATRegistry registry, GATTable_const system_config, GATTable_const instance_config, void *token) { GATResult retcode = GAT_MEMORYFAILURE; if (!GATVERSION_ISCOMPATIBLE()) { retcode = GAT_UNKNOWN_VERSION; } else { GATLogicalFileCPI cpi = NULL; GATLogicalFileCPI_Data cpidata; memset(&cpidata, 0, sizeof(GATLogicalFileCPI_Data)); /* * provide the appropriate callback functions */ /* adaptor instance data */ cpidata.data = NULL; cpidata.destroy = logicalfile_adaptor_LogicalFileCPI_Destroy; /* Lifetime control and basic GATObject functionality support for every * object instance created by the client. */ cpidata.service_actions = logicalfile_adaptor_LogicalFileCPI_ServiceActions; cpidata.create_instance = logicalfile_adaptor_LogicalFileCPI_CreateInstance; cpidata.destroy_instance = logicalfile_adaptor_LogicalFileCPI_DestroyInstance; cpidata.clone_instance = logicalfile_adaptor_LogicalFileCPI_CloneInstance; cpidata.equals_instance = logicalfile_adaptor_LogicalFileCPI_EqualsInstance; /* serialisation support for the provided instance data */ cpidata.serialise = logicalfile_adaptor_LogicalFileCPI_Serialise; cpidata.deserialise = logicalfile_adaptor_LogicalFileCPI_DeSerialise; /* the CPI specific functionality */ cpidata.add = logicalfile_adaptor_LogicalFileCPI_AddFile; cpidata.removefile = logicalfile_adaptor_LogicalFileCPI_RemoveFile; cpidata.replicate = logicalfile_adaptor_LogicalFileCPI_Replicate; cpidata.getfiles = logicalfile_adaptor_LogicalFileCPI_GetFiles; cpidata.remove = logicalfile_adaptor_LogicalFileCPI_Remove; /* monitoring support */ cpidata.get_metrics = logicalfile_adaptor_LogicalFileCPI_GetMetrics; cpidata.get_metric_event = logicalfile_adaptor_LogicalFileCPI_GetMetricEvent; /* Create a GATLogicalFileCPI object. */ cpi = GATLogicalFileCPI_Create(GATLOGICALFILECPI_VERSION, &cpidata); if(NULL != cpi) { /* Need to pass preferences to allow matching * of a user's preferences with what this adaptor does. */ GATPreferences preferences = GATPreferences_Create(); if(NULL != preferences) { /* at least the Name preference should be defined */ GATPreferences_Add(preferences, "Name", "logicalfile_adaptor"); GATPreferences_Add(preferences, "Security", "none"); GATPreferences_Add(preferences, "Local", "true"); retcode = GATRegistry_AddGATLogicalFileCPI(registry, cpi, token, preferences); GATPreferences_Destroy(&preferences); } } if (GAT_SUCCESS != retcode) { GATLogicalFileCPI_Destroy(&cpi); } } return retcode; } /* Local functions */ /** logicalfile_adaptor_LogicalFileCPI_Destroy * Destroy the adaptor-provided data object on GATLogicalFileCPI destruction. * When the GATLogicalFileCPI object created in this adaptor's _register * function is destroyed, this function is invoked to allow the * adaptor to cleanup. * * @param data Adaptor-provided data object. */ static void logicalfile_adaptor_LogicalFileCPI_Destroy(void *data) { /* nothing to do here (no internal data allocated) */ } /** logicalfile_adaptor_LogicalFileCPI_ServiceActions * * The function logicalfile_adaptor_LogicalFileCPI_ServiceActions is called, whenever * the client calls GATContext_ServiceActions. This function is called for * every created object. * This function should be used to update all instance specific data, which * may have been changed asynchronously or to fire pending events. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object * @param timeout This may be a 0 timeout to indicate no timeout at all, or * a specific time length. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_ServiceActions(void *data, GATLogicalFileCPI_Instance *instance_data, GATTimePeriod_const timeout) { return GAT_NOTIMPL; } /** logicalfile_adaptor_LogicalFileCPI_CreateInstance * Create a new CPI object instance. * Adaptor implementation of create instance capability. * * @param adaptor_data Adaptor-provided data object. * @param data The pointer to the data structure containing at least * the constructor provided data items and a member instance_data, which * may be used by the adaptor to store CPI instance specific data. * * @return An error code. */ GATResult logicalfile_adaptor_LogicalFileCPI_CreateInstance(void *adaptor_data, GATLogicalFileCPI_Instance *data) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != data) { /* this adaptor does not maintain instance data */ data->instance_data = NULL; retval = GAT_SUCCESS; } return retval; } /** logicalfile_adaptor_LogicalFileCPI_DestroyInstance * Destroy a CPI object instance. * Adaptor implementation of destroy instance capability. * * @param data Adaptor-provided data object. * @param instance_data The instance data of the CPI object to destroy. */ void logicalfile_adaptor_LogicalFileCPI_DestroyInstance(void *adaptor_data, GATLogicalFileCPI_Instance *data) { /* this adaptor does not maintain instance data */ assert(NULL == data || NULL == data->instance_data); } /** logicalfile_adaptor_LogicalFileCPI_CloneInstance * Clone a CPI object instance. * Adaptor implementation of the clone instance capability. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object * @param new_instance_data The pointer to the variable, where the instance * data of the cloned CPI object is to be returned to. * * @return An error code. */ GATResult logicalfile_adaptor_LogicalFileCPI_CloneInstance(void *adaptor_data, GATLogicalFileCPI_Instance const *instance_data, GATLogicalFileCPI_Instance *new_instance_data) { /* this adaptor does not maintain instance data */ assert(NULL != new_instance_data); new_instance_data->instance_data = NULL; return GAT_SUCCESS; } /** logicalfile_adaptor_LogicalFileCPI_EqualsInstance * Clone a CPI object instance. * Adaptor implementation of the clone instance capability. * * @param data Adaptor-provided data object. * @param lhs The instance data of the left CPI object. * @param lhs 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 logicalfile_adaptor_LogicalFileCPI_EqualsInstance(void *data, GATLogicalFileCPI_Instance const *lhs, GATLogicalFileCPI_Instance const *rhs, GATBool *isequal) { /* this adaptor does not maintain instance data */ GATResult retval = GAT_INVALID_HANDLE; if (NULL != isequal) { *isequal = GATTrue; retval = GAT_SUCCESS; } return retval; } /** logicalfile_adaptor_LogicalFileCPI_AddFile * Add a file to the logical file store. * Adaptor implementation of logical file add capability. * * @param data Adaptor-provided data object. * @param context a GATContext * @param target File to add to the logical file collection. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_AddFile(void *adaptor_data, GATLogicalFileCPI_Instance *data, GATFile_const target) { GATResult retcode = GAT_FAIL; char const *name = GATLocation_ToString(data->location); logical_filestore store = logical_filestore_create(data->context, name, data->mode); free((char *)name); if (NULL != store) { retcode = logical_filestore_addfile(data->context, store, target); logical_filestore_destroy(data->context, &store); /* flush to disk and destroy object */ } return retcode; } /** logicalfile_adaptor_LogicalFileCPI_RemoveFile * Remove a file from the logical file store. * Adaptor implementation of logical file remove capability. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object * @param target File to remove from the collection. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_RemoveFile(void *adaptor_data, GATLogicalFileCPI_Instance *data, GATFile_const target) { GATResult retcode = GAT_FAIL; char const *name = GATLocation_ToString(data->location); logical_filestore store = logical_filestore_create(data->context, name, data->mode); free((char *)name); if (NULL != store) { retcode = logical_filestore_removefile(data->context, store, target); logical_filestore_destroy(data->context, &store); /* flush to disk and destroy object */ } return retcode; } /** static GATResult logicalfile_adaptor_LogicalFileCPI_Remove * Remove the logical file store. * Adaptor implementation of logical file store remove capability. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_Remove(void *adaptor_data, GATLogicalFileCPI_Instance const *data) { GATResult retcode = GAT_FAIL; char const *name = GATLocation_ToString(data->location); logical_filestore store = logical_filestore_create(data->context, name, data->mode); free((char *)name); if (NULL != store) { retcode = logical_filestore_remove(store); logical_filestore_destroy(data->context, &store); /* flush to disk and destroy object */ } return retcode; } /** logicalfile_adaptor_LogicalFileCPI_Replicate * Replicates the logical file store to a file at the given location. * Adaptor implementation of logical file replicate capability. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object * @param target Location of the file, where the logical file store is to be * replicated to. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_Replicate(void *adaptor_data, GATLogicalFileCPI_Instance const *data, GATLocation_const target) { GATResult retcode = GAT_FAIL; char const *name = GATLocation_ToString(data->location); logical_filestore store = logical_filestore_create(data->context, name, data->mode); free((char *)name); if (NULL != store) { retcode = logical_filestore_replicate(data->context, store, target); logical_filestore_destroy(data->context, &store); /* flush to disk and destroy object */ if (GAT_SUCCESS == retcode) { /* fire the file_copied event */ char *source = GATLocation_ToString(target); retcode = logicalfile_adaptor_FireReplicatedEvent(data->monitorable, data->source, source); free(source); } } return retcode; } /** logicalfile_adaptor_LogicalFileCPI_GetFiles * Get the list of physical files contained in the given logical file store. * Adaptor implementation of logical file get files capability. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object * @param target A pointer to the location, where the returned list of files is * to be placed to. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_GetFiles(void *adaptor_data, GATLogicalFileCPI_Instance const *data, GATList_GATFile *target) { GAT_USES_STATUS(data->context, "logicalfile_adaptor_LogicalFileCPI_GetFiles"); if (NULL == target) { GAT_CREATE_STATUS(GAT_INVALID_PARAMETER); } else { char const *name = GATLocation_ToString(data->location); logical_filestore store = logical_filestore_create(data->context, name, data->mode); free((char *)name); *target = NULL; if (NULL != store) { GAT_CREATE_STATUS(logical_filestore_getfiles(data->context, store, target)); logical_filestore_destroy(data->context, &store); //retcode = (NULL != *target) ? GAT_SUCCESS : GAT_MEMORYFAILURE; }else{ GAT_CREATE_STATUS(GAT_MEMORYFAILURE); } } return GAT_RETURN_STATUS(); } /* Serialisation support */ /** logicalfile_adaptor_LogicalFileCPI_Serialise * * The function logicalfile_adaptor_LogicalFileCPI_Serialise is called by the * GAT engine, whenever the client requested a Serialise operation on the * corresponding GATLogicalFile object. The function should serialise into the * given stream all the instance specific data of the object. * * @param data Adaptor-provided data object. * @param instance_data The instance data of this CPI object. * @param stream The GATSTream object to use for serialisation of the instance * data. * @param clear_dirty This flag defines, whether the dirty flag of saved * dependent objects is to be cleared. * * @return An error code */ static GATResult logicalfile_adaptor_LogicalFileCPI_Serialise(void *data, GATLogicalFileCPI_Instance const *instance_data, GATObject stream, GATBool clear_dirty) { /* this adaptor does not maintain instance data */ GATResult retval = GAT_SUCCESS; return retval; } /** logicalfile_adaptor_LogicalFileCPI_DeSerialise * * The function logicalfile_adaptor_LogicalFileCPI_DeSerialise is called by * the GATEngine, whenever the client requested a DeSerialise operation for * a GATLogicalFile object. The function should deserialise all the instance * specific data of the object from the given stream. * * @param data Adaptor-provided data object. * @param stream The GATSTream object to use for de-serialisation of the * instance data. * @param instance_data The instance data of this CPI object. * * @return An error code */ static GATResult logicalfile_adaptor_LogicalFileCPI_DeSerialise(void *data, GATObject stream, GATLogicalFileCPI_Instance *instance_data) { /* this adaptor does not maintain instance data */ GATResult retval = GAT_SUCCESS; if (instance_data) { instance_data->instance_data = NULL; } return retval; } /* Monitoring support */ /** logicalfile_adaptor_LogicalFileCPI_GetMetrics * * The function logicalfile_adaptor_LogicalFileCPI_GetMetrics should return a * list of GATMetric objects supported by this adaptor. I.e. the adaptor is * capable to fire GATMetricEvents for the returned metrics. This list should * include all the supported metrics, event like and continuous ones. * * @param data Adaptor-provided data object. * @param instance_data Instance data for the CPI provider object. * @param metrics The pointer to the variable, which receives the returned * list of metrics. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_GetMetrics(void *data, GATLogicalFileCPI_Instance const *instance_data, GATList_GATMetric *metrics) { return GATMetric_CreateListOfMetrics(metric_data, __countof(metric_data), metrics); } /** logicalfile_adaptor_LogicalFileCPI_GetMetricEvent * * The function logicalfile_adaptor_LogicalFileCPI_GetMetricEvent should * return the GATMetricEvent associated with the given continuous metric. This * function gets called for continuous metrics only, since returning the * metric event object to the caller is th only way for the client to get * access to it. * * @param data Adaptor-provided data object. * @param instance_data Instance data for the CPI provider object. * @param metric The metric instance describing the metric event to return. * This metric should be equivalent to one of the metrics returned by * our own GetMetrics CPI function (see above). If this is another * (not known to us metric), an error should be returned. * @param event The pointer to the variable, which receives the metric event * to return. * * @return An error code. */ static GATResult logicalfile_adaptor_LogicalFileCPI_GetMetricEvent(void *data, GATLogicalFileCPI_Instance const *instance_data, GATMetric metric, GATMetricEvent *event) { /* this adaptor supports no continuous metrics */ GATResult retval = GAT_SUCCESS; return retval; } /** logicalfile_adaptor_FireReplicatedEvent * * The function logicalfile_adaptor_FireReplicatedEvent fires a * 'file replicated' event to all registered metric listeners. */ static GATResult logicalfile_adaptor_FireReplicatedEvent(GATMonitorable_Impl monitorable, GATObject_const source, char const *name) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != monitorable && NULL != source && NULL != name) { GATMetric metric = NULL; retval = GATMetric_CreateMetric(&metric_data[METRIC_FILE_REPLICATED], &metric); if (GAT_SUCCESS == retval) { GATMetricEvent event = GATMetricEvent_Create_EventLike(source, metric, (void *)name, (GATuint32)(strlen(name) + 1)); if (NULL != event) { retval = GATMonitorable_Impl_FireEvent(monitorable, metric, event); } else { retval = GAT_MEMORYFAILURE; } GATMetricEvent_Destroy(&event); GATMetric_Destroy(&metric); } } return retval; }