/*

 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.

 * 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;

import java.io.*;

import java.awt.*;

import java.awt.event.*;

import javax.swing.*;

import java.util.*;

import sun.jvm.hotspot.code.*;

import sun.jvm.hotspot.compiler.*;

import sun.jvm.hotspot.debugger.*;

import sun.jvm.hotspot.gc.parallel.*;

import sun.jvm.hotspot.gc.shared.*;

import sun.jvm.hotspot.gc.g1.*;

import sun.jvm.hotspot.interpreter.*;

import sun.jvm.hotspot.memory.*;

import sun.jvm.hotspot.oops.*;

import sun.jvm.hotspot.runtime.*;

import sun.jvm.hotspot.ui.*;

import sun.jvm.hotspot.ui.tree.*;

import sun.jvm.hotspot.ui.classbrowser.*;

import sun.jvm.hotspot.utilities.*;

/** The top-level HotSpot Debugger. FIXME: make this an embeddable

    component! (Among other things, figure out what to do with the

    menu bar...) */

public class HSDB implements ObjectHistogramPanel.Listener, SAListener {

  public static void main(String[] args) {

    new HSDB(args).run();

  }

  //--------------------------------------------------------------------------------

  // Internals only below this point

  //

  private HotSpotAgent agent;

  private JVMDebugger jvmDebugger;

  private JDesktopPane desktop;

  private boolean      attached;

  private boolean      argError;

  private JFrame frame;

  /** List <JMenuItem> */

  private java.util.List attachMenuItems;

  /** List <JMenuItem> */

  private java.util.List detachMenuItems;

  private JMenu toolsMenu;

  private JMenuItem showDbgConsoleMenuItem;

  private JMenuItem computeRevPtrsMenuItem;

  private JInternalFrame attachWaitDialog;

  private JInternalFrame threadsFrame;

  private JInternalFrame consoleFrame;

  private WorkerThread workerThread;

  // These had to be made data members because they are referenced in inner classes.

  private String pidText;

  private int pid;

  private String execPath;

  private String coreFilename;

  private void doUsage() {

    System.out.println("Usage:  java HSDB [[pid] | [path-to-java-executable [path-to-corefile]] | help ]");

    System.out.println("           pid:                     attach to the process whose id is 'pid'");

    System.out.println("           path-to-java-executable: Debug a core file produced by this program");

    System.out.println("           path-to-corefile:        Debug this corefile.  The default is 'core'");

    System.out.println("        If no arguments are specified, you can select what to do from the GUI.\n");

    HotSpotAgent.showUsage();

    argError = true;

  }

  public HSDB(JVMDebugger d) {

    jvmDebugger = d;

  }

