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.3
41 #define RIL_DEFAULT_TRACE_DECAY 0.5
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 ril_get_atsi (struct ATS_Address *address, uint32_t type)
739 GNUNET_assert(NULL != address);
741 if ((NULL == address->atsi) || (0 == address->atsi_count))
744 for (c1 = 0; c1 < address->atsi_count; c1++)
746 if (ntohl (address->atsi[c1].type) == type)
747 return ntohl (address->atsi[c1].value);
753 envi_reward_global (struct GAS_RIL_Handle *solver)
756 unsigned int in_available = 0;
757 unsigned int out_available = 0;
758 unsigned int in_assigned = 0;
759 unsigned int out_assigned = 0;
763 for (i = 0; i < solver->networks_count; i++)
765 in_available += solver->network_entries[i].bw_in_available;
766 in_assigned += solver->network_entries[i].bw_in_assigned;
767 out_available += solver->network_entries[i].bw_out_available;
768 out_assigned += solver->network_entries[i].bw_out_assigned;
771 ratio_in = ((double) in_assigned) / ((double) in_available);
772 ratio_out = ((double) out_assigned) / ((double) out_available);
774 return ((ratio_in + ratio_out) / 2) + 1;
778 envi_reward_local (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
780 const double *preferences;
781 const double *properties;
783 double pref_match = 0;
787 preferences = solver->plugin_envi->get_preferences (solver->plugin_envi->get_preference_cls,
789 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
790 agent->address_inuse);
792 //preference matching from latency
793 prop_index = ril_find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
794 dl_norm = 2 - properties[prop_index]; //invert property as we want to maximize for lower latencies
796 bw_norm = ((ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_IN)
797 / ril_get_max_bw (agent, GNUNET_YES))
798 + (ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_OUT)
799 / ril_get_max_bw (agent, GNUNET_NO))) / 2;
801 pref_match += (preferences[GNUNET_ATS_PREFERENCE_LATENCY] * dl_norm);
802 pref_match += (preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] * bw_norm);
804 return (pref_match / 4) +1;
808 * Gets the reward for the last performed step, which is calculated in equal
809 * parts from the local (the peer specific) and the global (for all peers
812 * @param solver the solver handle
813 * @param agent the agent handle
817 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
819 struct RIL_Network *net;
822 //punish overutilization
823 net = agent->address_inuse->solver_information;
824 if ((net->bw_in_assigned > net->bw_in_available)
825 || (net->bw_out_assigned > net->bw_out_available))
830 reward += envi_reward_global (solver);
831 reward += envi_reward_local (solver, agent);
836 * Doubles the bandwidth for the active address
838 * @param solver solver handle
839 * @param agent agent handle
840 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
843 envi_action_bw_double (struct GAS_RIL_Handle *solver,
844 struct RIL_Peer_Agent *agent,
849 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in * 2,
850 agent->bw_out, GNUNET_NO);
854 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
855 agent->bw_out * 2, GNUNET_NO);
860 * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
861 * the minimum bandwidth for a peer, in order to not invoke a disconnect.
863 * @param solver solver handle
864 * @param agent agent handle
865 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
869 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
870 struct RIL_Peer_Agent *agent,
873 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
874 unsigned long long new_bw;
878 new_bw = agent->bw_in / 2;
881 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
886 new_bw = agent->bw_out / 2;
889 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
895 * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
897 * @param solver solver handle
898 * @param agent agent handle
899 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
903 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
905 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
909 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in + (5 * min_bw),
910 agent->bw_out, GNUNET_NO);
914 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
915 agent->bw_out + (5 * min_bw), GNUNET_NO);
920 * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
921 * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
923 * @param solver solver handle
924 * @param agent agent handle
925 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
929 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
931 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
932 unsigned long long new_bw;
936 new_bw = agent->bw_in - (5 * min_bw);
939 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
944 new_bw = agent->bw_out - (5 * min_bw);
947 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
953 * Switches to the address given by its index
955 * @param solver solver handle
956 * @param agent agent handle
957 * @param address_index index of the address as it is saved in the agent's list, starting with zero
960 envi_action_address_switch (struct GAS_RIL_Handle *solver,
961 struct RIL_Peer_Agent *agent,
962 unsigned int address_index)
964 struct RIL_Address_Wrapped *cur;
967 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
969 if (i == address_index)
971 envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
979 //no address with address_index exists, in this case this action should not be callable
980 GNUNET_assert(GNUNET_NO);
984 * Puts the action into effect by calling the according function
986 * @param solver the solver handle
987 * @param agent the action handle
988 * @param action the action to perform by the solver
991 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
997 case RIL_ACTION_NOTHING:
999 case RIL_ACTION_BW_IN_DBL:
1000 envi_action_bw_double (solver, agent, GNUNET_YES);
1002 case RIL_ACTION_BW_IN_HLV:
1003 envi_action_bw_halven (solver, agent, GNUNET_YES);
1005 case RIL_ACTION_BW_IN_INC:
1006 envi_action_bw_inc (solver, agent, GNUNET_YES);
1008 case RIL_ACTION_BW_IN_DEC:
1009 envi_action_bw_dec (solver, agent, GNUNET_YES);
1011 case RIL_ACTION_BW_OUT_DBL:
1012 envi_action_bw_double (solver, agent, GNUNET_NO);
1014 case RIL_ACTION_BW_OUT_HLV:
1015 envi_action_bw_halven (solver, agent, GNUNET_NO);
1017 case RIL_ACTION_BW_OUT_INC:
1018 envi_action_bw_inc (solver, agent, GNUNET_NO);
1020 case RIL_ACTION_BW_OUT_DEC:
1021 envi_action_bw_dec (solver, agent, GNUNET_NO);
1024 if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
1026 address_index = action - RIL_ACTION_TYPE_NUM;
1028 GNUNET_assert(address_index >= 0);
1030 address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
1032 envi_action_address_switch (solver, agent, address_index);
1035 // error - action does not exist
1036 GNUNET_assert(GNUNET_NO);
1041 * Performs one step of the Markov Decision Process. Other than in the literature the step starts
1042 * after having done the last action a_old. It observes the new state s_next and the reward
1043 * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
1044 * next action is put into effect.
1046 * @param agent the agent performing the step
1049 agent_step (struct RIL_Peer_Agent *agent)
1051 int a_next = RIL_ACTION_INVALID;
1055 s_next = envi_get_state (agent->envi, agent);
1056 reward = envi_get_reward (agent->envi, agent);
1058 LOG(GNUNET_ERROR_TYPE_DEBUG, "agent_step() with algorithm %s\n",
1059 agent->envi->parameters.algorithm ? "Q" : "SARSA");
1061 switch (agent->envi->parameters.algorithm)
1063 case RIL_ALGO_SARSA:
1064 agent_modify_eligibility (agent, RIL_E_SET);
1065 if (agent_decide_exploration (agent))
1067 a_next = agent_get_action_explore (agent, s_next);
1071 a_next = agent_get_action_best (agent, s_next);
1073 if (RIL_ACTION_INVALID != agent->a_old)
1075 //updates weights with selected action (on-policy), if not first step
1076 agent_update_weights (agent, reward, s_next, a_next);
1081 a_next = agent_get_action_best (agent, s_next);
1082 if (RIL_ACTION_INVALID != agent->a_old)
1084 //updates weights with best action, disregarding actually selected action (off-policy), if not first step
1085 agent_update_weights (agent, reward, s_next, a_next);
1087 if (agent_decide_exploration (agent))
1089 a_next = agent_get_action_explore (agent, s_next);
1090 agent_modify_eligibility (agent, RIL_E_ZERO);
1094 a_next = agent_get_action_best (agent, s_next);
1095 agent_modify_eligibility (agent, RIL_E_SET);
1100 GNUNET_assert(RIL_ACTION_INVALID != a_next);
1102 agent_modify_eligibility (agent, RIL_E_ACCUMULATE);
1104 envi_do_action (agent->envi, agent, a_next);
1106 GNUNET_free(agent->s_old);
1107 agent->s_old = s_next;
1108 agent->a_old = a_next;
1110 agent->step_count += 1;
1114 ril_step (struct GAS_RIL_Handle *solver);
1117 * Task for the scheduler, which performs one step and lets the solver know that
1118 * no further step is scheduled.
1120 * @param cls the solver handle
1121 * @param tc the task context for the scheduler
1124 ril_step_scheduler_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1126 struct GAS_RIL_Handle *solver = cls;
1128 solver->task_pending = GNUNET_NO;
1133 ril_get_used_resource_ratio (struct GAS_RIL_Handle *solver)
1136 struct RIL_Network net;
1137 unsigned long long sum_assigned = 0;
1138 unsigned long long sum_available = 0;
1141 for (i = 0; i < solver->networks_count; i++)
1143 net = solver->network_entries[i];
1144 if (net.bw_in_assigned > 0) //only consider scopes with an active address
1146 sum_assigned += net.bw_in_assigned;
1147 sum_assigned += net.bw_out_assigned;
1148 sum_available += net.bw_in_available;
1149 sum_available += net.bw_out_available;
1152 if (sum_available > 0)
1154 ratio = ((double) sum_assigned) / ((double) sum_available);
1161 return ratio > 1 ? 1 : ratio; //overutilization possible, cap at 1
1165 * Schedules the next global step in an adaptive way. The more resources are
1166 * left, the earlier the next step is scheduled. This serves the reactivity of
1167 * the solver to changed inputs.
1169 * @param solver the solver handle
1172 ril_step_schedule_next (struct GAS_RIL_Handle *solver)
1178 struct GNUNET_TIME_Relative time_next;
1180 if (solver->task_pending)
1182 GNUNET_SCHEDULER_cancel (solver->step_next_task_id);
1185 used_ratio = ril_get_used_resource_ratio (solver);
1188 solver->parameters.step_time_min.rel_value_us
1189 < solver->parameters.step_time_max.rel_value_us);
1191 factor = (double) GNUNET_TIME_relative_subtract (solver->parameters.step_time_max,
1192 solver->parameters.step_time_min).rel_value_us;
1193 offset = (double) solver->parameters.step_time_min.rel_value_us;
1194 y = factor * pow (used_ratio, RIL_INTERVAL_EXPONENT) + offset;
1196 //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);
1197 //LOG (GNUNET_ERROR_TYPE_INFO, "factor = %f, offset = %f, y = %f\n", factor, offset, y);
1199 GNUNET_assert(y <= (double ) solver->parameters.step_time_max.rel_value_us);
1200 GNUNET_assert(y >= (double ) solver->parameters.step_time_min.rel_value_us);
1202 time_next = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, (unsigned int) y);
1204 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (time_next, &ril_step_scheduler_task,
1206 solver->task_pending = GNUNET_YES;
1210 * Triggers one step per agent
1214 ril_step (struct GAS_RIL_Handle *solver)
1216 struct RIL_Peer_Agent *cur;
1217 struct GNUNET_TIME_Absolute time_now;
1218 struct GNUNET_TIME_Relative time_delta;
1221 if (GNUNET_YES == solver->bulk_lock)
1223 solver->bulk_changes++;
1227 ril_inform (solver, GAS_OP_SOLVE_START, GAS_STAT_SUCCESS);
1229 LOG(GNUNET_ERROR_TYPE_DEBUG, "RIL step number %d\n", solver->step_count);
1231 if (0 == solver->step_count)
1233 solver->step_time_last = GNUNET_TIME_absolute_get ();
1236 //calculate tau, i.e. how many real valued time units have passed, one time unit is one minimum time step
1237 time_now = GNUNET_TIME_absolute_get ();
1238 time_delta = GNUNET_TIME_absolute_get_difference (solver->step_time_last, time_now);
1239 tau = ((double) time_delta.rel_value_us)
1240 / ((double) solver->parameters.step_time_min.rel_value_us);
1241 solver->step_time_last = time_now;
1243 //calculate reward discounts (once per step for all agents)
1244 solver->discount_variable = pow (M_E, ((-1.) * ((double) solver->parameters.beta) * tau));
1245 solver->discount_integrated = (1 - solver->discount_variable)
1246 / ((double) solver->parameters.beta);
1248 //trigger one step per active agent
1249 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1251 if (cur->is_active && cur->address_inuse)
1257 solver->step_count += 1;
1258 ril_step_schedule_next (solver);
1260 ril_inform (solver, GAS_OP_SOLVE_STOP, GAS_STAT_SUCCESS);
1266 * Initialize an agent without addresses and its knowledge base
1268 * @param s ril solver
1269 * @param peer the one in question
1270 * @return handle to the new agent
1272 static struct RIL_Peer_Agent *
1273 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1276 struct GAS_RIL_Handle * solver = s;
1277 struct RIL_Peer_Agent * agent = GNUNET_malloc (sizeof (struct RIL_Peer_Agent));
1279 agent->envi = solver;
1280 agent->peer = *peer;
1281 agent->step_count = 0;
1282 agent->is_active = GNUNET_NO;
1283 agent->n = RIL_ACTION_TYPE_NUM;
1284 agent->m = solver->networks_count * RIL_FEATURES_NETWORK_COUNT;
1285 agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1286 for (i = 0; i < agent->n; i++)
1288 agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1290 agent->a_old = RIL_ACTION_INVALID;
1291 agent->s_old = envi_get_state (solver, agent);
1292 agent->e = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1293 agent_modify_eligibility (agent, RIL_E_ZERO);
1295 GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, agent);
1303 * @param solver the solver handle
1304 * @param agent the agent to retire
1307 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1311 for (i = 0; i < agent->n; i++)
1313 GNUNET_free(agent->W[i]);
1315 GNUNET_free(agent->W);
1316 GNUNET_free(agent->e);
1317 GNUNET_free(agent->s_old);
1322 * Returns the agent for a peer
1324 * @param solver the solver handle
1325 * @param peer the identity of the peer
1326 * @param create whether or not to create an agent, if none is allocated yet
1329 static struct RIL_Peer_Agent *
1330 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
1332 struct RIL_Peer_Agent *cur;
1334 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1336 if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
1344 return agent_init (solver, peer);
1350 * Lookup network struct by type
1352 * @param s the solver handle
1353 * @param type the network type
1354 * @return the network struct
1356 static struct RIL_Network *
1357 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1361 for (i = 0; i < s->networks_count; i++)
1363 if (s->network_entries[i].type == type)
1365 return &s->network_entries[i];
1372 * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
1373 * considered inactive and not used. Addresses in an inactive network are ignored.
1375 * @param solver solver handle
1376 * @param network the network type
1377 * @return whether or not the network is considered active
1380 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1382 struct RIL_Network *net;
1383 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1385 net = ril_get_network (solver, network);
1386 if (net->bw_out_available < min_bw)
1392 * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
1393 * the reward function approximation. It copies the memory, which is not cut, to the new vector,
1394 * frees the memory of the old vector, and redirects the pointer to the new one.
1396 * @param old pointer to the pointer to the first element of the vector
1397 * @param element_size byte size of the vector elements
1398 * @param hole_start the first element to cut out
1399 * @param hole_length the number of elements to cut out
1400 * @param old_length the length of the old vector
1403 ril_cut_from_vector (void **old,
1404 size_t element_size,
1405 unsigned int hole_start,
1406 unsigned int hole_length,
1407 unsigned int old_length)
1410 char *oldptr = (char *) *old;
1412 unsigned int bytes_before;
1413 unsigned int bytes_hole;
1414 unsigned int bytes_after;
1416 GNUNET_assert(old_length > hole_length);
1417 GNUNET_assert(old_length >= (hole_start + hole_length));
1419 size = element_size * (old_length - hole_length);
1421 bytes_before = element_size * hole_start;
1422 bytes_hole = element_size * hole_length;
1423 bytes_after = element_size * (old_length - hole_start - hole_length);
1431 tmpptr = GNUNET_malloc (size);
1432 memcpy (tmpptr, oldptr, bytes_before);
1433 memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
1439 *old = (void *) tmpptr;
1443 * Solver API functions
1444 * ---------------------------
1448 * Change relative preference for quality in solver
1450 * @param solver the solver handle
1451 * @param peer the peer to change the preference for
1452 * @param kind the kind to change the preference
1453 * @param pref_rel the normalized preference value for this kind over all clients
1456 GAS_ril_address_change_preference (void *solver,
1457 const struct GNUNET_PeerIdentity *peer,
1458 enum GNUNET_ATS_PreferenceKind kind,
1461 LOG(GNUNET_ERROR_TYPE_DEBUG,
1462 "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
1463 GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
1469 * Entry point for the plugin
1471 * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
1474 libgnunet_plugin_ats_ril_init (void *cls)
1476 struct GNUNET_ATS_PluginEnvironment *env = cls;
1477 struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
1478 struct RIL_Network * cur;
1482 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
1484 GNUNET_assert(NULL != env);
1485 GNUNET_assert(NULL != env->cfg);
1486 GNUNET_assert(NULL != env->stats);
1487 GNUNET_assert(NULL != env->bandwidth_changed_cb);
1488 GNUNET_assert(NULL != env->get_preferences);
1489 GNUNET_assert(NULL != env->get_property);
1492 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MIN",
1493 &solver->parameters.step_time_min))
1495 solver->parameters.step_time_min = RIL_DEFAULT_STEP_TIME_MIN;
1498 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MAX",
1499 &solver->parameters.step_time_max))
1501 solver->parameters.step_time_max = RIL_DEFAULT_STEP_TIME_MAX;
1503 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string))
1505 solver->parameters.algorithm = !strcmp (string, "SARSA") ? RIL_ALGO_SARSA : RIL_ALGO_Q;
1506 GNUNET_free (string);
1510 solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
1512 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_DISCOUNT_BETA", &string))
1514 solver->parameters.beta = strtod (string, NULL);
1515 GNUNET_free (string);
1519 solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
1522 == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &string))
1524 solver->parameters.alpha = strtod (string, NULL);
1525 GNUNET_free (string);
1529 solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
1531 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TRACE_DECAY", &string))
1533 solver->parameters.lambda = strtod (string, NULL);
1534 GNUNET_free (string);
1538 solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
1540 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_EXPLORE_RATIO", &string))
1542 solver->parameters.explore_ratio = strtod (string, NULL);
1543 GNUNET_free (string);
1547 solver->parameters.explore_ratio = RIL_DEFAULT_EXPLORE_RATIO;
1550 env->sf.s_add = &GAS_ril_address_add;
1551 env->sf.s_address_update_property = &GAS_ril_address_property_changed;
1552 env->sf.s_address_update_session = &GAS_ril_address_session_changed;
1553 env->sf.s_address_update_inuse = &GAS_ril_address_inuse_changed;
1554 env->sf.s_address_update_network = &GAS_ril_address_change_network;
1555 env->sf.s_get = &GAS_ril_get_preferred_address;
1556 env->sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
1557 env->sf.s_pref = &GAS_ril_address_change_preference;
1558 env->sf.s_feedback = &GAS_ril_address_preference_feedback;
1559 env->sf.s_del = &GAS_ril_address_delete;
1560 env->sf.s_bulk_start = &GAS_ril_bulk_start;
1561 env->sf.s_bulk_stop = &GAS_ril_bulk_stop;
1563 solver->plugin_envi = env;
1564 solver->networks_count = env->network_count;
1565 solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Network));
1566 solver->step_count = 0;
1568 for (c = 0; c < env->network_count; c++)
1570 cur = &solver->network_entries[c];
1571 cur->type = env->networks[c];
1572 cur->bw_in_available = env->in_quota[c];
1573 cur->bw_in_assigned = 0;
1574 cur->bw_out_available = env->out_quota[c];
1575 cur->bw_out_assigned = 0;
1578 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (
1579 GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_get_millisecond_ (), 1000),
1580 &ril_step_scheduler_task, solver);
1581 solver->task_pending = GNUNET_YES;
1587 * Exit point for the plugin
1589 * @param cls the solver handle
1592 libgnunet_plugin_ats_ril_done (void *cls)
1594 struct GAS_RIL_Handle *s = cls;
1595 struct RIL_Peer_Agent *cur_agent;
1596 struct RIL_Peer_Agent *next_agent;
1598 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
1600 cur_agent = s->agents_head;
1601 while (NULL != cur_agent)
1603 next_agent = cur_agent->next;
1604 GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
1605 agent_die (s, cur_agent);
1606 cur_agent = next_agent;
1609 if (s->task_pending)
1611 GNUNET_SCHEDULER_cancel (s->step_next_task_id);
1613 GNUNET_free(s->network_entries);
1620 * Add a new address for a peer to the solver
1622 * The address is already contained in the addresses hashmap!
1624 * @param solver the solver Handle
1625 * @param address the address to add
1626 * @param network network type of this address
1629 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
1631 struct GAS_RIL_Handle *s = solver;
1632 struct RIL_Peer_Agent *agent;
1633 struct RIL_Address_Wrapped *address_wrapped;
1634 struct RIL_Network *net;
1641 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1643 net = ril_get_network (s, network);
1644 address->solver_information = net;
1646 if (!ril_network_is_active (s, network))
1648 LOG(GNUNET_ERROR_TYPE_DEBUG,
1649 "API_address_add() Did not add %s address %p for peer '%s', network does not have enough bandwidth\n",
1650 address->plugin, address->addr, GNUNET_i2s (&address->peer));
1654 agent = ril_get_agent (s, &address->peer, GNUNET_YES);
1657 address_wrapped = GNUNET_malloc (sizeof (struct RIL_Address_Wrapped));
1658 address_wrapped->address_naked = address;
1659 GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
1661 //increase size of W
1662 m_new = agent->m + RIL_FEATURES_ADDRESS_COUNT;
1664 n_new = agent->n + 1;
1667 GNUNET_array_grow(agent->W, agent->n, n_new);
1668 for (i = 0; i < n_new; i++)
1673 GNUNET_array_grow(agent->W[i], agent->m, m_new);
1678 GNUNET_array_grow(agent->W[i], zero, m_new);
1682 //increase size of old state vector
1684 GNUNET_array_grow(agent->s_old, agent->m, m_new);
1687 GNUNET_array_grow(agent->e, agent->m, m_new);
1689 if (NULL == agent->address_inuse)
1691 net->bw_in_assigned += min_bw;
1692 net->bw_out_assigned += min_bw;
1693 envi_set_active_suggestion (s, agent, address, min_bw, min_bw, GNUNET_NO);
1698 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %p for peer '%s'\n",
1699 address->active ? "active" : "inactive", address->plugin, address->addr,
1700 GNUNET_i2s (&address->peer));
1704 * Delete an address in the solver
1706 * The address is not contained in the address hashmap anymore!
1708 * @param solver the solver handle
1709 * @param address the address to remove
1710 * @param session_only delete only session not whole address
1713 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
1715 struct GAS_RIL_Handle *s = solver;
1716 struct RIL_Peer_Agent *agent;
1717 struct RIL_Address_Wrapped *address_wrapped;
1718 int address_was_used = address->active;
1723 struct RIL_Network *net;
1724 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1726 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Delete %s%s %s address %p for peer '%s'\n",
1727 session_only ? "session for " : "", address->active ? "active" : "inactive", address->plugin,
1728 address->addr, GNUNET_i2s (&address->peer));
1730 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1733 net = address->solver_information;
1734 GNUNET_assert(!ril_network_is_active (s, net->type));
1735 LOG(GNUNET_ERROR_TYPE_DEBUG,
1736 "No agent allocated for peer yet, since address was in inactive network\n");
1740 address_index = agent_address_get_index (agent, address);
1741 address_wrapped = agent_address_get (agent, address);
1743 if (NULL == address_wrapped)
1745 net = address->solver_information;
1746 GNUNET_assert(!ril_network_is_active (s, net->type));
1747 LOG(GNUNET_ERROR_TYPE_DEBUG,
1748 "Address not considered by agent, address was in inactive network\n");
1752 GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
1753 GNUNET_free(address_wrapped);
1756 m_new = agent->m - RIL_FEATURES_ADDRESS_COUNT;
1757 n_new = agent->n - 1;
1759 for (i = 0; i < agent->n; i++)
1761 ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
1762 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1763 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1765 GNUNET_free(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
1766 ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
1768 //correct last action
1769 if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
1773 else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
1775 agent->a_old = RIL_ACTION_INVALID;
1777 //decrease old state vector and eligibility vector
1778 ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
1779 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1780 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1781 ril_cut_from_vector ((void **) &agent->e, sizeof(double),
1782 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1783 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1787 LOG(GNUNET_ERROR_TYPE_DEBUG, "address was used: %s\n", address_was_used ? "yes" : "no");
1789 if (address_was_used)
1791 net = address->solver_information;
1792 net->bw_in_assigned -= agent->bw_in;
1793 net->bw_out_assigned -= agent->bw_out;
1795 if (NULL != agent->addresses_head) //if peer has an address left, use it
1797 LOG(GNUNET_ERROR_TYPE_DEBUG, "address left: %p\n",
1798 agent->addresses_head->address_naked->addr);
1799 //TODO? check if network/bandwidth update can be done more clever/elegant at different function
1800 envi_set_active_suggestion (s, agent, agent->addresses_head->address_naked, min_bw, min_bw,
1802 net = agent->addresses_head->address_naked->solver_information;
1803 net->bw_in_assigned -= min_bw;
1804 net->bw_out_assigned -= min_bw;
1808 LOG(GNUNET_ERROR_TYPE_DEBUG, "no address left => disconnect\n");
1810 envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
1816 LOG(GNUNET_ERROR_TYPE_DEBUG, "Address deleted\n");
1820 * Update the properties of an address in the solver
1822 * @param solver solver handle
1823 * @param address the address
1824 * @param type the ATSI type in HBO
1825 * @param abs_value the absolute value of the property
1826 * @param rel_value the normalized value
1829 GAS_ril_address_property_changed (void *solver,
1830 struct ATS_Address *address,
1835 LOG(GNUNET_ERROR_TYPE_DEBUG,
1836 "API_address_property_changed() Property '%s' for peer '%s' address %p changed "
1837 "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1838 address->addr, rel_value);
1844 * Update the session of an address in the solver
1846 * NOTE: values in addresses are already updated
1848 * @param solver solver handle
1849 * @param address the address
1850 * @param cur_session the current session
1851 * @param new_session the new session
1854 GAS_ril_address_session_changed (void *solver,
1855 struct ATS_Address *address,
1856 uint32_t cur_session,
1857 uint32_t new_session)
1860 * TODO? Future Work: Potentially add session activity as a feature in state vector
1862 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
1866 * Notify the solver that an address is (not) actively used by transport
1867 * to communicate with a remote peer
1869 * NOTE: values in addresses are already updated
1871 * @param solver solver handle
1872 * @param address the address
1873 * @param in_use usage state
1876 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
1878 /* Nothing to do here.
1879 * Possible TODO? Future Work: Potentially add usage variable to state vector
1881 LOG(GNUNET_ERROR_TYPE_DEBUG,
1882 "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
1883 address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1887 * Notify solver that the network an address is located in has changed
1889 * NOTE: values in addresses are already updated
1891 * @param solver solver handle
1892 * @param address the address
1893 * @param current_network the current network
1894 * @param new_network the new network
1897 GAS_ril_address_change_network (void *solver,
1898 struct ATS_Address *address,
1899 uint32_t current_network,
1900 uint32_t new_network)
1902 struct GAS_RIL_Handle *s = solver;
1903 struct RIL_Peer_Agent *agent;
1904 struct RIL_Network *net;
1905 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1907 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
1908 "%s address of peer %s from '%s' to '%s'\n",
1909 (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
1910 GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
1912 if (address->active && !ril_network_is_active (solver, new_network))
1914 GAS_ril_address_delete (solver, address, GNUNET_NO);
1918 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1921 GNUNET_assert(!ril_network_is_active (solver, current_network));
1923 GAS_ril_address_add (s, address, new_network);
1927 net = ril_get_network (s, current_network);
1928 net->bw_in_assigned -= agent->bw_in;
1929 net->bw_out_assigned -= agent->bw_out;
1931 net = ril_get_network (s, new_network);
1932 net->bw_in_assigned -= min_bw;
1933 net->bw_out_assigned -= min_bw;
1934 address->solver_information = net;
1938 * Give feedback about the current assignment
1940 * @param solver the solver handle
1941 * @param application the application
1942 * @param peer the peer to change the preference for
1943 * @param scope the time interval for this feedback: [now - scope .. now]
1944 * @param kind the kind to change the preference
1945 * @param score the score
1948 GAS_ril_address_preference_feedback (void *solver,
1950 const struct GNUNET_PeerIdentity *peer,
1951 const struct GNUNET_TIME_Relative scope,
1952 enum GNUNET_ATS_PreferenceKind kind,
1955 LOG(GNUNET_ERROR_TYPE_DEBUG,
1956 "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
1957 "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
1958 GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
1962 * Start a bulk operation
1964 * @param solver the solver
1967 GAS_ril_bulk_start (void *solver)
1969 struct GAS_RIL_Handle *s = solver;
1971 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_start() Locking solver for bulk operation ...\n");
1977 * Bulk operation done
1979 * @param solver the solver handle
1982 GAS_ril_bulk_stop (void *solver)
1984 struct GAS_RIL_Handle *s = solver;
1986 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_stop() Releasing solver from bulk operation ...\n");
1988 if (s->bulk_lock < 1)
1995 if (0 < s->bulk_changes)
1998 s->bulk_changes = 0;
2003 * Tell solver to notify ATS if the address to use changes for a specific
2004 * peer using the bandwidth changed callback
2006 * The solver must only notify about changes for peers with pending address
2009 * @param solver the solver handle
2010 * @param peer the identity of the peer
2012 const struct ATS_Address *
2013 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2016 * activate agent, return currently chosen address
2018 struct GAS_RIL_Handle *s = solver;
2019 struct RIL_Peer_Agent *agent;
2020 struct RIL_Network *net;
2022 agent = ril_get_agent (s, peer, GNUNET_YES);
2024 agent->is_active = GNUNET_YES;
2026 if (agent->address_inuse)
2028 net = agent->address_inuse->solver_information;
2029 net->bw_in_assigned += agent->bw_in;
2030 net->bw_out_assigned += agent->bw_out;
2032 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2035 if (agent->address_inuse)
2037 LOG(GNUNET_ERROR_TYPE_DEBUG,
2038 "API_get_preferred_address() Activated agent for peer '%s' with %s address %p\n",
2039 GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
2043 LOG(GNUNET_ERROR_TYPE_DEBUG,
2044 "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
2050 return agent->address_inuse;
2054 * Tell solver stop notifying ATS about changes for this peers
2056 * The solver must only notify about changes for peers with pending address
2059 * @param solver the solver handle
2060 * @param peer the peer
2063 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2065 struct GAS_RIL_Handle *s = solver;
2066 struct RIL_Peer_Agent *agent;
2067 struct RIL_Network *net;
2069 agent = ril_get_agent (s, peer, GNUNET_NO);
2076 if (GNUNET_NO == agent->is_active)
2082 agent->is_active = GNUNET_NO;
2083 if (agent->address_inuse)
2085 net = agent->address_inuse->solver_information;
2086 net->bw_in_assigned -= agent->bw_in;
2087 net->bw_out_assigned -= agent->bw_out;
2089 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2094 LOG(GNUNET_ERROR_TYPE_DEBUG,
2095 "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
2096 GNUNET_i2s (peer), agent->address_inuse->plugin);
2099 /* end of libgnunet_plugin_ats_ril.c */