X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4f52518f3f44161c269e8ba3ee45bcc6179c3b90..15c81e44412415173de220954a453019c68714cd:/include/amok/bandwidth.h
diff --git a/include/amok/bandwidth.h b/include/amok/bandwidth.h
index 0413ca5e7a..787a6c0406 100644
--- a/include/amok/bandwidth.h
+++ b/include/amok/bandwidth.h
@@ -1,8 +1,7 @@
-/* $Id$ */
-
/* amok_bandwidth - Bandwidth test facilities */
-/* Copyright (c) 2003-2005 Martin Quinson. All rights reserved. */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
@@ -10,16 +9,14 @@
#ifndef AMOK_BANDWIDTH_H
#define AMOK_BANDWIDTH_H
-#include "amok/base.h"
-
-/* module handling */
-
-
/** \addtogroup AMOK_bw
* \brief Test the bandwidth between two nodes
*
- * This module allows you to retrieve the bandwidth between to arbitrary hosts,
- * provided that they run some GRAS process which initialized this module.
+ * This module allows you to retrieve the bandwidth between to arbitrary hosts
+ * and saturating the links leading to them, provided that they run some GRAS
+ * process which initialized this module.
+ *
+ * \htmlonly Bandwidth measurement
\endhtmlonly
*
* Retrieving the bandwidth is usually done by active measurment: one send
* a packet of known size, time how long it needs to go back and forth,
@@ -52,48 +49,92 @@
* buf_size=32k, msg_size=16k and exp_size=64k. That means that the
* socket will be prepared to accept 32k in its buffer and then four
* messages of 16k will be sent (so that the total amount of data equals
- * 64k). Of course, you can use other values if you want to.
+ * 64k). Of course, you can use other values if you want to.
*
* \htmlonly
- * 
+ *
+ * Fig 1: AMOK bandwidth measurement protocol.
+ * Link saturation
* \endhtmlonly
*
- * \todo Cleanup and implement the link saturation stuff.
+ * You sometimes want to try saturating some link during the network
+ * related experiments (at least, we did ;). This also can turn quite
+ * untrivial to do, unless you use this great module. You can either ask
+ * for the saturation between the current host and a distant one with
+ * amok_bw_saturate_begin() or between two distant hosts with
+ * amok_bw_saturate_start(). In any case, remember that gras actors
+ * (processes) are not interruptible. It means that an actor you
+ * instructed to participate to a link saturation experiment will not do
+ * anything else until it is to its end (either because the asked duration
+ * was done or because someone used amok_bw_saturate_stop() on the emitter
+ * end of the experiment).
+ *
+ * The following figure depicts the used protocol. Note that any
+ * handshaking messages internal messages are omitted for sake of
+ * simplicity. In this example, the experiment ends before the planned
+ * experiment duration is over because one host use the
+ * amok_bw_saturate_stop() function, but things are not really different
+ * if the experiment stops alone. Also, it is not mandatory that the host
+ * calling amok_bw_saturate_stop() is the same than the one which called
+ * amok_bw_saturate_start(), despite what is depicted here.
+ *
+ * \htmlonly
+ * 
+ * Fig 2: AMOK link saturation protocol.
+ * \endhtmlonly
*
* @{
*/
-void amok_bw_init(void);
-void amok_bw_exit(void);
-
-void amok_bw_test(gras_socket_t peer,
- unsigned long int buf_size,unsigned long int exp_size,unsigned long int msg_size,
- /*OUT*/ double *sec, double *bw);
-
-void amok_bw_request(const char* from_name,unsigned int from_port,
- const char* to_name,unsigned int to_port,
- unsigned long int buf_size,unsigned long int exp_size,unsigned long int msg_size,
- /*OUT*/ double *sec, double*bw);
+/* module handling */
-double * amok_bw_matrix(xbt_dynar_t hosts, /* dynar of xbt_host_t */
- int buf_size_bw, int exp_size_bw, int msg_size_bw);
+XBT_PUBLIC(void) amok_bw_init(void);
+XBT_PUBLIC(void) amok_bw_exit(void);
+
+XBT_PUBLIC(void) amok_bw_test(gras_socket_t peer,
+ unsigned long int buf_size,
+ unsigned long int msg_size,
+ unsigned long int msg_amount,
+ double min_duration,
+ /*OUT*/ double *sec, double *bw);
+
+XBT_PUBLIC(void) amok_bw_request(const char *from_name,
+ unsigned int from_port,
+ const char *to_name, unsigned int to_port,
+ unsigned long int buf_size,
+ unsigned long int msg_size,
+ unsigned long int msg_amount,
+ double min_duration, /*OUT*/ double *sec,
+ double *bw);
+
+XBT_PUBLIC(double *) amok_bw_matrix(xbt_dynar_t hosts, /* dynar of xbt_host_t */
+ int buf_size_bw, int msg_size_bw,
+ int msg_amount_bw,
+ double min_duration);
/* ***************************************************************************
* Link saturation
* ***************************************************************************/
-void amok_bw_saturate_start(const char* from_name,unsigned int from_port,
- const char* to_name,unsigned int to_port,
- unsigned int msg_size, unsigned int duration);
+XBT_PUBLIC(void) amok_bw_saturate_start(const char *from_name,
+ unsigned int from_port,
+ const char *to_name,
+ unsigned int to_port,
+ unsigned int msg_size,
+ double duration);
-void amok_bw_saturate_begin(const char* to_name,unsigned int to_port,
- unsigned int msg_size, unsigned int duration,
- /*out*/ double *elapsed, double *bw);
+XBT_PUBLIC(void) amok_bw_saturate_begin(const char *to_name,
+ unsigned int to_port,
+ unsigned int msg_size,
+ double duration,
+ /*out */ double *elapsed,
+ double *bw);
-void amok_bw_saturate_stop(const char* from_name,unsigned int from_port,
- /*out*/ unsigned int *time, unsigned int *bw);
+XBT_PUBLIC(void) amok_bw_saturate_stop(const char *from_name,
+ unsigned int from_port,
+ /*out */ double *time, double *bw);
/** @} */
-#endif /* AMOK_BANDWIDTH_H */
+#endif /* AMOK_BANDWIDTH_H */