content/public/browser/utility_process_host.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 #ifndef CONTENT_PUBLIC_BROWSER_UTILITY_PROCESS_HOST_H_
   6 #define CONTENT_PUBLIC_BROWSER_UTILITY_PROCESS_HOST_H_
   7
   8 #include "base/environment.h"
   9 #include "base/process/launch.h"
  10 #include "base/threading/thread.h"
  11 #include "content/common/content_export.h"
  12 #include "ipc/ipc_sender.h"
  13
  14 namespace base {
  15 class FilePath;
  16 class SequencedTaskRunner;
  17 }
  18
  19 namespace content {
  20 class ServiceRegistry;
  21 class UtilityProcessHostClient;
  22 struct ChildProcessData;
  23
  24 // This class acts as the browser-side host to a utility child process.  A
  25 // utility process is a short-lived process that is created to run a specific
  26 // task.  This class lives solely on the IO thread.
  27 // If you need a single method call in the process, use StartFooBar(p).
  28 // If you need multiple batches of work to be done in the process, use
  29 // StartBatchMode(), then multiple calls to StartFooBar(p), then finish with
  30 // EndBatchMode().
  31 // If you need to call Mojo services, use StartMojoMode() to start the child
  32 // process and GetServiceRegistry() to get the service registry to connect to
  33 // the child's Mojo services.
  34 //
  35 // Note: If your class keeps a ptr to an object of this type, grab a weak ptr to
  36 // avoid a use after free since this object is deleted synchronously but the
  37 // client notification is asynchronous.  See http://crbug.com/108871.
  38 class UtilityProcessHost : public IPC::Sender,
  39                            public base::SupportsWeakPtr<UtilityProcessHost> {
  40  public:
  41   // Used to create a utility process. |client| is optional. If supplied it will
  42   // be notified of incoming messages from the utility process.
  43   // |client_task_runner| is required if |client| is supplied and is the task
  44   // runner upon which |client| will be invoked.
  45   CONTENT_EXPORT static UtilityProcessHost* Create(
  46       const scoped_refptr<UtilityProcessHostClient>& client,
  47       const scoped_refptr<base::SequencedTaskRunner>& client_task_runner);
  48
  49   ~UtilityProcessHost() override {}
  50
  51   // Starts utility process in batch mode. Caller must call EndBatchMode()
  52   // to finish the utility process.
  53   virtual bool StartBatchMode() = 0;
  54
  55   // Ends the utility process. Must be called after StartBatchMode().
  56   virtual void EndBatchMode() = 0;
  57
  58   // Allows a directory to be opened through the sandbox, in case it's needed by
  59   // the operation.
  60   virtual void SetExposedDir(const base::FilePath& dir) = 0;
  61
  62   // Perform presandbox initialization for mDNS.
  63   virtual void EnableMDns() = 0;
  64
  65   // Make the process run without a sandbox.
  66   virtual void DisableSandbox() = 0;
  67
  68 #if defined(OS_WIN)
  69   // Make the process run elevated.
  70   virtual void ElevatePrivileges() = 0;
  71 #endif
  72
  73   // Returns information about the utility child process.
  74   virtual const ChildProcessData& GetData() = 0;
  75
  76 #if defined(OS_POSIX)
  77   virtual void SetEnv(const base::EnvironmentMap& env) = 0;
  78 #endif
  79
  80   // Starts the utility process in Mojo mode.
  81   virtual bool StartMojoMode() = 0;
  82
  83   // Returns the ServiceRegistry for this process. Will return nullptr if
  84   // the process was not started with StartMojoMode().
  85   virtual ServiceRegistry* GetServiceRegistry() = 0;
  86
  87   // Set the name of the process to appear in the task manager.
  88   virtual void SetName(const base::string16& name) = 0;
  89 };
  90
  91 };  // namespace content
  92
  93 #endif  // CONTENT_PUBLIC_BROWSER_UTILITY_PROCESS_HOST_H_