src/components/nacl/common/nacl_types.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 #ifndef COMPONENTS_NACL_COMMON_NACL_TYPES_H_
   6 #define COMPONENTS_NACL_COMMON_NACL_TYPES_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/process/process_handle.h"
  13 #include "build/build_config.h"
  14 #include "ipc/ipc_channel.h"
  15
  16 #if defined(OS_POSIX)
  17 #include "base/file_descriptor_posix.h"
  18 #endif
  19
  20 #if defined(OS_WIN)
  21 #include <windows.h>   // for HANDLE
  22 #endif
  23
  24 // TODO(gregoryd): add a Windows definition for base::FileDescriptor
  25 namespace nacl {
  26
  27 #if defined(OS_WIN)
  28 typedef HANDLE FileDescriptor;
  29 inline HANDLE ToNativeHandle(const FileDescriptor& desc) {
  30   return desc;
  31 }
  32 #elif defined(OS_POSIX)
  33 typedef base::FileDescriptor FileDescriptor;
  34 inline int ToNativeHandle(const FileDescriptor& desc) {
  35   return desc.fd;
  36 }
  37 #endif
  38
  39
  40 // Parameters sent to the NaCl process when we start it.
  41 struct NaClStartParams {
  42   NaClStartParams();
  43   ~NaClStartParams();
  44
  45   std::vector<FileDescriptor> handles;
  46   FileDescriptor debug_stub_server_bound_socket;
  47
  48   bool validation_cache_enabled;
  49   std::string validation_cache_key;
  50   // Chrome version string. Sending the version string over IPC avoids linkage
  51   // issues in cases where NaCl is not compiled into the main Chromium
  52   // executable or DLL.
  53   std::string version;
  54
  55   bool enable_exception_handling;
  56   bool enable_debug_stub;
  57   bool enable_ipc_proxy;
  58   bool uses_irt;
  59   bool enable_dyncode_syscalls;
  60   // NOTE: Any new fields added here must also be added to the IPC
  61   // serialization in nacl_messages.h and (for POD fields) the constructor
  62   // in nacl_types.cc.
  63 };
  64
  65 // Parameters sent to the browser process to have it launch a NaCl process.
  66 //
  67 // If you change this, you will also need to update the IPC serialization in
  68 // nacl_host_messages.h.
  69 struct NaClLaunchParams {
  70   NaClLaunchParams();
  71   NaClLaunchParams(const std::string& u, int r, uint32 p,
  72                    bool uses_irt,
  73                    bool uses_nonsfi_mode,
  74                    bool enable_dyncode_syscalls,
  75                    bool enable_exception_handling,
  76                    bool enable_crash_throttling);
  77   NaClLaunchParams(const NaClLaunchParams& l);
  78   ~NaClLaunchParams();
  79
  80   std::string manifest_url;
  81   int render_view_id;
  82   uint32 permission_bits;
  83   bool uses_irt;
  84   bool uses_nonsfi_mode;
  85   bool enable_dyncode_syscalls;
  86   bool enable_exception_handling;
  87   bool enable_crash_throttling;
  88 };
  89
  90 struct NaClLaunchResult {
  91   NaClLaunchResult();
  92   NaClLaunchResult(
  93       FileDescriptor imc_channel_handle,
  94       const IPC::ChannelHandle& ppapi_ipc_channel_handle,
  95       const IPC::ChannelHandle& trusted_ipc_channel_handle,
  96       const IPC::ChannelHandle& manifest_service_ipc_channel_handle,
  97       base::ProcessId plugin_pid,
  98       int plugin_child_id);
  99   ~NaClLaunchResult();
 100
 101   // For plugin loader <-> renderer IMC communication.
 102   FileDescriptor imc_channel_handle;
 103
 104   // For plugin <-> renderer PPAPI communication.
 105   IPC::ChannelHandle ppapi_ipc_channel_handle;
 106
 107   // For plugin loader <-> renderer control communication (loading and
 108   // starting nexe).
 109   IPC::ChannelHandle trusted_ipc_channel_handle;
 110
 111   // For plugin <-> renderer ManifestService communication.
 112   IPC::ChannelHandle manifest_service_ipc_channel_handle;
 113
 114   base::ProcessId plugin_pid;
 115   int plugin_child_id;
 116 };
 117
 118 }  // namespace nacl
 119
 120 #endif  // COMPONENTS_NACL_COMMON_NACL_TYPES_H_