Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Give a p_netcard to simgrid::Host instead of relying on extensions for that
[simgrid.git] / src / surf / surf_routing.hpp
index a45a29c..6ed29be 100644 (file)
@@ -1,57 +1,60 @@
-/* Copyright (c) 2013-2014. The SimGrid Team.
+/* 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. */
 
-#include "surf_interface.hpp"
-#include <float.h>
-
 #ifndef NETWORK_ROUTING_HPP_
 #define NETWORK_ROUTING_HPP_
 
+#include <xbt/base.h>
+
+#include "surf_interface.hpp"
+#include <float.h>
+
 XBT_PUBLIC(void) routing_model_create( void *loopback);
 
-/* ************************************************************************** */
-/* ************************* 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);
+namespace simgrid {
+namespace surf {
 
 /***********
  * Classes *
  ***********/
 
-/* 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;
-
-class RoutingModelDescription;
-typedef RoutingModelDescription *RoutingModelDescriptionPtr;
-
-struct RoutingEdge;
-typedef RoutingEdge *RoutingEdgePtr;
-
-class Onelink;
-typedef Onelink *OnelinkPtr;
-
+class As;
+class XBT_PRIVATE RoutingModelDescription;
+class XBT_PRIVATE Onelink;
 class RoutingPlatf;
-typedef RoutingPlatf *RoutingPlatfPtr;
+
+/** @ingroup SURF_routing_interface
+ * @brief A network card
+ * @details This represents a position in the network. One can route information between two netcards
+ */
+class NetCard {
+public:
+  virtual ~NetCard(){};
+  virtual int getId()=0;
+  virtual int *getIdPtr()=0;
+  virtual void setId(int id)=0;
+  virtual char *getName()=0;
+  virtual As *getRcComponent()=0;
+  virtual e_surf_network_element_type_t getRcType()=0;
+};
 
 /** @ingroup SURF_routing_interface
  * @brief The Autonomous System (AS) routing interface
  * @details [TODO]
  */
-struct As {
+class As {
 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;
+  As *p_routingFather;
   xbt_dict_t p_routingSons;
-  RoutingEdgePtr p_netElem;
+  NetCard *p_netElem;
   xbt_dynar_t p_linkUpDownList;
 
   /**
@@ -64,6 +67,8 @@ public:
    */
   virtual ~As(){
        xbt_free(p_name);
+       if (p_netElem)
+               delete p_netElem;
   };
 
   /**
@@ -75,79 +80,68 @@ public:
    * @param into [description]
    * @param latency [description]
    */
-  virtual void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t into, double *latency)=0;
+  virtual void getRouteAndLatency(
+    NetCard *src, NetCard *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;
+  virtual sg_platf_route_cbarg_t getBypassRoute(
+    NetCard *src, NetCard *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 int parsePU(NetCard *elm)=0; /* A host or a router, whatever */
+  virtual int parseAS(NetCard *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;
 };
 
-/** @ingroup SURF_routing_interface
- * @brief A routing edge
- * @details [long description]
- */
-struct RoutingEdge {
+struct XBT_PRIVATE NetCardImpl : public NetCard {
 public:
-  virtual ~RoutingEdge(){};
-  virtual int getId()=0;
-  virtual int *getIdPtr()=0;
-  virtual void setId(int id)=0;
-  virtual char *getName()=0;
-  virtual AsPtr getRcComponent()=0;
-  virtual e_surf_network_element_type_t getRcType()=0;
-};
-
-struct RoutingEdgeImpl : public RoutingEdge {
-public:
-  RoutingEdgeImpl(char *name, int id, e_surf_network_element_type_t rcType, AsPtr rcComponent)
+  NetCardImpl(char *name, int id, e_surf_network_element_type_t rcType, As *rcComponent)
   : p_rcComponent(rcComponent), p_rcType(rcType), m_id(id), p_name(name) {}
-  ~RoutingEdgeImpl() { xbt_free(p_name);};
+  ~NetCardImpl() { xbt_free(p_name);};
 
   int getId() {return m_id;}
   int *getIdPtr() {return &m_id;}
   void setId(int id) {m_id = id;}
   char *getName() {return p_name;}
-  AsPtr getRcComponent() {return p_rcComponent;}
+  As *getRcComponent() {return p_rcComponent;}
   e_surf_network_element_type_t getRcType() {return p_rcType;}
 private:
-  AsPtr p_rcComponent;
+  As *p_rcComponent;
   e_surf_network_element_type_t p_rcType;
   int m_id;
   char *p_name;
 };
 
-struct RoutingEdgeWrapper : public RoutingEdge {
+struct RoutingEdgeWrapper : public NetCard {
 public:
-  RoutingEdgeWrapper(RoutingEdge *re) : p_re(re){}
+  RoutingEdgeWrapper(NetCard *re) : p_re(re){}
   ~RoutingEdgeWrapper(){}
   int getId() {return p_re->getId();}
   int *getIdPtr() {return p_re->getIdPtr();}
   void setId(int id) {p_re->setId(id);}
   char *getName() {return p_re->getName();}
-  AsPtr getRcComponent() {return p_re->getRcComponent();}
+  As *getRcComponent() {return p_re->getRcComponent();}
   e_surf_network_element_type_t getRcType() {return p_re->getRcType();}
 private:
-  RoutingEdge *p_re;
+  NetCard *p_re;
 };
 
 /** @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 lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings
  */
 class Onelink {
 public:
-  Onelink(void *link, RoutingEdgePtr src, RoutingEdgePtr dst)
+  Onelink(void *link, NetCard *src, NetCard *dst)
     : p_src(src), p_dst(dst), p_link(link) {};
-  RoutingEdgePtr p_src;
-  RoutingEdgePtr p_dst;
+  NetCard *p_src;
+  NetCard *p_dst;
   void *p_link;
 };
 
@@ -157,12 +151,22 @@ public:
 XBT_PUBLIC_CLASS RoutingPlatf {
 public:
   ~RoutingPlatf();
-  AsPtr p_root;
+  As *p_root;
   void *p_loopback;
   xbt_dynar_t p_lastRoute;
   xbt_dynar_t getOneLinkRoutes(void);
-  xbt_dynar_t recursiveGetOneLinkRoutes(AsPtr rc);
-  void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, xbt_dynar_t * links, double *latency);
+  xbt_dynar_t recursiveGetOneLinkRoutes(As *rc);
+  void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
 };
 
+/*************
+ * Callbacks *
+ *************/
+
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(NetCard*)>) routingEdgeCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(As*)>) asCreatedCallbacks;
+
+}
+}
+
 #endif /* NETWORK_ROUTING_HPP_ */