1// Copyright (c) 2014, 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#ifndef CLIENT_LINUX_MINIDUMP_WRITER_MICRODUMP_WRITER_H_
31#define CLIENT_LINUX_MINIDUMP_WRITER_MICRODUMP_WRITER_H_
32
33#include <stdint.h>
34#include <sys/types.h>
35
36#include "client/linux/dump_writer_common/mapping_info.h"
37
38namespace google_breakpad {
39
40struct MicrodumpExtraInfo;
41
42// Writes a microdump (a reduced dump containing only the state of the crashing
43// thread) on the console (logcat on Android). These functions do not malloc nor
44// use libc functions which may. Thus, it can be used in contexts where the
45// state of the heap may be corrupt.
46// Args:
47// crashing_process: the pid of the crashing process. This must be trusted.
48// blob: a blob of data from the crashing process. See exception_handler.h
49// blob_size: the length of |blob| in bytes.
50// mappings: a list of additional mappings provided by the application.
51// build_fingerprint: a (optional) C string which determines the OS
52// build fingerprint (e.g., aosp/occam/mako:5.1.1/LMY47W/1234:eng/dev-keys).
53// product_info: a (optional) C string which determines the product name and
54// version (e.g., WebView:42.0.2311.136).
55//
56// Returns true iff successful.
57bool WriteMicrodump(pid_t crashing_process,
58 const void* blob,
59 size_t blob_size,
60 const MappingList& mappings,
61 bool skip_dump_if_main_module_not_referenced,
62 uintptr_t address_within_main_module,
63 bool sanitize_stack,
64 const MicrodumpExtraInfo& microdump_extra_info);
65
66} // namespace google_breakpad
67
68#endif // CLIENT_LINUX_MINIDUMP_WRITER_MICRODUMP_WRITER_H_
69