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