1// Copyright (c) 2007, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14//     * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30// Author: Alfred Peng
31
32#ifndef CLIENT_SOLARIS_HANDLER_MINIDUMP_GENERATOR_H__
33#define CLIENT_SOLARIS_HANDLER_MINIDUMP_GENERATOR_H__
34
35#include <ucontext.h>
36
37#include "client/minidump_file_writer.h"
38#include "client/solaris/handler/solaris_lwp.h"
39#include "google_breakpad/common/breakpad_types.h"
40#include "google_breakpad/common/minidump_format.h"
41
42namespace google_breakpad {
43
44//
45// MinidumpGenerator
46//
47// A minidump generator should be created before any exception happen.
48//
49class MinidumpGenerator {
50  // Callback run for writing lwp information in the process.
51  friend bool LwpInformationCallback(lwpstatus_t *lsp, void *context);
52
53  // Callback run for writing module information in the process.
54  friend bool ModuleInfoCallback(const ModuleInfo &module_info, void *context);
55
56 public:
57  MinidumpGenerator();
58
59  ~MinidumpGenerator();
60
61  // Write minidump.
62  bool WriteMinidumpToFile(const char *file_pathname,
63                           int signo,
64                           uintptr_t sighandler_ebp,
65                           ucontext_t **sig_ctx) const;
66};
67
68}  // namespace google_breakpad
69
70#endif   // CLIENT_SOLARIS_HANDLER_MINIDUMP_GENERATOR_H_
71