src/ats/libgnunet_plugin_ats_ril.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/libgnunet_plugin_ats_ril.c
  23  * @brief ATS reinforcement learning solver
  24  * @author Fabian Oehlmann
  25  * @author Matthias Wachs
  26  */
  27 #include "libgnunet_plugin_ats_ril.h"
  28
  29 #define LOG(kind,...) GNUNET_log_from (kind, "ats-ril",__VA_ARGS__)
  30
  31 #define RIL_ACTION_INVALID -1
  32 #define RIL_FEATURES_ADDRESS_COUNT (3 + GNUNET_ATS_QualityPropertiesCount)
  33 #define RIL_FEATURES_NETWORK_COUNT 4
  34
  35 #define RIL_DEFAULT_STEP_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 3000)
  36 #define RIL_DEFAULT_ALGORITHM RIL_ALGO_Q
  37 #define RIL_DEFAULT_DISCOUNT_FACTOR 0.5
  38 #define RIL_DEFAULT_GRADIENT_STEP_SIZE 0.4
  39 #define RIL_DEFAULT_TRACE_DECAY 0.6
  40 #define RIL_EXPLORE_RATIO 0.1
  41
  42 /**
  43  * ATS reinforcement learning solver
  44  *
  45  * General description
  46  */
  47
  48 /**
  49  * The actions, how an agent can manipulate the current assignment. I.e. how the bandwidth can be
  50  * changed for the currently chosen address. Not depicted in the enum are the actions of switching
  51  * to a particular address. The action of switching to address with index i is depicted by the
  52  * number (RIL_ACTION_TYPE_NUM + i).
  53  */
  54 enum RIL_Action_Type
  55 {
  56   RIL_ACTION_NOTHING = 0,
  57   RIL_ACTION_BW_IN_DBL = 1,
  58   RIL_ACTION_BW_IN_HLV = 2,
  59   RIL_ACTION_BW_IN_INC = 3,
  60   RIL_ACTION_BW_IN_DEC = 4,
  61   RIL_ACTION_BW_OUT_DBL = 5,
  62   RIL_ACTION_BW_OUT_HLV = 6,
  63   RIL_ACTION_BW_OUT_INC = 7,
  64   RIL_ACTION_BW_OUT_DEC = 8,
  65   RIL_ACTION_TYPE_NUM = 9
  66 };
  67
  68 enum RIL_Algorithm
  69 {
  70   RIL_ALGO_SARSA = 0,
  71   RIL_ALGO_Q = 1
  72 };
  73
  74 enum RIL_E_Modification
  75 {
  76   RIL_E_SET,
  77   RIL_E_ZERO,
  78   RIL_E_ACCUMULATE,
  79   RIL_E_REPLACE
  80 };
  81
  82 /**
  83  * Global learning parameters
  84  */
  85 struct RIL_Learning_Parameters
  86 {
  87   /**
  88    * The TD-algorithm to use
  89    */
  90   enum RIL_Algorithm algorithm;
  91
  92   /**
  93    * Learning discount factor in the TD-update
  94    */
  95   float gamma;
  96
  97   /**
  98    * Gradient-descent step-size
  99    */
 100   float alpha;
 101
 102   /**
 103    * Trace-decay factor for eligibility traces
 104    */
 105   float lambda;
 106 };
 107
 108 /**
 109  * Wrapper for addresses to store them in agent's linked list
 110  */
 111 struct RIL_Address_Wrapped
 112 {
 113   /**
 114    * Next in DLL
 115    */
 116   struct RIL_Address_Wrapped *next;
 117
 118   /**
 119    * Previous in DLL
 120    */
 121   struct RIL_Address_Wrapped *prev;
 122
 123   /**
 124    * The address
 125    */
 126   struct ATS_Address *address_naked;
 127 };
 128
 129 struct RIL_Peer_Agent
 130 {
 131   /**
 132    * Next agent in solver's linked list
 133    */
 134   struct RIL_Peer_Agent *next;
 135
 136   /**
 137    * Previous agent in solver's linked list
 138    */
 139   struct RIL_Peer_Agent *prev;
 140
 141   /**
 142    * Environment handle
 143    */
 144   struct GAS_RIL_Handle *envi;
 145
 146   /**
 147    * Peer ID
 148    */
 149   struct GNUNET_PeerIdentity peer;
 150
 151   /**
 152    * Whether the agent is active or not
 153    */
 154   int active;
 155
 156   /**
 157    * Number of performed time-steps
 158    */
 159   unsigned long long step_count;
 160
 161   /**
 162    * Experience matrix W
 163    */
 164   double ** W;
 165
 166   /**
 167    * Number of rows of W / Number of state-vector features
 168    */
 169   unsigned int m;
 170
 171   /**
 172    * Number of columns of W / Number of actions
 173    */
 174   unsigned int n;
 175
 176   /**
 177    * Last perceived state feature vector
 178    */
 179   double * s_old;
 180
 181   /**
 182    * Last chosen action
 183    */
 184   int a_old;
 185
 186   /**
 187    * Eligibility trace vector
 188    */
 189   double * e;
 190
 191   /**
 192    * Address in use
 193    */
 194   struct ATS_Address * address_inuse;
 195
 196   /**
 197    * Head of addresses DLL
 198    */
 199   struct RIL_Address_Wrapped * addresses_head;
 200
 201   /**
 202    * Tail of addresses DLL
 203    */
 204   struct RIL_Address_Wrapped * addresses_tail;
 205
 206   /**
 207    * Inbound bandwidth assigned by the agent
 208    */
 209   unsigned long long bw_in;
 210
 211   /**
 212    * Outbound bandwidth assigned by the agent
 213    */
 214   unsigned long long bw_out;
 215 };
 216
 217 struct RIL_Network
 218 {
 219   /**
 220    * ATS network type
 221    */
 222   enum GNUNET_ATS_Network_Type type;
 223
 224   /**
 225    * Total available inbound bandwidth
 226    */
 227   unsigned long long bw_in_available;
 228
 229   /**
 230    * Total assigned outbound bandwidth
 231    */
 232   unsigned long long bw_in_assigned;
 233
 234   /**
 235    * Total available outbound bandwidth
 236    */
 237   unsigned long long bw_out_available;
 238
 239   /**
 240    * Total assigned outbound bandwidth
 241    */
 242   unsigned long long bw_out_assigned;
 243 };
 244
 245 /**
 246  * A handle for the reinforcement learning solver
 247  */
 248 struct GAS_RIL_Handle
 249 {
 250   /**
 251    *
 252    */
 253   struct GNUNET_ATS_PluginEnvironment *plugin_envi;
 254
 255   /**
 256    * Statistics handle
 257    */
 258   struct GNUNET_STATISTICS_Handle *stats;
 259
 260   /**
 261    * Number of performed time-steps
 262    */
 263   unsigned long long step_count;
 264
 265   /**
 266    * Interval time between steps in milliseconds //TODO? Future Work: Heterogeneous stepping among agents
 267    */
 268   struct GNUNET_TIME_Relative step_time;
 269
 270   /**
 271    * Task identifier of the next time-step to be executed
 272    */
 273   GNUNET_SCHEDULER_TaskIdentifier next_step;
 274
 275   /**
 276    * Learning parameters
 277    */
 278   struct RIL_Learning_Parameters parameters;
 279
 280   /**
 281    * Array of networks with global assignment state
 282    */
 283   struct RIL_Network * network_entries;
 284
 285   /**
 286    * Networks count
 287    */
 288   unsigned int networks_count;
 289
 290   /**
 291    * List of active peer-agents
 292    */
 293   struct RIL_Peer_Agent * agents_head;
 294   struct RIL_Peer_Agent * agents_tail;
 295 };
 296
 297 /*
 298  *  Private functions
 299  *  ---------------------------
 300  */
 301
 302 /**
 303  * Estimate the current action-value for state s and action a
 304  *
 305  * @param agent agent performing the estimation
 306  * @param state s
 307  * @param action a
 308  * @return estimation value
 309  */
 310 static double
 311 agent_estimate_q (struct RIL_Peer_Agent *agent, double *state, int action)
 312 {
 313   int i;
 314   double result = 0;
 315
 316   for (i = 0; i < agent->m; i++)
 317   {
 318     result += state[i] * agent->W[action][i];
 319   }
 320
 321   return result;
 322 }
 323
 324 /**
 325  * Decide whether to do exploration (i.e. taking a new action) or exploitation (i.e. taking the
 326  * currently estimated best action) in the current step
 327  *
 328  * @param agent agent performing the step
 329  * @return yes, if exploring
 330  */
 331 static int
 332 agent_decide_exploration (struct RIL_Peer_Agent *agent)
 333 {
 334   //TODO? Future Work: Improve exploration/exploitation trade-off by different mechanisms than e-greedy
 335   /*
 336    * An e-greedy replacement could be based on the accuracy of the prediction of the Q-value
 337    */
 338   double r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 339       UINT32_MAX) / (double) UINT32_MAX;
 340
 341 if  (r < RIL_EXPLORE_RATIO)
 342   {
 343     return GNUNET_YES;
 344   }
 345   return GNUNET_NO;
 346 }
 347
 348   /**
 349    * Get the index of the address in the agent's list.
 350    *
 351    * @param agent agent handle
 352    * @param address address handle
 353    * @return the index, starting with zero
 354    */
 355 static int
 356 agent_address_get_index (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
 357 {
 358   int i;
 359   struct RIL_Address_Wrapped *cur;
 360
 361   i = -1;
 362   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
 363   {
 364     i++;
 365     if (cur->address_naked == address)
 366     {
 367       return i;
 368     }
 369   }
 370
 371   return i;
 372 }
 373
 374 /**
 375  * Gets the wrapped address from the agent's list
 376  *
 377  * @param agent agent handle
 378  * @param address address handle
 379  * @return wrapped address
 380  */
 381 static struct RIL_Address_Wrapped *
 382 agent_address_get (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
 383 {
 384   struct RIL_Address_Wrapped *cur;
 385
 386   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
 387   {
 388     if (cur->address_naked == address)
 389     {
 390       return cur;
 391     }
 392   }
 393
 394   return NULL ;
 395 }
 396
 397 /**
 398  * Gets the action, with the maximal estimated Q-value (i.e. the one currently estimated to bring the
 399  * most reward in the future)
 400  *
 401  * @param agent agent performing the calculation
 402  * @param state the state from which to take the action
 403  * @return the action promising most future reward
 404  */
 405 static int
 406 agent_get_action_best (struct RIL_Peer_Agent *agent, double *state)
 407 {
 408   int i;
 409   int max_i = RIL_ACTION_INVALID;
 410   double cur_q;
 411   double max_q = -DBL_MAX;
 412
 413   for (i = 0; i < agent->n; i++)
 414   {
 415     cur_q = agent_estimate_q (agent, state, i);
 416     if (cur_q > max_q)
 417     {
 418       max_q = cur_q;
 419       max_i = i;
 420     }
 421   }
 422
 423   GNUNET_assert(RIL_ACTION_INVALID != max_i);
 424
 425   return max_i;
 426 }
 427
 428 /**
 429  * Gets any action, to explore the action space from that state
 430  *
 431  * @param agent agent performing the calculation
 432  * @param state the state from which to take the action
 433  * @return any action
 434  */
 435 static int
 436 agent_get_action_explore (struct RIL_Peer_Agent *agent, double *state)
 437 {
 438   // TODO?: Future Work: Choose the action for exploration, which has been explored the least in this state
 439   return GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, agent->n);
 440 }
 441
 442 /**
 443  * Updates the weights (i.e. coefficients) of the weight vector in matrix W for action a
 444  *
 445  * @param agent the agent performing the update
 446  * @param reward the reward received for the last action
 447  * @param s_next the new state, the last step got the agent into
 448  * @param a_prime the new
 449  */
 450 static void
 451 agent_update_weights (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a_prime)
 452 {
 453   int i;
 454   double delta;
 455   double *theta = agent->W[agent->a_old];
 456
 457   delta = reward + agent_estimate_q (agent, s_next, a_prime)
 458       - agent_estimate_q (agent, agent->s_old, agent->a_old);
 459   for (i = 0; i < agent->m; i++)
 460   {
 461     theta[i] += agent->envi->parameters.alpha * delta * (agent->e)[i];
 462   }
 463 }
 464
 465 /**
 466  * Changes the eligibility trace vector e in various manners:
 467  * RIL_E_ACCUMULATE - adds 1 to each component as in accumulating eligibility traces
 468  * RIL_E_REPLACE - resets each component to 1 as in replacing traces
 469  * RIL_E_SET - multiplies e with gamma and lambda as in the update rule
 470  * RIL_E_ZERO - sets e to 0 as in Watkin's Q-learning algorithm when exploring and when initializing
 471  *
 472  * @param agent the agent handle
 473  * @param mod the kind of modification
 474  */
 475 static void
 476 agent_modify_eligibility (struct RIL_Peer_Agent *agent, enum RIL_E_Modification mod)
 477 {
 478   int i;
 479   double *e = agent->e;
 480   double gamma = agent->envi->parameters.gamma;
 481   double lambda = agent->envi->parameters.lambda;
 482
 483   for (i = 0; i < agent->m; i++)
 484   {
 485     switch (mod)
 486     {
 487     case RIL_E_ACCUMULATE:
 488       e[i] += 1;
 489       break;
 490     case RIL_E_REPLACE:
 491       e[i] = 1;
 492       break;
 493     case RIL_E_SET:
 494       e[i] = gamma * lambda;
 495       break;
 496     case RIL_E_ZERO:
 497       e[i] = 0;
 498       break;
 499     }
 500   }
 501 }
 502
 503 /**
 504  * Changes the active assignment suggestion of the handler and invokes the bw_changed callback to
 505  * notify ATS of its new decision
 506  *
 507  * @param solver solver handle
 508  * @param agent agent handle
 509  * @param new_address the address which is to be used
 510  * @param new_bw_in the new amount of inbound bandwidth set for this address
 511  * @param new_bw_out the new amount of outbound bandwidth set for this address
 512  * @param silent disables invocation of the bw_changed callback, if GNUNET_YES
 513  */
 514 static void
 515 envi_set_active_suggestion (struct GAS_RIL_Handle *solver,
 516     struct RIL_Peer_Agent *agent,
 517     struct ATS_Address *new_address,
 518     unsigned long long new_bw_in,
 519     unsigned long long new_bw_out,
 520     int silent)
 521 {
 522   int notify = GNUNET_NO;
 523
 524   LOG(GNUNET_ERROR_TYPE_DEBUG, "set_active_suggestion()\n");
 525
 526   //address change
 527   if (agent->address_inuse != new_address)
 528   {
 529     if (NULL != agent->address_inuse)
 530     {
 531       agent->address_inuse->active = GNUNET_NO;
 532       agent->address_inuse->assigned_bw_in.value__ = htonl (0);
 533       agent->address_inuse->assigned_bw_out.value__ = htonl (0);
 534     }
 535     if (NULL != new_address)
 536     {
 537       LOG(GNUNET_ERROR_TYPE_DEBUG, "set address active: %s\n", agent->active ? "yes" : "no");
 538       new_address->active = agent->active;
 539       new_address->assigned_bw_in.value__ = htonl (agent->bw_in);
 540       new_address->assigned_bw_out.value__ = htonl (agent->bw_out);
 541     }
 542     notify |= GNUNET_YES;
 543   }
 544
 545   if (new_address)
 546   {
 547     //activity change
 548     if (new_address->active != agent->active)
 549     {
 550       new_address->active = agent->active;
 551     }
 552
 553     //bw change
 554     if (agent->bw_in != new_bw_in)
 555     {
 556       agent->bw_in = new_bw_in;
 557       new_address->assigned_bw_in.value__ = htonl (new_bw_out);
 558       notify |= GNUNET_YES;
 559     }
 560     if (agent->bw_out != new_bw_out)
 561     {
 562       agent->bw_out = new_bw_out;
 563       new_address->assigned_bw_out.value__ = htonl (new_bw_out);
 564       notify |= GNUNET_YES;
 565     }
 566   }
 567
 568   if (notify && agent->active && (GNUNET_NO == silent))
 569   {
 570     if (new_address)
 571     {
 572       solver->plugin_envi->bandwidth_changed_cb (solver->plugin_envi->bw_changed_cb_cls,
 573           new_address);
 574     }
 575     else if (agent->address_inuse)
 576     {
 577       GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_in.value__));
 578       GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_out.value__));
 579       agent->bw_in = 0;
 580       agent->bw_out = 0;
 581       //disconnect
 582       solver->plugin_envi->bandwidth_changed_cb (solver->plugin_envi->bw_changed_cb_cls,
 583           agent->address_inuse);
 584     }
 585   }
 586   agent->address_inuse = new_address;
 587 }
 588
 589 /**
 590  * Allocates a state vector and fills it with the features present
 591  *
 592  * @param solver the solver handle
 593  * @return pointer to the state vector
 594  */
 595 static double *
 596 envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
 597 {
 598   int i;
 599   int k;
 600   struct RIL_Network *net;
 601   double *state = GNUNET_malloc (sizeof (double) * agent->m);
 602   struct RIL_Address_Wrapped *cur_address;
 603   const double *properties;
 604
 605   for (i = 0; i < solver->networks_count; i++)
 606   {
 607     net = &solver->network_entries[i];
 608     state[i * RIL_FEATURES_NETWORK_COUNT + 0] = (double) net->bw_in_assigned;
 609     state[i * RIL_FEATURES_NETWORK_COUNT + 1] = (double) net->bw_in_available;
 610     state[i * RIL_FEATURES_NETWORK_COUNT + 2] = (double) net->bw_out_assigned;
 611     state[i * RIL_FEATURES_NETWORK_COUNT + 3] = (double) net->bw_out_available;
 612   }
 613
 614   i = i * RIL_FEATURES_NETWORK_COUNT; //first address feature
 615
 616   for (cur_address = agent->addresses_head; NULL != cur_address; cur_address = cur_address->next)
 617   {
 618     state[i++] = cur_address->address_naked->active;
 619     state[i++] = cur_address->address_naked->active ? agent->bw_in : 0;
 620     state[i++] = cur_address->address_naked->active ? agent->bw_out : 0;
 621     properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
 622         cur_address->address_naked);
 623     for (k = 0; k < GNUNET_ATS_QualityPropertiesCount; k++)
 624     {
 625       state[i++] = properties[k];
 626     }
 627   }
 628
 629   return state;
 630 }
 631
 632 /**
 633  * For all networks a peer has an address in, this gets the maximum bandwidth which could
 634  * theoretically be available in one of the networks. This is used for bandwidth normalization.
 635  *
 636  * @param solver the solver handle
 637  * @param agent the agent handle
 638  * @param direction_in whether the inbound bandwidth should be considered. Returns the maximum outbound bandwidth if GNUNET_NO
 639  */
 640 static long long unsigned
 641 ril_get_max_bw (struct RIL_Peer_Agent *agent, int direction_in)
 642 {
 643   /*
 644    * get the maximum bandwidth possible for a peer, e.g. among all addresses which addresses'
 645    * network could provide the maximum bandwidth if all that bandwidth was used on that one peer.
 646    */
 647   int max = 0;
 648   struct RIL_Address_Wrapped *cur;
 649   struct RIL_Network *net;
 650
 651   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
 652   {
 653     net = cur->address_naked->solver_information;
 654     if (direction_in)
 655     {
 656       if (net->bw_in_available > max)
 657       {
 658         max = net->bw_in_available;
 659       }
 660     }
 661     else
 662     {
 663       if (net->bw_out_available > max)
 664       {
 665         max = net->bw_out_available;
 666       }
 667     }
 668   }
 669   return max;
 670 }
 671
 672 /**
 673  * Get the index of the quality-property in question
 674  *
 675  * @param type the quality property type
 676  * @return the index
 677  */
 678 static int
 679 ril_find_property_index (uint32_t type)
 680 {
 681   int existing_types[] = GNUNET_ATS_QualityProperties;
 682   int c;
 683   for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
 684     if (existing_types[c] == type)
 685       return c;
 686   return GNUNET_SYSERR;
 687 }
 688
 689 /**
 690  * Gets the reward for the last performed step
 691  *
 692  * @param solver solver handle
 693  * @return the reward
 694  */
 695 static double
 696 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
 697 {
 698   /*
 699    * - Match the preferences of the peer with the current assignment
 700    * - Validity of the solution
 701    */
 702   const double *preferences;
 703   const double *properties;
 704   double pref_match = 0;
 705   double bw_norm;
 706   struct RIL_Network *net;
 707   int prop_index;
 708
 709   preferences = solver->plugin_envi->get_preferences (solver->plugin_envi->get_preference_cls,
 710       &agent->peer);
 711   properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
 712       agent->address_inuse);
 713   prop_index = ril_find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
 714   pref_match += preferences[GNUNET_ATS_PREFERENCE_LATENCY] * (3 - properties[prop_index]); //invert property as we want to maximize for lower latencies
 715   bw_norm = GNUNET_MAX(2, (((
 716                   ((double) agent->bw_in / (double) ril_get_max_bw(agent, GNUNET_YES)) +
 717                   ((double) agent->bw_out / (double) ril_get_max_bw(agent, GNUNET_NO))
 718               ) / 2
 719           ) + 1));
 720   pref_match += preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] * bw_norm;
 721
 722   net = agent->address_inuse->solver_information;
 723   if ((net->bw_in_assigned > net->bw_in_available) || (net->bw_out_assigned > net->bw_out_available))
 724   {
 725     return -1;
 726   }
 727
 728   return pref_match;
 729 }
 730
 731 /**
 732  * Doubles the bandwidth for the active address
 733  *
 734  * @param solver solver handle
 735  * @param agent agent handle
 736  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
 737  */
 738 static void
 739 envi_action_bw_double (struct GAS_RIL_Handle *solver,
 740     struct RIL_Peer_Agent *agent,
 741     int direction_in)
 742 {
 743   if (direction_in)
 744   {
 745     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in * 2,
 746         agent->bw_out, GNUNET_NO);
 747   }
 748   else
 749   {
 750     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
 751         agent->bw_out * 2, GNUNET_NO);
 752   }
 753 }
 754
 755 /**
 756  * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
 757  * the minimum bandwidth for a peer, in order to not invoke a disconnect.
 758  *
 759  * @param solver solver handle
 760  * @param agent agent handle
 761  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
 762  * bandwidth
 763  */
 764 static void
 765 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
 766     struct RIL_Peer_Agent *agent,
 767     int direction_in)
 768 {
 769   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 770   unsigned long long new_bw;
 771
 772   if (direction_in)
 773   {
 774     new_bw = agent->bw_in / 2;
 775     if (new_bw < min_bw)
 776       new_bw = min_bw;
 777     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
 778         GNUNET_NO);
 779   }
 780   else
 781   {
 782     new_bw = agent->bw_out / 2;
 783     if (new_bw < min_bw)
 784       new_bw = min_bw;
 785     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
 786         GNUNET_NO);
 787   }
 788 }
 789
 790 /**
 791  * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
 792  *
 793  * @param solver solver handle
 794  * @param agent agent handle
 795  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
 796  * bandwidth
 797  */
 798 static void
 799 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
 800 {
 801   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 802
 803   if (direction_in)
 804   {
 805     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in + (5 * min_bw),
 806         agent->bw_out, GNUNET_NO);
 807   }
 808   else
 809   {
 810     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
 811         agent->bw_out + (5 * min_bw), GNUNET_NO);
 812   }
 813 }
 814
 815 /**
 816  * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
 817  * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
 818  *
 819  * @param solver solver handle
 820  * @param agent agent handle
 821  * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
 822  * bandwidth
 823  */
 824 static void
 825 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
 826 {
 827   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 828   unsigned long long new_bw;
 829
 830   if (direction_in)
 831   {
 832     new_bw = agent->bw_in - (5 * min_bw);
 833     if (new_bw < min_bw)
 834       new_bw = min_bw;
 835     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
 836         GNUNET_NO);
 837   }
 838   else
 839   {
 840     new_bw = agent->bw_out - (5 * min_bw);
 841     if (new_bw < min_bw)
 842       new_bw = min_bw;
 843     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
 844         GNUNET_NO);
 845   }
 846 }
 847
 848 /**
 849  * Switches to the address given by its index
 850  *
 851  * @param solver solver handle
 852  * @param agent agent handle
 853  * @param address_index index of the address as it is saved in the agent's list, starting with zero
 854  */
 855 static void
 856 envi_action_address_switch (struct GAS_RIL_Handle *solver,
 857     struct RIL_Peer_Agent *agent,
 858     unsigned int address_index)
 859 {
 860   struct RIL_Address_Wrapped *cur;
 861   int i = 0;
 862
 863   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
 864   {
 865     if (i == address_index)
 866     {
 867       envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
 868           GNUNET_NO);
 869       return;
 870     }
 871
 872     i++;
 873   }
 874
 875   //no address with address_index exists, in this case this action should not be callable
 876   GNUNET_assert(GNUNET_NO);
 877 }
 878
 879 /**
 880  * Puts the action into effect by calling the according function
 881  *
 882  * @param solver solver handle
 883  * @param action action to perform by the solver
 884  */
 885 static void
 886 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
 887 {
 888   int address_index;
 889
 890   switch (action)
 891   {
 892   case RIL_ACTION_NOTHING:
 893     break;
 894   case RIL_ACTION_BW_IN_DBL:
 895     envi_action_bw_double (solver, agent, GNUNET_YES);
 896     break;
 897   case RIL_ACTION_BW_IN_HLV:
 898     envi_action_bw_halven (solver, agent, GNUNET_YES);
 899     break;
 900   case RIL_ACTION_BW_IN_INC:
 901     envi_action_bw_inc (solver, agent, GNUNET_YES);
 902     break;
 903   case RIL_ACTION_BW_IN_DEC:
 904     envi_action_bw_dec (solver, agent, GNUNET_YES);
 905     break;
 906   case RIL_ACTION_BW_OUT_DBL:
 907     envi_action_bw_double (solver, agent, GNUNET_NO);
 908     break;
 909   case RIL_ACTION_BW_OUT_HLV:
 910     envi_action_bw_halven (solver, agent, GNUNET_NO);
 911     break;
 912   case RIL_ACTION_BW_OUT_INC:
 913     envi_action_bw_inc (solver, agent, GNUNET_NO);
 914     break;
 915   case RIL_ACTION_BW_OUT_DEC:
 916     envi_action_bw_dec (solver, agent, GNUNET_NO);
 917     break;
 918   default:
 919     if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
 920     {
 921       address_index = action - RIL_ACTION_TYPE_NUM;
 922
 923       GNUNET_assert(address_index >= 0);
 924       GNUNET_assert(
 925           address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
 926
 927       envi_action_address_switch (solver, agent, address_index);
 928       break;
 929     }
 930     // error - action does not exist
 931     GNUNET_assert(GNUNET_NO);
 932   }
 933 }
 934
 935 /**
 936  * Performs one step of the Markov Decision Process. Other than in the literature the step starts
 937  * after having done the last action a_old. It observes the new state s_next and the reward
 938  * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
 939  * next action is put into effect.
 940  *
 941  * @param agent the agent performing the step
 942  */
 943 static void
 944 agent_step (struct RIL_Peer_Agent *agent)
 945 {
 946   int a_next = RIL_ACTION_INVALID;
 947   double *s_next;
 948   double reward;
 949
 950   s_next = envi_get_state (agent->envi, agent);
 951   reward = envi_get_reward (agent->envi, agent);
 952
 953   LOG(GNUNET_ERROR_TYPE_DEBUG, "agent_step() with algorithm %s\n",
 954       agent->envi->parameters.algorithm ? "Q" : "SARSA");
 955
 956   switch (agent->envi->parameters.algorithm)
 957   {
 958   case RIL_ALGO_SARSA:
 959     agent_modify_eligibility (agent, RIL_E_SET);
 960     if (agent_decide_exploration (agent))
 961     {
 962       a_next = agent_get_action_explore (agent, s_next);
 963     }
 964     else
 965     {
 966       a_next = agent_get_action_best (agent, s_next);
 967     }
 968     if (RIL_ACTION_INVALID != agent->a_old)
 969     {
 970       //updates weights with selected action (on-policy), if not first step
 971       agent_update_weights (agent, reward, s_next, a_next);
 972     }
 973     break;
 974
 975   case RIL_ALGO_Q:
 976     a_next = agent_get_action_best (agent, s_next);
 977     if (RIL_ACTION_INVALID != agent->a_old)
 978     {
 979       //updates weights with best action, disregarding actually selected action (off-policy), if not first step
 980       agent_update_weights (agent, reward, s_next, a_next);
 981     }
 982     if (agent_decide_exploration (agent))
 983     {
 984       a_next = agent_get_action_explore (agent, s_next);
 985       agent_modify_eligibility (agent, RIL_E_ZERO);
 986     }
 987     else
 988     {
 989       a_next = agent_get_action_best (agent, s_next);
 990       agent_modify_eligibility (agent, RIL_E_SET);
 991     }
 992     break;
 993   }
 994
 995   GNUNET_assert(RIL_ACTION_INVALID != a_next);
 996
 997   agent_modify_eligibility (agent, RIL_E_ACCUMULATE);
 998
 999   envi_do_action (agent->envi, agent, a_next);
1000
1001   GNUNET_free(agent->s_old);
1002   agent->s_old = s_next;
1003   agent->a_old = a_next;
1004
1005   agent->step_count += 1;
1006 }
1007
1008 /**
1009  * Cycles through all agents and lets the active ones do a step. Schedules the next step.
1010  *
1011  * @param solver the solver handle
1012  * @param tc task context for the scheduler
1013  */
1014 static void
1015 ril_periodic_step (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1016 {
1017   struct GAS_RIL_Handle *solver = cls;
1018   struct RIL_Peer_Agent *cur;
1019
1020   LOG(GNUNET_ERROR_TYPE_DEBUG, "RIL step number %d\n", solver->step_count);
1021
1022   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1023   {
1024     if (cur->active && cur->address_inuse)
1025     {
1026       agent_step (cur);
1027     }
1028   }
1029
1030   solver->step_count += 1;
1031   solver->next_step = GNUNET_SCHEDULER_add_delayed (solver->step_time, &ril_periodic_step, solver);
1032 }
1033
1034 /**
1035  * Initialize an agent without addresses and its knowledge base
1036  *
1037  * @param s ril solver
1038  * @param peer the one in question
1039  * @return handle to the new agent
1040  */
1041 static struct RIL_Peer_Agent *
1042 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1043 {
1044   int i;
1045   struct GAS_RIL_Handle * solver = s;
1046   struct RIL_Peer_Agent * agent = GNUNET_malloc (sizeof (struct RIL_Peer_Agent));
1047
1048   agent->envi = solver;
1049   agent->peer = *peer;
1050   agent->step_count = 0;
1051   agent->active = GNUNET_NO;
1052   agent->n = RIL_ACTION_TYPE_NUM;
1053   agent->m = solver->networks_count * RIL_FEATURES_NETWORK_COUNT;
1054   agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1055   for (i = 0; i < agent->n; i++)
1056   {
1057     agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1058   }
1059   agent->a_old = RIL_ACTION_INVALID;
1060   agent->s_old = envi_get_state (solver, agent);
1061   agent->e = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1062   agent_modify_eligibility (agent, RIL_E_ZERO);
1063
1064   GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, agent);
1065
1066   return agent;
1067 }
1068
1069 /**
1070  * Deallocate agent
1071  *
1072  * @param s solver handle
1073  * @param agent the agent to retire
1074  */
1075 static void
1076 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1077 {
1078   int i;
1079
1080   for (i = 0; i < agent->n; i++)
1081   {
1082     GNUNET_free(agent->W[i]);
1083   }
1084   GNUNET_free(agent->W);
1085   GNUNET_free(agent->e);
1086   GNUNET_free(agent->s_old);
1087   GNUNET_free(agent);
1088 }
1089
1090 /**
1091  * Returns the agent for a peer
1092  *
1093  * @param s solver handle
1094  * @param peer identity of the peer
1095  * @param create whether to create an agent if none is allocated yet
1096  * @return agent
1097  */
1098 static struct RIL_Peer_Agent *
1099 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
1100 {
1101   struct RIL_Peer_Agent *cur;
1102
1103   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1104   {
1105     if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
1106     {
1107       return cur;
1108     }
1109   }
1110
1111   if (create)
1112   {
1113     return agent_init (solver, peer);
1114   }
1115   return NULL ;
1116 }
1117
1118 /**
1119  * Lookup network struct by type
1120  *
1121  * @param s the solver handle
1122  * @param type the network type
1123  * @return the network struct
1124  */
1125 static struct RIL_Network *
1126 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1127 {
1128   int i;
1129
1130   for (i = 0; i < s->networks_count; i++)
1131   {
1132     if (s->network_entries[i].type == type)
1133     {
1134       return &s->network_entries[i];
1135     }
1136   }
1137   return NULL ;
1138 }
1139
1140 /**
1141  * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
1142  * considered inactive and not used. Addresses in an inactive network are ignored.
1143  *
1144  * @param solver solver handle
1145  * @param network the network type
1146  * @return whether or not the network is considered active
1147  */
1148 static int
1149 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1150 {
1151   struct RIL_Network *net;
1152   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1153
1154   net = ril_get_network (solver, network);
1155   if (net->bw_out_available < min_bw)
1156     return GNUNET_NO;
1157   return GNUNET_YES;
1158 }
1159
1160 /**
1161  * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
1162  * the reward function approximation. It copies the memory, which is not cut, to the new vector,
1163  * frees the memory of the old vector, and redirects the pointer to the new one.
1164  *
1165  * @param old pointer to the pointer to the first element of the vector
1166  * @param element_size byte size of the vector elements
1167  * @param hole_start the first element to cut out
1168  * @param hole_length the number of elements to cut out
1169  * @param old_length the length of the old vector
1170  */
1171 static void
1172 ril_cut_from_vector (void **old,
1173     size_t element_size,
1174     unsigned int hole_start,
1175     unsigned int hole_length,
1176     unsigned int old_length)
1177 {
1178   char *tmpptr;
1179   char *oldptr = (char *) *old;
1180   size_t size;
1181   unsigned int bytes_before;
1182   unsigned int bytes_hole;
1183   unsigned int bytes_after;
1184
1185   GNUNET_assert(old_length > hole_length);
1186   GNUNET_assert(old_length >= (hole_start + hole_length));
1187
1188   size = element_size * (old_length - hole_length);
1189
1190   bytes_before = element_size * hole_start;
1191   bytes_hole = element_size * hole_length;
1192   bytes_after = element_size * (old_length - hole_start - hole_length);
1193
1194   if (0 == size)
1195   {
1196     tmpptr = NULL;
1197   }
1198   else
1199   {
1200     tmpptr = GNUNET_malloc (size);
1201     memcpy (tmpptr, oldptr, bytes_before);
1202     memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
1203   }
1204   if (NULL != *old)
1205   {
1206     GNUNET_free(*old);
1207   }
1208   *old = (void *) tmpptr;
1209 }
1210
1211 /*
1212  *  Solver API functions
1213  *  ---------------------------
1214  */
1215
1216 /**
1217  * Change relative preference for quality in solver
1218  *
1219  * @param solver the solver handle
1220  * @param peer the peer to change the preference for
1221  * @param kind the kind to change the preference
1222  * @param pref_rel the normalized preference value for this kind over all clients
1223  */
1224 void
1225 GAS_ril_address_change_preference (void *s,
1226     const struct GNUNET_PeerIdentity *peer,
1227     enum GNUNET_ATS_PreferenceKind kind,
1228     double pref_rel)
1229 {
1230   LOG(GNUNET_ERROR_TYPE_DEBUG,
1231       "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
1232       GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
1233   /*
1234    * Nothing to do here. Preferences are considered during reward calculation.
1235    */
1236 }
1237
1238 /**
1239  * Entry point for the plugin
1240  *
1241  * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
1242  */
1243 void *
1244 libgnunet_plugin_ats_ril_init (void *cls)
1245 {
1246   struct GNUNET_ATS_PluginEnvironment *env = cls;
1247   struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
1248   struct RIL_Network * cur;
1249   int c;
1250   unsigned long long tmp;
1251   char *string;
1252
1253   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
1254
1255   GNUNET_assert(NULL != env);
1256   GNUNET_assert(NULL != env->cfg);
1257   GNUNET_assert(NULL != env->stats);
1258   GNUNET_assert(NULL != env->bandwidth_changed_cb);
1259   GNUNET_assert(NULL != env->get_preferences);
1260   GNUNET_assert(NULL != env->get_property);
1261
1262   if (GNUNET_OK
1263       != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME", &solver->step_time))
1264   {
1265     solver->step_time = RIL_DEFAULT_STEP_TIME;
1266   }
1267   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string)
1268       && NULL != string && 0 == strcmp (string, "SARSA"))
1269   {
1270     solver->parameters.algorithm = RIL_ALGO_SARSA;
1271   }
1272   else
1273   {
1274     solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
1275   }
1276   if (GNUNET_OK
1277       == GNUNET_CONFIGURATION_get_value_size (env->cfg, "ats", "RIL_DISCOUNT_FACTOR", &tmp))
1278   {
1279     solver->parameters.gamma = (double) tmp / 100;
1280   }
1281   else
1282   {
1283     solver->parameters.gamma = RIL_DEFAULT_DISCOUNT_FACTOR;
1284   }
1285   if (GNUNET_OK
1286       == GNUNET_CONFIGURATION_get_value_size (env->cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &tmp))
1287   {
1288     solver->parameters.alpha = (double) tmp / 100;
1289   }
1290   else
1291   {
1292     solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
1293   }
1294   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (env->cfg, "ats", "RIL_TRACE_DECAY", &tmp))
1295   {
1296     solver->parameters.lambda = (double) tmp / 100;
1297   }
1298   else
1299   {
1300     solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
1301   }
1302
1303   env->sf.s_add = &GAS_ril_address_add;
1304   env->sf.s_address_update_property = &GAS_ril_address_property_changed;
1305   env->sf.s_address_update_session = &GAS_ril_address_session_changed;
1306   env->sf.s_address_update_inuse = &GAS_ril_address_inuse_changed;
1307   env->sf.s_address_update_network = &GAS_ril_address_change_network;
1308   env->sf.s_get = &GAS_ril_get_preferred_address;
1309   env->sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
1310   env->sf.s_pref = &GAS_ril_address_change_preference;
1311   env->sf.s_feedback = &GAS_ril_address_preference_feedback;
1312   env->sf.s_del = &GAS_ril_address_delete;
1313   env->sf.s_bulk_start = &GAS_ril_bulk_start;
1314   env->sf.s_bulk_stop = &GAS_ril_bulk_stop;
1315
1316   solver->plugin_envi = env;
1317   solver->networks_count = env->network_count;
1318   solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Network));
1319   solver->step_count = 0;
1320
1321   for (c = 0; c < env->network_count; c++)
1322   {
1323     cur = &solver->network_entries[c];
1324     cur->type = env->networks[c];
1325     cur->bw_in_available = env->in_quota[c];
1326     cur->bw_in_assigned = 0;
1327     cur->bw_out_available = env->out_quota[c];
1328     cur->bw_out_assigned = 0;
1329   }
1330
1331   solver->next_step = GNUNET_SCHEDULER_add_delayed (
1332       GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_get_millisecond_ (), 1000),
1333       &ril_periodic_step, solver);
1334
1335   return solver;
1336 }
1337
1338 /**
1339  * Exit point for the plugin
1340  *
1341  * @param cls the solver handle
1342  */
1343 void *
1344 libgnunet_plugin_ats_ril_done (void *cls)
1345 {
1346   struct GAS_RIL_Handle *s = cls;
1347   struct RIL_Peer_Agent *cur_agent;
1348   struct RIL_Peer_Agent *next_agent;
1349
1350   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
1351
1352   cur_agent = s->agents_head;
1353   while (NULL != cur_agent)
1354   {
1355     next_agent = cur_agent->next;
1356     GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
1357     agent_die (s, cur_agent);
1358     cur_agent = next_agent;
1359   }
1360
1361   GNUNET_SCHEDULER_cancel (s->next_step);
1362   GNUNET_free(s->network_entries);
1363   GNUNET_free(s);
1364
1365   return NULL ;
1366 }
1367
1368 /**
1369  * Add a new address for a peer to the solver
1370  *
1371  * The address is already contained in the addresses hashmap!
1372  *
1373  * @param solver the solver Handle
1374  * @param address the address to add
1375  * @param network network type of this address
1376  */
1377 void
1378 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
1379 {
1380   struct GAS_RIL_Handle *s = solver;
1381   struct RIL_Peer_Agent *agent;
1382   struct RIL_Address_Wrapped *address_wrapped;
1383   struct RIL_Network *net;
1384   unsigned int m_new;
1385   unsigned int m_old;
1386   unsigned int n_new;
1387   unsigned int n_old;
1388   int i;
1389   unsigned int zero;
1390   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1391
1392   net = ril_get_network (s, network);
1393   address->solver_information = net;
1394
1395   if (!ril_network_is_active (s, network))
1396   {
1397     LOG(GNUNET_ERROR_TYPE_DEBUG,
1398         "API_address_add() Did not add %s address %p for peer '%s', network does not have enough bandwidth\n",
1399         address->plugin, address->addr, GNUNET_i2s (&address->peer));
1400     return;
1401   }
1402
1403   agent = ril_get_agent (s, &address->peer, GNUNET_YES);
1404
1405   //add address
1406   address_wrapped = GNUNET_malloc (sizeof (struct RIL_Address_Wrapped));
1407   address_wrapped->address_naked = address;
1408   GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
1409
1410   //increase size of W
1411   m_new = agent->m + RIL_FEATURES_ADDRESS_COUNT;
1412   m_old = agent->m;
1413   n_new = agent->n + 1;
1414   n_old = agent->n;
1415
1416   GNUNET_array_grow(agent->W, agent->n, n_new);
1417   for (i = 0; i < n_new; i++)
1418   {
1419     if (i < n_old)
1420     {
1421       agent->m = m_old;
1422       GNUNET_array_grow(agent->W[i], agent->m, m_new);
1423     }
1424     else
1425     {
1426       zero = 0;
1427       GNUNET_array_grow(agent->W[i], zero, m_new);
1428     }
1429   }
1430
1431   //increase size of old state vector
1432   agent->m = m_old;
1433   GNUNET_array_grow(agent->s_old, agent->m, m_new);
1434
1435   agent->m = m_old;
1436   GNUNET_array_grow(agent->e, agent->m, m_new);
1437
1438   if (NULL == agent->address_inuse)
1439   {
1440     net->bw_in_assigned += min_bw;
1441     net->bw_out_assigned += min_bw;
1442     envi_set_active_suggestion (s, agent, address, min_bw, min_bw, GNUNET_NO);
1443   }
1444
1445   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %p for peer '%s'\n",
1446       address->active ? "active" : "inactive", address->plugin, address->addr,
1447       GNUNET_i2s (&address->peer));
1448 }
1449
1450 /**
1451  * Delete an address in the solver
1452  *
1453  * The address is not contained in the address hashmap anymore!
1454  *
1455  * @param solver the solver handle
1456  * @param address the address to remove
1457  * @param session_only delete only session not whole address
1458  */
1459 void
1460 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
1461 {
1462   struct GAS_RIL_Handle *s = solver;
1463   struct RIL_Peer_Agent *agent;
1464   struct RIL_Address_Wrapped *address_wrapped;
1465   int address_was_used = address->active;
1466   int address_index;
1467   unsigned int m_new;
1468   unsigned int n_new;
1469   int i;
1470   struct RIL_Network *net;
1471   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1472
1473   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Delete %s%s %s address %p for peer '%s'\n",
1474       session_only ? "session for " : "", address->active ? "active" : "inactive", address->plugin,
1475       address->addr, GNUNET_i2s (&address->peer));
1476
1477   agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1478   if (NULL == agent)
1479   {
1480     net = address->solver_information;
1481     GNUNET_assert(!ril_network_is_active (s, net->type));
1482     LOG(GNUNET_ERROR_TYPE_DEBUG,
1483         "No agent allocated for peer yet, since address was in inactive network\n");
1484     return;
1485   }
1486
1487   address_index = agent_address_get_index (agent, address);
1488   address_wrapped = agent_address_get (agent, address);
1489
1490   if (NULL == address_wrapped)
1491   {
1492     net = address->solver_information;
1493     GNUNET_assert(!ril_network_is_active (s, net->type));
1494     LOG(GNUNET_ERROR_TYPE_DEBUG,
1495         "Address not considered by agent, address was in inactive network\n");
1496     return;
1497   }
1498
1499   GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
1500   GNUNET_free(address_wrapped);
1501
1502   //decrease W
1503   m_new = agent->m - RIL_FEATURES_ADDRESS_COUNT;
1504   n_new = agent->n - 1;
1505
1506   for (i = 0; i < agent->n; i++)
1507   {
1508     ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
1509         ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1510             + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1511   }
1512   GNUNET_free(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
1513   ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
1514       1, agent->n);
1515   //correct last action
1516   if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
1517   {
1518     agent->a_old -= 1;
1519   }
1520   else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
1521   {
1522     agent->a_old = RIL_ACTION_INVALID;
1523   }
1524   //decrease old state vector and eligibility vector
1525   ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
1526       ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1527           + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1528   ril_cut_from_vector ((void **) &agent->e, sizeof(double),
1529       ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1530           + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1531   agent->m = m_new;
1532   agent->n = n_new;
1533
1534   LOG(GNUNET_ERROR_TYPE_DEBUG, "address was used: %s\n", address_was_used ? "yes" : "no");
1535
1536   if (address_was_used)
1537   {
1538     net = address->solver_information;
1539     net->bw_in_assigned -= agent->bw_in;
1540     net->bw_out_assigned -= agent->bw_out;
1541
1542     if (NULL != agent->addresses_head) //if peer has an address left, use it
1543     {
1544       LOG(GNUNET_ERROR_TYPE_DEBUG, "address left: %p\n",
1545           agent->addresses_head->address_naked->addr);
1546       //TODO? check if network/bandwidth update can be done more clever/elegant at different function
1547       envi_set_active_suggestion (s, agent, agent->addresses_head->address_naked, min_bw, min_bw,
1548           GNUNET_NO);
1549       net = agent->addresses_head->address_naked->solver_information;
1550       net->bw_in_assigned -= min_bw;
1551       net->bw_out_assigned -= min_bw;
1552     }
1553     else
1554     {
1555       LOG(GNUNET_ERROR_TYPE_DEBUG, "no address left => disconnect\n");
1556
1557       envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
1558     }
1559   }
1560
1561   LOG(GNUNET_ERROR_TYPE_DEBUG, "Address deleted\n");
1562 }
1563
1564 /**
1565  * Update the properties of an address in the solver
1566  *
1567  * @param solver solver handle
1568  * @param address the address
1569  * @param type the ATSI type in HBO
1570  * @param abs_value the absolute value of the property
1571  * @param rel_value the normalized value
1572  */
1573 void
1574 GAS_ril_address_property_changed (void *solver,
1575     struct ATS_Address *address,
1576     uint32_t type,
1577     uint32_t abs_value,
1578     double rel_value)
1579 {
1580   LOG(GNUNET_ERROR_TYPE_DEBUG,
1581       "API_address_property_changed() Property '%s' for peer '%s' address %p changed "
1582           "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1583       address->addr, rel_value);
1584   /*
1585    * Nothing to do here, properties are considered in every reward calculation
1586    */
1587 }
1588
1589 /**
1590  * Update the session of an address in the solver
1591  *
1592  * NOTE: values in addresses are already updated
1593  *
1594  * @param solver solver handle
1595  * @param address the address
1596  * @param cur_session the current session
1597  * @param new_session the new session
1598  */
1599 void
1600 GAS_ril_address_session_changed (void *solver,
1601     struct ATS_Address *address,
1602     uint32_t cur_session,
1603     uint32_t new_session)
1604 {
1605   /*
1606    * TODO? Future Work: Potentially add session activity as a feature in state vector
1607    */
1608   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
1609 }
1610
1611 /**
1612  * Notify the solver that an address is (not) actively used by transport
1613  * to communicate with a remote peer
1614  *
1615  * NOTE: values in addresses are already updated
1616  *
1617  * @param solver solver handle
1618  * @param address the address
1619  * @param in_use usage state
1620  */
1621 void
1622 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
1623 {
1624   /* Nothing to do here.
1625    * Possible TODO? Future Work: Use usage as state vector
1626    */
1627   LOG(GNUNET_ERROR_TYPE_DEBUG,
1628       "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
1629       address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1630 }
1631
1632 /**
1633  * Notify solver that the network an address is located in has changed
1634  *
1635  * NOTE: values in addresses are already updated
1636  *
1637  * @param solver solver handle
1638  * @param address the address
1639  * @param current_network the current network
1640  * @param new_network the new network
1641  */
1642 void
1643 GAS_ril_address_change_network (void *solver,
1644     struct ATS_Address *address,
1645     uint32_t current_network,
1646     uint32_t new_network)
1647 {
1648   struct GAS_RIL_Handle *s = solver;
1649   struct RIL_Peer_Agent *agent;
1650   struct RIL_Network *net;
1651   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1652
1653   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
1654       "%s address of peer %s from '%s' to '%s'\n",
1655       (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
1656       GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
1657
1658   if (address->active && !ril_network_is_active (solver, new_network))
1659   {
1660     GAS_ril_address_delete (solver, address, GNUNET_NO);
1661     return;
1662   }
1663
1664   agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1665   if (NULL == agent)
1666   {
1667     GNUNET_assert(!ril_network_is_active (solver, current_network));
1668
1669     GAS_ril_address_add (s, address, new_network);
1670     return;
1671   }
1672
1673   net = ril_get_network (s, current_network);
1674   net->bw_in_assigned -= agent->bw_in;
1675   net->bw_out_assigned -= agent->bw_out;
1676
1677   net = ril_get_network (s, new_network);
1678   net->bw_in_assigned -= min_bw;
1679   net->bw_out_assigned -= min_bw;
1680   address->solver_information = net;
1681 }
1682
1683 /**
1684  * Give feedback about the current assignment
1685  *
1686  * @param solver the solver handle
1687  * @param application the application
1688  * @param peer the peer to change the preference for
1689  * @param scope the time interval for this feedback: [now - scope .. now]
1690  * @param kind the kind to change the preference
1691  * @param score the score
1692  */
1693 void
1694 GAS_ril_address_preference_feedback (void *solver,
1695     void *application,
1696     const struct GNUNET_PeerIdentity *peer,
1697     const struct GNUNET_TIME_Relative scope,
1698     enum GNUNET_ATS_PreferenceKind kind,
1699     double score)
1700 {
1701   LOG(GNUNET_ERROR_TYPE_DEBUG,
1702       "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
1703           "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
1704       GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
1705 }
1706
1707 /**
1708  * Start a bulk operation
1709  *
1710  * Since new calculations of the assignment are not triggered by a change of preferences, as it
1711  * happens in the proportional and the mlp solver, there is no need to block this solver.
1712  *
1713  * @param solver the solver
1714  */
1715 void
1716 GAS_ril_bulk_start (void *solver)
1717 {
1718   /* nop */
1719 }
1720
1721 /**
1722  * Bulk operation done
1723  *
1724  * Since new calculations of the assignment are not triggered by a change of preferences, as it
1725  * happens in the proportional and the mlp solver, there is no need to block this solver.
1726  *
1727  * @param solver the solver handle
1728  */
1729 void
1730 GAS_ril_bulk_stop (void *solver)
1731 {
1732   /* nop */
1733 }
1734
1735 /**
1736  * Tell solver to notify ATS if the address to use changes for a specific
1737  * peer using the bandwidth changed callback
1738  *
1739  * The solver must only notify about changes for peers with pending address
1740  * requests!
1741  *
1742  * @param solver the solver handle
1743  * @param peer the identity of the peer
1744  */
1745 const struct ATS_Address *
1746 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
1747 {
1748   /*
1749    * activate agent, return currently chosen address
1750    */
1751   struct GAS_RIL_Handle *s = solver;
1752   struct RIL_Peer_Agent *agent;
1753   struct RIL_Network *net;
1754
1755   agent = ril_get_agent (s, peer, GNUNET_YES);
1756
1757   agent->active = GNUNET_YES;
1758
1759   if (agent->address_inuse)
1760   {
1761     net = agent->address_inuse->solver_information;
1762     net->bw_in_assigned += agent->bw_in;
1763     net->bw_out_assigned += agent->bw_out;
1764   }
1765   envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
1766       GNUNET_YES);
1767
1768   if (agent->address_inuse)
1769   {
1770     LOG(GNUNET_ERROR_TYPE_DEBUG,
1771         "API_get_preferred_address() Activated agent for peer '%s' with %s address %p\n",
1772         GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
1773   }
1774   else
1775   {
1776     LOG(GNUNET_ERROR_TYPE_DEBUG,
1777         "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
1778         GNUNET_i2s (peer));
1779   }
1780
1781   return agent->address_inuse;
1782 }
1783
1784 /**
1785  * Tell solver stop notifying ATS about changes for this peers
1786  *
1787  * The solver must only notify about changes for peers with pending address
1788  * requests!
1789  *
1790  * @param solver the solver handle
1791  * @param peer the peer
1792  */
1793 void
1794 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
1795 {
1796   struct GAS_RIL_Handle *s = solver;
1797   struct RIL_Peer_Agent *agent;
1798   struct RIL_Network *net;
1799
1800   agent = ril_get_agent (s, peer, GNUNET_NO);
1801
1802   if (NULL == agent)
1803   {
1804     GNUNET_break(0);
1805     return;
1806   }
1807   if (GNUNET_NO == agent->active)
1808   {
1809     GNUNET_break(0);
1810     return;
1811   }
1812
1813   agent->active = GNUNET_NO;
1814   if (agent->address_inuse)
1815   {
1816     net = agent->address_inuse->solver_information;
1817     net->bw_in_assigned -= agent->bw_in;
1818     net->bw_out_assigned -= agent->bw_out;
1819   }
1820   envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
1821       GNUNET_YES);
1822
1823   LOG(GNUNET_ERROR_TYPE_DEBUG,
1824       "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
1825       GNUNET_i2s (peer), agent->address_inuse->plugin);
1826 }
1827
1828 /* end of libgnunet_plugin_ats_ril.c */