Upstream version 9.38.198.0
[platform/framework/web/crosswalk.git] / src / components / nacl / common / nacl_messages.h
1 // Copyright 2013 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 // Defines messages between the browser and NaCl process.
6
7 // Multiply-included message file, no traditional include guard.
8 #include "base/process/process.h"
9 #include "components/nacl/common/nacl_types.h"
10 #include "ipc/ipc_channel_handle.h"
11 #include "ipc/ipc_message_macros.h"
12 #include "ipc/ipc_platform_file.h"
13
14 #define IPC_MESSAGE_START NaClMsgStart
15
16 IPC_STRUCT_TRAITS_BEGIN(nacl::NaClStartParams)
17   IPC_STRUCT_TRAITS_MEMBER(nexe_file)
18   IPC_STRUCT_TRAITS_MEMBER(nexe_token_lo)
19   IPC_STRUCT_TRAITS_MEMBER(nexe_token_hi)
20   IPC_STRUCT_TRAITS_MEMBER(handles)
21   IPC_STRUCT_TRAITS_MEMBER(debug_stub_server_bound_socket)
22   IPC_STRUCT_TRAITS_MEMBER(validation_cache_enabled)
23   IPC_STRUCT_TRAITS_MEMBER(validation_cache_key)
24   IPC_STRUCT_TRAITS_MEMBER(version)
25   IPC_STRUCT_TRAITS_MEMBER(enable_exception_handling)
26   IPC_STRUCT_TRAITS_MEMBER(enable_debug_stub)
27   IPC_STRUCT_TRAITS_MEMBER(enable_ipc_proxy)
28   IPC_STRUCT_TRAITS_MEMBER(uses_irt)
29   IPC_STRUCT_TRAITS_MEMBER(enable_dyncode_syscalls)
30 IPC_STRUCT_TRAITS_END()
31
32 //-----------------------------------------------------------------------------
33 // NaClProcess messages
34 // These are messages sent between the browser and the NaCl process.
35 // Tells the NaCl process to start.
36 IPC_MESSAGE_CONTROL1(NaClProcessMsg_Start,
37                      nacl::NaClStartParams /* params */)
38
39 #if defined(OS_WIN)
40 // Tells the NaCl broker to launch a NaCl loader process.
41 IPC_MESSAGE_CONTROL1(NaClProcessMsg_LaunchLoaderThroughBroker,
42                      std::string /* channel ID for the loader */)
43
44 // Notify the browser process that the loader was launched successfully.
45 IPC_MESSAGE_CONTROL2(NaClProcessMsg_LoaderLaunched,
46                      std::string,  /* channel ID for the loader */
47                      base::ProcessHandle /* loader process handle */)
48
49 // Tells the NaCl broker to attach a debug exception handler to the
50 // given NaCl loader process.
51 IPC_MESSAGE_CONTROL3(NaClProcessMsg_LaunchDebugExceptionHandler,
52                      int32 /* pid of the NaCl process */,
53                      base::ProcessHandle /* handle of the NaCl process */,
54                      std::string /* NaCl internal process layout info */)
55
56 // Notify the browser process that the broker process finished
57 // attaching a debug exception handler to the given NaCl loader
58 // process.
59 IPC_MESSAGE_CONTROL2(NaClProcessMsg_DebugExceptionHandlerLaunched,
60                      int32 /* pid */,
61                      bool /* success */)
62
63 // Notify the broker that all loader processes have been terminated and it
64 // should shutdown.
65 IPC_MESSAGE_CONTROL0(NaClProcessMsg_StopBroker)
66
67 // Used by the NaCl process to request that a Windows debug exception
68 // handler be attached to it.
69 IPC_SYNC_MESSAGE_CONTROL1_1(NaClProcessMsg_AttachDebugExceptionHandler,
70                             std::string, /* Internal process info */
71                             bool /* Result */)
72
73 // Notify the browser process that the NaCl process has bound the given
74 // TCP port number to use for the GDB debug stub.
75 IPC_MESSAGE_CONTROL1(NaClProcessHostMsg_DebugStubPortSelected,
76                      uint16_t /* debug_stub_port */)
77 #endif
78
79 // Used by the NaCl process to query a database in the browser.  The database
80 // contains the signatures of previously validated code chunks.
81 IPC_SYNC_MESSAGE_CONTROL1_1(NaClProcessMsg_QueryKnownToValidate,
82                             std::string, /* A validation signature */
83                             bool /* Can validation be skipped? */)
84
85 // Used by the NaCl process to add a validation signature to the validation
86 // database in the browser.
87 IPC_MESSAGE_CONTROL1(NaClProcessMsg_SetKnownToValidate,
88                      std::string /* A validation signature */)
89
90 // Used by the NaCl process to acquire trusted information about a file directly
91 // from the browser, including the file's path as well as a fresh version of the
92 // file handle.
93 IPC_SYNC_MESSAGE_CONTROL2_2(NaClProcessMsg_ResolveFileToken,
94                             uint64, /* file_token_lo */
95                             uint64, /* file_token_hi */
96                             IPC::PlatformFileForTransit, /* fd */
97                             base::FilePath /* Path opened to get fd */)
98
99 // Notify the browser process that the server side of the PPAPI channel was
100 // created successfully.
101 IPC_MESSAGE_CONTROL4(NaClProcessHostMsg_PpapiChannelsCreated,
102                      IPC::ChannelHandle, /* browser_channel_handle */
103                      IPC::ChannelHandle, /* ppapi_renderer_channel_handle */
104                      IPC::ChannelHandle, /* trusted_renderer_channel_handle */
105                      IPC::ChannelHandle /* manifest_service_channel_handle */)