summaryrefslogtreecommitdiff
path: root/src/VBox/Additions/WINNT/Graphics/Video/disp/wddm/gallium/VBoxGallium.cpp
blob: de2ba7b1fd872c466bb51fbb4cd095b6d021c0a0 (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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
/* $Id$ */
/** @file
 * VirtualBox Windows Guest Mesa3D - Gallium driver interface. Constructs Gallium stack.
 */

/*
 * Copyright (C) 2016-2022 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.
 */

#include "VBoxGallium.h"
#include <VBoxGaNine.h>

#include "VBoxD3DAdapter9.h"
#include "VBoxPresent.h"
#include "VBoxGaD3DDevice9Ex.h"
#include "GaDrvEnvWddm.h"

#include <VBox/log.h>

#include <iprt/asm.h>
#include <iprt/string.h>

/*
 * Loading Gallium state tracker and driver:
 *   1) load the hardware driver VBoxVMSVGA or VBoxVirGL:
 *     a) get an entry point to create the pipe_screen;
 *     b) create the pipe_screen passing handles required to call the WDDM miniport driver.
 *   2) load VBoxNine:
 *     a) get an entry point to create the ID3DAdapter interface (GaNineD3DAdapter9Create);
 *     b) create ID3DAdapter passing the pipe_screen pointer.
 *   3) create GaDirect3D9Ex to have IDirect3DEx or GaDirect3DDevice9Ex to have IDirect3DDevice9Ex,
 *      which is returned to WDDM user mode driver to substitute wine's IDirect3DDevice9Ex.
 */

static const char *gpszNineDll =
#ifdef VBOX_WDDM_WOW64
    "VBoxNine-x86.dll"
#else
    "VBoxNine.dll"
#endif
;

static const char *gpszSvgaDll =
#ifdef VBOX_WDDM_WOW64
    "VBoxSVGA-x86.dll"
#else
    "VBoxSVGA.dll"
#endif
;

/**
 * Loads a system DLL.
 *
 * @returns Module handle or NULL
 * @param   pszName             The DLL name.
 */
static HMODULE loadSystemDll(const char *pszName)
{
    char   szPath[MAX_PATH];
    UINT   cchPath = GetSystemDirectoryA(szPath, sizeof(szPath));
    size_t cbName  = strlen(pszName) + 1;
    if (cchPath + 1 + cbName > sizeof(szPath))
    {
        SetLastError(ERROR_FILENAME_EXCED_RANGE);
        return NULL;
    }
    szPath[cchPath] = '\\';
    memcpy(&szPath[cchPath + 1], pszName, cbName);
    return LoadLibraryA(szPath);
}

struct VBOXGAPROC
{
    const char *pszName;
    FARPROC *ppfn;
};

static HRESULT getProcAddresses(HMODULE hmod, struct VBOXGAPROC *paProcs)
{
    struct VBOXGAPROC *pIter = paProcs;
    while (pIter->pszName)
    {
        FARPROC pfn = GetProcAddress(hmod, pIter->pszName);
        if (pfn == NULL)
        {
            Log(("Failed to get the entry point: %s\n", pIter->pszName));
            return E_FAIL;
        }

        *pIter->ppfn = pfn;
        ++pIter;
    }

    return S_OK;
}

static HRESULT loadDll(const char *pszName, HMODULE *phmod, struct VBOXGAPROC *paProcs)
{
    *phmod = loadSystemDll(pszName);
    if (!*phmod)
    {
        Log(("Failed to load the DLL: %s\n", pszName));
        return E_FAIL;
    }

    return getProcAddresses(*phmod, paProcs);
}

/*
 * GalliumStack
 *
 * Load Gallium dlls and provide helpers to create D3D9 interfaces and call Gallium driver API.
 */
class VBoxGalliumStack: public IGalliumStack
{
    public:
        VBoxGalliumStack();
        virtual ~VBoxGalliumStack();

        HRESULT Load();

        /* IUnknown methods */
        STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj);
        STDMETHOD_(ULONG,AddRef)(THIS);
        STDMETHOD_(ULONG,Release)(THIS);

        /* IGalliumStack */
        STDMETHOD(CreateDirect3DEx)(HANDLE hAdapter,
                                    HANDLE hDevice,
                                    const D3DDDI_DEVICECALLBACKS *pDeviceCallbacks,
                                    const VBOXGAHWINFO *pHWInfo,
                                    IDirect3D9Ex **ppOut);
        STDMETHOD(GaCreateDeviceEx)(THIS_
                                    D3DDEVTYPE DeviceType,HWND hFocusWindow,DWORD BehaviorFlags,
                                    D3DPRESENT_PARAMETERS* pPresentationParameters,
                                    D3DDISPLAYMODEEX* pFullscreenDisplayMode,
                                    HANDLE hAdapter,
                                    HANDLE hDevice,
                                    const D3DDDI_DEVICECALLBACKS *pDeviceCallbacks,
                                    const VBOXGAHWINFO *pHWInfo,
                                    IDirect3DDevice9Ex** ppReturnedDeviceInterface);

        STDMETHOD(GaNineD3DAdapter9Create)(struct pipe_screen *s, ID3DAdapter9 **ppOut);
        STDMETHOD_(struct pipe_resource *, GaNinePipeResourceFromSurface)(IUnknown *pSurface);
        STDMETHOD_(struct pipe_context *, GaNinePipeContextFromDevice)(IDirect3DDevice9 *pDevice);

        STDMETHOD_(struct pipe_screen *, GaDrvScreenCreate)(const WDDMGalliumDriverEnv *pEnv);
        STDMETHOD_(void, GaDrvScreenDestroy)(struct pipe_screen *s);
        STDMETHOD_(WDDMGalliumDriverEnv const *, GaDrvGetWDDMEnv)(struct pipe_screen *pScreen);
        STDMETHOD_(uint32_t, GaDrvGetContextId)(struct pipe_context *pPipeContext);
        STDMETHOD_(uint32_t, GaDrvGetSurfaceId)(struct pipe_screen *pScreen, struct pipe_resource *pResource);
        STDMETHOD_(void, GaDrvContextFlush)(struct pipe_context *pPipeContext);

    private:
        void unload();

        volatile ULONG mcRefs;

        HMODULE mhmodStateTracker;
        HMODULE mhmodDriver;

        struct GaNineFunctions
        {
            PFNGaNineD3DAdapter9Create       pfnGaNineD3DAdapter9Create;
            PFNGaNinePipeResourceFromSurface pfnGaNinePipeResourceFromSurface;
            PFNGaNinePipeContextFromDevice   pfnGaNinePipeContextFromDevice;
        } mNine;

        struct GaDrvFunctions
        {
            PFNGaDrvScreenCreate  pfnGaDrvScreenCreate;
            PFNGaDrvScreenDestroy pfnGaDrvScreenDestroy;
            PFNGaDrvGetWDDMEnv    pfnGaDrvGetWDDMEnv;
            PFNGaDrvGetContextId  pfnGaDrvGetContextId;
            PFNGaDrvGetSurfaceId  pfnGaDrvGetSurfaceId;
            PFNGaDrvContextFlush  pfnGaDrvContextFlush;
        } mDrv;
};


