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

GATRegistry.c Go to the documentation of this file. /** @file GATRegistry.c * Main file for the GATRegsitry class. * * The Registry keeps track of all capabilities and their providers. * * @date Thu Sep 18 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATRegistry.c,v 1.34 2004/04/18 18:35:10 hartmutkaiser Exp $ * * Copyright (C) Tom Goodale * This file is part of the GAT Engine. * Contributed by Tom Goodale <goodale@aei.mpg.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/GATRegistry.c,v 1.34 2004/04/18 18:35:10 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> #include <string.h> #include <assert.h> /* GAT Header Files */ #include "GATRegistry.h" #include "GATErrors.h" #include "GATPreferences.h" #include "GATList.h" #include "GATSelf.h" /* Macros */ GATOBJECT_DEFINE_VTABLE(GATRegistry); GATLIST_DEFINE_QUALIFIED(static, GATObject, GATList_GATObject, GATType_PlainOldData); #define CPILIST_NAME(object) object ## _list #define CPI_FUNCTIONS(object) \ \ int GATRegistry_AddGAT ## object ## CPI(GATRegistry this, \ GAT ## object ## CPI cpi, void *token, GATPreferences_const preferences) \ { \ return GATRegistry_internal_AddCPI(&(this->CPILIST_NAME(object)), \ cpi, token, preferences); \ } \ \ GAT ## object ## CPIList GATRegistry_FindGAT ## object ## CPI( \ GATRegistry_const this, GATPreferences_const preferences) \ { \ return (GAT ## object ## CPIList) GATRegistry_internal_FindCPI( \ this->CPILIST_NAME(object), preferences); \ } \ \ void GAT ## object ## CPIList_Destroy(GAT ## object ## CPIList list) \ { \ GATRegistry_internal_DestroyCPIList((CPIList)list); \ } \ \ GAT ## object ## CPIList GATRegistry_CloneGAT ## object ## CPIList( \ GAT ## object ## CPIList_const list) \ { \ return (GAT ## object ## CPIList) GATRegistry_internal_CloneCPIList( \ (CPIList_const) list); \ } \ \ GATResult GATRegistry_WalkGAT ## object ## CPIList(GATRegistry_const this, \ GATCPICallback callback, void *data) \ { \ return GATRegistry_internal_WalkCPIList( \ this->CPILIST_NAME(object), (GATCPICallback)callback, data); \ } \ \ GATResult GATRegistry_AddGAT ## object ## ToCPIList(GATContext ctx, \ GAT ## object ## CPI cpi, GAT ## object obj) \ { \ GATRegistry_const registry = GATContext_internal_GetRegistry(ctx); \ return GATRegistry_internal_AddGATObjectToCPIList( \ registry->CPILIST_NAME(object), cpi, \ GAT ## object ## _ToGATObject(obj)); \ } \ \ GATResult GATRegistry_RemoveGAT ## object ## FromCPIList( \ GATContext ctx, GAT ## object ## CPI cpi, GAT ## object obj) \ { \ GATRegistry_const registry = GATContext_internal_GetRegistry(ctx); \ return GATRegistry_internal_RemoveGATObjectFromCPIList( \ registry->CPILIST_NAME(object), cpi, \ GAT ## object ## _ToGATObject(obj)); \ } \ /**/ /* Structures, unions and enums */ struct CPIRegistryList_S { struct CPIRegistryList_S *next; /* next cpi of this type */ void *token; /* token of the accociated adaptor */ GATPreferences preferences; /* preferences registered for this CPI */ void *cpi; /* pointer to function table */ GATList_GATObject objects; /* list of objects created by this CPI */ }; struct CPIList_S { struct CPIList_S *next; void *cpi; }; typedef struct CPIList_S *CPIList; typedef struct CPIList_S const *CPIList_const; struct GATRegistry_S { GATRegistry_vtable *GATObject__vtable; CPIRegistryList CPILIST_NAME(Pipe); CPIRegistryList CPILIST_NAME(Endpoint); CPIRegistryList CPILIST_NAME(File); CPIRegistryList CPILIST_NAME(FileStream); CPIRegistryList CPILIST_NAME(LogicalFile); CPIRegistryList CPILIST_NAME(ResourceBroker); CPIRegistryList CPILIST_NAME(Reservation); CPIRegistryList CPILIST_NAME(Resource); CPIRegistryList CPILIST_NAME(Job); CPIRegistryList CPILIST_NAME(Self); CPIRegistryList CPILIST_NAME(Request); CPIRegistryList CPILIST_NAME(AdvertService); }; /* generic part of every GAT...CPI structure */ typedef void (*GATCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATCPI_Adaptor_ServiceActions)(void *, void *, GATTimePeriod_const); struct GATCPI_S { /* CPI data (type local data) */ void *data; GATCPI_Adaptor_Destroy destroy; GATCPI_Adaptor_ServiceActions service_actions; }; /* Static function prototypes */ static int GATRegistry_internal_AddCPI(CPIRegistryList *list, void *cpi, void *token, GATPreferences_const preferences); static CPIList GATRegistry_internal_FindCPI(CPIRegistryList_const list, GATPreferences_const preferences); static CPIList GATRegistry_internal_FindCPIWorker(CPIRegistryList_const list, GATPreferences_const preferences); static void GATRegistry_internal_DestroyCPIList(CPIList list); static CPIList GATRegistry_internal_CloneCPIList(CPIList_const list); static GATResult GATRegistry_internal_WalkCPIList(CPIRegistryList_const list, GATCPICallback callback, void *data); static GATResult GATRegistry_ServiceActionsCallback(CPIRegistryList_const cpi, void *data); static GATResult GATRegistry_CorrectTimeout(GATTime start, GATTimePeriod *timeout); static GATResult GATRegistry_internal_AddGATObjectToCPIList(CPIRegistryList_const list, void *cpi, GATObject object); static GATResult GATRegistry_internal_RemoveGATObjectFromCPIList(CPIRegistryList_const list, void *cpi, GATObject object); /* type specific destroy functions */ static void GATRegistry_DestroyPipeCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyEndpointCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyFileCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyFileStreamCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyLogicalFileCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyResourceBrokerCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyReservationCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyResourceCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyJobCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroySelfCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyRequestCPIRegistryList(CPIRegistryList list); static void GATRegistry_DestroyAdvertServiceCPIRegistryList(CPIRegistryList list); /* Dummy functions for the vtable */ static GATType GATRegistry_GetType(GATRegistry_const file); static GATResult GATRegistry_Equals(GATRegistry_const lhs, GATRegistry_const rhs, GATBool *isequal); static GATResult GATRegistry_Clone(GATRegistry_const object, GATRegistry *new_object); static GATResult GATRegistry_GetInterface(GATRegistry_const object, GATInterface iftype, void const **ifp); /* File scope variables */ static GATRegistry_vtable GATRegistry__vtable = { GATRegistry_GetType, GATRegistry_Destroy, GATRegistry_Equals, GATRegistry_Clone, GATRegistry_GetInterface, 0 /* this is needed for CPI based types only */ }; /* External functions */ /** GATRegistry_Create * The GATRegistry constructor. * This is the constructor for GATRegistry objects. * * @return A new GATRegistry */ GATRegistry GATRegistry_Create(void) { GATRegistry registry = (GATRegistry)malloc(sizeof(struct GATRegistry_S)); if(registry) { registry->GATObject__vtable = &GATRegistry__vtable; registry->CPILIST_NAME(Pipe) = NULL; registry->CPILIST_NAME(Endpoint) = NULL; registry->CPILIST_NAME(File) = NULL; registry->CPILIST_NAME(FileStream) = NULL; registry->CPILIST_NAME(LogicalFile) = NULL; registry->CPILIST_NAME(ResourceBroker) = NULL; registry->CPILIST_NAME(Reservation) = NULL; registry->CPILIST_NAME(Resource) = NULL; registry->CPILIST_NAME(Job) = NULL; registry->CPILIST_NAME(Self) = NULL; registry->CPILIST_NAME(Request) = NULL; registry->CPILIST_NAME(AdvertService) = NULL; } return registry; } /** GATRegistry_Destroy * The GATRegistry destructor. * This is the destructor for GATRegistry objects. * * @param this An old GATRegistry */ void GATRegistry_Destroy(GATRegistry *registry) { if(NULL != registry && NULL != *registry) { /* free registered file CPI's */ GATRegistry_DestroyPipeCPIRegistryList((*registry)->CPILIST_NAME(Pipe)); GATRegistry_DestroyEndpointCPIRegistryList((*registry)->CPILIST_NAME(Endpoint)); GATRegistry_DestroyFileCPIRegistryList((*registry)->CPILIST_NAME(File)); GATRegistry_DestroyFileStreamCPIRegistryList((*registry)->CPILIST_NAME(FileStream)); GATRegistry_DestroyLogicalFileCPIRegistryList( (*registry)->CPILIST_NAME(LogicalFile)); GATRegistry_DestroyResourceBrokerCPIRegistryList( (*registry)->CPILIST_NAME(ResourceBroker)); GATRegistry_DestroyReservationCPIRegistryList( (*registry)->CPILIST_NAME(Reservation)); GATRegistry_DestroyResourceCPIRegistryList( (*registry)->CPILIST_NAME(Resource)); GATRegistry_DestroyJobCPIRegistryList((*registry)->CPILIST_NAME(Job)); GATRegistry_DestroySelfCPIRegistryList((*registry)->CPILIST_NAME(Self)); GATRegistry_DestroyRequestCPIRegistryList((*registry)->CPILIST_NAME(Request)); GATRegistry_DestroyRequestCPIRegistryList( (*registry)->CPILIST_NAME(AdvertService)); free(*registry); *registry = NULL; } } /** GATType GATRegistry_GetType(GATRegistry_const file) * @brief Return the type of the GATRegistry * * The function @c GATRegistry_GetType always returns GATType_GATRegistry. * * @param object The object to inspect * * @return returns always @c #GATType_GATRegistry. */ static GATType GATRegistry_GetType(GATRegistry_const file) { GAT_UNUSED_PARAMETER(file); return GATType_GATRegistry; } /** GATRegistry_Equals * @brief Compare two GATRegistry objects * * The function @c GATRegistry_Equals compares two objects of the * @c GATRegistry type. * * @param lhs The first list to compare * @param rhs The second list to compare * @param isequal The pointer to the GATBool variable, which should receive * the result if the comparision * * @return An error code. */ GATResult GATRegistry_Equals(GATRegistry_const lhs, GATRegistry_const rhs, GATBool *isequal) { return GAT_NOTIMPL; /* shouldn't be called */ } /** GATRegistry_Clone * @brief Clone the given GATRegistry * * The function @c GATRegistry_Clone generates a (deep) copy of * the given GATRegistry. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ static GATResult GATRegistry_Clone(GATRegistry_const handle, GATRegistry *new_handle) { return GAT_NOTIMPL; /* shouldn't be called */ } /** GATResult GATRegistry_GetInterface(GATRegistry_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATRegistry_GetInterface allows to get a pointer to an * additional interface supported by this GATRegistry. * * @param object The object to be asked for the new interface. * @param iftype The interface the object is to be asked for. * @param ifp The pointer, through which the result is to be returned. * * @return An error type. */ static GATResult GATRegistry_GetInterface(GATRegistry_const object, GATInterface iftype, void const **ifp) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != ifp) { *ifp = NULL; retval = GAT_NO_INTERFACE; } return retval; } /* define the concrete CPI API functions */ CPI_FUNCTIONS(Pipe) CPI_FUNCTIONS(Endpoint) CPI_FUNCTIONS(File) CPI_FUNCTIONS(FileStream) CPI_FUNCTIONS(LogicalFile) CPI_FUNCTIONS(ResourceBroker) CPI_FUNCTIONS(Reservation) CPI_FUNCTIONS(Resource) CPI_FUNCTIONS(Job) CPI_FUNCTIONS(Self) CPI_FUNCTIONS(Request) CPI_FUNCTIONS(AdvertService) /* Local functions */ /** GATRegistry_internal_AddCPI * Add a CPI to a given list of CPIs * This adds the specified CPI object to the passed list. * Used internally by the type-safe visible functions. * * @param list the list to be added to * @param cpi The CPI object * @param token An arbitrary token used by the loader * @param preferences The preferences which a user may match against to use this CPI. * * @return An error code. */ static GATResult GATRegistry_internal_AddCPI(CPIRegistryList *list, void *cpi, void *token, GATPreferences_const preferences) { GATResult retcode; CPIRegistryList newcpi; CPIRegistryList current; newcpi = (CPIRegistryList)malloc(sizeof(struct CPIRegistryList_S)); if(NULL != newcpi) { memset(newcpi, 0, sizeof(struct CPIRegistryList_S)); newcpi->token = token; newcpi->cpi = cpi; newcpi->objects = GATList_GATObject_Create(); if (NULL == newcpi->objects) { retcode = GAT_MEMORYFAILURE; } else { retcode = GATPreferences_Clone(preferences, &(newcpi->preferences)); } if (GAT_SUCCESS == retcode) { if(NULL != *list) { /* Find end of list */ for(current = *list; NULL != current->next; current = current->next) { /* Do nothing */ } current->next = newcpi; } else { *list = newcpi; } retcode = GAT_SUCCESS; } else { GATList_GATObject_Destroy(&newcpi->objects); free(newcpi); } } else { retcode = GAT_MEMORYFAILURE; } return retcode; } /** GATRegistry_internal_FindCPI * Find a CPI to a given list of CPIs and preferences. * This searches the CPI list for matching ones and constructs a list to * return to the calling function. * Used internally by the type-safe visible functions. * * @param list the list to be searched * @param preferences The preferences which must be matched. * * @return A list of CPIs. */ static CPIList GATRegistry_internal_FindCPI(CPIRegistryList_const list, GATPreferences_const preferences) { CPIList newlist = NULL; if (NULL != preferences) { newlist = GATRegistry_internal_FindCPIWorker(list, preferences); } else { /* no (default) given, try to use local adaptors first */ GATPreferences localprefs = GATPreferences_Create(); if (NULL != localprefs) { GATPreferences_Add(localprefs, "Local", "true"); newlist = GATRegistry_internal_FindCPIWorker(list, localprefs); GATPreferences_Destroy(&localprefs); } if (NULL == newlist) { /* if this failed, try to use any adaptor */ newlist = GATRegistry_internal_FindCPIWorker(list, 0); } } return newlist; } static CPIList GATRegistry_internal_FindCPIWorker(CPIRegistryList_const list, GATPreferences_const preferences) { CPIList newlist = NULL; CPIList newcurrent = NULL; CPIList newelement = NULL; CPIRegistryList_const current = NULL; /* try to collect all adapters matching the given preferences */ for(current = list; NULL != current; current = current->next) { if (GATPreferences_Match(current->preferences, preferences)) { newelement = (CPIList)malloc(sizeof(*newelement)); if(newelement) { newelement->cpi = current->cpi; newelement->next = NULL; if(newcurrent) { newcurrent->next = newelement; } else { newlist = newelement; } newcurrent = newelement; } else { /* FIXME: Should use GATStatus object, but that's not been written yet */ assert(newelement); } } } return newlist; } /** * */ static CPIList GATRegistry_internal_CloneCPIList(CPIList_const list) { CPIList newlist = NULL; CPIList newcurrent = NULL; CPIList_const current = list; for(/**/; NULL != current; current = current->next) { CPIList newelement = (CPIList) malloc(sizeof(struct CPIList_S)); if(newelement) { newelement->cpi = current->cpi; newelement->next = NULL; if(NULL != newcurrent) { newcurrent->next = newelement; } else { newlist = newelement; } newcurrent = newelement; } else { GATRegistry_internal_DestroyCPIList(newlist); newlist = NULL; break; } } return newlist; } /* GATRegistry_internal_WalkCPIList * * Walk through the list of registred CPI's in a given list */ static GATResult GATRegistry_internal_WalkCPIList(CPIRegistryList_const list, GATCPICallback callback, void *data) { CPIRegistryList_const current = list; GATResult retval = GAT_SUCCESS; for(/**/; NULL != current; current = current->next) { if (NULL != current->cpi) { retval = callback(current, data); if (GAT_FAILED(retval)) { break; } } } return retval; } /* * */ static GATResult GATRegistry_internal_AddGATObjectToCPIList(CPIRegistryList_const list, void *cpi, GATObject object) { GATResult retval = GAT_NO_MATCHING_CPI; CPIRegistryList_const current = list; /* find the given CPI */ for(/**/; NULL != current; current = current->next) { if (NULL != current->cpi && cpi == current->cpi) { break; } } /* add the given object to the corresponing RegistryList element */ if (NULL != current) { GATList_GATObject_Iterator it = GATList_GATObject_Insert(current->objects, GATList_GATObject_End(current->objects), object); if (NULL == it) { retval = GAT_MEMORYFAILURE; } else { retval = GAT_SUCCESS; } } return retval; } /* * */ static GATResult GATRegistry_internal_RemoveGATObjectFromCPIList(CPIRegistryList_const list, void *cpi, GATObject object) { GATResult retval = GAT_NO_MATCHING_CPI; CPIRegistryList_const current = list; /* find the given CPI */ for(/**/; NULL != current; current = current->next) { if (NULL != current->cpi && cpi == current->cpi) { break; } } /* remove the given object to the corresponing RegistryList element */ if (NULL != current) { /* re-find the given object */ GATBool found = GATFalse; GATList_GATObject_Iterator it = GATList_GATObject_Begin(current->objects); GATList_GATObject_Iterator end = GATList_GATObject_End(current->objects); for (/**/; it != end; it = GATList_GATObject_Next(it)) { GATObject *obj = GATList_GATObject_Get(it); if (NULL == obj) { retval = GAT_FAIL; break; } else if (object == *obj) { GATList_GATObject_Iterator next = GATList_GATObject_Erase(current->objects, it); if (NULL == next) { retval = GAT_FAIL; } else { retval = GAT_SUCCESS; } found = GATTrue; break; } } if (GATFalse == found) { /* object not registered from this CPI */ retval = GAT_KEY_NOT_FOUND; } } return retval; } /** GATRegistry_internal_DestroyCPIList * Destroy a CPIList * Frees the memory associated with a CPI List. * Used internally by the type-safe visible functions. * * @param list the list to be destroyed */ static void GATRegistry_internal_DestroyCPIList(CPIList list) { CPIList current = list; while (NULL != current) { CPIList next = current->next; free(current); current = next; } } /** GATRegistry_DestroyFileStreamCPIRegistryList * Destroy a RegistryCPList of FileStream CPI's. This destroys the embedded CPI's * as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyFileStreamCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATFileStreamCPI_Destroy((GATFileStreamCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyPipeCPIRegistryList * Destroy a RegistryCPList of Pipes CPI's. This destroys the embedded CPI's * as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyPipeCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATPipeCPI_Destroy((GATPipeCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyEndpointCPIRegistryList * Destroy a RegistryCPList of Endpoint CPI's. This destroys the embedded CPI's * as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyEndpointCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATEndpointCPI_Destroy((GATEndpointCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyFileCPIRegistryList * Destroy a RegistryCPList of File CPI's. This destroys the embedded CPI's * as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyFileCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATFileCPI_Destroy((GATFileCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyLogicalFileCPIRegistryList * Destroy a RegistryCPList of LogicalFile CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyLogicalFileCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATLogicalFileCPI_Destroy((GATLogicalFileCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyResourceBrokerCPIRegistryList * Destroy a RegistryCPList of resourceBroker CPI's. This destroys the * embedded CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyResourceBrokerCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATResourceBrokerCPI_Destroy((GATResourceBrokerCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyReservationCPIRegistryList * Destroy a RegistryCPList of Reservation CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyReservationCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATReservationCPI_Destroy((GATReservationCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyResourceCPIRegistryList * Destroy a RegistryCPList of Resource CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyResourceCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATResourceCPI_Destroy((GATResourceCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyJobCPIRegistryList * Destroy a RegistryCPList of Job CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyJobCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATJobCPI_Destroy((GATJobCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroySelfCPIRegistryList * Destroy a RegistryCPList of Self CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroySelfCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATSelfCPI_Destroy((GATSelfCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyRequestCPIRegistryList * Destroy a RegistryCPList of Request CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyRequestCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATRequestCPI_Destroy((GATRequestCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /** GATRegistry_DestroyAdvertServiceCPIRegistryList * Destroy a RegistryCPList of AdvertService CPI's. This destroys the embedded * CPI's as well. * * @param list The registry list to be destroyed */ static void GATRegistry_DestroyAdvertServiceCPIRegistryList(CPIRegistryList list) { CPIRegistryList current = list; while (NULL != current) { /* call the adaptor supplied destroy function */ CPIRegistryList next = current->next; GATAdvertServiceCPI_Destroy((GATAdvertServiceCPI *) &current->cpi); GATPreferences_Destroy(&current->preferences); GATList_GATObject_Destroy(&current->objects); free(current); current = next; } } /* GATRegistry_internal_ServiceAction * * The ServiceActions call is used to allow the GAT Engine to service * asynchronous actions, such as GATRequests and GATMetricEvents. In a * single-threaded application it is likely that a timeout would be supplied, * in a multi-threaded application one thread may be used for the GAT by using * this call and no timeout. * * @param timeout This may be a 0 timeout to indicate no timeout at all, or * a specific time length. * * @return An error code. */ GATResult GATRegistry_internal_ServiceActions(GATRegistry_const registry, GATContext context, GATTimePeriod_const timeout) { GAT_USES_STATUS(context, "GATRegistry_internal_ServiceActions"); GATTimePeriod period = NULL; if (NULL != timeout) { GAT_CREATE_STATUS(GATTimePeriod_Clone(timeout, &period)); } GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(FileStream), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Pipe), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Endpoint), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(File), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(LogicalFile), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(ResourceBroker), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Reservation), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Resource), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Job), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Self), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(Request), GATRegistry_ServiceActionsCallback, (void *)&period)); GAT_CREATE_STATUS(GATRegistry_internal_WalkCPIList( registry->CPILIST_NAME(AdvertService), GATRegistry_ServiceActionsCallback, (void *)&period)); GATTimePeriod_Destroy(&period); return GAT_RETURN_STATUS(); } /* GATRegistry_CorrectTimeout * * Calculate the duration since the given start time. * * @return An error value. */ static GATResult GATRegistry_CorrectTimeout(GATTime start, GATTimePeriod *timeout) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != start && NULL != timeout) { GATTime now = GATTime_Create(0); if (NULL == now) { retval = GAT_MEMORYFAILURE; } else { /* calculate the duration of the previous call */ GATTimePeriod call_duration = GATTimePeriod_Create_Difference(start, now); if (NULL == call_duration) { retval = GAT_MEMORYFAILURE; } else { GATdouble64 diff = GATTimePeriod_GetDuration(*timeout) - GATTimePeriod_GetDuration(call_duration); GATTimePeriod period = GATTimePeriod_Create(diff); if (NULL == period) { retval = GAT_MEMORYFAILURE; } else { /* replace the old timeout value with the remaining time */ GATTimePeriod_Destroy(timeout); *timeout = period; } GATTimePeriod_Destroy(&call_duration); } GATTime_Destroy(&now); } } return retval; } static GATResult GATRegistry_ServiceActionsCallback(CPIRegistryList_const cpilist, void *data) { GATResult retval = GAT_SUCCESS; struct GATCPI_S *cpi = (struct GATCPI_S *)cpilist->cpi; if (NULL != cpi->service_actions) { /* call the serviceaction procedure for every registered object */ GATList_GATObject_Iterator it = GATList_GATObject_Begin(cpilist->objects); GATList_GATObject_Iterator end = GATList_GATObject_End(cpilist->objects); for (/**/; it != end; it = GATList_GATObject_Next(it)) { GATObject *obj = GATList_GATObject_Get(it); if (NULL == obj) { retval = GAT_FAIL; break; } { GATTimePeriod *timeout = (GATTimePeriod *) ((NULL != data) ? data : 0); if (timeout != 0 && NULL != *timeout) { // there is a timeout given GATTime start = GATTime_Create(0); if (NULL == start) { retval = GAT_MEMORYFAILURE; } else { void *cpidata = NULL; retval = GATObject_GetCPIInstanceData(*obj, &cpidata); if (GAT_SUCCEEDED(retval)) { retval = cpi->service_actions(cpi->data, cpidata, *timeout); } if (GAT_SUCCEEDED(retval)) { retval = GATRegistry_CorrectTimeout(start, timeout); } if (GAT_NOTIMPL == retval) { retval = GAT_SUCCESS; } } GATTime_Destroy(&start); } else { // no timeout given void *cpidata = NULL; retval = GATObject_GetCPIInstanceData(*obj, &cpidata); if (GAT_SUCCEEDED(retval)) { retval = cpi->service_actions(cpi->data, cpidata, 0); if (GAT_NOTIMPL == retval) { retval = GAT_SUCCESS; } } } } } } return retval; } /* Registry Helper functions, for internal use only */ GATResult GATRegistry_internal_AddGATSelfToCPIList(GATRegistry registry, GATSelfCPI cpi, GATSelf object) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != registry) { retval = GATRegistry_internal_AddGATObjectToCPIList( registry->CPILIST_NAME(Self), cpi, GATSelf_ToGATObject(object)); } return retval; } GATResult GATRegistry_internal_RemoveGATSelfFromCPIList(GATRegistry registry, GATSelfCPI cpi, GATSelf object) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != registry) { retval = GATRegistry_internal_RemoveGATObjectFromCPIList( registry->CPILIST_NAME(Self), cpi, GATSelf_ToGATObject(object)); } return retval; }