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.h Go to the documentation of this file. /** @file GATJobCPI.h * Header file for the GATJobCPI class. * * @date Sat Oct 25 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATJobCPI.h,v 1.12 2004/03/24 19:30:58 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) */ #if !defined(_GATJOBCPI_H_) #define _GATJOBCPI_H_ typedef struct GATJobCPI_S *GATJobCPI; #include "GATContext.h" #include "GATPreferences.h" #include "GATMonitorable.h" /* Versioning constants for the GATJobCPI_Data struct */ #define GATJOBCPI_VERSION1 1 /* the newest version we know of */ #define GATJOBCPI_VERSION GATJOBCPI_VERSION1 /** * The @c #GATJobCPI_Instance structure holds all data items supplied * by the client during the construction of the corresponding GAT object. */ typedef struct { GATContext context; /* the GAT context to use for all GATFile operations */ GATJobState state; /* the state of this job */ GATJobID jobid; /* the job id */ GATBool isdirty; /* dirty status for the whole object */ GATMonitorable_Impl monitorable; /* monitoring support */ GATObject_const source; /* the object this CPI is associated with */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATJobCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATJobCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATJobCPI_Adaptor_ServiceActions)(void *, GATJobCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ typedef void (*GATJobCPI_Adaptor_DestroyInstance)(void *, GATJobCPI_Instance *); typedef GATResult (*GATJobCPI_Adaptor_CreateInstance)(void *, GATJobCPI_Instance *, void *); typedef GATResult (*GATJobCPI_Adaptor_CloneInstance)(void *, GATJobCPI_Instance const *, GATJobCPI_Instance *); typedef GATResult (*GATJobCPI_Adaptor_EqualsInstance)(void *, GATJobCPI_Instance const *, GATJobCPI_Instance const *, GATBool *); /* CPI specific API */ typedef GATResult (*GATJobCPI_Adaptor_UnSchedule)(void *, GATJobCPI_Instance const *); typedef GATResult (*GATJobCPI_Adaptor_Checkpoint)(void *, GATJobCPI_Instance const *); typedef GATResult (*GATJobCPI_Adaptor_CloneJob)(void *, GATJobCPI_Instance const *, GATHardwareResource_const, GATJob *); typedef GATResult (*GATJobCPI_Adaptor_Migrate)(void *, GATJobCPI_Instance const *, GATHardwareResource_const, GATJob *); typedef GATResult (*GATJobCPI_Adaptor_Stop)(void *, GATJobCPI_Instance const *); typedef GATResult (*GATJobCPI_Adaptor_GetJobDescription)(void *, GATJobCPI_Instance const *, GATJobDescription_const *jd); typedef GATResult (*GATJobCPI_Adaptor_GetInfo)(void *, GATJobCPI_Instance const *, GATTable_const *jobinfo); typedef GATResult (*GATJobCPI_Adaptor_GetJobID)(void *, GATJobCPI_Instance const *, GATJobID_const *jobid); typedef GATResult (*GATJobCPI_Adaptor_GetStatus)(void *, GATJobCPI_Instance const *, GATStatus_const *jobstatus); /* callback function prototypes for the GATMonitorable interface support */ typedef GATResult (* GATJobCPI_Adaptor_GetMetrics)(void *, GATJobCPI_Instance const *, GATList_GATMetric *); typedef GATResult (* GATJobCPI_Adaptor_GetMetricEvent)(void *, GATJobCPI_Instance const *, GATMetric, GATMetricEvent *); /* Serialisation API */ typedef GATResult (*GATJobCPI_Adaptor_Serialise)(void *, GATJobCPI_Instance const *, GATObject, GATBool); typedef GATResult (*GATJobCPI_Adaptor_DeSerialise)(void *, GATObject, GATJobCPI_Instance *); /* CPI data passed from the adaptor while registering the CPI */ typedef struct { /* 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; } GATJobCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ /** 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); /* API internal to the GAT engine */ /** GATJobCPI_Destroy * @brief The GATJobCPI destructor. * * This is the destructor for GATJobCPI objects. * * @param this An old GATJobCPI */ void GATJobCPI_Destroy(GATJobCPI *cpi); /* CPI instance specific functions */ /** 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); /** 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); /** 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); /** 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); /* CPI specific API */ /* TODO: insert the declaration of your CPI specific API functions here */ /* GATMonitorable */ /** 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); /** 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); /* Serialisation API */ /** 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); /** 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); /* CPI specific API */ GATResult GATJobCPI_UnSchedule(GATJobCPI cpi, GATJobCPI_Instance const *data); GATResult GATJobCPI_Checkpoint(GATJobCPI cpi, GATJobCPI_Instance const *data); GATResult GATJobCPI_CloneJob(GATJobCPI cpi, GATJobCPI_Instance const *data, GATHardwareResource_const hr, GATJob *cloned_job); GATResult GATJobCPI_Migrate(GATJobCPI cpi, GATJobCPI_Instance const *data, GATHardwareResource_const hr, GATJob *migrated_job); GATResult GATJobCPI_Stop(GATJobCPI cpi, GATJobCPI_Instance const *data); GATResult GATJobCPI_GetJobDescription(GATJobCPI cpi, GATJobCPI_Instance const *data, GATJobDescription_const *jd); GATResult GATJobCPI_GetInfo(GATJobCPI cpi, GATJobCPI_Instance const *data, GATTable_const *jobinfo); GATResult GATJobCPI_GetJobID(GATJobCPI cpi, GATJobCPI_Instance const *data, GATJobID_const *jobid); GATResult GATJobCPI_GetStatus(GATJobCPI cpi, GATJobCPI_Instance const *data, GATStatus_const *jobstatus); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATJOBCPI_H_) */