1    :  // Copyright 2014 Google Inc. All Rights Reserved.
   2    :  //
   3    :  // Licensed under the Apache License, Version 2.0 (the "License");
   4    :  // you may not use this file except in compliance with the License.
   5    :  // You may obtain a copy of the License at
   6    :  //
   7    :  //     http://www.apache.org/licenses/LICENSE-2.0
   8    :  //
   9    :  // Unless required by applicable law or agreed to in writing, software
  10    :  // distributed under the License is distributed on an "AS IS" BASIS,
  11    :  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    :  // See the License for the specific language governing permissions and
  13    :  // limitations under the License.
  14    :  
  15    :  #ifndef SYZYGY_KASKO_MINIDUMP_H_
  16    :  #define SYZYGY_KASKO_MINIDUMP_H_
  17    :  
  18    :  #include <vector>
  19    :  
  20    :  #include "base/process/process_handle.h"
  21    :  #include "base/threading/platform_thread.h"
  22    :  #include "syzygy/kasko/minidump_type.h"
  23    :  
  24  m :  namespace base {
  25  m :  class FilePath;
  26  m :  }  // namespace base
  27    :  
  28  m :  namespace kasko {
  29    :  
  30    :  // Represents a custom stream to be included in the generated minidump.
  31  m :  struct CustomStream {
  32  m :    uint32_t type;
  33  m :    const void* data;
  34  m :    size_t length;
  35  m :  };
  36    :  
  37    :  // Generates a minidump.
  38    :  // @param destination The path where the dump should be generated.
  39    :  // @param target_process The ID of the process whose dump should be captured.
  40    :  // @param thread_id The thread that threw the exception, or 0 in the absence of
  41    :  //     an exception.
  42    :  // @param client_exception_pointers The optional address of an
  43    :  //     EXCEPTION_POINTERS structure in the target process memory space.
  44    :  // @param minidump_type The type of minidump to be included in the report.
  45    :  // @param custom_streams A vector of extra streams to include in the minidump.
  46    :  // @returns true if the operation is successful.
  47  m :  bool GenerateMinidump(const base::FilePath& destination,
  48  m :                        base::ProcessId target_process,
  49  m :                        base::PlatformThreadId thread_id,
  50  m :                        unsigned long client_exception_pointers,
  51  m :                        MinidumpType minidump_type,
  52  m :                        const std::vector<CustomStream>& custom_streams);
  53    :  
  54  m :  }  // namespace kasko
  55    :  
  56    :  #endif  // SYZYGY_KASKO_MINIDUMP_H_