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

GATResourceBrokerCPI.c Go to the documentation of this file. /** @file GATResourceBrokerCPI.c * Source file for the GATResourceBrokerCPI class. * * A GATResourcebrokerCPI encapsulates all the methods that a * GATResourceBroker capability provider provides. * * @date Thu Oct 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceBrokerCPI.c,v 1.6 2004/04/02 12:31:58 hartmutkaiser Exp $ * * Copyright (C) Hartmut Kaiser * new_cpi 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/src/GATResourceBrokerCPI.c,v 1.6 2004/04/02 12:31:58 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATErrors.h" #include "GATResource.h" #include "GATResourceBrokerCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATResourceBrokerCPI_S { /* CPI data (type local data) */ void *data; GATResourceBrokerCPI_Adaptor_Destroy destroy; GATResourceBrokerCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATResourceBrokerCPI_Adaptor_CreateInstance create_instance; GATResourceBrokerCPI_Adaptor_DestroyInstance destroy_instance; GATResourceBrokerCPI_Adaptor_CloneInstance clone_instance; GATResourceBrokerCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATResourceBrokerCPI_Adaptor_ReserveResource_Description reserve_description; GATResourceBrokerCPI_Adaptor_ReserveResource reserve; GATResourceBrokerCPI_Adaptor_FindResources find_resources; GATResourceBrokerCPI_Adaptor_SubmitJob submit_job; }; /* Static function prototypes */ static GATBool GATResourceBrokerCPI_IsValidData_V1(GATResourceBrokerCPI_Data *data); /* File scope variables */ /* External functions */ /** GATResourceBrokerCPI_Create * The GATResourceBrokerCPI constructor. * new_cpi is the constructor for GATResourceBrokerCPI objects. * * @param version Version of the GATResourceBrokerCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATResourceBrokerCPI */ GATResourceBrokerCPI GATResourceBrokerCPI_Create(unsigned long int version, GATResourceBrokerCPI_Data *data) { GATResourceBrokerCPI new_cpi = NULL; if (version <= GATRESOURCEBROKERCPI_VERSION) { if (version == GATRESOURCEBROKERCPI_VERSION && GATTrue == GATResourceBrokerCPI_IsValidData_V1(data)) { new_cpi = (GATResourceBrokerCPI)malloc(sizeof(*new_cpi)); 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->reserve_description = data->reserve_description; new_cpi->reserve = data->reserve; new_cpi->find_resources = data->find_resources; new_cpi->submit_job = data->submit_job; } } /* add functionality for newer versions here else if (version == GATRESOURCEBROKERCPI_VERSION2 && GATResourceBrokerCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ new_cpi = NULL; } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ new_cpi = NULL; } return new_cpi; } /** GATResourceBrokerCPI_Destroy * @brief The GATResourceBrokerCPI destructor. * * This is the destructor for GATResourceBrokerCPI objects. * * @param this An old GATResourceBrokerCPI */ void GATResourceBrokerCPI_Destroy(GATResourceBrokerCPI *object) { if(NULL != object && NULL != *object) { /* call the adapter supplied destroy function */ (*object)->destroy((*object)->data); free(*object); *object = NULL; } } /** GATResourceBrokerCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param context a GATContext * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATResourceBrokerCPI_CreateInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance *instance_data) { return cpi->create_instance(cpi->data, instance_data); } /** GATResourceBrokerCPI_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 GATResourceBrokerCPI_DestroyInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance *instance_data) { cpi->destroy_instance(cpi->data, instance_data); } /** GATResourceBrokerCPI_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 new_instance_data The new instance data is to be returned here. * * @return An error code. */ GATResult GATResourceBrokerCPI_CloneInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *instance_data, GATResourceBrokerCPI_Instance *new_instance_data) { return cpi->clone_instance(cpi->data, instance_data, new_instance_data); } /** GATResourceBrokerCPI_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 GATResourceBrokerCPI_EqualsInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *lhs, GATResourceBrokerCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATResourceBrokerCPI_ReserveResource_Description * @brief Reserve a resource, which mets the description. * * Call the adaptor to allocate a reservation * * @param cpi The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param description The ResourceDescription to use to select the appropriate * resource. * @param time The (optional) time, when the reservation has to start * @param duration The (optional) time period for which to reserve the * resource. * @param reservation The pointer to the GATReservation variable to use to * return the resulting reservation. * * @return An error value. */ GATResult GATResourceBrokerCPI_ReserveResource_Description(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *instance_data, GATResourceDescription_const description, GATTime_const time, GATTimePeriod_const duration, GATReservation *reservation) { return cpi->reserve_description(cpi->data, instance_data, description, time, duration, reservation); } /** GATResourceBrokerCPI_ReserveResource * @brief Reserve a given resource. * * Call the adaptor to allocate a reservation * * @param cpi The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param resource The resource to reserve. * @param time The (optional) time, when the reservation has to start * @param duration The (optional) time period for which to reserve the * resource. * @param reservation The pointer to the GATReservation variable to use to * return the resulting reservation. * * @return An error value. */ GATResult GATResourceBrokerCPI_ReserveResource(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *instance_data, GATResource_const resource, GATTime_const time, GATTimePeriod_const duration, GATReservation *reservation) { return cpi->reserve(cpi->data, instance_data, resource, time, duration, reservation); } /** GATResourceBrokerCPI_FindResources * @brief Find a list of matching resources. * * Call the adaptor to find a list of resources matching the given resource * description. * * @param cpi The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param description The resource description to match. * @param resources The pointer to the GATList_GATResource variable to use to * return the resulting list of resources. * * @return An error value. */ GATResult GATResourceBrokerCPI_FindResources(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *instance_data, GATResourceDescription_const description, GATList_GATResource *resources) { return cpi->find_resources(cpi->data, instance_data, description, resources); } /** GATResourceBrokerCPI_SubmitJob * @brief Submit a new job. * * Call the adaptor to submit a new job to a resource. * * @param cpi The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param description The resource description to match. * @param resources The pointer to the GATJob variable to use to * return the resulting job. * * @return An error value. */ GATResult GATResourceBrokerCPI_SubmitJob(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *instance_data, GATJobDescription_const description, GATJob *job) { return cpi->submit_job(cpi->data, instance_data, description, job); } /* Local functions */ static GATBool GATResourceBrokerCPI_IsValidData_V1(GATResourceBrokerCPI_Data *data) { return ( NULL != data->destroy && // NULL != data->service_actions && NULL != data->create_instance && NULL != data->destroy_instance && NULL != data->clone_instance && NULL != data->equals_instance && NULL != data->reserve_description && NULL != data->reserve && NULL != data->find_resources && NULL != data->submit_job ) ? GATTrue : GATFalse; }