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
152 * @param h logger handle
155 trigger_flush_notification (struct GNUNET_TESTBED_LOGGER_Handle *h)
157 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
158 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
159 h->flush_completion_task = GNUNET_SCHEDULER_add_now (&call_flush_completion, h);
164 * Function called to notify a client about the connection begin ready to queue
165 * more data. "buf" will be NULL and "size" zero if the connection was closed
166 * for writing in the meantime.
169 * @param size number of bytes available in buf
170 * @param buf where the callee should write the message
171 * @return number of bytes written to buf
174 transmit_ready_notify (void *cls, size_t size, void *buf)
176 struct GNUNET_TESTBED_LOGGER_Handle *h = cls;
177 struct MessageQueue *mq;
181 GNUNET_assert (NULL != mq);
182 if ((0 == size) && (NULL == buf)) /* Timeout */
184 LOG_DEBUG ("Message sending timed out -- retrying\n");
185 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
187 GNUNET_CLIENT_notify_transmit_ready (h->client,
188 ntohs (mq->msg->size),
189 h->retry_backoff, GNUNET_YES,
190 &transmit_ready_notify, h);
193 h->retry_backoff = GNUNET_TIME_UNIT_ZERO;
194 GNUNET_assert (ntohs (mq->msg->size) <= size);
195 size = ntohs (mq->msg->size);
196 memcpy (buf, mq->msg, size);
197 LOG_DEBUG ("Message of type: %u and size: %u sent\n",
198 ntohs (mq->msg->type), size);
199 GNUNET_free (mq->msg);
200 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
206 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
208 GNUNET_CLIENT_notify_transmit_ready (h->client,
209 ntohs (mq->msg->size),
210 h->retry_backoff, GNUNET_YES,
211 &transmit_ready_notify, h);
215 trigger_flush_notification (h); /* Call the flush completion callback */
221 * Queues a message in send queue of the logger handle
223 * @param h the logger handle
224 * @param msg the message to queue
227 queue_message (struct GNUNET_TESTBED_LOGGER_Handle *h,
228 struct GNUNET_MessageHeader *msg)
230 struct MessageQueue *mq;
234 type = ntohs (msg->type);
235 size = ntohs (msg->size);
236 mq = GNUNET_malloc (sizeof (struct MessageQueue));
238 LOG (GNUNET_ERROR_TYPE_DEBUG,
239 "Queueing message of type %u, size %u for sending\n", type,
241 GNUNET_CONTAINER_DLL_insert_tail (h->mq_head, h->mq_tail, mq);
244 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
246 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
247 h->retry_backoff, GNUNET_YES,
248 &transmit_ready_notify,
255 * Send the buffered data to the service
257 * @param h the logger handle
260 dispatch_buffer (struct GNUNET_TESTBED_LOGGER_Handle *h)
262 struct GNUNET_MessageHeader *msg;
265 msize = sizeof (struct GNUNET_MessageHeader) + h->bs;
266 msg = GNUNET_realloc (h->buf, msize);
268 memmove (&msg[1], msg, h->bs);
270 msg->type = htons (GNUNET_MESSAGE_TYPE_TESTBED_LOGGER_MSG);
271 msg->size = htons (msize);
272 queue_message (h, msg);
277 * Connect to the testbed logger service
279 * @param cfg configuration to use
280 * @return the handle which can be used for sending data to the service; NULL
283 struct GNUNET_TESTBED_LOGGER_Handle *
284 GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
286 struct GNUNET_TESTBED_LOGGER_Handle *h;
287 struct GNUNET_CLIENT_Connection *client;
289 client = GNUNET_CLIENT_connect ("testbed-logger", cfg);
292 h = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_LOGGER_Handle));
299 * Disconnect from the logger service.
301 * @param h the logger handle
304 GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h)
306 struct MessageQueue *mq;
308 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
309 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
310 while (NULL != (mq = h->mq_head))
312 GNUNET_CONTAINER_DLL_remove (h->mq_head, h->mq_tail, mq);
313 GNUNET_free (mq->msg);
316 GNUNET_CLIENT_disconnect (h->client);
322 * Send data to be logged to the logger service. The data will be buffered and
323 * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
324 * exceeding a threshold size.
326 * @param h the logger handle
327 * @param data the data to send;
328 * @param size how many bytes of data to send
331 GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
332 const void *data, size_t size)
336 GNUNET_assert (0 != size);
337 GNUNET_assert (NULL != data);
338 GNUNET_assert (size < (GNUNET_SERVER_MAX_MESSAGE_SIZE
339 - sizeof (struct GNUNET_MessageHeader)));
340 fit_size = sizeof (struct GNUNET_MessageHeader) + h->bs + size;
341 if ( GNUNET_SERVER_MAX_MESSAGE_SIZE < fit_size )
345 h->buf = GNUNET_malloc (size);
347 memcpy (h->buf, data, size);
350 h->buf = GNUNET_realloc (h->buf, h->bs + size);
351 memcpy (h->buf + h->bs, data, size);
358 * Flush the buffered data to the logger service
360 * @param h the logger handle
361 * @param cb the callback to call after the data is flushed
362 * @param cb_cls the closure for the above callback
365 GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
366 GNUNET_TESTBED_LOGGER_FlushCompletion cb,
373 trigger_flush_notification (h);
381 * Cancel notification upon flush.
383 * @param h the logger handle
386 GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h)
388 if (GNUNET_SCHEDULER_NO_TASK != h->flush_completion_task)
390 GNUNET_SCHEDULER_cancel (h->flush_completion_task);
391 h->flush_completion_task = GNUNET_SCHEDULER_NO_TASK;
397 /* End of testbed_logger_api.c */