Merge branch 'release/0.3.1'

Author: overheadhunter

.github/workflows/build.yml

@@ -20,7 +20,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install fuse3 libfuse3-dev
       - name: Maven build
-        run: mvn -B verify
+        run: mvn -B verify -Dfuse.lib.path="/lib/x86_64-linux-gnu/libfuse3.so.3"
       - uses: actions/upload-artifact@v3
         with:
           name: coverage-linux-amd64
@@ -29,7 +29,7 @@ jobs:
 
   mac:
     name: Test jfuse-mac
-    runs-on: macos-10.15
+    runs-on: macos-12
     if: "!contains(github.event.head_commit.message, '[ci skip]') && !contains(github.event.head_commit.message, '[skip ci]')"
     steps:
       - uses: actions/checkout@v3
@@ -39,9 +39,12 @@ jobs:
           distribution: 'zulu'
           cache: 'maven'
       - name: Setup fuse
-        run: brew install macfuse
+        run: |
+          brew tap macos-fuse-t/homebrew-cask
+          brew update
+          brew install fuse-t
       - name: Maven build
-        run: mvn -B verify
+        run: mvn -B verify -Dfuse.lib.path="/usr/local/lib/libfuse-t.dylib"
       - uses: actions/upload-artifact@v3
         with:
           name: coverage-mac
@@ -60,9 +63,10 @@ jobs:
           distribution: 'zulu'
           cache: 'maven'
       - name: Setup fuse
-        run: choco install winfsp --version 1.10.22006 -y
+        run: choco install winfsp --version 1.11.22176 -y
       - name: Maven build
-        run: mvn -B verify
+        shell: bash # surprise, running maven in pwsh is crappy, see https://stackoverflow.com/q/6347985/4014509
+        run: mvn -B verify -Dfuse.lib.path="C:\Program Files (x86)\WinFsp\bin\winfsp-x64.dll"
       - uses: actions/upload-artifact@v3
         with:
           name: coverage-win

jfuse-api/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>org.cryptomator</groupId>
 		<artifactId>jfuse-parent</artifactId>
-		<version>0.3.0</version>
+		<version>0.3.1</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>jfuse-api</artifactId>

jfuse-api/src/main/java/org/cryptomator/jfuse/api/Architecture.java

@@ -1,11 +1,29 @@
 package org.cryptomator.jfuse.api;
 
