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