com.net2plan.libraries

Class IPUtils

Object

com.net2plan.libraries.IPUtils

public class IPUtils
extends Object

Class for destination-based routing (IP-like).

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Field Summary

Fields

Modifier and Type	Field and Description
static String	IP_WEIGHT_ATTRIBUTE_NAME Link attribute name for IP weight setting.

Method Summary

Methods

Modifier and Type	Method and Description
static double	calculateIGPCost(double[] y_e, double[] u_e) Returns the cost of a routing scheme according to the carried traffic per link and the link capacity vectors, assuming the IGP-WO cost model.
static double	calculateIGPCost(Map<Long,Double> y_e, Map<Long,Double> u_e) Returns the cost of a routing scheme according to the carried traffic per link and link capacities, assuming the IGP-WO cost model.
static Quadruple<Map<Pair<Long,Long>,Double>,Map<Pair<Long,Long>,Double>,Map<Long,Double>,Map<Long,Double>>	computeCarriedTrafficFromIGPWeights(NetPlan netPlan, long layerId, Map<Long,Double> linkWeightMap) Computes the resulting carried traffic according to a link weight setting and OSPF/ECMP routing.
static Quadruple<Map<Pair<Long,Long>,Double>,Map<Pair<Long,Long>,Double>,Map<Long,Double>,Map<Long,Double>>	computeCarriedTrafficFromIGPWeights(NetPlan netPlan, Map<Long,Double> linkWeightMap) Computes the resulting carried traffic according to a link weight setting and OSPF/ECMP routing.
static Map<Pair<Long,Long>,Double>	computeECMPForwardingRules(Set<Long> nodeIds, Map<Long,Pair<Long,Long>> linkMap, Map<Long,Pair<Long,Long>> demandMap, Map<Long,Double> linkWeightMap) Computes the forwarding rules according to an OSPF/ECMP scheme.
static Map<Pair<Long,Long>,Double>	computeECMPRoutingTableMap(Set<Long> nodeIds, Map<Long,Pair<Long,Long>> linkMap, Map<Long,Double> linkWeightMap) Computes the routing table matrix according to an OSPF/ECMP scheme.
static cern.colt.matrix.tdouble.DoubleMatrix2D	computeECMPRoutingTableMatrix(Set<Long> nodeIds, Map<Long,Pair<Long,Long>> linkMap, Map<Long,Double> linkWeightMap) Computes the routing table matrix according to an OSPF/ECMP scheme.
static double	getLinkWeight(NetPlan netPlan, long linkId) Returns the weight associated to a given link.
static double	getLinkWeight(NetPlan netPlan, long layerId, long linkId) Returns the weight associated to a given link.
static Map<Long,Double>	getLinkWeightMap(NetPlan netPlan) Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.
static Map<Long,Double>	getLinkWeightMap(NetPlan netPlan, long layerId) Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.
static double[]	getLinkWeightVector(NetPlan netPlan) Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.
static double[]	getLinkWeightVector(NetPlan netPlan, long layerId) Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.
static cern.colt.matrix.tdouble.DoubleMatrix2D	getRoutingTableMatrix(NetPlan netPlan) Obtains a destination-based routing from a given network design.
static String	routingTableMatrixToString(Set<Long> nodeIds, Map<Long,Pair<Long,Long>> linkMap, double[][] f_te) Outputs a given set of routing tables to a String.
static void	setECMPForwardingRulesFromLinkWeights(NetPlan netPlan, long layerId, Map<Long,Double> linkWeightMap) Sets the OSPF/ECMP forwarding rules in the given design, according to the given IGP weight setting.
static void	setECMPForwardingRulesFromLinkWeights(NetPlan netPlan, Map<Long,Double> linkWeightMap) Sets the OSPF/ECMP forwarding rules in the given design, according to the given IGP weight setting.
static void	setECMPRoutesFromLinkWeights(NetPlan netPlan, long layerId, Map<Long,Double> linkWeightMap) Sets the explicit traffic routing according to an OSPF/ECMP scheme.
static void	setECMPRoutesFromLinkWeights(NetPlan netPlan, Map<Long,Double> linkWeightMap) Sets the explicit traffic routing according to an OSPF/ECMP scheme.
static void	setLinkWeight(NetPlan netPlan, long linkId, double linkWeight) Sets the weight associated to the link.
static void	setLinkWeight(NetPlan netPlan, long layerId, long linkId, double linkWeight) Sets the weight associated to the link.
static void	setLinkWeights(NetPlan netPlan, double linkWeight) Sets the weight associated to every link.
static void	setLinkWeights(NetPlan netPlan, double[] linkWeightVector) Sets the weight associated to each link.
static void	setLinkWeights(NetPlan netPlan, long layerId, double linkWeight) Sets the weight associated to every link.
static void	setLinkWeights(NetPlan netPlan, long layerId, double[] linkWeightVector) Sets the weight associated to each link.
static void	setLinkWeights(NetPlan netPlan, long layerId, Map<Long,Double> linkWeightMap) Sets the weight associated to each link.
static void	setLinkWeights(NetPlan netPlan, Map<Long,Double> linkWeightMap) Sets the weight associated to each link.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IP_WEIGHT_ATTRIBUTE_NAME

