Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove features marked with XBT_ATTRIB_DEPRECATED_v325.
[simgrid.git] / src / msg / msg_private.hpp
index 62b4285..35c3ee5 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 #ifndef MSG_PRIVATE_HPP
 #define MSG_PRIVATE_HPP
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/msg.h"
-
 #include "src/kernel/activity/CommImpl.hpp"
-#include "src/kernel/activity/ExecImpl.hpp"
-#include "xbt/Extendable.hpp"
+#include <simgrid/modelchecker.h>
 
-#include <atomic>
+#include <cmath>
 
 /**************** datatypes **********************************/
-/**************************** Host Extension *********************************/
 namespace simgrid {
-class MsgHostExt {
-public:
-  static simgrid::xbt::Extension<s4u::Host, MsgHostExt> EXTENSION_ID;
+namespace msg {
+class Task {
+  std::string name_             = "";
+  std::string tracing_category_ = "";
+  void* userdata_               = nullptr;
+  long long int id_;
 
-  ~MsgHostExt() { delete file_descriptor_table; }
-  std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
-};
-}
-/********************************* Task **************************************/
+  double timeout_  = 0.0;
+  double priority_ = 1.0;
+  double bound_    = 0.0;   /* Capping for CPU resource, or 0 for no capping */
+  double rate_     = -1;    /* Capping for network resource, or -1 for no capping*/
+  bool is_used_    = false; /* Indicates whether the task is used in SIMIX currently */
 
-struct s_simdata_task_t {
-  ~s_simdata_task_t()
-  {
-    /* parallel tasks only */
-    delete[] this->host_list;
-    /* flops_parallel_amount and bytes_parallel_amount are automatically deleted in ~L07Action */
-  }
-  void setUsed();
-  void setNotUsed() { this->isused = false; }
-
-  simgrid::kernel::activity::ExecImplPtr compute = nullptr; /* SIMIX modeling of computation */
-  simgrid::kernel::activity::CommImplPtr comm    = nullptr; /* SIMIX modeling of communication */
-  double bytes_amount                            = 0.0;     /* Data size */
-  double flops_amount                            = 0.0;     /* Computation size */
-  msg_process_t sender                           = nullptr;
-  msg_process_t receiver                         = nullptr;
-  msg_host_t source                              = nullptr;
-
-  double priority = 1.0;
-  double bound    = 0.0; /* Capping for CPU resource, or 0 for no capping */
-  double rate     = -1;  /* Capping for network resource, or -1 for no capping*/
-
-  bool isused = false; /* Indicates whether the task is used in SIMIX currently */
-  int host_nb = 0;     /* ==0 if sequential task; parallel task if not */
-  /*******  Parallel Tasks Only !!!! *******/
-  sg_host_t* host_list          = nullptr;
-  double* flops_parallel_amount = nullptr;
-  double* bytes_parallel_amount = nullptr;
-
-private:
-  void reportMultipleUse() const;
-};
+  explicit Task(const std::string& name, double flops_amount, double bytes_amount, void* data);
+  explicit Task(const std::string& name, std::vector<s4u::Host*>&& hosts, std::vector<double>&& flops_amount,
+                std::vector<double>&& bytes_amount, void* data);
 
-/******************************* Process *************************************/
+  void report_multiple_use() const;
 
-namespace simgrid {
-namespace msg {
-class ActorExt {
 public:
-  explicit ActorExt(void* d) : data(d) {}
-  msg_error_t errno_ = MSG_OK;  /* the last value returned by a MSG_function */
-  void* data         = nullptr; /* user data */
+  static Task* create(const std::string& name, double flops_amount, double bytes_amount, void* data);
+  static Task* create_parallel(const std::string& name, int host_nb, const msg_host_t* host_list, double* flops_amount,
+                               double* bytes_amount, void* data);
+  msg_error_t execute();
+  msg_error_t send(const std::string& alias, double timeout);
+  s4u::CommPtr send_async(const std::string& alias, void_f_pvoid_t cleanup, bool detached);
+
+  void cancel();
+
+  Task(const Task&) = delete;
+  Task& operator=(const Task&) = delete;
+  ~Task()                      = default;
+
+  bool is_used() { return is_used_; }
+  bool is_parallel() { return parallel_; }
+
+  void set_used();
+  void set_not_used() { this->is_used_ = false; }
+  const std::string& get_name() const { return name_; }
+  const char* get_cname() { return name_.c_str(); }
+  void set_name(const char* new_name) { name_ = std::string(new_name); }
+  void set_tracing_category(const char* category) { tracing_category_ = category ? std::string(category) : ""; }
+  const std::string& get_tracing_category() { return tracing_category_; }
+  bool has_tracing_category() { return not tracing_category_.empty(); }
+  void* get_user_data() { return userdata_; }
+  void set_user_data(void* data) { userdata_ = data; }
+  long long int get_id() { return id_; }
+  double get_priority() { return priority_; }
+  void set_priority(double priority);
+  void set_bound(double bound) { bound_ = bound; }
+  double get_bound() { return bound_; }
+  void set_rate(double rate) { rate_ = rate; }
+  double get_rate() { return rate_; }
+  void set_timeout(double timeout) { timeout_ = timeout; }
+
+  s4u::Actor* get_sender();
+  s4u::Host* get_source();
+
+  s4u::ExecPtr compute = nullptr; /* S4U modeling of computation */
+  s4u::CommPtr comm    = nullptr; /* S4U modeling of communication */
+  double flops_amount  = 0.0;     /* Computation size */
+  double bytes_amount  = 0.0;     /* Data size */
+
+  /*******  Parallel Tasks Only !!!! *******/
+  bool parallel_ = false;
+  std::vector<s4u::Host*> hosts_;
+  std::vector<double> flops_parallel_amount;
+  std::vector<double> bytes_parallel_amount;
 };
 
 class Comm {
+  msg_error_t status_ = MSG_OK; /* status of the communication once finished */
 public:
-  msg_task_t task_sent;        /* task sent (NULL for the receiver) */
-  msg_task_t* task_received;   /* where the task will be received (NULL for the sender) */
-  smx_activity_t s_comm;       /* SIMIX communication object encapsulated (the same for both processes) */
-  msg_error_t status = MSG_OK; /* status of the communication once finished */
-  Comm(msg_task_t sent, msg_task_t* received, smx_activity_t comm)
+  Task* task_sent;             /* task sent (NULL for the receiver) */
+  Task** task_received;        /* where the task will be received (NULL for the sender) */
+  s4u::CommPtr s_comm;         /* SIMIX communication object encapsulated (the same for both processes) */
+  Comm(msg_task_t sent, msg_task_t* received, s4u::CommPtr comm)
       : task_sent(sent), task_received(received), s_comm(std::move(comm))
   {
   }
+  bool test();
+  msg_error_t wait_for(double timeout);
+  void set_status(msg_error_t status) { status_ = status; }
+  msg_error_t get_status() { return status_; }
 };
-}
-}
+
+class ActorUserData {
+  void* userdata_      = nullptr;
+
+public:
+  static xbt::Extension<simgrid::s4u::Actor, ActorUserData> EXTENSION_ID;
+
+  void set_user_data(void* data) { userdata_ = data; }
+  void* get_user_data() { return userdata_; }
+};
+
+} // namespace msg
+} // namespace simgrid
 
 /************************** Global variables ********************************/
