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

8329138: Convert JFR FileForceEvent to static mirror event

Browse source 
Reviewed-by: alanb, egahlin
This commit is contained in:
Tim Prinzing 2024-04-30 15:39:23 +00:00 • committed by Alan Bateman
parent 2cc8eccb36
commit f4caac8dea
12 changed files with 252 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

110
src/java.base/share/classes/jdk/internal/event/FileForceEvent.java Normal file
View file

@ -0,0 +1,110 @@
/*
* Copyright (c) 2024, 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;
/**
* A JFR event for forced updates written to files. This event is mirrored in
* {@code jdk.jfr.events.FileForceEvent } where the event annotations are
* provided. 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, boolean)} method
* must be the same as the order of the fields.
*/
public class FileForceEvent extends Event {
// THE ORDER OF THE FOLLOWING FIELDS IS IMPORTANT!
// The order must match the argument order of the generated commit method.
public String path;
public boolean metaData;
/**
* 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, boolean)}.
*
* @param start timestamp of the start of the operation
* @param path the full pathname of the file
* @param metaData true if the file metadata is updated
*/
public static void offer(long start, String path, boolean metaData) {
long duration = timestamp() - start;
if (shouldCommit(duration)) {
commit(start, duration, path, metaData);
}
}
/**
* Actually commit an event. The implementation is generated automatically.
* The order of the fields must be the same as the parameters in this method.
*
* @param start timestamp of the start of the operation
* @param duration time in nanoseconds to complete the operation
* @param path the full pathname of the file
* @param metaData true if the file metadata is updated
*/
public static void commit(long start, long duration, String path, boolean metaData) {
// 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 this type of event is 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;
}
}

15
src/java.base/share/classes/sun/nio/ch/FileChannelImpl.java
View file

@ -50,6 +50,7 @@ import java.util.Objects;
import jdk.internal.access.JavaIOFileDescriptorAccess;
import jdk.internal.access.SharedSecrets;
import jdk.internal.event.FileForceEvent;
import jdk.internal.foreign.MemorySessionImpl;
import jdk.internal.foreign.SegmentFactories;
import jdk.internal.misc.Blocker;
@ -486,8 +487,7 @@ public class FileChannelImpl
}
}
@Override
public void force(boolean metaData) throws IOException {
private void implForce(boolean metaData) throws IOException {
ensureOpen();
int rv = -1;
int ti = -1;
@ -511,6 +511,17 @@ public class FileChannelImpl
}
}
@Override
public void force(boolean metaData) throws IOException {
if (!FileForceEvent.enabled()) {
implForce(metaData);
return;
}
long start = FileForceEvent.timestamp();
implForce(metaData);
FileForceEvent.offer(start, path, metaData);
}
// Assume at first that the underlying kernel supports sendfile/equivalent;
// set this to true if we find out later that it doesn't
//

