summaryrefslogtreecommitdiff
path: root/FreeRTOS/Test/CMock/queue/sets/queue_unlock_cascaded_set_utest.c
blob: 1c32add4dc927ab2dfc0875ed5bd99b4c9af0e80 (plain)
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
/*
 * FreeRTOS V202111.00
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 *
 */
/*! @file queue_unlock_utest.c */

/* C runtime includes. */
#include <stdlib.h>
#include <stdbool.h>
#include <string.h>

#include "../queue_utest_common.h"

/* Queue includes */
#include "FreeRTOS.h"
#include "FreeRTOSConfig.h"
#include "queue.h"
#include "mock_fake_port.h"

/* ============================  GLOBAL VARIABLES =========================== */

#define TICKS_TO_WAIT                10
#define NUM_CALLS_TO_INTERCEPT_TX    TICKS_TO_WAIT / 2
#define NUM_CALLS_TO_INTERCEPT_RX    TICKS_TO_WAIT / 2

/* Share QueueHandle_t / QueueSetHandle_t between a test case and it's callbacks */
static QueueHandle_t xQueueHandleStatic;
static QueueSetHandle_t xQueueSetHandleStatic;

/* ==========================  CALLBACK FUNCTIONS =========================== */

/* ============================= Unity Fixtures ============================= */

void setUp( void )
{
    commonSetUp();
    vFakePortAssertIfInterruptPriorityInvalid_Ignore();
    xQueueHandleStatic = NULL;
    xQueueSetHandleStatic = NULL;
}

void tearDown( void )
{
    commonTearDown();
}

void suiteSetUp()
{
    commonSuiteSetUp();
}

int suiteTearDown( int numFailures )
{
    return commonSuiteTearDown( numFailures );
}

/* ==========================  Helper functions =========================== */

/* ==========================  Test Cases =========================== */

/* / ** */
/*  *  @brief Callback for test_macro_xQueueSend_blocking_success which empties it's test queue. */
/*  * / */
/* static BaseType_t xQueueSend_locked_xTaskCheckForTimeOutCB( TimeOut_t* const pxTimeOut, */
/*                                                             TickType_t* const pxTicksToWait, */
/*                                                             int cmock_num_calls ) */
/* { */
/*     BaseType_t xReturnValue = td_task_xTaskCheckForTimeOutStub( pxTimeOut, pxTicksToWait, cmock_num_calls ); */

/*     if(cmock_num_calls == NUM_CALLS_TO_INTERCEPT_TX) */
/*     { */
/*         uint32_t checkVal = INVALID_UINT32; */
/*         QueueHandle_t xQueue = xQueueSelectFromSetFromISR( xQueueSetHandleStatic ); */
/*         TEST_ASSERT_NOT_NULL( xQueue ); */
/*         xQueueReceiveFromISR( xQueue, &checkVal, NULL ); */
/*         TEST_ASSERT_EQUAL( getLastMonotonicTestValue(), checkVal ); */
/*     } */
/*     return xReturnValue; */
/* } */

/* void test_macro_xQueueSend_in_set_blocking_success_locked_no_pending( void ) */
/* { */
/*     QueueSetHandle_t xQueueSet = xQueueCreateSet( 1 ); */

/*     QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) ); */

/*     xQueueAddToSet( xQueue, xQueueSet ); */

/*     / * Export for callbacks * / */
/*     xQueueSetHandleStatic = xQueueSet; */

/*     uint32_t testVal = getNextMonotonicTestValue(); */

/*     TEST_ASSERT_EQUAL( pdTRUE, xQueueSend( xQueue, &testVal, 0 ) ); */

/*     xTaskCheckForTimeOut_Stub( &xQueueSend_locked_xTaskCheckForTimeOutCB  ); */
/*     xTaskResumeAll_Stub( &td_task_xTaskResumeAllStub ); */

/*     uint32_t testVal2 = getLastMonotonicTestValue() + 12345; */

