interface_list.cc revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7 
1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "ppapi/proxy/interface_list.h"
6
7#include "base/hash.h"
8#include "base/lazy_instance.h"
9#include "base/memory/singleton.h"
10#include "ppapi/c/dev/ppb_alarms_dev.h"
11#include "ppapi/c/dev/ppb_audio_input_dev.h"
12#include "ppapi/c/dev/ppb_buffer_dev.h"
13#include "ppapi/c/dev/ppb_char_set_dev.h"
14#include "ppapi/c/dev/ppb_crypto_dev.h"
15#include "ppapi/c/dev/ppb_cursor_control_dev.h"
16#include "ppapi/c/dev/ppb_device_ref_dev.h"
17#include "ppapi/c/dev/ppb_font_dev.h"
18#include "ppapi/c/dev/ppb_gles_chromium_texture_mapping_dev.h"
19#include "ppapi/c/dev/ppb_graphics_2d_dev.h"
20#include "ppapi/c/dev/ppb_ime_input_event_dev.h"
21#include "ppapi/c/dev/ppb_memory_dev.h"
22#include "ppapi/c/dev/ppb_opengles2ext_dev.h"
23#include "ppapi/c/dev/ppb_printing_dev.h"
24#include "ppapi/c/dev/ppb_text_input_dev.h"
25#include "ppapi/c/dev/ppb_trace_event_dev.h"
26#include "ppapi/c/dev/ppb_truetype_font_dev.h"
27#include "ppapi/c/dev/ppb_url_util_dev.h"
28#include "ppapi/c/dev/ppb_var_deprecated.h"
29#include "ppapi/c/dev/ppb_video_capture_dev.h"
30#include "ppapi/c/dev/ppb_view_dev.h"
31#include "ppapi/c/extensions/dev/ppb_ext_socket_dev.h"
32#include "ppapi/c/ppb_audio.h"
33#include "ppapi/c/ppb_audio_buffer.h"
34#include "ppapi/c/ppb_audio_config.h"
35#include "ppapi/c/ppb_console.h"
36#include "ppapi/c/ppb_core.h"
37#include "ppapi/c/ppb_file_io.h"
38#include "ppapi/c/ppb_file_mapping.h"
39#include "ppapi/c/ppb_file_ref.h"
40#include "ppapi/c/ppb_file_system.h"
41#include "ppapi/c/ppb_fullscreen.h"
42#include "ppapi/c/ppb_graphics_2d.h"
43#include "ppapi/c/ppb_host_resolver.h"
44#include "ppapi/c/ppb_image_data.h"
45#include "ppapi/c/ppb_input_event.h"
46#include "ppapi/c/ppb_instance.h"
47#include "ppapi/c/ppb_media_stream_audio_track.h"
48#include "ppapi/c/ppb_media_stream_video_track.h"
49#include "ppapi/c/ppb_message_loop.h"
50#include "ppapi/c/ppb_messaging.h"
51#include "ppapi/c/ppb_mouse_lock.h"
52#include "ppapi/c/ppb_net_address.h"
53#include "ppapi/c/ppb_network_list.h"
54#include "ppapi/c/ppb_network_monitor.h"
55#include "ppapi/c/ppb_network_proxy.h"
56#include "ppapi/c/ppb_opengles2.h"
57#include "ppapi/c/ppb_tcp_socket.h"
58#include "ppapi/c/ppb_text_input_controller.h"
59#include "ppapi/c/ppb_udp_socket.h"
60#include "ppapi/c/ppb_url_loader.h"
61#include "ppapi/c/ppb_url_request_info.h"
62#include "ppapi/c/ppb_url_response_info.h"
63#include "ppapi/c/ppb_var.h"
64#include "ppapi/c/ppb_var_array.h"
65#include "ppapi/c/ppb_var_array_buffer.h"
66#include "ppapi/c/ppb_var_dictionary.h"
67#include "ppapi/c/ppb_video_frame.h"
68#include "ppapi/c/ppb_view.h"
69#include "ppapi/c/pp_errors.h"
70#include "ppapi/c/ppp_instance.h"
71#include "ppapi/c/private/ppb_content_decryptor_private.h"
72#include "ppapi/c/private/ppb_ext_crx_file_system_private.h"
73#include "ppapi/c/private/ppb_file_io_private.h"
74#include "ppapi/c/private/ppb_file_ref_private.h"
75#include "ppapi/c/private/ppb_flash_clipboard.h"
76#include "ppapi/c/private/ppb_flash_file.h"
77#include "ppapi/c/private/ppb_flash_font_file.h"
78#include "ppapi/c/private/ppb_flash_fullscreen.h"
79#include "ppapi/c/private/ppb_flash.h"
80#include "ppapi/c/private/ppb_flash_device_id.h"
81#include "ppapi/c/private/ppb_flash_drm.h"
82#include "ppapi/c/private/ppb_flash_menu.h"
83#include "ppapi/c/private/ppb_flash_message_loop.h"
84#include "ppapi/c/private/ppb_flash_print.h"
85#include "ppapi/c/private/ppb_host_resolver_private.h"
86#include "ppapi/c/private/ppb_isolated_file_system_private.h"
87#include "ppapi/c/private/ppb_net_address_private.h"
88#include "ppapi/c/private/ppb_output_protection_private.h"
89#include "ppapi/c/private/ppb_pdf.h"
90#include "ppapi/c/private/ppb_platform_verification_private.h"
91#include "ppapi/c/private/ppb_talk_private.h"
92#include "ppapi/c/private/ppb_tcp_server_socket_private.h"
93#include "ppapi/c/private/ppb_tcp_socket_private.h"
94#include "ppapi/c/private/ppb_testing_private.h"
95#include "ppapi/c/private/ppb_udp_socket_private.h"
96#include "ppapi/c/private/ppb_uma_private.h"
97#include "ppapi/c/private/ppb_video_destination_private.h"
98#include "ppapi/c/private/ppb_video_source_private.h"
99#include "ppapi/c/private/ppb_x509_certificate_private.h"
100#include "ppapi/c/private/ppp_content_decryptor_private.h"
101#include "ppapi/c/trusted/ppb_broker_trusted.h"
102#include "ppapi/c/trusted/ppb_browser_font_trusted.h"
103#include "ppapi/c/trusted/ppb_char_set_trusted.h"
104#include "ppapi/c/trusted/ppb_file_chooser_trusted.h"
105#include "ppapi/c/trusted/ppb_url_loader_trusted.h"
106#include "ppapi/proxy/interface_proxy.h"
107#include "ppapi/proxy/plugin_globals.h"
108#include "ppapi/proxy/ppapi_messages.h"
109#include "ppapi/proxy/ppb_audio_proxy.h"
110#include "ppapi/proxy/ppb_broker_proxy.h"
111#include "ppapi/proxy/ppb_buffer_proxy.h"
112#include "ppapi/proxy/ppb_core_proxy.h"
113#include "ppapi/proxy/ppb_flash_message_loop_proxy.h"
114#include "ppapi/proxy/ppb_graphics_3d_proxy.h"
115#include "ppapi/proxy/ppb_image_data_proxy.h"
116#include "ppapi/proxy/ppb_instance_proxy.h"
117#include "ppapi/proxy/ppb_message_loop_proxy.h"
118#include "ppapi/proxy/ppb_testing_proxy.h"
119#include "ppapi/proxy/ppb_var_deprecated_proxy.h"
120#include "ppapi/proxy/ppb_video_decoder_proxy.h"
121#include "ppapi/proxy/ppb_x509_certificate_private_proxy.h"
122#include "ppapi/proxy/ppp_class_proxy.h"
123#include "ppapi/proxy/ppp_content_decryptor_private_proxy.h"
124#include "ppapi/proxy/ppp_graphics_3d_proxy.h"
125#include "ppapi/proxy/ppp_input_event_proxy.h"
126#include "ppapi/proxy/ppp_instance_private_proxy.h"
127#include "ppapi/proxy/ppp_instance_proxy.h"
128#include "ppapi/proxy/ppp_messaging_proxy.h"
129#include "ppapi/proxy/ppp_mouse_lock_proxy.h"
130#include "ppapi/proxy/ppp_pdf_proxy.h"
131#include "ppapi/proxy/ppp_printing_proxy.h"
132#include "ppapi/proxy/ppp_text_input_proxy.h"
133#include "ppapi/proxy/ppp_video_decoder_proxy.h"
134#include "ppapi/proxy/resource_creation_proxy.h"
135#include "ppapi/shared_impl/ppb_opengles2_shared.h"
136#include "ppapi/shared_impl/ppb_var_shared.h"
137#include "ppapi/thunk/thunk.h"
138
139// Helper to get the proxy name PPB_Foo_Proxy given the API name PPB_Foo.
140#define PROXY_CLASS_NAME(api_name) api_name##_Proxy
141
142// Helper to get the interface ID PPB_Foo_Proxy::kApiID given the API
143// name PPB_Foo.
144#define PROXY_API_ID(api_name) PROXY_CLASS_NAME(api_name)::kApiID
145
146// Helper to get the name of the templatized factory function.
147#define PROXY_FACTORY_NAME(api_name) ProxyFactory<PROXY_CLASS_NAME(api_name)>
148
149// Helper to get the name of the thunk GetPPB_Foo_1_0_Thunk given the interface
150// struct name PPB_Foo_1_0.
151#define INTERFACE_THUNK_NAME(iface_struct) thunk::Get##iface_struct##_Thunk
152
153namespace ppapi {
154namespace proxy {
155
156namespace {
157
158template<typename ProxyClass>
159InterfaceProxy* ProxyFactory(Dispatcher* dispatcher) {
160  return new ProxyClass(dispatcher);
161}
162
163base::LazyInstance<PpapiPermissions> g_process_global_permissions;
164
165}  // namespace
166
167InterfaceList::InterfaceList() {
168  memset(id_to_factory_, 0, sizeof(id_to_factory_));
169
170  // Register the API factories for each of the API types. This calls AddProxy
171  // for each InterfaceProxy type we support.
172  #define PROXIED_API(api_name) \
173      AddProxy(PROXY_API_ID(api_name), &PROXY_FACTORY_NAME(api_name));
174
175  // Register each proxied interface by calling AddPPB for each supported
176  // interface. Set current_required_permission to the appropriate value for
177  // the value you want expanded by this macro.
178  #define PROXIED_IFACE(iface_str, iface_struct) \
179      AddPPB(iface_str, \
180             INTERFACE_THUNK_NAME(iface_struct)(), \
181             current_required_permission);
182
183  {
184    Permission current_required_permission = PERMISSION_NONE;
185    #include "ppapi/thunk/interfaces_ppb_private_no_permissions.h"
186    #include "ppapi/thunk/interfaces_ppb_public_stable.h"
187  }
188  {
189    Permission current_required_permission = PERMISSION_DEV;
190    #include "ppapi/thunk/interfaces_ppb_public_dev.h"
191  }
192  {
193    Permission current_required_permission = PERMISSION_PRIVATE;
194    #include "ppapi/thunk/interfaces_ppb_private.h"
195  }
196  {
197#if !defined(OS_NACL)
198    Permission current_required_permission = PERMISSION_FLASH;
199    #include "ppapi/thunk/interfaces_ppb_private_flash.h"
200#endif  // !defined(OS_NACL)
201  }
202  {
203    Permission current_required_permission = PERMISSION_DEV_CHANNEL;
204    #include "ppapi/thunk/interfaces_ppb_public_dev_channel.h"
205  }
206
207  #undef PROXIED_API
208  #undef PROXIED_IFACE
209
210  // Manually add some special proxies. Some of these don't have interfaces
211  // that they support, so aren't covered by the macros above, but have proxies
212  // for message routing. Others have different implementations between the
213  // proxy and the impl and there's no obvious message routing.
214  AddProxy(API_ID_RESOURCE_CREATION, &ResourceCreationProxy::Create);
215  AddProxy(API_ID_PPP_CLASS, &PPP_Class_Proxy::Create);
216  AddPPB(PPB_CORE_INTERFACE_1_0,
217         PPB_Core_Proxy::GetPPB_Core_Interface(), PERMISSION_NONE);
218  AddPPB(PPB_MESSAGELOOP_INTERFACE_1_0,
219         PPB_MessageLoop_Proxy::GetInterface(), PERMISSION_NONE);
220  AddPPB(PPB_OPENGLES2_INTERFACE_1_0,
221         PPB_OpenGLES2_Shared::GetInterface(), PERMISSION_NONE);
222  AddPPB(PPB_OPENGLES2_INSTANCEDARRAYS_INTERFACE_1_0,
223         PPB_OpenGLES2_Shared::GetInstancedArraysInterface(), PERMISSION_NONE);
224  AddPPB(PPB_OPENGLES2_FRAMEBUFFERBLIT_INTERFACE_1_0,
225         PPB_OpenGLES2_Shared::GetFramebufferBlitInterface(), PERMISSION_NONE);
226  AddPPB(PPB_OPENGLES2_FRAMEBUFFERMULTISAMPLE_INTERFACE_1_0,
227         PPB_OpenGLES2_Shared::GetFramebufferMultisampleInterface(),
228         PERMISSION_NONE);
229  AddPPB(PPB_OPENGLES2_CHROMIUMENABLEFEATURE_INTERFACE_1_0,
230         PPB_OpenGLES2_Shared::GetChromiumEnableFeatureInterface(),
231         PERMISSION_NONE);
232  AddPPB(PPB_OPENGLES2_CHROMIUMMAPSUB_INTERFACE_1_0,
233         PPB_OpenGLES2_Shared::GetChromiumMapSubInterface(), PERMISSION_NONE);
234  AddPPB(PPB_OPENGLES2_CHROMIUMMAPSUB_DEV_INTERFACE_1_0,
235         PPB_OpenGLES2_Shared::GetChromiumMapSubInterface(), PERMISSION_NONE);
236  AddPPB(PPB_OPENGLES2_QUERY_INTERFACE_1_0,
237         PPB_OpenGLES2_Shared::GetQueryInterface(), PERMISSION_NONE);
238  AddPPB(PPB_VAR_ARRAY_BUFFER_INTERFACE_1_0,
239         PPB_Var_Shared::GetVarArrayBufferInterface1_0(), PERMISSION_NONE);
240  AddPPB(PPB_VAR_INTERFACE_1_2,
241         PPB_Var_Shared::GetVarInterface1_2(), PERMISSION_NONE);
242  AddPPB(PPB_VAR_INTERFACE_1_1,
243         PPB_Var_Shared::GetVarInterface1_1(), PERMISSION_NONE);
244  AddPPB(PPB_VAR_INTERFACE_1_0,
245         PPB_Var_Shared::GetVarInterface1_0(), PERMISSION_NONE);
246
247#if !defined(OS_NACL)
248  // PPB (browser) interfaces.
249  // Do not add more stuff here, they should be added to interface_list*.h
250  // TODO(brettw) remove these.
251  AddProxy(API_ID_PPB_INSTANCE_PRIVATE, &ProxyFactory<PPB_Instance_Proxy>);
252  AddPPB(PPB_INSTANCE_PRIVATE_INTERFACE_0_1,
253         thunk::GetPPB_Instance_Private_0_1_Thunk(),
254         PERMISSION_PRIVATE);
255
256  AddProxy(API_ID_PPB_VAR_DEPRECATED, &ProxyFactory<PPB_Var_Deprecated_Proxy>);
257  AddPPB(PPB_VAR_DEPRECATED_INTERFACE,
258         PPB_Var_Deprecated_Proxy::GetProxyInterface(), PERMISSION_DEV);
259
260  // TODO(tomfinegan): Figure out where to put these once we refactor things
261  // to load the PPP interface struct from the PPB interface.
262  AddProxy(API_ID_PPP_CONTENT_DECRYPTOR_PRIVATE,
263           &ProxyFactory<PPP_ContentDecryptor_Private_Proxy>);
264  AddPPP(PPP_CONTENTDECRYPTOR_PRIVATE_INTERFACE,
265         PPP_ContentDecryptor_Private_Proxy::GetProxyInterface());
266#endif
267  AddProxy(API_ID_PPB_TESTING, &ProxyFactory<PPB_Testing_Proxy>);
268  AddPPB(PPB_TESTING_PRIVATE_INTERFACE,
269         PPB_Testing_Proxy::GetProxyInterface(), PERMISSION_TESTING);
270
271  // PPP (plugin) interfaces.
272  // TODO(brettw) move these to interface_list*.h
273  AddProxy(API_ID_PPP_GRAPHICS_3D, &ProxyFactory<PPP_Graphics3D_Proxy>);
274  AddPPP(PPP_GRAPHICS_3D_INTERFACE, PPP_Graphics3D_Proxy::GetProxyInterface());
275  AddProxy(API_ID_PPP_INPUT_EVENT, &ProxyFactory<PPP_InputEvent_Proxy>);
276  AddPPP(PPP_INPUT_EVENT_INTERFACE, PPP_InputEvent_Proxy::GetProxyInterface());
277  AddProxy(API_ID_PPP_INSTANCE, &ProxyFactory<PPP_Instance_Proxy>);
278#if !defined(OS_NACL)
279  AddPPP(PPP_INSTANCE_INTERFACE_1_1,
280         PPP_Instance_Proxy::GetInstanceInterface());
281  AddProxy(API_ID_PPP_INSTANCE_PRIVATE,
282           &ProxyFactory<PPP_Instance_Private_Proxy>);
283  AddPPP(PPP_INSTANCE_PRIVATE_INTERFACE,
284         PPP_Instance_Private_Proxy::GetProxyInterface());
285#endif
286  AddProxy(API_ID_PPP_MESSAGING, &ProxyFactory<PPP_Messaging_Proxy>);
287  AddPPP(PPP_MESSAGING_INTERFACE, PPP_Messaging_Proxy::GetProxyInterface());
288  AddProxy(API_ID_PPP_MOUSE_LOCK, &ProxyFactory<PPP_MouseLock_Proxy>);
289  AddPPP(PPP_MOUSELOCK_INTERFACE, PPP_MouseLock_Proxy::GetProxyInterface());
290  AddProxy(API_ID_PPP_PRINTING, &ProxyFactory<PPP_Printing_Proxy>);
291  AddPPP(PPP_PRINTING_DEV_INTERFACE, PPP_Printing_Proxy::GetProxyInterface());
292  AddProxy(API_ID_PPP_TEXT_INPUT, &ProxyFactory<PPP_TextInput_Proxy>);
293  AddPPP(PPP_TEXTINPUT_DEV_INTERFACE, PPP_TextInput_Proxy::GetProxyInterface());
294  AddProxy(API_ID_PPP_PDF, &ProxyFactory<PPP_Pdf_Proxy>);
295  AddPPP(PPP_PDF_INTERFACE, PPP_Pdf_Proxy::GetProxyInterface());
296#if !defined(OS_NACL)
297  AddProxy(API_ID_PPP_VIDEO_DECODER_DEV, &ProxyFactory<PPP_VideoDecoder_Proxy>);
298  AddPPP(PPP_VIDEODECODER_DEV_INTERFACE,
299         PPP_VideoDecoder_Proxy::GetProxyInterface());
300#endif
301}
302
303InterfaceList::~InterfaceList() {
304}
305
306// static
307InterfaceList* InterfaceList::GetInstance() {
308  return Singleton<InterfaceList>::get();
309}
310
311// static
312void InterfaceList::SetProcessGlobalPermissions(
313    const PpapiPermissions& permissions) {
314  g_process_global_permissions.Get() = permissions;
315}
316
317InterfaceProxy::Factory InterfaceList::GetFactoryForID(ApiID id) const {
318  int index = static_cast<int>(id);
319  COMPILE_ASSERT(API_ID_NONE == 0, none_must_be_zero);
320  if (id <= 0 || id >= API_ID_COUNT)
321    return NULL;
322  return id_to_factory_[index];
323}
324
325const void* InterfaceList::GetInterfaceForPPB(const std::string& name) {
326  NameToInterfaceInfoMap::iterator found =
327      name_to_browser_info_.find(name);
328  if (found == name_to_browser_info_.end())
329    return NULL;
330
331  if (g_process_global_permissions.Get().HasPermission(
332          found->second.required_permission)) {
333    // Only log interface use once per plugin.
334    if (!found->second.interface_logged) {
335      PluginGlobals::Get()->GetBrowserSender()->Send(
336          new PpapiHostMsg_LogInterfaceUsage(HashInterfaceName(name)));
337      found->second.interface_logged = true;
338    }
339    return found->second.iface;
340  }
341  return NULL;
342}
343
344const void* InterfaceList::GetInterfaceForPPP(const std::string& name) const {
345  NameToInterfaceInfoMap::const_iterator found =
346      name_to_plugin_info_.find(name);
347  if (found == name_to_plugin_info_.end())
348    return NULL;
349  return found->second.iface;
350}
351
352void InterfaceList::AddProxy(ApiID id,
353                             InterfaceProxy::Factory factory) {
354  // For interfaces with no corresponding _Proxy objects, the macros will
355  // generate calls to this function with API_ID_NONE. This means we
356  // should just skip adding a factory for these functions.
357  if (id == API_ID_NONE)
358    return;
359
360  // The factory should be an exact dupe of the one we already have if it
361  // has already been registered before.
362  int index = static_cast<int>(id);
363  DCHECK(!id_to_factory_[index] || id_to_factory_[index] == factory);
364
365  id_to_factory_[index] = factory;
366}
367
368void InterfaceList::AddPPB(const char* name,
369                           const void* iface,
370                           Permission perm) {
371  DCHECK(name_to_browser_info_.find(name) == name_to_browser_info_.end());
372  name_to_browser_info_[name] = InterfaceInfo(iface, perm);
373}
374
375void InterfaceList::AddPPP(const char* name,
376                           const void* iface) {
377  DCHECK(name_to_plugin_info_.find(name) == name_to_plugin_info_.end());
378  name_to_plugin_info_[name] = InterfaceInfo(iface, PERMISSION_NONE);
379}
380
381// static
382int InterfaceList::HashInterfaceName(const std::string& name) {
383  uint32 data = base::Hash(name.c_str(), name.size());
384  // Strip off the signed bit because UMA doesn't support negative values,
385  // but takes a signed int as input.
386  return static_cast<int>(data & 0x7fffffff);
387}
388
389}  // namespace proxy
390}  // namespace ppapi
391