Add a file rename method to the PageCache interface

We need this since only the page cache is aware of any custom IO subsystem configurations we might have, and renaming files is an operation that is used in a fair number of places.

community/io/src/main/java/org/neo4j/io/fs/DefaultFileSystemAbstraction.java

@@ -135,14 +135,9 @@ public void deleteRecursively( File directory ) throws IOException
     }
 
     @Override
-    public boolean move( File from, File to, CopyOption... copyOptions ) throws IOException
+    public void renameFile( File from, File to, CopyOption... copyOptions ) throws IOException
     {
-        if ( copyOptions.length > 0 )
-        {
-            Files.move( from.toPath(), to.toPath(), copyOptions );
-            return true; // will throw if failure
-        }
-        return FileUtils.renameFile( from, to );
+        Files.move( from.toPath(), to.toPath(), copyOptions );
     }
 
     @Override

community/io/src/main/java/org/neo4j/io/fs/DelegateFileSystemAbstraction.java

@@ -38,11 +38,9 @@
 import java.nio.file.StandardCopyOption;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
-import static java.nio.file.StandardCopyOption.ATOMIC_MOVE;
 import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
 
 /**
@@ -170,10 +168,9 @@ public void deleteRecursively( File directory ) throws IOException
     }
 
     @Override
-    public boolean move( File from, File to, CopyOption... copyOptions ) throws IOException
+    public void renameFile( File from, File to, CopyOption... copyOptions ) throws IOException
     {
         Files.move( path( from ), path( to ), copyOptions );
-        return true;
     }
 
     @Override

community/io/src/main/java/org/neo4j/io/fs/FileSystemAbstraction.java

@@ -58,7 +58,7 @@ public interface FileSystemAbstraction
 
     void deleteRecursively( File directory ) throws IOException;
 
-    boolean move( File from, File to, CopyOption... copyOptions ) throws IOException;
+    void renameFile( File from, File to, CopyOption... copyOptions ) throws IOException;
 
     File[] listFiles( File directory );
 

community/io/src/main/java/org/neo4j/io/fs/FileUtils.java

@@ -42,6 +42,7 @@
 import java.nio.channels.SeekableByteChannel;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.CopyOption;
 import java.nio.file.DirectoryStream;
 import java.nio.file.FileVisitResult;
 import java.nio.file.Files;
@@ -120,7 +121,7 @@ public static boolean deleteFile( File file )
      * Utility method that moves a file from its current location to the
      * new target location. If rename fails (for example if the target is
      * another disk) a copy/delete will be performed instead. This is not a rename,
-     * use {@link #renameFile(File, File)} instead.
+     * use {@link #renameFile(File, File, CopyOption...)} instead.
      *
      * @param toMove The File object to move.
      * @param target Target file to move to.
@@ -161,7 +162,7 @@ public static void moveFile( File toMove, File target ) throws IOException
      * Utility method that moves a file from its current location to the
      * provided target directory. If rename fails (for example if the target is
      * another disk) a copy/delete will be performed instead. This is not a rename,
-     * use {@link #renameFile(File, File)} instead.
+     * use {@link #renameFile(File, File, CopyOption...)} instead.
      *
      * @param toMove The File object to move.
      * @param targetDirectory the destination directory
@@ -181,33 +182,9 @@ public static File moveFileToDirectory( File toMove, File targetDirectory ) thro
         return target;
     }
 
-    public static boolean renameFile( File srcFile, File renameToFile ) throws IOException
+    public static void renameFile( File srcFile, File renameToFile, CopyOption... copyOptions ) throws IOException
     {
-        if ( !srcFile.exists() )
-        {
-            throw new FileNotFoundException( "Source file[" + srcFile.getName() + "] not found" );
-        }
-        if ( renameToFile.exists() )
-        {
-            throw new FileNotFoundException( "Target file[" + renameToFile.getName() + "] already exists" );
-        }
-        if ( !renameToFile.getParentFile().isDirectory() )
-        {
-            throw new FileNotFoundException( "Target directory[" + renameToFile.getParent() + "] does not exists" );
-        }
-        int count = 0;
-        boolean renamed;
-        do
-        {
-            renamed = srcFile.renameTo( renameToFile );
-            if ( !renamed )
-            {
-                count++;
-                waitAndThenTriggerGC();
-            }
-        }
-        while ( !renamed && count <= WINDOWS_RETRY_COUNT );
-        return renamed;
+        Files.move( srcFile.toPath(), renameToFile.toPath(), copyOptions );
     }
 
     public static void truncateFile( SeekableByteChannel fileChannel, long position )

community/io/src/main/java/org/neo4j/io/pagecache/PageCache.java

@@ -21,6 +21,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.CopyOption;
 import java.nio.file.OpenOption;
 import java.nio.file.StandardOpenOption;
 import java.util.Optional;
@@ -94,4 +95,17 @@ public interface PageCache extends AutoCloseable
 
     /** The max number of cached pages. */
     int maxCachedPages();
