PPAPI: Add dev synchronous JS->Plugin messaging API

ppapi/native_client/src/untrusted/pnacl_irt_shim/pnacl_shim.c

 /* Copyright (c) 2014 The Chromium Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 /* NOTE: this is auto-generated from IDL */
 #include "ppapi/native_client/src/untrusted/pnacl_irt_shim/pnacl_shim.h"
 
 #include "ppapi/c/ppb.h"
 #include "ppapi/c/dev/ppb_alarms_dev.h"
@@ skipping 32 matching lines @@
 #include "ppapi/c/ppb_text_input_controller.h"
 #include "ppapi/c/ppb_udp_socket.h"
 #include "ppapi/c/ppb_url_loader.h"
 #include "ppapi/c/ppb_url_request_info.h"
 #include "ppapi/c/ppb_url_response_info.h"
 #include "ppapi/c/ppb_var.h"
 #include "ppapi/c/ppb_var_array.h"
 #include "ppapi/c/ppb_var_array_buffer.h"
 #include "ppapi/c/ppb_var_dictionary.h"
 #include "ppapi/c/ppb_websocket.h"
+#include "ppapi/c/ppp_message_handler.h"
 #include "ppapi/c/ppp_messaging.h"
 #include "ppapi/c/private/ppb_content_decryptor_private.h"
 #include "ppapi/c/private/ppb_display_color_profile_private.h"
 #include "ppapi/c/private/ppb_ext_crx_file_system_private.h"
 #include "ppapi/c/private/ppb_file_io_private.h"
 #include "ppapi/c/private/ppb_file_ref_private.h"
 #include "ppapi/c/private/ppb_flash.h"
 #include "ppapi/c/private/ppb_flash_clipboard.h"
 #include "ppapi/c/private/ppb_flash_device_id.h"
 #include "ppapi/c/private/ppb_flash_drm.h"
@@ skipping 48 matching lines @@
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_MouseInputEvent_1_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_WheelInputEvent_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_KeyboardInputEvent_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_KeyboardInputEvent_1_2;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_TouchInputEvent_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_IMEInputEvent_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_MediaStreamAudioTrack_0_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_MediaStreamVideoTrack_0_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_MessageLoop_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Messaging_1_0;
+static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Messaging_1_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_MouseLock_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_NetAddress_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_NetworkList_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_NetworkMonitor_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_NetworkProxy_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_TCPSocket_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_TCPSocket_1_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_TextInputController_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_UDPSocket_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_URLLoader_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_URLRequestInfo_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_URLResponseInfo_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Var_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Var_1_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Var_1_2;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_VarArray_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_VarArrayBuffer_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_VarDictionary_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_WebSocket_1_0;
+static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPP_MessageHandler_0_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPP_Messaging_1_0;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Alarms_Dev_0_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_AudioInput_Dev_0_3;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_AudioInput_Dev_0_4;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_DeviceRef_Dev_0_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_FileChooser_Dev_0_5;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_FileChooser_Dev_0_6;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Font_Dev_0_6;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_IMEInputEvent_Dev_0_1;
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_IMEInputEvent_Dev_0_2;
@@ skipping 969 matching lines @@
 
 /* Begin wrapper methods for PPB_Messaging_1_0 */
 
 static void Pnacl_M14_PPB_Messaging_PostMessage(PP_Instance instance, struct PP_Var* message) {
   const struct PPB_Messaging_1_0 *iface = Pnacl_WrapperInfo_PPB_Messaging_1_0.real_iface;
   iface->PostMessage(instance, *message);
 }
 
 /* End wrapper methods for PPB_Messaging_1_0 */
 
