2 * This file is part of GNUnet
3 * Copyright (C) 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 psyc/psyc_util_lib.c
23 * @brief PSYC utilities; receiving/transmitting/logging PSYC messages.
24 * @author Gabor X Toth
30 #include "gnunet_util_lib.h"
31 #include "gnunet_env_lib.h"
32 #include "gnunet_psyc_service.h"
33 #include "gnunet_psyc_util_lib.h"
35 #define LOG(kind,...) GNUNET_log_from (kind, "psyc-util",__VA_ARGS__)
38 struct GNUNET_PSYC_TransmitHandle
41 * Client connection to service.
43 struct GNUNET_CLIENT_MANAGER_Connection *client;
46 * Message currently being received from the client.
48 struct GNUNET_MessageHeader *msg;
51 * Callback to request next modifier from client.
53 GNUNET_PSYC_TransmitNotifyModifier notify_mod;
56 * Closure for the notify callbacks.
61 * Callback to request next data fragment from client.
63 GNUNET_PSYC_TransmitNotifyData notify_data;
66 * Closure for the notify callbacks.
68 void *notify_data_cls;
71 * Modifier of the environment that is currently being transmitted.
73 struct GNUNET_ENV_Modifier *mod;
78 const char *mod_value;
81 * Number of bytes remaining to be transmitted from the current modifier value.
83 uint32_t mod_value_remaining;
86 * State of the current message being received from client.
88 enum GNUNET_PSYC_MessageState state;
91 * Number of PSYC_TRANSMIT_ACK messages we are still waiting for.
96 * Is transmission paused?
101 * Are we currently transmitting a message?
108 struct GNUNET_PSYC_ReceiveHandle
113 GNUNET_PSYC_MessageCallback message_cb;
116 * Message part callback.
118 GNUNET_PSYC_MessagePartCallback message_part_cb;
121 * Closure for the callbacks.
126 * ID of the message being received from the PSYC service.
131 * Public key of the slave from which a message is being received.
133 struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
136 * State of the currently being received message from the PSYC service.
138 enum GNUNET_PSYC_MessageState state;
141 * Flags for the currently being received message from the PSYC service.
143 enum GNUNET_PSYC_MessageFlags flags;
146 * Expected value size for the modifier being received from the PSYC service.
148 uint32_t mod_value_size_expected;
151 * Actual value size for the modifier being received from the PSYC service.
153 uint32_t mod_value_size;
161 * Create a PSYC message.
164 * PSYC method for the message.
166 * Environment for the message.
168 * Data payload for the message.
172 * @return Message header with size information,
173 * followed by the message parts.
175 struct GNUNET_PSYC_Message *
176 GNUNET_PSYC_message_create (const char *method_name,
177 const struct GNUNET_ENV_Environment *env,
181 struct GNUNET_ENV_Modifier *mod = NULL;
182 struct GNUNET_PSYC_MessageMethod *pmeth = NULL;
183 struct GNUNET_PSYC_MessageModifier *pmod = NULL;
184 struct GNUNET_MessageHeader *pmsg = NULL;
185 uint16_t env_size = 0;
188 mod = GNUNET_ENV_environment_head (env);
191 env_size += sizeof (*pmod) + strlen (mod->name) + 1 + mod->value_size;
196 struct GNUNET_PSYC_Message *msg;
197 uint16_t method_name_size = strlen (method_name) + 1;
198 if (method_name_size == 1)
201 uint16_t msg_size = sizeof (*msg) /* header */
202 + sizeof (*pmeth) + method_name_size /* method */
203 + env_size /* modifiers */
204 + ((0 < data_size) ? sizeof (*pmsg) + data_size : 0)/* data */
205 + sizeof (*pmsg); /* end of message */
206 msg = GNUNET_malloc (msg_size);
207 msg->header.size = htons (msg_size);
208 msg->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE); /* FIXME */
210 pmeth = (struct GNUNET_PSYC_MessageMethod *) &msg[1];
211 pmeth->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD);
212 pmeth->header.size = htons (sizeof (*pmeth) + method_name_size);
213 memcpy (&pmeth[1], method_name, method_name_size);
215 uint16_t p = sizeof (*msg) + sizeof (*pmeth) + method_name_size;
218 mod = GNUNET_ENV_environment_head (env);
221 uint16_t mod_name_size = strlen (mod->name) + 1;
222 pmod = (struct GNUNET_PSYC_MessageModifier *) ((char *) msg + p);
223 pmod->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER);
224 pmod->header.size = sizeof (*pmod) + mod_name_size + mod->value_size;
225 p += pmod->header.size;
226 pmod->header.size = htons (pmod->header.size);
228 memcpy (&pmod[1], mod->name, mod_name_size);
229 if (0 < mod->value_size)
230 memcpy ((char *) &pmod[1] + mod_name_size, mod->value, mod->value_size);
238 pmsg = (struct GNUNET_MessageHeader *) ((char *) msg + p);
239 pmsg->size = sizeof (*pmsg) + data_size;
241 pmsg->size = htons (pmsg->size);
242 pmsg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA);
243 memcpy (&pmsg[1], data, data_size);
246 pmsg = (struct GNUNET_MessageHeader *) ((char *) msg + p);
247 pmsg->size = htons (sizeof (*pmsg));
248 pmsg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END);
250 GNUNET_assert (p + sizeof (*pmsg) == msg_size);
256 GNUNET_PSYC_log_message (enum GNUNET_ErrorType kind,
257 const struct GNUNET_MessageHeader *msg)
259 uint16_t size = ntohs (msg->size);
260 uint16_t type = ntohs (msg->type);
261 GNUNET_log (kind, "Message of type %d and size %u:\n", type, size);
264 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE:
266 struct GNUNET_PSYC_MessageHeader *pmsg
267 = (struct GNUNET_PSYC_MessageHeader *) msg;
268 GNUNET_log (kind, "\tID: %" PRIu64 "\tflags: %x" PRIu32 "\n",
269 GNUNET_ntohll (pmsg->message_id), ntohl (pmsg->flags));
272 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD:
274 struct GNUNET_PSYC_MessageMethod *meth
275 = (struct GNUNET_PSYC_MessageMethod *) msg;
276 GNUNET_log (kind, "\t%.*s\n", size - sizeof (*meth), &meth[1]);
279 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER:
281 struct GNUNET_PSYC_MessageModifier *mod
282 = (struct GNUNET_PSYC_MessageModifier *) msg;
283 uint16_t name_size = ntohs (mod->name_size);
284 char oper = ' ' < mod->oper ? mod->oper : ' ';
285 GNUNET_log (kind, "\t%c%.*s\t%.*s\n", oper, name_size, &mod[1],
286 size - sizeof (*mod) - name_size,
287 ((char *) &mod[1]) + name_size);
290 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT:
291 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA:
292 GNUNET_log (kind, "\t%.*s\n", size - sizeof (*msg), &msg[1]);
298 /**** Transmitting messages ****/
302 * Create a transmission handle.
304 struct GNUNET_PSYC_TransmitHandle *
305 GNUNET_PSYC_transmit_create (struct GNUNET_CLIENT_MANAGER_Connection *client)
307 struct GNUNET_PSYC_TransmitHandle *tmit = GNUNET_malloc (sizeof (*tmit));
308 tmit->client = client;
314 * Destroy a transmission handle.
317 GNUNET_PSYC_transmit_destroy (struct GNUNET_PSYC_TransmitHandle *tmit)
324 * Queue a message part for transmission.
326 * The message part is added to the current message buffer.
327 * When this buffer is full, it is added to the transmission queue.
330 * Transmission handle.
332 * Message part, or NULL.
335 * #GNUNET_YES or #GNUNET_NO.
338 transmit_queue_insert (struct GNUNET_PSYC_TransmitHandle *tmit,
339 const struct GNUNET_MessageHeader *msg,
342 uint16_t size = (NULL != msg) ? ntohs (msg->size) : 0;
344 LOG (GNUNET_ERROR_TYPE_DEBUG,
345 "Queueing message part of type %u and size %u (end: %u)).\n",
346 ntohs (msg->type), size, end);
348 if (NULL != tmit->msg)
351 || GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD < tmit->msg->size + size)
353 /* End of message or buffer is full, add it to transmission queue
354 * and start with empty buffer */
355 tmit->msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE);
356 tmit->msg->size = htons (tmit->msg->size);
357 GNUNET_CLIENT_MANAGER_transmit (tmit->client, tmit->msg);
359 tmit->acks_pending++;
363 /* Message fits in current buffer, append */
364 tmit->msg = GNUNET_realloc (tmit->msg, tmit->msg->size + size);
365 memcpy ((char *) tmit->msg + tmit->msg->size, msg, size);
366 tmit->msg->size += size;
370 if (NULL == tmit->msg && NULL != msg)
372 /* Empty buffer, copy over message. */
373 tmit->msg = GNUNET_malloc (sizeof (*tmit->msg) + size);
374 tmit->msg->size = sizeof (*tmit->msg) + size;
375 memcpy (&tmit->msg[1], msg, size);
378 if (NULL != tmit->msg
379 && (GNUNET_YES == end
380 || (GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD
381 < tmit->msg->size + sizeof (struct GNUNET_MessageHeader))))
383 /* End of message or buffer is full, add it to transmission queue. */
384 tmit->msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE);
385 tmit->msg->size = htons (tmit->msg->size);
386 GNUNET_CLIENT_MANAGER_transmit (tmit->client, tmit->msg);
388 tmit->acks_pending++;
391 if (GNUNET_YES == end)
392 tmit->in_transmit = GNUNET_NO;
397 * Request data from client to transmit.
399 * @param tmit Transmission handle.
402 transmit_data (struct GNUNET_PSYC_TransmitHandle *tmit)
404 uint16_t data_size = GNUNET_PSYC_DATA_MAX_PAYLOAD;
405 char data[GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD] = "";
406 struct GNUNET_MessageHeader *msg = (struct GNUNET_MessageHeader *) data;
407 msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA);
409 int notify_ret = tmit->notify_data (tmit->notify_data_cls, &data_size, &msg[1]);
410 LOG (GNUNET_ERROR_TYPE_DEBUG,
411 "transmit_data (ret: %d, size: %u): %.*s\n",
412 notify_ret, data_size, data_size, &msg[1]);
418 /* Transmission paused, nothing to send. */
419 tmit->paused = GNUNET_YES;
425 tmit->state = GNUNET_PSYC_MESSAGE_STATE_END;
429 LOG (GNUNET_ERROR_TYPE_ERROR,
430 "TransmitNotifyData callback returned error when requesting data.\n");
432 tmit->state = GNUNET_PSYC_MESSAGE_STATE_CANCEL;
433 msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_CANCEL);
434 msg->size = htons (sizeof (*msg));
435 transmit_queue_insert (tmit, msg, GNUNET_YES);
441 GNUNET_assert (data_size <= GNUNET_PSYC_DATA_MAX_PAYLOAD);
442 msg->size = htons (sizeof (*msg) + data_size);
443 transmit_queue_insert (tmit, msg, !notify_ret);
446 /* End of message. */
447 if (GNUNET_YES == notify_ret)
449 msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END);
450 msg->size = htons (sizeof (*msg));
451 transmit_queue_insert (tmit, msg, GNUNET_YES);
457 * Request a modifier from a client to transmit.
459 * @param tmit Transmission handle.
462 transmit_mod (struct GNUNET_PSYC_TransmitHandle *tmit)
464 uint16_t max_data_size, data_size;
465 char data[GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD] = "";
466 struct GNUNET_MessageHeader *msg = (struct GNUNET_MessageHeader *) data;
471 case GNUNET_PSYC_MESSAGE_STATE_MODIFIER:
473 struct GNUNET_PSYC_MessageModifier *mod
474 = (struct GNUNET_PSYC_MessageModifier *) msg;
475 max_data_size = data_size = GNUNET_PSYC_MODIFIER_MAX_PAYLOAD;
476 msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER);
477 msg->size = sizeof (struct GNUNET_PSYC_MessageModifier);
478 notify_ret = tmit->notify_mod (tmit->notify_mod_cls, &data_size, &mod[1],
479 &mod->oper, &mod->value_size);
481 mod->name_size = strnlen ((char *) &mod[1], data_size) + 1;
482 LOG (GNUNET_ERROR_TYPE_DEBUG,
483 "transmit_mod (ret: %d, size: %u + %u): %.*s\n",
484 notify_ret, mod->name_size, mod->value_size, data_size, &mod[1]);
485 if (mod->name_size < data_size)
487 tmit->mod_value_remaining
488 = mod->value_size - (data_size - mod->name_size);
489 mod->value_size = htonl (mod->value_size);
490 mod->name_size = htons (mod->name_size);
492 else if (0 < data_size)
494 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got invalid modifier name.\n");
495 notify_ret = GNUNET_SYSERR;
499 case GNUNET_PSYC_MESSAGE_STATE_MOD_CONT:
501 max_data_size = data_size = GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD;
502 msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT);
503 msg->size = sizeof (struct GNUNET_MessageHeader);
504 notify_ret = tmit->notify_mod (tmit->notify_mod_cls,
505 &data_size, &msg[1], NULL, NULL);
506 tmit->mod_value_remaining -= data_size;
507 LOG (GNUNET_ERROR_TYPE_DEBUG,
508 "transmit_mod (ret: %d, size: %u): %.*s\n",
509 notify_ret, data_size, data_size, &msg[1]);
520 { /* Transmission paused, nothing to send. */
521 tmit->paused = GNUNET_YES;
525 = (0 == tmit->mod_value_remaining)
526 ? GNUNET_PSYC_MESSAGE_STATE_MODIFIER
527 : GNUNET_PSYC_MESSAGE_STATE_MOD_CONT;
530 case GNUNET_YES: /* End of modifiers. */
531 GNUNET_assert (0 == tmit->mod_value_remaining);
535 LOG (GNUNET_ERROR_TYPE_ERROR,
536 "TransmitNotifyModifier callback returned with error.\n");
538 tmit->state = GNUNET_PSYC_MESSAGE_STATE_CANCEL;
539 msg->type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_CANCEL);
540 msg->size = htons (sizeof (*msg));
542 transmit_queue_insert (tmit, msg, GNUNET_YES);
548 GNUNET_assert (data_size <= max_data_size);
549 msg->size = htons (msg->size + data_size);
550 transmit_queue_insert (tmit, msg, GNUNET_NO);
553 if (GNUNET_YES == notify_ret)
555 tmit->state = GNUNET_PSYC_MESSAGE_STATE_DATA;
556 if (0 == tmit->acks_pending)
557 transmit_data (tmit);
567 transmit_notify_env (void *cls, uint16_t *data_size, void *data, uint8_t *oper,
568 uint32_t *full_value_size)
571 struct GNUNET_PSYC_TransmitHandle *tmit = cls;
572 uint16_t name_size = 0;
573 size_t value_size = 0;
574 const char *value = NULL;
578 if (NULL != tmit->mod)
579 tmit->mod = tmit->mod->next;
580 if (NULL == tmit->mod)
581 { /* No more modifiers, continue with data */
586 GNUNET_assert (tmit->mod->value_size < UINT32_MAX);
587 *full_value_size = tmit->mod->value_size;
588 *oper = tmit->mod->oper;
589 name_size = strlen (tmit->mod->name) + 1;
591 if (name_size + tmit->mod->value_size <= *data_size)
593 *data_size = name_size + tmit->mod->value_size;
597 value_size = *data_size - name_size;
598 tmit->mod_value = tmit->mod->value + value_size;
601 memcpy (data, tmit->mod->name, name_size);
602 memcpy ((char *)data + name_size, tmit->mod->value, value_size);
606 { /* Modifier continuation */
607 GNUNET_assert (NULL != tmit->mod_value && 0 < tmit->mod_value_remaining);
608 value = tmit->mod_value;
609 if (tmit->mod_value_remaining <= *data_size)
611 value_size = tmit->mod_value_remaining;
612 tmit->mod_value = NULL;
616 value_size = *data_size;
617 tmit->mod_value += value_size;
620 if (*data_size < value_size)
622 LOG (GNUNET_ERROR_TYPE_DEBUG,
623 "Value in environment larger than buffer: %u < %zu\n",
624 *data_size, value_size);
629 *data_size = value_size;
630 memcpy (data, value, value_size);
631 return (NULL == tmit->mod_value) ? GNUNET_YES : GNUNET_NO;
637 * Transmit a message.
640 * Transmission handle.
642 * Which method should be invoked.
644 * Environment for the message.
645 * Should stay available until the first call to notify_data.
646 * Can be NULL if there are no modifiers or @a notify_mod is
649 * Function to call to obtain modifiers.
650 * Can be NULL if there are no modifiers or @a env is provided instead.
652 * Function to call to obtain fragments of the data.
654 * Closure for @a notify_mod and @a notify_data.
656 * Flags for the message being transmitted.
658 * @return #GNUNET_OK if the transmission was started.
659 * #GNUNET_SYSERR if another transmission is already going on.
662 GNUNET_PSYC_transmit_message (struct GNUNET_PSYC_TransmitHandle *tmit,
663 const char *method_name,
664 const struct GNUNET_ENV_Environment *env,
665 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
666 GNUNET_PSYC_TransmitNotifyData notify_data,
670 if (GNUNET_NO != tmit->in_transmit)
671 return GNUNET_SYSERR;
672 tmit->in_transmit = GNUNET_YES;
674 size_t size = strlen (method_name) + 1;
675 struct GNUNET_PSYC_MessageMethod *pmeth;
676 tmit->msg = GNUNET_malloc (sizeof (*tmit->msg) + sizeof (*pmeth) + size);
677 tmit->msg->size = sizeof (*tmit->msg) + sizeof (*pmeth) + size;
679 pmeth = (struct GNUNET_PSYC_MessageMethod *) &tmit->msg[1];
680 pmeth->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD);
681 pmeth->header.size = htons (sizeof (*pmeth) + size);
682 pmeth->flags = htonl (flags);
683 memcpy (&pmeth[1], method_name, size);
685 tmit->state = GNUNET_PSYC_MESSAGE_STATE_MODIFIER;
686 tmit->notify_data = notify_data;
687 tmit->notify_data_cls = notify_cls;
689 if (NULL != notify_mod)
691 tmit->notify_mod = notify_mod;
692 tmit->notify_mod_cls = notify_cls;
696 tmit->notify_mod = &transmit_notify_env;
697 tmit->notify_mod_cls = tmit;
700 struct GNUNET_ENV_Modifier mod = {};
701 mod.next = GNUNET_ENV_environment_head (env);
716 * Resume transmission.
718 * @param tmit Transmission handle.
721 GNUNET_PSYC_transmit_resume (struct GNUNET_PSYC_TransmitHandle *tmit)
723 if (0 == tmit->acks_pending)
725 tmit->paused = GNUNET_NO;
726 transmit_data (tmit);
732 * Abort transmission request.
734 * @param tmit Transmission handle.
737 GNUNET_PSYC_transmit_cancel (struct GNUNET_PSYC_TransmitHandle *tmit)
739 if (GNUNET_NO == tmit->in_transmit)
742 tmit->state = GNUNET_PSYC_MESSAGE_STATE_CANCEL;
743 tmit->in_transmit = GNUNET_NO;
744 tmit->paused = GNUNET_NO;
747 struct GNUNET_MessageHeader msg;
748 msg.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA);
749 msg.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_CANCEL);
750 msg.size = htons (sizeof (msg));
751 transmit_queue_insert (tmit, &msg, GNUNET_YES);
756 * Got acknowledgement of a transmitted message part, continue transmission.
758 * @param tmit Transmission handle.
761 GNUNET_PSYC_transmit_got_ack (struct GNUNET_PSYC_TransmitHandle *tmit)
763 if (0 == tmit->acks_pending)
765 LOG (GNUNET_ERROR_TYPE_WARNING, "Ignoring extraneous message ACK\n");
769 tmit->acks_pending--;
773 case GNUNET_PSYC_MESSAGE_STATE_MODIFIER:
774 case GNUNET_PSYC_MESSAGE_STATE_MOD_CONT:
775 if (GNUNET_NO == tmit->paused)
779 case GNUNET_PSYC_MESSAGE_STATE_DATA:
780 if (GNUNET_NO == tmit->paused)
781 transmit_data (tmit);
784 case GNUNET_PSYC_MESSAGE_STATE_END:
785 case GNUNET_PSYC_MESSAGE_STATE_CANCEL:
789 LOG (GNUNET_ERROR_TYPE_DEBUG,
790 "Ignoring message ACK in state %u.\n", tmit->state);
795 /**** Receiving messages ****/
799 * Create handle for receiving messages.
801 struct GNUNET_PSYC_ReceiveHandle *
802 GNUNET_PSYC_receive_create (GNUNET_PSYC_MessageCallback message_cb,
803 GNUNET_PSYC_MessagePartCallback message_part_cb,
806 struct GNUNET_PSYC_ReceiveHandle *recv = GNUNET_malloc (sizeof (*recv));
807 recv->message_cb = message_cb;
808 recv->message_part_cb = message_part_cb;
809 recv->cb_cls = cb_cls;
815 * Destroy handle for receiving messages.
818 GNUNET_PSYC_receive_destroy (struct GNUNET_PSYC_ReceiveHandle *recv)
825 * Reset stored data related to the last received message.
828 GNUNET_PSYC_receive_reset (struct GNUNET_PSYC_ReceiveHandle *recv)
830 recv->state = GNUNET_PSYC_MESSAGE_STATE_START;
832 recv->message_id = 0;
833 recv->mod_value_size = 0;
834 recv->mod_value_size_expected = 0;
839 recv_error (struct GNUNET_PSYC_ReceiveHandle *recv)
841 if (NULL != recv->message_part_cb)
842 recv->message_part_cb (recv->cb_cls, recv->message_id, 0, recv->flags, NULL);
844 if (NULL != recv->message_cb)
845 recv->message_cb (recv->cb_cls, recv->message_id, recv->flags, NULL);
847 GNUNET_PSYC_receive_reset (recv);
852 * Handle incoming PSYC message.
854 * @param recv Receive handle.
855 * @param msg The message.
857 * @return #GNUNET_OK on success,
858 * #GNUNET_SYSERR on receive error.
861 GNUNET_PSYC_receive_message (struct GNUNET_PSYC_ReceiveHandle *recv,
862 const struct GNUNET_PSYC_MessageHeader *msg)
864 uint16_t size = ntohs (msg->header.size);
865 uint32_t flags = ntohl (msg->flags);
868 GNUNET_PSYC_log_message (GNUNET_ERROR_TYPE_DEBUG,
869 (struct GNUNET_MessageHeader *) msg);
871 if (GNUNET_PSYC_MESSAGE_STATE_START == recv->state)
873 recv->message_id = GNUNET_ntohll (msg->message_id);
875 recv->slave_key = msg->slave_key;
876 recv->mod_value_size = 0;
877 recv->mod_value_size_expected = 0;
879 else if (GNUNET_ntohll (msg->message_id) != recv->message_id)
882 LOG (GNUNET_ERROR_TYPE_WARNING,
883 "Unexpected message ID. Got: %" PRIu64 ", expected: %" PRIu64 "\n",
884 GNUNET_ntohll (msg->message_id), recv->message_id);
887 return GNUNET_SYSERR;
889 else if (flags != recv->flags)
891 LOG (GNUNET_ERROR_TYPE_WARNING,
892 "Unexpected message flags. Got: %lu, expected: %lu\n",
896 return GNUNET_SYSERR;
898 message_id = recv->message_id;
900 uint16_t pos = 0, psize = 0, ptype, size_eq, size_min;
902 for (pos = 0; sizeof (*msg) + pos < size; pos += psize)
904 const struct GNUNET_MessageHeader *pmsg
905 = (const struct GNUNET_MessageHeader *) ((char *) &msg[1] + pos);
906 psize = ntohs (pmsg->size);
907 ptype = ntohs (pmsg->type);
908 size_eq = size_min = 0;
910 if (psize < sizeof (*pmsg) || sizeof (*msg) + pos + psize > size)
912 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
913 "Dropping message of type %u with invalid size %u.\n",
916 return GNUNET_SYSERR;
919 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
920 "Received message part from PSYC.\n");
921 GNUNET_PSYC_log_message (GNUNET_ERROR_TYPE_DEBUG, pmsg);
925 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD:
926 size_min = sizeof (struct GNUNET_PSYC_MessageMethod);
928 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER:
929 size_min = sizeof (struct GNUNET_PSYC_MessageModifier);
931 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT:
932 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA:
933 size_min = sizeof (struct GNUNET_MessageHeader);
935 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END:
936 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_CANCEL:
937 size_eq = sizeof (struct GNUNET_MessageHeader);
942 return GNUNET_SYSERR;
945 if (! ((0 < size_eq && psize == size_eq)
946 || (0 < size_min && size_min <= psize)))
950 return GNUNET_SYSERR;
955 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD:
957 struct GNUNET_PSYC_MessageMethod *meth
958 = (struct GNUNET_PSYC_MessageMethod *) pmsg;
960 if (GNUNET_PSYC_MESSAGE_STATE_START != recv->state)
962 LOG (GNUNET_ERROR_TYPE_WARNING,
963 "Dropping out of order message method (%u).\n",
965 /* It is normal to receive an incomplete message right after connecting,
966 * but should not happen later.
967 * FIXME: add a check for this condition.
971 return GNUNET_SYSERR;
974 if ('\0' != *((char *) meth + psize - 1))
976 LOG (GNUNET_ERROR_TYPE_WARNING,
977 "Dropping message with malformed method. "
978 "Message ID: %" PRIu64 "\n", recv->message_id);
981 return GNUNET_SYSERR;
983 recv->state = GNUNET_PSYC_MESSAGE_STATE_METHOD;
986 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER:
988 if (!(GNUNET_PSYC_MESSAGE_STATE_METHOD == recv->state
989 || GNUNET_PSYC_MESSAGE_STATE_MODIFIER == recv->state
990 || GNUNET_PSYC_MESSAGE_STATE_MOD_CONT == recv->state))
992 LOG (GNUNET_ERROR_TYPE_WARNING,
993 "Dropping out of order message modifier (%u).\n",
997 return GNUNET_SYSERR;
1000 struct GNUNET_PSYC_MessageModifier *mod
1001 = (struct GNUNET_PSYC_MessageModifier *) pmsg;
1003 uint16_t name_size = ntohs (mod->name_size);
1004 recv->mod_value_size_expected = ntohl (mod->value_size);
1005 recv->mod_value_size = psize - sizeof (*mod) - name_size;
1007 if (psize < sizeof (*mod) + name_size
1008 || '\0' != *((char *) &mod[1] + name_size - 1)
1009 || recv->mod_value_size_expected < recv->mod_value_size)
1011 LOG (GNUNET_ERROR_TYPE_WARNING, "Dropping malformed modifier.\n");
1012 GNUNET_break_op (0);
1014 return GNUNET_SYSERR;
1016 recv->state = GNUNET_PSYC_MESSAGE_STATE_MODIFIER;
1019 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT:
1021 recv->mod_value_size += psize - sizeof (*pmsg);
1023 if (!(GNUNET_PSYC_MESSAGE_STATE_MODIFIER == recv->state
1024 || GNUNET_PSYC_MESSAGE_STATE_MOD_CONT == recv->state)
1025 || recv->mod_value_size_expected < recv->mod_value_size)
1027 LOG (GNUNET_ERROR_TYPE_WARNING,
1028 "Dropping out of order message modifier continuation "
1029 "!(%u == %u || %u == %u) || %lu < %lu.\n",
1030 GNUNET_PSYC_MESSAGE_STATE_MODIFIER, recv->state,
1031 GNUNET_PSYC_MESSAGE_STATE_MOD_CONT, recv->state,
1032 recv->mod_value_size_expected, recv->mod_value_size);
1033 GNUNET_break_op (0);
1035 return GNUNET_SYSERR;
1039 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA:
1041 if (recv->state < GNUNET_PSYC_MESSAGE_STATE_METHOD
1042 || recv->mod_value_size_expected != recv->mod_value_size)
1044 LOG (GNUNET_ERROR_TYPE_WARNING,
1045 "Dropping out of order message data fragment "
1046 "(%u < %u || %lu != %lu).\n",
1047 recv->state, GNUNET_PSYC_MESSAGE_STATE_METHOD,
1048 recv->mod_value_size_expected, recv->mod_value_size);
1050 GNUNET_break_op (0);
1052 return GNUNET_SYSERR;
1054 recv->state = GNUNET_PSYC_MESSAGE_STATE_DATA;
1059 if (NULL != recv->message_part_cb)
1060 recv->message_part_cb (recv->cb_cls, recv->message_id, 0, // FIXME: data_offset
1065 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END:
1066 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_CANCEL:
1067 GNUNET_PSYC_receive_reset (recv);
1072 if (NULL != recv->message_cb)
1073 recv->message_cb (recv->cb_cls, message_id, flags, msg);
1079 * Check if @a data contains a series of valid message parts.
1081 * @param data_size Size of @a data.
1083 * @param[out] first_ptype Type of first message part.
1084 * @param[out] last_ptype Type of last message part.
1086 * @return Number of message parts found in @a data.
1087 * or GNUNET_SYSERR if the message contains invalid parts.
1090 GNUNET_PSYC_receive_check_parts (uint16_t data_size, const char *data,
1091 uint16_t *first_ptype, uint16_t *last_ptype)
1093 const struct GNUNET_MessageHeader *pmsg;
1094 uint16_t parts = 0, ptype = 0, psize = 0, pos = 0;
1095 if (NULL != first_ptype)
1097 if (NULL != last_ptype)
1100 for (pos = 0; pos < data_size; pos += psize, parts++)
1102 pmsg = (const struct GNUNET_MessageHeader *) (data + pos);
1103 GNUNET_PSYC_log_message (GNUNET_ERROR_TYPE_DEBUG, pmsg);
1104 psize = ntohs (pmsg->size);
1105 ptype = ntohs (pmsg->type);
1106 if (0 == parts && NULL != first_ptype)
1107 *first_ptype = ptype;
1108 if (NULL != last_ptype
1109 && *last_ptype < GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END)
1110 *last_ptype = ptype;
1111 if (psize < sizeof (*pmsg)
1112 || pos + psize > data_size
1113 || ptype < GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
1114 || GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_CANCEL < ptype)
1116 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1117 "Invalid message part of type %u and size %u.\n",
1119 return GNUNET_SYSERR;
1121 /* FIXME: check message part order */
1127 struct ParseMessageClosure
1129 struct GNUNET_ENV_Environment *env;
1130 const char **method_name;
1132 uint16_t *data_size;
1133 enum GNUNET_PSYC_MessageState msg_state;
1138 parse_message_part_cb (void *cls, uint64_t message_id, uint64_t data_offset,
1139 uint32_t flags, const struct GNUNET_MessageHeader *msg)
1141 struct ParseMessageClosure *pmc = cls;
1144 pmc->msg_state = GNUNET_PSYC_MESSAGE_STATE_ERROR;
1148 switch (ntohs (msg->type))
1150 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD:
1152 struct GNUNET_PSYC_MessageMethod *
1153 pmeth = (struct GNUNET_PSYC_MessageMethod *) msg;
1154 *pmc->method_name = (const char *) &pmeth[1];
1155 pmc->msg_state = GNUNET_PSYC_MESSAGE_STATE_METHOD;
1159 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER:
1161 struct GNUNET_PSYC_MessageModifier *
1162 pmod = (struct GNUNET_PSYC_MessageModifier *) msg;
1164 const char *name = (const char *) &pmod[1];
1165 const void *value = name + pmod->name_size;
1166 GNUNET_ENV_environment_add (pmc->env, pmod->oper, name, value,
1168 pmc->msg_state = GNUNET_PSYC_MESSAGE_STATE_MODIFIER;
1172 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA:
1173 *pmc->data = &msg[1];
1174 *pmc->data_size = ntohs (msg->size) - sizeof (*msg);
1175 pmc->msg_state = GNUNET_PSYC_MESSAGE_STATE_DATA;
1178 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END:
1179 pmc->msg_state = GNUNET_PSYC_MESSAGE_STATE_END;
1183 pmc->msg_state = GNUNET_PSYC_MESSAGE_STATE_ERROR;
1189 * Parse PSYC message.
1192 * The PSYC message to parse.
1193 * @param[out] method_name
1194 * Pointer to the method name inside @a pmsg.
1196 * The environment for the message with a list of modifiers.
1198 * Pointer to data inside @a pmsg.
1199 * @param[out] data_size
1200 * Size of @data is written here.
1202 * @return #GNUNET_OK on success,
1203 * #GNUNET_SYSERR on parse error.
1206 GNUNET_PSYC_message_parse (const struct GNUNET_PSYC_Message *msg,
1207 const char **method_name,
1208 struct GNUNET_ENV_Environment *env,
1210 uint16_t *data_size)
1212 struct ParseMessageClosure cls;
1214 cls.method_name = method_name;
1216 cls.data_size = data_size;
1218 uint16_t msg_size = ntohs (msg->header.size);
1219 struct GNUNET_PSYC_MessageHeader *
1220 pmsg = GNUNET_malloc (sizeof (*pmsg) + msg_size - sizeof (*msg));
1221 memcpy (&pmsg[1], &msg[1], msg_size - sizeof (*msg));
1223 struct GNUNET_PSYC_ReceiveHandle *
1224 recv = GNUNET_PSYC_receive_create (NULL, &parse_message_part_cb, &cls);
1225 GNUNET_PSYC_receive_message (recv, pmsg);
1226 GNUNET_PSYC_receive_destroy (recv);
1229 return (GNUNET_PSYC_MESSAGE_STATE_END == cls.msg_state)