-fixes
[oweals/gnunet.git] / src / ats / gnunet-service-ats_addresses.h
1 /*
2  This file is part of GNUnet.
3  (C) 2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19  */
20
21 /**
22  * @file ats/gnunet-service-ats_addresses.h
23  * @brief ats service address management
24  * @author Matthias Wachs
25  * @author Christian Grothoff
26  */
27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
29
30 #include "gnunet_util_lib.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet-service-ats.h"
33 #include "gnunet_statistics_service.h"
34 #include "ats.h"
35
36 /**
37  * NOTE: Do not change this documentation. This documentation is based on
38  * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
39  * use build_txt.sh to generate plaintext output
40  *
41  *   1 ATS addresses : ATS address management
42  *
43  *    This ATS addresses ("addresses") component manages the addresses known to
44  *    ATS service and suggests addresses to transport service when it is
45  *    interested in address suggestion for a peer. ATS addresses also
46  *    instantiates the bandwidth assignment mechanism (solver), notifies it
47  *    about changes to addresses and forwards changes to bandwidth assignments
48  *    to transport, depending if transport is interested in this change.
49  *
50  *     1.1 Input data
51  *
52  *       1.1.1 Addresses
53  *
54  *    Addresses are added by specifying peer ID, plugin, address, address length
55  *    and session, if available. ATS information can be specified if available.
56  *
57  *       1.1.2 Networks
58  *
59  *    ATS specifies a fix set of networks an address can belong to. For each
60  *    network an inbound and outbound quota will be specified. The available
61  *    networks and addtional helper varaibles are defined in
62  *    gnunet_ats_service.h. At the moment 5 networks are defined:
63  *      * GNUNET_ATS_NET_UNSPECIFIED
64  *      * GNUNET_ATS_NET_LOOPBACK
65  *      * GNUNET_ATS_NET_LAN
66  *      * GNUNET_ATS_NET_WAN
67  *      * GNUNET_ATS_NET_WLAN
68  *
69  *    The total number of networks defined is stored in
70  *    GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
71  *    initializer for an int array, while GNUNET_ATS_NetworkType is an
72  *    initializer for a char array containing a string description of all
73  *    networks
74  *
75  *       1.1.3 Quotas
76  *
77  *    An inbound and outbound quota for each of the networks mentioned in 1.1.2
78  *    is loaded from ats configuration during initialization. This quota defines
79  *    to total amount of inbound and outbound traffic allowed for a specific
80  *    network. The configuration values used are in section ats:
81  *      * "NETWORK"_QUOTA_IN = <value>
82  *      * "NETWORK"_QUOTA_IN = <value>
83  *
84  *    You can specify quotas by setting the <value> to a:
85  *      * unrestricted: unlimited
86  *      * number of bytes: e.g. 10240
87  *      * fancy value: e.g. 64 Kib
88  *
89  *    unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
90  *    the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
91  *    are:
92  *      * GNUNET_ATS_DefaultBandwidth: 65536
93  *      * GNUNET_ATS_MaxBandwidth: UINT32_MAX
94  *      * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
95  *
96  *    Details of loading quotas and default values will be described on
97  *
98  *       1.1.4 Preference values
99  *
100  *     1.2 Data structures used
101  *
102  *    Addresse uses struct ATS_Address for each address. The structs are stored
103  *    in a linked list and provides a pointer void *solver_information for the
104  *    solver to store address specific information. It provides the int values
105  *    active which is set to GNUNET_YES if the address is select for transport
106  *    use and used, representing that transport service is actively using this
107  *    address. Address information are stored in peer, addr, addr_len, plugin.
108  *
109  *     1.3 Initialization
110  *
111  *    During initialization a hashmap to store addresses is created. The quotas
112  *    for all networks defined for ATS are loaded from configuration. For each
113  *    network first the logic will check if the string
114  *    GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
115  *    the configured value as a fancy size and if this fails it will try to use
116  *    it as a value_number. If no configuration value is found it will assign
117  *    GNUNET_ATS_DefaultBandwidth. The most important step is to load the
118  *    configured solver using configuration "[ats]:MODE". Current solvers are
119  *    MODE_PROPORTIONAL, MODE_MLP. Interaction is done using a solver API
120  *
121  *     1.4 Solver API
122  *
123  *    Solver functions:
124  *      * s_init: init the solver with required information
125  *      * s_add: add a new address
126  *      * s_update: update ATS values or session for an address
127  *      * s_get: get prefered address for a peer
128  *      * s_del: delete an address
129  *      * s_pref: change preference value for a peer
130  *      * s_done: shutdown solver
131  *
132  *    Callbacks: addresses provides a bandwidth_changed_cb callback to the
133  *    solver which is called when bandwidth assigned to peer has changed
134  *
135  *     1.5 Shutdown
136  *
137  *    During shutdown all addresses are freed and the solver told to shutdown
138  *
139  *     1.6 Addresses and sessions
140  *
141  *    Addresses consist of the address itself and a numerical session. When a
142  *    new address without a session is added it has no session, so it gets
143  *    session 0 assigned. When an address with a session is added and an address
144  *    object with session 0 is found, this object is updated with the session
145  *    otherwise a new address object with this session assigned is created.
146  *
147  *       1.6.1 Terminology
148  *
149  *    Addresses a1,a2 with session s1, s2 are "exact" if:
150  *    (a1 == a2)&&(s1 == s2)
151  *    Addresses a1,a2 with session s1, s2 are "equivalent" if:
152  *    (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
153  *
154  *     1.7 Address management
155  *
156  *    Transport service notifies ATS about changes to the addresses known to
157  *    him.
158  *
159  *       1.7.1 Adding an address
160  *
161  *    When transport learns a new address it tells ATS and ATS is telling
162  *    addresses about it using GAS_address_add. If not known to addresses it
163  *    creates a new address object and calls solver's s_add. ATS information are
164  *    deserialized and solver is notified about the session and ATS information
165  *    using s_update.
166  *
167  *       1.7.2 Updating an address
168  *
169  *    Addresses does an lookup up for the existing address with the given
170  *    session. If disassembles included ATS information and notifies the solver
171  *    using s_update about the update.
172  *
173  *       1.7.3 Deleting an address
174  *
175  *    Addresses does an lookup for the exact address and session and if removes
176  *    this address. If session != 0 the session is set to 0 and the address is
177  *    kept. If session == 0, the addresses is removed.
178  *
179  *       1.7.4 Requesting an address suggestion
180  *
181  *    The address client issues a request address message to be notified about
182  *    address suggestions for a specific peer. Addresses asks the solver with
183  *    s_get. If no address is available, it will not send a response, otherwise
184  *    it will respond with the choosen address.
185  *
186  *       1.7.5 Address suggestions
187  *
188  *    Addresses will notify the client automatically on any bandwidth_changed_cb
189  *    by the solver if a address suggestion request is pending. If no address is
190  *    available it will not respond at all If the client is not interested
191  *    anymore, it has to cancel the address suggestion request.
192  *
193  *       1.7.6 Suggestions blocks and reset
194  *
195  *    After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
196  *    prevent the client from being thrashed. If the client requires immediately
197  *    it can reset this block using GAS_addresses_handle_backoff_reset.
198  *
199  *       1.7.7 Marking address in use
200  *
201  *    The client can notify addresses that it successfully uses an address and
202  *    wants this address to be kept by calling GSA_address_in_use. Adresses will
203  *    mark the address as used an notify the solver about the use.
204  *
205  *       1.7.8 Address lifecycle
206  *
207  *      * (add address)
208  *      * (updated address) || (address in use)
209  *      * (delete address)
210  *
211  *     1.8 Bandwidth assignment
212  *
213  *    The addresses are used to perform resource allocation operations. ATS
214  *    addresses takes care of instantiating the solver configured and notifies
215  *    the respective solver about address changes and receives changes to the
216  *    bandwidth assignment from the solver. The current bandwidth assignment is
217  *    sent to transport. The specific solvers will be described in the specific
218  *    section.
219  *
220  *     1.9 Changing peer preferences
221  *
222  *    The bandwidth assigned to a peer can be influenced by setting a preference
223  *    for a peer. The prefernce will be given to to the solver with s_pref which
224  *    has to take care of the preference value
225
226  */
227
228 /*
229  * How long will address suggestions blocked after a suggestion
230  */
231 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
232
233 /**
234  * Information provided by ATS normalization
235  */
236 struct GAS_NormalizationInfo
237 {
238   /**
239    * Next index to use in averaging queue
240    */
241   unsigned int avg_queue_index;
242
243   /**
244    * Averaging queue
245    */
246   uint32_t atsi_abs[GAS_normalization_queue_length];
247
248   /**
249    * Averaged ATSI values from queue
250    */
251   uint32_t avg;
252
253   /**
254    * Normalized values from queue to a range of values [1.0...2.0]
255    */
256   double norm;
257 };
258
259 /**
260  * Address with additional information
261  */
262 struct ATS_Address
263 {
264   /**
265    * Next element in DLL
266    */
267   struct ATS_Address *next;
268
269   /**
270    * Previous element in DLL
271    */
272   struct ATS_Address *prev;
273
274   /**
275    * Peer ID
276    */
277   struct GNUNET_PeerIdentity peer;
278
279   /**
280    * Session ID, 0 if no session is given
281    */
282   uint32_t session_id;
283
284   /**
285    * Address
286    */
287   const void *addr;
288
289   /**
290    * Address length
291    */
292   size_t addr_len;
293
294   /**
295    * Plugin name
296    */
297   char *plugin;
298
299   /**
300    * Solver specific information for this address
301    */
302   void *solver_information;
303
304   /**
305    * ATS performance information for this address
306    */
307   struct GNUNET_ATS_Information *atsi;
308
309   /**
310    * ATS performance information for this address
311    */
312   uint32_t atsi_count;
313
314   /**
315    * Inbound bandwidth assigned by solver in NBO
316    */
317   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
318
319   /**
320    * Outbound bandwidth assigned by solver in NBO
321    */
322   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
323
324   /**
325    * Blocking interval
326    */
327   struct GNUNET_TIME_Relative block_interval;
328
329   /**
330    * Time when address can be suggested again
331    */
332   struct GNUNET_TIME_Absolute blocked_until;
333
334   /**
335    * Is this the active address for this peer?
336    */
337   int active;
338
339   /**
340    * Is this the address for this peer in use?
341    */
342   int used;
343
344   /**
345    * Normalized ATS performance information for this address
346    * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
347    */
348   struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
349 };
350
351
352
353 /**
354  * Initialize address subsystem. The addresses subsystem manages the addresses
355  * known and current performance information. It has a solver component
356  * responsible for the resource allocation. It tells the solver about changes
357  * and receives updates when the solver changes the ressource allocation.
358  *
359  * @param cfg configuration to use
360  * @param stats the statistics handle to use
361  * @return an address handle
362  */
363 struct GAS_Addresses_Handle *
364 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
365     const struct GNUNET_STATISTICS_Handle *stats);
366
367 /**
368  * Shutdown address subsystem.
369  *
370  * @param handle the address handle to shutdown
371  */
372 void
373 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
374
375 /**
376  * Add a new address for a peer.
377  *
378  * @param handle the address handle to use
379  * @param peer peer
380  * @param plugin_name transport plugin name
381  * @param plugin_addr plugin address
382  * @param plugin_addr_len length of the plugin address
383  * @param session_id session id, can be 0
384  * @param atsi performance information for this address
385  * @param atsi_count number of performance information contained
386  */
387 void
388 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
389     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
390     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
391     const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count);
392
393 /**
394  * Notification about active use of an address.
395  * in_use == GNUNET_YES:
396  *      This address is used to maintain an active connection with a peer.
397  * in_use == GNUNET_NO:
398  *      This address is no longer used to maintain an active connection with a peer.
399  *
400  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
401  * before
402  *
403  * @param handle the address handle to use
404  * @param peer peer
405  * @param plugin_name transport plugin name
406  * @param plugin_addr plugin address
407  * @param plugin_addr_len length of the plugin address
408  * @param session_id session id, can be 0
409  * @param in_use GNUNET_YES if GNUNET_NO
410  * @return GNUNET_SYSERR on failure (address unknown ...)
411  */
412 int
413 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
414     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
415     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
416     int in_use);
417
418 /**
419  * Update an address with a session or performance information for a peer.
420  *
421  * If an address was added without a session it will be updated with the
422  * session
423  *
424  * @param handle the address handle to use
425  * @param peer peer
426  * @param plugin_name transport plugin name
427  * @param plugin_addr plugin address
428  * @param plugin_addr_len length of the plugin address
429  * @param session_id session id, can be 0
430  * @param atsi performance information for this address
431  * @param atsi_count number of performance information contained
432  */
433 void
434 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
435     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
436     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
437     const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count);
438
439 /**
440  * Remove an address or just a session for a peer.
441  *
442  * @param handle the address handle to use
443  * @param peer peer
444  * @param plugin_name transport plugin name
445  * @param plugin_addr plugin address
446  * @param plugin_addr_len length of the plugin address
447  * @param session_id session id, can be 0
448  */
449 void
450 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
451     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
452     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id);
453
454 /**
455  * Remove all addresses
456  *
457  * @param handle the address handle to use
458  */
459 void
460 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
461
462 /**
463  * Request address suggestions for a peer
464  *
465  * @param handle the address handle
466  * @param peer the peer id
467  */
468 void
469 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
470     const struct GNUNET_PeerIdentity *peer);
471
472 /**
473  * Cancel address suggestions for a peer
474  *
475  * @param handle the address handle
476  * @param peer the peer id
477  */
478 void
479 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
480     const struct GNUNET_PeerIdentity *peer);
481
482 /**
483  * Reset suggestion backoff for a peer
484  *
485  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
486  * reset using this function
487  *
488  * @param handle the address handle
489  * @param peer the peer id
490  */
491 void
492 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
493     const struct GNUNET_PeerIdentity *peer);
494
495 /**
496  * Change the preference for a peer
497  *
498  * @param handle the address handle
499  * @param client the client sending this request
500  * @param peer the peer id
501  * @param kind the preference kind to change
502  * @param score_abs the new preference score
503  */
504 void
505 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
506     void *client, const struct GNUNET_PeerIdentity *peer,
507     enum GNUNET_ATS_PreferenceKind kind, float score_abs);
508
509 /**
510  * Application feedback on how good preference requirements are fulfilled
511  * for a specific preference in the given time scope [now - scope .. now]
512  *
513  * An application notifies ATS if (and only if) it has feedback information
514  * for a specific property. This value is valid until the feedback score is
515  * updated by the application.
516  *
517  * If the application has no feedback for this preference kind the application
518  * will not explicitly call.
519  *
520  * @param handle the address handle
521  * @param application the application sending this request
522  * @param peer the peer id
523  * @param scope the time interval this valid for: [now - scope .. now]
524  * @param kind the preference kind this feedback is intended for
525  * @param score_abs the new preference score
526  */
527 void
528 GAS_addresses_preference_feedback (struct GAS_Addresses_Handle *handle,
529     void *application, const struct GNUNET_PeerIdentity *peer,
530     const struct GNUNET_TIME_Relative scope,
531     enum GNUNET_ATS_PreferenceKind kind, float score_abs);
532
533 /**
534  * Iterator for GAS_addresses_iterate_peers
535  *
536  * @param p_it_cls closure
537  * @param id the peer id
538  */
539 typedef void
540 (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
541     const struct GNUNET_PeerIdentity *id);
542
543 /**
544  * Return all peers currently known to ATS
545  *
546  * @param handle the address handle to use
547  * @param p_it the iterator to call for every peer
548  * @param p_it_cls the closure for the iterator
549  */
550 void
551 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
552     GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
553
554 /**
555  * Iterator for GAS_addresses_get_peer_info
556  *
557  * @param p_it_cls closure closure
558  * @param id the peer id
559  * @param plugin_name plugin name
560  * @param plugin_addr address
561  * @param plugin_addr_len address length
562  * @param address_active is address actively used
563  * @param atsi ats performance information
564  * @param atsi_count number of ats performance elements
565  * @param bandwidth_out current outbound bandwidth assigned to address
566  * @param bandwidth_in current inbound bandwidth assigned to address
567  */
568 typedef void
569 (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
570     const struct GNUNET_PeerIdentity *id, const char *plugin_name,
571     const void *plugin_addr, size_t plugin_addr_len, const int address_active,
572     const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count,
573     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
574     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
575
576 /**
577  * Return information all peers currently known to ATS
578  *
579  * @param handle the address handle to use
580  * @param peer the respective peer
581  * @param pi_it the iterator to call for every peer
582  * @param pi_it_cls the closure for the iterator
583  */
584 void
585 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
586     const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it,
587     void *pi_it_cls);
588
589 #endif
590
591 /* end of gnunet-service-ats_addresses.h */