X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftransport%2Fgnunet-service-transport_ats.c;h=01e115bfca35fbab6d8b8a7840534480ec0ff9c4;hb=0d24b1ba329faa35990034fcc861a264bb985fb1;hp=5124cd57852d22cde8e108bb70883f5aa99468d6;hpb=e5bd8fb4aa72717b8707a4652f14c0735acb52c4;p=oweals%2Fgnunet.git diff --git a/src/transport/gnunet-service-transport_ats.c b/src/transport/gnunet-service-transport_ats.c index 5124cd578..01e115bfc 100644 --- a/src/transport/gnunet-service-transport_ats.c +++ b/src/transport/gnunet-service-transport_ats.c @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - Copyright (C) 2015 Christian Grothoff (and other contributing authors) + Copyright (C) 2015 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -18,7 +18,7 @@ Boston, MA 02110-1301, USA. */ /** - * @file transport/gnunet-service-transport_ats.h + * @file transport/gnunet-service-transport_ats.c * @brief interfacing between transport and ATS service * @author Christian Grothoff */ @@ -29,6 +29,9 @@ #include "gnunet-service-transport_plugins.h" #include "gnunet_ats_service.h" +/** + * Log convenience function. + */ #define LOG(kind,...) GNUNET_log_from(kind, "transport-ats", __VA_ARGS__) @@ -39,14 +42,15 @@ struct AddressInfo { /** - * The address (with peer identity). + * The address (with peer identity). Must never change + * while this struct is in the #p2a map. */ struct GNUNET_HELLO_Address *address; /** * Session (can be NULL) */ - struct Session *session; + struct GNUNET_ATS_Session *session; /** * Record with ATS API for the address. @@ -100,8 +104,9 @@ static struct GNUNET_CONTAINER_MultiPeerMap *p2a; */ static unsigned int num_blocked; + /** - * Closure for #find_ai(). + * Closure for #find_ai_cb() and #find_ai_no_session_cb(). */ struct FindClosure { @@ -109,7 +114,7 @@ struct FindClosure /** * Session to look for (only used if the address is inbound). */ - struct Session *session; + struct GNUNET_ATS_Session *session; /** * Address to look for. @@ -144,7 +149,9 @@ publish_p2a_stat_update () /** - * Find matching address info. + * Find matching address info. Both the address and the session + * must match; note that expired addresses are still found (as + * the session kind-of keeps those alive). * * @param cls the `struct FindClosure` * @param key which peer is this about @@ -167,15 +174,13 @@ find_ai_cb (void *cls, fc->ret = ai; return GNUNET_NO; } - GNUNET_assert ( (fc->session != ai->session) || - (NULL == ai->session) ); return GNUNET_YES; } /** * Find the address information struct for the - * given address and session. + * given @a address and @a session. * * @param address address to look for * @param session session to match for inbound connections @@ -183,7 +188,7 @@ find_ai_cb (void *cls, */ static struct AddressInfo * find_ai (const struct GNUNET_HELLO_Address *address, - struct Session *session) + struct GNUNET_ATS_Session *session) { struct FindClosure fc; @@ -199,7 +204,8 @@ find_ai (const struct GNUNET_HELLO_Address *address, /** - * Find matching address info, ignoring sessions. + * Find matching address info, ignoring sessions and expired + * addresses. * * @param cls the `struct FindClosure` * @param key which peer is this about @@ -214,6 +220,8 @@ find_ai_no_session_cb (void *cls, struct FindClosure *fc = cls; struct AddressInfo *ai = value; + if (ai->expired) + return GNUNET_YES; /* expired do not count here */ if (0 == GNUNET_HELLO_address_cmp (fc->address, ai->address)) @@ -250,6 +258,8 @@ find_ai_no_session (const struct GNUNET_HELLO_Address *address) /** * Test if ATS knows about this @a address and @a session. + * Note that even if the address is expired, we return + * #GNUNET_YES if the respective session matches. * * @param address the address * @param session the session @@ -257,14 +267,15 @@ find_ai_no_session (const struct GNUNET_HELLO_Address *address) */ int GST_ats_is_known (const struct GNUNET_HELLO_Address *address, - struct Session *session) + struct GNUNET_ATS_Session *session) { return (NULL != find_ai (address, session)) ? GNUNET_YES : GNUNET_NO; } /** - * Test if ATS knows about this @a address. + * Test if ATS knows about this @a address. Note that + * expired addresses do not count. * * @param address the address * @return #GNUNET_YES if @a address is known, #GNUNET_NO if not. @@ -272,7 +283,9 @@ GST_ats_is_known (const struct GNUNET_HELLO_Address *address, int GST_ats_is_known_no_session (const struct GNUNET_HELLO_Address *address) { - return (NULL != find_ai_no_session (address)) ? GNUNET_YES : GNUNET_NO; + return (NULL != find_ai_no_session (address)) + ? GNUNET_YES + : GNUNET_NO; } @@ -281,11 +294,9 @@ GST_ats_is_known_no_session (const struct GNUNET_HELLO_Address *address) * suggest it again. * * @param cls the `struct AddressInfo` of the address to unblock - * @param tc unused */ static void -unblock_address (void *cls, - const struct GNUNET_SCHEDULER_TaskContext *tc) +unblock_address (void *cls) { struct AddressInfo *ai = cls; @@ -315,20 +326,21 @@ unblock_address (void *cls, */ void GST_ats_block_address (const struct GNUNET_HELLO_Address *address, - struct Session *session) + struct GNUNET_ATS_Session *session) { struct AddressInfo *ai; - ai = find_ai (address, session); - if (NULL == ai) - { - GNUNET_assert (0); - return; - } - if (NULL == ai->ar) + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ + ai = find_ai (address, + session); + if (NULL == ai || NULL == ai->ar) { - /* already blocked, how did it get used!? */ - GNUNET_break (0); + /* The address is already gone/blocked, this can happen during a blacklist + * callback. */ return; } ai->back_off = GNUNET_TIME_STD_BACKOFF (ai->back_off); @@ -351,7 +363,14 @@ GST_ats_block_address (const struct GNUNET_HELLO_Address *address, (GNUNET_NO == GNUNET_ATS_address_del_session (ai->ar, session)) ) + { GNUNET_ATS_address_destroy (ai->ar); + } + /* "ar" has been freed, regardless how the branch + above played out: it was either freed in + #GNUNET_ATS_address_del_session() because it was + incoming, or explicitly in + #GNUNET_ATS_address_del_session(). */ ai->ar = NULL; /* determine when the address should come back to life */ @@ -366,7 +385,7 @@ GST_ats_block_address (const struct GNUNET_HELLO_Address *address, /** * Reset address blocking time. Resets the exponential - * back-off timer for this address to zero. Done when + * back-off timer for this address to zero. Called when * an address was used to create a successful connection. * * @param address the address to reset the blocking timer @@ -374,10 +393,15 @@ GST_ats_block_address (const struct GNUNET_HELLO_Address *address, */ void GST_ats_block_reset (const struct GNUNET_HELLO_Address *address, - struct Session *session) + struct GNUNET_ATS_Session *session) { struct AddressInfo *ai; + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ ai = find_ai (address, session); if (NULL == ai) { @@ -391,10 +415,10 @@ GST_ats_block_reset (const struct GNUNET_HELLO_Address *address, /** - * Notify ATS about the a new inbound address. We may already - * know the address (as this is called each time we receive - * a message from an inbound connection). If the address is - * indeed new, make it available to ATS. + * Notify ATS about a new inbound @a address. The @a address in + * combination with the @a session must be new, but this function will + * perform a santiy check. If the @a address is indeed new, make it + * available to ATS. * * @param address the address * @param session the session @@ -402,18 +426,25 @@ GST_ats_block_reset (const struct GNUNET_HELLO_Address *address, */ void GST_ats_add_inbound_address (const struct GNUNET_HELLO_Address *address, - struct Session *session, + struct GNUNET_ATS_Session *session, const struct GNUNET_ATS_Properties *prop) { struct GNUNET_ATS_AddressRecord *ar; struct AddressInfo *ai; - /* valid new address, let ATS know! */ + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ + + /* Sanity checks for a valid inbound address */ if (NULL == address->transport_name) { GNUNET_break(0); return; } + GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope); GNUNET_assert (GNUNET_YES == GNUNET_HELLO_address_check_option (address, GNUNET_HELLO_ADDRESS_INFO_INBOUND)); @@ -426,20 +457,18 @@ GST_ats_add_inbound_address (const struct GNUNET_HELLO_Address *address, GNUNET_break (0); return; } - GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope); + /* Is indeed new, let's tell ATS */ LOG (GNUNET_ERROR_TYPE_DEBUG, "Notifying ATS about peer `%s''s new inbound address `%s' session %p in network %s\n", GNUNET_i2s (&address->peer), - (0 == address->address_length) - ? "" - : GST_plugins_a2s (address), + GST_plugins_a2s (address), session, GNUNET_ATS_print_network_type (prop->scope)); ar = GNUNET_ATS_address_add (GST_ats, address, session, prop); - GNUNET_break (NULL != ar); + GNUNET_assert (NULL != ar); ai = GNUNET_new (struct AddressInfo); ai->address = GNUNET_HELLO_address_copy (address); ai->session = session; @@ -467,7 +496,12 @@ GST_ats_add_address (const struct GNUNET_HELLO_Address *address, struct GNUNET_ATS_AddressRecord *ar; struct AddressInfo *ai; - /* valid new address, let ATS know! */ + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ + /* validadte address */ if (NULL == address->transport_name) { GNUNET_break(0); @@ -479,17 +513,17 @@ GST_ats_add_address (const struct GNUNET_HELLO_Address *address, ai = find_ai_no_session (address); GNUNET_assert (NULL == ai); GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope); + + /* address seems sane, let's tell ATS */ LOG (GNUNET_ERROR_TYPE_INFO, - "Notifying ATS about peer `%s''s new address `%s'\n", + "Notifying ATS about peer %s's new address `%s'\n", GNUNET_i2s (&address->peer), - (0 == address->address_length) - ? "" - : GST_plugins_a2s (address)); + GST_plugins_a2s (address)); ar = GNUNET_ATS_address_add (GST_ats, address, NULL, prop); - GNUNET_break (NULL != ar); + GNUNET_assert (NULL != ar); ai = GNUNET_new (struct AddressInfo); ai->address = GNUNET_HELLO_address_copy (address); ai->ar = ar; @@ -503,53 +537,108 @@ GST_ats_add_address (const struct GNUNET_HELLO_Address *address, /** - * Notify ATS about a new session now existing for the given - * address. + * Notify ATS about a new @a session now existing for the given + * @a address. Essentially, an outbound @a address was used + * to establish a @a session. It is safe to call this function + * repeatedly for the same @a address and @a session pair. * * @param address the address * @param session the session */ void GST_ats_new_session (const struct GNUNET_HELLO_Address *address, - struct Session *session) + struct GNUNET_ATS_Session *session) { struct AddressInfo *ai; + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ ai = find_ai (address, NULL); if (NULL == ai) { - /* We may already be aware of the session, even if some other part - of the code could not tell if it just created a new session or - just got one recycled from the plugin; hence, we may be called - with "new" session even for an "old" session; in that case, - check that this is the case, but just ignore it. */ + /* We may simply already be aware of the session, even if some + other part of the code could not tell if it just created a new + session or just got one recycled from the plugin; hence, we may + be called with "new" session even for an "old" session; in that + case, check that this is the case, but just ignore it. */ GNUNET_assert (NULL != (find_ai (address, session))); return; } - GNUNET_break (NULL == ai->session); + GNUNET_assert (NULL == ai->session); ai->session = session; LOG (GNUNET_ERROR_TYPE_DEBUG, "Telling ATS about new session for peer %s\n", GNUNET_i2s (&address->peer)); + /* Note that the address might currently be blocked; we only + tell ATS about the session if the address is currently not + blocked; otherwise, ATS will be told about the session on + unblock. */ if (NULL != ai->ar) GNUNET_ATS_address_add_session (ai->ar, session); + else + GNUNET_assert (NULL != ai->unblock_task); } /** - * Notify ATS that the session (but not the address) of - * a given address is no longer relevant. + * Release memory used by the given address data. + * + * @param ai the `struct AddressInfo` + */ +static void +destroy_ai (struct AddressInfo *ai) +{ + GNUNET_assert (NULL == ai->session); + if (NULL != ai->unblock_task) + { + GNUNET_SCHEDULER_cancel (ai->unblock_task); + ai->unblock_task = NULL; + num_blocked--; + } + GNUNET_assert (GNUNET_YES == + GNUNET_CONTAINER_multipeermap_remove (p2a, + &ai->address->peer, + ai)); + LOG (GNUNET_ERROR_TYPE_DEBUG, + "Telling ATS to destroy address from peer %s\n", + GNUNET_i2s (&ai->address->peer)); + if (NULL != ai->ar) + { + GNUNET_ATS_address_destroy (ai->ar); + ai->ar = NULL; + } + publish_p2a_stat_update (); + GNUNET_HELLO_address_free (ai->address); + GNUNET_free (ai); +} + + +/** + * Notify ATS that the @a session (but not the @a address) of + * a given @a address is no longer relevant. (The @a session + * went down.) This function may be called even if for the + * respective outbound address #GST_ats_new_session() was + * never called and thus the pair is unknown to ATS. In this + * case, the call is simply ignored. * * @param address the address * @param session the session */ void GST_ats_del_session (const struct GNUNET_HELLO_Address *address, - struct Session *session) + struct GNUNET_ATS_Session *session) { struct AddressInfo *ai; + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ if (NULL == session) { GNUNET_break (0); @@ -566,7 +655,6 @@ GST_ats_del_session (const struct GNUNET_HELLO_Address *address, GNUNET_break (GNUNET_YES != GNUNET_HELLO_address_check_option (address, GNUNET_HELLO_ADDRESS_INFO_INBOUND)); - return; } GNUNET_assert (session == ai->session); @@ -575,31 +663,72 @@ GST_ats_del_session (const struct GNUNET_HELLO_Address *address, "Telling ATS to destroy session %p from peer %s\n", session, GNUNET_i2s (&address->peer)); + if (GNUNET_YES == ai->expired) + { + /* last reason to keep this 'ai' around is now gone, the + session is dead as well, clean up */ + if (NULL != ai->ar) + { + /* Address expired but not blocked, and thus 'ar' was still + live because of the session; deleting just the session + will do for an inbound session, but for an outbound we + then also need to destroy the address with ATS. */ + if (GNUNET_NO == + GNUNET_ATS_address_del_session (ai->ar, + session)) + { + GNUNET_ATS_address_destroy (ai->ar); + } + /* "ar" has been freed, regardless how the branch + above played out: it was either freed in + #GNUNET_ATS_address_del_session() because it was + incoming, or explicitly in + #GNUNET_ATS_address_del_session(). */ + ai->ar = NULL; + } + destroy_ai (ai); + return; + } + if (NULL == ai->ar) { - /* If ATS doesn't know about the address/session, and this was an - inbound session or one that expired, then we must forget about - the address as well. Otherwise, we are done as we have set - `ai->session` to NULL already. */ - if ( (GNUNET_YES == ai->expired) || - (GNUNET_YES == - GNUNET_HELLO_address_check_option (address, - GNUNET_HELLO_ADDRESS_INFO_INBOUND)) ) - GST_ats_expire_address (address); + /* If ATS doesn't know about the address/session, this means + this address was blocked. */ + if (GNUNET_YES == + GNUNET_HELLO_address_check_option (address, + GNUNET_HELLO_ADDRESS_INFO_INBOUND)) + { + /* This was a blocked inbound session, which now lost the + session. But inbound addresses are by themselves useless, + so we must forget about the address as well. */ + destroy_ai (ai); + return; + } + /* Otherwise, we are done as we have set `ai->session` to NULL + already and ATS will simply not be told about the session when + the connection is unblocked and the outbound address becomes + available again. . */ return; } + + /* This is the "simple" case where ATS knows about the session and + the address is neither blocked nor expired. Delete the session, + and if it was inbound, free the address as well. */ if (GNUNET_YES == GNUNET_ATS_address_del_session (ai->ar, session)) { + /* This was an inbound address, the session is now gone, so we + need to also forget about the address itself. */ ai->ar = NULL; - GST_ats_expire_address (address); + destroy_ai (ai); } } /** - * Notify ATS about DV distance change to an address's. + * Notify ATS about DV @a distance change to an @a address. + * Does nothing if the @a address is not known to us. * * @param address the address * @param distance new distance value @@ -612,15 +741,21 @@ GST_ats_update_distance (const struct GNUNET_HELLO_Address *address, ai = find_ai_no_session (address); if (NULL == ai) + { + /* We do not know about this address, do nothing. */ return; + } LOG (GNUNET_ERROR_TYPE_DEBUG, "Updated distance for peer `%s' to %u\n", GNUNET_i2s (&address->peer), distance); ai->properties.distance = distance; + /* Give manipulation its chance to change metrics */ GST_manipulation_manipulate_metrics (address, ai->session, &ai->properties); + /* Address may be blocked, only give ATS if address is + currently active. */ if (NULL != ai->ar) GNUNET_ATS_address_update (ai->ar, &ai->properties); @@ -628,7 +763,8 @@ GST_ats_update_distance (const struct GNUNET_HELLO_Address *address, /** - * Notify ATS about property changes to an address's properties. + * Notify ATS about @a delay changes to properties of an @a address. + * Does nothing if the @a address is not known to us. * * @param address the address * @param delay new delay value @@ -641,16 +777,22 @@ GST_ats_update_delay (const struct GNUNET_HELLO_Address *address, ai = find_ai_no_session (address); if (NULL == ai) + { + /* We do not know about this address, do nothing. */ return; + } LOG (GNUNET_ERROR_TYPE_DEBUG, "Updated latency for peer `%s' to %s\n", GNUNET_i2s (&address->peer), GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES)); ai->properties.delay = delay; + /* Give manipulation its chance to change metrics */ GST_manipulation_manipulate_metrics (address, ai->session, &ai->properties); + /* Address may be blocked, only give ATS if address is + currently active. */ if (NULL != ai->ar) GNUNET_ATS_address_update (ai->ar, &ai->properties); @@ -658,7 +800,8 @@ GST_ats_update_delay (const struct GNUNET_HELLO_Address *address, /** - * Notify ATS about utilization changes to an address. + * Notify ATS about utilization changes to an @a address. + * Does nothing if the @a address is not known to us. * * @param address our information about the address * @param bps_in new utilization inbound @@ -673,7 +816,10 @@ GST_ats_update_utilization (const struct GNUNET_HELLO_Address *address, ai = find_ai_no_session (address); if (NULL == ai) + { + /* We do not know about this address, do nothing. */ return; + } LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating utilization for peer `%s' address %s: %u/%u\n", GNUNET_i2s (&address->peer), @@ -682,9 +828,12 @@ GST_ats_update_utilization (const struct GNUNET_HELLO_Address *address, (unsigned int) bps_out); ai->properties.utilization_in = bps_in; ai->properties.utilization_out = bps_out; + /* Give manipulation its chance to change metrics */ GST_manipulation_manipulate_metrics (address, ai->session, &ai->properties); + /* Address may be blocked, only give ATS if address is + currently active. */ if (NULL != ai->ar) GNUNET_ATS_address_update (ai->ar, &ai->properties); @@ -703,6 +852,11 @@ GST_ats_expire_address (const struct GNUNET_HELLO_Address *address) { struct AddressInfo *ai; + if (0 == + memcmp (&GST_my_identity, + &address->peer, + sizeof (struct GNUNET_PeerIdentity))) + return; /* our own, ignore! */ LOG (GNUNET_ERROR_TYPE_DEBUG, "Address %s of peer %s expired\n", GST_plugins_a2s (address), @@ -713,45 +867,15 @@ GST_ats_expire_address (const struct GNUNET_HELLO_Address *address) GNUNET_assert (0); return; } - if (NULL != ai->unblock_task) - { - GNUNET_SCHEDULER_cancel (ai->unblock_task); - ai->unblock_task = NULL; - num_blocked--; - } if (NULL != ai->session) { + /* Got an active session, just remember the expiration + and act upon it when the session goes down. */ ai->expired = GNUNET_YES; - if (NULL != ai->ar) - { - GNUNET_ATS_address_destroy (ai->ar); - ai->ar = NULL; - } return; } - GNUNET_assert (GNUNET_YES == - GNUNET_CONTAINER_multipeermap_remove (p2a, - &address->peer, - ai)); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Telling ATS to destroy address from peer %s\n", - GNUNET_i2s (&address->peer)); - if (NULL != ai->ar) - { - /* We usually should not have a session here when we - expire an address, but during shutdown a session - may be active while validation causes the address - to 'expire'. So clean up both if necessary. */ - if ( (NULL == ai->session) || - (GNUNET_NO == - GNUNET_ATS_address_del_session (ai->ar, - ai->session)) ) - GNUNET_ATS_address_destroy (ai->ar); - ai->ar = NULL; - } - publish_p2a_stat_update (); - GNUNET_HELLO_address_free (ai->address); - GNUNET_free (ai); + /* Address expired, no session, free resources */ + destroy_ai (ai); } @@ -774,29 +898,13 @@ GST_ats_init () * @return #GNUNET_OK (continue to iterate) */ static int -destroy_ai (void *cls, - const struct GNUNET_PeerIdentity *key, - void *value) +destroy_ai_cb (void *cls, + const struct GNUNET_PeerIdentity *key, + void *value) { struct AddressInfo *ai = value; - GNUNET_assert (GNUNET_YES == - GNUNET_CONTAINER_multipeermap_remove (p2a, - key, - ai)); - if (NULL != ai->unblock_task) - { - GNUNET_SCHEDULER_cancel (ai->unblock_task); - ai->unblock_task = NULL; - num_blocked--; - } - if (NULL != ai->ar) - { - GNUNET_ATS_address_destroy (ai->ar); - ai->ar = NULL; - } - GNUNET_HELLO_address_free (ai->address); - GNUNET_free (ai); + destroy_ai (ai); return GNUNET_OK; } @@ -808,7 +916,7 @@ void GST_ats_done () { GNUNET_CONTAINER_multipeermap_iterate (p2a, - &destroy_ai, + &destroy_ai_cb, NULL); publish_p2a_stat_update (); GNUNET_CONTAINER_multipeermap_destroy (p2a);