Mac: Add support for in-process crash reporting

client/mac/Framework/Breakpad.mm

 // Copyright (c) 2006, Google Inc.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
 //
 //     * Redistributions of source code must retain the above copyright
 // notice, this list of conditions and the following disclaimer.
 //     * Redistributions in binary form must reproduce the above
@@ skipping 26 matching lines @@
 #import <Foundation/Foundation.h>
 #include <pthread.h>
 #include <sys/stat.h>
 #include <sys/sysctl.h>
 
 #import "client/mac/crash_generation/Inspector.h"
 #import "client/mac/handler/exception_handler.h"
 #import "client/mac/Framework/Breakpad.h"
 #import "client/mac/Framework/OnDemandServer.h"
 #import "client/mac/handler/protected_memory_allocator.h"
+#include "common/mac/launch_reporter.h"
 #import "common/mac/MachIPC.h"
 #import "common/simple_string_dictionary.h"
 
 #ifndef __EXCEPTIONS
 // This file uses C++ try/catch (but shouldn't). Duplicate the macros from
 // <c++/4.2.1/exception_defines.h> allowing this file to work properly with
 // exceptions disabled even when other C++ libraries are used. #undef the try
 // and catch macros first in case libstdc++ is in use and has already provided
 // its own definitions.
 #undef try
@@ skipping 109 matching lines @@
   Breakpad()
     : handler_(NULL),
       config_params_(NULL),
       send_and_exit_(true),
       filter_callback_(NULL),
       filter_callback_context_(NULL) {
     inspector_path_[0] = 0;
   }
 
   bool Initialize(NSDictionary *parameters);
+  bool InitializeInProcess(NSDictionary *parameters);
+  bool InitializeOutOfProcess(NSDictionary *parameters);
 
   bool ExtractParameters(NSDictionary *parameters);
 
   // Dispatches to HandleException()
   static bool ExceptionHandlerDirectCallback(void *context,
                                              int exception_type,
                                              int exception_code,
                                              int exception_subcode,
                                              mach_port_t crashing_thread);
 
   bool HandleException(int exception_type,
                        int exception_code,
                        int exception_subcode,
                        mach_port_t crashing_thread);
 
+  // Dispatches to HandleMinidump().
+  // This gets called instead of ExceptionHandlerDirectCallback when running
+  // with the BREAKPAD_IN_PROCESS option.
+  static bool HandleMinidumpCallback(const char *dump_dir,
+                                     const char *minidump_id,
+                                     void *context, bool succeeded);

[Mark Mentovai, 2014/09/15 13:38:44]

If you have to break parameters up to take more than one line, you should put
each parameter on its own line, otherwise the last two melt into one another.

[Andre, 2014/09/15 17:42:39]

Done.

+
+  bool HandleMinidump(const char *dump_dir,

[Mark Mentovai, 2014/09/15 13:38:44]

This should also have a comment explaining that it’s only used with
BREAKPAD_IN_PROCESS.

It might be better to name it more descriptively, like
WriteMinidumpInProcessAndLaunchReporter().

[Andre, 2014/09/15 17:42:39]

Done.
This method does not actually write the minidump file (the minidump was already
written by
ExceptionHandler before this callback in invoked), so WriteMinidump may not be a
good name.
I'm leaning towards keeping the name HandleMinidump (and it matches iOS
breakpad), WDYT?

+                      const char *minidump_id);

[Mark Mentovai, 2014/09/15 13:38:44]

Nit (may be irrelevant if the method is renamed): it doesn’t look like you
actually needed to put this one on its own line at all.

[Andre, 2014/09/15 17:42:39]

Done.

+
   // Since ExceptionHandler (w/o namespace) is defined as typedef in OSX's
   // MachineExceptions.h, we have to explicitly name the handler.
   google_breakpad::ExceptionHandler *handler_; // The actual handler (STRONG)
 
   char                    inspector_path_[PATH_MAX];  // Path to inspector tool
 
   SimpleStringDictionary  *config_params_; // Create parameters (STRONG)
 
   OnDemandServer          inspector_;
 