/*     TEST_ASSERT_EQUAL( pdTRUE, xQueueSend( xQueue, &testVal2, TICKS_TO_WAIT ) ); */

/*     (void) xQueueRemoveFromSet( xQueue, xQueueSet ); */
/*     vQueueDelete( xQueueSet ); */
/*     vQueueDelete( xQueue ); */
/* } */

/* static BaseType_t xQueueSend_xTaskResumeAllCallback( int cmock_num_calls ) */
/* { */
/*     BaseType_t xReturnValue = td_task_xTaskResumeAllStub( cmock_num_calls ); */
/*     / * If td_task_xTaskResumeAllStub returns pdTRUE, a higher priority task is pending */
/*        Send from an ISR to block * / */
/*     if( pdTRUE == xReturnValue ) */
/*     { */
/*         if(cmock_num_calls == NUM_CALLS_TO_INTERCEPT_TX) */
/*         { */
/*             uint32_t testVal = getNextMonotonicTestValue(); */
/*             (void) xQueueSendFromISR( xQueueHandleStatic, &testVal, NULL ); */
/*         } */
/*     } */
/*     return xReturnValue; */
/* } */

/* / * @coverage prvUnlockQueue * / */
/* void test_macro_xQueueSend_in_set_blocking_fail_locked_high_prio_pending( void ) */
/* { */
/*     QueueSetHandle_t xQueueSet = xQueueCreateSet( 1 ); */

/*     QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) ); */

/*     xQueueAddToSet( xQueue, xQueueSet ); */

/*     / * Export for callbacks * / */
/*     xQueueHandleStatic = xQueue; */
/*     xQueueSetHandleStatic = xQueueSet; */

/*     uint32_t testVal = getNextMonotonicTestValue(); */

/*     TEST_ASSERT_EQUAL( pdTRUE, xQueueSend( xQueue, &testVal, 0 ) ); */

/*     xTaskCheckForTimeOut_Stub( &xQueueSend_locked_xTaskCheckForTimeOutCB  ); */
/*     xTaskResumeAll_Stub( &xQueueSend_xTaskResumeAllCallback ); */

/*     / * this task is lower priority than the pending task * / */
/*     td_task_setFakeTaskPriority( DEFAULT_PRIORITY + 1 ); */

/*     td_task_addFakeTaskWaitingToSendToQueue( xQueue ); */

/*     uint32_t testVal2 = getLastMonotonicTestValue() + 12345; */

/*     TEST_ASSERT_EQUAL( pdFALSE, xQueueSend( xQueue, &testVal2, TICKS_TO_WAIT ) ); */

/*     (void) xQueueRemoveFromSet( xQueue, xQueueSet ); */
/*     vQueueDelete( xQueueSet ); */
/*     vQueueDelete( xQueue ); */
/* } */


/* void test_macro_xQueueSend_in_set_blocking_success_locked_low_prio_pending( void ) */
/* { */
/*     QueueSetHandle_t xQueueSet = xQueueCreateSet( 1 ); */

/*     QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) ); */

/*     xQueueAddToSet( xQueue, xQueueSet ); */

/*     / * Export for callbacks * / */
/*     xQueueHandleStatic = xQueue; */
/*     xQueueSetHandleStatic = xQueueSet; */

/*     uint32_t testVal = getNextMonotonicTestValue(); */

/*     TEST_ASSERT_EQUAL( pdTRUE, xQueueSend( xQueue, &testVal, 0 ) ); */

/*     xTaskCheckForTimeOut_Stub( &xQueueSend_locked_xTaskCheckForTimeOutCB  ); */
/*     xTaskResumeAll_Stub( &xQueueSend_xTaskResumeAllCallback ); */

/*     / * this task is higher priority than the pending task * / */
/*     td_task_setFakeTaskPriority( DEFAULT_PRIORITY - 1 ); */

/*     td_task_addFakeTaskWaitingToSendToQueue( xQueue ); */

