1 /* 2 * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef SHARE_SERVICES_HEAPDUMPER_HPP 26 #define SHARE_SERVICES_HEAPDUMPER_HPP 27 28 #include "memory/allocation.hpp" 29 #include "oops/oop.hpp" 30 #include "runtime/os.hpp" 31 32 // HeapDumper is used to dump the java heap to file in HPROF binary format: 33 // 34 // { HeapDumper dumper(true /* full GC before heap dump */); 35 // if (dumper.dump("/export/java.hprof")) { 36 // ResourceMark rm; 37 // tty->print_cr("Dump failed: %s", dumper.error_as_C_string()); 38 // } else { 39 // // dump succeeded 40 // } 41 // } 42 // 43 44 class outputStream; 45 46 class HeapDumper : public StackObj { 47 private: 48 char* _error; 49 bool _gc_before_heap_dump; 50 bool _oome; 51 elapsedTimer _t; 52 53 HeapDumper(bool gc_before_heap_dump, bool oome) : 54 _error(NULL), _gc_before_heap_dump(gc_before_heap_dump), _oome(oome) { } 55 56 // string representation of error 57 char* error() const { return _error; } 58 void set_error(char* error); 59 60 // internal timer. 61 elapsedTimer* timer() { return &_t; } 62 63 static void dump_heap(bool oome); 64 65 public: 66 HeapDumper(bool gc_before_heap_dump) : 67 _error(NULL), _gc_before_heap_dump(gc_before_heap_dump), _oome(false) { } 68 69 ~HeapDumper(); 70 71 // dumps the heap to the specified file, returns 0 if success. 72 // additional info is written to out if not NULL. 73 int dump(const char* path, outputStream* out = NULL); 74 75 // returns error message (resource allocated), or NULL if no error 76 char* error_as_C_string() const; 77 78 static void dump_heap() NOT_SERVICES_RETURN; 79 80 static void dump_heap_from_oome() NOT_SERVICES_RETURN; 81 }; 82 83 #endif // SHARE_SERVICES_HEAPDUMPER_HPP