src/ats/gnunet-service-ats_performance.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011-2015 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file ats/gnunet-service-ats_performance.c
  22  * @brief ats service, interaction with 'performance' API
  23  * @author Matthias Wachs
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - simplify functions by passing a `struct GNUNET_HELLO_Address`
  28  */
  29 #include "platform.h"
  30 #include "gnunet-service-ats.h"
  31 #include "gnunet-service-ats_addresses.h"
  32 #include "gnunet-service-ats_performance.h"
  33 #include "ats.h"
  34
  35
  36 /**
  37  * Context for sending messages to performance clients without PIC.
  38  */
  39 static struct GNUNET_SERVER_NotificationContext *nc_no_pic;
  40
  41 /**
  42  * Context for sending messages to performance clients with PIC.
  43  */
  44 static struct GNUNET_SERVER_NotificationContext *nc_pic;
  45
  46
  47 /**
  48  * Transmit the given performance information to all performance
  49  * clients.
  50  *
  51  * @param pc client to send to, NULL for all
  52  * @param peer peer for which this is an address suggestion
  53  * @param plugin_name 0-termintated string specifying the transport plugin
  54  * @param plugin_addr binary address for the plugin to use
  55  * @param plugin_addr_len number of bytes in plugin_addr
  56  * @param active #GNUNET_YES if this address is actively used
  57  *        to maintain a connection to a peer;
  58  *        #GNUNET_NO if the address is not actively used;
  59  *        #GNUNET_SYSERR if this address is no longer available for ATS
  60  * @param prop performance data for the address
  61  * @param local_address_info information about the local flags for the address
  62  * @param bandwidth_out assigned outbound bandwidth
  63  * @param bandwidth_in assigned inbound bandwidth
  64  */
  65 static void
  66 notify_client (struct GNUNET_SERVER_Client *client,
  67                const struct GNUNET_PeerIdentity *peer,
  68                const char *plugin_name,
  69                const void *plugin_addr,
  70                size_t plugin_addr_len,
  71                int active,
  72                const struct GNUNET_ATS_Properties *prop,
  73                enum GNUNET_HELLO_AddressInfo local_address_info,
  74                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
  75                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
  76 {
  77   struct PeerInformationMessage *msg;
  78   size_t plugin_name_length = strlen (plugin_name) + 1;
  79   size_t msize =
  80     sizeof (struct PeerInformationMessage) +
  81     plugin_addr_len +
  82     plugin_name_length;
  83   char buf[msize] GNUNET_ALIGN;
  84   struct GNUNET_SERVER_NotificationContext **uc;
  85   struct GNUNET_SERVER_NotificationContext *nc;
  86   char *addrp;
  87
  88   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
  89   msg = (struct PeerInformationMessage *) buf;
  90   msg->header.size = htons (msize);
  91   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
  92   msg->id = htonl (0);
  93   msg->peer = *peer;
  94   msg->address_length = htons (plugin_addr_len);
  95   msg->address_active = ntohl ((uint32_t) active);
  96   msg->plugin_name_length = htons (plugin_name_length);
  97   msg->bandwidth_out = bandwidth_out;
  98   msg->bandwidth_in = bandwidth_in;
  99   if (NULL != prop)
 100     GNUNET_ATS_properties_hton (&msg->properties,
 101                                 prop);
 102   else
 103     memset (&msg->properties,
 104             0,
 105             sizeof (struct GNUNET_ATS_Properties));
 106   msg->address_local_info = htonl (local_address_info);
 107   addrp = (char *) &msg[1];
 108   memcpy (addrp, plugin_addr, plugin_addr_len);
 109   strcpy (&addrp[plugin_addr_len], plugin_name);
 110   if (NULL == client)
 111   {
 112     GNUNET_SERVER_notification_context_broadcast (nc_pic,
 113                                                   &msg->header,
 114                                                   GNUNET_YES);
 115   }
 116   else
 117   {
 118     uc = GNUNET_SERVER_client_get_user_context (client,
 119                                                  struct GNUNET_SERVER_NotificationContext *);
 120     if (NULL == uc)
 121     {
 122       GNUNET_break (0);
 123       return;
 124     }
 125     nc = *uc;
 126     GNUNET_SERVER_notification_context_unicast (nc,
 127                                                 client,
 128                                                 &msg->header,
 129                                                 GNUNET_YES);
 130   }
 131 }
 132
 133
 134 /**
 135  * Transmit the given performance information to all performance
 136  * clients.
 137  *
 138  * @param peer peer for which this is an address suggestion
 139  * @param plugin_name 0-termintated string specifying the transport plugin
 140  * @param plugin_addr binary address for the plugin to use
 141  * @param plugin_addr_len number of bytes in @a plugin_addr
 142  * @param active #GNUNET_YES if this address is actively used
 143  *        to maintain a connection to a peer;
 144  *        #GNUNET_NO if the address is not actively used;
 145  *        #GNUNET_SYSERR if this address is no longer available for ATS
 146  * @param prop performance data for the address
 147  * @param local_address_info information about the local flags for the address
 148  * @param bandwidth_out assigned outbound bandwidth
 149  * @param bandwidth_in assigned inbound bandwidth
 150  */
 151 void
 152 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
 153                                     const char *plugin_name,
 154                                     const void *plugin_addr,
 155                                     size_t plugin_addr_len,
 156                                     int active,
 157                                     const struct GNUNET_ATS_Properties *prop,
 158                                     enum GNUNET_HELLO_AddressInfo local_address_info,
 159                                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 160                                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 161 {
 162   notify_client (NULL,
 163                  peer,
 164                  plugin_name,
 165                  plugin_addr,
 166                  plugin_addr_len,
 167                  active,
 168                  prop,
 169                  local_address_info,
 170                  bandwidth_out,
 171                  bandwidth_in);
 172   GNUNET_STATISTICS_update (GSA_stats,
 173                             "# performance updates given to clients",
 174                             1,
 175                             GNUNET_NO);
 176 }
 177
 178
 179 /**
 180  * Iterator for called from #GAS_addresses_get_peer_info()
 181  *
 182  * @param cls closure with the `struct GNUNET_SERVER_Client *` to inform.
 183  * @param id the peer id
 184  * @param plugin_name plugin name
 185  * @param plugin_addr address
 186  * @param plugin_addr_len length of @a plugin_addr
 187  * @param active is address actively used
 188  * @param prop performance information
 189  * @param local_address_info information about the local flags for the address
 190  * @param bandwidth_out current outbound bandwidth assigned to address
 191  * @param bandwidth_in current inbound bandwidth assigned to address
 192  */
 193 static void
 194 peerinfo_it (void *cls,
 195              const struct GNUNET_PeerIdentity *id,
 196              const char *plugin_name,
 197              const void *plugin_addr,
 198              size_t plugin_addr_len,
 199              int active,
 200              const struct GNUNET_ATS_Properties *prop,
 201              enum GNUNET_HELLO_AddressInfo local_address_info,
 202              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 203              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 204 {
 205   struct GNUNET_SERVER_Client *client = cls;
 206
 207   if (NULL == id)
 208     return;
 209   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 210               "Callback for peer `%s' plugin `%s' BW out %u, BW in %u \n",
 211               GNUNET_i2s (id),
 212               plugin_name,
 213               (unsigned int) ntohl (bandwidth_out.value__),
 214               (unsigned int) ntohl (bandwidth_in.value__));
 215   notify_client (client,
 216                  id,
 217                  plugin_name,
 218                  plugin_addr,
 219                  plugin_addr_len,
 220                  active,
 221                  prop,
 222                  local_address_info,
 223                  bandwidth_out,
 224                  bandwidth_in);
 225 }
 226
 227
 228 /**
 229  * Register a new performance client.
 230  *
 231  * @param client handle of the new client
 232  * @param flag flag specifying the type of the client
 233  */
 234 void
 235 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
 236                             enum StartFlag flag)
 237 {
 238   if (START_FLAG_PERFORMANCE_WITH_PIC == flag)
 239   {
 240     GNUNET_SERVER_notification_context_add (nc_pic,
 241                                             client);
 242     GNUNET_SERVER_client_set_user_context (client,
 243                                            &nc_pic);
 244     GAS_addresses_get_peer_info (NULL,
 245                                  &peerinfo_it,
 246                                  client);
 247   }
 248   else
 249   {
 250     GNUNET_SERVER_notification_context_add (nc_no_pic,
 251                                             client);
 252     GNUNET_SERVER_client_set_user_context (client,
 253                                            &nc_no_pic);
 254   }
 255 }
 256
 257
 258 /**
 259  * Initialize performance subsystem.
 260  *
 261  * @param server handle to our server
 262  */
 263 void
 264 GAS_performance_init (struct GNUNET_SERVER_Handle *server)
 265 {
 266   nc_no_pic = GNUNET_SERVER_notification_context_create (server, 32);
 267   nc_pic = GNUNET_SERVER_notification_context_create (server, 32);
 268 }
 269
 270
 271 /**
 272  * Shutdown performance subsystem.
 273  */
 274 void
 275 GAS_performance_done ()
 276 {
 277   GNUNET_SERVER_notification_context_destroy (nc_no_pic);
 278   nc_no_pic = NULL;
 279   GNUNET_SERVER_notification_context_destroy (nc_pic);
 280   nc_pic = NULL;
 281 }
 282
 283 /* end of gnunet-service-ats_performance.c */