src/ats/gnunet-service-ats_addresses_mlp.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_addresses_mlp.c
  23  * @brief ats mlp problem solver
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet-service-ats_addresses.h"
  30 #include "gnunet-service-ats_addresses_mlp.h"
  31 #include "gnunet_statistics_service.h"
  32 #include "glpk.h"
  33
  34 #define WRITE_MLP GNUNET_NO
  35 #define DEBUG_ATS GNUNET_NO
  36 #define VERBOSE_GLPK GNUNET_NO
  37
  38 #define ENABLE_C8 GNUNET_YES
  39 #define ENABLE_C9 GNUNET_YES
  40 /**
  41  * Translate glpk solver error codes to text
  42  * @param retcode return code
  43  * @return string with result
  44  */
  45 const char *
  46 mlp_solve_to_string (int retcode)
  47 {
  48   switch (retcode) {
  49     case 0:
  50       return "ok";
  51       break;
  52     case GLP_EBADB:
  53       return "invalid basis";
  54       break;
  55     case GLP_ESING:
  56       return "singular matrix";
  57       break;
  58     case GLP_ECOND:
  59       return "ill-conditioned matrix";
  60       break;
  61     case GLP_EBOUND:
  62       return "invalid bounds";
  63       break;
  64     case GLP_EFAIL:
  65       return "solver failed";
  66       break;
  67     case GLP_EOBJLL:
  68       return "objective lower limit reached";
  69       break;
  70     case GLP_EOBJUL:
  71       return "objective upper limit reached";
  72       break;
  73     case GLP_EITLIM:
  74       return "iteration limit exceeded";
  75       break;
  76     case GLP_ETMLIM:
  77       return "time limit exceeded";
  78       break;
  79     case GLP_ENOPFS:
  80       return "no primal feasible solution";
  81       break;
  82     case GLP_EROOT:
  83       return "root LP optimum not provided";
  84       break;
  85     case GLP_ESTOP:
  86       return "search terminated by application";
  87       break;
  88     case GLP_EMIPGAP:
  89       return "relative mip gap tolerance reached";
  90       break;
  91     case GLP_ENOFEAS:
  92       return "no dual feasible solution";
  93       break;
  94     case GLP_ENOCVG:
  95       return "no convergence";
  96       break;
  97     case GLP_EINSTAB:
  98       return "numerical instability";
  99       break;
 100     case GLP_EDATA:
 101       return "invalid data";
 102       break;
 103     case GLP_ERANGE:
 104       return "result out of range";
 105       break;
 106     default:
 107       GNUNET_break (0);
 108       return "unknown error";
 109       break;
 110   }
 111   GNUNET_break (0);
 112   return "unknown error";
 113 }
 114
 115
 116 /**
 117  * Translate glpk status error codes to text
 118  * @param retcode return code
 119  * @return string with result
 120  */
 121 const char *
 122 mlp_status_to_string (int retcode)
 123 {
 124   switch (retcode) {
 125     case GLP_UNDEF:
 126       return "solution is undefined";
 127       break;
 128     case GLP_FEAS:
 129       return "solution is feasible";
 130       break;
 131     case GLP_INFEAS:
 132       return "solution is infeasible";
 133       break;
 134     case GLP_NOFEAS:
 135       return "no feasible solution exists";
 136       break;
 137     case GLP_OPT:
 138       return "solution is optimal";
 139       break;
 140     case GLP_UNBND:
 141       return "solution is unbounded";
 142       break;
 143     default:
 144       GNUNET_break (0);
 145       return "unknown error";
 146       break;
 147   }
 148   GNUNET_break (0);
 149   return "unknown error";
 150 }
 151
 152 /**
 153  * Translate ATS properties to text
 154  * Just intended for debugging
 155  *
 156  * @param ats_index the ATS index
 157  * @return string with result
 158  */
 159 const char *
 160 mlp_ats_to_string (int ats_index)
 161 {
 162   switch (ats_index) {
 163     case GNUNET_ATS_ARRAY_TERMINATOR:
 164       return "GNUNET_ATS_ARRAY_TERMINATOR";
 165       break;
 166     case GNUNET_ATS_UTILIZATION_UP:
 167       return "GNUNET_ATS_UTILIZATION_UP";
 168       break;
 169     case GNUNET_ATS_UTILIZATION_DOWN:
 170       return "GNUNET_ATS_UTILIZATION_DOWN";
 171       break;
 172     case GNUNET_ATS_COST_LAN:
 173       return "GNUNET_ATS_COST_LAN";
 174       break;
 175     case GNUNET_ATS_COST_WAN:
 176       return "GNUNET_ATS_COST_LAN";
 177       break;
 178     case GNUNET_ATS_COST_WLAN:
 179       return "GNUNET_ATS_COST_WLAN";
 180       break;
 181     case GNUNET_ATS_NETWORK_TYPE:
 182       return "GNUNET_ATS_NETWORK_TYPE";
 183       break;
 184     case GNUNET_ATS_QUALITY_NET_DELAY:
 185       return "GNUNET_ATS_QUALITY_NET_DELAY";
 186       break;
 187     case GNUNET_ATS_QUALITY_NET_DISTANCE:
 188       return "GNUNET_ATS_QUALITY_NET_DISTANCE";
 189       break;
 190     default:
 191       return "unknown";
 192       break;
 193   }
 194   GNUNET_break (0);
 195   return "unknown error";
 196 }
 197
 198 /**
 199  * Find a peer in the DLL
 200  *
 201  * @param mlp the mlp handle
 202  * @param peer the peer to find
 203  * @return the peer struct
 204  */
 205 static struct ATS_Peer *
 206 mlp_find_peer (struct GAS_MLP_Handle *mlp, const struct GNUNET_PeerIdentity *peer)
 207 {
 208   struct ATS_Peer *res = mlp->peer_head;
 209   while (res != NULL)
 210   {
 211     if (0 == memcmp (peer, &res->id, sizeof (struct GNUNET_PeerIdentity)))
 212       break;
 213     res = res->next;
 214   }
 215   return res;
 216 }
 217
 218 /**
 219  * Intercept GLPK terminal output
 220  * @param info the mlp handle
 221  * @param s the string to print
 222  * @return 0: glpk prints output on terminal, 0 != surpress output
 223  */
 224 static int
 225 mlp_term_hook (void *info, const char *s)
 226 {
 227   /* Not needed atm struct MLP_information *mlp = info; */
 228   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%s", s);
 229   return 1;
 230 }
 231
 232 /**
 233  * Delete the MLP problem and free the constrain matrix
 234  *
 235  * @param mlp the MLP handle
 236  */
 237 static void
 238 mlp_delete_problem (struct GAS_MLP_Handle *mlp)
 239 {
 240   if (mlp != NULL)
 241   {
 242     if (mlp->prob != NULL)
 243       glp_delete_prob(mlp->prob);
 244
 245     /* delete row index */
 246     if (mlp->ia != NULL)
 247     {
 248       GNUNET_free (mlp->ia);
 249       mlp->ia = NULL;
 250     }
 251
 252     /* delete column index */
 253     if (mlp->ja != NULL)
 254     {
 255       GNUNET_free (mlp->ja);
 256       mlp->ja = NULL;
 257     }
 258
 259     /* delete coefficients */
 260     if (mlp->ar != NULL)
 261     {
 262       GNUNET_free (mlp->ar);
 263       mlp->ar = NULL;
 264     }
 265     mlp->ci = 0;
 266     mlp->prob = NULL;
 267   }
 268 }
 269
 270 /**
 271  * Add constraints that are iterating over "forall addresses"
 272  * and collects all existing peers for "forall peers" constraints
 273  *
 274  * @param cls GAS_MLP_Handle
 275  * @param key Hashcode
 276  * @param value ATS_Address
 277  *
 278  * @return GNUNET_OK to continue
 279  */
 280 static int
 281 create_constraint_it (void *cls, const GNUNET_HashCode * key, void *value)
 282 {
 283   struct GAS_MLP_Handle *mlp = cls;
 284   struct ATS_Address *address = value;
 285   struct MLP_information *mlpi;
 286   unsigned int row_index;
 287   char *name;
 288
 289   GNUNET_assert (address->mlp_information != NULL);
 290   mlpi = (struct MLP_information *) address->mlp_information;
 291
 292   /* c 1) bandwidth capping
 293    * b_t  + (-M) * n_t <= 0
 294    */
 295   row_index = glp_add_rows (mlp->prob, 1);
 296   mlpi->r_c1 = row_index;
 297   /* set row name */
 298   GNUNET_asprintf(&name, "c1_%s_%s", GNUNET_i2s(&address->peer), address->plugin);
 299   glp_set_row_name (mlp->prob, row_index, name);
 300   GNUNET_free (name);
 301   /* set row bounds: <= 0 */
 302   glp_set_row_bnds (mlp->prob, row_index, GLP_UP, 0.0, 0.0);
 303   mlp->ia[mlp->ci] = row_index;
 304   mlp->ja[mlp->ci] = mlpi->c_b;
 305   mlp->ar[mlp->ci] = 1;
 306   mlp->ci++;
 307
 308   mlp->ia[mlp->ci] = row_index;
 309   mlp->ja[mlp->ci] = mlpi->c_n;
 310   mlp->ar[mlp->ci] = -mlp->BIG_M;
 311   mlp->ci++;
 312
 313   /* c 3) minimum bandwidth
 314    * b_t + (-n_t * b_min) >= 0
 315    */
 316
 317   row_index = glp_add_rows (mlp->prob, 1);
 318   /* set row name */
 319   GNUNET_asprintf(&name, "c3_%s_%s", GNUNET_i2s(&address->peer), address->plugin);
 320   glp_set_row_name (mlp->prob, row_index, name);
 321   GNUNET_free (name);
 322   mlpi->r_c3 = row_index;
 323   /* set row bounds: >= 0 */
 324   glp_set_row_bnds (mlp->prob, row_index, GLP_LO, 0.0, 0.0);
 325
 326   mlp->ia[mlp->ci] = row_index;
 327   mlp->ja[mlp->ci] = mlpi->c_b;
 328   mlp->ar[mlp->ci] = 1;
 329   mlp->ci++;
 330
 331   mlp->ia[mlp->ci] = row_index;
 332   mlp->ja[mlp->ci] = mlpi->c_n;
 333   mlp->ar[mlp->ci] = - (double) mlp->b_min;
 334   mlp->ci++;
 335
 336   /* c 4) minimum connections
 337    * (1)*n_1 + ... + (1)*n_m >= n_min
 338    */
 339   mlp->ia[mlp->ci] = mlp->r_c4;
 340   mlp->ja[mlp->ci] = mlpi->c_n;
 341   mlp->ar[mlp->ci] = 1;
 342   mlp->ci++;
 343
 344   /* c 6) maximize diversity
 345    * (1)*n_1 + ... + (1)*n_m - d == 0
 346    */
 347   mlp->ia[mlp->ci] = mlp->r_c6;
 348   mlp->ja[mlp->ci] = mlpi->c_n;
 349   mlp->ar[mlp->ci] = 1;
 350   mlp->ci++;
 351
 352   /* c 10) obey network specific quotas
 353    * (1)*b_1 + ... + (1)*b_m <= quota_n
 354    */
 355
 356   int cur_row = 0;
 357   int c;
 358   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
 359     {
 360     if (mlp->quota_index[c] == address->atsp_network_type)
 361     {
 362       cur_row = mlp->r_quota[c];
 363       break;
 364     }
 365   }
 366
 367   if (cur_row != 0)
 368   {
 369     mlp->ia[mlp->ci] = cur_row;
 370     mlp->ja[mlp->ci] = mlpi->c_b;
 371     mlp->ar[mlp->ci] = 1;
 372     mlp->ci++;
 373   }
 374   else
 375   {
 376     GNUNET_break (0);
 377   }
 378
 379   return GNUNET_OK;
 380 }
 381
 382 /**
 383  * Find the required ATS information for an address
 384  *
 385  * @param addr the address
 386  * @param ats_index the desired ATS index
 387  *
 388  * @return the index on success, otherwise GNUNET_SYSERR
 389  */
 390
 391 static int
 392 mlp_lookup_ats (struct ATS_Address *addr, int ats_index)
 393 {
 394   struct GNUNET_ATS_Information * ats = addr->ats;
 395   int c = 0;
 396   int found = GNUNET_NO;
 397   for (c = 0; c < addr->ats_count; c++)
 398   {
 399     if (ats[c].type == ats_index)
 400     {
 401       found = GNUNET_YES;
 402       break;
 403     }
 404   }
 405   if (found == GNUNET_YES)
 406     return c;
 407   else
 408     return GNUNET_SYSERR;
 409 }
 410
 411 /**
 412  * Adds the problem constraints for all addresses
 413  * Required for problem recreation after address deletion
 414  *
 415  * @param mlp the mlp handle
 416  * @param addresses all addresses
 417  */
 418
 419 static void
 420 mlp_add_constraints_all_addresses (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses)
 421 {
 422   unsigned int n_addresses;
 423   int c;
 424   char *name;
 425
 426   /* Problem matrix*/
 427   n_addresses = GNUNET_CONTAINER_multihashmap_size(addresses);
 428
 429   /* Required indices in the constrain matrix
 430    *
 431    * feasibility constraints:
 432    *
 433    * c 1) bandwidth capping
 434    * #rows: |n_addresses|
 435    * #indices: 2 * |n_addresses|
 436    *
 437    * c 2) one active address per peer
 438    * #rows: |peers|
 439    * #indices: |n_addresses|
 440    *
 441    * c 3) minium bandwidth assigned
 442    * #rows: |n_addresses|
 443    * #indices: 2 * |n_addresses|
 444    *
 445    * c 4) minimum number of active connections
 446    * #rows: 1
 447    * #indices: |n_addresses|
 448    *
 449    * c 5) maximum ressource consumption
 450    * #rows: |ressources|
 451    * #indices: |n_addresses|
 452    *
 453    * c 10) obey network specific quota
 454    * #rows: |network types
 455    * #indices: |n_addresses|
 456    *
 457    * Sum for feasibility constraints:
 458    * #rows: 3 * |n_addresses| +  |ressources| + |peers| + 1
 459    * #indices: 7 * |n_addresses|
 460    *
 461    * optimality constraints:
 462    *
 463    * c 6) diversity
 464    * #rows: 1
 465    * #indices: |n_addresses| + 1
 466    *
 467    * c 7) quality
 468    * #rows: |quality properties|
 469    * #indices: |n_addresses| + |quality properties|
 470    *
 471    * c 8) utilization
 472    * #rows: 1
 473    * #indices: |n_addresses| + 1
 474    *
 475    * c 9) relativity
 476    * #rows: |peers|
 477    * #indices: |n_addresses| + |peers|
 478    * */
 479
 480   /* last +1 caused by glpk index starting with one: [1..pi]*/
 481   int pi = ((7 * n_addresses) + (5 * n_addresses +  mlp->m_q + mlp->c_p + 2) + 1);
 482   mlp->cm_size = pi;
 483   mlp->ci = 1;
 484
 485   /* row index */
 486   int *ia = GNUNET_malloc (pi * sizeof (int));
 487   mlp->ia = ia;
 488
 489   /* column index */
 490   int *ja = GNUNET_malloc (pi * sizeof (int));
 491   mlp->ja = ja;
 492
 493   /* coefficient */
 494   double *ar= GNUNET_malloc (pi * sizeof (double));
 495   mlp->ar = ar;
 496
 497   /* Adding constraint rows
 498    * This constraints are kind of "for all addresses"
 499    * Feasibility constraints:
 500    *
 501    * c 1) bandwidth capping
 502    * c 3) minimum bandwidth
 503    * c 4) minimum number of connections
 504    * c 6) maximize diversity
 505    * c 10) obey network specific quota
 506    */
 507
 508   int min = mlp->n_min;
 509   if (mlp->n_min > mlp->c_p)
 510     min = mlp->c_p;
 511
 512   mlp->r_c4 = glp_add_rows (mlp->prob, 1);
 513   glp_set_row_name (mlp->prob, mlp->r_c4, "c4");
 514   glp_set_row_bnds (mlp->prob, mlp->r_c4, GLP_LO, min, min);
 515
 516   /* Add row for c6) */
 517
 518   mlp->r_c6 = glp_add_rows (mlp->prob, 1);
 519   /* Set type type to fix */
 520   glp_set_row_bnds (mlp->prob, mlp->r_c6, GLP_FX, 0.0, 0.0);
 521   /* Setting -D */
 522   ia[mlp->ci] = mlp->r_c6 ;
 523   ja[mlp->ci] = mlp->c_d;
 524   ar[mlp->ci] = -1;
 525   mlp->ci++;
 526
 527   /* Add rows for c 10) */
 528   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
 529   {
 530     mlp->r_quota[c] = glp_add_rows (mlp->prob, 1);
 531     char * text;
 532     GNUNET_asprintf(&text, "quota_ats_%i", mlp->quota_index[c]);
 533     glp_set_row_name (mlp->prob, mlp->r_quota[c], text);
 534     GNUNET_free (text);
 535     /* Set bounds to 0 <= x <= quota_out */
 536     glp_set_row_bnds (mlp->prob, mlp->r_quota[c], GLP_UP, 0.0, mlp->quota_out[c]);
 537   }
 538
 539   GNUNET_CONTAINER_multihashmap_iterate (addresses, create_constraint_it, mlp);
 540
 541   /* Adding constraint rows
 542    * This constraints are kind of "for all peers"
 543    * Feasibility constraints:
 544    *
 545    * c 2) 1 address per peer
 546    * sum (n_p1_1 + ... + n_p1_n) = 1
 547    *
 548    * c 8) utilization
 549    * sum (f_p * b_p1_1 + ... + f_p * b_p1_n) - u = 0
 550    *
 551    * c 9) relativity
 552    * V p : sum (bt_1 + ... +bt_n) - f_p * r = 0
 553    * */
 554
 555   /* Adding rows for c 8) */
 556   mlp->r_c8 = glp_add_rows (mlp->prob, mlp->c_p);
 557   glp_set_row_name (mlp->prob, mlp->r_c8, "c8");
 558   /* Set row bound == 0 */
 559   glp_set_row_bnds (mlp->prob, mlp->r_c8, GLP_FX, 0.0, 0.0);
 560   /* -u */
 561
 562   ia[mlp->ci] = mlp->r_c8;
 563   ja[mlp->ci] = mlp->c_u;
 564   ar[mlp->ci] = -1;
 565   mlp->ci++;
 566
 567   struct ATS_Peer * peer = mlp->peer_head;
 568   while (peer != NULL)
 569   {
 570     struct ATS_Address *addr = peer->head;
 571     struct MLP_information *mlpi = NULL;
 572
 573     /* Adding rows for c 2) */
 574     peer->r_c2 = glp_add_rows (mlp->prob, 1);
 575     GNUNET_asprintf(&name, "c2_%s", GNUNET_i2s(&peer->id));
 576     glp_set_row_name (mlp->prob, peer->r_c2, name);
 577     GNUNET_free (name);
 578     /* Set row bound == 1 */
 579     glp_set_row_bnds (mlp->prob, peer->r_c2, GLP_FX, 1.0, 1.0);
 580
 581     /* Adding rows for c 9) */
 582 #if ENABLE_C9
 583     peer->r_c9 = glp_add_rows (mlp->prob, 1);
 584     GNUNET_asprintf(&name, "c9_%s", GNUNET_i2s(&peer->id));
 585     glp_set_row_name (mlp->prob, peer->r_c9, name);
 586     GNUNET_free (name);
 587     /* Set row bound == 0 */
 588     glp_set_row_bnds (mlp->prob, peer->r_c9, GLP_LO, 0.0, 0.0);
 589
 590     /* Set -r */
 591     ia[mlp->ci] = peer->r_c9;
 592     ja[mlp->ci] = mlp->c_r;
 593     ar[mlp->ci] = -1;
 594     mlp->ci++;
 595 #endif
 596
 597     while (addr != NULL)
 598     {
 599       mlpi = (struct MLP_information *) addr->mlp_information;
 600
 601       /* coefficient for c 2) */
 602
 603       ia[mlp->ci] = peer->r_c2;
 604       ja[mlp->ci] = mlpi->c_n;
 605       ar[mlp->ci] = 1;
 606       mlp->ci++;
 607
 608       /* coefficient for c 8) */
 609       ia[mlp->ci] = mlp->r_c8;
 610       ja[mlp->ci] = mlpi->c_b;
 611       ar[mlp->ci] = peer->f;
 612       mlp->ci++;
 613
 614 #if ENABLE_C9
 615       /* coefficient for c 9) */
 616       ia[mlp->ci] = peer->r_c9;
 617       ja[mlp->ci] = mlpi->c_b;
 618       ar[mlp->ci] = 1;
 619       mlp->ci++;
 620 #endif
 621
 622       addr = addr->next;
 623     }
 624     peer = peer->next;
 625   }
 626
 627   /* c 7) For all quality metrics */
 628
 629
 630   for (c = 0; c < mlp->m_q; c++)
 631   {
 632     struct ATS_Peer *tp;
 633     struct ATS_Address *ta;
 634     struct MLP_information * mlpi;
 635     double value = 1.0;
 636
 637     /* Adding rows for c 7) */
 638     mlp->r_q[c] = glp_add_rows (mlp->prob, 1);
 639     GNUNET_asprintf(&name, "c7_q%i_%s", c, mlp_ats_to_string(mlp->q[c]));
 640     glp_set_row_name (mlp->prob, mlp->r_q[c], name);
 641     GNUNET_free (name);
 642     /* Set row bound == 0 */
 643     glp_set_row_bnds (mlp->prob, mlp->r_q[c], GLP_LO, 0.0, 0.0);
 644
 645     ia[mlp->ci] = mlp->r_q[c];
 646     ja[mlp->ci] = mlp->c_q[c];
 647     ar[mlp->ci] = -1;
 648     mlp->ci++;
 649
 650     for (tp = mlp->peer_head; tp != NULL; tp = tp->next)
 651       for (ta = tp->head; ta != NULL; ta = ta->next)
 652         {
 653           mlpi = ta->mlp_information;
 654           value = mlpi->q_averaged[c];
 655
 656           mlpi->r_q[c] = mlp->r_q[c];
 657
 658           ia[mlp->ci] = mlp->r_q[c];
 659           ja[mlp->ci] = mlpi->c_b;
 660           ar[mlp->ci] = tp->f * value;
 661           mlp->ci++;
 662         }
 663   }
 664 }
 665
 666
 667 /**
 668  * Add columns for all addresses
 669  *
 670  * @param cls GAS_MLP_Handle
 671  * @param key Hashcode
 672  * @param value ATS_Address
 673  *
 674  * @return GNUNET_OK to continue
 675  */
 676 static int
 677 create_columns_it (void *cls, const GNUNET_HashCode * key, void *value)
 678 {
 679   struct GAS_MLP_Handle *mlp = cls;
 680   struct ATS_Address *address = value;
 681   struct MLP_information *mlpi;
 682   unsigned int col;
 683   char *name;
 684
 685   GNUNET_assert (address->mlp_information != NULL);
 686   mlpi = address->mlp_information;
 687
 688   /* Add bandwidth column */
 689   col = glp_add_cols (mlp->prob, 2);
 690   mlpi->c_b = col;
 691   mlpi->c_n = col + 1;
 692
 693
 694   GNUNET_asprintf (&name, "b_%s_%s", GNUNET_i2s (&address->peer), address->plugin);
 695   glp_set_col_name (mlp->prob, mlpi->c_b , name);
 696   GNUNET_free (name);
 697   /* Lower bound == 0 */
 698   glp_set_col_bnds (mlp->prob, mlpi->c_b , GLP_LO, 0.0, 0.0);
 699   /* Continuous value*/
 700   glp_set_col_kind (mlp->prob, mlpi->c_b , GLP_CV);
 701   /* Objective function coefficient == 0 */
 702   glp_set_obj_coef (mlp->prob, mlpi->c_b , 0);
 703
 704
 705   /* Add usage column */
 706   GNUNET_asprintf (&name, "n_%s_%s", GNUNET_i2s (&address->peer), address->plugin);
 707   glp_set_col_name (mlp->prob, mlpi->c_n, name);
 708   GNUNET_free (name);
 709   /* Limit value : 0 <= value <= 1 */
 710   glp_set_col_bnds (mlp->prob, mlpi->c_n, GLP_DB, 0.0, 1.0);
 711   /* Integer value*/
 712   glp_set_col_kind (mlp->prob, mlpi->c_n, GLP_IV);
 713   /* Objective function coefficient == 0 */
 714   glp_set_obj_coef (mlp->prob, mlpi->c_n, 0);
 715
 716   return GNUNET_OK;
 717 }
 718
 719
 720
 721 /**
 722  * Create the MLP problem
 723  *
 724  * @param mlp the MLP handle
 725  * @param addresses the hashmap containing all adresses
 726  * @return GNUNET_OK or GNUNET_SYSERR
 727  */
 728 static int
 729 mlp_create_problem (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses)
 730 {
 731   int res = GNUNET_OK;
 732   int col;
 733   int c;
 734   char *name;
 735
 736   GNUNET_assert (mlp->prob == NULL);
 737
 738   /* create the glpk problem */
 739   mlp->prob = glp_create_prob ();
 740
 741   /* Set a problem name */
 742   glp_set_prob_name (mlp->prob, "gnunet ats bandwidth distribution");
 743
 744   /* Set optimization direction to maximize */
 745   glp_set_obj_dir (mlp->prob, GLP_MAX);
 746
 747   /* Adding invariant columns */
 748
 749   /* Diversity d column  */
 750
 751   col = glp_add_cols (mlp->prob, 1);
 752   mlp->c_d = col;
 753   /* Column name */
 754   glp_set_col_name (mlp->prob, col, "d");
 755   /* Column objective function coefficient */
 756   glp_set_obj_coef (mlp->prob, col, mlp->co_D);
 757   /* Column lower bound = 0.0 */
 758   glp_set_col_bnds (mlp->prob, col, GLP_LO, 0.0, 0.0);
 759
 760   /* Utilization u column  */
 761
 762   col = glp_add_cols (mlp->prob, 1);
 763   mlp->c_u = col;
 764   /* Column name */
 765   glp_set_col_name (mlp->prob, col, "u");
 766   /* Column objective function coefficient */
 767   glp_set_obj_coef (mlp->prob, col, mlp->co_U);
 768   /* Column lower bound = 0.0 */
 769   glp_set_col_bnds (mlp->prob, col, GLP_LO, 0.0, 0.0);
 770
 771 #if ENABLE_C9
 772   /* Relativity r column  */
 773   col = glp_add_cols (mlp->prob, 1);
 774   mlp->c_r = col;
 775   /* Column name */
 776   glp_set_col_name (mlp->prob, col, "r");
 777   /* Column objective function coefficient */
 778   glp_set_obj_coef (mlp->prob, col, mlp->co_R);
 779   /* Column lower bound = 0.0 */
 780   glp_set_col_bnds (mlp->prob, col, GLP_LO, 0.0, 0.0);
 781 #endif
 782
 783   /* Quality metric columns */
 784   col = glp_add_cols(mlp->prob, mlp->m_q);
 785   for (c = 0; c < mlp->m_q; c++)
 786   {
 787     mlp->c_q[c] = col + c;
 788     GNUNET_asprintf (&name, "q_%u", mlp->q[c]);
 789     glp_set_col_name (mlp->prob, col + c, name);
 790     /* Column lower bound = 0.0 */
 791     glp_set_col_bnds (mlp->prob, col + c, GLP_LO, 0.0, 0.0);
 792     GNUNET_free (name);
 793     /* Coefficient == Qm */
 794     glp_set_obj_coef (mlp->prob, col + c, mlp->co_Q[c]);
 795   }
 796
 797   /* Add columns for addresses */
 798   GNUNET_CONTAINER_multihashmap_iterate (addresses, create_columns_it, mlp);
 799
 800   /* Add constraints */
 801   mlp_add_constraints_all_addresses (mlp, addresses);
 802
 803   /* Load the matrix */
 804   glp_load_matrix(mlp->prob, (mlp->ci-1), mlp->ia, mlp->ja, mlp->ar);
 805
 806   return res;
 807 }
 808
 809 /**
 810  * Solves the LP problem
 811  *
 812  * @param mlp the MLP Handle
 813  * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
 814  */
 815 static int
 816 mlp_solve_lp_problem (struct GAS_MLP_Handle *mlp)
 817 {
 818   int res;
 819   struct GNUNET_TIME_Relative duration;
 820   struct GNUNET_TIME_Absolute end;
 821   struct GNUNET_TIME_Absolute start = GNUNET_TIME_absolute_get();
 822
 823   /* LP presolver?
 824    * Presolver is required if the problem was modified and an existing
 825    * valid basis is now invalid */
 826   if (mlp->presolver_required == GNUNET_YES)
 827     mlp->control_param_lp.presolve = GLP_ON;
 828   else
 829     mlp->control_param_lp.presolve = GLP_OFF;
 830
 831   /* Solve LP problem to have initial valid solution */
 832 lp_solv:
 833   res = glp_simplex(mlp->prob, &mlp->control_param_lp);
 834   if (res == 0)
 835   {
 836     /* The LP problem instance has been successfully solved. */
 837   }
 838   else if (res == GLP_EITLIM)
 839   {
 840     /* simplex iteration limit has been exceeded. */
 841     // TODO Increase iteration limit?
 842   }
 843   else if (res == GLP_ETMLIM)
 844   {
 845     /* Time limit has been exceeded.  */
 846     // TODO Increase time limit?
 847   }
 848   else
 849   {
 850     /* Problem was ill-defined, retry with presolver */
 851     if (mlp->presolver_required == GNUNET_NO)
 852     {
 853       mlp->presolver_required = GNUNET_YES;
 854       goto lp_solv;
 855     }
 856     else
 857     {
 858       /* Problem was ill-defined, no way to handle that */
 859       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 860           "ats-mlp",
 861           "Solving LP problem failed: %i %s\n", res, mlp_solve_to_string(res));
 862       return GNUNET_SYSERR;
 863     }
 864   }
 865
 866   end = GNUNET_TIME_absolute_get ();
 867   duration = GNUNET_TIME_absolute_get_difference (start, end);
 868   mlp->lp_solved++;
 869   mlp->lp_total_duration =+ duration.rel_value;
 870
 871   GNUNET_STATISTICS_update (mlp->stats,"# LP problem solved", 1, GNUNET_NO);
 872   GNUNET_STATISTICS_set (mlp->stats,"# LP execution time", duration.rel_value, GNUNET_NO);
 873   GNUNET_STATISTICS_set (mlp->stats,"# LP execution time average",
 874                          mlp->lp_total_duration / mlp->lp_solved,  GNUNET_NO);
 875
 876
 877   /* Analyze problem status  */
 878   res = glp_get_status (mlp->prob);
 879   switch (res) {
 880     /* solution is optimal */
 881     case GLP_OPT:
 882     /* solution is feasible */
 883     case GLP_FEAS:
 884       break;
 885
 886     /* Problem was ill-defined, no way to handle that */
 887     default:
 888       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 889           "ats-mlp",
 890           "Solving LP problem failed, no solution: %s\n", mlp_status_to_string(res));
 891       return GNUNET_SYSERR;
 892       break;
 893   }
 894
 895   /* solved sucessfully, no presolver required next time */
 896   mlp->presolver_required = GNUNET_NO;
 897
 898   return GNUNET_OK;
 899 }
 900
 901
 902 /**
 903  * Solves the MLP problem
 904  *
 905  * @param mlp the MLP Handle
 906  * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
 907  */
 908 int
 909 mlp_solve_mlp_problem (struct GAS_MLP_Handle *mlp)
 910 {
 911   int res;
 912   struct GNUNET_TIME_Relative duration;
 913   struct GNUNET_TIME_Absolute end;
 914   struct GNUNET_TIME_Absolute start = GNUNET_TIME_absolute_get();
 915
 916   /* solve MLP problem */
 917   res = glp_intopt(mlp->prob, &mlp->control_param_mlp);
 918
 919   if (res == 0)
 920   {
 921     /* The MLP problem instance has been successfully solved. */
 922   }
 923   else if (res == GLP_EITLIM)
 924   {
 925     /* simplex iteration limit has been exceeded. */
 926     // TODO Increase iteration limit?
 927   }
 928   else if (res == GLP_ETMLIM)
 929   {
 930     /* Time limit has been exceeded.  */
 931     // TODO Increase time limit?
 932   }
 933   else
 934   {
 935     /* Problem was ill-defined, no way to handle that */
 936     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 937         "ats-mlp",
 938         "Solving MLP problem failed:  %s\n", mlp_solve_to_string(res));
 939     return GNUNET_SYSERR;
 940   }
 941
 942   end = GNUNET_TIME_absolute_get ();
 943   duration = GNUNET_TIME_absolute_get_difference (start, end);
 944   mlp->mlp_solved++;
 945   mlp->mlp_total_duration =+ duration.rel_value;
 946
 947   GNUNET_STATISTICS_update (mlp->stats,"# MLP problem solved", 1, GNUNET_NO);
 948   GNUNET_STATISTICS_set (mlp->stats,"# MLP execution time", duration.rel_value, GNUNET_NO);
 949   GNUNET_STATISTICS_set (mlp->stats,"# MLP execution time average",
 950                          mlp->mlp_total_duration / mlp->mlp_solved,  GNUNET_NO);
 951
 952   /* Analyze problem status  */
 953   res = glp_mip_status(mlp->prob);
 954   switch (res) {
 955     /* solution is optimal */
 956     case GLP_OPT:
 957     /* solution is feasible */
 958     case GLP_FEAS:
 959       break;
 960
 961     /* Problem was ill-defined, no way to handle that */
 962     default:
 963       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 964           "ats-mlp",
 965           "Solving MLP problem failed, %s\n\n", mlp_status_to_string(res));
 966       return GNUNET_SYSERR;
 967       break;
 968   }
 969
 970   return GNUNET_OK;
 971 }
 972
 973 int GAS_mlp_solve_problem (struct GAS_MLP_Handle *mlp);
 974
 975 static void
 976 mlp_scheduler (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 977 {
 978   struct GAS_MLP_Handle *mlp = cls;
 979
 980   mlp->mlp_task = GNUNET_SCHEDULER_NO_TASK;
 981
 982   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 983     return;
 984
 985
 986   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Scheduled problem solving\n");
 987
 988   if (mlp->addr_in_problem != 0)
 989     GAS_mlp_solve_problem(mlp);
 990 }
 991
 992
 993 /**
 994  * Solves the MLP problem
 995  *
 996  * @param mlp the MLP Handle
 997  * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
 998  */
 999 int
1000 GAS_mlp_solve_problem (struct GAS_MLP_Handle *mlp)
1001 {
1002   int res;
1003   mlp->last_execution = GNUNET_TIME_absolute_get ();
1004
1005   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Problem solving\n");
1006
1007
1008 #if WRITE_MLP
1009   char * name;
1010   static int i;
1011   i++;
1012   GNUNET_asprintf(&name, "problem_%i", i);
1013   glp_write_lp (mlp->prob, 0, name);
1014   GNUNET_free (name);
1015 # endif
1016
1017   res = mlp_solve_lp_problem (mlp);
1018
1019 #if WRITE_MLP
1020   GNUNET_asprintf(&name, "problem_%i_lp_solution", i);
1021   glp_print_sol (mlp->prob,  name);
1022   GNUNET_free (name);
1023 # endif
1024
1025   if (res != GNUNET_OK)
1026   {
1027
1028   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "LP Problem solving failed\n");
1029
1030     return GNUNET_SYSERR;
1031   }
1032
1033   res = mlp_solve_mlp_problem (mlp);
1034
1035 #if WRITE_MLP
1036   GNUNET_asprintf(&name, "problem_%i_mlp_solution", i);
1037   glp_print_mip (mlp->prob, name);
1038   GNUNET_free (name);
1039 # endif
1040   if (res != GNUNET_OK)
1041   {
1042
1043   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MLP Problem solving failed\n");
1044
1045     return GNUNET_SYSERR;
1046   }
1047
1048
1049   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Problem solved\n");
1050   /* Process result */
1051   struct ATS_Peer *p = NULL;
1052   struct ATS_Address *a = NULL;
1053   struct MLP_information *mlpi = NULL;
1054
1055   for (p = mlp->peer_head; p != NULL; p = p->next)
1056   {
1057     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s'\n", GNUNET_i2s (&p->id));
1058     for (a = p->head; a != NULL; a = a->next)
1059     {
1060       double b = 0.0;
1061       double n = 0.0;
1062
1063       mlpi = a->mlp_information;
1064
1065       b = glp_mip_col_val(mlp->prob, mlpi->c_b);
1066       mlpi->b = b;
1067
1068       n = glp_mip_col_val(mlp->prob, mlpi->c_n);
1069       if (n == 1.0)
1070         mlpi->n = GNUNET_YES;
1071       else
1072         mlpi->n = GNUNET_NO;
1073
1074       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "\tAddress %s %f\n",
1075           (n == 1.0) ? "[x]" : "[ ]", b);
1076     }
1077   }
1078
1079   if (mlp->mlp_task != GNUNET_SCHEDULER_NO_TASK)
1080   {
1081     GNUNET_SCHEDULER_cancel(mlp->mlp_task);
1082     mlp->mlp_task = GNUNET_SCHEDULER_NO_TASK;
1083   }
1084   mlp->mlp_task = GNUNET_SCHEDULER_add_delayed (mlp->exec_interval, &mlp_scheduler, mlp);
1085   return res;
1086 }
1087
1088 /**
1089  * Init the MLP problem solving component
1090  *
1091  * @param cfg the GNUNET_CONFIGURATION_Handle handle
1092  * @param stats the GNUNET_STATISTICS handle
1093  * @param max_duration maximum numbers of iterations for the LP/MLP Solver
1094  * @param max_iterations maximum time limit for the LP/MLP Solver
1095  * @return struct GAS_MLP_Handle * on success, NULL on fail
1096  */
1097 struct GAS_MLP_Handle *
1098 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1099               const struct GNUNET_STATISTICS_Handle *stats,
1100               struct GNUNET_TIME_Relative max_duration,
1101               unsigned int max_iterations)
1102 {
1103   struct GAS_MLP_Handle * mlp = GNUNET_malloc (sizeof (struct GAS_MLP_Handle));
1104
1105   double D;
1106   double R;
1107   double U;
1108   long long unsigned int tmp;
1109   unsigned int b_min;
1110   unsigned int n_min;
1111   struct GNUNET_TIME_Relative i_exec;
1112   int c;
1113   char * quota_out_str;
1114   char * quota_in_str;
1115
1116   /* Init GLPK environment */
1117   GNUNET_assert (glp_init_env() == 0);
1118
1119   /* Create initial MLP problem */
1120   mlp->prob = glp_create_prob();
1121   GNUNET_assert (mlp->prob != NULL);
1122
1123   mlp->BIG_M = (double) BIG_M_VALUE;
1124
1125   /* Get diversity coefficient from configuration */
1126   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1127                                                       "COEFFICIENT_D",
1128                                                       &tmp))
1129     D = (double) tmp / 100;
1130   else
1131     D = 1.0;
1132
1133   /* Get proportionality coefficient from configuration */
1134   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1135                                                       "COEFFICIENT_R",
1136                                                       &tmp))
1137     R = (double) tmp / 100;
1138   else
1139     R = 1.0;
1140
1141   /* Get utilization coefficient from configuration */
1142   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1143                                                       "COEFFICIENT_U",
1144                                                       &tmp))
1145     U = (double) tmp / 100;
1146   else
1147     U = 1.0;
1148
1149   /* Get quality metric coefficients from configuration */
1150   int i_delay = -1;
1151   int i_distance = -1;
1152   int q[GNUNET_ATS_QualityPropertiesCount] = GNUNET_ATS_QualityProperties;
1153   for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1154   {
1155     /* initialize quality coefficients with default value 1.0 */
1156     mlp->co_Q[c] = 1.0;
1157
1158     mlp->q[c] = q[c];
1159     if (q[c] == GNUNET_ATS_QUALITY_NET_DELAY)
1160       i_delay = c;
1161     if (q[c] == GNUNET_ATS_QUALITY_NET_DISTANCE)
1162       i_distance = c;
1163   }
1164
1165   if ((i_delay != -1) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1166                                                       "COEFFICIENT_QUALITY_DELAY",
1167                                                       &tmp)))
1168
1169     mlp->co_Q[i_delay] = (double) tmp / 100;
1170   else
1171     mlp->co_Q[i_delay] = 1.0;
1172
1173   if ((i_distance != -1) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1174                                                       "COEFFICIENT_QUALITY_DISTANCE",
1175                                                       &tmp)))
1176     mlp->co_Q[i_distance] = (double) tmp / 100;
1177   else
1178     mlp->co_Q[i_distance] = 1.0;
1179
1180   /* Get minimum bandwidth per used address from configuration */
1181   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1182                                                       "MIN_BANDWIDTH",
1183                                                       &tmp))
1184     b_min = tmp;
1185   else
1186   {
1187     b_min = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1188   }
1189
1190   /* Get minimum number of connections from configuration */
1191   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1192                                                       "MIN_CONNECTIONS",
1193                                                       &tmp))
1194     n_min = tmp;
1195   else
1196     n_min = 4;
1197
1198   /* Init network quotas */
1199   int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1200   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1201   {
1202     mlp->quota_index[c] = quotas[c];
1203     static char * entry_in = NULL;
1204     static char * entry_out = NULL;
1205     unsigned long long quota_in = 0;
1206     unsigned long long quota_out = 0;
1207
1208     switch (quotas[c]) {
1209       case GNUNET_ATS_NET_UNSPECIFIED:
1210         entry_out = "UNSPECIFIED_QUOTA_OUT";
1211         entry_in = "UNSPECIFIED_QUOTA_IN";
1212         break;
1213       case GNUNET_ATS_NET_LOOPBACK:
1214         entry_out = "LOOPBACK_QUOTA_OUT";
1215         entry_in = "LOOPBACK_QUOTA_IN";
1216         break;
1217       case GNUNET_ATS_NET_LAN:
1218         entry_out = "LAN_QUOTA_OUT";
1219         entry_in = "LAN_QUOTA_IN";
1220         break;
1221       case GNUNET_ATS_NET_WAN:
1222         entry_out = "WAN_QUOTA_OUT";
1223         entry_in = "WAN_QUOTA_IN";
1224         break;
1225       case GNUNET_ATS_NET_WLAN:
1226         entry_out = "WLAN_QUOTA_OUT";
1227         entry_in = "WLAN_QUOTA_IN";
1228         break;
1229       default:
1230         break;
1231     }
1232
1233     if ((entry_in == NULL) || (entry_out == NULL))
1234       continue;
1235
1236     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
1237     {
1238       if (0 == strcmp(quota_out_str, BIG_M_STRING) ||
1239           (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &quota_out)))
1240         quota_out = mlp->BIG_M;
1241
1242       GNUNET_free (quota_out_str);
1243       quota_out_str = NULL;
1244     }
1245     else if (GNUNET_ATS_NET_UNSPECIFIED == quotas[c])
1246     {
1247       quota_out = 0;
1248     }
1249     else
1250     {
1251       quota_out = mlp->BIG_M;
1252     }
1253
1254     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
1255     {
1256       if (0 == strcmp(quota_in_str, BIG_M_STRING) ||
1257           (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &quota_in)))
1258         quota_in = mlp->BIG_M;
1259
1260       GNUNET_free (quota_in_str);
1261       quota_in_str = NULL;
1262     }
1263     else if (GNUNET_ATS_NET_UNSPECIFIED == quotas[c])
1264     {
1265       quota_in = 0;
1266     }
1267     else
1268     {
1269       quota_in = mlp->BIG_M;
1270     }
1271
1272     /* Check if defined quota could make problem unsolvable */
1273     if (((n_min * b_min) > quota_out) && (GNUNET_ATS_NET_UNSPECIFIED != quotas[c]))
1274     {
1275       GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Inconsistent quota configuration value `%s': " \
1276           "outbound quota (%u Bps) too small for combination of minimum connections and minimum bandwidth per peer (%u * %u Bps = %u)\n", entry_out, quota_out, n_min, b_min, n_min * b_min);
1277
1278       GAS_mlp_done(mlp);
1279       mlp = NULL;
1280       return NULL;
1281     }
1282
1283     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Found `%s' quota %llu and `%s' quota %llu\n",
1284                 entry_out, quota_out, entry_in, quota_in);
1285     GNUNET_STATISTICS_update ((struct GNUNET_STATISTICS_Handle *) stats, entry_out, quota_out, GNUNET_NO);
1286     GNUNET_STATISTICS_update ((struct GNUNET_STATISTICS_Handle *) stats, entry_in, quota_in, GNUNET_NO);
1287     mlp->quota_out[c] = quota_out;
1288     mlp->quota_in[c] = quota_in;
1289   }
1290
1291   /* Get minimum number of connections from configuration */
1292   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_time (cfg, "ats",
1293                                                         "ATS_EXEC_INTERVAL",
1294                                                         &i_exec))
1295     mlp->exec_interval = i_exec;
1296   else
1297     mlp->exec_interval = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30);
1298
1299   mlp->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1300   mlp->max_iterations = max_iterations;
1301   mlp->max_exec_duration = max_duration;
1302   mlp->auto_solve = GNUNET_YES;
1303
1304   /* Redirect GLPK output to GNUnet logging */
1305   glp_error_hook((void *) mlp, &mlp_term_hook);
1306
1307   /* Init LP solving parameters */
1308   glp_init_smcp(&mlp->control_param_lp);
1309
1310   mlp->control_param_lp.msg_lev = GLP_MSG_OFF;
1311 #if VERBOSE_GLPK
1312   mlp->control_param_lp.msg_lev = GLP_MSG_ALL;
1313 #endif
1314
1315   mlp->control_param_lp.it_lim = max_iterations;
1316   mlp->control_param_lp.tm_lim = max_duration.rel_value;
1317
1318   /* Init MLP solving parameters */
1319   glp_init_iocp(&mlp->control_param_mlp);
1320
1321   mlp->control_param_mlp.msg_lev = GLP_MSG_OFF;
1322 #if VERBOSE_GLPK
1323   mlp->control_param_mlp.msg_lev = GLP_MSG_ALL;
1324 #endif
1325   mlp->control_param_mlp.tm_lim = max_duration.rel_value;
1326
1327   mlp->last_execution = GNUNET_TIME_absolute_get_forever();
1328
1329   mlp->co_D = D;
1330   mlp->co_R = R;
1331   mlp->co_U = U;
1332   mlp->b_min = b_min;
1333   mlp->n_min = n_min;
1334   mlp->m_q = GNUNET_ATS_QualityPropertiesCount;
1335
1336   return mlp;
1337 }
1338
1339 static void
1340 update_quality (struct GAS_MLP_Handle *mlp, struct ATS_Address * address)
1341 {
1342   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating quality metrics for peer `%s'\n",
1343       GNUNET_i2s (&address->peer));
1344
1345   struct MLP_information *mlpi = address->mlp_information;
1346   struct GNUNET_ATS_Information *ats = address->ats;
1347   GNUNET_assert (mlpi != NULL);
1348
1349   int c;
1350
1351   for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1352   {
1353     int index = mlp_lookup_ats(address, mlp->q[c]);
1354
1355     if (index == GNUNET_SYSERR)
1356       continue;
1357
1358     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating address for peer `%s' value `%s': %f\n",
1359         GNUNET_i2s (&address->peer),
1360         mlp_ats_to_string(mlp->q[c]),
1361         (double) ats[index].value);
1362
1363     int i = mlpi->q_avg_i[c];
1364     double * qp = mlpi->q[c];
1365     qp[i] = (double) ats[index].value;
1366
1367     int t;
1368     for (t = 0; t < MLP_AVERAGING_QUEUE_LENGTH; t++)
1369     {
1370       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s': `%s' queue[%u]: %f\n",
1371         GNUNET_i2s (&address->peer),
1372         mlp_ats_to_string(mlp->q[c]),
1373         t,
1374         qp[t]);
1375     }
1376
1377     if (mlpi->q_avg_i[c] + 1 < (MLP_AVERAGING_QUEUE_LENGTH))
1378       mlpi->q_avg_i[c] ++;
1379     else
1380       mlpi->q_avg_i[c] = 0;
1381
1382
1383     int c2;
1384     int c3;
1385     double avg = 0.0;
1386     switch (mlp->q[c])
1387     {
1388       case GNUNET_ATS_QUALITY_NET_DELAY:
1389         c3 = 0;
1390         for (c2 = 0; c2 < MLP_AVERAGING_QUEUE_LENGTH; c2++)
1391         {
1392           if (mlpi->q[c][c2] != -1)
1393           {
1394             double * t2 = mlpi->q[c] ;
1395             avg += t2[c2];
1396             c3 ++;
1397           }
1398         }
1399         if (c3 > 0)
1400           /* avg = 1 / ((q[0] + ... + q[l]) /c3) => c3 / avg*/
1401           mlpi->q_averaged[c] = (double) c3 / avg;
1402         else
1403           mlpi->q_averaged[c] = 0.0;
1404
1405         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s': `%s' average sum: %f, average: %f, weight: %f\n",
1406           GNUNET_i2s (&address->peer),
1407           mlp_ats_to_string(mlp->q[c]),
1408           avg,
1409           avg / (double) c3,
1410           mlpi->q_averaged[c]);
1411
1412         break;
1413       case GNUNET_ATS_QUALITY_NET_DISTANCE:
1414         c3 = 0;
1415         for (c2 = 0; c2 < MLP_AVERAGING_QUEUE_LENGTH; c2++)
1416         {
1417           if (mlpi->q[c][c2] != -1)
1418           {
1419             double * t2 = mlpi->q[c] ;
1420             avg += t2[c2];
1421             c3 ++;
1422           }
1423         }
1424         if (c3 > 0)
1425           /* avg = 1 / ((q[0] + ... + q[l]) /c3) => c3 / avg*/
1426           mlpi->q_averaged[c] = (double) c3 / avg;
1427         else
1428           mlpi->q_averaged[c] = 0.0;
1429
1430         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s': `%s' average sum: %f, average: %f, weight: %f\n",
1431           GNUNET_i2s (&address->peer),
1432           mlp_ats_to_string(mlp->q[c]),
1433           avg,
1434           avg / (double) c3,
1435           mlpi->q_averaged[c]);
1436
1437         break;
1438       default:
1439         break;
1440     }
1441
1442     if ((mlpi->c_b != 0) && (mlpi->r_q[c] != 0))
1443     {
1444
1445       /* Get current number of columns */
1446       int found = GNUNET_NO;
1447       int cols = glp_get_num_cols(mlp->prob);
1448       int *ind = GNUNET_malloc (cols * sizeof (int) + 1);
1449       double *val = GNUNET_malloc (cols * sizeof (double) + 1);
1450
1451       /* Get the matrix row of quality */
1452       int length = glp_get_mat_row(mlp->prob, mlp->r_q[c], ind, val);
1453       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "cols %i, length %i c_b %i\n", cols, length, mlpi->c_b);
1454       int c4;
1455       /* Get the index if matrix row of quality */
1456       for (c4 = 1; c4 <= length; c4++ )
1457       {
1458         if (mlpi->c_b == ind[c4])
1459         {
1460           /* Update the value */
1461           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating quality `%s' column `%s' row `%s' : %f -> %f\n",
1462               mlp_ats_to_string(mlp->q[c]),
1463               glp_get_col_name (mlp->prob, ind[c4]),
1464               glp_get_row_name (mlp->prob, mlp->r_q[c]),
1465               val[c4],
1466               mlpi->q_averaged[c]);
1467           val[c4] = mlpi->q_averaged[c];
1468           found = GNUNET_YES;
1469           break;
1470         }
1471       }
1472
1473       if (found == GNUNET_NO)
1474         {
1475
1476           ind[length+1] = mlpi->c_b;
1477           val[length+1] = mlpi->q_averaged[c];
1478           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%i ind[%i] val[%i]:  %i %f\n", length+1,  length+1, length+1, mlpi->c_b, mlpi->q_averaged[c]);
1479           glp_set_mat_row (mlp->prob, mlpi->r_q[c], length+1, ind, val);
1480         }
1481       else
1482         {
1483         /* Get the index if matrix row of quality */
1484         glp_set_mat_row (mlp->prob, mlpi->r_q[c], length, ind, val);
1485         }
1486
1487       GNUNET_free (ind);
1488       GNUNET_free (val);
1489     }
1490   }
1491 }
1492
1493 /**
1494  * Updates a single address in the MLP problem
1495  *
1496  * If the address did not exist before in the problem:
1497  * The MLP problem has to be recreated and the problem has to be resolved
1498  *
1499  * Otherwise the addresses' values can be updated and the existing base can
1500  * be reused
1501  *
1502  * @param mlp the MLP Handle
1503  * @param addresses the address hashmap
1504  *        the address has to be already removed from the hashmap
1505  * @param address the address to update
1506  */
1507 void
1508 GAS_mlp_address_update (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address)
1509 {
1510   int new;
1511   struct MLP_information *mlpi;
1512
1513   GNUNET_STATISTICS_update (mlp->stats,"# LP address updates", 1, GNUNET_NO);
1514
1515   /* We add a new address */
1516   if (address->mlp_information == NULL)
1517     new = GNUNET_YES;
1518   else
1519     new = GNUNET_NO;
1520
1521   /* Do the update */
1522   if (new == GNUNET_YES)
1523   {
1524     mlpi = GNUNET_malloc (sizeof (struct MLP_information));
1525
1526     int c;
1527     for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1528     {
1529       int c2;
1530       mlpi->r_q[c] = 0;
1531       for (c2 = 0; c2 < MLP_AVERAGING_QUEUE_LENGTH; c2++)
1532         mlpi->q[c][c2] = -1.0; /* -1.0: invalid value */
1533       mlpi->q_avg_i[c] = 0;
1534       mlpi->q_averaged[c] = 0.0;
1535     }
1536
1537     address->mlp_information = mlpi;
1538     mlp->addr_in_problem ++;
1539
1540     /* Check for and add peer */
1541     struct ATS_Peer *peer = mlp_find_peer (mlp, &address->peer);
1542     if (peer == NULL)
1543     {
1544
1545       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding new peer `%s'\n",
1546           GNUNET_i2s (&address->peer));
1547
1548       peer = GNUNET_malloc (sizeof (struct ATS_Peer));
1549       peer->head = NULL;
1550       peer->tail = NULL;
1551
1552       int c;
1553       for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1554       {
1555         peer->f_q[c] = 1.0;
1556       }
1557       peer->f = 1.0;
1558
1559       memcpy (&peer->id, &address->peer, sizeof (struct GNUNET_PeerIdentity));
1560       GNUNET_assert(address->prev == NULL);
1561       GNUNET_assert(address->next == NULL);
1562       GNUNET_CONTAINER_DLL_insert (peer->head, peer->tail, address);
1563       GNUNET_CONTAINER_DLL_insert (mlp->peer_head, mlp->peer_tail, peer);
1564       mlp->c_p ++;
1565     }
1566     else
1567     {
1568
1569       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding address to peer `%s'\n",
1570           GNUNET_i2s (&address->peer));
1571
1572       GNUNET_CONTAINER_DLL_insert (peer->head, peer->tail, address);
1573     }
1574
1575     update_quality (mlp, address);
1576   }
1577   else
1578   {
1579     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating existing address to peer `%s'\n",
1580         GNUNET_i2s (&address->peer));
1581
1582     update_quality (mlp, address);
1583   }
1584
1585   /* Recalculate */
1586   if (new == GNUNET_YES)
1587   {
1588     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Recreating problem: new address\n");
1589
1590     mlp_delete_problem (mlp);
1591     mlp_create_problem (mlp, addresses);
1592     mlp->presolver_required = GNUNET_YES;
1593   }
1594   if (mlp->auto_solve == GNUNET_YES)
1595     GAS_mlp_solve_problem (mlp);
1596 }
1597
1598 /**
1599  * Deletes a single address in the MLP problem
1600  *
1601  * The MLP problem has to be recreated and the problem has to be resolved
1602  *
1603  * @param mlp the MLP Handle
1604  * @param addresses the address hashmap
1605  *        the address has to be already removed from the hashmap
1606  * @param address the address to delete
1607  */
1608 void
1609 GAS_mlp_address_delete (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address)
1610 {
1611   GNUNET_STATISTICS_update (mlp->stats,"# LP address deletions", 1, GNUNET_NO);
1612
1613   /* Free resources */
1614   if (address->mlp_information != NULL)
1615   {
1616     GNUNET_free (address->mlp_information);
1617     address->mlp_information = NULL;
1618
1619     mlp->addr_in_problem --;
1620   }
1621
1622   /* Remove from peer list */
1623   struct ATS_Peer *head = mlp_find_peer (mlp, &address->peer);
1624   GNUNET_assert (head != NULL);
1625
1626   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Deleting address for `%s'\n", GNUNET_i2s (&address->peer));
1627
1628   GNUNET_CONTAINER_DLL_remove (head->head, head->tail, address);
1629   if ((head->head == NULL) && (head->tail == NULL))
1630   {
1631     /* No address for peer left, remove peer */
1632
1633     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Deleting peer `%s'\n", GNUNET_i2s (&address->peer));
1634
1635     GNUNET_CONTAINER_DLL_remove (mlp->peer_head, mlp->peer_tail, head);
1636     GNUNET_free (head);
1637     mlp->c_p --;
1638   }
1639
1640   /* Update problem */
1641   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Recreating problem: new address\n");
1642
1643   mlp_delete_problem (mlp);
1644   if ((GNUNET_CONTAINER_multihashmap_size (addresses) > 0) && (mlp->c_p > 0))
1645   {
1646     mlp_create_problem (mlp, addresses);
1647
1648     /* Recalculate */
1649     mlp->presolver_required = GNUNET_YES;
1650     if (mlp->auto_solve == GNUNET_YES)
1651       GAS_mlp_solve_problem (mlp);
1652   }
1653 }
1654
1655 static int
1656 mlp_get_preferred_address_it (void *cls, const GNUNET_HashCode * key, void *value)
1657 {
1658
1659   struct ATS_PreferedAddress *aa = (struct ATS_PreferedAddress *) cls;
1660   struct ATS_Address *addr = value;
1661   struct MLP_information *mlpi = addr->mlp_information;
1662   if (mlpi == NULL)
1663     return GNUNET_YES;
1664   if (mlpi->n == GNUNET_YES)
1665   {
1666     aa->address = addr;
1667     if (mlpi->b > (double) UINT32_MAX)
1668       aa->bandwidth_out = UINT32_MAX;
1669     else
1670       aa->bandwidth_out = (uint32_t) mlpi->b;
1671     aa->bandwidth_in = 0;
1672     return GNUNET_NO;
1673   }
1674   return GNUNET_YES;
1675 }
1676
1677
1678 /**
1679  * Get the preferred address for a specific peer
1680  *
1681  * @param mlp the MLP Handle
1682  * @param addresses address hashmap
1683  * @param peer the peer
1684  * @return suggested address
1685  */
1686 struct ATS_PreferedAddress *
1687 GAS_mlp_get_preferred_address (struct GAS_MLP_Handle *mlp,
1688                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
1689                                const struct GNUNET_PeerIdentity *peer)
1690 {
1691   struct ATS_PreferedAddress * aa = GNUNET_malloc (sizeof (struct ATS_PreferedAddress));
1692   aa->address = NULL;
1693   aa->bandwidth_in = 0;
1694   aa->bandwidth_out = 0;
1695   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Getting preferred address for `%s'\n", GNUNET_i2s (peer));
1696   GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey, mlp_get_preferred_address_it, aa);
1697   return aa;
1698 }
1699
1700
1701 /**
1702  * Changes the preferences for a peer in the MLP problem
1703  *
1704  * @param mlp the MLP Handle
1705  * @param peer the peer
1706  * @param kind the kind to change the preference
1707  * @param score the score
1708  */
1709 void
1710 GAS_mlp_address_change_preference (struct GAS_MLP_Handle *mlp,
1711                                    const struct GNUNET_PeerIdentity *peer,
1712                                    enum GNUNET_ATS_PreferenceKind kind,
1713                                    float score)
1714 {
1715   GNUNET_STATISTICS_update (mlp->stats,"# LP address preference changes", 1, GNUNET_NO);
1716
1717   struct ATS_Peer *p = mlp_find_peer (mlp, peer);
1718   p = p;
1719   /* Here we have to do the matching */
1720 }
1721
1722 /**
1723  * Shutdown the MLP problem solving component
1724  * @param mlp the MLP handle
1725  */
1726 void
1727 GAS_mlp_done (struct GAS_MLP_Handle *mlp)
1728 {
1729   struct ATS_Peer * peer;
1730   struct ATS_Peer * tmp;
1731
1732   GNUNET_assert (mlp != NULL);
1733
1734   if (mlp->mlp_task != GNUNET_SCHEDULER_NO_TASK)
1735   {
1736     GNUNET_SCHEDULER_cancel(mlp->mlp_task);
1737     mlp->mlp_task = GNUNET_SCHEDULER_NO_TASK;
1738   }
1739
1740   /* clean up peer list */
1741   peer = mlp->peer_head;
1742   while (peer != NULL)
1743   {
1744     GNUNET_CONTAINER_DLL_remove(mlp->peer_head, mlp->peer_tail, peer);
1745     tmp = peer->next;
1746     GNUNET_free (peer);
1747     peer = tmp;
1748   }
1749   mlp_delete_problem (mlp);
1750
1751   /* Clean up GLPK environment */
1752   glp_free_env();
1753
1754   GNUNET_free (mlp);
1755 }
1756
1757
1758 /* end of gnunet-service-ats_addresses_mlp.c */