summaryrefslogtreecommitdiff
path: root/src/VBox/Main/testcase/tstMouseImpl.cpp
blob: 361daf1498ae7330095e4b60718f1c91eeadc2c6 (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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/* $Id: tstMouseImpl.cpp $ */
/** @file
 * Main unit test - Mouse class.
 */

/*
 * Copyright (C) 2011-2013 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

/******************************************************************************
*   Header Files                                                              *
******************************************************************************/
#define IN_VMM_R3 /* Kill most Windows warnings on CFGMR3* implementations. */
#include "MouseImpl.h"
#include "VMMDev.h"
#include "DisplayImpl.h"

#include <VBox/vmm/cfgm.h>
#include <VBox/vmm/pdmdrv.h>
#include <VBox/VMMDev.h>
#include <iprt/assert.h>
#include <iprt/test.h>

#ifndef RT_OS_WINDOWS
NS_DECL_CLASSINFO(Mouse)
NS_IMPL_THREADSAFE_ISUPPORTS1_CI(Mouse, IMouse)
#endif

PDMIVMMDEVPORT VMMDevPort;

class TestVMMDev : public VMMDevMouseInterface
{
    PPDMIVMMDEVPORT getVMMDevPort(void) { return &VMMDevPort; }
};

class TestDisplay : public DisplayMouseInterface
{
    void getFramebufferDimensions(int32_t *px1, int32_t *py1,
                                  int32_t *px2, int32_t *py2);
    int getScreenResolution(uint32_t cScreen, ULONG *pcx, ULONG *pcy,
                            ULONG *pcBPP, LONG *pXOrigin, LONG *pYOrigin);
};

class TestConsole : public ConsoleMouseInterface
{
public:
    VMMDevMouseInterface *getVMMDevMouseInterface() { return &mVMMDev; }
    DisplayMouseInterface *getDisplayMouseInterface() { return &mDisplay; }
    /** @todo why on earth is this not implemented? */
    void onMouseCapabilityChange(BOOL supportsAbsolute, BOOL supportsRelative,
                                 BOOL supportsMT, BOOL needsHostCursor) {}

private:
    TestVMMDev mVMMDev;
    TestDisplay mDisplay;
};

static int pdmdrvhlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags,
                           PPDMIBASE *ppBaseInterface)
{
    return VERR_PDM_NO_ATTACHED_DRIVER;
}

static struct PDMDRVHLPR3 pdmHlpR3 =
{
    PDM_DRVHLPR3_VERSION,
    pdmdrvhlpAttach,
    NULL,                    /* pfnDetach */
    NULL,                    /* pfnDetachSelf */
    NULL,                    /* pfnMountPrepare */
    NULL,                    /* pfnAssertEMT */
    NULL,                    /* pfnAssertOther */
    NULL,                    /* pfnVMSetError */
    NULL,                    /* pfnVMSetErrorV */
    NULL,                    /* pfnVMSetRuntimeError */
    NULL,                    /* pfnVMSetRuntimeErrorV */
    NULL,                    /* pfnVMState */
    NULL,                    /* pfnVMTeleportedAndNotFullyResumedYet */
    NULL,                    /* pfnGetSupDrvSession */
    NULL,                    /* pfnQueueCreate */
    NULL,                    /* pfnTMGetVirtualFreq */
    NULL,                    /* pfnTMGetVirtualTime */
    NULL,                    /* pfnTMTimerCreate */
    NULL,                    /* pfnSSMRegister */
    NULL,                    /* pfnSSMDeregister */
    NULL,                    /* pfnDBGFInfoRegister */
    NULL,                    /* pfnDBGFInfoDeregister */
    NULL,                    /* pfnSTAMRegister */
    NULL,                    /* pfnSTAMRegisterF */
    NULL,                    /* pfnSTAMRegisterV */
    NULL,                    /* pfnSTAMDeregister */
    NULL,                    /* pfnSUPCallVMMR0Ex */
    NULL,                    /* pfnUSBRegisterHub */
    NULL,                    /* pfnSetAsyncNotification */
    NULL,                    /* pfnAsyncNotificationCompleted */
    NULL,                    /* pfnThreadCreate */
    NULL,                    /* pfnAsyncCompletionTemplateCreate */
#ifdef VBOX_WITH_NETSHAPER
    NULL,                    /* pfnNetShaperAttach */
    NULL,                    /* pfnNetShaperDetach */
#endif
    NULL,                    /* pfnLdrGetRCInterfaceSymbols */
    NULL,                    /* pfnLdrGetR0InterfaceSymbols */
    NULL,                    /* pfnCritSectInit */
    NULL,                    /* pfnCallR0 */
    NULL,                    /* pfnFTSetCheckpoint */
    NULL,                    /* pfnBlkCacheRetain */
    NULL,                    /* pfnVMGetSuspendReason */
    NULL,                    /* pfnVMGetResumeReason */
    NULL,                    /* pfnReserved0 */
    NULL,                    /* pfnReserved1 */
    NULL,                    /* pfnReserved2 */
    NULL,                    /* pfnReserved3 */
    NULL,                    /* pfnReserved4 */
    NULL,                    /* pfnReserved5 */
    NULL,                    /* pfnReserved6 */
    NULL,                    /* pfnReserved7 */
    NULL,                    /* pfnReserved8 */
    NULL,                    /* pfnReserved9 */
    PDM_DRVHLPR3_VERSION     /* u32TheEnd */
};

