summaryrefslogtreecommitdiff
path: root/src/pal/tests/palsuite/threading/QueueUserAPC/test7/test7.cpp
blob: 54a63982fe4f74a5d45d11de459a5f8e1edc7a26 (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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

/*=============================================================================
**
** Source: test7.c
**
** Dependencies: PAL_Initialize
**               PAL_Terminate
**               CreateEvent
**               SetEvent
**               CreateThread
**               ResumeThread
**               WaitForMultipleObjectsEx
**               CloseHandle
**
** Purpose:
**
** Test to ensure proper operation of the QueueUserAPC()
** API by trying to queue an APC function on a thread and
** activating it with WaitForMultipleObjectsEx.
**
**
**===========================================================================*/
#include <palsuite.h>


static HANDLE hSyncEvent = NULL;
static HANDLE hTestEvent = NULL;
static int nAPCExecuted = 0;
static BOOL bThreadResult = FALSE;

VOID PALAPI APCFunc( ULONG_PTR dwParam )
{
    ++nAPCExecuted;
}

/**
 * ThreadFunc
 *
 * Dummy thread function for APC queuing.
 */
DWORD PALAPI ThreadFunc( LPVOID param )
{
    DWORD ret = 0;

    /* pessimism */
    bThreadResult = FALSE;

    /* set the sync event to notify the main thread */
    if( ! SetEvent( hSyncEvent ) )
    {
        Trace( "ERROR:%lu:SetEvent() call failed\n", GetLastError() );
        goto done;
    }

    /* wait until the test event is signalled */
    ret = WaitForSingleObject( hTestEvent, INFINITE );
    if( ret != WAIT_OBJECT_0 )
    {
        Trace( "ERROR:WaitForSingleObject() returned %lu, "
                "expected WAIT_OBJECT_0\n",
                ret );
		goto done;
    }

    /* now do an alertable wait on the same event, which is now
       in an unsignalled state */
    ret = WaitForMultipleObjectsEx( 1, &hTestEvent, TRUE, 2000, TRUE );

    /* verify that we got a WAIT_IO_COMPLETION result */
    if( ret != WAIT_IO_COMPLETION )
    {
        Trace( "ERROR:WaitForMultipleObjectsEx returned %lu, "
                "expected WAIT_IO_COMPLETION\n",
                ret );
        goto done;
    }

    /* set the event again */
    if( ! SetEvent( hTestEvent ) )
    {
        Trace( "ERROR:%lu:SetEvent() call failed\n", GetLastError() );
        goto done;
    }

    /* do a non-alertable wait on the same event */
    ret = WaitForMultipleObjectsEx( 1, &hTestEvent, TRUE, INFINITE, FALSE );

    /* verify that we got a WAIT_OBJECT_0 result */
    if( ret != WAIT_OBJECT_0 )
    {
        Trace( "ERROR:WaitForMultipleObjectsEx returned %lu, "
                "expected WAIT_OBJECT_0\n",
                ret );
        goto done;
    }

    /* success at this point */
    bThreadResult = TRUE;


done:
    return bThreadResult;
}


int __cdecl main( int argc, char **argv )

{
    /* local variables */
    HANDLE hThread = NULL;
    DWORD  IDThread;
    DWORD  ret;
    BOOL   bResult = FALSE;

    /* PAL initialization */
    if( (PAL_Initialize(argc, argv)) != 0 )
    {
        return( FAIL );
    }

    /* create an auto-reset event for the other thread to wait on */
    hTestEvent = CreateEvent( NULL, FALSE, FALSE, NULL );
    if( hTestEvent == NULL )
    {
        Fail( "ERROR:%lu:CreateEvent() call failed\n", GetLastError() );
    }

    /* create an auto-reset event for synchronization */
    hSyncEvent = CreateEvent( NULL, FALSE, FALSE, NULL );
    if( hSyncEvent == NULL )
    {
        Trace( "ERROR:%lu:CreateEvent() call failed\n", GetLastError() );
        if( ! CloseHandle( hTestEvent ) )
        {
            Trace( "ERROR:%lu:CreateEvent() call failed\n", GetLastError() );
        }
        Fail( "test failed\n" );
    }

    /* run another dummy thread to cause notification of the library       */
    hThread = CreateThread(    NULL,             /* no security attributes */
                               0,                /* use default stack size */
      (LPTHREAD_START_ROUTINE) ThreadFunc,       /* thread function        */
                      (LPVOID) NULL,             /* pass thread index as   */
                                                 /* function argument      */
                               CREATE_SUSPENDED, /* create suspended       */
                               &IDThread );      /* returns thread id      */

    /* Check the return value for success. */
    if( hThread == NULL )
    {
        /* error creating thread */
        Trace( "ERROR:%lu:CreateThread call failed\n", GetLastError() );
        if( ! CloseHandle( hTestEvent ) )
        {
            Trace( "ERROR:%lu:CloseHandle() call failed\n", GetLastError() );
        }
        Fail( "test failed\n" );
    }

    /* Resume the suspended thread */
    ResumeThread( hThread );

    /* wait until the other thread is ready to proceed */
    ret = WaitForSingleObject( hSyncEvent, 10000 );
    if( ret != WAIT_OBJECT_0 )
    {
        Trace( "ERROR:WaitForSingleObject returned %lu, "
                "expected WAIT_OBJECT_0\n",
                ret );
        goto cleanup;
    }


    /* now queue our APC on the test thread */
    ret = QueueUserAPC( APCFunc, hThread, 0 );
    if( ret == 0 )
    {
        Trace( "ERROR:%lu:QueueUserAPC call failed\n", GetLastError() );
        goto cleanup;
    }

    /* signal the test event so the other thread will proceed */
    if( ! SetEvent( hTestEvent ) )
    {
        Trace( "ERROR:%lu:SetEvent() call failed\n", GetLastError() );
        goto cleanup;
    }

    /* wait on the other thread to complete */
    ret = WaitForSingleObject( hThread, INFINITE );
    if( ret != WAIT_OBJECT_0 )
    {
        Trace( "ERROR:WaitForSingleObject() returned %lu, "
                "expected WAIT_OBJECT_0\n",
                ret );
        goto cleanup;
    }

    /* check the result of the other thread */
    if( bThreadResult == FALSE )
    {
        goto cleanup;
    }

    /* check that the APC function was actually executed exactly one time */
    if( nAPCExecuted != 1 )
    {
        Trace( "ERROR:APC function was executed %d times, "
                "expected once\n", nAPCExecuted );
        goto cleanup;
    }

    /* set the success flag */
    bResult = PASS;


cleanup:
    /* close the global event handles */
    if( ! CloseHandle( hTestEvent ) )
    {
        Trace( "ERROR:%lu:CloseHandle() call failed\n", GetLastError() );
        bResult = FAIL;
    }

    if( ! CloseHandle( hSyncEvent ) )
    {
        Trace( "ERROR:%lu:CloseHandle() call failed\n", GetLastError() );
        bResult = FAIL;
    }

    /* close the thread handle */
    if( ! CloseHandle( hThread ) )
    {
        Trace( "ERROR:%lu:CloseHandle() call failed\n", GetLastError() );
        bResult = FAIL;
    }

    /* output final failure result for failure case */
    if( bResult == FAIL )
    {
        Fail( "test failed\n" );
    }

    /* PAL termination */
    PAL_Terminate();

    /* return success */
    return PASS;
}