duke@435: /*
coleenp@4037:  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #ifndef SHARE_VM_SERVICES_HEAPDUMPER_HPP
stefank@2314: #define SHARE_VM_SERVICES_HEAPDUMPER_HPP
stefank@2314: 
stefank@2314: #include "memory/allocation.hpp"
stefank@2314: #include "oops/oop.hpp"
stefank@2314: #include "runtime/os.hpp"
stefank@2314: 
duke@435: // HeapDumper is used to dump the java heap to file in HPROF binary format:
duke@435: //
duke@435: //  { HeapDumper dumper(true /* full GC before heap dump */);
duke@435: //    if (dumper.dump("/export/java.hprof")) {
duke@435: //      ResourceMark rm;
duke@435: //      tty->print_cr("Dump failed: %s", dumper.error_as_C_string());
duke@435: //    } else {
duke@435: //      // dump succeeded
duke@435: //    }
duke@435: //  }
duke@435: //
duke@435: 
duke@435: class HeapDumper : public StackObj {
duke@435:  private:
duke@435:   char* _error;
duke@435:   bool _print_to_tty;
duke@435:   bool _gc_before_heap_dump;
thurka@2130:   bool _oome;
duke@435:   elapsedTimer _t;
duke@435: 
thurka@2130:   HeapDumper(bool gc_before_heap_dump, bool print_to_tty, bool oome) :
thurka@2130:     _gc_before_heap_dump(gc_before_heap_dump), _error(NULL), _print_to_tty(print_to_tty), _oome(oome) { }
thurka@2130: 
duke@435:   // string representation of error
duke@435:   char* error() const                   { return _error; }
duke@435:   void set_error(char* error);
duke@435: 
duke@435:   // indicates if progress messages can be sent to tty
duke@435:   bool print_to_tty() const             { return _print_to_tty; }
duke@435: 
duke@435:   // internal timer.
duke@435:   elapsedTimer* timer()                 { return &_t; }
duke@435: 
thurka@2130:   static void dump_heap(bool oome);
thurka@2130: 
duke@435:  public:
duke@435:   HeapDumper(bool gc_before_heap_dump) :
thurka@2130:     _gc_before_heap_dump(gc_before_heap_dump), _error(NULL), _print_to_tty(false), _oome(false) { }
duke@435: 
duke@435:   ~HeapDumper();
duke@435: 
duke@435:   // dumps the heap to the specified file, returns 0 if success.
duke@435:   int dump(const char* path);
duke@435: 
duke@435:   // returns error message (resource allocated), or NULL if no error
duke@435:   char* error_as_C_string() const;
duke@435: 
jprovino@4165:   static void dump_heap()    NOT_SERVICES_RETURN;
thurka@2130: 
jprovino@4165:   static void dump_heap_from_oome()    NOT_SERVICES_RETURN;
duke@435: };
stefank@2314: 
stefank@2314: #endif // SHARE_VM_SERVICES_HEAPDUMPER_HPP