public static final String IP_WEIGHT_ATTRIBUTE_NAME

Link attribute name for IP weight setting.

Since:

0.3.0

See Also:

Constant Field Values

Method Detail

calculateIGPCost

public static double calculateIGPCost(double[] y_e,
                      double[] u_e)

Returns the cost of a routing scheme according to the carried traffic per link and the link capacity vectors, assuming the IGP-WO cost model.

For more information, see calculateIGPCost(java.util.Map, java.util.Map)

Parameters:

y_e - Carried traffic per link vector

u_e - Link capacity vector

Returns:

IGP cost

Since:

0.2.3

See Also:

calculateIGPCost(java.util.Map, java.util.Map)

calculateIGPCost

public static double calculateIGPCost(Map<Long,Double> y_e,
                      Map<Long,Double> u_e)

Returns the cost of a routing scheme according to the carried traffic per link and link capacities, assuming the IGP-WO cost model.

Let E be a set of links, where u_e is the capacity for link e ∈ E, and y_e is the carried traffic by link e ∈ E. Then, the total cost of the associated routing, denoted as C, is the sum for every link e ∈ E of its associated cost c_e, which is computed as follows:

• c_e = y_e , if ρ_e ∈ [0, 1/3)
• c_e = 3 * y_e - (2 / 3) * u_e, if ρ_e ∈ [1/3, 2/3)
• c_e = 10 * y_e - (16 / 3) * u_e, if ρ_e ∈ [2/3, 9/10)
• c_e = 70 * y_e - (178 / 3) * u_e, if ρ_e ∈ [9/10, 1)
• c_e = 500 * y_e - (1468 / 3) * u_e, if ρ_e ∈ [1, 11/10)
• c_e = 5000 * y_e - (16318 / 3) * u_e, otherwise

where ρ_e is the ratio y_e / u_e.

Reference: H. Ümit, "Techniques and Tools for Intra-domain Traffic Engineering," Ph.D. Thesis, Université Catholique de Louvain (Belgium), December 2009

Parameters:

y_e - Carried traffic per link

u_e - Capacity per link

Returns:

IGP cost

Since:

0.3.0

computeCarriedTrafficFromIGPWeights

public static Quadruple<Map<Pair<Long,Long>,Double>,Map<Pair<Long,Long>,Double>,Map<Long,Double>,Map<Long,Double>> computeCarriedTrafficFromIGPWeights(NetPlan netPlan,
                                                                                                                                       long layerId,
                                                                                                                                       Map<Long,Double> linkWeightMap)

Computes the resulting carried traffic according to a link weight setting and OSPF/ECMP routing.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means 'takes weight from link attribute'). No special iteration-order (i.e. ascending) is required

Returns:

