src/msg/msg_private.hpp

   1 /* Copyright (c) 2004-2019. 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 MSG_PRIVATE_HPP
   7 #define MSG_PRIVATE_HPP
   8
   9 #include "simgrid/msg.h"
  10
  11 #include "src/kernel/activity/CommImpl.hpp"
  12 #include "src/kernel/activity/ExecImpl.hpp"
  13
  14 /**************** datatypes **********************************/
  15 namespace simgrid {
  16 namespace msg {
  17 class Task {
  18   std::string name_             = "";
  19   std::string tracing_category_ = "";
  20   void* userdata_               = nullptr;
  21
  22 public:
  23   ~Task();
  24   explicit Task(std::string name, double flops_amount, double bytes_amount, void* data)
  25       : name_(std::move(name)), userdata_(data), flops_amount(flops_amount), bytes_amount(bytes_amount)
  26   {
  27   }
  28   void set_used();
  29   void set_not_used() { this->is_used = false; }
  30
  31   const std::string& get_name() const { return name_; }
  32   const char* get_cname() { return name_.c_str(); }
  33   void set_name(const char* new_name) { name_ = std::string(new_name); }
  34   void set_tracing_category(const char* category) { tracing_category_ = category ? std::string(category) : ""; }
  35   const std::string& get_tracing_category() { return tracing_category_; }
  36   bool has_tracing_category() { return not tracing_category_.empty(); }
  37   void* get_user_data() { return userdata_; }
  38   void set_user_data(void* data) { userdata_ = data; }
  39
  40   kernel::activity::ExecImplPtr compute          = nullptr; /* SIMIX modeling of computation */
  41   s4u::CommPtr comm                              = nullptr; /* S4U modeling of communication */
  42   double flops_amount                            = 0.0;     /* Computation size */
  43   double bytes_amount                            = 0.0;     /* Data size */
  44   msg_process_t sender                           = nullptr;
  45   msg_process_t receiver                         = nullptr;
  46
  47   double priority = 1.0;
  48   double bound    = 0.0; /* Capping for CPU resource, or 0 for no capping */
  49   double rate     = -1;  /* Capping for network resource, or -1 for no capping*/
  50
  51   bool is_used = 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 report_multiple_use() const;
  60 };
  61
  62 class Comm {
  63 public:
  64   msg_task_t task_sent;        /* task sent (NULL for the receiver) */
  65   msg_task_t* task_received;   /* where the task will be received (NULL for the sender) */
  66   s4u::CommPtr s_comm;         /* SIMIX communication object encapsulated (the same for both processes) */
  67   msg_error_t status = MSG_OK; /* status of the communication once finished */
  68   Comm(msg_task_t sent, msg_task_t* received, s4u::CommPtr comm)
  69       : task_sent(sent), task_received(received), s_comm(std::move(comm))
  70   {
  71   }
  72 };
  73
  74 } // namespace msg
  75 } // namespace simgrid
  76
  77 /************************** Global variables ********************************/
  78 struct s_MSG_Global_t {
  79   bool debug_multiple_use;           /* whether we want an error message when reusing the same Task for 2 things */
  80   std::atomic_int_fast32_t sent_msg; /* Total amount of messages sent during the simulation */
  81   void (*task_copy_callback)(msg_task_t task, msg_process_t src, msg_process_t dst);
  82   void_f_pvoid_t process_data_cleanup;
  83 };
  84 typedef s_MSG_Global_t* MSG_Global_t;
  85
  86 XBT_PUBLIC_DATA MSG_Global_t msg_global;
  87
  88 /*************************************************************/
  89 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size);
  90
  91 /********** Tracing **********/
  92 /* declaration of instrumentation functions from msg_task_instr.c */
  93 XBT_PRIVATE void TRACE_msg_task_put_start(msg_task_t task);
  94
  95
  96 #endif