Merge pull request #178 from francescomessina/update_router

Update router to the ip/prefix notation, removing the netmask

Author: frisso

Documentation/cubes.rst

@@ -158,10 +158,10 @@ For instance:
   # create port2 on br1 (simplebridge), it doesn't require any further parameters
   polycubectl br1 ports add port2
 
-  # create portX on r1 (router), it requires ip and netmask parameters
-  polycubectl r1 ports add port1 ip=10.0.1.1 netmask=255.255.255.0
-  polycubectl r1 ports add port2 ip=10.0.2.1 netmask=255.255.255.0
-  polycubectl r1 ports add port1 ip=10.0.3.1 netmask=255.255.255.0
+  # create portX on r1 (router), it doesn't require mandatory parameters, but it is useful to assign an ip (during or after creation)
+  polycubectl r1 ports add port1 ip=10.0.1.1/24
+  polycubectl r1 ports add port2 ip=10.0.2.1/24
+  polycubectl r1 ports add port1 ip=10.0.3.1/24
 
 Connect Ports
 ^^^^^^^^^^^^^

Documentation/tutorials/tutorial2/tutorial2.rst

@@ -77,14 +77,13 @@ Before trying to add a port, let's use the ``polycubectl`` help to get the info
 
      Other parameters:
      peer=value          string   Peer name, such as a network interfaces (e.g., 'veth0') or another cube (e.g., 'br1:port2')
-     ip=value            string   IP address of the port
-     netmask=value       string   Netmask of the port
+     ip=value            string   IP address and prefix of the port
      mac=value           string   MAC address of the port
     Example:
-     polycubectl r1 ports add port1 peer=r0:port1 ip=207.46.130.1 netmask=255.255.255.0 mac=B3:23:45:F5:3A
+     polycubectl r1 ports add port1 peer=r0:port1 ip=207.46.130.1/24 mac=B3:23:45:F5:3A
 
 
-The output indicates that a port name is expected ``Keyword``, and following it the ``peer``, ``ip``, ``netmask`` and ``mac`` are supported parameters.
+The output indicates that a port name is expected ``Keyword``, and following it the ``peer``, ``ip`` and ``mac`` are supported parameters.
 
 
 **Connect** ``veth1`` **to** ``r1``
@@ -93,7 +92,7 @@ The output indicates that a port name is expected ``Keyword``, and following it
 ::
 
     # create new port on r1 and set the IP parameters
-    polycubectl r1 ports add to_veth1 ip=10.0.1.254 netmask=255.255.255.0
+    polycubectl r1 ports add to_veth1 ip=10.0.1.254/24
     # connect port to netdev
     polycubectl connect r1:to_veth1 veth1
 
@@ -102,8 +101,8 @@ The router automatically adds a new local entry in the routing table.
 ::
 
     polycubectl r1 show route
-    interface  netmask        network   nexthop  pathcost
-    to_veth1   255.255.255.0  10.0.1.0  local    0
+    interface  network      nexthop  pathcost
+    to_veth1   10.0.1.0/24  local    0
 
 
 
@@ -112,7 +111,7 @@ The router automatically adds a new local entry in the routing table.
 ::
 
     # create new port on r1 and set the IP parameters
-    polycubectl r1 ports add to_veth2 ip=10.0.2.254 netmask=255.255.255.0
+    polycubectl r1 ports add to_veth2 ip=10.0.2.254/24
 
     # connect router port to netdev interface
     polycubectl r1 ports to_veth2 set peer=veth2
@@ -126,7 +125,7 @@ The router automatically adds a new local entry in the routing table.
 
     # create new port on r1 and set the IP parameters
     # notice that in this case 'peer' is also set so the port is also connected to the netdev
-    polycubectl r1 ports add to_veth3 ip=10.0.3.254 netmask=255.255.255.0 peer=veth3
+    polycubectl r1 ports add to_veth3 ip=10.0.3.254/24 peer=veth3
 
 
 Step 3: Check configuration
