include/msg/msg.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef MSG_H
   9 #define MSG_H
  10
  11 #include "xbt/misc.h"
  12 #include "xbt/sysdep.h"
  13
  14 BEGIN_DECL()
  15 #include "msg/datatypes.h"
  16
  17 /************************** Global ******************************************/
  18 xbt_error_t MSG_config(const char *name, ...);
  19 void MSG_global_init(void);
  20 void MSG_global_init_args(int *argc, char **argv);
  21 void MSG_set_verbosity(MSG_outputmode_t mode);
  22 MSG_error_t MSG_set_channel_number(int number);
  23 MSG_error_t MSG_set_sharing_policy(MSG_sharing_t mode, double param);
  24 int MSG_get_channel_number(void);
  25 MSG_error_t MSG_main(void);
  26 MSG_error_t MSG_clean(void);
  27 void MSG_function_register(const char *name, m_process_code_t code);
  28 m_process_code_t MSG_get_registered_function(const char *name);
  29 void MSG_launch_application(const char *file);
  30 void MSG_paje_output(const char *filename);
  31
  32 double MSG_getClock(void);
  33 double MSG_get_clock(void);
  34
  35 /************************** Host handling ***********************************/
  36 MSG_error_t MSG_host_set_data(m_host_t host, void *data);
  37 void *MSG_host_get_data(m_host_t host);
  38 const char *MSG_host_get_name(m_host_t host);
  39 m_host_t MSG_host_self(void);
  40 int MSG_get_host_msgload(m_host_t host);
  41 /* int MSG_get_msgload(void); This function lacks specification; discard it */
  42
  43 void MSG_create_environment(const char *file);
  44
  45 m_host_t MSG_get_host_by_name(const char *name);
  46 int MSG_get_host_number(void);
  47 m_host_t *MSG_get_host_table(void);
  48
  49 /************************** Process handling *********************************/
  50 m_process_t MSG_process_create(const char *name,
  51                                m_process_code_t code, void *data,
  52                                m_host_t host);
  53 m_process_t MSG_process_create_with_arguments(const char *name,
  54                                               m_process_code_t code, void *data,
  55                                               m_host_t host, int argc, char **argv);
  56 void MSG_process_kill(m_process_t process);
  57 int MSG_process_killall(int reset_PIDs);
  58 MSG_error_t MSG_get_arguments(int *argc, char ***argv);
  59 MSG_error_t MSG_set_arguments(m_process_t process,int argc, char *argv[]);
  60
  61 MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host);
  62
  63 void *MSG_process_get_data(m_process_t process);
  64 MSG_error_t MSG_process_set_data(m_process_t process, void *data);
  65 m_host_t MSG_process_get_host(m_process_t process);
  66 m_process_t MSG_process_from_PID(int PID);
  67 int MSG_process_get_PID(m_process_t process);
  68 int MSG_process_get_PPID(m_process_t process);
  69 const char *MSG_process_get_name(m_process_t process);
  70 int MSG_process_self_PID(void);
  71 int MSG_process_self_PPID(void);
  72 m_process_t MSG_process_self(void);
  73
  74 MSG_error_t MSG_process_suspend(m_process_t process);
  75 MSG_error_t MSG_process_resume(m_process_t process);
  76 int MSG_process_isSuspended(m_process_t process);
  77
  78 MSG_error_t MSG_process_start(m_process_t process);
  79
  80 /************************** Task handling ************************************/
  81
  82 m_task_t MSG_task_create(const char *name, double compute_duration,
  83                          double message_size, void *data);
  84 m_task_t MSG_parallel_task_create(const char *name,
  85                                   int host_nb,
  86                                   const m_host_t *host_list,
  87                                   double *computation_amount,
  88                                   double *communication_amount,
  89                                   void *data);
  90 void *MSG_task_get_data(m_task_t task);
  91 m_process_t MSG_task_get_sender(m_task_t task);
  92 const char *MSG_task_get_name(m_task_t task);
  93
  94 MSG_error_t MSG_task_destroy(m_task_t task);
  95
  96 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel);
  97 MSG_error_t MSG_task_get_with_time_out(m_task_t * task, m_channel_t channel,
  98                                        double max_duration);
  99 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest,
 100                          m_channel_t channel);
 101 MSG_error_t MSG_task_put_bounded(m_task_t task,
 102                                  m_host_t dest, m_channel_t channel,
 103                                  double max_rate);
 104 MSG_error_t MSG_task_execute(m_task_t task);
 105 MSG_error_t MSG_parallel_task_execute(m_task_t task);
 106
 107 int MSG_task_Iprobe(m_channel_t channel);
 108 int MSG_task_probe_from(m_channel_t channel);
 109 MSG_error_t MSG_channel_select_from(m_channel_t channel, double max_duration,
 110                                     int *PID);
 111 MSG_error_t MSG_process_sleep(double nb_sec);
 112 MSG_error_t MSG_get_errno(void);
 113
 114 double MSG_task_get_compute_duration(m_task_t task);
 115 double MSG_task_get_data_size(m_task_t task);
 116
 117 /************************** Deprecated ***************************************/
 118 /* MSG_error_t MSG_routing_table_init(void); */
 119 /* MSG_error_t MSG_routing_table_set(m_host_t host1, m_host_t host2, */
 120 /*                                m_link_t link); */
 121 /* m_link_t MSG_routing_table_get(m_host_t host1, m_host_t host2); */
 122 /* m_host_t MSG_host_create(const char *name, */
 123 /*                      char *trace_file, */
 124 /*                      long double fixed_cpu, */
 125 /*                      char* failure_trace, */
 126 /*                      long double fixed_failure, */
 127 /*                      void *data); */
 128 /* m_host_t MSG_host_from_PID(int PID); */
 129 /* MSG_error_t MSG_host_destroy(m_host_t host); */
 130
 131 /* void MSG_link_set_sharing_value(long double alpha); */
 132 /* m_link_t MSG_link_create(const char *name, */
 133 /*                       char *lat_trace_file, long double fixed_latency, */
 134 /*                       char *bw_trace_file, long double fixed_bandwidth); */
 135 /* MSG_error_t MSG_link_destroy(m_link_t link); */
 136 /* m_link_t MSG_link_merge(const char *name, m_link_t src1, m_link_t src2); */
 137 /* m_link_t MSG_get_link_by_name(const char *name); */
 138 /* void MSG_tracelink(m_host_t dest, const char* **names, int *count); */
 139 END_DECL()
 140 #endif