A Quadruple composed of f_de (splitting rules), x_de (carried traffic for demand 'd' through link 'e'), r_d (end-to-end carried traffic for demand 'd'), and y_e (carried traffic by link 'e')

Since:

0.3.0

computeCarriedTrafficFromIGPWeights

public static Quadruple<Map<Pair<Long,Long>,Double>,Map<Pair<Long,Long>,Double>,Map<Long,Double>,Map<Long,Double>> computeCarriedTrafficFromIGPWeights(NetPlan netPlan,
                                                                                                                                       Map<Long,Double> linkWeightMap)

Computes the resulting carried traffic according to a link weight setting and OSPF/ECMP routing.

Parameters:

netPlan - Network design

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means 'takes weight from link attribute'). No special iteration-order (i.e. ascending) is required

Returns:

A Quadruple composed of f_de (splitting rules), x_de (carried traffic for demand 'd' through link 'e'), r_d (end-to-end carried traffic for demand 'd'), and y_e (carried traffic by link 'e')

Since:

0.3.0

computeECMPForwardingRules

public static Map<Pair<Long,Long>,Double> computeECMPForwardingRules(Set<Long> nodeIds,
                                                     Map<Long,Pair<Long,Long>> linkMap,
                                                     Map<Long,Pair<Long,Long>> demandMap,
                                                     Map<Long,Double> linkWeightMap)

Computes the forwarding rules according to an OSPF/ECMP scheme. Each forwarding rule is determined by a demand-outgoing link pair, and its corresponding splitting ratio. Splitting ratio is defined as the fraction of traffic sent through the given outgoing link, with respect to the total traffic entering to the node for the given demand.

Parameters:

nodeIds - Set of node identifiers. It is mandatory that can be iterated in ascending order of node identifier (i.e. using TreeSet or those Set objects returned from Net2Plan object

linkMap - Map of links, where the key is the unique link identifier and the value is a Pair representing the origin node and the destination node of the link, respectively. It is mandatory that can be iterated in ascending order of link identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

demandMap - Map of demands, where the key is the unique demand identifier and the value is a Pair representing the ingress node and the egress node of the demand, respectively. It is mandatory that can be iterated in ascending order of demand identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means each link will have a weight equal to '1'). No special iteration-order (i.e. ascending) is required

Returns:

Forwarding rule mapping, where key is the demand-outgoing link pair and the value is the splitting ratio

Since:

0.3.0

computeECMPRoutingTableMap

public static Map<Pair<Long,Long>,Double> computeECMPRoutingTableMap(Set<Long> nodeIds,
                                                     Map<Long,Pair<Long,Long>> linkMap,
                                                     Map<Long,Double> linkWeightMap)

Computes the routing table matrix according to an OSPF/ECMP scheme. For each destination node t, and each link e, f_te[t][e] sets the fraction of the traffic targeted to node t that arrives (or is generated in) node a(e) (the initial node of link e), that is forwarded through link e. It must hold that for every node n different of t, the sum of the fractions f_te along its outgoing links must be 1. For every destination t, f_te = 0 for all the links e that are outgoing links of t.

Parameters:

nodeIds - Set of node identifiers. It is mandatory that can be iterated in ascending order of node identifier (i.e. using TreeSet or those Set objects returned from Net2Plan object

linkMap - Map of links, where the key is the unique link identifier and the value is a Pair representing the origin node and the destination node of the link, respectively. It is mandatory that can be iterated in ascending order of link identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means each link will have a weight equal to '1'). No special iteration-order (i.e. ascending) is required

Returns:

Destination-based routing in the form f_te (fractions of traffic in a node, that is forwarded through each of its output links to node t)

Since:

0.3.0

computeECMPRoutingTableMatrix

public static cern.colt.matrix.tdouble.DoubleMatrix2D computeECMPRoutingTableMatrix(Set<Long> nodeIds,
                                                                    Map<Long,Pair<Long,Long>> linkMap,
                                                                    Map<Long,Double> linkWeightMap)