/*
 * IDirect3D9Ex implementation corresponds to one WDDM device.
 */
class GaDirect3D9Ex: public IGaDirect3D9Ex
{
    public:
        GaDirect3D9Ex(VBoxGalliumStack *pStack);
        virtual ~GaDirect3D9Ex();

        HRESULT Init(HANDLE hAdapter,
                     HANDLE hDevice,
                     const D3DDDI_DEVICECALLBACKS *pDeviceCallbacks,
                     const VBOXGAHWINFO *pHWInfo);

        /*** IUnknown methods ***/
        STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj);
        STDMETHOD_(ULONG,AddRef)(THIS);
        STDMETHOD_(ULONG,Release)(THIS);

        /*** IDirect3D9 methods ***/
        STDMETHOD(RegisterSoftwareDevice)(THIS_ void* pInitializeFunction);
        STDMETHOD_(UINT, GetAdapterCount)(THIS);
        STDMETHOD(GetAdapterIdentifier)(THIS_ UINT Adapter,DWORD Flags,D3DADAPTER_IDENTIFIER9* pIdentifier);
        STDMETHOD_(UINT, GetAdapterModeCount)(THIS_ UINT Adapter,D3DFORMAT Format);
        STDMETHOD(EnumAdapterModes)(THIS_ UINT Adapter,D3DFORMAT Format,UINT Mode,D3DDISPLAYMODE* pMode);
        STDMETHOD(GetAdapterDisplayMode)(THIS_ UINT Adapter,D3DDISPLAYMODE* pMode);
        STDMETHOD(CheckDeviceType)(THIS_ UINT Adapter,D3DDEVTYPE DevType,D3DFORMAT AdapterFormat,
                                   D3DFORMAT BackBufferFormat,BOOL bWindowed);
        STDMETHOD(CheckDeviceFormat)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT AdapterFormat,
                                     DWORD Usage,D3DRESOURCETYPE RType,D3DFORMAT CheckFormat);
        STDMETHOD(CheckDeviceMultiSampleType)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT SurfaceFormat,
                                              BOOL Windowed,D3DMULTISAMPLE_TYPE MultiSampleType,DWORD* pQualityLevels);
        STDMETHOD(CheckDepthStencilMatch)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT AdapterFormat,
                                          D3DFORMAT RenderTargetFormat,D3DFORMAT DepthStencilFormat);
        STDMETHOD(CheckDeviceFormatConversion)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT SourceFormat,
                                               D3DFORMAT TargetFormat);
        STDMETHOD(GetDeviceCaps)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DCAPS9* pCaps);
        STDMETHOD_(HMONITOR, GetAdapterMonitor)(THIS_ UINT Adapter);
        STDMETHOD(CreateDevice)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,HWND hFocusWindow,
                                DWORD BehaviorFlags,D3DPRESENT_PARAMETERS* pPresentationParameters,
                                IDirect3DDevice9** ppReturnedDeviceInterface);

        /*** IDirect3D9Ex methods ***/
        STDMETHOD_(UINT, GetAdapterModeCountEx)(THIS_ UINT Adapter,CONST D3DDISPLAYMODEFILTER* pFilter);
        STDMETHOD(EnumAdapterModesEx)(THIS_ UINT Adapter,CONST D3DDISPLAYMODEFILTER* pFilter,
                                      UINT Mode,D3DDISPLAYMODEEX* pMode);
        STDMETHOD(GetAdapterDisplayModeEx)(THIS_ UINT Adapter,D3DDISPLAYMODEEX* pMode,D3DDISPLAYROTATION* pRotation);
        STDMETHOD(CreateDeviceEx)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,HWND hFocusWindow,DWORD BehaviorFlags,
                                  D3DPRESENT_PARAMETERS* pPresentationParameters,
                                  D3DDISPLAYMODEEX* pFullscreenDisplayMode,
                                  IDirect3DDevice9Ex** ppReturnedDeviceInterface);
        STDMETHOD(GetAdapterLUID)(THIS_ UINT Adapter,LUID * pLUID);

        /* IGaDirect3D9Ex methods */
        STDMETHOD_(IGalliumStack *, GetGalliumStack)(THIS);
        STDMETHOD_(ID3DAdapter9 *, GetAdapter9)(THIS);
        STDMETHOD_(struct pipe_screen *, GetScreen)(THIS);

    private:
        void cleanup();

        volatile ULONG mcRefs;

        VBoxGalliumStack *mpStack;
        struct pipe_screen *mpPipeScreen;
        ID3DAdapter9 *mpD3DAdapter9;

        /* The Gallium driver environment helper object. */
        GaDrvEnvWddm mEnv;
};


