| 1 | /* Copyright (c) 2001, Stanford University
|
|---|
| 2 | * All rights reserved
|
|---|
| 3 | *
|
|---|
| 4 | * See the file LICENSE.txt for information on redistributing this software.
|
|---|
| 5 | */
|
|---|
| 6 |
|
|---|
| 7 |
|
|---|
| 8 | /*
|
|---|
| 9 | * How this all works...
|
|---|
| 10 | *
|
|---|
| 11 | * This directory implements three different interfaces to Chromium:
|
|---|
| 12 | *
|
|---|
| 13 | * 1. the Chromium interface - this is defined by the functions that start
|
|---|
| 14 | * with the "cr" prefix and are defined in chromium.h and implemented in
|
|---|
| 15 | * stub.c. Typically, this is used by parallel apps (like psubmit).
|
|---|
| 16 | *
|
|---|
| 17 | * 2. GLX emulation interface - the glX*() functions are emulated here.
|
|---|
| 18 | * When glXCreateContext() is called we may either create a real, native
|
|---|
| 19 | * GLX context or a Chromium context (depending on match_window_title and
|
|---|
| 20 | * minimum_window_size).
|
|---|
| 21 | *
|
|---|
| 22 | * 3. WGL emulation interface - the wgl*() functions are emulated here.
|
|---|
| 23 | * When wglCreateContext() is called we may either create a real, native
|
|---|
| 24 | * WGL context or a Chromium context (depending on match_window_title and
|
|---|
| 25 | * minimum_window_size).
|
|---|
| 26 | *
|
|---|
| 27 | *
|
|---|
| 28 | */
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 | #ifndef CR_STUB_H
|
|---|
| 32 | #define CR_STUB_H
|
|---|
| 33 |
|
|---|
| 34 | #include "chromium.h"
|
|---|
| 35 | #include "cr_version.h"
|
|---|
| 36 | #include "cr_hash.h"
|
|---|
| 37 | #include "cr_process.h"
|
|---|
| 38 | #include "cr_spu.h"
|
|---|
| 39 | #include "cr_threads.h"
|
|---|
| 40 | #include "spu_dispatch_table.h"
|
|---|
| 41 |
|
|---|
| 42 | #ifdef GLX
|
|---|
| 43 | #include <X11/extensions/XShm.h>
|
|---|
| 44 | #include <sys/shm.h>
|
|---|
| 45 | #include <X11/extensions/Xdamage.h>
|
|---|
| 46 | #include <X11/extensions/Xcomposite.h>
|
|---|
| 47 | #include <X11/extensions/Xfixes.h>
|
|---|
| 48 | #endif
|
|---|
| 49 |
|
|---|
| 50 | #if defined(WINDOWS) || defined(Linux) || defined(SunOS)
|
|---|
| 51 | # define CR_NEWWINTRACK
|
|---|
| 52 | #endif
|
|---|
| 53 |
|
|---|
| 54 | #if !defined(CHROMIUM_THREADSAFE) && defined(CR_NEWWINTRACK)
|
|---|
| 55 | # error CHROMIUM_THREADSAFE have to be defined
|
|---|
| 56 | #endif
|
|---|
| 57 |
|
|---|
| 58 | #ifdef CHROMIUM_THREADSAFE
|
|---|
| 59 | # include <cr_threads.h>
|
|---|
| 60 | #endif
|
|---|
| 61 | /*#define VBOX_TEST_MEGOO*/
|
|---|
| 62 |
|
|---|
| 63 | #if 0 && defined(CR_NEWWINTRACK) && !defined(WINDOWS)
|
|---|
| 64 | #define XLOCK(dpy) XLockDisplay(dpy)
|
|---|
| 65 | #define XUNLOCK(dpy) XUnlockDisplay(dpy)
|
|---|
| 66 | #else
|
|---|
| 67 | #define XLOCK(dpy)
|
|---|
| 68 | #define XUNLOCK(dpy)
|
|---|
| 69 | #endif
|
|---|
| 70 |
|
|---|
| 71 | /* When we first create a rendering context we can't be sure whether
|
|---|
| 72 | * it'll be handled by Chromium or as a native GLX/WGL context. So in
|
|---|
| 73 | * CreateContext() we'll mark the ContextInfo object as UNDECIDED then
|
|---|
| 74 | * switch it to either NATIVE or CHROMIUM the first time MakeCurrent()
|
|---|
| 75 | * is called. In MakeCurrent() we can use a criteria like window size
|
|---|
| 76 | * or window title to decide between CHROMIUM and NATIVE.
|
|---|
| 77 | */
|
|---|
| 78 | typedef enum
|
|---|
| 79 | {
|
|---|
| 80 | UNDECIDED,
|
|---|
| 81 | CHROMIUM,
|
|---|
| 82 | NATIVE
|
|---|
| 83 | } ContextType;
|
|---|
| 84 |
|
|---|
| 85 | #define MAX_DPY_NAME 1000
|
|---|
| 86 |
|
|---|
| 87 | typedef struct context_info_t ContextInfo;
|
|---|
| 88 | typedef struct window_info_t WindowInfo;
|
|---|
| 89 |
|
|---|
| 90 | #ifdef GLX
|
|---|
| 91 | typedef struct glxpixmap_info_t GLX_Pixmap_t;
|
|---|
| 92 |
|
|---|
| 93 | struct glxpixmap_info_t
|
|---|
| 94 | {
|
|---|
| 95 | int x, y;
|
|---|
| 96 | unsigned int w, h, border, depth;
|
|---|
| 97 | GLenum format;
|
|---|
| 98 | Window root;
|
|---|
| 99 | GLenum target;
|
|---|
| 100 | GC gc;
|
|---|
| 101 | Pixmap hShmPixmap; /* Shared memory pixmap object, if it's supported*/
|
|---|
| 102 | Damage hDamage; /* damage xserver handle*/
|
|---|
| 103 | Bool bPixmapImageDirty;
|
|---|
| 104 | Region pDamageRegion;
|
|---|
| 105 | };
|
|---|
| 106 | #endif
|
|---|
| 107 |
|
|---|
| 108 | struct context_info_t
|
|---|
| 109 | {
|
|---|
| 110 | char dpyName[MAX_DPY_NAME];
|
|---|
| 111 | GLint spuContext; /* returned by head SPU's CreateContext() */
|
|---|
| 112 | ContextType type; /* CHROMIUM, NATIVE or UNDECIDED */
|
|---|
| 113 | unsigned long id; /* the client-visible handle */
|
|---|
| 114 | GLint visBits;
|
|---|
| 115 | WindowInfo *currentDrawable;
|
|---|
| 116 |
|
|---|
| 117 | #if defined(VBOX_WITH_CRHGSMI) && defined(IN_GUEST)
|
|---|
| 118 | GLint spuConnection;
|
|---|
| 119 | struct VBOXUHGSMI *pHgsmi;
|
|---|
| 120 | #endif
|
|---|
| 121 |
|
|---|
| 122 | #ifdef CHROMIUM_THREADSAFE
|
|---|
| 123 | VBOXTLSREFDATA
|
|---|
| 124 | #endif
|
|---|
| 125 |
|
|---|
| 126 | #ifdef WINDOWS
|
|---|
| 127 | HGLRC hglrc;
|
|---|
| 128 | #elif defined(DARWIN)
|
|---|
| 129 | ContextInfo *share;
|
|---|
| 130 | CGLContextObj cglc;
|
|---|
| 131 |
|
|---|
| 132 | /* CGLContextEnable (CGLEnable, CGLDisable, and CGLIsEnabled) */
|
|---|
| 133 | unsigned int options;
|
|---|
| 134 |
|
|---|
| 135 | /* CGLContextParameter (CGLSetParameter and CGLGetParameter) */
|
|---|
| 136 | GLint parambits;
|
|---|
| 137 | long swap_rect[4], swap_interval;
|
|---|
| 138 | unsigned long client_storage;
|
|---|
| 139 | long surf_order, surf_opacy;
|
|---|
| 140 |
|
|---|
| 141 | long disp_mask;
|
|---|
| 142 | #elif defined(GLX)
|
|---|
| 143 | Display *dpy;
|
|---|
| 144 | ContextInfo *share;
|
|---|
| 145 | XVisualInfo *visual;
|
|---|
| 146 | Bool direct;
|
|---|
| 147 | GLXContext glxContext;
|
|---|
| 148 | CRHashTable *pGLXPixmapsHash;
|
|---|
| 149 | Bool damageInitFailed;
|
|---|
| 150 | Display *damageDpy; /* second display connection to read xdamage extension data */
|
|---|
| 151 | int damageEventsBase;
|
|---|
| 152 | #endif
|
|---|
| 153 | };
|
|---|
| 154 |
|
|---|
| 155 | #ifdef DARWIN
|
|---|
| 156 | enum {
|
|---|
| 157 | VISBIT_SWAP_RECT,
|
|---|
| 158 | VISBIT_SWAP_INTERVAL,
|
|---|
| 159 | VISBIT_CLIENT_STORAGE
|
|---|
| 160 | };
|
|---|
| 161 | #endif
|
|---|
| 162 |
|
|---|
| 163 | struct window_info_t
|
|---|
| 164 | {
|
|---|
| 165 | char dpyName[MAX_DPY_NAME];
|
|---|
| 166 | int x, y;
|
|---|
| 167 | unsigned int width, height;
|
|---|
| 168 | ContextType type;
|
|---|
| 169 | GLint spuWindow; /* returned by head SPU's WindowCreate() */
|
|---|
| 170 | ContextInfo *pOwner; /* ctx which created this window */
|
|---|
| 171 | GLboolean mapped;
|
|---|
| 172 | #if defined(VBOX_WITH_CRHGSMI) && defined(IN_GUEST)
|
|---|
| 173 | GLint spuConnection;
|
|---|
| 174 | #endif
|
|---|
| 175 | #ifdef WINDOWS
|
|---|
| 176 | HDC drawable;
|
|---|
| 177 | HRGN hVisibleRegion;
|
|---|
| 178 | DWORD dmPelsWidth;
|
|---|
| 179 | DWORD dmPelsHeight;
|
|---|
| 180 | HWND hWnd;
|
|---|
| 181 | #elif defined(DARWIN)
|
|---|
| 182 | CGSConnectionID connection;
|
|---|
| 183 | CGSWindowID drawable;
|
|---|
| 184 | CGSSurfaceID surface;
|
|---|
| 185 | #elif defined(GLX)
|
|---|
| 186 | Display *dpy;
|
|---|
| 187 | # ifdef CR_NEWWINTRACK
|
|---|
| 188 | Display *syncDpy;
|
|---|
| 189 | # endif
|
|---|
| 190 | GLXDrawable drawable;
|
|---|
| 191 | XRectangle *pVisibleRegions;
|
|---|
| 192 | GLint cVisibleRegions;
|
|---|
| 193 | #endif
|
|---|
| 194 | #ifdef CR_NEWWINTRACK
|
|---|
| 195 | uint32_t u32ClientID;
|
|---|
| 196 | #endif
|
|---|
| 197 | };
|
|---|
| 198 |
|
|---|
| 199 | /* "Global" variables for the stub library */
|
|---|
| 200 | typedef struct {
|
|---|
| 201 | /* the first SPU in the SPU chain on this app node */
|
|---|
| 202 | SPU *spu;
|
|---|
| 203 |
|
|---|
| 204 | /* OpenGL/SPU dispatch tables */
|
|---|
| 205 | crOpenGLInterface wsInterface;
|
|---|
| 206 | SPUDispatchTable spuDispatch;
|
|---|
| 207 | SPUDispatchTable nativeDispatch;
|
|---|
| 208 | GLboolean haveNativeOpenGL;
|
|---|
| 209 |
|
|---|
| 210 | /* config options */
|
|---|
| 211 | int appDrawCursor;
|
|---|
| 212 | GLuint minChromiumWindowWidth;
|
|---|
| 213 | GLuint minChromiumWindowHeight;
|
|---|
| 214 | GLuint maxChromiumWindowWidth;
|
|---|
| 215 | GLuint maxChromiumWindowHeight;
|
|---|
| 216 | GLuint matchChromiumWindowCount;
|
|---|
| 217 | GLuint matchChromiumWindowCounter;
|
|---|
| 218 | GLuint *matchChromiumWindowID;
|
|---|
| 219 | GLuint numIgnoreWindowID;
|
|---|
| 220 | char *matchWindowTitle;
|
|---|
| 221 | int ignoreFreeglutMenus;
|
|---|
| 222 | int trackWindowSize;
|
|---|
| 223 | int trackWindowPos;
|
|---|
| 224 | int trackWindowVisibility;
|
|---|
| 225 | int trackWindowVisibleRgn;
|
|---|
| 226 | char *spu_dir;
|
|---|
| 227 | int force_pbuffers;
|
|---|
| 228 | int viewportHack;
|
|---|
| 229 |
|
|---|
| 230 | /* thread safety stuff */
|
|---|
| 231 | GLboolean threadSafe;
|
|---|
| 232 | #ifdef CHROMIUM_THREADSAFE
|
|---|
| 233 | CRtsd dispatchTSD;
|
|---|
| 234 | CRmutex mutex;
|
|---|
| 235 | #endif
|
|---|
| 236 |
|
|---|
| 237 | CRpid mothershipPID;
|
|---|
| 238 |
|
|---|
| 239 | /* contexts */
|
|---|
| 240 | int freeContextNumber;
|
|---|
| 241 | CRHashTable *contextTable;
|
|---|
| 242 | #ifndef CHROMIUM_THREADSAFE
|
|---|
| 243 | ContextInfo *currentContext; /* may be NULL */
|
|---|
| 244 | #endif
|
|---|
| 245 |
|
|---|
| 246 | /* windows */
|
|---|
| 247 | CRHashTable *windowTable;
|
|---|
| 248 |
|
|---|
| 249 | #ifdef GLX
|
|---|
| 250 | /* Shared memory, used to transfer XServer pixmaps data into client memory */
|
|---|
| 251 | XShmSegmentInfo xshmSI;
|
|---|
| 252 | GLboolean bShmInitFailed;
|
|---|
| 253 |
|
|---|
| 254 | CRHashTable *pGLXPixmapsHash;
|
|---|
| 255 |
|
|---|
| 256 | GLboolean bXExtensionsChecked;
|
|---|
| 257 | GLboolean bHaveXComposite;
|
|---|
| 258 | GLboolean bHaveXFixes;
|
|---|
| 259 | #endif
|
|---|
| 260 |
|
|---|
| 261 | #ifdef WINDOWS
|
|---|
| 262 | # ifndef CR_NEWWINTRACK
|
|---|
| 263 | HHOOK hMessageHook;
|
|---|
| 264 | # endif
|
|---|
| 265 | # ifdef VBOX_WITH_WDDM
|
|---|
| 266 | bool bRunningUnderWDDM;
|
|---|
| 267 | # endif
|
|---|
| 268 | #endif
|
|---|
| 269 |
|
|---|
| 270 | #ifdef CR_NEWWINTRACK
|
|---|
| 271 | RTTHREAD hSyncThread;
|
|---|
| 272 | bool volatile bShutdownSyncThread;
|
|---|
| 273 | #endif
|
|---|
| 274 |
|
|---|
| 275 | } Stub;
|
|---|
| 276 |
|
|---|
| 277 | #ifdef CHROMIUM_THREADSAFE
|
|---|
| 278 | /* we place the g_stubCurrentContextTLS outside the Stub data because Stub data is inited by the client's call,
|
|---|
| 279 | * while we need g_stubCurrentContextTLS the g_stubCurrentContextTLS to be valid at any time to be able to handle
|
|---|
| 280 | * THREAD_DETACH cleanup on windows.
|
|---|
| 281 | * Note that we can not do
|
|---|
| 282 | * STUB_INIT_LOCK();
|
|---|
| 283 | * if (stub_initialized) stubSetCurrentContext(NULL);
|
|---|
| 284 | * STUB_INIT_UNLOCK();
|
|---|
| 285 | * on THREAD_DETACH since it may cause deadlock, i.e. in this situation loader lock is acquired first and then the init lock,
|
|---|
| 286 | * but since we use GetModuleFileName in crGetProcName called from stubInitLocked, the lock order might be the oposite.
|
|---|
| 287 | * Note that GetModuleFileName acquires the loader lock.
|
|---|
| 288 | * */
|
|---|
| 289 | extern CRtsd g_stubCurrentContextTSD;
|
|---|
| 290 |
|
|---|
| 291 | # define stubGetCurrentContext() VBoxTlsRefGetCurrent(ContextInfo, &g_stubCurrentContextTSD)
|
|---|
| 292 | # define stubSetCurrentContext(_ctx) VBoxTlsRefSetCurrent(ContextInfo, &g_stubCurrentContextTSD, _ctx)
|
|---|
| 293 | #else
|
|---|
| 294 | # define stubGetCurrentContext() (stub.currentContext)
|
|---|
| 295 | # define stubSetCurrentContext(_ctx) do { stub.currentContext = (_ctx); } while (0)
|
|---|
| 296 | #endif
|
|---|
| 297 |
|
|---|
| 298 | extern Stub stub;
|
|---|
| 299 |
|
|---|
| 300 | extern DECLEXPORT(SPUDispatchTable) glim;
|
|---|
| 301 | extern SPUDispatchTable stubThreadsafeDispatch;
|
|---|
| 302 | extern DECLEXPORT(SPUDispatchTable) stubNULLDispatch;
|
|---|
| 303 |
|
|---|
| 304 | #if defined(GLX) || defined (WINDOWS)
|
|---|
| 305 | extern GLboolean stubUpdateWindowVisibileRegions(WindowInfo *pWindow);
|
|---|
| 306 | #endif
|
|---|
| 307 |
|
|---|
| 308 | #ifdef WINDOWS
|
|---|
| 309 |
|
|---|
| 310 | /* WGL versions */
|
|---|
| 311 | extern WindowInfo *stubGetWindowInfo( HDC drawable );
|
|---|
| 312 |
|
|---|
| 313 | extern void stubInstallWindowMessageHook();
|
|---|
| 314 | extern void stubUninstallWindowMessageHook();
|
|---|
| 315 |
|
|---|
| 316 | #elif defined(DARWIN)
|
|---|
| 317 |
|
|---|
| 318 | extern CGSConnectionID _CGSDefaultConnection(void);
|
|---|
| 319 | extern OSStatus CGSGetWindowLevel( CGSConnectionID cid, CGSWindowID wid, CGWindowLevel *level );
|
|---|
| 320 | extern OSStatus CGSSetWindowAlpha( const CGSConnectionID cid, CGSWindowID wid, float alpha );
|
|---|
| 321 |
|
|---|
| 322 | /* These don't seem to be included in the OSX glext.h ... */
|
|---|
| 323 | extern void glPointParameteri( GLenum pname, GLint param );
|
|---|
| 324 | extern void glPointParameteriv( GLenum pname, const GLint * param );
|
|---|
| 325 |
|
|---|
| 326 | extern WindowInfo *stubGetWindowInfo( CGSWindowID drawable );
|
|---|
| 327 |
|
|---|
| 328 | #elif defined(GLX)
|
|---|
| 329 |
|
|---|
| 330 | /* GLX versions */
|
|---|
| 331 | extern WindowInfo *stubGetWindowInfo( Display *dpy, GLXDrawable drawable );
|
|---|
| 332 | extern void stubUseXFont( Display *dpy, Font font, int first, int count, int listbase );
|
|---|
| 333 | extern Display* stubGetWindowDisplay(WindowInfo *pWindow);
|
|---|
| 334 |
|
|---|
| 335 | extern void stubCheckXExtensions(WindowInfo *pWindow);
|
|---|
| 336 | #endif
|
|---|
| 337 |
|
|---|
| 338 |
|
|---|
| 339 | extern ContextInfo *stubNewContext( const char *dpyName, GLint visBits, ContextType type, unsigned long shareCtx
|
|---|
| 340 | #if defined(VBOX_WITH_CRHGSMI) && defined(IN_GUEST)
|
|---|
| 341 | , struct VBOXUHGSMI *pHgsmi
|
|---|
| 342 | #endif
|
|---|
| 343 | );
|
|---|
| 344 | extern void stubDestroyContext( unsigned long contextId );
|
|---|
| 345 | extern GLboolean stubMakeCurrent( WindowInfo *window, ContextInfo *context );
|
|---|
| 346 | extern GLint stubNewWindow( const char *dpyName, GLint visBits );
|
|---|
| 347 | extern void stubSwapBuffers(WindowInfo *window, GLint flags);
|
|---|
| 348 | extern void stubGetWindowGeometry(WindowInfo *win, int *x, int *y, unsigned int *w, unsigned int *h);
|
|---|
| 349 | extern GLboolean stubUpdateWindowGeometry(WindowInfo *pWindow, GLboolean bForceUpdate);
|
|---|
| 350 | extern GLboolean stubIsWindowVisible(WindowInfo *win);
|
|---|
| 351 | extern bool stubInit(void);
|
|---|
| 352 |
|
|---|
| 353 | extern void APIENTRY stub_GetChromiumParametervCR( GLenum target, GLuint index, GLenum type, GLsizei count, GLvoid *values );
|
|---|
| 354 |
|
|---|
| 355 | extern void APIENTRY glBoundsInfoCR(const CRrecti *, const GLbyte *, GLint, GLint);
|
|---|
| 356 |
|
|---|
| 357 | #endif /* CR_STUB_H */
|
|---|
