/*
- This file is part of GNUnet.
- (C) 2010,2011 Christian Grothoff (and other contributing authors)
-
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
-
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ This file is part of GNUnet.
+ Copyright (C) 2010, 2011, 2016 GNUnet e.V.
+
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
+
+ GNUnet is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @file ats/ats_api_performance.c
#include "gnunet_ats_service.h"
#include "ats.h"
-/**
- * Message in linked list we should send to the ATS service. The
- * actual binary message follows this struct.
- */
-struct PendingMessage
-{
- /**
- * Kept in a DLL.
- */
- struct PendingMessage *next;
+#define LOG(kind,...) GNUNET_log_from(kind, "ats-performance-api", __VA_ARGS__)
- /**
- * Kept in a DLL.
- */
- struct PendingMessage *prev;
-
- /**
- * Size of the message.
- */
- size_t size;
-
- /**
- * Is this the 'ATS_START' message?
- */
- int is_init;
-};
/**
* Linked list of pending reservations.
GNUNET_ATS_ReservationCallback rcb;
/**
- * Closure for 'rcb'
+ * Closure for @e rcb
*/
void *rcb_cls;
/**
* Do we need to undo this reservation if it succeeded? Set to
- * GNUNET_YES if a reservation is cancelled. (at that point, 'info'
+ * #GNUNET_YES if a reservation is cancelled. (at that point, 'info'
* is also set to NULL; however, info will ALSO be NULL for the
* reservation context that is created to undo the original request,
* so 'info' being NULL cannot be used to check if undo is
int undo;
};
+
/**
* Linked list of pending reservations.
*/
GNUNET_ATS_AddressInformationCallback cb;
/**
- * Callback closure
+ * Callback closure for @e cb
*/
void *cb_cls;
uint32_t id;
};
+
/**
* ATS Handle to obtain and/or modify performance information.
*/
GNUNET_ATS_AddressInformationCallback addr_info_cb;
/**
- * Closure for 'addr_info_cb'.
+ * Closure for @e addr_info_cb.
*/
void *addr_info_cb_cls;
/**
* Connection to ATS service.
*/
- struct GNUNET_CLIENT_Connection *client;
-
- /**
- * Head of list of messages for the ATS service.
- */
- struct PendingMessage *pending_head;
-
- /**
- * Tail of list of messages for the ATS service
- */
- struct PendingMessage *pending_tail;
+ struct GNUNET_MQ_Handle *mq;
/**
* Head of linked list of pending reservation requests.
/**
* Task to trigger reconnect.
*/
- GNUNET_SCHEDULER_TaskIdentifier task;
+ struct GNUNET_SCHEDULER_Task *task;
+
+ /**
+ * Reconnect backoff delay.
+ */
+ struct GNUNET_TIME_Relative backoff;
/**
* Monitor request multiplexing
* Request multiplexing
*/
uint32_t id;
+
+ /**
+ * Is the receive loop active?
+ */
+ int in_receive;
};
/**
static void
reconnect (struct GNUNET_ATS_PerformanceHandle *ph);
+
/**
* Re-establish the connection to the ATS service.
*
* @param cls handle to use to re-connect.
- * @param tc scheduler context
*/
static void
-reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+reconnect_task (void *cls)
{
struct GNUNET_ATS_PerformanceHandle *ph = cls;
- ph->task = GNUNET_SCHEDULER_NO_TASK;
+ ph->task = NULL;
reconnect (ph);
}
-/**
- * Transmit messages from the message queue to the service
- * (if there are any, and if we are not already trying).
- *
- * @param ph handle to use
- */
-static void
-do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
/**
- * Type of a function to call when we receive a message
- * from the service.
+ * Reconnect to the ATS service, something went wrong.
*
- * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
- * @param msg message received, NULL on timeout or fatal error
+ * @param ph handle to reconnect
*/
static void
-process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg);
-
-/**
- * We can now transmit a message to ATS. Do it.
- *
- * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
- * @param size number of bytes we can transmit to ATS
- * @param buf where to copy the messages
- * @return number of bytes copied into buf
- */
-static size_t
-transmit_message_to_ats (void *cls, size_t size, void *buf)
+do_reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
{
- struct GNUNET_ATS_PerformanceHandle *ph = cls;
- struct PendingMessage *p;
- size_t ret;
- char *cbuf;
-
- ph->th = NULL;
- ret = 0;
- cbuf = buf;
- while ((NULL != (p = ph->pending_head)) && (p->size <= size))
+ struct GNUNET_ATS_ReservationContext *rc;
+ struct GNUNET_ATS_AddressListHandle *alh;
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
+
+ if (NULL != ph->mq)
{
- memcpy (&cbuf[ret], &p[1], p->size);
- ret += p->size;
- size -= p->size;
- GNUNET_CONTAINER_DLL_remove(ph->pending_head, ph->pending_tail, p);
- GNUNET_free(p);
+ GNUNET_MQ_destroy (ph->mq);
+ ph->mq = NULL;
}
- do_transmit (ph);
- return ret;
+ while (NULL != (rc = ph->reservation_head))
+ {
+ GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
+ ph->reservation_tail,
+ rc);
+ if (NULL != rc->rcb)
+ rc->rcb (rc->rcb_cls,
+ NULL,
+ 0,
+ GNUNET_TIME_UNIT_FOREVER_REL);
+ GNUNET_free (rc);
+ }
+ bandwidth_zero.value__ = htonl (0);
+ while (NULL != (alh = ph->addresslist_head))
+ {
+ GNUNET_CONTAINER_DLL_remove (ph->addresslist_head,
+ ph->addresslist_tail,
+ alh);
+ if (NULL != alh->cb)
+ alh->cb (alh->cb_cls,
+ NULL,
+ GNUNET_NO,
+ bandwidth_zero,
+ bandwidth_zero,
+ NULL);
+ GNUNET_free (alh);
+ }
+ if (NULL != ph->addr_info_cb)
+ {
+ /* Indicate reconnect */
+ ph->addr_info_cb (ph->addr_info_cb_cls,
+ NULL,
+ GNUNET_NO,
+ bandwidth_zero,
+ bandwidth_zero,
+ NULL);
+ }
+ ph->backoff = GNUNET_TIME_STD_BACKOFF (ph->backoff);
+ ph->task = GNUNET_SCHEDULER_add_delayed (ph->backoff,
+ &reconnect_task,
+ ph);
}
-/**
- * Transmit messages from the message queue to the service
- * (if there are any, and if we are not already trying).
- *
- * @param ph handle to use
- */
-static void
-do_transmit (struct GNUNET_ATS_PerformanceHandle *ph)
-{
- struct PendingMessage *p;
-
- if (NULL != ph->th)
- return;
- if (NULL == (p = ph->pending_head))
- return;
- if (NULL == ph->client)
- return; /* currently reconnecting */
- ph->th = GNUNET_CLIENT_notify_transmit_ready (ph->client, p->size,
- GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, &transmit_message_to_ats, ph);
-}
/**
* We received a peer information message. Validate and process it.
*
- * @param ph our context with the callback
- * @param msg the message
- * @return GNUNET_OK if the message was well-formed
+ * @param cls our context with the callback
+ * @param pi the message
+ * @return #GNUNET_OK if the message was well-formed
*/
static int
-process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_MessageHeader *msg)
+check_peer_information (void *cls,
+ const struct PeerInformationMessage *pi)
{
- const struct PeerInformationMessage *pi;
- const struct GNUNET_ATS_Information *atsi;
const char *plugin_address;
const char *plugin_name;
- struct GNUNET_HELLO_Address address;
uint16_t plugin_address_length;
uint16_t plugin_name_length;
- uint32_t ats_count;
- int addr_active;
- if (ntohs (msg->size) < sizeof(struct PeerInformationMessage))
- {
- GNUNET_break(0);
- return GNUNET_SYSERR;
- }
-
- pi = (const struct PeerInformationMessage *) msg;
- ats_count = ntohl (pi->ats_count);
plugin_address_length = ntohs (pi->address_length);
plugin_name_length = ntohs (pi->plugin_name_length);
- addr_active = ntohl (pi->address_active);
- atsi = (const struct GNUNET_ATS_Information *) &pi[1];
- plugin_address = (const char *) &atsi[ats_count];
+ plugin_address = (const char *) &pi[1];
plugin_name = &plugin_address[plugin_address_length];
- if ((plugin_address_length + plugin_name_length
- + ats_count * sizeof(struct GNUNET_ATS_Information)
- + sizeof(struct PeerInformationMessage) != ntohs (msg->size))
- || (ats_count
- > GNUNET_SERVER_MAX_MESSAGE_SIZE
- / sizeof(struct GNUNET_ATS_Information))
- || (plugin_name[plugin_name_length - 1] != '\0'))
+ if ( (plugin_address_length + plugin_name_length
+ + sizeof(struct PeerInformationMessage) != ntohs (pi->header.size)) ||
+ (plugin_name[plugin_name_length - 1] != '\0'))
{
GNUNET_break(0);
return GNUNET_SYSERR;
}
+ return GNUNET_OK;
+}
- if (NULL != ph->addr_info_cb)
- {
- address.peer = pi->peer;
- address.address = plugin_address;
- address.address_length = plugin_address_length;
- address.transport_name = plugin_name;
- ph->addr_info_cb (ph->addr_info_cb_cls, &address, addr_active,
- pi->bandwidth_out, pi->bandwidth_in, atsi, ats_count);
- }
- return GNUNET_OK;
+/**
+ * We received a peer information message. Validate and process it.
+ *
+ * @param cls our context with the callback
+ * @param pi the message
+ * @return #GNUNET_OK if the message was well-formed
+ */
+static void
+handle_peer_information (void *cls,
+ const struct PeerInformationMessage *pi)
+{
+ struct GNUNET_ATS_PerformanceHandle *ph = cls;
+ const char *plugin_address;
+ const char *plugin_name;
+ struct GNUNET_HELLO_Address address;
+ uint16_t plugin_address_length;
+ int addr_active;
+ struct GNUNET_ATS_Properties prop;
+
+ if (NULL == ph->addr_info_cb)
+ return;
+ plugin_address_length = ntohs (pi->address_length);
+ addr_active = (int) ntohl (pi->address_active);
+ plugin_address = (const char *) &pi[1];
+ plugin_name = &plugin_address[plugin_address_length];
+
+ GNUNET_ATS_properties_ntoh (&prop,
+ &pi->properties);
+ address.peer = pi->peer;
+ address.local_info = (enum GNUNET_HELLO_AddressInfo) ntohl (pi->address_local_info);
+ address.address = plugin_address;
+ address.address_length = plugin_address_length;
+ address.transport_name = plugin_name;
+ ph->addr_info_cb (ph->addr_info_cb_cls,
+ &address,
+ addr_active,
+ pi->bandwidth_out,
+ pi->bandwidth_in,
+ &prop);
}
+
/**
* We received a reservation result message. Validate and process it.
*
- * @param ph our context with the callback
- * @param msg the message
- * @return GNUNET_OK if the message was well-formed
+ * @param cls our context with the callback
+ * @param rr the message
*/
-static int
-process_rr_message (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_MessageHeader *msg)
+static void
+handle_reservation_result (void *cls,
+ const struct ReservationResultMessage *rr)
{
- const struct ReservationResultMessage *rr;
+ struct GNUNET_ATS_PerformanceHandle *ph = cls;
struct GNUNET_ATS_ReservationContext *rc;
int32_t amount;
- if (ntohs (msg->size) < sizeof(struct ReservationResultMessage))
- {
- GNUNET_break(0);
- return GNUNET_SYSERR;
- }
- rr = (const struct ReservationResultMessage *) msg;
amount = ntohl (rr->amount);
rc = ph->reservation_head;
- if (0 != memcmp (&rr->peer, &rc->peer, sizeof(struct GNUNET_PeerIdentity)))
+ if (0 != GNUNET_memcmp (&rr->peer,
+ &rc->peer))
{
GNUNET_break(0);
- return GNUNET_SYSERR;
+ reconnect (ph);
+ return;
}
- GNUNET_CONTAINER_DLL_remove(ph->reservation_head, ph->reservation_tail, rc);
- if ((amount == 0) || (rc->rcb != NULL ))
+ GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
+ ph->reservation_tail,
+ rc);
+ if ( (0 == amount) ||
+ (NULL != rc->rcb) )
{
/* tell client if not cancelled */
- if (rc->rcb != NULL )
- rc->rcb (rc->rcb_cls, &rr->peer, amount,
- GNUNET_TIME_relative_ntoh (rr->res_delay));
- GNUNET_free(rc);
- return GNUNET_OK;
+ if (NULL != rc->rcb)
+ rc->rcb (rc->rcb_cls,
+ &rr->peer,
+ amount,
+ GNUNET_TIME_relative_ntoh (rr->res_delay));
+ GNUNET_free (rc);
+ return;
}
/* amount non-zero, but client cancelled, consider undo! */
if (GNUNET_YES != rc->undo)
{
- GNUNET_free(rc);
- return GNUNET_OK; /* do not try to undo failed undos or negative amounts */
+ GNUNET_free (rc);
+ return; /* do not try to undo failed undos or negative amounts */
}
- GNUNET_free(rc);
- (void) GNUNET_ATS_reserve_bandwidth (ph, &rr->peer, -amount, NULL, NULL );
- return GNUNET_OK;
+ GNUNET_free (rc);
+ (void) GNUNET_ATS_reserve_bandwidth (ph,
+ &rr->peer,
+ -amount,
+ NULL, NULL);
}
+
/**
- * We received a reservation result message. Validate and process it.
+ * We received a PeerInformationMessage. Validate it.
*
- * @param ph our context with the callback
- * @param msg the message
- * @return GNUNET_OK if the message was well-formed
+ * @param cls our context with the callback
+ * @param pi the message
+ * @return #GNUNET_OK if the message was well-formed
*/
static int
-process_ar_message (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_MessageHeader *msg)
+check_address_list (void *cls,
+ const struct PeerInformationMessage *pi)
+{
+ const char *plugin_address;
+ const char *plugin_name;
+ uint16_t plugin_address_length;
+ uint16_t plugin_name_length;
+
+ plugin_address_length = ntohs (pi->address_length);
+ plugin_name_length = ntohs (pi->plugin_name_length);
+ plugin_address = (const char *) &pi[1];
+ plugin_name = &plugin_address[plugin_address_length];
+ if ( (plugin_address_length + plugin_name_length
+ + sizeof (struct PeerInformationMessage) != ntohs (pi->header.size)) ||
+ (plugin_name[plugin_name_length - 1] != '\0') )
+ {
+ GNUNET_break(0);
+ return GNUNET_SYSERR;
+ }
+ return GNUNET_OK;
+}
+
+
+/**
+ * We received a #GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE.
+ * Process it.
+ *
+ * @param cls our context with the callback
+ * @param pi the message
+ */
+static void
+handle_address_list (void *cls,
+ const struct PeerInformationMessage *pi)
{
- const struct PeerInformationMessage *pi;
+ struct GNUNET_ATS_PerformanceHandle *ph = cls;
struct GNUNET_ATS_AddressListHandle *alh;
struct GNUNET_ATS_AddressListHandle *next;
- const struct GNUNET_ATS_Information *atsi;
const char *plugin_address;
const char *plugin_name;
struct GNUNET_HELLO_Address address;
struct GNUNET_PeerIdentity allzeros;
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
+ struct GNUNET_ATS_Properties prop;
uint16_t plugin_address_length;
uint16_t plugin_name_length;
- uint32_t ats_count;
uint32_t active;
uint32_t id;
- if (ntohs (msg->size) < sizeof(struct PeerInformationMessage))
- {
- GNUNET_break(0);
- return GNUNET_SYSERR;
- }
- GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, _("Received %s message\n"),
- "ATS_ADDRESSLIST_RESPONSE");
-
- pi = (const struct PeerInformationMessage *) msg;
id = ntohl (pi->id);
- ats_count = ntohl (pi->ats_count);
active = ntohl (pi->address_active);
plugin_address_length = ntohs (pi->address_length);
plugin_name_length = ntohs (pi->plugin_name_length);
- atsi = (const struct GNUNET_ATS_Information *) &pi[1];
- plugin_address = (const char *) &atsi[ats_count];
+ plugin_address = (const char *) &pi[1];
plugin_name = &plugin_address[plugin_address_length];
- if ((plugin_address_length + plugin_name_length
- + ats_count * sizeof(struct GNUNET_ATS_Information)
- + sizeof(struct PeerInformationMessage) != ntohs (msg->size))
- || (ats_count
- > GNUNET_SERVER_MAX_MESSAGE_SIZE
- / sizeof(struct GNUNET_ATS_Information))
- || (plugin_name[plugin_name_length - 1] != '\0'))
- {
- GNUNET_break(0);
- return GNUNET_SYSERR;
- }
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Received ATS_ADDRESSLIST_RESPONSE message for peer %s and plugin %s\n",
+ GNUNET_i2s (&pi->peer),
+ plugin_name);
next = ph->addresslist_head;
while (NULL != (alh = next))
break;
}
if (NULL == alh)
- {
- /* was canceled */
- return GNUNET_SYSERR;
- }
+ return; /* was canceled */
- memset (&allzeros, '\0', sizeof(allzeros));
- if ((0 == memcmp (&allzeros, &pi->peer, sizeof(allzeros)))
- && (0 == plugin_name_length) && (0 == plugin_address_length)
- && (0 == ats_count))
+ memset (&allzeros, '\0', sizeof (allzeros));
+ if ( (0 == GNUNET_is_zero (&pi->peer)) &&
+ (0 == plugin_name_length) &&
+ (0 == plugin_address_length) )
{
/* Done */
- GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, _("Received last message for %s \n"),
- "ATS_ADDRESSLIST_RESPONSE");
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Received last message for ATS_ADDRESSLIST_RESPONSE\n");
bandwidth_zero.value__ = htonl (0);
+ GNUNET_CONTAINER_DLL_remove (ph->addresslist_head,
+ ph->addresslist_tail,
+ alh);
if (NULL != alh->cb)
- alh->cb (ph->addr_info_cb_cls, NULL, GNUNET_NO, bandwidth_zero,
- bandwidth_zero, NULL, 0);
- GNUNET_CONTAINER_DLL_remove(ph->addresslist_head, ph->addresslist_tail,
- alh);
- GNUNET_free(alh);
- return GNUNET_OK;
+ alh->cb (alh->cb_cls,
+ NULL,
+ GNUNET_NO,
+ bandwidth_zero,
+ bandwidth_zero,
+ NULL);
+ GNUNET_free (alh);
+ return;
}
address.peer = pi->peer;
address.address = plugin_address;
address.address_length = plugin_address_length;
address.transport_name = plugin_name;
-
- if ((GNUNET_YES == alh->all_addresses) || (GNUNET_YES == active))
+ if ( ( (GNUNET_YES == alh->all_addresses) ||
+ (GNUNET_YES == active) ) &&
+ (NULL != alh->cb) )
{
- if (NULL != alh->cb)
- alh->cb (ph->addr_info_cb_cls, &address, active, pi->bandwidth_out,
- pi->bandwidth_in, atsi, ats_count);
+ GNUNET_ATS_properties_ntoh (&prop,
+ &pi->properties);
+ alh->cb (alh->cb_cls,
+ &address,
+ active,
+ pi->bandwidth_out,
+ pi->bandwidth_in,
+ &prop);
}
- return GNUNET_OK;
}
+
/**
- * Type of a function to call when we receive a message
- * from the service.
+ * Generic error handler, called with the appropriate error code and
+ * the same closure specified at the creation of the message queue.
+ * Not every message queue implementation supports an error handler.
*
- * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
- * @param msg message received, NULL on timeout or fatal error
+ * @param cls closure with the `struct GNUNET_ATS_PerformanceHandle *`
+ * @param error error code
*/
static void
-process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
+mq_error_handler (void *cls,
+ enum GNUNET_MQ_Error error)
{
struct GNUNET_ATS_PerformanceHandle *ph = cls;
- if (NULL == msg)
- goto reconnect;
- switch (ntohs (msg->type))
- {
- case GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION:
- if (GNUNET_OK != process_pi_message (ph, msg))
- goto reconnect;
- break;
- case GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT:
- if (GNUNET_OK != process_rr_message (ph, msg))
- goto reconnect;
- break;
- case GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE:
- if (GNUNET_OK != process_ar_message (ph, msg))
- goto reconnect;
- break;
- default:
- GNUNET_break(0);
- goto reconnect;
- }
- GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
- GNUNET_TIME_UNIT_FOREVER_REL);
- return;
- reconnect: if (NULL != ph->th)
- {
- GNUNET_CLIENT_notify_transmit_ready_cancel (ph->th);
- ph->th = NULL;
- }
- GNUNET_CLIENT_disconnect (ph->client);
- ph->client = NULL;
- ph->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
- &reconnect_task, ph);
+ do_reconnect (ph);
}
+
/**
* Re-establish the connection to the ATS service.
*
static void
reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
{
- struct PendingMessage *p;
+ struct GNUNET_MQ_MessageHandler handlers[] = {
+ GNUNET_MQ_hd_var_size (peer_information,
+ GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION,
+ struct PeerInformationMessage,
+ ph),
+ GNUNET_MQ_hd_fixed_size (reservation_result,
+ GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT,
+ struct ReservationResultMessage,
+ ph),
+ GNUNET_MQ_hd_var_size (address_list,
+ GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE,
+ struct PeerInformationMessage,
+ ph),
+ GNUNET_MQ_handler_end ()
+ };
+ struct GNUNET_MQ_Envelope *env;
struct ClientStartMessage *init;
- GNUNET_assert(NULL == ph->client);
- ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
- GNUNET_assert(NULL != ph->client);
- GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
- GNUNET_TIME_UNIT_FOREVER_REL);
- if ((NULL == (p = ph->pending_head)) || (GNUNET_YES != p->is_init))
- {
- p = GNUNET_malloc (sizeof (struct PendingMessage) +
- sizeof (struct ClientStartMessage));
- p->size = sizeof(struct ClientStartMessage);
- p->is_init = GNUNET_YES;
- init = (struct ClientStartMessage *) &p[1];
- init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
- init->header.size = htons (sizeof(struct ClientStartMessage));
- init->start_flag = htonl (
- (NULL == ph->addr_info_cb) ?
- START_FLAG_PERFORMANCE_NO_PIC : START_FLAG_PERFORMANCE_WITH_PIC);
- GNUNET_CONTAINER_DLL_insert(ph->pending_head, ph->pending_tail, p);
- }
- do_transmit (ph);
+ GNUNET_assert (NULL == ph->mq);
+ ph->mq = GNUNET_CLIENT_connect (ph->cfg,
+ "ats",
+ handlers,
+ &mq_error_handler,
+ ph);
+ if (NULL == ph->mq)
+ return;
+ env = GNUNET_MQ_msg (init,
+ GNUNET_MESSAGE_TYPE_ATS_START);
+ init->start_flag = htonl ( (NULL == ph->addr_info_cb)
+ ? START_FLAG_PERFORMANCE_NO_PIC
+ : START_FLAG_PERFORMANCE_WITH_PIC);
+ GNUNET_MQ_send (ph->mq,
+ env);
}
+
/**
* Get handle to access performance API of the ATS subsystem.
*
* @param cfg configuration to use
* @param addr_info_cb callback called when performance characteristics for
* an address change
- * @param addr_info_cb_cls closure for infocb
+ * @param addr_info_cb_cls closure for @a addr_info_cb
* @return ats performance context
*/
struct GNUNET_ATS_PerformanceHandle *
GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
- GNUNET_ATS_AddressInformationCallback addr_info_cb, void *addr_info_cb_cls)
+ GNUNET_ATS_AddressInformationCallback addr_info_cb,
+ void *addr_info_cb_cls)
{
struct GNUNET_ATS_PerformanceHandle *ph;
ph->cfg = cfg;
ph->addr_info_cb = addr_info_cb;
ph->addr_info_cb_cls = addr_info_cb_cls;
- ph->id = 0;
reconnect (ph);
+ if (NULL == ph->mq)
+ {
+ GNUNET_free (ph);
+ return NULL;
+ }
return ph;
}
+
/**
* Client is done using the ATS performance subsystem, release resources.
*
void
GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
{
- struct PendingMessage *p;
struct GNUNET_ATS_ReservationContext *rc;
struct GNUNET_ATS_AddressListHandle *alh;
- while (NULL != (p = ph->pending_head))
- {
- GNUNET_CONTAINER_DLL_remove(ph->pending_head, ph->pending_tail, p);
- GNUNET_free(p);
- }
while (NULL != (alh = ph->addresslist_head))
{
- GNUNET_CONTAINER_DLL_remove(ph->addresslist_head, ph->addresslist_tail,
- alh);
- GNUNET_free(alh);
+ GNUNET_CONTAINER_DLL_remove (ph->addresslist_head,
+ ph->addresslist_tail,
+ alh);
+ GNUNET_free (alh);
}
while (NULL != (rc = ph->reservation_head))
{
- GNUNET_CONTAINER_DLL_remove(ph->reservation_head, ph->reservation_tail, rc);
- GNUNET_break(NULL == rc->rcb);
- GNUNET_free(rc);
+ GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
+ ph->reservation_tail,
+ rc);
+ GNUNET_break (NULL == rc->rcb);
+ GNUNET_free (rc);
}
-
- if (GNUNET_SCHEDULER_NO_TASK != ph->task)
+ if (NULL != ph->task)
{
GNUNET_SCHEDULER_cancel (ph->task);
- ph->task = GNUNET_SCHEDULER_NO_TASK;
+ ph->task = NULL;
}
- if (NULL != ph->client)
+ if (NULL != ph->mq)
{
- GNUNET_CLIENT_disconnect (ph->client);
- ph->client = NULL;
+ GNUNET_MQ_destroy (ph->mq);
+ ph->mq = NULL;
}
- GNUNET_free(ph);
+ GNUNET_free (ph);
}
+
/**
* Reserve inbound bandwidth from the given peer. ATS will look at
* the current amount of traffic we receive from the peer and ensure
- * that the peer could add 'amount' of data to its stream.
+ * that the peer could add @a amount of data to its stream.
*
* @param ph performance handle
* @param peer identifies the peer
* @param amount reserve N bytes for receiving, negative
* amounts can be used to undo a (recent) reservation;
* @param rcb function to call with the resulting reservation information
- * @param rcb_cls closure for info
+ * @param rcb_cls closure for @a rcb
* @return NULL on error
* @deprecated will be replaced soon
*/
struct GNUNET_ATS_ReservationContext *
GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_PeerIdentity *peer, int32_t amount,
- GNUNET_ATS_ReservationCallback rcb, void *rcb_cls)
+ const struct GNUNET_PeerIdentity *peer,
+ int32_t amount,
+ GNUNET_ATS_ReservationCallback rcb,
+ void *rcb_cls)
{
struct GNUNET_ATS_ReservationContext *rc;
- struct PendingMessage *p;
+ struct GNUNET_MQ_Envelope *env;
struct ReservationRequestMessage *m;
+ if (NULL == ph->mq)
+ return NULL;
rc = GNUNET_new (struct GNUNET_ATS_ReservationContext);
rc->size = amount;
rc->peer = *peer;
rc->rcb = rcb;
rc->rcb_cls = rcb_cls;
- if ((rcb != NULL )&& (amount > 0))rc->undo = GNUNET_YES;
- GNUNET_CONTAINER_DLL_insert_tail(ph->reservation_head, ph->reservation_tail,
- rc);
-
- p = GNUNET_malloc (sizeof (struct PendingMessage) +
- sizeof (struct ReservationRequestMessage));
- p->size = sizeof(struct ReservationRequestMessage);
- p->is_init = GNUNET_NO;
- m = (struct ReservationRequestMessage *) &p[1];
- m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST);
- m->header.size = htons (sizeof(struct ReservationRequestMessage));
+ if ( (NULL != rcb) &&
+ (amount > 0) )
+ rc->undo = GNUNET_YES;
+ GNUNET_CONTAINER_DLL_insert_tail (ph->reservation_head,
+ ph->reservation_tail,
+ rc);
+ env = GNUNET_MQ_msg (m,
+ GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST);
m->amount = htonl (amount);
m->peer = *peer;
- GNUNET_CONTAINER_DLL_insert_tail(ph->pending_head, ph->pending_tail, p);
- do_transmit (ph);
+ GNUNET_MQ_send (ph->mq,
+ env);
return rc;
}
+
/**
* Cancel request for reserving bandwidth.
*
- * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
+ * @param rc context returned by the original #GNUNET_ATS_reserve_bandwidth() call
*/
void
GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc)
rc->rcb = NULL;
}
+
/**
* Get information about addresses known to the ATS subsystem.
*
- * @param handle the performance handle to use
+ * @param ph the performance handle to use
* @param peer peer idm can be NULL for all peers
- * @param all GNUNET_YES to get information about all addresses or GNUNET_NO to
+ * @param all #GNUNET_YES to get information about all addresses or #GNUNET_NO to
* get only address currently used
* @param infocb callback to call with the addresses,
* will callback with address == NULL when done
- * @param infocb_cls closure for infocb
+ * @param infocb_cls closure for @a infocb
* @return ats performance context
*/
struct GNUNET_ATS_AddressListHandle*
-GNUNET_ATS_performance_list_addresses (
- struct GNUNET_ATS_PerformanceHandle *handle,
- const struct GNUNET_PeerIdentity *peer, int all,
- GNUNET_ATS_AddressInformationCallback infocb, void *infocb_cls)
+GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *ph,
+ const struct GNUNET_PeerIdentity *peer,
+ int all,
+ GNUNET_ATS_AddressInformationCallback infocb,
+ void *infocb_cls)
{
struct GNUNET_ATS_AddressListHandle *alh;
- struct PendingMessage *p;
+ struct GNUNET_MQ_Envelope *env;
struct AddressListRequestMessage *m;
- GNUNET_assert(NULL != handle);
+ if (NULL == ph->mq)
+ return NULL;
if (NULL == infocb)
- return NULL ;
-
+ {
+ GNUNET_break (0);
+ return NULL;
+ }
alh = GNUNET_new (struct GNUNET_ATS_AddressListHandle);
- alh->id = handle->id;
- handle->id++;
+ alh->id = ph->id++;
alh->cb = infocb;
alh->cb_cls = infocb_cls;
- alh->ph = handle;
+ alh->ph = ph;
alh->all_addresses = all;
if (NULL == peer)
+ {
alh->all_peers = GNUNET_YES;
+ }
else
{
alh->all_peers = GNUNET_NO;
- alh->peer = (*peer);
+ alh->peer = *peer;
}
-
- GNUNET_CONTAINER_DLL_insert(handle->addresslist_head,
- handle->addresslist_tail, alh);
-
- p = GNUNET_malloc (sizeof (struct PendingMessage) +
- sizeof (struct AddressListRequestMessage));
- p->size = sizeof(struct AddressListRequestMessage);
- m = (struct AddressListRequestMessage *) &p[1];
- m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST);
- m->header.size = htons (sizeof(struct AddressListRequestMessage));
+ GNUNET_CONTAINER_DLL_insert (ph->addresslist_head,
+ ph->addresslist_tail,
+ alh);
+ env = GNUNET_MQ_msg (m,
+ GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST);
m->all = htonl (all);
m->id = htonl (alh->id);
if (NULL != peer)
m->peer = *peer;
- else
- {
- memset (&m->peer, '\0', sizeof(struct GNUNET_PeerIdentity));
- }
- GNUNET_CONTAINER_DLL_insert_tail(handle->pending_head, handle->pending_tail,
- p);
-
- do_transmit (handle);
-
+ GNUNET_MQ_send (ph->mq,
+ env);
return alh;
}
+
/**
* Cancel a pending address listing operation
*
- * @param handle the GNUNET_ATS_AddressListHandle handle to cancel
+ * @param alh the handle of the request to cancel
*/
void
-GNUNET_ATS_performance_list_addresses_cancel (
- struct GNUNET_ATS_AddressListHandle *handle)
+GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *alh)
{
- GNUNET_assert(NULL != handle);
+ struct GNUNET_ATS_PerformanceHandle *ph = alh->ph;
- GNUNET_CONTAINER_DLL_remove(handle->ph->addresslist_head,
- handle->ph->addresslist_tail, handle);
- GNUNET_free(handle);
+ GNUNET_CONTAINER_DLL_remove (ph->addresslist_head,
+ ph->addresslist_tail,
+ alh);
+ GNUNET_free (alh);
}
+
/**
- * Convert a GNUNET_ATS_PreferenceType to a string
+ * Convert a `enum GNUNET_ATS_PreferenceType` to a string
*
* @param type the preference type
* @return a string or NULL if invalid
*/
const char *
-GNUNET_ATS_print_preference_type (uint32_t type)
+GNUNET_ATS_print_preference_type (enum GNUNET_ATS_PreferenceKind type)
{
- char *prefs[GNUNET_ATS_PreferenceCount] = GNUNET_ATS_PreferenceTypeString;
- if (type < GNUNET_ATS_PreferenceCount)
+ const char *prefs[] = GNUNET_ATS_PreferenceTypeString;
+
+ if (type < GNUNET_ATS_PREFERENCE_END)
return prefs[type];
- return NULL ;
+ return NULL;
}
+
/**
* Change preferences for the given peer. Preference changes are forgotten if peers
* disconnect.
*
* @param ph performance handle
* @param peer identifies the peer
- * @param ... 0-terminated specification of the desired changes
+ * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the desired changes
*/
void
-GNUNET_ATS_performance_change_preference (
- struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_PeerIdentity *peer, ...)
+GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
+ const struct GNUNET_PeerIdentity *peer,
+ ...)
{
- struct PendingMessage *p;
+ struct GNUNET_MQ_Envelope *env;
struct ChangePreferenceMessage *m;
- size_t msize;
uint32_t count;
struct PreferenceInformation *pi;
va_list ap;
enum GNUNET_ATS_PreferenceKind kind;
+ if (NULL == ph->mq)
+ return;
count = 0;
va_start(ap, peer);
- while (GNUNET_ATS_PREFERENCE_END != (kind =
- va_arg (ap, enum GNUNET_ATS_PreferenceKind) ))
+ while (GNUNET_ATS_PREFERENCE_END !=
+ (kind = GNUNET_VA_ARG_ENUM (ap, GNUNET_ATS_PreferenceKind) ))
{
switch (kind)
{
case GNUNET_ATS_PREFERENCE_BANDWIDTH:
count++;
(void) va_arg (ap, double);
-
break;
case GNUNET_ATS_PREFERENCE_LATENCY:
count++;
(void) va_arg (ap, double);
-
break;
default:
GNUNET_assert(0);
}
}
va_end(ap);
- msize = count * sizeof(struct PreferenceInformation)
- + sizeof(struct ChangePreferenceMessage);
- p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
- p->size = msize;
- p->is_init = GNUNET_NO;
- m = (struct ChangePreferenceMessage *) &p[1];
- m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE);
- m->header.size = htons (msize);
+ env = GNUNET_MQ_msg_extra (m,
+ count * sizeof(struct PreferenceInformation),
+ GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE);
m->num_preferences = htonl (count);
m->peer = *peer;
pi = (struct PreferenceInformation *) &m[1];
count = 0;
va_start(ap, peer);
while (GNUNET_ATS_PREFERENCE_END != (kind =
- va_arg (ap, enum GNUNET_ATS_PreferenceKind) ))
+ GNUNET_VA_ARG_ENUM (ap, GNUNET_ATS_PreferenceKind) ))
{
pi[count].preference_kind = htonl (kind);
switch (kind)
}
}
va_end(ap);
- GNUNET_CONTAINER_DLL_insert_tail(ph->pending_head, ph->pending_tail, p);
- do_transmit (ph);
+ GNUNET_MQ_send (ph->mq,
+ env);
}
+
/**
* Send feedback to ATS on how good a the requirements for a peer and a
* preference is satisfied by ATS
* @param ph performance handle
* @param scope the time interval this valid for: [now - scope .. now]
* @param peer identifies the peer
- * @param ... 0-terminated specification of the desired changes
+ * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the desired changes
*/
void
GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_TIME_Relative scope, ...)
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_TIME_Relative scope,
+ ...)
{
- struct PendingMessage *p;
+ struct GNUNET_MQ_Envelope *env;
struct FeedbackPreferenceMessage *m;
- size_t msize;
uint32_t count;
struct PreferenceInformation *pi;
va_list ap;
enum GNUNET_ATS_PreferenceKind kind;
+ if (NULL == ph->mq)
+ return;
count = 0;
va_start(ap, scope);
- while (GNUNET_ATS_PREFERENCE_END != (kind =
- va_arg (ap, enum GNUNET_ATS_PreferenceKind) ))
+ while (GNUNET_ATS_PREFERENCE_END !=
+ (kind = GNUNET_VA_ARG_ENUM (ap, GNUNET_ATS_PreferenceKind) ))
{
switch (kind)
{
case GNUNET_ATS_PREFERENCE_BANDWIDTH:
count++;
(void) va_arg (ap, double);
-
break;
case GNUNET_ATS_PREFERENCE_LATENCY:
count++;
(void) va_arg (ap, double);
-
break;
default:
GNUNET_assert(0);
}
}
va_end(ap);
- msize = count * sizeof(struct PreferenceInformation)
- + sizeof(struct FeedbackPreferenceMessage);
- p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
- p->size = msize;
- p->is_init = GNUNET_NO;
- m = (struct FeedbackPreferenceMessage *) &p[1];
- m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK);
- m->header.size = htons (msize);
+ env = GNUNET_MQ_msg_extra (m,
+ count * sizeof(struct PreferenceInformation),
+ GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK);
m->scope = GNUNET_TIME_relative_hton (scope);
m->num_feedback = htonl (count);
m->peer = *peer;
count = 0;
va_start(ap, scope);
while (GNUNET_ATS_PREFERENCE_END != (kind =
- va_arg (ap, enum GNUNET_ATS_PreferenceKind) ))
+ GNUNET_VA_ARG_ENUM (ap, GNUNET_ATS_PreferenceKind) ))
{
pi[count].preference_kind = htonl (kind);
switch (kind)
}
}
va_end(ap);
- GNUNET_CONTAINER_DLL_insert_tail(ph->pending_head, ph->pending_tail, p);
- do_transmit (ph);
+ GNUNET_MQ_send (ph->mq,
+ env);
}
/* end of ats_api_performance.c */
projects / oweals / gnunet.git / blobdiff