aboutsummaryrefslogtreecommitdiff
path: root/src/transport/transport-testing-communicator.h
blob: 1875258b4a901d5ac07205368f3b53a91b286c8e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
/*
     This file is part of GNUnet.
     Copyright (C) 2019 GNUnet e.V.

     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.

     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
 */

/**
 * @file transport/transport-testing-communicator.h
 * @brief functions and structures related to testing-tng
 * @author Christian Grothoff
 * @author Julius Bünger
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_ats_transport_service.h"
#include "transport.h"

/**
 * @brief Queue of a communicator and some context
 */
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue;


/**
 * @brief Handle/Context to a single transmission
 */
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorTransmission;

/**
 * @brief Function signature for callbacks that are called when new
 * backchannel message arrived
 *
 * @param cls Closure
 * @param msg Backchannel message
 * @param pid Target peer
 */
typedef struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *
(*GNUNET_TRANSPORT_TESTING_BackchannelCallback)(void *cls,
                                                struct GNUNET_MessageHeader *msg,
                                                struct GNUNET_PeerIdentity *pid);


/**
 * @brief Function signature for callbacks that are called when new
 * communicators become available
 *
 * @param cls Closure
 * @param tc_h Communicator handle
 * @param cc Characteristics of communicator
 * @param address_prefix Prefix of the address
 */
typedef void
(*GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback)(void *cls,
                                                          struct
                                                          GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                                          *tc_h,
                                                          enum
                                                          GNUNET_TRANSPORT_CommunicatorCharacteristics
                                                          cc,
                                                          char *address_prefix);


/**
 * @brief Receive information about the address of a communicator.
 *
 * @param cls Closure
 * @param tc_h Communicator handle
 * @param address Address represented as string
 * @param expiration Expiration
 * @param aid Aid
 * @param nt Network Type
 */
typedef void
(*GNUNET_TRANSPORT_TESTING_AddAddressCallback)(void *cls,
                                               struct
                                               GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                               *tc_h,
                                               const char *address,
                                               struct GNUNET_TIME_Relative
                                               expiration,
                                               uint32_t aid,
                                               enum GNUNET_NetworkType nt);


/**
 * @brief Get informed about the success of a queue request.
 *
 * @param cls Closure
 * @param tc_h Communicator handle
 * @param will_try #GNUNET_YES if communicator will try to create queue
 */
typedef void
(*GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback)(void *cls,
                                                     struct
                                                     GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                                     *tc_h,
                                                     int will_try);


/**
 * @brief Handle opening of queue
 *
 * @param cls Closure
 * @param tc_h Communicator handle
 * @param tc_queue Handle to newly opened queue
 */
typedef void
(*GNUNET_TRANSPORT_TESTING_AddQueueCallback)(void *cls,
                                             struct
                                             GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                             *tc_h,
                                             struct
                                             GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue
                                             *tc_queue,
                                             size_t mtu);


/**
 * @brief Handle an incoming message
 *
 * @param cls Closure
 * @param tc_h Handle to the receiving communicator
 * @param msg Received message
 */
typedef void
(*GNUNET_TRANSPORT_TESTING_IncomingMessageCallback)(void *cls,
                                                    struct
                                                    GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                                    *tc_h,
                                                    const char*payload,
                                                    size_t payload_len);

