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 "xbt/fifo.h"
  14 #include "simix/datatypes.h"
  15
  16 SG_BEGIN_DECL()
  17
  18
  19 /************************** Global ******************************************/
  20 XBT_PUBLIC(void) SIMIX_config(const char *name, va_list pa);
  21 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
  22 XBT_PUBLIC(void) SIMIX_global_init_args(int *argc, char **argv);
  23 XBT_PUBLIC(void) 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
  27 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
  28
  29 XBT_PUBLIC(double) SIMIX_get_clock(void);
  30 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
  31
  32 /* Timer functions */
  33 XBT_PUBLIC(void) SIMIX_timer_set (double date, void *function, void *arg);
  34 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
  35
  36 /* only for tests */
  37 XBT_PUBLIC(void) __SIMIX_main(void);
  38
  39 /* User create and kill process, the function must accept the folling parameters:
  40  * const char *name: a name for the object. It is for user-level information and can be NULL
  41  * smx_process_code_t code: is a function describing the behavior of the agent
  42  * void *data: data a pointer to any data one may want to attach to the new object.
  43  * smx_host_t host: the location where the new agent is executed
  44  * int argc, char **argv: parameters passed to code
  45  *
  46  * */
  47 XBT_PUBLIC(void) SIMIX_function_register_process_create(void * function);
  48 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void * function);
  49
  50 /************************** Host handling ***********************************/
  51
  52 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
  53 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
  54
  55 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
  56 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
  57 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
  58 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
  59
  60 XBT_PUBLIC(int) SIMIX_host_get_number(void);
  61 XBT_PUBLIC(smx_host_t *)SIMIX_host_get_table(void);
  62
  63 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
  64 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
  65
  66 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
  67 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
  68
  69 /************************** Process handling *********************************/
  70 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
  71                                smx_process_code_t code, void *data,
  72                                const char * hostname, void * clean_process_function);
  73 XBT_PUBLIC(smx_process_t) SIMIX_process_create_with_arguments(const char *name,
  74                                               smx_process_code_t code, void *data,
  75                                               const char * hostname, int argc, char **argv, void * clean_process_function);
  76 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
  77 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
  78 XBT_PUBLIC(void) SIMIX_process_killall(void);
  79
  80 //above layer
  81 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
  82 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
  83
  84 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
  85 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
  86 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
  87
  88 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
  89 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
  90 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
  91
  92
  93 /************************** Synchro handling **********************************/
  94
  95 /******Mutex******/
  96 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
  97 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
  98 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
  99 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
 100 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
 101
 102 /*****Conditional*****/
 103 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
 104 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
 105 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
 106 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
 107 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
 108 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
 109 XBT_PUBLIC(void) SIMIX_register_condition_to_action(smx_action_t action, smx_cond_t cond);
 110
 111
 112 /************************** Action handling ************************************/
 113 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, char *name,
 114                                                                                                                                                                                                         double size, double rate);
 115 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,char *name, double amount);
 116 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
 117 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
 118 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
 119 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
 120 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
 121 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
 122
 123 /*Not implemented yet */
 124 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(int workstation_nb,
 125                                                                                                                                                                                                                         void **workstation_list,
 126                                                                                                                                                                                                                         double *computation_amount,
 127                                                                                                                                                                                                                         double *communication_amount,
 128                                                                                                                                                                                                                         double amount,
 129                                                                                                                                                                                                                         double rate);
 130
 131
 132 SG_END_DECL()
 133
 134 #endif                          /* _SIMIX_SIMIX_H */