ats_ril: address administration changed
[oweals/gnunet.git] / src / ats / gnunet-service-ats-solver_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/gnunet-service-ats-solver_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 "gnunet_util_lib.h"
30 #include "gnunet-service-ats_addresses.h"
31 #include "gnunet_statistics_service.h"
32
33 #define LOG(kind,...) GNUNET_log_from (kind, "ats-ril",__VA_ARGS__)
34
35 #define RIL_DEFAULT_STEP_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 3000)
36 #define RIL_DEFAULT_ALGORITHM RIL_ALGO_Q
37 #define RIL_DEFAULT_DISCOUNT_FACTOR 0.5
38 #define RIL_DEFAULT_GRADIENT_STEP_SIZE 0.4
39 #define RIL_DEFAULT_TRACE_DECAY 0.6
40 #define RIL_EXPLORE_RATIO 0.1
41
42 /**
43  * ATS reinforcement learning solver
44  *
45  * General description
46  */
47
48 /**
49  * TODO! implement address administration
50  * TODO! implement reward calculation 1 and 2 (i.e. meeting preferences and taking scores)
51  */
52
53 enum RIL_Action_Type
54 {
55   RIL_ACTION_NOTHING = 0,
56   RIL_ACTION_BW_IN_DBL = 1,
57   RIL_ACTION_BW_IN_HLV = 2,
58   RIL_ACTION_BW_IN_INC = 3,
59   RIL_ACTION_BW_IN_DEC = 4,
60   RIL_ACTION_BW_OUT_DBL = 5,
61   RIL_ACTION_BW_OUT_HLV = 6,
62   RIL_ACTION_BW_OUT_INC = 7,
63   RIL_ACTION_BW_OUT_DEC = 8,
64   RIL_ACTION_TYPE_NUM = 9
65 };
66 //TODO! add the rest of the actions
67
68 enum RIL_Algorithm
69 {
70   RIL_ALGO_SARSA = 0,
71   RIL_ALGO_Q = 1
72 };
73
74 enum RIL_E_Modification
75 {
76   RIL_E_SET,
77   RIL_E_ZERO,
78   RIL_E_ACCUMULATE,
79   RIL_E_REPLACE
80 };
81
82 /**
83  * Global learning parameters
84  */
85 struct RIL_Learning_Parameters
86 {
87   /**
88    * The TD-algorithm to use
89    */
90   enum RIL_Algorithm algorithm;
91
92   /**
93    * Learning discount factor in the TD-update
94    */
95   float gamma;
96
97   /**
98    * Gradient-descent step-size
99    */
100   float alpha;
101
102   /**
103    * Trace-decay factor for eligibility traces
104    */
105   float lambda;
106 };
107
108 /**
109  * Wrapper for addresses to store them in agent's linked list
110  */
111 struct RIL_Address_Wrapped
112 {
113   /**
114    * Next in DLL
115    */
116   struct RIL_Address_Wrapped *next;
117
118   /**
119    * Previous in DLL
120    */
121   struct RIL_Address_Wrapped *prev;
122
123   /**
124    * The address
125    */
126   struct ATS_Address *address_naked;
127 };
128
129 struct RIL_Peer_Agent
130 {
131   /**
132    * Next agent in solver's linked list
133    */
134   struct RIL_Peer_Agent *next;
135
136   /**
137    * Previous agent in solver's linked list
138    */
139   struct RIL_Peer_Agent *prev;
140
141   /**
142    * Environment handle
143    */
144   struct GAS_RIL_Handle *envi;
145
146   /**
147    * Peer ID
148    */
149   struct GNUNET_PeerIdentity peer;
150
151   /**
152    * Whether the agent is active or not
153    */
154   int active;
155
156   /**
157    * Number of performed time-steps
158    */
159   unsigned long long step_count;
160
161   /**
162    * Experience matrix W
163    */
164   double ** W;
165
166   /**
167    * Number of rows of W / Number of state-vector features
168    */
169   unsigned int m;
170
171   /**
172    * Number of columns of W / Number of actions
173    */
174   unsigned int n;
175
176   /**
177    * Last perceived state feature vector
178    */
179   double * s_old;
180
181   /**
182    * Last chosen action
183    */
184   int a_old;
185
186   /**
187    * Eligibility trace vector
188    */
189   double * e;
190
191   /**
192    * Address in use
193    */
194   struct ATS_Address * address_inuse;
195
196   /**
197    * Head of addresses DLL
198    */
199   struct RIL_Address_Wrapped * addresses_head;
200
201   /**
202    * Tail of addresses DLL
203    */
204   struct RIL_Address_Wrapped * addresses_tail;
205
206   /**
207    * Inbound bandwidth assigned by the agent
208    */
209   unsigned long long bw_in;
210
211   /**
212    * Outbound bandwidth assigned by the agent
213    */
214   unsigned long long bw_out;
215 };
216
217 struct RIL_Network
218 {
219   /**
220    * ATS network type
221    */
222   enum GNUNET_ATS_Network_Type type;
223
224   /**
225    * Total available inbound bandwidth
226    */
227   unsigned long long bw_in_available;
228
229   /**
230    * Total assigned outbound bandwidth
231    */
232   unsigned long long bw_in_assigned;
233
234   /**
235    * Total available outbound bandwidth
236    */
237   unsigned long long bw_out_available;
238
239   /**
240    * Total assigned outbound bandwidth
241    */
242   unsigned long long bw_out_assigned;
243 };
244
245 struct RIL_Callbacks
246 {
247   /**
248    * Bandwidth changed callback
249    */
250   GAS_bandwidth_changed_cb bw_changed;
251
252   /**
253    * Bandwidth changed callback cls
254    */
255   void *bw_changed_cls;
256
257   /**
258    * ATS function to get preferences
259    */
260   GAS_get_preferences get_preferences;
261
262   /**
263    * Closure for ATS function to get preferences
264    */
265   void *get_preferences_cls;
266
267   /**
268    * ATS function to get properties
269    */
270   GAS_get_properties get_properties;
271
272   /**
273    * Closure for ATS function to get properties
274    */
275   void *get_properties_cls;
276 };
277
278 /**
279  * A handle for the reinforcement learning solver
280  */
281 struct GAS_RIL_Handle
282 {
283   /**
284    * Statistics handle
285    */
286   struct GNUNET_STATISTICS_Handle *stats;
287
288   /**
289    * Hashmap containing all valid addresses
290    */
291   const struct GNUNET_CONTAINER_MultiHashMap *addresses;
292
293   /**
294    * Callbacks for the solver
295    */
296   struct RIL_Callbacks *callbacks;
297
298   /**
299    * Bulk lock
300    */
301   int bulk_lock;
302
303   /**
304    * Number of changes while solver was locked
305    */
306   int bulk_requests;
307
308   /**
309    * Number of performed time-steps
310    */
311   unsigned long long step_count;
312
313   /**
314    * Interval time between steps in milliseconds //TODO? put in agent
315    */
316   struct GNUNET_TIME_Relative step_time;
317
318   /**
319    * Task identifier of the next time-step to be executed //TODO? put in agent
320    */
321   GNUNET_SCHEDULER_TaskIdentifier next_step;
322
323   /**
324    * Learning parameters
325    */
326   struct RIL_Learning_Parameters parameters;
327
328   /**
329    * Array of networks with global assignment state
330    */
331   struct RIL_Network * network_entries;
332
333   /**
334    * Networks count
335    */
336   unsigned int networks_count;
337
338   /**
339    * List of active peer-agents
340    */
341   struct RIL_Peer_Agent * agents_head;
342   struct RIL_Peer_Agent * agents_tail;
343 };
344
345 /**
346  *  Private functions
347  *  ---------------------------
348  */
349
350 /**
351  * Estimate the current action-value for state s and action a
352  * @param agent agent performing the estimation
353  * @param state s
354  * @param action a
355  * @return estimation value
356  */
357 static double
358 agent_estimate_q (struct RIL_Peer_Agent *agent, double *state, int action)
359 {
360   int i;
361   double result = 0;
362
363   for (i = 0; i < agent->m; i++)
364   {
365     result += state[i] * agent->W[action][i];
366   }
367
368   return result;
369 }
370
371 /**
372  * Decide whether to do exploration (i.e. taking a new action) or exploitation (i.e. taking the
373  * currently estimated best action) in the current step
374  * @param agent agent performing the step
375  * @return yes, if exploring
376  */
377 static int
378 agent_decide_exploration (struct RIL_Peer_Agent *agent)
379 {
380   double r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
381       UINT32_MAX) / (double) UINT32_MAX;
382
383 if  (r < RIL_EXPLORE_RATIO)
384   {
385     return GNUNET_YES;
386   }
387   return GNUNET_NO;
388 }
389
390 static int
391 agent_address_get_index (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
392 {
393   int i;
394   struct RIL_Address_Wrapped *cur;
395
396   i = 0;
397   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
398   {
399     if (cur->address_naked == address)
400     {
401       return i;
402     }
403     i++;
404   }
405
406   return -1;
407 }
408
409 static struct RIL_Address_Wrapped *
410 agent_address_get (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
411 {
412   struct RIL_Address_Wrapped *cur;
413
414   for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
415   {
416     if (cur->address_naked == address)
417     {
418       return cur;
419     }
420   }
421
422   return NULL;
423 }
424
425   /**
426    * Gets the action, with the maximal estimated Q-value (i.e. the one currently estimated to bring the
427    * most reward in the future)
428    * @param agent agent performing the calculation
429    * @param state the state from which to take the action
430    * @return the action promising most future reward
431    */
432 static int
433 agent_get_action_best (struct RIL_Peer_Agent *agent, double *state)
434 {
435   int i;
436   int max_i = -1;
437   double cur_q;
438   double max_q = -DBL_MAX;
439
440   for (i = 0; i < agent->n; i++)
441   {
442     cur_q = agent_estimate_q (agent, state, i);
443     if (cur_q > max_q)
444     {
445       max_q = cur_q;
446       max_i = i;
447     }
448   }
449
450   GNUNET_assert(-1 != max_i);
451
452   return max_i;
453 }
454
455 /**
456  * Gets any action, to explore the action space from that state
457  * @param agent agent performing the calculation
458  * @param state the state from which to take the action
459  * @return any action
460  */
461 static int
462 agent_get_action_explore (struct RIL_Peer_Agent *agent, double *state)
463 {
464   return GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, agent->n);
465 }
466
467 /**
468  * Updates the weights (i.e. coefficients) of the weight vector in matrix W for action a
469  * @param agent the agent performing the update
470  * @param reward the reward received for the last action
471  * @param s_next the new state, the last step got the agent into
472  * @param a_prime the new
473  */
474 static void
475 agent_update_weights (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a_prime)
476 {
477   int i;
478   double delta;
479   double *theta = agent->W[agent->a_old];
480
481   delta = reward + agent_estimate_q (agent, s_next, a_prime)
482       - agent_estimate_q (agent, agent->s_old, agent->a_old);
483   for (i = 0; i < agent->m; i++)
484   {
485     theta[i] += agent->envi->parameters.alpha * delta * (agent->e)[i];
486   }
487 }
488
489 /**
490  * Changes the eligibility trace vector e in various manners:
491  * RIL_E_ACCUMULATE - adds 1 to each component as in accumulating eligibility traces
492  * RIL_E_REPLACE - resets each component to 1 as in replacing traces
493  * RIL_E_SET - multiplies e with gamma and lambda as in the update rule
494  * RIL_E_ZERO - sets e to 0 as in Watkin's Q-learning algorithm when exploring and when initializing
495  * @param agent
496  * @param mod
497  */
498 static void
499 agent_modify_eligibility (struct RIL_Peer_Agent *agent, enum RIL_E_Modification mod)
500 {
501   int i;
502   double *e = agent->e;
503   double gamma = agent->envi->parameters.gamma;
504   double lambda = agent->envi->parameters.lambda;
505
506   for (i = 0; i < agent->m; i++)
507   {
508     switch (mod)
509     {
510     case RIL_E_ACCUMULATE:
511       e[i] += 1;
512       break;
513     case RIL_E_REPLACE:
514       e[i] = 1;
515       break;
516     case RIL_E_SET:
517       e[i] = gamma * lambda;
518       break;
519     case RIL_E_ZERO:
520       e[i] = 0;
521       break;
522     }
523   }
524 }
525
526 static void
527 envi_set_active_suggestion (struct GAS_RIL_Handle *solver,
528     struct RIL_Peer_Agent *agent,
529     struct ATS_Address *new_address,
530     unsigned long long new_bw_in,
531     unsigned long long new_bw_out)
532 {
533   int notify = GNUNET_NO;
534
535   if (agent->address_inuse != new_address)
536   {
537     if (NULL != agent->address_inuse)
538     {
539       agent->address_inuse->active = GNUNET_NO;
540     }
541     agent->address_inuse = new_address;
542     agent->address_inuse->active = GNUNET_YES;
543     agent->address_inuse->assigned_bw_in.value__ = htonl (agent->bw_in);
544     agent->address_inuse->assigned_bw_out.value__ = htonl (agent->bw_out);
545     notify |= GNUNET_YES;
546   }
547   if (agent->bw_in != new_bw_in)
548   {
549     agent->bw_in = new_bw_in;
550     agent->address_inuse->assigned_bw_in.value__ = htonl (new_bw_out);
551     notify |= GNUNET_YES;
552   }
553   if (agent->bw_out != new_bw_out)
554   {
555     agent->bw_out = new_bw_out;
556     agent->address_inuse->assigned_bw_out.value__ = htonl (new_bw_out);
557     notify |= GNUNET_YES;
558   }
559
560   if (notify && agent->active)
561   {
562     solver->callbacks->bw_changed (solver->callbacks->bw_changed_cls, agent->address_inuse);
563   }
564 }
565
566 /**
567  * Allocates a state vector and fills it with the features present
568  * @param solver the solver handle
569  * @return pointer to the state vector
570  */
571 static double *
572 envi_get_state (struct GAS_RIL_Handle *solver)
573 {
574   int i;
575   struct RIL_Network *net;
576   double *state = GNUNET_malloc (sizeof (double) * solver->networks_count * 4);
577
578   for (i = 0; i < solver->networks_count; i++)
579   {
580     net = &solver->network_entries[i];
581     state[i * 4 + 0] = (double) net->bw_in_assigned;
582     state[i * 4 + 1] = (double) net->bw_in_available;
583     state[i * 4 + 2] = (double) net->bw_out_assigned;
584     state[i * 4 + 3] = (double) net->bw_out_available;
585   }
586
587   return state;
588 }
589
590 /**
591  * Gets the reward of the last performed step
592  * @param solver solver handle
593  * @return the reward
594  */
595 static double
596 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
597 {
598   //TODO! implement reward calculation
599
600   return (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT32_MAX)
601       / (double) UINT32_MAX;
602 }
603
604 static void
605 envi_action_bw_double (struct GAS_RIL_Handle *solver,
606     struct RIL_Peer_Agent *agent,
607     int direction_in)
608 {
609   if (direction_in)
610   {
611     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in * 2, agent->bw_out);
612   }
613   else
614   {
615     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, agent->bw_out * 2);
616   }
617 }
618
619 static void
620 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
621     struct RIL_Peer_Agent *agent,
622     int direction_in)
623 {
624   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
625   unsigned long long new_bw;
626
627   if (direction_in)
628   {
629     new_bw = agent->bw_in / 2;
630     if (new_bw < min_bw)
631       new_bw = min_bw;
632     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out);
633   }
634   else
635   {
636     new_bw = agent->bw_out / 2;
637     if (new_bw < min_bw)
638       new_bw = min_bw;
639     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw);
640   }
641 }
642
643 static void
644 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
645 {
646   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
647
648   if (direction_in)
649   {
650     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in + (5 * min_bw),
651         agent->bw_out);
652   }
653   else
654   {
655     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
656         agent->bw_out + (5 * min_bw));
657   }
658 }
659
660 static void
661 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
662 {
663   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
664   unsigned long long new_bw;
665
666   if (direction_in)
667   {
668     new_bw = agent->bw_in - (5 * min_bw);
669     if (new_bw < min_bw)
670       new_bw = min_bw;
671     envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out);
672   }
673   else
674   {
675     new_bw = agent->bw_out - (5 * min_bw);
676     if (new_bw < min_bw)
677       new_bw = min_bw;
678     envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw);
679   }
680 }
681
682 /**
683  * Puts the action into effect
684  * @param solver solver handle
685  * @param action action to perform by the solver
686  */
687 static void
688 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
689 {
690   switch (action)
691   {
692   case RIL_ACTION_NOTHING:
693     break;
694   case RIL_ACTION_BW_IN_DBL:
695     envi_action_bw_double (solver, agent, GNUNET_YES);
696     break;
697   case RIL_ACTION_BW_IN_HLV:
698     envi_action_bw_halven (solver, agent, GNUNET_YES);
699     break;
700   case RIL_ACTION_BW_IN_INC:
701     envi_action_bw_inc (solver, agent, GNUNET_YES);
702     break;
703   case RIL_ACTION_BW_IN_DEC:
704     envi_action_bw_dec (solver, agent, GNUNET_YES);
705     break;
706   case RIL_ACTION_BW_OUT_DBL:
707     envi_action_bw_double (solver, agent, GNUNET_NO);
708     break;
709   case RIL_ACTION_BW_OUT_HLV:
710     envi_action_bw_halven (solver, agent, GNUNET_NO);
711     break;
712   case RIL_ACTION_BW_OUT_INC:
713     envi_action_bw_inc (solver, agent, GNUNET_NO);
714     break;
715   case RIL_ACTION_BW_OUT_DEC:
716     envi_action_bw_dec (solver, agent, GNUNET_NO);
717     break;
718   default:
719     // error - action does not exist
720     GNUNET_assert(GNUNET_NO);
721   }
722 }
723
724 /**
725  * Performs one step of the Markov Decision Process. Other than in the literature the step starts
726  * after having done the last action a_old. It observes the new state s_next and the reward
727  * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
728  * next action is put into effect.
729  * @param agent the agent performing the step
730  */
731 static void
732 agent_step (struct RIL_Peer_Agent *agent)
733 {
734   int a_next = -1;
735   double *s_next;
736   double reward;
737
738   s_next = envi_get_state (agent->envi);
739   reward = envi_get_reward (agent->envi, agent);
740
741   LOG(GNUNET_ERROR_TYPE_DEBUG, "agent_step() with algorithm %s\n",
742       agent->envi->parameters.algorithm ? "Q" : "SARSA");
743
744   switch (agent->envi->parameters.algorithm)
745   {
746   case RIL_ALGO_SARSA:
747     agent_modify_eligibility (agent, RIL_E_SET);
748     if (agent_decide_exploration (agent))
749     {
750       a_next = agent_get_action_explore (agent, s_next);
751     }
752     else
753     {
754       a_next = agent_get_action_best (agent, s_next);
755     }
756     //updates weights with selected action (on-policy), if not first step
757     if (-1 != agent->a_old)
758       agent_update_weights (agent, reward, s_next, a_next);
759     break;
760
761   case RIL_ALGO_Q:
762     //updates weights with best action, disregarding actually selected action (off-policy), if not first step
763     a_next = agent_get_action_best (agent, s_next);
764     if (-1 != agent->a_old)
765       agent_update_weights (agent, reward, s_next, a_next);
766     if (agent_decide_exploration (agent))
767     {
768       a_next = agent_get_action_explore (agent, s_next);
769       agent_modify_eligibility (agent, RIL_E_ZERO);
770     }
771     else
772     {
773       a_next = agent_get_action_best (agent, s_next);
774       agent_modify_eligibility (agent, RIL_E_SET);
775     }
776     break;
777   }
778
779   GNUNET_assert(-1 != a_next);
780
781   agent_modify_eligibility (agent, RIL_E_ACCUMULATE);
782
783   envi_do_action (agent->envi, agent, a_next);
784
785   GNUNET_free(agent->s_old);
786   agent->s_old = s_next;
787   agent->a_old = a_next;
788
789   agent->step_count += 1;
790 }
791
792 /**
793  * Cycles through all agents and lets the active ones do a step. Schedules the next step.
794  * @param solver the solver handle
795  * @param tc task context for the scheduler
796  */
797 static void
798 ril_periodic_step (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
799 {
800   struct GAS_RIL_Handle *solver = cls;
801   struct RIL_Peer_Agent *cur;
802
803   LOG(GNUNET_ERROR_TYPE_DEBUG, "RIL step number %d\n", solver->step_count);
804
805   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
806   {
807     if (cur->active)
808     {
809       agent_step (cur);
810     }
811   }
812
813   solver->step_count += 1;
814   solver->next_step = GNUNET_SCHEDULER_add_delayed (solver->step_time, &ril_periodic_step, solver);
815 }
816
817 /**
818  * Initialize an agent without addresses and its knowledge base
819  * @param s ril solver
820  * @param peer the one in question
821  * @return handle to the new agent
822  */
823 static struct RIL_Peer_Agent *
824 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
825 {
826   int i;
827   struct GAS_RIL_Handle * solver = s;
828   struct RIL_Peer_Agent * agent = GNUNET_malloc (sizeof (struct RIL_Peer_Agent));
829
830   agent->envi = solver;
831   agent->peer = *peer;
832   agent->step_count = 0;
833   agent->active = GNUNET_NO;
834   agent->s_old = envi_get_state (solver);
835   agent->n = RIL_ACTION_TYPE_NUM;
836   agent->m = solver->networks_count * 4;
837   agent->W = (double **) GNUNET_malloc (sizeof (double) * agent->n);
838   for (i = 0; i < agent->n; i++)
839   {
840     agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
841   }
842   agent->a_old = -1;
843   agent->e = (double *) GNUNET_malloc (sizeof (double) * agent->m);
844   agent_modify_eligibility (agent, RIL_E_ZERO);
845
846   GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, agent);
847
848   return agent;
849 }
850
851 /**
852  * Deallocate agent
853  * @param s solver handle
854  * @param agent the agent to retire
855  */
856 static void
857 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
858 {
859   int i;
860
861   for (i = 0; i < agent->n; i++)
862   {
863     GNUNET_free(agent->W[i]);
864   }
865   GNUNET_free(agent->W);
866   GNUNET_free(agent->e);
867   GNUNET_free(agent->s_old);
868 }
869
870 /**
871  * Returns the agent for a peer
872  * @param s solver handle
873  * @param peer identity of the peer
874  * @param create whether to create an agent if none is allocated yet
875  * @return agent
876  */
877 static struct RIL_Peer_Agent *
878 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
879 {
880   struct RIL_Peer_Agent *cur;
881
882   for (cur = solver->agents_head; NULL != cur; cur = cur->next)
883   {
884     if (0 == GNUNET_CRYPTO_hash_cmp (&peer->hashPubKey, &cur->peer.hashPubKey))
885     {
886       return cur;
887     }
888   }
889
890   if (create)
891     return agent_init (solver, peer);
892   return NULL ;
893 }
894
895 /**
896  * Lookup network struct by type
897  *
898  * @param s the solver handle
899  * @param type the network type
900  * @return the network struct
901  */
902 static struct RIL_Network *
903 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
904 {
905   int i;
906
907   for (i = 0; i < s->networks_count; i++)
908   {
909     if (s->network_entries[i].type == type)
910     {
911       return &s->network_entries[i];
912     }
913   }
914   return NULL ;
915 }
916
917 static int
918 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
919 {
920   struct RIL_Network *net;
921   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
922
923   net = ril_get_network(solver, network);
924   if (net->bw_out_available < min_bw)
925     return GNUNET_NO;
926   return GNUNET_YES;
927 }
928
929 static void
930 ril_cut_from_vector (void **old, size_t element_size, unsigned int hole_start, unsigned int hole_length, unsigned int old_length)
931 {
932   char *tmpptr;
933   char *oldptr = (char *) *old;
934   size_t size;
935   unsigned int bytes_before;
936   unsigned int bytes_hole;
937   unsigned int bytes_after;
938
939   GNUNET_assert(old_length > hole_length);
940   GNUNET_assert(old_length > (hole_start + hole_length - 1));
941
942   size = (old_length - hole_length) * element_size;
943
944   bytes_before = element_size * hole_start;
945   bytes_hole   = element_size * hole_length;
946   bytes_after  = element_size * (old_length - hole_start - hole_length);
947
948   if (0 == size)
949   {
950     tmpptr = NULL;
951   }
952   else
953   {
954     tmpptr = GNUNET_malloc (size);
955     memcpy (tmpptr, oldptr, bytes_before);
956     memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
957   }
958   if (NULL != *old)
959   {
960     GNUNET_free(*old);
961   }
962   *old = (void *) tmpptr;
963 }
964
965 /**
966  *  Solver API functions
967  *  ---------------------------
968  */
969
970 /**
971  * Changes the preferences for a peer in the problem
972  *
973  * @param solver the solver handle
974  * @param peer the peer to change the preference for
975  * @param kind the kind to change the preference
976  * @param pref_rel the normalized preference value for this kind over all clients
977  */
978 void
979 GAS_ril_address_change_preference (void *s,
980     const struct GNUNET_PeerIdentity *peer,
981     enum GNUNET_ATS_PreferenceKind kind,
982     double pref_rel)
983 {
984   LOG(GNUNET_ERROR_TYPE_DEBUG,
985       "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
986       GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
987   /*
988    * Nothing to do here. Preferences are considered during reward calculation.
989    */
990 }
991
992 /**
993  * Init the reinforcement learning problem solver
994  *
995  * Quotas:
996  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
997  * out_quota[i] contains outbound quota for network type i
998  * in_quota[i] contains inbound quota for network type i
999  *
1000  * Example
1001  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
1002  * network[2]   == GNUNET_ATS_NET_LAN
1003  * out_quota[2] == 65353
1004  * in_quota[2]  == 65353
1005  *
1006  * @param cfg configuration handle
1007  * @param stats the GNUNET_STATISTICS handle
1008  * @param network array of GNUNET_ATS_NetworkType with length dest_length
1009  * @param addresses hashmap containing all addresses
1010  * @param out_quota array of outbound quotas
1011  * @param in_quota array of outbound quota
1012  * @param dest_length array length for quota arrays
1013  * @param bw_changed_cb callback for changed bandwidth amounts
1014  * @param bw_changed_cb_cls cls for callback
1015  * @param get_preference callback to get relative preferences for a peer
1016  * @param get_preference_cls cls for callback to get relative preferences
1017  * @param get_properties_cls for callback to get relative properties
1018  * @param get_properties_cls cls for callback to get relative properties
1019  * @return handle for the solver on success, NULL on fail
1020  */
1021 void *
1022 GAS_ril_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1023     const struct GNUNET_STATISTICS_Handle *stats,
1024     const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1025     int *network,
1026     unsigned long long *out_quota,
1027     unsigned long long *in_quota,
1028     int dest_length,
1029     GAS_bandwidth_changed_cb bw_changed_cb,
1030     void *bw_changed_cb_cls,
1031     GAS_get_preferences get_preference,
1032     void *get_preference_cls,
1033     GAS_get_properties get_properties,
1034     void *get_properties_cls)
1035 {
1036   int c;
1037   unsigned long long tmp;
1038   char *string;
1039   struct RIL_Network * cur;
1040   struct GAS_RIL_Handle *solver = GNUNET_malloc (sizeof (struct GAS_RIL_Handle));
1041
1042   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
1043
1044   GNUNET_assert(NULL != cfg);
1045   GNUNET_assert(NULL != stats);
1046   GNUNET_assert(NULL != network);
1047   GNUNET_assert(NULL != bw_changed_cb);
1048   GNUNET_assert(NULL != get_preference);
1049   GNUNET_assert(NULL != get_properties);
1050
1051   if (GNUNET_OK
1052       != GNUNET_CONFIGURATION_get_value_time (cfg, "ats", "RIL_STEP_TIME", &solver->step_time))
1053   {
1054     solver->step_time = RIL_DEFAULT_STEP_TIME;
1055   }
1056   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "RIL_ALGORITHM", &string)
1057       && NULL != string && 0 == strcmp (string, "SARSA"))
1058   {
1059     solver->parameters.algorithm = RIL_ALGO_SARSA;
1060   }
1061   else
1062   {
1063     solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
1064   }
1065   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats", "RIL_DISCOUNT_FACTOR", &tmp))
1066   {
1067     solver->parameters.gamma = (double) tmp / 100;
1068   }
1069   else
1070   {
1071     solver->parameters.gamma = RIL_DEFAULT_DISCOUNT_FACTOR;
1072   }
1073   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &tmp))
1074   {
1075     solver->parameters.alpha = (double) tmp / 100;
1076   }
1077   else
1078   {
1079     solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
1080   }
1081   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats", "RIL_TRACE_DECAY", &tmp))
1082   {
1083     solver->parameters.lambda = (double) tmp / 100;
1084   }
1085   else
1086   {
1087     solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
1088   }
1089
1090   solver->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1091   solver->callbacks = GNUNET_malloc (sizeof (struct RIL_Callbacks));
1092   solver->callbacks->bw_changed = bw_changed_cb;
1093   solver->callbacks->bw_changed_cls = bw_changed_cb_cls;
1094   solver->callbacks->get_preferences = get_preference;
1095   solver->callbacks->get_preferences_cls = get_preference_cls;
1096   solver->callbacks->get_properties = get_properties;
1097   solver->callbacks->get_properties_cls = get_properties_cls;
1098   solver->networks_count = dest_length;
1099   solver->network_entries = GNUNET_malloc (dest_length * sizeof (struct RIL_Network));
1100   solver->bulk_lock = GNUNET_NO;
1101   solver->addresses = addresses;
1102   solver->step_count = 0;
1103
1104   for (c = 0; c < dest_length; c++)
1105   {
1106     cur = &solver->network_entries[c];
1107     cur->type = network[c];
1108     cur->bw_in_available = in_quota[c];
1109     cur->bw_in_assigned = 0;
1110     cur->bw_out_available = out_quota[c];
1111     cur->bw_out_assigned = 0;
1112   }
1113
1114   solver->next_step = GNUNET_SCHEDULER_add_delayed (
1115       GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_get_millisecond_ (), 1000),
1116       &ril_periodic_step, solver);
1117
1118   return solver;
1119 }
1120
1121 /**
1122  * Shutdown the reinforcement learning problem solver
1123  *
1124  * @param solver the respective handle to shutdown
1125  */
1126 void
1127 GAS_ril_done (void * solver)
1128 {
1129   struct GAS_RIL_Handle *s = solver;
1130   struct RIL_Peer_Agent *cur_agent;
1131   struct RIL_Peer_Agent *next_agent;
1132
1133   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
1134
1135   cur_agent = s->agents_head;
1136   while (NULL != cur_agent)
1137   {
1138     next_agent = cur_agent->next;
1139     GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
1140     agent_die (s, cur_agent);
1141     cur_agent = next_agent;
1142   }
1143
1144   GNUNET_SCHEDULER_cancel (s->next_step);
1145   GNUNET_free(s->callbacks);
1146   GNUNET_free(s->network_entries);
1147   GNUNET_free(s);
1148 }
1149
1150 /**
1151  * Add a single address within a network to the solver
1152  *
1153  * @param solver the solver Handle
1154  * @param address the address to add
1155  * @param network network type of this address
1156  */
1157 void
1158 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
1159 {
1160   struct GAS_RIL_Handle *s = solver;
1161   struct RIL_Peer_Agent *agent;
1162   struct RIL_Address_Wrapped *address_wrapped;
1163   unsigned int m_new;
1164   unsigned int m_old;
1165   unsigned int n_new;
1166   unsigned int n_old;
1167   int i;
1168   unsigned int zero;
1169   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1170
1171   address->solver_information = ril_get_network (s, network);
1172
1173   if (!ril_network_is_active(s, network))
1174   {
1175     LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Did not add %s address %p for peer '%s', network does not have enough bandwidth\n",
1176         address->plugin, address->addr, GNUNET_i2s (&address->peer));
1177     return;
1178   }
1179
1180   agent = ril_get_agent(s, &address->peer, GNUNET_YES);
1181
1182   //add address
1183   address_wrapped = GNUNET_malloc (sizeof (struct RIL_Address_Wrapped));
1184   address_wrapped->address_naked = address;
1185   GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
1186
1187   //increase size of W
1188   m_new = agent->m + 5; //TODO! make size of features from address variable (Note to self: ctrl+f for "5" or I kill you!)
1189   m_old = agent->m;
1190   n_new = agent->n + 1;
1191   n_old = agent->n;
1192
1193   GNUNET_array_grow (agent->W, agent->n, n_new);
1194   for (i = 0; i < n_new; i++)
1195   {
1196     if (i < n_old)
1197     {
1198       agent->m = m_old;
1199       GNUNET_array_grow(agent->W[i], agent->m, m_new);
1200     }
1201     else
1202     {
1203       zero = 0;
1204       GNUNET_array_grow(agent->W[i], zero, m_new);
1205     }
1206   }
1207
1208   //increase size of old state vector if there is one
1209   if (-1 != agent->a_old)
1210   {
1211     agent->m = m_old;
1212     GNUNET_array_grow(agent->s_old, agent->m, m_new); //TODO initialize new state features?
1213   }
1214
1215   agent->m = m_old;
1216   GNUNET_array_grow(agent->e, agent->m, m_new);
1217
1218   if (NULL == agent->address_inuse)
1219   {
1220     envi_set_active_suggestion(s, agent, address, min_bw, min_bw);
1221   }
1222
1223   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s address %p for peer '%s'\n",
1224       address->plugin, address->addr, GNUNET_i2s (&address->peer));
1225 }
1226
1227 /**
1228  * Remove an address from the solver
1229  *
1230  * @param solver the solver handle
1231  * @param address the address to remove
1232  * @param session_only delete only session not whole address
1233  */
1234 void
1235 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
1236 {
1237   //TODO! delete session only
1238   struct GAS_RIL_Handle *s = solver;
1239   struct RIL_Peer_Agent *agent;
1240   struct RIL_Address_Wrapped *address_wrapped;
1241   int address_was_used = address->active;
1242   int address_index;
1243   unsigned int m_new;
1244   unsigned int n_new;
1245   int i;
1246   struct RIL_Network *net;
1247   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1248
1249   agent = ril_get_agent(s, &address->peer, GNUNET_NO);
1250   if (NULL == agent)
1251   {
1252     LOG (GNUNET_ERROR_TYPE_DEBUG, "No agent allocated for peer\n");
1253   }
1254
1255   address_index = agent_address_get_index(agent, address);
1256   address_wrapped = agent_address_get(agent, address);
1257
1258   GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
1259
1260   //decrease W
1261   m_new = agent->m - 5;
1262   n_new = agent->n - 1;
1263
1264   for (i = 0; i < agent->n; i++)
1265   {
1266     ril_cut_from_vector((void **) &agent->W[i], sizeof (double), ((s->networks_count * 4) + (i * 5)), 5, agent->m);
1267   }
1268   ril_cut_from_vector((void **) &agent->W, sizeof (double *), RIL_ACTION_TYPE_NUM + address_index, 1, agent->n);
1269   //correct last action
1270   if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
1271   {
1272     agent->a_old -= 1;
1273   }
1274   else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
1275   {
1276     agent->a_old = -1; //TODO! macro for invalid action
1277   }
1278   //decrease old state vector and eligibility vector
1279   ril_cut_from_vector((void **) &agent->s_old, sizeof (double), ((s->networks_count * 4) + (i * 5)), 5, agent->m);
1280   ril_cut_from_vector((void **) &agent->e,     sizeof (double), ((s->networks_count * 4) + (i * 5)), 5, agent->m);
1281   agent->m = m_new;
1282   agent->n = n_new;
1283
1284   if (address_was_used)
1285   {
1286     net = address->solver_information;
1287     net->bw_in_assigned -= agent->bw_in;
1288     net->bw_out_assigned -= agent->bw_out;
1289
1290     //TODO? check if network/bandwidth update can be done more clever/elegant at different function
1291     envi_set_active_suggestion(s, agent, agent->addresses_head->address_naked, min_bw, min_bw);
1292     net = agent->addresses_head->address_naked->solver_information;
1293     net->bw_in_assigned -= min_bw;
1294     net->bw_out_assigned -= min_bw;
1295   }
1296
1297   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Deleted %s%s address for peer '%s'\n",
1298       session_only ? "session for " : "", address->plugin, GNUNET_i2s (&address->peer));
1299 }
1300
1301 /**
1302  * Transport properties for this address have changed
1303  *
1304  * @param solver solver handle
1305  * @param address the address
1306  * @param type the ATSI type in HBO
1307  * @param abs_value the absolute value of the property
1308  * @param rel_value the normalized value
1309  */
1310 void
1311 GAS_ril_address_property_changed (void *solver,
1312     struct ATS_Address *address,
1313     uint32_t type,
1314     uint32_t abs_value,
1315     double rel_value)
1316 {
1317   LOG(GNUNET_ERROR_TYPE_DEBUG,
1318       "API_address_property_changed() Property '%s' for peer '%s' address %p changed "
1319           "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer), address,
1320       rel_value);
1321   /*
1322    * Nothing to do here, properties are considered in every reward calculation
1323    */
1324 }
1325
1326 /**
1327  * Transport session for this address has changed
1328  *
1329  * NOTE: values in addresses are already updated
1330  *
1331  * @param solver solver handle
1332  * @param address the address
1333  * @param cur_session the current session
1334  * @param new_session the new session
1335  */
1336 void
1337 GAS_ril_address_session_changed (void *solver,
1338     struct ATS_Address *address,
1339     uint32_t cur_session,
1340     uint32_t new_session)
1341 {
1342   //TODO? consider session changed in solver behaviour
1343   /*
1344    * Potentially add session activity as a feature in state vector
1345    */
1346   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
1347 }
1348
1349 /**
1350  * Usage for this address has changed
1351  *
1352  * NOTE: values in addresses are already updated
1353  *
1354  * @param solver solver handle
1355  * @param address the address
1356  * @param in_use usage state
1357  */
1358 void
1359 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
1360 {
1361   //TODO! consider address_inuse_changed according to matthias' email
1362   /**
1363    * See matthias' email
1364    */
1365   LOG(GNUNET_ERROR_TYPE_DEBUG,
1366       "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
1367       address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1368 }
1369
1370 /**
1371  * Network scope for this address has changed
1372  *
1373  * NOTE: values in addresses are already updated
1374  *
1375  * @param solver solver handle
1376  * @param address the address
1377  * @param current_network the current network
1378  * @param new_network the new network
1379  */
1380 void
1381 GAS_ril_address_change_network (void *solver,
1382     struct ATS_Address *address,
1383     uint32_t current_network,
1384     uint32_t new_network)
1385 {
1386   struct GAS_RIL_Handle *s = solver;
1387   struct RIL_Peer_Agent *agent;
1388   struct RIL_Network *net;
1389   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1390
1391   LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
1392       "%s address of peer %s from '%s' to '%s'\n",
1393       (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
1394       GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
1395
1396   if (address->active && !ril_network_is_active(solver, new_network))
1397   {
1398     GAS_ril_address_delete(solver, address, GNUNET_NO);
1399     return;
1400   }
1401
1402   agent = ril_get_agent(s, &address->peer, GNUNET_NO);
1403   if (NULL == agent)
1404   {
1405     //no agent there yet, so add as if address is new
1406     address->solver_information = ril_get_network (s, new_network);
1407     GAS_ril_address_add(s,address,new_network);
1408     return;
1409   }
1410
1411   net = ril_get_network (s, current_network);
1412   net->bw_in_assigned -= agent->bw_in;
1413   net->bw_out_assigned -= agent->bw_out;
1414
1415   net = ril_get_network (s, new_network);
1416   net->bw_in_assigned -= min_bw;
1417   net->bw_out_assigned -= min_bw;
1418   address->solver_information = net;
1419 }
1420
1421 /**
1422  * Get application feedback for a peer
1423  *
1424  * @param solver the solver handle
1425  * @param application the application
1426  * @param peer the peer to change the preference for
1427  * @param scope the time interval for this feedback: [now - scope .. now]
1428  * @param kind the kind to change the preference
1429  * @param score the score
1430  */
1431 void
1432 GAS_ril_address_preference_feedback (void *solver,
1433     void *application,
1434     const struct GNUNET_PeerIdentity *peer,
1435     const struct GNUNET_TIME_Relative scope,
1436     enum GNUNET_ATS_PreferenceKind kind,
1437     double score)
1438 {
1439   //TODO! collect reward until next reward calculation
1440   LOG(GNUNET_ERROR_TYPE_DEBUG,
1441       "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
1442           "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
1443       GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
1444 }
1445
1446 /**
1447  * Start a bulk operation
1448  *
1449  * @param solver the solver
1450  */
1451 void
1452 GAS_ril_bulk_start (void *solver)
1453 {
1454   //TODO? consideration: keep bulk counter and stop agents during bulk
1455   /*
1456    * bulk counter up, but not really relevant, because there is no complete calculation of the
1457    * bandwidth assignment triggered anyway. Therefore, changes to addresses can come and go as
1458    * they want. Consideration: Step-pause during bulk-start-stop period...
1459    */
1460
1461   //LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_start()\n");
1462 }
1463
1464 /**
1465  * Bulk operation done
1466  */
1467 void
1468 GAS_ril_bulk_stop (void *solver)
1469 {
1470   //TODO? consideration: keep bulk counter and stop agents during bulk
1471   /*
1472    * bulk counter down, see bulk_start()
1473    */
1474
1475   //LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_stop()\n");
1476 }
1477
1478 /**
1479  * Get the preferred address for a specific peer
1480  *
1481  * @param solver the solver handle
1482  * @param peer the identity of the peer
1483  */
1484 const struct ATS_Address *
1485 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
1486 {
1487   /*
1488    * activate agent, return currently chosen address
1489    */
1490   struct GAS_RIL_Handle *s = solver;
1491   struct RIL_Peer_Agent *agent;
1492
1493   agent = ril_get_agent (s, peer, GNUNET_NO);
1494
1495   if (NULL == agent)
1496   {
1497     LOG(GNUNET_ERROR_TYPE_DEBUG,
1498         "API_get_preferred_address() No agent for peer '%s' do not suggest address\n",
1499         GNUNET_i2s (peer));
1500     return NULL ;
1501   }
1502
1503   agent->active = GNUNET_YES;
1504
1505   GNUNET_assert(NULL != agent->address_inuse);
1506
1507   LOG(GNUNET_ERROR_TYPE_DEBUG,
1508       "API_get_preferred_address() Activated agent for peer '%s' with %s address\n",
1509       GNUNET_i2s (peer), agent->address_inuse->plugin);
1510
1511   return agent->address_inuse;
1512 }
1513
1514 /**
1515  * Stop notifying about address and bandwidth changes for this peer
1516  *
1517  * @param solver the solver handle
1518  * @param peer the peer
1519  */
1520 void
1521 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
1522 {
1523   struct GAS_RIL_Handle *s = solver;
1524   struct RIL_Peer_Agent *agent;
1525
1526   agent = ril_get_agent (s, peer, GNUNET_NO);
1527   agent->active = GNUNET_NO;
1528
1529   LOG(GNUNET_ERROR_TYPE_DEBUG,
1530       "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
1531       GNUNET_i2s (peer), agent->address_inuse->plugin);
1532 }
1533
1534 /* end of gnunet-service-ats-solver_ril.c */