Computes the routing table matrix according to an OSPF/ECMP scheme. For each destination node t, and each link e, f_te[t][e] sets the fraction of the traffic targeted to node t that arrives (or is generated in) node a(e) (the initial node of link e), that is forwarded through link e. It must hold that for every node n different of t, the sum of the fractions f_te along its outgoing links must be 1. For every destination t, f_te = 0 for all the links e that are outgoing links of t.

Parameters:

nodeIds - Set of node identifiers. It is mandatory that can be iterated in ascending order of node identifier (i.e. using TreeSet or those Set objects returned from Net2Plan object

linkMap - Map of links, where the key is the unique link identifier and the value is a Pair representing the origin node and the destination node of the link, respectively. It is mandatory that can be iterated in ascending order of link identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means each link will have a weight equal to '1'). No special iteration-order (i.e. ascending) is required

Returns:

Destination-based routing in the form f_te (fractions of traffic in a node, that is forwarded through each of its output links to node t)

Since:

0.3.1

getLinkWeight

public static double getLinkWeight(NetPlan netPlan,
                   long linkId)

Returns the weight associated to a given link.

Parameters:

netPlan - Network design

linkId - Link identifier

Returns:

Link weight (or Double.MAX_VALUE if link is down)

Since:

0.3.0

getLinkWeight

public static double getLinkWeight(NetPlan netPlan,
                   long layerId,
                   long linkId)

Returns the weight associated to a given link.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkId - Link identifier

Returns:

Link weight (or Double.MAX_VALUE if link is down)

Since:

0.3.0

getLinkWeightMap

public static Map<Long,Double> getLinkWeightMap(NetPlan netPlan)

Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.

Parameters:

netPlan - Network design

Returns:

Set of link weights (must be greater than zero, default: 1)

Since:

0.3.0

getLinkWeightMap

public static Map<Long,Double> getLinkWeightMap(NetPlan netPlan,
                                long layerId)

Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.

Parameters:

netPlan - Network design

layerId - Layer identifier

Returns:

Set of link weights (must be greater than zero, default: 1)

Since:

0.3.0

getLinkWeightVector

public static double[] getLinkWeightVector(NetPlan netPlan)

Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.

Parameters:

netPlan - Network design

Returns:

Set of link weights (must be greater than zero, default: 1)

Since:

0.3.0

getLinkWeightVector

public static double[] getLinkWeightVector(NetPlan netPlan,
                           long layerId)

Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design.

Parameters:

netPlan - Network design

layerId - Layer identifier

Returns:

Set of link weights (must be greater than zero, default: 1)

Since:

0.3.0

getRoutingTableMatrix

public static cern.colt.matrix.tdouble.DoubleMatrix2D getRoutingTableMatrix(NetPlan netPlan)

Obtains a destination-based routing from a given network design.

Parameters:

netPlan - Network design

Returns:

A destination-based routing in the form of fractions f_te (fraction of the traffic targeted to node t that arrives (or is generated in) node a(e) (the initial node of link e), that is forwarded through link e)

Since:

0.3.1

routingTableMatrixToString

public static String routingTableMatrixToString(Set<Long> nodeIds,
                                Map<Long,Pair<Long,Long>> linkMap,
                                double[][] f_te)

Outputs a given set of routing tables to a String. For debugging purposes.

Parameters:

nodeIds - Set of node identifiers

linkMap - Map of links, where the key is the link identifier and the value is Pair representing the origin node and the destination node of the link, respectively.

f_te - Destination-based routing in the form of fractions f_te (fraction of the traffic targeted to node t that arrives (or is generated in) node a(e) (the initial node of link e), that is forwarded through link e)

Returns:

A String from the given routing tables

Since:

0.3.0

setECMPForwardingRulesFromLinkWeights

public static void setECMPForwardingRulesFromLinkWeights(NetPlan netPlan,
                                         long layerId,
                                         Map<Long,Double> linkWeightMap)

Sets the OSPF/ECMP forwarding rules in the given design, according to the given IGP weight setting. Any previous routing information (either source routing or hop-by-hop routing) will be removed. This method calls sequentually to computeECMPForwardingRules and setForwardingRules methods.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means 'takes weight from link attribute'). No special iteration-order (i.e. ascending) is required

