1 /*
   2  * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 #import <stdlib.h>
  27 #import <string.h>
  28 #import <ApplicationServices/ApplicationServices.h>
  29 #import <JavaNativeFoundation/JavaNativeFoundation.h>
  30 
  31 #import "sun_java2d_opengl_CGLGraphicsConfig.h"
  32 
  33 #import "jni.h"
  34 #import "jni_util.h"
  35 #import "CGLGraphicsConfig.h"
  36 #import "CGLSurfaceData.h"
  37 #import "LWCToolkit.h"
  38 #import "ThreadUtilities.h"
  39 
  40 #pragma mark -
  41 #pragma mark "--- Mac OS X specific methods for GL pipeline ---"
  42 
  43 /**
  44  * Disposes all memory and resources associated with the given
  45  * CGLGraphicsConfigInfo (including its native OGLContext data).
  46  */
  47 void
  48 OGLGC_DestroyOGLGraphicsConfig(jlong pConfigInfo)
  49 {
  50     J2dTraceLn(J2D_TRACE_INFO, "OGLGC_DestroyOGLGraphicsConfig");
  51 
  52     CGLGraphicsConfigInfo *cglinfo =
  53         (CGLGraphicsConfigInfo *)jlong_to_ptr(pConfigInfo);
  54     if (cglinfo == NULL) {
  55         J2dRlsTraceLn(J2D_TRACE_ERROR,
  56                       "OGLGC_DestroyOGLGraphicsConfig: info is null");
  57         return;
  58     }
  59 
  60     OGLContext *oglc = (OGLContext*)cglinfo->context;
  61     if (oglc != NULL) {
  62         OGLContext_DestroyContextResources(oglc);
  63 
  64         CGLCtxInfo *ctxinfo = (CGLCtxInfo *)oglc->ctxInfo;
  65         if (ctxinfo != NULL) {
  66             NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];        
  67             [NSOpenGLContext clearCurrentContext];
  68             [ctxinfo->context clearDrawable];
  69             [ctxinfo->context release];
  70             if (ctxinfo->scratchSurface != 0) {
  71                 [ctxinfo->scratchSurface release];
  72             }
  73             [pool drain];
  74             free(ctxinfo);
  75         }
  76     }
  77 
  78     free(cglinfo);
  79 }
  80 
  81 #pragma mark -
  82 #pragma mark "--- CGLGraphicsConfig methods ---"
  83 
  84 #ifdef REMOTELAYER
  85 mach_port_t JRSRemotePort;
  86 int remoteSocketFD = -1;
  87 
  88 static void *JRSRemoteThreadFn(void *data) {
  89     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
  90 
  91     // Negotiate a unix domain socket to communicate the
  92     // out of band data: to read the mach port server name, and
  93     // subsequently write out the layer ID.
  94     static char* sock_path = "/tmp/JRSRemoteDemoSocket";
  95     struct sockaddr_un address;
  96     int  socket_fd, nbytes;
  97     int BUFLEN = 256;
  98     char buffer[BUFLEN];
  99 
 100     remoteSocketFD = socket(PF_LOCAL, SOCK_STREAM, 0);
 101     if (remoteSocketFD < 0) {
 102         NSLog(@"socket() failed");
 103         return NULL;
 104     }
 105     memset(&address, 0, sizeof(struct sockaddr_un));
 106     address.sun_family = AF_UNIX;
 107     memcpy(address.sun_path, sock_path, strlen(sock_path)+1);
 108     int tries=0, status=-1;
 109     while (status !=0 && tries<600) {
 110         status = connect(remoteSocketFD, (struct sockaddr *) &address,
 111                          sizeof(struct sockaddr_un));
 112         if (status != 0) {
 113             tries++;
 114             NSLog(@"connection attempt %d failed.", tries);
 115             usleep(5000000);
 116         }
 117     }
 118     if (status != 0) {
 119         NSLog(@"failed to connect");
 120         return NULL;
 121     }
 122     nbytes = read(remoteSocketFD, buffer, BUFLEN);
 123     NSString* serverString = [[NSString alloc] initWithUTF8String:buffer];
 124     CFRetain(serverString);
 125     NSLog(@"Read server name %@", serverString);
 126     JRSRemotePort = [JRSRenderServer recieveRenderServer:serverString];
 127     NSLog(@"Read server port %d", JRSRemotePort);
 128 
 129     [pool drain];
 130     return NULL;
 131 }
 132 
 133 void sendLayerID(int layerID) {
 134     if (JRSRemotePort == 0 || remoteSocketFD < 0) {
 135         NSLog(@"No connection to send ID");
 136         return;
 137     }
 138     int BUFLEN = 256;
 139     char buffer[BUFLEN];
 140     snprintf(buffer, BUFLEN, "%d", layerID);
 141     write(remoteSocketFD, buffer, BUFLEN);
 142 }
 143 #endif  /* REMOTELAYER */
 144 
 145 /**
 146  * This is a globally shared context used when creating textures.  When any
 147  * new contexts are created, they specify this context as the "share list"
 148  * context, which means any texture objects created when this shared context
 149  * is current will be available to any other context in any other thread.
 150  */
 151 NSOpenGLContext *sharedContext = NULL;
 152 NSOpenGLPixelFormat *sharedPixelFormat = NULL;
 153 
 154 /**
 155  * Attempts to initialize CGL and the core OpenGL library.
 156  */
 157 JNIEXPORT jboolean JNICALL
 158 Java_sun_java2d_opengl_CGLGraphicsConfig_initCGL
 159     (JNIEnv *env, jclass cglgc)
 160 {
 161     J2dRlsTraceLn(J2D_TRACE_INFO, "CGLGraphicsConfig_initCGL");
 162 
 163     if (!OGLFuncs_OpenLibrary()) {
 164         return JNI_FALSE;
 165     }
 166 
 167     if (!OGLFuncs_InitPlatformFuncs() ||
 168         !OGLFuncs_InitBaseFuncs() ||
 169         !OGLFuncs_InitExtFuncs())
 170     {
 171         OGLFuncs_CloseLibrary();
 172         return JNI_FALSE;
 173     }
 174 #ifdef REMOTELAYER
 175     pthread_t jrsRemoteThread;
 176     pthread_create(&jrsRemoteThread, NULL, JRSRemoteThreadFn, NULL);
 177 #endif
 178     return JNI_TRUE;
 179 }
 180 
 181 
 182 /**
 183  * Determines whether the CGL pipeline can be used for a given GraphicsConfig
 184  * provided its screen number and visual ID.  If the minimum requirements are
 185  * met, the native CGLGraphicsConfigInfo structure is initialized for this
 186  * GraphicsConfig with the necessary information (pixel format, etc.)
 187  * and a pointer to this structure is returned as a jlong.  If
 188  * initialization fails at any point, zero is returned, indicating that CGL
 189  * cannot be used for this GraphicsConfig (we should fallback on an existing
 190  * 2D pipeline).
 191  */
 192 JNIEXPORT jlong JNICALL
 193 Java_sun_java2d_opengl_CGLGraphicsConfig_getCGLConfigInfo
 194     (JNIEnv *env, jclass cglgc,
 195      jint displayID, jint pixfmt, jint swapInterval)
 196 {
 197   jlong ret = 0L;
 198   JNF_COCOA_ENTER(env);
 199   NSMutableArray * retArray = [NSMutableArray arrayWithCapacity:3];
 200   [retArray addObject: [NSNumber numberWithInt: (int)displayID]];
 201   [retArray addObject: [NSNumber numberWithInt: (int)pixfmt]];
 202   [retArray addObject: [NSNumber numberWithInt: (int)swapInterval]];
 203   if ([NSThread isMainThread]) {
 204       [GraphicsConfigUtil _getCGLConfigInfo: retArray];
 205   } else {
 206       [GraphicsConfigUtil performSelectorOnMainThread: @selector(_getCGLConfigInfo:) withObject: retArray waitUntilDone: YES];
 207   }
 208   NSNumber * num = (NSNumber *)[retArray objectAtIndex: 0];
 209   ret = (jlong)[num longValue];
 210   JNF_COCOA_EXIT(env);
 211   return ret;
 212 }
 213 
 214 
 215 
 216 @implementation GraphicsConfigUtil
 217 + (void) _getCGLConfigInfo: (NSMutableArray *)argValue {
 218     AWT_ASSERT_APPKIT_THREAD;
 219 
 220     jint displayID = (jint)[(NSNumber *)[argValue objectAtIndex: 0] intValue];
 221     jint pixfmt = (jint)[(NSNumber *)[argValue objectAtIndex: 1] intValue];
 222     jint swapInterval = (jint)[(NSNumber *)[argValue objectAtIndex: 2] intValue];
 223     JNIEnv *env = [ThreadUtilities getJNIEnvUncached];
 224     [argValue removeAllObjects];
 225 
 226     J2dRlsTraceLn(J2D_TRACE_INFO, "CGLGraphicsConfig_getCGLConfigInfo");
 227 
 228     NSAutoreleasePool* pool = [[NSAutoreleasePool alloc] init];
 229 
 230     CGOpenGLDisplayMask glMask = (CGOpenGLDisplayMask)pixfmt;
 231     if (sharedContext == NULL) {
 232         if (glMask == 0) {
 233             glMask = CGDisplayIDToOpenGLDisplayMask(displayID);
 234         }
 235 
 236         NSOpenGLPixelFormatAttribute attrs[] = {
 237             NSOpenGLPFAClosestPolicy,
 238             NSOpenGLPFAWindow,
 239             NSOpenGLPFAPixelBuffer,
 240             NSOpenGLPFADoubleBuffer,
 241             NSOpenGLPFAColorSize, 32,
 242             NSOpenGLPFAAlphaSize, 8,
 243             NSOpenGLPFADepthSize, 16,
 244             NSOpenGLPFAScreenMask, glMask,
 245             0
 246         };
 247 
 248         sharedPixelFormat =
 249             [[NSOpenGLPixelFormat alloc] initWithAttributes:attrs];
 250         if (sharedPixelFormat == nil) {
 251             J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: shared NSOpenGLPixelFormat is NULL");
 252             [argValue addObject: [NSNumber numberWithLong: 0L]];
 253             return;
 254         }
 255 
 256         sharedContext =
 257             [[NSOpenGLContext alloc]
 258                 initWithFormat:sharedPixelFormat
 259                 shareContext: NULL];
 260         if (sharedContext == nil) {
 261             J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: shared NSOpenGLContext is NULL");
 262             [argValue addObject: [NSNumber numberWithLong: 0L]];
 263             return;
 264         }
 265     }
 266 
 267 #if USE_NSVIEW_FOR_SCRATCH
 268     NSRect contentRect = NSMakeRect(0, 0, 64, 64);
 269     NSWindow *window =
 270         [[NSWindow alloc]
 271             initWithContentRect: contentRect
 272             styleMask: NSBorderlessWindowMask
 273             backing: NSBackingStoreBuffered
 274             defer: false];
 275     if (window == nil) {
 276         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: NSWindow is NULL");
 277         [argValue addObject: [NSNumber numberWithLong: 0L]];
 278         return;
 279     }
 280 
 281     NSView *scratchSurface =
 282         [[NSView alloc]
 283             initWithFrame: contentRect];
 284     if (scratchSurface == nil) {
 285         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: NSView is NULL");
 286         [argValue addObject: [NSNumber numberWithLong: 0L]];
 287         return;
 288     }
 289     [window setContentView: scratchSurface];
 290 #else
 291     NSOpenGLPixelBuffer *scratchSurface =
 292         [[NSOpenGLPixelBuffer alloc]
 293             initWithTextureTarget:GL_TEXTURE_2D
 294             textureInternalFormat:GL_RGB
 295             textureMaxMipMapLevel:0
 296             pixelsWide:64
 297             pixelsHigh:64];
 298 #endif
 299 
 300     NSOpenGLContext *context =
 301         [[NSOpenGLContext alloc]
 302             initWithFormat: sharedPixelFormat
 303             shareContext: sharedContext];
 304     if (context == nil) {
 305         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: NSOpenGLContext is NULL");
 306         [argValue addObject: [NSNumber numberWithLong: 0L]];
 307         return;
 308     }
 309 
 310     GLint contextVirtualScreen = [context currentVirtualScreen];
 311 #if USE_NSVIEW_FOR_SCRATCH
 312     [context setView: scratchSurface];
 313 #else
 314     [context
 315         setPixelBuffer: scratchSurface
 316         cubeMapFace:0
 317         mipMapLevel:0
 318         currentVirtualScreen: contextVirtualScreen];
 319 #endif
 320     [context makeCurrentContext];
 321 
 322     // get version and extension strings
 323     const unsigned char *versionstr = j2d_glGetString(GL_VERSION);
 324     if (!OGLContext_IsVersionSupported(versionstr)) {
 325         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: OpenGL 1.2 is required");
 326         [NSOpenGLContext clearCurrentContext];
 327         [argValue addObject: [NSNumber numberWithLong: 0L]];
 328         return;
 329     }
 330     J2dRlsTraceLn1(J2D_TRACE_INFO, "CGLGraphicsConfig_getCGLConfigInfo: OpenGL version=%s", versionstr);
 331 
 332     jint caps = CAPS_EMPTY;
 333     OGLContext_GetExtensionInfo(env, &caps);
 334 
 335     GLint value = 0;
 336     [sharedPixelFormat
 337         getValues: &value
 338         forAttribute: NSOpenGLPFADoubleBuffer
 339         forVirtualScreen: contextVirtualScreen];
 340     if (value != 0) {
 341         caps |= CAPS_DOUBLEBUFFERED;
 342     }
 343     [sharedPixelFormat
 344         getValues: &value
 345         forAttribute: NSOpenGLPFAAlphaSize
 346         forVirtualScreen: contextVirtualScreen];
 347     if (value != 0) {
 348         caps |= CAPS_STORED_ALPHA;
 349     }
 350 
 351     J2dRlsTraceLn2(J2D_TRACE_INFO,
 352                    "CGLGraphicsConfig_getCGLConfigInfo: db=%d alpha=%d",
 353                    (caps & CAPS_DOUBLEBUFFERED) != 0,
 354                    (caps & CAPS_STORED_ALPHA) != 0);
 355 
 356     // remove before shipping (?)
 357 #if 1
 358     [sharedPixelFormat
 359         getValues: &value
 360         forAttribute: NSOpenGLPFAAccelerated
 361         forVirtualScreen: contextVirtualScreen];
 362     if (value == 0) {
 363         [sharedPixelFormat
 364             getValues: &value
 365             forAttribute: NSOpenGLPFARendererID
 366             forVirtualScreen: contextVirtualScreen];
 367         fprintf(stderr, "WARNING: GL pipe is running in software mode (Renderer ID=0x%x)\n", (int)value);
 368     }
 369 #endif
 370 
 371     // 0: the buffers are swapped with no regard to the vertical refresh rate
 372     // 1: the buffers are swapped only during the vertical retrace
 373     GLint params = swapInterval;
 374     [context setValues: &params forParameter: NSOpenGLCPSwapInterval];
 375 
 376     CGLCtxInfo *ctxinfo = (CGLCtxInfo *)malloc(sizeof(CGLCtxInfo));
 377     if (ctxinfo == NULL) {
 378         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGC_InitOGLContext: could not allocate memory for ctxinfo");
 379         [NSOpenGLContext clearCurrentContext];
 380         [argValue addObject: [NSNumber numberWithLong: 0L]];
 381         return;
 382     }
 383     memset(ctxinfo, 0, sizeof(CGLCtxInfo));
 384     ctxinfo->context = context;
 385     ctxinfo->scratchSurface = scratchSurface;
 386 
 387     OGLContext *oglc = (OGLContext *)malloc(sizeof(OGLContext));
 388     if (oglc == 0L) {
 389         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGC_InitOGLContext: could not allocate memory for oglc");
 390         [NSOpenGLContext clearCurrentContext];
 391         free(ctxinfo);
 392         [argValue addObject: [NSNumber numberWithLong: 0L]];
 393         return;
 394     }
 395     memset(oglc, 0, sizeof(OGLContext));
 396     oglc->ctxInfo = ctxinfo;
 397     oglc->caps = caps;
 398 
 399     // create the CGLGraphicsConfigInfo record for this config
 400     CGLGraphicsConfigInfo *cglinfo = (CGLGraphicsConfigInfo *)malloc(sizeof(CGLGraphicsConfigInfo));
 401     if (cglinfo == NULL) {
 402         J2dRlsTraceLn(J2D_TRACE_ERROR, "CGLGraphicsConfig_getCGLConfigInfo: could not allocate memory for cglinfo");
 403         [NSOpenGLContext clearCurrentContext];
 404         free(oglc);
 405         free(ctxinfo);
 406         [argValue addObject: [NSNumber numberWithLong: 0L]];
 407         return;
 408     }
 409     memset(cglinfo, 0, sizeof(CGLGraphicsConfigInfo));
 410     cglinfo->screen = displayID;
 411     cglinfo->pixfmt = sharedPixelFormat;
 412     cglinfo->context = oglc;
 413 
 414     [NSOpenGLContext clearCurrentContext];
 415     [argValue addObject: [NSNumber numberWithLong:ptr_to_jlong(cglinfo)]];
 416     [pool drain];
 417 }
 418 @end //GraphicsConfigUtil
 419 
 420 JNIEXPORT jint JNICALL
 421 Java_sun_java2d_opengl_CGLGraphicsConfig_getOGLCapabilities
 422     (JNIEnv *env, jclass cglgc, jlong configInfo)
 423 {
 424     J2dTraceLn(J2D_TRACE_INFO, "CGLGraphicsConfig_getOGLCapabilities");
 425 
 426     CGLGraphicsConfigInfo *cglinfo =
 427         (CGLGraphicsConfigInfo *)jlong_to_ptr(configInfo);
 428     if ((cglinfo == NULL) || (cglinfo->context == NULL)) {
 429         return CAPS_EMPTY;
 430     } else {
 431         return cglinfo->context->caps;
 432     }
 433 }
 434 
 435 JNIEXPORT jint JNICALL
 436 Java_sun_java2d_opengl_CGLGraphicsConfig_getMaxTextureSize
 437     (JNIEnv *env, jclass cglgc)
 438 {
 439     J2dTraceLn(J2D_TRACE_INFO, "CGLGraphicsConfig_getMaxTextureSize");
 440 
 441     __block int max = 0;
 442 
 443     [JNFRunLoop performOnMainThreadWaiting:YES withBlock:^(){
 444         [sharedContext makeCurrentContext];
 445         j2d_glGetIntegerv(GL_MAX_TEXTURE_SIZE, &max);
 446     }];
 447 
 448     return (jint)max;
 449 }
 450