static struct
{
    int32_t dx;
    int32_t dy;
    int32_t dz;
    int32_t dw;
} mouseEvent;

static int mousePutEvent(PPDMIMOUSEPORT pInterface, int32_t iDeltaX,
                         int32_t iDeltaY, int32_t iDeltaZ, int32_t iDeltaW,
                         uint32_t fButtonStates)
{
    mouseEvent.dx = iDeltaX;
    mouseEvent.dy = iDeltaY;
    mouseEvent.dz = iDeltaZ;
    mouseEvent.dw = iDeltaW;
    return VINF_SUCCESS;
}

static struct
{
    uint32_t cx;
    uint32_t cy;
    int32_t  dz;
    int32_t  dw;
    uint32_t fButtonStates;
} mouseEventAbs;

static int mousePutEventAbs(PPDMIMOUSEPORT pInterface, uint32_t uX,
                            uint32_t uY, int32_t iDeltaZ, int32_t iDeltaW,
                            uint32_t fButtonStates)
{
    mouseEventAbs.cx            = uX;
    mouseEventAbs.cy            = uY;
    mouseEventAbs.dz            = iDeltaZ;
    mouseEventAbs.dw            = iDeltaW;
    mouseEventAbs.fButtonStates = fButtonStates;
    return VINF_SUCCESS;
}

static struct PDMIMOUSEPORT pdmiMousePort =
{
    mousePutEvent,
    mousePutEventAbs,
    NULL                     /* pfnPutEventMT */
};

static void *pdmiBaseQuery(struct PDMIBASE *pInterface, const char *pszIID)
{
    return &pdmiMousePort;
}

static struct PDMIBASE pdmiBase =
{
    pdmiBaseQuery
};

static struct PDMDRVINS pdmdrvInsCore =
{
    PDM_DRVINS_VERSION,
    0,                       /* iInstance */
    NIL_RTRCPTR,             /* pHlpRC */
    NIL_RTRCPTR,             /* pvInstanceDataRC */
    NIL_RTR0PTR,             /* pHelpR0 */
    NIL_RTR0PTR,             /* pvInstanceDataR0 */
    &pdmHlpR3,
    NULL,                    /* pvInstanceDataR3 */
    NIL_RTR3PTR,             /* pReg */
    NIL_RTR3PTR,             /* pCfg */
    &pdmiBase,
    NULL,                    /* pDownBase */
    {                        /* IBase */
        NULL                 /* pfnQueryInterface */
    },
    0,                       /* fTracing */
    0,                       /* idTracing */
#if HC_ARCH_BITS == 32
    { 0 },                   /* au32Padding */
#endif
    {
        { 0 }                /* padding */
    },                       /* Internal */
    { 0 }                    /* achInstanceData */
};

static struct PDMDRVINS *ppdmdrvIns = NULL;

ComObjPtr<Mouse> pMouse;
ConsoleMouseInterface *pConsole = NULL;

static struct
{
    int32_t x;
    int32_t y;
} absoluteMouse;

static int setAbsoluteMouse(PPDMIVMMDEVPORT, int32_t x, int32_t y)
{
    absoluteMouse.x = x;
    absoluteMouse.y = y;
    return VINF_SUCCESS;
}

static int updateMouseCapabilities(PPDMIVMMDEVPORT, uint32_t, uint32_t)
{
    return VINF_SUCCESS;
}

void TestDisplay::getFramebufferDimensions(int32_t *px1, int32_t *py1,
                                           int32_t *px2, int32_t *py2)
{
    if (px1)
        *px1 = -320;
    if (py1)
        *py1 = -240;
    if (px2)
        *px2 = 320;
    if (py2)
        *py2 = 240;
}

int TestDisplay::getScreenResolution(uint32_t cScreen, ULONG *pcx,
                                     ULONG *pcy, ULONG *pcBPP, LONG *pXOrigin, LONG *pYOrigin)
{
    NOREF(cScreen);
    if (pcx)
        *pcx = 640;
    if (pcy)
        *pcy = 480;
    if (pcBPP)
        *pcBPP = 32;
    if (pXOrigin)
        *pXOrigin = 0;
    if (pYOrigin)
        *pYOrigin = 0;
    return S_OK;
}

