2 This file is part of GNUnet.
3 Copyright (C) 2011-2015 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file ats/gnunet-service-ats_performance.c
22 * @brief ats service, interaction with 'performance' API
23 * @author Matthias Wachs
24 * @author Christian Grothoff
27 * - simplify functions by passing a `struct GNUNET_HELLO_Address`
30 #include "gnunet-service-ats.h"
31 #include "gnunet-service-ats_addresses.h"
32 #include "gnunet-service-ats_performance.h"
37 * Context for sending messages to performance clients without PIC.
39 static struct GNUNET_NotificationContext *nc_no_pic;
42 * Context for sending messages to performance clients with PIC.
44 static struct GNUNET_NotificationContext *nc_pic;
48 * Transmit the given performance information to all performance
51 * @param client 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
66 notify_client (struct GNUNET_SERVICE_Client *client,
67 const struct GNUNET_PeerIdentity *peer,
68 const char *plugin_name,
69 const void *plugin_addr,
70 size_t plugin_addr_len,
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)
77 struct PeerInformationMessage *msg;
78 size_t plugin_name_length = strlen (plugin_name) + 1;
80 sizeof (struct PeerInformationMessage) +
83 char buf[msize] GNUNET_ALIGN;
87 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope);
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);
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;
100 GNUNET_ATS_properties_hton (&msg->properties,
103 memset (&msg->properties,
105 sizeof (struct GNUNET_ATS_Properties));
106 msg->address_local_info = htonl (local_address_info);
107 addrp = (char *) &msg[1];
108 GNUNET_memcpy (addrp, plugin_addr, plugin_addr_len);
109 strcpy (&addrp[plugin_addr_len], plugin_name);
112 GNUNET_notification_context_broadcast (nc_pic,
118 struct GNUNET_MQ_Envelope *env;
120 env = GNUNET_MQ_msg_copy (&msg->header);
121 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
128 * Transmit the given performance information to all performance
131 * @param peer peer for which this is an address suggestion
132 * @param plugin_name 0-termintated string specifying the transport plugin
133 * @param plugin_addr binary address for the plugin to use
134 * @param plugin_addr_len number of bytes in @a plugin_addr
135 * @param active #GNUNET_YES if this address is actively used
136 * to maintain a connection to a peer;
137 * #GNUNET_NO if the address is not actively used;
138 * #GNUNET_SYSERR if this address is no longer available for ATS
139 * @param prop performance data for the address
140 * @param local_address_info information about the local flags for the address
141 * @param bandwidth_out assigned outbound bandwidth
142 * @param bandwidth_in assigned inbound bandwidth
145 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
146 const char *plugin_name,
147 const void *plugin_addr,
148 size_t plugin_addr_len,
150 const struct GNUNET_ATS_Properties *prop,
151 enum GNUNET_HELLO_AddressInfo local_address_info,
152 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
153 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
155 GNUNET_break ( (NULL == prop) ||
156 (GNUNET_ATS_NET_UNSPECIFIED != prop->scope) );
167 GNUNET_STATISTICS_update (GSA_stats,
168 "# performance updates given to clients",
175 * Iterator for called from #GAS_addresses_get_peer_info()
177 * @param cls closure with the `struct GNUNET_SERVICE_Client *` to inform.
178 * @param id the peer id
179 * @param plugin_name plugin name
180 * @param plugin_addr address
181 * @param plugin_addr_len length of @a plugin_addr
182 * @param active is address actively used
183 * @param prop performance information
184 * @param local_address_info information about the local flags for the address
185 * @param bandwidth_out current outbound bandwidth assigned to address
186 * @param bandwidth_in current inbound bandwidth assigned to address
189 peerinfo_it (void *cls,
190 const struct GNUNET_PeerIdentity *id,
191 const char *plugin_name,
192 const void *plugin_addr,
193 size_t plugin_addr_len,
195 const struct GNUNET_ATS_Properties *prop,
196 enum GNUNET_HELLO_AddressInfo local_address_info,
197 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
198 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
200 struct GNUNET_SERVICE_Client *client = cls;
204 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
205 "Callback for peer `%s' plugin `%s' BW out %u, BW in %u \n",
208 (unsigned int) ntohl (bandwidth_out.value__),
209 (unsigned int) ntohl (bandwidth_in.value__));
210 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope);
211 notify_client (client,
225 * Register a new performance client.
227 * @param client handle of the new client
228 * @param flag flag specifying the type of the client
231 GAS_performance_add_client (struct GNUNET_SERVICE_Client *client,
234 struct GNUNET_MQ_Handle *mq;
236 mq = GNUNET_SERVICE_client_get_mq (client);
237 if (START_FLAG_PERFORMANCE_WITH_PIC == flag)
239 GNUNET_notification_context_add (nc_pic,
241 GAS_addresses_get_peer_info (NULL,
247 GNUNET_notification_context_add (nc_no_pic,
254 * Initialize performance subsystem.
256 * @param server handle to our server
259 GAS_performance_init ()
261 nc_no_pic = GNUNET_notification_context_create (32);
262 nc_pic = GNUNET_notification_context_create (32);
267 * Shutdown performance subsystem.
270 GAS_performance_done ()
272 GNUNET_notification_context_destroy (nc_no_pic);
274 GNUNET_notification_context_destroy (nc_pic);
278 /* end of gnunet-service-ats_performance.c */