components/nacl/renderer/plugin/nacl_subprocess.h

   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 // Instances of NaCl modules spun up within the plugin as a subprocess.
   6 // This may represent the "main" nacl module, or it may represent helpers
   7 // that perform various tasks within the plugin, for example,
   8 // a NaCl module for a compiler could be loaded to translate LLVM bitcode
   9 // into native code.
  10
  11 #ifndef COMPONENTS_NACL_RENDERER_PLUGIN_NACL_SUBPROCESS_H_
  12 #define COMPONENTS_NACL_RENDERER_PLUGIN_NACL_SUBPROCESS_H_
  13
  14 #include <stdarg.h>
  15
  16 #include "components/nacl/renderer/plugin/service_runtime.h"
  17 #include "components/nacl/renderer/plugin/srpc_client.h"
  18 #include "native_client/src/include/nacl_macros.h"
  19 #include "native_client/src/include/portability.h"
  20
  21 namespace plugin {
  22
  23 class Plugin;
  24 class ServiceRuntime;
  25 class SrpcParams;
  26
  27
  28 // A class representing an instance of a NaCl module, loaded by the plugin.
  29 class NaClSubprocess {
  30  public:
  31   NaClSubprocess(const std::string& description,
  32                  ServiceRuntime* service_runtime,
  33                  SrpcClient* srpc_client);
  34   virtual ~NaClSubprocess();
  35
  36   ServiceRuntime* service_runtime() const { return service_runtime_.get(); }
  37   void set_service_runtime(ServiceRuntime* service_runtime) {
  38     service_runtime_.reset(service_runtime);
  39   }
  40
  41   // The socket used for communicating w/ the NaCl module.
  42   SrpcClient* srpc_client() const { return srpc_client_.get(); }
  43
  44   // A basic description of the subprocess.
  45   std::string description() const { return description_; }
  46
  47   // A detailed description of the subprocess that may contain addresses.
  48   // Only use for debugging, but do not expose this to untrusted webapps.
  49   std::string detailed_description() const;
  50
  51   // Start up interfaces.
  52   bool StartSrpcServices();
  53
  54   // Invoke an Srpc Method.  |out_params| must be allocated and cleaned up
  55   // outside of this function, but it will be initialized by this function, and
  56   // on success any out-params (if any) will be placed in |out_params|.
  57   // Input types must be listed in |input_signature|, with the actual
  58   // arguments passed in as var-args.  Returns |true| on success.
  59   bool InvokeSrpcMethod(const std::string& method_name,
  60                         const std::string& input_signature,
  61                         SrpcParams* out_params,
  62                         ...);
  63
  64   // Fully shut down the subprocess.
  65   void Shutdown();
  66
  67  private:
  68   NACL_DISALLOW_COPY_AND_ASSIGN(NaClSubprocess);
  69
  70   bool VInvokeSrpcMethod(const std::string& method_name,
  71                          const std::string& signature,
  72                          SrpcParams* params,
  73                          va_list vl);
  74
  75   std::string description_;
  76
  77   // The service runtime representing the NaCl module instance.
  78   nacl::scoped_ptr<ServiceRuntime> service_runtime_;
  79   // Ownership of srpc_client taken from the service runtime.
  80   nacl::scoped_ptr<SrpcClient> srpc_client_;
  81 };
  82
  83 }  // namespace plugin
  84
  85 #endif  // COMPONENTS_NACL_RENDERER_PLUGIN_NACL_SUBPROCESS_H_