/*     uint32_t testVal2 = getLastMonotonicTestValue() + 12345; */

/*     TEST_ASSERT_EQUAL( pdTRUE, xQueueSend( xQueue, &testVal2, TICKS_TO_WAIT ) ); */

/*     (void) xQueueRemoveFromSet( xQueue, xQueueSet ); */
/*     vQueueDelete( xQueueSet ); */
/*     vQueueDelete( xQueue ); */
/* } */

/**
 *  @brief Callback for test_macro_xQueueReceive_blocking_success_locked_no_pending which adds an item to it's test queue.
 */
static BaseType_t xQueueReceive_xTaskCheckForTimeOutCB( TimeOut_t * const pxTimeOut,
                                                        TickType_t * const pxTicksToWait,
                                                        int cmock_num_calls )
{
    BaseType_t xReturnValue = td_task_xTaskCheckForTimeOutStub( pxTimeOut, pxTicksToWait, cmock_num_calls );

    printf( "In xQueueReceive_xTaskCheckForTimeOutCB %d\n", cmock_num_calls );

    if( cmock_num_calls == NUM_CALLS_TO_INTERCEPT_TX )
    {
        uint32_t testVal = getNextMonotonicTestValue();
        printf( "Calling xQueueSendFromISR\n" );
        TEST_ASSERT_TRUE( xQueueSendFromISR( xQueueHandleStatic, &testVal, NULL ) );
    }

    return xReturnValue;
}

void test_macro_xQueueReceive_in_set_blocking_success_locked_no_pending( void )
{
    QueueSetHandle_t xQueueSetOuter = xQueueCreateSet( 1 );
    QueueSetHandle_t xQueueSetInner = xQueueCreateSet( 1 );

    QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) );

    printf( "xQueueSetOuter: %lu, xQueueSetInner: %lu, xQueue: %lu\n", ( unsigned long ) xQueueSetOuter, ( unsigned long ) xQueueSetInner, ( unsigned long ) xQueue );


    TEST_ASSERT_TRUE( xQueueAddToSet( xQueueSetInner, xQueueSetOuter ) );

    TEST_ASSERT_TRUE( xQueueAddToSet( xQueue, xQueueSetInner ) );

    /* Export for callbacks */
    xQueueHandleStatic = xQueue;

    xTaskCheckForTimeOut_Stub( &xQueueReceive_xTaskCheckForTimeOutCB );
    xTaskResumeAll_Stub( &td_task_xTaskResumeAllStub );

    uint32_t checkVal = INVALID_UINT32;

    /* printf("Calling xQueueSelectFromSet from OuterSet\n"); */
    /* QueueSetHandle_t xQueueSetFromSet = xQueueSelectFromSet( xQueueSetOuter, TICKS_TO_WAIT ); */

    /* TEST_ASSERT_EQUAL( xQueueSetInner, xQueueSetFromSet ); */

    QueueHandle_t xQueueFromSet = xQueueSelectFromSet( xQueueSetOuter, TICKS_TO_WAIT );

    TEST_ASSERT_EQUAL( xQueue, xQueueFromSet ); /* TODO: assert equality */

    printf( "Calling xQueueReceive\n" );
    TEST_ASSERT_EQUAL( pdTRUE, xQueueReceive( xQueueFromSet, &checkVal, 0 ) );

    TEST_ASSERT_EQUAL( getLastMonotonicTestValue(), checkVal );

    ( void ) xQueueRemoveFromSet( xQueueSetInner, xQueueSetOuter );
    vQueueDelete( xQueueSetOuter );
    ( void ) xQueueRemoveFromSet( xQueue, xQueueSetInner );
    vQueueDelete( xQueueSetInner );
    vQueueDelete( xQueue );
}

/* static BaseType_t xQueueReceive_xTaskResumeAllCallback( int cmock_num_calls ) */
/* { */
/*     BaseType_t xReturnValue = td_task_xTaskResumeAllStub( cmock_num_calls ); */
/*     / * If td_task_xTaskResumeAllStub returns pdTRUE, a higher priority task is pending */
/*        Receive from an ISR to block * / */

