Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Factorize some code into the netcard constructor
[simgrid.git] / src / surf / surf_routing.hpp
index e4d93c6..ccbb7d6 100644 (file)
-#include "surf_interface.hpp"
-#include <float.h>
+/* Copyright (c) 2013-2015. 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 NETWORK_ROUTING_HPP_
 #define NETWORK_ROUTING_HPP_
 
-void routing_model_create( void *loopback);
+#include <xbt/base.h>
+#include <xbt/signal.hpp>
 
-/* ************************************************************************** */
-/* ************************* GRAPH EXPORTING FUNCTIONS ********************** */
-xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes);
-xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges);
+#include "surf_interface.hpp"
+#include "src/surf/xml/platf_private.hpp" // FIXME: including this here is pure madness. KILKILKIL XML.
+#include "src/surf/AsImpl.hpp"
 
-/***********
- * Classes *
- ***********/
+#include <float.h>
+#include <vector>
+#include <map>
 
-/* Note: As and RoutingEdge are declard as struct instead of class, to keep
-   compatibility with C files where they are mentioned. */
-struct As;
-typedef As *AsPtr;
+SG_BEGIN_DECL()
+XBT_PUBLIC(void) routing_model_create(Link *loopback);
+XBT_PRIVATE xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes);
+XBT_PRIVATE xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges);
+SG_END_DECL()
 
-class RoutingModelDescription;
-typedef RoutingModelDescription *RoutingModelDescriptionPtr;
+namespace simgrid {
+namespace surf {
 
-struct RoutingEdge;
-typedef RoutingEdge *RoutingEdgePtr;
+  XBT_PUBLIC_DATA(simgrid::xbt::signal<void(s4u::As*)>) asCreatedCallbacks;
+  XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
 
-class Onelink;
-typedef Onelink *OnelinkPtr;
+/***********
+ * Classes *
+ ***********/
 
+class XBT_PRIVATE Onelink;
 class RoutingPlatf;
-typedef RoutingPlatf *RoutingPlatfPtr;
 
 /** @ingroup SURF_routing_interface
- * @brief The Autonomous System (AS) routing interface
- * @details [TODO]
+ * @brief Network cards are the vertices in the graph representing the network, used to compute paths between nodes.
+ *
+ * @details This represents a position in the network. One can route information between two netcards
  */
-struct As {
+class NetCard {
 public:
-  xbt_dynar_t p_indexNetworkElm;
-  xbt_dict_t p_bypassRoutes;    /* store bypass routes */
-  routing_model_description_t p_modelDesc;
-  e_surf_routing_hierarchy_t p_hierarchy;
-  char *p_name;
-  AsPtr p_routingFather;
-  xbt_dict_t p_routingSons;
-  RoutingEdgePtr p_netElem;
-  xbt_dynar_t p_linkUpDownList;
-
-  /**
-   * @brief The As constructor
-   */
-  As(){};
-
-  /**
-   * @brief The As destructor
-   */
-  virtual ~As(){
-       xbt_free(p_name);
-  };
-
-  /**
-   * @brief Get the route and latency between two RoutingEdgs
-   * @details [long description]
-   * 
-   * @param src [description]
-   * @param dst [description]
-   * @param into [description]
-   * @param latency [description]
-   */
-  virtual void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t into, double *latency)=0;
-  virtual xbt_dynar_t getOneLinkRoutes()=0;
-  virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
-  virtual sg_platf_route_cbarg_t getBypassRoute(RoutingEdgePtr src, RoutingEdgePtr dst, double *lat)=0;
-
-  /* The parser calls the following functions to inform the routing models
-   * that a new element is added to the AS currently built.
-   *
-   * Of course, only the routing model of this AS is informed, not every ones */
-  virtual int parsePU(RoutingEdgePtr elm)=0; /* A host or a router, whatever */
-  virtual int parseAS( RoutingEdgePtr elm)=0;
-  virtual void parseRoute(sg_platf_route_cbarg_t route)=0;
-  virtual void parseASroute(sg_platf_route_cbarg_t route)=0;
-  virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
+  virtual ~NetCard(){};
+  virtual int id()=0; // Our rank in the vertices_ array of our containing AS.
+  virtual char *name()=0;
+  virtual AsImpl *containingAS()=0; // This is the AS in which I am
+  virtual bool isAS()=0;
+  virtual bool isHost()=0;
+  virtual bool isRouter()=0;
 };
 
-/** @ingroup SURF_routing_interface
- * @brief A routing edge
- * @details [long description]
- */
-struct RoutingEdge {
+struct XBT_PRIVATE NetCardImpl : public NetCard {
 public:
-  ~RoutingEdge() { xbt_free(p_name);};
-  AsPtr p_rcComponent;
-  e_surf_network_element_type_t p_rcType;
-  int m_id;
-  char *p_name;
+  NetCardImpl(const char *name, e_surf_network_element_type_t componentType, AsImpl *containingAS)
+  : name_(xbt_strdup(name)),
+    componentType_(componentType),
+    containingAS_(containingAS)
+  {
+    if (containingAS != nullptr)
+      id_ = containingAS->addComponent(this);
+    simgrid::surf::netcardCreatedCallbacks(this);
+  }
+  ~NetCardImpl() { xbt_free(name_);};
+
+  int id()           override {return id_;}
+  char *name()       override {return name_;}
+  AsImpl *containingAS() override {return containingAS_;}
+
+  bool isAS()        override {return componentType_ == SURF_NETWORK_ELEMENT_AS;}
+  bool isHost()      override {return componentType_ == SURF_NETWORK_ELEMENT_HOST;}
+  bool isRouter()    override {return componentType_ == SURF_NETWORK_ELEMENT_ROUTER;}
+
+private:
+  int id_ = -1;
+  char *name_;
+  e_surf_network_element_type_t componentType_;
+  AsImpl *containingAS_;
 };
 
-
 /** @ingroup SURF_routing_interface
- * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
+ * @brief Link of length 1, alongside with its source and destination. This is mainly useful in the ns3 bindings
  */
 class Onelink {
 public:
-  Onelink(void *link, RoutingEdgePtr src, RoutingEdgePtr dst)
-    : p_src(src), p_dst(dst), p_link(link) {};
-  RoutingEdgePtr p_src;
-  RoutingEdgePtr p_dst;
-  void *p_link;
+  Onelink(void *link, NetCard *src, NetCard *dst)
+    : src_(src), dst_(dst), link_(link) {};
+  NetCard *src_;
+  NetCard *dst_;
+  void *link_;
 };
 
 /** @ingroup SURF_routing_interface
  * @brief The class representing a whole routing platform
  */
-class RoutingPlatf {
+XBT_PUBLIC_CLASS RoutingPlatf {
 public:
+  RoutingPlatf(Link *loopback);
   ~RoutingPlatf();
-  AsPtr p_root;
-  void *p_loopback;
-  xbt_dynar_t p_lastRoute;
+  AsImpl *root_ = nullptr;
+  Link *loopback_;
   xbt_dynar_t getOneLinkRoutes(void);
-  xbt_dynar_t recursiveGetOneLinkRoutes(AsPtr rc);
-  void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, xbt_dynar_t * links, double *latency);
+  void getRouteAndLatency(NetCard *src, NetCard *dst, std::vector<Link*> * links, double *latency);
 };
 
+}
+}
+
 #endif /* NETWORK_ROUTING_HPP_ */