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