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;
234 * Flag whether a suggestion has to be issued
236 int suggestion_issue;
239 * The address which has to be issued ()
241 struct ATS_Address * suggestion_address;
249 enum GNUNET_ATS_Network_Type type;
252 * Total available inbound bandwidth
254 unsigned long long bw_in_available;
257 * Total available outbound bandwidth
259 unsigned long long bw_out_available;
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() for peer '%s'\n", GNUNET_i2s (&agent->peer));
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;
598 notify |= GNUNET_YES;
602 if (agent->bw_in != new_bw_in)
604 agent->bw_in = new_bw_in;
605 new_address->assigned_bw_in.value__ = htonl (new_bw_in);
606 notify |= GNUNET_YES;
608 if (agent->bw_out != new_bw_out)
610 agent->bw_out = new_bw_out;
611 new_address->assigned_bw_out.value__ = htonl (new_bw_out);
612 notify |= GNUNET_YES;
616 if (notify && agent->is_active && (GNUNET_NO == silent))
620 LOG(GNUNET_ERROR_TYPE_DEBUG, " envi_set_active_suggestion() notify\n");
621 agent->suggestion_issue = GNUNET_YES;
622 agent->suggestion_address = new_address;
624 else if (agent->address_inuse)
626 //disconnect case, no new address
627 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_in.value__));
628 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_out.value__));
632 agent->suggestion_issue = GNUNET_YES;
633 agent->suggestion_address = agent->address_inuse;
636 agent->address_inuse = new_address;
639 static unsigned long long
640 ril_network_get_assigned (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type type, int direction_in)
642 struct RIL_Peer_Agent *cur;
643 struct RIL_Network *net;
644 unsigned long long sum = 0;
646 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
648 if (cur->is_active && cur->address_inuse)
650 net = cur->address_inuse->solver_information;
651 if (net->type == type)
665 * Allocates a state vector and fills it with the features present
666 * @param solver the solver handle
667 * @param agent the agent handle
668 * @return pointer to the state vector
671 envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
675 struct RIL_Network net;
676 double *state = GNUNET_malloc (sizeof (double) * agent->m);
677 struct RIL_Address_Wrapped *cur_address;
678 const double *properties;
680 for (i = 0; i < solver->networks_count; i++)
682 net = solver->network_entries[i];
683 state[i * RIL_FEATURES_NETWORK_COUNT + 0] = (double) ril_network_get_assigned(solver, net.type, GNUNET_YES);
684 state[i * RIL_FEATURES_NETWORK_COUNT + 1] = (double) net.bw_in_available;
685 state[i * RIL_FEATURES_NETWORK_COUNT + 2] = (double) ril_network_get_assigned(solver, net.type, GNUNET_NO);
686 state[i * RIL_FEATURES_NETWORK_COUNT + 3] = (double) net.bw_out_available;
689 i = i * RIL_FEATURES_NETWORK_COUNT; //first address feature
691 for (cur_address = agent->addresses_head; NULL != cur_address; cur_address = cur_address->next)
693 state[i++] = cur_address->address_naked->active;
694 state[i++] = cur_address->address_naked->active ? agent->bw_in : 0;
695 state[i++] = cur_address->address_naked->active ? agent->bw_out : 0;
696 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
697 cur_address->address_naked);
698 for (k = 0; k < GNUNET_ATS_QualityPropertiesCount; k++)
700 state[i++] = properties[k];
708 * For all networks a peer has an address in, this gets the maximum bandwidth which could
709 * theoretically be available in one of the networks. This is used for bandwidth normalization.
711 * @param agent the agent handle
712 * @param direction_in whether the inbound bandwidth should be considered. Returns the maximum outbound bandwidth if GNUNET_NO
714 static long long unsigned
715 ril_get_max_bw (struct RIL_Peer_Agent *agent, int direction_in)
718 * get the maximum bandwidth possible for a peer, e.g. among all addresses which addresses'
719 * network could provide the maximum bandwidth if all that bandwidth was used on that one peer.
722 struct RIL_Address_Wrapped *cur;
723 struct RIL_Network *net;
725 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
727 net = cur->address_naked->solver_information;
730 if (net->bw_in_available > max)
732 max = net->bw_in_available;
737 if (net->bw_out_available > max)
739 max = net->bw_out_available;
747 * Get the index of the quality-property in question
749 * @param type the quality property type
753 ril_find_property_index (uint32_t type)
755 int existing_types[] = GNUNET_ATS_QualityProperties;
757 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
758 if (existing_types[c] == type)
760 return GNUNET_SYSERR;
764 ril_get_atsi (struct ATS_Address *address, uint32_t type)
767 GNUNET_assert(NULL != address);
769 if ((NULL == address->atsi) || (0 == address->atsi_count))
772 for (c1 = 0; c1 < address->atsi_count; c1++)
774 if (ntohl (address->atsi[c1].type) == type)
775 return ntohl (address->atsi[c1].value);
781 envi_reward_global (struct GAS_RIL_Handle *solver)
784 struct RIL_Network net;
785 unsigned int sum_in_available = 0;
786 unsigned int sum_out_available = 0;
787 unsigned int sum_in_assigned = 0;
788 unsigned int sum_out_assigned = 0;
792 for (i = 0; i < solver->networks_count; i++)
794 net = solver->network_entries[i];
795 sum_in_available += net.bw_in_available;
796 sum_in_assigned += ril_network_get_assigned(solver, net.type, GNUNET_YES);
797 sum_out_available += net.bw_out_available;
798 sum_out_assigned += ril_network_get_assigned(solver, net.type, GNUNET_NO);
801 ratio_in = ((double) sum_in_assigned) / ((double) sum_in_available);
802 ratio_out = ((double) sum_out_assigned) / ((double) sum_out_available);
804 // global reward in [1,2]
805 return ((ratio_in + ratio_out) / 2) + 1;
809 envi_reward_local (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
811 const double *preferences;
812 const double *properties;
814 double pref_match = 0;
818 preferences = solver->plugin_envi->get_preferences (solver->plugin_envi->get_preference_cls,
820 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
821 agent->address_inuse);
824 prop_index = ril_find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
825 dl_norm = 2 - properties[prop_index]; //invert property as we want to maximize for lower latencies
827 // utilization in [0,1]
828 bw_norm = ((ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_IN)
829 / ril_get_max_bw (agent, GNUNET_YES))
830 + (ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_OUT)
831 / ril_get_max_bw (agent, GNUNET_NO))) / 2;
833 // preference matching in [0,4]
834 pref_match += (preferences[GNUNET_ATS_PREFERENCE_LATENCY] * dl_norm);
835 pref_match += (preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] * bw_norm);
837 // local reward in [1,2]
838 return (pref_match / 4) +1;
842 * Gets the reward for the last performed step, which is calculated in equal
843 * parts from the local (the peer specific) and the global (for all peers
846 * @param solver the solver handle
847 * @param agent the agent handle
851 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
853 struct RIL_Network *net;
856 //punish overutilization
857 net = agent->address_inuse->solver_information;
858 if ((ril_network_get_assigned(solver, net->type, GNUNET_YES) > net->bw_in_available)
859 || (ril_network_get_assigned(solver, net->type, GNUNET_NO) > net->bw_out_available))
864 reward += envi_reward_global (solver);
865 reward += envi_reward_local (solver, agent);
870 * Doubles the bandwidth for the active address
872 * @param solver solver handle
873 * @param agent agent handle
874 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
877 envi_action_bw_double (struct GAS_RIL_Handle *solver,
878 struct RIL_Peer_Agent *agent,
881 unsigned long long new_bw;
885 new_bw = agent->bw_in * 2;
886 if (new_bw < agent->bw_in)
888 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
889 agent->bw_out, GNUNET_NO);
893 new_bw = agent->bw_out * 2;
894 if (new_bw < agent->bw_out)
896 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
902 * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
903 * the minimum bandwidth for a peer, in order to not invoke a disconnect.
905 * @param solver solver handle
906 * @param agent agent handle
907 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
911 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
912 struct RIL_Peer_Agent *agent,
915 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
916 unsigned long long new_bw;
920 new_bw = agent->bw_in / 2;
921 if (new_bw < min_bw || new_bw > agent->bw_in)
923 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
928 new_bw = agent->bw_out / 2;
929 if (new_bw < min_bw || new_bw > agent->bw_out)
931 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
937 * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
939 * @param solver solver handle
940 * @param agent agent handle
941 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
945 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
947 unsigned long long new_bw;
948 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
952 new_bw = agent->bw_in + (5 * min_bw);
953 if (new_bw < agent->bw_in)
955 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
956 agent->bw_out, GNUNET_NO);
960 new_bw = agent->bw_out + (5 * min_bw);
961 if (new_bw < agent->bw_out)
963 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
969 * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
970 * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
972 * @param solver solver handle
973 * @param agent agent handle
974 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
978 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
980 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
981 unsigned long long new_bw;
985 new_bw = agent->bw_in - (5 * min_bw);
986 if (new_bw < min_bw || new_bw > agent->bw_in)
988 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
993 new_bw = agent->bw_out - (5 * min_bw);
994 if (new_bw < min_bw || new_bw > agent->bw_in)
996 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1002 * Switches to the address given by its index
1004 * @param solver solver handle
1005 * @param agent agent handle
1006 * @param address_index index of the address as it is saved in the agent's list, starting with zero
1009 envi_action_address_switch (struct GAS_RIL_Handle *solver,
1010 struct RIL_Peer_Agent *agent,
1011 unsigned int address_index)
1013 struct RIL_Address_Wrapped *cur;
1016 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
1018 if (i == address_index)
1020 envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
1028 //no address with address_index exists, in this case this action should not be callable
1029 GNUNET_assert(GNUNET_NO);
1033 * Puts the action into effect by calling the according function
1035 * @param solver the solver handle
1036 * @param agent the action handle
1037 * @param action the action to perform by the solver
1040 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
1046 case RIL_ACTION_NOTHING:
1048 case RIL_ACTION_BW_IN_DBL:
1049 envi_action_bw_double (solver, agent, GNUNET_YES);
1051 case RIL_ACTION_BW_IN_HLV:
1052 envi_action_bw_halven (solver, agent, GNUNET_YES);
1054 case RIL_ACTION_BW_IN_INC:
1055 envi_action_bw_inc (solver, agent, GNUNET_YES);
1057 case RIL_ACTION_BW_IN_DEC:
1058 envi_action_bw_dec (solver, agent, GNUNET_YES);
1060 case RIL_ACTION_BW_OUT_DBL:
1061 envi_action_bw_double (solver, agent, GNUNET_NO);
1063 case RIL_ACTION_BW_OUT_HLV:
1064 envi_action_bw_halven (solver, agent, GNUNET_NO);
1066 case RIL_ACTION_BW_OUT_INC:
1067 envi_action_bw_inc (solver, agent, GNUNET_NO);
1069 case RIL_ACTION_BW_OUT_DEC:
1070 envi_action_bw_dec (solver, agent, GNUNET_NO);
1073 if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
1075 address_index = action - RIL_ACTION_TYPE_NUM;
1077 GNUNET_assert(address_index >= 0);
1079 address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
1081 envi_action_address_switch (solver, agent, address_index);
1084 // error - action does not exist
1085 GNUNET_assert(GNUNET_NO);
1090 * Performs one step of the Markov Decision Process. Other than in the literature the step starts
1091 * after having done the last action a_old. It observes the new state s_next and the reward
1092 * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
1093 * next action is put into effect.
1095 * @param agent the agent performing the step
1098 agent_step (struct RIL_Peer_Agent *agent)
1100 int a_next = RIL_ACTION_INVALID;
1104 LOG(GNUNET_ERROR_TYPE_DEBUG, " agent_step() Peer '%s', algorithm %s\n",
1105 GNUNET_i2s (&agent->peer),
1106 agent->envi->parameters.algorithm ? "Q" : "SARSA");
1108 s_next = envi_get_state (agent->envi, agent);
1109 reward = envi_get_reward (agent->envi, agent);
1111 switch (agent->envi->parameters.algorithm)
1113 case RIL_ALGO_SARSA:
1114 agent_modify_eligibility (agent, RIL_E_SET);
1115 if (agent_decide_exploration (agent))
1117 a_next = agent_get_action_explore (agent, s_next);
1121 a_next = agent_get_action_best (agent, s_next);
1123 if (RIL_ACTION_INVALID != agent->a_old)
1125 //updates weights with selected action (on-policy), if not first step
1126 agent_update_weights (agent, reward, s_next, a_next);
1131 a_next = agent_get_action_best (agent, s_next);
1132 if (RIL_ACTION_INVALID != agent->a_old)
1134 //updates weights with best action, disregarding actually selected action (off-policy), if not first step
1135 agent_update_weights (agent, reward, s_next, a_next);
1137 if (agent_decide_exploration (agent))
1139 a_next = agent_get_action_explore (agent, s_next);
1140 agent_modify_eligibility (agent, RIL_E_ZERO);
1144 a_next = agent_get_action_best (agent, s_next);
1145 agent_modify_eligibility (agent, RIL_E_SET);
1150 GNUNET_assert(RIL_ACTION_INVALID != a_next);
1152 agent_modify_eligibility (agent, RIL_E_ACCUMULATE);
1154 envi_do_action (agent->envi, agent, a_next);
1156 GNUNET_free(agent->s_old);
1157 agent->s_old = s_next;
1158 agent->a_old = a_next;
1160 agent->step_count += 1;
1164 ril_step (struct GAS_RIL_Handle *solver);
1167 * Task for the scheduler, which performs one step and lets the solver know that
1168 * no further step is scheduled.
1170 * @param cls the solver handle
1171 * @param tc the task context for the scheduler
1174 ril_step_scheduler_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1176 struct GAS_RIL_Handle *solver = cls;
1178 solver->task_pending = GNUNET_NO;
1183 ril_get_used_resource_ratio (struct GAS_RIL_Handle *solver)
1186 struct RIL_Network net;
1187 unsigned long long sum_assigned = 0;
1188 unsigned long long sum_available = 0;
1191 for (i = 0; i < solver->networks_count; i++)
1193 net = solver->network_entries[i];
1194 if (ril_network_get_assigned(solver, net.type, GNUNET_YES) > 0) //only consider scopes with an active address
1196 sum_assigned += ril_network_get_assigned(solver, net.type, GNUNET_YES);
1197 sum_assigned += ril_network_get_assigned(solver, net.type, GNUNET_NO);
1198 sum_available += net.bw_in_available;
1199 sum_available += net.bw_out_available;
1202 if (sum_available > 0)
1204 ratio = ((double) sum_assigned) / ((double) sum_available);
1211 return ratio > 1 ? 1 : ratio; //overutilization possible, cap at 1
1215 * Schedules the next global step in an adaptive way. The more resources are
1216 * left, the earlier the next step is scheduled. This serves the reactivity of
1217 * the solver to changed inputs.
1219 * @param solver the solver handle
1222 ril_step_schedule_next (struct GAS_RIL_Handle *solver)
1228 struct GNUNET_TIME_Relative time_next;
1230 if (solver->task_pending)
1232 GNUNET_SCHEDULER_cancel (solver->step_next_task_id);
1235 used_ratio = ril_get_used_resource_ratio (solver);
1238 solver->parameters.step_time_min.rel_value_us
1239 < solver->parameters.step_time_max.rel_value_us);
1241 factor = (double) GNUNET_TIME_relative_subtract (solver->parameters.step_time_max,
1242 solver->parameters.step_time_min).rel_value_us;
1243 offset = (double) solver->parameters.step_time_min.rel_value_us;
1244 y = factor * pow (used_ratio, RIL_INTERVAL_EXPONENT) + offset;
1246 GNUNET_assert(y <= (double ) solver->parameters.step_time_max.rel_value_us);
1247 GNUNET_assert(y >= (double ) solver->parameters.step_time_min.rel_value_us);
1249 time_next = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, (unsigned int) y);
1251 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (time_next, &ril_step_scheduler_task,
1253 solver->task_pending = GNUNET_YES;
1257 * Triggers one step per agent
1261 ril_step (struct GAS_RIL_Handle *solver)
1263 struct RIL_Peer_Agent *cur;
1264 struct GNUNET_TIME_Absolute time_now;
1265 struct GNUNET_TIME_Relative time_delta;
1268 if (GNUNET_YES == solver->bulk_lock)
1270 solver->bulk_changes++;
1274 ril_inform (solver, GAS_OP_SOLVE_START, GAS_STAT_SUCCESS);
1276 LOG(GNUNET_ERROR_TYPE_DEBUG, " RIL step number %d\n", solver->step_count);
1278 if (0 == solver->step_count)
1280 solver->step_time_last = GNUNET_TIME_absolute_get ();
1283 //calculate tau, i.e. how many real valued time units have passed, one time unit is one minimum time step
1284 time_now = GNUNET_TIME_absolute_get ();
1285 time_delta = GNUNET_TIME_absolute_get_difference (solver->step_time_last, time_now);
1286 tau = ((double) time_delta.rel_value_us)
1287 / ((double) solver->parameters.step_time_min.rel_value_us);
1288 solver->step_time_last = time_now;
1290 //calculate reward discounts (once per step for all agents)
1291 solver->discount_variable = pow (M_E, ((-1.) * ((double) solver->parameters.beta) * tau));
1292 solver->discount_integrated = (1 - solver->discount_variable)
1293 / ((double) solver->parameters.beta);
1295 //trigger one step per active agent
1296 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1298 if (cur->is_active && cur->address_inuse)
1304 solver->step_count += 1;
1305 ril_step_schedule_next (solver);
1307 ril_inform (solver, GAS_OP_SOLVE_STOP, GAS_STAT_SUCCESS);
1309 ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START, GAS_STAT_SUCCESS);
1310 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1312 if (cur->suggestion_issue) {
1313 solver->plugin_envi->bandwidth_changed_cb(solver->plugin_envi->bw_changed_cb_cls, cur->suggestion_address);
1314 LOG(GNUNET_ERROR_TYPE_DEBUG, "\n Suggest address: %s\n\n",
1315 cur->suggestion_address->addr);
1316 cur->suggestion_issue = GNUNET_NO;
1319 ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP, GAS_STAT_SUCCESS);
1325 ril_count_agents (struct GAS_RIL_Handle *solver)
1328 struct RIL_Peer_Agent *cur_agent;
1330 for (cur_agent = solver->agents_head; NULL != cur_agent; cur_agent = cur_agent->next)
1338 agent_w_start (struct RIL_Peer_Agent *agent)
1341 struct RIL_Peer_Agent *other;
1345 count = ril_count_agents(agent->envi);
1350 for (other = agent->envi->agents_head; NULL != other; other = other->next)
1352 for (i = 0; i < agent->n; i++)
1354 for (k = 0; k < agent->m; k++)
1356 agent->W[i][k] += (other->W[i][k] / (double) count);
1363 * Initialize an agent without addresses and its knowledge base
1365 * @param s ril solver
1366 * @param peer the one in question
1367 * @return handle to the new agent
1369 static struct RIL_Peer_Agent *
1370 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1373 struct GAS_RIL_Handle * solver = s;
1374 struct RIL_Peer_Agent * agent = GNUNET_malloc (sizeof (struct RIL_Peer_Agent));
1376 agent->envi = solver;
1377 agent->peer = *peer;
1378 agent->step_count = 0;
1379 agent->is_active = GNUNET_NO;
1382 agent->suggestion_issue = GNUNET_NO;
1383 agent->n = RIL_ACTION_TYPE_NUM;
1384 agent->m = solver->networks_count * RIL_FEATURES_NETWORK_COUNT;
1385 agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1386 for (i = 0; i < agent->n; i++)
1388 agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1390 agent_w_start(agent);
1391 agent->a_old = RIL_ACTION_INVALID;
1392 agent->s_old = envi_get_state (solver, agent);
1393 agent->e = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1394 agent_modify_eligibility (agent, RIL_E_ZERO);
1396 GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, agent);
1404 * @param solver the solver handle
1405 * @param agent the agent to retire
1408 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1412 for (i = 0; i < agent->n; i++)
1414 GNUNET_free(agent->W[i]);
1416 GNUNET_free(agent->W);
1417 GNUNET_free(agent->e);
1418 GNUNET_free(agent->s_old);
1423 * Returns the agent for a peer
1425 * @param solver the solver handle
1426 * @param peer the identity of the peer
1427 * @param create whether or not to create an agent, if none is allocated yet
1430 static struct RIL_Peer_Agent *
1431 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
1433 struct RIL_Peer_Agent *cur;
1435 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1437 if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
1445 return agent_init (solver, peer);
1451 * Lookup network struct by type
1453 * @param s the solver handle
1454 * @param type the network type
1455 * @return the network struct
1457 static struct RIL_Network *
1458 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1462 for (i = 0; i < s->networks_count; i++)
1464 if (s->network_entries[i].type == type)
1466 return &s->network_entries[i];
1473 * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
1474 * considered inactive and not used. Addresses in an inactive network are ignored.
1476 * @param solver solver handle
1477 * @param network the network type
1478 * @return whether or not the network is considered active
1481 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1483 struct RIL_Network *net;
1484 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1486 net = ril_get_network (solver, network);
1487 if (net->bw_out_available < min_bw)
1493 * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
1494 * the reward function approximation. It copies the memory, which is not cut, to the new vector,
1495 * frees the memory of the old vector, and redirects the pointer to the new one.
1497 * @param old pointer to the pointer to the first element of the vector
1498 * @param element_size byte size of the vector elements
1499 * @param hole_start the first element to cut out
1500 * @param hole_length the number of elements to cut out
1501 * @param old_length the length of the old vector
1504 ril_cut_from_vector (void **old,
1505 size_t element_size,
1506 unsigned int hole_start,
1507 unsigned int hole_length,
1508 unsigned int old_length)
1511 char *oldptr = (char *) *old;
1513 unsigned int bytes_before;
1514 unsigned int bytes_hole;
1515 unsigned int bytes_after;
1517 GNUNET_assert(old_length > hole_length);
1518 GNUNET_assert(old_length >= (hole_start + hole_length));
1520 size = element_size * (old_length - hole_length);
1522 bytes_before = element_size * hole_start;
1523 bytes_hole = element_size * hole_length;
1524 bytes_after = element_size * (old_length - hole_start - hole_length);
1532 tmpptr = GNUNET_malloc (size);
1533 memcpy (tmpptr, oldptr, bytes_before);
1534 memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
1540 *old = (void *) tmpptr;
1544 * Solver API functions
1545 * ---------------------------
1549 * Change relative preference for quality in solver
1551 * @param solver the solver handle
1552 * @param peer the peer to change the preference for
1553 * @param kind the kind to change the preference
1554 * @param pref_rel the normalized preference value for this kind over all clients
1557 GAS_ril_address_change_preference (void *solver,
1558 const struct GNUNET_PeerIdentity *peer,
1559 enum GNUNET_ATS_PreferenceKind kind,
1562 LOG(GNUNET_ERROR_TYPE_DEBUG,
1563 "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
1564 GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
1570 * Entry point for the plugin
1572 * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
1575 libgnunet_plugin_ats_ril_init (void *cls)
1577 struct GNUNET_ATS_PluginEnvironment *env = cls;
1578 struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
1579 struct RIL_Network * cur;
1583 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
1585 GNUNET_assert(NULL != env);
1586 GNUNET_assert(NULL != env->cfg);
1587 GNUNET_assert(NULL != env->stats);
1588 GNUNET_assert(NULL != env->bandwidth_changed_cb);
1589 GNUNET_assert(NULL != env->get_preferences);
1590 GNUNET_assert(NULL != env->get_property);
1593 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MIN",
1594 &solver->parameters.step_time_min))
1596 solver->parameters.step_time_min = RIL_DEFAULT_STEP_TIME_MIN;
1599 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MAX",
1600 &solver->parameters.step_time_max))
1602 solver->parameters.step_time_max = RIL_DEFAULT_STEP_TIME_MAX;
1604 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string))
1606 solver->parameters.algorithm = !strcmp (string, "SARSA") ? RIL_ALGO_SARSA : RIL_ALGO_Q;
1607 GNUNET_free (string);
1611 solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
1613 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_DISCOUNT_BETA", &string))
1615 solver->parameters.beta = strtod (string, NULL);
1616 GNUNET_free (string);
1620 solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
1623 == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &string))
1625 solver->parameters.alpha = strtod (string, NULL);
1626 GNUNET_free (string);
1630 solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
1632 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TRACE_DECAY", &string))
1634 solver->parameters.lambda = strtod (string, NULL);
1635 GNUNET_free (string);
1639 solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
1641 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_EXPLORE_RATIO", &string))
1643 solver->parameters.explore_ratio = strtod (string, NULL);
1644 GNUNET_free (string);
1648 solver->parameters.explore_ratio = RIL_DEFAULT_EXPLORE_RATIO;
1651 env->sf.s_add = &GAS_ril_address_add;
1652 env->sf.s_address_update_property = &GAS_ril_address_property_changed;
1653 env->sf.s_address_update_session = &GAS_ril_address_session_changed;
1654 env->sf.s_address_update_inuse = &GAS_ril_address_inuse_changed;
1655 env->sf.s_address_update_network = &GAS_ril_address_change_network;
1656 env->sf.s_get = &GAS_ril_get_preferred_address;
1657 env->sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
1658 env->sf.s_pref = &GAS_ril_address_change_preference;
1659 env->sf.s_feedback = &GAS_ril_address_preference_feedback;
1660 env->sf.s_del = &GAS_ril_address_delete;
1661 env->sf.s_bulk_start = &GAS_ril_bulk_start;
1662 env->sf.s_bulk_stop = &GAS_ril_bulk_stop;
1664 solver->plugin_envi = env;
1665 solver->networks_count = env->network_count;
1666 solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Network));
1667 solver->step_count = 0;
1669 for (c = 0; c < env->network_count; c++)
1671 cur = &solver->network_entries[c];
1672 cur->type = env->networks[c];
1673 cur->bw_in_available = env->in_quota[c];
1674 cur->bw_out_available = env->out_quota[c];
1677 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (
1678 GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_get_millisecond_ (), 1000),
1679 &ril_step_scheduler_task, solver);
1680 solver->task_pending = GNUNET_YES;
1686 * Exit point for the plugin
1688 * @param cls the solver handle
1691 libgnunet_plugin_ats_ril_done (void *cls)
1693 struct GAS_RIL_Handle *s = cls;
1694 struct RIL_Peer_Agent *cur_agent;
1695 struct RIL_Peer_Agent *next_agent;
1697 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
1699 cur_agent = s->agents_head;
1700 while (NULL != cur_agent)
1702 next_agent = cur_agent->next;
1703 GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
1704 agent_die (s, cur_agent);
1705 cur_agent = next_agent;
1708 if (s->task_pending)
1710 GNUNET_SCHEDULER_cancel (s->step_next_task_id);
1712 GNUNET_free(s->network_entries);
1719 * Add a new address for a peer to the solver
1721 * The address is already contained in the addresses hashmap!
1723 * @param solver the solver Handle
1724 * @param address the address to add
1725 * @param network network type of this address
1728 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
1730 struct GAS_RIL_Handle *s = solver;
1731 struct RIL_Peer_Agent *agent;
1732 struct RIL_Address_Wrapped *address_wrapped;
1733 struct RIL_Network *net;
1740 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1742 LOG (GNUNET_ERROR_TYPE_DEBUG, "API_address_add()\n");
1744 net = ril_get_network (s, network);
1745 address->solver_information = net;
1747 if (!ril_network_is_active (s, network))
1749 LOG(GNUNET_ERROR_TYPE_DEBUG,
1750 "API_address_add() Did not add %s address %s for peer '%s', network does not have enough bandwidth\n",
1751 address->plugin, address->addr, GNUNET_i2s (&address->peer));
1755 agent = ril_get_agent (s, &address->peer, GNUNET_YES);
1758 address_wrapped = GNUNET_malloc (sizeof (struct RIL_Address_Wrapped));
1759 address_wrapped->address_naked = address;
1760 GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
1762 //increase size of W
1763 m_new = agent->m + RIL_FEATURES_ADDRESS_COUNT;
1765 n_new = agent->n + 1;
1768 GNUNET_array_grow(agent->W, agent->n, n_new);
1769 for (i = 0; i < n_new; i++)
1774 GNUNET_array_grow(agent->W[i], agent->m, m_new);
1779 GNUNET_array_grow(agent->W[i], zero, m_new);
1783 //increase size of old state vector
1785 GNUNET_array_grow(agent->s_old, agent->m, m_new);
1788 GNUNET_array_grow(agent->e, agent->m, m_new);
1790 if (NULL == agent->address_inuse)
1792 envi_set_active_suggestion (s, agent, address, min_bw, min_bw, GNUNET_NO);
1797 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %s for peer '%s'\n",
1798 address->active ? "active" : "inactive", address->plugin, address->addr,
1799 GNUNET_i2s (&address->peer));
1803 * Delete an address in the solver
1805 * The address is not contained in the address hashmap anymore!
1807 * @param solver the solver handle
1808 * @param address the address to remove
1809 * @param session_only delete only session not whole address
1812 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
1814 struct GAS_RIL_Handle *s = solver;
1815 struct RIL_Peer_Agent *agent;
1816 struct RIL_Address_Wrapped *address_wrapped;
1817 int address_was_used = address->active;
1822 struct RIL_Network *net;
1823 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1825 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Delete %s%s %s address %s for peer '%s'\n",
1826 session_only ? "session for " : "", address->active ? "active" : "inactive", address->plugin,
1827 address->addr, GNUNET_i2s (&address->peer));
1829 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1832 net = address->solver_information;
1833 GNUNET_assert(!ril_network_is_active (s, net->type));
1834 LOG(GNUNET_ERROR_TYPE_DEBUG,
1835 "No agent allocated for peer yet, since address was in inactive network\n");
1839 address_index = agent_address_get_index (agent, address);
1840 address_wrapped = agent_address_get (agent, address);
1842 if (NULL == address_wrapped)
1844 net = address->solver_information;
1845 GNUNET_assert(!ril_network_is_active (s, net->type));
1846 LOG(GNUNET_ERROR_TYPE_DEBUG,
1847 "Address not considered by agent, address was in inactive network\n");
1851 GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
1852 GNUNET_free(address_wrapped);
1855 m_new = agent->m - RIL_FEATURES_ADDRESS_COUNT;
1856 n_new = agent->n - 1;
1858 for (i = 0; i < agent->n; i++)
1860 ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
1861 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1862 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1864 GNUNET_free(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
1865 ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
1867 //correct last action
1868 if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
1872 else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
1874 agent->a_old = RIL_ACTION_INVALID;
1876 //decrease old state vector and eligibility vector
1877 ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
1878 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1879 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1880 ril_cut_from_vector ((void **) &agent->e, sizeof(double),
1881 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
1882 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
1886 LOG(GNUNET_ERROR_TYPE_DEBUG, "address was used: %s\n", address_was_used ? "yes" : "no");
1888 if (address_was_used)
1890 if (NULL != agent->addresses_head) //if peer has an address left, use it
1892 LOG(GNUNET_ERROR_TYPE_DEBUG, "address left: %s\n",
1893 agent->addresses_head->address_naked->addr);
1895 envi_set_active_suggestion (s, agent, agent->addresses_head->address_naked, min_bw, min_bw,
1900 LOG(GNUNET_ERROR_TYPE_DEBUG, "no address left => disconnect\n");
1902 envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
1906 LOG(GNUNET_ERROR_TYPE_DEBUG, "Address deleted: %s\n", address->addr);
1912 * Update the properties of an address in the solver
1914 * @param solver solver handle
1915 * @param address the address
1916 * @param type the ATSI type in HBO
1917 * @param abs_value the absolute value of the property
1918 * @param rel_value the normalized value
1921 GAS_ril_address_property_changed (void *solver,
1922 struct ATS_Address *address,
1927 LOG(GNUNET_ERROR_TYPE_DEBUG,
1928 "API_address_property_changed() Property '%s' for peer '%s' address %s changed "
1929 "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1930 address->addr, rel_value);
1936 * Update the session of an address in the solver
1938 * NOTE: values in addresses are already updated
1940 * @param solver solver handle
1941 * @param address the address
1942 * @param cur_session the current session
1943 * @param new_session the new session
1946 GAS_ril_address_session_changed (void *solver,
1947 struct ATS_Address *address,
1948 uint32_t cur_session,
1949 uint32_t new_session)
1952 * TODO? Future Work: Potentially add session activity as a feature in state vector
1954 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
1958 * Notify the solver that an address is (not) actively used by transport
1959 * to communicate with a remote peer
1961 * NOTE: values in addresses are already updated
1963 * @param solver solver handle
1964 * @param address the address
1965 * @param in_use usage state
1968 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
1970 /* Nothing to do here.
1971 * Possible TODO? Future Work: Potentially add usage variable to state vector
1973 LOG(GNUNET_ERROR_TYPE_DEBUG,
1974 "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
1975 address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1979 * Notify solver that the network an address is located in has changed
1981 * NOTE: values in addresses are already updated
1983 * @param solver solver handle
1984 * @param address the address
1985 * @param current_network the current network
1986 * @param new_network the new network
1989 GAS_ril_address_change_network (void *solver,
1990 struct ATS_Address *address,
1991 uint32_t current_network,
1992 uint32_t new_network)
1994 struct GAS_RIL_Handle *s = solver;
1995 struct RIL_Peer_Agent *agent;
1997 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
1998 "%s address of peer %s from '%s' to '%s'\n",
1999 (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
2000 GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
2002 if (address->active && !ril_network_is_active (solver, new_network))
2004 GAS_ril_address_delete (solver, address, GNUNET_NO);
2008 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
2011 GNUNET_assert(!ril_network_is_active (solver, current_network));
2013 GAS_ril_address_add (s, address, new_network);
2017 address->solver_information = ril_get_network(solver, new_network);
2021 * Give feedback about the current assignment
2023 * @param solver the solver handle
2024 * @param application the application
2025 * @param peer the peer to change the preference for
2026 * @param scope the time interval for this feedback: [now - scope .. now]
2027 * @param kind the kind to change the preference
2028 * @param score the score
2031 GAS_ril_address_preference_feedback (void *solver,
2033 const struct GNUNET_PeerIdentity *peer,
2034 const struct GNUNET_TIME_Relative scope,
2035 enum GNUNET_ATS_PreferenceKind kind,
2038 LOG(GNUNET_ERROR_TYPE_DEBUG,
2039 "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
2040 "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
2041 GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
2045 * Start a bulk operation
2047 * @param solver the solver
2050 GAS_ril_bulk_start (void *solver)
2052 struct GAS_RIL_Handle *s = solver;
2054 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_start() lock: %d\n", s->bulk_lock+1);
2060 * Bulk operation done
2062 * @param solver the solver handle
2065 GAS_ril_bulk_stop (void *solver)
2067 struct GAS_RIL_Handle *s = solver;
2069 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_stop() lock: %d\n", s->bulk_lock-1);
2071 if (s->bulk_lock < 1)
2078 if (0 < s->bulk_changes)
2081 s->bulk_changes = 0;
2086 * Tell solver to notify ATS if the address to use changes for a specific
2087 * peer using the bandwidth changed callback
2089 * The solver must only notify about changes for peers with pending address
2092 * @param solver the solver handle
2093 * @param peer the identity of the peer
2095 const struct ATS_Address *
2096 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2099 * activate agent, return currently chosen address
2101 struct GAS_RIL_Handle *s = solver;
2102 struct RIL_Peer_Agent *agent;
2104 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_get_preferred_address()\n");
2106 agent = ril_get_agent (s, peer, GNUNET_YES);
2108 agent->is_active = GNUNET_YES;
2110 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2113 if (agent->address_inuse)
2115 LOG(GNUNET_ERROR_TYPE_DEBUG,
2116 "API_get_preferred_address() Activated agent for peer '%s' with %s address %s\n",
2117 GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
2121 LOG(GNUNET_ERROR_TYPE_DEBUG,
2122 "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
2126 return agent->address_inuse;
2130 * Tell solver stop notifying ATS about changes for this peers
2132 * The solver must only notify about changes for peers with pending address
2135 * @param solver the solver handle
2136 * @param peer the peer
2139 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2141 struct GAS_RIL_Handle *s = solver;
2142 struct RIL_Peer_Agent *agent;
2144 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_stop_get_preferred_address()");
2146 agent = ril_get_agent (s, peer, GNUNET_NO);
2153 if (GNUNET_NO == agent->is_active)
2159 agent->is_active = GNUNET_NO;
2161 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2166 LOG(GNUNET_ERROR_TYPE_DEBUG,
2167 "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
2168 GNUNET_i2s (peer), agent->address_inuse->plugin);
2171 /* end of libgnunet_plugin_ats_ril.c */