df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync/* $Id$ */
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync/** @file
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync *
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * VBox extension to Wine D3D
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync *
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2011-2012 Oracle Corporation
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync *
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * available from http://www.virtualbox.org. This file is free software;
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * you can redistribute it and/or modify it under the terms of the GNU
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * General Public License (GPL) as published by the Free Software
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync */
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync#ifndef ___VBOXEXT_H__
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync#define ___VBOXEXT_H__
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync#ifdef VBOX_WINE_WITHOUT_LIBWINE
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync# include <windows.h>
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync#endif
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync#include <iprt/list.h>
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsyncHRESULT VBoxExtCheckInit();
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsyncHRESULT VBoxExtCheckTerm();
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync#if defined(VBOX_WINE_WITH_SINGLE_CONTEXT) || defined(VBOX_WINE_WITH_SINGLE_SWAPCHAIN_CONTEXT)
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync# ifndef VBOX_WITH_WDDM
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync/* Windows destroys HDC created by a given thread when the thread is terminated
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * this leads to a mess-up in Wine & Chromium code in some situations, e.g.
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * D3D device is created in one thread, then the thread is terminated,
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync * then device is started to be used in another thread */
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsyncHDC VBoxExtGetDC(HWND hWnd);
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsyncint VBoxExtReleaseDC(HWND hWnd, HDC hDC);
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync# endif
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync/* We need to do a VBoxTlsRefRelease for the current thread context on thread exit to avoid memory leaking
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync * Calling VBoxTlsRefRelease may result in a call to context dtor callback, which is supposed to be run under wined3d lock.
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync * We can not acquire a wined3d lock in DllMain since this would result in a lock order violation, which may result in a deadlock.
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync * In other words, wined3d may internally call Win32 API functions which result in a DLL lock acquisition while holding wined3d lock.
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync * So lock order should always be "wined3d lock" -> "dll lock".
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsync * To avoid possible deadlocks we make an asynchronous call to a worker thread to make a context release from there. */
6decafdf89f825b3af922ab6fa02345e08e5be7bvboxsyncvoid VBoxExtReleaseContextAsync(struct wined3d_context *context);
3a974120cf0d8d23b2531cd62fe04532e6ac205evboxsync#endif
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync
3b5b00fc19a7b52f11075648a1b93d477137f4d3vboxsync/* API for creating & destroying windows */
3a974120cf0d8d23b2531cd62fe04532e6ac205evboxsyncHRESULT VBoxExtWndDestroy(HWND hWnd, HDC hDC);
3a974120cf0d8d23b2531cd62fe04532e6ac205evboxsyncHRESULT VBoxExtWndCreate(DWORD width, DWORD height, HWND *phWnd, HDC *phDC);
3b5b00fc19a7b52f11075648a1b93d477137f4d3vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync/* hashmap */
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef DECLCALLBACK(uint32_t) FNVBOXEXT_HASHMAP_HASH(void *pvKey);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef FNVBOXEXT_HASHMAP_HASH *PFNVBOXEXT_HASHMAP_HASH;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef DECLCALLBACK(bool) FNVBOXEXT_HASHMAP_EQUAL(void *pvKey1, void *pvKey2);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef FNVBOXEXT_HASHMAP_EQUAL *PFNVBOXEXT_HASHMAP_EQUAL;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef DECLCALLBACK(bool) FNVBOXEXT_HASHMAP_VISITOR(struct VBOXEXT_HASHMAP *pMap, void *pvKey, struct VBOXEXT_HASHMAP_ENTRY *pValue, void *pvVisitor);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef FNVBOXEXT_HASHMAP_VISITOR *PFNVBOXEXT_HASHMAP_VISITOR;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef struct VBOXEXT_HASHMAP_ENTRY
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync RTLISTNODE ListNode;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync void *pvKey;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync uint32_t u32Hash;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync} VBOXEXT_HASHMAP_ENTRY, *PVBOXEXT_HASHMAP_ENTRY;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef struct VBOXEXT_HASHMAP_BUCKET
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync RTLISTNODE EntryList;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync} VBOXEXT_HASHMAP_BUCKET, *PVBOXEXT_HASHMAP_BUCKET;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync#define VBOXEXT_HASHMAP_NUM_BUCKETS 29
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef struct VBOXEXT_HASHMAP
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PFNVBOXEXT_HASHMAP_HASH pfnHash;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PFNVBOXEXT_HASHMAP_EQUAL pfnEqual;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync uint32_t cEntries;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync VBOXEXT_HASHMAP_BUCKET aBuckets[VBOXEXT_HASHMAP_NUM_BUCKETS];
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync} VBOXEXT_HASHMAP, *PVBOXEXT_HASHMAP;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncvoid VBoxExtHashInit(PVBOXEXT_HASHMAP pMap, PFNVBOXEXT_HASHMAP_HASH pfnHash, PFNVBOXEXT_HASHMAP_EQUAL pfnEqual);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncPVBOXEXT_HASHMAP_ENTRY VBoxExtHashPut(PVBOXEXT_HASHMAP pMap, void *pvKey, PVBOXEXT_HASHMAP_ENTRY pEntry);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncPVBOXEXT_HASHMAP_ENTRY VBoxExtHashGet(PVBOXEXT_HASHMAP pMap, void *pvKey);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncPVBOXEXT_HASHMAP_ENTRY VBoxExtHashRemove(PVBOXEXT_HASHMAP pMap, void *pvKey);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncvoid* VBoxExtHashRemoveEntry(PVBOXEXT_HASHMAP pMap, PVBOXEXT_HASHMAP_ENTRY pEntry);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncvoid VBoxExtHashVisit(PVBOXEXT_HASHMAP pMap, PFNVBOXEXT_HASHMAP_VISITOR pfnVisitor, void *pvVisitor);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncvoid VBoxExtHashCleanup(PVBOXEXT_HASHMAP pMap, PFNVBOXEXT_HASHMAP_VISITOR pfnVisitor, void *pvVisitor);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncDECLINLINE(uint32_t) VBoxExtHashSize(PVBOXEXT_HASHMAP pMap)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync return pMap->cEntries;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync}
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncDECLINLINE(void*) VBoxExtHashEntryKey(PVBOXEXT_HASHMAP_ENTRY pEntry)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync return pEntry->pvKey;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync}
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef DECLCALLBACK(void) FNVBOXEXT_HASHCACHE_CLEANUP_ENTRY(void *pvKey, struct VBOXEXT_HASHCACHE_ENTRY *pEntry);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef FNVBOXEXT_HASHCACHE_CLEANUP_ENTRY *PFNVBOXEXT_HASHCACHE_CLEANUP_ENTRY;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef struct VBOXEXT_HASHCACHE_ENTRY
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync VBOXEXT_HASHMAP_ENTRY MapEntry;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync uint32_t u32Usage;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync} VBOXEXT_HASHCACHE_ENTRY, *PVBOXEXT_HASHCACHE_ENTRY;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsynctypedef struct VBOXEXT_HASHCACHE
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync VBOXEXT_HASHMAP Map;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync uint32_t cMaxElements;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PFNVBOXEXT_HASHCACHE_CLEANUP_ENTRY pfnCleanupEntry;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync} VBOXEXT_HASHCACHE, *PVBOXEXT_HASHCACHE;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync#define VBOXEXT_HASHCACHE_FROM_MAP(_pMap) RT_FROM_MEMBER((_pMap), VBOXEXT_HASHCACHE, Map)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync#define VBOXEXT_HASHCACHE_ENTRY_FROM_MAP(_pEntry) RT_FROM_MEMBER((_pEntry), VBOXEXT_HASHCACHE_ENTRY, MapEntry)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncDECLINLINE(void) VBoxExtCacheInit(PVBOXEXT_HASHCACHE pCache, uint32_t cMaxElements,
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PFNVBOXEXT_HASHMAP_HASH pfnHash,
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PFNVBOXEXT_HASHMAP_EQUAL pfnEqual,
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PFNVBOXEXT_HASHCACHE_CLEANUP_ENTRY pfnCleanupEntry)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync VBoxExtHashInit(&pCache->Map, pfnHash, pfnEqual);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync pCache->cMaxElements = cMaxElements;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync pCache->pfnCleanupEntry = pfnCleanupEntry;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync}
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncDECLINLINE(PVBOXEXT_HASHCACHE_ENTRY) VBoxExtCacheGet(PVBOXEXT_HASHCACHE pCache, void *pvKey)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PVBOXEXT_HASHMAP_ENTRY pEntry = VBoxExtHashRemove(&pCache->Map, pvKey);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync return VBOXEXT_HASHCACHE_ENTRY_FROM_MAP(pEntry);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync}
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncDECLINLINE(void) VBoxExtCachePut(PVBOXEXT_HASHCACHE pCache, void *pvKey, PVBOXEXT_HASHCACHE_ENTRY pEntry)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PVBOXEXT_HASHMAP_ENTRY pOldEntry = VBoxExtHashPut(&pCache->Map, pvKey, &pEntry->MapEntry);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync PVBOXEXT_HASHCACHE_ENTRY pOld;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync if (!pOldEntry)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync return;
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync pOld = VBOXEXT_HASHCACHE_ENTRY_FROM_MAP(pOldEntry);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync if (pOld != pEntry)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync pCache->pfnCleanupEntry(pvKey, pOld);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync}
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncvoid VBoxExtCacheCleanup(PVBOXEXT_HASHCACHE pCache);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsyncDECLINLINE(void) VBoxExtCacheTerm(PVBOXEXT_HASHCACHE pCache)
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync{
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync VBoxExtCacheCleanup(pCache);
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync}
b62daae35a821b998dc41ab2c90da52d18b6f229vboxsync
df4e0d2af793d52c48d1f2a91a575d78eb728511vboxsync#endif /* #ifndef ___VBOXEXT_H__*/