+
+    /**
+     * Move the file from the given source path, to the given target path.
+     *
+     * Both files have to be unmapped when performing the move, otherwise an exception will be thrown.
+     *
+     * @param sourceFile The name of the file to move.
+     * @param targetFile The new name of the file after the move.
+     * @param copyOptions Options to modify the behaviour of the move in possibly platform specific ways. In particular,
+     * {@link java.nio.file.StandardCopyOption#REPLACE_EXISTING} may be used to overwrite any existing file at the
+     * target path name, instead of throwing an exception.
+     */
+    void moveFile( File sourceFile, File targetFile, CopyOption... copyOptions ) throws IOException;
 }

community/io/src/main/java/org/neo4j/io/pagecache/PageSwapperFactory.java

@@ -21,6 +21,8 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.CopyOption;
+import java.nio.file.Path;
 
 import org.neo4j.io.fs.FileSystemAbstraction;
 
@@ -97,4 +99,21 @@ PageSwapper createPageSwapper(
      * durable regardless of which method that does the forcing.
      */
     void syncDevice() throws IOException;
+
+    /**
+     * Move the file by the given source file name, to the path indicated by the given target file name.
+     *
+     * The provided list of {@link CopyOption CopyOptions} can be used to modify and influence platform specific
+     * behaviour. In particular, {@link java.nio.file.StandardCopyOption#REPLACE_EXISTING} may be used to overwrite any
+     * existing file at the target path name, instead of throwing an exception.
+     *
+     * Implementors are free to assume that neither file name will be mapped by the page cache at the time of the move,
+     * and thus the move will see no interference from concurrent IO operations.
+     * @param sourceFile The existing file to move.
+     * @param targetFile The desired new path of the source file. This file should not exist, unless
+     * {@link java.nio.file.StandardCopyOption#REPLACE_EXISTING} is given as a {@code copyOption}.
+     * @param copyOptions Options to modify the behaviour of the move in possibly platform specific ways.
+     * @see java.nio.file.Files#move(Path, Path, CopyOption...)
+     */
+    void moveUnopenedFile( File sourceFile, File targetFile, CopyOption... copyOptions ) throws IOException;
 }

community/io/src/main/java/org/neo4j/io/pagecache/impl/CannotMoveMappedFileException.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2002-2016 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.io.pagecache.impl;
+
+import java.io.File;
+import java.io.IOException;
+
+public class CannotMoveMappedFileException extends IOException
+{
+    public CannotMoveMappedFileException( File file )
+    {
+        super( "Cannot move mapped file: " + file );
+    }
+}

community/io/src/main/java/org/neo4j/io/pagecache/impl/SingleFilePageSwapperFactory.java

@@ -21,6 +21,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.CopyOption;
 import java.nio.file.NoSuchFileException;
 
 import org.neo4j.io.fs.FileSystemAbstraction;
@@ -70,6 +71,12 @@ public void syncDevice()
         // Nothing do to, since we `fsync` files individually in `force()`.
     }
 
+    @Override
+    public void moveUnopenedFile( File sourceFile, File targetFile, CopyOption... copyOptions ) throws IOException
+    {
+        fs.renameFile( sourceFile, targetFile, copyOptions );
+    }
+
     @Override
     public String implementationName()
     {

community/io/src/main/java/org/neo4j/io/pagecache/impl/muninn/MuninnPageCache.java

@@ -21,6 +21,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.CopyOption;
 import java.nio.file.OpenOption;
 import java.nio.file.StandardOpenOption;
 import java.util.Arrays;
@@ -37,6 +38,7 @@
 import org.neo4j.io.pagecache.PageCacheOpenOptions;
 import org.neo4j.io.pagecache.PageSwapperFactory;
 import org.neo4j.io.pagecache.PagedFile;
+import org.neo4j.io.pagecache.impl.CannotMoveMappedFileException;
 import org.neo4j.io.pagecache.tracing.EvictionEvent;
 import org.neo4j.io.pagecache.tracing.EvictionRunEvent;
 import org.neo4j.io.pagecache.tracing.FlushEventOpportunity;
@@ -370,23 +372,50 @@ public synchronized Optional<PagedFile> getExistingMapping( File file ) throws I
         ensureThreadsInitialised();
 
         file = file.getCanonicalFile();
+        MuninnPagedFile pagedFile = tryGetMappingOrNull( file );
+        if ( pagedFile != null )
+        {
+            pagedFile.incrementRefCount();
+            return Optional.of( pagedFile );
+        }
+        return Optional.empty();
+    }
 
