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
159 cancel_timeout_flush (struct GNUNET_TESTBED_LOGGER_Handle *h)
161 GNUNET_SCHEDULER_cancel (h->timeout_flush_task);
162 h->timeout_flush_task = GNUNET_SCHEDULER_NO_TASK;
167 * Task to call the flush completion notification
169 * @param cls the logger handle
170 * @param tc the scheduler task context
173 call_flush_completion (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
175 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
176 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
180 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
187 if (GNUNET_SCHEDULER_NO_TASK != h->timeout_flush_task)
188 cancel_timeout_flush (h);
195 * Schedule the flush completion notification task
197 * @param h logger handle
200 trigger_flush_notification (struct GNUNET_TESTBED_LOGGER_Handle *h)
202 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
203 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
204 h->flush_completion_task = GNUNET_SCHEDULER_add_now (&call_flush_completion, h);
209 * Function called to notify a client about the connection begin ready to queue
210 * more data. "buf" will be NULL and "size" zero if the connection was closed
211 * for writing in the meantime.
214 * @param size number of bytes available in buf
215 * @param buf where the callee should write the message
216 * @return number of bytes written to buf
219 transmit_ready_notify (void *cls, size_t size, void *buf)
221 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
222 struct MessageQueue *mq;
226 GNUNET_assert (NULL != mq);
227 if ((0 == size) && (NULL == buf)) /* Timeout */
229 LOG_DEBUG ("Message sending timed out -- retrying\n");
230 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
232 GNUNET_CLIENT_notify_transmit_ready (h->client,
233 ntohs (mq->msg->size),
234 h->retry_backoff, GNUNET_YES,
235 &transmit_ready_notify, h);
238 h->retry_backoff = GNUNET_TIME_UNIT_ZERO;
239 GNUNET_assert (ntohs (mq->msg->size) <= size);
240 size = ntohs (mq->msg->size);
241 memcpy (buf, mq->msg, size);
242 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
243 ntohs (mq->msg->type), size);
244 GNUNET_free (mq->msg);
245 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
247 h->bwrote += (size - sizeof (struct GNUNET_MessageHeader));
251 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
253 GNUNET_CLIENT_notify_transmit_ready (h->client,
254 ntohs (mq->msg->size),
255 h->retry_backoff, GNUNET_YES,
256 &transmit_ready_notify, h);
260 trigger_flush_notification (h); /* Call the flush completion callback */
266 * Queues a message in send queue of the logger handle
268 * @param h the logger handle
269 * @param msg the message to queue
272 queue_message (struct GNUNET_TESTBED_LOGGER_Handle *h,
273 struct GNUNET_MessageHeader *msg)
275 struct MessageQueue *mq;
279 type = ntohs (msg->type);
280 size = ntohs (msg->size);
281 mq = GNUNET_malloc (sizeof (struct MessageQueue));
283 LOG (GNUNET_ERROR_TYPE_DEBUG,
284 "Queueing message of type %u, size %u for sending\n", type,
286 GNUNET_CONTAINER_DLL_insert_tail (h->mq_head, h->mq_tail, mq);
289 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
291 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
292 h->retry_backoff, GNUNET_YES,
293 &transmit_ready_notify,
300 * Send the buffered data to the service
302 * @param h the logger handle
305 dispatch_buffer (struct GNUNET_TESTBED_LOGGER_Handle *h)
307 struct GNUNET_MessageHeader *msg;
310 msize = sizeof (struct GNUNET_MessageHeader) + h->bs;
311 msg = GNUNET_realloc (h->buf, msize);
313 memmove (&msg[1], msg, h->bs);
315 msg->type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LOGGER_MSG);
316 msg->size = htons (msize);
317 queue_message (h, msg);
322 * Connect to the testbed logger service
324 * @param cfg configuration to use
325 * @return the handle which can be used for sending data to the service; NULL
328 struct GNUNET_TESTBED_LOGGER_Handle *
329 GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
331 struct GNUNET_TESTBED_LOGGER_Handle *h;
332 struct GNUNET_CLIENT_Connection *client;
334 client = GNUNET_CLIENT_connect ("testbed-logger", cfg);
337 h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_LOGGER_Handle));
344 * Disconnect from the logger service.
346 * @param h the logger handle
349 GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h)
351 struct MessageQueue *mq;
353 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
354 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
355 while (NULL != (mq = h->mq_head))
357 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
358 GNUNET_free (mq->msg);
361 GNUNET_CLIENT_disconnect (h->client);
367 * Send data to be logged to the logger service. The data will be buffered and
368 * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
369 * exceeding a threshold size.
371 * @param h the logger handle
372 * @param data the data to send;
373 * @param size how many bytes of data to send
376 GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
377 const void *data, size_t size)
381 GNUNET_assert (0 != size);
382 GNUNET_assert (NULL != data);
383 GNUNET_assert (size < (GNUNET_SERVER_MAX_MESSAGE_SIZE
384 - sizeof (struct GNUNET_MessageHeader)));
385 fit_size = sizeof (struct GNUNET_MessageHeader) + h->bs + size;
386 if ( GNUNET_SERVER_MAX_MESSAGE_SIZE < fit_size )
390 h->buf = GNUNET_malloc (size);
392 memcpy (h->buf, data, size);
395 h->buf = GNUNET_realloc (h->buf, h->bs + size);
396 memcpy (h->buf + h->bs, data, size);
403 * Task to be executed when flushing our local buffer takes longer than timeout
404 * given to GNUNET_TESTBED_LOGGER_flush(). The flush completion callback will
405 * be called with 0 as the amount of data sent.
407 * @param cls the logger handle
408 * @param tc scheduler task context
411 timeout_flush (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
413 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
414 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
417 h->timeout_flush_task = GNUNET_SCHEDULER_NO_TASK;
422 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
424 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
425 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
433 * Flush the buffered data to the logger service
435 * @param h the logger handle
436 * @param timeout how long to wait before calling the flust completion callback
437 * @param cb the callback to call after the data is flushed
438 * @param cb_cls the closure for the above callback
441 GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
442 struct GNUNET_TIME_Relative timeout,
443 GNUNET_TESTBED_LOGGER_FlushCompletion cb,
448 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->timeout_flush_task);
449 h->timeout_flush_task =
450 GNUNET_SCHEDULER_add_delayed (timeout, &timeout_flush, h);
453 trigger_flush_notification (h);
461 * Cancel notification upon flush. Should only be used when the flush
462 * completion callback given to GNUNET_TESTBED_LOGGER_flush() is not already
465 * @param h the logger handle
468 GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h)
470 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
472 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
473 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
475 if (GNUNET_SCHEDULER_NO_TASK != h->timeout_flush_task)
476 cancel_timeout_flush (h);
481 /* End of testbed_logger_api.c */