/**
 * @brief Handle to a transport communicator
 */
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
{
  /**
   * Clients
   */
  struct MyClient *client_head;
  struct MyClient *client_tail;

  /**
  * @brief Handle to the client
  */
  struct GNUNET_MQ_Handle *c_mq;

  /**
    * @brief Handle to the configuration
    */
  struct GNUNET_CONFIGURATION_Handle *cfg;

  /**
   * @brief File name of configuration file
   */
  char *cfg_filename;

  struct GNUNET_PeerIdentity peer_id;

  /**
   * @brief Handle to the transport service
   */
  struct GNUNET_SERVICE_Handle *tsh;

  /**
   * @brief Task that will be run on shutdown to stop and clean transport
   * service
   */
  struct GNUNET_SCHEDULER_Task *ts_shutdown_task;


  /**
   * @brief Process of the communicator
   */
  struct GNUNET_OS_Process *c_proc;

  /**
   * NAT process
   */
  struct GNUNET_OS_Process *nat_proc;

  /**
   * resolver service process
   */
  struct GNUNET_OS_Process *resolver_proc;

  /**
   * statistics service process
   */
  struct GNUNET_OS_Process *stat_proc;

  /**
   * peerstore service process
   */
  struct GNUNET_OS_Process *ps_proc;

  /**
   * @brief Task that will be run on shutdown to stop and clean communicator
   */
  struct GNUNET_SCHEDULER_Task *c_shutdown_task;

  /**
   * @brief Characteristics of the communicator
   */
  enum GNUNET_TRANSPORT_CommunicatorCharacteristics c_characteristics;

  /**
   * @brief Specifies supported addresses
   */
  char *c_addr_prefix;

  /**
   * @brief Specifies supported addresses
   */
  char *c_address;

  /**
   * @brief Head of the DLL of queues associated with this communicator
   */
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *queue_head;

  /**
   * @brief Tail of the DLL of queues associated with this communicator
   */
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *queue_tail;

  /* Callbacks + Closures */
  /**
   * @brief Callback called when a new communicator connects
   */
  GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback
    communicator_available_cb;

  /**
   * @brief Callback called when a new communicator connects
   */
  GNUNET_TRANSPORT_TESTING_AddAddressCallback add_address_cb;

  /**
   * @brief Callback called when a new communicator connects
   */
  GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback queue_create_reply_cb;

  /**
   * @brief Callback called when a new communicator connects
   */
  GNUNET_TRANSPORT_TESTING_AddQueueCallback add_queue_cb;

  /**
   * @brief Callback called when a new communicator connects
   */
  GNUNET_TRANSPORT_TESTING_IncomingMessageCallback incoming_msg_cb;

  /**
   * @brief Backchannel callback
   */
  GNUNET_TRANSPORT_TESTING_BackchannelCallback bc_cb;

  /**
   * Our service handle
   */
  struct GNUNET_SERVICE_Handle *sh;

  /**
   * @brief Closure to the callback
   */
  void *cb_cls;

  /**
   * Backchannel supported
   */
  int bc_enabled;
};

/**
 * @brief Start communicator part of transport service and communicator
 *
 * @param service_name Name of the service
 * @param cfg Configuration handle
 * @param communicator_available Callback that is called when a new
 * communicator becomes available
 * @param add_address_cb Callback handling new addresses
 * @param queue_create_reply_cb Callback handling success of queue requests
 * @param add_queue_cb Callback handling freshly created queues
 * @param incoming_message_cb Callback handling incoming messages
 * @param cb_cls Closure to @p communicator_available
 *
 * @return Handle to the communicator duo
 */
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *
GNUNET_TRANSPORT_TESTING_transport_communicator_service_start (
  const char *service_name,
  const char *binary_name,
  const char *cfg_filename,
  const struct GNUNET_PeerIdentity *peer_id,
  GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback
  communicator_available_cb,
  GNUNET_TRANSPORT_TESTING_AddAddressCallback add_address_cb,
  GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback queue_create_reply_cb,
  GNUNET_TRANSPORT_TESTING_AddQueueCallback add_queue_cb,
  GNUNET_TRANSPORT_TESTING_IncomingMessageCallback incoming_message_cb,
  GNUNET_TRANSPORT_TESTING_BackchannelCallback bc_cb,
  void *cb_cls);


void
GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop (
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h);


/**
 * @brief Instruct communicator to open a queue
 *
 * @param tc_h Handle to communicator which shall open queue
 * @param peer_id Towards which peer
 * @param address For which address
 */
void
GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue (struct
                                                            GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                                            *tc_h,
                                                            const struct
                                                            GNUNET_PeerIdentity
                                                            *peer_id,
                                                            const char *address);


/**
 * @brief Instruct communicator to send data
 *
 * @param tc_queue The queue to use for sending
 * @param cont function to call when done sending
 * @param cont_cls closure for @a cont
 * @param payload Data to send
 * @param payload_size Size of the @a payload
 */
void
GNUNET_TRANSPORT_TESTING_transport_communicator_send (struct
                                                      GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
                                                      *tc_h,
                                                      GNUNET_SCHEDULER_TaskCallback
                                                      cont,
                                                      void *cont_cls,
                                                      const void *payload,
                                                      size_t payload_size);