-struct s_MSG_Global_t {
-  int debug_multiple_use;            /* whether we want an error message when reusing the same Task for 2 things */
+struct MSG_Global_t {
+  static bool debug_multiple_use;    /* whether we want an error message when reusing the same Task for 2 things */
   std::atomic_int_fast32_t sent_msg; /* Total amount of messages sent during the simulation */
   void (*task_copy_callback)(msg_task_t task, msg_process_t src, msg_process_t dst);
   void_f_pvoid_t process_data_cleanup;
 };
-typedef s_MSG_Global_t* MSG_Global_t;
-
-XBT_PRIVATE std::string instr_pid(msg_process_t proc);
-XBT_PRIVATE void TRACE_msg_process_create(std::string process_name, int process_pid, msg_host_t host);
-XBT_PRIVATE void TRACE_msg_process_destroy(std::string process_name, int process_pid);
 
-extern "C" {
-
-XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
+XBT_PUBLIC_DATA MSG_Global_t* msg_global;
 
 /*************************************************************/
-XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
-XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data,
-                                                      sg_host_t host, std::map<std::string, std::string>* properties,
-                                                      smx_actor_t parent_process);
-XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
-
-XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
-XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
-
-/********** Tracing **********/
-/* declaration of instrumentation functions from msg_task_instr.c */
-XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char* category);
-XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
-XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
-XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
-XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
-XBT_PRIVATE void TRACE_msg_task_get_end(msg_task_t task);
-XBT_PRIVATE void TRACE_msg_task_get_start();
-XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task); // returns TRUE if the task_put_end must be called
-XBT_PRIVATE void TRACE_msg_task_put_end();
-
-/* declaration of instrumentation functions from msg_process_instr.c */
-XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t new_host);
-XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
-XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
-XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
-XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process); // called from msg/gos.c
-XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
-}
-
-inline void s_simdata_task_t::setUsed()
-{
-  if (this->isused)
-    this->reportMultipleUse();
-  if (msg_global->debug_multiple_use) {
-    // TODO, backtrace
-  }
-  this->isused = true;
-}
 
 #endif