Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Avoid unsafe things
[simgrid.git] / src / surf / network_interface.hpp
index 4b4c256..25ec028 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2017. 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. */
@@ -7,17 +6,12 @@
 #ifndef SURF_NETWORK_INTERFACE_HPP_
 #define SURF_NETWORK_INTERFACE_HPP_
 
-#include <xbt/base.h>
-
-#include <boost/unordered_map.hpp>
-
-#include "xbt/fifo.h"
-#include "xbt/dict.h"
-#include "surf_interface.hpp"
-#include "surf_routing.hpp"
+#include "simgrid/s4u/Link.hpp"
 #include "src/surf/PropertyHolder.hpp"
-
-#include "simgrid/link.h"
+#include "src/surf/surf_interface.hpp"
+#include "xbt/base.h"
+#include <list>
+#include <unordered_map>
 
 /***********
  * Classes *
 
 namespace simgrid {
   namespace surf {
-
-    class NetworkModel;
-    class NetworkAction;
-
-    /*************
-     * Callbacks *
-     *************/
-
-
-    /** @brief Callback signal fired when the state of a NetworkAction changes
-     *  Signature: `void(NetworkAction *action, simgrid::surf::Action::State old, simgrid::surf::Action::State current)` */
-    XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) networkActionStateChangedCallbacks;
-
-    /** @brief Callback signal fired when a NetworkAction is created (when a communication starts)
-     *  Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` */
-    XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst, double size, double rate)>) networkCommunicateCallbacks;
-
-  }
-}
-
-/*********
- * Tools *
- *********/
-XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
-
-/*********
- * Model *
- *********/
-
-namespace simgrid {
-  namespace surf {
+    /*********
+     * Model *
+     *********/
 
     /** @ingroup SURF_network_interface
      * @brief SURF network model interface class
@@ -67,13 +33,7 @@ namespace simgrid {
       NetworkModel() : Model() { }
 
       /** @brief Destructor */
-      ~NetworkModel() {
-        if (maxminSystem_)
-          lmm_system_free(maxminSystem_);
-        if (actionHeap_)
-          xbt_heap_free(actionHeap_);
-        delete modifiedSet_;
-      }
+      ~NetworkModel() override;
 
       /**
        * @brief Create a Link
@@ -82,16 +42,14 @@ namespace simgrid {
        * @param bandwidth The initial bandwidth of the Link in bytes per second
        * @param latency The initial latency of the Link in seconds
        * @param policy The sharing policy of the Link
-       * @param properties Dictionary of properties associated to this Resource
-       * @return The created Link
        */
-      virtual Link* createLink(const char *name, double bandwidth, double latency,
-          e_surf_link_sharing_policy_t policy, xbt_dict_t properties)=0;
+      virtual LinkImpl* createLink(const char* name, double bandwidth, double latency,
+                                   e_surf_link_sharing_policy_t 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.
+       *          between the two end points.
        *
        * @param src The source of the communication
        * @param dst The destination of the communication
@@ -100,7 +58,7 @@ namespace simgrid {
        * unlimited.
        * @return The action representing the communication
        */
-      virtual Action *communicate(NetCard *src, NetCard *dst, double size, double rate)=0;
+      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
        *
@@ -142,7 +100,9 @@ namespace simgrid {
        * @return The new bandwidth.
        */
       virtual double bandwidthConstraint(double rate, double bound, double size);
-      double next_occuring_event_full(double now) override;
+      double nextOccuringEventFull(double now) override;
+
+      LinkImpl* loopback_ = nullptr;
     };
 
     /************
@@ -150,67 +110,35 @@ namespace simgrid {
      ************/
     /** @ingroup SURF_network_interface
      * @brief SURF network link interface class
-     * @details A Link represents the link between two [hosts](\ref Host)
+     * @details A Link represents the link between two [hosts](\ref simgrid::surf::HostImpl)
      */
-    class Link :
-        public simgrid::surf::Resource,
-        public simgrid::surf::PropertyHolder {
-        public:
-      /**
-       * @brief Link constructor
-       *
-       * @param model The NetworkModel associated to this Link
-       * @param name The name of the Link
-       * @param props Dictionary of properties associated to this Link
-       */
-      Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
-
-      /**
-       * @brief Link constructor
-       *
-       * @param model The NetworkModel associated to this Link
-       * @param name The name of the Link
-       * @param props Dictionary of properties associated to this Link
-       * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
-       */
-      Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
-
-      /* Link destruction logic */
-      /**************************/
-        protected:
-      ~Link();
-        public:
+    class LinkImpl : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
+    protected:
+      LinkImpl(simgrid::surf::NetworkModel* model, const char* name, lmm_constraint_t constraint);
+      ~LinkImpl() override;
+    public:
       void destroy(); // Must be called instead of the destructor
-        private:
+    private:
       bool currentlyDestroying_ = false;
 
-        public:
-      /** @brief Callback signal fired when a new Link is created.
-       *  Signature: void(Link*) */
-      static simgrid::xbt::signal<void(simgrid::surf::Link*)> onCreation;
-
-      /** @brief Callback signal fired when a Link is destroyed.
-       *  Signature: void(Link*) */
-      static simgrid::xbt::signal<void(simgrid::surf::Link*)> onDestruction;
-
-      /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off)
-       *  Signature: `void(Link*)` */
-      static simgrid::xbt::signal<void(simgrid::surf::Link*)> onStateChange;
-
+    public:
+      /** @brief Public interface */
+      s4u::Link piface_;
 
       /** @brief Get the bandwidth in bytes per second of current Link */
-      virtual double getBandwidth();
+      virtual double bandwidth();
 
       /** @brief Update the bandwidth in bytes per second of current Link */
-      virtual void updateBandwidth(double value)=0;
+      virtual void setBandwidth(double value) = 0;
 
       /** @brief Get the latency in seconds of current Link */
-      virtual double getLatency();
+      virtual double latency();
 
       /** @brief Update the latency in seconds of current Link */
-      virtual void updateLatency(double value)=0;
+      virtual void setLatency(double value) = 0;
 
-      /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
+      /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2:
+       * FULLDUPLEX) */
       virtual int sharingPolicy();
 
       /** @brief Check if the Link is used */
@@ -219,28 +147,32 @@ namespace simgrid {
       void turnOn() override;
       void turnOff() override;
 
-      virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values. */
-      virtual void setBandwidthTrace(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(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 setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF).
+                                                          Trace must contain boolean values. */
+      virtual void setBandwidthTrace(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(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 m_stateEvent = NULL;
-      s_surf_metric_t m_latency = {1.0,0,NULL};
-      s_surf_metric_t m_bandwidth = {1.0,0,NULL};
+      tmgr_trace_iterator_t stateEvent_ = nullptr;
+      s_surf_metric_t latency_          = {1.0, 0, nullptr};
+      s_surf_metric_t bandwidth_        = {1.0, 0, nullptr};
 
       /* User data */
-        public:
+    public:
       void *getData()        { return userData;}
       void  setData(void *d) { userData=d;}
-        private:
-      void *userData = NULL;
-
-      /* List of all links */
-        private:
-      static boost::unordered_map<std::string, Link *> *links;
-        public:
-      static Link *byName(const char* name);
+    private:
+      void *userData = nullptr;
+
+      /* List of all links. FIXME: should move to the Engine */
+    private:
+      static std::unordered_map<std::string, LinkImpl*>* links;
+
+    public:
+      static LinkImpl* byName(const char* name);
       static int linksCount();
-      static Link **linksList();
+      static LinkImpl** linksList();
       static void linksExit();
     };
 
@@ -249,7 +181,7 @@ namespace simgrid {
      **********/
     /** @ingroup SURF_network_interface
      * @brief SURF network action interface class
-     * @details A NetworkAction represents a communication between two [hosts](\ref Host)
+     * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl)
      */
     class NetworkAction : public simgrid::surf::Action {
     public:
@@ -275,14 +207,12 @@ namespace simgrid {
       : simgrid::surf::Action(model, cost, failed, var) {};
 
       void setState(simgrid::surf::Action::State state) override;
+      std::list<LinkImpl*> links();
 
       double latency_;
       double latCurrent_;
       double weight_;
       double rate_;
-      const char* senderLinkName_;
-      double senderSize_;
-      xbt_fifo_item_t senderFifoItem_;
     };
   }
 }