Since:

0.3.0

setECMPForwardingRulesFromLinkWeights

public static void setECMPForwardingRulesFromLinkWeights(NetPlan netPlan,
                                         Map<Long,Double> linkWeightMap)

Sets the OSPF/ECMP forwarding rules in the given design, according to the given IGP weight setting. Any previous routing information (either source routing or hop-by-hop routing) will be removed. This method calls sequentually to computeECMPForwardingRules and setForwardingRules methods.

Parameters:

netPlan - Network design

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means 'takes weight from link attribute'). No special iteration-order (i.e. ascending) is required

Since:

0.3.0

setECMPRoutesFromLinkWeights

public static void setECMPRoutesFromLinkWeights(NetPlan netPlan,
                                long layerId,
                                Map<Long,Double> linkWeightMap)

Sets the explicit traffic routing according to an OSPF/ECMP scheme. Any previous routing information (either source routing or hop-by-hop routing) will be removed.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means 'takes weight from link attribute'). No special iteration-order (i.e. ascending) is required

Since:

0.3.1

setECMPRoutesFromLinkWeights

public static void setECMPRoutesFromLinkWeights(NetPlan netPlan,
                                Map<Long,Double> linkWeightMap)

Sets the explicit traffic routing according to an OSPF/ECMP scheme. Any previous routing information (either source routing or hop-by-hop routing) will be removed.

Parameters:

netPlan - Network design

linkWeightMap - Cost per link, where the key is the link identifier and the value is the link weight (null means 'takes weight from link attribute'). No special iteration-order (i.e. ascending) is required

Since:

0.3.1

setLinkWeight

public static void setLinkWeight(NetPlan netPlan,
                 long linkId,
                 double linkWeight)

Sets the weight associated to the link.

Parameters:

netPlan - Network design

linkId - Link identifier

linkWeight - IGP weight associated to the link (must be greater or equal than one)

Since:

0.3.0

setLinkWeight

public static void setLinkWeight(NetPlan netPlan,
                 long layerId,
                 long linkId,
                 double linkWeight)

Sets the weight associated to the link.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkId - Link identifier

linkWeight - IGP weight associated to the link (must be greater or equal than one)

Since:

0.3.0

setLinkWeights

public static void setLinkWeights(NetPlan netPlan,
                  double linkWeight)

Sets the weight associated to every link.

Parameters:

netPlan - Network design

linkWeight - IGP weight associated to each link (must be greater or equal than one)

Since:

0.2.0

setLinkWeights

public static void setLinkWeights(NetPlan netPlan,
                  double[] linkWeightVector)

Sets the weight associated to each link.

Parameters:

netPlan - Network design

linkWeightVector - IGP weight per link (must be greater or equal than one)

Since:

0.2.0

setLinkWeights

public static void setLinkWeights(NetPlan netPlan,
                  long layerId,
                  double linkWeight)

Sets the weight associated to every link.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkWeight - IGP weight associated to each link (must be greater or equal than one)

Since:

0.3.0

setLinkWeights

public static void setLinkWeights(NetPlan netPlan,
                  long layerId,
                  double[] linkWeightVector)

Sets the weight associated to each link.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkWeightVector - IGP weight per link (must be greater or equal than one)

Since:

0.3.0

setLinkWeights

public static void setLinkWeights(NetPlan netPlan,
                  long layerId,
                  Map<Long,Double> linkWeightMap)

Sets the weight associated to each link.

Parameters:

netPlan - Network design

layerId - Layer identifier

linkWeightMap - IGP weight per link (must be greater or equal than one)

Since:

0.3.0

setLinkWeights

public static void setLinkWeights(NetPlan netPlan,
                  Map<Long,Double> linkWeightMap)

Sets the weight associated to each link.

Parameters:

netPlan - Network design

linkWeightMap - IGP weight per link (must be greater or equal than one)

Since:

0.3.0