archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 15:24:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8308995: Update Network IO JFR events to be static mirror events

Browse source 
Reviewed-by: egahlin, alanb
This commit is contained in:
Tim Prinzing 2023-09-20 12:34:08 +00:00 • committed by Alan Bateman
parent e1870d360e
commit b275bdd9b5
13 changed files with 527 additions and 387 deletions
Download patch file Download diff file Expand all files Collapse all files

38
src/java.base/share/classes/java/net/Socket.java
View file

@ -25,6 +25,8 @@
package java.net;
import jdk.internal.event.SocketReadEvent;
import jdk.internal.event.SocketWriteEvent;
import sun.security.util.SecurityConstants;
import java.io.InputStream;
@ -1073,9 +1075,6 @@ public class Socket implements java.io.Closeable {
/**
* An InputStream that delegates read/available operations to an underlying
* input stream. The close method is overridden to close the Socket.
*
* This class is instrumented by Java Flight Recorder (JFR) to get socket
* I/O events.
*/
private static class SocketInputStream extends InputStream {
private final Socket parent;
@ -1092,6 +1091,16 @@ public class Socket implements java.io.Closeable {
}
@Override
public int read(byte[] b, int off, int len) throws IOException {
if (!SocketReadEvent.enabled()) {
return implRead(b, off, len);
}
long start = SocketReadEvent.timestamp();
int nbytes = implRead(b, off, len);
SocketReadEvent.offer(start, nbytes, parent.getRemoteSocketAddress(), getSoTimeout());
return nbytes;
}
private int implRead(byte[] b, int off, int len) throws IOException {
try {
return in.read(b, off, len);
} catch (SocketTimeoutException e) {
@ -1105,6 +1114,16 @@ public class Socket implements java.io.Closeable {
throw e;
}
}
private int getSoTimeout() {
try {
return parent.getSoTimeout();
} catch (SocketException e) {
// ignored - avoiding exceptions in jfr event data gathering
}
return 0;
}
@Override
public int available() throws IOException {
return in.available();
@ -1169,9 +1188,6 @@ public class Socket implements java.io.Closeable {
/**
* An OutputStream that delegates write operations to an underlying output
* stream. The close method is overridden to close the Socket.
*
* This class is instrumented by Java Flight Recorder (JFR) to get socket
* I/O events.
*/
private static class SocketOutputStream extends OutputStream {
private final Socket parent;
@ -1187,6 +1203,16 @@ public class Socket implements java.io.Closeable {
}
@Override
public void write(byte[] b, int off, int len) throws IOException {
if (!SocketWriteEvent.enabled()) {
implWrite(b, off, len);
return;
}
long start = SocketWriteEvent.timestamp();
implWrite(b, off, len);
SocketWriteEvent.offer(start, len, parent.getRemoteSocketAddress());
}
private void implWrite(byte[] b, int off, int len) throws IOException {
try {
out.write(b, off, len);
} catch (InterruptedIOException e) {

134
src/java.base/share/classes/jdk/internal/event/SocketReadEvent.java Normal file
View file

@ -0,0 +1,134 @@
/*
* Copyright (c) 2023, 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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 jdk.internal.event;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.UnixDomainSocketAddress;
/**
* A JFR event for socket read operations. This event is mirrored in
* {@code jdk.jfr.events.SocketReadEvent } where the metadata for the event is
* provided with annotations. Some of the methods are replaced by generated
* methods when jfr is enabled. Note that the order of the arguments of the
* {@link #commit(long, long, String, String, int, long, long, boolean)} method
* must be the same as the order of the fields.
*/
public class SocketReadEvent extends Event {
// THE ORDER OF THE FOLLOWING FIELDS IS IMPORTANT!
// The order must match the argument order of the generated commit method.
public String host;
public String address;
public int port;
public long timeout;
public long bytesRead;
public boolean endOfStream;
/**
* Actually commit a socket read event. The implementation
* of this method is generated automatically if jfr is enabled.
* The order of the fields must be the same as the parameters in this method.
* {@code commit(..., String, String, int, long, long, boolean)}
*
* @param start timestamp of the start of the operation
* @param duration time in nanoseconds to complete the operation
* @param host remote host of the transfer
* @param address remote address of the transfer
* @param port remote port of the transfer
* @param timeout timeout setting for the read
* @param bytes number of bytes that were transferred
* @param endOfStream has the end of the stream been reached
*/
public static void commit(long start, long duration, String host, String address, int port, long timeout, long bytes, boolean endOfStream) {
// Generated by JFR
}
/**
* Determine if an event should be emitted. The duration of the operation
* must exceed some threshold in order to commit the event. The implementation
* of this method is generated automatically if jfr is enabled.
*
* @param duration time in nanoseconds to complete the operation
* @return true if the event should be commited
*/
public static boolean shouldCommit(long duration) {
// Generated by JFR
return false;
}
/**
* Determine if this kind of event is enabled. The implementation
* of this method is generated automatically if jfr is enabled.
*
* @return true if socket read events are enabled, false otherwise
*/
public static boolean enabled() {
// Generated by JFR
return false;
}
/**
* Fetch the current timestamp in nanoseconds. This method is used
* to determine the start and end of an operation. The implementation
* of this method is generated automatically if jfr is enabled.
*
* @return the current timestamp value
*/
public static long timestamp() {
// Generated by JFR
return 0L;
}
/**
* Helper method to offer the data needed to potentially commit an event.
* The duration of the operation is computed using the current
* timestamp and the given start time. If the duration is meets
* or exceeds the configured value (determined by calling the generated method
* {@link #shouldCommit(long)}), an event will be emitted by calling
* {@link #commit(long, long, String, String, int, long, long, boolean)}.
*
* @param start the start time
* @param nbytes how many bytes were transferred
* @param remote the address of the remote socket
* @param timeout maximum time to wait
*/
public static void offer(long start, long nbytes, SocketAddress remote, long timeout) {
long duration = timestamp() - start;
if (shouldCommit(duration)) {
boolean eof = nbytes < 0 ? true : false;
nbytes = nbytes < 0 ? 0 : nbytes;
if (remote instanceof InetSocketAddress isa) {
commit(start, duration, isa.getHostString(), isa.getAddress().getHostAddress(), isa.getPort(), timeout, nbytes, eof);
} else if (remote instanceof UnixDomainSocketAddress udsa) {
String path = "[" + udsa.getPath().toString() + "]";
commit(start, duration, "Unix domain socket", path, 0, timeout, nbytes, eof);
}
}
}
}

126
src/java.base/share/classes/jdk/internal/event/SocketWriteEvent.java Normal file
View file

@ -0,0 +1,126 @@
/*
* Copyright (c) 2023, 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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 jdk.internal.event;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.UnixDomainSocketAddress;
/**
* A JFR event for socket write operations. This event is mirrored in
* {@code jdk.jfr.events.SocketWriteEvent } where the metadata for the event is
* provided with annotations. Some of the methods are replaced by generated
* methods when jfr is enabled. Note that the order of the arguments of the
* {@link #commit(long, long, String, String, int, long)} method
* must be the same as the order of the fields.
*/
public class SocketWriteEvent extends Event {
// THE ORDER OF THE FOLLOWING FIELDS IS IMPORTANT!
// The order must match the argument order of the generated commit method.
public String host;
public String address;
public int port;
public long bytesWritten;
/**
* Actually commit a socket write event. This is generated automatically.
* The order of the fields must be the same as the parameters in this method.
* {@code commit(..., String, String, int, long)}
*
* @param start timestamp of the start of the operation
* @param duration time in nanoseconds to complete the operation
* @param host remote host of the transfer
* @param address remote address of the transfer
* @param port remote port of the transfer
* @param bytes number of bytes that were transferred
*/
public static void commit(long start, long duration, String host, String address, int port, long bytes) {
// Generated by JFR
}
/**
* Determine if an event should be emitted. The duration of the operation
* must exceed some threshold in order to commit the event. The implementation
* of this method is generated automatically if jfr is enabled.
*
* @param duration time in nanoseconds to complete the operation
* @return true if the event should be commited
*/
public static boolean shouldCommit(long duration) {
// Generated by JFR
return false;
}
/**
* Determine if this kind of event is enabled. The implementation
* of this method is generated automatically if jfr is enabled.
*
* @return true if socket write events are enabled, false otherwise
*/
public static boolean enabled() {
// Generated by JFR
return false;
}
/**
* Fetch the current timestamp in nanoseconds. This method is used
* to determine the start and end of an operation. The implementation
* of this method is generated automatically if jfr is enabled.
*
* @return the current timestamp value
*/
public static long timestamp() {
// Generated by JFR
return 0L;
}
/**
* Helper method to offer the data needed to potentially commit an event.
* The duration of the operation is computed using the current
* timestamp and the given start time. If the duration is meets
* or exceeds the configured value (determined by calling the generated method
* {@link #shouldCommit(long)}), an event will be emitted by calling
* {@link #commit(long, long, String, String, int, long)}.
*
* @param start the start time
* @param bytesWritten how many bytes were sent
* @param remote the address of the remote socket being written to
*/
public static void offer(long start, long bytesWritten, SocketAddress remote) {
long duration = timestamp() - start;
if (shouldCommit(duration)) {
long bytes = bytesWritten < 0 ? 0 : bytesWritten;
if (remote instanceof InetSocketAddress isa) {
commit(start, duration, isa.getHostString(), isa.getAddress().getHostAddress(), isa.getPort(), bytes);
} else if (remote instanceof UnixDomainSocketAddress udsa) {
String path = "[" + udsa.getPath().toString() + "]";
commit(start, duration, "Unix domain socket", path, 0, bytes);
}
}
}
}

63
src/java.base/share/classes/sun/nio/ch/SocketChannelImpl.java
View file

@ -59,6 +59,8 @@ import static java.net.StandardProtocolFamily.INET;
import static java.net.StandardProtocolFamily.INET6;
import static java.net.StandardProtocolFamily.UNIX;
import jdk.internal.event.SocketReadEvent;
import jdk.internal.event.SocketWriteEvent;
import sun.net.ConnectionResetException;
import sun.net.NetHooks;
import sun.net.ext.ExtendedSocketOptions;
@ -401,8 +403,7 @@ class SocketChannelImpl
throw new SocketException("Connection reset");
}
@Override
public int read(ByteBuffer buf) throws IOException {
private int implRead(ByteBuffer buf) throws IOException {
Objects.requireNonNull(buf);
readLock.lock();
@ -443,8 +444,7 @@ class SocketChannelImpl
}
}
@Override
public long read(ByteBuffer[] dsts, int offset, int length)
private long implRead(ByteBuffer[] dsts, int offset, int length)
throws IOException
{
Objects.checkFromIndexSize(offset, length, dsts.length);
@ -487,6 +487,31 @@ class SocketChannelImpl
}
}
@Override
public int read(ByteBuffer buf) throws IOException {
if (!SocketReadEvent.enabled()) {
return implRead(buf);
}
long start = SocketReadEvent.timestamp();
int nbytes = implRead(buf);
SocketReadEvent.offer(start, nbytes, remoteAddress(), 0);
return nbytes;
}
@Override
public long read(ByteBuffer[] dsts, int offset, int length)
throws IOException
{
if (!SocketReadEvent.enabled()) {
return implRead(dsts, offset, length);
}
long start = SocketReadEvent.timestamp();
long nbytes = implRead(dsts, offset, length);
SocketReadEvent.offer(start, nbytes, remoteAddress(), 0);
return nbytes;
}
/**
* Marks the beginning of a write operation that might block.
*
@ -528,8 +553,7 @@ class SocketChannelImpl
}
}
@Override
public int write(ByteBuffer buf) throws IOException {
private int implWrite(ByteBuffer buf) throws IOException {
Objects.requireNonNull(buf);
writeLock.lock();
try {
@ -557,8 +581,7 @@ class SocketChannelImpl
}
}
@Override
public long write(ByteBuffer[] srcs, int offset, int length)
private long implWrite(ByteBuffer[] srcs, int offset, int length)
throws IOException
{
Objects.checkFromIndexSize(offset, length, srcs.length);
@ -589,6 +612,30 @@ class SocketChannelImpl
}
}
@Override
public int write(ByteBuffer buf) throws IOException {
if (!SocketWriteEvent.enabled()) {
return implWrite(buf);
}
long start = SocketWriteEvent.timestamp();
int nbytes = implWrite(buf);
SocketWriteEvent.offer(start, nbytes, remoteAddress());
return nbytes;
}
@Override
public long write(ByteBuffer[] srcs, int offset, int length)
throws IOException
{
if (!SocketWriteEvent.enabled()) {
return implWrite(srcs, offset, length);
}
long start = SocketWriteEvent.timestamp();
long nbytes = implWrite(srcs, offset, length);
SocketWriteEvent.offer(start, nbytes, remoteAddress());
return nbytes;
}
/**
* Writes a byte of out of band data.
*/