[GNUnet-SVN] r32055 - gnunet/src/ats

[gnunet]

Author: wachs
Date: 2014-01-28 10:18:27 +0100 (Tue, 28 Jan 2014)
New Revision: 32055

Modified:
   gnunet/src/ats/perf_ats_solver.c
Log:
documentation for the performance benchmark


Modified: gnunet/src/ats/perf_ats_solver.c
===================================================================
--- gnunet/src/ats/perf_ats_solver.c    2014-01-28 09:01:26 UTC (rev 32054)
+++ gnunet/src/ats/perf_ats_solver.c    2014-01-28 09:18:27 UTC (rev 32055)
@@ -191,49 +191,155 @@
   int expecting_solution;
 };
 
+/**
+ * Data structure to store results for a single iteration
+ */
 struct Iteration
 {
+  /**
+   * Head of the linked list
+   */
   struct Result *result_head;
 
+  /**
+   * Tail of the linked list
+   */
   struct Result *result_tail;
 };
 
+
+/**
+ * Result for a solver calculcation
+ */
 struct Result
 {
+  /**
+   * Previous element in the linked list
+   */
   struct Result *prev;
+
+  /**
+   * Next element in the linked list
+   */
   struct Result *next;
 
+  /**
+   * Number of peers this solution included
+   */
   int peers;
+
+  /**
+   * Number of addresses per peer this solution included
+   */
   int addresses;
+
+  /**
+   * Is this an update or a full solution
+   */
   int update;
+
+  /**
+   * Was the solution valid or did the solver fail
+   */
   int valid;
 
+  /**
+   * Result of the solver
+   */
   enum GAS_Solver_Additional_Information info;
 
+  /**
+   * Duration of setting up the problem in the solver
+   */
   struct GNUNET_TIME_Relative d_setup;
+
+  /**
+   * Duration of solving the LP problem in the solver
+   * MLP solver only
+   */
   struct GNUNET_TIME_Relative d_lp;
+
+  /**
+   * Duration of solving the MLP problem in the solver
+   * MLP solver only
+   */
   struct GNUNET_TIME_Relative d_mlp;
+
+  /**
+   * Duration of solving whole problem in the solver
+   */
   struct GNUNET_TIME_Relative d_total;
 
+  /**
+   * Start time of setting up the problem in the solver
+   */
   struct GNUNET_TIME_Absolute s_setup;
+
+  /**
+   * Start time of solving the LP problem in the solver
+   * MLP solver only
+   */
   struct GNUNET_TIME_Absolute s_lp;
+
+  /**
+   * Start time of solving the MLP problem in the solver
+   * MLP solver only
+   */
   struct GNUNET_TIME_Absolute s_mlp;
+
+  /**
+   * Start time of solving whole problem in the solver
+   */
   struct GNUNET_TIME_Absolute s_total;
 
+  /**
+   * End time of setting up the problem in the solver
+   */
   struct GNUNET_TIME_Absolute e_setup;
+
+  /**
+   * End time of solving the LP problem in the solver
+   * MLP solver only
+   */
   struct GNUNET_TIME_Absolute e_lp;
+
+  /**
+   * End time of solving the MLP problem in the solver
+   * MLP solver only
+   */
   struct GNUNET_TIME_Absolute e_mlp;
+
+  /**
+   * End time of solving whole problem in the solver
+   */
   struct GNUNET_TIME_Absolute e_total;
 };
 
+/**
+ * Peer used for the benchmarking
+ */
 struct PerfPeer
 {
+  /**
+   * Peer identitity
+   */
   struct GNUNET_PeerIdentity id;
 
+  /**
+   * Head of linked list of addresses used with this peer
+   */
   struct ATS_Address *head;
+
+  /**
+   * Head of linked list of addresses used with this peer
+   */
   struct ATS_Address *tail;
 };
 
+
+/**
+ * ATS performance handle
+ */
 static struct PerfHandle ph;
 
 /**
@@ -241,13 +347,6 @@
  */
 static int ret;
 
-
-/**
- * ATS information
- */
-//static struct GNUNET_ATS_Information ats[2];
-
-
 static void
 end_now (int res)
 {