/*
 * VBoxGalliumStack implementation.
 */

VBoxGalliumStack::VBoxGalliumStack()
    :
    mcRefs(0),
    mhmodStateTracker(0),
    mhmodDriver(0)
{
    RT_ZERO(mNine);
    RT_ZERO(mDrv);
}

VBoxGalliumStack::~VBoxGalliumStack()
{
    unload();
}

STDMETHODIMP_(ULONG) VBoxGalliumStack::AddRef()
{
    ULONG refs = InterlockedIncrement(&mcRefs);
    return refs;
}

STDMETHODIMP_(ULONG) VBoxGalliumStack::Release()
{
    ULONG refs = InterlockedDecrement(&mcRefs);
    if (refs == 0)
    {
        delete this;
    }
    return refs;
}

STDMETHODIMP VBoxGalliumStack::QueryInterface(REFIID riid,
                                              void **ppvObject)
{
    if (!ppvObject)
    {
        return E_POINTER;
    }

    if (IsEqualGUID(IID_IUnknown, riid))
    {
        AddRef();
        *ppvObject = this;
        return S_OK;
    }

    *ppvObject = NULL;
    return E_NOINTERFACE;
}

HRESULT VBoxGalliumStack::Load()
{
    struct VBOXGAPROC aNineProcs[] =
    {
        { "GaNineD3DAdapter9Create",        (FARPROC *)&mNine.pfnGaNineD3DAdapter9Create },
        { "GaNinePipeResourceFromSurface",  (FARPROC *)&mNine.pfnGaNinePipeResourceFromSurface },
        { "GaNinePipeContextFromDevice",    (FARPROC *)&mNine.pfnGaNinePipeContextFromDevice },
        { NULL, NULL }
    };

    struct VBOXGAPROC aDrvProcs[] =
    {
        { "GaDrvScreenCreate",  (FARPROC *)&mDrv.pfnGaDrvScreenCreate },
        { "GaDrvScreenDestroy", (FARPROC *)&mDrv.pfnGaDrvScreenDestroy },
        { "GaDrvGetWDDMEnv",    (FARPROC *)&mDrv.pfnGaDrvGetWDDMEnv },
        { "GaDrvGetContextId",  (FARPROC *)&mDrv.pfnGaDrvGetContextId },
        { "GaDrvGetSurfaceId",  (FARPROC *)&mDrv.pfnGaDrvGetSurfaceId },
        { "GaDrvContextFlush",  (FARPROC *)&mDrv.pfnGaDrvContextFlush },
        { NULL, NULL }
    };

    /** @todo Select the driver dll according to the hardware. */
    const char *pszDriverDll = gpszSvgaDll;

    HRESULT hr = loadDll(pszDriverDll, &mhmodDriver, aDrvProcs);
    if (SUCCEEDED(hr))
    {
        hr = loadDll(gpszNineDll, &mhmodStateTracker, aNineProcs);
    }

    return hr;
}

