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