Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mv the internal isend function to the class
[simgrid.git] / src / msg / msg_private.hpp
index 3482e3c..31440dc 100644 (file)
-/* Copyright (c) 2004-2015. 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 METASIMGRID_PRIVATE_H
-#define METASIMGRID_PRIVATE_H
-
-#include <exception>
-#include <functional>
+#ifndef MSG_PRIVATE_HPP
+#define MSG_PRIVATE_HPP
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/msg.h"
-#include "simgrid/simix.h"
-#include "src/include/surf/surf.h"
-#include "xbt/base.h"
-#include "xbt/fifo.h"
-#include "xbt/dynar.h"
-#include "xbt/swag.h"
-#include "xbt/dict.h"
-#include "xbt/config.h"
-#include "src/instr/instr_private.h"
-
-#include "src/kernel/activity/SynchroExec.hpp"
-#include "src/kernel/activity/SynchroComm.hpp"
+#include "src/kernel/activity/CommImpl.hpp"
+#include "src/kernel/activity/ExecImpl.hpp"
+#include <simgrid/modelchecker.h>
 
-SG_BEGIN_DECL()
+#include <cmath>
 
 /**************** datatypes **********************************/
-/********************************* Host **************************************/
-typedef struct s_msg_host_priv {
-  int        dp_enabled;
-  xbt_dict_t dp_objs;
-  double     dp_updated_by_deleted_tasks;
-  int        is_migrating;
-
-  std::vector<int> *file_descriptor_table;
-} s_msg_host_priv_t;
-/********************************* Task **************************************/
-
-typedef struct simdata_task {
-  ~simdata_task()
-  {
-    if (this->compute)
-      this->compute->unref();
+namespace simgrid {
+namespace msg {
+class Task {
+  std::string name_             = "";
+  std::string tracing_category_ = "";
+  void* userdata_               = nullptr;
+  long long int id_;
+
+  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 */
+
+  explicit Task(std::string name, double flops_amount, double bytes_amount, void* data);
+  explicit Task(std::string name, std::vector<s4u::Host*> hosts, std::vector<double> flops_amount,
+                std::vector<double> bytes_amount, void* data);
+
+  void report_multiple_use() const;
+
+public:
+  static Task* create(std::string name, double flops_amount, double bytes_amount, void* data);
+  static Task* create_parallel(std::string name, int host_nb, const msg_host_t* host_list, double* flops_amount,
+                               double* bytes_amount, void* data);
+  msg_error_t execute();
+  Comm* send_async(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_; }
+
+  s4u::Actor* get_sender();
+  s4u::Host* get_source();
+
+  kernel::activity::ExecImplPtr compute          = nullptr; /* SIMIX 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 */
-    xbt_free(this->host_list);
-  }
-  void setUsed();
-  void setNotUsed()
+
+  /*******  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 {
+public:
+  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) */
+  msg_error_t status = MSG_OK; /* status of the communication once finished */
+  Comm(msg_task_t sent, msg_task_t* received, s4u::CommPtr comm)
+      : task_sent(sent), task_received(received), s_comm(std::move(comm))
   {
-    this->isused = false;
   }
+};
 
-  simgrid::kernel::activity::Exec *compute = nullptr; /* SIMIX modeling of computation */
-  simgrid::kernel::activity::Comm *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 = 0.0;
-  double bound = 0.0; /* Capping for CPU resource */
-  double rate = 0.0;  /* Capping for network resource */
-
-  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;
-} s_simdata_task_t;
-
-/********************************* File **************************************/
-typedef struct simdata_file {
-  smx_file_t smx_file;
-} s_simdata_file_t;
-
-XBT_PRIVATE int __MSG_host_get_file_descriptor_id(msg_host_t host);
-XBT_PRIVATE void __MSG_host_release_file_descriptor_id(msg_host_t host, int id);
-
-/******************************* Process *************************************/
-
-typedef struct simdata_process {
-  msg_host_t m_host;              /* the host on which the process is running */
-  msg_host_t put_host;            /* used for debugging purposes */
-  smx_activity_t waiting_action;
-  msg_task_t waiting_task;
-  msg_error_t last_errno;       /* the last value returned by a MSG_function */
-
-  void* data;                   /* user data */
-} s_simdata_process_t, *simdata_process_t;
-
-typedef struct process_arg {
-  const char *name;
-  xbt_main_func_t code;
-  void *data;
-  msg_host_t m_host;
-  int argc;
-  char **argv;
-  double kill_time;
-} s_process_arg_t, *process_arg_t;
-
-typedef struct msg_comm {
-  smx_activity_t s_comm;          /* SIMIX communication object encapsulated (the same for both processes) */
-  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) */
-  msg_error_t status;           /* status of the communication once finished */
-} s_msg_comm_t;
-
-/******************************* VM *************************************/
-typedef struct dirty_page {
-  double prev_clock;
-  double prev_remaining;
-  msg_task_t task;
-} s_dirty_page, *dirty_page_t;
-
-XBT_PUBLIC_DATA(const char*) MSG_vm_get_property_value(msg_vm_t vm, const char *name);
-XBT_PUBLIC_DATA(xbt_dict_t) MSG_vm_get_properties(msg_vm_t vm);
-XBT_PUBLIC_DATA(void) MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn);
-XBT_PUBLIC_DATA(msg_vm_t) MSG_vm_get_by_name(const char *name);
-XBT_PUBLIC_DATA(const char*) MSG_vm_get_name(msg_vm_t vm);
+} // namespace msg
+} // namespace simgrid
 
 /************************** Global variables ********************************/