void VBoxGalliumStack::unload()
{
    RT_ZERO(mNine);
    RT_ZERO(mDrv);

    if (mhmodStateTracker)
    {
        FreeLibrary(mhmodStateTracker);
        mhmodStateTracker = 0;
    }

    if (mhmodDriver)
    {
        FreeLibrary(mhmodDriver);
        mhmodDriver = 0;
    }
}

STDMETHODIMP VBoxGalliumStack::GaNineD3DAdapter9Create(struct pipe_screen *s,
                                                       ID3DAdapter9 **ppOut)
{
    return mNine.pfnGaNineD3DAdapter9Create(s, ppOut);
}

STDMETHODIMP_(struct pipe_resource *) VBoxGalliumStack::GaNinePipeResourceFromSurface(IUnknown *pSurface)
{
    return mNine.pfnGaNinePipeResourceFromSurface(pSurface);
}

STDMETHODIMP_(struct pipe_context *) VBoxGalliumStack::GaNinePipeContextFromDevice(IDirect3DDevice9 *pDevice)
{
    return mNine.pfnGaNinePipeContextFromDevice(pDevice);
}

STDMETHODIMP_(struct pipe_screen *) VBoxGalliumStack::GaDrvScreenCreate(const WDDMGalliumDriverEnv *pEnv)
{
    return mDrv.pfnGaDrvScreenCreate(pEnv);
}

STDMETHODIMP_(void) VBoxGalliumStack::GaDrvScreenDestroy(struct pipe_screen *s)
{
    mDrv.pfnGaDrvScreenDestroy(s);
}

STDMETHODIMP_(WDDMGalliumDriverEnv const *) VBoxGalliumStack::GaDrvGetWDDMEnv(struct pipe_screen *pScreen)
{
    return mDrv.pfnGaDrvGetWDDMEnv(pScreen);
}

STDMETHODIMP_(uint32_t) VBoxGalliumStack::GaDrvGetContextId(struct pipe_context *pPipeContext)
{
    return mDrv.pfnGaDrvGetContextId(pPipeContext);
}

STDMETHODIMP_(uint32_t) VBoxGalliumStack::GaDrvGetSurfaceId(struct pipe_screen *pScreen,
                                                            struct pipe_resource *pResource)
{
    return mDrv.pfnGaDrvGetSurfaceId(pScreen, pResource);
}

