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

GATJobCPI.c Go to the documentation of this file. /** @file GATJobCPI.c * Source file for the GATJobCPI class. * * @date Sat Oct 25 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATJobCPI.c,v 1.9 2004/04/02 12:31:57 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/src/GATJobCPI.c,v 1.9 2004/04/02 12:31:57 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATErrors.h" #include "GATMonitorable.h" #include "GATJobCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATJobCPI_S { /* CPI data (type local data) */ void *data; GATJobCPI_Adaptor_Destroy destroy; GATJobCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATJobCPI_Adaptor_CreateInstance create_instance; GATJobCPI_Adaptor_DestroyInstance destroy_instance; GATJobCPI_Adaptor_CloneInstance clone_instance; GATJobCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATJobCPI_Adaptor_UnSchedule unschedule; GATJobCPI_Adaptor_Checkpoint checkpoint; GATJobCPI_Adaptor_CloneJob clonejob; GATJobCPI_Adaptor_Migrate migratejob; GATJobCPI_Adaptor_Stop stopjob; GATJobCPI_Adaptor_GetJobDescription get_jobdescription; GATJobCPI_Adaptor_GetInfo get_jobinfo; GATJobCPI_Adaptor_GetJobID get_jobid; GATJobCPI_Adaptor_GetStatus get_status; /* CPI monitoring support */ GATJobCPI_Adaptor_GetMetrics get_metrics; GATJobCPI_Adaptor_GetMetricEvent get_metric_event; /* CPI serialisation */ GATJobCPI_Adaptor_Serialise serialise; GATJobCPI_Adaptor_DeSerialise deserialise; }; /* Static function prototypes */ static GATBool GATJobCPI_IsValidData_V1(GATJobCPI_Data *data); /* File scope variables */ /* External functions */ /** GATJobCPI_Create * The GATJobCPI constructor. * new_cpi is the constructor for GATJobCPI objects. * * @param version Version of the GATJobCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATJobCPI */ GATJobCPI GATJobCPI_Create(unsigned long int version, GATJobCPI_Data *data) { GATJobCPI new_cpi = NULL; if (version <= GATJOBCPI_VERSION) { if (version == GATJOBCPI_VERSION && GATTrue == GATJobCPI_IsValidData_V1(data)) { new_cpi = (GATJobCPI)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->unschedule = data->unschedule; new_cpi->checkpoint = data->checkpoint; new_cpi->clonejob = data->clonejob; new_cpi->migratejob = data->migratejob; new_cpi->stopjob = data->stopjob; new_cpi->get_jobdescription = data->get_jobdescription; new_cpi->get_jobinfo = data->get_jobinfo; new_cpi->get_jobid = data->get_jobid; new_cpi->get_status = data->get_status; new_cpi->get_metrics = data->get_metrics; new_cpi->get_metric_event = data->get_metric_event; new_cpi->serialise = data->serialise; new_cpi->deserialise = data->deserialise; } } /* add functionality for newer versions here else if (version == GATJOBCPI_VERSION2 && GATJobCPI_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; } /** GATJobCPI_Destroy * @brief The GATJobCPI destructor. * * This is the destructor for GATJobCPI objects. * * @param this An old GATJobCPI */ void GATJobCPI_Destroy(GATJobCPI *object) { if(NULL != object && NULL != *object) { /* call the adapter supplied destroy function */ (*object)->destroy((*object)->data); free(*object); *object = NULL; } } /** GATJobCPI_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 GATJobCPI_CreateInstance(GATJobCPI cpi, GATJobCPI_Instance *instance_data, void *initialisation_data) { return cpi->create_instance(cpi->data, instance_data, initialisation_data); } /** GATJobCPI_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 GATJobCPI_DestroyInstance(GATJobCPI cpi, GATJobCPI_Instance *instance_data) { cpi->destroy_instance(cpi->data, instance_data); } /** GATJobCPI_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 GATJobCPI_EqualsInstance(GATJobCPI cpi, GATJobCPI_Instance const *lhs, GATJobCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATJobCPI_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 GATJobCPI_CloneInstance(GATJobCPI cpi, GATJobCPI_Instance const *instance_data, GATJobCPI_Instance *new_instance_data) { return cpi->clone_instance(cpi->data, instance_data, new_instance_data); } /** GATJobCPI_GetMetrics * * The function GATJobCPI_GetMetrics returns the list of metrics supported * by this adaptor. * * @param cpi The CPI object. * @param instance_data The instance data of the attached CPI object * @param The pointer to the variable, which receives the resulting list of * metrics. * * @return An error code. */ GATResult GATJobCPI_GetMetrics(GATJobCPI cpi, GATJobCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATJobCPI_GetMetricEvent * * The function GATJobCPI_GetMetricEvent returns the metric event, which is * associated with the given metric. * * @param cpi The CPI object. * @param instance_data The instance data of the attached CPI object * @param metric The continuous metric, for which the metric event is to be * returned. * @param event The pointer to the variable, which receives the resulting * metric event. * * @return An error code. */ GATResult GATJobCPI_GetMetricEvent(GATJobCPI cpi, GATJobCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /** GATJobCPI_Serialise * @brief Serialise the instance data. * * Calls the adaptor to serialise the instance data. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param stream The stream to use be used for serialisation. * @param clear_dirty If the clear_dirty parameter is set to GATTrue, the * internal dirty flag of this object is to be reset. * * @return An error code. */ GATResult GATJobCPI_Serialise(GATJobCPI cpi, GATJobCPI_Instance const *data, GATObject stream, GATBool clear_dirty) { return cpi->serialise(cpi->data, data, stream, clear_dirty); } /** GATJobCPI_DeSerialise * @brief De-serialise the instance data * * Call the adaptor to de-serialise the instance data. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param instance_data The pointer to a variable, which contains the client * data of the new object. The member instance data of this object * may receive the pointer to the new instance data of the CPI object. * * @return An error code. */ GATResult GATJobCPI_DeSerialise(GATJobCPI cpi, GATObject stream, GATJobCPI_Instance *data) { return cpi->deserialise(cpi->data, stream, data); } /* CPI specific API functions */ /* * */ GATResult GATJobCPI_UnSchedule(GATJobCPI cpi, GATJobCPI_Instance const *data) { return cpi->unschedule(cpi->data, data); } /* * */ GATResult GATJobCPI_Checkpoint(GATJobCPI cpi, GATJobCPI_Instance const *data) { return cpi->checkpoint(cpi->data, data); } /* * */ GATResult GATJobCPI_CloneJob(GATJobCPI cpi, GATJobCPI_Instance const *data, GATHardwareResource_const hr, GATJob *cloned_job) { return cpi->clonejob(cpi->data, data, hr, cloned_job); } /* * */ GATResult GATJobCPI_Migrate(GATJobCPI cpi, GATJobCPI_Instance const *data, GATHardwareResource_const hr, GATJob *migrated_job) { return cpi->migratejob(cpi->data, data, hr, migrated_job); } /* * */ GATResult GATJobCPI_Stop(GATJobCPI cpi, GATJobCPI_Instance const *data) { return cpi->stopjob(cpi->data, data); } /* * */ GATResult GATJobCPI_GetJobDescription(GATJobCPI cpi, GATJobCPI_Instance const *data, GATJobDescription_const *jd) { return cpi->get_jobdescription(cpi->data, data, jd); } /* * */ GATResult GATJobCPI_GetInfo(GATJobCPI cpi, GATJobCPI_Instance const *data, GATTable_const *jobinfo) { return cpi->get_jobinfo(cpi->data, data, jobinfo); } /* * */ GATResult GATJobCPI_GetJobID(GATJobCPI cpi, GATJobCPI_Instance const *data, GATJobID_const *jobid) { return cpi->get_jobid(cpi->data, data, jobid); } /* * */ GATResult GATJobCPI_GetStatus(GATJobCPI cpi, GATJobCPI_Instance const *data, GATStatus_const *jobstatus) { return cpi->get_status(cpi->data, data, jobstatus); } /* Local functions */ static GATBool GATJobCPI_IsValidData_V1(GATJobCPI_Data *data) { return ( NULL != data->destroy && // NULL != data->service_actions && NULL != data->get_metrics && NULL != data->get_metric_event && NULL != data->serialise && NULL != data->deserialise && NULL != data->destroy && NULL != data->unschedule && NULL != data->checkpoint && NULL != data->clonejob && NULL != data->migratejob && NULL != data->stopjob && NULL != data->get_jobdescription && NULL != data->get_jobinfo && NULL != data->get_jobid && NULL != data->get_status && NULL != data->create_instance && NULL != data->destroy_instance && NULL != data->clone_instance && NULL != data->equals_instance ) ? GATTrue : GATFalse; }