GNUnet  0.11.x
gnunet-service-ats.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2011 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your 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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet-service-ats.h"
37 #include "ats.h"
38 
43 
44 
52 static void
53 handle_ats_start (void *cls,
54  const struct ClientStartMessage *msg)
55 {
56  struct GNUNET_SERVICE_Client *client = cls;
57  enum StartFlag flag;
58 
59  flag = ntohl (msg->start_flag);
61  "Received ATS_START (%d) message\n",
62  (int) flag);
63  switch (flag)
64  {
66  if (GNUNET_OK !=
68  {
70  return;
71  }
72  break;
73 
76  flag);
77  break;
78 
81  flag);
82  break;
83 
85  /* This client won't receive messages from us, no need to 'add' */
86  break;
87 
88  default:
89  GNUNET_break (0);
91  return;
92  }
94 }
95 
96 
103 static void
105  const struct ReservationRequestMessage *message)
106 {
107  struct GNUNET_SERVICE_Client *client = cls;
108 
110  message);
112 }
113 
114 
122 static int
123 check_feedback (void *cls,
124  const struct FeedbackPreferenceMessage *message)
125 {
126  uint16_t msize;
127  uint32_t nump;
128 
130  "Received PREFERENCE_FEEDBACK message\n");
131  msize = ntohs (message->header.size);
132  nump = ntohl (message->num_feedback);
133  if (msize !=
134  sizeof(struct FeedbackPreferenceMessage)
135  + nump * sizeof(struct PreferenceInformation))
136  {
137  GNUNET_break (0);
138  return GNUNET_SYSERR;
139  }
140  return GNUNET_OK;
141 }
142 
143 
150 static void
151 handle_feedback (void *cls,
152  const struct FeedbackPreferenceMessage *msg)
153 {
154  struct GNUNET_SERVICE_Client *client = cls;
155  const struct PreferenceInformation *pi;
156  uint32_t nump;
157 
158  nump = ntohl (msg->num_feedback);
159  if (GNUNET_NO ==
161  &msg->peer))
162  {
164  "Received PREFERENCE FEEDBACK for unknown peer `%s'\n",
165  GNUNET_i2s (&msg->peer));
167  return;
168  }
169 
171  "# preference feedbacks requests processed",
172  1,
173  GNUNET_NO);
174  pi = (const struct PreferenceInformation *) &msg[1];
175  for (uint32_t i = 0; i < nump; i++)
176  {
178  "Received PREFERENCE FEEDBACK for peer `%s'\n",
179  GNUNET_i2s (&msg->peer));
181  &msg->peer,
183  (enum GNUNET_ATS_PreferenceKind) ntohl (
184  pi[i].preference_kind),
185  pi[i].preference_value);
186  }
188 }
189 
190 
197 static void
199  const struct AddressListRequestMessage *message)
200 {
201  struct GNUNET_SERVICE_Client *client = cls;
202 
204  message);
206 }
207 
208 
215 static void
217  const struct RequestAddressMessage *message)
218 {
219  struct GNUNET_SERVICE_Client *client = cls;
220 
222  message);
224 }
225 
226 
233 static void
235  const struct RequestAddressMessage *message)
236 {
237  struct GNUNET_SERVICE_Client *client = cls;
238 
240  message);
242 }
243 
244 
251 static int
252 check_address_add (void *cls,
253  const struct AddressAddMessage *m)
254 {
255  const char *address;
256  const char *plugin_name;
257  uint16_t address_length;
258  uint16_t plugin_name_length;
259  uint16_t size;
260 
261  size = ntohs (m->header.size);
262  address_length = ntohs (m->address_length);
263  plugin_name_length = ntohs (m->plugin_name_length);
264  address = (const char *) &m[1];
265  if (plugin_name_length != 0)
266  plugin_name = &address[address_length];
267  else
268  plugin_name = "";
269 
270  if ((address_length + plugin_name_length
271  + sizeof(struct AddressAddMessage) != size) ||
272  ((plugin_name_length > 0) &&
273  (plugin_name[plugin_name_length - 1] != '\0')))
274  {
275  GNUNET_break (0);
276  return GNUNET_SYSERR;
277  }
278  return GNUNET_OK;
279 }
280 
281 
288 static void
290  const struct AddressAddMessage *message)
291 {
292  struct GNUNET_SERVICE_Client *client = cls;
293 
294  GAS_handle_address_add (message);
296 }
297 
298 
305 static void
307  const struct AddressUpdateMessage *message)
308 {
309  struct GNUNET_SERVICE_Client *client = cls;
310 
311  GAS_handle_address_update (message);
313 }
314 
315 
322 static void
324  const struct AddressDestroyedMessage *message)
325 {
326  struct GNUNET_SERVICE_Client *client = cls;
327 
330 }
331 
332 
340 static int
342  const struct ChangePreferenceMessage *message)
343 {
344  uint16_t msize;
345  uint32_t nump;
346 
347  msize = ntohs (message->header.size);
348  nump = ntohl (message->num_preferences);
349  if ((msize !=
350  sizeof(struct ChangePreferenceMessage)
351  + nump * sizeof(struct PreferenceInformation)) ||
352  (UINT16_MAX / sizeof(struct PreferenceInformation) < nump))
353  {
354  GNUNET_break (0);
355  return GNUNET_SYSERR;
356  }
357  return GNUNET_OK;
358 }
359 
360 
367 static void
369  const struct ChangePreferenceMessage *message)
370 {
371  struct GNUNET_SERVICE_Client *client = cls;
372 
374  message);
376 }
377 
378 
388 static void *
389 client_connect_cb (void *cls,
390  struct GNUNET_SERVICE_Client *client,
391  struct GNUNET_MQ_Handle *mq)
392 {
393  return client;
394 }
395 
396 
405 static void
407  struct GNUNET_SERVICE_Client *client,
408  void *app_ctx)
409 {
410  if (NULL == client)
411  return;
415 }
416 
417 
423 static void
424 cleanup_task (void *cls)
425 {
427  "ATS shutdown initiated\n");
430  GAS_plugin_done ();
435  if (NULL != GSA_stats)
436  {
438  GSA_stats = NULL;
439  }
440 }
441 
442 
450 static void
451 run (void *cls,
452  const struct GNUNET_CONFIGURATION_Handle *cfg,
454 {
456  cfg);
462  if (GNUNET_OK !=
464  {
465  GNUNET_break (0);
471  if (NULL != GSA_stats)
472  {
474  GNUNET_NO);
475  GSA_stats = NULL;
476  }
477  return;
478  }
481  NULL);
482 }
483 
484 
489  ("ats",
491  &run,
494  NULL,
495  GNUNET_MQ_hd_fixed_size (ats_start,
497  struct ClientStartMessage,
498  NULL),
499  GNUNET_MQ_hd_fixed_size (request_address,
501  struct RequestAddressMessage,
502  NULL),
503  GNUNET_MQ_hd_fixed_size (request_address_cancel,
505  struct RequestAddressMessage,
506  NULL),
507  GNUNET_MQ_hd_fixed_size (request_address_list,
510  NULL),
511  GNUNET_MQ_hd_var_size (address_add,
513  struct AddressAddMessage,
514  NULL),
515  GNUNET_MQ_hd_fixed_size (address_update,
517  struct AddressUpdateMessage,
518  NULL),
519  GNUNET_MQ_hd_fixed_size (address_destroyed,
522  NULL),
523  GNUNET_MQ_hd_fixed_size (reservation_request,
526  NULL),
527  GNUNET_MQ_hd_var_size (preference_change,
530  NULL),
531  GNUNET_MQ_hd_var_size (feedback,
534  NULL),
536 
537 
538 /* end of gnunet-service-ats.c */
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
automatic transport selection messages
StartFlag
Flag used to indicate which type of client is connecting to the ATS service.
Definition: ats.h:38
@ START_FLAG_PERFORMANCE_NO_PIC
Performance monitoring client that does NOT want to learn about changes in performance characteristic...
Definition: ats.h:54
@ START_FLAG_CONNECTION_SUGGESTION
Connection suggestion handle.
Definition: ats.h:59
@ START_FLAG_SCHEDULING
This is a scheduling client (aka transport service)
Definition: ats.h:42
@ START_FLAG_PERFORMANCE_WITH_PIC
Performance monitoring client that wants to learn about changes in performance characteristics.
Definition: ats.h:48
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:104
static char * address
GNS address for this phone.
static struct GNUNET_PEERINFO_Handle * pi
Handle to peerinfo service.
static struct GNUNET_SERVICE_Handle * service
Handle to our service instance.
static void handle_request_address_cancel(void *cls, const struct RequestAddressMessage *message)
Cancel 'request address' messages from clients.
static void handle_reservation_request(void *cls, const struct ReservationRequestMessage *message)
Handle 'reservation request' messages from clients.
static void handle_address_update(void *cls, const struct AddressUpdateMessage *message)
Handle 'address update' messages from clients.
static void handle_request_address_list(void *cls, const struct AddressListRequestMessage *message)
Handle 'request address list' messages from clients.
static void cleanup_task(void *cls)
Task run during shutdown.
struct GNUNET_STATISTICS_Handle * GSA_stats
Handle for statistics.
static void handle_request_address(void *cls, const struct RequestAddressMessage *message)
Handle 'request address' messages from clients.
static void handle_ats_start(void *cls, const struct ClientStartMessage *msg)
We have received a struct ClientStartMessage from a client.
static int check_preference_change(void *cls, const struct ChangePreferenceMessage *message)
Check that 'change preference' message is well-formed.
static void handle_feedback(void *cls, const struct FeedbackPreferenceMessage *msg)
Handle 'preference feedback' messages from clients.
GNUNET_SERVICE_MAIN("ats", GNUNET_SERVICE_OPTION_NONE, &run, &client_connect_cb, &client_disconnect_cb, NULL, GNUNET_MQ_hd_fixed_size(ats_start, GNUNET_MESSAGE_TYPE_ATS_START, struct ClientStartMessage, NULL), GNUNET_MQ_hd_fixed_size(request_address, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS, struct RequestAddressMessage, NULL), GNUNET_MQ_hd_fixed_size(request_address_cancel, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL, struct RequestAddressMessage, NULL), GNUNET_MQ_hd_fixed_size(request_address_list, GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST, struct AddressListRequestMessage, NULL), GNUNET_MQ_hd_var_size(address_add, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD, struct AddressAddMessage, NULL), GNUNET_MQ_hd_fixed_size(address_update, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE, struct AddressUpdateMessage, NULL), GNUNET_MQ_hd_fixed_size(address_destroyed, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED, struct AddressDestroyedMessage, NULL), GNUNET_MQ_hd_fixed_size(reservation_request, GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST, struct ReservationRequestMessage, NULL), GNUNET_MQ_hd_var_size(preference_change, GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE, struct ChangePreferenceMessage, NULL), GNUNET_MQ_hd_var_size(feedback, GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK, struct FeedbackPreferenceMessage, NULL), GNUNET_MQ_handler_end())
Define "main" method using service macro.
static void handle_address_add(void *cls, const struct AddressAddMessage *message)
Handle 'address add' messages from clients.
static void * client_connect_cb(void *cls, struct GNUNET_SERVICE_Client *client, struct GNUNET_MQ_Handle *mq)
A client connected to us.
static void handle_address_destroyed(void *cls, const struct AddressDestroyedMessage *message)
Handle 'address destroyed' messages from clients.
static int check_address_add(void *cls, const struct AddressAddMessage *m)
Handle 'address add' messages from clients.
static void handle_preference_change(void *cls, const struct ChangePreferenceMessage *message)
Handle 'change preference' messages from clients.
static void client_disconnect_cb(void *cls, struct GNUNET_SERVICE_Client *client, void *app_ctx)
A client disconnected from us.
static void run(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg, struct GNUNET_SERVICE_Handle *service)
Process template requests.
static int check_feedback(void *cls, const struct FeedbackPreferenceMessage *message)
Check 'preference feedback' message is well-formed.
void GAS_addresses_init()
Initialize address subsystem.
struct GNUNET_CONTAINER_MultiPeerMap * GSA_addresses
A multihashmap to store all addresses.
void GAS_handle_request_address_list(struct GNUNET_SERVICE_Client *client, const struct AddressListRequestMessage *alrm)
Handle 'address list request' messages from clients.
void GAS_addresses_done()
Shutdown address subsystem.
ats service address management
void GAS_connectivity_remove_client(struct GNUNET_SERVICE_Client *client)
Unregister a client (which may have been a connectivity client, but this is not assured).
void GAS_handle_request_address_cancel(struct GNUNET_SERVICE_Client *client, const struct RequestAddressMessage *msg)
Handle GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL messages from clients.
void GAS_connectivity_init()
Shutdown connectivity subsystem.
void GAS_handle_request_address(struct GNUNET_SERVICE_Client *client, const struct RequestAddressMessage *msg)
Handle GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS messages from clients.
void GAS_connectivity_done()
Shutdown connectivity subsystem.
ats service, interaction with 'connecivity' API
void GAS_normalization_stop()
Stop the normalization component and free all items.
void GAS_normalization_start()
Start the normalization component.
ats service address: management of ATS properties and preferences normalization
void GAS_performance_add_client(struct GNUNET_SERVICE_Client *client, enum StartFlag flag)
Register a new performance client.
void GAS_performance_init()
Initialize performance subsystem.
void GAS_performance_done()
Shutdown performance subsystem.
ats service, interaction with 'performance' API
void GAS_plugin_notify_feedback(struct GNUNET_SERVICE_Client *application, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_TIME_Relative scope, enum GNUNET_ATS_PreferenceKind kind, float score_abs)
Tell the solver that the given client has expressed its appreciation for the past performance of a gi...
int GAS_plugin_init(const struct GNUNET_CONFIGURATION_Handle *cfg)
Initialize plugins subsystem.
void GAS_plugin_done()
Shutdown address subsystem.
ats service plugin management
void GAS_preference_client_disconnect(struct GNUNET_SERVICE_Client *client)
A performance client disconnected.
void GAS_preference_init()
Initialize preferences subsystem.
void GAS_preference_done()
Shutdown preferences subsystem.
void GAS_handle_preference_change(struct GNUNET_SERVICE_Client *client, const struct ChangePreferenceMessage *msg)
Handle 'preference change' messages from clients.
manage preferences expressed by clients
void GAS_handle_reservation_request(struct GNUNET_SERVICE_Client *client, const struct ReservationRequestMessage *msg)
Handle 'reservation request' messages from clients.
void GAS_reservations_done()
Shutdown reservations subsystem.
void GAS_reservations_init()
Initialize reservations subsystem.
ats service, inbound bandwidth reservation management
void GAS_handle_address_add(const struct AddressAddMessage *m)
Handle 'address add' messages from clients.
void GAS_handle_address_update(const struct AddressUpdateMessage *m)
Handle 'address update' messages from clients.
void GAS_handle_address_destroyed(const struct AddressDestroyedMessage *m)
Handle 'address destroyed' messages from clients.
void GAS_scheduling_remove_client(struct GNUNET_SERVICE_Client *client)
Unregister a client (which may have been a scheduling client, but this is not assured).
int GAS_scheduling_add_client(struct GNUNET_SERVICE_Client *client)
Register a new scheduling client.
ats service, interaction with 'scheduling' API
static char * plugin_name
Name of our plugin.
#define GNUNET_log(kind,...)
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_NO
Definition: gnunet_common.h:94
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
GNUNET_ATS_PreferenceKind
Enum defining all known preference categories.
int GNUNET_CONTAINER_multipeermap_contains(const struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key)
Check if the map contains any value under the given key (including values that are NULL).
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
#define GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK
Type of the 'struct ChangePreferenceMessage' sent by clients to ATS to ask for allocation preference ...
#define GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST
Type of the 'struct AddressListRequestMessage' sent by client to ATS to request information about add...
#define GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS
Type of the 'struct RequestAddressMessage' sent by clients to ATS to request an address to help conne...
#define GNUNET_MESSAGE_TYPE_ATS_START
Type of the 'struct ClientStartMessage' sent by clients to ATS to identify the type of the client.
#define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE
Type of the 'struct AddressUpdateMessage' sent by clients to ATS to inform ATS about performance chan...
#define GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL
Type of the 'struct RequestAddressMessage' sent by clients to ATS to request an address to help conne...
#define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD
Type of the 'struct AddressUpdateMessage' sent by client to ATS to add a new address.
#define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED
Type of the 'struct AddressDestroyedMessage' sent by clients to ATS to inform ATS about an address be...
#define GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST
Type of the 'struct ReservationRequestMessage' sent by clients to ATS to ask for inbound bandwidth re...
#define GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE
Type of the 'struct ChangePreferenceMessage' sent by clients to ATS to ask for allocation preference ...
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received,...
Definition: scheduler.c:1331
void GNUNET_SERVICE_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2325
void GNUNET_SERVICE_client_continue(struct GNUNET_SERVICE_Client *c)
Continue receiving further messages from the given client.
Definition: service.c:2244
@ GNUNET_SERVICE_OPTION_NONE
Use defaults.
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).
struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh(struct GNUNET_TIME_RelativeNBO a)
Convert relative time from network byte order.
Definition: time.c:454
static unsigned int size
Size of the "table".
Definition: peer.c:67
Scheduling client to ATS service: here is another address you can use.
Definition: ats.h:112
Message sent by ATS client to ATS service when an address was destroyed and must thus henceforth no l...
Definition: ats.h:193
Client to service: please give us an overview of the addresses.
Definition: ats.h:342
Message used to notify ATS that the performance characteristics for an address have changed.
Definition: ats.h:162
Client to ATS: I have a performance preference for a peer.
Definition: ats.h:438
uint32_t num_preferences
How many struct PreferenceInformation entries follow this struct?
Definition: ats.h:448
struct GNUNET_MessageHeader header
Type is GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE.
Definition: ats.h:442
First message any client sends to ATS, used to self-identify (what type of client this is).
Definition: ats.h:70
Message containing application feedback for a peer.
Definition: ats.h:464
struct GNUNET_MessageHeader header
Type is GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK.
Definition: ats.h:468
uint32_t num_feedback
Number of feedback values included.
Definition: ats.h:473
Handle to a message queue.
Definition: mq.c:86
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
Handle to a client that is connected to a service.
Definition: service.c:251
Handle to a service.
Definition: service.c:117
Handle for the service.
Variable-size entry in a struct ChangePreferenceMessage or struct FeedbackPreferenceMessage.
Definition: ats.h:420
uint32_t preference_kind
An enum GNUNET_ATS_PreferenceKind in NBO.
Definition: ats.h:424
float preference_value
Degree of preference (or appreciation) for this preference_kind being expressed.
Definition: ats.h:430
Connectivity client to ATS service: we would like to have address suggestions for this peer.
Definition: ats.h:88