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