+/* Begin wrapper methods for PPB_Messaging_1_1 */
+
+static void Pnacl_M36_PPB_Messaging_PostMessage(PP_Instance instance, struct PP_Var* message) {
+  const struct PPB_Messaging_1_1 *iface = Pnacl_WrapperInfo_PPB_Messaging_1_1.real_iface;
+  iface->PostMessage(instance, *message);
+}
+
+static int32_t Pnacl_M36_PPB_Messaging_RegisterMessageHandler(PP_Instance instance, const void* user_data, const struct PPP_MessageHandler_0_1* handler, PP_Resource message_loop) {

[jvoung (off chromium), 2014/06/02 15:58:49]

One thought on how to handle this w/ shims is to modify the shim generator to do
some interception right here. That is instead of trying to have some API for
reaching into the shim.

Suppose in the IDL, you tag the PPP_MessageHandler_0_1 argument as special in
the sense that:

(a) it points to a struct of function pointers that themselves need to be
shimmed and you know the shim generator will generate the wrappers
(b) only one set of those function pointers are live at a time

Then you can copy the function pointers from handler into some static location
("real_ppp_message_handler_0_1" for example). Then set
"Pnacl_WrapperInfo_PPP_MessageHandler_0_1.real_iface" to point to that copy.

Then in the call to iface->RegisterMessageHandler(), instead of passing
"handler", pass "Pnacl_WrapperInfo_PPP_MessageHandler_0_1.wrapped_iface". The
generated wrappers for Pnacl_WrapperInfo_PPP_MessageHandler_0_1 should then
handle the rest.

Maybe it's not too clean to have to tag the IDL w/ info about shimming. You
could try to detect this situation instead, but the restriction (b) above is not
something you can just detect. Might also need to be careful if the registration
thread is different from the PPP handler thread, so don't want to be too
automatic (unless the shim code is thread safe)?

+  const struct PPB_Messaging_1_1 *iface = Pnacl_WrapperInfo_PPB_Messaging_1_1.real_iface;
+  return iface->RegisterMessageHandler(instance, user_data, handler, message_loop);
+}
+
+static void Pnacl_M36_PPB_Messaging_UnregisterMessageHandler(PP_Instance instance) {
+  const struct PPB_Messaging_1_1 *iface = Pnacl_WrapperInfo_PPB_Messaging_1_1.real_iface;
+  iface->UnregisterMessageHandler(instance);
+}
+
+/* End wrapper methods for PPB_Messaging_1_1 */
+
 /* Not generating wrapper methods for PPB_MouseCursor_1_0 */
 
 /* Begin wrapper methods for PPB_MouseLock_1_0 */
 
 static int32_t Pnacl_M16_PPB_MouseLock_LockMouse(PP_Instance instance, struct PP_CompletionCallback* callback) {
   const struct PPB_MouseLock_1_0 *iface = Pnacl_WrapperInfo_PPB_MouseLock_1_0.real_iface;
   return iface->LockMouse(instance, *callback);
 }
 
 static void Pnacl_M16_PPB_MouseLock_UnlockMouse(PP_Instance instance) {
@@ skipping 647 matching lines @@
 /* End wrapper methods for PPB_WebSocket_1_0 */
 
 /* Not generating wrapper methods for PPP_Graphics3D_1_0 */
 
 /* Not generating wrapper methods for PPP_InputEvent_0_1 */
 
 /* Not generating wrapper methods for PPP_Instance_1_0 */
 
 /* Not generating wrapper methods for PPP_Instance_1_1 */
 
+/* Begin wrapper methods for PPP_MessageHandler_0_1 */
+
+static void Pnacl_M36_PPP_MessageHandler_HandleMessage(PP_Instance instance, const void* user_data, struct PP_Var message) {
+  const struct PPP_MessageHandler_0_1 *iface = Pnacl_WrapperInfo_PPP_MessageHandler_0_1.real_iface;
+  void (*temp_fp)(PP_Instance instance, const void* user_data, struct PP_Var* message) =
+    ((void (*)(PP_Instance instance, const void* user_data, struct PP_Var* message))iface->HandleMessage);
+  temp_fp(instance, user_data, &message);
+}
+
+static struct PP_Var Pnacl_M36_PPP_MessageHandler_HandleBlockingMessage(PP_Instance instance, const void* user_data, struct PP_Var message) {
+  const struct PPP_MessageHandler_0_1 *iface = Pnacl_WrapperInfo_PPP_MessageHandler_0_1.real_iface;
+  void (*temp_fp)(struct PP_Var* _struct_result, PP_Instance instance, const void* user_data, struct PP_Var* message) =
+    ((void (*)(struct PP_Var* _struct_result, PP_Instance instance, const void* user_data, struct PP_Var* message))iface->HandleBlockingMessage);
+  struct PP_Var _struct_result;
+  temp_fp(&_struct_result, instance, user_data, &message);
+  return _struct_result;
+}
+
+static void Pnacl_M36_PPP_MessageHandler_Destroy(PP_Instance instance, const void* user_data) {
+  const struct PPP_MessageHandler_0_1 *iface = Pnacl_WrapperInfo_PPP_MessageHandler_0_1.real_iface;
+  void (*temp_fp)(PP_Instance instance, const void* user_data) =
+    ((void (*)(PP_Instance instance, const void* user_data))iface->Destroy);
+  temp_fp(instance, user_data);
+}
+
+/* End wrapper methods for PPP_MessageHandler_0_1 */
+
 /* Begin wrapper methods for PPP_Messaging_1_0 */
 
 static void Pnacl_M14_PPP_Messaging_HandleMessage(PP_Instance instance, struct PP_Var message) {
   const struct PPP_Messaging_1_0 *iface = Pnacl_WrapperInfo_PPP_Messaging_1_0.real_iface;
   void (*temp_fp)(PP_Instance instance, struct PP_Var* message) =
     ((void (*)(PP_Instance instance, struct PP_Var* message))iface->HandleMessage);
   temp_fp(instance, &message);
 }
 
 /* End wrapper methods for PPP_Messaging_1_0 */
@@ skipping 2762 matching lines @@
     .AttachToCurrentThread = (int32_t (*)(PP_Resource message_loop))&Pnacl_M25_PPB_MessageLoop_AttachToCurrentThread,
     .Run = (int32_t (*)(PP_Resource message_loop))&Pnacl_M25_PPB_MessageLoop_Run,
     .PostWork = (int32_t (*)(PP_Resource message_loop, struct PP_CompletionCallback callback, int64_t delay_ms))&Pnacl_M25_PPB_MessageLoop_PostWork,
     .PostQuit = (int32_t (*)(PP_Resource message_loop, PP_Bool should_destroy))&Pnacl_M25_PPB_MessageLoop_PostQuit
 };
 
 static const struct PPB_Messaging_1_0 Pnacl_Wrappers_PPB_Messaging_1_0 = {
     .PostMessage = (void (*)(PP_Instance instance, struct PP_Var message))&Pnacl_M14_PPB_Messaging_PostMessage
 };
 
