Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of framagit.org:simgrid/simgrid
[simgrid.git] / src / surf / network_interface.hpp
index f8b0e65..79103fd 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2018. 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. */
@@ -11,7 +11,6 @@
 #include "simgrid/s4u/Link.hpp"
 #include "src/kernel/lmm/maxmin.hpp"
 #include "src/surf/PropertyHolder.hpp"
-#include "src/surf/trace_mgr.hpp"
 
 #include <list>
 #include <unordered_map>
@@ -33,10 +32,12 @@ namespace resource {
  */
 class NetworkModel : public Model {
 public:
-  static simgrid::config::Flag<double> cfg_tcp_gamma;
-  static simgrid::config::Flag<bool> cfg_crosstraffic;
+  static config::Flag<double> cfg_tcp_gamma;
+  static config::Flag<bool> cfg_crosstraffic;
 
   explicit NetworkModel(Model::UpdateAlgo algo) : Model(algo) {}
+  NetworkModel(const NetworkModel&) = delete;
+  NetworkModel& operator=(const NetworkModel&) = delete;
   ~NetworkModel() override;
 
   /**
@@ -47,57 +48,53 @@ public:
    * @param latency The initial latency of the Link in seconds
    * @param policy The sharing policy of the Link
    */
-  virtual LinkImpl* createLink(const std::string& name, double bandwidth, double latency,
-                               s4u::Link::SharingPolicy policy) = 0;
+  virtual LinkImpl* create_link(const std::string& name, double bandwidth, double latency,
+                                s4u::Link::SharingPolicy policy) = 0;
 
   /**
    * @brief Create a communication between two hosts.
-   * @details It makes calls to the routing part, and execute the communication
-   *          between the two end points.
+   * @details It makes calls to the routing part, and execute the communication between the two end points.
    *
    * @param src The source of the communication
    * @param dst The destination of the communication
    * @param size The size of the communication in bytes
-   * @param rate Allows to limit the transfer rate. Negative value means
-   * unlimited.
+   * @param rate Allows to limit the transfer rate. Negative value means unlimited.
    * @return The action representing the communication
    */
   virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
 
   /**
    * @brief Get the right multiplicative factor for the latency.
-   * @details Depending on the model, the effective latency when sending
-   * a message might be different from the theoretical latency of the link,
-   * in function of the message size. In order to account for this, this
-   * function gets this factor.
+   * @details Depending on the model, the effective latency when sending a message might be different from the
+   * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
+   * this factor.
    *
    * @param size The size of the message.
    * @return The latency factor.
    */
-  virtual double latencyFactor(double size);
+  virtual double get_latency_factor(double size);
 
   /**
    * @brief Get the right multiplicative factor for the bandwidth.
-   * @details Depending on the model, the effective bandwidth when sending
-   * a message might be different from the theoretical bandwidth of the link,
-   * in function of the message size. In order to account for this, this
-   * function gets this factor.
+   * @details Depending on the model, the effective bandwidth when sending a message might be different from the
+   * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
+   * gets this factor.
    *
    * @param size The size of the message.
    * @return The bandwidth factor.
    */
-  virtual double bandwidthFactor(double size);
+  virtual double get_bandwidth_factor(double size);
 
   /**
    * @brief Get definitive bandwidth.
-   * @details It gives the minimum bandwidth between the one that would
-   * occur if no limitation was enforced, and the one arbitrary limited.
+   * @details It gives the minimum bandwidth between the one that would occur if no limitation was enforced, and the
+   * one arbitrary limited.
    * @param rate The desired maximum bandwidth.
    * @param bound The bandwidth with only the network taken into account.
    * @param size The size of the message.
    * @return The new bandwidth.
    */
-  virtual double bandwidthConstraint(double rate, double bound, double size);
+  virtual double get_bandwidth_constraint(double rate, double bound, double size);
   double next_occuring_event_full(double now) override;
 
   LinkImpl* loopback_ = nullptr;
@@ -108,19 +105,23 @@ public:
  ************/
 /** @ingroup SURF_network_interface
  * @brief SURF network link interface class
- * @details A Link represents the link between two [hosts](\ref simgrid::surf::HostImpl)
+ * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
  */
-class LinkImpl : public Resource, public simgrid::surf::PropertyHolder {
+class LinkImpl : public Resource, public surf::PropertyHolder {
+  bool currently_destroying_ = false;
+  void* userdata_            = nullptr;
+
 protected:
   LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
+  LinkImpl(const LinkImpl&) = delete;
+  LinkImpl& operator=(const LinkImpl&) = delete;
   ~LinkImpl() override;
 
 public:
   void destroy(); // Must be called instead of the destructor
-private:
-  bool currentlyDestroying_ = false;
+  void* get_data() { return userdata_; }
+  void set_data(void* d) { userdata_ = d; }
 
-public:
   /** @brief Public interface */
   s4u::Link piface_;
 
@@ -147,21 +148,18 @@ public:
 
   void on_bandwidth_change();
 
-  virtual void set_bandwidth_trace(
-      tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to external load).
-                                   Trace must contain percentages (value between 0 and 1). */
-  virtual void set_latency_trace(
-      tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to external load).
-                                   Trace must contain absolute values */
+  virtual void
+  set_bandwidth_profile(kernel::profile::Profile* profile); /*< setup the profile file with bandwidth events
+                                                   (peak speed changes due to external load). Trace must
+                                                   contain percentages (value between 0 and 1). */
+  virtual void
+  set_latency_profile(kernel::profile::Profile* profile); /*< setup the trace file with latency events (peak
+                                                 latency changes due to external load).   Trace must contain
+                                                 absolute values */
 
   Metric latency_                   = {1.0, 0, nullptr};
   Metric bandwidth_                 = {1.0, 0, nullptr};
 
-  /* User data */
-  void* get_data() { return userdata_; }
-  void set_data(void* d) { userdata_ = d; }
-private:
-  void* userdata_ = nullptr;
 };
 
 /**********
@@ -169,7 +167,7 @@ private:
  **********/
 /** @ingroup SURF_network_interface
  * @brief SURF network action interface class
- * @details A NetworkAction represents a communication between two [hosts](\ref simgrid::surf::HostImpl)
+ * @details A NetworkAction represents a communication between two [hosts](@ref simgrid::surf::HostImpl)
  */
 class NetworkAction : public Action {
 public:
@@ -192,18 +190,19 @@ public:
   NetworkAction(Model* model, double cost, bool failed, lmm::Variable* var) : Action(model, cost, failed, var){};
 
   void set_state(Action::State state) override;
-  virtual std::list<LinkImpl*> links();
+  virtual std::list<LinkImpl*> links() const;
 
   double latency_    = {};
   double lat_current_ = {};
-  double weight_     = {};
+  double sharing_penalty_ = {};
   double rate_       = {};
 };
-}
-}
+} // namespace resource
+} // namespace kernel
 } // namespace simgrid
-/** \ingroup SURF_models
- *  \brief The network model
+
+/** @ingroup SURF_models
+ *  @brief The network model
  */
 XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;