1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/vm/services/heapDumper.hpp Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,69 @@
1.4 +/*
1.5 + * Copyright 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation.
1.11 + *
1.12 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.14 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.15 + * version 2 for more details (a copy is included in the LICENSE file that
1.16 + * accompanied this code).
1.17 + *
1.18 + * You should have received a copy of the GNU General Public License version
1.19 + * 2 along with this work; if not, write to the Free Software Foundation,
1.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.21 + *
1.22 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.23 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.24 + * have any questions.
1.25 + *
1.26 + */
1.27 +
1.28 +// HeapDumper is used to dump the java heap to file in HPROF binary format:
1.29 +//
1.30 +// { HeapDumper dumper(true /* full GC before heap dump */);
1.31 +// if (dumper.dump("/export/java.hprof")) {
1.32 +// ResourceMark rm;
1.33 +// tty->print_cr("Dump failed: %s", dumper.error_as_C_string());
1.34 +// } else {
1.35 +// // dump succeeded
1.36 +// }
1.37 +// }
1.38 +//
1.39 +
1.40 +class HeapDumper : public StackObj {
1.41 + private:
1.42 + char* _error;
1.43 + bool _print_to_tty;
1.44 + bool _gc_before_heap_dump;
1.45 + elapsedTimer _t;
1.46 +
1.47 + // string representation of error
1.48 + char* error() const { return _error; }
1.49 + void set_error(char* error);
1.50 +
1.51 + // indicates if progress messages can be sent to tty
1.52 + bool print_to_tty() const { return _print_to_tty; }
1.53 +
1.54 + // internal timer.
1.55 + elapsedTimer* timer() { return &_t; }
1.56 +
1.57 + public:
1.58 + HeapDumper(bool gc_before_heap_dump) :
1.59 + _gc_before_heap_dump(gc_before_heap_dump), _error(NULL), _print_to_tty(false) { }
1.60 + HeapDumper(bool gc_before_heap_dump, bool print_to_tty) :
1.61 + _gc_before_heap_dump(gc_before_heap_dump), _error(NULL), _print_to_tty(print_to_tty) { }
1.62 +
1.63 + ~HeapDumper();
1.64 +
1.65 + // dumps the heap to the specified file, returns 0 if success.
1.66 + int dump(const char* path);
1.67 +
1.68 + // returns error message (resource allocated), or NULL if no error
1.69 + char* error_as_C_string() const;
1.70 +
1.71 + static void dump_heap() KERNEL_RETURN;
1.72 +};
