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;
95 struct GNUNET_CLIENT_TransmitHandle *th;
98 * DLL head for the message queue
100 struct MessageQueue *mq_head;
103 * DLL tail for the message queue
105 struct MessageQueue *mq_tail;
107 GNUNET_SCHEDULER_TaskIdentifier flush_completion_task;
109 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
119 struct GNUNET_TIME_Relative retry_backoff;
124 * Task to call the flush completion notification
126 * @param cls the logger handle
127 * @param tc the scheduler task context
130 call_flush_completion (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
132 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
133 GNUNET_TESTBED_LOGGER_FlushCompletion cb;
137 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
150 * Schedule the flush completion notification task
156 trigger_flush_notification (struct GNUNET_TESTBED_LOGGER_Handle *h)
158 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
159 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
160 h->flush_completion_task = GNUNET_SCHEDULER_add_now (&call_flush_completion, h);
165 * Function called to notify a client about the connection begin ready to queue
166 * more data. "buf" will be NULL and "size" zero if the connection was closed
167 * for writing in the meantime.
170 * @param size number of bytes available in buf
171 * @param buf where the callee should write the message
172 * @return number of bytes written to buf
175 transmit_ready_notify (void *cls, size_t size, void *buf)
177 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
178 struct MessageQueue *mq;
182 GNUNET_assert (NULL != mq);
183 if ((0 == size) && (NULL == buf)) /* Timeout */
185 LOG_DEBUG ("Message sending timed out -- retrying\n");
186 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
188 GNUNET_CLIENT_notify_transmit_ready (h->client,
189 ntohs (mq->msg->size),
190 h->retry_backoff, GNUNET_YES,
191 &transmit_ready_notify, h);
194 h->retry_backoff = GNUNET_TIME_UNIT_ZERO;
195 GNUNET_assert (ntohs (mq->msg->size) <= size);
196 size = ntohs (mq->msg->size);
197 memcpy (buf, mq->msg, size);
198 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
199 ntohs (mq->msg->type), size);
200 GNUNET_free (mq->msg);
201 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
207 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
209 GNUNET_CLIENT_notify_transmit_ready (h->client,
210 ntohs (mq->msg->size),
211 h->retry_backoff, GNUNET_YES,
212 &transmit_ready_notify, h);
216 trigger_flush_notification (h); /* Call the flush completion callback */
222 * Queues a message in send queue of the logger handle
224 * @param h the logger handle
225 * @param msg the message to queue
228 queue_message (struct GNUNET_TESTBED_LOGGER_Handle *h,
229 struct GNUNET_MessageHeader *msg)
231 struct MessageQueue *mq;
235 type = ntohs (msg->type);
236 size = ntohs (msg->size);
237 mq = GNUNET_malloc (sizeof (struct MessageQueue));
239 LOG (GNUNET_ERROR_TYPE_DEBUG,
240 "Queueing message of type %u, size %u for sending\n", type,
242 GNUNET_CONTAINER_DLL_insert_tail (h->mq_head, h->mq_tail, mq);
245 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
247 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
248 h->retry_backoff, GNUNET_YES,
249 &transmit_ready_notify,
256 * Send the buffered data to the service
258 * @param h the logger handle
261 dispatch_buffer (struct GNUNET_TESTBED_LOGGER_Handle *h)
263 struct GNUNET_MessageHeader *msg;
266 msize = sizeof (struct GNUNET_MessageHeader) + h->bs;
267 msg = GNUNET_realloc (h->buf, msize);
269 memmove (&msg[1], msg, h->bs);
271 msg->type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LOGGER_MSG);
272 msg->size = htons (msize);
273 queue_message (h, msg);
278 * Connect to the testbed logger service
280 * @param cfg configuration to use
281 * @return the handle which can be used for sending data to the service; NULL
284 struct GNUNET_TESTBED_LOGGER_Handle *
285 GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
287 struct GNUNET_TESTBED_LOGGER_Handle *h;
288 struct GNUNET_CLIENT_Connection *client;
290 client = GNUNET_CLIENT_connect ("testbed-logger", cfg);
293 h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_LOGGER_Handle));
300 * Disconnect from the logger service.
302 * @param h the logger handle
305 GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h)
307 struct MessageQueue *mq;
309 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
310 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
311 while (NULL != (mq = h->mq_head))
313 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
314 GNUNET_free (mq->msg);
317 GNUNET_CLIENT_disconnect (h->client);
323 * Send data to be logged to the logger service. The data will be buffered and
324 * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
325 * exceeding a threshold size.
327 * @param h the logger handle
328 * @param data the data to send;
329 * @param size how many bytes of data to send
330 * @param cb the callback to be called upon completion of the send request
331 * @param cb_cls the closure for the above callback
332 * @return the send handle which can used for cancelling the send operation.
333 * Will be invalid if upon call to completion callback
336 GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
337 const void *data, size_t size)
341 GNUNET_assert (0 != size);
342 GNUNET_assert (NULL != data);
343 GNUNET_assert (size < (GNUNET_SERVER_MAX_MESSAGE_SIZE
344 - sizeof (struct GNUNET_MessageHeader)));
345 fit_size = sizeof (struct GNUNET_MessageHeader) + h->bs + size;
346 if ( GNUNET_SERVER_MAX_MESSAGE_SIZE < fit_size )
350 h->buf = GNUNET_malloc (size);
352 memcpy (h->buf, data, size);
355 h->buf = GNUNET_realloc (h->buf, h->bs + size);
356 memcpy (h->buf + h->bs, data, size);
363 * Flush the buffered data to the logger service
365 * @param h the logger handle
366 * @param cb the callback to call after the data is flushed
367 * @param cb_cls the closure for the above callback
370 GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
371 GNUNET_TESTBED_LOGGER_FlushCompletion cb,
378 trigger_flush_notification (h);
386 * Cancel notification upon flush.
388 * @param h the logger handle
391 GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h)
393 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
395 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
396 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
402 /* End of testbed_logger_api.c */