components/nacl/common/nacl_host_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 // Multiply-included file, no traditional include guard.
   6
   7 #include <string>
   8
   9 #include "base/basictypes.h"
  10 #include "base/process/process.h"
  11 #include "build/build_config.h"
  12 #include "components/nacl/common/nacl_types.h"
  13 #include "components/nacl/common/nacl_types_param_traits.h"
  14 #include "components/nacl/common/pnacl_types.h"
  15 #include "content/public/common/common_param_traits.h"
  16 #include "ipc/ipc_channel_handle.h"
  17 #include "ipc/ipc_message_macros.h"
  18 #include "ipc/ipc_platform_file.h"
  19 #include "url/gurl.h"
  20
  21 #define IPC_MESSAGE_START NaClHostMsgStart
  22
  23 IPC_STRUCT_TRAITS_BEGIN(nacl::NaClLaunchParams)
  24   IPC_STRUCT_TRAITS_MEMBER(manifest_url)
  25   IPC_STRUCT_TRAITS_MEMBER(nexe_file)
  26   IPC_STRUCT_TRAITS_MEMBER(nexe_token_lo)
  27   IPC_STRUCT_TRAITS_MEMBER(nexe_token_hi)
  28   IPC_STRUCT_TRAITS_MEMBER(render_view_id)
  29   IPC_STRUCT_TRAITS_MEMBER(permission_bits)
  30   IPC_STRUCT_TRAITS_MEMBER(uses_nonsfi_mode)
  31   IPC_STRUCT_TRAITS_MEMBER(process_type)
  32 IPC_STRUCT_TRAITS_END()
  33
  34 IPC_STRUCT_TRAITS_BEGIN(nacl::NaClLaunchResult)
  35   IPC_STRUCT_TRAITS_MEMBER(imc_channel_handle)
  36   IPC_STRUCT_TRAITS_MEMBER(ppapi_ipc_channel_handle)
  37   IPC_STRUCT_TRAITS_MEMBER(trusted_ipc_channel_handle)
  38   IPC_STRUCT_TRAITS_MEMBER(manifest_service_ipc_channel_handle)
  39   IPC_STRUCT_TRAITS_MEMBER(plugin_pid)
  40   IPC_STRUCT_TRAITS_MEMBER(plugin_child_id)
  41   IPC_STRUCT_TRAITS_MEMBER(crash_info_shmem_handle)
  42 IPC_STRUCT_TRAITS_END()
  43
  44 IPC_STRUCT_TRAITS_BEGIN(nacl::PnaclCacheInfo)
  45   IPC_STRUCT_TRAITS_MEMBER(pexe_url)
  46   IPC_STRUCT_TRAITS_MEMBER(abi_version)
  47   IPC_STRUCT_TRAITS_MEMBER(opt_level)
  48   IPC_STRUCT_TRAITS_MEMBER(last_modified)
  49   IPC_STRUCT_TRAITS_MEMBER(etag)
  50   IPC_STRUCT_TRAITS_MEMBER(has_no_store_header)
  51   IPC_STRUCT_TRAITS_MEMBER(sandbox_isa)
  52   IPC_STRUCT_TRAITS_MEMBER(extra_flags)
  53 IPC_STRUCT_TRAITS_END()
  54
  55 // A renderer sends this to the browser process when it wants to start
  56 // a new instance of the Native Client process. The browser will launch
  57 // the process and return an IPC channel handle. This handle will only
  58 // be valid if the NaCl IPC proxy is enabled.
  59 IPC_SYNC_MESSAGE_CONTROL1_2(NaClHostMsg_LaunchNaCl,
  60                             nacl::NaClLaunchParams /* launch_params */,
  61                             nacl::NaClLaunchResult /* launch_result */,
  62                             std::string /* error_message */)
  63
  64 // A renderer sends this to the browser process when it wants to
  65 // open a file for from the Pnacl component directory.
  66 IPC_SYNC_MESSAGE_CONTROL2_3(NaClHostMsg_GetReadonlyPnaclFD,
  67                             std::string /* name of requested PNaCl file */,
  68                             bool /* is_executable */,
  69                             IPC::PlatformFileForTransit /* output file */,
  70                             uint64_t /* file_token_lo */,
  71                             uint64_t /* file_token_hi */)
  72
  73 // A renderer sends this to the browser process when it wants to
  74 // create a temporary file.
  75 IPC_SYNC_MESSAGE_CONTROL0_1(NaClHostMsg_NaClCreateTemporaryFile,
  76                             IPC::PlatformFileForTransit /* out file */)
  77
  78 // A renderer sends this to the browser to request a file descriptor for
  79 // a translated nexe.
  80 IPC_MESSAGE_CONTROL3(NaClHostMsg_NexeTempFileRequest,
  81                      int /* render_view_id */,
  82                      int /* instance */,
  83                      nacl::PnaclCacheInfo /* cache info */)
  84
  85 // The browser replies to a renderer's temp file request with output_file,
  86 // which is either a writeable temp file to use for translation, or a
  87 // read-only file containing the translated nexe from the cache.
  88 IPC_MESSAGE_CONTROL3(NaClViewMsg_NexeTempFileReply,
  89                      int /* instance */,
  90                      bool /* is_cache_hit */,
  91                      IPC::PlatformFileForTransit /* output file */)
  92
  93 // A renderer sends this to the browser to report that its translation has
  94 // finished and its temp file contains the translated nexe.
  95 IPC_MESSAGE_CONTROL2(NaClHostMsg_ReportTranslationFinished,
  96                      int /* instance */,
  97                      bool /* success */)
  98
  99 // A renderer sends this to the browser process to report when the client
 100 // architecture is not listed in the manifest.
 101 IPC_MESSAGE_CONTROL1(NaClHostMsg_MissingArchError,
 102                      int /* render_view_id */)
 103
 104 // A renderer sends this to the browser process when it wants to
 105 // open a NaCl executable file from an installed application directory.
 106 IPC_SYNC_MESSAGE_CONTROL2_3(NaClHostMsg_OpenNaClExecutable,
 107                             int /* render_view_id */,
 108                             GURL /* URL of NaCl executable file */,
 109                             IPC::PlatformFileForTransit /* output file */,
 110                             uint64 /* file_token_lo */,
 111                             uint64 /* file_token_hi */)
 112
 113 // A renderer sends this to the browser process to determine how many
 114 // processors are online.
 115 IPC_SYNC_MESSAGE_CONTROL0_1(NaClHostMsg_NaClGetNumProcessors,
 116                             int /* Number of processors */)
 117
 118 // A renderer sends this to the browser process to determine if the
 119 // NaCl application started from the given NMF URL will be debugged.
 120 // If not (filtered out by commandline flags), it sets should_debug to false.
 121 IPC_SYNC_MESSAGE_CONTROL1_1(NaClHostMsg_NaClDebugEnabledForURL,
 122                             GURL /* alleged URL of NMF file */,
 123                             bool /* should debug */)