+static const struct PPB_Messaging_1_1 Pnacl_Wrappers_PPB_Messaging_1_1 = {
+    .PostMessage = (void (*)(PP_Instance instance, struct PP_Var message))&Pnacl_M36_PPB_Messaging_PostMessage,
+    .RegisterMessageHandler = (int32_t (*)(PP_Instance instance, const void* user_data, const struct PPP_MessageHandler_0_1* handler, PP_Resource message_loop))&Pnacl_M36_PPB_Messaging_RegisterMessageHandler,
+    .UnregisterMessageHandler = (void (*)(PP_Instance instance))&Pnacl_M36_PPB_Messaging_UnregisterMessageHandler
+};
+
 /* Not generating wrapper interface for PPB_MouseCursor_1_0 */
 
 static const struct PPB_MouseLock_1_0 Pnacl_Wrappers_PPB_MouseLock_1_0 = {
     .LockMouse = (int32_t (*)(PP_Instance instance, struct PP_CompletionCallback callback))&Pnacl_M16_PPB_MouseLock_LockMouse,
     .UnlockMouse = (void (*)(PP_Instance instance))&Pnacl_M16_PPB_MouseLock_UnlockMouse
 };
 
 static const struct PPB_NetAddress_1_0 Pnacl_Wrappers_PPB_NetAddress_1_0 = {
     .CreateFromIPv4Address = (PP_Resource (*)(PP_Instance instance, const struct PP_NetAddress_IPv4* ipv4_addr))&Pnacl_M29_PPB_NetAddress_CreateFromIPv4Address,
     .CreateFromIPv6Address = (PP_Resource (*)(PP_Instance instance, const struct PP_NetAddress_IPv6* ipv6_addr))&Pnacl_M29_PPB_NetAddress_CreateFromIPv6Address,
@@ skipping 168 matching lines @@
 };
 
 /* Not generating wrapper interface for PPP_Graphics3D_1_0 */
 
 /* Not generating wrapper interface for PPP_InputEvent_0_1 */
 
 /* Not generating wrapper interface for PPP_Instance_1_0 */
 
 /* Not generating wrapper interface for PPP_Instance_1_1 */
 