-typedef struct MSG_Global {
-  xbt_fifo_t host;
-  int session;
-  int debug_multiple_use;
-  unsigned long int 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);
+struct s_MSG_Global_t {
+  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;
-} s_MSG_Global_t, *MSG_Global_t;
+};
+typedef s_MSG_Global_t* MSG_Global_t;
 
-/*extern MSG_Global_t msg_global;*/
-XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
+XBT_PUBLIC_DATA MSG_Global_t msg_global;
 
 /*************************************************************/
-XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
-XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
-XBT_PRIVATE void __MSG_host_priv_free(msg_host_priv_t priv);
-XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
-XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
-
-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,
-                                   const char *hostname, double kill_time,
-                                   xbt_dict_t properties, int auto_restart,
-                                   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_post_create_environment();
-
-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);
+XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size);
 
 /********** 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(double start_time, 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 char *instr_process_id (msg_process_t proc, char *str, int len);
-XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
-XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
-XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
-XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
-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);
-
-/* declaration of instrumentation functions from instr_msg_vm.c */
-XBT_PRIVATE char *instr_vm_id(msg_vm_t vm, char *str, int len);
-XBT_PRIVATE char *instr_vm_id_2(const char *vm_name, char *str, int len);
-XBT_PRIVATE void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host, msg_host_t new_host);
-XBT_PRIVATE void TRACE_msg_vm_start(msg_vm_t vm);
-XBT_PRIVATE void TRACE_msg_vm_create(const char *vm_name, msg_host_t host);
-XBT_PRIVATE void TRACE_msg_vm_kill(msg_vm_t process);
-XBT_PRIVATE void TRACE_msg_vm_suspend(msg_vm_t vm);
-XBT_PRIVATE void TRACE_msg_vm_resume(msg_vm_t vm);
-XBT_PRIVATE void TRACE_msg_vm_save(msg_vm_t vm);
-XBT_PRIVATE void TRACE_msg_vm_restore(msg_vm_t vm);
-XBT_PRIVATE void TRACE_msg_vm_end(msg_vm_t vm);
-
-SG_END_DECL()
-
-XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(
-  const char *name, std::function<void()> code, void *data,
-  msg_host_t host, xbt_dict_t properties);
-
-inline void simdata_task::setUsed()
-{
-  if (this->isused)
-    this->reportMultipleUse();
-  if (msg_global->debug_multiple_use) {
-    // TODO, backtrace
-  }
-  this->isused = true;
-}
+XBT_PRIVATE void TRACE_msg_task_put_start(msg_task_t task);
+
 
 #endif