stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8265505: findsym does not work on remote debug server

Browse Source 
Reviewed-by: cjplummer, kevinw
This commit is contained in:
Yasumasa Suenaga 2021-05-05 00:26:12 +00:00
parent b88785d2c6
commit 8bcebe73d2
6 changed files with 156 additions and 43 deletions
src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot
CommandProcessor.java
debugger
Debugger.javaDebuggerBase.java
remote
RemoteDebuggerClient.javaRemoteDebuggerServer.java
test/hotspot/jtreg/serviceability/sa/sadebugd
RunCommandOnServerTest.java

30
src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/CommandProcessor.java

@ -47,8 +47,6 @@ import sun.jvm.hotspot.ci.ciEnv;
import sun.jvm.hotspot.code.CodeBlob;
import sun.jvm.hotspot.code.CodeCacheVisitor;
import sun.jvm.hotspot.code.NMethod;
import sun.jvm.hotspot.debugger.cdbg.CDebugger;
import sun.jvm.hotspot.debugger.cdbg.LoadObject;
import sun.jvm.hotspot.debugger.Address;
import sun.jvm.hotspot.debugger.OopHandle;
import sun.jvm.hotspot.classfile.ClassLoaderDataGraph;
@ -599,32 +597,8 @@ public class CommandProcessor {
if (t.countTokens() != 1) {
usage();
} else {
String symbol = t.nextToken();
Address addr = VM.getVM().getDebugger().lookup(null, symbol);
if (addr == null && VM.getVM().getDebugger().getOS().equals("win32")) {
// On win32 symbols are prefixed with the dll name. Do the user
// a favor and see if this is a symbol in jvm.dll or java.dll.
addr = VM.getVM().getDebugger().lookup(null, "jvm!" + symbol);
if (addr == null) {
addr = VM.getVM().getDebugger().lookup(null, "java!" + symbol);
}
}
if (addr == null) {
out.println("Symbol not found");
return;
}
out.print(addr); // Print the address of the symbol.
CDebugger cdbg = VM.getVM().getDebugger().getCDebugger();
LoadObject loadObject = cdbg.loadObjectContainingPC(addr);
// Print the shared library path and the offset of the symbol.
if (loadObject != null) {
out.print(": " + loadObject.getName());
long diff = addr.minus(loadObject.getBase());
if (diff != 0L) {
out.print(" + 0x" + Long.toHexString(diff));
}
}
out.println();
String result = VM.getVM().getDebugger().findSymbol(t.nextToken());
out.println(result == null ? "Symbol not found" : result);
}
}
},

7
src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/debugger/Debugger.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, 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
@ -109,6 +109,11 @@ public interface Debugger extends SymbolLookup, ThreadAccess {
null. */
public CDebugger getCDebugger() throws DebuggerException;
/**
* Find address and executable which contains symbol.
*/
public String findSymbol(String symbol);
/** the following methods are intended only for RemoteDebuggerClient */
public long getJBooleanSize();
public long getJByteSize();

30
src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/debugger/DebuggerBase.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2001, 2009, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2001, 2021, 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
@ -526,6 +526,34 @@ public abstract class DebuggerBase implements Debugger {
cache.clear(startAddress, numBytes);
}
@Override
public String findSymbol(String symbol) {
Address addr = lookup(null, symbol);
if (addr == null && getOS().equals("win32")) {
// On win32 symbols are prefixed with the dll name. Do the user
// a favor and see if this is a symbol in jvm.dll or java.dll.
addr = lookup(null, "jvm!" + symbol);
if (addr == null) {
addr = lookup(null, "java!" + symbol);
}
}
if (addr == null) {
return null;
}
var builder = new StringBuilder(addr.toString());
var cdbg = getCDebugger();
var loadObject = cdbg.loadObjectContainingPC(addr);
// Print the shared library path and the offset of the symbol
if (loadObject != null) {
builder.append(": ").append(loadObject.getName());
long diff = addr.minus(loadObject.getBase());
if (diff != 0L) {
builder.append(" + 0x").append(Long.toHexString(diff));
}
}
return builder.toString();
}
public long getJBooleanSize() {
return jbooleanSize;
}

5
src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/debugger/remote/RemoteDebuggerClient.java

@ -423,4 +423,9 @@ public class RemoteDebuggerClient extends DebuggerBase implements JVMDebugger {
throw new DebuggerException(e);
}
}
@Override
public String findSymbol(String symbol) {
return execCommandOnServer("findsym", Map.of("symbol", symbol));
}
}

