Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
snake case for better consistency
[simgrid.git] / src / surf / network_interface.hpp
index d9a1671..c69c2bf 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2018. 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. */
@@ -6,10 +6,13 @@
 #ifndef SURF_NETWORK_INTERFACE_HPP_
 #define SURF_NETWORK_INTERFACE_HPP_
 
+#include "simgrid/kernel/resource/Model.hpp"
+#include "simgrid/kernel/resource/Resource.hpp"
 #include "simgrid/s4u/Link.hpp"
+#include "src/kernel/lmm/maxmin.hpp"
 #include "src/surf/PropertyHolder.hpp"
-#include "src/surf/surf_interface.hpp"
-#include "xbt/base.h"
+#include "src/surf/trace_mgr.hpp"
+
 #include <list>
 #include <unordered_map>
 
@@ -18,7 +21,8 @@
  ***********/
 
 namespace simgrid {
-namespace surf {
+namespace kernel {
+namespace resource {
 /*********
  * Model *
  *********/
@@ -29,10 +33,10 @@ namespace surf {
  */
 class NetworkModel : public Model {
 public:
-  /** @brief Constructor */
-  NetworkModel() : Model() {}
+  static simgrid::config::Flag<double> cfg_tcp_gamma;
+  static simgrid::config::Flag<bool> cfg_crosstraffic;
 
-  /** @brief Destructor */
+  explicit NetworkModel(Model::UpdateAlgo algo) : Model(algo) {}
   ~NetworkModel() override;
 
   /**
@@ -43,8 +47,8 @@ public:
    * @param latency The initial latency of the Link in seconds
    * @param policy The sharing policy of the Link
    */
-  virtual LinkImpl* createLink(const char* name, double bandwidth, double latency,
-                               e_surf_link_sharing_policy_t policy) = 0;
+  virtual LinkImpl* createLink(const std::string& name, double bandwidth, double latency,
+                               s4u::Link::SharingPolicy policy) = 0;
 
   /**
    * @brief Create a communication between two hosts.
@@ -58,13 +62,7 @@ public:
    * unlimited.
    * @return The action representing the communication
    */
-  virtual Action* communicate(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double size, double rate) = 0;
-
-  /** @brief Function pointer to the function to use to solve the lmm_system_t
-   *
-   * @param system The lmm_system_t to solve
-   */
-  void (*f_networkSolve)(lmm_system_t) = lmm_solve;
+  virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
 
   /**
    * @brief Get the right multiplicative factor for the latency.
@@ -100,7 +98,7 @@ public:
    * @return The new bandwidth.
    */
   virtual double bandwidthConstraint(double rate, double bound, double size);
-  double nextOccuringEventFull(double now) override;
+  double next_occuring_event_full(double now) override;
 
   LinkImpl* loopback_ = nullptr;
 };
@@ -112,9 +110,9 @@ public:
  * @brief SURF network link interface class
  * @details A Link represents the link between two [hosts](\ref simgrid::surf::HostImpl)
  */
-class LinkImpl : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
+class LinkImpl : public Resource, public simgrid::surf::PropertyHolder {
 protected:
-  LinkImpl(simgrid::surf::NetworkModel* model, const char* name, lmm_constraint_t constraint);
+  LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
   ~LinkImpl() override;
 
 public:
@@ -127,53 +125,55 @@ public:
   s4u::Link piface_;
 
   /** @brief Get the bandwidth in bytes per second of current Link */
-  virtual double bandwidth();
+  virtual double get_bandwidth();
 
   /** @brief Update the bandwidth in bytes per second of current Link */
-  virtual void setBandwidth(double value) = 0;
+  virtual void set_bandwidth(double value) = 0;
 
   /** @brief Get the latency in seconds of current Link */
-  virtual double latency();
+  virtual double get_latency();
 
   /** @brief Update the latency in seconds of current Link */
-  virtual void setLatency(double value) = 0;
+  virtual void set_latency(double value) = 0;
 
-  /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2:
-   * FULLDUPLEX) */
-  virtual int sharingPolicy();
+  /** @brief The sharing policy */
+  virtual s4u::Link::SharingPolicy get_sharing_policy();
 
   /** @brief Check if the Link is used */
-  bool isUsed() override;
+  bool is_used() override;
 
-  void turnOn() override;
-  void turnOff() override;
+  void turn_on() override;
+  void turn_off() override;
 
-  virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF).
+  void on_bandwidth_change();
+
+  virtual void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF).
                                                           Trace must contain boolean values. */
-  virtual void setBandwidthTrace(
+  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 setLatencyTrace(
+  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 */
 
-  tmgr_trace_iterator_t stateEvent_ = nullptr;
-  s_surf_metric_t latency_          = {1.0, 0, nullptr};
-  s_surf_metric_t bandwidth_        = {1.0, 0, nullptr};
+  tmgr_trace_event_t state_event_   = nullptr;
+  Metric latency_                   = {1.0, 0, nullptr};
+  Metric bandwidth_                 = {1.0, 0, nullptr};
 
   /* User data */
-  void* getData() { return userData; }
-  void setData(void* d) { userData = d; }
+  void* get_data() { return userdata_; }
+  void set_data(void* d) { userdata_ = d; }
 private:
-  void* userData = nullptr;
+  void* userdata_ = nullptr;
 
   /* List of all links. FIXME: should move to the Engine */
   static std::unordered_map<std::string, LinkImpl*>* links;
 
 public:
-  static LinkImpl* byName(const char* name);
+  static LinkImpl* by_name(std::string name);
   static int linksCount();
   static LinkImpl** linksList();
+  static void linksList(std::vector<s4u::Link*>* linkList);
   static void linksExit();
 };
 
@@ -182,9 +182,9 @@ public:
  **********/
 /** @ingroup SURF_network_interface
  * @brief SURF network action interface class
- * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl)
+ * @details A NetworkAction represents a communication between two [hosts](\ref simgrid::surf::HostImpl)
  */
-class NetworkAction : public simgrid::surf::Action {
+class NetworkAction : public Action {
 public:
   /** @brief Constructor
    *
@@ -192,30 +192,33 @@ public:
    * @param cost The cost of this  NetworkAction in [TODO]
    * @param failed [description]
    */
-  NetworkAction(simgrid::surf::Model* model, double cost, bool failed) : simgrid::surf::Action(model, cost, failed) {}
+  NetworkAction(Model* model, double cost, bool failed) : Action(model, cost, failed) {}
 
   /**
    * @brief NetworkAction constructor
    *
    * @param model The NetworkModel associated to this NetworkAction
-   * @param cost The cost of this  NetworkAction in [TODO]
-   * @param failed [description]
-   * @param var The lmm variable associated to this Action if it is part of a
-   * LMM component
+   * @param cost The cost of this  NetworkAction in bytes
+   * @param failed Actions can be created in a failed state
+   * @param var The lmm variable associated to this Action if it is part of a LMM component
    */
-  NetworkAction(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
-      : simgrid::surf::Action(model, cost, failed, var){};
+  NetworkAction(Model* model, double cost, bool failed, lmm::Variable* var) : Action(model, cost, failed, var){};
 
-  void setState(simgrid::surf::Action::State state) override;
-  std::list<LinkImpl*> links();
+  void set_state(Action::State state) override;
+  virtual std::list<LinkImpl*> links();
 
-  double latency_;
-  double latCurrent_;
-  double weight_;
-  double rate_;
+  double latency_    = {};
+  double lat_current_ = {};
+  double weight_     = {};
+  double rate_       = {};
 };
 }
 }
+} // namespace simgrid
+/** \ingroup SURF_models
+ *  \brief The network model
+ */
+XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;
 
 #endif /* SURF_NETWORK_INTERFACE_HPP_ */