/*     printf("In xQueueReceive_xTaskResumeAllCallback %d\n", cmock_num_calls); */
/*     if( pdTRUE == xReturnValue ) */
/*     { */
/*         if(cmock_num_calls == NUM_CALLS_TO_INTERCEPT_TX) */
/*         { */
/*             uint32_t checkValue = INVALID_UINT32; */
/*             QueueHandle_t xQueue = xQueueSelectFromSetFromISR( xQueueSetHandleStatic ); */
/*             TEST_ASSERT_TRUE( xQueueReceiveFromISR( xQueue, &checkValue, NULL ) ); */
/*             TEST_ASSERT_EQUAL( getLastMonotonicTestValue(), checkValue ); */
/*         } */
/*     } */
/*     return xReturnValue; */
/* } */


/* void test_macro_xQueueReceive_in_set_blocking_success_locked_high_prio_pending( void ) */
/* { */
/*     QueueSetHandle_t xQueueSet = xQueueCreateSet( 1 ); */

/*     QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) ); */

/*     xQueueAddToSet( xQueue, xQueueSet ); */

/*     / * Export for callbacks * / */
/*     xQueueHandleStatic = xQueue; */
/*     xQueueSetHandleStatic = xQueueSet; */

/*     xTaskCheckForTimeOut_Stub( &xQueueReceive_xTaskCheckForTimeOutCB  ); */
/*     xTaskResumeAll_Stub( &xQueueReceive_xTaskResumeAllCallback ); */

/*     td_task_setFakeTaskPriority( DEFAULT_PRIORITY + 1 ); */

/*     td_task_addFakeTaskWaitingToReceiveFromQueue( xQueueSet ); */

/*     QueueHandle_t xQueueFromSet = xQueueSelectFromSet( xQueueSet, TICKS_TO_WAIT ); */

/*     TEST_ASSERT_EQUAL( NULL, xQueueFromSet ); */

/*     (void) xQueueRemoveFromSet( xQueue, xQueueSet ); */
/*     vQueueDelete( xQueueSet ); */
/*     vQueueDelete( xQueue ); */
/* } */


/* void test_macro_xQueueReceive_in_set_blocking_success_locked_low_prio_pending( void ) */
/* { */
/*     QueueSetHandle_t xQueueSet = xQueueCreateSet( 1 ); */

/*     QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) ); */

/*     xQueueAddToSet( xQueue, xQueueSet ); */

/*     / * Export for callbacks * / */
/*     xQueueHandleStatic = xQueue; */
/*     xQueueSetHandleStatic = xQueueSet; */

/*     xTaskCheckForTimeOut_Stub( &xQueueReceive_xTaskCheckForTimeOutCB  ); */
/*     xTaskResumeAll_Stub( &xQueueReceive_xTaskResumeAllCallback ); */

/*     td_task_setFakeTaskPriority( DEFAULT_PRIORITY - 1 ); */

/*     td_task_addFakeTaskWaitingToReceiveFromQueue( xQueueSet ); */

/*     uint32_t checkVal = INVALID_UINT32; */

/*     QueueHandle_t xQueueFromSet = xQueueSelectFromSet( xQueueSet, TICKS_TO_WAIT ); */

/*     TEST_ASSERT_NOT_NULL( xQueueFromSet ); */

/*     TEST_ASSERT_EQUAL( pdTRUE, xQueueReceive( xQueueFromSet, &checkVal, TICKS_TO_WAIT ) ); */

/*     TEST_ASSERT_EQUAL( getLastMonotonicTestValue(), checkVal ); */

/*     (void) xQueueRemoveFromSet( xQueue, xQueueSet ); */
/*     vQueueDelete( xQueueSet ); */
/*     vQueueDelete( xQueue ); */
/* } */