libGL: Consolidate DRI initialization in dri_glx.c
[mesa.git] / src / glx / x11 / glxclient.h
1 /*
2 ** License Applicability. Except to the extent portions of this file are
3 ** made subject to an alternative license as permitted in the SGI Free
4 ** Software License B, Version 1.1 (the "License"), the contents of this
5 ** file are subject only to the provisions of the License. You may not use
6 ** this file except in compliance with the License. You may obtain a copy
7 ** of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
8 ** Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:
9 **
10 ** http://oss.sgi.com/projects/FreeB
11 **
12 ** Note that, as provided in the License, the Software is distributed on an
13 ** "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
14 ** DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
15 ** CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
16 ** PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
17 **
18 ** Original Code. The Original Code is: OpenGL Sample Implementation,
19 ** Version 1.2.1, released January 26, 2000, developed by Silicon Graphics,
20 ** Inc. The Original Code is Copyright (c) 1991-2000 Silicon Graphics, Inc.
21 ** Copyright in any portions created by third parties is as indicated
22 ** elsewhere herein. All Rights Reserved.
23 **
24 ** Additional Notice Provisions: The application programming interfaces
25 ** established by SGI in conjunction with the Original Code are The
26 ** OpenGL(R) Graphics System: A Specification (Version 1.2.1), released
27 ** April 1, 1999; The OpenGL(R) Graphics System Utility Library (Version
28 ** 1.3), released November 4, 1998; and OpenGL(R) Graphics with the X
29 ** Window System(R) (Version 1.3), released October 19, 1998. This software
30 ** was created using the OpenGL(R) version 1.2.1 Sample Implementation
31 ** published by SGI, but has not been independently verified as being
32 ** compliant with the OpenGL(R) version 1.2.1 Specification.
33 */
34 /* $XFree86: xc/lib/GL/glx/glxclient.h,v 1.21 2004/02/09 23:46:31 alanh Exp $ */
35
36 /**
37 * \file glxclient.h
38 * Direct rendering support added by Precision Insight, Inc.
39 *
40 * \author Kevin E. Martin <kevin@precisioninsight.com>
41 */
42
43 #ifndef _GLX_client_h_
44 #define _GLX_client_h_
45 #define NEED_REPLIES
46 #define NEED_EVENTS
47 #include <X11/Xproto.h>
48 #include <X11/Xlibint.h>
49 #define GLX_GLXEXT_PROTOTYPES
50 #include <GL/glx.h>
51 #include <GL/glxext.h>
52 #include <string.h>
53 #include <stdlib.h>
54 #include <stdio.h>
55 #ifdef WIN32
56 #include <stdint.h>
57 #endif
58 #include "GL/glxint.h"
59 #include "GL/glxproto.h"
60 #include "GL/internal/glcore.h"
61 #include "glapitable.h"
62 #include "glxextensions.h"
63 #include "glxhash.h"
64 #if defined( USE_XTHREADS )
65 # include <X11/Xthreads.h>
66 #elif defined( PTHREADS )
67 # include <pthread.h>
68 #endif
69
70 #define GLX_MAJOR_VERSION 1 /* current version numbers */
71 #define GLX_MINOR_VERSION 4
72
73 #define __GLX_MAX_TEXTURE_UNITS 32
74
75 typedef struct __GLXscreenConfigsRec __GLXscreenConfigs;
76 typedef struct __GLXcontextRec __GLXcontext;
77 typedef struct __GLXdrawableRec __GLXdrawable;
78 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate;
79 typedef struct _glapi_table __GLapi;
80
81 /************************************************************************/
82
83 #ifdef GLX_DIRECT_RENDERING
84
85 #define containerOf(ptr, type, member) \
86 (type *)( (char *)ptr - offsetof(type,member) )
87
88 #include <GL/internal/dri_interface.h>
89
90
91 /**
92 * Display dependent methods. This structure is initialized during the
93 * \c driCreateDisplay call.
94 */
95 struct __DRIdisplayRec {
96 /**
97 * Method to destroy the private DRI display data.
98 */
99 void (*destroyDisplay)(Display *dpy, void *displayPrivate);
100
101 /**
102 * Opaque pointer to private per display direct rendering data.
103 * \c NULL if direct rendering is not supported on this display.
104 */
105 struct __DRIdisplayPrivateRec *private;
106
107 /**
108 * Array of pointers to methods to create and initialize the private DRI
109 * screen data.
110 */
111 PFNCREATENEWSCREENFUNC * createNewScreen;
112 };
113
114
115 /*
116 ** We keep a linked list of these structures, one per DRI device driver.
117 */
118 struct __DRIdriverRec {
119 const char *name;
120 const char *libpath;
121 void *handle;
122 PFNCREATENEWSCREENFUNC createNewScreenFunc;
123 struct __DRIdriverRec *next;
124 };
125
126 /*
127 ** Function to create and DRI display data and initialize the display
128 ** dependent methods.
129 */
130 extern void *driCreateDisplay(Display *dpy, __DRIdisplay *pdisp);
131 extern void driCreateScreen(__GLXscreenConfigs *psc, int screen,
132 __GLXdisplayPrivate *priv);
133
134 extern __DRIdriver *driGetDriver(Display *dpy, int scrNum);
135
136 extern void DRI_glXUseXFont( Font font, int first, int count, int listbase );
137
138 /*
139 ** Functions to obtain driver configuration information from a direct
140 ** rendering client application
141 */
142 extern const char *glXGetScreenDriver (Display *dpy, int scrNum);
143
144 extern const char *glXGetDriverConfig (const char *driverName);
145
146 extern Bool __glXWindowExists(Display *dpy, GLXDrawable draw);
147
148 #endif
149
150 /************************************************************************/
151
152 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
153
154 typedef struct __GLXpixelStoreModeRec {
155 GLboolean swapEndian;
156 GLboolean lsbFirst;
157 GLuint rowLength;
158 GLuint imageHeight;
159 GLuint imageDepth;
160 GLuint skipRows;
161 GLuint skipPixels;
162 GLuint skipImages;
163 GLuint alignment;
164 } __GLXpixelStoreMode;
165
166
167 typedef struct __GLXattributeRec {
168 GLuint mask;
169
170 /**
171 * Pixel storage state. Most of the pixel store mode state is kept
172 * here and used by the client code to manage the packing and
173 * unpacking of data sent to/received from the server.
174 */
175 __GLXpixelStoreMode storePack, storeUnpack;
176
177 /**
178 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
179 * disabled?
180 */
181 GLboolean NoDrawArraysProtocol;
182
183 /**
184 * Vertex Array storage state. The vertex array component
185 * state is stored here and is used to manage the packing of
186 * DrawArrays data sent to the server.
187 */
188 struct array_state_vector * array_state;
189 } __GLXattribute;
190
191 typedef struct __GLXattributeMachineRec {
192 __GLXattribute *stack[__GL_CLIENT_ATTRIB_STACK_DEPTH];
193 __GLXattribute **stackPointer;
194 } __GLXattributeMachine;
195
196 /**
197 * GLX state that needs to be kept on the client. One of these records
198 * exist for each context that has been made current by this client.
199 */
200 struct __GLXcontextRec {
201 /**
202 * \name Drawing command buffer.
203 *
204 * Drawing commands are packed into this buffer before being sent as a
205 * single GLX protocol request. The buffer is sent when it overflows or
206 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
207 * in the buffer to be filled. \c limit is described above in the buffer
208 * slop discussion.
209 *
210 * Commands that require large amounts of data to be transfered will
211 * also use this buffer to hold a header that describes the large
212 * command.
213 *
214 * These must be the first 6 fields since they are static initialized
215 * in the dummy context in glxext.c
216 */
217 /*@{*/
218 GLubyte *buf;
219 GLubyte *pc;
220 GLubyte *limit;
221 GLubyte *bufEnd;
222 GLint bufSize;
223 /*@}*/
224
225 /**
226 * The XID of this rendering context. When the context is created a
227 * new XID is allocated. This is set to None when the context is
228 * destroyed but is still current to some thread. In this case the
229 * context will be freed on next MakeCurrent.
230 */
231 XID xid;
232
233 /**
234 * The XID of the \c shareList context.
235 */
236 XID share_xid;
237
238 /**
239 * Screen number.
240 */
241 GLint screen;
242 __GLXscreenConfigs *psc;
243
244 /**
245 * \c GL_TRUE if the context was created with ImportContext, which
246 * means the server-side context was created by another X client.
247 */
248 GLboolean imported;
249
250 /**
251 * The context tag returned by MakeCurrent when this context is made
252 * current. This tag is used to identify the context that a thread has
253 * current so that proper server context management can be done. It is
254 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
255 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
256 * context)).
257 */
258 GLXContextTag currentContextTag;
259
260 /**
261 * \name Rendering mode
262 *
263 * The rendering mode is kept on the client as well as the server.
264 * When \c glRenderMode is called, the buffer associated with the
265 * previous rendering mode (feedback or select) is filled.
266 */
267 /*@{*/
268 GLenum renderMode;
269 GLfloat *feedbackBuf;
270 GLuint *selectBuf;
271 /*@}*/
272
273 /**
274 * This is \c GL_TRUE if the pixel unpack modes are such that an image
275 * can be unpacked from the clients memory by just copying. It may
276 * still be true that the server will have to do some work. This
277 * just promises that a straight copy will fetch the correct bytes.
278 */
279 GLboolean fastImageUnpack;
280
281 /**
282 * Fill newImage with the unpacked form of \c oldImage getting it
283 * ready for transport to the server.
284 */
285 void (*fillImage)(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum,
286 GLenum, const GLvoid*, GLubyte*, GLubyte*);
287
288 /**
289 * Client side attribs.
290 */
291 __GLXattributeMachine attributes;
292
293 /**
294 * Client side error code. This is set when client side gl API
295 * routines need to set an error because of a bad enumerant or
296 * running out of memory, etc.
297 */
298 GLenum error;
299
300 /**
301 * Whether this context does direct rendering.
302 */
303 Bool isDirect;
304
305 /**
306 * \c dpy of current display for this context. Will be \c NULL if not
307 * current to any display, or if this is the "dummy context".
308 */
309 Display *currentDpy;
310
311 /**
312 * The current drawable for this context. Will be None if this
313 * context is not current to any drawable. currentReadable is below.
314 */
315 GLXDrawable currentDrawable;
316
317 /**
318 * \name GL Constant Strings
319 *
320 * Constant strings that describe the server implementation
321 * These pertain to GL attributes, not to be confused with
322 * GLX versioning attributes.
323 */
324 /*@{*/
325 GLubyte *vendor;
326 GLubyte *renderer;
327 GLubyte *version;
328 GLubyte *extensions;
329 /*@}*/
330
331 /**
332 * Record the dpy this context was created on for later freeing
333 */
334 Display *createDpy;
335
336 /**
337 * Maximum small render command size. This is the smaller of 64k and
338 * the size of the above buffer.
339 */
340 GLint maxSmallRenderCommandSize;
341
342 /**
343 * Major opcode for the extension. Copied here so a lookup isn't
344 * needed.
345 */
346 GLint majorOpcode;
347
348 /**
349 * Pointer to the mode used to create this context.
350 */
351 const __GLcontextModes * mode;
352
353 #ifdef GLX_DIRECT_RENDERING
354 /**
355 * Per context direct rendering interface functions and data.
356 */
357 __DRIcontext driContext;
358
359 /**
360 * XID for the server side drm_context_t
361 */
362 XID hwContextID;
363 #endif
364
365 /**
366 * The current read-drawable for this context. Will be None if this
367 * context is not current to any drawable.
368 *
369 * \since Internal API version 20030606.
370 */
371 GLXDrawable currentReadable;
372
373 /**
374 * Pointer to client-state data that is private to libGL. This is only
375 * used for indirect rendering contexts.
376 *
377 * No internal API version change was made for this change. Client-side
378 * drivers should NEVER use this data or even care that it exists.
379 */
380 void * client_state_private;
381
382 /**
383 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
384 */
385 int renderType;
386
387 /**
388 * \name Raw server GL version
389 *
390 * True core GL version supported by the server. This is the raw value
391 * returned by the server, and it may not reflect what is actually
392 * supported (or reported) by the client-side library.
393 */
394 /*@{*/
395 int server_major; /**< Major version number. */
396 int server_minor; /**< Minor version number. */
397 /*@}*/
398
399 char gl_extension_bits[ __GL_EXT_BYTES ];
400 };
401
402 #define __glXSetError(gc,code) \
403 if (!(gc)->error) { \
404 (gc)->error = code; \
405 }
406
407 extern void __glFreeAttributeState(__GLXcontext *);
408
409 /************************************************************************/
410
411 /**
412 * The size of the largest drawing command known to the implementation
413 * that will use the GLXRender GLX command. In this case it is
414 * \c glPolygonStipple.
415 */
416 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
417
418 /**
419 * To keep the implementation fast, the code uses a "limit" pointer
420 * to determine when the drawing command buffer is too full to hold
421 * another fixed size command. This constant defines the amount of
422 * space that must always be available in the drawing command buffer
423 * at all times for the implementation to work. It is important that
424 * the number be just large enough, but not so large as to reduce the
425 * efficacy of the buffer. The "+32" is just to keep the code working
426 * in case somebody counts wrong.
427 */
428 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
429
430 /**
431 * This implementation uses a smaller threshold for switching
432 * to the RenderLarge protocol than the protcol requires so that
433 * large copies don't occur.
434 */
435 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
436
437 /**
438 * One of these records exists per screen of the display. It contains
439 * a pointer to the config data for that screen (if the screen supports GL).
440 */
441 struct __GLXscreenConfigsRec {
442 /**
443 * GLX extension string reported by the X-server.
444 */
445 const char *serverGLXexts;
446
447 /**
448 * GLX extension string to be reported to applications. This is the
449 * set of extensions that the application can actually use.
450 */
451 char *effectiveGLXexts;
452
453 #ifdef GLX_DIRECT_RENDERING
454 /**
455 * Per screen direct rendering interface functions and data.
456 */
457 __DRIscreen driScreen;
458 __glxHashTable *drawHash;
459 Display *dpy;
460 int scr;
461
462 #ifdef __DRI_COPY_SUB_BUFFER
463 __DRIcopySubBufferExtension *copySubBuffer;
464 #endif
465
466 #ifdef __DRI_SWAP_CONTROL
467 __DRIswapControlExtension *swapControl;
468 #endif
469
470 #ifdef __DRI_ALLOCATE
471 __DRIallocateExtension *allocate;
472 #endif
473
474 #ifdef __DRI_FRAME_TRACKING
475 __DRIframeTrackingExtension *frameTracking;
476 #endif
477
478 #ifdef __DRI_MEDIA_STREAM_COUNTER
479 __DRImediaStreamCounterExtension *msc;
480 #endif
481
482 #endif
483
484 /**
485 * Linked list of glx visuals and fbconfigs for this screen.
486 */
487 __GLcontextModes *visuals, *configs;
488
489 /**
490 * Per-screen dynamic GLX extension tracking. The \c direct_support
491 * field only contains enough bits for 64 extensions. Should libGL
492 * ever need to track more than 64 GLX extensions, we can safely grow
493 * this field. The \c __GLXscreenConfigs structure is not used outside
494 * libGL.
495 */
496 /*@{*/
497 unsigned char direct_support[8];
498 GLboolean ext_list_first_time;
499 /*@}*/
500
501 };
502
503 /**
504 * Per display private data. One of these records exists for each display
505 * that is using the OpenGL (GLX) extension.
506 */
507 struct __GLXdisplayPrivateRec {
508 /**
509 * Back pointer to the display
510 */
511 Display *dpy;
512
513 /**
514 * The \c majorOpcode is common to all connections to the same server.
515 * It is also copied into the context structure.
516 */
517 int majorOpcode;
518
519 /**
520 * \name Server Version
521 *
522 * Major and minor version returned by the server during initialization.
523 */
524 /*@{*/
525 int majorVersion, minorVersion;
526 /*@}*/
527
528 /**
529 * \name Storage for the servers GLX vendor and versions strings.
530 *
531 * These are the same for all screens on this display. These fields will
532 * be filled in on demand.
533 */
534 /*@{*/
535 const char *serverGLXvendor;
536 const char *serverGLXversion;
537 /*@}*/
538
539 /**
540 * Configurations of visuals for all screens on this display.
541 * Also, per screen data which now includes the server \c GLX_EXTENSION
542 * string.
543 */
544 __GLXscreenConfigs *screenConfigs;
545
546 #ifdef GLX_DIRECT_RENDERING
547 /**
548 * Per display direct rendering interface functions and data.
549 */
550 __DRIdisplay driDisplay;
551 #endif
552 };
553
554 #ifdef GLX_DIRECT_RENDERING
555
556 struct __GLXdrawableRec {
557 XID drawable;
558 __GLXscreenConfigs *psc;
559 __DRIdrawable driDrawable;
560 };
561
562 #endif
563
564
565
566 void __glXFreeContext(__GLXcontext*);
567
568 extern GLubyte *__glXFlushRenderBuffer(__GLXcontext*, GLubyte*);
569
570 extern void __glXSendLargeChunk(__GLXcontext *gc, GLint requestNumber,
571 GLint totalRequests,
572 const GLvoid * data, GLint dataLen);
573
574 extern void __glXSendLargeCommand(__GLXcontext *, const GLvoid *, GLint,
575 const GLvoid *, GLint);
576
577 /* Initialize the GLX extension for dpy */
578 extern __GLXdisplayPrivate *__glXInitialize(Display*);
579
580 /************************************************************************/
581
582 extern int __glXDebug;
583
584 /* This is per-thread storage in an MT environment */
585 #if defined( USE_XTHREADS ) || defined( PTHREADS )
586
587 extern void __glXSetCurrentContext(__GLXcontext *c);
588
589 # if defined( GLX_USE_TLS )
590
591 extern __thread void * __glX_tls_Context
592 __attribute__((tls_model("initial-exec")));
593
594 # define __glXGetCurrentContext() __glX_tls_Context
595
596 # else
597
598 extern __GLXcontext *__glXGetCurrentContext(void);
599
600 # endif /* defined( GLX_USE_TLS ) */
601
602 #else
603
604 extern __GLXcontext *__glXcurrentContext;
605 #define __glXGetCurrentContext() __glXcurrentContext
606 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
607
608 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
609
610
611 /*
612 ** Global lock for all threads in this address space using the GLX
613 ** extension
614 */
615 #if defined( USE_XTHREADS )
616 extern xmutex_rec __glXmutex;
617 #define __glXLock() xmutex_lock(&__glXmutex)
618 #define __glXUnlock() xmutex_unlock(&__glXmutex)
619 #elif defined( PTHREADS )
620 extern pthread_mutex_t __glXmutex;
621 #define __glXLock() pthread_mutex_lock(&__glXmutex)
622 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
623 #else
624 #define __glXLock()
625 #define __glXUnlock()
626 #endif
627
628 /*
629 ** Setup for a command. Initialize the extension for dpy if necessary.
630 */
631 extern CARD8 __glXSetupForCommand(Display *dpy);
632
633 /************************************************************************/
634
635 /*
636 ** Data conversion and packing support.
637 */
638
639 extern const GLuint __glXDefaultPixelStore[9];
640
641 /* Send an image to the server using RenderLarge. */
642 extern void __glXSendLargeImage(__GLXcontext *gc, GLint compsize, GLint dim,
643 GLint width, GLint height, GLint depth, GLenum format, GLenum type,
644 const GLvoid *src, GLubyte *pc, GLubyte *modes);
645
646 /* Return the size, in bytes, of some pixel data */
647 extern GLint __glImageSize(GLint, GLint, GLint, GLenum, GLenum, GLenum);
648
649 /* Return the number of elements per group of a specified format*/
650 extern GLint __glElementsPerGroup(GLenum format, GLenum type);
651
652 /* Return the number of bytes per element, based on the element type (other
653 ** than GL_BITMAP).
654 */
655 extern GLint __glBytesPerElement(GLenum type);
656
657 /*
658 ** Fill the transport buffer with the data from the users buffer,
659 ** applying some of the pixel store modes (unpack modes) to the data
660 ** first. As a side effect of this call, the "modes" field is
661 ** updated to contain the modes needed by the server to decode the
662 ** sent data.
663 */
664 extern void __glFillImage(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum,
665 GLenum, const GLvoid*, GLubyte*, GLubyte*);
666
667 /* Copy map data with a stride into a packed buffer */
668 extern void __glFillMap1f(GLint, GLint, GLint, const GLfloat *, GLubyte *);
669 extern void __glFillMap1d(GLint, GLint, GLint, const GLdouble *, GLubyte *);
670 extern void __glFillMap2f(GLint, GLint, GLint, GLint, GLint,
671 const GLfloat *, GLfloat *);
672 extern void __glFillMap2d(GLint, GLint, GLint, GLint, GLint,
673 const GLdouble *, GLdouble *);
674
675 /*
676 ** Empty an image out of the reply buffer into the clients memory applying
677 ** the pack modes to pack back into the clients requested format.
678 */
679 extern void __glEmptyImage(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum,
680 GLenum, const GLubyte *, GLvoid *);
681
682
683 /*
684 ** Allocate and Initialize Vertex Array client state
685 */
686 extern void __glXInitVertexArrayState(__GLXcontext*);
687
688 /*
689 ** Inform the Server of the major and minor numbers and of the client
690 ** libraries extension string.
691 */
692 extern void __glXClientInfo ( Display *dpy, int opcode );
693
694 /************************************************************************/
695
696 /*
697 ** Declarations that should be in Xlib
698 */
699 #ifdef __GL_USE_OUR_PROTOTYPES
700 extern void _XFlush(Display*);
701 extern Status _XReply(Display*, xReply*, int, Bool);
702 extern void _XRead(Display*, void*, long);
703 extern void _XSend(Display*, const void*, long);
704 #endif
705
706
707 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes *config,
708 int count, const INT32 *bp, Bool tagged_only, Bool fbconfig_style_tags );
709
710 extern char * __glXGetStringFromServer( Display * dpy, int opcode,
711 CARD32 glxCode, CARD32 for_whom, CARD32 name );
712
713 extern char *__glXstrdup(const char *str);
714
715
716 extern const char __glXGLClientVersion[];
717 extern const char __glXGLClientExtensions[];
718
719 /* Get the unadjusted system time */
720 extern int __glXGetUST( int64_t * ust );
721
722 extern GLboolean __glXGetMscRateOML(Display * dpy, GLXDrawable drawable,
723 int32_t * numerator, int32_t * denominator);
724
725 #ifdef GLX_DIRECT_RENDERING
726 GLboolean
727 __driGetMscRateOML(__DRIdrawable *draw, int32_t *numerator, int32_t *denominator);
728 #endif
729
730 #endif /* !__GLX_client_h__ */