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