STDMETHODIMP_(void) VBoxGalliumStack::GaDrvContextFlush(struct pipe_context *pPipeContext)
{
    mDrv.pfnGaDrvContextFlush(pPipeContext);
}

STDMETHODIMP VBoxGalliumStack::CreateDirect3DEx(HANDLE hAdapter,
                                                HANDLE hDevice,
                                                const D3DDDI_DEVICECALLBACKS *pDeviceCallbacks,
                                                const VBOXGAHWINFO *pHWInfo,
                                                IDirect3D9Ex **ppOut)
{
    GaDirect3D9Ex *p = new GaDirect3D9Ex(this);
    if (!p)
        return E_OUTOFMEMORY;

    HRESULT hr = p->Init(hAdapter, hDevice, pDeviceCallbacks, pHWInfo);
    if (SUCCEEDED(hr))
    {
        p->AddRef();
        *ppOut = p;
    }
    else
    {
        delete p;
    }

    return hr;
}

STDMETHODIMP VBoxGalliumStack::GaCreateDeviceEx(D3DDEVTYPE DeviceType,
                                                HWND hFocusWindow,
                                                DWORD BehaviorFlags,
                                                D3DPRESENT_PARAMETERS* pPresentationParameters,
                                                D3DDISPLAYMODEEX* pFullscreenDisplayMode,
                                                HANDLE hAdapter,
                                                HANDLE hDevice,
                                                const D3DDDI_DEVICECALLBACKS *pDeviceCallbacks,
                                                const VBOXGAHWINFO *pHWInfo,
                                                IDirect3DDevice9Ex **ppReturnedDeviceInterface)
{
    /* Create the per-WDDM-device gallium adapter. */
    IGaDirect3D9Ex *pD3D9 = NULL;
    HRESULT hr = CreateDirect3DEx(hAdapter,
                                  hDevice,
                                  pDeviceCallbacks,
                                  pHWInfo,
                                  (IDirect3D9Ex **)&pD3D9);
    if (SUCCEEDED(hr))
    {
        /* Create wrapper object for IDirect3DDevice9Ex */
        GaDirect3DDevice9Ex *p = new GaDirect3DDevice9Ex(pD3D9, hAdapter, hDevice, pDeviceCallbacks);
        if (p)
        {
            hr = p->Init(DeviceType, hFocusWindow, BehaviorFlags, pPresentationParameters, pFullscreenDisplayMode);
            if (SUCCEEDED(hr))
            {
                p->AddRef();
                *ppReturnedDeviceInterface = p;
            }
            else
            {
                delete p;
            }
        }
        else
        {
            hr = E_OUTOFMEMORY;
        }

        pD3D9->Release();
    }

    return hr;
}

HRESULT GalliumStackCreate(IGalliumStack **ppOut)
{
    VBoxGalliumStack *p = new VBoxGalliumStack();
    if (!p)
        return E_OUTOFMEMORY;

    HRESULT hr = p->Load();
    if (SUCCEEDED(hr))
    {
        p->AddRef();
        *ppOut = p;
    }
    else
    {
        delete p;
    }

    return hr;
}


/*
 * GaDirect3D9Ex
 *
 * IDirect3D9Ex implementation based on Gallium D3D9 state tracker "nine".
 */

GaDirect3D9Ex::GaDirect3D9Ex(VBoxGalliumStack *pStack)
    :
    mcRefs(0),
    mpStack(pStack),
    mpPipeScreen(0),
    mpD3DAdapter9(0)
{
    mpStack->AddRef();
}

GaDirect3D9Ex::~GaDirect3D9Ex()
{
    cleanup();
}

STDMETHODIMP_(ULONG) GaDirect3D9Ex::AddRef()
{
    ULONG refs = InterlockedIncrement(&mcRefs);
    return refs;
}

STDMETHODIMP_(ULONG) GaDirect3D9Ex::Release()
{
    ULONG refs = InterlockedDecrement(&mcRefs);
    if (refs == 0)
    {
        delete this;
    }
    return refs;
}

