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