summaryrefslogtreecommitdiff
path: root/src/pal/tests/palsuite/threading/QueueUserAPC/test5/test5.c
blob: 3d26a55f5900a6e1cab6ef98d365fa12abc6d375 (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
// 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: test5.c
**
** Dependencies: PAL_Initialize
**               PAL_Terminate
**               CreateEvent
**               SetEvent
**               CreateThread
**               ResumeThread
**               WaitForSingleObject
**               CloseHandle
**
** Purpose:
**
** Test to ensure proper operation of the QueueUserAPC()
** API by trying to queue and activate APC functions on
** a thread that was created suspended, prior to resuming
** it. We're verifying the following behavior:
**
** "If an application queues an APC before the thread begins
** running, the thread begins by calling the APC function.
** After the thread calls an APC function, it calls the APC
** functions for all APCs in its APC queue."
**
**
**===========================================================================*/
#include <palsuite.h>


static HANDLE hEvent = NULL;
static BOOL bAPCExecuted = FALSE;

VOID PALAPI APCFunc( ULONG_PTR dwParam )
{
    bAPCExecuted = TRUE;
}

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

    /* alertable wait until the global event is signalled */
    ret = WaitForSingleObject( hEvent, INFINITE );
    if( ret != WAIT_OBJECT_0 )
    {
        Fail( "ERROR:WaitForSingleObject() returned %lu, "
                "expected WAIT_OBJECT_0\n",
                ret );
    }

    return 0;
}


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 event for the other thread to wait on */
    hEvent = CreateEvent( NULL, TRUE, FALSE, NULL );
    if( hEvent == NULL )
    {
        Fail( "ERROR:%lu:CreateEvent() call failed\n", GetLastError() );
    }

    /* 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( hEvent ) )
        {
            Trace( "ERROR:%lu:CloseHandle() call failed\n", GetLastError() );
        }
        Fail( "test failed\n" );
    }

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

    /* wait on the suspended thread */
    ret = WaitForSingleObject( hThread, 2000 );
    if( ret != WAIT_TIMEOUT )
    {
        Trace( "ERROR:WaitForSingleObject() returned %lu, "
                "expected WAIT_TIMEOUT\n",
                ret );
        goto cleanup;
    }

    /* verify that the APC function was not executed */
    if( bAPCExecuted == TRUE )
    {
        Trace( "ERROR:APC function was executed for a suspended thread\n" );
        goto cleanup;
    }

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

    /* do another wait on the resumed thread */
    ret = WaitForSingleObject( hThread, 2000 );

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

    /* check that the APC function was actually executed */
    if( bAPCExecuted == FALSE )
    {
        Trace( "ERROR:APC function was not executed\n" );
        goto cleanup;
    }

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

cleanup:
    /* signal the event so the other thread will exit */
    if( ! SetEvent( hEvent ) )
    {
        Trace( "ERROR:%lu:SetEvent() call failed\n", GetLastError() );
        bResult = FAIL;
    }

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

    /* wait on the other thread to complete */
    ret = WaitForSingleObject( hThread, 2000 );
    if( ret != WAIT_OBJECT_0 )
    {
        Trace( "ERROR:WaitForSingleObject() returned %lu, "
                "expected WAIT_OBJECT_0\n",
                ret );
        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;
}