summaryrefslogtreecommitdiff
path: root/test/smp/regression/threadx_byte_memory_suspension_test.c
blob: 3af5fc81e2ac5c790d5cda22a3051c238a2d2feb (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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation                                */
/* Copyright (c) 2026 Eclipse ThreadX contributors                         */
/*                                                                         */
/* This program and the accompanying materials are made available under    */
/* the terms of the MIT License which is available at                      */
/* https://opensource.org/licenses/MIT.                                    */
/*                                                                         */
/* SPDX-License-Identifier: MIT                                            */
/***************************************************************************/

/* This test is designed to test suspension on a memory byte pool.  */

#include   <stdio.h>
#include   "tx_api.h"
#include   "threadx_test_port.h"

static unsigned long   thread_0_counter =  0;
static TX_THREAD       thread_0;
static unsigned long   thread_1_counter =  0;
static TX_THREAD       thread_1;
static unsigned long   thread_2_counter =  0;
static TX_THREAD       thread_2;
static unsigned long   thread_3_counter =  0;
static TX_THREAD       thread_3;


static TX_BYTE_POOL   pool_0;


/* Define thread prototypes.  */

static void    thread_0_entry(ULONG thread_input);
static void    thread_1_entry(ULONG thread_input);
static void    thread_2_entry(ULONG thread_input);
static void    thread_3_entry(ULONG thread_input);



#ifndef TX_MANUAL_TEST

/* Define test flags for automated test.  */

extern TEST_FLAG    threadx_byte_allocate_loop_test;
extern TEST_FLAG    threadx_byte_release_loop_test;

#endif


void abort_and_resume_byte_allocating_thread(void)
{

UCHAR   *search_ptr;

    /* Adjust the search pointer to avoid the search pointer change for this test.  */
    search_ptr =  pool_0.tx_byte_pool_search;
    while (search_ptr >= pool_0.tx_byte_pool_search)

    {
        search_ptr =  *((UCHAR **) ((VOID *) search_ptr));
    }
    pool_0.tx_byte_pool_search =  search_ptr;

    tx_thread_wait_abort(&thread_3);
    tx_thread_resume(&thread_3);
}


/* Prototype for test control return.  */
void  test_control_return(UINT status);


/* Define what the initial system looks like.  */

#ifdef CTEST
void test_application_define(void *first_unused_memory)
#else
void    threadx_byte_memory_suspension_application_define(void *first_unused_memory)
#endif
{

UINT    status;
CHAR    *pointer;


    /* Put first available memory address into a character pointer.  */
    pointer =  (CHAR *) first_unused_memory;

    /* Put system definition stuff in here, e.g. thread creates and other assorted
       create information.  */

    status =  tx_thread_create(&thread_0, "thread 0", thread_0_entry, 1,
            pointer, TEST_STACK_SIZE_PRINTF,
            17, 17, 100, TX_AUTO_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Byte Memory Suspension Test................................. ERROR #1\n");
        test_control_return(1);
    }

    status =  tx_thread_create(&thread_1, "thread 1", thread_1_entry, 1,
            pointer, TEST_STACK_SIZE_PRINTF,
            17, 17, 100, TX_AUTO_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Byte Memory Suspension Test................................. ERROR #2\n");
        test_control_return(1);
    }

    status =  tx_thread_create(&thread_2, "thread 2", thread_2_entry, 2,
            pointer, TEST_STACK_SIZE_PRINTF,
            17, 17, 100, TX_DONT_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;
    status +=  tx_thread_create(&thread_3, "thread 3", thread_3_entry, 3,
            pointer, TEST_STACK_SIZE_PRINTF,
            16, 16, 100, TX_DONT_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Byte Memory Suspension Test................................. ERROR #3\n");
        test_control_return(1);
    }

    /* Create byte pool 0.  */
    status =  tx_byte_pool_create(&pool_0, "pool 0", pointer, TX_TEST_BYTE_POOL_BYTES(108));
    pointer = pointer + TX_TEST_BYTE_POOL_BYTES(108);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Byte Memory Suspension Test................................. ERROR #4\n");
        test_control_return(1);
    }
}



/* Define the test threads.  */

static void    thread_0_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer;


    /* Inform user.  */
    printf("Running Byte Memory Suspension Test................................. ");

    /* Increment the thread counter.  */
    thread_0_counter++;

    /* Allocate memory from the pool.  Only one block of this size will fit.  */
    status = tx_byte_allocate(&pool_0, (VOID **) &pointer, 60, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Byte memory error.  */
        printf("ERROR #5\n");
        test_control_return(1);
    }

    /* Let other thread suspend on byte pool.  */
    tx_thread_relinquish();

    /* Now release the blocks. */
    status =  tx_byte_release(pointer);

    /* Check status.  */
    if ((status != TX_SUCCESS) && (thread_1_counter == 0))
    {

        /* Byte memory error.  */
        printf("ERROR #6\n");
        test_control_return(1);
    }

    /* Let other thread run again.  */
    tx_thread_relinquish();

    /* Check to make sure thread 1 has now run.  */
    if (thread_1_counter != 1)
    {

        /* Byte memory error.  */
        printf("ERROR #7\n");
        test_control_return(1);
    }

    /* Now allocate the memory again. Only one block of this size will fit.  */
    status = tx_byte_allocate(&pool_0, (VOID **) &pointer, 60, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Byte memory error.  */
        printf("ERROR #8\n");
        test_control_return(1);
    }

    /* Resume the second thread.  */
    tx_thread_resume(&thread_2);

    /* Now relinquish to let both thread 1 and 2 suspend.  */
    tx_thread_relinquish();

    /* At this point both threads should be suspended on the byte pool.  */

    /* Release the memory again.  */
    status =  tx_byte_release(pointer);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Byte memory error.  */
        printf("ERROR #9\n");
        test_control_return(1);
    }

    /* Now relinquish to get the other threads to run once.  */
    tx_thread_relinquish();
    tx_thread_relinquish();

    /* At this point both threads 1 and 2 are suspended on the byte pool again.  */
    if ((thread_1_counter != 3) && (thread_2_counter != 1))
    {

        /* Byte memory error.  */
        printf("ERROR #10\n");
        test_control_return(1);
    }

    /* Now allocate the memory again. Only one block of this size will fit.  */
    status = tx_byte_allocate(&pool_0, (VOID **) &pointer, 60, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Byte memory error.  */
        printf("ERROR #10a\n");
        test_control_return(1);
    }

    /* Resume thread 3 to get it suspended on the the pool.  */
    tx_thread_resume(&thread_3);