+    private MuninnPagedFile tryGetMappingOrNull( File file ) throws IOException
+    {
         FileMapping current = mappedFiles;
 
         // find an existing mapping
         while ( current != null )
         {
             if ( current.file.equals( file ) )
             {
-                MuninnPagedFile pagedFile = current.pagedFile;
-                pagedFile.incrementRefCount();
-                return Optional.of( current.pagedFile );
+                return current.pagedFile;
             }
             current = current.next;
         }
 
         // no mapping exists
-        return Optional.empty();
+        return null;
+    }
+
+    @Override
+    public synchronized void moveFile( File sourceFile, File targetFile, CopyOption... copyOptions )
+            throws IOException
+    {
+        sourceFile = sourceFile.getCanonicalFile();
+        targetFile = targetFile.getCanonicalFile();
+        throwIfMapped( sourceFile );
+        throwIfMapped( targetFile );
+        swapperFactory.moveUnopenedFile( sourceFile, targetFile, copyOptions );
+    }
+
+    private void throwIfMapped( File file ) throws IOException
+    {
+        if ( tryGetMappingOrNull( file ) != null )
+        {
+            throw new CannotMoveMappedFileException( file );
+        }
     }
 
     /**

community/io/src/test/java/org/neo4j/adversaries/fs/AdversarialFileSystemAbstraction.java

@@ -69,10 +69,10 @@ public StoreChannel open( File fileName, String mode ) throws IOException
         return AdversarialFileChannel.wrap( (StoreFileChannel) delegate.open( fileName, mode ), adversary );
     }
 
-    public boolean move( File from, File to, CopyOption... copyOptions ) throws IOException
+    public void renameFile( File from, File to, CopyOption... copyOptions ) throws IOException
     {
         adversary.injectFailure( FileNotFoundException.class, SecurityException.class );
-        return delegate.move( from, to, copyOptions );
+        delegate.renameFile( from, to, copyOptions );
     }
 
     public OutputStream openAsOutputStream( File fileName, boolean append ) throws IOException

community/io/src/test/java/org/neo4j/adversaries/pagecache/AdversarialPageCache.java

@@ -24,6 +24,8 @@
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.nio.file.CopyOption;
+import java.nio.file.FileAlreadyExistsException;
 import java.nio.file.OpenOption;
 import java.nio.file.StandardOpenOption;
 import java.util.Objects;
@@ -33,6 +35,7 @@
 import org.neo4j.io.pagecache.IOLimiter;
 import org.neo4j.io.pagecache.PageCache;
 import org.neo4j.io.pagecache.PagedFile;
+import org.neo4j.io.pagecache.impl.CannotMoveMappedFileException;
 
 /**
  * A {@linkplain PageCache page cache} that wraps another page cache and an {@linkplain Adversary adversary} to provide
@@ -112,4 +115,13 @@ public int maxCachedPages()
     {
         return delegate.maxCachedPages();
     }
+
+    @Override
+    public void moveFile( File sourceFile, File targetFile, CopyOption... copyOptions )
+            throws IOException
+    {
+        adversary.injectFailure( CannotMoveMappedFileException.class, FileAlreadyExistsException.class,
+                IOException.class, SecurityException.class );
+        delegate.moveFile( sourceFile, targetFile, copyOptions );
+    }
 }

community/io/src/test/java/org/neo4j/graphdb/mockfs/DelegatingFileSystemAbstraction.java

@@ -86,9 +86,9 @@ public long lastModifiedTime( File file ) throws IOException
     }
 
     @Override
-    public boolean move( File from, File to, CopyOption... copyOptions ) throws IOException
+    public void renameFile( File from, File to, CopyOption... copyOptions ) throws IOException
     {
-        return delegate.move( from, to, copyOptions );
+        delegate.renameFile( from, to, copyOptions );
     }
 
     @Override