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

resource.c Go to the documentation of this file. /** @file resource.c * Source file for the GATResourceCPI provider class for the * resourcebroker adaptor. * * TODO: Fill in the description of the new CPI provider here * * @date Wed Nov 19 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/resourcebroker/resource.c,v 1.11 2004/04/27 11:34:50 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/resourcebroker/resource.c,v 1.11 2004/04/27 11:34:50 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> #include <string.h> /* GAT Header Files */ #include "GATCPI.h" #include "GATResourceCPIInstanceData.h" /* Macros */ /* Structures, unions and enums */ /* Static function prototypes */ static void resourcebroker_adaptor_GATResourceCPI_Destroy(void *data); /* instance specific functions */ static GATResult resourcebroker_adaptor_GATResourceCPI_ServiceActions(void *data, GATResourceCPI_Instance *instance_data, GATTimePeriod_const timeout); static GATResult resourcebroker_adaptor_GATResourceCPI_CreateInstance( void *data, GATResourceCPI_Instance *instance_data, void *initialisation_data); static void resourcebroker_adaptor_GATResourceCPI_DestroyInstance( void *data, GATResourceCPI_Instance *instance_data); static GATResult resourcebroker_adaptor_GATResourceCPI_CloneInstance( void *data, GATResourceCPI_Instance const *instance_data, GATResourceCPI_Instance *new_instance_data); static GATResult resourcebroker_adaptor_GATResourceCPI_EqualsInstance( void *data, GATResourceCPI_Instance const *lhs, GATResourceCPI_Instance const *rhs, GATBool *isequal); /* Monitoring support */ static GATResult resourcebroker_adaptor_GATResourceCPI_GetMetrics( void *data, GATResourceCPI_Instance const *instance_data, GATList_GATMetric *metrics); static GATResult resourcebroker_adaptor_GATResourceCPI_GetMetricEvent( void *data, GATResourceCPI_Instance const *instance_data, GATMetric metric, GATMetricEvent *event); /* Serialisation support */ static GATResult resourcebroker_adaptor_GATResourceCPI_Serialise( void *data, GATResourceCPI_Instance const *instance_data, GATObject stream, GATBool clear_dirty); static GATResult resourcebroker_adaptor_GATResourceCPI_DeSerialise( void *data, GATObject stream, GATResourceCPI_Instance *instance_data); /* CPI API functionality */ static GATResult resourcebroker_adaptor_GATResourceCPI_GetResourceDescription( void *data, GATResourceCPI_Instance const *instance_data, GATResourceDescription_const *description); static GATResult resourcebroker_adaptor_GATResourceCPI_GetReservation( void *data, GATResourceCPI_Instance const *instance_data, GATReservation_const *reservation); /* File scope variables */ /* External functions */ /* Register the CPI to implement */ GATResult resourcebroker_adaptor_Register_GATResourceCPI( GATContext error_context, GATRegistry registry, GATTable_const system_config, GATTable_const instance_config, void *token) { GAT_USES_STATUS(error_context, "resourcebroker_adaptor_Register_GATResourceCPI"); GATResourceCPI cpi = NULL; GATResourceCPI_Data cpidata; { memset(&cpidata, 0, sizeof(GATResourceCPI_Data)); /* * provide the appropriate callback functions */ cpidata.data = NULL; /* no adaptor instance data */ cpidata.destroy = resourcebroker_adaptor_GATResourceCPI_Destroy; /* instance data handling */ cpidata.service_actions = resourcebroker_adaptor_GATResourceCPI_ServiceActions; cpidata.create_instance = resourcebroker_adaptor_GATResourceCPI_CreateInstance; cpidata.destroy_instance = resourcebroker_adaptor_GATResourceCPI_DestroyInstance; cpidata.clone_instance = resourcebroker_adaptor_GATResourceCPI_CloneInstance; cpidata.equals_instance = resourcebroker_adaptor_GATResourceCPI_EqualsInstance; /* monitoring support functions */ cpidata.get_metrics = resourcebroker_adaptor_GATResourceCPI_GetMetrics; cpidata.get_metric_event = resourcebroker_adaptor_GATResourceCPI_GetMetricEvent; /* serialisation support functions */ cpidata.serialise = resourcebroker_adaptor_GATResourceCPI_Serialise; cpidata.deserialise = resourcebroker_adaptor_GATResourceCPI_DeSerialise; /* CPI specific API functions */ cpidata.get_resource_description = resourcebroker_adaptor_GATResourceCPI_GetResourceDescription; cpidata.get_reservation = resourcebroker_adaptor_GATResourceCPI_GetReservation; /* Create a GATResourceCPI object. */ cpi = GATResourceCPI_Create(GATRESOURCECPI_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) { GAT_CREATE_STATUS(GATPreferences_Add(preferences, "Name", "resourcebroker_adaptor")); GAT_CREATE_STATUS(GATPreferences_Add(preferences, "Security", "none")); GAT_CREATE_STATUS(GATPreferences_Add(preferences, "Local", "true")); GAT_CREATE_STATUS(GATRegistry_AddGATResourceCPI(registry, cpi, token, preferences)); GATPreferences_Destroy(&preferences); } else { GAT_CREATE_STATUS(GAT_MEMORYFAILURE); } } else { GAT_CREATE_STATUS(GAT_MEMORYFAILURE); } } if (GAT_FAILED(GAT_CURRENT_STATUS())) { GATResourceCPI_Destroy(&cpi); } return GAT_RETURN_STATUS(); } /* Local functions */ static void resourcebroker_adaptor_GATResourceCPI_Destroy(void *data) { /* nothing to do here (no internal data allocated) */ assert(NULL == data); } /* instance specific functions */ /** resourcebroker_adaptor_GATResourceCPI_ServiceActions * * The function resourcebroker_adaptor_GATResourceCPI_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 resourcebroker_adaptor_GATResourceCPI_ServiceActions(void *data, GATResourceCPI_Instance *instance_data, GATTimePeriod_const timeout) { return GAT_NOTIMPL; } /** resourcebroker_adaptor_GATResourceCPI_CreateInstance * Create a new CPI object instance. * Adaptor implementation of create instance capability. * * @param data Adaptor-provided data object. * @param context The GATContext for this CPI instance * @param target The location of the file in question. * @param new_instance_data The pointer to the variable, where the instance * data of this CPI object is to be returned to. * * @return An error code. */ static GATResult resourcebroker_adaptor_GATResourceCPI_CreateInstance(void *data, GATResourceCPI_Instance *new_instance_data, void *initialisation_data) { if (NULL != new_instance_data) { GAT_USES_STATUS(new_instance_data->context, "resourcebroker_adaptor_GATResourceCPI_CreateInstance"); GAT_CREATE_STATUS(GATResourceCPIInstance_Data_Clone( (GATResourceCPIInstance_Data *) initialisation_data, (GATResourceCPIInstance_Data **) &new_instance_data->instance_data)); return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /** resourcebroker_adaptor_GATResourceCPI_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. */ static void resourcebroker_adaptor_GATResourceCPI_DestroyInstance(void *data, GATResourceCPI_Instance *instance_data) { if (NULL != instance_data) { GATResourceCPIInstance_Data_Destroy( (GATResourceCPIInstance_Data **)&instance_data->instance_data); } } /** resourcebroker_adaptor_GATResourceCPI_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. */ static GATResult resourcebroker_adaptor_GATResourceCPI_CloneInstance( void *data, GATResourceCPI_Instance const *instance_data, GATResourceCPI_Instance *new_instance_data) { if (NULL != instance_data) { GAT_USES_STATUS(instance_data->context, "resourcebroker_adaptor_GATResourceCPI_CloneInstance"); if (NULL != instance_data && NULL != new_instance_data) { GAT_CREATE_STATUS(GATResourceCPIInstance_Data_Clone( (GATResourceCPIInstance_Data const *) instance_data->instance_data, (GATResourceCPIInstance_Data **) &new_instance_data->instance_data)); } else { GAT_CREATE_STATUS(GAT_INVALID_PARAMETER); } return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /** resourcebroker_adaptor_GATResourceCPI_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. */ static GATResult resourcebroker_adaptor_GATResourceCPI_EqualsInstance( void *data, GATResourceCPI_Instance const *lhs, GATResourceCPI_Instance const *rhs, GATBool *isequal) { if (NULL != lhs) { GAT_USES_STATUS(lhs->context, "resourcebroker_adaptor_GATResourceCPI_CloneInstance"); if (NULL != rhs) { GAT_CREATE_STATUS(GATResourceCPIInstance_Data_Equals( (GATResourceCPIInstance_Data const *) lhs->instance_data, (GATResourceCPIInstance_Data *) rhs->instance_data, isequal)); } else { GAT_CREATE_STATUS(GAT_INVALID_HANDLE); } return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /* Monitoring support */ /** resourcebroker_adaptor_GATResourceCPI_GetMetrics * * The function resourcebroker_adaptor_GATResourceCPI_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 resourcebroker_adaptor_GATResourceCPI_GetMetrics(void *data, GATResourceCPI_Instance const *instance_data, GATList_GATMetric *metrics) { /* TODO: Add code to return a list of supported metrics here */ GATResult retval = GAT_NOTIMPL; return retval; } /** resourcebroker_adaptor_GATResourceCPI_GetMetricEvent * * The function resourcebroker_adaptor_GATResourceCPI_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 resourcebroker_adaptor_GATResourceCPI_GetMetricEvent(void *data, GATResourceCPI_Instance const *instance_data, GATMetric metric, GATMetricEvent *event) { GATResult retval = GAT_NOTIMPL; return retval; } /* Serialisation support */ /** resourcebroker_adaptor_GATResourceCPI_Serialise * * The function resourcebroker_adaptor_GATResourceCPI_Serialise is called by the * GAT engine, whenever the client requested a Serialise operation on the * corresponding 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. * * @return An error code */ static GATResult resourcebroker_adaptor_GATResourceCPI_Serialise(void *data, GATResourceCPI_Instance const *instance_data, GATObject stream, GATBool clear_dirty) { if (NULL != instance_data) { GAT_USES_STATUS(instance_data->context, "resourcebroker_adaptor_GATResourceCPI_Serialise"); GAT_CREATE_STATUS(GATResourceCPIInstance_Data_Serialize( (GATResourceCPIInstance_Data const *)instance_data->instance_data, stream, clear_dirty)); return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /** resourcebroker_adaptor_GATResourceCPI_DeSerialise * * The function resourcebroker_adaptor_GATResourceCPI_DeSerialise is called by * the GATEngine, whenever the client requested a DeSerialise operation for * a corresponding 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 resourcebroker_adaptor_GATResourceCPI_DeSerialise(void *data, GATObject stream, GATResourceCPI_Instance *instance_data) { if (NULL != instance_data) { GAT_USES_STATUS(instance_data->context, "resourcebroker_adaptor_GATResourceCPI_DeSerialise"); GAT_CREATE_STATUS(GATResourceCPIInstance_Data_DeSerialize( instance_data->context, stream, (GATResourceCPIInstance_Data **)&instance_data->instance_data)); return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /* CPI API functionality */ /** resourcebroker_adaptor_GATResourceCPI_GetResourceDescription * * */ static GATResult resourcebroker_adaptor_GATResourceCPI_GetResourceDescription( void *data, GATResourceCPI_Instance const *instance_data, GATResourceDescription_const *description) { if (NULL != instance_data) { GAT_USES_STATUS(instance_data->context, "resourcebroker_adaptor_GATResourceCPI_GetResourceDescription"); GAT_CREATE_STATUS(GATResourceCPIInstance_Data_GetResourceDescription( (GATResourceCPIInstance_Data const *)instance_data->instance_data, description)); return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } static GATResult resourcebroker_adaptor_GATResourceCPI_GetReservation( void *data, GATResourceCPI_Instance const *instance_data, GATReservation_const *reservation) { GATResult retval = GAT_NOTIMPL; return retval; }