/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

package sun.jvm.hotspot.tools;

import sun.jvm.hotspot.utilities.HeapHprofBinWriter;

import sun.jvm.hotspot.debugger.JVMDebugger;

import java.io.IOException;

/*

 * This tool is used by the JDK jmap utility to dump the heap of the target

 * process/core as a HPROF binary file. It can also be used as a standalone

 * tool if required.

 */

public class HeapDumper extends Tool {

    private static String DEFAULT_DUMP_FILE = "heap.bin";

    private String dumpFile;

    public HeapDumper(String dumpFile) {

        this.dumpFile = dumpFile;

    }

    public HeapDumper(String dumpFile, JVMDebugger d) {

        super(d);

        this.dumpFile = dumpFile;

    }

    protected void printFlagsUsage() {

        System.out.println("    <no option>\tto dump heap to " +

            DEFAULT_DUMP_FILE);

        System.out.println("    -f <file>\tto dump heap to <file>");

        super.printFlagsUsage();

    }

    // use HeapHprofBinWriter to write the heap dump

    public void run() {

        System.out.println("Dumping heap to " + dumpFile + " ...");

        try {

            new HeapHprofBinWriter().write(dumpFile);

            System.out.println("Heap dump file created");

        } catch (IOException ioe) {

            System.err.println(ioe.getMessage());

        }

    }

    // JDK jmap utility will always invoke this tool as:

    //   HeapDumper -f <file> <args...>

    public static void main(String args[]) {

        String file = DEFAULT_DUMP_FILE;

        if (args.length > 2) {

            if (args[0].equals("-f")) {

                file = args[1];

                String[] newargs = new String[args.length-2];

                System.arraycopy(args, 2, newargs, 0, args.length-2);

                args = newargs;

            }

        }

        HeapDumper dumper = new HeapDumper(file);

        dumper.execute(args);

    }

}