2 This file is part of GNUnet
3 (C) 2008--2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file testbed/testbed_logger_api.c
23 * @brief Client-side routines for communicating with the tesbted logger service
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
28 #include "gnunet_util_lib.h"
29 #include "gnunet_testbed_logger_service.h"
32 * Generic logging shorthand
34 #define LOG(kind, ...) \
35 GNUNET_log_from (kind, "testbed-logger-api", __VA_ARGS__)
40 #define LOG_DEBUG(...) \
41 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
43 #ifdef GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD
44 #undef GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD
48 * Threshold after which exponential backoff should not increase (15 s).
50 #define GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
54 * The message queue for sending messages to the controller service
59 * next pointer for DLL
61 struct MessageQueue *next;
64 * prev pointer for DLL
66 struct MessageQueue *prev;
69 * The message to be sent
71 struct GNUNET_MessageHeader *msg;
76 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
86 * Connection handle for the logger service
88 struct GNUNET_TESTBED_LOGGER_Handle
93 struct GNUNET_CLIENT_Connection *client;
96 * The transport handle
98 struct GNUNET_CLIENT_TransmitHandle *th;
101 * DLL head for the message queue
103 struct MessageQueue *mq_head;
106 * DLL tail for the message queue
108 struct MessageQueue *mq_tail;
111 * Flush completion callback
113 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
116 * Closure for the above callback
121 * Local buffer for data to be transmitted
126 * The size of the local buffer
131 * Number of bytes wrote since last flush
136 * How long after should we retry sending a message to the service?
138 struct GNUNET_TIME_Relative retry_backoff;
141 * Task to call the flush completion callback
143 GNUNET_SCHEDULER_TaskIdentifier flush_completion_task;
146 * Task to be executed when flushing takes too long
148 GNUNET_SCHEDULER_TaskIdentifier timeout_flush_task;
153 * Cancels the flush timeout task
155 * @param h handle to the logger
158 cancel_timeout_flush (struct GNUNET_TESTBED_LOGGER_Handle *h)
160 GNUNET_SCHEDULER_cancel (h->timeout_flush_task);
161 h->timeout_flush_task = GNUNET_SCHEDULER_NO_TASK;
166 * Task to call the flush completion notification
168 * @param cls the logger handle
169 * @param tc the scheduler task context
172 call_flush_completion (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
174 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
175 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
179 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
186 if (GNUNET_SCHEDULER_NO_TASK != h->timeout_flush_task)
187 cancel_timeout_flush (h);
194 * Schedule the flush completion notification task
196 * @param h logger handle
199 trigger_flush_notification (struct GNUNET_TESTBED_LOGGER_Handle *h)
201 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
202 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
203 h->flush_completion_task = GNUNET_SCHEDULER_add_now (&call_flush_completion, h);
208 * Function called to notify a client about the connection begin ready to queue
209 * more data. "buf" will be NULL and "size" zero if the connection was closed
210 * for writing in the meantime.
213 * @param size number of bytes available in buf
214 * @param buf where the callee should write the message
215 * @return number of bytes written to buf
218 transmit_ready_notify (void *cls, size_t size, void *buf)
220 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
221 struct MessageQueue *mq;
225 GNUNET_assert (NULL != mq);
226 if ((0 == size) && (NULL == buf)) /* Timeout */
228 LOG_DEBUG ("Message sending timed out -- retrying\n");
229 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
231 GNUNET_CLIENT_notify_transmit_ready (h->client,
232 ntohs (mq->msg->size),
233 h->retry_backoff, GNUNET_YES,
234 &transmit_ready_notify, h);
237 h->retry_backoff = GNUNET_TIME_UNIT_ZERO;
238 GNUNET_assert (ntohs (mq->msg->size) <= size);
239 size = ntohs (mq->msg->size);
240 memcpy (buf, mq->msg, size);
241 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
242 ntohs (mq->msg->type), size);
243 GNUNET_free (mq->msg);
244 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
246 h->bwrote += (size - sizeof (struct GNUNET_MessageHeader));
250 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
252 GNUNET_CLIENT_notify_transmit_ready (h->client,
253 ntohs (mq->msg->size),
254 h->retry_backoff, GNUNET_YES,
255 &transmit_ready_notify, h);
259 trigger_flush_notification (h); /* Call the flush completion callback */
265 * Queues a message in send queue of the logger handle
267 * @param h the logger handle
268 * @param msg the message to queue
271 queue_message (struct GNUNET_TESTBED_LOGGER_Handle *h,
272 struct GNUNET_MessageHeader *msg)
274 struct MessageQueue *mq;
278 type = ntohs (msg->type);
279 size = ntohs (msg->size);
280 mq = GNUNET_malloc (sizeof (struct MessageQueue));
282 LOG (GNUNET_ERROR_TYPE_DEBUG,
283 "Queueing message of type %u, size %u for sending\n", type,
285 GNUNET_CONTAINER_DLL_insert_tail (h->mq_head, h->mq_tail, mq);
288 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
290 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
291 h->retry_backoff, GNUNET_YES,
292 &transmit_ready_notify,
299 * Send the buffered data to the service
301 * @param h the logger handle
304 dispatch_buffer (struct GNUNET_TESTBED_LOGGER_Handle *h)
306 struct GNUNET_MessageHeader *msg;
309 msize = sizeof (struct GNUNET_MessageHeader) + h->bs;
310 msg = GNUNET_realloc (h->buf, msize);
312 memmove (&msg[1], msg, h->bs);
314 msg->type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LOGGER_MSG);
315 msg->size = htons (msize);
316 queue_message (h, msg);
321 * Connect to the testbed logger service
323 * @param cfg configuration to use
324 * @return the handle which can be used for sending data to the service; NULL
327 struct GNUNET_TESTBED_LOGGER_Handle *
328 GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
330 struct GNUNET_TESTBED_LOGGER_Handle *h;
331 struct GNUNET_CLIENT_Connection *client;
333 client = GNUNET_CLIENT_connect ("testbed-logger", cfg);
336 h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_LOGGER_Handle));
343 * Disconnect from the logger service.
345 * @param h the logger handle
348 GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h)
350 struct MessageQueue *mq;
352 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
353 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
354 while (NULL != (mq = h->mq_head))
356 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
357 GNUNET_free (mq->msg);
360 GNUNET_CLIENT_disconnect (h->client);
366 * Send data to be logged to the logger service. The data will be buffered and
367 * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
368 * exceeding a threshold size.
370 * @param h the logger handle
371 * @param data the data to send;
372 * @param size how many bytes of data to send
375 GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
376 const void *data, size_t size)
380 GNUNET_assert (0 != size);
381 GNUNET_assert (NULL != data);
382 GNUNET_assert (size < (GNUNET_SERVER_MAX_MESSAGE_SIZE
383 - sizeof (struct GNUNET_MessageHeader)));
384 fit_size = sizeof (struct GNUNET_MessageHeader) + h->bs + size;
385 if ( GNUNET_SERVER_MAX_MESSAGE_SIZE < fit_size )
389 h->buf = GNUNET_malloc (size);
391 memcpy (h->buf, data, size);
394 h->buf = GNUNET_realloc (h->buf, h->bs + size);
395 memcpy (h->buf + h->bs, data, size);
402 * Task to be executed when flushing our local buffer takes longer than timeout
403 * given to GNUNET_TESTBED_LOGGER_flush(). The flush completion callback will
404 * be called with 0 as the amount of data sent.
406 * @param cls the logger handle
407 * @param tc scheduler task context
410 timeout_flush (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
412 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
413 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
416 h->timeout_flush_task = GNUNET_SCHEDULER_NO_TASK;
421 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
423 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
424 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
432 * Flush the buffered data to the logger service
434 * @param h the logger handle
435 * @param timeout how long to wait before calling the flust completion callback
436 * @param cb the callback to call after the data is flushed
437 * @param cb_cls the closure for the above callback
440 GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
441 struct GNUNET_TIME_Relative timeout,
442 GNUNET_TESTBED_LOGGER_FlushCompletion cb,
447 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->timeout_flush_task);
448 h->timeout_flush_task =
449 GNUNET_SCHEDULER_add_delayed (timeout, &timeout_flush, h);
452 trigger_flush_notification (h);
460 * Cancel notification upon flush. Should only be used when the flush
461 * completion callback given to GNUNET_TESTBED_LOGGER_flush() is not already
464 * @param h the logger handle
467 GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h)
469 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
471 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
472 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
474 if (GNUNET_SCHEDULER_NO_TASK != h->timeout_flush_task)
475 cancel_timeout_flush (h);
480 /* End of testbed_logger_api.c */