/******************************************************************************
*   Main test code                                                            *
******************************************************************************/

static int setup(void)
{
    PCFGMNODE pCfg = NULL;
    Mouse *pMouse2;
    int rc = VERR_NO_MEMORY;
    VMMDevPort.pfnSetAbsoluteMouse = setAbsoluteMouse;
    VMMDevPort.pfnUpdateMouseCapabilities = updateMouseCapabilities;
    HRESULT hrc = pMouse.createObject();
    AssertComRC(hrc);
    if (FAILED(hrc))
        return VERR_GENERAL_FAILURE;
    pConsole = new TestConsole;
    pMouse->init(pConsole);
    ppdmdrvIns = (struct PDMDRVINS *) RTMemAllocZ(  sizeof(struct PDMDRVINS)
                                                  + Mouse::DrvReg.cbInstance);
    *ppdmdrvIns = pdmdrvInsCore;
    pMouse2 = pMouse;
    pCfg = CFGMR3CreateTree(NULL);
    if (pCfg)
    {
        rc = CFGMR3InsertInteger(pCfg, "Object", (uintptr_t)pMouse2);
        if (RT_SUCCESS(rc))
            Mouse::DrvReg.pfnConstruct(ppdmdrvIns, pCfg, 0);
    }
    return rc;
}

static void teardown(void)
{
    pMouse.setNull();
    if (pConsole)
        delete pConsole;
    if (ppdmdrvIns)
        RTMemFree(ppdmdrvIns);
}

static bool approxEq(int a, int b, int prec)
{
    return a - b < prec && b - a < prec;
}

/** @test testAbsToVMMDevNewProtocol */
static void testAbsToVMMDevNewProtocol(RTTEST hTest)
{
    PPDMIBASE pBase;
    PPDMIMOUSECONNECTOR pConnector;

    RTTestSub(hTest, "Absolute event to VMMDev, new protocol");
    pBase = &ppdmdrvIns->IBase;
    pConnector = (PPDMIMOUSECONNECTOR)pBase->pfnQueryInterface(pBase,
                                                 PDMIMOUSECONNECTOR_IID);
    pConnector->pfnReportModes(pConnector, true, false, false);
    pMouse->onVMMDevGuestCapsChange(  VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE
                                    | VMMDEV_MOUSE_NEW_PROTOCOL);
    pMouse->PutMouseEventAbsolute(0, 0, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.x, 0x8000, 200),
                      ("absoluteMouse.x=%d\n", absoluteMouse.x));
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.y, 0x8000, 200),
                      ("absoluteMouse.y=%d\n", absoluteMouse.y));
    pMouse->PutMouseEventAbsolute(-319, -239, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.x, 0, 200),
                      ("absoluteMouse.x=%d\n", absoluteMouse.x));
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.y, 0, 200),
                      ("absoluteMouse.y=%d\n", absoluteMouse.y));
    pMouse->PutMouseEventAbsolute(320, 240, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.x, 0xffff, 200),
                      ("absoluteMouse.x=%d\n", absoluteMouse.x));
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.y, 0xffff, 200),
                      ("absoluteMouse.y=%d\n", absoluteMouse.y));
    RTTestSubDone(hTest);
}

/** @test testAbsToVMMDevOldProtocol */
static void testAbsToVMMDevOldProtocol(RTTEST hTest)
{
    PPDMIBASE pBase;
    PPDMIMOUSECONNECTOR pConnector;

    RTTestSub(hTest, "Absolute event to VMMDev, old protocol");
    pBase = &ppdmdrvIns->IBase;
    pConnector = (PPDMIMOUSECONNECTOR)pBase->pfnQueryInterface(pBase,
                                                 PDMIMOUSECONNECTOR_IID);
    pConnector->pfnReportModes(pConnector, true, false, false);
    pMouse->onVMMDevGuestCapsChange(VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE);
    pMouse->PutMouseEventAbsolute(320, 240, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.x, 0x8000, 200),
                      ("absoluteMouse.x=%d\n", absoluteMouse.x));
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.y, 0x8000, 200),
                      ("absoluteMouse.y=%d\n", absoluteMouse.y));
    pMouse->PutMouseEventAbsolute(0, 0, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.x, 0, 200),
                      ("absoluteMouse.x=%d\n", absoluteMouse.x));
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.y, 0, 200),
                      ("absoluteMouse.y=%d\n", absoluteMouse.y));
    pMouse->PutMouseEventAbsolute(-319, -239, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.x, -0x8000, 200),
                      ("absoluteMouse.x=%d\n", absoluteMouse.x));
    RTTESTI_CHECK_MSG(approxEq(absoluteMouse.y, -0x8000, 200),
                      ("absoluteMouse.y=%d\n", absoluteMouse.y));
    RTTestSubDone(hTest);
}