  private HSDB(String[] args) {

    switch (args.length) {

    case (0):

      break;

    case (1):

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

        doUsage();

      }

      // If all numbers, it is a PID to attach to

      // Else, it is a pathname to a .../bin/java for a core file.

      try {

        int unused = Integer.parseInt(args[0]);

        // If we get here, we have a PID and not a core file name

        pidText = args[0];

      } catch (NumberFormatException e) {

        execPath = args[0];

        coreFilename = "core";

      }

      break;

    case (2):

      execPath = args[0];

      coreFilename = args[1];

      break;

    default:

      System.out.println("HSDB Error: Too many options specified");

      doUsage();

    }

  }

  private class CloseUI extends WindowAdapter {

      @Override

      public void windowClosing(WindowEvent e) {

          workerThread.shutdown();

          frame.dispose();

      }

  }

  public void run() {

    // Don't start the UI if there were bad arguments.

    if (argError) {

        return;

    }

    // Create frame first, to catch any GUI creation issues

    // before we initialize agent

    frame = new JFrame("HSDB - HotSpot Debugger");

    frame.setSize(800, 600);

    frame.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);

    frame.addWindowListener(new CloseUI());

    agent = new HotSpotAgent();

    workerThread = new WorkerThread();

    attachMenuItems = new java.util.ArrayList();

    detachMenuItems = new java.util.ArrayList();

    JMenuBar menuBar = new JMenuBar();

    //

    // File menu

    //

    JMenu menu = new JMenu("File");

    menu.setMnemonic(KeyEvent.VK_F);

    JMenuItem item;

    item = createMenuItem("Attach to HotSpot process...",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showAttachDialog();

                              }

                            });

    item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_A, ActionEvent.ALT_MASK));

    item.setMnemonic(KeyEvent.VK_A);

    menu.add(item);

    attachMenuItems.add(item);

    item = createMenuItem("Open HotSpot core file...",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showOpenCoreFileDialog();

                              }

                            });

    item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_O, ActionEvent.ALT_MASK));

    item.setMnemonic(KeyEvent.VK_O);

    menu.add(item);

    attachMenuItems.add(item);

    item = createMenuItem("Connect to debug server...",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showConnectDialog();

                              }

                            });

    item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_S, ActionEvent.ALT_MASK));

    item.setMnemonic(KeyEvent.VK_S);

    menu.add(item);

    attachMenuItems.add(item);

    item = createMenuItem("Detach",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                detach();

                              }

                            });

    item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_D, ActionEvent.ALT_MASK));

    item.setMnemonic(KeyEvent.VK_S);

    menu.add(item);

    detachMenuItems.add(item);

    // Disable detach menu items at first

    setMenuItemsEnabled(detachMenuItems, false);

    menu.addSeparator();

    item = createMenuItem("Exit",

                            new ActionListener() {

                                public void actionPerformed(ActionEvent e) {

                                  workerThread.shutdown();

                                  frame.dispose();

                                }

                              });

    item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_X, ActionEvent.ALT_MASK));

    item.setMnemonic(KeyEvent.VK_X);

    menu.add(item);

    menuBar.add(menu);

    //

    // Tools menu

    //

    toolsMenu = new JMenu("Tools");

    toolsMenu.setMnemonic(KeyEvent.VK_T);

    item = createMenuItem("Class Browser",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                showClassBrowser();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_B);

    toolsMenu.add(item);

    item = createMenuItem("Code Viewer",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                showCodeViewer();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_C);

    toolsMenu.add(item);

    item = createMenuItem("Compute Reverse Ptrs",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                fireComputeReversePtrs();

                              }

                            });

    computeRevPtrsMenuItem = item;

    item.setMnemonic(KeyEvent.VK_M);

    toolsMenu.add(item);

    item = createMenuItem("Deadlock Detection",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showDeadlockDetectionPanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_D);

    toolsMenu.add(item);

    item = createMenuItem("Find Object by Query",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showFindByQueryPanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_Q);

    toolsMenu.add(item);

    item = createMenuItem("Find Pointer",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showFindPanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_P);

    toolsMenu.add(item);

    item = createMenuItem("Find Value In Heap",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showFindInHeapPanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_V);

    toolsMenu.add(item);

    item = createMenuItem("Find Value In Code Cache",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showFindInCodeCachePanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_A);

    toolsMenu.add(item);

    item = createMenuItem("Heap Parameters",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showHeapParametersPanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_H);

    toolsMenu.add(item);

    item = createMenuItem("Inspector",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showInspector(null);

                              }

                            });

    item.setMnemonic(KeyEvent.VK_R);

    item.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_R, ActionEvent.ALT_MASK));

    toolsMenu.add(item);

    item = createMenuItem("Memory Viewer",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                showMemoryViewer();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_M);

    toolsMenu.add(item);

    item = createMenuItem("Monitor Cache Dump",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showMonitorCacheDumpPanel();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_D);

    toolsMenu.add(item);

    item = createMenuItem("Object Histogram",

                          new ActionListener() {

                              public void actionPerformed(ActionEvent e) {

                                showObjectHistogram();

                              }

                            });

    item.setMnemonic(KeyEvent.VK_O);

    toolsMenu.add(item);

    item = createMenuItem("Show System Properties",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                showSystemProperties();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_S);

    toolsMenu.add(item);

    item = createMenuItem("Show VM Version",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                showVMVersion();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_M);

    toolsMenu.add(item);

    item = createMenuItem("Show -XX flags",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                showCommandLineFlags();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_X);

    toolsMenu.add(item);

    toolsMenu.setEnabled(false);

    menuBar.add(toolsMenu);

    //

    // Windows menu

    //

    JMenu windowsMenu = new JMenu("Windows");

    windowsMenu.setMnemonic(KeyEvent.VK_W);

    item = createMenuItem("Console",

                          new ActionListener() {

                             public void actionPerformed(ActionEvent e) {

                                 showConsole();

                             }

                          });

    item.setMnemonic(KeyEvent.VK_C);

    windowsMenu.add(item);

    showDbgConsoleMenuItem = createMenuItem("Debugger Console",

                                         new ActionListener() {

                                             public void actionPerformed(ActionEvent e) {

                                               showDebuggerConsole();

                                             }

                                           });

    showDbgConsoleMenuItem.setMnemonic(KeyEvent.VK_D);

    windowsMenu.add(showDbgConsoleMenuItem);

    showDbgConsoleMenuItem.setEnabled(false);

    menuBar.add(windowsMenu);

    frame.setJMenuBar(menuBar);

    desktop = new JDesktopPane();

    frame.getContentPane().add(desktop);

    GraphicsUtilities.reshapeToAspectRatio(frame, 4.0f/3.0f, 0.75f, Toolkit.getDefaultToolkit().getScreenSize());

    GraphicsUtilities.centerInContainer(frame, Toolkit.getDefaultToolkit().getScreenSize());

    frame.setVisible(true);

    Runtime.getRuntime().addShutdownHook(new java.lang.Thread() {

        public void run() {

          detachDebugger();

        }

      });

    // If jvmDebugger is already set, we have been given a JVMDebugger.

    // Otherwise, if pidText != null we are supposed to attach to it.

    // Finally, if execPath != null, it is the path of a jdk/bin/java

    // and coreFilename is the pathname of a core file we are

    // supposed to attach to.

    if (jvmDebugger != null) {

      attach(jvmDebugger);

    } else if (pidText != null) {

      attach(pidText);

    } else if (execPath != null) {

      attach(execPath, coreFilename);

    }

  }

  // FIXME: merge showAttachDialog, showOpenCoreFileDialog, showConnectDialog

  private void showAttachDialog() {

    // FIXME: create filtered text field which only accepts numbers

    setMenuItemsEnabled(attachMenuItems, false);

    final JInternalFrame attachDialog = new JInternalFrame("Attach to HotSpot process");

    attachDialog.getContentPane().setLayout(new BorderLayout());

    JPanel panel = new JPanel();

    panel.setLayout(new BoxLayout(panel, BoxLayout.X_AXIS));

    panel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));

    attachDialog.setBackground(panel.getBackground());

    panel.add(new JLabel("Enter process ID:"));

    final JTextField pidTextField = new JTextField(10);

    ActionListener attacher = new ActionListener() {

        public void actionPerformed(ActionEvent e) {

          attachDialog.setVisible(false);

          desktop.remove(attachDialog);

          workerThread.invokeLater(new Runnable() {

              public void run() {

                attach(pidTextField.getText());

              }

            });

        }

      };

    pidTextField.addActionListener(attacher);

    panel.add(pidTextField);

    attachDialog.getContentPane().add(panel, BorderLayout.NORTH);

    Box vbox = Box.createVerticalBox();

    panel = new JPanel();

    panel.setLayout(new BoxLayout(panel, BoxLayout.Y_AXIS));

    panel.setBorder(BorderFactory.createEmptyBorder(8, 8, 8, 8));

    JTextArea ta = new JTextArea(

                                 "Enter the process ID of a currently-running HotSpot process. On " +

                                 "Solaris and most Unix operating systems, this can be determined by " +

                                 "typing \"ps -u <your username> | grep java\"; the process ID is the " +

                                 "first number which appears on the resulting line. On Windows, the " +

                                 "process ID is present in the Task Manager, which can be brought up " +

                                 "while logged on to the desktop by pressing Ctrl-Alt-Delete.");

    ta.setLineWrap(true);

    ta.setWrapStyleWord(true);

    ta.setEditable(false);

    ta.setBackground(panel.getBackground());

    panel.add(ta);

    vbox.add(panel);

    Box hbox = Box.createHorizontalBox();

    hbox.add(Box.createGlue());

    JButton button = new JButton("OK");

    button.addActionListener(attacher);

    hbox.add(button);

    hbox.add(Box.createHorizontalStrut(20));

    button = new JButton("Cancel");

    button.addActionListener(new ActionListener() {

        public void actionPerformed(ActionEvent e) {

          attachDialog.setVisible(false);

          desktop.remove(attachDialog);

          setMenuItemsEnabled(attachMenuItems, true);

        }

      });

    hbox.add(button);

    hbox.add(Box.createGlue());

    panel = new JPanel();

    panel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));

    panel.add(hbox);

    vbox.add(panel);

    attachDialog.getContentPane().add(vbox, BorderLayout.SOUTH);

    desktop.add(attachDialog);

    attachDialog.setSize(400, 300);

    GraphicsUtilities.centerInContainer(attachDialog);

    attachDialog.show();

    pidTextField.requestFocus();

  }