+/**
+ * CPU architecture
+ */
 public enum Architecture {
+	/**
+	 * AMD64 aka. x86_64
+	 */
 	AMD64,
+
+	/**
+	 * ARM64 aka. aarch64
+	 */
 	ARM64,
+
+	/**
+	 * Other or unknown architecture
+	 */
 	UNKNOWN;
 
 	private static final String OS_ARCH = System.getProperty("os.arch").toLowerCase();
+
+	/**
+	 * The CPU architecture of the current machine.
+	 */
 	public static final Architecture CURRENT = getCurrent();
 
 	private static Architecture getCurrent() {

jfuse-api/src/main/java/org/cryptomator/jfuse/api/DirFiller.java

@@ -3,6 +3,10 @@
 import java.io.IOException;
 import java.util.function.Consumer;
 
+/**
+ * The DirFiller will be used during {@link FuseOperations#readdir(String, DirFiller, long, FileInfo, int) readdir} requests
+ * and needs to be invoked by file system implementations once for every child of the read dir.
+ */
 public interface DirFiller {
 
 	/**

jfuse-api/src/main/java/org/cryptomator/jfuse/api/Errno.java

@@ -12,62 +12,86 @@
 public interface Errno {
 
 	/**
-	 * @return code representing: No such file or directory
+	 * No such file or directory
+	 *
+	 * @return error constant {@code ENOENT}
 	 */
 	int enoent();
 
 	/**
-	 * @return code representing: Unsupported operation
+	 * Unsupported operation
+	 *
+	 * @return error constant {@code ENOSYS}
 	 */
 	int enosys();
 
 	/**
-	 * @return code representing: Not enough memory
+	 * Not enough memory
+	 *
+	 * @return error constant {@code ENOMEM}
 	 */
 	int enomem();
 
 	/**
-	 * @return code representing: Permission denied
+	 * Permission denied
+	 *
+	 * @return error constant {@code EACCES}
 	 */
 	int eacces();
 
 	/**
-	 * @return code representing: I/O error
+	 * I/O error
+	 *
+	 * @return error constant {@code EIO}
 	 */
 	int eio();
 
 	/**
-	 * @return code representing: Read only file system
+	 * Read only file system
+	 *
+	 * @return error constant {@code EROFS}
 	 */
 	int erofs();
 
 	/**
-	 * @return code representing: Bad file number
+	 * Bad file number
+	 *
+	 * @return error constant {@code EBADF}
 	 */
 	int ebadf();
 
 	/**
-	 * @return code representing: File already exists
+	 * File already exists
+	 *
+	 * @return error constant {@code EEXIST}
 	 */
 	int eexist();
 
 	/**
-	 * @return code representing: Not a directory
+	 * Not a directory
+	 *
+	 * @return error constant {@code ENOTDIR}
 	 */
 	int enotdir();
 
 	/**
-	 * @return code representing: Is a directory
+	 * Is a directory
+	 *
+	 * @return error constant {@code EISDIR}
 	 */
 	int eisdir();
 
 	/**
-	 * @return code representing: Directory not empty
+	 * Directory not empty
+	 *
+	 * @return error constant {@code ENOTEMPTY}
 	 */
 	int enotempty();
 
 	/**
-	 * @return code representing: Invalid argument
+	 * Invalid argument
+	 *
+	 * @return error constant {@code EINVAL}
 	 */
 	int einval();
 

jfuse-api/src/main/java/org/cryptomator/jfuse/api/FileInfo.java

@@ -3,12 +3,33 @@
 import java.nio.file.StandardOpenOption;
 import java.util.Set;
 
+/**
+ * The {@code fi} argument passed to most calls in {@link FuseOperations} when working on an open file.
+ */
 public interface FileInfo {
 
+	/**
+	 * File handle id. May be filled in by filesystem in {@link FuseOperations#create(String, int, FileInfo) create},
+	 * {@link FuseOperations#open(String, FileInfo) open}, and {@link FuseOperations#opendir(String, FileInfo) opendir()}.
+	 * Available in most other file operations on the same file handle.
+	 *
+	 * @return File handle id
+	 */
 	long getFh();
 
+	/**
+	 * Sets the file handle id during {@link FuseOperations#create(String, int, FileInfo) create},
+	 * {@link FuseOperations#open(String, FileInfo) open} or {@link FuseOperations#opendir(String, FileInfo) opendir()}.
+	 *
+	 * @param fh File handle id
+	 */
 	void setFh(long fh);
 
+	/**
+	 * Open flags. Available in {@link FuseOperations#open(String, FileInfo)} and {@link FuseOperations#release(String, FileInfo)}.
+	 *
+	 * @return Open flags
+	 */
 	int getFlags();
 
 	/**
@@ -21,6 +42,11 @@ public interface FileInfo {
 	 */
 	Set<StandardOpenOption> getOpenFlags();
 
+	/**
+	 * Lock owner id. Available in locking operations and flush
+	 *
+	 * @return Lock owner id
+	 */
 	long getLockOwner();
 
 }

jfuse-api/src/main/java/org/cryptomator/jfuse/api/FileModes.java

@@ -4,14 +4,26 @@
 import java.util.EnumSet;
 import java.util.Set;
 
+/**
+ * Utility for parsing and serializing file permissions to and from octal int representation.
+ */
 @SuppressWarnings("OctalInteger")
 public final class FileModes {
 
+	/**
+	 * Mask of the 9 permission bits in a file mode integer
+	 */
 	public static final int PERMISSIONS_MASK = 0777;
 
 	private FileModes() {
 	}
 
+	/**
+	 * Parses permissions from the 9 least significant bits of the file mode.
+	 *
+	 * @param mode File mode
+	 * @return Parsed permissions
+	 */
 	public static Set<PosixFilePermission> toPermissions(int mode) {
 		Set<PosixFilePermission> permissions = EnumSet.noneOf(PosixFilePermission.class);
 		// @formatter:off
@@ -28,6 +40,12 @@ public static Set<PosixFilePermission> toPermissions(int mode) {
 		return permissions;
 	}
 
+	/**
+	 * Serializes the given permissions into a integer.
+	 *
+	 * @param permissions Permissions
+	 * @return An integer with the {@link #PERMISSIONS_MASK permission bits} set accordingly
+	 */
 	public static int fromPermissions(Set<PosixFilePermission> permissions) {
 		int mode = 0;
 		// @formatter:off