src/msg/msg_private.h

   1 /* Copyright (c) 2004-2015. 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 "simgrid/msg.h"
  11 #include "simgrid/simix.h"
  12 #include "src/include/surf/surf.h"
  13 #include "xbt/base.h"
  14 #include "xbt/fifo.h"
  15 #include "xbt/dynar.h"
  16 #include "xbt/swag.h"
  17 #include "xbt/dict.h"
  18 #include "xbt/config.h"
  19 #include "src/instr/instr_private.h"
  20 SG_BEGIN_DECL()
  21
  22 /**************** datatypes **********************************/
  23
  24 /********************************* Task **************************************/
  25 #define MSG_BT(ptr, m)                              \
  26   do {xbt_ex_t *_xbt_ex_t = xbt_new0(xbt_ex_t, 1); \
  27   /* build the exception */                                             \
  28   _xbt_ex_t->msg      = (bprintf(m));                                 \
  29   _xbt_ex_t->category = (xbt_errcat_t)(0);                   \
  30   _xbt_ex_t->value    = (0);                                 \
  31   _xbt_ex_t->procname = (char*)xbt_procname();               \
  32   _xbt_ex_t->pid      = xbt_getpid();                        \
  33   _xbt_ex_t->file     = (char*)__FILE__;                     \
  34   _xbt_ex_t->line     = __LINE__;                            \
  35   _xbt_ex_t->func     = (char*)__func__;                \
  36   _xbt_ex_t->bt_strings = NULL;                              \
  37   xbt_backtrace_current(_xbt_ex_t); \
  38   ptr = _xbt_ex_t; } while(0)
  39
  40 typedef struct simdata_task {
  41   smx_synchro_t compute;         /* SIMIX modeling of computation */
  42   smx_synchro_t comm;            /* SIMIX modeling of communication */
  43   double bytes_amount;    /* Data size */
  44   double flops_amount;    /* Computation size */
  45   msg_process_t sender;
  46   msg_process_t receiver;
  47   msg_host_t source;
  48   double priority;
  49   double bound; /* Capping for CPU resource */
  50   double rate;  /* Capping for network resource */
  51
  52   /* CPU affinity database of this task */
  53   xbt_dict_t affinity_mask_db; /* smx_host_t host => unsigned long mask */
  54
  55   void *isused;  /* Indicates whether the task is used in SIMIX currently */
  56   int host_nb;                  /* ==0 if sequential task; parallel task if not */
  57   /*******  Parallel Tasks Only !!!! *******/
  58   sg_host_t *host_list;
  59   double *flops_parallel_amount;
  60   double *bytes_parallel_amount;
  61 } s_simdata_task_t;
  62
  63 /********************************* File **************************************/
  64 typedef struct simdata_file {
  65   smx_file_t smx_file;
  66 } s_simdata_file_t;
  67
  68 XBT_PRIVATE int __MSG_host_get_file_descriptor_id(msg_host_t host);
  69 XBT_PRIVATE void __MSG_host_release_file_descriptor_id(msg_host_t host, int id);
  70
  71 /*************** Begin GPU ***************/
  72 typedef struct simdata_gpu_task {
  73   double flops_amount;    /* Computation size */
  74   double dispatch_latency;
  75   double collect_latency;
  76   int isused;  /* Indicates whether the task is used in SIMIX currently */
  77 } s_simdata_gpu_task_t;
  78 /*************** End GPU ***************/
  79
  80 /******************************* Process *************************************/
  81
  82 typedef struct simdata_process {
  83   msg_host_t m_host;              /* the host on which the process is running */
  84   msg_host_t put_host;            /* used for debugging purposes */
  85   smx_synchro_t waiting_action;
  86   msg_task_t waiting_task;
  87   char **argv;                  /* arguments table if any */
  88   int argc;                     /* arguments number if any */
  89   msg_error_t last_errno;       /* the last value returned by a MSG_function */
  90
  91   void* data;                   /* user data */
  92 } s_simdata_process_t, *simdata_process_t;
  93
  94 typedef struct process_arg {
  95   const char *name;
  96   xbt_main_func_t code;
  97   void *data;
  98   msg_host_t m_host;
  99   int argc;
 100   char **argv;
 101   double kill_time;
 102 } s_process_arg_t, *process_arg_t;
 103
 104 typedef struct msg_comm {
 105   smx_synchro_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
 106   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
 107   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
 108   msg_error_t status;           /* status of the communication once finished */
 109 } s_msg_comm_t;
 110
 111 /******************************* VM *************************************/
 112 typedef struct dirty_page {
 113   double prev_clock;
 114   double prev_remaining;
 115   msg_task_t task;
 116 } s_dirty_page, *dirty_page_t;
 117
 118 XBT_PUBLIC_DATA(const char*) MSG_vm_get_property_value(msg_vm_t vm, const char *name);
 119 XBT_PUBLIC_DATA(xbt_dict_t) MSG_vm_get_properties(msg_vm_t vm);
 120 XBT_PUBLIC_DATA(void) MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn);
 121 XBT_PUBLIC_DATA(msg_vm_t) MSG_vm_get_by_name(const char *name);
 122 XBT_PUBLIC_DATA(const char*) MSG_vm_get_name(msg_vm_t vm);
 123
 124 /************************** Global variables ********************************/
 125 typedef struct MSG_Global {
 126   xbt_fifo_t host;
 127   int session;
 128   int debug_multiple_use;
 129   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
 130   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
 131   void_f_pvoid_t process_data_cleanup;
 132 } s_MSG_Global_t, *MSG_Global_t;
 133
 134 /*extern MSG_Global_t msg_global;*/
 135 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
 136
 137 /*************************************************************/
 138 // FIXME: KILLME
 139 #  define MSG_RETURN(val) return(val)
 140
 141 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
 142 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
 143 XBT_PRIVATE void __MSG_host_priv_free(msg_host_priv_t priv);
 144 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
 145 XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
 146
 147 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc);
 148 XBT_PRIVATE smx_process_t MSG_process_create_from_SIMIX(const char *name,
 149                                    xbt_main_func_t code, void *data,
 150                                    const char *hostname, double kill_time,
 151                                    int argc, char **argv,
 152                                    xbt_dict_t properties, int auto_restart,
 153                                    smx_process_t parent_process);
 154 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_synchro_t comm, void* buff, size_t buff_size);
 155
 156 XBT_PRIVATE void MSG_post_create_environment(void);
 157
 158 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
 159 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
 160 /* @brief MSG_mailbox_free - release a mailbox from the memory.
 161  * Releases a mailbox from the memory but does not remove it from the dictionary.
 162  * @param   mailbox  The mailbox to release.
 163  */
 164 XBT_PRIVATE void MSG_mailbox_free(void *mailbox);
 165
 166 /********** Tracing **********/
 167 /* declaration of instrumentation functions from msg_task_instr.c */
 168 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
 169 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
 170 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
 171 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
 172 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
 173 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
 174 XBT_PRIVATE void TRACE_msg_task_get_start(void);
 175 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
 176 XBT_PRIVATE void TRACE_msg_task_put_end(void);
 177
 178 /* declaration of instrumentation functions from msg_process_instr.c */
 179 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
 180 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
 181 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
 182 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
 183 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
 184 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
 185 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
 186 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
 187 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
 188 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
 189
 190 /* declaration of instrumentation functions from instr_msg_vm.c */
 191 XBT_PRIVATE char *instr_vm_id(msg_vm_t vm, char *str, int len);
 192 XBT_PRIVATE char *instr_vm_id_2(const char *vm_name, char *str, int len);
 193 XBT_PRIVATE void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host, msg_host_t new_host);
 194 XBT_PRIVATE void TRACE_msg_vm_start(msg_vm_t vm);
 195 XBT_PRIVATE void TRACE_msg_vm_create(const char *vm_name, msg_host_t host);
 196 XBT_PRIVATE void TRACE_msg_vm_kill(msg_vm_t process);
 197 XBT_PRIVATE void TRACE_msg_vm_suspend(msg_vm_t vm);
 198 XBT_PRIVATE void TRACE_msg_vm_resume(msg_vm_t vm);
 199 XBT_PRIVATE void TRACE_msg_vm_save(msg_vm_t vm);
 200 XBT_PRIVATE void TRACE_msg_vm_restore(msg_vm_t vm);
 201 XBT_PRIVATE void TRACE_msg_vm_end(msg_vm_t vm);
 202
 203 SG_END_DECL()
 204 #endif