xref: /aosp_15_r20/external/google-breakpad/src/client/linux/crash_generation/crash_generation_client.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2010 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 #ifndef CLIENT_LINUX_CRASH_GENERATION_CRASH_GENERATION_CLIENT_H_
30 #define CLIENT_LINUX_CRASH_GENERATION_CRASH_GENERATION_CLIENT_H_
31 
32 #include <stddef.h>
33 
34 namespace google_breakpad {
35 
36 // CrashGenerationClient is an interface for implementing out-of-process crash
37 // dumping.  The default implementation, accessed via the TryCreate() factory,
38 // works in conjunction with the CrashGenerationServer to generate a minidump
39 // via a remote process.
40 class CrashGenerationClient {
41  public:
42   CrashGenerationClient() = default;
43   CrashGenerationClient(const CrashGenerationClient&) = delete;
44   void operator=(const CrashGenerationClient&) = delete;
45   virtual ~CrashGenerationClient() = default;
46 
47   // Request the crash server to generate a dump.  |blob| is an opaque
48   // CrashContext pointer from exception_handler.h.
49   // Returns true if the dump was successful; false otherwise.
50   virtual bool RequestDump(const void* blob, size_t blob_size) = 0;
51 
52   // Returns a new CrashGenerationClient if |server_fd| is valid and
53   // connects to a CrashGenerationServer.  Otherwise, return NULL.
54   // The returned CrashGenerationClient* is owned by the caller of
55   // this function.
56   static CrashGenerationClient* TryCreate(int server_fd);
57 };
58 
59 }  // namespace google_breakpad
60 
61 #endif  // CLIENT_LINUX_CRASH_GENERATION_CRASH_GENERATION_CLIENT_H_
62