chrome/browser/crash_handler_host_linux.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 CHROME_BROWSER_CRASH_HANDLER_HOST_LINUX_H_
   6 #define CHROME_BROWSER_CRASH_HANDLER_HOST_LINUX_H_
   7
   8 #include <sys/types.h>
   9
  10 #include <string>
  11
  12 #include "base/compiler_specific.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/message_loop/message_loop.h"
  15
  16 struct BreakpadInfo;
  17
  18 namespace base {
  19 class Thread;
  20 }
  21
  22 template <typename T> struct DefaultSingletonTraits;
  23
  24 // This is the base class for singleton objects which crash dump renderers and
  25 // plugins on Linux or Android. We perform the crash dump from the browser
  26 // because it allows us to be outside the sandbox.
  27 //
  28 // PluginCrashHandlerHostLinux and RendererCrashHandlerHostLinux are
  29 // singletons that handle plugin and renderer crashes, respectively.
  30 //
  31 // Processes signal that they need to be dumped by sending a datagram over a
  32 // UNIX domain socket. All processes of the same type share the client end of
  33 // this socket which is installed in their descriptor table before exec.
  34 class CrashHandlerHostLinux : public base::MessageLoopForIO::Watcher,
  35                               public base::MessageLoop::DestructionObserver {
  36  public:
  37   // Get the file descriptor which processes should be given in order to signal
  38   // crashes to the browser.
  39   int GetDeathSignalSocket() const {
  40     return process_socket_;
  41   }
  42
  43   // MessagePumbLibevent::Watcher impl:
  44   virtual void OnFileCanWriteWithoutBlocking(int fd) OVERRIDE;
  45   virtual void OnFileCanReadWithoutBlocking(int fd) OVERRIDE;
  46
  47   // MessageLoop::DestructionObserver impl:
  48   virtual void WillDestroyCurrentMessageLoop() OVERRIDE;
  49
  50   // Whether we are shutting down or not.
  51   bool IsShuttingDown() const;
  52
  53  protected:
  54   CrashHandlerHostLinux();
  55   virtual ~CrashHandlerHostLinux();
  56
  57   // Only called in concrete subclasses.
  58   void InitCrashUploaderThread();
  59
  60   std::string process_type_;
  61
  62  private:
  63   void Init();
  64
  65   // This is here on purpose to make CrashHandlerHostLinux abstract.
  66   virtual void SetProcessType() = 0;
  67
  68   // Do work on the FILE thread for OnFileCanReadWithoutBlocking().
  69   void WriteDumpFile(BreakpadInfo* info,
  70                      pid_t crashing_pid,
  71                      char* crash_context,
  72                      int signal_fd);
  73
  74   // Continue OnFileCanReadWithoutBlocking()'s work on the IO thread.
  75   void QueueCrashDumpTask(BreakpadInfo* info, int signal_fd);
  76
  77   int process_socket_;
  78   int browser_socket_;
  79
  80   base::MessageLoopForIO::FileDescriptorWatcher file_descriptor_watcher_;
  81   scoped_ptr<base::Thread> uploader_thread_;
  82   bool shutting_down_;
  83
  84 #if defined(ADDRESS_SANITIZER)
  85   char* asan_report_str_;
  86 #endif
  87
  88   DISALLOW_COPY_AND_ASSIGN(CrashHandlerHostLinux);
  89 };
  90
  91 class ExtensionCrashHandlerHostLinux : public CrashHandlerHostLinux {
  92  public:
  93   // Returns the singleton instance.
  94   static ExtensionCrashHandlerHostLinux* GetInstance();
  95
  96  private:
  97   friend struct DefaultSingletonTraits<ExtensionCrashHandlerHostLinux>;
  98   ExtensionCrashHandlerHostLinux();
  99   virtual ~ExtensionCrashHandlerHostLinux();
 100
 101   virtual void SetProcessType() OVERRIDE;
 102
 103   DISALLOW_COPY_AND_ASSIGN(ExtensionCrashHandlerHostLinux);
 104 };
 105
 106 class GpuCrashHandlerHostLinux : public CrashHandlerHostLinux {
 107  public:
 108   // Returns the singleton instance.
 109   static GpuCrashHandlerHostLinux* GetInstance();
 110
 111  private:
 112   friend struct DefaultSingletonTraits<GpuCrashHandlerHostLinux>;
 113   GpuCrashHandlerHostLinux();
 114   virtual ~GpuCrashHandlerHostLinux();
 115
 116   virtual void SetProcessType() OVERRIDE;
 117
 118   DISALLOW_COPY_AND_ASSIGN(GpuCrashHandlerHostLinux);
 119 };
 120
 121 class PluginCrashHandlerHostLinux : public CrashHandlerHostLinux {
 122  public:
 123   // Returns the singleton instance.
 124   static PluginCrashHandlerHostLinux* GetInstance();
 125
 126  private:
 127   friend struct DefaultSingletonTraits<PluginCrashHandlerHostLinux>;
 128   PluginCrashHandlerHostLinux();
 129   virtual ~PluginCrashHandlerHostLinux();
 130
 131   virtual void SetProcessType() OVERRIDE;
 132
 133   DISALLOW_COPY_AND_ASSIGN(PluginCrashHandlerHostLinux);
 134 };
 135
 136 class PpapiCrashHandlerHostLinux : public CrashHandlerHostLinux {
 137  public:
 138   // Returns the singleton instance.
 139   static PpapiCrashHandlerHostLinux* GetInstance();
 140
 141  private:
 142   friend struct DefaultSingletonTraits<PpapiCrashHandlerHostLinux>;
 143   PpapiCrashHandlerHostLinux();
 144   virtual ~PpapiCrashHandlerHostLinux();
 145
 146   virtual void SetProcessType() OVERRIDE;
 147
 148   DISALLOW_COPY_AND_ASSIGN(PpapiCrashHandlerHostLinux);
 149 };
 150
 151 class RendererCrashHandlerHostLinux : public CrashHandlerHostLinux {
 152  public:
 153   // Returns the singleton instance.
 154   static RendererCrashHandlerHostLinux* GetInstance();
 155
 156  private:
 157   friend struct DefaultSingletonTraits<RendererCrashHandlerHostLinux>;
 158   RendererCrashHandlerHostLinux();
 159   virtual ~RendererCrashHandlerHostLinux();
 160
 161   virtual void SetProcessType() OVERRIDE;
 162
 163   DISALLOW_COPY_AND_ASSIGN(RendererCrashHandlerHostLinux);
 164 };
 165
 166 #endif  // CHROME_BROWSER_CRASH_HANDLER_HOST_LINUX_H_