#ifdef TX_MANUAL_TEST

    /* Set BP hear. Now release the memory and step into the code. After byte search issue IRQ2 mannually, which will
       make thread 3 abort the first request and make another request of a different size. This is the path we are trying
       to generate in the test.  */
    status =  tx_byte_release(pointer);
#else

    /* Set the flag that will make thread 3 abort the first request and make another request of a different size. This tests the memory size change path
       in the byte release loop logic.  */
    threadx_byte_release_loop_test =  1;
    status =  tx_byte_release(pointer);

#endif

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Byte memory error.  */
        printf("ERROR #10b\n");
        test_control_return(1);
    }
    else
    {

        /* Successful test.  */
        printf("SUCCESS!\n");
        test_control_return(0);
    }
}


static void    thread_1_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer;

    while(1)
    {

        /* Allocate memory from the pool.  */
        status = tx_byte_allocate(&pool_0, (VOID **) &pointer, 60, TX_WAIT_FOREVER);

        /* Check status.  */
        if (status != TX_SUCCESS)
            return;

        /* Increment the thread counter.  */
        thread_1_counter++;

        /* Now release each of the blocks. */
        status =  tx_byte_release(pointer);

        /* Check for status.  */
        if (status != TX_SUCCESS)
            return;

        /* Let thread 0 run again.  */
        tx_thread_relinquish();
    }
}


static void    thread_2_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer;

    while(1)
    {

        /* Allocate memory from the pool.  */
        status = tx_byte_allocate(&pool_0, (VOID **) &pointer, 60, TX_WAIT_FOREVER);

        /* Check status.  */
        if (status != TX_SUCCESS)
            return;

        /* Increment the thread counter.  */
        thread_2_counter++;

        /* Now release each of the blocks. */
        status =  tx_byte_release(pointer);

        /* Check for status.  */
        if (status != TX_SUCCESS)
            return;

        /* Let thread 0 run again.  */
        tx_thread_relinquish();
    }
}


static void    thread_3_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer;

    while (1)
    {

        /* Allocate memory from the pool.  */
        tx_byte_allocate(&pool_0, (VOID **) &pointer, 60, TX_WAIT_FOREVER);

#ifdef TX_MANUAL_TEST

        /* Set BP here and manually clear the owner after one failed byte search just to test the loop
           construct in tx_byte_allocate.c.  */
        status =  tx_byte_allocate(&pool_0, (VOID **) &pointer, 90, TX_WAIT_FOREVER);
#else

        /* Set the flag that clears the pool owner after one failed byte search to test the loop
           construct processing in tx_byte_allocate.c.  */
        threadx_byte_allocate_loop_test =  1;
        status =  tx_byte_allocate(&pool_0, (VOID **) &pointer, 90, TX_WAIT_FOREVER);
#endif

        /* Check for status.  */
        if (status != TX_SUCCESS)
            return;

        /* Increment the thread counter.  */
        thread_3_counter++;

        /* Now release the block. */
        status =  tx_byte_release(pointer);

        /* Check for status.  */
        if (status != TX_SUCCESS)
            return;

        /* suspend this thread.  */
        tx_thread_suspend(&thread_3);
    }
}