hotspot/agent/make/marks_notes.html
author jjg
Wed, 14 Mar 2012 13:53:41 -0700
changeset 12215 25d9238c9b75
parent 1 489c9b5090e2
child 15798 cea39eefa98e
permissions -rw-r--r--
7150784: bad copyright date in file Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
489c9b5090e2 Initial load
duke
parents:
diff changeset
     2
<html>
489c9b5090e2 Initial load
duke
parents:
diff changeset
     3
  <head>
489c9b5090e2 Initial load
duke
parents:
diff changeset
     4
    <title>Hotspot SA User Interface Notes</title>
489c9b5090e2 Initial load
duke
parents:
diff changeset
     5
  </head>
489c9b5090e2 Initial load
duke
parents:
diff changeset
     6
489c9b5090e2 Initial load
duke
parents:
diff changeset
     7
  <body>
489c9b5090e2 Initial load
duke
parents:
diff changeset
     8
    <h1>Hotspot SA User Interface Notes</h1>
489c9b5090e2 Initial load
duke
parents:
diff changeset
     9
489c9b5090e2 Initial load
duke
parents:
diff changeset
    10
    <h2>Workspace and Building</h2>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    11
489c9b5090e2 Initial load
duke
parents:
diff changeset
    12
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    13
      All the source code for the Serviceability Agent is in 
489c9b5090e2 Initial load
duke
parents:
diff changeset
    14
      <code>src/share/vm/agent</code> in the HotSport workspace 
489c9b5090e2 Initial load
duke
parents:
diff changeset
    15
      <code>/net/jano.sfbay/export/disk05/hotspot/ws/1.4/sa_baseline</code>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    16
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    17
      You can build the project by typing <code>gnumake</code> in the
489c9b5090e2 Initial load
duke
parents:
diff changeset
    18
      <code>src/share/vm/agent</code> directory.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    19
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    20
      You can also use the default build target using the Ant build file (build.xml). You can download Ant from
489c9b5090e2 Initial load
duke
parents:
diff changeset
    21
      <a href="http://jakarta.apache.org/ant">http://jakarta.apache.org/ant</a>. Documentation for Ant can be
489c9b5090e2 Initial load
duke
parents:
diff changeset
    22
      found at <a href="http://jakarta.apache.org/ant/manual/index.html">http://jakarta.apache.org/ant/manual/index.html</a>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    23
489c9b5090e2 Initial load
duke
parents:
diff changeset
    24
      
489c9b5090e2 Initial load
duke
parents:
diff changeset
    25
    <h2>Running the project</h2>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    26
489c9b5090e2 Initial load
duke
parents:
diff changeset
    27
    <ul>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    28
      <li><code>java -cp classes sun.jvm.hotspot.HSDB</code>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    29
      <li><code>java -cp classes sun.jvm.hotspot.bugspot.Main</code>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    30
    </ul>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    31
489c9b5090e2 Initial load
duke
parents:
diff changeset
    32
    <h2>Feedback</h2>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    33
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    34
      Refactoring of package hierarchy. All user interface components should be in
489c9b5090e2 Initial load
duke
parents:
diff changeset
    35
      the ui package. Perhaps: sun.jvm.hotspot.ui.hsdb.Main for the HSDB and
489c9b5090e2 Initial load
duke
parents:
diff changeset
    36
      sun.jvm.hotspot.ui.bugspot.Main for BugSpot.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    37
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    38
      The src\share\vm\agent area seems like a workspace so it should be organized like
489c9b5090e2 Initial load
duke
parents:
diff changeset
    39
      one. In particular, I'd like to suggest the following directory layout:<br>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    40
      
489c9b5090e2 Initial load
duke
parents:
diff changeset
    41
    <ul>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    42
      <li>src: All sources that are curently under the sun directory.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    43
      <li>classes: compiled class files.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    44
      <li>lib: Resources like images, icons and jar files.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    45
      <li>docs: Documentation 
489c9b5090e2 Initial load
duke
parents:
diff changeset
    46
      <li>deploy: distribution bundles for Java Web Start.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    47
    </ul>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    48
489c9b5090e2 Initial load
duke
parents:
diff changeset
    49
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    50
      Seems like there is a lot of redundant functionality. Between the HSDB and BugSpot. Perhaps
