nettest.h
10.2 KB
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
/*
* Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup net_gnrc_nettest NETAPI test framework
* @ingroup net_gnrc_netapi
* @brief This provides a framework to test the @ref net_gnrc_netapi IPC
* calls.
* @{
*
* @file
* @brief Definitions for the @ref net_gnrc_netapi test framework
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
#ifndef GNRC_NETTEST_H_
#define GNRC_NETTEST_H_
#include <stdint.h>
#include <stdlib.h>
#include "kernel_types.h"
#include "net/gnrc/netapi.h"
#include "net/netopt.h"
#include "net/gnrc/nettype.h"
#include "net/gnrc/pkt.h"
#include "thread.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Timeout for tests in microseconds
*/
#ifndef GNRC_NETTEST_TIMEOUT
#define GNRC_NETTEST_TIMEOUT (1000)
#endif
/**
* @brief Default stack size to use for the nettest thread
*/
#ifndef GNRC_NETTEST_STACK_SIZE
#define GNRC_NETTEST_STACK_SIZE (THREAD_STACKSIZE_DEFAULT)
#endif
/**
* @brief Default priority for the nettest thread
*/
#ifndef GNRC_NETTEST_PRIO
#define GNRC_NETTEST_PRIO (THREAD_PRIORITY_MAIN)
#endif
/**
* @brief Default message queue size to use for the nettest thread.
*/
#ifndef GNRC_NETTEST_MSG_QUEUE_SIZE
#define GNRC_NETTEST_MSG_QUEUE_SIZE (8U)
#endif
/**
* @brief Type for get/set callbacks.
*
* @param[in] context (Optional) context for the option.
* Compare gnrc_netapi_opt_t::context.
* @param[in,out] data Data to set or buffer to read into.
* Compare gnrc_netapi_opt_t::data.
* @param[in] data_len Size of the data / the buffer.
* Compare gnrc_netapi_opt_t::data_len
*
* @return The value for the @ref GNRC_NETAPI_MSG_TYPE_ACK message.
*/
typedef int (*gnrc_nettest_opt_cb_t)(uint16_t context, void *data, uint16_t data_len);
/**
* @brief Option callback list element.
*/
typedef struct {
gnrc_nettest_opt_cb_t get; /**< getter for an option */
gnrc_nettest_opt_cb_t set; /**< setter for an option */
} gnrc_nettest_opt_cbs_t;
/**
* @brief Result type for tests.
*/
typedef enum {
GNRC_NETTEST_SUCCESS = 0, /**< test was successful */
GNRC_NETTEST_FAIL, /**< test failed */
GNRC_NETTEST_TIMED_OUT, /**< test timed out */
GNRC_NETTEST_WRONG_MSG, /**< wrong message type received */
GNRC_NETTEST_WRONG_SENDER, /**< wrong message type received */
} gnrc_nettest_res_t;
/**
* @brief Registers a getter for an option.
*
* @details Overrides previous registrations.
*
* @param[in] opt The option to register the getter for.
* @param[in] cb An option getter. NULL to delete.
*/
void gnrc_nettest_register_get(netopt_t opt, gnrc_nettest_opt_cb_t cb);
/**
* @brief Registers a setter for an option.
*
* @details Overrides previous registrations.
*
* @param[in] opt The option to register the setter for.
* @param[in] cb An option setter. NULL to delete.
*/
void gnrc_nettest_register_set(netopt_t opt, gnrc_nettest_opt_cb_t cb);
/**
* @brief Test @ref GNRC_NETAPI_MSG_TYPE_SND command to @p pid.
*
* @details This registered the nettest thread to (@p exp_type, @p exp_demux_ctx)
* and checks if @p exp_pkts of @p exp_out were received from @p exp_senders.
* If no message was received after @ref GNRC_NETTEST_TIMEOUT microseconds, while
* there are still packets expected, the function will return GNRC_NETTEST_TIMED_OUT.
*
* In case of success it releases all packets send by the tested module.
*
* @param[in] pid The thread you want to test the
* @ref GNRC_NETAPI_MSG_TYPE_SND command for.
* @param[in] in The packet you want to send through @p pid.
* @param[in] exp_pkts The number of packets expected to be received.
* @param[in] exp_senders The PID the resulting packet should be coming from.
* Must be of dimension @p exp_pkts.
* @param[in] exp_out The expected packet from @p exp_sender.
* Must be of dimension @p exp_pkts.
* @param[in] exp_type The expected receiver type for the
* @ref GNRC_NETAPI_MSG_TYPE_SND command.
* @param[in] exp_demux_ctx The expected receiver demux type for the
* @ref GNRC_NETAPI_MSG_TYPE_SND command.
*
* @return @see gnrc_nettest_res_t
*/
gnrc_nettest_res_t gnrc_nettest_send(kernel_pid_t pid, gnrc_pktsnip_t *in,
unsigned int exp_pkts,
const kernel_pid_t *exp_senders,
const gnrc_pktsnip_t **exp_out,
gnrc_nettype_t exp_type, uint32_t exp_demux_ctx);
/**
* @brief Test @ref GNRC_NETAPI_MSG_TYPE_SND command to @p pid with the receiving
* thread being an interface.
*
* @details This registered the nettest thread as an interface and checks ifx
* @p exp_pkts of @p exp_out were received from @p exp_senders. If no message
* was received after @ref GNRC_NETTEST_TIMEOUT microseconds, while there are
* still packets expected, the function will return GNRC_NETTEST_TIMED_OUT.
*
* In case of success it releases all packets received from the tested module.
*
* @param[in] pid The thread you want to test the
* @ref GNRC_NETAPI_MSG_TYPE_SND command for.
* @param[in] in The packet you want to send through @p pid.
* @param[in] exp_pkts The number of packets expected to be received.
* @param[in] exp_senders The PID the resulting packet should be coming from.
* Must be of dimension @p exp_pkts. May be NULL if
* @p exp_pkts == 0.
* @param[in] exp_out The expected packet from @p exp_sender.
* Must be of dimension @p exp_pkts. May be NULL if
* @p exp_pkts == 0.
*
* @return @see gnrc_nettest_res_t
*/
gnrc_nettest_res_t gnrc_nettest_send_iface(kernel_pid_t pid, gnrc_pktsnip_t *in,
unsigned int exp_pkts,
const kernel_pid_t *exp_senders,
const gnrc_pktsnip_t **exp_out);
/**
* @brief Test @ref GNRC_NETAPI_MSG_TYPE_RCV command to @p pid.
*
* @details This registered the nettest thread to (@p exp_type, @p exp_demux_ctx)
* and checks if @p exp_pkts of @p exp_out were received from @p exp_senders.
* If no message was received after @ref GNRC_NETTEST_TIMEOUT microseconds, while
* there are still packets expected, the function will return GNRC_NETTEST_TIMED_OUT.
*
* @param[in] pid The thread you want to test the
* @ref GNRC_NETAPI_MSG_TYPE_RCV command for.
* @param[in] in The packet you want to send through @p pid.
* @param[in] exp_pkts The number of packets expected to be received.
* @param[in] exp_senders The PID the resulting packet should be coming from.
* Must be of dimension @p exp_pkts.
* @param[in] exp_out The expected packet from @p exp_sender.
* Must be of dimension @p exp_pkts.
* @param[in] exp_type The expected receiver type for the
* @ref GNRC_NETAPI_MSG_TYPE_RCV command.
* @param[in] exp_demux_ctx The expected receiver demux type for the
* @ref GNRC_NETAPI_MSG_TYPE_RCV command.
*
* @return @see gnrc_nettest_res_t
*/
gnrc_nettest_res_t gnrc_nettest_receive(kernel_pid_t pid, gnrc_pktsnip_t *in,
unsigned int exp_pkts,
const kernel_pid_t *exp_senders,
const gnrc_pktsnip_t **exp_out,
gnrc_nettype_t exp_type, uint32_t exp_demux_ctx);
/**
* @brief Test @ref GNRC_NETAPI_MSG_TYPE_GET command to @p pid.
*
* @param[in] pid The thread you want to test the
* @ref GNRC_NETAPI_MSG_TYPE_GET command for.
* @param[in] opt The option you want to test.
* @param[in] context The context for the option.
* @param[in] data The data pointer for the @ref GNRC_NETAPI_MSG_TYPE_GET
* command.
* @param[in] data_len The maximum length for @p data.
* @param[in] exp_data The expected value for the returned data. May be
* NULL if @p exp_res < 0
* @param[in] exp_res The expected return value for the
* @ref GNRC_NETAPI_MSG_TYPE_GET command.
*
* @return @see gnrc_nettest_res_t
*/
gnrc_nettest_res_t gnrc_nettest_get(kernel_pid_t pid, netopt_t opt,
uint16_t context, void *data, size_t data_len,
void *exp_data, int exp_res);
/**
* @brief Test @ref GNRC_NETAPI_MSG_TYPE_SET command to @p pid.
*
* @param[in] pid The thread you want to test the
* @ref GNRC_NETAPI_MSG_TYPE_SET command for.
* @param[in] opt The option you want to test.
* @param[in] context The context for the option.
* @param[in] data The data pointer for the @ref GNRC_NETAPI_MSG_TYPE_SET
* command.
* @param[in] data_len The maximum length for @p data.
* @param[in] exp_res The expected return value for the
* @ref GNRC_NETAPI_MSG_TYPE_SET command.
*
* @return @see gnrc_nettest_res_t
*/
gnrc_nettest_res_t gnrc_nettest_set(kernel_pid_t pid, netopt_t opt,
uint16_t context, void *data, size_t data_len,
int exp_res);
/**
* @brief Initializes the @ref net_gnrc_nettest module.
*
* @return The PID to the nettest thread, on success.
* @return a negative errno on error.
* @return -EOVERFLOW, if there are too many threads running already
*/
int gnrc_nettest_init(void);
/**
* @brief Resets gnrc_nettest_opt_cbs_t list.
*/
void gnrc_nettest_reset(void);
#ifdef __cplusplus
}
#endif
#endif /* GNRC_NETTEST_H_ */
/** @} */