src/include/simix/simix.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
   4    All rights reserved.                                          */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _SIMIX_SIMIX_H
  10 #define _SIMIX_SIMIX_H
  11
  12 #include "xbt/misc.h"
  13 #include "simix/datatypes.h"
  14
  15 SG_BEGIN_DECL()
  16
  17
  18 /************************** Global ******************************************/
  19 XBT_PUBLIC(void) SIMIX_config(const char *name, ...);
  20 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  21 XBT_PUBLIC(void) SIMIX_global_init_args(int *argc, char **argv);
  22 XBT_PUBLIC(SIMIX_error_t) SIMIX_main(void);
  23 XBT_PUBLIC(SIMIX_error_t) SIMIX_clean(void);
  24 XBT_PUBLIC(void) SIMIX_function_register(const char *name, smx_process_code_t code);
  25 XBT_PUBLIC(smx_process_code_t) SIMIX_get_registered_function(const char *name);
  26 // SIMIX_deploy_application???
  27 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
  28
  29 XBT_PUBLIC(double) SIMIX_get_clock(void);
  30
  31 /************************** Host handling ***********************************/
  32 //pointer to above layer
  33 XBT_PUBLIC(SIMIX_error_t) SIMIX_host_set_data(smx_host_t host, void *data);
  34 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
  35
  36 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
  37 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
  38 /* int SIMIX_get_msgload(void); This function lacks specification; discard it */
  39 XBT_PUBLIC(double) SIMIX_get_host_speed(smx_host_t h);
  40 XBT_PUBLIC(int) SIMIX_host_is_avail (smx_host_t h);
  41
  42 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
  43
  44 XBT_PUBLIC(smx_host_t) SIMIX_get_host_by_name(const char *name);
  45 XBT_PUBLIC(int) SIMIX_get_host_number(void);
  46 XBT_PUBLIC(smx_host_t *)SIMIX_get_host_table(void);
  47
  48 /************************** Process handling *********************************/
  49 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
  50                                smx_process_code_t code, void *data,
  51                                smx_host_t host);
  52 XBT_PUBLIC(smx_process_t) SIMIX_process_create_with_arguments(const char *name,
  53                                               smx_process_code_t code, void *data,
  54                                               smx_host_t host, int argc, char **argv);
  55 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
  56 XBT_PUBLIC(void) SIMIX_process_killall(void);
  57
  58 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_change_host(smx_process_t process, smx_host_t host);
  59 //above layer
  60 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
  61 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_set_data(smx_process_t process, void *data);
  62
  63 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
  64 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
  65 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
  66
  67 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_suspend(smx_process_t process);
  68 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_resume(smx_process_t process);
  69 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
  70
  71 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_sleep(double nb_sec);
  72 XBT_PUBLIC(SIMIX_error_t) SIMIX_get_errno(void);
  73
  74 /************************** Synchro handling **********************************/
  75
  76 /******Mutex******/
  77 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
  78 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
  79 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
  80 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
  81 XBT_PUBLIC(SIMIX_error_t) SIMIX_mutex_destroy(smx_mutex_t mutex);
  82
  83 /*****Conditional*****/
  84 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
  85 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
  86 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
  87 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
  88 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
  89 XBT_PUBLIC(SIMIX_error_t) SIMIX_cond_destroy(smx_cond_t cond);
  90
  91
  92 /************************** Action handling ************************************/
  93 XBT_PUBLIC(smx_action_t) SIMIX_communicate(smx_host_t sender,smx_host_t receiver, char *name, double size, double rate);
  94 XBT_PUBLIC(smx_action_t) SIMIX_execute(smx_host_t host,char *name, double amount);
  95 XBT_PUBLIC(SIMIX_error_t) SIMIX_action_cancel(smx_action_t action);
  96 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
  97 XBT_PUBLIC(SIMIX_error_t) SIMIX_action_destroy(smx_action_t action);
  98 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
  99 XBT_PUBLIC(void) SIMIX_register_condition_to_action(smx_action_t action, smx_cond_t cond);
 100
 101 //SIMIX_action_wait_for_computation(smx_process_t process, smx_action_t action);
 102
 103 SG_END_DECL()
 104 #endif                          /* _SIMIX_SIMIX_H */