@@ skipping 58 matching lines @@
   if (!breakpad)
     return false;
 
   return breakpad->HandleException( exception_type,
                                     exception_code,
                                     exception_subcode,
                                     crashing_thread);
 }
 
 //=============================================================================
+bool Breakpad::HandleMinidumpCallback(const char *dump_dir,
+                                      const char *minidump_id,
+                                      void *context, bool succeeded) {

[Mark Mentovai, 2014/09/15 13:38:44]

As above.

[Andre, 2014/09/15 17:42:39]

Done.

+  Breakpad *breakpad = (Breakpad *)context;
+
+  // If our context is damaged or something, just return false to indicate that
+  // the handler should continue without us.
+  if (!breakpad || !succeeded)
+    return false;
+
+  return breakpad->HandleMinidump(dump_dir, minidump_id);
+}
+
+//=============================================================================
 #pragma mark -
 
 #include <dlfcn.h>
 
 //=============================================================================
 // Returns the pathname to the Resources directory for this version of
 // Breakpad which we are now running.
 //
 // Don't make the function static, since _dyld_lookup_and_bind_fully needs a
 // simple non-static C name
@@ skipping 40 matching lines @@
   // Check for debugger
   if (IsDebuggerActive()) {
     return true;
   }
 
   // Gather any user specified parameters
   if (!ExtractParameters(parameters)) {
     return false;
   }
 
+  if ([[parameters objectForKey:@BREAKPAD_IN_PROCESS] boolValue])
+    return InitializeInProcess(parameters);
+  else
+    return InitializeOutOfProcess(parameters);
+}
+
+//=============================================================================
+bool Breakpad::InitializeInProcess(NSDictionary* parameters) {
+  handler_ =
+      new (gBreakpadAllocator->Allocate(
+          sizeof(google_breakpad::ExceptionHandler)))
+          google_breakpad::ExceptionHandler(
+              config_params_->GetValueForKey(BREAKPAD_DUMP_DIRECTORY),
+              0, &HandleMinidumpCallback, this, true, 0);
+  return true;    
+}
+
+//=============================================================================
+bool Breakpad::InitializeOutOfProcess(NSDictionary* parameters) {
   // Get path to Inspector executable.
   NSString *inspectorPathString = KeyValue(@BREAKPAD_INSPECTOR_LOCATION);
 
   // Standardize path (resolve symlinkes, etc.)  and escape spaces
   inspectorPathString = [inspectorPathString stringByStandardizingPath];
   inspectorPathString = [[inspectorPathString componentsSeparatedByString:@" "]
                                               componentsJoinedByString:@"\\ "];
 
   // Create an on-demand server object representing the Inspector.
   // In case of a crash, we simply need to call the LaunchOnDemand()
@@ skipping 365 matching lines @@
 #endif
 
   // If we don't want any forwarding, return true here to indicate that we've
   // processed things as much as we want.
   if (send_and_exit_) return true;
 
   return false;
 }
 
 //=============================================================================
+bool Breakpad::HandleMinidump(const char *dump_dir,
+                              const char *minidump_id) {
+  google_breakpad::ConfigFile config_file;
+  config_file.WriteFile(dump_dir, config_params_, dump_dir, minidump_id);
+  google_breakpad::LaunchReporter(
+      config_params_->GetValueForKey(BREAKPAD_REPORTER_EXE_LOCATION),
+      config_file.GetFilePath());
+  return true;
+}
+
+//=============================================================================
 //=============================================================================
 
 #pragma mark -
 #pragma mark Public API
 
 //=============================================================================
 BreakpadRef BreakpadCreate(NSDictionary *parameters) {
   try {
     // This is confusing.  Our two main allocators for breakpad memory are:
     //    - gKeyValueAllocator for the key/value memory
@@ skipping 252 matching lines @@
     }
     logFileCounter++;
     logFileKey = [NSString stringWithFormat:@"%@%d",
                            @BREAKPAD_LOGFILE_KEY_PREFIX,
                            logFileCounter];
     existingLogFilename = BreakpadKeyValue(ref, logFileKey);
   }
 
   BreakpadSetKeyValue(ref, logFileKey, logPathname);
 }