Module org.cryptomator.jfuse.api

Package org.cryptomator.jfuse.api

Class Fuse

java.lang.Object

org.cryptomator.jfuse.api.Fuse

All Implemented Interfaces:

AutoCloseable

public abstract class Fuse
extends Object
implements AutoCloseable

Represents a FUSE file system. Instances of this class are stateful and can not be reused.

The lifecycle starts by creating an instance using the builder, then mounting the file system and closing it when done.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Arena	fuseArena	The memory session associated with the lifecycle of this Fuse instance.
protected final FuseOperations	fuseOperations	The file system operations invoked by this FUSE file system.
protected final MemorySegment	fuseOperationsStruct	The memory segment containing the fuse_operations struct.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Fuse(FuseOperations fuseOperations, Function<SegmentAllocator,MemorySegment> structAllocator)	Creates a new FUSE session.

Method Summary

Modifier and Type	Method	Description
protected abstract void	bind(FuseOperations.Operation operation)	Registers the callback function for the given operation in the fuse_operations struct.
static FuseBuilder	builder()	Gets the builder suitable for the current platform.
void	close()	Unmounts (if needed) this fuse file system and frees up system resources.
void	mount(String progName, Path mountPoint, String... flags)	Mounts this fuse file system at the given mount point.
protected abstract FuseMount	mount(List<String> args)	Mounts the fuse file system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fuseArena

protected final Arena fuseArena

The memory session associated with the lifecycle of this Fuse instance.

fuseOperations

protected final FuseOperations fuseOperations

The file system operations invoked by this FUSE file system.

fuseOperationsStruct

protected final MemorySegment fuseOperationsStruct

The memory segment containing the fuse_operations struct.

Constructor Details

Fuse

protected Fuse(FuseOperations fuseOperations,
 Function<SegmentAllocator,MemorySegment> structAllocator)

Creates a new FUSE session.

Parameters:

fuseOperations - The file system operations

Method Details

builder

public static FuseBuilder builder()

Gets the builder suitable for the current platform.

Returns:

A FuseBuilder

bind

protected abstract void bind(FuseOperations.Operation operation)

Registers the callback function for the given operation in the fuse_operations struct.

Implementers need to make sure to:

1. create an upcall stub for the given operation and save its address at the appropriate position within the fuseOperationsStruct
2. the necessary adaption between native and high-level Java types takes place
3. the adapter calls the corresponding function in fuseOperations

Parameters:

operation - Which function

mount

@Blocking
@MustBeInvokedByOverriders
public void mount(String progName,
 Path mountPoint,
 String... flags)
           throws FuseMountFailedException,
IllegalArgumentException

Mounts this fuse file system at the given mount point.

This method blocks until either FuseOperations.init(FuseConnInfo, FuseConfig) completes or an error occurs.

Parameters:

progName - The program name used to construct a usage message and to derive a fallback for -ofsname=...

mountPoint - mount point

flags - Additional flags. Use flag -help to get a list of available flags

Throws:

FuseMountFailedException - If mounting failed

IllegalArgumentException - If providing unsupported mount flags

mount

@Blocking
protected abstract FuseMount mount(List<String> args)
                            throws FuseMountFailedException,
IllegalArgumentException

Mounts the fuse file system.

Parameters:

args - Mount args

Returns:

A mount object

Throws:

FuseMountFailedException - Thrown if mounting failed

IllegalArgumentException - Thrown if parsing args failed

close

@Blocking
@MustBeInvokedByOverriders
public void close()
           throws TimeoutException

Unmounts (if needed) this fuse file system and frees up system resources.

This method is idempotent and closing multiple times will be no-op.

Important: Before closing, a graceful unmount via system tools (e.g. fusermount -u) should be attempted.

Specified by:

close in interface AutoCloseable

Throws:

TimeoutException