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

request.c Go to the documentation of this file. /** @file request.c * Source file for the GATRequestCPI provider class for the * request adaptor. * * @date Mon Feb 02 2004 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/resourcebroker/request.c,v 1.4 2004/04/26 15:45:00 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/request.c,v 1.4 2004/04/26 15:45:00 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> #include <string.h> #include <time.h> /* GAT Header Files */ #include "GATCPI.h" #include "GATRequestNotifier.h" #include "GATRequestCPIInstanceData.h" #include "request.h" /* Macros */ #ifndef PATH_MAX #define PATH_MAX 4096 #endif /* ! PATH_MAX */ /* Structures, unions and enums */ /* Static function prototypes */ static void resourcebroker_adaptor_GATRequestCPI_Destroy(void *data); /* instance specific functions */ static GATResult resourcebroker_adaptor_GATRequestCPI_ServiceActions(void *data, GATRequestCPI_Instance *instance_data, GATTimePeriod_const timeout /* = 0 */); static GATResult resourcebroker_adaptor_GATRequestCPI_CreateInstance(void *adaptor_data, GATRequestCPI_Instance *instance_data, void *initialisation_data); static void resourcebroker_adaptor_GATRequestCPI_DestroyInstance( void *data, GATRequestCPI_Instance *instance_data); static GATResult resourcebroker_adaptor_GATRequestCPI_CloneInstance( void *data, GATRequestCPI_Instance const *instance_data, GATRequestCPI_Instance *new_instance_data); static GATResult resourcebroker_adaptor_GATRequestCPI_EqualsInstance( void *data, GATRequestCPI_Instance const *lhs, GATRequestCPI_Instance const *rhs, GATBool *isequal); /* CPI API functionality */ static GATResult resourcebroker_adaptor_GATRequestCPI_InitRequestNotifier( void *data, GATRequestCPI_Instance const *instance_data, GATRequestNotifier_const *notifier); /* local functions */ static GATResult resourcebroker_adaptor_GATRequestCPI_request_notifier_listener( void *data, GATRequestCPI_Instance const *instance_data, GATTable_const notifier_data, void *context_data); /* File scope variables */ /* External functions */ /* Register the CPI to implement */ GATResult resourcebroker_adaptor_Register_GATRequestCPI( GATContext error_context, GATRegistry registry, GATTable_const system_config, GATTable_const instance_config, void *token) { GAT_USES_STATUS(error_context, "resourcebroker_adaptor_Register_GATRequestCPI"); GATRequestCPI cpi = NULL; GATRequestCPI_Data cpidata; { memset(&cpidata, 0, sizeof(GATRequestCPI_Data)); /* * provide the appropriate callback functions */ cpidata.data = NULL; /* no adaptor instance data */ cpidata.destroy = resourcebroker_adaptor_GATRequestCPI_Destroy; /* instance data handling */ cpidata.service_actions = resourcebroker_adaptor_GATRequestCPI_ServiceActions; cpidata.create_instance = resourcebroker_adaptor_GATRequestCPI_CreateInstance; cpidata.destroy_instance = resourcebroker_adaptor_GATRequestCPI_DestroyInstance; cpidata.clone_instance = resourcebroker_adaptor_GATRequestCPI_CloneInstance; cpidata.equals_instance = resourcebroker_adaptor_GATRequestCPI_EqualsInstance; /* CPI specific API functions */ cpidata.init_notifier = resourcebroker_adaptor_GATRequestCPI_InitRequestNotifier; /* Create a GATRequestCPI object. */ cpi = GATRequestCPI_Create(GATREQUESTCPI_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_AddGATRequestCPI(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())) { GATRequestCPI_Destroy(&cpi); } return GAT_RETURN_STATUS(); } /* Local functions */ static void resourcebroker_adaptor_GATRequestCPI_Destroy(void *data) { /* nothing to do here (no internal data allocated) */ assert(NULL == data); } /* instance specific functions */ /** 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 resourcebroker_adaptor_GATRequestCPI_ServiceActions(void *data, GATRequestCPI_Instance *instance_data, GATTimePeriod_const timeout) { if (NULL != instance_data) { /* TODO: include checkpoint callback listen -- ANDRE */ GATResult retval = GAT_SUCCESS; GATRequestCPIInstance_Data *data = (GATRequestCPIInstance_Data *)instance_data->instance_data; if (difftime(time(0), data->start_time) >= 2) { /* wait an appropriate amount of time */ retval = GATRequest_IssueCommand(instance_data->source); } return retval; } return GAT_INVALID_HANDLE; } /** resourcebroker_adaptor_GATRequestCPI_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_GATRequestCPI_CreateInstance(void *data, GATRequestCPI_Instance *new_instance_data, void *initialisation_data) { if (NULL != new_instance_data) { GAT_USES_STATUS(new_instance_data->context, "resourcebroker_adaptor_GATRequestCPI_CreateInstance"); GAT_CREATE_STATUS(GATRequestCPIInstance_Data_Clone(initialisation_data, (GATRequestCPIInstance_Data **)&new_instance_data->instance_data)); return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /** resourcebroker_adaptor_GATRequestCPI_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_GATRequestCPI_DestroyInstance(void *data, GATRequestCPI_Instance *instance_data) { GATRequestCPIInstance_Data_Destroy( (GATRequestCPIInstance_Data **) &instance_data->instance_data); } /** resourcebroker_adaptor_GATRequestCPI_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_GATRequestCPI_CloneInstance( void *data, GATRequestCPI_Instance const *instance_data, GATRequestCPI_Instance *new_instance_data) { if (NULL != instance_data) { GAT_USES_STATUS(instance_data->context, "resourcebroker_adaptor_GATRequestCPI_CloneInstance"); if (NULL != new_instance_data) { GAT_CREATE_STATUS(GATRequestCPIInstance_Data_Clone( (GATRequestCPIInstance_Data const *)instance_data->instance_data, (GATRequestCPIInstance_Data **)&new_instance_data->instance_data)); } else { GAT_CREATE_STATUS(GAT_INVALID_PARAMETER); } return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /** resourcebroker_adaptor_GATRequestCPI_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_GATRequestCPI_EqualsInstance( void *data, GATRequestCPI_Instance const *lhs, GATRequestCPI_Instance const *rhs, GATBool *isequal) { if (NULL != lhs && NULL != rhs) { GAT_USES_STATUS(lhs->context, "resourcebroker_adaptor_GATRequestCPI_EqualsInstance"); GAT_CREATE_STATUS(GATRequestCPIInstance_Data_Equals( (GATRequestCPIInstance_Data const *) lhs->instance_data, (GATRequestCPIInstance_Data const *) rhs->instance_data, isequal)); return GAT_RETURN_STATUS(); } return GAT_INVALID_HANDLE; } /* CPI specific API functions */ /** resourcebroker_adaptor_GATRequestCPI_InitRequestNotifier * * Calls the adaptor to return the associated request notifier. * * @param data Adaptor-provided data object. * @param instance_data The instance data of the CPI object to ask for the * request notifier. * @param notifier The pointer to a variable, which should receive the * returned request notifier. * * @return An error code. */ static GATResult resourcebroker_adaptor_GATRequestCPI_InitRequestNotifier( void *data, GATRequestCPI_Instance const *instance_data, GATRequestNotifier_const *notifier) { GATResult retval = GAT_MEMORYFAILURE; GATRequestNotifier new_notifier = GATRequestNotifier_Create(data, instance_data, resourcebroker_adaptor_GATRequestCPI_request_notifier_listener, 0); if (NULL != new_notifier) { if (NULL != notifier) { *notifier = new_notifier; retval = GAT_SUCCESS; } else { GATRequestNotifier_Destroy(&new_notifier); retval = GAT_INVALID_PARAMETER; } } return retval; } /** resourcebroker_adaptor_GATRequestCPI_request_notifier_listener * */ static GATResult resourcebroker_adaptor_GATRequestCPI_request_notifier_listener( void *data, GATRequestCPI_Instance const *instance_data, GATTable_const notifier_data, void *context_data) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != notifier_data) { /* test, whether a checkpoint_file1 key exists */ char buffer[PATH_MAX+1]; retval = GATTable_Get_String(notifier_data, "checkpoint_file1", buffer, sizeof(buffer)); if (GAT_SUCCEEDED(retval)) { retval = !strcmp(buffer, "some_name") ? GAT_SUCCESS : GAT_FAIL; } } return retval; }