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 bound; /* Capping for CPU resource */
  35   double rate;  /* Capping for network resource */
  36   int isused;  /* Indicates whether the task is used in SIMIX currently */
  37   int host_nb;                  /* ==0 if sequential task; parallel task if not */
  38   /*******  Parallel Tasks Only !!!! *******/
  39   smx_host_t *host_list;
  40   double *comp_amount;
  41   double *comm_amount;
  42 } s_simdata_task_t;
  43
  44 /********************************* File **************************************/
  45 typedef struct simdata_file {
  46   smx_file_t smx_file;
  47 } s_simdata_file_t;
  48
  49 /*************** Begin GPU ***************/
  50 typedef struct simdata_gpu_task {
  51   double computation_amount;    /* Computation size */
  52   double dispatch_latency;
  53   double collect_latency;
  54   int isused;  /* Indicates whether the task is used in SIMIX currently */
  55 } s_simdata_gpu_task_t;
  56 /*************** End GPU ***************/
  57
  58 /******************************* Process *************************************/
  59
  60 typedef struct simdata_process {
  61   msg_host_t m_host;              /* the host on which the process is running */
  62   msg_host_t put_host;            /* used for debugging purposes */
  63 #ifdef MSG_USE_DEPRECATED
  64   m_channel_t put_channel;      /* used for debugging purposes */
  65 #endif
  66   smx_action_t waiting_action;
  67   msg_task_t waiting_task;
  68   char **argv;                  /* arguments table if any */
  69   int argc;                     /* arguments number if any */
  70   msg_error_t last_errno;       /* the last value returned by a MSG_function */
  71
  72   void* data;                   /* user data */
  73 } s_simdata_process_t, *simdata_process_t;
  74
  75 typedef struct process_arg {
  76   const char *name;
  77   xbt_main_func_t code;
  78   void *data;
  79   msg_host_t m_host;
  80   int argc;
  81   char **argv;
  82   double kill_time;
  83 } s_process_arg_t, *process_arg_t;
  84
  85 typedef struct msg_comm {
  86   smx_action_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
  87   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
  88   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
  89   msg_error_t status;           /* status of the communication once finished */
  90 } s_msg_comm_t;
  91
  92
  93 /******************************* VM *************************************/
  94 typedef struct dirty_page {
  95   double prev_clock;
  96   double prev_remaining;
  97   msg_task_t task;
  98 } s_dirty_page, *dirty_page_t;
  99
 100 XBT_PUBLIC_DATA(const char*) MSG_vm_get_property_value(msg_vm_t vm, const char *name);
 101 XBT_PUBLIC_DATA(xbt_dict_t) MSG_vm_get_properties(msg_vm_t vm);
 102 XBT_PUBLIC_DATA(void) MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn);
 103 XBT_PUBLIC_DATA(msg_vm_t) MSG_vm_get_by_name(const char *name);
 104 XBT_PUBLIC_DATA(const char*) MSG_vm_get_name(msg_vm_t vm);
 105
 106 /************************** Global variables ********************************/
 107 typedef struct MSG_Global {
 108   xbt_fifo_t host;
 109 #ifdef MSG_USE_DEPRECATED
 110   int max_channel;
 111 #endif
 112   int session;
 113   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
 114   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
 115   void_f_pvoid_t process_data_cleanup;
 116 } s_MSG_Global_t, *MSG_Global_t;
 117
 118 /*extern MSG_Global_t msg_global;*/
 119 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
 120
 121
 122 /*************************************************************/
 123
 124 #ifdef MSG_USE_DEPRECATED
 125 #  define PROCESS_SET_ERRNO(val) \
 126   (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno=val)
 127 #  define PROCESS_GET_ERRNO() \
 128   (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno)
 129 #define MSG_RETURN(val) do {PROCESS_SET_ERRNO(val);return(val);} while(0)
 130 /* #define CHECK_ERRNO()  ASSERT((PROCESS_GET_ERRNO()!=MSG_HOST_FAILURE),"Host failed, you cannot call this function.") */
 131
 132 #else
 133 #  define MSG_RETURN(val) return(val)
 134 #endif
 135
 136 msg_host_t __MSG_host_create(smx_host_t workstation);
 137 void __MSG_host_destroy(msg_host_t host);
 138
 139 void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc);
 140 void MSG_process_create_from_SIMIX(smx_process_t *process, const char *name,
 141                                    xbt_main_func_t code, void *data,
 142                                    const char *hostname, double kill_time,  int argc,
 143                                    char **argv, xbt_dict_t properties, int auto_restart);
 144 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size);
 145
 146 void _MSG_action_init(void);
 147 void _MSG_action_exit(void);
 148
 149 void MSG_post_create_environment(void);
 150
 151 static inline void *msg_host_resource_priv(const void *host) {
 152   return xbt_lib_get_level((void *)host, MSG_HOST_LEVEL);
 153 }
 154
 155 void MSG_host_add_task(msg_host_t host, msg_task_t task);
 156 void MSG_host_del_task(msg_host_t host, msg_task_t task);
 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_start(msg_vm_t vm);
 190 void TRACE_msg_vm_create(const char *vm_name, msg_host_t host);
 191 void TRACE_msg_vm_kill(msg_vm_t process);
 192 void TRACE_msg_vm_suspend(msg_vm_t vm);
 193 void TRACE_msg_vm_resume(msg_vm_t vm);
 194 void TRACE_msg_vm_save(msg_vm_t vm);
 195 void TRACE_msg_vm_restore(msg_vm_t vm);
 196 void TRACE_msg_vm_end(msg_vm_t vm);
 197
 198 SG_END_DECL()
 199 #endif