src/ats/plugin_ats_ril.c

   1 /*
   2  This file is part of GNUnet.
   3  Copyright (C) 2011-2014 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/plugin_ats_ril.c
  23  * @brief ATS reinforcement learning solver
  24  * @author Fabian Oehlmann
  25  * @author Matthias Wachs
  26  */
  27 #include "platform.h"
  28 #include <float.h>
  29 #include <math.h>
  30 #include "gnunet_ats_plugin.h"
  31 #include "gnunet-service-ats_addresses.h"
  32
  33
  34
  35 #define LOG(kind,...) GNUNET_log_from (kind, "ats-ril",__VA_ARGS__)
  36
  37 #define RIL_MIN_BW                      (5 * ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__))
  38 #define RIL_MAX_BW                      GNUNET_ATS_MaxBandwidth
  39
  40 #define RIL_ACTION_INVALID              -1
  41 #define RIL_INTERVAL_EXPONENT           10
  42 #define RIL_UTILITY_DELAY_MAX           1000
  43
  44 #define RIL_DEFAULT_STEP_TIME_MIN       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 200)
  45 #define RIL_DEFAULT_STEP_TIME_MAX       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 2000)
  46 #define RIL_DEFAULT_ALGORITHM           RIL_ALGO_SARSA
  47 #define RIL_DEFAULT_SELECT              RIL_SELECT_SOFTMAX
  48 #define RIL_DEFAULT_WELFARE             RIL_WELFARE_NASH
  49 #define RIL_DEFAULT_DISCOUNT_BETA       0.6
  50 #define RIL_DEFAULT_DISCOUNT_GAMMA      0.5
  51 #define RIL_DEFAULT_GRADIENT_STEP_SIZE  0.01
  52 #define RIL_DEFAULT_TRACE_DECAY         0.5
  53 #define RIL_DEFAULT_EXPLORE_RATIO       1
  54 #define RIL_DEFAULT_EXPLORE_DECAY       0.95
  55 #define RIL_DEFAULT_RBF_DIVISOR         50
  56 #define RIL_DEFAULT_TEMPERATURE         0.1
  57 #define RIL_DEFAULT_TEMPERATURE_DECAY   1
  58
  59 #define RIL_INC_DEC_STEP_SIZE           1
  60 #define RIL_NOP_DECAY                   0.5
  61
  62 /**
  63  * ATS reinforcement learning solver
  64  *
  65  * General description
  66  */
  67
  68 /**
  69  * The actions, how an agent can manipulate the current assignment. I.e. how the bandwidth can be
  70  * changed for the currently chosen address. Not depicted in the enum are the actions of switching
  71  * to a particular address. The action of switching to address with index i is depicted by the
  72  * number (RIL_ACTION_TYPE_NUM + i).
  73  */
  74 enum RIL_Action_Type
  75 {
  76   RIL_ACTION_NOTHING = 0,
  77   RIL_ACTION_BW_IN_DBL = -2, //TODO? Potentially add more actions
  78   RIL_ACTION_BW_IN_HLV = -3,
  79   RIL_ACTION_BW_IN_INC = 1,
  80   RIL_ACTION_BW_IN_DEC = 2,
  81   RIL_ACTION_BW_OUT_DBL = -4,
  82   RIL_ACTION_BW_OUT_HLV = -5,
  83   RIL_ACTION_BW_OUT_INC = 3,
  84   RIL_ACTION_BW_OUT_DEC = 4,
  85   RIL_ACTION_TYPE_NUM = 5
  86 };
  87
  88 enum RIL_Algorithm
  89 {
  90   RIL_ALGO_SARSA = 0,
  91   RIL_ALGO_Q = 1
  92 };
  93
  94 enum RIL_Select
  95 {
  96   RIL_SELECT_SOFTMAX = 0,
  97   RIL_SELECT_EGREEDY = 1
  98 };
  99
 100 enum RIL_Welfare
 101 {
 102   RIL_WELFARE_NASH,
 103   RIL_WELFARE_EGALITARIAN
 104 };
 105
 106 enum RIL_E_Modification
 107 {
 108   RIL_E_DECAY,
 109   RIL_E_ZERO,
 110   RIL_E_ACCUMULATE,
 111   RIL_E_REPLACE
 112 };
 113
 114 /**
 115  * Global learning parameters
 116  */
 117 struct RIL_Learning_Parameters
 118 {
 119   /**
 120    * The TD-algorithm to use
 121    */
 122   enum RIL_Algorithm algorithm;
 123
 124   /**
 125    * Gradient-descent step-size
 126    */
 127   double alpha;
 128
 129   /**
 130    * Learning discount variable in the TD-update for semi-MDPs
 131    */
 132   double beta;
 133
 134   /**
 135    * Learning discount factor in the TD-update for MDPs
 136    */
 137   double gamma;
 138
 139   /**
 140    * Trace-decay factor for eligibility traces
 141    */
 142   double lambda;
 143
 144   /**
 145    * Whether to accumulate or replace eligibility traces
 146    */
 147   enum RIL_E_Modification eligibility_trace_mode;
 148
 149   /**
 150    * Initial softmax action-selection temperature
 151    */
 152   double temperature_init;
 153
 154   /**
 155    * Softmax action-selection temperature
 156    */
 157   double temperature;
 158
 159   /**
 160    * Decay factor of the temperature value
 161    */
 162   double temperature_decay;
 163
 164   /**
 165    * Which measure of social welfare should be used
 166    */
 167   enum RIL_Welfare social_welfare;
 168
 169   /**
 170    * State space divisor
 171    */
 172   unsigned long long rbf_divisor;
 173
 174   /**
 175    * Action selection strategy;
 176    */
 177   enum RIL_Select select;
 178
 179   /**
 180    * Initial exploration ratio value
 181    */
 182   double epsilon_init;
 183
 184   /**
 185    * Ratio, with what probability an agent should explore in the e-greed policy
 186    */
 187   double epsilon;
 188
 189   /**
 190    * Decay factor of the explore ratio
 191    */
 192   double epsilon_decay;
 193
 194   /**
 195    * Minimal interval time between steps in milliseconds
 196    */
 197   struct GNUNET_TIME_Relative step_time_min;
 198
 199   /**
 200    * Maximum interval time between steps in milliseconds
 201    */
 202   struct GNUNET_TIME_Relative step_time_max;
 203 };
 204
 205 /**
 206  * Wrapper for addresses to store them in agent's linked list
 207  */
 208 struct RIL_Address_Wrapped
 209 {
 210   /**
 211    * Next in DLL
 212    */
 213   struct RIL_Address_Wrapped *next;
 214
 215   /**
 216    * Previous in DLL
 217    */
 218   struct RIL_Address_Wrapped *prev;
 219
 220   /**
 221    * The address
 222    */
 223   struct ATS_Address *address_naked;
 224 };
 225
 226
 227 struct RIL_Peer_Agent
 228 {
 229   /**
 230    * Next agent in solver's linked list
 231    */
 232   struct RIL_Peer_Agent *next;
 233
 234   /**
 235    * Previous agent in solver's linked list
 236    */
 237   struct RIL_Peer_Agent *prev;
 238
 239   /**
 240    * Environment handle
 241    */
 242   struct GAS_RIL_Handle *envi;
 243
 244   /**
 245    * Peer ID
 246    */
 247   struct GNUNET_PeerIdentity peer;
 248
 249   /**
 250    * Whether the agent is active or not
 251    */
 252   int is_active;
 253
 254   /**
 255    * Number of performed time-steps
 256    */
 257   unsigned long long step_count;
 258
 259   /**
 260    * Experience matrix W
 261    */
 262   double ** W;
 263
 264   /**
 265    * Number of rows of W / Number of state-vector features
 266    */
 267   unsigned int m;
 268
 269   /**
 270    * Number of columns of W / Number of actions
 271    */
 272   unsigned int n;
 273
 274   /**
 275    * Last perceived state feature vector
 276    */
 277   double *s_old;
 278
 279   /**
 280    * Last chosen action
 281    */
 282   int a_old;
 283
 284   /**
 285    * Eligibility traces
 286    */
 287   double ** E;
 288
 289   /**
 290    * Whether to reset the eligibility traces to 0 after a Q-exploration step
 291    */
 292   int eligibility_reset;
 293
 294   /**
 295    * Address in use
 296    */
 297   struct ATS_Address *address_inuse;
 298
 299   /**
 300    * Head of addresses DLL
 301    */
 302   struct RIL_Address_Wrapped *addresses_head;
 303
 304   /**
 305    * Tail of addresses DLL
 306    */
 307   struct RIL_Address_Wrapped *addresses_tail;
 308
 309   /**
 310    * Inbound bandwidth assigned by the agent
 311    */
 312   uint32_t bw_in;
 313
 314   /**
 315    * Outbound bandwidth assigned by the agent
 316    */
 317   uint32_t bw_out;
 318
 319   /**
 320    * Flag whether a suggestion has to be issued
 321    */
 322   int suggestion_issue;
 323
 324   /**
 325    * The address which has to be issued
 326    */
 327   struct ATS_Address *suggestion_address;
 328
 329   /**
 330    * The agent's last objective value
 331    */
 332   double objective_old;
 333
 334   /**
 335    * NOP bonus
 336    */
 337   double nop_bonus;
 338 };
 339
 340 struct RIL_Scope
 341 {
 342   /**
 343    * ATS network type
 344    */
 345   enum GNUNET_ATS_Network_Type type;
 346
 347   /**
 348    * Total available inbound bandwidth
 349    */
 350   uint32_t bw_in_available;
 351
 352   /**
 353    * Bandwidth inbound assigned in network after last step
 354    */
 355   uint32_t bw_in_assigned;
 356
 357   /**
 358    * Bandwidth inbound actually utilized in the network
 359    */
 360   uint32_t bw_in_utilized;
 361
 362   /**
 363    * Total available outbound bandwidth
 364    */
 365   uint32_t bw_out_available;
 366
 367   /**
 368    * Bandwidth outbound assigned in network after last step
 369    */
 370   unsigned long long bw_out_assigned;
 371
 372   /**
 373    * Bandwidth outbound actually utilized in the network
 374    */
 375   unsigned long long bw_out_utilized;
 376
 377   /**
 378    * Number of active agents in scope
 379    */
 380   unsigned int active_agent_count;
 381
 382   /**
 383    * The social welfare achieved in the scope
 384    */
 385   double social_welfare;
 386 };
 387
 388 /**
 389  * A handle for the reinforcement learning solver
 390  */
 391 struct GAS_RIL_Handle
 392 {
 393   /**
 394    * The solver-plugin environment of the solver-plugin API
 395    */
 396   struct GNUNET_ATS_PluginEnvironment *env;
 397
 398   /**
 399    * Number of performed steps
 400    */
 401   unsigned long long step_count;
 402
 403   /**
 404    * Timestamp for the last time-step
 405    */
 406   struct GNUNET_TIME_Absolute step_time_last;
 407
 408   /**
 409    * Task identifier of the next time-step to be executed
 410    */
 411   struct GNUNET_SCHEDULER_Task * step_next_task_id;
 412
 413   /**
 414    * Variable discount factor, dependent on time between steps
 415    */
 416   double global_discount_variable;
 417
 418   /**
 419    * Integrated variable discount factor, dependent on time between steps
 420    */
 421   double global_discount_integrated;
 422
 423   /**
 424    * Lock for bulk operations
 425    */
 426   int bulk_lock;
 427
 428   /**
 429    * Number of changes during a lock
 430    */
 431   int bulk_changes;
 432
 433   /**
 434    * Learning parameters
 435    */
 436   struct RIL_Learning_Parameters parameters;
 437
 438   /**
 439    * Array of networks with global assignment state
 440    */
 441   struct RIL_Scope * network_entries;
 442
 443   /**
 444    * Networks count
 445    */
 446   unsigned int networks_count;
 447
 448   /**
 449    * List of active peer-agents
 450    */
 451   struct RIL_Peer_Agent * agents_head;
 452   struct RIL_Peer_Agent * agents_tail;
 453
 454   /**
 455    * Shutdown
 456    */
 457   int done;
 458
 459   /**
 460    * Simulate steps, i.e. schedule steps immediately
 461    */
 462   unsigned long long simulate;
 463 };
 464
 465 /*
 466  *  "Private" functions
 467  *  ---------------------------
 468  */
 469
 470 /**
 471  * Estimate the current action-value for state s and action a
 472  *
 473  * @param agent agent performing the estimation
 474  * @param state s
 475  * @param action a
 476  * @return estimation value
 477  */
 478 static double
 479 agent_q (struct RIL_Peer_Agent *agent,
 480          const double *state,
 481          int action)
 482 {
 483   unsigned int i;
 484   double result = 0.0;
 485
 486   for (i = 0; i < agent->m; i++)
 487     result += state[i] * agent->W[action][i];
 488
 489   /* prevent crashes if learning diverges */
 490   if (isnan(result))
 491       return isnan(result) * UINT32_MAX;
 492   if (isinf(result))
 493     return isinf(result) * UINT32_MAX;
 494   return result;
 495 }
 496
 497
 498 /**
 499  * Get the index of the address in the agent's list.
 500  *
 501  * @param agent agent handle
 502  * @param address address handle
 503  * @return the index, starting with zero
 504  */
 505 static int
 506 agent_address_get_index (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
 507 {
 508   int i;
 509   struct RIL_Address_Wrapped *cur;
 510
 511   i = -1;
 512   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
 513   {
 514     i++;
 515     if (cur->address_naked == address)
 516       return i;
 517   }
 518   return i;
 519 }
 520
 521
 522 /**
 523  * Gets the wrapped address from the agent's list
 524  *
 525  * @param agent agent handle
 526  * @param address address handle
 527  * @return wrapped address
 528  */
 529 static struct RIL_Address_Wrapped *
 530 agent_address_get_wrapped (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
 531 {
 532   struct RIL_Address_Wrapped *cur;
 533
 534   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
 535     if (cur->address_naked == address)
 536       return cur;
 537   return NULL;
 538 }
 539
 540
 541 static int
 542 agent_action_is_possible (struct RIL_Peer_Agent *agent, int action)
 543 {
 544   int address_index;
 545
 546   switch (action)
 547   {
 548   case RIL_ACTION_NOTHING:
 549     return GNUNET_YES;
 550     break;
 551   case RIL_ACTION_BW_IN_INC:
 552   case RIL_ACTION_BW_IN_DBL:
 553     if (agent->bw_in >= RIL_MAX_BW)
 554       return GNUNET_NO;
 555     else
 556       return GNUNET_YES;
 557     break;
 558   case RIL_ACTION_BW_IN_DEC:
 559   case RIL_ACTION_BW_IN_HLV:
 560     if (agent->bw_in <= 0)
 561       return GNUNET_NO;
 562     else
 563       return GNUNET_YES;
 564     break;
 565   case RIL_ACTION_BW_OUT_INC:
 566   case RIL_ACTION_BW_OUT_DBL:
 567     if (agent->bw_out >= RIL_MAX_BW)
 568       return GNUNET_NO;
 569     else
 570       return GNUNET_YES;
 571     break;
 572   case RIL_ACTION_BW_OUT_DEC:
 573   case RIL_ACTION_BW_OUT_HLV:
 574     if (agent->bw_out <= 0)
 575       return GNUNET_NO;
 576     else
 577       return GNUNET_YES;
 578     break;
 579   default:
 580     if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
 581     {
 582       address_index = action - RIL_ACTION_TYPE_NUM;
 583
 584       GNUNET_assert(address_index >= 0);
 585       GNUNET_assert(
 586           address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
 587
 588       if ((agent_address_get_index(agent, agent->address_inuse) == address_index) ||
 589           agent->address_inuse->active)
 590         return GNUNET_NO;
 591       else
 592         return GNUNET_YES;
 593       break;
 594     }
 595     // error - action does not exist
 596     GNUNET_assert(GNUNET_NO);
 597   }
 598 }
 599
 600
 601 /**
 602  * Gets the action, with the maximal estimated Q-value (i.e. the one currently estimated to bring the
 603  * most reward in the future)
 604  *
 605  * @param agent agent performing the calculation
 606  * @param state the state from which to take the action
 607  * @return the action promising most future reward
 608  */
 609 static int
 610 agent_get_action_max (struct RIL_Peer_Agent *agent, double *state)
 611 {
 612   int i;
 613   int max_i = RIL_ACTION_INVALID;
 614   double cur_q;
 615   double max_q = -DBL_MAX;
 616
 617   for (i = 0; i < agent->n; i++)
 618   {
 619     if (agent_action_is_possible(agent, i))
 620     {
 621       cur_q = agent_q (agent, state, i);
 622       if (cur_q > max_q)
 623       {
 624         max_q = cur_q;
 625         max_i = i;
 626       }
 627     }
 628   }
 629
 630   GNUNET_assert(RIL_ACTION_INVALID != max_i);
 631
 632   return max_i;
 633 }
 634
 635 /**
 636  * Chooses a random action from the set of possible ones
 637  *
 638  * @param agent the agent performing the action
 639  * @return the action index
 640  */
 641 static int
 642 agent_get_action_random (struct RIL_Peer_Agent *agent)
 643 {
 644   int i;
 645   int is_possible[agent->n];
 646   int sum = 0;
 647   int r;
 648
 649   for (i = 0; i<agent->n; i++)
 650   {
 651     if (agent_action_is_possible(agent, i))
 652     {
 653       is_possible[i] = GNUNET_YES;
 654       sum++;
 655     }
 656     else
 657     {
 658       is_possible[i] = GNUNET_NO;
 659     }
 660   }
 661
 662   r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, sum);
 663
 664   sum = -1;
 665   for (i = 0; i<agent->n; i++)
 666   {
 667     if (is_possible[i])
 668     {
 669       sum++;
 670       if (sum == r)
 671         return i;
 672     }
 673   }
 674
 675   GNUNET_assert(GNUNET_NO);
 676   return RIL_ACTION_INVALID;
 677 }
 678
 679
 680 /**
 681  * Updates the weights (i.e. coefficients) of the weight vector in matrix W for action a
 682  *
 683  * @param agent the agent performing the update
 684  * @param reward the reward received for the last action
 685  * @param s_next the new state, the last step got the agent into
 686  * @param a_prime the new
 687  */
 688 static void
 689 agent_update (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a_prime)
 690 {
 691   int i;
 692   int k;
 693   double delta;
 694   double **theta = agent->W;
 695
 696   delta = agent->envi->global_discount_integrated * reward; //reward
 697   delta += agent->envi->global_discount_variable * agent_q (agent, s_next, a_prime); //discounted future value
 698   delta -= agent_q (agent, agent->s_old, agent->a_old); //one step
 699
 700 //  LOG(GNUNET_ERROR_TYPE_INFO, "update()   Step# %llu  Q(s,a): %f  a: %f  r: %f  y: %f  Q(s+1,a+1) = %f  delta: %f\n",
 701 //      agent->step_count,
 702 //      agent_q (agent, agent->s_old, agent->a_old),
 703 //      agent->envi->parameters.alpha,
 704 //      reward,
 705 //      agent->envi->global_discount_variable,
 706 //      agent_q (agent, s_next, a_prime),
 707 //      delta);
 708
 709   for (k = 0; k < agent->n; k++)
 710   {
 711     for (i = 0; i < agent->m; i++)
 712     {
 713   //    LOG(GNUNET_ERROR_TYPE_INFO, "alpha = %f   delta = %f   e[%d] = %f\n",
 714   //        agent->envi->parameters.alpha,
 715   //        delta,
 716   //        i,
 717   //        agent->e[i]);
 718       theta[k][i] += agent->envi->parameters.alpha * delta * agent->E[k][i];
 719     }
 720   }
 721 }
 722
 723
 724 /**
 725  * Changes the eligibility trace vector e in various manners:
 726  * #RIL_E_ACCUMULATE - adds @a feature to each component as in accumulating eligibility traces
 727  * #RIL_E_REPLACE - resets each component to @a feature  as in replacing traces
 728  * #RIL_E_DECAY - multiplies e with discount factor and lambda as in the update rule
 729  * #RIL_E_ZERO - sets e to 0 as in Watkin's Q-learning algorithm when exploring and when initializing
 730  *
 731  * @param agent the agent handle
 732  * @param mod the kind of modification
 733  * @param feature the feature vector
 734  * @param action the action to take
 735  */
 736 static void
 737 agent_modify_eligibility (struct RIL_Peer_Agent *agent,
 738                           enum RIL_E_Modification mod,
 739                           double *feature,
 740                           int action)
 741 {
 742   int i;
 743   int k;
 744
 745   for (i = 0; i < agent->m; i++)
 746   {
 747     switch (mod)
 748     {
 749     case RIL_E_ACCUMULATE:
 750       agent->E[action][i] += feature[i];
 751       break;
 752     case RIL_E_REPLACE:
 753       agent->E[action][i] = agent->E[action][i] > feature[i] ? agent->E[action][i] : feature[i];
 754       break;
 755     case RIL_E_DECAY:
 756       for (k = 0; k < agent->n; k++)
 757       {
 758         agent->E[k][i] *= agent->envi->global_discount_variable * agent->envi->parameters.lambda;
 759       }
 760       break;
 761     case RIL_E_ZERO:
 762       for (k = 0; k < agent->n; k++)
 763       {
 764         agent->E[k][i] = 0;
 765       }
 766       break;
 767     }
 768   }
 769 }
 770
 771 /**
 772  * Informs the environment about the status of the solver
 773  *
 774  * @param solver
 775  * @param op
 776  * @param stat
 777  */
 778 static void
 779 ril_inform (struct GAS_RIL_Handle *solver,
 780             enum GAS_Solver_Operation op,
 781             enum GAS_Solver_Status stat)
 782 {
 783   solver->env->info_cb (solver->env->cls,
 784                         op,
 785                         stat,
 786                         GAS_INFO_NONE);
 787 }
 788
 789 /**
 790  * Calculates the maximum bandwidth an agent can assign in a network scope
 791  *
 792  * @param net
 793  */
 794 static unsigned long long
 795 ril_get_max_bw (struct RIL_Scope *net)
 796 {
 797   return GNUNET_MIN(2 * GNUNET_MAX(net->bw_in_available, net->bw_out_available), GNUNET_ATS_MaxBandwidth);
 798 }
 799
 800 /**
 801  * Changes the active assignment suggestion of the handler and invokes the bw_changed callback to
 802  * notify ATS of its new decision
 803  *
 804  * @param solver solver handle
 805  * @param agent agent handle
 806  * @param new_address the address which is to be used
 807  * @param new_bw_in the new amount of inbound bandwidth set for this address
 808  * @param new_bw_out the new amount of outbound bandwidth set for this address
 809  * @param silent disables invocation of the bw_changed callback, if #GNUNET_YES
 810  */
 811 static void
 812 envi_set_active_suggestion (struct GAS_RIL_Handle *solver,
 813     struct RIL_Peer_Agent *agent,
 814     struct ATS_Address *new_address,
 815     unsigned long long new_bw_in,
 816     unsigned long long new_bw_out,
 817     int silent)
 818 {
 819   int notify = GNUNET_NO;
 820
 821   LOG(GNUNET_ERROR_TYPE_DEBUG,
 822       "    set_active_suggestion() for peer '%s'\n",
 823       GNUNET_i2s (&agent->peer));
 824
 825   //address change
 826   if (agent->address_inuse != new_address)
 827   {
 828     if (NULL != agent->address_inuse)
 829     {
 830       agent->address_inuse->active = GNUNET_NO;
 831       agent->address_inuse->assigned_bw_in = 0;
 832       agent->address_inuse->assigned_bw_out = 0;
 833     }
 834     if (NULL != new_address)
 835     {
 836       LOG(GNUNET_ERROR_TYPE_DEBUG, "    set address active: %s\n", agent->is_active ? "yes" : "no");
 837       new_address->active = agent->is_active;
 838       new_address->assigned_bw_in = agent->bw_in;
 839       new_address->assigned_bw_out = agent->bw_out;
 840     }
 841     notify |= GNUNET_YES;
 842   }
 843
 844   if (new_address)
 845   {
 846     //activity change
 847     if (new_address->active != agent->is_active)
 848     {
 849       new_address->active = agent->is_active;
 850       notify |= GNUNET_YES;
 851     }
 852
 853     //bw change
 854     if (agent->bw_in != new_bw_in)
 855     {
 856       agent->bw_in = new_bw_in;
 857       new_address->assigned_bw_in = new_bw_in;
 858       notify |= GNUNET_YES;
 859     }
 860     if (agent->bw_out != new_bw_out)
 861     {
 862       agent->bw_out = new_bw_out;
 863       new_address->assigned_bw_out = new_bw_out;
 864       notify |= GNUNET_YES;
 865     }
 866   }
 867
 868   if (notify && agent->is_active && (GNUNET_NO == silent))
 869   {
 870     if (new_address)
 871     {
 872       LOG(GNUNET_ERROR_TYPE_DEBUG, "    envi_set_active_suggestion() notify\n");
 873       agent->suggestion_issue = GNUNET_YES;
 874       agent->suggestion_address = new_address;
 875     }
 876     else if (agent->address_inuse)
 877     {
 878       /* disconnect case, no new address */
 879       GNUNET_assert(0 ==  agent->address_inuse->assigned_bw_in);
 880       GNUNET_assert(0 == agent->address_inuse->assigned_bw_out);
 881       agent->bw_in = 0;
 882       agent->bw_out = 0;
 883
 884       agent->suggestion_issue = GNUNET_YES;
 885       agent->suggestion_address = agent->address_inuse;
 886     }
 887   }
 888   agent->address_inuse = new_address;
 889 }
 890
 891
 892 /**
 893  * Allocates a state vector and fills it with the features present
 894  * @param solver the solver handle
 895  * @param agent the agent handle
 896  * @return pointer to the state vector
 897  */
 898 static double *
 899 envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
 900 {
 901   double *state;
 902   double y[2];
 903   double x[2];
 904   double d[2];
 905   double sigma;
 906   double f;
 907   int m;
 908   int i;
 909   int k;
 910   unsigned long long max_bw;
 911
 912   state = GNUNET_malloc (sizeof(double) * agent->m);
 913
 914   max_bw = ril_get_max_bw((struct RIL_Scope *) agent->address_inuse->solver_information);
 915
 916   y[0] = (double) agent->bw_out;
 917   y[1] = (double) agent->bw_in;
 918
 919   m = agent_address_get_index (agent, agent->address_inuse) * (solver->parameters.rbf_divisor+1) * (solver->parameters.rbf_divisor+1);
 920   for (i = 0; i <= solver->parameters.rbf_divisor; i++)
 921   {
 922     for (k = 0; k <= solver->parameters.rbf_divisor; k++)
 923     {
 924       x[0] = (double) i * (double) max_bw / (double) solver->parameters.rbf_divisor;
 925       x[1] = (double) k * (double) max_bw / (double) solver->parameters.rbf_divisor;
 926       d[0] = x[0]-y[0];
 927       d[1] = x[1]-y[1];
 928       sigma = (((double) max_bw / ((double) solver->parameters.rbf_divisor + 1)) * 0.5);
 929       f = exp(-((d[0]*d[0] + d[1]*d[1]) / (2 * sigma * sigma)));
 930       state[m++] = f;
 931     }
 932   }
 933
 934   return state;
 935 }
 936
 937
 938 /**
 939  * Returns the utility value of the connection an agent manages
 940  *
 941  * @param agent the agent in question
 942  * @return the utility value
 943  */
 944 static double
 945 agent_get_utility (struct RIL_Peer_Agent *agent)
 946 {
 947   const double *preferences;
 948   double delay_atsi;
 949   double delay_norm;
 950   double pref_match;
 951
 952   preferences = agent->envi->env->get_preferences (agent->envi->env->cls,
 953                                                    &agent->peer);
 954
 955   delay_atsi = agent->address_inuse->norm_delay.norm;
 956   delay_norm = RIL_UTILITY_DELAY_MAX*exp(-delay_atsi*0.00001);
 957
 958   pref_match = preferences[GNUNET_ATS_PREFERENCE_LATENCY] * delay_norm;
 959   pref_match += preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] *
 960       sqrt((double) (agent->bw_in/RIL_MIN_BW) * (double) (agent->bw_out/RIL_MIN_BW));
 961   return pref_match;
 962 }
 963
 964 /**
 965  * Calculates the social welfare within a network scope according to what social
 966  * welfare measure is set in the configuration.
 967  *
 968  * @param solver the solver handle
 969  * @param scope the network scope in question
 970  * @return the social welfare value
 971  */
 972 static double
 973 ril_network_get_social_welfare (struct GAS_RIL_Handle *solver, struct RIL_Scope *scope)
 974 {
 975   struct RIL_Peer_Agent *cur;
 976   double result;
 977
 978   switch (solver->parameters.social_welfare)
 979   {
 980   case RIL_WELFARE_EGALITARIAN:
 981     result = DBL_MAX;
 982     for (cur = solver->agents_head; NULL != cur; cur = cur->next)
 983     {
 984       if (cur->is_active && cur->address_inuse && (cur->address_inuse->solver_information == scope))
 985       {
 986         result = GNUNET_MIN(result, agent_get_utility(cur));
 987       }
 988     }
 989     return result;
 990
 991   case RIL_WELFARE_NASH:
 992     result = 0;
 993     for (cur = solver->agents_head; NULL != cur; cur = cur->next)
 994     {
 995       if (cur->is_active && cur->address_inuse && (cur->address_inuse->solver_information == scope))
 996       {
 997         result *= pow(agent_get_utility(cur), 1.0 / (double) scope->active_agent_count);
 998       }
 999     }
1000     return result;
1001   }
1002   GNUNET_assert(GNUNET_NO);
1003   return 1;
1004 }
1005
1006 static double
1007 envi_get_penalty (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1008 {
1009   struct RIL_Scope *net;
1010   unsigned long long over_max;
1011   unsigned long long over_in = 0;
1012   unsigned long long over_out = 0;
1013
1014   net = agent->address_inuse->solver_information;
1015
1016   if (net->bw_in_utilized > net->bw_in_available)
1017   {
1018     over_in = net->bw_in_utilized - net->bw_in_available;
1019     if (RIL_ACTION_BW_IN_INC == agent->a_old)
1020     {
1021       /* increase quadratically */
1022       over_in *= over_in;
1023     }
1024   }
1025   if (net->bw_out_utilized > net->bw_out_available)
1026   {
1027     over_out = net->bw_out_utilized - net->bw_out_available;
1028     if (RIL_ACTION_BW_OUT_INC == agent->a_old)
1029     {
1030       /* increase quadratically */
1031       over_out *= over_out;
1032     }
1033   }
1034   over_max = (over_in + over_out) / (RIL_MIN_BW * RIL_MIN_BW);
1035
1036   return -1.0 * (double) over_max;
1037 }
1038
1039 /**
1040  * Gets the reward for the last performed step, which is calculated in equal
1041  * parts from the local (the peer specific) and the global (for all peers
1042  * identical) reward.
1043  *
1044  * @param solver the solver handle
1045  * @param agent the agent handle
1046  * @return the reward
1047  */
1048 static double
1049 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1050 {
1051   struct RIL_Scope *net;
1052   double objective;
1053   double delta;
1054   double steady;
1055   double penalty;
1056   double reward;
1057
1058   net = agent->address_inuse->solver_information;
1059
1060   penalty = envi_get_penalty(solver, agent);
1061   objective = (agent_get_utility (agent) + net->social_welfare) / 2;
1062   delta = objective - agent->objective_old;
1063   agent->objective_old = objective;
1064
1065   if (delta != 0 && penalty == 0)
1066   {
1067     agent->nop_bonus = delta * RIL_NOP_DECAY;
1068   }
1069   else
1070   {
1071     agent->nop_bonus *= RIL_NOP_DECAY;
1072   }
1073
1074   steady = (RIL_ACTION_NOTHING == agent->a_old) ? agent->nop_bonus : 0;
1075
1076   reward = delta + steady;
1077   return reward + penalty;
1078 }
1079
1080 /**
1081  * Doubles the bandwidth for the active address
1082  *
1083  * @param solver solver handle
1084  * @param agent agent handle
1085  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
1086  */
1087 static void
1088 envi_action_bw_double (struct GAS_RIL_Handle *solver,
1089     struct RIL_Peer_Agent *agent,
1090     int direction_in)
1091 {
1092   unsigned long long new_bw;
1093   unsigned long long max_bw;
1094
1095   max_bw = ril_get_max_bw((struct RIL_Scope *) agent->address_inuse->solver_information);
1096
1097   if (direction_in)
1098   {
1099     new_bw = agent->bw_in * 2;
1100     if (new_bw < agent->bw_in || new_bw > max_bw)
1101       new_bw = max_bw;
1102     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
1103         agent->bw_out, GNUNET_NO);
1104   }
1105   else
1106   {
1107     new_bw = agent->bw_out * 2;
1108     if (new_bw < agent->bw_out || new_bw > max_bw)
1109       new_bw = max_bw;
1110     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
1111         new_bw, GNUNET_NO);
1112   }
1113 }
1114
1115 /**
1116  * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
1117  * the minimum bandwidth for a peer, in order to not invoke a disconnect.
1118  *
1119  * @param solver solver handle
1120  * @param agent agent handle
1121  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1122  * bandwidth
1123  */
1124 static void
1125 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
1126     struct RIL_Peer_Agent *agent,
1127     int direction_in)
1128 {
1129   unsigned long long new_bw;
1130
1131   if (direction_in)
1132   {
1133     new_bw = agent->bw_in / 2;
1134     if (new_bw <= 0 || new_bw > agent->bw_in)
1135       new_bw = 0;
1136     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
1137         GNUNET_NO);
1138   }
1139   else
1140   {
1141     new_bw = agent->bw_out / 2;
1142     if (new_bw <= 0 || new_bw > agent->bw_out)
1143       new_bw = 0;
1144     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1145         GNUNET_NO);
1146   }
1147 }
1148
1149 /**
1150  * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
1151  *
1152  * @param solver solver handle
1153  * @param agent agent handle
1154  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1155  * bandwidth
1156  */
1157 static void
1158 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
1159 {
1160   unsigned long long new_bw;
1161   unsigned long long max_bw;
1162
1163   max_bw = ril_get_max_bw((struct RIL_Scope *) agent->address_inuse->solver_information);
1164
1165   if (direction_in)
1166   {
1167     new_bw = agent->bw_in + (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1168     if (new_bw < agent->bw_in || new_bw > max_bw)
1169       new_bw = max_bw;
1170     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
1171         agent->bw_out, GNUNET_NO);
1172   }
1173   else
1174   {
1175     new_bw = agent->bw_out + (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1176     if (new_bw < agent->bw_out || new_bw > max_bw)
1177       new_bw = max_bw;
1178     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
1179         new_bw, GNUNET_NO);
1180   }
1181 }
1182
1183 /**
1184  * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
1185  * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
1186  *
1187  * @param solver solver handle
1188  * @param agent agent handle
1189  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1190  * bandwidth
1191  */
1192 static void
1193 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
1194 {
1195   unsigned long long new_bw;
1196
1197   if (direction_in)
1198   {
1199     new_bw = agent->bw_in - (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1200     if (new_bw <= 0 || new_bw > agent->bw_in)
1201       new_bw = 0;
1202     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
1203         GNUNET_NO);
1204   }
1205   else
1206   {
1207     new_bw = agent->bw_out - (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1208     if (new_bw <= 0 || new_bw > agent->bw_out)
1209       new_bw = 0;
1210     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1211         GNUNET_NO);
1212   }
1213 }
1214
1215 /**
1216  * Switches to the address given by its index
1217  *
1218  * @param solver solver handle
1219  * @param agent agent handle
1220  * @param address_index index of the address as it is saved in the agent's list, starting with zero
1221  */
1222 static void
1223 envi_action_address_switch (struct GAS_RIL_Handle *solver,
1224     struct RIL_Peer_Agent *agent,
1225     unsigned int address_index)
1226 {
1227   struct RIL_Address_Wrapped *cur;
1228   int i = 0;
1229
1230   //cur = agent_address_get_wrapped(agent, agent->address_inuse);
1231
1232   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
1233   {
1234     if (i == address_index)
1235     {
1236       envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
1237           GNUNET_NO);
1238       return;
1239     }
1240
1241     i++;
1242   }
1243
1244   //no address with address_index exists, in this case this action should not be callable
1245   GNUNET_assert(GNUNET_NO);
1246 }
1247
1248 /**
1249  * Puts the action into effect by calling the according function
1250  *
1251  * @param solver the solver handle
1252  * @param agent the action handle
1253  * @param action the action to perform by the solver
1254  */
1255 static void
1256 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
1257 {
1258   int address_index;
1259
1260   switch (action)
1261   {
1262   case RIL_ACTION_NOTHING:
1263     break;
1264   case RIL_ACTION_BW_IN_DBL:
1265     envi_action_bw_double (solver, agent, GNUNET_YES);
1266     break;
1267   case RIL_ACTION_BW_IN_HLV:
1268     envi_action_bw_halven (solver, agent, GNUNET_YES);
1269     break;
1270   case RIL_ACTION_BW_IN_INC:
1271     envi_action_bw_inc (solver, agent, GNUNET_YES);
1272     break;
1273   case RIL_ACTION_BW_IN_DEC:
1274     envi_action_bw_dec (solver, agent, GNUNET_YES);
1275     break;
1276   case RIL_ACTION_BW_OUT_DBL:
1277     envi_action_bw_double (solver, agent, GNUNET_NO);
1278     break;
1279   case RIL_ACTION_BW_OUT_HLV:
1280     envi_action_bw_halven (solver, agent, GNUNET_NO);
1281     break;
1282   case RIL_ACTION_BW_OUT_INC:
1283     envi_action_bw_inc (solver, agent, GNUNET_NO);
1284     break;
1285   case RIL_ACTION_BW_OUT_DEC:
1286     envi_action_bw_dec (solver, agent, GNUNET_NO);
1287     break;
1288   default:
1289     if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
1290     {
1291       address_index = action - RIL_ACTION_TYPE_NUM;
1292
1293       GNUNET_assert(address_index >= 0);
1294       GNUNET_assert(
1295           address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
1296
1297       envi_action_address_switch (solver, agent, address_index);
1298       break;
1299     }
1300     // error - action does not exist
1301     GNUNET_assert(GNUNET_NO);
1302   }
1303 }
1304
1305 /**
1306  * Selects the next action using the e-greedy strategy. I.e. with a probability
1307  * of (1-e) the action with the maximum expected return will be chosen
1308  * (=> exploitation) and with probability (e) a random action will be chosen.
1309  * In case the Q-learning rule is set, the function also resets the eligibility
1310  * traces in the exploration case (after Watkin's Q-learning).
1311  *
1312  * @param agent the agent selecting an action
1313  * @param state the current state-feature vector
1314  * @return the action index
1315  */
1316 static int
1317 agent_select_egreedy (struct RIL_Peer_Agent *agent, double *state)
1318 {
1319   int action;
1320   double r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1321         UINT32_MAX) / (double) UINT32_MAX;
1322
1323   if (r < agent->envi->parameters.epsilon) //explore
1324   {
1325     action = agent_get_action_random(agent);
1326     if (RIL_ALGO_Q == agent->envi->parameters.algorithm)
1327     {
1328       agent->eligibility_reset = GNUNET_YES;
1329     }
1330     agent->envi->parameters.epsilon *= agent->envi->parameters.epsilon_decay;
1331     return action;
1332   }
1333   else //exploit
1334   {
1335     action = agent_get_action_max(agent, state);
1336     return action;
1337   }
1338 }
1339
1340 /**
1341  * Selects the next action with a probability corresponding to its value. The
1342  * probability is calculated using a Boltzmann distribution with a temperature
1343  * value. The higher the temperature, the more are the action selection
1344  * probabilities the same. With a temperature of 0, the selection is greedy,
1345  * i.e. always the action with the highest value is chosen.
1346  * @param agent
1347  * @param state
1348  * @return
1349  */
1350 static int
1351 agent_select_softmax (struct RIL_Peer_Agent *agent, double *state)
1352 {
1353   int i;
1354   int a_max;
1355   double eqt[agent->n];
1356   double p[agent->n];
1357   double sum = 0;
1358   double r;
1359
1360   a_max = agent_get_action_max(agent, state);
1361
1362   for (i=0; i<agent->n; i++)
1363   {
1364     if (agent_action_is_possible(agent, i))
1365     {
1366       eqt[i] = exp(agent_q(agent,state,i) / agent->envi->parameters.temperature);
1367       if (isinf (eqt[i]))
1368         eqt[i] = isinf(eqt[i]) * UINT32_MAX;
1369       sum += eqt[i];
1370     }
1371   }
1372   for (i=0; i<agent->n; i++)
1373   {
1374     if (agent_action_is_possible(agent, i))
1375     {
1376       p[i] = eqt[i]/sum;
1377     }
1378     else
1379     {
1380       p[i] = 0;
1381     }
1382   }
1383   r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1384       UINT32_MAX) / (double) UINT32_MAX;
1385   sum = 0;
1386   for (i=0; i<agent->n; i++)
1387   {
1388     if (sum + p[i] > r)
1389     {
1390       if (i != a_max)
1391       {
1392         if (RIL_ALGO_Q == agent->envi->parameters.algorithm)
1393           agent->eligibility_reset = GNUNET_YES;
1394         agent->envi->parameters.temperature *= agent->envi->parameters.temperature_decay;
1395       }
1396       return i;
1397     }
1398     sum += p[i];
1399   }
1400   GNUNET_assert(GNUNET_NO);
1401   return RIL_ACTION_INVALID;
1402 }
1403
1404 /**
1405  * Select the next action of an agent either according to the e-greedy strategy
1406  * or the softmax strategy.
1407  *
1408  * @param agent the agent in question
1409  * @param state the current state-feature vector
1410  * @return the action index
1411  */
1412 static int
1413 agent_select_action (struct RIL_Peer_Agent *agent, double *state)
1414 {
1415   if (agent->envi->parameters.select == RIL_SELECT_EGREEDY)
1416   {
1417     return agent_select_egreedy(agent, state);
1418   }
1419   else
1420   {
1421     return agent_select_softmax(agent, state);
1422   }
1423 }
1424
1425 /**
1426  * Performs one step of the Markov Decision Process. Other than in the literature the step starts
1427  * after having done the last action a_old. It observes the new state s_next and the reward
1428  * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
1429  * next action is put into effect.
1430  *
1431  * @param agent the agent performing the step
1432  */
1433 static void
1434 agent_step (struct RIL_Peer_Agent *agent)
1435 {
1436   int a_next = RIL_ACTION_INVALID;
1437   int a_max;
1438   double *s_next;
1439   double reward;
1440
1441   LOG(GNUNET_ERROR_TYPE_DEBUG, "    agent_step() Peer '%s', algorithm %s\n",
1442       GNUNET_i2s (&agent->peer),
1443       agent->envi->parameters.algorithm ? "Q" : "SARSA");
1444
1445   s_next = envi_get_state (agent->envi, agent);
1446   reward = envi_get_reward (agent->envi, agent);
1447
1448   if (agent->eligibility_reset)
1449   {
1450     agent_modify_eligibility(agent, RIL_E_ZERO, NULL, -1);
1451     agent->eligibility_reset = GNUNET_NO;
1452   }
1453   else
1454   {
1455     agent_modify_eligibility (agent, RIL_E_DECAY, NULL, -1);
1456   }
1457   if (RIL_ACTION_INVALID != agent->a_old)
1458   {
1459     agent_modify_eligibility (agent, agent->envi->parameters.eligibility_trace_mode, agent->s_old, agent->a_old);
1460   }
1461
1462   switch (agent->envi->parameters.algorithm)
1463   {
1464   case RIL_ALGO_SARSA:
1465     a_next = agent_select_action (agent, s_next);
1466     if (RIL_ACTION_INVALID != agent->a_old)
1467     {
1468       //updates weights with selected action (on-policy), if not first step
1469       agent_update (agent, reward, s_next, a_next);
1470     }
1471     break;
1472
1473   case RIL_ALGO_Q:
1474     a_max = agent_get_action_max (agent, s_next);
1475     if (RIL_ACTION_INVALID != agent->a_old)
1476     {
1477       //updates weights with best action, disregarding actually selected action (off-policy), if not first step
1478       agent_update (agent, reward, s_next, a_max);
1479     }
1480     a_next = agent_select_action (agent, s_next);
1481     break;
1482   }
1483
1484   GNUNET_assert(RIL_ACTION_INVALID != a_next);
1485
1486   LOG (GNUNET_ERROR_TYPE_DEBUG, "step()  Step# %llu  R: %f  IN %llu  OUT %llu  A: %d\n",
1487         agent->step_count,
1488         reward,
1489         agent->bw_in/1024,
1490         agent->bw_out/1024,
1491         a_next);
1492
1493   envi_do_action (agent->envi, agent, a_next);
1494
1495   GNUNET_free(agent->s_old);
1496   agent->s_old = s_next;
1497   agent->a_old = a_next;
1498
1499   agent->step_count += 1;
1500 }
1501
1502 /**
1503  * Prototype of the ril_step() procedure
1504  *
1505  * @param solver the solver handle
1506  */
1507 static void
1508 ril_step (struct GAS_RIL_Handle *solver);
1509
1510
1511 /**
1512  * Task for the scheduler, which performs one step and lets the solver know that
1513  * no further step is scheduled.
1514  *
1515  * @param cls the solver handle
1516  * @param tc the task context for the scheduler
1517  */
1518 static void
1519 ril_step_scheduler_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1520 {
1521   struct GAS_RIL_Handle *solver = cls;
1522
1523   solver->step_next_task_id = NULL;
1524   ril_step (solver);
1525 }
1526
1527 /**
1528  * Determines how much of the available bandwidth is assigned. If more is
1529  * assigned than available it returns 1. The function is used to determine the
1530  * step size of the adaptive stepping.
1531  *
1532  * @param solver the solver handle
1533  * @return the ratio
1534  */
1535 static double
1536 ril_get_used_resource_ratio (struct GAS_RIL_Handle *solver)
1537 {
1538   int i;
1539   struct RIL_Scope net;
1540   unsigned long long sum_assigned = 0;
1541   unsigned long long sum_available = 0;
1542   double ratio;
1543
1544   for (i = 0; i < solver->networks_count; i++)
1545   {
1546     net = solver->network_entries[i];
1547     if (net.bw_in_assigned > 0) //only consider scopes where an address is actually active
1548     {
1549       sum_assigned += net.bw_in_utilized;
1550       sum_assigned += net.bw_out_utilized;
1551       sum_available += net.bw_in_available;
1552       sum_available += net.bw_out_available;
1553     }
1554   }
1555   if (sum_available > 0)
1556   {
1557     ratio = ((double) sum_assigned) / ((double) sum_available);
1558   }
1559   else
1560   {
1561     ratio = 0;
1562   }
1563
1564   return ratio > 1 ? 1 : ratio; //overutilization is possible, cap at 1
1565 }
1566
1567 /**
1568  * Lookup network struct by type
1569  *
1570  * @param s the solver handle
1571  * @param type the network type
1572  * @return the network struct
1573  */
1574 static struct RIL_Scope *
1575 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1576 {
1577   int i;
1578
1579   for (i = 0; i < s->networks_count; i++)
1580   {
1581     if (s->network_entries[i].type == type)
1582     {
1583       return &s->network_entries[i];
1584     }
1585   }
1586   return NULL ;
1587 }
1588
1589 /**
1590  * Determines whether more connections are allocated in a network scope, than
1591  * they would theoretically fit. This is used as a heuristic to determine,
1592  * whether a new connection can be allocated or not.
1593  *
1594  * @param solver the solver handle
1595  * @param network the network scope in question
1596  * @return GNUNET_YES if there are theoretically enough resources left
1597  */
1598 static int
1599 ril_network_is_not_full (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1600 {
1601   struct RIL_Scope *net;
1602   struct RIL_Peer_Agent *agent;
1603   unsigned long long address_count = 0;
1604
1605   for (agent = solver->agents_head; NULL != agent; agent = agent->next)
1606   {
1607     if (agent->address_inuse && agent->is_active)
1608     {
1609       net = agent->address_inuse->solver_information;
1610       if (net->type == network)
1611       {
1612         address_count++;
1613       }
1614     }
1615   }
1616
1617   net = ril_get_network (solver, network);
1618   return (net->bw_in_available > RIL_MIN_BW * address_count) && (net->bw_out_available > RIL_MIN_BW * address_count);
1619 }
1620
1621 /**
1622  * Unblocks an agent for which a connection request is there, that could not
1623  * be satisfied. Iterates over the addresses of the agent, if one of its
1624  * addresses can now be allocated in its scope the agent is unblocked,
1625  * otherwise it remains unchanged.
1626  *
1627  * @param solver the solver handle
1628  * @param agent the agent in question
1629  * @param silent
1630  */
1631 static void
1632 ril_try_unblock_agent (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int silent)
1633 {
1634   struct RIL_Address_Wrapped *addr_wrap;
1635   struct RIL_Scope *net;
1636   unsigned long long start_in;
1637   unsigned long long start_out;
1638
1639   for (addr_wrap = agent->addresses_head; NULL != addr_wrap; addr_wrap = addr_wrap->next)
1640   {
1641     net = addr_wrap->address_naked->solver_information;
1642     if (ril_network_is_not_full(solver, net->type))
1643     {
1644       if (NULL == agent->address_inuse)
1645       {
1646         start_in = net->bw_in_available < net->bw_in_utilized ? (net->bw_in_available - net->bw_in_utilized) / 2 : RIL_MIN_BW;
1647         start_out = net->bw_out_available < net->bw_out_utilized ? (net->bw_out_available - net->bw_out_utilized) / 2 : RIL_MIN_BW;
1648         envi_set_active_suggestion (solver, agent, addr_wrap->address_naked, start_in, start_out, silent);
1649       }
1650       return;
1651     }
1652   }
1653   agent->address_inuse = NULL;
1654 }
1655
1656 /**
1657  * Determines how much the reward needs to be discounted depending on the amount
1658  * of time, which has passed since the last time-step.
1659  *
1660  * @param solver the solver handle
1661  */
1662 static void
1663 ril_calculate_discount (struct GAS_RIL_Handle *solver)
1664 {
1665   struct GNUNET_TIME_Absolute time_now;
1666   struct GNUNET_TIME_Relative time_delta;
1667   double tau;
1668
1669   // MDP case only for debugging purposes
1670   if (solver->simulate)
1671   {
1672     solver->global_discount_variable = solver->parameters.gamma;
1673     solver->global_discount_integrated = 1;
1674     return;
1675   }
1676
1677   // semi-MDP case
1678
1679   //calculate tau, i.e. how many real valued time units have passed, one time unit is one minimum time step
1680   time_now = GNUNET_TIME_absolute_get ();
1681   time_delta = GNUNET_TIME_absolute_get_difference (solver->step_time_last, time_now);
1682   solver->step_time_last = time_now;
1683   tau = (double) time_delta.rel_value_us
1684       / (double) solver->parameters.step_time_min.rel_value_us;
1685
1686   //calculate reward discounts (once per step for all agents)
1687   solver->global_discount_variable = pow (M_E, ((-1.0) * ((double) solver->parameters.beta) * tau));
1688   solver->global_discount_integrated = (1.0 - solver->global_discount_variable)
1689       / (double) solver->parameters.beta;
1690 }
1691
1692 /**
1693  * Count the number of active agents/connections in a network scope
1694  *
1695  * @param solver the solver handle
1696  * @param scope the network scope in question
1697  * @return the number of allocated connections
1698  */
1699 static int
1700 ril_network_count_active_agents (struct GAS_RIL_Handle *solver, struct RIL_Scope *scope)
1701 {
1702   int c = 0;
1703   struct RIL_Peer_Agent *cur_agent;
1704
1705   for (cur_agent = solver->agents_head; NULL != cur_agent; cur_agent = cur_agent->next)
1706   {
1707     if (cur_agent->is_active && cur_agent->address_inuse && (cur_agent->address_inuse->solver_information == scope))
1708     {
1709       c++;
1710     }
1711   }
1712   return c;
1713 }
1714
1715 /**
1716  * Calculates how much bandwidth is assigned in sum in a network scope, either
1717  * in the inbound or in the outbound direction.
1718  *
1719  * @param solver the solver handle
1720  * @param type the type of the network scope in question
1721  * @param direction_in GNUNET_YES if the inbound direction should be summed up,
1722  *   otherwise the outbound direction will be summed up
1723  * @return the sum of the assigned bandwidths
1724  */
1725 static unsigned long long
1726 ril_network_get_assigned (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type type, int direction_in)
1727 {
1728   struct RIL_Peer_Agent *cur;
1729   struct RIL_Scope *net;
1730   unsigned long long sum = 0;
1731
1732   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1733   {
1734     if (cur->is_active && cur->address_inuse)
1735     {
1736       net = cur->address_inuse->solver_information;
1737       if (net->type == type)
1738       {
1739         if (direction_in)
1740           sum += cur->bw_in;
1741         else
1742           sum += cur->bw_out;
1743       }
1744     }
1745   }
1746
1747   return sum;
1748 }
1749
1750 /**
1751  * Calculates how much bandwidth is actually utilized in sum in a network scope,
1752  * either in the inbound or in the outbound direction.
1753  *
1754  * @param solver the solver handle
1755  * @param type the type of the network scope in question
1756  * @param direction_in GNUNET_YES if the inbound direction should be summed up,
1757  *   otherwise the outbound direction will be summed up
1758  * @return the sum of the utilized bandwidths (in bytes/second)
1759  */
1760 static unsigned long long
1761 ril_network_get_utilized (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type type, int direction_in)
1762 {
1763   struct RIL_Peer_Agent *cur;
1764   struct RIL_Scope *net;
1765   unsigned long long sum = 0;
1766
1767   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1768   {
1769     if (cur->is_active && cur->address_inuse)
1770     {
1771       net = cur->address_inuse->solver_information;
1772       if (net->type == type)
1773       {
1774         if (direction_in)
1775           sum += cur->address_inuse->norm_utilization_in.norm;
1776         else
1777           sum += cur->address_inuse->norm_utilization_out.norm;
1778       }
1779     }
1780   }
1781
1782   return sum;
1783 }
1784
1785 /**
1786  * Retrieves the state of the network scope, so that its attributes are up-to-
1787  * date.
1788  *
1789  * @param solver the solver handle
1790  */
1791 static void
1792 ril_networks_update_state (struct GAS_RIL_Handle *solver)
1793 {
1794   int c;
1795   struct RIL_Scope *net;
1796
1797   for (c = 0; c < solver->networks_count; c++)
1798   {
1799     net = &solver->network_entries[c];
1800     net->bw_in_assigned = ril_network_get_assigned(solver, net->type, GNUNET_YES);
1801     net->bw_in_utilized = ril_network_get_utilized(solver, net->type, GNUNET_YES);
1802     net->bw_out_assigned = ril_network_get_assigned(solver, net->type, GNUNET_NO);
1803     net->bw_out_utilized = ril_network_get_utilized(solver, net->type, GNUNET_NO);
1804     net->active_agent_count = ril_network_count_active_agents(solver, net);
1805     net->social_welfare = ril_network_get_social_welfare(solver, net);
1806   }
1807 }
1808
1809 /**
1810  * Schedules the next global step in an adaptive way. The more resources are
1811  * left, the earlier the next step is scheduled. This serves the reactivity of
1812  * the solver to changed inputs.
1813  *
1814  * @param solver the solver handle
1815  */
1816 static void
1817 ril_step_schedule_next (struct GAS_RIL_Handle *solver)
1818 {
1819   double used_ratio;
1820   double factor;
1821   double y;
1822   double offset;
1823   struct GNUNET_TIME_Relative time_next;
1824
1825   used_ratio = ril_get_used_resource_ratio (solver);
1826
1827   GNUNET_assert(
1828       solver->parameters.step_time_min.rel_value_us
1829           <= solver->parameters.step_time_max.rel_value_us);
1830
1831   factor = (double) GNUNET_TIME_relative_subtract (solver->parameters.step_time_max,
1832       solver->parameters.step_time_min).rel_value_us;
1833   offset = (double) solver->parameters.step_time_min.rel_value_us;
1834   y = factor * pow (used_ratio, RIL_INTERVAL_EXPONENT) + offset;
1835
1836   GNUNET_assert(y <= (double) solver->parameters.step_time_max.rel_value_us);
1837   GNUNET_assert(y >= (double) solver->parameters.step_time_min.rel_value_us);
1838
1839   time_next = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, (unsigned long long) y);
1840
1841 //  LOG (GNUNET_ERROR_TYPE_INFO, "ratio: %f, factor: %f, offset: %f, y: %f\n",
1842 //      used_ratio,
1843 //      factor,
1844 //      offset,
1845 //      y);
1846
1847   if (solver->simulate)
1848   {
1849     time_next = GNUNET_TIME_UNIT_ZERO;
1850   }
1851
1852   if ((NULL == solver->step_next_task_id) && (GNUNET_NO == solver->done))
1853   {
1854     solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (time_next, &ril_step_scheduler_task,
1855           solver);
1856   }
1857 }
1858
1859 /**
1860  * Triggers one step per agent
1861  *
1862  * @param solver
1863  */
1864 static void
1865 ril_step (struct GAS_RIL_Handle *solver)
1866 {
1867   struct RIL_Peer_Agent *cur;
1868
1869   if (GNUNET_YES == solver->bulk_lock)
1870   {
1871     solver->bulk_changes++;
1872     return;
1873   }
1874
1875   ril_inform (solver, GAS_OP_SOLVE_START, GAS_STAT_SUCCESS);
1876
1877   LOG(GNUNET_ERROR_TYPE_DEBUG, "    RIL step number %d\n", solver->step_count);
1878
1879   if (0 == solver->step_count)
1880   {
1881     solver->step_time_last = GNUNET_TIME_absolute_get ();
1882   }
1883
1884   ril_calculate_discount (solver);
1885   ril_networks_update_state (solver);
1886
1887   //trigger one step per active, unblocked agent
1888   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1889   {
1890     if (cur->is_active)
1891     {
1892       if (NULL == cur->address_inuse)
1893       {
1894         ril_try_unblock_agent(solver, cur, GNUNET_NO);
1895       }
1896       if (cur->address_inuse)
1897       {
1898         agent_step (cur);
1899       }
1900     }
1901   }
1902
1903   ril_networks_update_state (solver);
1904
1905   solver->step_count++;
1906   ril_step_schedule_next (solver);
1907
1908   ril_inform (solver, GAS_OP_SOLVE_STOP, GAS_STAT_SUCCESS);
1909
1910   ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START, GAS_STAT_SUCCESS);
1911   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1912   {
1913     if (cur->suggestion_issue) {
1914       solver->env->bandwidth_changed_cb (solver->env->cls,
1915                                          cur->suggestion_address);
1916       cur->suggestion_issue = GNUNET_NO;
1917     }
1918   }
1919   ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP, GAS_STAT_SUCCESS);
1920 }
1921
1922 /**
1923  * Initializes the matrix W of parameter vectors theta with small random numbers.
1924  *
1925  * @param agent The respective agent
1926  */
1927 static void
1928 agent_w_init (struct RIL_Peer_Agent *agent)
1929 {
1930   int i;
1931   int k;
1932
1933   for (i = 0; i < agent->n; i++)
1934   {
1935     for (k = 0; k < agent->m; k++)
1936     {
1937       agent->W[i][k] = agent->envi->parameters.alpha * (1.0 - 2.0 * ((double) GNUNET_CRYPTO_random_u32(GNUNET_CRYPTO_QUALITY_WEAK, UINT32_MAX)/(double) UINT32_MAX));
1938     }
1939   }
1940 }
1941
1942 /**
1943  * Initialize an agent without addresses and its knowledge base
1944  *
1945  * @param s ril solver
1946  * @param peer the one in question
1947  * @return handle to the new agent
1948  */
1949 static struct RIL_Peer_Agent *
1950 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1951 {
1952   int i;
1953   struct GAS_RIL_Handle * solver = s;
1954   struct RIL_Peer_Agent * agent = GNUNET_new (struct RIL_Peer_Agent);
1955
1956   agent->envi = solver;
1957   agent->peer = *peer;
1958   agent->step_count = 0;
1959   agent->is_active = GNUNET_NO;
1960   agent->bw_in = RIL_MIN_BW;
1961   agent->bw_out = RIL_MIN_BW;
1962   agent->suggestion_issue = GNUNET_NO;
1963   agent->n = RIL_ACTION_TYPE_NUM;
1964   agent->m = 0;
1965   agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1966   agent->E = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1967   for (i = 0; i < agent->n; i++)
1968   {
1969     agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1970     agent->E[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1971   }
1972   agent_w_init(agent);
1973   agent->eligibility_reset = GNUNET_NO;
1974   agent->a_old = RIL_ACTION_INVALID;
1975   agent->s_old = GNUNET_malloc (sizeof (double) * agent->m);
1976   agent->address_inuse = NULL;
1977   agent->objective_old = 0;
1978   agent->nop_bonus = 0;
1979
1980   return agent;
1981 }
1982
1983 /**
1984  * Deallocate agent
1985  *
1986  * @param solver the solver handle
1987  * @param agent the agent to retire
1988  */
1989 static void
1990 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1991 {
1992   int i;
1993
1994   for (i = 0; i < agent->n; i++)
1995   {
1996     GNUNET_free_non_null(agent->W[i]);
1997     GNUNET_free_non_null(agent->E[i]);
1998   }
1999   GNUNET_free_non_null(agent->W);
2000   GNUNET_free_non_null(agent->E);
2001   GNUNET_free_non_null(agent->s_old);
2002   GNUNET_free(agent);
2003 }
2004
2005 /**
2006  * Returns the agent for a peer
2007  *
2008  * @param solver the solver handle
2009  * @param peer the identity of the peer
2010  * @param create whether or not to create an agent, if none is allocated yet
2011  * @return the agent
2012  */
2013 static struct RIL_Peer_Agent *
2014 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
2015 {
2016   struct RIL_Peer_Agent *cur;
2017
2018   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
2019   {
2020     if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
2021     {
2022       return cur;
2023     }
2024   }
2025
2026   if (create)
2027   {
2028     cur = agent_init (solver, peer);
2029     GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, cur);
2030     return cur;
2031   }
2032   return NULL ;
2033 }
2034
2035 /**
2036  * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
2037  * considered inactive and not used. Addresses in an inactive network are ignored.
2038  *
2039  * @param solver solver handle
2040  * @param network the network type
2041  * @return whether or not the network is considered active
2042  */
2043 static int
2044 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
2045 {
2046   struct RIL_Scope *net;
2047
2048   net = ril_get_network (solver, network);
2049   return net->bw_out_available >= RIL_MIN_BW;
2050 }
2051
2052 /**
2053  * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
2054  * the reward function approximation. It copies the memory, which is not cut, to the new vector,
2055  * frees the memory of the old vector, and redirects the pointer to the new one.
2056  *
2057  * @param old pointer to the pointer to the first element of the vector
2058  * @param element_size byte size of the vector elements
2059  * @param hole_start the first element to cut out
2060  * @param hole_length the number of elements to cut out
2061  * @param old_length the length of the old vector
2062  */
2063 static void
2064 ril_cut_from_vector (void **old,
2065     size_t element_size,
2066     unsigned int hole_start,
2067     unsigned int hole_length,
2068     unsigned int old_length)
2069 {
2070   char *tmpptr;
2071   char *oldptr = (char *) *old;
2072   size_t size;
2073   unsigned int bytes_before;
2074   unsigned int bytes_hole;
2075   unsigned int bytes_after;
2076
2077   GNUNET_assert(old_length >= hole_length);
2078   GNUNET_assert(old_length >= (hole_start + hole_length));
2079
2080   size = element_size * (old_length - hole_length);
2081
2082   bytes_before = element_size * hole_start;
2083   bytes_hole = element_size * hole_length;
2084   bytes_after = element_size * (old_length - hole_start - hole_length);
2085
2086   if (0 == size)
2087   {
2088     tmpptr = NULL;
2089   }
2090   else
2091   {
2092     tmpptr = GNUNET_malloc (size);
2093     memcpy (tmpptr, oldptr, bytes_before);
2094     memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
2095   }
2096   if (NULL != *old)
2097   {
2098     GNUNET_free(*old);
2099   }
2100   *old = (void *) tmpptr;
2101 }
2102
2103 /*
2104  *  Solver API functions
2105  *  ---------------------------
2106  */
2107
2108 /**
2109  * Change relative preference for quality in solver
2110  *
2111  * @param solver the solver handle
2112  * @param peer the peer to change the preference for
2113  * @param kind the kind to change the preference
2114  * @param pref_rel the normalized preference value for this kind over all clients
2115  */
2116 static void
2117 GAS_ril_address_change_preference (void *solver,
2118                                    const struct GNUNET_PeerIdentity *peer,
2119                                    enum GNUNET_ATS_PreferenceKind kind,
2120                                    double pref_rel)
2121 {
2122   LOG(GNUNET_ERROR_TYPE_DEBUG,
2123       "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
2124       GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
2125
2126   struct GAS_RIL_Handle *s = solver;
2127
2128   s->parameters.temperature = s->parameters.temperature_init;
2129   s->parameters.epsilon = s->parameters.epsilon_init;
2130   ril_step (s);
2131 }
2132
2133
2134 /**
2135  * Add a new address for a peer to the solver
2136  *
2137  * The address is already contained in the addresses hashmap!
2138  *
2139  * @param solver the solver Handle
2140  * @param address the address to add
2141  * @param network network type of this address
2142  */
2143 static void
2144 GAS_ril_address_add (void *solver,
2145                      struct ATS_Address *address,
2146                      uint32_t network)
2147 {
2148   struct GAS_RIL_Handle *s = solver;
2149   struct RIL_Peer_Agent *agent;
2150   struct RIL_Address_Wrapped *address_wrapped;
2151   struct RIL_Scope *net;
2152   unsigned int m_new;
2153   unsigned int m_old;
2154   unsigned int n_new;
2155   unsigned int n_old;
2156   int i;
2157   unsigned int zero;
2158
2159   LOG (GNUNET_ERROR_TYPE_DEBUG,
2160        "API_address_add()\n");
2161
2162   net = ril_get_network (s, network);
2163   address->solver_information = net;
2164
2165   if (!ril_network_is_active (s, network))
2166   {
2167     LOG(GNUNET_ERROR_TYPE_DEBUG,
2168         "API_address_add() Did not add %s address %s for peer '%s', network does not have enough bandwidth\n",
2169         address->plugin, address->addr, GNUNET_i2s (&address->peer));
2170     return;
2171   }
2172
2173   s->parameters.temperature = s->parameters.temperature_init;
2174   s->parameters.epsilon = s->parameters.epsilon_init;
2175
2176   agent = ril_get_agent (s, &address->peer, GNUNET_YES);
2177
2178   //add address
2179   address_wrapped = GNUNET_new (struct RIL_Address_Wrapped);
2180   address_wrapped->address_naked = address;
2181   GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
2182
2183   //increase size of W
2184   m_new = agent->m + ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1));
2185   m_old = agent->m;
2186   n_new = agent->n + 1;
2187   n_old = agent->n;
2188
2189   GNUNET_array_grow(agent->W, agent->n, n_new);
2190   agent->n = n_old;
2191   GNUNET_array_grow(agent->E, agent->n, n_new);
2192   for (i = 0; i < n_new; i++)
2193   {
2194     if (i < n_old)
2195     {
2196       agent->m = m_old;
2197       GNUNET_array_grow(agent->W[i], agent->m, m_new);
2198       agent->m = m_old;
2199       GNUNET_array_grow(agent->E[i], agent->m, m_new);
2200     }
2201     else
2202     {
2203       zero = 0;
2204       GNUNET_array_grow(agent->W[i], zero, m_new);
2205       zero = 0;
2206       GNUNET_array_grow(agent->E[i], zero, m_new);
2207     }
2208   }
2209
2210   //increase size of old state vector
2211   agent->m = m_old;
2212   GNUNET_array_grow(agent->s_old, agent->m, m_new);
2213
2214   ril_try_unblock_agent(s, agent, GNUNET_NO);
2215
2216   ril_step (s);
2217
2218   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %s for peer '%s'\n",
2219       address->active ? "active" : "inactive", address->plugin, address->addr,
2220       GNUNET_i2s (&address->peer));
2221 }
2222
2223 /**
2224  * Delete an address in the solver
2225  *
2226  * The address is not contained in the address hashmap anymore!
2227  *
2228  * @param solver the solver handle
2229  * @param address the address to remove
2230  */
2231 static void
2232 GAS_ril_address_delete (void *solver,
2233                         struct ATS_Address *address)
2234 {
2235   struct GAS_RIL_Handle *s = solver;
2236   struct RIL_Peer_Agent *agent;
2237   struct RIL_Address_Wrapped *address_wrapped;
2238   int address_index;
2239   unsigned int m_new;
2240   unsigned int n_new;
2241   int i;
2242   struct RIL_Scope *net;
2243
2244   LOG (GNUNET_ERROR_TYPE_DEBUG,
2245        "API_address_delete() Delete %s %s address %s for peer '%s'\n",
2246        address->active ? "active" : "inactive",
2247        address->plugin,
2248        address->addr,
2249        GNUNET_i2s (&address->peer));
2250
2251   agent = ril_get_agent (s, &address->peer, GNUNET_NO);
2252   if (NULL == agent)
2253   {
2254     net = address->solver_information;
2255     GNUNET_assert(! ril_network_is_active (s, net->type));
2256     LOG (GNUNET_ERROR_TYPE_DEBUG,
2257          "No agent allocated for peer yet, since address was in inactive network\n");
2258     return;
2259   }
2260
2261   s->parameters.temperature = s->parameters.temperature_init;
2262   s->parameters.epsilon = s->parameters.epsilon_init;
2263
2264   address_index = agent_address_get_index (agent, address);
2265   address_wrapped = agent_address_get_wrapped (agent, address);
2266
2267   if (NULL == address_wrapped)
2268   {
2269     net = address->solver_information;
2270     LOG (GNUNET_ERROR_TYPE_DEBUG,
2271          "Address not considered by agent, address was in inactive network\n");
2272     return;
2273   }
2274   GNUNET_CONTAINER_DLL_remove (agent->addresses_head,
2275                                agent->addresses_tail,
2276                                address_wrapped);
2277   GNUNET_free (address_wrapped);
2278
2279   //decrease W
2280   m_new = agent->m - ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1));
2281   n_new = agent->n - 1;
2282
2283   for (i = 0; i < agent->n; i++)
2284   {
2285     ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
2286         address_index * ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)),
2287         ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)), agent->m);
2288     ril_cut_from_vector ((void **) &agent->E[i], sizeof(double),
2289         address_index * ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)),
2290         ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)), agent->m);
2291   }
2292   GNUNET_free_non_null(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
2293   GNUNET_free_non_null(agent->E[RIL_ACTION_TYPE_NUM + address_index]);
2294   ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
2295       1, agent->n);
2296   ril_cut_from_vector ((void **) &agent->E, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
2297       1, agent->n);
2298   //correct last action
2299   if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
2300   {
2301     agent->a_old -= 1;
2302   }
2303   else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
2304   {
2305     agent->a_old = RIL_ACTION_INVALID;
2306   }
2307   //decrease old state vector
2308   ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
2309                        address_index * ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)),
2310                        ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)), agent->m);
2311   agent->m = m_new;
2312   agent->n = n_new;
2313
2314   if (agent->address_inuse == address)
2315   {
2316     if (NULL != agent->addresses_head) //if peer has an address left, use it
2317     {
2318       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2319                   "Active address died, suggesting alternative!\n");
2320       envi_set_active_suggestion (s,
2321                                   agent,
2322                                   agent->addresses_head->address_naked,
2323                                   agent->bw_in,
2324                                   agent->bw_out,
2325                                   GNUNET_YES);
2326     }
2327     else
2328     {
2329       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2330                   "Active address died, suggesting disconnect!\n");
2331       envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
2332     }
2333   }
2334   ril_step (solver);
2335   if (agent->suggestion_address == address)
2336   {
2337     agent->suggestion_issue = GNUNET_NO;
2338     agent->suggestion_address = NULL;
2339   }
2340   GNUNET_assert (agent->address_inuse != address);
2341 }
2342
2343
2344 /**
2345  * Update the properties of an address in the solver
2346  *
2347  * @param solver solver handle
2348  * @param address the address
2349  */
2350 static void
2351 GAS_ril_address_property_changed (void *solver,
2352                                   struct ATS_Address *address)
2353 {
2354   struct GAS_RIL_Handle *s = solver;
2355
2356   LOG(GNUNET_ERROR_TYPE_DEBUG,
2357       "Properties for peer '%s' address changed\n",
2358       GNUNET_i2s (&address->peer));
2359   s->parameters.temperature = s->parameters.temperature_init;
2360   s->parameters.epsilon = s->parameters.epsilon_init;
2361   ril_step (s);
2362 }
2363
2364
2365 /**
2366  * Give feedback about the current assignment
2367  *
2368  * @param solver the solver handle
2369  * @param application the application
2370  * @param peer the peer to change the preference for
2371  * @param scope the time interval for this feedback: [now - scope .. now]
2372  * @param kind the kind to change the preference
2373  * @param score the score
2374  */
2375 static void
2376 GAS_ril_address_preference_feedback (void *solver,
2377                                      struct GNUNET_SERVER_Client *application,
2378                                      const struct GNUNET_PeerIdentity *peer,
2379                                      const struct GNUNET_TIME_Relative scope,
2380                                      enum GNUNET_ATS_PreferenceKind kind,
2381                                      double score)
2382 {
2383   LOG (GNUNET_ERROR_TYPE_DEBUG,
2384        "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
2385        "preference %s for %d seconds\n",
2386        GNUNET_i2s (peer),
2387        "UNKNOWN",
2388        GNUNET_ATS_print_preference_type (kind),
2389        scope.rel_value_us / 1000000);
2390 }
2391
2392
2393 /**
2394  * Start a bulk operation
2395  *
2396  * @param solver the solver
2397  */
2398 static void
2399 GAS_ril_bulk_start (void *solver)
2400 {
2401   struct GAS_RIL_Handle *s = solver;
2402
2403   LOG (GNUNET_ERROR_TYPE_DEBUG,
2404        "API_bulk_start() lock: %d\n", s->bulk_lock+1);
2405
2406   s->bulk_lock++;
2407 }
2408
2409
2410 /**
2411  * Bulk operation done
2412  *
2413  * @param solver the solver handle
2414  */
2415 static void
2416 GAS_ril_bulk_stop (void *solver)
2417 {
2418   struct GAS_RIL_Handle *s = solver;
2419
2420   LOG(GNUNET_ERROR_TYPE_DEBUG,
2421       "API_bulk_stop() lock: %d\n",
2422       s->bulk_lock - 1);
2423
2424   if (s->bulk_lock < 1)
2425   {
2426     GNUNET_break(0);
2427     return;
2428   }
2429   s->bulk_lock--;
2430
2431   if (0 < s->bulk_changes)
2432   {
2433     ril_step (solver);
2434     s->bulk_changes = 0;
2435   }
2436 }
2437
2438
2439 /**
2440  * Tell solver to notify ATS if the address to use changes for a specific
2441  * peer using the bandwidth changed callback
2442  *
2443  * The solver must only notify about changes for peers with pending address
2444  * requests!
2445  *
2446  * @param solver the solver handle
2447  * @param peer the identity of the peer
2448  */
2449 static void
2450 GAS_ril_get_preferred_address (void *solver,
2451                                const struct GNUNET_PeerIdentity *peer)
2452 {
2453   struct GAS_RIL_Handle *s = solver;
2454   struct RIL_Peer_Agent *agent;
2455
2456   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_get_preferred_address()\n");
2457
2458   agent = ril_get_agent (s, peer, GNUNET_YES);
2459
2460   agent->is_active = GNUNET_YES;
2461   envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, agent->bw_out, GNUNET_YES);
2462
2463   ril_try_unblock_agent(solver, agent, GNUNET_YES);
2464
2465   if (agent->address_inuse)
2466   {
2467     LOG(GNUNET_ERROR_TYPE_DEBUG,
2468         "API_get_preferred_address() Activated agent for peer '%s' with %s address %s\n",
2469         GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
2470   }
2471   else
2472   {
2473     LOG(GNUNET_ERROR_TYPE_DEBUG,
2474         "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
2475         GNUNET_i2s (peer));
2476     s->parameters.temperature = s->parameters.temperature_init;
2477     s->parameters.epsilon = s->parameters.epsilon_init;
2478   }
2479   if (NULL != agent->address_inuse)
2480     s->env->bandwidth_changed_cb (s->env->cls,
2481                                   agent->address_inuse);
2482 }
2483
2484
2485 /**
2486  * Tell solver stop notifying ATS about changes for this peers
2487  *
2488  * The solver must only notify about changes for peers with pending address
2489  * requests!
2490  *
2491  * @param solver the solver handle
2492  * @param peer the peer
2493  */
2494 static void
2495 GAS_ril_stop_get_preferred_address (void *solver,
2496                                     const struct GNUNET_PeerIdentity *peer)
2497 {
2498   struct GAS_RIL_Handle *s = solver;
2499   struct RIL_Peer_Agent *agent;
2500
2501   LOG (GNUNET_ERROR_TYPE_DEBUG,
2502        "API_stop_get_preferred_address()");
2503
2504   agent = ril_get_agent (s, peer, GNUNET_NO);
2505
2506   if (NULL == agent)
2507   {
2508     GNUNET_break(0);
2509     return;
2510   }
2511   if (GNUNET_NO == agent->is_active)
2512   {
2513     GNUNET_break(0);
2514     return;
2515   }
2516
2517   s->parameters.temperature = s->parameters.temperature_init;
2518   s->parameters.epsilon = s->parameters.epsilon_init;
2519
2520   agent->is_active = GNUNET_NO;
2521
2522   envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2523       GNUNET_YES);
2524
2525   ril_step (s);
2526
2527   LOG(GNUNET_ERROR_TYPE_DEBUG,
2528       "API_stop_get_preferred_address() Paused agent for peer '%s'\n",
2529       GNUNET_i2s (peer));
2530 }
2531
2532
2533 /**
2534  * Entry point for the plugin
2535  *
2536  * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
2537  */
2538 void *
2539 libgnunet_plugin_ats_ril_init (void *cls)
2540 {
2541   static struct GNUNET_ATS_SolverFunctions sf;
2542   struct GNUNET_ATS_PluginEnvironment *env = cls;
2543   struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
2544   struct RIL_Scope * cur;
2545   int c;
2546   char *string;
2547   float f_tmp;
2548
2549   LOG (GNUNET_ERROR_TYPE_DEBUG,
2550        "API_init() Initializing RIL solver\n");
2551
2552   GNUNET_assert (NULL != env);
2553   GNUNET_assert (NULL != env->cfg);
2554   GNUNET_assert (NULL != env->stats);
2555   GNUNET_assert (NULL != env->bandwidth_changed_cb);
2556   GNUNET_assert (NULL != env->get_preferences);
2557
2558   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(env->cfg, "ats", "RIL_RBF_DIVISOR", &solver->parameters.rbf_divisor))
2559   {
2560     solver->parameters.rbf_divisor = RIL_DEFAULT_RBF_DIVISOR;
2561   }
2562
2563   if (GNUNET_OK
2564       != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MIN",
2565           &solver->parameters.step_time_min))
2566   {
2567     solver->parameters.step_time_min = RIL_DEFAULT_STEP_TIME_MIN;
2568   }
2569
2570   if (GNUNET_OK
2571       != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MAX",
2572           &solver->parameters.step_time_max))
2573   {
2574     solver->parameters.step_time_max = RIL_DEFAULT_STEP_TIME_MAX;
2575   }
2576
2577   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string))
2578   {
2579     GNUNET_STRINGS_utf8_toupper (string, string);
2580     if (0 == strcmp (string, "SARSA"))
2581     {
2582         solver->parameters.algorithm = RIL_ALGO_SARSA;
2583     }
2584     if (0 == strcmp (string, "Q-LEARNING"))
2585     {
2586         solver->parameters.algorithm = RIL_ALGO_Q;
2587     }
2588
2589     GNUNET_free (string);
2590   }
2591   else
2592   {
2593     solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
2594   }
2595
2596   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_SELECT", &string))
2597   {
2598     solver->parameters.select = !strcmp (string, "EGREEDY") ? RIL_SELECT_EGREEDY : RIL_SELECT_SOFTMAX;
2599     GNUNET_free (string);
2600   }
2601   else
2602   {
2603     solver->parameters.select = RIL_DEFAULT_SELECT;
2604   }
2605
2606
2607   solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
2608   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2609       "RIL_DISCOUNT_BETA", &f_tmp))
2610   {
2611     if (f_tmp < 0.0)
2612     {
2613       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2614           "RIL_DISCOUNT_BETA", f_tmp);
2615     }
2616     else
2617     {
2618       solver->parameters.beta = f_tmp;
2619       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2620           "RIL_DISCOUNT_BETA", f_tmp);
2621     }
2622   }
2623
2624   solver->parameters.gamma = RIL_DEFAULT_DISCOUNT_GAMMA;
2625   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2626       "RIL_DISCOUNT_GAMMA", &f_tmp))
2627   {
2628     if ((f_tmp < 0.0) || (f_tmp > 1.0))
2629     {
2630       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2631           "RIL_DISCOUNT_GAMMA", f_tmp);
2632     }
2633     else
2634     {
2635       solver->parameters.gamma = f_tmp;
2636       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2637           "RIL_DISCOUNT_GAMMA", f_tmp);
2638     }
2639   }
2640
2641   solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
2642   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2643       "RIL_GRADIENT_STEP_SIZE", &f_tmp))
2644   {
2645     if ((f_tmp < 0.0) || (f_tmp > 1.0))
2646     {
2647       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2648           "RIL_GRADIENT_STEP_SIZE", f_tmp);
2649     }
2650     else
2651     {
2652       solver->parameters.alpha = f_tmp;
2653       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2654           "RIL_GRADIENT_STEP_SIZE", f_tmp);
2655     }
2656   }
2657
2658   solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
2659   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2660       "RIL_TRACE_DECAY", &f_tmp))
2661   {
2662     if ((f_tmp < 0.0) || (f_tmp > 1.0))
2663     {
2664       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2665           "RIL_TRACE_DECAY", f_tmp);
2666     }
2667     else
2668     {
2669       solver->parameters.lambda = f_tmp;
2670       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2671           "RIL_TRACE_DECAY", f_tmp);
2672     }
2673   }
2674
2675   solver->parameters.epsilon_init = RIL_DEFAULT_EXPLORE_RATIO;
2676   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2677       "RIL_EXPLORE_RATIO", &f_tmp))
2678   {
2679     if ((f_tmp < 0.0) || (f_tmp > 1.0))
2680     {
2681       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2682           "RIL_EXPLORE_RATIO", f_tmp);
2683     }
2684     else
2685     {
2686       solver->parameters.epsilon_init = f_tmp;
2687       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2688           "RIL_EXPLORE_RATIO", f_tmp);
2689     }
2690   }
2691
2692   solver->parameters.epsilon_decay = RIL_DEFAULT_EXPLORE_DECAY;
2693   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2694       "RIL_EXPLORE_DECAY", &f_tmp))
2695   {
2696     if ((f_tmp < 0.0) || (f_tmp > 1.0))
2697     {
2698       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2699           "RIL_EXPLORE_DECAY", f_tmp);
2700     }
2701     else
2702     {
2703       solver->parameters.epsilon_decay = f_tmp;
2704       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2705           "RIL_EXPLORE_DECAY", f_tmp);
2706     }
2707   }
2708
2709   solver->parameters.temperature_init = RIL_DEFAULT_TEMPERATURE;
2710   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2711       "RIL_TEMPERATURE", &f_tmp))
2712   {
2713     if (f_tmp <= 0.0)
2714     {
2715       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2716           "RIL_TEMPERATURE", f_tmp);
2717     }
2718     else
2719     {
2720       solver->parameters.temperature_init = f_tmp;
2721       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2722           "RIL_TEMPERATURE", f_tmp);
2723     }
2724   }
2725
2726   solver->parameters.temperature_decay = RIL_DEFAULT_TEMPERATURE_DECAY;
2727   if (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2728       "RIL_TEMPERATURE_DECAY", &f_tmp))
2729   {
2730     if ((f_tmp <= 0.0) || solver->parameters.temperature_decay > 1)
2731     {
2732       LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid %s configuration %f \n"),
2733           "RIL_TEMPERATURE_DECAY", f_tmp);
2734     }
2735     else
2736     {
2737       solver->parameters.temperature_decay = f_tmp;
2738       LOG (GNUNET_ERROR_TYPE_INFO, "Using %s of %.3f\n",
2739           "RIL_TEMPERATURE_DECAY", f_tmp);
2740     }
2741   }
2742
2743   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (env->cfg, "ats", "RIL_SIMULATE", &solver->simulate))
2744   {
2745     solver->simulate = GNUNET_NO;
2746   }
2747
2748   if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno(env->cfg, "ats", "RIL_REPLACE_TRACES"))
2749   {
2750     solver->parameters.eligibility_trace_mode = RIL_E_REPLACE;
2751   }
2752   else
2753   {
2754     solver->parameters.eligibility_trace_mode = RIL_E_ACCUMULATE;
2755   }
2756
2757   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_SOCIAL_WELFARE", &string))
2758   {
2759     solver->parameters.social_welfare = !strcmp (string, "NASH") ? RIL_WELFARE_NASH : RIL_WELFARE_EGALITARIAN;
2760     GNUNET_free (string);
2761   }
2762   else
2763   {
2764     solver->parameters.social_welfare = RIL_DEFAULT_WELFARE;
2765   }
2766
2767   solver->env = env;
2768   sf.cls = solver;
2769   sf.s_add = &GAS_ril_address_add;
2770   sf.s_address_update_property = &GAS_ril_address_property_changed;
2771   sf.s_get = &GAS_ril_get_preferred_address;
2772   sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
2773   sf.s_pref = &GAS_ril_address_change_preference;
2774   sf.s_feedback = &GAS_ril_address_preference_feedback;
2775   sf.s_del = &GAS_ril_address_delete;
2776   sf.s_bulk_start = &GAS_ril_bulk_start;
2777   sf.s_bulk_stop = &GAS_ril_bulk_stop;
2778
2779   solver->networks_count = env->network_count;
2780   solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Scope));
2781   solver->step_count = 0;
2782   solver->done = GNUNET_NO;
2783
2784   for (c = 0; c < env->network_count; c++)
2785   {
2786     cur = &solver->network_entries[c];
2787     cur->type = c;
2788     cur->bw_in_available = env->in_quota[c];
2789     cur->bw_out_available = env->out_quota[c];
2790     LOG (GNUNET_ERROR_TYPE_DEBUG,
2791          "init()  Quotas for %s network:  IN %llu - OUT %llu\n",
2792          GNUNET_ATS_print_network_type(cur->type),
2793          cur->bw_in_available/1024,
2794          cur->bw_out_available/1024);
2795   }
2796
2797   LOG(GNUNET_ERROR_TYPE_DEBUG, "init()  Parameters:\n");
2798   LOG(GNUNET_ERROR_TYPE_DEBUG, "init()  Algorithm = %s, alpha = %f, beta = %f, lambda = %f\n",
2799       solver->parameters.algorithm ? "Q" : "SARSA",
2800       solver->parameters.alpha,
2801       solver->parameters.beta,
2802       solver->parameters.lambda);
2803   LOG(GNUNET_ERROR_TYPE_DEBUG, "init()  exploration_ratio = %f, temperature = %f, ActionSelection = %s\n",
2804       solver->parameters.epsilon,
2805       solver->parameters.temperature,
2806       solver->parameters.select ? "EGREEDY" : "SOFTMAX");
2807   LOG(GNUNET_ERROR_TYPE_DEBUG, "init()  RBF_DIVISOR = %llu\n",
2808       solver->parameters.rbf_divisor);
2809
2810   return &sf;
2811 }
2812
2813
2814 /**
2815  * Exit point for the plugin
2816  *
2817  * @param cls the solver handle
2818  */
2819 void *
2820 libgnunet_plugin_ats_ril_done (void *cls)
2821 {
2822   struct GNUNET_ATS_SolverFunctions *sf = cls;
2823   struct GAS_RIL_Handle *s = sf->cls;
2824   struct RIL_Peer_Agent *cur_agent;
2825   struct RIL_Peer_Agent *next_agent;
2826
2827   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
2828
2829   s->done = GNUNET_YES;
2830
2831   cur_agent = s->agents_head;
2832   while (NULL != cur_agent)
2833   {
2834     next_agent = cur_agent->next;
2835     GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
2836     agent_die (s, cur_agent);
2837     cur_agent = next_agent;
2838   }
2839
2840   if (NULL != s->step_next_task_id)
2841   {
2842     GNUNET_SCHEDULER_cancel (s->step_next_task_id);
2843   }
2844   GNUNET_free(s->network_entries);
2845   GNUNET_free(s);
2846
2847   return NULL;
2848 }
2849
2850
2851 /* end of plugin_ats_ril.c */