@@ -144,16 +143,16 @@ You should see an output similar to the next one, where ports are ``up`` and hav
     loglevel: info
 
     ports:
-     name      uuid                                  status  peer   ip          netmask        mac
-     to_veth3  c51bb0ed-9e6f-44ed-a096-b13bc1011331  up      veth3  10.0.3.254  255.255.255.0  72:59:a8:c2:c2:44
-     to_veth2  48f8d130-aa32-4354-a1b5-105df9a8ad7b  up      veth2  10.0.2.254  255.255.255.0  d6:42:7f:65:b4:40
-     to_veth1  46c685b9-4c80-4466-9d81-985598a07444  up      veth1  10.0.1.254  255.255.255.0  52:f0:5f:2c:a5:a7
+     name      uuid                                  status  peer   ip             mac
+     to_veth3  c51bb0ed-9e6f-44ed-a096-b13bc1011331  up      veth3  10.0.3.254/24  72:59:a8:c2:c2:44
+     to_veth2  48f8d130-aa32-4354-a1b5-105df9a8ad7b  up      veth2  10.0.2.254/24  d6:42:7f:65:b4:40
+     to_veth1  46c685b9-4c80-4466-9d81-985598a07444  up      veth1  10.0.1.254/24  52:f0:5f:2c:a5:a7
 
     route:
-     network   netmask        nexthop  interface  pathcost
-     10.0.1.0  255.255.255.0  local    to_veth1   0
-     10.0.2.0  255.255.255.0  local    to_veth2   0
-     10.0.3.0  255.255.255.0  local    to_veth3   0
+     network      nexthop  interface  pathcost
+     10.0.1.0/24  local    to_veth1   0
+     10.0.2.0/24  local    to_veth2   0
+     10.0.3.0/24  local    to_veth3   0
 
 
 Step 4: Test the connectivity between the namespaces and the router

Documentation/tutorials/tutorial3/tutorial3.rst

@@ -103,7 +103,7 @@ Step 3: Add and connect ports on routers
 ::
 
     # Create new port on r1 and set the IP parameters
-    polycubectl r1 ports add to_br1 ip=10.0.1.254 netmask=255.255.255.0
+    polycubectl r1 ports add to_br1 ip=10.0.1.254/24
     # Create a bridge interface on br1
     polycubectl br1 ports add to_r1
     # Connect both ports
@@ -117,15 +117,15 @@ In order to permit more networks on the same router interface we need to add a s
 ::
 
     # Add a secondary address on r1 interface `to_br1`
-    polycubectl r1 ports to_br1 secondaryip add 10.0.2.254 255.255.255.0
+    polycubectl r1 ports to_br1 secondaryip add 10.0.2.254/24
 
 
 **Connect** ``r2`` **to** ``br2``
 
 ::
 
     # Create new port on r2 and set the IP parameters
-    polycubectl r2 ports add to_br2 ip=10.0.3.254 netmask=255.255.255.0
+    polycubectl r2 ports add to_br2 ip=10.0.3.254/24
 
     # Create a bridge interface on br2
     polycubectl br2 ports add to_r2
@@ -139,8 +139,8 @@ In the router ``r2`` we have three different networks, so we need to add two sec
 ::
 
     # Add the secondary addresses on r2 interface `to_br2`
-    polycubectl r2 ports to_br2 secondaryip add 10.0.4.254 255.255.255.0
-    polycubectl r2 ports to_br2 secondaryip add 10.0.5.254 255.255.255.0
+    polycubectl r2 ports to_br2 secondaryip add 10.0.4.254/24
+    polycubectl r2 ports to_br2 secondaryip add 10.0.5.254/24
 
 **Connect the routers**
 
@@ -149,8 +149,8 @@ We need to create a point-to-point link between the routers to connect them. To
 ::
 
     # Create new port on r1 and r2 and set the IP parameters
