drmaa_tool.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef DRMAA_TOOL_H_
#define DRMAA_TOOL_H_
 
#include "drmaa_library.h"
#include "typedefs.h"
#include "linked_list.h"
#include "operation.h"
#include "json_util.h"
#include "uuid_defs.h"
//#include "drmaa.h"
#include "grassroots_server.h"
 
 
 
#define DRMAA_ID_BUFFER_SIZE (256)
 
/* forward declaration */
struct drmaa_job_template_s;
 
typedef struct DrmaaTool
{
  char *dt_program_name_s;
  LinkedList *dt_args_p;
  char *dt_queue_name_s;
  char *dt_working_directory_s;
 
  struct drmaa_job_template_s *dt_job_p;
  char *dt_grassroots_uuid_s;
  char dt_id_s [DRMAA_ID_BUFFER_SIZE];
 
  char dt_id_out_s [DRMAA_ID_BUFFER_SIZE];
 
  char *dt_output_filename_s;
  uint32 dt_num_cores;
  uint32 dt_mb_mem_usage;
  char *dt_host_name_s;
  char *dt_user_name_s;
  char **dt_email_addresses_ss;
 
 
  char *dt_environment_s;
 
  bool (*dt_run_fn) (struct DrmaaTool *tool_p, const bool async_flag);
 
  OperationStatus (*dt_get_status_fn) (struct DrmaaTool *tool_p);
 
} DrmaaTool;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
GRASSROOTS_DRMAA_API bool InitDrmaa (void);
 
 
GRASSROOTS_DRMAA_API bool ExitDrmaa (void);
 
 
 
GRASSROOTS_DRMAA_API DrmaaTool *AllocateDrmaaTool (const char *program_name_s, const uuid_t id, GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_DRMAA_API bool InitDrmaaTool (DrmaaTool *tool_p, const char *program_name_s, const uuid_t id, GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_DRMAA_API void FreeDrmaaTool (DrmaaTool *tool_p);
 
 
GRASSROOTS_DRMAA_API void ClearDrmaaTool (DrmaaTool *tool_p);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolCurrentWorkingDirectory (DrmaaTool *tool_p, const char *path_s);
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolQueueName (DrmaaTool *tool_p, const char *queue_name_s);
 
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolEnvVars (DrmaaTool *tool_p, const char *env_vars_s);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolCores (DrmaaTool *tool_p, uint32 num_cores);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolMemory (DrmaaTool *tool_p, uint32 mem);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolHostName (DrmaaTool *tool_p, const char *host_name_s);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolJobId (DrmaaTool *tool_p, const char *id_s);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolJobOutId (DrmaaTool *tool_p, const char *id_s);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolJobName (DrmaaTool *tool_p, const char *job_name_s);
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolOutputFilename (DrmaaTool *tool_p, const char *output_name_s);
 
 
GRASSROOTS_DRMAA_API bool AddDrmaaToolArgument (DrmaaTool *tool_p, const char *arg_s);
 
 
GRASSROOTS_DRMAA_API bool RunDrmaaTool (DrmaaTool *tool_p, const bool async_flag, const char * const log_s);
 
 
GRASSROOTS_DRMAA_API OperationStatus GetDrmaaToolStatus (DrmaaTool *tool_p);
 
 
 
GRASSROOTS_DRMAA_API bool SetDrmaaToolEmailNotifications (DrmaaTool *tool_p, const char **email_addresses_ss);
 
 
GRASSROOTS_DRMAA_API json_t *ConvertDrmaaToolToJSON (const DrmaaTool * const tool_p);
 
 
GRASSROOTS_DRMAA_API DrmaaTool *ConvertDrmaaToolFromJSON (const json_t * const json_p, GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_DRMAA_API unsigned char *SerialiseDrmaaTool (const DrmaaTool * const job_p, const size_t *size_p);
 
 
GRASSROOTS_DRMAA_API DrmaaTool *DeserialiseDrmaaTool (const unsigned char * const data_s);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DRMAA_TOOL_H_ */