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/plugin_ats_ril.c
23 * @brief ATS reinforcement learning solver
24 * @author Fabian Oehlmann
25 * @author Matthias Wachs
27 #include "plugin_ats_ril.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "ats-ril",__VA_ARGS__)
31 #define RIL_MIN_BW (5 * ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__))
32 #define RIL_MAX_BW GNUNET_ATS_MaxBandwidth
34 #define RIL_ACTION_INVALID -1
35 #define RIL_INTERVAL_EXPONENT 10
36 #define RIL_UTILITY_DELAY_MAX 1000
38 #define RIL_DEFAULT_STEP_TIME_MIN GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 200)
39 #define RIL_DEFAULT_STEP_TIME_MAX GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 2000)
40 #define RIL_DEFAULT_ALGORITHM RIL_ALGO_SARSA
41 #define RIL_DEFAULT_SELECT RIL_SELECT_SOFTMAX
42 #define RIL_DEFAULT_WELFARE RIL_WELFARE_NASH
43 #define RIL_DEFAULT_DISCOUNT_BETA 0.6
44 #define RIL_DEFAULT_DISCOUNT_GAMMA 0.5
45 #define RIL_DEFAULT_GRADIENT_STEP_SIZE 0.01
46 #define RIL_DEFAULT_TRACE_DECAY 0.5
47 #define RIL_DEFAULT_EXPLORE_RATIO 1
48 #define RIL_DEFAULT_EXPLORE_DECAY 0.95
49 #define RIL_DEFAULT_RBF_DIVISOR 50
50 #define RIL_DEFAULT_TEMPERATURE 0.1
51 #define RIL_DEFAULT_TEMPERATURE_DECAY 1
53 #define RIL_INC_DEC_STEP_SIZE 1
54 #define RIL_NOP_DECAY 0.5
57 * ATS reinforcement learning solver
63 * The actions, how an agent can manipulate the current assignment. I.e. how the bandwidth can be
64 * changed for the currently chosen address. Not depicted in the enum are the actions of switching
65 * to a particular address. The action of switching to address with index i is depicted by the
66 * number (RIL_ACTION_TYPE_NUM + i).
70 RIL_ACTION_NOTHING = 0,
71 RIL_ACTION_BW_IN_DBL = -2, //TODO? Potentially add more actions
72 RIL_ACTION_BW_IN_HLV = -3,
73 RIL_ACTION_BW_IN_INC = 1,
74 RIL_ACTION_BW_IN_DEC = 2,
75 RIL_ACTION_BW_OUT_DBL = -4,
76 RIL_ACTION_BW_OUT_HLV = -5,
77 RIL_ACTION_BW_OUT_INC = 3,
78 RIL_ACTION_BW_OUT_DEC = 4,
79 RIL_ACTION_TYPE_NUM = 5
90 RIL_SELECT_SOFTMAX = 0,
91 RIL_SELECT_EGREEDY = 1
97 RIL_WELFARE_EGALITARIAN
100 enum RIL_E_Modification
109 * Global learning parameters
111 struct RIL_Learning_Parameters
114 * The TD-algorithm to use
116 enum RIL_Algorithm algorithm;
119 * Gradient-descent step-size
124 * Learning discount variable in the TD-update for semi-MDPs
129 * Learning discount factor in the TD-update for MDPs
134 * Trace-decay factor for eligibility traces
139 * Whether to accumulate or replace eligibility traces
141 enum RIL_E_Modification eligibility_trace_mode;
144 * Initial softmax action-selection temperature
146 double temperature_init;
149 * Softmax action-selection temperature
154 * Decay factor of the temperature value
156 double temperature_decay;
159 * Which measure of social welfare should be used
161 enum RIL_Welfare social_welfare;
164 * State space divisor
166 unsigned long long rbf_divisor;
169 * Action selection strategy;
171 enum RIL_Select select;
174 * Initial exploration ratio value
179 * Ratio, with what probability an agent should explore in the e-greed policy
184 * Decay factor of the explore ratio
186 double epsilon_decay;
189 * Minimal interval time between steps in milliseconds
191 struct GNUNET_TIME_Relative step_time_min;
194 * Maximum interval time between steps in milliseconds
196 struct GNUNET_TIME_Relative step_time_max;
200 * Wrapper for addresses to store them in agent's linked list
202 struct RIL_Address_Wrapped
207 struct RIL_Address_Wrapped *next;
212 struct RIL_Address_Wrapped *prev;
217 struct ATS_Address *address_naked;
220 struct RIL_Peer_Agent
223 * Next agent in solver's linked list
225 struct RIL_Peer_Agent *next;
228 * Previous agent in solver's linked list
230 struct RIL_Peer_Agent *prev;
235 struct GAS_RIL_Handle *envi;
240 struct GNUNET_PeerIdentity peer;
243 * Whether the agent is active or not
248 * Number of performed time-steps
250 unsigned long long step_count;
253 * Experience matrix W
258 * Number of rows of W / Number of state-vector features
263 * Number of columns of W / Number of actions
268 * Last perceived state feature vector
283 * Whether to reset the eligibility traces to 0 after a Q-exploration step
285 int eligibility_reset;
290 struct ATS_Address * address_inuse;
293 * Head of addresses DLL
295 struct RIL_Address_Wrapped * addresses_head;
298 * Tail of addresses DLL
300 struct RIL_Address_Wrapped * addresses_tail;
303 * Inbound bandwidth assigned by the agent
305 unsigned long long bw_in;
308 * Outbound bandwidth assigned by the agent
310 unsigned long long bw_out;
313 * Flag whether a suggestion has to be issued
315 int suggestion_issue;
318 * The address which has to be issued
320 struct ATS_Address * suggestion_address;
323 * The agent's last objective value
325 double objective_old;
338 enum GNUNET_ATS_Network_Type type;
341 * Total available inbound bandwidth
343 unsigned long long bw_in_available;
346 * Bandwidth inbound assigned in network after last step
348 unsigned long long bw_in_assigned;
351 * Bandwidth inbound actually utilized in the network
353 unsigned long long bw_in_utilized;
356 * Total available outbound bandwidth
358 unsigned long long bw_out_available;
361 * Bandwidth outbound assigned in network after last step
363 unsigned long long bw_out_assigned;
366 * Bandwidth outbound actually utilized in the network
368 unsigned long long bw_out_utilized;
371 * Number of active agents in scope
373 unsigned int active_agent_count;
376 * The social welfare achieved in the scope
378 double social_welfare;
382 * A handle for the reinforcement learning solver
384 struct GAS_RIL_Handle
387 * The solver-plugin environment of the solver-plugin API
389 struct GNUNET_ATS_PluginEnvironment *plugin_envi;
394 struct GNUNET_STATISTICS_Handle *stats;
397 * Number of performed steps
399 unsigned long long step_count;
402 * Timestamp for the last time-step
404 struct GNUNET_TIME_Absolute step_time_last;
407 * Task identifier of the next time-step to be executed
409 GNUNET_SCHEDULER_TaskIdentifier step_next_task_id;
412 * Variable discount factor, dependent on time between steps
414 double global_discount_variable;
417 * Integrated variable discount factor, dependent on time between steps
419 double global_discount_integrated;
422 * Lock for bulk operations
427 * Number of changes during a lock
432 * Learning parameters
434 struct RIL_Learning_Parameters parameters;
437 * Array of networks with global assignment state
439 struct RIL_Scope * network_entries;
444 unsigned int networks_count;
447 * List of active peer-agents
449 struct RIL_Peer_Agent * agents_head;
450 struct RIL_Peer_Agent * agents_tail;
458 * Simulate steps, i.e. schedule steps immediately
460 unsigned long long simulate;
464 * "Private" functions
465 * ---------------------------
469 * Estimate the current action-value for state s and action a
471 * @param agent agent performing the estimation
474 * @return estimation value
477 agent_q (struct RIL_Peer_Agent *agent, double *state, int action)
482 for (i = 0; i < agent->m; i++)
484 result += state[i] * agent->W[action][i];
487 GNUNET_assert(!isnan(result));
489 //prevent crash when learning diverges
492 return isinf(result) * UINT32_MAX;
499 * Get the index of the address in the agent's list.
501 * @param agent agent handle
502 * @param address address handle
503 * @return the index, starting with zero
506 agent_address_get_index (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
509 struct RIL_Address_Wrapped *cur;
512 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
515 if (cur->address_naked == address)
523 * Gets the wrapped address from the agent's list
525 * @param agent agent handle
526 * @param address address handle
527 * @return wrapped address
529 static struct RIL_Address_Wrapped *
530 agent_address_get_wrapped (struct RIL_Peer_Agent *agent, struct ATS_Address *address)
532 struct RIL_Address_Wrapped *cur;
534 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
535 if (cur->address_naked == address)
542 agent_action_is_possible (struct RIL_Peer_Agent *agent, int action)
548 case RIL_ACTION_NOTHING:
551 case RIL_ACTION_BW_IN_INC:
552 case RIL_ACTION_BW_IN_DBL:
553 if (agent->bw_in >= RIL_MAX_BW)
558 case RIL_ACTION_BW_IN_DEC:
559 case RIL_ACTION_BW_IN_HLV:
560 if (agent->bw_in <= 0)
565 case RIL_ACTION_BW_OUT_INC:
566 case RIL_ACTION_BW_OUT_DBL:
567 if (agent->bw_out >= RIL_MAX_BW)
572 case RIL_ACTION_BW_OUT_DEC:
573 case RIL_ACTION_BW_OUT_HLV:
574 if (agent->bw_out <= 0)
580 if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
582 address_index = action - RIL_ACTION_TYPE_NUM;
584 GNUNET_assert(address_index >= 0);
586 address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
588 if ((agent_address_get_index(agent, agent->address_inuse) == address_index) ||
589 agent->address_inuse->active)
595 // error - action does not exist
596 GNUNET_assert(GNUNET_NO);
602 * Gets the action, with the maximal estimated Q-value (i.e. the one currently estimated to bring the
603 * most reward in the future)
605 * @param agent agent performing the calculation
606 * @param state the state from which to take the action
607 * @return the action promising most future reward
610 agent_get_action_max (struct RIL_Peer_Agent *agent, double *state)
613 int max_i = RIL_ACTION_INVALID;
615 double max_q = -DBL_MAX;
617 for (i = 0; i < agent->n; i++)
619 if (agent_action_is_possible(agent, i))
621 cur_q = agent_q (agent, state, i);
630 GNUNET_assert(RIL_ACTION_INVALID != max_i);
636 * Chooses a random action from the set of possible ones
638 * @param agent the agent performing the action
639 * @return the action index
642 agent_get_action_random (struct RIL_Peer_Agent *agent)
645 int is_possible[agent->n];
649 for (i = 0; i<agent->n; i++)
651 if (agent_action_is_possible(agent, i))
653 is_possible[i] = GNUNET_YES;
658 is_possible[i] = GNUNET_NO;
662 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, sum);
665 for (i = 0; i<agent->n; i++)
675 GNUNET_assert(GNUNET_NO);
676 return RIL_ACTION_INVALID;
681 * Updates the weights (i.e. coefficients) of the weight vector in matrix W for action a
683 * @param agent the agent performing the update
684 * @param reward the reward received for the last action
685 * @param s_next the new state, the last step got the agent into
686 * @param a_prime the new
689 agent_update (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a_prime)
694 double **theta = agent->W;
696 delta = agent->envi->global_discount_integrated * reward; //reward
697 delta += agent->envi->global_discount_variable * agent_q (agent, s_next, a_prime); //discounted future value
698 delta -= agent_q (agent, agent->s_old, agent->a_old); //one step
700 // LOG(GNUNET_ERROR_TYPE_INFO, "update() Step# %llu Q(s,a): %f a: %f r: %f y: %f Q(s+1,a+1) = %f delta: %f\n",
701 // agent->step_count,
702 // agent_q (agent, agent->s_old, agent->a_old),
703 // agent->envi->parameters.alpha,
705 // agent->envi->global_discount_variable,
706 // agent_q (agent, s_next, a_prime),
709 for (k = 0; k < agent->n; k++)
711 for (i = 0; i < agent->m; i++)
713 // LOG(GNUNET_ERROR_TYPE_INFO, "alpha = %f delta = %f e[%d] = %f\n",
714 // agent->envi->parameters.alpha,
718 theta[k][i] += agent->envi->parameters.alpha * delta * agent->E[k][i];
725 * Changes the eligibility trace vector e in various manners:
726 * #RIL_E_ACCUMULATE - adds @a feature to each component as in accumulating eligibility traces
727 * #RIL_E_REPLACE - resets each component to @a feature as in replacing traces
728 * #RIL_E_DECAY - multiplies e with discount factor and lambda as in the update rule
729 * #RIL_E_ZERO - sets e to 0 as in Watkin's Q-learning algorithm when exploring and when initializing
731 * @param agent the agent handle
732 * @param mod the kind of modification
733 * @param feature the feature vector
736 agent_modify_eligibility (struct RIL_Peer_Agent *agent,
737 enum RIL_E_Modification mod,
744 for (i = 0; i < agent->m; i++)
748 case RIL_E_ACCUMULATE:
749 agent->E[action][i] += feature[i];
752 agent->E[action][i] = agent->E[action][i] > feature[i] ? agent->E[action][i] : feature[i];
755 for (k = 0; k < agent->n; k++)
757 agent->E[k][i] *= agent->envi->global_discount_variable * agent->envi->parameters.lambda;
761 for (k = 0; k < agent->n; k++)
771 * Informs the environment about the status of the solver
778 ril_inform (struct GAS_RIL_Handle *solver,
779 enum GAS_Solver_Operation op,
780 enum GAS_Solver_Status stat)
782 if (NULL != solver->plugin_envi->info_cb)
783 solver->plugin_envi->info_cb (solver->plugin_envi->info_cb_cls, op, stat, GAS_INFO_NONE);
787 * Calculates the maximum bandwidth an agent can assign in a network scope
791 static unsigned long long
792 ril_get_max_bw (struct RIL_Scope *net)
794 return GNUNET_MIN(2 * GNUNET_MAX(net->bw_in_available, net->bw_out_available), GNUNET_ATS_MaxBandwidth);
798 * Changes the active assignment suggestion of the handler and invokes the bw_changed callback to
799 * notify ATS of its new decision
801 * @param solver solver handle
802 * @param agent agent handle
803 * @param new_address the address which is to be used
804 * @param new_bw_in the new amount of inbound bandwidth set for this address
805 * @param new_bw_out the new amount of outbound bandwidth set for this address
806 * @param silent disables invocation of the bw_changed callback, if GNUNET_YES
809 envi_set_active_suggestion (struct GAS_RIL_Handle *solver,
810 struct RIL_Peer_Agent *agent,
811 struct ATS_Address *new_address,
812 unsigned long long new_bw_in,
813 unsigned long long new_bw_out,
816 int notify = GNUNET_NO;
818 LOG(GNUNET_ERROR_TYPE_DEBUG, " set_active_suggestion() for peer '%s'\n", GNUNET_i2s (&agent->peer));
821 if (agent->address_inuse != new_address)
823 if (NULL != agent->address_inuse)
825 agent->address_inuse->active = GNUNET_NO;
826 agent->address_inuse->assigned_bw_in.value__ = htonl (0);
827 agent->address_inuse->assigned_bw_out.value__ = htonl (0);
829 if (NULL != new_address)
831 LOG(GNUNET_ERROR_TYPE_DEBUG, " set address active: %s\n", agent->is_active ? "yes" : "no");
832 new_address->active = agent->is_active;
833 new_address->assigned_bw_in.value__ = htonl (agent->bw_in);
834 new_address->assigned_bw_out.value__ = htonl (agent->bw_out);
836 notify |= GNUNET_YES;
842 if (new_address->active != agent->is_active)
844 new_address->active = agent->is_active;
845 notify |= GNUNET_YES;
849 if (agent->bw_in != new_bw_in)
851 agent->bw_in = new_bw_in;
852 new_address->assigned_bw_in.value__ = htonl (new_bw_in);
853 notify |= GNUNET_YES;
855 if (agent->bw_out != new_bw_out)
857 agent->bw_out = new_bw_out;
858 new_address->assigned_bw_out.value__ = htonl (new_bw_out);
859 notify |= GNUNET_YES;
863 if (notify && agent->is_active && (GNUNET_NO == silent))
867 LOG(GNUNET_ERROR_TYPE_DEBUG, " envi_set_active_suggestion() notify\n");
868 agent->suggestion_issue = GNUNET_YES;
869 agent->suggestion_address = new_address;
871 else if (agent->address_inuse)
873 //disconnect case, no new address
874 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_in.value__));
875 GNUNET_assert(0 == ntohl (agent->address_inuse->assigned_bw_out.value__));
879 agent->suggestion_issue = GNUNET_YES;
880 agent->suggestion_address = agent->address_inuse;
883 agent->address_inuse = new_address;
888 * Allocates a state vector and fills it with the features present
889 * @param solver the solver handle
890 * @param agent the agent handle
891 * @return pointer to the state vector
894 envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
905 unsigned long long max_bw;
907 state = GNUNET_malloc (sizeof(double) * agent->m);
909 max_bw = ril_get_max_bw((struct RIL_Scope *) agent->address_inuse->solver_information);
911 y[0] = (double) agent->bw_out;
912 y[1] = (double) agent->bw_in;
914 m = agent_address_get_index (agent, agent->address_inuse) * (solver->parameters.rbf_divisor+1) * (solver->parameters.rbf_divisor+1);
915 for (i = 0; i <= solver->parameters.rbf_divisor; i++)
917 for (k = 0; k <= solver->parameters.rbf_divisor; k++)
919 x[0] = (double) i * (double) max_bw / (double) solver->parameters.rbf_divisor;
920 x[1] = (double) k * (double) max_bw / (double) solver->parameters.rbf_divisor;
923 sigma = (((double) max_bw / ((double) solver->parameters.rbf_divisor + 1)) * 0.5);
924 f = exp(-((d[0]*d[0] + d[1]*d[1]) / (2 * sigma * sigma)));
933 * Retrieves an ATS information value of an address
935 * @param address the address in question
936 * @param type the ATS information type
940 ril_get_atsi (struct ATS_Address *address, uint32_t type)
943 GNUNET_assert(NULL != address);
945 if ((NULL == address->atsi) || (0 == address->atsi_count))
946 return GNUNET_ATS_QUALITY_NET_DELAY == type ? UINT32_MAX : 1;
948 for (c1 = 0; c1 < address->atsi_count; c1++)
950 if (ntohl (address->atsi[c1].type) == type)
951 return ntohl (address->atsi[c1].value);
953 return GNUNET_ATS_QUALITY_NET_DELAY == type ? UINT32_MAX : 1;
957 * Returns the utility value of the connection an agent manages
959 * @param agent the agent in question
960 * @return the utility value
963 agent_get_utility (struct RIL_Peer_Agent *agent)
965 const double *preferences;
970 preferences = agent->envi->plugin_envi->get_preferences (agent->envi->plugin_envi->get_preference_cls,
973 delay_atsi = (double) ril_get_atsi (agent->address_inuse, GNUNET_ATS_QUALITY_NET_DELAY);
974 delay_norm = RIL_UTILITY_DELAY_MAX*exp(-delay_atsi*0.00001);
976 pref_match = preferences[GNUNET_ATS_PREFERENCE_LATENCY] * delay_norm;
977 pref_match += preferences[GNUNET_ATS_PREFERENCE_BANDWIDTH] *
978 sqrt((double) (agent->bw_in/RIL_MIN_BW) * (double) (agent->bw_out/RIL_MIN_BW));
979 // sqrt((double) (ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_IN)/RIL_MIN_BW) * (double) (ril_get_atsi (agent->address_inuse, GNUNET_ATS_UTILIZATION_OUT)/RIL_MIN_BW));
981 // return (double) (agent->bw_in/RIL_MIN_BW);
982 // return sqrt((double) (agent->bw_in/RIL_MIN_BW) * (double) (agent->bw_out/RIL_MIN_BW));
987 * Calculates the social welfare within a network scope according to what social
988 * welfare measure is set in the configuration.
990 * @param solver the solver handle
991 * @param scope the network scope in question
992 * @return the social welfare value
995 ril_network_get_social_welfare (struct GAS_RIL_Handle *solver, struct RIL_Scope *scope)
997 struct RIL_Peer_Agent *cur;
1000 switch (solver->parameters.social_welfare)
1002 case RIL_WELFARE_EGALITARIAN:
1004 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1006 if (cur->is_active && cur->address_inuse && (cur->address_inuse->solver_information == scope))
1008 result = GNUNET_MIN(result, agent_get_utility(cur));
1013 case RIL_WELFARE_NASH:
1015 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1017 if (cur->is_active && cur->address_inuse && (cur->address_inuse->solver_information == scope))
1019 result *= pow(agent_get_utility(cur), 1.0 / (double) scope->active_agent_count);
1024 GNUNET_assert(GNUNET_NO);
1029 envi_get_penalty (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1031 struct RIL_Scope *net;
1032 unsigned long long over_max;
1033 unsigned long long over_in = 0;
1034 unsigned long long over_out = 0;
1036 net = agent->address_inuse->solver_information;
1038 if (net->bw_in_utilized > net->bw_in_available)
1040 over_in = net->bw_in_utilized - net->bw_in_available;
1041 if (RIL_ACTION_BW_IN_INC == agent->a_old)
1046 if (net->bw_out_utilized > net->bw_out_available)
1048 over_out = net->bw_out_utilized - net->bw_out_available;
1049 if (RIL_ACTION_BW_OUT_INC == agent->a_old)
1054 over_max = (over_in + over_out) / RIL_MIN_BW;
1056 return -1.0 * (double) over_max;
1060 * Gets the reward for the last performed step, which is calculated in equal
1061 * parts from the local (the peer specific) and the global (for all peers
1062 * identical) reward.
1064 * @param solver the solver handle
1065 * @param agent the agent handle
1066 * @return the reward
1069 envi_get_reward (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
1071 struct RIL_Scope *net;
1078 net = agent->address_inuse->solver_information;
1080 penalty = envi_get_penalty(solver, agent);
1081 objective = (agent_get_utility (agent) + net->social_welfare) / 2;
1082 delta = objective - agent->objective_old;
1083 agent->objective_old = objective;
1085 if (delta != 0 && penalty == 0)
1087 agent->nop_bonus = delta * RIL_NOP_DECAY;
1091 agent->nop_bonus *= RIL_NOP_DECAY;
1094 steady = (RIL_ACTION_NOTHING == agent->a_old) ? agent->nop_bonus : 0;
1096 reward = delta + steady;
1097 return reward + penalty;
1101 * Doubles the bandwidth for the active address
1103 * @param solver solver handle
1104 * @param agent agent handle
1105 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise the outbound bandwidth
1108 envi_action_bw_double (struct GAS_RIL_Handle *solver,
1109 struct RIL_Peer_Agent *agent,
1112 unsigned long long new_bw;
1113 unsigned long long max_bw;
1115 max_bw = ril_get_max_bw((struct RIL_Scope *) agent->address_inuse->solver_information);
1119 new_bw = agent->bw_in * 2;
1120 if (new_bw < agent->bw_in || new_bw > max_bw)
1122 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
1123 agent->bw_out, GNUNET_NO);
1127 new_bw = agent->bw_out * 2;
1128 if (new_bw < agent->bw_out || new_bw > max_bw)
1130 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
1136 * Cuts the bandwidth for the active address in half. The least amount of bandwidth suggested, is
1137 * the minimum bandwidth for a peer, in order to not invoke a disconnect.
1139 * @param solver solver handle
1140 * @param agent agent handle
1141 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1145 envi_action_bw_halven (struct GAS_RIL_Handle *solver,
1146 struct RIL_Peer_Agent *agent,
1149 unsigned long long new_bw;
1153 new_bw = agent->bw_in / 2;
1154 if (new_bw <= 0 || new_bw > agent->bw_in)
1156 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
1161 new_bw = agent->bw_out / 2;
1162 if (new_bw <= 0 || new_bw > agent->bw_out)
1164 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1170 * Increases the bandwidth by 5 times the minimum bandwidth for the active address.
1172 * @param solver solver handle
1173 * @param agent agent handle
1174 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1178 envi_action_bw_inc (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
1180 unsigned long long new_bw;
1181 unsigned long long max_bw;
1183 max_bw = ril_get_max_bw((struct RIL_Scope *) agent->address_inuse->solver_information);
1187 new_bw = agent->bw_in + (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1188 if (new_bw < agent->bw_in || new_bw > max_bw)
1190 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw,
1191 agent->bw_out, GNUNET_NO);
1195 new_bw = agent->bw_out + (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1196 if (new_bw < agent->bw_out || new_bw > max_bw)
1198 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in,
1204 * Decreases the bandwidth by 5 times the minimum bandwidth for the active address. The least amount
1205 * of bandwidth suggested, is the minimum bandwidth for a peer, in order to not invoke a disconnect.
1207 * @param solver solver handle
1208 * @param agent agent handle
1209 * @param direction_in if GNUNET_YES, change inbound bandwidth, otherwise change the outbound
1213 envi_action_bw_dec (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int direction_in)
1215 unsigned long long new_bw;
1219 new_bw = agent->bw_in - (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1220 if (new_bw <= 0 || new_bw > agent->bw_in)
1222 envi_set_active_suggestion (solver, agent, agent->address_inuse, new_bw, agent->bw_out,
1227 new_bw = agent->bw_out - (RIL_INC_DEC_STEP_SIZE * RIL_MIN_BW);
1228 if (new_bw <= 0 || new_bw > agent->bw_out)
1230 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, new_bw,
1236 * Switches to the address given by its index
1238 * @param solver solver handle
1239 * @param agent agent handle
1240 * @param address_index index of the address as it is saved in the agent's list, starting with zero
1243 envi_action_address_switch (struct GAS_RIL_Handle *solver,
1244 struct RIL_Peer_Agent *agent,
1245 unsigned int address_index)
1247 struct RIL_Address_Wrapped *cur;
1250 cur = agent_address_get_wrapped(agent, agent->address_inuse);
1252 for (cur = agent->addresses_head; NULL != cur; cur = cur->next)
1254 if (i == address_index)
1256 envi_set_active_suggestion (solver, agent, cur->address_naked, agent->bw_in, agent->bw_out,
1264 //no address with address_index exists, in this case this action should not be callable
1265 GNUNET_assert(GNUNET_NO);
1269 * Puts the action into effect by calling the according function
1271 * @param solver the solver handle
1272 * @param agent the action handle
1273 * @param action the action to perform by the solver
1276 envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action)
1282 case RIL_ACTION_NOTHING:
1284 case RIL_ACTION_BW_IN_DBL:
1285 envi_action_bw_double (solver, agent, GNUNET_YES);
1287 case RIL_ACTION_BW_IN_HLV:
1288 envi_action_bw_halven (solver, agent, GNUNET_YES);
1290 case RIL_ACTION_BW_IN_INC:
1291 envi_action_bw_inc (solver, agent, GNUNET_YES);
1293 case RIL_ACTION_BW_IN_DEC:
1294 envi_action_bw_dec (solver, agent, GNUNET_YES);
1296 case RIL_ACTION_BW_OUT_DBL:
1297 envi_action_bw_double (solver, agent, GNUNET_NO);
1299 case RIL_ACTION_BW_OUT_HLV:
1300 envi_action_bw_halven (solver, agent, GNUNET_NO);
1302 case RIL_ACTION_BW_OUT_INC:
1303 envi_action_bw_inc (solver, agent, GNUNET_NO);
1305 case RIL_ACTION_BW_OUT_DEC:
1306 envi_action_bw_dec (solver, agent, GNUNET_NO);
1309 if ((action >= RIL_ACTION_TYPE_NUM) && (action < agent->n)) //switch address action
1311 address_index = action - RIL_ACTION_TYPE_NUM;
1313 GNUNET_assert(address_index >= 0);
1315 address_index <= agent_address_get_index (agent, agent->addresses_tail->address_naked));
1317 envi_action_address_switch (solver, agent, address_index);
1320 // error - action does not exist
1321 GNUNET_assert(GNUNET_NO);
1326 * Selects the next action using the e-greedy strategy. I.e. with a probability
1327 * of (1-e) the action with the maximum expected return will be chosen
1328 * (=> exploitation) and with probability (e) a random action will be chosen.
1329 * In case the Q-learning rule is set, the function also resets the eligibility
1330 * traces in the exploration case (after Watkin's Q-learning).
1332 * @param agent the agent selecting an action
1333 * @param state the current state-feature vector
1334 * @return the action index
1337 agent_select_egreedy (struct RIL_Peer_Agent *agent, double *state)
1340 double r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1341 UINT32_MAX) / (double) UINT32_MAX;
1343 if (r < agent->envi->parameters.epsilon) //explore
1345 action = agent_get_action_random(agent);
1346 if (RIL_ALGO_Q == agent->envi->parameters.algorithm)
1348 agent->eligibility_reset = GNUNET_YES;
1350 agent->envi->parameters.epsilon *= agent->envi->parameters.epsilon_decay;
1355 action = agent_get_action_max(agent, state);
1361 * Selects the next action with a probability corresponding to its value. The
1362 * probability is calculated using a Boltzmann distribution with a temperature
1363 * value. The higher the temperature, the more are the action selection
1364 * probabilities the same. With a temperature of 0, the selection is greedy,
1365 * i.e. always the action with the highest value is chosen.
1371 agent_select_softmax (struct RIL_Peer_Agent *agent, double *state)
1375 double eqt[agent->n];
1380 a_max = agent_get_action_max(agent, state);
1382 for (i=0; i<agent->n; i++)
1384 if (agent_action_is_possible(agent, i))
1386 eqt[i] = exp(agent_q(agent,state,i) / agent->envi->parameters.temperature);
1390 for (i=0; i<agent->n; i++)
1392 if (agent_action_is_possible(agent, i))
1401 r = (double) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1402 UINT32_MAX) / (double) UINT32_MAX;
1404 for (i=0; i<agent->n; i++)
1410 if (RIL_ALGO_Q == agent->envi->parameters.algorithm)
1411 agent->eligibility_reset = GNUNET_YES;
1412 agent->envi->parameters.temperature *= agent->envi->parameters.temperature_decay;
1418 GNUNET_assert(GNUNET_NO);
1419 return RIL_ACTION_INVALID;
1423 * Select the next action of an agent either according to the e-greedy strategy
1424 * or the softmax strategy.
1426 * @param agent the agent in question
1427 * @param state the current state-feature vector
1428 * @return the action index
1431 agent_select_action (struct RIL_Peer_Agent *agent, double *state)
1433 if (agent->envi->parameters.select == RIL_SELECT_EGREEDY)
1435 return agent_select_egreedy(agent, state);
1439 return agent_select_softmax(agent, state);
1444 * Performs one step of the Markov Decision Process. Other than in the literature the step starts
1445 * after having done the last action a_old. It observes the new state s_next and the reward
1446 * received. Then the coefficient update is done according to the SARSA or Q-learning method. The
1447 * next action is put into effect.
1449 * @param agent the agent performing the step
1452 agent_step (struct RIL_Peer_Agent *agent)
1454 int a_next = RIL_ACTION_INVALID;
1459 LOG(GNUNET_ERROR_TYPE_DEBUG, " agent_step() Peer '%s', algorithm %s\n",
1460 GNUNET_i2s (&agent->peer),
1461 agent->envi->parameters.algorithm ? "Q" : "SARSA");
1463 s_next = envi_get_state (agent->envi, agent);
1464 reward = envi_get_reward (agent->envi, agent);
1466 if (agent->eligibility_reset)
1468 agent_modify_eligibility(agent, RIL_E_ZERO, NULL, -1);
1469 agent->eligibility_reset = GNUNET_NO;
1473 agent_modify_eligibility (agent, RIL_E_DECAY, NULL, -1);
1475 if (RIL_ACTION_INVALID != agent->a_old)
1477 agent_modify_eligibility (agent, agent->envi->parameters.eligibility_trace_mode, agent->s_old, agent->a_old);
1480 switch (agent->envi->parameters.algorithm)
1482 case RIL_ALGO_SARSA:
1483 a_next = agent_select_action (agent, s_next);
1484 if (RIL_ACTION_INVALID != agent->a_old)
1486 //updates weights with selected action (on-policy), if not first step
1487 agent_update (agent, reward, s_next, a_next);
1492 a_max = agent_get_action_max (agent, s_next);
1493 if (RIL_ACTION_INVALID != agent->a_old)
1495 //updates weights with best action, disregarding actually selected action (off-policy), if not first step
1496 agent_update (agent, reward, s_next, a_max);
1498 a_next = agent_select_action (agent, s_next);
1502 GNUNET_assert(RIL_ACTION_INVALID != a_next);
1504 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "step() Step# %llu R: %f IN %llu OUT %llu A: %d\n",
1511 envi_do_action (agent->envi, agent, a_next);
1513 GNUNET_free(agent->s_old);
1514 agent->s_old = s_next;
1515 agent->a_old = a_next;
1517 agent->step_count += 1;
1521 * Prototype of the ril_step() procedure
1523 * @param solver the solver handle
1526 ril_step (struct GAS_RIL_Handle *solver);
1529 * Task for the scheduler, which performs one step and lets the solver know that
1530 * no further step is scheduled.
1532 * @param cls the solver handle
1533 * @param tc the task context for the scheduler
1536 ril_step_scheduler_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1538 struct GAS_RIL_Handle *solver = cls;
1540 solver->step_next_task_id = GNUNET_SCHEDULER_NO_TASK;
1545 * Determines how much of the available bandwidth is assigned. If more is
1546 * assigned than available it returns 1. The function is used to determine the
1547 * step size of the adaptive stepping.
1549 * @param solver the solver handle
1553 ril_get_used_resource_ratio (struct GAS_RIL_Handle *solver)
1556 struct RIL_Scope net;
1557 unsigned long long sum_assigned = 0;
1558 unsigned long long sum_available = 0;
1561 for (i = 0; i < solver->networks_count; i++)
1563 net = solver->network_entries[i];
1564 if (net.bw_in_assigned > 0) //only consider scopes where an address is actually active
1566 sum_assigned += net.bw_in_utilized;
1567 sum_assigned += net.bw_out_utilized;
1568 sum_available += net.bw_in_available;
1569 sum_available += net.bw_out_available;
1572 if (sum_available > 0)
1574 ratio = ((double) sum_assigned) / ((double) sum_available);
1581 return ratio > 1 ? 1 : ratio; //overutilization is possible, cap at 1
1585 * Lookup network struct by type
1587 * @param s the solver handle
1588 * @param type the network type
1589 * @return the network struct
1591 static struct RIL_Scope *
1592 ril_get_network (struct GAS_RIL_Handle *s, uint32_t type)
1596 for (i = 0; i < s->networks_count; i++)
1598 if (s->network_entries[i].type == type)
1600 return &s->network_entries[i];
1607 * Determines whether more connections are allocated in a network scope, than
1608 * they would theoretically fit. This is used as a heuristic to determine,
1609 * whether a new connection can be allocated or not.
1611 * @param solver the solver handle
1612 * @param network the network scope in question
1613 * @return GNUNET_YES if there are theoretically enough resources left
1616 ril_network_is_not_full (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
1618 struct RIL_Scope *net;
1619 struct RIL_Peer_Agent *agent;
1620 unsigned long long address_count = 0;
1622 for (agent = solver->agents_head; NULL != agent; agent = agent->next)
1624 if (agent->address_inuse && agent->is_active)
1626 net = agent->address_inuse->solver_information;
1627 if (net->type == network)
1634 net = ril_get_network (solver, network);
1635 return (net->bw_in_available > RIL_MIN_BW * address_count) && (net->bw_out_available > RIL_MIN_BW * address_count);
1639 * Unblocks an agent for which a connection request is there, that could not
1640 * be satisfied. Iterates over the addresses of the agent, if one of its
1641 * addresses can now be allocated in its scope the agent is unblocked,
1642 * otherwise it remains unchanged.
1644 * @param solver the solver handle
1645 * @param agent the agent in question
1649 ril_try_unblock_agent (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int silent)
1651 struct RIL_Address_Wrapped *addr_wrap;
1652 struct RIL_Scope *net;
1653 unsigned long long start_in;
1654 unsigned long long start_out;
1656 for (addr_wrap = agent->addresses_head; NULL != addr_wrap; addr_wrap = addr_wrap->next)
1658 net = addr_wrap->address_naked->solver_information;
1659 if (ril_network_is_not_full(solver, net->type))
1661 if (NULL == agent->address_inuse)
1663 start_in = net->bw_in_available < net->bw_in_utilized ? (net->bw_in_available - net->bw_in_utilized) / 2 : RIL_MIN_BW;
1664 start_out = net->bw_out_available < net->bw_out_utilized ? (net->bw_out_available - net->bw_out_utilized) / 2 : RIL_MIN_BW;
1665 envi_set_active_suggestion (solver, agent, addr_wrap->address_naked, start_in, start_out, silent);
1670 agent->address_inuse = NULL;
1674 * Determines how much the reward needs to be discounted depending on the amount
1675 * of time, which has passed since the last time-step.
1677 * @param solver the solver handle
1680 ril_calculate_discount (struct GAS_RIL_Handle *solver)
1682 struct GNUNET_TIME_Absolute time_now;
1683 struct GNUNET_TIME_Relative time_delta;
1686 // MDP case only for debugging purposes
1687 if (solver->simulate)
1689 solver->global_discount_variable = solver->parameters.gamma;
1690 solver->global_discount_integrated = 1;
1696 //calculate tau, i.e. how many real valued time units have passed, one time unit is one minimum time step
1697 time_now = GNUNET_TIME_absolute_get ();
1698 time_delta = GNUNET_TIME_absolute_get_difference (solver->step_time_last, time_now);
1699 solver->step_time_last = time_now;
1700 tau = (double) time_delta.rel_value_us
1701 / (double) solver->parameters.step_time_min.rel_value_us;
1703 //calculate reward discounts (once per step for all agents)
1704 solver->global_discount_variable = pow (M_E, ((-1.0) * ((double) solver->parameters.beta) * tau));
1705 solver->global_discount_integrated = (1.0 - solver->global_discount_variable)
1706 / (double) solver->parameters.beta;
1710 * Count the number of active agents/connections in a network scope
1712 * @param solver the solver handle
1713 * @param scope the network scope in question
1714 * @return the number of allocated connections
1717 ril_network_count_active_agents (struct GAS_RIL_Handle *solver, struct RIL_Scope *scope)
1720 struct RIL_Peer_Agent *cur_agent;
1722 for (cur_agent = solver->agents_head; NULL != cur_agent; cur_agent = cur_agent->next)
1724 if (cur_agent->is_active && cur_agent->address_inuse && (cur_agent->address_inuse->solver_information == scope))
1733 * Calculates how much bandwidth is assigned in sum in a network scope, either
1734 * in the inbound or in the outbound direction.
1736 * @param solver the solver handle
1737 * @param type the type of the network scope in question
1738 * @param direction_in GNUNET_YES if the inbound direction should be summed up,
1739 * otherwise the outbound direction will be summed up
1740 * @return the sum of the assigned bandwidths
1742 static unsigned long long
1743 ril_network_get_assigned (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type type, int direction_in)
1745 struct RIL_Peer_Agent *cur;
1746 struct RIL_Scope *net;
1747 unsigned long long sum = 0;
1749 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1751 if (cur->is_active && cur->address_inuse)
1753 net = cur->address_inuse->solver_information;
1754 if (net->type == type)
1768 * Calculates how much bandwidth is actually utilized in sum in a network scope,
1769 * either in the inbound or in the outbound direction.
1771 * @param solver the solver handle
1772 * @param type the type of the network scope in question
1773 * @param direction_in GNUNET_YES if the inbound direction should be summed up,
1774 * otherwise the outbound direction will be summed up
1775 * @return the sum of the utilized bandwidths (in bytes/second)
1777 static unsigned long long
1778 ril_network_get_utilized (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type type, int direction_in)
1780 struct RIL_Peer_Agent *cur;
1781 struct RIL_Scope *net;
1782 unsigned long long sum = 0;
1784 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1786 if (cur->is_active && cur->address_inuse)
1788 net = cur->address_inuse->solver_information;
1789 if (net->type == type)
1792 sum += ril_get_atsi (cur->address_inuse, GNUNET_ATS_UTILIZATION_IN);
1794 sum += ril_get_atsi (cur->address_inuse, GNUNET_ATS_UTILIZATION_OUT);
1803 * Retrieves the state of the network scope, so that its attributes are up-to-
1806 * @param solver the solver handle
1809 ril_networks_update_state (struct GAS_RIL_Handle *solver)
1812 struct RIL_Scope *net;
1814 for (c = 0; c < solver->networks_count; c++)
1816 net = &solver->network_entries[c];
1817 net->bw_in_assigned = ril_network_get_assigned(solver, net->type, GNUNET_YES);
1818 net->bw_in_utilized = ril_network_get_utilized(solver, net->type, GNUNET_YES);
1819 net->bw_out_assigned = ril_network_get_assigned(solver, net->type, GNUNET_NO);
1820 net->bw_out_utilized = ril_network_get_utilized(solver, net->type, GNUNET_NO);
1821 net->active_agent_count = ril_network_count_active_agents(solver, net);
1822 net->social_welfare = ril_network_get_social_welfare(solver, net);
1827 * Schedules the next global step in an adaptive way. The more resources are
1828 * left, the earlier the next step is scheduled. This serves the reactivity of
1829 * the solver to changed inputs.
1831 * @param solver the solver handle
1834 ril_step_schedule_next (struct GAS_RIL_Handle *solver)
1840 struct GNUNET_TIME_Relative time_next;
1842 used_ratio = ril_get_used_resource_ratio (solver);
1845 solver->parameters.step_time_min.rel_value_us
1846 <= solver->parameters.step_time_max.rel_value_us);
1848 factor = (double) GNUNET_TIME_relative_subtract (solver->parameters.step_time_max,
1849 solver->parameters.step_time_min).rel_value_us;
1850 offset = (double) solver->parameters.step_time_min.rel_value_us;
1851 y = factor * pow (used_ratio, RIL_INTERVAL_EXPONENT) + offset;
1853 GNUNET_assert(y <= (double) solver->parameters.step_time_max.rel_value_us);
1854 GNUNET_assert(y >= (double) solver->parameters.step_time_min.rel_value_us);
1856 time_next = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, (unsigned long long) y);
1858 // LOG (GNUNET_ERROR_TYPE_INFO, "ratio: %f, factor: %f, offset: %f, y: %f\n",
1864 if (solver->simulate)
1866 time_next = GNUNET_TIME_UNIT_ZERO;
1869 if ((GNUNET_SCHEDULER_NO_TASK == solver->step_next_task_id) && (GNUNET_NO == solver->done))
1871 solver->step_next_task_id = GNUNET_SCHEDULER_add_delayed (time_next, &ril_step_scheduler_task,
1877 * Triggers one step per agent
1882 ril_step (struct GAS_RIL_Handle *solver)
1884 struct RIL_Peer_Agent *cur;
1886 if (GNUNET_YES == solver->bulk_lock)
1888 solver->bulk_changes++;
1892 ril_inform (solver, GAS_OP_SOLVE_START, GAS_STAT_SUCCESS);
1894 LOG(GNUNET_ERROR_TYPE_DEBUG, " RIL step number %d\n", solver->step_count);
1896 if (0 == solver->step_count)
1898 solver->step_time_last = GNUNET_TIME_absolute_get ();
1901 ril_calculate_discount (solver);
1902 ril_networks_update_state (solver);
1904 //trigger one step per active, unblocked agent
1905 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1909 if (NULL == cur->address_inuse)
1911 ril_try_unblock_agent(solver, cur, GNUNET_NO);
1913 if (cur->address_inuse)
1920 ril_networks_update_state (solver);
1922 solver->step_count += 1;
1923 ril_step_schedule_next (solver);
1925 ril_inform (solver, GAS_OP_SOLVE_STOP, GAS_STAT_SUCCESS);
1927 ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START, GAS_STAT_SUCCESS);
1928 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
1930 if (cur->suggestion_issue) {
1931 solver->plugin_envi->bandwidth_changed_cb(solver->plugin_envi->bw_changed_cb_cls, cur->suggestion_address);
1932 cur->suggestion_issue = GNUNET_NO;
1935 ril_inform (solver, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP, GAS_STAT_SUCCESS);
1939 * Initializes the matrix W of parameter vectors theta with small random numbers.
1941 * @param agent The respective agent
1944 agent_w_init (struct RIL_Peer_Agent *agent)
1949 for (i = 0; i < agent->n; i++)
1951 for (k = 0; k < agent->m; k++)
1953 agent->W[i][k] = agent->envi->parameters.alpha * (1.0 - 2.0 * ((double) GNUNET_CRYPTO_random_u32(GNUNET_CRYPTO_QUALITY_WEAK, UINT32_MAX)/(double) UINT32_MAX));
1959 * Initialize an agent without addresses and its knowledge base
1961 * @param s ril solver
1962 * @param peer the one in question
1963 * @return handle to the new agent
1965 static struct RIL_Peer_Agent *
1966 agent_init (void *s, const struct GNUNET_PeerIdentity *peer)
1969 struct GAS_RIL_Handle * solver = s;
1970 struct RIL_Peer_Agent * agent = GNUNET_new (struct RIL_Peer_Agent);
1972 agent->envi = solver;
1973 agent->peer = *peer;
1974 agent->step_count = 0;
1975 agent->is_active = GNUNET_NO;
1976 agent->bw_in = RIL_MIN_BW;
1977 agent->bw_out = RIL_MIN_BW;
1978 agent->suggestion_issue = GNUNET_NO;
1979 agent->n = RIL_ACTION_TYPE_NUM;
1981 agent->W = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1982 agent->E = (double **) GNUNET_malloc (sizeof (double *) * agent->n);
1983 for (i = 0; i < agent->n; i++)
1985 agent->W[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1986 agent->E[i] = (double *) GNUNET_malloc (sizeof (double) * agent->m);
1988 agent_w_init(agent);
1989 agent->eligibility_reset = GNUNET_NO;
1990 agent->a_old = RIL_ACTION_INVALID;
1991 agent->s_old = GNUNET_malloc (sizeof (double) * agent->m);
1992 agent->address_inuse = NULL;
1993 agent->objective_old = 0;
1994 agent->nop_bonus = 0;
2002 * @param solver the solver handle
2003 * @param agent the agent to retire
2006 agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent)
2010 for (i = 0; i < agent->n; i++)
2012 GNUNET_free_non_null(agent->W[i]);
2013 GNUNET_free_non_null(agent->E[i]);
2015 GNUNET_free_non_null(agent->W);
2016 GNUNET_free_non_null(agent->E);
2017 GNUNET_free_non_null(agent->s_old);
2022 * Returns the agent for a peer
2024 * @param solver the solver handle
2025 * @param peer the identity of the peer
2026 * @param create whether or not to create an agent, if none is allocated yet
2029 static struct RIL_Peer_Agent *
2030 ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create)
2032 struct RIL_Peer_Agent *cur;
2034 for (cur = solver->agents_head; NULL != cur; cur = cur->next)
2036 if (0 == memcmp (peer, &cur->peer, sizeof(struct GNUNET_PeerIdentity)))
2044 cur = agent_init (solver, peer);
2045 GNUNET_CONTAINER_DLL_insert_tail(solver->agents_head, solver->agents_tail, cur);
2052 * Determine whether at least the minimum bandwidth is set for the network. Otherwise the network is
2053 * considered inactive and not used. Addresses in an inactive network are ignored.
2055 * @param solver solver handle
2056 * @param network the network type
2057 * @return whether or not the network is considered active
2060 ril_network_is_active (struct GAS_RIL_Handle *solver, enum GNUNET_ATS_Network_Type network)
2062 struct RIL_Scope *net;
2064 net = ril_get_network (solver, network);
2065 return net->bw_out_available >= RIL_MIN_BW;
2069 * Cuts a slice out of a vector of elements. This is used to decrease the size of the matrix storing
2070 * the reward function approximation. It copies the memory, which is not cut, to the new vector,
2071 * frees the memory of the old vector, and redirects the pointer to the new one.
2073 * @param old pointer to the pointer to the first element of the vector
2074 * @param element_size byte size of the vector elements
2075 * @param hole_start the first element to cut out
2076 * @param hole_length the number of elements to cut out
2077 * @param old_length the length of the old vector
2080 ril_cut_from_vector (void **old,
2081 size_t element_size,
2082 unsigned int hole_start,
2083 unsigned int hole_length,
2084 unsigned int old_length)
2087 char *oldptr = (char *) *old;
2089 unsigned int bytes_before;
2090 unsigned int bytes_hole;
2091 unsigned int bytes_after;
2093 GNUNET_assert(old_length >= hole_length);
2094 GNUNET_assert(old_length >= (hole_start + hole_length));
2096 size = element_size * (old_length - hole_length);
2098 bytes_before = element_size * hole_start;
2099 bytes_hole = element_size * hole_length;
2100 bytes_after = element_size * (old_length - hole_start - hole_length);
2108 tmpptr = GNUNET_malloc (size);
2109 memcpy (tmpptr, oldptr, bytes_before);
2110 memcpy (tmpptr + bytes_before, oldptr + (bytes_before + bytes_hole), bytes_after);
2116 *old = (void *) tmpptr;
2120 * Solver API functions
2121 * ---------------------------
2125 * Change relative preference for quality in solver
2127 * @param solver the solver handle
2128 * @param peer the peer to change the preference for
2129 * @param kind the kind to change the preference
2130 * @param pref_rel the normalized preference value for this kind over all clients
2133 GAS_ril_address_change_preference (void *solver,
2134 const struct GNUNET_PeerIdentity *peer,
2135 enum GNUNET_ATS_PreferenceKind kind,
2138 LOG(GNUNET_ERROR_TYPE_DEBUG,
2139 "API_address_change_preference() Preference '%s' for peer '%s' changed to %.2f \n",
2140 GNUNET_ATS_print_preference_type (kind), GNUNET_i2s (peer), pref_rel);
2142 struct GAS_RIL_Handle *s = solver;
2144 s->parameters.temperature = s->parameters.temperature_init;
2145 s->parameters.epsilon = s->parameters.epsilon_init;
2150 * Entry point for the plugin
2152 * @param cls pointer to the 'struct GNUNET_ATS_PluginEnvironment'
2155 libgnunet_plugin_ats_ril_init (void *cls)
2157 struct GNUNET_ATS_PluginEnvironment *env = cls;
2158 struct GAS_RIL_Handle *solver = GNUNET_new (struct GAS_RIL_Handle);
2159 struct RIL_Scope * cur;
2163 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_init() Initializing RIL solver\n");
2165 GNUNET_assert(NULL != env);
2166 GNUNET_assert(NULL != env->cfg);
2167 GNUNET_assert(NULL != env->stats);
2168 GNUNET_assert(NULL != env->bandwidth_changed_cb);
2169 GNUNET_assert(NULL != env->get_preferences);
2170 GNUNET_assert(NULL != env->get_property);
2172 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(env->cfg, "ats", "RIL_RBF_DIVISOR", &solver->parameters.rbf_divisor))
2174 solver->parameters.rbf_divisor = RIL_DEFAULT_RBF_DIVISOR;
2178 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MIN",
2179 &solver->parameters.step_time_min))
2181 solver->parameters.step_time_min = RIL_DEFAULT_STEP_TIME_MIN;
2185 != GNUNET_CONFIGURATION_get_value_time (env->cfg, "ats", "RIL_STEP_TIME_MAX",
2186 &solver->parameters.step_time_max))
2188 solver->parameters.step_time_max = RIL_DEFAULT_STEP_TIME_MAX;
2191 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_ALGORITHM", &string))
2193 solver->parameters.algorithm = !strcmp (string, "SARSA") ? RIL_ALGO_SARSA : RIL_ALGO_Q;
2194 GNUNET_free (string);
2198 solver->parameters.algorithm = RIL_DEFAULT_ALGORITHM;
2201 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_SELECT", &string))
2203 solver->parameters.select = !strcmp (string, "EGREEDY") ? RIL_SELECT_EGREEDY : RIL_SELECT_SOFTMAX;
2204 GNUNET_free (string);
2208 solver->parameters.select = RIL_DEFAULT_SELECT;
2211 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_DISCOUNT_BETA", &string))
2213 solver->parameters.beta = strtod (string, NULL);
2214 GNUNET_free (string);
2215 if (!(solver->parameters.beta > 0))
2217 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_DISCOUNT_BETA not configured as positive number. Set to default value of %f instead.\n", RIL_DEFAULT_DISCOUNT_BETA);
2218 solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
2223 solver->parameters.beta = RIL_DEFAULT_DISCOUNT_BETA;
2226 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_DISCOUNT_GAMMA", &string))
2228 solver->parameters.gamma = strtod (string, NULL);
2229 GNUNET_free (string);
2230 if (!(solver->parameters.gamma < 1) || (solver->parameters.gamma < 0))
2232 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_DISCOUNT_GAMMA not configured in range [0,1[. Set to default value of %f instead.\n", RIL_DEFAULT_DISCOUNT_GAMMA);
2233 solver->parameters.gamma = RIL_DEFAULT_DISCOUNT_GAMMA;
2238 solver->parameters.gamma = RIL_DEFAULT_DISCOUNT_GAMMA;
2242 == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_GRADIENT_STEP_SIZE", &string))
2244 solver->parameters.alpha = strtod (string, NULL);
2245 GNUNET_free (string);
2246 if (!(solver->parameters.alpha > 0) || solver->parameters.alpha > 1)
2248 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_GRADIENT_STEP_SIZE not configured in range ]0,1]. Set to default value of %f instead.\n", RIL_DEFAULT_GRADIENT_STEP_SIZE);
2249 solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
2254 solver->parameters.alpha = RIL_DEFAULT_GRADIENT_STEP_SIZE;
2257 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TRACE_DECAY", &string))
2259 solver->parameters.lambda = strtod (string, NULL);
2260 GNUNET_free (string);
2261 if (solver->parameters.lambda < 0 || solver->parameters.lambda > 1)
2263 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_TRACE_DECAY not configured in range [0,1]. Set to default value of %f instead.\n", RIL_DEFAULT_TRACE_DECAY);
2264 solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
2269 solver->parameters.lambda = RIL_DEFAULT_TRACE_DECAY;
2272 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_EXPLORE_RATIO", &string))
2274 solver->parameters.epsilon_init = strtod (string, NULL);
2275 GNUNET_free (string);
2276 if (solver->parameters.epsilon_init < 0 || solver->parameters.epsilon_init > 1)
2278 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_EXPLORE_RATIO not configured in range [0,1]. Set to default value of %f instead.\n", RIL_DEFAULT_EXPLORE_RATIO);
2279 solver->parameters.epsilon_init = RIL_DEFAULT_EXPLORE_RATIO;
2284 solver->parameters.epsilon_init = RIL_DEFAULT_EXPLORE_RATIO;
2287 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_EXPLORE_DECAY", &string))
2289 solver->parameters.epsilon_decay = strtod (string, NULL);
2290 GNUNET_free (string);
2291 if (solver->parameters.epsilon_decay < 0 || solver->parameters.epsilon_decay > 1)
2293 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_EXPLORE_RATIO not configured in range [0,1]. Set to default value of %f instead.\n", RIL_DEFAULT_EXPLORE_DECAY);
2294 solver->parameters.epsilon_decay = RIL_DEFAULT_EXPLORE_DECAY;
2299 solver->parameters.epsilon_decay = RIL_DEFAULT_EXPLORE_DECAY;
2302 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TEMPERATURE", &string))
2304 solver->parameters.temperature_init = strtod (string, NULL);
2305 GNUNET_free (string);
2306 if (solver->parameters.temperature_init <= 0)
2308 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_TEMPERATURE not positive. Set to default value of %f instead.\n", RIL_DEFAULT_TEMPERATURE);
2309 solver->parameters.temperature_init = RIL_DEFAULT_TEMPERATURE;
2314 solver->parameters.temperature_init = RIL_DEFAULT_TEMPERATURE;
2317 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_TEMPERATURE_DECAY", &string))
2319 solver->parameters.temperature_decay = strtod (string, NULL);
2320 GNUNET_free (string);
2321 if (solver->parameters.temperature_decay <= 0 || solver->parameters.temperature_decay > 1)
2323 LOG (GNUNET_ERROR_TYPE_WARNING, "RIL_TEMPERATURE_DECAY not in range [0,1]. Set to default value of %f instead.\n", RIL_DEFAULT_TEMPERATURE_DECAY);
2324 solver->parameters.temperature_decay = RIL_DEFAULT_TEMPERATURE_DECAY;
2329 solver->parameters.temperature_decay = RIL_DEFAULT_TEMPERATURE_DECAY;
2332 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (env->cfg, "ats", "RIL_SIMULATE", &solver->simulate))
2334 solver->simulate = GNUNET_NO;
2337 if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno(env->cfg, "ats", "RIL_REPLACE_TRACES"))
2339 solver->parameters.eligibility_trace_mode = RIL_E_REPLACE;
2343 solver->parameters.eligibility_trace_mode = RIL_E_ACCUMULATE;
2346 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (env->cfg, "ats", "RIL_SOCIAL_WELFARE", &string))
2348 solver->parameters.social_welfare = !strcmp (string, "NASH") ? RIL_WELFARE_NASH : RIL_WELFARE_EGALITARIAN;
2349 GNUNET_free (string);
2353 solver->parameters.social_welfare = RIL_DEFAULT_WELFARE;
2356 env->sf.s_add = &GAS_ril_address_add;
2357 env->sf.s_address_update_property = &GAS_ril_address_property_changed;
2358 env->sf.s_address_update_session = &GAS_ril_address_session_changed;
2359 env->sf.s_address_update_inuse = &GAS_ril_address_inuse_changed;
2360 env->sf.s_address_update_network = &GAS_ril_address_change_network;
2361 env->sf.s_get = &GAS_ril_get_preferred_address;
2362 env->sf.s_get_stop = &GAS_ril_stop_get_preferred_address;
2363 env->sf.s_pref = &GAS_ril_address_change_preference;
2364 env->sf.s_feedback = &GAS_ril_address_preference_feedback;
2365 env->sf.s_del = &GAS_ril_address_delete;
2366 env->sf.s_bulk_start = &GAS_ril_bulk_start;
2367 env->sf.s_bulk_stop = &GAS_ril_bulk_stop;
2369 solver->plugin_envi = env;
2370 solver->networks_count = env->network_count;
2371 solver->network_entries = GNUNET_malloc (env->network_count * sizeof (struct RIL_Scope));
2372 solver->step_count = 0;
2373 solver->done = GNUNET_NO;
2375 for (c = 0; c < env->network_count; c++)
2377 cur = &solver->network_entries[c];
2378 cur->type = env->networks[c];
2379 cur->bw_in_available = env->in_quota[c];
2380 cur->bw_out_available = env->out_quota[c];
2381 LOG(GNUNET_ERROR_TYPE_DEBUG, "init() Quotas for %s network: IN %llu - OUT %llu\n", GNUNET_ATS_print_network_type(cur->type), cur->bw_in_available/1024, cur->bw_out_available/1024);
2384 LOG(GNUNET_ERROR_TYPE_DEBUG, "init() Parameters:\n");
2385 LOG(GNUNET_ERROR_TYPE_DEBUG, "init() Algorithm = %s, alpha = %f, beta = %f, lambda = %f\n",
2386 solver->parameters.algorithm ? "Q" : "SARSA",
2387 solver->parameters.alpha,
2388 solver->parameters.beta,
2389 solver->parameters.lambda);
2390 LOG(GNUNET_ERROR_TYPE_DEBUG, "init() exploration_ratio = %f, temperature = %f, ActionSelection = %s\n",
2391 solver->parameters.epsilon,
2392 solver->parameters.temperature,
2393 solver->parameters.select ? "EGREEDY" : "SOFTMAX");
2394 LOG(GNUNET_ERROR_TYPE_DEBUG, "init() RBF_DIVISOR = %llu\n",
2395 solver->parameters.rbf_divisor);
2401 * Exit point for the plugin
2403 * @param cls the solver handle
2406 libgnunet_plugin_ats_ril_done (void *cls)
2408 struct GAS_RIL_Handle *s = cls;
2409 struct RIL_Peer_Agent *cur_agent;
2410 struct RIL_Peer_Agent *next_agent;
2412 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_done() Shutting down RIL solver\n");
2414 s->done = GNUNET_YES;
2416 cur_agent = s->agents_head;
2417 while (NULL != cur_agent)
2419 next_agent = cur_agent->next;
2420 GNUNET_CONTAINER_DLL_remove(s->agents_head, s->agents_tail, cur_agent);
2421 agent_die (s, cur_agent);
2422 cur_agent = next_agent;
2425 if (GNUNET_SCHEDULER_NO_TASK != s->step_next_task_id)
2427 GNUNET_SCHEDULER_cancel (s->step_next_task_id);
2429 GNUNET_free(s->network_entries);
2436 * Add a new address for a peer to the solver
2438 * The address is already contained in the addresses hashmap!
2440 * @param solver the solver Handle
2441 * @param address the address to add
2442 * @param network network type of this address
2445 GAS_ril_address_add (void *solver, struct ATS_Address *address, uint32_t network)
2447 struct GAS_RIL_Handle *s = solver;
2448 struct RIL_Peer_Agent *agent;
2449 struct RIL_Address_Wrapped *address_wrapped;
2450 struct RIL_Scope *net;
2458 LOG (GNUNET_ERROR_TYPE_DEBUG, "API_address_add()\n");
2460 net = ril_get_network (s, network);
2461 address->solver_information = net;
2463 if (!ril_network_is_active (s, network))
2465 LOG(GNUNET_ERROR_TYPE_DEBUG,
2466 "API_address_add() Did not add %s address %s for peer '%s', network does not have enough bandwidth\n",
2467 address->plugin, address->addr, GNUNET_i2s (&address->peer));
2471 s->parameters.temperature = s->parameters.temperature_init;
2472 s->parameters.epsilon = s->parameters.epsilon_init;
2474 agent = ril_get_agent (s, &address->peer, GNUNET_YES);
2477 address_wrapped = GNUNET_new (struct RIL_Address_Wrapped);
2478 address_wrapped->address_naked = address;
2479 GNUNET_CONTAINER_DLL_insert_tail(agent->addresses_head, agent->addresses_tail, address_wrapped);
2481 //increase size of W
2482 m_new = agent->m + ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1));
2484 n_new = agent->n + 1;
2487 GNUNET_array_grow(agent->W, agent->n, n_new);
2489 GNUNET_array_grow(agent->E, agent->n, n_new);
2490 for (i = 0; i < n_new; i++)
2495 GNUNET_array_grow(agent->W[i], agent->m, m_new);
2497 GNUNET_array_grow(agent->E[i], agent->m, m_new);
2502 GNUNET_array_grow(agent->W[i], zero, m_new);
2504 GNUNET_array_grow(agent->E[i], zero, m_new);
2508 //increase size of old state vector
2510 GNUNET_array_grow(agent->s_old, agent->m, m_new);
2512 ril_try_unblock_agent(s, agent, GNUNET_NO);
2516 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_add() Added %s %s address %s for peer '%s'\n",
2517 address->active ? "active" : "inactive", address->plugin, address->addr,
2518 GNUNET_i2s (&address->peer));
2522 * Delete an address in the solver
2524 * The address is not contained in the address hashmap anymore!
2526 * @param solver the solver handle
2527 * @param address the address to remove
2528 * @param session_only delete only session not whole address
2531 GAS_ril_address_delete (void *solver, struct ATS_Address *address, int session_only)
2533 struct GAS_RIL_Handle *s = solver;
2534 struct RIL_Peer_Agent *agent;
2535 struct RIL_Address_Wrapped *address_wrapped;
2536 int address_was_used = address->active;
2541 struct RIL_Scope *net;
2543 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_delete() Delete %s%s %s address %s for peer '%s'\n",
2544 session_only ? "session for " : "", address->active ? "active" : "inactive", address->plugin,
2545 address->addr, GNUNET_i2s (&address->peer));
2547 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
2550 net = address->solver_information;
2551 GNUNET_assert(!ril_network_is_active (s, net->type));
2552 LOG(GNUNET_ERROR_TYPE_DEBUG,
2553 "No agent allocated for peer yet, since address was in inactive network\n");
2557 s->parameters.temperature = s->parameters.temperature_init;
2558 s->parameters.epsilon = s->parameters.epsilon_init;
2560 address_index = agent_address_get_index (agent, address);
2561 address_wrapped = agent_address_get_wrapped (agent, address);
2563 if (NULL == address_wrapped)
2565 net = address->solver_information;
2566 LOG(GNUNET_ERROR_TYPE_DEBUG,
2567 "Address not considered by agent, address was in inactive network\n");
2571 GNUNET_CONTAINER_DLL_remove(agent->addresses_head, agent->addresses_tail, address_wrapped);
2572 GNUNET_free(address_wrapped);
2575 m_new = agent->m - ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1));
2576 n_new = agent->n - 1;
2578 for (i = 0; i < agent->n; i++)
2580 ril_cut_from_vector ((void **) &agent->W[i], sizeof(double),
2581 address_index * ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)),
2582 ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)), agent->m);
2583 ril_cut_from_vector ((void **) &agent->E[i], sizeof(double),
2584 address_index * ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)),
2585 ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)), agent->m);
2587 GNUNET_free_non_null(agent->W[RIL_ACTION_TYPE_NUM + address_index]);
2588 GNUNET_free_non_null(agent->E[RIL_ACTION_TYPE_NUM + address_index]);
2589 ril_cut_from_vector ((void **) &agent->W, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
2591 ril_cut_from_vector ((void **) &agent->E, sizeof(double *), RIL_ACTION_TYPE_NUM + address_index,
2593 //correct last action
2594 if (agent->a_old > (RIL_ACTION_TYPE_NUM + address_index))
2598 else if (agent->a_old == (RIL_ACTION_TYPE_NUM + address_index))
2600 agent->a_old = RIL_ACTION_INVALID;
2602 //decrease old state vector
2603 ril_cut_from_vector ((void **) &agent->s_old, sizeof(double),
2604 address_index * ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)),
2605 ((s->parameters.rbf_divisor+1) * (s->parameters.rbf_divisor+1)), agent->m);
2609 if (address_was_used)
2611 if (NULL != agent->addresses_head) //if peer has an address left, use it
2613 envi_set_active_suggestion (s, agent, agent->addresses_head->address_naked, agent->bw_in, agent->bw_out,
2618 envi_set_active_suggestion (s, agent, NULL, 0, 0, GNUNET_NO);
2626 * Update the properties of an address in the solver
2628 * @param solver solver handle
2629 * @param address the address
2630 * @param type the ATSI type in HBO
2631 * @param abs_value the absolute value of the property
2632 * @param rel_value the normalized value
2635 GAS_ril_address_property_changed (void *solver,
2636 struct ATS_Address *address,
2641 LOG(GNUNET_ERROR_TYPE_DEBUG,
2642 "API_address_property_changed() Property '%s' for peer '%s' address %s changed "
2643 "to %.2f \n", GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
2644 address->addr, rel_value);
2646 struct GAS_RIL_Handle *s = solver;
2648 s->parameters.temperature = s->parameters.temperature_init;
2649 s->parameters.epsilon = s->parameters.epsilon_init;
2654 * Update the session of an address in the solver
2656 * NOTE: values in addresses are already updated
2658 * @param solver solver handle
2659 * @param address the address
2660 * @param cur_session the current session
2661 * @param new_session the new session
2664 GAS_ril_address_session_changed (void *solver,
2665 struct ATS_Address *address,
2666 uint32_t cur_session,
2667 uint32_t new_session)
2669 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_session_changed()\n");
2673 * Notify the solver that an address is (not) actively used by transport
2674 * to communicate with a remote peer
2676 * NOTE: values in addresses are already updated
2678 * @param solver solver handle
2679 * @param address the address
2680 * @param in_use usage state
2683 GAS_ril_address_inuse_changed (void *solver, struct ATS_Address *address, int in_use)
2685 LOG(GNUNET_ERROR_TYPE_DEBUG,
2686 "API_address_inuse_changed() Usage for %s address of peer '%s' changed to %s\n",
2687 address->plugin, GNUNET_i2s (&address->peer), (GNUNET_YES == in_use) ? "USED" : "UNUSED");
2691 * Notify solver that the network an address is located in has changed
2693 * NOTE: values in addresses are already updated
2695 * @param solver solver handle
2696 * @param address the address
2697 * @param current_network the current network
2698 * @param new_network the new network
2701 GAS_ril_address_change_network (void *solver,
2702 struct ATS_Address *address,
2703 uint32_t current_network,
2704 uint32_t new_network)
2706 struct GAS_RIL_Handle *s = solver;
2707 struct RIL_Peer_Agent *agent;
2709 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_address_change_network() Network type changed, moving "
2710 "%s address of peer %s from '%s' to '%s'\n",
2711 (GNUNET_YES == address->active) ? "active" : "inactive", GNUNET_i2s (&address->peer),
2712 GNUNET_ATS_print_network_type (current_network), GNUNET_ATS_print_network_type (new_network));
2714 s->parameters.temperature = s->parameters.temperature_init;
2715 s->parameters.epsilon = s->parameters.epsilon_init;
2717 if (address->active && !ril_network_is_active (solver, new_network))
2719 GAS_ril_address_delete (solver, address, GNUNET_NO);
2723 agent = ril_get_agent (s, &address->peer, GNUNET_NO);
2726 GNUNET_assert(!ril_network_is_active (solver, current_network));
2728 GAS_ril_address_add (s, address, new_network);
2732 address->solver_information = ril_get_network(solver, new_network);
2736 * Give feedback about the current assignment
2738 * @param solver the solver handle
2739 * @param application the application
2740 * @param peer the peer to change the preference for
2741 * @param scope the time interval for this feedback: [now - scope .. now]
2742 * @param kind the kind to change the preference
2743 * @param score the score
2746 GAS_ril_address_preference_feedback (void *solver,
2748 const struct GNUNET_PeerIdentity *peer,
2749 const struct GNUNET_TIME_Relative scope,
2750 enum GNUNET_ATS_PreferenceKind kind,
2753 LOG(GNUNET_ERROR_TYPE_DEBUG,
2754 "API_address_preference_feedback() Peer '%s' got a feedback of %+.3f from application %s for "
2755 "preference %s for %d seconds\n", GNUNET_i2s (peer), "UNKNOWN",
2756 GNUNET_ATS_print_preference_type (kind), scope.rel_value_us / 1000000);
2760 * Start a bulk operation
2762 * @param solver the solver
2765 GAS_ril_bulk_start (void *solver)
2767 struct GAS_RIL_Handle *s = solver;
2769 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_start() lock: %d\n", s->bulk_lock+1);
2775 * Bulk operation done
2777 * @param solver the solver handle
2780 GAS_ril_bulk_stop (void *solver)
2782 struct GAS_RIL_Handle *s = solver;
2784 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_bulk_stop() lock: %d\n", s->bulk_lock-1);
2786 if (s->bulk_lock < 1)
2793 if (0 < s->bulk_changes)
2796 s->bulk_changes = 0;
2801 * Tell solver to notify ATS if the address to use changes for a specific
2802 * peer using the bandwidth changed callback
2804 * The solver must only notify about changes for peers with pending address
2807 * @param solver the solver handle
2808 * @param peer the identity of the peer
2810 const struct ATS_Address *
2811 GAS_ril_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2813 struct GAS_RIL_Handle *s = solver;
2814 struct RIL_Peer_Agent *agent;
2816 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_get_preferred_address()\n");
2818 agent = ril_get_agent (s, peer, GNUNET_YES);
2820 agent->is_active = GNUNET_YES;
2821 envi_set_active_suggestion (solver, agent, agent->address_inuse, agent->bw_in, agent->bw_out, GNUNET_YES);
2823 ril_try_unblock_agent(solver, agent, GNUNET_YES);
2825 if (agent->address_inuse)
2827 LOG(GNUNET_ERROR_TYPE_DEBUG,
2828 "API_get_preferred_address() Activated agent for peer '%s' with %s address %s\n",
2829 GNUNET_i2s (peer), agent->address_inuse->plugin, agent->address_inuse->addr);
2833 LOG(GNUNET_ERROR_TYPE_DEBUG,
2834 "API_get_preferred_address() Activated agent for peer '%s', but no address available\n",
2836 s->parameters.temperature = s->parameters.temperature_init;
2837 s->parameters.epsilon = s->parameters.epsilon_init;
2839 return agent->address_inuse;
2843 * Tell solver stop notifying ATS about changes for this peers
2845 * The solver must only notify about changes for peers with pending address
2848 * @param solver the solver handle
2849 * @param peer the peer
2852 GAS_ril_stop_get_preferred_address (void *solver, const struct GNUNET_PeerIdentity *peer)
2854 struct GAS_RIL_Handle *s = solver;
2855 struct RIL_Peer_Agent *agent;
2857 LOG(GNUNET_ERROR_TYPE_DEBUG, "API_stop_get_preferred_address()");
2859 agent = ril_get_agent (s, peer, GNUNET_NO);
2866 if (GNUNET_NO == agent->is_active)
2872 s->parameters.temperature = s->parameters.temperature_init;
2873 s->parameters.epsilon = s->parameters.epsilon_init;
2875 agent->is_active = GNUNET_NO;
2877 envi_set_active_suggestion (s, agent, agent->address_inuse, agent->bw_in, agent->bw_out,
2882 LOG(GNUNET_ERROR_TYPE_DEBUG,
2883 "API_stop_get_preferred_address() Paused agent for peer '%s' with %s address\n",
2884 GNUNET_i2s (peer), agent->address_inuse->plugin);
2887 /* end of plugin_ats_ril.c */