-    polycubectl r1 ports add to_r2 ip=10.1.0.1 netmask=255.255.255.252
-    polycubectl r2 ports add to_r1 ip=10.1.0.2 netmask=255.255.255.252
+    polycubectl r1 ports add to_r2 ip=10.1.0.1/30
+    polycubectl r2 ports add to_r1 ip=10.1.0.2/30
 
     # Connects the routers
     polycubectl connect r1:to_r2 r2:to_r1
@@ -164,9 +164,9 @@ We need to tell the router `r1` which are the networks reachable through `r2`
 
 ::
 
-    polycubectl r1 route add 10.0.3.0 255.255.255.0 10.1.0.2
-    polycubectl r1 route add 10.0.4.0 255.255.255.0 10.1.0.2
-    polycubectl r1 route add 10.0.5.0 255.255.255.0 10.1.0.2
+    polycubectl r1 route add 10.0.3.0/24 10.1.0.2
+    polycubectl r1 route add 10.0.4.0/24 10.1.0.2
+    polycubectl r1 route add 10.0.5.0/24 10.1.0.2
 
 
 **Add static entries in the routing table of router `r2`**
@@ -175,8 +175,8 @@ We need to do the same on the router `r2`
 
 ::
 
-    polycubectl r2 route add 10.0.1.0 255.255.255.0 10.1.0.1
-    polycubectl r2 route add 10.0.2.0 255.255.255.0 10.1.0.1
+    polycubectl r2 route add 10.0.1.0/24 10.1.0.1
+    polycubectl r2 route add 10.0.2.0/24 10.1.0.1
 
 
 **Show the routing tables of the routers**

scripts/install.sh

@@ -140,14 +140,14 @@ echo "Install polycube"
 cd $DIR/..
 if [ "$INSTALL_CLEAN_POLYCUBE" == true ] ; then
   $SUDO rm -rf build
-else
+#else
   # The above commands are executed only in case of a manual install;
   #   Jenkins runs this script with "$INSTALL_CLEAN_POLYCUBE" = true
   # The above commands are useful in case you are re-running this
   #   script on an existing install, i.e., update source code and
   #   all the submodules
-  git pull
-  git submodule update --init --recursive
+  #git pull
+  #git submodule update --init --recursive
 fi
 
 mkdir -p build && cd build

src/libs/polycube/include/polycube/services/utils.h

@@ -65,7 +65,12 @@ uint32_t get_netmask_length(const std::string &netmask_string);
 
 /* Take in ingress a prefix length like 24 and return the
 * "netmask" -> 255.255.255.0 in this case */
