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

reservation.c Go to the documentation of this file. /** @file reservation.c * Source file for the sample Reservation CPI provider. * * @date Thu Oct 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/resourcebroker/reservation.c,v 1.7 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/reservation.c,v 1.7 2004/04/26 15:45:00 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> #include <string.h> /* GAT Header Files */ #include "GATCPI.h" #include "GATUtil.h" /* Macros */ /* Structures, unions and enums */ /* Static function prototypes */ static void resourcebroker_adaptor_GATReservationCPI_Destroy(void *data); /* instance specific functions */ static GATResult resourcebroker_adaptor_GATReservationCPI_ServiceActions(void *data, GATReservationCPI_Instance *instance_data, GATTimePeriod_const timeout); GATResult resourcebroker_adaptor_GATReservationCPI_CreateInstance(void *data, GATReservationCPI_Instance *instance_data); void resourcebroker_adaptor_GATReservationCPI_DestroyInstance(void *data, GATReservationCPI_Instance *instance_data); GATResult resourcebroker_adaptor_GATReservationCPI_CloneInstance(void *data, GATReservationCPI_Instance const *instance_data, GATReservationCPI_Instance *new_instance_data); GATResult resourcebroker_adaptor_GATReservationCPI_EqualsInstance(void *data, GATReservationCPI_Instance const *lhs, GATReservationCPI_Instance const *rhs, GATBool *isequal); /* CPI API functionality */ static GATResult resourcebroker_adaptor_ReservationCPI_Cancel(void *data, GATReservationCPI_Instance *instance_data); static GATResult resourcebroker_adaptor_ReservationCPI_GetResource(void *data, GATReservationCPI_Instance const *instance_data, GATResource_const *resource); /* File scope variables */ /* External functions */ /* Register the CPI to implement */ GATResult resourcebroker_adaptor_Register_GATReservationCPI( GATContext error_context, GATRegistry registry, GATTable_const system_config, GATTable_const instance_config, void *token) { GAT_USES_STATUS(error_context, "resourcebroker_adaptor_Register_GATReservationCPI"); GATReservationCPI cpi = NULL; GATReservationCPI_Data cpidata; { memset(&cpidata, 0, sizeof(GATReservationCPI_Data)); /* * provide the appropriate callback functions */ cpidata.data = NULL; /* no adaptor instance data */ cpidata.destroy = resourcebroker_adaptor_GATReservationCPI_Destroy; /* instance data handling */ cpidata.service_actions = resourcebroker_adaptor_GATReservationCPI_ServiceActions; cpidata.create_instance = resourcebroker_adaptor_GATReservationCPI_CreateInstance; cpidata.destroy_instance = resourcebroker_adaptor_GATReservationCPI_DestroyInstance; cpidata.clone_instance = resourcebroker_adaptor_GATReservationCPI_CloneInstance; cpidata.equals_instance = resourcebroker_adaptor_GATReservationCPI_EqualsInstance; /* CPI specific API functions */ cpidata.cancel = resourcebroker_adaptor_ReservationCPI_Cancel; cpidata.get_resource = resourcebroker_adaptor_ReservationCPI_GetResource; /* Create a GATReservationCPI object. */ cpi = GATReservationCPI_Create(GATRESERVATIONCPI_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_AddGATReservationCPI(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())) { GATReservationCPI_Destroy(&cpi); } return GAT_RETURN_STATUS(); } /* Local functions */ static void resourcebroker_adaptor_GATReservationCPI_Destroy(void *data) { /* nothing to do here (no internal data allocated) */ } /* instance specific functions */ /** resourcebroker_adaptor_GATReservationCPI_ServiceActions * * The function resourcebroker_adaptor_GATReservationCPI_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_GATReservationCPI_ServiceActions(void *data, GATReservationCPI_Instance *instance_data, GATTimePeriod_const timeout) { return GAT_NOTIMPL; } /** resourcebroker_adaptor_GATReservationCPI_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. */ GATResult resourcebroker_adaptor_GATReservationCPI_CreateInstance(void *data, GATReservationCPI_Instance *new_instance_data) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != new_instance_data) { new_instance_data->instance_data = NULL; /* no instance data */ retval = GAT_SUCCESS; } return retval; } /** resourcebroker_adaptor_GATReservationCPI_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 resourcebroker_adaptor_GATReservationCPI_DestroyInstance(void *data, GATReservationCPI_Instance *instance_data) { assert(NULL == instance_data->instance_data); /* no instance data */ } /** resourcebroker_adaptor_GATReservationCPI_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 resourcebroker_adaptor_GATReservationCPI_CloneInstance(void *data, GATReservationCPI_Instance const *instance_data, GATReservationCPI_Instance *new_instance_data) { if (new_instance_data) { new_instance_data->instance_data = NULL; /* no instance data */ } return GAT_SUCCESS; } /** resourcebroker_adaptor_GATReservationCPI_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 resourcebroker_adaptor_GATReservationCPI_EqualsInstance(void *data, GATReservationCPI_Instance const *lhs, GATReservationCPI_Instance const *rhs, GATBool *isequal) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != isequal) { *isequal = GATTrue; retval = GAT_SUCCESS; } return retval; } /* CPI specific API functions */ static GATResult resourcebroker_adaptor_ReservationCPI_Cancel(void *data, GATReservationCPI_Instance *instance_data) { GATResult retval = GAT_NOTIMPL; return retval; } static GATResult resourcebroker_adaptor_ReservationCPI_GetResource(void *data, GATReservationCPI_Instance const *instance_data, GATResource_const *resource) { GATResult retval = GAT_NOTIMPL; return retval; }