2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file ats/libgnunet_plugin_ats_ril.c
23 * @brief ATS reinforcement learning solver
24 * @author Fabian Oehlmann
25 * @author Matthias Wachs
27 #include "libgnunet_plugin_ats_ril.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "ats-ril",__VA_ARGS__)
31 #define RIL_ACTION_INVALID -1
32 #define RIL_FEATURES_ADDRESS_COUNT (3 + GNUNET_ATS_QualityPropertiesCount)
33 #define RIL_FEATURES_NETWORK_COUNT 4
34 #define RIL_INTERVAL_EXPONENT 10
36 #define RIL_DEFAULT_STEP_TIME_MIN GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
37 #define RIL_DEFAULT_STEP_TIME_MAX GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 3000)
38 #define RIL_DEFAULT_ALGORITHM RIL_ALGO_SARSA
39 #define RIL_DEFAULT_DISCOUNT_BETA 0.7
40 #define RIL_DEFAULT_GRADIENT_STEP_SIZE 0.4
41 #define RIL_DEFAULT_TRACE_DECAY 0.6
42 #define RIL_DEFAULT_EXPLORE_RATIO 0.1
45 * ATS reinforcement learning solver
51 * The actions, how an agent can manipulate the current assignment. I.e. how the bandwidth can be
52 * changed for the currently chosen address. Not depicted in the enum are the actions of switching
53 * to a particular address. The action of switching to address with index i is depicted by the
54 * number (RIL_ACTION_TYPE_NUM + i).
58 RIL_ACTION_NOTHING = 0,
59 RIL_ACTION_BW_IN_DBL = 1,
60 RIL_ACTION_BW_IN_HLV = 2,
61 RIL_ACTION_BW_IN_INC = 3,
62 RIL_ACTION_BW_IN_DEC = 4,
63 RIL_ACTION_BW_OUT_DBL = 5,
64 RIL_ACTION_BW_OUT_HLV = 6,
65 RIL_ACTION_BW_OUT_INC = 7,
66 RIL_ACTION_BW_OUT_DEC = 8,
67 RIL_ACTION_TYPE_NUM = 9
76 enum RIL_E_Modification
85 * Global learning parameters
87 struct RIL_Learning_Parameters
90 * The TD-algorithm to use
92 enum RIL_Algorithm algorithm;
95 * Learning discount factor in the TD-update
100 * Gradient-descent step-size
105 * Trace-decay factor for eligibility traces
112 double explore_ratio;
115 * Minimal interval time between steps in milliseconds
117 struct GNUNET_TIME_Relative step_time_min;
120 * Maximum interval time between steps in milliseconds
122 struct GNUNET_TIME_Relative step_time_max;
126 * Wrapper for addresses to store them in agent's linked list
128 struct RIL_Address_Wrapped
133 struct RIL_Address_Wrapped *next;
138 struct RIL_Address_Wrapped *prev;
143 struct ATS_Address *address_naked;
146 struct RIL_Peer_Agent
149 * Next agent in solver's linked list
151 struct RIL_Peer_Agent *next;
154 * Previous agent in solver's linked list
156 struct RIL_Peer_Agent *prev;
161 struct GAS_RIL_Handle *envi;
166 struct GNUNET_PeerIdentity peer;
169 * Whether the agent is active or not
174 * Number of performed time-steps
176 unsigned long long step_count;
179 * Experience matrix W
184 * Number of rows of W / Number of state-vector features
189 * Number of columns of W / Number of actions
194 * Last perceived state feature vector
204 * Eligibility trace vector
211 struct ATS_Address * address_inuse;
214 * Head of addresses DLL
216 struct RIL_Address_Wrapped * addresses_head;
219 * Tail of addresses DLL
221 struct RIL_Address_Wrapped * addresses_tail;
224 * Inbound bandwidth assigned by the agent
226 unsigned long long bw_in;
229 * Outbound bandwidth assigned by the agent
231 unsigned long long bw_out;
239 enum GNUNET_ATS_Network_Type type;
242 * Total available inbound bandwidth
244 unsigned long long bw_in_available;
247 * Total assigned outbound bandwidth
249 unsigned long long bw_in_assigned;
252 * Total available outbound bandwidth
254 unsigned long long bw_out_available;
257 * Total assigned outbound bandwidth
259 unsigned long long bw_out_assigned;
263 * A handle for the reinforcement learning solver
265 struct GAS_RIL_Handle
268 * The solver-plugin environment of the solver-plugin API
270 struct GNUNET_ATS_PluginEnvironment *plugin_envi;
275 struct GNUNET_STATISTICS_Handle *stats;
278 * Number of performed steps
280 unsigned long long step_count;
283 * Timestamp for the last time-step
285 struct GNUNET_TIME_Absolute step_time_last;
288 * Task identifier of the next time-step to be executed
290 GNUNET_SCHEDULER_TaskIdentifier step_next_task_id;
293 * Whether a step is already scheduled
298 * Variable discount factor, dependent on time between steps
300 double discount_variable;
303 * Integrated variable discount factor, dependent on time between steps
305 double discount_integrated;
308 * Lock for bulk operations
313 * Number of changes during a lock
318 * Learning parameters
320 struct RIL_Learning_Parameters parameters;
323 * Array of networks with global assignment state
325 struct RIL_Network * network_entries;
330 unsigned int networks_count;
333 * List of active peer-agents
335 struct RIL_Peer_Agent * agents_head;
336 struct RIL_Peer_Agent * agents_tail;
341 * ---------------------------
345 * Estimate the current action-value for state s and action a
347 * @param agent agent performing the estimation
350 * @return estimation value
353 agent_estimate_q (struct RIL_Peer_Agent *agent, double *state, int action)
358 for (i = 0; i < agent->m; i++)
360 result += state[i] * agent->W[action][i];
367 * Decide whether to do exploration (i.e. taking a new action) or exploitation (i.e. taking the
368 * currently estimated best action) in the current step
370 * @param agent agent performing the step
371 * @return yes, if exploring
374 agent_decide_exploration (struct RIL_Peer_Agent *agent)
376 //TODO? Future Work: Improve exploration/exploitation trade-off by different mechanisms than e-greedy
377 double r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
378 UINT32_MAX) / (double) UINT32_MAX;
380 if (r < agent->envi->parameters.explore_ratio)
388 * Get the index of the address in the agent's list.
390 * @param agent agent handle
391 * @param address address handle
392 * @return the index, starting with zero
395 agent_address_get_index (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
398 struct RIL_Address_Wrapped *cur;
401 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
404 if (cur->address_naked == address)
414 * Gets the wrapped address from the agent's list
416 * @param agent agent handle
417 * @param address address handle
418 * @return wrapped address
420 static struct RIL_Address_Wrapped *
421 agent_address_get (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
423 struct RIL_Address_Wrapped *cur;
425 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
427 if (cur->address_naked == address)
437 * Gets the action, with the maximal estimated Q-value (i.e. the one currently estimated to bring the
438 * most reward in the future)
440 * @param agent agent performing the calculation
441 * @param state the state from which to take the action
442 * @return the action promising most future reward
445 agent_get_action_best (struct RIL_Peer_Agent *agent, double *state)
448 int max_i = RIL_ACTION_INVALID;
450 double max_q = -DBL_MAX;
452 for (i = 0; i < agent->n; i++)
454 cur_q = agent_estimate_q (agent, state, i);
462 GNUNET_assert(RIL_ACTION_INVALID != max_i);
468 * Gets any action, to explore the action space from that state
470 * @param agent agent performing the calculation
471 * @param state the state from which to take the action
475 agent_get_action_explore (struct RIL_Peer_Agent *agent, double *state)
477 // TODO?: Future Work: Choose the action for exploration, which has been explored the least in this state
478 return GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, agent->n);
482 * Updates the weights (i.e. coefficients) of the weight vector in matrix W for action a
484 * @param agent the agent performing the update
485 * @param reward the reward received for the last action
486 * @param s_next the new state, the last step got the agent into
487 * @param a_prime the new
490 agent_update_weights (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a_prime)
494 double *theta = agent->W[agent->a_old];
496 delta = agent->envi->discount_integrated * reward; //reward
497 delta += agent->envi->discount_variable * agent_estimate_q (agent, s_next, a_prime); //discounted future value
498 delta -= agent_estimate_q (agent, agent->s_old, agent->a_old); //one step
499 for (i = 0; i < agent->m; i++)
501 theta[i] += agent->envi->parameters.alpha * delta * agent->e[i];
506 * Changes the eligibility trace vector e in various manners:
507 * RIL_E_ACCUMULATE - adds 1 to each component as in accumulating eligibility traces
508 * RIL_E_REPLACE - resets each component to 1 as in replacing traces
509 * RIL_E_SET - multiplies e with discount factor and lambda as in the update rule
510 * RIL_E_ZERO - sets e to 0 as in Watkin's Q-learning algorithm when exploring and when initializing
512 * @param agent the agent handle
513 * @param mod the kind of modification
516 agent_modify_eligibility (struct RIL_Peer_Agent *agent, enum RIL_E_Modification mod)
519 double *e = agent->e;
521 for (i = 0; i < agent->m; i++)
525 case RIL_E_ACCUMULATE:
532 e[i] = agent->envi->discount_variable * agent->envi->parameters.lambda;
542 ril_inform (struct GAS_RIL_Handle *solver,
543 enum GAS_Solver_Operation op,
544 enum GAS_Solver_Status stat)
546 if (NULL != solver->plugin_envi->info_cb)
547 solver->plugin_envi->info_cb (solver->plugin_envi->info_cb_cls, op, stat, GAS_INFO_NONE);
551 * Changes the active assignment suggestion of the handler and invokes the bw_changed callback to
552 * notify ATS of its new decision
554 * @param solver solver handle
555 * @param agent agent handle
556 * @param new_address the address which is to be used
557 * @param new_bw_in the new amount of inbound bandwidth set for this address
558 * @param new_bw_out the new amount of outbound bandwidth set for this address
559 * @param silent disables invocation of the bw_changed callback, if GNUNET_YES
562 envi_set_active_suggestion (struct GAS_RIL_Handle *solver,
563 struct RIL_Peer_Agent *agent,
564 struct ATS_Address *new_address,
565 unsigned long long new_bw_in,
566 unsigned long long new_bw_out,
569 int notify = GNUNET_NO;
571 LOG(GNUNET_ERROR_TYPE_DEBUG, "set_active_suggestion()\n");
574 if (agent->address_inuse != new_address)
576 if (NULL != agent->address_inuse)
578 agent->address_inuse->active = GNUNET_NO;
579 agent->address_inuse->assigned_bw_in.value__ = htonl (0);
580 agent->address_inuse->assigned_bw_out.value__ = htonl (0);
582 if (NULL != new_address)
584 LOG(GNUNET_ERROR_TYPE_DEBUG, "set address active: %s\n", agent->is_active ? "yes" : "no");
585 new_address->active = agent->is_active;
586 new_address->assigned_bw_in.value__ = htonl (agent->bw_in);
587 new_address->assigned_bw_out.value__ = htonl (agent->bw_out);
589 notify |= GNUNET_YES;
595 if (new_address->active != agent->is_active)
597 new_address->active = agent->is_active;
601 if (agent->bw_in != new_bw_in)
603 agent->bw_in = new_bw_in;
604 new_address->assigned_bw_in.value__ = htonl (new_bw_out);
605 notify |= GNUNET_YES;
607 if (agent->bw_out != new_bw_out)
609 agent->bw_out = new_bw_out;
610 new_address->assigned_bw_out.value__ = htonl (new_bw_out);
611 notify |= GNUNET_YES;
615 if (notify && agent->is_active && (GNUNET_NO == silent))
619 solver->plugin_envi->bandwidth_changed_cb (solver->plugin_envi->bw_changed_cb_cls,
622 else if (agent->address_inuse)
624 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_in.value__));
625 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_out.value__));
629 solver->plugin_envi->bandwidth_changed_cb (solver->plugin_envi->bw_changed_cb_cls,
630 agent->address_inuse);
633 agent->address_inuse = new_address;
637 * Allocates a state vector and fills it with the features present
638 * @param solver the solver handle
639 * @param agent the agent handle
640 * @return pointer to the state vector
643 envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
647 struct RIL_Network *net;
648 double *state = GNUNET_malloc (sizeof (double) * agent->m);
649 struct RIL_Address_Wrapped *cur_address;
650 const double *properties;
652 for (i = 0; i < solver->networks_count; i++)
654 net = &solver->network_entries[i];
655 state[i * RIL_FEATURES_NETWORK_COUNT + 0] = (double) net->bw_in_assigned;
656 state[i * RIL_FEATURES_NETWORK_COUNT + 1] = (double) net->bw_in_available;
657 state[i * RIL_FEATURES_NETWORK_COUNT + 2] = (double) net->bw_out_assigned;
658 state[i * RIL_FEATURES_NETWORK_COUNT + 3] = (double) net->bw_out_available;
661 i = i * RIL_FEATURES_NETWORK_COUNT; //first address feature
663 for (cur_address = agent->addresses_head; NULL != cur_address; cur_address = cur_address->next)
665 state[i++] = cur_address->address_naked->active;
666 state[i++] = cur_address->address_naked->active ? agent->bw_in : 0;
667 state[i++] = cur_address->address_naked->active ? agent->bw_out : 0;
668 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
669 cur_address->address_naked);
670 for (k = 0; k < GNUNET_ATS_QualityPropertiesCount; k++)
672 state[i++] = properties[k];
680 * For all networks a peer has an address in, this gets the maximum bandwidth which could
681 * theoretically be available in one of the networks. This is used for bandwidth normalization.
683 * @param agent the agent handle
684 * @param direction_in whether the inbound bandwidth should be considered. Returns the maximum outbound bandwidth if GNUNET_NO
686 static long long unsigned
687 ril_get_max_bw (struct RIL_Peer_Agent *agent, int direction_in)
690 * get the maximum bandwidth possible for a peer, e.g. among all addresses which addresses'
691 * network could provide the maximum bandwidth if all that bandwidth was used on that one peer.
694 struct RIL_Address_Wrapped *cur;
695 struct RIL_Network *net;
697 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
699 net = cur->address_naked->solver_information;
702 if (net->bw_in_available > max)
704 max = net->bw_in_available;
709 if (net->bw_out_available > max)
711 max = net->bw_out_available;
719 * Get the index of the quality-property in question
721 * @param type the quality property type
725 ril_find_property_index (uint32_t type)
727 int existing_types[] = GNUNET_ATS_QualityProperties;
729 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
730 if (existing_types[c] == type)
732 return GNUNET_SYSERR;
736 envi_reward_global (struct GAS_RIL_Handle *solver)
739 unsigned int in_available = 0;
740 unsigned int out_available = 0;
741 unsigned int in_assigned = 0;
742 unsigned int out_assigned = 0;
746 for (i = 0; i < solver->networks_count; i++)
748 in_available += solver->network_entries[i].bw_in_available;
749 in_assigned += solver->network_entries[i].bw_in_assigned;
750 out_available += solver->network_entries[i].bw_out_available;
751 out_assigned += solver->network_entries[i].bw_out_assigned;
754 ratio_in = ((double) in_assigned) / ((double) in_available);
755 ratio_out = ((double) out_assigned) / ((double) out_available);
757 return ((ratio_in + ratio_out) * 0.5) + 1;
761 envi_reward_local (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
763 //TODO! add utilization
765 const double *preferences;
766 const double *properties;
768 double pref_match = 0;
771 preferences = solver->plugin_envi->get_preferences (solver->plugin_envi->get_preference_cls,
773 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
774 agent->address_inuse);
776 //preference matching from latency and bandwidth
777 prop_index = ril_find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
778 pref_match += 1 - (preferences[GNUNET_ATS_PREFERENCE_LATENCY] * (3 - properties[prop_index])); //invert property as we want to maximize for lower latencies
779 bw_norm = GNUNET_MAX(2, (((
780 ((double) agent->bw_in / (double) ril_get_max_bw(agent, GNUNET_YES)) +
781 ((double) agent->bw_out / (double) ril_get_max_bw(agent, GNUNET_NO))
785 pref_match += 1 - (preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] * bw_norm);
787 return pref_match * 0.5;
791 * Gets the reward for the last performed step, which is calculated in equal
792 * parts from the local (the peer specific) and the global (for all peers
795 * @param solver the solver handle
796 * @param agent the agent handle
800 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
802 struct RIL_Network *net;
805 //punish overutilization
806 net = agent->address_inuse->solver_information;
807 if ((net->bw_in_assigned > net->bw_in_available)
808 || (net->bw_out_assigned > net->bw_out_available))
813 reward += envi_reward_global (solver);
814 reward += envi_reward_local (solver, agent);
819 * Doubles the bandwidth for the active address
821 * @param solver solver handle
822 * @param agent agent handle
823 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
826 envi_action_bw_double (struct GAS_RIL_Handle *solver,
827 struct RIL_Peer_Agent *agent,
832 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in * 2,
833 agent->bw_out, GNUNET_NO);
837 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
838 agent->bw_out * 2, GNUNET_NO);
843 * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
844 * the minimum bandwidth for a peer, in order to not invoke a disconnect.
846 * @param solver solver handle
847 * @param agent agent handle
848 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
852 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
853 struct RIL_Peer_Agent *agent,
856 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
857 unsigned long long new_bw;
861 new_bw = agent->bw_in / 2;
864 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
869 new_bw = agent->bw_out / 2;
872 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
878 * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
880 * @param solver solver handle
881 * @param agent agent handle
882 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
886 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
888 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
892 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in + (5 * min_bw),
893 agent->bw_out, GNUNET_NO);
897 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
898 agent->bw_out + (5 * min_bw), GNUNET_NO);
903 * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
904 * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
906 * @param solver solver handle
907 * @param agent agent handle
908 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
912 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
914 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
915 unsigned long long new_bw;
919 new_bw = agent->bw_in - (5 * min_bw);
922 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
927 new_bw = agent->bw_out - (5 * min_bw);
930 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
936 * Switches to the address given by its index
938 * @param solver solver handle
939 * @param agent agent handle
940 * @param address_index index of the address as it is saved in the agent's list, starting with zero
943 envi_action_address_switch (struct GAS_RIL_Handle *solver,
944 struct RIL_Peer_Agent *agent,
945 unsigned int address_index)
947 struct RIL_Address_Wrapped *cur;
950 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
952 if (i == address_index)
954 envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
962 //no address with address_index exists, in this case this action should not be callable
963 GNUNET_assert(GNUNET_NO);
967 * Puts the action into effect by calling the according function
969 * @param solver the solver handle
970 * @param agent the action handle
971 * @param action the action to perform by the solver
974 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
980 case RIL_ACTION_NOTHING:
982 case RIL_ACTION_BW_IN_DBL:
983 envi_action_bw_double (solver, agent, GNUNET_YES);
985 case RIL_ACTION_BW_IN_HLV:
986 envi_action_bw_halven (solver, agent, GNUNET_YES);
988 case RIL_ACTION_BW_IN_INC:
989 envi_action_bw_inc (solver, agent, GNUNET_YES);
991 case RIL_ACTION_BW_IN_DEC:
992 envi_action_bw_dec (solver, agent, GNUNET_YES);
994 case RIL_ACTION_BW_OUT_DBL:
995 envi_action_bw_double (solver, agent, GNUNET_NO);
997 case RIL_ACTION_BW_OUT_HLV:
998 envi_action_bw_halven (solver, agent, GNUNET_NO);
1000 case RIL_ACTION_BW_OUT_INC:
1001 envi_action_bw_inc (solver, agent, GNUNET_NO);
1003 case RIL_ACTION_BW_OUT_DEC:
1004 envi_action_bw_dec (solver, agent, GNUNET_NO);
1007 if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
1009 address_index = action - RIL_ACTION_TYPE_NUM;
1011 GNUNET_assert(address_index >= 0);
1013 address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
1015 envi_action_address_switch (solver, agent, address_index);
1018 // error - action does not exist
1019 GNUNET_assert(GNUNET_NO);
1024 * Performs one step of the Markov Decision Process. Other than in the literature the step starts
1025 * after having done the last action a_old. It observes the new state s_next and the reward
1026 * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
1027 * next action is put into effect.
1029 * @param agent the agent performing the step
1032 agent_step (struct RIL_Peer_Agent *agent)
1034 int a_next = RIL_ACTION_INVALID;
1038 s_next = envi_get_state (agent->envi, agent);
1039 reward = envi_get_reward (agent->envi, agent);
1041 LOG(GNUNET_ERROR_TYPE_DEBUG, "agent_step() with algorithm %s\n",
1042 agent->envi->parameters.algorithm ? "Q" : "SARSA");
1044 switch (agent->envi->parameters.algorithm)
1046 case RIL_ALGO_SARSA:
1047 agent_modify_eligibility (agent, RIL_E_SET);
1048 if (agent_decide_exploration (agent))
1050 a_next = agent_get_action_explore (agent, s_next);
1054 a_next = agent_get_action_best (agent, s_next);
1056 if (RIL_ACTION_INVALID != agent->a_old)
1058 //updates weights with selected action (on-policy), if not first step
1059 agent_update_weights (agent, reward, s_next, a_next);
1064 a_next = agent_get_action_best (agent, s_next);
1065 if (RIL_ACTION_INVALID != agent->a_old)
1067 //updates weights with best action, disregarding actually selected action (off-policy), if not first step
1068 agent_update_weights (agent, reward, s_next, a_next);
1070 if (agent_decide_exploration (agent))
1072 a_next = agent_get_action_explore (agent, s_next);
1073 agent_modify_eligibility (agent, RIL_E_ZERO);
1077 a_next = agent_get_action_best (agent, s_next);
1078 agent_modify_eligibility (agent, RIL_E_SET);
1083 GNUNET_assert(RIL_ACTION_INVALID != a_next);
1085 agent_modify_eligibility (agent, RIL_E_ACCUMULATE);
1087 envi_do_action (agent->envi, agent, a_next);
1089 GNUNET_free(agent->s_old);
1090 agent->s_old = s_next;
1091 agent->a_old = a_next;
1093 agent->step_count += 1;
1097 ril_step (struct GAS_RIL_Handle *solver);
1100 * Task for the scheduler, which performs one step and lets the solver know that
1101 * no further step is scheduled.
1103 * @param cls the solver handle
1104 * @param tc the task context for the scheduler
1107 ril_step_scheduler_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1109 struct GAS_RIL_Handle *solver = cls;
1111 solver->task_pending = GNUNET_NO;
1116 ril_get_used_resource_ratio (struct GAS_RIL_Handle *solver)
1119 struct RIL_Network net;
1120 unsigned long long sum_assigned = 0;
1121 unsigned long long sum_available = 0;
1124 for (i = 0; i < solver->networks_count; i++)
1126 net = solver->network_entries[i];
1127 if (net.bw_in_assigned > 0) //only consider scopes with an active address
1129 sum_assigned += net.bw_in_assigned;
1130 sum_assigned += net.bw_out_assigned;
1131 sum_available += net.bw_in_available;
1132 sum_available += net.bw_out_available;
1135 if (sum_available > 0)
1137 ratio = ((double) sum_assigned) / ((double) sum_available);
1144 return ratio > 1 ? 1 : ratio; //overutilization possible, cap at 1
1148 * Schedules the next global step in an adaptive way. The more resources are
1149 * left, the earlier the next step is scheduled. This serves the reactivity of
1150 * the solver to changed inputs.
1152 * @param solver the solver handle
1155 ril_step_schedule_next (struct GAS_RIL_Handle *solver)
1161 struct GNUNET_TIME_Relative time_next;
1163 if (solver->task_pending)
1165 GNUNET_SCHEDULER_cancel (solver->step_next_task_id);
1168 used_ratio = ril_get_used_resource_ratio (solver);
1171 solver->parameters.step_time_min.rel_value_us
1172 < solver->parameters.step_time_max.rel_value_us);
1174 factor = (double) GNUNET_TIME_relative_subtract (solver->parameters.step_time_max,
1175 solver->parameters.step_time_min).rel_value_us;
1176 offset = (double) solver->parameters.step_time_min.rel_value_us;
1177 y = factor * pow (used_ratio, RIL_INTERVAL_EXPONENT) + offset;
1179 //LOG (GNUNET_ERROR_TYPE_INFO, "used = %f, min = %f, max = %f\n", used_ratio, (double)solver->parameters.step_time_min.rel_value_us, (double)solver->parameters.step_time_max.rel_value_us);
1180 //LOG (GNUNET_ERROR_TYPE_INFO, "factor = %f, offset = %f, y = %f\n", factor, offset, y);
1182 GNUNET_assert(y <= (double ) solver->parameters.step_time_max.rel_value_us);
1183 GNUNET_assert(y >= (double ) solver->parameters.step_time_min.rel_value_us);
1185 time_next = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, (unsigned int) y);
1187 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (time_next, &ril_step_scheduler_task,
1189 solver->task_pending = GNUNET_YES;
1193 * Triggers one step per agent
1197 ril_step (struct GAS_RIL_Handle *solver)
1199 struct RIL_Peer_Agent *cur;
1200 struct GNUNET_TIME_Absolute time_now;
1201 struct GNUNET_TIME_Relative time_delta;
1204 if (GNUNET_YES == solver->bulk_lock)
1206 solver->bulk_changes++;
1210 ril_inform (solver, GAS_OP_SOLVE_START, GAS_STAT_SUCCESS);
1212 LOG(GNUNET_ERROR_TYPE_DEBUG, "RIL step number %d\n", solver->step_count);
1214 if (0 == solver->step_count)
1216 solver->step_time_last = GNUNET_TIME_absolute_get ();
1219 //calculate tau, i.e. how many real valued time units have passed, one time unit is one minimum time step
1220 time_now = GNUNET_TIME_absolute_get ();
1221 time_delta = GNUNET_TIME_absolute_get_difference (solver->step_time_last, time_now);
1222 tau = ((double) time_delta.rel_value_us)
1223 / ((double) solver->parameters.step_time_min.rel_value_us);
1224 solver->step_time_last = time_now;
1226 //calculate reward discounts (once per step for all agents)
1227 solver->discount_variable = pow (M_E, ((-1.) * ((double) solver->parameters.beta) * tau));
1228 solver->discount_integrated = (1 - solver->discount_variable)
1229 / ((double) solver->parameters.beta);
1231 //trigger one step per active agent
1232 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1234 if (cur->is_active && cur->address_inuse)
1240 solver->step_count += 1;
1241 ril_step_schedule_next (solver);
1243 ril_inform (solver, GAS_OP_SOLVE_STOP, GAS_STAT_SUCCESS);
1249 * Initialize an agent without addresses and its knowledge base
1251 * @param s ril solver
1252 * @param peer the one in question
1253 * @return handle to the new agent
1255 static struct RIL_Peer_Agent *
1256 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1259 struct GAS_RIL_Handle * solver = s;
1260 struct RIL_Peer_Agent * agent = GNUNET_malloc (sizeof (struct RIL_Peer_Agent));
1262 agent->envi = solver;
1263 agent->peer = *peer;
1264 agent->step_count = 0;
1265 agent->is_active = GNUNET_NO;
1266 agent->n = RIL_ACTION_TYPE_NUM;
1267 agent->m = solver->networks_count * RIL_FEATURES_NETWORK_COUNT;
1268 agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1269 for (i = 0; i < agent->n; i++)
1271 agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1273 agent->a_old = RIL_ACTION_INVALID;
1274 agent->s_old = envi_get_state (solver, agent);
1275 agent->e = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1276 agent_modify_eligibility (agent, RIL_E_ZERO);
1278 GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, agent);
1286 * @param solver the solver handle
1287 * @param agent the agent to retire
1290 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1294 for (i = 0; i < agent->n; i++)
1296 GNUNET_free(agent->W[i]);
1298 GNUNET_free(agent->W);
1299 GNUNET_free(agent->e);
1300 GNUNET_free(agent->s_old);
1305 * Returns the agent for a peer
1307 * @param solver the solver handle
1308 * @param peer the identity of the peer
1309 * @param create whether or not to create an agent, if none is allocated yet
1312 static struct RIL_Peer_Agent *
1313 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
1315 struct RIL_Peer_Agent *cur;
1317 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1319 if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
1327 return agent_init (solver, peer);
1333 * Lookup network struct by type
1335 * @param s the solver handle
1336 * @param type the network type
1337 * @return the network struct
1339 static struct RIL_Network *
1340 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1344 for (i = 0; i < s->networks_count; i++)
1346 if (s->network_entries[i].type == type)
1348 return &s->network_entries[i];
1355 * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
1356 * considered inactive and not used. Addresses in an inactive network are ignored.
1358 * @param solver solver handle
1359 * @param network the network type
1360 * @return whether or not the network is considered active
1363 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1365 struct RIL_Network *net;
1366 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1368 net = ril_get_network (solver, network);
1369 if (net->bw_out_available < min_bw)
1375 * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
1376 * the reward function approximation. It copies the memory, which is not cut, to the new vector,
1377 * frees the memory of the old vector, and redirects the pointer to the new one.
1379 * @param old pointer to the pointer to the first element of the vector
1380 * @param element_size byte size of the vector elements
1381 * @param hole_start the first element to cut out
1382 * @param hole_length the number of elements to cut out
1383 * @param old_length the length of the old vector
1386 ril_cut_from_vector (void **old,
1387 size_t element_size,
1388 unsigned int hole_start,
1389 unsigned int hole_length,
1390 unsigned int old_length)
1393 char *oldptr = (char *) *old;
1395 unsigned int bytes_before;
1396 unsigned int bytes_hole;
1397 unsigned int bytes_after;
1399 GNUNET_assert(old_length > hole_length);
1400 GNUNET_assert(old_length >= (hole_start + hole_length));
1402 size = element_size * (old_length - hole_length);
1404 bytes_before = element_size * hole_start;
1405 bytes_hole = element_size * hole_length;
1406 bytes_after = element_size * (old_length - hole_start - hole_length);
1414 tmpptr = GNUNET_malloc (size);
1415 memcpy (tmpptr, oldptr, bytes_before);
1416 memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
1422 *old = (void *) tmpptr;
1426 * Solver API functions
1427 * ---------------------------
1431 * Change relative preference for quality in solver
1433 * @param solver the solver handle
1434 * @param peer the peer to change the preference for
1435 * @param kind the kind to change the preference
1436 * @param pref_rel the normalized preference value for this kind over all clients
1439 GAS_ril_address_change_preference (void *solver,
1440 const struct GNUNET_PeerIdentity *peer,
1441 enum GNUNET_ATS_PreferenceKind kind,
1444 LOG(GNUNET_ERROR_TYPE_DEBUG,
1445 "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
1446 GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
1452 * Entry point for the plugin
1454 * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
1457 libgnunet_plugin_ats_ril_init (void *cls)
1459 struct GNUNET_ATS_PluginEnvironment *env = cls;
1460 struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
1461 struct RIL_Network * cur;
1465 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
1467 GNUNET_assert(NULL != env);
1468 GNUNET_assert(NULL != env->cfg);
1469 GNUNET_assert(NULL != env->stats);
1470 GNUNET_assert(NULL != env->bandwidth_changed_cb);
1471 GNUNET_assert(NULL != env->get_preferences);
1472 GNUNET_assert(NULL != env->get_property);
1475 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MIN",
1476 &solver->parameters.step_time_min))
1478 solver->parameters.step_time_min = RIL_DEFAULT_STEP_TIME_MIN;
1481 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MAX",
1482 &solver->parameters.step_time_max))
1484 solver->parameters.step_time_max = RIL_DEFAULT_STEP_TIME_MAX;
1486 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string))
1488 solver->parameters.algorithm = !strcmp (string, "SARSA") ? RIL_ALGO_SARSA : RIL_ALGO_Q;
1492 solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
1494 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_DISCOUNT_BETA", &string))
1496 solver->parameters.beta = strtod (string, NULL);
1500 solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
1503 == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &string))
1505 solver->parameters.alpha = strtod (string, NULL);
1509 solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
1511 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TRACE_DECAY", &string))
1513 solver->parameters.lambda = strtod (string, NULL);
1517 solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
1519 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_EXPLORE_RATIO", &string))
1521 solver->parameters.explore_ratio = strtod (string, NULL);
1525 solver->parameters.explore_ratio = RIL_DEFAULT_EXPLORE_RATIO;
1528 env->sf.s_add = &GAS_ril_address_add;
1529 env->sf.s_address_update_property = &GAS_ril_address_property_changed;
1530 env->sf.s_address_update_session = &GAS_ril_address_session_changed;
1531 env->sf.s_address_update_inuse = &GAS_ril_address_inuse_changed;
1532 env->sf.s_address_update_network = &GAS_ril_address_change_network;
1533 env->sf.s_get = &GAS_ril_get_preferred_address;
1534 env->sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
1535 env->sf.s_pref = &GAS_ril_address_change_preference;
1536 env->sf.s_feedback = &GAS_ril_address_preference_feedback;
1537 env->sf.s_del = &GAS_ril_address_delete;
1538 env->sf.s_bulk_start = &GAS_ril_bulk_start;
1539 env->sf.s_bulk_stop = &GAS_ril_bulk_stop;
1541 solver->plugin_envi = env;
1542 solver->networks_count = env->network_count;
1543 solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Network));
1544 solver->step_count = 0;
1546 for (c = 0; c < env->network_count; c++)
1548 cur = &solver->network_entries[c];
1549 cur->type = env->networks[c];
1550 cur->bw_in_available = env->in_quota[c];
1551 cur->bw_in_assigned = 0;
1552 cur->bw_out_available = env->out_quota[c];
1553 cur->bw_out_assigned = 0;
1556 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (
1557 GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_get_millisecond_ (), 1000),
1558 &ril_step_scheduler_task, solver);
1559 solver->task_pending = GNUNET_YES;
1565 * Exit point for the plugin
1567 * @param cls the solver handle
1570 libgnunet_plugin_ats_ril_done (void *cls)
1572 struct GAS_RIL_Handle *s = cls;
1573 struct RIL_Peer_Agent *cur_agent;
1574 struct RIL_Peer_Agent *next_agent;
1576 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
1578 cur_agent = s->agents_head;
1579 while (NULL != cur_agent)
1581 next_agent = cur_agent->next;
1582 GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
1583 agent_die (s, cur_agent);
1584 cur_agent = next_agent;
1587 if (s->task_pending)
1589 GNUNET_SCHEDULER_cancel (s->step_next_task_id);
1591 GNUNET_free(s->network_entries);
1598 * Add a new address for a peer to the solver
1600 * The address is already contained in the addresses hashmap!
1602 * @param solver the solver Handle
1603 * @param address the address to add
1604 * @param network network type of this address
1607 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
1609 struct GAS_RIL_Handle *s = solver;
1610 struct RIL_Peer_Agent *agent;
1611 struct RIL_Address_Wrapped *address_wrapped;
1612 struct RIL_Network *net;
1619 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1621 net = ril_get_network (s, network);
1622 address->solver_information = net;
1624 if (!ril_network_is_active (s, network))
1626 LOG(GNUNET_ERROR_TYPE_DEBUG,
1627 "API_address_add() Did not add %s address %p for peer '%s', network does not have enough bandwidth\n",
1628 address->plugin, address->addr, GNUNET_i2s (&address->peer));
1632 agent = ril_get_agent (s, &address->peer, GNUNET_YES);
1635 address_wrapped = GNUNET_malloc (sizeof (struct RIL_Address_Wrapped));
1636 address_wrapped->address_naked = address;
1637 GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
1639 //increase size of W
1640 m_new = agent->m + RIL_FEATURES_ADDRESS_COUNT;
1642 n_new = agent->n + 1;
1645 GNUNET_array_grow(agent->W, agent->n, n_new);
1646 for (i = 0; i < n_new; i++)
1651 GNUNET_array_grow(agent->W[i], agent->m, m_new);
1656 GNUNET_array_grow(agent->W[i], zero, m_new);
1660 //increase size of old state vector
1662 GNUNET_array_grow(agent->s_old, agent->m, m_new);
1665 GNUNET_array_grow(agent->e, agent->m, m_new);
1667 if (NULL == agent->address_inuse)
1669 net->bw_in_assigned += min_bw;
1670 net->bw_out_assigned += min_bw;
1671 envi_set_active_suggestion (s, agent, address, min_bw, min_bw, GNUNET_NO);
1676 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %p for peer '%s'\n",
1677 address->active ? "active" : "inactive", address->plugin, address->addr,
1678 GNUNET_i2s (&address->peer));
1682 * Delete an address in the solver
1684 * The address is not contained in the address hashmap anymore!
1686 * @param solver the solver handle
1687 * @param address the address to remove
1688 * @param session_only delete only session not whole address
1691 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
1693 struct GAS_RIL_Handle *s = solver;
1694 struct RIL_Peer_Agent *agent;
1695 struct RIL_Address_Wrapped *address_wrapped;
1696 int address_was_used = address->active;
1701 struct RIL_Network *net;
1702 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1704 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Delete %s%s %s address %p for peer '%s'\n",
1705 session_only ? "session for " : "", address->active ? "active" : "inactive", address->plugin,
1706 address->addr, GNUNET_i2s (&address->peer));
1708 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1711 net = address->solver_information;
1712 GNUNET_assert(!ril_network_is_active (s, net->type));
1713 LOG(GNUNET_ERROR_TYPE_DEBUG,
1714 "No agent allocated for peer yet, since address was in inactive network\n");
1718 address_index = agent_address_get_index (agent, address);
1719 address_wrapped = agent_address_get (agent, address);
1721 if (NULL == address_wrapped)
1723 net = address->solver_information;
1724 GNUNET_assert(!ril_network_is_active (s, net->type));
1725 LOG(GNUNET_ERROR_TYPE_DEBUG,
1726 "Address not considered by agent, address was in inactive network\n");
1730 GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
1731 GNUNET_free(address_wrapped);
1734 m_new = agent->m - RIL_FEATURES_ADDRESS_COUNT;
1735 n_new = agent->n - 1;
1737 for (i = 0; i < agent->n; i++)
1739 ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
1740 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1741 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1743 GNUNET_free(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
1744 ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
1746 //correct last action
1747 if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
1751 else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
1753 agent->a_old = RIL_ACTION_INVALID;
1755 //decrease old state vector and eligibility vector
1756 ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
1757 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1758 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1759 ril_cut_from_vector ((void **) &agent->e, sizeof(double),
1760 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1761 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1765 LOG(GNUNET_ERROR_TYPE_DEBUG, "address was used: %s\n", address_was_used ? "yes" : "no");
1767 if (address_was_used)
1769 net = address->solver_information;
1770 net->bw_in_assigned -= agent->bw_in;
1771 net->bw_out_assigned -= agent->bw_out;
1773 if (NULL != agent->addresses_head) //if peer has an address left, use it
1775 LOG(GNUNET_ERROR_TYPE_DEBUG, "address left: %p\n",
1776 agent->addresses_head->address_naked->addr);
1777 //TODO? check if network/bandwidth update can be done more clever/elegant at different function
1778 envi_set_active_suggestion (s, agent, agent->addresses_head->address_naked, min_bw, min_bw,
1780 net = agent->addresses_head->address_naked->solver_information;
1781 net->bw_in_assigned -= min_bw;
1782 net->bw_out_assigned -= min_bw;
1786 LOG(GNUNET_ERROR_TYPE_DEBUG, "no address left => disconnect\n");
1788 envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
1794 LOG(GNUNET_ERROR_TYPE_DEBUG, "Address deleted\n");
1798 * Update the properties of an address in the solver
1800 * @param solver solver handle
1801 * @param address the address
1802 * @param type the ATSI type in HBO
1803 * @param abs_value the absolute value of the property
1804 * @param rel_value the normalized value
1807 GAS_ril_address_property_changed (void *solver,
1808 struct ATS_Address *address,
1813 LOG(GNUNET_ERROR_TYPE_DEBUG,
1814 "API_address_property_changed() Property '%s' for peer '%s' address %p changed "
1815 "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1816 address->addr, rel_value);
1822 * Update the session of an address in the solver
1824 * NOTE: values in addresses are already updated
1826 * @param solver solver handle
1827 * @param address the address
1828 * @param cur_session the current session
1829 * @param new_session the new session
1832 GAS_ril_address_session_changed (void *solver,
1833 struct ATS_Address *address,
1834 uint32_t cur_session,
1835 uint32_t new_session)
1838 * TODO? Future Work: Potentially add session activity as a feature in state vector
1840 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
1844 * Notify the solver that an address is (not) actively used by transport
1845 * to communicate with a remote peer
1847 * NOTE: values in addresses are already updated
1849 * @param solver solver handle
1850 * @param address the address
1851 * @param in_use usage state
1854 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
1856 /* Nothing to do here.
1857 * Possible TODO? Future Work: Potentially add usage variable to state vector
1859 LOG(GNUNET_ERROR_TYPE_DEBUG,
1860 "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
1861 address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1865 * Notify solver that the network an address is located in has changed
1867 * NOTE: values in addresses are already updated
1869 * @param solver solver handle
1870 * @param address the address
1871 * @param current_network the current network
1872 * @param new_network the new network
1875 GAS_ril_address_change_network (void *solver,
1876 struct ATS_Address *address,
1877 uint32_t current_network,
1878 uint32_t new_network)
1880 struct GAS_RIL_Handle *s = solver;
1881 struct RIL_Peer_Agent *agent;
1882 struct RIL_Network *net;
1883 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1885 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
1886 "%s address of peer %s from '%s' to '%s'\n",
1887 (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
1888 GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
1890 if (address->active && !ril_network_is_active (solver, new_network))
1892 GAS_ril_address_delete (solver, address, GNUNET_NO);
1896 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1899 GNUNET_assert(!ril_network_is_active (solver, current_network));
1901 GAS_ril_address_add (s, address, new_network);
1905 net = ril_get_network (s, current_network);
1906 net->bw_in_assigned -= agent->bw_in;
1907 net->bw_out_assigned -= agent->bw_out;
1909 net = ril_get_network (s, new_network);
1910 net->bw_in_assigned -= min_bw;
1911 net->bw_out_assigned -= min_bw;
1912 address->solver_information = net;
1916 * Give feedback about the current assignment
1918 * @param solver the solver handle
1919 * @param application the application
1920 * @param peer the peer to change the preference for
1921 * @param scope the time interval for this feedback: [now - scope .. now]
1922 * @param kind the kind to change the preference
1923 * @param score the score
1926 GAS_ril_address_preference_feedback (void *solver,
1928 const struct GNUNET_PeerIdentity *peer,
1929 const struct GNUNET_TIME_Relative scope,
1930 enum GNUNET_ATS_PreferenceKind kind,
1933 LOG(GNUNET_ERROR_TYPE_DEBUG,
1934 "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
1935 "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
1936 GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
1940 * Start a bulk operation
1942 * @param solver the solver
1945 GAS_ril_bulk_start (void *solver)
1947 struct GAS_RIL_Handle *s = solver;
1949 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_start() Locking solver for bulk operation ...\n");
1955 * Bulk operation done
1957 * @param solver the solver handle
1960 GAS_ril_bulk_stop (void *solver)
1962 struct GAS_RIL_Handle *s = solver;
1964 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_stop() Releasing solver from bulk operation ...\n");
1966 if (s->bulk_lock < 1)
1973 if (0 < s->bulk_changes)
1976 s->bulk_changes = 0;
1981 * Tell solver to notify ATS if the address to use changes for a specific
1982 * peer using the bandwidth changed callback
1984 * The solver must only notify about changes for peers with pending address
1987 * @param solver the solver handle
1988 * @param peer the identity of the peer
1990 const struct ATS_Address *
1991 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
1994 * activate agent, return currently chosen address
1996 struct GAS_RIL_Handle *s = solver;
1997 struct RIL_Peer_Agent *agent;
1998 struct RIL_Network *net;
2000 agent = ril_get_agent (s, peer, GNUNET_YES);
2002 agent->is_active = GNUNET_YES;
2004 if (agent->address_inuse)
2006 net = agent->address_inuse->solver_information;
2007 net->bw_in_assigned += agent->bw_in;
2008 net->bw_out_assigned += agent->bw_out;
2010 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2013 if (agent->address_inuse)
2015 LOG(GNUNET_ERROR_TYPE_DEBUG,
2016 "API_get_preferred_address() Activated agent for peer '%s' with %s address %p\n",
2017 GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
2021 LOG(GNUNET_ERROR_TYPE_DEBUG,
2022 "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
2028 return agent->address_inuse;
2032 * Tell solver stop notifying ATS about changes for this peers
2034 * The solver must only notify about changes for peers with pending address
2037 * @param solver the solver handle
2038 * @param peer the peer
2041 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2043 struct GAS_RIL_Handle *s = solver;
2044 struct RIL_Peer_Agent *agent;
2045 struct RIL_Network *net;
2047 agent = ril_get_agent (s, peer, GNUNET_NO);
2054 if (GNUNET_NO == agent->is_active)
2060 agent->is_active = GNUNET_NO;
2061 if (agent->address_inuse)
2063 net = agent->address_inuse->solver_information;
2064 net->bw_in_assigned -= agent->bw_in;
2065 net->bw_out_assigned -= agent->bw_out;
2067 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2072 LOG(GNUNET_ERROR_TYPE_DEBUG,
2073 "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
2074 GNUNET_i2s (peer), agent->address_inuse->plugin);
2077 /* end of libgnunet_plugin_ats_ril.c */