29
src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/debugger/remote/RemoteDebuggerServer.java

@ -181,20 +181,23 @@ public class RemoteDebuggerServer extends UnicastRemoteObject
@Override
public String execCommandOnServer(String command, Map<String, Object> options) throws RemoteException {
ByteArrayOutputStream bout = new ByteArrayOutputStream();
try (var out = new PrintStream(bout)) {
if (command.equals("pmap")) {
(new PMap(debugger)).run(out, debugger);
} else if (command.equals("pstack")) {
PStack pstack = new PStack(debugger);
pstack.setVerbose(false);
pstack.setConcurrentLocks((boolean)options.get("concurrentLocks"));
pstack.run(out, debugger);
} else {
throw new DebuggerException(command + " is not supported in this debugger");
if (command.equals("findsym")) {
return debugger.findSymbol((String)options.get("symbol"));
} else {
ByteArrayOutputStream bout = new ByteArrayOutputStream();
try (var out = new PrintStream(bout)) {
if (command.equals("pmap")) {
(new PMap(debugger)).run(out, debugger);
} else if (command.equals("pstack")) {
PStack pstack = new PStack(debugger);
pstack.setVerbose(false);
pstack.setConcurrentLocks((boolean)options.get("concurrentLocks"));
pstack.run(out, debugger);
} else {
throw new DebuggerException(command + " is not supported in this debugger");
}
}
return bout.toString();
}
return bout.toString();
}
}

98
test/hotspot/jtreg/serviceability/sa/sadebugd/RunCommandOnServerTest.java Normal file

@ -0,0 +1,98 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2021 NTT DATA.
* 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.
*/
import java.io.PrintStream;
import jdk.test.lib.JDKToolLauncher;
import jdk.test.lib.apps.LingeredApp;
import jdk.test.lib.process.OutputAnalyzer;
import jdk.test.lib.SA.SATestUtils;
import jtreg.SkippedException;
/**
* @test
* @bug 8265505
* @summary Test clhsdb command which should be run on debugd server
* @requires vm.hasSA
* @requires os.family != "windows"
* @library /test/lib
* @run main/othervm RunCommandOnServerTest
*/
public class RunCommandOnServerTest {
public static void main(String[] args) throws Exception {
SATestUtils.skipIfCannotAttach(); // throws SkippedException if attach not expected to work.
SATestUtils.validateSADebugDPrivileges();
LingeredApp theApp = null;
DebugdUtils debugd = null;
try {
theApp = LingeredApp.startApp();
System.out.println("Started LingeredApp with pid " + theApp.getPid());
debugd = new DebugdUtils(null);
debugd.attach(theApp.getPid());
JDKToolLauncher jhsdbLauncher = JDKToolLauncher.createUsingTestJDK("jhsdb");
jhsdbLauncher.addToolArg("clhsdb");
jhsdbLauncher.addToolArg("--connect");
jhsdbLauncher.addToolArg("localhost");
Process jhsdb = (SATestUtils.createProcessBuilder(jhsdbLauncher)).start();
OutputAnalyzer out = new OutputAnalyzer(jhsdb);
try (PrintStream console = new PrintStream(jhsdb.getOutputStream(), true)) {
console.println("echo true");
console.println("verbose true");
console.println("findsym gHotSpotVMTypes");
console.println("quit");
}
jhsdb.waitFor();
System.out.println(out.getStdout());
System.err.println(out.getStderr());
out.stderrShouldBeEmptyIgnoreDeprecatedWarnings();
out.shouldMatch("^0x[0-9a-f]+: .+/libjvm\\.(so|dylib) \\+ 0x[0-9a-f]+$");
out.shouldHaveExitValue(0);
// This will detect most SA failures, including during the attach.
out.shouldNotMatch("^sun.jvm.hotspot.debugger.DebuggerException:.*$");
// This will detect unexpected exceptions, like NPEs and asserts, that are caught
// by sun.jvm.hotspot.CommandProcessor.
out.shouldNotMatch("^Error: .*$");
} catch (SkippedException se) {
throw se;
} catch (Exception ex) {
throw new RuntimeException("Test ERROR " + ex, ex);
} finally {
if (debugd != null) {
debugd.detach();
}
LingeredApp.stopApp(theApp);
}
System.out.println("Test PASSED");
}
}