src/share/vm/services/heapDumper.hpp

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 435
a61af66fc99e
child 1050
c6c601a0f2d6
permissions
-rw-r--r--

Initial load

duke@435 1 /*
duke@435 2 * Copyright 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 // HeapDumper is used to dump the java heap to file in HPROF binary format:
duke@435 26 //
duke@435 27 // { HeapDumper dumper(true /* full GC before heap dump */);
duke@435 28 // if (dumper.dump("/export/java.hprof")) {
duke@435 29 // ResourceMark rm;
duke@435 30 // tty->print_cr("Dump failed: %s", dumper.error_as_C_string());
duke@435 31 // } else {
duke@435 32 // // dump succeeded
duke@435 33 // }
duke@435 34 // }
duke@435 35 //
duke@435 36
duke@435 37 class HeapDumper : public StackObj {
duke@435 38 private:
duke@435 39 char* _error;
duke@435 40 bool _print_to_tty;
duke@435 41 bool _gc_before_heap_dump;
duke@435 42 elapsedTimer _t;
duke@435 43
duke@435 44 // string representation of error
duke@435 45 char* error() const { return _error; }
duke@435 46 void set_error(char* error);
duke@435 47
duke@435 48 // indicates if progress messages can be sent to tty
duke@435 49 bool print_to_tty() const { return _print_to_tty; }
duke@435 50
duke@435 51 // internal timer.
duke@435 52 elapsedTimer* timer() { return &_t; }
duke@435 53
duke@435 54 public:
duke@435 55 HeapDumper(bool gc_before_heap_dump) :
duke@435 56 _gc_before_heap_dump(gc_before_heap_dump), _error(NULL), _print_to_tty(false) { }
duke@435 57 HeapDumper(bool gc_before_heap_dump, bool print_to_tty) :
duke@435 58 _gc_before_heap_dump(gc_before_heap_dump), _error(NULL), _print_to_tty(print_to_tty) { }
duke@435 59
duke@435 60 ~HeapDumper();
duke@435 61
duke@435 62 // dumps the heap to the specified file, returns 0 if success.
duke@435 63 int dump(const char* path);
duke@435 64
duke@435 65 // returns error message (resource allocated), or NULL if no error
duke@435 66 char* error_as_C_string() const;
duke@435 67
duke@435 68 static void dump_heap() KERNEL_RETURN;
duke@435 69 };

mercurial