/** @test testAbsToAbsDev */
static void testAbsToAbsDev(RTTEST hTest)
{
    PPDMIBASE pBase;
    PPDMIMOUSECONNECTOR pConnector;

    RTTestSub(hTest, "Absolute event to absolute device");
    pBase = &ppdmdrvIns->IBase;
    pConnector = (PPDMIMOUSECONNECTOR)pBase->pfnQueryInterface(pBase,
                                                 PDMIMOUSECONNECTOR_IID);
    pConnector->pfnReportModes(pConnector, false, true, false);
    pMouse->onVMMDevGuestCapsChange(VMMDEV_MOUSE_NEW_PROTOCOL);
    pMouse->PutMouseEventAbsolute(0, 0, 0, 0, 0);
    RTTESTI_CHECK_MSG(approxEq(mouseEventAbs.cx, 0x8000, 200),
                      ("mouseEventAbs.cx=%d\n", mouseEventAbs.cx));
    RTTESTI_CHECK_MSG(approxEq(mouseEventAbs.cy, 0x8000, 200),
                      ("mouseEventAbs.cy=%d\n", mouseEventAbs.cy));
    pMouse->PutMouseEventAbsolute(-319, -239, 0, 0, 3);
    RTTESTI_CHECK_MSG(approxEq(mouseEventAbs.cx, 0, 200),
                      ("mouseEventAbs.cx=%d\n", mouseEventAbs.cx));
    RTTESTI_CHECK_MSG(approxEq(mouseEventAbs.cy, 0, 200),
                      ("mouseEventAbs.cy=%d\n", mouseEventAbs.cy));
    RTTESTI_CHECK_MSG(mouseEventAbs.fButtonStates == 3,
                      ("mouseEventAbs.fButtonStates=%u\n",
                      (unsigned) mouseEventAbs.fButtonStates));
    pMouse->PutMouseEventAbsolute(320, 240, -3, 2, 1);
    RTTESTI_CHECK_MSG(approxEq(mouseEventAbs.cx, 0xffff, 200),
                      ("mouseEventAbs.cx=%d\n", mouseEventAbs.cx));
    RTTESTI_CHECK_MSG(approxEq(mouseEventAbs.cy, 0xffff, 200),
                      ("mouseEventAbs.cy=%d\n", mouseEventAbs.cy));
    RTTESTI_CHECK_MSG(mouseEventAbs.fButtonStates == 1,
                      ("mouseEventAbs.fButtonStates=%u\n",
                      (unsigned) mouseEventAbs.fButtonStates));
    RTTESTI_CHECK_MSG(mouseEventAbs.dz == -3,
                      ("mouseEventAbs.dz=%d\n", (int) mouseEvent.dz));
    RTTESTI_CHECK_MSG(mouseEventAbs.dw == 2,
                      ("mouseEventAbs.dw=%d\n", (int) mouseEvent.dw));
    mouseEventAbs.cx = mouseEventAbs.cy = 0xffff;
    pMouse->PutMouseEventAbsolute(-640, -480, 0, 0, 0);
    RTTESTI_CHECK_MSG(mouseEventAbs.cx == 0xffff,
                      ("mouseEventAbs.cx=%d\n", mouseEventAbs.cx));
    RTTESTI_CHECK_MSG(mouseEventAbs.cy == 0xffff,
                      ("mouseEventAbs.cy=%d\n", mouseEventAbs.cy));
    RTTestSubDone(hTest);
}

/** @todo generate this using the @test blocks above */
typedef void (*PFNTEST)(RTTEST);
static PFNTEST g_tests[] =
{
    testAbsToVMMDevNewProtocol,
    testAbsToVMMDevOldProtocol,
    testAbsToAbsDev,
    NULL
};

int main(void)
{
    /*
     * Init the runtime, test and say hello.
     */
    RTTEST hTest;
    RTEXITCODE rcExit = RTTestInitAndCreate("tstMouseImpl", &hTest);
    if (rcExit != RTEXITCODE_SUCCESS)
        return rcExit;
    RTTestBanner(hTest);

    /*
     * Run the tests.
     */
    for (unsigned i = 0; g_tests[i]; ++i)
    {
        int rc = setup();
        AssertRC(rc);
        if (RT_SUCCESS(rc))
            g_tests[i](hTest);
        teardown();
    }

    /*
     * Summary
     */
    return RTTestSummaryAndDestroy(hTest);
}