STDMETHODIMP GaDirect3D9Ex::QueryInterface(REFIID riid,
                                           void **ppvObject)
{
    if (!ppvObject)
    {
        return E_POINTER;
    }

    if (   IsEqualGUID(IID_IGaDirect3D9Ex, riid)
        || IsEqualGUID(IID_IDirect3D9Ex, riid)
        || IsEqualGUID(IID_IDirect3D9, riid)
        || IsEqualGUID(IID_IUnknown, riid))
    {
        AddRef();
        *ppvObject = this;
        return S_OK;
    }

    *ppvObject = NULL;
    return E_NOINTERFACE;
}

HRESULT GaDirect3D9Ex::Init(HANDLE hAdapter,
                            HANDLE hDevice,
                            const D3DDDI_DEVICECALLBACKS *pDeviceCallbacks,
                            const VBOXGAHWINFO *pHWInfo)
{
    LogFunc(("%p %p %p\n", hAdapter, hDevice, pDeviceCallbacks));

    HRESULT hr;

    mEnv.Init(hAdapter, hDevice, pDeviceCallbacks, pHWInfo);
    const WDDMGalliumDriverEnv *pEnv = mEnv.Env();

    mpPipeScreen = mpStack->GaDrvScreenCreate(pEnv);
    if (mpPipeScreen)
    {
        hr = mpStack->GaNineD3DAdapter9Create(mpPipeScreen, &mpD3DAdapter9);
        Assert(SUCCEEDED(hr));
    }
    else
    {
        hr = E_FAIL;
        AssertFailed();
    }

    return hr;
}

void GaDirect3D9Ex::cleanup()
{
    if (mpD3DAdapter9)
    {
        D3DAdapter9_Release(mpD3DAdapter9);
        mpD3DAdapter9 = NULL;
    }

    if (mpPipeScreen)
    {
        mpStack->GaDrvScreenDestroy(mpPipeScreen);
        mpPipeScreen = NULL;
    }

    if (mpStack)
    {
        mpStack->Release();
        mpStack = 0;
    }
}

#define TRAPNOTIMPL do { \
    ASMBreakpoint(); \
} while (0)