489c9b5090e2 Initial load
duke
parents:
diff changeset
    51
      this can be consolidated with a <code>javax.swing.Actions</code> architecture.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    52
489c9b5090e2 Initial load
duke
parents:
diff changeset
    53
    <h2>Tasklist</h2>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    54
    
489c9b5090e2 Initial load
duke
parents:
diff changeset
    55
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    56
      <b>Stack memory pane</b>: 
489c9b5090e2 Initial load
duke
parents:
diff changeset
    57
      It's one of the more useful JVM debugging tools in the SA. However, it
489c9b5090e2 Initial load
duke
parents:
diff changeset
    58
      doesn't support any interaction with the text; the Memory Panel in BugSpot
489c9b5090e2 Initial load
duke
parents:
diff changeset
    59
      was written afterward (with help from Shannon) and implements proper
489c9b5090e2 Initial load
duke
parents:
diff changeset
    60
      selection, scrolling, and drag-and-drop, but no annotations. I'm not sure how
489c9b5090e2 Initial load
duke
parents:
diff changeset
    61
      to integrate the annotations with the JTable that's being used for the memory
489c9b5090e2 Initial load
duke
parents:
diff changeset
    62
      view; if you have suggestions here please let me know.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    63
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    64
      <b>Integrations with the NetBeans architecture (plug in).</b> See the
489c9b5090e2 Initial load
duke
parents:
diff changeset
    65
      <a href="http://openide.netbeans.org">Netbeans Open APIs homepage</a>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    66
489c9b5090e2 Initial load
duke
parents:
diff changeset
    67
      
489c9b5090e2 Initial load
duke
parents:
diff changeset
    68
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    69
      HSDB: Object Histogram. Column sizes should be sized according the the
489c9b5090e2 Initial load
duke
parents:
diff changeset
    70
      contents. i.e, The size and count columns should be narrow enought to
489c9b5090e2 Initial load
duke
parents:
diff changeset
    71
      handle the largest window. Since there is a lot of data, sorting
489c9b5090e2 Initial load
duke
parents:
diff changeset
    72
      and searching should be implemented.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    73
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    74
489c9b5090e2 Initial load
duke
parents:
diff changeset
    75
    <h2>Log</h2>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    76
489c9b5090e2 Initial load
duke
parents:
diff changeset
    77
    <i>Last modified: Tue Feb 05 19:15:12 Pacific Standard Time 2002</i>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    78
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    79
      sun.jvm.hotspot.oops.ObjectHistogram should be the underlying data
489c9b5090e2 Initial load
duke
parents:
diff changeset
    80
      structure for the TableModels. It shouldnt bother with sorting the data - 
489c9b5090e2 Initial load
duke
parents:
diff changeset
    81
      the table model should do that. It should implement these methods:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    82
489c9b5090e2 Initial load
duke
parents:
diff changeset
    83
    <pre>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    84
      public int getSize()
489c9b5090e2 Initial load
duke
parents:
diff changeset
    85
      public ObjectHistogramElement getElementAt(int row);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    86
    </pre>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    87
    <p>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    88
      ObjectHistogramElement should return the String that represents
489c9b5090e2 Initial load
duke
parents:
diff changeset
    89
      the third column
489c9b5090e2 Initial load
duke
parents:
diff changeset
    90
    
489c9b5090e2 Initial load
duke
parents:
diff changeset
    91
489c9b5090e2 Initial load
duke
parents:
diff changeset
    92
    <hr>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    93
    <address><a href="mailto:mark.davidson@sun.com">Mark Davidson</a></address>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    94
<!-- Created: Mon Jan 28 14:33:47 Pacific Standard Time 2002 -->
489c9b5090e2 Initial load
duke
parents:
diff changeset
    95
<!-- hhmts start -->
489c9b5090e2 Initial load
duke
parents:
diff changeset
    96
Last modified: Tue Feb 05 20:05:13 Pacific Standard Time 2002
489c9b5090e2 Initial load
duke
parents:
diff changeset
    97
<!-- hhmts end -->
489c9b5090e2 Initial load
duke
parents:
diff changeset
    98
  </body>
489c9b5090e2 Initial load
duke
parents:
diff changeset
    99
</html>