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