+static const struct PPP_MessageHandler_0_1 Pnacl_Wrappers_PPP_MessageHandler_0_1 = {
+    .HandleMessage = &Pnacl_M36_PPP_MessageHandler_HandleMessage,
+    .HandleBlockingMessage = &Pnacl_M36_PPP_MessageHandler_HandleBlockingMessage,
+    .Destroy = &Pnacl_M36_PPP_MessageHandler_Destroy
+};
+
 static const struct PPP_Messaging_1_0 Pnacl_Wrappers_PPP_Messaging_1_0 = {
     .HandleMessage = &Pnacl_M14_PPP_Messaging_HandleMessage
 };
 
 /* Not generating wrapper interface for PPP_MouseLock_1_0 */
 
 /* Not generating wrapper interface for PPB_BrokerTrusted_0_2 */
 
 /* Not generating wrapper interface for PPB_BrokerTrusted_0_3 */
 
@@ skipping 823 matching lines @@
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_MessageLoop_1_0,
   .real_iface = NULL
 };
 
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Messaging_1_0 = {
   .iface_macro = PPB_MESSAGING_INTERFACE_1_0,
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_Messaging_1_0,
   .real_iface = NULL
 };
 
+static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Messaging_1_1 = {
+  .iface_macro = PPB_MESSAGING_INTERFACE_1_1,
+  .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_Messaging_1_1,
+  .real_iface = NULL
+};
+
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_MouseLock_1_0 = {
   .iface_macro = PPB_MOUSELOCK_INTERFACE_1_0,
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_MouseLock_1_0,
   .real_iface = NULL
 };
 
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_NetAddress_1_0 = {
   .iface_macro = PPB_NETADDRESS_INTERFACE_1_0,
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_NetAddress_1_0,
   .real_iface = NULL
@@ skipping 94 matching lines @@
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_VarDictionary_1_0,
   .real_iface = NULL
 };
 
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_WebSocket_1_0 = {
   .iface_macro = PPB_WEBSOCKET_INTERFACE_1_0,
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_WebSocket_1_0,
   .real_iface = NULL
 };
 
