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
44class HeapDumper : public StackObj {
45 private:
46 char* _error;
47 bool _print_to_tty;
48 bool _gc_before_heap_dump;
49 bool _oome;
50 elapsedTimer _t;
51
52 HeapDumper(bool gc_before_heap_dump, bool print_to_tty, bool oome) :
53 _error(NULL), _print_to_tty(print_to_tty), _gc_before_heap_dump(gc_before_heap_dump), _oome(oome) { }
54
55 // string representation of error
56 char* error() const { return _error; }
57 void set_error(char* error);
58
59 // indicates if progress messages can be sent to tty
60 bool print_to_tty() const { return _print_to_tty; }
61
62 // internal timer.
63 elapsedTimer* timer() { return &_t; }
64
65 static void dump_heap(bool oome);
66
67 public:
68 HeapDumper(bool gc_before_heap_dump) :
69 _error(NULL), _print_to_tty(false), _gc_before_heap_dump(gc_before_heap_dump), _oome(false) { }
70
71 ~HeapDumper();
72
73 // dumps the heap to the specified file, returns 0 if success.
74 int dump(const char* path);
75
76 // returns error message (resource allocated), or NULL if no error
77 char* error_as_C_string() const;
78
79 static void dump_heap() NOT_SERVICES_RETURN;
80
81 static void dump_heap_from_oome() NOT_SERVICES_RETURN;
82};
83
84#endif // SHARE_SERVICES_HEAPDUMPER_HPP
85