src/amok/Bandwidth/saturate.c

   1 /* $Id$ */
   2
   3 /* amok_saturate - Link saturating facilities (for ALNeM's BW testing)      */
   4
   5 /* Copyright (c) 2003, 2004 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 #include "amok/Bandwidth/bandwidth_private.h"
  11 #include "gras/Msg/msg_private.h" /* FIXME: This mucks with contextes to answer RPC directly */
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(amok_bw_sat,amok_bw,"Everything concerning the SATuration part of the amok_bw module");
  14
  15 static int amok_bw_cb_sat_start(gras_msg_cb_ctx_t ctx, void *payload);
  16 static int amok_bw_cb_sat_begin(gras_msg_cb_ctx_t ctx, void *payload);
  17
  18
  19 void amok_bw_sat_init(void) {
  20   gras_datadesc_type_t bw_res_desc=gras_datadesc_by_name("bw_res_t");
  21   gras_datadesc_type_t sat_request_desc;
  22   /* Build the saturation datatype descriptions */
  23
  24   sat_request_desc = gras_datadesc_struct("s_sat_request_desc_t");
  25   gras_datadesc_struct_append(sat_request_desc,"host",gras_datadesc_by_name("s_xbt_host_t"));
  26   gras_datadesc_struct_append(sat_request_desc,"msg_size",gras_datadesc_by_name("unsigned int"));
  27   gras_datadesc_struct_append(sat_request_desc,"duration",gras_datadesc_by_name("unsigned int"));
  28   gras_datadesc_struct_close(sat_request_desc);
  29   sat_request_desc = gras_datadesc_ref("sat_request_t",sat_request_desc);
  30
  31   /* Register the saturation messages */
  32   gras_msgtype_declare_rpc("amok_bw_sat start", sat_request_desc, NULL);
  33   gras_msgtype_declare_rpc("amok_bw_sat begin", sat_request_desc, sat_request_desc);
  34   gras_msgtype_declare_rpc("amok_bw_sat stop",  NULL,             bw_res_desc);
  35
  36 }
  37 void amok_bw_sat_join(void) {
  38   gras_cb_register(gras_msgtype_by_name("amok_bw_sat start"),
  39                    &amok_bw_cb_sat_start);
  40   gras_cb_register(gras_msgtype_by_name("amok_bw_sat begin"),
  41                    &amok_bw_cb_sat_begin);
  42 }
  43 void amok_bw_sat_leave(void) {
  44   gras_cb_unregister(gras_msgtype_by_name("amok_bw_sat start"),
  45                      &amok_bw_cb_sat_start);
  46   gras_cb_unregister(gras_msgtype_by_name("amok_bw_sat begin"),
  47                      &amok_bw_cb_sat_begin);
  48 }
  49
  50 /* ***************************************************************************
  51  * Link saturation
  52  * ***************************************************************************/
  53
  54 /**
  55  * @brief Ask 'from_name:from_port' to stop saturating going to to_name:to_name.
  56  *
  57  * @param from_name: Name of the host we are asking to do a experiment with (to_name:to_port)
  58  * @param from_port: port on which the process we are asking for an experiment is listening
  59  * (for message, do not give a raw socket here. The needed raw socket will be negociated
  60  * between the peers)
  61  * @param to_name: Name of the host with which we should conduct the experiment
  62  * @param to_port: port on which the peer process is listening for message
  63  * @param msg_size: Size of each message sent.
  64  * @param duration: How long in maximum should be the saturation.
  65  *
  66  * Ask the process 'from_name:from_port' to start to saturate the link between itself
  67  * and to_name:to_name.
  68  */
  69 void amok_bw_saturate_start(const char* from_name,unsigned int from_port,
  70                             const char* to_name,unsigned int to_port,
  71                             unsigned int msg_size, double duration) {
  72   gras_socket_t sock;
  73
  74   sat_request_t request = xbt_new(s_sat_request_t,1);
  75
  76   sock = gras_socket_client(from_name,from_port);
  77
  78   request->host.name = (char*)to_name;
  79   request->host.port = to_port;
  80
  81   request->duration=duration;
  82   request->msg_size=msg_size;
  83
  84
  85   gras_msg_rpccall(sock,60,gras_msgtype_by_name("amok_bw_sat start"),&request, NULL);
  86
  87   free(request);
  88   gras_socket_close(sock);
  89 }
  90
  91 /* Asked to begin a saturation */
  92 static int amok_bw_cb_sat_start(gras_msg_cb_ctx_t ctx, void *payload){
  93   sat_request_t request = *(sat_request_t*)payload;
  94   gras_socket_t expeditor = gras_msg_cb_ctx_from(ctx);
  95
  96   VERB4("Asked by %s:%d to start a saturation to %s:%d",
  97         gras_socket_peer_name(expeditor),gras_socket_peer_port(expeditor),
  98         request->host.name,request->host.port);
  99
 100   gras_msg_rpcreturn(60,ctx, NULL);
 101   amok_bw_saturate_begin(request->host.name,request->host.port,
 102                          request->msg_size, request->duration,
 103                          NULL,NULL);
 104   free(request->host.name);
 105   free(request);
 106   return 1;
 107 }
 108
 109 /**
 110  * @brief Start saturating between the current process and the designated peer
 111  *
 112  * Note that the only way to break this function before the end of the timeout
 113  * is to have a remote host calling amok_bw_saturate_stop to this process.
 114  *
 115  * If duration=0, the experiment will never timeout (you then have to manually
 116  * stop it).
 117  *
 118  * If msg_size=0, the size will be automatically computed to make sure that
 119  * each of the messages occupy the connexion one second
 120  */
 121 void amok_bw_saturate_begin(const char* to_name,unsigned int to_port,
 122                             unsigned int msg_size, double duration,
 123                             /*out*/ double *elapsed_res, double *bw_res) {
 124
 125   xbt_ex_t e;
 126
 127   gras_socket_t peer_cmd = gras_socket_client(to_name, to_port);
 128   gras_msg_cb_ctx_t ctx;
 129
 130   gras_socket_t meas;
 131
 132   s_gras_msg_t msg_got;
 133
 134   unsigned int packet_sent=0;
 135   double start,elapsed=-1; /* timer */
 136   double bw;
 137
 138   volatile int saturate_further; /* boolean in the main loop */
 139
 140   /* Negociate the saturation with the peer */
 141   sat_request_t request = xbt_new(s_sat_request_t,1);
 142
 143   DEBUG2("Begin to saturate to %s:%d",to_name,to_port);
 144   memset(&msg_got,0,sizeof(msg_got));
 145
 146   request->msg_size = msg_size;
 147   request->duration = duration;
 148   request->host.name = NULL;
 149   request->host.port = 0;
 150
 151   /* Size autodetection on need */
 152   if (!msg_size) {
 153     double bw;
 154     double sec;
 155     amok_bw_test(peer_cmd,
 156                  0,512*1024, 512*1024, /* 512k as first guess */
 157                  1, /* at least one sec */
 158                  &sec, &bw);
 159     request->msg_size = (int)bw;
 160   }
 161
 162   /* Launch the saturation */
 163   ctx = gras_msg_rpc_async_call(peer_cmd, 60,
 164                                 gras_msgtype_by_name("amok_bw_sat begin"),
 165                                                   &request);
 166   free(request);
 167   gras_msg_rpc_async_wait(ctx,&request);
 168   meas=gras_socket_client_ext( to_name, request->host.port,
 169                                0 /*bufsize: auto*/,
 170                                1 /*meas: true*/);
 171   free(request);
 172
 173   gras_socket_close(peer_cmd);
 174   INFO2("Saturation(%s->%s) started",gras_os_myname(),to_name);
 175
 176   /* Start experiment */
 177   start=gras_os_time();
 178
 179   do {
 180     /* do send it */
 181     gras_socket_meas_send(meas,120,msg_size,msg_size);
 182     packet_sent++;
 183
 184     /* Check whether someone asked us to stop saturation */
 185     saturate_further = 0;
 186     TRY {
 187       gras_msg_wait_ext(0/*no wait*/,gras_msgtype_by_name("amok_bw_sat stop"),
 188                         NULL /* accept any sender */,
 189                         NULL, NULL, /* No specific filter */
 190                         &msg_got);
 191     } CATCH(e) {
 192       if (e.category == timeout_error) {
 193         saturate_further=1;
 194         memset(&msg_got,0,sizeof(msg_got)); /* may be overprotectiv here */
 195       }
 196       xbt_ex_free(e);
 197     }
 198
 199     /* Check whether the experiment has to be terminated by now */
 200     elapsed=gras_os_time()-start;
 201     DEBUG2("elapsed %f duration %f",elapsed, duration);
 202
 203   } while (saturate_further && (duration==0 || elapsed < duration));
 204
 205   bw = ((double)(packet_sent*msg_size)) / elapsed;
 206
 207   if (elapsed_res)
 208     *elapsed_res = elapsed;
 209   if (bw_res)
 210     *bw_res = bw;
 211
 212   /* If someone stopped us, inform him about the achieved bandwidth */
 213   if (msg_got.expe) {
 214     bw_res_t answer = xbt_new(s_bw_res_t,1);
 215     s_gras_msg_cb_ctx_t ctx;
 216
 217     INFO3("Saturation from %s to %s stopped by %s",
 218           gras_os_myname(),to_name, gras_socket_peer_name(msg_got.expe));
 219     answer->timestamp=gras_os_time();
 220     answer->sec=elapsed;
 221     answer->bw=bw;
 222
 223     ctx.expeditor = msg_got.expe;
 224     ctx.ID = msg_got.ID;
 225     ctx.msgtype = msg_got.type;
 226
 227     gras_msg_rpcreturn(60,&ctx,&answer);
 228     free(answer);
 229   } else {
 230     INFO4("Saturation from %s to %s elapsed after %f sec (achieving %f kb/s)",
 231           gras_os_myname(),to_name,elapsed,bw/1024.0);
 232   }
 233
 234   gras_socket_close(meas);
 235 }
 236
 237 /* Sender will saturate link to us */
 238 static int amok_bw_cb_sat_begin(gras_msg_cb_ctx_t ctx, void *payload){
 239   sat_request_t request=*(sat_request_t*)payload;
 240   sat_request_t answer=xbt_new0(s_sat_request_t,1);
 241   volatile int saturate_further = 1;
 242   xbt_ex_t e;
 243   gras_socket_t measMaster=NULL,meas=NULL;
 244   gras_socket_t from=gras_msg_cb_ctx_from(ctx);
 245
 246   int port=6000;
 247   while (port <= 10000 && measMaster == NULL) {
 248     TRY {
 249       measMaster = gras_socket_server_ext(port,
 250                                           0 /*bufsize: auto*/,
 251                                           1 /*meas: true*/);
 252     } CATCH(e) {
 253       measMaster = NULL;
 254       if (port < 10000)
 255         xbt_ex_free(e);
 256       else
 257         RETHROW0("Error encountered while opening a measurement server socket: %s");
 258     }
 259     if (measMaster == NULL)
 260       port++; /* prepare for a new loop */
 261   }
 262   answer->host.port=port;
 263
 264   gras_msg_rpcreturn(60, ctx, &answer);
 265   free(answer);
 266
 267   gras_os_sleep(5); /* Wait for the accept */
 268
 269   TRY {
 270     meas = gras_socket_meas_accept(measMaster);
 271     DEBUG0("saturation handshake answered");
 272   } CATCH(e) {
 273     gras_socket_close(measMaster);
 274     RETHROW0("Error during saturation handshake: %s");
 275   }
 276
 277   while (saturate_further) {
 278     TRY {
 279       gras_socket_meas_recv(meas,5,request->msg_size,request->msg_size);
 280     } CATCH(e) {
 281       saturate_further = 0;
 282       xbt_ex_free(e);
 283     }
 284   }
 285   INFO3("Saturation comming from %s:%d stopped on %s",
 286         gras_socket_peer_name(from),gras_socket_peer_port(from),
 287         gras_os_myname());
 288
 289   gras_socket_close(meas);
 290   if (gras_if_RL()) /* On SG, accepted=master */
 291     gras_socket_close(measMaster);
 292   free(request);
 293   return 1;
 294 }
 295
 296 /**
 297  * @brief Ask 'from_name:from_port' to stop any saturation experiments
 298  * @param from_name: Name of the host we are asking to do a experiment with (to_name:to_port)
 299  * @param from_port: port on which the process we are asking for an experiment is listening
 300  * @param time: the duration of the experiment
 301  * @param bw: the achieved bandwidth
 302  *
 303  */
 304 void amok_bw_saturate_stop(const char* from_name,unsigned int from_port,
 305                            /*out*/ double *time, double *bw) {
 306   xbt_ex_t e;
 307
 308   gras_socket_t sock = gras_socket_client(from_name,from_port);
 309   bw_res_t answer;
 310   VERB2("Ask %s:%d to stop the saturation",from_name,from_port);
 311   TRY {
 312      gras_msg_rpccall(sock,60,gras_msgtype_by_name("amok_bw_sat stop"),NULL,&answer);
 313   } CATCH(e) {
 314      RETHROW2("Cannot ask %s:%d to stop saturation: %s",from_name, from_port);
 315   }
 316   gras_socket_close(sock);
 317   if (time) *time=answer->sec;
 318   if (bw)   *bw  =answer->bw;
 319   free(answer);
 320 }