+static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPP_MessageHandler_0_1 = {
+  .iface_macro = NULL,
+  .wrapped_iface = (const void *) &Pnacl_Wrappers_PPP_MessageHandler_0_1,
+  .real_iface = NULL
+};
+
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPP_Messaging_1_0 = {
   .iface_macro = PPP_MESSAGING_INTERFACE_1_0,
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPP_Messaging_1_0,
   .real_iface = NULL
 };
 
 static struct __PnaclWrapperInfo Pnacl_WrapperInfo_PPB_Alarms_Dev_0_1 = {
   .iface_macro = PPB_ALARMS_DEV_INTERFACE_0_1,
   .wrapped_iface = (const void *) &Pnacl_Wrappers_PPB_Alarms_Dev_0_1,
   .real_iface = NULL
@@ skipping 371 matching lines @@
   &Pnacl_WrapperInfo_PPB_MouseInputEvent_1_1,
   &Pnacl_WrapperInfo_PPB_WheelInputEvent_1_0,
   &Pnacl_WrapperInfo_PPB_KeyboardInputEvent_1_0,
   &Pnacl_WrapperInfo_PPB_KeyboardInputEvent_1_2,
   &Pnacl_WrapperInfo_PPB_TouchInputEvent_1_0,
   &Pnacl_WrapperInfo_PPB_IMEInputEvent_1_0,
   &Pnacl_WrapperInfo_PPB_MediaStreamAudioTrack_0_1,
   &Pnacl_WrapperInfo_PPB_MediaStreamVideoTrack_0_1,
   &Pnacl_WrapperInfo_PPB_MessageLoop_1_0,
   &Pnacl_WrapperInfo_PPB_Messaging_1_0,
+  &Pnacl_WrapperInfo_PPB_Messaging_1_1,
   &Pnacl_WrapperInfo_PPB_MouseLock_1_0,
   &Pnacl_WrapperInfo_PPB_NetAddress_1_0,
   &Pnacl_WrapperInfo_PPB_NetworkList_1_0,
   &Pnacl_WrapperInfo_PPB_NetworkMonitor_1_0,
   &Pnacl_WrapperInfo_PPB_NetworkProxy_1_0,
   &Pnacl_WrapperInfo_PPB_TCPSocket_1_0,
   &Pnacl_WrapperInfo_PPB_TCPSocket_1_1,
   &Pnacl_WrapperInfo_PPB_TextInputController_1_0,
   &Pnacl_WrapperInfo_PPB_UDPSocket_1_0,
   &Pnacl_WrapperInfo_PPB_URLLoader_1_0,
@@ skipping 60 matching lines @@
   &Pnacl_WrapperInfo_PPB_UMA_Private_0_3,
   &Pnacl_WrapperInfo_PPB_VideoDestination_Private_0_1,
   &Pnacl_WrapperInfo_PPB_VideoSource_Private_0_1,
   &Pnacl_WrapperInfo_PPB_X509Certificate_Private_0_1,
   &Pnacl_WrapperInfo_PPB_Ext_Socket_Dev_0_1,
   &Pnacl_WrapperInfo_PPB_Ext_Socket_Dev_0_2,
   NULL
 };
 
 static struct __PnaclWrapperInfo *s_ppp_wrappers[] = {
+  &Pnacl_WrapperInfo_PPP_MessageHandler_0_1,
   &Pnacl_WrapperInfo_PPP_Messaging_1_0,
   &Pnacl_WrapperInfo_PPP_Selection_Dev_0_3,
   &Pnacl_WrapperInfo_PPP_ContentDecryptor_Private_0_11,
   &Pnacl_WrapperInfo_PPP_Instance_Private_0_1,
   NULL
 };
 
 
 
 static PPB_GetInterface __real_PPBGetInterface;
@@ skipping 16 matching lines @@
     ++next;
   }
   return NULL;
 }
 
 /* Map interface string -> wrapper metadata */
 static struct __PnaclWrapperInfo *PnaclPPPShimIface(
     const char *name) {
   struct __PnaclWrapperInfo **next = s_ppp_wrappers;
   while (*next != NULL) {
     if (mystrcmp(name, (*next)->iface_macro) == 0) return *next;

[jvoung (off chromium), 2014/05/01 21:29:06]

The mystrcmp currently doesn't handle NULL pointer arguments.

On the other hand, if the iface_macro is NULL the there might as well not be a
wrapper under s_ppp_wrappers, since it will never match in this search loop?

[dmichael (off chromium), 2014/05/30 20:30:46]

Done. See also https://codereview.chromium.org/305233002/

     ++next;
   }
   return NULL;
 }
 
 const void *__Pnacl_PPBGetInterface(const char *name) {
   struct __PnaclWrapperInfo *wrapper = PnaclPPBShimIface(name);
   if (wrapper == NULL) {
     /* We did not generate a wrapper for this, so return the real interface. */
     return (*__real_PPBGetInterface)(name);
@@ skipping 18 matching lines @@
 
   /* Initialize the real_iface if it hasn't been. The wrapper depends on it. */
   if (wrapper->real_iface == NULL) {
     const void *iface = (*__real_PPPGetInterface)(name);
     if (NULL == iface) return NULL;
     wrapper->real_iface = iface;
   }
 
   return wrapper->wrapped_iface;
 }