-std::string get_netmask_from_CIDR(const int cidr);
+std::string get_netmask_from_prefixlength(const int prefixlength);
+
+/* Take in ingress an ip/prefix and return the ip address and the netmask
+*  in the variables ip_address and netmask passed by reference */
+void split_ip_and_prefix(const std::string &ip_and_prefix,
+                        std::string &ip_address, std::string &netmask);
 
 /*
  * formats a debug string, custom specifiers are evaluated by a

src/libs/polycube/src/utils.cpp

@@ -296,17 +296,33 @@ uint32_t get_netmask_length(const std::string &netmask_string) {
     throw std::runtime_error("IP Address is not in a valid format");
 }
 
-std::string get_netmask_from_CIDR(const int cidr) {
+std::string get_netmask_from_prefixlength(const int prefixlength) {
   uint32_t ipv4Netmask;
 
+  if (prefixlength == 0) {
+    return "0.0.0.0";
+  }
+
   ipv4Netmask = 0xFFFFFFFF;
-  ipv4Netmask <<= 32 - cidr;
+  ipv4Netmask <<= 32 - prefixlength;
   ipv4Netmask = ntohl(ipv4Netmask);
   struct in_addr addr = {ipv4Netmask};
 
   return inet_ntoa(addr);
 }
 
+void split_ip_and_prefix(const std::string &ip_and_prefix,
+                        std::string &ip_address, std::string &netmask) {
+  // ip_and_prefix = ip_address/prefix
+  std::istringstream split(ip_and_prefix);
+  std::vector<std::string> info;
+  char split_char = '/';
+  for (std::string each; std::getline(split, each, split_char);
+       info.push_back(each));
+  ip_address = info[0];
+  netmask = get_netmask_from_prefixlength(std::atoi(info[1].c_str()));
+}
+
 }  // namespace utils
 }  // namespace service
 }  // namespace polycube

src/polycubed/src/cube.cpp

@@ -164,9 +164,13 @@ std::shared_ptr<PortIface> Cube::add_port(const std::string &name,
     peerB.set_status(IFACE_STATUS::UP);
     peerA.set_namespace(prefix_ns + get_name());
     peerA.set_status(IFACE_STATUS::UP);
-    if (conf.count("ip") && conf.count("netmask")) {
-      int prefix = polycube::service::utils::get_netmask_length(conf.at("netmask").get<std::string>());
-      peerA.set_ip(conf.at("ip").get<std::string>(), prefix);
+    if (conf.count("ip")) {
+      std::string ip_address;
+      std::string netmask;
+      polycube::service::utils::split_ip_and_prefix(
+                conf.at("ip").get<std::string>(), ip_address, netmask);
+      int prefix = polycube::service::utils::get_netmask_length(netmask);
+      peerA.set_ip(ip_address, prefix);
     } else if (conf.count("ipv6")) {
       peerA.set_ipv6(conf.at("ipv6").get<std::string>());
     }

src/services/pcn-nat/test/examples/example1.sh

@@ -36,9 +36,9 @@ create_veth_net 2
 polycubectl nat add nat1
 polycubectl router add r1
 
-polycubectl router r1 ports add to_veth1 ip=$to_veth1_ip netmask=255.255.255.0
+polycubectl router r1 ports add to_veth1 ip=$to_veth1_ip/24
 polycubectl router r1 ports to_veth1 set peer=veth1
-polycubectl router r1 ports add to_nat1 ip=$to_nat_ip netmask=255.255.255.0
+polycubectl router r1 ports add to_nat1 ip=$to_nat_ip/24
 
 polycubectl nat1 ports add to_r1 type=INTERNAL
 polycubectl connect nat1:to_r1 r1:to_nat1

src/services/pcn-nat/test/examples/example2.sh

@@ -36,9 +36,9 @@ create_veth_net 2
 polycubectl nat add nat1
 polycubectl router add r1
 
-polycubectl router r1 ports add to_veth1 ip=$to_veth1_ip netmask=255.255.255.0
+polycubectl router r1 ports add to_veth1 ip=$to_veth1_ip/24
 polycubectl router r1 ports to_veth1 set peer=veth1
-polycubectl router r1 ports add to_nat1 ip=$to_nat_ip netmask=255.255.255.0
+polycubectl router r1 ports add to_nat1 ip=$to_nat_ip/24
 
 polycubectl nat1 ports add to_r1 type=INTERNAL
 polycubectl connect nat1:to_r1 r1:to_nat1

src/services/pcn-nat/test/examples/example3.sh

@@ -38,9 +38,9 @@ create_veth_net 2
 polycubectl nat add nat1
 polycubectl router add r1
 
-polycubectl router r1 ports add to_veth1 ip=$to_veth1_ip netmask=255.255.255.0
+polycubectl router r1 ports add to_veth1 ip=$to_veth1_ip/24
 polycubectl router r1 ports to_veth1 set peer=veth1
-polycubectl router r1 ports add to_nat1 ip=$to_nat_ip netmask=255.255.255.0
+polycubectl router r1 ports add to_nat1 ip=$to_nat_ip/24
 
 polycubectl nat1 ports add to_r1 type=INTERNAL
 polycubectl connect nat1:to_r1 r1:to_nat1