src/msg/msg_private.h

   1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef METASIMGRID_PRIVATE_H
   7 #define METASIMGRID_PRIVATE_H
   8
   9 #include "simgrid/msg.h"
  10
  11 #include "src/kernel/activity/SynchroExec.hpp"
  12 #include "src/kernel/activity/SynchroComm.hpp"
  13
  14 #include <xbt/Extendable.hpp>
  15
  16 /**************** datatypes **********************************/
  17 /**************************** Host Extension *********************************/
  18 namespace simgrid {
  19 class MsgHostExt {
  20 public:
  21   static simgrid::xbt::Extension<s4u::Host, MsgHostExt> EXTENSION_ID;
  22
  23   ~MsgHostExt() {
  24     delete file_descriptor_table;
  25   }
  26   std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
  27 };
  28 }
  29 /********************************* Task **************************************/
  30
  31 typedef struct simdata_task {
  32   ~simdata_task()
  33   {
  34     if (this->compute)
  35       this->compute->unref();
  36
  37     /* parallel tasks only */
  38     xbt_free(this->host_list);
  39   }
  40   void setUsed();
  41   void setNotUsed()
  42   {
  43     this->isused = false;
  44   }
  45
  46   simgrid::kernel::activity::Exec *compute = nullptr; /* SIMIX modeling of computation */
  47   simgrid::kernel::activity::Comm *comm = nullptr;    /* SIMIX modeling of communication */
  48   double bytes_amount = 0.0; /* Data size */
  49   double flops_amount = 0.0; /* Computation size */
  50   msg_process_t sender = nullptr;
  51   msg_process_t receiver = nullptr;
  52   msg_host_t source = nullptr;
  53
  54   double priority = 1.0;
  55   double bound    = 0.0; /* Capping for CPU resource, or 0 for no capping */
  56   double rate     = -1;  /* Capping for network resource, or -1 for no capping*/
  57
  58   bool isused = false;  /* Indicates whether the task is used in SIMIX currently */
  59   int host_nb = 0;      /* ==0 if sequential task; parallel task if not */
  60   /*******  Parallel Tasks Only !!!! *******/
  61   sg_host_t *host_list = nullptr;
  62   double *flops_parallel_amount = nullptr;
  63   double *bytes_parallel_amount = nullptr;
  64
  65 private:
  66   void reportMultipleUse() const;
  67 } s_simdata_task_t;
  68
  69 /********************************* File **************************************/
  70 typedef struct simdata_file {
  71   smx_file_t smx_file;
  72 } s_simdata_file_t;
  73
  74 /******************************* Process *************************************/
  75
  76 namespace simgrid {
  77 class MsgActorExt {
  78 public:
  79   explicit MsgActorExt(void* d) : data(d) {}
  80   msg_error_t errno_ = MSG_OK;  /* the last value returned by a MSG_function */
  81   void* data = nullptr; /* user data */
  82 };
  83 }
  84
  85 typedef struct msg_comm {
  86   smx_activity_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 /************************** Global variables ********************************/
  93 typedef struct MSG_Global {
  94   int debug_multiple_use;       /* whether we want an error message when reusing the same Task for 2 things */
  95   unsigned long int sent_msg;   /* Total amount of messages sent during the simulation */
  96   void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
  97   void_f_pvoid_t process_data_cleanup;
  98 } s_MSG_Global_t;
  99 typedef s_MSG_Global_t* MSG_Global_t;
 100
 101 SG_BEGIN_DECL()
 102
 103 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
 104
 105 /*************************************************************/
 106
 107 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
 108 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
 109 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
 110 XBT_PRIVATE void __MSG_file_destroy(msg_file_t file);
 111
 112 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
 113 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data,
 114                                                       sg_host_t host, xbt_dict_t properties,
 115                                                       smx_actor_t parent_process);
 116 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
 117
 118 XBT_PRIVATE void MSG_post_create_environment();
 119
 120 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
 121 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
 122
 123 /********** Tracing **********/
 124 /* declaration of instrumentation functions from msg_task_instr.c */
 125 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
 126 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
 127 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
 128 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
 129 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
 130 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
 131 XBT_PRIVATE void TRACE_msg_task_get_start();
 132 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
 133 XBT_PRIVATE void TRACE_msg_task_put_end();
 134
 135 /* declaration of instrumentation functions from msg_process_instr.c */
 136 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
 137 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
 138 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
 139 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
 140 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
 141 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
 142 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
 143 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
 144 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
 145 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
 146
 147 SG_END_DECL()
 148
 149 inline void simdata_task::setUsed()
 150 {
 151   if (this->isused)
 152     this->reportMultipleUse();
 153   if (msg_global->debug_multiple_use) {
 154     // TODO, backtrace
 155   }
 156   this->isused = true;
 157 }
 158
 159 #endif