GNUnet  0.11.x
gnunet_mq_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2012-2016 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
35 #ifndef GNUNET_MQ_LIB_H
36 #define GNUNET_MQ_LIB_H
37 
38 #include "gnunet_scheduler_lib.h"
39 
52 #define GNUNET_MQ_msg_extra(mvar, esize, type) \
53  GNUNET_MQ_msg_ (((struct GNUNET_MessageHeader **) &(mvar)), \
54  (esize) + sizeof *(mvar), \
55  (type))
56 
67 #define GNUNET_MQ_msg(mvar, type) GNUNET_MQ_msg_extra (mvar, 0, type)
68 
69 
76 #define GNUNET_MQ_msg_header(type) \
77  GNUNET_MQ_msg_ (NULL, sizeof(struct GNUNET_MessageHeader), type)
78 
79 
88 #define GNUNET_MQ_msg_header_extra(mh, esize, type) \
89  GNUNET_MQ_msg_ (&mh, (esize) + sizeof(struct GNUNET_MessageHeader), type)
90 
91 
102 #define GNUNET_MQ_msg_nested_mh(mvar, type, mh) \
103  ({ \
104  struct GNUNET_MQ_Envelope *_ev; \
105  _ev = GNUNET_MQ_msg_nested_mh_ ((struct GNUNET_MessageHeader **) &(mvar), \
106  sizeof(*(mvar)), \
107  (type), \
108  (mh)); \
109  (void) (mvar)->header; /* type check */ \
110  _ev; \
111  })
112 
113 
122 #define GNUNET_MQ_extract_nested_mh(var) \
123  GNUNET_MQ_extract_nested_mh_ ((struct GNUNET_MessageHeader *) (var), \
124  sizeof(*(var)))
125 
126 
135 const struct GNUNET_MessageHeader *
137  uint16_t base_size);
138 
139 
143 struct GNUNET_MQ_Envelope;
144 
145 
152 const struct GNUNET_MessageHeader *
154 
155 
162 const struct GNUNET_MQ_Envelope *
164 
165 
175 struct GNUNET_MQ_Envelope *
177  uint16_t base_size,
178  uint16_t type,
179  const struct GNUNET_MessageHeader *nested_mh);
180 
181 
185 struct GNUNET_MQ_Handle;
186 
187 
192 {
199 
204 
209 
215 
221 };
222 
223 
228 {
234 
239 
244 
249 
254 
268 
278 
286 
294 
299 };
300 
301 
308 typedef void (*GNUNET_MQ_MessageCallback) (
309  void *cls,
310  const struct GNUNET_MessageHeader *msg);
311 
312 
322  void *cls,
323  const struct GNUNET_MessageHeader *msg);
324 
325 
334 typedef void (*GNUNET_MQ_SendImpl) (struct GNUNET_MQ_Handle *mq,
335  const struct GNUNET_MessageHeader *msg,
336  void *impl_state);
337 
338 
348 typedef void (*GNUNET_MQ_DestroyImpl) (struct GNUNET_MQ_Handle *mq,
349  void *impl_state);
350 
351 
358 typedef void (*GNUNET_MQ_CancelImpl) (struct GNUNET_MQ_Handle *mq,
359  void *impl_state);
360 
361 
371 typedef void (*GNUNET_MQ_ErrorHandler) (void *cls, enum GNUNET_MQ_Error error);
372 
373 
386 void
388  struct GNUNET_MQ_Envelope **env_tail,
389  struct GNUNET_MQ_Envelope *env);
390 
391 
404 void
406  struct GNUNET_MQ_Envelope **env_tail,
407  struct GNUNET_MQ_Envelope *env);
408 
409 
422 void
423 GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head,
424  struct GNUNET_MQ_Envelope **env_tail,
425  struct GNUNET_MQ_Envelope *env);
426 
427 
440 
441 
456  GNUNET_MQ_MessageCallback agpl_handler,
457  void *agpl_cls);
458 
459 
466 unsigned int
468 
469 
474 {
483 
490 
494  void *cls;
495 
499  uint16_t type;
500 
507  uint16_t expected_size;
508 };
509 
510 
514 #define GNUNET_MQ_handler_end() \
515  { \
516  NULL, NULL, NULL, 0, 0 \
517  }
518 
519 
548 #define GNUNET_MQ_hd_fixed_size(name, code, str, ctx) \
549  ({ \
550  void (*_cb)(void *cls, const str *msg) = &handle_ ## name; \
551  ((struct GNUNET_MQ_MessageHandler){ NULL, \
552  (GNUNET_MQ_MessageCallback) _cb, \
553  (ctx), \
554  (code), \
555  sizeof(str) }); \
556  })
557 
558 
599 #define GNUNET_MQ_hd_var_size(name, code, str, ctx) \
600  __extension__ ({ \
601  int (*_mv)(void *cls, const str *msg) = &check_ ## name; \
602  void (*_cb)(void *cls, const str *msg) = &handle_ ## name; \
603  ((struct GNUNET_MQ_MessageHandler){ (GNUNET_MQ_MessageValidationCallback) \
604  _mv, \
605  (GNUNET_MQ_MessageCallback) _cb, \
606  (ctx), \
607  (code), \
608  sizeof(str) }); \
609  })
610 
611 
622 #define GNUNET_MQ_check_zero_termination(m) \
623  { \
624  const char *str = (const char *) &m[1]; \
625  const struct GNUNET_MessageHeader *hdr = \
626  (const struct GNUNET_MessageHeader *) m; \
627  uint16_t slen = ntohs (hdr->size) - sizeof(*m); \
628  if ((0 == slen) || (memchr (str, 0, slen) != &str[slen - 1])) \
629  { \
630  GNUNET_break (0); \
631  return GNUNET_NO; \
632  } \
633  }
634 
635 
648 #define GNUNET_MQ_check_boxed_message(m) \
649  { \
650  const struct GNUNET_MessageHeader *inbox = \
651  (const struct GNUNET_MessageHeader *) &m[1]; \
652  const struct GNUNET_MessageHeader *hdr = \
653  (const struct GNUNET_MessageHeader *) m; \
654  uint16_t slen = ntohs (hdr->size) - sizeof(*m); \
655  if ((slen < sizeof(struct GNUNET_MessageHeader)) || \
656  (slen != ntohs (inbox->size))) \
657  { \
658  GNUNET_break (0); \
659  return GNUNET_NO; \
660  } \
661  }
662 
663 
676 int
678  const struct GNUNET_MessageHeader *mh);
679 
680 
689 struct GNUNET_MQ_Envelope *
691  uint16_t size,
692  uint16_t type);
693 
694 
701 struct GNUNET_MQ_Envelope *
702 GNUNET_MQ_msg_copy (const struct GNUNET_MessageHeader *hdr);
703 
704 
712 void
714 
715 
723 struct GNUNET_MQ_Envelope *
725 
726 
734 struct GNUNET_MQ_Envelope *
736 
737 
744 struct GNUNET_MQ_Envelope *
746 
747 
756 void
759 
760 
769 
770 
782 
783 
791 struct GNUNET_MQ_Envelope *
793 
794 
801 void
804 
805 
812 unsigned int
814 
815 
823 void
824 GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev);
825 
826 
834 void
836  const struct GNUNET_MQ_Envelope *ev);
837 
838 
846 void
848 
849 
856 uint32_t
857 GNUNET_MQ_assoc_add (struct GNUNET_MQ_Handle *mq, void *assoc_data);
858 
859 
867 void *
868 GNUNET_MQ_assoc_get (struct GNUNET_MQ_Handle *mq, uint32_t request_id);
869 
870 
878 void *
879 GNUNET_MQ_assoc_remove (struct GNUNET_MQ_Handle *mq, uint32_t request_id);
880 
881 
894 struct GNUNET_MQ_Handle *
897  GNUNET_MQ_CancelImpl cancel,
898  void *impl_state,
899  const struct GNUNET_MQ_MessageHandler *handlers,
901  void *cls);
902 
903 
911 void
913  void *handlers_cls);
914 
915 
925 void
928  void *cb_cls);
929 
930 
936 void
938 
939 
945 
946 
959  void *cb_cls);
960 
966 void
969 
970 
981 void
983  const struct GNUNET_MessageHeader *mh);
984 
985 
996 void
998  enum GNUNET_MQ_Error error);
999 
1000 
1011 void
1013 
1014 
1025 void
1027 
1028 
1043 void *
1045 
1046 
1056 const struct GNUNET_MessageHeader *
1058 
1059 
1066 {
1071 
1077 
1083 
1089 
1093 #define GNUNET_MQ_PREFERENCE_COUNT 4
1094 };
1095 
1096 
1105 const char *
1107 
1108 
1109 #endif
1110  /* end of group mq */
void GNUNET_MQ_dll_insert_tail(struct GNUNET_MQ_Envelope **env_head, struct GNUNET_MQ_Envelope **env_tail, struct GNUNET_MQ_Envelope *env)
Insert env into the envelope DLL starting at env_head Note that env must not be in any MQ while this ...
Definition: mq.c:1174
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_combine_options(enum GNUNET_MQ_PriorityPreferences p1, enum GNUNET_MQ_PriorityPreferences p2)
Combine performance preferences set for different envelopes that are being combined into one larger e...
Definition: mq.c:1041
struct GNUNET_MQ_Envelope * GNUNET_MQ_get_last_envelope(struct GNUNET_MQ_Handle *mq)
Function to obtain the last envelope in the queue.
Definition: mq.c:987
void GNUNET_MQ_dll_insert_head(struct GNUNET_MQ_Envelope **env_head, struct GNUNET_MQ_Envelope **env_tail, struct GNUNET_MQ_Envelope *env)
Insert env into the envelope DLL starting at env_head Note that env must not be in any MQ while this ...
Definition: mq.c:1153
Handle we return for callbacks registered to be notified when GNUNET_MQ_destroy() is called on a queu...
Definition: mq.c:789
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_copy(const struct GNUNET_MessageHeader *hdr)
Create a new envelope by copying an existing message.
Definition: mq.c:653
void * impl_state
Implementation-specific state.
Definition: mq.c:111
Urgent traffic (local peer, i.e.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_MQ_DestroyNotificationHandle * GNUNET_MQ_destroy_notify(struct GNUNET_MQ_Handle *mq, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Register function to be called whenever mq is being destroyed.
Definition: mq.c:1109
const struct GNUNET_MessageHeader * GNUNET_MQ_env_get_msg(const struct GNUNET_MQ_Envelope *env)
Obtain message contained in envelope.
Definition: mq.c:1080
void GNUNET_MQ_inject_error(struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_Error error)
Call the error handler of a message queue with the given error code.
Definition: mq.c:300
uint16_t expected_size
Expected size of messages of this type.
uint32_t GNUNET_MQ_assoc_add(struct GNUNET_MQ_Handle *mq, void *assoc_data)
Associate the assoc_data in mq with a unique request id.
Definition: mq.c:708
void(* GNUNET_MQ_ErrorHandler)(void *cls, enum GNUNET_MQ_Error error)
Generic error handler, called with the appropriate error code and the same closure specified at the c...
GNUNET_MQ_Error
Error codes for the queue.
We received a message for which we have no matching handler.
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
struct GNUNET_MQ_MessageHandler * GNUNET_MQ_copy_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Copy an array of handlers.
Definition: mq.c:1214
void GNUNET_MQ_env_set_options(struct GNUNET_MQ_Envelope *env, enum GNUNET_MQ_PriorityPreferences pp)
Set application-specific options for this envelope.
Definition: mq.c:1005
No preference was expressed.
int GNUNET_MQ_handle_message(const struct GNUNET_MQ_MessageHandler *handlers, const struct GNUNET_MessageHeader *mh)
Call the message message handler that was registered for the type of the given message in the given h...
Definition: mq.c:229
GNUNET_MQ_PriorityPreferences
Per envelope preferences and priorities.
const struct GNUNET_MessageHeader * GNUNET_MQ_impl_current(struct GNUNET_MQ_Handle *mq)
Get the message that should currently be sent.
Definition: mq.c:602
const struct GNUNET_MQ_Envelope * GNUNET_MQ_env_next(const struct GNUNET_MQ_Envelope *env)
Return next envelope in queue.
Definition: mq.c:1093
void(* GNUNET_SCHEDULER_TaskCallback)(void *cls)
Signature of the main function of a task.
Flag to indicate that low latency is important.
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_get_options(struct GNUNET_MQ_Envelope *env)
Get performance preferences set for this envelope.
Definition: mq.c:1020
Best-effort traffic (i.e.
void GNUNET_MQ_set_handlers_closure(struct GNUNET_MQ_Handle *mq, void *handlers_cls)
Change the closure argument in all of the handlers of the mq.
Definition: mq.c:583
void GNUNET_MQ_impl_send_in_flight(struct GNUNET_MQ_Handle *mq)
Call the send notification for the current message, but do not try to send the next message until #gn...
Definition: mq.c:519
uint16_t type
Type of the message this handler covers, in host byte order.
Flag to indicate that high bandwidth is desired.
GNUNET_MQ_PreferenceKind
Enum defining all known preference categories.
struct GNUNET_MQ_Handle * GNUNET_MQ_queue_for_callbacks(GNUNET_MQ_SendImpl send, GNUNET_MQ_DestroyImpl destroy, GNUNET_MQ_CancelImpl cancel, void *impl_state, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *cls)
Create a message queue for the specified handlers.
Definition: mq.c:552
void * cls
Closure for mv and cb.
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
void GNUNET_MQ_notify_sent(struct GNUNET_MQ_Envelope *ev, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore...
Definition: mq.c:774
GNUNET_MQ_MessageValidationCallback mv
Callback to validate a message of the specified type.
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_nested_mh_(struct GNUNET_MessageHeader **mhp, uint16_t base_size, uint16_t type, const struct GNUNET_MessageHeader *nested_mh)
Implementation of the GNUNET_MQ_msg_nested_mh macro.
Definition: mq.c:675
unsigned int GNUNET_MQ_get_length(struct GNUNET_MQ_Handle *mq)
Obtain the current length of the message queue.
Definition: mq.c:335
FIXME: document!
The preferred transmission for this envelope focuses on maximizing bandwidth.
Failed to read message from the network.
void * GNUNET_MQ_impl_state(struct GNUNET_MQ_Handle *mq)
Get the implementation state associated with the message queue.
Definition: mq.c:625
void(* GNUNET_MQ_DestroyImpl)(struct GNUNET_MQ_Handle *mq, void *impl_state)
Signature of functions implementing the destruction of a message queue.
GNUNET_MQ_MessageCallback cb
Callback, called every time a new message of the specified type has been receied. ...
void GNUNET_MQ_inject_message(struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *mh)
Call the message message handler that was registered for the type of the given message in the given m...
Definition: mq.c:202
We received a message that was malformed and thus could not be passed to its handler.
struct GNUNET_MQ_MessageHandler * GNUNET_MQ_copy_handlers2(const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_MessageCallback agpl_handler, void *agpl_cls)
Copy an array of handlers, appending AGPL handler.
Definition: mq.c:1244
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_(struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type)
Create a new envelope.
Definition: mq.c:632
Message handler for a specific message type.
void GNUNET_MQ_dll_remove(struct GNUNET_MQ_Envelope **env_head, struct GNUNET_MQ_Envelope **env_tail, struct GNUNET_MQ_Envelope *env)
Remove env from the envelope DLL starting at env_head.
Definition: mq.c:1195
unsigned int GNUNET_MQ_count_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Count the handlers in a handler array.
Definition: mq.c:1274
void GNUNET_MQ_discard(struct GNUNET_MQ_Envelope *mqm)
Discard the message queue message, free all allocated resources.
Definition: mq.c:321
FIXME: document!
static unsigned int size
Size of the "table".
Definition: peer.c:67
Lowest priority, i.e.
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
void(* GNUNET_MQ_CancelImpl)(struct GNUNET_MQ_Handle *mq, void *impl_state)
Implementation function that cancels the currently sent message.
Bit mask to apply to extract the priority bits.
void(* GNUNET_MQ_MessageCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message has been received.
static void error_handler(void *cls, enum GNUNET_MQ_Error error)
We encountered an error handling the MQ to the ATS service.
Handle to a message queue.
Definition: mq.c:85
void GNUNET_MQ_set_options(struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_PriorityPreferences pp)
Set application-specific options for this queue.
Definition: mq.c:1066
const char * GNUNET_MQ_preference_to_string(enum GNUNET_MQ_PreferenceKind type)
Convert an enum GNUNET_MQ_PreferenceType to a string.
Definition: mq.c:1295
int(* GNUNET_MQ_MessageValidationCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message needs to be validated.
void * GNUNET_MQ_assoc_remove(struct GNUNET_MQ_Handle *mq, uint32_t request_id)
Remove the association for a request_id.
Definition: mq.c:752
void(* GNUNET_MQ_SendImpl)(struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
Signature of functions implementing the sending functionality of a message queue. ...
void GNUNET_MQ_send_copy(struct GNUNET_MQ_Handle *mq, const struct GNUNET_MQ_Envelope *ev)
Send a copy of a message with the given message queue.
Definition: mq.c:432
The preferred transmission for this envelope foces on minimizing latency.
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
Flag to indicate that out-of-order delivery is OK.
void GNUNET_MQ_destroy_notify_cancel(struct GNUNET_MQ_DestroyNotificationHandle *dnh)
Cancel registration from GNUNET_MQ_destroy_notify().
Definition: mq.c:1130
const struct GNUNET_MessageHeader * GNUNET_MQ_extract_nested_mh_(const struct GNUNET_MessageHeader *mh, uint16_t base_size)
Implementation of the #GNUNET_MQ_extract_nexted_mh macro.
Definition: mq.c:881
Flag to indicate that CORKing is acceptable.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Header for all communications.
struct GNUNET_MQ_Envelope * GNUNET_MQ_get_current_envelope(struct GNUNET_MQ_Handle *mq)
Function to obtain the current envelope from within GNUNET_MQ_SendImpl implementations.
Definition: mq.c:974
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:824
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:353
Flag to indicate that unreliable delivery is acceptable.
struct GNUNET_MQ_Envelope * GNUNET_MQ_unsent_head(struct GNUNET_MQ_Handle *mq)
Remove the first envelope that has not yet been sent from the message queue and return it...
Definition: mq.c:394
static void destroy(void *cls)
Highest priority, control traffic (i.e.
struct GNUNET_MQ_Envelope * GNUNET_MQ_env_copy(struct GNUNET_MQ_Envelope *env)
Function to copy an envelope.
Definition: mq.c:414
void GNUNET_MQ_impl_send_continue(struct GNUNET_MQ_Handle *mq)
Call the send implementation for the next queued message, if any.
Definition: mq.c:486
void GNUNET_MQ_send_cancel(struct GNUNET_MQ_Envelope *ev)
Cancel sending the message.
Definition: mq.c:916
void * cb_cls
Closure for cb.
Definition: mq.c:814
void * GNUNET_MQ_assoc_get(struct GNUNET_MQ_Handle *mq, uint32_t request_id)
Get the data associated with a request_id in a queue.
Definition: mq.c:736
The preferred transmission for this envelope foces on reliability.