From 536274b203068230ea88669e76291176d893b186 Mon Sep 17 00:00:00 2001 From: Christian Heinrich Date: Wed, 20 May 2015 12:17:32 +0200 Subject: [PATCH] Added anchors and references for link sharing policies. --- doc/doxygen/platform.doc | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index b86e29bccd..e80a7ba245 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -341,7 +341,7 @@ bb_lat | no | int | Latency for backbone (if any). See lin bb_sharing_policy | no | string | Sharing policy for the backbone (if any). See link section for syntax/details. availability_file | no | string | Allows you to use a file as input for availability. Similar to hosts attribute. state_file | no | string | Allows you to use a file as input for states. Similar to hosts attribute. -loopback_bw | no | int | Bandwidth for loopback (if any). See link section for syntax/details. If loopback_bw and loopback_lat (see below) attributes are omitted, no loopback link is created and all intra-node communication will use the main network link of the node. Loopback link is a FATPIPE. +loopback_bw | no | int | Bandwidth for loopback (if any). See link section for syntax/details. If loopback_bw and loopback_lat (see below) attributes are omitted, no loopback link is created and all intra-node communication will use the main network link of the node. Loopback link is a \ref sharing_policy_fatpipe "\b FATPIPE". loopback_lat | no | int | Latency for loopback (if any). See link section for syntax/details. See loopback_bw for more info. topology | no | FLAT\|TORUS\|FAT_TREE (default: FLAT) | Network topology to use. SimGrid currently supports FLAT (with or without backbone, as described before), TORUS and FAT_TREE attributes for this tag. topo_parameters | no | string | Specific parameters to pass for the topology defined in the topology tag. For torus networks, comma-separated list of the number of nodes in each dimension of the torus. For fat trees, refer to \ref AsClusterFatTree "AsClusterFatTree documentation". @@ -488,7 +488,7 @@ Attribute name | Mandatory | Values | Description id | yes | string | The identifier of the link to be used when referring to it. bandwidth | yes | int | Maximum bandwidth for this link, given in bytes/s latency | no | double (default: 0.0) | Latency for this link. -sharing_policy | no | SHARED\|FATPIPE\|FULLDUPLEX (default: SHARED) | Sharing policy for the link. +sharing_policy | no | \ref sharing_policy_shared "SHARED"\|\ref sharing_policy_fatpipe "FATPIPE"\|\ref sharing_policy_fullduplex "FULLDUPLEX" (default: SHARED) | Sharing policy for the link. state | no | ON\|OFF (default: ON) | Allows you to to turn this link on or off (working / not working) bandwidth_file | no | string | Allows you to use a file as input for bandwidth. latency_file | no | string | Allows you to use a file as input for latency. @@ -523,11 +523,13 @@ Picosecond | ps | 0.000000000001 = 10^(-12) #### Sharing policy #### -By default a network link is SHARED, i.e., if two or more data flows go +\anchor sharing_policy_shared +By default a network link is \b SHARED, i.e., if two or more data flows go through a link, the bandwidth is shared fairly among all data flows. This is similar to the sharing policy TCP uses. -On the other hand, if a link is defined as a FATPIPE, +\anchor sharing_policy_fatpipe +On the other hand, if a link is defined as a \b FATPIPE, each flow going through this link will be provided with the complete bandwidth, i.e., no sharing occurs and the bandwidth is only limiting each flow individually. The complete bandwidth provided by this link in this mode @@ -536,7 +538,8 @@ is ``#flows*bandwidth``, with at most ``bandwidth`` being available per flow. Using the FATPIPE mode allows to model backbones that won't affect performance (except latency). -The last mode available is FULLDUPLEX. This means that SimGrid will +\anchor sharing_policy_fullduplex +The last mode available is \b FULLDUPLEX. This means that SimGrid will automatically generate two links (one carrying the suffix _UP and the other the suffix _DOWN) for each ```` tag. This models situations when the direction of traffic is important. -- 2.20.1