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
  12 #include "src/kernel/activity/SynchroExec.hpp"
  13 #include "src/kernel/activity/SynchroComm.hpp"
  14
  15 SG_BEGIN_DECL()
  16
  17 /**************** datatypes **********************************/
  18 /********************************* Host **************************************/
  19 typedef struct s_msg_host_priv {
  20
  21   std::vector<int> *file_descriptor_table;
  22 } s_msg_host_priv_t;
  23 /********************************* Task **************************************/
  24
  25 typedef struct simdata_task {
  26   ~simdata_task()
  27   {
  28     if (this->compute)
  29       this->compute->unref();
  30
  31     /* parallel tasks only */
  32     xbt_free(this->host_list);
  33   }
  34   void setUsed();
  35   void setNotUsed()
  36   {
  37     this->isused = false;
  38   }
  39
  40   simgrid::kernel::activity::Exec *compute = nullptr; /* SIMIX modeling of computation */
  41   simgrid::kernel::activity::Comm *comm = nullptr;    /* SIMIX modeling of communication */
  42   double bytes_amount = 0.0; /* Data size */
  43   double flops_amount = 0.0; /* Computation size */
  44   msg_process_t sender = nullptr;
  45   msg_process_t receiver = nullptr;
  46   msg_host_t source = nullptr;
  47   double priority = 0.0;
  48   double bound = 0.0; /* Capping for CPU resource */
  49   double rate = 0.0;  /* Capping for network resource */
  50
  51   bool isused = false;  /* Indicates whether the task is used in SIMIX currently */
  52   int host_nb = 0;      /* ==0 if sequential task; parallel task if not */
  53   /*******  Parallel Tasks Only !!!! *******/
  54   sg_host_t *host_list = nullptr;
  55   double *flops_parallel_amount = nullptr;
  56   double *bytes_parallel_amount = nullptr;
  57
  58 private:
  59   void reportMultipleUse() const;
  60 } s_simdata_task_t;
  61
  62 /********************************* File **************************************/
  63 typedef struct simdata_file {
  64   smx_file_t smx_file;
  65 } s_simdata_file_t;
  66
  67 XBT_PRIVATE int __MSG_host_get_file_descriptor_id(msg_host_t host);
  68 XBT_PRIVATE void __MSG_host_release_file_descriptor_id(msg_host_t host, int id);
  69
  70 /******************************* Process *************************************/
  71
  72 typedef struct simdata_process {
  73   msg_host_t m_host;              /* the host on which the process is running */
  74   msg_host_t put_host;            /* used for debugging purposes */
  75   smx_activity_t waiting_action;
  76   msg_task_t waiting_task;
  77   msg_error_t last_errno;       /* the last value returned by a MSG_function */
  78
  79   void* data;                   /* user data */
  80 } s_simdata_process_t, *simdata_process_t;
  81
  82 typedef struct process_arg {
  83   const char *name;
  84   xbt_main_func_t code;
  85   void *data;
  86   msg_host_t m_host;
  87   int argc;
  88   char **argv;
  89   double kill_time;
  90 } s_process_arg_t, *process_arg_t;
  91
  92 typedef struct msg_comm {
  93   smx_activity_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
  94   msg_task_t task_sent;           /* task sent (NULL for the receiver) */
  95   msg_task_t *task_received;      /* where the task will be received (NULL for the sender) */
  96   msg_error_t status;           /* status of the communication once finished */
  97 } s_msg_comm_t;
  98
  99 /************************** Global variables ********************************/
 100 typedef struct MSG_Global {
 101   int debug_multiple_use;       /* whether we want an error message when reusing the same Task for 2 things */
 102   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
 103   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
 104   void_f_pvoid_t process_data_cleanup;
 105 } s_MSG_Global_t, *MSG_Global_t;
 106
 107 /*extern MSG_Global_t msg_global;*/
 108 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
 109
 110 /*************************************************************/
 111 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
 112 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
 113 XBT_PRIVATE void __MSG_host_priv_free(msg_host_priv_t priv);
 114 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
 115 XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
 116
 117 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
 118 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char *name,
 119                                    std::function<void()> code, void *data,
 120                                    sg_host_t host, double kill_time,
 121                                    xbt_dict_t properties, int auto_restart,
 122                                    smx_actor_t parent_process);
 123 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
 124
 125 XBT_PRIVATE void MSG_post_create_environment();
 126
 127 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
 128 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
 129
 130 /********** Tracing **********/
 131 /* declaration of instrumentation functions from msg_task_instr.c */
 132 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
 133 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
 134 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
 135 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
 136 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
 137 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
 138 XBT_PRIVATE void TRACE_msg_task_get_start();
 139 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
 140 XBT_PRIVATE void TRACE_msg_task_put_end();
 141
 142 /* declaration of instrumentation functions from msg_process_instr.c */
 143 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
 144 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
 145 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
 146 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
 147 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
 148 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
 149 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
 150 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
 151 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
 152 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
 153
 154 SG_END_DECL()
 155
 156 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(
 157   const char *name, std::function<void()> code, void *data,
 158   msg_host_t host, xbt_dict_t properties);
 159
 160 inline void simdata_task::setUsed()
 161 {
 162   if (this->isused)
 163     this->reportMultipleUse();
 164   if (msg_global->debug_multiple_use) {
 165     // TODO, backtrace
 166   }
 167   this->isused = true;
 168 }
 169
 170 #endif