src/msg/msg_private.h

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef METASIMGRID_PRIVATE_H
   8 #define METASIMGRID_PRIVATE_H
   9
  10 #include "msg/msg.h"
  11 #include "simgrid/simix.h"
  12 #include "surf/surf.h"
  13 #include "xbt/fifo.h"
  14 #include "xbt/dynar.h"
  15 #include "xbt/swag.h"
  16 #include "xbt/dict.h"
  17 #include "xbt/config.h"
  18 #include "instr/instr_private.h"
  19 SG_BEGIN_DECL()
  20
  21 /**************** datatypes **********************************/
  22
  23 /********************************* Task **************************************/
  24
  25 typedef struct simdata_task {
  26   smx_action_t compute;         /* SIMIX modeling of computation */
  27   smx_action_t comm;            /* SIMIX modeling of communication */
  28   double message_size;          /* Data size */
  29   double computation_amount;    /* Computation size */
  30   msg_process_t sender;
  31   msg_process_t receiver;
  32   msg_host_t source;
  33   double priority;
  34   double rate;
  35   int isused;  /* Indicates whether the task is used in SIMIX currently */
  36   int host_nb;                  /* ==0 if sequential task; parallel task if not */
  37   /*******  Parallel Tasks Only !!!! *******/
  38   smx_host_t *host_list;
  39   double *comp_amount;
  40   double *comm_amount;
  41 } s_simdata_task_t;
  42
  43 /********************************* File **************************************/
  44 typedef struct simdata_file {
  45   smx_file_t smx_file;
  46 } s_simdata_file_t;
  47
  48 /*************** Begin GPU ***************/
  49 typedef struct simdata_gpu_task {
  50   double computation_amount;    /* Computation size */
  51   double dispatch_latency;
  52   double collect_latency;
  53   int isused;  /* Indicates whether the task is used in SIMIX currently */
  54 } s_simdata_gpu_task_t;
  55 /*************** End GPU ***************/
  56
  57 /******************************* Process *************************************/
  58
  59 typedef struct simdata_process {
  60   msg_host_t m_host;              /* the host on which the process is running */
  61   int PID;                      /* used for debugging purposes */
  62   int PPID;                     /* The parent PID */
  63   msg_host_t put_host;            /* used for debugging purposes */
  64 #ifdef MSG_USE_DEPRECATED
  65   m_channel_t put_channel;      /* used for debugging purposes */
  66 #endif
  67   smx_action_t waiting_action;
  68   msg_task_t waiting_task;
  69   char **argv;                  /* arguments table if any */
  70   int argc;                     /* arguments number if any */
  71   msg_error_t last_errno;       /* the last value returned by a MSG_function */
  72
  73   msg_vm_t vm;                 /* virtual machine the process is in */
  74
  75   void* data;                   /* user data */
  76 } s_simdata_process_t, *simdata_process_t;
  77
  78 typedef struct process_arg {
  79   const char *name;
  80   xbt_main_func_t code;
  81   void *data;
  82   msg_host_t m_host;
  83   int argc;
  84   char **argv;
  85   double kill_time;
  86 } s_process_arg_t, *process_arg_t;
  87
  88 typedef struct msg_comm {
  89   smx_action_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
  90   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
  91   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
  92   msg_error_t status;           /* status of the communication once finished */
  93 } s_msg_comm_t;
  94 /*
  95 typedef enum {
  96   msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
  97 } e_msg_vm_state_t;
  98
  99 typedef struct msg_vm {
 100   const char *name;
 101   s_xbt_swag_hookup_t all_vms_hookup;
 102   s_xbt_swag_hookup_t host_vms_hookup;
 103   xbt_dynar_t processes;
 104   e_msg_vm_state_t state;
 105   msg_host_t location;
 106   int coreAmount;
 107 } s_msg_vm_t;
 108 */
 109 /************************** Global variables ********************************/
 110 typedef struct MSG_Global {
 111   xbt_fifo_t host;
 112 #ifdef MSG_USE_DEPRECATED
 113   int max_channel;
 114 #endif
 115   int PID;
 116   int session;
 117   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
 118   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
 119   void_f_pvoid_t process_data_cleanup;
 120   xbt_swag_t vms;
 121 } s_MSG_Global_t, *MSG_Global_t;
 122
 123 /*extern MSG_Global_t msg_global;*/
 124 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
 125
 126
 127 /*************************************************************/
 128
 129 #ifdef MSG_USE_DEPRECATED
 130 #  define PROCESS_SET_ERRNO(val) \
 131   (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno=val)
 132 #  define PROCESS_GET_ERRNO() \
 133   (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno)
 134 #define MSG_RETURN(val) do {PROCESS_SET_ERRNO(val);return(val);} while(0)
 135 /* #define CHECK_ERRNO()  ASSERT((PROCESS_GET_ERRNO()!=MSG_HOST_FAILURE),"Host failed, you cannot call this function.") */
 136
 137 #else
 138 #  define MSG_RETURN(val) return(val)
 139 #endif
 140
 141 msg_host_t __MSG_host_create(smx_host_t workstation);
 142 void __MSG_host_destroy(msg_host_t host);
 143
 144 void __MSG_display_process_status(void);
 145
 146 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc);
 147 void MSG_process_create_from_SIMIX(smx_process_t *process, const char *name,
 148                                    xbt_main_func_t code, void *data,
 149                                    const char *hostname, double kill_time,  int argc,
 150                                    char **argv, xbt_dict_t properties, int auto_restart);
 151 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size);
 152
 153 void _MSG_action_init(void);
 154 void _MSG_action_exit(void);
 155
 156 void MSG_post_create_environment(void);
 157
 158 /********** Tracing **********/
 159 /* declaration of instrumentation functions from msg_task_instr.c */
 160 void TRACE_msg_set_task_category(msg_task_t task, const char *category);
 161 void TRACE_msg_task_create(msg_task_t task);
 162 void TRACE_msg_task_execute_start(msg_task_t task);
 163 void TRACE_msg_task_execute_end(msg_task_t task);
 164 void TRACE_msg_task_destroy(msg_task_t task);
 165 void TRACE_msg_task_get_start(void);
 166 void TRACE_msg_task_get_end(double start_time, msg_task_t task);
 167 int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
 168 void TRACE_msg_task_put_end(void);
 169
 170 /* declaration of instrumentation functions from msg_process_instr.c */
 171 char *instr_process_id (msg_process_t proc, char *str, int len);
 172 char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
 173 void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host,
 174                                    msg_host_t new_host);
 175 void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
 176 void TRACE_msg_process_destroy (const char *process_name, int process_pid, msg_host_t host);
 177 void TRACE_msg_process_kill(msg_process_t process);
 178 void TRACE_msg_process_suspend(msg_process_t process);
 179 void TRACE_msg_process_resume(msg_process_t process);
 180 void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
 181 void TRACE_msg_process_sleep_out(msg_process_t process);
 182 void TRACE_msg_process_end(msg_process_t process);
 183
 184 /* declaration of instrumentation functions from instr_msg_vm.c */
 185 char *instr_vm_id (msg_vm_t vm, char *str, int len);
 186 char *instr_vm_id_2 (const char *vm_name, char *str, int len);
 187 void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host,
 188                                    msg_host_t new_host);
 189 void TRACE_msg_vm_create (const char *vm_name, msg_host_t host);
 190 void TRACE_msg_vm_kill(msg_vm_t process);
 191 void TRACE_msg_vm_suspend(msg_vm_t vm);
 192 void TRACE_msg_vm_resume(msg_vm_t vm);
 193 void TRACE_msg_vm_sleep_in(msg_vm_t vm);
 194 void TRACE_msg_vm_sleep_out(msg_vm_t vm);
 195 void TRACE_msg_vm_end(msg_vm_t vm);
 196
 197 SG_END_DECL()
 198 #endif