26
src/java.base/share/classes/sun/nio/ch/SimpleAsynchronousFileChannelImpl.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024, 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
@ -25,6 +25,8 @@
package sun.nio.ch;
import jdk.internal.event.FileForceEvent;
import java.nio.channels.*;
import java.util.concurrent.*;
import java.nio.ByteBuffer;
@ -50,19 +52,25 @@ public class SimpleAsynchronousFileChannelImpl
// Used to make native read and write calls
private static final FileDispatcher nd = new FileDispatcherImpl();
// file path
private final String path;
// Thread-safe set of IDs of native threads, for signalling
private final NativeThreadSet threads = new NativeThreadSet(2);
SimpleAsynchronousFileChannelImpl(FileDescriptor fdObj,
String path,
boolean reading,
boolean writing,
ExecutorService executor)
{
super(fdObj, reading, writing, executor);
this.path = path;
}
public static AsynchronousFileChannel open(FileDescriptor fdo,
String path,
boolean reading,
boolean writing,
ThreadPool pool)
@ -70,7 +78,7 @@ public class SimpleAsynchronousFileChannelImpl
// Executor is either default or based on pool parameters
ExecutorService executor = (pool == null) ?
DefaultExecutorHolder.defaultExecutor : pool.executor();
return new SimpleAsynchronousFileChannelImpl(fdo, reading, writing, executor);
return new SimpleAsynchronousFileChannelImpl(fdo, path, reading, writing, executor);
}
@Override
@ -151,8 +159,7 @@ public class SimpleAsynchronousFileChannelImpl
}
}
@Override
public void force(boolean metaData) throws IOException {
private void implForce(boolean metaData) throws IOException {
int ti = threads.add();
try {
int n = 0;
@ -169,6 +176,17 @@ public class SimpleAsynchronousFileChannelImpl
}
}
@Override
public void force(boolean metaData) throws IOException {
if (!FileForceEvent.enabled()) {
implForce(metaData);
return;
}
long start = FileForceEvent.timestamp();
implForce(metaData);
FileForceEvent.offer(start, path, metaData);
}
@Override
<A> Future<FileLock> implLock(final long position,
final long size,

2
src/java.base/unix/classes/sun/nio/fs/UnixChannelFactory.java
View file

@ -168,7 +168,7 @@ class UnixChannelFactory {
// for now use simple implementation
FileDescriptor fdObj = open(-1, path, null, flags, mode);
return SimpleAsynchronousFileChannelImpl.open(fdObj, flags.read, flags.write, pool);
return SimpleAsynchronousFileChannelImpl.open(fdObj, path.toString(), flags.read, flags.write, pool);
}
/**

26
src/java.base/windows/classes/sun/nio/ch/WindowsAsynchronousFileChannelImpl.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024, 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
@ -33,6 +33,7 @@ import java.io.IOException;
import java.io.FileDescriptor;
import jdk.internal.access.SharedSecrets;
import jdk.internal.access.JavaIOFileDescriptorAccess;
import jdk.internal.event.FileForceEvent;
/**
* Windows implementation of AsynchronousFileChannel using overlapped I/O.
@ -63,6 +64,9 @@ public class WindowsAsynchronousFileChannelImpl
// Used for force/truncate/size methods
private static final FileDispatcher nd = new FileDispatcherImpl();
// file path
private final String path;
// The handle is extracted for use in native methods invoked from this class.
private final long handle;
@ -79,6 +83,7 @@ public class WindowsAsynchronousFileChannelImpl
private WindowsAsynchronousFileChannelImpl(FileDescriptor fdObj,
String path,
boolean reading,
boolean writing,
Iocp iocp,
@ -86,6 +91,7 @@ public class WindowsAsynchronousFileChannelImpl
throws IOException
{
super(fdObj, reading, writing, iocp.executor());
this.path = path;
this.handle = fdAccess.getHandle(fdObj);
this.iocp = iocp;
this.isDefaultIocp = isDefaultIocp;
@ -94,6 +100,7 @@ public class WindowsAsynchronousFileChannelImpl
}
public static AsynchronousFileChannel open(FileDescriptor fdo,
String path,
boolean reading,
boolean writing,
ThreadPool pool)
@ -109,8 +116,7 @@ public class WindowsAsynchronousFileChannelImpl
isDefaultIocp = false;
}
try {
return new
WindowsAsynchronousFileChannelImpl(fdo, reading, writing, iocp, isDefaultIocp);
return new WindowsAsynchronousFileChannelImpl(fdo, path, reading, writing, iocp, isDefaultIocp);
} catch (IOException x) {
// error binding to port so need to close it (if created for this channel)
if (!isDefaultIocp)
@ -196,8 +202,7 @@ public class WindowsAsynchronousFileChannelImpl
return this;
}
@Override
public void force(boolean metaData) throws IOException {
private void implForce(boolean metaData) throws IOException {
try {
begin();
nd.force(fdObj, metaData);
@ -206,6 +211,17 @@ public class WindowsAsynchronousFileChannelImpl
}
}
@Override
public void force(boolean metaData) throws IOException {
if (!FileForceEvent.enabled()) {
implForce(metaData);
return;
}
long start = FileForceEvent.timestamp();
implForce(metaData);
FileForceEvent.offer(start, path, metaData);
}
// -- file locking --
/**

2
src/java.base/windows/classes/sun/nio/fs/WindowsChannelFactory.java
View file

@ -212,7 +212,7 @@ class WindowsChannelFactory {
// create the AsynchronousFileChannel
try {
return WindowsAsynchronousFileChannelImpl.open(fdObj, flags.read, flags.write, pool);
return WindowsAsynchronousFileChannelImpl.open(fdObj, pathForWindows, flags.read, flags.write, pool);
} catch (IOException x) {
// IOException is thrown if the file handle cannot be associated
// with the completion port. All we can do is close the file.