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 6
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 1
40 #define RIL_DEFAULT_GRADIENT_STEP_SIZE 0.1
41 #define RIL_DEFAULT_TRACE_DECAY 0.5
42 #define RIL_DEFAULT_EXPLORE_RATIO 0.1
43 #define RIL_DEFAULT_GLOBAL_REWARD_SHARE 0.5
46 * ATS reinforcement learning solver
52 * The actions, how an agent can manipulate the current assignment. I.e. how the bandwidth can be
53 * changed for the currently chosen address. Not depicted in the enum are the actions of switching
54 * to a particular address. The action of switching to address with index i is depicted by the
55 * number (RIL_ACTION_TYPE_NUM + i).
59 RIL_ACTION_NOTHING = 0,
60 RIL_ACTION_BW_IN_DBL = -1, //TODO! put actions back
61 RIL_ACTION_BW_IN_HLV = -2,
62 RIL_ACTION_BW_IN_INC = 1,
63 RIL_ACTION_BW_IN_DEC = 2,
64 RIL_ACTION_BW_OUT_DBL = -3,
65 RIL_ACTION_BW_OUT_HLV = -4,
66 RIL_ACTION_BW_OUT_INC = 3,
67 RIL_ACTION_BW_OUT_DEC = 4,
68 RIL_ACTION_TYPE_NUM = 5
77 enum RIL_E_Modification
86 * Global learning parameters
88 struct RIL_Learning_Parameters
91 * The TD-algorithm to use
93 enum RIL_Algorithm algorithm;
96 * Learning discount factor in the TD-update
101 * Gradient-descent step-size
106 * Trace-decay factor for eligibility traces
111 * Ratio, with what probability an agent should explore in the e-greed policy
113 double explore_ratio;
116 * How big the share of the global part of the reward signal is
118 double reward_global_share;
121 * Minimal interval time between steps in milliseconds
123 struct GNUNET_TIME_Relative step_time_min;
126 * Maximum interval time between steps in milliseconds
128 struct GNUNET_TIME_Relative step_time_max;
132 * Wrapper for addresses to store them in agent's linked list
134 struct RIL_Address_Wrapped
139 struct RIL_Address_Wrapped *next;
144 struct RIL_Address_Wrapped *prev;
149 struct ATS_Address *address_naked;
152 struct RIL_Peer_Agent
155 * Next agent in solver's linked list
157 struct RIL_Peer_Agent *next;
160 * Previous agent in solver's linked list
162 struct RIL_Peer_Agent *prev;
167 struct GAS_RIL_Handle *envi;
172 struct GNUNET_PeerIdentity peer;
175 * Whether the agent is active or not
180 * Number of performed time-steps
182 unsigned long long step_count;
185 * Experience matrix W
190 * Number of rows of W / Number of state-vector features
195 * Number of columns of W / Number of actions
200 * Last perceived state feature vector
210 * Eligibility trace vector
217 struct ATS_Address * address_inuse;
220 * Head of addresses DLL
222 struct RIL_Address_Wrapped * addresses_head;
225 * Tail of addresses DLL
227 struct RIL_Address_Wrapped * addresses_tail;
230 * Inbound bandwidth assigned by the agent
232 unsigned long long bw_in;
235 * Outbound bandwidth assigned by the agent
237 unsigned long long bw_out;
240 * Flag whether a suggestion has to be issued
242 int suggestion_issue;
245 * The address which has to be issued ()
247 struct ATS_Address * suggestion_address;
255 enum GNUNET_ATS_Network_Type type;
258 * Total available inbound bandwidth
260 unsigned long long bw_in_available;
263 * Total available outbound bandwidth
265 unsigned long long bw_out_available;
269 * A handle for the reinforcement learning solver
271 struct GAS_RIL_Handle
274 * The solver-plugin environment of the solver-plugin API
276 struct GNUNET_ATS_PluginEnvironment *plugin_envi;
281 struct GNUNET_STATISTICS_Handle *stats;
284 * Number of performed steps
286 unsigned long long step_count;
289 * Timestamp for the last time-step
291 struct GNUNET_TIME_Absolute step_time_last;
294 * Task identifier of the next time-step to be executed
296 GNUNET_SCHEDULER_TaskIdentifier step_next_task_id;
299 * Variable discount factor, dependent on time between steps
301 double global_discount_variable;
304 * Integrated variable discount factor, dependent on time between steps
306 double global_discount_integrated;
309 * State vector for networks for the current step
311 double *global_state_networks;
314 * Lock for bulk operations
319 * Number of changes during a lock
324 * Learning parameters
326 struct RIL_Learning_Parameters parameters;
329 * Array of networks with global assignment state
331 struct RIL_Network * network_entries;
336 unsigned int networks_count;
339 * List of active peer-agents
341 struct RIL_Peer_Agent * agents_head;
342 struct RIL_Peer_Agent * agents_tail;
352 * ---------------------------
356 ril_count_agents(struct GAS_RIL_Handle * solver);
359 * Estimate the current action-value for state s and action a
361 * @param agent agent performing the estimation
364 * @return estimation value
367 agent_estimate_q (struct RIL_Peer_Agent *agent, double *state, int action)
372 for (i = 0; i < agent->m; i++)
374 result += state[i] * agent->W[action][i];
377 GNUNET_assert(!isnan(result));
381 return isinf(result) * (DBL_MAX / 2); //is still big enough
388 * Decide whether to do exploration (i.e. taking a new action) or exploitation (i.e. taking the
389 * currently estimated best action) in the current step
391 * @param agent agent performing the step
392 * @return yes, if exploring
395 agent_decide_exploration (struct RIL_Peer_Agent *agent)
397 //TODO? Future Work: Improve exploration/exploitation trade-off by different mechanisms than e-greedy
398 double r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
399 UINT32_MAX) / (double) UINT32_MAX;
401 if (r < agent->envi->parameters.explore_ratio)
409 * Get the index of the address in the agent's list.
411 * @param agent agent handle
412 * @param address address handle
413 * @return the index, starting with zero
416 agent_address_get_index (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
419 struct RIL_Address_Wrapped *cur;
422 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
425 if (cur->address_naked == address)
435 * Gets the wrapped address from the agent's list
437 * @param agent agent handle
438 * @param address address handle
439 * @return wrapped address
441 static struct RIL_Address_Wrapped *
442 agent_address_get (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
444 struct RIL_Address_Wrapped *cur;
446 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
448 if (cur->address_naked == address)
458 * Gets the action, with the maximal estimated Q-value (i.e. the one currently estimated to bring the
459 * most reward in the future)
461 * @param agent agent performing the calculation
462 * @param state the state from which to take the action
463 * @return the action promising most future reward
466 agent_get_action_best (struct RIL_Peer_Agent *agent, double *state)
469 int max_i = RIL_ACTION_INVALID;
471 double max_q = -DBL_MAX;
473 for (i = 0; i < agent->n; i++)
475 cur_q = agent_estimate_q (agent, state, i);
483 GNUNET_assert(RIL_ACTION_INVALID != max_i);
489 * Gets any action, to explore the action space from that state
491 * @param agent agent performing the calculation
492 * @param state the state from which to take the action
496 agent_get_action_explore (struct RIL_Peer_Agent *agent, double *state)
498 // TODO?: Future Work: Choose the action for exploration, which has been explored the least in this state
499 return GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, agent->n);
503 * Updates the weights (i.e. coefficients) of the weight vector in matrix W for action a
505 * @param agent the agent performing the update
506 * @param reward the reward received for the last action
507 * @param s_next the new state, the last step got the agent into
508 * @param a_prime the new
511 agent_update_weights (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a_prime)
515 double *theta = agent->W[agent->a_old];
517 delta = agent->envi->global_discount_integrated * reward; //reward
518 delta += agent->envi->global_discount_variable * agent_estimate_q (agent, s_next, a_prime); //discounted future value
519 delta -= agent_estimate_q (agent, agent->s_old, agent->a_old); //one step
521 for (i = 0; i < agent->m; i++)
523 theta[i] += agent->envi->parameters.alpha * delta * agent->e[i];
528 * Changes the eligibility trace vector e in various manners:
529 * RIL_E_ACCUMULATE - adds 1 to each component as in accumulating eligibility traces
530 * RIL_E_REPLACE - resets each component to 1 as in replacing traces
531 * RIL_E_SET - multiplies e with discount factor and lambda as in the update rule
532 * RIL_E_ZERO - sets e to 0 as in Watkin's Q-learning algorithm when exploring and when initializing
534 * @param agent the agent handle
535 * @param mod the kind of modification
538 agent_modify_eligibility (struct RIL_Peer_Agent *agent, enum RIL_E_Modification mod)
541 double *e = agent->e;
543 for (i = 0; i < agent->m; i++)
547 case RIL_E_ACCUMULATE:
554 e[i] *= agent->envi->global_discount_variable * agent->envi->parameters.lambda;
564 ril_inform (struct GAS_RIL_Handle *solver,
565 enum GAS_Solver_Operation op,
566 enum GAS_Solver_Status stat)
568 if (NULL != solver->plugin_envi->info_cb)
569 solver->plugin_envi->info_cb (solver->plugin_envi->info_cb_cls, op, stat, GAS_INFO_NONE);
573 * Changes the active assignment suggestion of the handler and invokes the bw_changed callback to
574 * notify ATS of its new decision
576 * @param solver solver handle
577 * @param agent agent handle
578 * @param new_address the address which is to be used
579 * @param new_bw_in the new amount of inbound bandwidth set for this address
580 * @param new_bw_out the new amount of outbound bandwidth set for this address
581 * @param silent disables invocation of the bw_changed callback, if GNUNET_YES
584 envi_set_active_suggestion (struct GAS_RIL_Handle *solver,
585 struct RIL_Peer_Agent *agent,
586 struct ATS_Address *new_address,
587 unsigned long long new_bw_in,
588 unsigned long long new_bw_out,
591 int notify = GNUNET_NO;
593 LOG(GNUNET_ERROR_TYPE_DEBUG, " set_active_suggestion() for peer '%s'\n", GNUNET_i2s (&agent->peer));
596 if (agent->address_inuse != new_address)
598 if (NULL != agent->address_inuse)
600 agent->address_inuse->active = GNUNET_NO;
601 agent->address_inuse->assigned_bw_in.value__ = htonl (0);
602 agent->address_inuse->assigned_bw_out.value__ = htonl (0);
604 if (NULL != new_address)
606 LOG(GNUNET_ERROR_TYPE_DEBUG, " set address active: %s\n", agent->is_active ? "yes" : "no");
607 new_address->active = agent->is_active;
608 new_address->assigned_bw_in.value__ = htonl (agent->bw_in);
609 new_address->assigned_bw_out.value__ = htonl (agent->bw_out);
611 notify |= GNUNET_YES;
617 if (new_address->active != agent->is_active)
619 new_address->active = agent->is_active;
620 notify |= GNUNET_YES;
624 if (agent->bw_in != new_bw_in)
626 agent->bw_in = new_bw_in;
627 new_address->assigned_bw_in.value__ = htonl (new_bw_in);
628 notify |= GNUNET_YES;
630 if (agent->bw_out != new_bw_out)
632 agent->bw_out = new_bw_out;
633 new_address->assigned_bw_out.value__ = htonl (new_bw_out);
634 notify |= GNUNET_YES;
638 if (notify && agent->is_active && (GNUNET_NO == silent))
642 LOG(GNUNET_ERROR_TYPE_DEBUG, " envi_set_active_suggestion() notify\n");
643 agent->suggestion_issue = GNUNET_YES;
644 agent->suggestion_address = new_address;
646 else if (agent->address_inuse)
648 //disconnect case, no new address
649 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_in.value__));
650 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_out.value__));
654 agent->suggestion_issue = GNUNET_YES;
655 agent->suggestion_address = agent->address_inuse;
658 agent->address_inuse = new_address;
661 static unsigned long long
662 ril_network_get_assigned (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type type, int direction_in)
664 struct RIL_Peer_Agent *cur;
665 struct RIL_Network *net;
666 unsigned long long sum = 0;
668 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
670 if (cur->is_active && cur->address_inuse)
672 net = cur->address_inuse->solver_information;
673 if (net->type == type)
687 envi_state_networks (struct GAS_RIL_Handle *solver)
690 struct RIL_Network net;
691 unsigned long long assigned_in;
692 unsigned long long assigned_out;
694 int overutilized_out;
696 for (i = 0; i < solver->networks_count; i++)
698 net = solver->network_entries[i];
700 assigned_in = ril_network_get_assigned(solver, net.type, GNUNET_YES);
701 assigned_out = ril_network_get_assigned(solver, net.type, GNUNET_NO);
702 overutilized_in = assigned_in > net.bw_in_available;
703 overutilized_out = assigned_out > net.bw_out_available;
705 solver->global_state_networks[i * RIL_FEATURES_NETWORK_COUNT + 0] = (double) assigned_in;
706 solver->global_state_networks[i * RIL_FEATURES_NETWORK_COUNT + 1] = (double) net.bw_in_available;
707 solver->global_state_networks[i * RIL_FEATURES_NETWORK_COUNT + 2] = (double) overutilized_in;
708 solver->global_state_networks[i * RIL_FEATURES_NETWORK_COUNT + 3] = (double) assigned_out;
709 solver->global_state_networks[i * RIL_FEATURES_NETWORK_COUNT + 4] = (double) net.bw_out_available;
710 solver->global_state_networks[i * RIL_FEATURES_NETWORK_COUNT + 5] = (double) overutilized_out;
715 * Allocates a state vector and fills it with the features present
716 * @param solver the solver handle
717 * @param agent the agent handle
718 * @return pointer to the state vector
721 envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
725 double *state = GNUNET_malloc (sizeof (double) * agent->m);
726 struct RIL_Address_Wrapped *cur_address;
727 const double *preferences;
728 const double *properties;
730 //copy global networks state
731 for (i = 0; i < solver->networks_count * RIL_FEATURES_NETWORK_COUNT; i++)
733 state[i] = solver->global_state_networks[i];
737 preferences = solver->plugin_envi->get_preferences (solver->plugin_envi->get_preference_cls,
739 for (k = 0; k < GNUNET_ATS_PreferenceCount; k++)
741 state[i++] = preferences[k];
744 //get address specific features
745 for (cur_address = agent->addresses_head; NULL != cur_address; cur_address = cur_address->next)
747 //when changing the number of address specific state features, change RIL_FEATURES_ADDRESS_COUNT macro
748 state[i++] = cur_address->address_naked->active;
749 state[i++] = cur_address->address_naked->active ? agent->bw_in : 0;
750 state[i++] = cur_address->address_naked->active ? agent->bw_out : 0;
751 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
752 cur_address->address_naked);
753 for (k = 0; k < GNUNET_ATS_QualityPropertiesCount; k++)
755 state[i++] = properties[k];
763 * For all networks a peer has an address in, this gets the maximum bandwidth which could
764 * theoretically be available in one of the networks. This is used for bandwidth normalization.
766 * @param agent the agent handle
767 * @param direction_in whether the inbound bandwidth should be considered. Returns the maximum outbound bandwidth if GNUNET_NO
769 static unsigned long long
770 ril_get_max_bw (struct RIL_Peer_Agent *agent, int direction_in)
773 * get the maximum bandwidth possible for a peer, e.g. among all addresses which addresses'
774 * network could provide the maximum bandwidth if all that bandwidth was used on that one peer.
776 unsigned long long max = 0;
777 struct RIL_Address_Wrapped *cur;
778 struct RIL_Network *net;
780 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
782 net = cur->address_naked->solver_information;
785 if (net->bw_in_available > max)
787 max = net->bw_in_available;
792 if (net->bw_out_available > max)
794 max = net->bw_out_available;
802 * Get the index of the quality-property in question
804 * @param type the quality property type
808 ril_find_property_index (uint32_t type)
810 int existing_types[] = GNUNET_ATS_QualityProperties;
812 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
813 if (existing_types[c] == type)
815 return GNUNET_SYSERR;
819 ril_get_atsi (struct ATS_Address *address, uint32_t type)
822 GNUNET_assert(NULL != address);
824 if ((NULL == address->atsi) || (0 == address->atsi_count))
827 for (c1 = 0; c1 < address->atsi_count; c1++)
829 if (ntohl (address->atsi[c1].type) == type)
830 return ntohl (address->atsi[c1].value);
836 envi_reward_global (struct GAS_RIL_Handle *solver)
839 struct RIL_Network net;
840 unsigned int sum_in_available = 0;
841 unsigned int sum_out_available = 0;
842 unsigned int sum_in_assigned = 0;
843 unsigned int sum_out_assigned = 0;
847 for (i = 0; i < solver->networks_count; i++)
849 net = solver->network_entries[i];
850 sum_in_available += net.bw_in_available;
851 sum_in_assigned += ril_network_get_assigned(solver, net.type, GNUNET_YES);
852 sum_out_available += net.bw_out_available;
853 sum_out_assigned += ril_network_get_assigned(solver, net.type, GNUNET_NO);
856 ratio_in = ((double) sum_in_assigned) / ((double) sum_in_available);
857 ratio_out = ((double) sum_out_assigned) / ((double) sum_out_available);
859 // global reward in [1,2]
860 return ((ratio_in + ratio_out) / 2) + 1;
864 envi_reward_local (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
866 const double *preferences;
867 const double *properties;
869 double pref_match = 0;
873 preferences = solver->plugin_envi->get_preferences (solver->plugin_envi->get_preference_cls,
875 properties = solver->plugin_envi->get_property (solver->plugin_envi->get_property_cls,
876 agent->address_inuse);
879 prop_index = ril_find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
880 dl_norm = 2 - properties[prop_index]; //invert property as we want to maximize for lower latencies
882 // utilization in [0,1]
883 bw_norm = (((double) ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_IN)
884 / (double) ril_get_max_bw (agent, GNUNET_YES))
885 + ((double) ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_OUT)
886 / (double) ril_get_max_bw (agent, GNUNET_NO))) / 2;
888 // preference matching in [0,4]
889 pref_match += (preferences[GNUNET_ATS_PREFERENCE_LATENCY] * dl_norm);
890 pref_match += (preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] * bw_norm);
892 // local reward in [1,2]
893 return (pref_match / 4) +1;
897 * Gets the reward for the last performed step, which is calculated in equal
898 * parts from the local (the peer specific) and the global (for all peers
901 * @param solver the solver handle
902 * @param agent the agent handle
906 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
908 struct RIL_Network *net;
910 unsigned long long assigned_in;
911 unsigned long long assigned_out;
912 unsigned long long overutilized = 0;
914 //punish overutilization
915 net = agent->address_inuse->solver_information;
916 assigned_in = ril_network_get_assigned(solver, net->type, GNUNET_YES);
917 assigned_out = ril_network_get_assigned(solver, net->type, GNUNET_NO);
919 if (assigned_in > net->bw_in_available)
921 overutilized += assigned_in - net->bw_in_available;
923 if (assigned_out > net->bw_out_available)
925 overutilized += assigned_out - net->bw_out_available;
927 if (overutilized > 0)
929 return -1. * (double) overutilized / 1024;
933 reward += envi_reward_global (solver) * (solver->parameters.reward_global_share);
934 reward += envi_reward_local (solver, agent) * (1 - solver->parameters.reward_global_share);
936 return (reward - 1.) * 100;
940 * Doubles the bandwidth for the active address
942 * @param solver solver handle
943 * @param agent agent handle
944 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
947 envi_action_bw_double (struct GAS_RIL_Handle *solver,
948 struct RIL_Peer_Agent *agent,
951 unsigned long long new_bw;
955 new_bw = agent->bw_in * 2;
956 if (new_bw < agent->bw_in)
958 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
959 agent->bw_out, GNUNET_NO);
963 new_bw = agent->bw_out * 2;
964 if (new_bw < agent->bw_out)
966 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
972 * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
973 * the minimum bandwidth for a peer, in order to not invoke a disconnect.
975 * @param solver solver handle
976 * @param agent agent handle
977 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
981 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
982 struct RIL_Peer_Agent *agent,
985 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
986 unsigned long long new_bw;
990 new_bw = agent->bw_in / 2;
991 if (new_bw < min_bw || new_bw > agent->bw_in)
993 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
998 new_bw = agent->bw_out / 2;
999 if (new_bw < min_bw || new_bw > agent->bw_out)
1001 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1007 * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
1009 * @param solver solver handle
1010 * @param agent agent handle
1011 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1015 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
1017 unsigned long long new_bw;
1018 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1022 new_bw = agent->bw_in + (5 * min_bw);
1023 if (new_bw < agent->bw_in)
1024 new_bw = ULLONG_MAX;
1025 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
1026 agent->bw_out, GNUNET_NO);
1030 new_bw = agent->bw_out + (5 * min_bw);
1031 if (new_bw < agent->bw_out)
1032 new_bw = ULLONG_MAX;
1033 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
1039 * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
1040 * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
1042 * @param solver solver handle
1043 * @param agent agent handle
1044 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1048 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
1050 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1051 unsigned long long new_bw;
1055 new_bw = agent->bw_in - (5 * min_bw);
1056 if (new_bw < min_bw || new_bw > agent->bw_in)
1058 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
1063 new_bw = agent->bw_out - (5 * min_bw);
1064 if (new_bw < min_bw || new_bw > agent->bw_out)
1066 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1072 * Switches to the address given by its index
1074 * @param solver solver handle
1075 * @param agent agent handle
1076 * @param address_index index of the address as it is saved in the agent's list, starting with zero
1079 envi_action_address_switch (struct GAS_RIL_Handle *solver,
1080 struct RIL_Peer_Agent *agent,
1081 unsigned int address_index)
1083 struct RIL_Address_Wrapped *cur;
1086 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
1088 if (i == address_index)
1090 envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
1098 //no address with address_index exists, in this case this action should not be callable
1099 GNUNET_assert(GNUNET_NO);
1103 * Puts the action into effect by calling the according function
1105 * @param solver the solver handle
1106 * @param agent the action handle
1107 * @param action the action to perform by the solver
1110 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
1116 case RIL_ACTION_NOTHING:
1118 case RIL_ACTION_BW_IN_DBL:
1119 envi_action_bw_double (solver, agent, GNUNET_YES);
1121 case RIL_ACTION_BW_IN_HLV:
1122 envi_action_bw_halven (solver, agent, GNUNET_YES);
1124 case RIL_ACTION_BW_IN_INC:
1125 envi_action_bw_inc (solver, agent, GNUNET_YES);
1127 case RIL_ACTION_BW_IN_DEC:
1128 envi_action_bw_dec (solver, agent, GNUNET_YES);
1130 case RIL_ACTION_BW_OUT_DBL:
1131 envi_action_bw_double (solver, agent, GNUNET_NO);
1133 case RIL_ACTION_BW_OUT_HLV:
1134 envi_action_bw_halven (solver, agent, GNUNET_NO);
1136 case RIL_ACTION_BW_OUT_INC:
1137 envi_action_bw_inc (solver, agent, GNUNET_NO);
1139 case RIL_ACTION_BW_OUT_DEC:
1140 envi_action_bw_dec (solver, agent, GNUNET_NO);
1143 if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
1145 address_index = action - RIL_ACTION_TYPE_NUM;
1147 GNUNET_assert(address_index >= 0);
1149 address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
1151 envi_action_address_switch (solver, agent, address_index);
1154 // error - action does not exist
1155 GNUNET_assert(GNUNET_NO);
1160 * Performs one step of the Markov Decision Process. Other than in the literature the step starts
1161 * after having done the last action a_old. It observes the new state s_next and the reward
1162 * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
1163 * next action is put into effect.
1165 * @param agent the agent performing the step
1168 agent_step (struct RIL_Peer_Agent *agent)
1170 int a_next = RIL_ACTION_INVALID;
1174 LOG(GNUNET_ERROR_TYPE_DEBUG, " agent_step() Peer '%s', algorithm %s\n",
1175 GNUNET_i2s (&agent->peer),
1176 agent->envi->parameters.algorithm ? "Q" : "SARSA");
1178 s_next = envi_get_state (agent->envi, agent);
1179 reward = envi_get_reward (agent->envi, agent);
1181 switch (agent->envi->parameters.algorithm)
1183 case RIL_ALGO_SARSA:
1184 agent_modify_eligibility (agent, RIL_E_SET);
1185 if (agent_decide_exploration (agent))
1187 a_next = agent_get_action_explore (agent, s_next);
1191 a_next = agent_get_action_best (agent, s_next);
1193 if (RIL_ACTION_INVALID != agent->a_old)
1195 //updates weights with selected action (on-policy), if not first step
1196 agent_update_weights (agent, reward, s_next, a_next);
1201 a_next = agent_get_action_best (agent, s_next);
1202 if (RIL_ACTION_INVALID != agent->a_old)
1204 //updates weights with best action, disregarding actually selected action (off-policy), if not first step
1205 agent_update_weights (agent, reward, s_next, a_next);
1207 if (agent_decide_exploration (agent))
1209 a_next = agent_get_action_explore (agent, s_next);
1210 agent_modify_eligibility (agent, RIL_E_ZERO);
1214 a_next = agent_get_action_best (agent, s_next);
1215 agent_modify_eligibility (agent, RIL_E_SET);
1220 GNUNET_assert(RIL_ACTION_INVALID != a_next);
1222 agent_modify_eligibility (agent, RIL_E_ACCUMULATE);
1224 envi_do_action (agent->envi, agent, a_next);
1226 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Agent step %llu: Action: %d Reward: %f Result: IN %llu OUT %llu\n",
1231 agent->bw_out/1024);
1233 GNUNET_free(agent->s_old);
1234 agent->s_old = s_next;
1235 agent->a_old = a_next;
1237 agent->step_count += 1;
1241 ril_step (struct GAS_RIL_Handle *solver);
1244 * Task for the scheduler, which performs one step and lets the solver know that
1245 * no further step is scheduled.
1247 * @param cls the solver handle
1248 * @param tc the task context for the scheduler
1251 ril_step_scheduler_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1253 struct GAS_RIL_Handle *solver = cls;
1255 solver->step_next_task_id = GNUNET_SCHEDULER_NO_TASK;
1260 ril_get_used_resource_ratio (struct GAS_RIL_Handle *solver)
1263 struct RIL_Network net;
1264 unsigned long long sum_assigned = 0;
1265 unsigned long long sum_available = 0;
1268 for (i = 0; i < solver->networks_count; i++)
1270 net = solver->network_entries[i];
1271 if (ril_network_get_assigned(solver, net.type, GNUNET_YES) > 0) //only consider scopes where an address is actually active
1273 sum_assigned += ril_network_get_assigned(solver, net.type, GNUNET_YES);
1274 sum_assigned += ril_network_get_assigned(solver, net.type, GNUNET_NO);
1275 sum_available += net.bw_in_available;
1276 sum_available += net.bw_out_available;
1279 if (sum_available > 0)
1281 ratio = ((double) sum_assigned) / ((double) sum_available);
1288 return ratio > 1 ? 1 : ratio; //overutilization possible, cap at 1
1292 * Lookup network struct by type
1294 * @param s the solver handle
1295 * @param type the network type
1296 * @return the network struct
1298 static struct RIL_Network *
1299 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1303 for (i = 0; i < s->networks_count; i++)
1305 if (s->network_entries[i].type == type)
1307 return &s->network_entries[i];
1314 ril_network_is_not_full (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1316 struct RIL_Network *net;
1317 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1318 struct RIL_Peer_Agent *agent;
1319 unsigned long long address_count = 0;
1321 for (agent = solver->agents_head; NULL != agent; agent = agent->next)
1323 if (agent->address_inuse && agent->is_active)
1325 net = agent->address_inuse->solver_information;
1326 if (net->type == network)
1333 net = ril_get_network (solver, network);
1334 return (net->bw_in_available > min_bw * address_count) && (net->bw_out_available > min_bw * address_count);
1338 ril_try_unblock_agent (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int silent)
1340 struct RIL_Address_Wrapped *addr_wrap;
1341 struct RIL_Network *net;
1342 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1344 for (addr_wrap = agent->addresses_head; NULL != addr_wrap; addr_wrap = addr_wrap->next)
1346 net = addr_wrap->address_naked->solver_information;
1347 if (ril_network_is_not_full(solver, net->type))
1349 if (NULL == agent->address_inuse)
1350 envi_set_active_suggestion (solver, agent, addr_wrap->address_naked, min_bw, min_bw, silent);
1354 agent->address_inuse = NULL;
1358 * Schedules the next global step in an adaptive way. The more resources are
1359 * left, the earlier the next step is scheduled. This serves the reactivity of
1360 * the solver to changed inputs.
1362 * @param solver the solver handle
1365 ril_step_schedule_next (struct GAS_RIL_Handle *solver)
1371 struct GNUNET_TIME_Relative time_next;
1373 used_ratio = ril_get_used_resource_ratio (solver);
1376 solver->parameters.step_time_min.rel_value_us
1377 <= solver->parameters.step_time_max.rel_value_us);
1379 factor = (double) GNUNET_TIME_relative_subtract (solver->parameters.step_time_max,
1380 solver->parameters.step_time_min).rel_value_us;
1381 offset = (double) solver->parameters.step_time_min.rel_value_us;
1382 y = factor * pow (used_ratio, RIL_INTERVAL_EXPONENT) + offset;
1384 GNUNET_assert(y <= (double ) solver->parameters.step_time_max.rel_value_us);
1385 GNUNET_assert(y >= (double ) solver->parameters.step_time_min.rel_value_us);
1387 time_next = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, (unsigned long long) y);
1389 if ((GNUNET_SCHEDULER_NO_TASK == solver->step_next_task_id) && (GNUNET_NO == solver->done))
1391 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (time_next, &ril_step_scheduler_task,
1397 * Triggers one step per agent
1401 ril_step (struct GAS_RIL_Handle *solver)
1403 struct RIL_Peer_Agent *cur;
1404 struct GNUNET_TIME_Absolute time_now;
1405 struct GNUNET_TIME_Relative time_delta;
1408 if (GNUNET_YES == solver->bulk_lock)
1410 solver->bulk_changes++;
1414 ril_inform (solver, GAS_OP_SOLVE_START, GAS_STAT_SUCCESS);
1416 LOG(GNUNET_ERROR_TYPE_DEBUG, " RIL step number %d\n", solver->step_count);
1418 if (0 == solver->step_count)
1420 solver->step_time_last = GNUNET_TIME_absolute_get ();
1423 //calculate tau, i.e. how many real valued time units have passed, one time unit is one minimum time step
1424 time_now = GNUNET_TIME_absolute_get ();
1425 time_delta = GNUNET_TIME_absolute_get_difference (solver->step_time_last, time_now);
1426 solver->step_time_last = time_now;
1427 tau = ((double) time_delta.rel_value_us)
1428 / ((double) solver->parameters.step_time_min.rel_value_us);
1430 //calculate reward discounts (once per step for all agents)
1431 solver->global_discount_variable = pow (M_E, ((-1.) * ((double) solver->parameters.beta) * tau));
1432 solver->global_discount_integrated = (1 - solver->global_discount_variable)
1433 / ((double) solver->parameters.beta);
1435 //calculate network state vector
1436 envi_state_networks(solver);
1438 //trigger one step per active, unblocked agent
1439 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1443 if (NULL == cur->address_inuse)
1445 ril_try_unblock_agent(solver, cur, GNUNET_NO);
1447 if (cur->address_inuse)
1454 solver->step_count += 1;
1455 ril_step_schedule_next (solver);
1457 ril_inform (solver, GAS_OP_SOLVE_STOP, GAS_STAT_SUCCESS);
1459 ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START, GAS_STAT_SUCCESS);
1460 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1462 if (cur->suggestion_issue) {
1463 solver->plugin_envi->bandwidth_changed_cb(solver->plugin_envi->bw_changed_cb_cls, cur->suggestion_address);
1464 cur->suggestion_issue = GNUNET_NO;
1467 ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP, GAS_STAT_SUCCESS);
1471 ril_count_agents (struct GAS_RIL_Handle *solver)
1474 struct RIL_Peer_Agent *cur_agent;
1476 for (cur_agent = solver->agents_head; NULL != cur_agent; cur_agent = cur_agent->next)
1484 agent_w_start (struct RIL_Peer_Agent *agent)
1487 struct RIL_Peer_Agent *other;
1491 count = ril_count_agents(agent->envi);
1493 for (other = agent->envi->agents_head; NULL != other; other = other->next)
1495 for (i = 0; i < agent->n; i++)
1497 for (k = 0; k < agent->m; k++)
1503 agent->W[i][k] += (other->W[i][k] / (double) count);
1506 GNUNET_assert(!isinf(agent->W[i][k]));
1513 * Initialize an agent without addresses and its knowledge base
1515 * @param s ril solver
1516 * @param peer the one in question
1517 * @return handle to the new agent
1519 static struct RIL_Peer_Agent *
1520 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1523 struct GAS_RIL_Handle * solver = s;
1524 struct RIL_Peer_Agent * agent = GNUNET_malloc (sizeof (struct RIL_Peer_Agent));
1526 agent->envi = solver;
1527 agent->peer = *peer;
1528 agent->step_count = 0;
1529 agent->is_active = GNUNET_NO;
1530 agent->bw_in = 1024; //TODO? put min_bw
1531 agent->bw_out = 1024;
1532 agent->suggestion_issue = GNUNET_NO;
1533 agent->n = RIL_ACTION_TYPE_NUM;
1534 agent->m = (solver->networks_count * RIL_FEATURES_NETWORK_COUNT) + GNUNET_ATS_PreferenceCount;
1535 agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1536 for (i = 0; i < agent->n; i++)
1538 agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1540 agent_w_start(agent);
1541 agent->a_old = RIL_ACTION_INVALID;
1542 agent->s_old = envi_get_state (solver, agent);
1543 agent->e = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1544 agent_modify_eligibility (agent, RIL_E_ZERO);
1552 * @param solver the solver handle
1553 * @param agent the agent to retire
1556 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1560 for (i = 0; i < agent->n; i++)
1562 GNUNET_free(agent->W[i]);
1564 GNUNET_free(agent->W);
1565 GNUNET_free(agent->e);
1566 GNUNET_free(agent->s_old);
1571 * Returns the agent for a peer
1573 * @param solver the solver handle
1574 * @param peer the identity of the peer
1575 * @param create whether or not to create an agent, if none is allocated yet
1578 static struct RIL_Peer_Agent *
1579 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
1581 struct RIL_Peer_Agent *cur;
1583 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1585 if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
1593 cur = agent_init (solver, peer);
1594 GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, cur);
1601 * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
1602 * considered inactive and not used. Addresses in an inactive network are ignored.
1604 * @param solver solver handle
1605 * @param network the network type
1606 * @return whether or not the network is considered active
1609 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1611 struct RIL_Network *net;
1612 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1614 net = ril_get_network (solver, network);
1615 return net->bw_out_available >= min_bw;
1619 * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
1620 * the reward function approximation. It copies the memory, which is not cut, to the new vector,
1621 * frees the memory of the old vector, and redirects the pointer to the new one.
1623 * @param old pointer to the pointer to the first element of the vector
1624 * @param element_size byte size of the vector elements
1625 * @param hole_start the first element to cut out
1626 * @param hole_length the number of elements to cut out
1627 * @param old_length the length of the old vector
1630 ril_cut_from_vector (void **old,
1631 size_t element_size,
1632 unsigned int hole_start,
1633 unsigned int hole_length,
1634 unsigned int old_length)
1637 char *oldptr = (char *) *old;
1639 unsigned int bytes_before;
1640 unsigned int bytes_hole;
1641 unsigned int bytes_after;
1643 GNUNET_assert(old_length > hole_length);
1644 GNUNET_assert(old_length >= (hole_start + hole_length));
1646 size = element_size * (old_length - hole_length);
1648 bytes_before = element_size * hole_start;
1649 bytes_hole = element_size * hole_length;
1650 bytes_after = element_size * (old_length - hole_start - hole_length);
1658 tmpptr = GNUNET_malloc (size);
1659 memcpy (tmpptr, oldptr, bytes_before);
1660 memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
1666 *old = (void *) tmpptr;
1670 * Solver API functions
1671 * ---------------------------
1675 * Change relative preference for quality in solver
1677 * @param solver the solver handle
1678 * @param peer the peer to change the preference for
1679 * @param kind the kind to change the preference
1680 * @param pref_rel the normalized preference value for this kind over all clients
1683 GAS_ril_address_change_preference (void *solver,
1684 const struct GNUNET_PeerIdentity *peer,
1685 enum GNUNET_ATS_PreferenceKind kind,
1688 LOG(GNUNET_ERROR_TYPE_DEBUG,
1689 "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
1690 GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
1696 * Entry point for the plugin
1698 * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
1701 libgnunet_plugin_ats_ril_init (void *cls)
1703 struct GNUNET_ATS_PluginEnvironment *env = cls;
1704 struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
1705 struct RIL_Network * cur;
1709 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
1711 GNUNET_assert(NULL != env);
1712 GNUNET_assert(NULL != env->cfg);
1713 GNUNET_assert(NULL != env->stats);
1714 GNUNET_assert(NULL != env->bandwidth_changed_cb);
1715 GNUNET_assert(NULL != env->get_preferences);
1716 GNUNET_assert(NULL != env->get_property);
1719 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MIN",
1720 &solver->parameters.step_time_min))
1722 solver->parameters.step_time_min = RIL_DEFAULT_STEP_TIME_MIN;
1725 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MAX",
1726 &solver->parameters.step_time_max))
1728 solver->parameters.step_time_max = RIL_DEFAULT_STEP_TIME_MAX;
1730 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string))
1732 solver->parameters.algorithm = !strcmp (string, "SARSA") ? RIL_ALGO_SARSA : RIL_ALGO_Q;
1733 GNUNET_free (string);
1737 solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
1739 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_DISCOUNT_BETA", &string))
1741 solver->parameters.beta = strtod (string, NULL);
1742 GNUNET_free (string);
1746 solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
1749 == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &string))
1751 solver->parameters.alpha = strtod (string, NULL);
1752 GNUNET_free (string);
1756 solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
1758 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TRACE_DECAY", &string))
1760 solver->parameters.lambda = strtod (string, NULL);
1761 GNUNET_free (string);
1765 solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
1767 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_EXPLORE_RATIO", &string))
1769 solver->parameters.explore_ratio = strtod (string, NULL);
1770 GNUNET_free (string);
1774 solver->parameters.explore_ratio = RIL_DEFAULT_EXPLORE_RATIO;
1776 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_GLOBAL_REWARD_SHARE", &string))
1778 solver->parameters.reward_global_share = strtod (string, NULL);
1779 GNUNET_free (string);
1783 solver->parameters.reward_global_share = RIL_DEFAULT_GLOBAL_REWARD_SHARE;
1786 env->sf.s_add = &GAS_ril_address_add;
1787 env->sf.s_address_update_property = &GAS_ril_address_property_changed;
1788 env->sf.s_address_update_session = &GAS_ril_address_session_changed;
1789 env->sf.s_address_update_inuse = &GAS_ril_address_inuse_changed;
1790 env->sf.s_address_update_network = &GAS_ril_address_change_network;
1791 env->sf.s_get = &GAS_ril_get_preferred_address;
1792 env->sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
1793 env->sf.s_pref = &GAS_ril_address_change_preference;
1794 env->sf.s_feedback = &GAS_ril_address_preference_feedback;
1795 env->sf.s_del = &GAS_ril_address_delete;
1796 env->sf.s_bulk_start = &GAS_ril_bulk_start;
1797 env->sf.s_bulk_stop = &GAS_ril_bulk_stop;
1799 solver->plugin_envi = env;
1800 solver->networks_count = env->network_count;
1801 solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Network));
1802 solver->step_count = 0;
1803 solver->global_state_networks = GNUNET_malloc (solver->networks_count * RIL_FEATURES_NETWORK_COUNT * sizeof (double));
1804 solver->done = GNUNET_NO;
1806 for (c = 0; c < env->network_count; c++)
1808 cur = &solver->network_entries[c];
1809 cur->type = env->networks[c];
1810 cur->bw_in_available = env->in_quota[c];
1811 cur->bw_out_available = env->out_quota[c];
1812 LOG(GNUNET_ERROR_TYPE_INFO, "Quotas for %s network: IN %llu - OUT %llu\n", GNUNET_ATS_print_network_type(cur->type), cur->bw_in_available/1024, cur->bw_out_available/1024);
1815 // solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (
1816 // GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_get_millisecond_ (), 1000),
1817 // &ril_step_scheduler_task, solver);
1818 // solver->step_next_task_id = GNUNET_SCHEDULER_add_now(&ril_step_scheduler_task, solver);
1820 LOG(GNUNET_ERROR_TYPE_INFO, "Parameters:\n");
1821 LOG(GNUNET_ERROR_TYPE_INFO, "Algorithm = %s, alpha = %f, beta = %f, lambda = %f\n",
1822 solver->parameters.algorithm ? "Q" : "SARSA",
1823 solver->parameters.alpha,
1824 solver->parameters.beta,
1825 solver->parameters.lambda);
1826 LOG(GNUNET_ERROR_TYPE_INFO, "explore = %f, global_share = %f\n",
1827 solver->parameters.explore_ratio,
1828 solver->parameters.reward_global_share);
1834 * Exit point for the plugin
1836 * @param cls the solver handle
1839 libgnunet_plugin_ats_ril_done (void *cls)
1841 struct GAS_RIL_Handle *s = cls;
1842 struct RIL_Peer_Agent *cur_agent;
1843 struct RIL_Peer_Agent *next_agent;
1845 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
1847 s->done = GNUNET_YES;
1849 cur_agent = s->agents_head;
1850 while (NULL != cur_agent)
1852 next_agent = cur_agent->next;
1853 GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
1854 agent_die (s, cur_agent);
1855 cur_agent = next_agent;
1858 if (GNUNET_SCHEDULER_NO_TASK != s->step_next_task_id)
1860 GNUNET_SCHEDULER_cancel (s->step_next_task_id);
1862 GNUNET_free(s->network_entries);
1863 GNUNET_free(s->global_state_networks);
1870 * Add a new address for a peer to the solver
1872 * The address is already contained in the addresses hashmap!
1874 * @param solver the solver Handle
1875 * @param address the address to add
1876 * @param network network type of this address
1879 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
1881 struct GAS_RIL_Handle *s = solver;
1882 struct RIL_Peer_Agent *agent;
1883 struct RIL_Address_Wrapped *address_wrapped;
1884 struct RIL_Network *net;
1892 LOG (GNUNET_ERROR_TYPE_DEBUG, "API_address_add()\n");
1894 net = ril_get_network (s, network);
1895 address->solver_information = net;
1897 if (!ril_network_is_active (s, network))
1899 LOG(GNUNET_ERROR_TYPE_DEBUG,
1900 "API_address_add() Did not add %s address %s for peer '%s', network does not have enough bandwidth\n",
1901 address->plugin, address->addr, GNUNET_i2s (&address->peer));
1905 agent = ril_get_agent (s, &address->peer, GNUNET_YES);
1908 address_wrapped = GNUNET_malloc (sizeof (struct RIL_Address_Wrapped));
1909 address_wrapped->address_naked = address;
1910 GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
1912 //increase size of W
1913 m_new = agent->m + RIL_FEATURES_ADDRESS_COUNT;
1915 n_new = agent->n + 1;
1918 GNUNET_array_grow(agent->W, agent->n, n_new);
1919 for (i = 0; i < n_new; i++)
1924 GNUNET_array_grow(agent->W[i], agent->m, m_new);
1929 GNUNET_array_grow(agent->W[i], zero, m_new);
1933 //increase size of old state vector
1935 GNUNET_array_grow(agent->s_old, agent->m, m_new);
1938 GNUNET_array_grow(agent->e, agent->m, m_new);
1940 ril_try_unblock_agent(s, agent, GNUNET_NO);
1944 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %s for peer '%s'\n",
1945 address->active ? "active" : "inactive", address->plugin, address->addr,
1946 GNUNET_i2s (&address->peer));
1950 * Delete an address in the solver
1952 * The address is not contained in the address hashmap anymore!
1954 * @param solver the solver handle
1955 * @param address the address to remove
1956 * @param session_only delete only session not whole address
1959 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
1961 struct GAS_RIL_Handle *s = solver;
1962 struct RIL_Peer_Agent *agent;
1963 struct RIL_Address_Wrapped *address_wrapped;
1964 int address_was_used = address->active;
1969 struct RIL_Network *net;
1970 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1972 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Delete %s%s %s address %s for peer '%s'\n",
1973 session_only ? "session for " : "", address->active ? "active" : "inactive", address->plugin,
1974 address->addr, GNUNET_i2s (&address->peer));
1976 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
1979 net = address->solver_information;
1980 GNUNET_assert(!ril_network_is_active (s, net->type));
1981 LOG(GNUNET_ERROR_TYPE_DEBUG,
1982 "No agent allocated for peer yet, since address was in inactive network\n");
1986 address_index = agent_address_get_index (agent, address);
1987 address_wrapped = agent_address_get (agent, address);
1989 if (NULL == address_wrapped)
1991 net = address->solver_information;
1992 GNUNET_assert(!ril_network_is_active (s, net->type));
1993 LOG(GNUNET_ERROR_TYPE_DEBUG,
1994 "Address not considered by agent, address was in inactive network\n");
1998 GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
1999 GNUNET_free(address_wrapped);
2002 m_new = agent->m - RIL_FEATURES_ADDRESS_COUNT;
2003 n_new = agent->n - 1;
2005 for (i = 0; i < agent->n; i++)
2007 ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
2008 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
2009 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
2011 GNUNET_free(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
2012 ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
2014 //correct last action
2015 if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
2019 else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
2021 agent->a_old = RIL_ACTION_INVALID;
2023 //decrease old state vector and eligibility vector
2024 ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
2025 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
2026 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
2027 ril_cut_from_vector ((void **) &agent->e, sizeof(double),
2028 ((s->networks_count * RIL_FEATURES_NETWORK_COUNT)
2029 + (address_index * RIL_FEATURES_ADDRESS_COUNT)), RIL_FEATURES_ADDRESS_COUNT, agent->m);
2033 if (address_was_used)
2035 if (NULL != agent->addresses_head) //if peer has an address left, use it
2037 envi_set_active_suggestion (s, agent, agent->addresses_head->address_naked, min_bw, min_bw,
2042 envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
2050 * Update the properties of an address in the solver
2052 * @param solver solver handle
2053 * @param address the address
2054 * @param type the ATSI type in HBO
2055 * @param abs_value the absolute value of the property
2056 * @param rel_value the normalized value
2059 GAS_ril_address_property_changed (void *solver,
2060 struct ATS_Address *address,
2065 LOG(GNUNET_ERROR_TYPE_DEBUG,
2066 "API_address_property_changed() Property '%s' for peer '%s' address %s changed "
2067 "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
2068 address->addr, rel_value);
2074 * Update the session of an address in the solver
2076 * NOTE: values in addresses are already updated
2078 * @param solver solver handle
2079 * @param address the address
2080 * @param cur_session the current session
2081 * @param new_session the new session
2084 GAS_ril_address_session_changed (void *solver,
2085 struct ATS_Address *address,
2086 uint32_t cur_session,
2087 uint32_t new_session)
2090 * TODO? Future Work: Potentially add session activity as a feature in state vector
2092 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
2096 * Notify the solver that an address is (not) actively used by transport
2097 * to communicate with a remote peer
2099 * NOTE: values in addresses are already updated
2101 * @param solver solver handle
2102 * @param address the address
2103 * @param in_use usage state
2106 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
2109 * TODO? Future Work: Potentially add usage variable to state vector
2111 LOG(GNUNET_ERROR_TYPE_DEBUG,
2112 "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
2113 address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
2117 * Notify solver that the network an address is located in has changed
2119 * NOTE: values in addresses are already updated
2121 * @param solver solver handle
2122 * @param address the address
2123 * @param current_network the current network
2124 * @param new_network the new network
2127 GAS_ril_address_change_network (void *solver,
2128 struct ATS_Address *address,
2129 uint32_t current_network,
2130 uint32_t new_network)
2132 struct GAS_RIL_Handle *s = solver;
2133 struct RIL_Peer_Agent *agent;
2135 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
2136 "%s address of peer %s from '%s' to '%s'\n",
2137 (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
2138 GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
2140 if (address->active && !ril_network_is_active (solver, new_network))
2142 GAS_ril_address_delete (solver, address, GNUNET_NO);
2146 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
2149 GNUNET_assert(!ril_network_is_active (solver, current_network));
2151 GAS_ril_address_add (s, address, new_network);
2155 address->solver_information = ril_get_network(solver, new_network);
2159 * Give feedback about the current assignment
2161 * @param solver the solver handle
2162 * @param application the application
2163 * @param peer the peer to change the preference for
2164 * @param scope the time interval for this feedback: [now - scope .. now]
2165 * @param kind the kind to change the preference
2166 * @param score the score
2169 GAS_ril_address_preference_feedback (void *solver,
2171 const struct GNUNET_PeerIdentity *peer,
2172 const struct GNUNET_TIME_Relative scope,
2173 enum GNUNET_ATS_PreferenceKind kind,
2176 LOG(GNUNET_ERROR_TYPE_DEBUG,
2177 "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
2178 "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
2179 GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
2183 * Start a bulk operation
2185 * @param solver the solver
2188 GAS_ril_bulk_start (void *solver)
2190 struct GAS_RIL_Handle *s = solver;
2192 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_start() lock: %d\n", s->bulk_lock+1);
2198 * Bulk operation done
2200 * @param solver the solver handle
2203 GAS_ril_bulk_stop (void *solver)
2205 struct GAS_RIL_Handle *s = solver;
2207 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_stop() lock: %d\n", s->bulk_lock-1);
2209 if (s->bulk_lock < 1)
2216 if (0 < s->bulk_changes)
2219 s->bulk_changes = 0;
2224 * Tell solver to notify ATS if the address to use changes for a specific
2225 * peer using the bandwidth changed callback
2227 * The solver must only notify about changes for peers with pending address
2230 * @param solver the solver handle
2231 * @param peer the identity of the peer
2233 const struct ATS_Address *
2234 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2237 * activate agent, return currently chosen address
2239 struct GAS_RIL_Handle *s = solver;
2240 struct RIL_Peer_Agent *agent;
2242 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_get_preferred_address()\n");
2244 agent = ril_get_agent (s, peer, GNUNET_YES);
2246 agent->is_active = GNUNET_YES;
2247 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, agent->bw_out, GNUNET_YES);
2249 ril_try_unblock_agent(solver, agent, GNUNET_YES);
2251 if (agent->address_inuse)
2253 LOG(GNUNET_ERROR_TYPE_DEBUG,
2254 "API_get_preferred_address() Activated agent for peer '%s' with %s address %s\n",
2255 GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
2259 LOG(GNUNET_ERROR_TYPE_DEBUG,
2260 "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
2264 return agent->address_inuse;
2268 * Tell solver stop notifying ATS about changes for this peers
2270 * The solver must only notify about changes for peers with pending address
2273 * @param solver the solver handle
2274 * @param peer the peer
2277 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2279 struct GAS_RIL_Handle *s = solver;
2280 struct RIL_Peer_Agent *agent;
2282 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_stop_get_preferred_address()");
2284 agent = ril_get_agent (s, peer, GNUNET_NO);
2291 if (GNUNET_NO == agent->is_active)
2297 agent->is_active = GNUNET_NO;
2299 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2304 LOG(GNUNET_ERROR_TYPE_DEBUG,
2305 "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
2306 GNUNET_i2s (peer), agent->address_inuse->plugin);
2309 /* end of libgnunet_plugin_ats_ril.c */