include/amok/bandwidth.h

   1 /* $Id$ */
   2
   3 /* amok_bandwidth - Bandwidth test facilities                               */
   4
   5 /* Copyright (c) 2003-2005 Martin Quinson. All rights reserved.             */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #ifndef AMOK_BANDWIDTH_H
  11 #define AMOK_BANDWIDTH_H
  12
  13 #include "amok/base.h"
  14
  15 /** \addtogroup AMOK_bw
  16  *  \brief Test the bandwidth between two nodes
  17  *
  18  *  This module allows you to retrieve the bandwidth between to arbitrary hosts
  19  *  and saturating the links leading to them, provided that they run some GRAS
  20  *  process which initialized this module.
  21  *
  22  * \htmlonly <h3>Bandwidth measurement</h3>\endhtmlonly
  23  *
  24  *  Retrieving the bandwidth is usually done by active measurment: one send
  25  *  a packet of known size, time how long it needs to go back and forth,
  26  *  and you get the bandwidth in Kb/s available on the wire.
  27  *
  28  *  This is not as easy as it first seems to do so in GRAS. The first issue
  29  *  is that GRAS messages can get buffered, or the receiver cannot be
  30  *  waiting for the message when it arrives. This results in extra delays
  31  *  impacting the measurement quality. You thus have to setup a rendez-vous
  32  *  protocol. The second issue is that GRAS message do have an header, so
  33  *  figuring out their size is not trivial. Moreover, they get converted
  34  *  when the sender and receiver processor architecture are different,
  35  *  inducing extra delays. For this, GRAS provide the so-called measurement
  36  *  sockets. On them, you can send raw data which is not converted (see
  37  *  \ref GRAS_sock_meas).
  38  *
  39  *  Solving all these problems is quite error prone and anoying, so we
  40  *  implemented this in the current module so that you don't have to do it
  41  *  yourself. The API is very simple. Use amok_bw_test() to get the BW
  42  *  between the local host and the specified peer, or amok_bw_request() to
  43  *  get the BW between two remote hosts. The elapsed time, as long as the
  44  *  achieved bandwidth is returned in the last arguments of the functions.
  45  *
  46  *  All sizes are in bytes. The \a buf_size is the size of the buffer
  47  *   (this is a socket parameter set automatically). The \a exp_size is the
  48  *   amount of data to send during an experiment. \a msg_size is the size
  49  *   of each message sent. These values allow you to study phenomenon such
  50  *   as TCP slow start (which are not correctly modelized by \ref SURF_API,
  51  *   yet). They are mimicked from the NWS API, and default values could be
  52  *   buf_size=32k, msg_size=16k and exp_size=64k. That means that the
  53  *   socket will be prepared to accept 32k in its buffer and then four
  54  *   messages of 16k will be sent (so that the total amount of data equals
  55  *   64k). Of course, you can use other values if you want to.
  56  *
  57  *  \htmlonly
  58  * <center><img align=center src="amok_bw_test.png" alt="amok bandwidth measurement protocol"><br>
  59  * Fig 1: AMOK bandwidth measurement protocol.</center>
  60  * <h3>Link saturation</h3>
  61  * \endhtmlonly
  62  *
  63  *  You sometimes want to try saturating some link during the network
  64  *  related experiments (at least, we did ;). This also can turn quite
  65  *  untrivial to do, unless you use this great module. You can either ask
  66  *  for the saturation between the current host and a distant one with
  67  *  amok_bw_saturate_begin() or between two distant hosts with
  68  *  amok_bw_saturate_start(). In any case, remember that gras actors
  69  *  (processes) are not interruptible. It means that an actor you
  70  *  instructed to participate to a link saturation experiment will not do
  71  *  anything else until it is to its end (either because the asked duration
  72  *  was done or because someone used amok_bw_saturate_stop() on the emitter
  73  *  end of the experiment).
  74  *
  75  *  The following figure depicts the used protocol. Note that any
  76  *  handshaking messages internal messages are omitted for sake of
  77  *  simplicity. In this example, the experiment ends before the planned
  78  *  experiment duration is over because one host use the
  79  *  amok_bw_saturate_stop() function, but things are not really different
  80  *  if the experiment stops alone. Also, it is not mandatory that the host
  81  *  calling amok_bw_saturate_stop() is the same than the one which called
  82  *  amok_bw_saturate_start(), despite what is depicted here.
  83  *
  84  *  \htmlonly
  85  * <center><img align=center src="amok_bw_sat.png" alt="amok bandwidth saturation protocol"><br>
  86  * Fig 2: AMOK link saturation protocol.</center>
  87  * \endhtmlonly
  88  *
  89  *  @{
  90  */
  91
  92 /* module handling */
  93
  94 void amok_bw_init(void);
  95 void amok_bw_exit(void);
  96
  97 void amok_bw_test(gras_socket_t peer,
  98                   unsigned long int buf_size,unsigned long int exp_size,unsigned long int msg_size,
  99           /*OUT*/ double *sec, double *bw);
 100
 101 void amok_bw_request(const char* from_name,unsigned int from_port,
 102                      const char* to_name,unsigned int to_port,
 103                      unsigned long int buf_size,unsigned long int exp_size,unsigned long int msg_size,
 104              /*OUT*/ double *sec, double*bw);
 105
 106 double * amok_bw_matrix(xbt_dynar_t hosts, /* dynar of xbt_host_t */
 107                         int buf_size_bw, int exp_size_bw, int msg_size_bw);
 108
 109 /* ***************************************************************************
 110  * Link saturation
 111  * ***************************************************************************/
 112
 113
 114 void amok_bw_saturate_start(const char* from_name,unsigned int from_port,
 115                             const char* to_name,unsigned int to_port,
 116                             unsigned int msg_size, double duration);
 117
 118 void amok_bw_saturate_begin(const char* to_name,unsigned int to_port,
 119                             unsigned int msg_size, double duration,
 120                             /*out*/ double *elapsed, double *bw);
 121
 122 void amok_bw_saturate_stop(const char* from_name,unsigned int from_port,
 123                            /*out*/ double *time, double *bw);
 124
 125 /** @} */
 126
 127 #endif /* AMOK_BANDWIDTH_H */