1 /*
   2  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 package sun.jvm.hotspot.runtime;
  26 
  27 import java.util.*;
  28 import sun.jvm.hotspot.debugger.*;
  29 import sun.jvm.hotspot.types.*;
  30 import sun.jvm.hotspot.runtime.solaris_sparc.SolarisSPARCJavaThreadPDAccess;
  31 import sun.jvm.hotspot.runtime.solaris_x86.SolarisX86JavaThreadPDAccess;
  32 import sun.jvm.hotspot.runtime.solaris_amd64.SolarisAMD64JavaThreadPDAccess;
  33 import sun.jvm.hotspot.runtime.win32_amd64.Win32AMD64JavaThreadPDAccess;
  34 import sun.jvm.hotspot.runtime.win32_x86.Win32X86JavaThreadPDAccess;
  35 import sun.jvm.hotspot.runtime.linux_x86.LinuxX86JavaThreadPDAccess;
  36 import sun.jvm.hotspot.runtime.linux_amd64.LinuxAMD64JavaThreadPDAccess;
  37 import sun.jvm.hotspot.runtime.linux_sparc.LinuxSPARCJavaThreadPDAccess;
  38 import sun.jvm.hotspot.runtime.bsd_x86.BsdX86JavaThreadPDAccess;
  39 import sun.jvm.hotspot.runtime.bsd_amd64.BsdAMD64JavaThreadPDAccess;
  40 import sun.jvm.hotspot.utilities.*;
  41 
  42 public class Threads {
  43     private static JavaThreadFactory threadFactory;
  44     private static AddressField      threadListField;
  45     private static CIntegerField     numOfThreadsField;
  46     private static VirtualConstructor virtualConstructor;
  47     private static JavaThreadPDAccess access;
  48 
  49     static {
  50         VM.registerVMInitializedObserver(new Observer() {
  51             public void update(Observable o, Object data) {
  52                 initialize(VM.getVM().getTypeDataBase());
  53             }
  54         });
  55     }
  56 
  57     private static synchronized void initialize(TypeDataBase db) {
  58         Type type = db.lookupType("Threads");
  59 
  60         threadListField = type.getAddressField("_thread_list");
  61         numOfThreadsField = type.getCIntegerField("_number_of_threads");
  62 
  63         // Instantiate appropriate platform-specific JavaThreadFactory
  64         String os  = VM.getVM().getOS();
  65         String cpu = VM.getVM().getCPU();
  66 
  67         access = null;
  68         // FIXME: find the platform specific PD class by reflection?
  69         if (os.equals("solaris")) {
  70             if (cpu.equals("sparc")) {
  71                 access = new SolarisSPARCJavaThreadPDAccess();
  72             } else if (cpu.equals("x86")) {
  73                 access = new SolarisX86JavaThreadPDAccess();
  74             } else if (cpu.equals("amd64")) {
  75                 access = new SolarisAMD64JavaThreadPDAccess();
  76             }
  77         } else if (os.equals("win32")) {
  78             if (cpu.equals("x86")) {
  79                 access =  new Win32X86JavaThreadPDAccess();
  80             } else if (cpu.equals("amd64")) {
  81                 access =  new Win32AMD64JavaThreadPDAccess();
  82             }
  83         } else if (os.equals("linux")) {
  84             if (cpu.equals("x86")) {
  85                 access = new LinuxX86JavaThreadPDAccess();
  86             } else if (cpu.equals("amd64")) {
  87                 access = new LinuxAMD64JavaThreadPDAccess();
  88             } else if (cpu.equals("sparc")) {
  89                 access = new LinuxSPARCJavaThreadPDAccess();
  90             } else {
  91               try {
  92                 access = (JavaThreadPDAccess)
  93                   Class.forName("sun.jvm.hotspot.runtime.linux_" +
  94                      cpu.toLowerCase() + ".Linux" + cpu.toUpperCase() +
  95                      "JavaThreadPDAccess").newInstance();
  96               } catch (Exception e) {
  97                 throw new RuntimeException("OS/CPU combination " + os + "/" + cpu +
  98                                            " not yet supported");
  99               }
 100             }
 101         } else if (os.equals("bsd")) {
 102             if (cpu.equals("x86")) {
 103                 access = new BsdX86JavaThreadPDAccess();
 104             } else if (cpu.equals("amd64") || cpu.equals("x86_64")) {
 105                 access = new BsdAMD64JavaThreadPDAccess();
 106             }
 107         } else if (os.equals("darwin")) {
 108             if (cpu.equals("amd64") || cpu.equals("x86_64")) {
 109                 access = new BsdAMD64JavaThreadPDAccess();
 110             }
 111         }
 112 
 113         if (access == null) {
 114             throw new RuntimeException("OS/CPU combination " + os + "/" + cpu +
 115             " not yet supported");
 116         }
 117 
 118         virtualConstructor = new VirtualConstructor(db);
 119         // Add mappings for all known thread types
 120         virtualConstructor.addMapping("JavaThread", JavaThread.class);
 121         if (!VM.getVM().isCore()) {
 122             virtualConstructor.addMapping("CompilerThread", CompilerThread.class);
 123         }
 124         // for now, use JavaThread itself. fix it later with appropriate class if needed
 125         virtualConstructor.addMapping("SurrogateLockerThread", JavaThread.class);
 126         virtualConstructor.addMapping("JvmtiAgentThread", JvmtiAgentThread.class);
 127         virtualConstructor.addMapping("ServiceThread", ServiceThread.class);
 128     }
 129 
 130     public Threads() {
 131     }
 132 
 133     /** NOTE: this returns objects of type JavaThread, CompilerThread,
 134       JvmtiAgentThread, and ServiceThread.
 135       The latter four are subclasses of the former. Most operations
 136       (fetching the top frame, etc.) are only allowed to be performed on
 137       a "pure" JavaThread. For this reason, {@link
 138       sun.jvm.hotspot.runtime.JavaThread#isJavaThread} has been
 139       changed from the definition in the VM (which returns true for
 140       all of these thread types) to return true for JavaThreads and
 141       false for the three subclasses. FIXME: should reconsider the
 142       inheritance hierarchy; see {@link
 143       sun.jvm.hotspot.runtime.JavaThread#isJavaThread}. */
 144     public JavaThread first() {
 145         Address threadAddr = threadListField.getValue();
 146         if (threadAddr == null) {
 147             return null;
 148         }
 149 
 150         return createJavaThreadWrapper(threadAddr);
 151     }
 152 
 153     public int getNumberOfThreads() {
 154         return (int) numOfThreadsField.getValue();
 155     }
 156 
 157     /** Routine for instantiating appropriately-typed wrapper for a
 158       JavaThread. Currently needs to be public for OopUtilities to
 159       access it. */
 160     public JavaThread createJavaThreadWrapper(Address threadAddr) {
 161         try {
 162             JavaThread thread = (JavaThread)virtualConstructor.instantiateWrapperFor(threadAddr);
 163             thread.setThreadPDAccess(access);
 164             return thread;
 165         } catch (Exception e) {
 166             throw new RuntimeException("Unable to deduce type of thread from address " + threadAddr +
 167             " (expected type JavaThread, CompilerThread, ServiceThread, JvmtiAgentThread, or SurrogateLockerThread)", e);
 168         }
 169     }
 170 
 171     /** Memory operations */
 172     public void oopsDo(AddressVisitor oopVisitor) {
 173         // FIXME: add more of VM functionality
 174         for (JavaThread thread = first(); thread != null; thread = thread.next()) {
 175             thread.oopsDo(oopVisitor);
 176         }
 177     }
 178 
 179     // refer to Threads::owning_thread_from_monitor_owner
 180     public JavaThread owningThreadFromMonitor(Address o) {
 181         if (o == null) return null;
 182         for (JavaThread thread = first(); thread != null; thread = thread.next()) {
 183             if (o.equals(thread.threadObjectAddress())) {
 184                 return thread;
 185             }
 186         }
 187 
 188         for (JavaThread thread = first(); thread != null; thread = thread.next()) {
 189           if (thread.isLockOwned(o))
 190             return thread;
 191         }
 192         return null;
 193     }
 194 
 195     public JavaThread owningThreadFromMonitor(ObjectMonitor monitor) {
 196         return owningThreadFromMonitor(monitor.owner());
 197     }
 198 
 199     // refer to Threads::get_pending_threads
 200     // Get list of Java threads that are waiting to enter the specified monitor.
 201     public List getPendingThreads(ObjectMonitor monitor) {
 202         List pendingThreads = new ArrayList();
 203         for (JavaThread thread = first(); thread != null; thread = thread.next()) {
 204             if (thread.isCompilerThread()) {
 205                 continue;
 206             }
 207             ObjectMonitor pending = thread.getCurrentPendingMonitor();
 208             if (monitor.equals(pending)) {
 209                 pendingThreads.add(thread);
 210             }
 211         }
 212         return pendingThreads;
 213     }
 214 
 215     // Get list of Java threads that have called Object.wait on the specified monitor.
 216     public List getWaitingThreads(ObjectMonitor monitor) {
 217         List pendingThreads = new ArrayList();
 218         for (JavaThread thread = first(); thread != null; thread = thread.next()) {
 219             ObjectMonitor waiting = thread.getCurrentWaitingMonitor();
 220             if (monitor.equals(waiting)) {
 221                 pendingThreads.add(thread);
 222             }
 223         }
 224         return pendingThreads;
 225     }
 226 
 227     // FIXME: add other accessors
 228 }