STDMETHODIMP GaDirect3D9Ex::RegisterSoftwareDevice(void *pInitializeFunction)
{
    RT_NOREF(pInitializeFunction);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP_(UINT) GaDirect3D9Ex::GetAdapterCount()
{
    TRAPNOTIMPL;
    return 1;
}

STDMETHODIMP GaDirect3D9Ex::GetAdapterIdentifier(UINT Adapter,
                                                 DWORD Flags,
                                                 D3DADAPTER_IDENTIFIER9 *pIdentifier)
{
    RT_NOREF3(Adapter, Flags, pIdentifier);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP_(UINT) GaDirect3D9Ex::GetAdapterModeCount(UINT Adapter,
                                                       D3DFORMAT Format)
{
    RT_NOREF2(Adapter, Format);
    TRAPNOTIMPL;
    return 1;
}

STDMETHODIMP GaDirect3D9Ex::EnumAdapterModes(UINT Adapter,
                                             D3DFORMAT Format,
                                             UINT Mode,
                                             D3DDISPLAYMODE *pMode)
{
    RT_NOREF4(Adapter, Format, Mode, pMode);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::GetAdapterDisplayMode(UINT Adapter,
                                                  D3DDISPLAYMODE *pMode)
{
    RT_NOREF2(Adapter, pMode);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::CheckDeviceType(UINT iAdapter,
                                            D3DDEVTYPE DevType,
                                            D3DFORMAT DisplayFormat,
                                            D3DFORMAT BackBufferFormat,
                                            BOOL bWindowed)
{
    RT_NOREF5(iAdapter, DevType, DisplayFormat, BackBufferFormat, bWindowed);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::CheckDeviceFormat(UINT Adapter,
                                              D3DDEVTYPE DeviceType,
                                              D3DFORMAT AdapterFormat,
                                              DWORD Usage,
                                              D3DRESOURCETYPE RType,
                                              D3DFORMAT CheckFormat)
{
    RT_NOREF6(Adapter, DeviceType, AdapterFormat, Usage, RType, CheckFormat);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::CheckDeviceMultiSampleType(UINT Adapter,
                                                       D3DDEVTYPE DeviceType,
                                                       D3DFORMAT SurfaceFormat,
                                                       BOOL Windowed,
                                                       D3DMULTISAMPLE_TYPE MultiSampleType,
                                                       DWORD *pQualityLevels)
{
    RT_NOREF6(Adapter, DeviceType, SurfaceFormat, Windowed, MultiSampleType, pQualityLevels);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::CheckDepthStencilMatch(UINT Adapter,
                                                   D3DDEVTYPE DeviceType,
                                                   D3DFORMAT AdapterFormat,
                                                   D3DFORMAT RenderTargetFormat,
                                                   D3DFORMAT DepthStencilFormat)
{
    RT_NOREF5(Adapter, DeviceType, AdapterFormat, RenderTargetFormat, DepthStencilFormat);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::CheckDeviceFormatConversion(UINT Adapter,
                                                        D3DDEVTYPE DeviceType,
                                                        D3DFORMAT SourceFormat,
                                                        D3DFORMAT TargetFormat)
{
    RT_NOREF4(Adapter, DeviceType, SourceFormat, TargetFormat);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::GetDeviceCaps(UINT Adapter,
                                          D3DDEVTYPE DeviceType,
                                          D3DCAPS9 *pCaps)
{
    RT_NOREF(Adapter);
    HRESULT hr = D3DAdapter9_GetDeviceCaps(mpD3DAdapter9, DeviceType, pCaps);
    return hr;
}

STDMETHODIMP_(HMONITOR) GaDirect3D9Ex::GetAdapterMonitor(UINT Adapter)
{
    RT_NOREF(Adapter);
    TRAPNOTIMPL;
    return NULL;
}

STDMETHODIMP GaDirect3D9Ex::CreateDevice(UINT Adapter,
                                         D3DDEVTYPE DeviceType,
                                         HWND hFocusWindow,
                                         DWORD BehaviorFlags,
                                         D3DPRESENT_PARAMETERS *pPresentationParameters,
                                         IDirect3DDevice9 **ppReturnedDeviceInterface)
{
    return CreateDeviceEx(Adapter, DeviceType, hFocusWindow, BehaviorFlags, pPresentationParameters,
                          NULL, (IDirect3DDevice9Ex **)ppReturnedDeviceInterface);
}

STDMETHODIMP_(UINT) GaDirect3D9Ex::GetAdapterModeCountEx(UINT Adapter,
                                                         CONST D3DDISPLAYMODEFILTER *pFilter)
{
    RT_NOREF2(Adapter, pFilter);
    TRAPNOTIMPL;
    return 1;
}

STDMETHODIMP GaDirect3D9Ex::EnumAdapterModesEx(UINT Adapter,
                                               CONST D3DDISPLAYMODEFILTER *pFilter,
                                               UINT Mode,
                                               D3DDISPLAYMODEEX *pMode)
{
    RT_NOREF4(Adapter, pFilter, Mode, pMode);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::GetAdapterDisplayModeEx(UINT Adapter,
                                                    D3DDISPLAYMODEEX *pMode,
                                                    D3DDISPLAYROTATION *pRotation)
{
    RT_NOREF3(Adapter, pMode, pRotation);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::CreateDeviceEx(UINT Adapter,
                                           D3DDEVTYPE DeviceType,
                                           HWND hFocusWindow,
                                           DWORD BehaviorFlags,
                                           D3DPRESENT_PARAMETERS *pPresentationParameters,
                                           D3DDISPLAYMODEEX *pFullscreenDisplayMode,
                                           IDirect3DDevice9Ex **ppReturnedDeviceInterface)
{
    RT_NOREF7(Adapter, DeviceType, hFocusWindow, BehaviorFlags, pPresentationParameters,
              pFullscreenDisplayMode, ppReturnedDeviceInterface);
    /* This method should never be called. GaCreateDeviceEx is the right one. */
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP GaDirect3D9Ex::GetAdapterLUID(UINT Adapter,
                                           LUID *pLUID)
{
    RT_NOREF2(Adapter, pLUID);
    TRAPNOTIMPL;
    return D3DERR_INVALIDCALL;
}

STDMETHODIMP_(IGalliumStack *) GaDirect3D9Ex::GetGalliumStack(void)
{
    return mpStack;
}

STDMETHODIMP_(ID3DAdapter9 *) GaDirect3D9Ex::GetAdapter9(void)
{
    return mpD3DAdapter9;
}

STDMETHODIMP_(struct pipe_screen *) GaDirect3D9Ex::GetScreen(void)
{
    return mpPipeScreen;
}