Gate *glGetProcAddress() functions behind a linker flag -sGL_ENABLE_GET_PROC_ADDRESS=1 so that we can restrict new GL extensions from being advertised in the future that *glGetProcAddress() cannot support.

Author: juj

ChangeLog.md

@@ -45,6 +45,11 @@ See docs/process.md for more on how version tagging works.
 - Update GLFW handling of touch events to avoid sending duplicate mousedown and
   and mouseup events. Maps touchmove to mousemove events for a single primary
   touch. (#20805)
+- Breaking change: Using the `*glGetProcAddress()` family of functions now
+  requires passing a linker flag -sGL_ENABLE_GET_PROC_ADDRESS. This prevents
+  ports of native GL renderers from later accidentally attempting to activate
+  "dormant" features if web browser implementations gain new WebGL extensions in
+  the future, which `*glGetProcAddress()` is not able to support. (#20802)
 
 3.1.49 - 11/14/23
 -----------------

embuilder.py

@@ -59,6 +59,7 @@
     'libmimalloc',
     'libmimalloc-mt',
     'libGL',
+    'libGL-getprocaddr',
     'libhtml5',
     'libsockets',
     'libstubs',

emcc.py

@@ -935,6 +935,11 @@ def phase_setup(options, state, newargs):
     else:
       settings.SUPPORT_LONGJMP = 'emscripten'
 
+  # SDL2 requires eglGetProcAddress() to work.
+  # NOTE: if SDL2 is updated to not rely on eglGetProcAddress(), this can be removed
+  if settings.USE_SDL == 2 or settings.USE_SDL_MIXER == 2 or settings.USE_SDL_GFX == 2:
+    default_setting('GL_ENABLE_GET_PROC_ADDRESS', 1)
+
   return (newargs, input_files)
 
 

src/library_exceptions_stub.js

@@ -22,7 +22,7 @@ var LibraryExceptions = {};
 ].forEach(function(name) {
   LibraryExceptions[name] = function() { abort(); };
 #if !INCLUDE_FULL_LIBRARY
-  // This method of link-time error genertation is not compatible with INCLUDE_FULL_LIBRARY
+  // This method of link-time error generation is not compatible with INCLUDE_FULL_LIBRARY
   LibraryExceptions[name + '__deps'] = [function() {
     error(`DISABLE_EXCEPTION_THROWING was set (likely due to -fno-exceptions), which means no C++ exception throwing support code is linked in, but such support is required by symbol '${name}'. Either do not set DISABLE_EXCEPTION_THROWING (if you do want exception throwing) or compile all source files with -fno-except (so that no exceptions support code is required); also make sure DISABLE_EXCEPTION_CATCHING is set to the right value - if you want exceptions, it should be off, and vice versa.`);
   }];

src/library_sigs.js

@@ -76,6 +76,7 @@ sigs = {
   SDL_GL_DeleteContext__sig: 'vp',
   SDL_GL_ExtensionSupported__sig: 'ip',
   SDL_GL_GetAttribute__sig: 'iip',
+  SDL_GL_GetProcAddress__sig: 'pp',
   SDL_GL_GetSwapInterval__sig: 'i',
   SDL_GL_MakeCurrent__sig: 'ipp',
   SDL_GL_SetAttribute__sig: 'iii',
@@ -547,6 +548,7 @@ sigs = {
   eglGetCurrentSurface__sig: 'pi',
   eglGetDisplay__sig: 'pp',
   eglGetError__sig: 'i',
+  eglGetProcAddress__sig: 'pp',
   eglInitialize__sig: 'ippp',
   eglMakeCurrent__sig: 'ipppp',
   eglQueryAPI__sig: 'i',
@@ -849,6 +851,8 @@ sigs = {
   emscripten_wasm_worker_post_function_vii__sig: 'vipii',
   emscripten_wasm_worker_post_function_viii__sig: 'vipiii',
   emscripten_wasm_worker_self_id__sig: 'i',
+  emscripten_webgl1_get_proc_address__sig: 'pp',
+  emscripten_webgl2_get_proc_address__sig: 'pp',
   emscripten_webgl_commit_frame__sig: 'i',
   emscripten_webgl_create_context__sig: 'ppp',
   emscripten_webgl_destroy_context__sig: 'ip',
@@ -870,6 +874,7 @@ sigs = {
   emscripten_webgl_get_parameter_o__sig: 'ii',
   emscripten_webgl_get_parameter_utf8__sig: 'pi',
   emscripten_webgl_get_parameter_v__sig: 'iipii',
+  emscripten_webgl_get_proc_address__sig: 'pp',
   emscripten_webgl_get_program_info_log_utf8__sig: 'pi',
   emscripten_webgl_get_program_parameter_d__sig: 'dii',
   emscripten_webgl_get_shader_info_log_utf8__sig: 'pi',
@@ -1387,6 +1392,7 @@ sigs = {
   glfwGetMouseWheel__sig: 'i',
   glfwGetNumberOfProcessors__sig: 'i',
   glfwGetPrimaryMonitor__sig: 'p',
+  glfwGetProcAddress__sig: 'pp',
   glfwGetRequiredInstanceExtensions__sig: 'pp',
   glfwGetThreadID__sig: 'i',
   glfwGetTime__sig: 'd',

src/library_webgl.js

@@ -739,6 +739,58 @@ for (/**@suppress{duplicate}*/var i = 0; i < {{{ GL_POOL_TEMP_BUFFERS_SIZE }}};
       disableHalfFloatExtensionIfBroken(ctx);
 #endif
 
+      // If end user enables *glGetProcAddress() functionality, then we must filter out
+      // all future WebGL extensions from being passed to the user, and only restrict to advertising
+      // extensions that the *glGetProcAddress() function knows to handle.
+#if GL_ENABLE_GET_PROC_ADDRESS
+      var _allSupportedExtensions = ctx.getSupportedExtensions;
+      var supportedExtensionsForGetProcAddress = [
+#if MIN_WEBGL_VERSION == 1
+        // WebGL 1 extensions
+        'ANGLE_instanced_arrays',
+        'EXT_blend_minmax',
+        'EXT_disjoint_timer_query',
+        'EXT_frag_depth',
+        'EXT_shader_texture_lod',
+        'EXT_sRGB',
+        'OES_element_index_uint',
+        'OES_fbo_render_mipmap',
+        'OES_standard_derivatives',
+        'OES_texture_float',
+        'OES_texture_half_float',
+        'OES_texture_half_float_linear',
+        'OES_vertex_array_object',
+        'WEBGL_color_buffer_float',
+        'WEBGL_depth_texture',
+        'WEBGL_draw_buffers',
+#endif
+#if MAX_WEBGL_VERSION >= 2
+        // WebGL 2 extensions
+        'EXT_color_buffer_float',
+        'EXT_disjoint_timer_query_webgl2',
+        'EXT_texture_norm16',
+        'WEBGL_clip_cull_distance',
+#endif
+        // WebGL 1 and WebGL 2 extensions
+        'EXT_color_buffer_half_float',
+        'EXT_float_blend',
+        'EXT_texture_compression_bptc',
+        'EXT_texture_compression_rgtc',
+        'EXT_texture_filter_anisotropic',
+        'KHR_parallel_shader_compile',
+        'OES_texture_float_linear',
+        'WEBGL_compressed_texture_s3tc',
+        'WEBGL_compressed_texture_s3tc_srgb',
+        'WEBGL_debug_renderer_info',
+        'WEBGL_debug_shaders',
+        'WEBGL_lose_context',
+        'WEBGL_multi_draw',
+      ];
+      ctx.getSupportedExtensions = function() {
+        return (_allSupportedExtensions.apply(this) || []).filter(ext => supportedExtensionsForGetProcAddress.includes(ext));
+      }
+#endif
+
       return handle;
     },
 
@@ -4219,6 +4271,27 @@ for (/**@suppress{duplicate}*/var i = 0; i < {{{ GL_POOL_TEMP_BUFFERS_SIZE }}};
 #endif
 };
 
+#if !GL_ENABLE_GET_PROC_ADDRESS
+[
+  'emscripten_webgl1_get_proc_address',
+  'emscripten_webgl2_get_proc_address',
+  'emscripten_webgl_get_proc_address',
+  'SDL_GL_GetProcAddress',
+  'eglGetProcAddress',
+  'glfwGetProcAddress'
+].forEach(function(name) {
+  LibraryGL[name] = function(name) { abort(); };
+  // Due to the two pass nature of compiling .js files,
+  // in INCLUDE_FULL_LIBRARY mode, we must include the above
+  // stub functions, but not their __deps message handlers.
+#if !INCLUDE_FULL_LIBRARY
+  LibraryGL[name + '__deps'] = [function() {
+    error(`linker: Undefined symbol: ${name}(). Please pass -sGL_ENABLE_GET_PROC_ADDRESS at link time to link in ${name}().`);
+  }];
+#endif
+});
+#endif
+
 // Simple pass-through functions.
 // - Starred ones have return values.
 // - [X] ones have X in the C name but not in the JS name

src/settings.js

@@ -589,6 +589,13 @@ var GL_DISABLE_HALF_FLOAT_EXTENSION_IF_BROKEN = false;
 // Set this to 0 to force-disable the workaround if you know the issue will not affect you.
 var GL_WORKAROUND_SAFARI_GETCONTEXT_BUG = true;
 
+// If 1, link with support to *glGetProcAddress() functionality.
+// In WebGL, *glGetProcAddress() causes a substantial code size and performance impact, since WebGL
+// does not natively provide such functionality, and it must be emulated. Using *glGetProcAddress()
+// is not recommended. If you still need to use this, e.g. when porting an existing renderer,
+// you can link with -sGL_ENABLE_GET_PROC_ADDRESS=1 to get support for this functionality.
+var GL_ENABLE_GET_PROC_ADDRESS = false;
+
 // Use JavaScript math functions like Math.tan. This saves code size as we can avoid shipping
 // compiled musl code. However, it can be significantly slower as it calls out to JS. It
 // also may give different results as JS math is specced somewhat differently than libc, and

system/lib/gl/gl.c

@@ -1569,6 +1569,8 @@ GLAPI void APIENTRY emscripten_glGetObjectParameteriv (GLhandleARB obj, GLenum p
 GLAPI void APIENTRY emscripten_glGetInfoLog (GLhandleARB obj, GLsizei maxLength, GLsizei *length, GLcharARB *infoLog);
 GLAPI void APIENTRY emscripten_glBindProgram (GLenum target, GLuint program);
 
+#if GL_ENABLE_GET_PROC_ADDRESS
+
 extern void *emscripten_webgl1_get_proc_address(const char *name);
 extern void *_webgl1_match_ext_proc_address_without_suffix(const char *name);
 extern void *emscripten_webgl2_get_proc_address(const char *name);
@@ -1837,3 +1839,5 @@ extern void *emscripten_webgl_get_proc_address(const char *name)
 #endif
   return ptr;
 }
+
+#endif

system/lib/gl/libprocaddr.c

@@ -7,6 +7,8 @@
 
 // GL proc address library integration
 
+#if GL_ENABLE_GET_PROC_ADDRESS
+
 extern void* emscripten_GetProcAddress(const char *name);
 
 __attribute__((weak)) // SDL2 will link in its own version of this
@@ -21,3 +23,5 @@ void* eglGetProcAddress(const char* name) {
 void* glfwGetProcAddress(const char* name) {
   return emscripten_GetProcAddress(name);
 }
+
+#endif

system/lib/gl/webgl1.c

@@ -579,6 +579,8 @@ RET_SYNC_GL_FUNCTION_3(EM_FUNC_SIG_VIII, void, glGetQueryObjectui64vEXT, GLenum,
 
 #endif // ~(__EMSCRIPTEN_PTHREADS__ && __EMSCRIPTEN_OFFSCREEN_FRAMEBUFFER__)
 
+#if GL_ENABLE_GET_PROC_ADDRESS
+
 // Returns a function pointer to the given WebGL 1 extension function, when queried without
 // a GL extension suffix such as "EXT", "OES", or "ANGLE". This function is used by
 // emscripten_GetProcAddress() to implement legacy GL emulation semantics for portability.
@@ -797,3 +799,5 @@ void *emscripten_webgl1_get_proc_address(const char *name) {
 
   return 0;
 }
+
+#endif