2017-06-19 12:44:49 +00:00
package mountlib
import (
2017-11-09 00:37:27 +00:00
"io"
2017-06-19 12:44:49 +00:00
"log"
2017-11-09 00:37:27 +00:00
"os"
2020-07-23 12:08:38 +00:00
"os/signal"
2019-01-10 14:18:00 +00:00
"path/filepath"
2017-11-16 12:20:53 +00:00
"runtime"
2018-05-03 08:34:07 +00:00
"strings"
2020-11-27 10:50:10 +00:00
"sync"
2020-07-23 12:08:38 +00:00
"syscall"
2018-03-02 16:39:42 +00:00
"time"
2017-06-19 12:44:49 +00:00
2020-09-18 15:37:54 +00:00
sysdnotify "github.com/iguanesolutions/go-systemd/v5/notify"
2017-11-09 00:37:27 +00:00
"github.com/pkg/errors"
2019-07-28 17:47:38 +00:00
"github.com/rclone/rclone/cmd"
"github.com/rclone/rclone/fs"
"github.com/rclone/rclone/fs/config"
"github.com/rclone/rclone/fs/config/flags"
2020-07-23 16:17:01 +00:00
"github.com/rclone/rclone/fs/rc"
2020-07-23 12:08:38 +00:00
"github.com/rclone/rclone/lib/atexit"
2019-07-28 17:47:38 +00:00
"github.com/rclone/rclone/vfs"
"github.com/rclone/rclone/vfs/vfsflags"
2017-06-19 12:44:49 +00:00
"github.com/spf13/cobra"
2020-07-23 16:17:01 +00:00
"github.com/spf13/pflag"
2017-06-19 12:44:49 +00:00
)
2020-07-23 16:17:01 +00:00
// Options for creating the mount
type Options struct {
DebugFUSE bool
AllowNonEmpty bool
AllowRoot bool
AllowOther bool
DefaultPermissions bool
WritebackCache bool
Daemon bool
MaxReadAhead fs . SizeSuffix
2017-11-07 17:09:08 +00:00
ExtraOptions [ ] string
ExtraFlags [ ] string
2020-07-23 16:17:01 +00:00
AttrTimeout time . Duration // how long the kernel caches attribute for
2018-05-03 08:34:07 +00:00
VolumeName string
2020-07-23 16:17:01 +00:00
NoAppleDouble bool
NoAppleXattr bool
2018-07-18 15:21:35 +00:00
DaemonTimeout time . Duration // OSXFUSE only
2020-07-23 16:17:01 +00:00
AsyncRead bool
2020-11-06 13:21:38 +00:00
NetworkMode bool // Windows only
2020-07-23 16:17:01 +00:00
}
// DefaultOpt is the default values for creating the mount
var DefaultOpt = Options {
MaxReadAhead : 128 * 1024 ,
AttrTimeout : 1 * time . Second , // how long the kernel caches attribute for
NoAppleDouble : true , // use noappledouble by default
NoAppleXattr : false , // do not use noapplexattr by default
AsyncRead : true , // do async reads by default
}
2017-06-19 12:44:49 +00:00
2020-04-25 05:03:07 +00:00
type (
// UnmountFn is called to unmount the file system
UnmountFn func ( ) error
// MountFn is called to mount the file system
2020-07-23 16:17:01 +00:00
MountFn func ( VFS * vfs . VFS , mountpoint string , opt * Options ) ( <- chan error , func ( ) error , error )
2020-04-25 05:03:07 +00:00
)
2019-10-18 09:53:07 +00:00
// Global constants
const (
2020-01-19 14:54:55 +00:00
MaxLeafSize = 1024 // don't pass file names longer than this
2019-10-18 09:53:07 +00:00
)
2019-06-24 10:54:38 +00:00
func init ( ) {
2019-10-12 11:41:36 +00:00
// DaemonTimeout defaults to non zero for macOS
if runtime . GOOS == "darwin" {
2020-07-23 16:17:01 +00:00
DefaultOpt . DaemonTimeout = 15 * time . Minute
}
}
// Options set by command line flags
var (
Opt = DefaultOpt
)
// AddFlags adds the non filing system specific flags to the command
func AddFlags ( flagSet * pflag . FlagSet ) {
rc . AddOption ( "mount" , & Opt )
flags . BoolVarP ( flagSet , & Opt . DebugFUSE , "debug-fuse" , "" , Opt . DebugFUSE , "Debug the FUSE internals - needs -v." )
flags . BoolVarP ( flagSet , & Opt . AllowNonEmpty , "allow-non-empty" , "" , Opt . AllowNonEmpty , "Allow mounting over a non-empty directory (not Windows)." )
2020-10-26 10:36:57 +00:00
flags . BoolVarP ( flagSet , & Opt . AllowRoot , "allow-root" , "" , Opt . AllowRoot , "Allow access to root user (not Windows)." )
flags . BoolVarP ( flagSet , & Opt . AllowOther , "allow-other" , "" , Opt . AllowOther , "Allow access to other users (not Windows)." )
2020-07-23 16:17:01 +00:00
flags . BoolVarP ( flagSet , & Opt . DefaultPermissions , "default-permissions" , "" , Opt . DefaultPermissions , "Makes kernel enforce access control based on the file mode." )
flags . BoolVarP ( flagSet , & Opt . WritebackCache , "write-back-cache" , "" , Opt . WritebackCache , "Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used." )
flags . FVarP ( flagSet , & Opt . MaxReadAhead , "max-read-ahead" , "" , "The number of bytes that can be prefetched for sequential reads." )
flags . DurationVarP ( flagSet , & Opt . AttrTimeout , "attr-timeout" , "" , Opt . AttrTimeout , "Time for which file/directory attributes are cached." )
flags . StringArrayVarP ( flagSet , & Opt . ExtraOptions , "option" , "o" , [ ] string { } , "Option for libfuse/WinFsp. Repeat if required." )
flags . StringArrayVarP ( flagSet , & Opt . ExtraFlags , "fuse-flag" , "" , [ ] string { } , "Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required." )
flags . BoolVarP ( flagSet , & Opt . Daemon , "daemon" , "" , Opt . Daemon , "Run mount as a daemon (background mode)." )
flags . StringVarP ( flagSet , & Opt . VolumeName , "volname" , "" , Opt . VolumeName , "Set the volume name (not supported by all OSes)." )
flags . DurationVarP ( flagSet , & Opt . DaemonTimeout , "daemon-timeout" , "" , Opt . DaemonTimeout , "Time limit for rclone to respond to kernel (not supported by all OSes)." )
flags . BoolVarP ( flagSet , & Opt . AsyncRead , "async-read" , "" , Opt . AsyncRead , "Use asynchronous reads." )
if runtime . GOOS == "darwin" {
flags . BoolVarP ( flagSet , & Opt . NoAppleDouble , "noappledouble" , "" , Opt . NoAppleDouble , "Sets the OSXFUSE option noappledouble." )
flags . BoolVarP ( flagSet , & Opt . NoAppleXattr , "noapplexattr" , "" , Opt . NoAppleXattr , "Sets the OSXFUSE option noapplexattr." )
2020-11-06 13:21:38 +00:00
} else if runtime . GOOS == "windows" {
flags . BoolVarP ( flagSet , & Opt . NetworkMode , "network-mode" , "" , Opt . NetworkMode , "Mount as remote network drive, instead of fixed disk drive." )
2019-06-24 10:54:38 +00:00
}
}
2020-10-26 10:36:57 +00:00
// Check if folder is empty
2017-11-09 00:37:27 +00:00
func checkMountEmpty ( mountpoint string ) error {
fp , fpErr := os . Open ( mountpoint )
if fpErr != nil {
return errors . Wrap ( fpErr , "Can not open: " + mountpoint )
}
defer fs . CheckClose ( fp , & fpErr )
_ , fpErr = fp . Readdirnames ( 1 )
// directory is not empty
if fpErr != io . EOF {
var e error
var errorMsg = "Directory is not empty: " + mountpoint + " If you want to mount it anyway use: --allow-non-empty option"
if fpErr == nil {
e = errors . New ( errorMsg )
} else {
e = errors . Wrap ( fpErr , errorMsg )
}
return e
}
return nil
}
2019-01-10 14:18:00 +00:00
// Check the root doesn't overlap the mountpoint
func checkMountpointOverlap ( root , mountpoint string ) error {
abs := func ( x string ) string {
if absX , err := filepath . EvalSymlinks ( x ) ; err == nil {
x = absX
}
if absX , err := filepath . Abs ( x ) ; err == nil {
x = absX
}
x = filepath . ToSlash ( x )
if ! strings . HasSuffix ( x , "/" ) {
x += "/"
}
return x
}
rootAbs , mountpointAbs := abs ( root ) , abs ( mountpoint )
if strings . HasPrefix ( rootAbs , mountpointAbs ) || strings . HasPrefix ( mountpointAbs , rootAbs ) {
return errors . Errorf ( "mount point %q and directory to be mounted %q mustn't overlap" , mountpoint , root )
}
return nil
}
2017-06-19 12:44:49 +00:00
// NewMountCommand makes a mount command with the given name and Mount function
2020-07-23 12:08:38 +00:00
func NewMountCommand ( commandName string , hidden bool , mount MountFn ) * cobra . Command {
2019-10-11 15:58:11 +00:00
var commandDefinition = & cobra . Command {
2020-02-11 12:05:43 +00:00
Use : commandName + " remote:path /path/to/mountpoint" ,
Hidden : hidden ,
Short : ` Mount the remote as file system on a mountpoint. ` ,
2017-06-19 12:44:49 +00:00
Long : `
rclone ` + commandName + ` allows Linux , FreeBSD , macOS and Windows to
mount any of Rclone ' s cloud storage systems as a file system with
FUSE .
First set up your remote using ` + " ` rclone config ` " + ` . Check it works with ` + " ` rclone ls ` " + ` etc .
2020-05-25 23:26:20 +00:00
You can either run mount in foreground mode or background ( daemon ) mode . Mount runs in
2020-10-28 00:27:36 +00:00
foreground mode by default , use the ` + " ` -- daemon ` " + ` flag to specify background mode .
2020-02-10 15:21:22 +00:00
Background mode is only supported on Linux and OSX , you can only run mount in
foreground mode on Windows .
2020-03-31 11:16:03 +00:00
On Linux / macOS / FreeBSD Start the mount like this where ` + " ` / path / to / local / mount ` " + `
is an * * empty * * * * existing * * directory .
2017-06-19 12:44:49 +00:00
rclone ` + commandName + ` remote : path / to / files / path / to / local / mount
2020-03-31 11:16:03 +00:00
Or on Windows like this where ` + " ` X : ` " + ` is an unused drive letter
2020-10-28 00:27:36 +00:00
or ( unless [ mounting as a network drive ] ( # network - drive ) ) use a path
to * * non - existent * * subdirectory of an * * existing * * parent directory or drive .
2017-06-19 12:44:49 +00:00
rclone ` + commandName + ` remote : path / to / files X :
2020-03-31 11:16:03 +00:00
rclone ` + commandName + ` remote : path / to / files C : \ path \ to \ nonexistent \ directory
2017-06-19 12:44:49 +00:00
2020-02-10 15:21:22 +00:00
When running in background mode the user will have to stop the mount manually ( specified below ) .
When the program ends while in foreground mode , either via Ctrl + C or receiving
a SIGINT or SIGTERM signal , the mount is automatically stopped .
2017-06-19 12:44:49 +00:00
The umount operation can fail , for example when the mountpoint is busy .
2020-02-10 15:21:22 +00:00
When that happens , it is the user ' s responsibility to stop the mount manually .
Stopping the mount manually :
2017-06-19 12:44:49 +00:00
# Linux
fusermount - u / path / to / local / mount
# OS X
umount / path / to / local / mount
2020-07-23 09:45:45 +00:00
* * Note * * : As of ` + " ` rclone ` 1.52.2, ` rclone mount ` " + ` now requires Go version 1.13
or newer on some platforms depending on the underlying FUSE library in use .
2018-01-18 19:16:21 +00:00
# # # Installing on Windows
2017-07-23 11:13:29 +00:00
To run rclone ` + commandName + ` on Windows , you will need to
download and install [ WinFsp ] ( http : //www.secfs.net/winfsp/).
2020-05-25 08:08:16 +00:00
[ WinFsp ] ( https : //github.com/billziss-gh/winfsp) is an open source
2017-07-23 11:13:29 +00:00
Windows File System Proxy which makes it easy to write user space file
systems for Windows . It provides a FUSE emulation layer which rclone
uses combination with
[ cgofuse ] ( https : //github.com/billziss-gh/cgofuse). Both of these
packages are by Bill Zissimopoulos who was very helpful during the
implementation of rclone ` + commandName + ` for Windows .
2018-01-18 19:16:21 +00:00
# # # # Windows caveats
2017-07-26 20:08:24 +00:00
Note that drives created as Administrator are not visible by other
accounts ( including the account that was elevated as
Administrator ) . So if you start a Windows drive from an Administrative
Command Prompt and then try to access the same drive from Explorer
( which does not run as Administrator ) , you will not be able to see the
new drive .
The easiest way around this is to start the drive from a normal
command prompt . It is also possible to start a drive from the SYSTEM
account ( using [ the WinFsp . Launcher
infrastructure ] ( https : //github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture))
2018-02-11 17:37:47 +00:00
which creates drives accessible for everyone on the system or
alternatively using [ the nssm service manager ] ( https : //nssm.cc/usage).
2017-07-26 20:08:24 +00:00
2020-02-10 14:42:09 +00:00
# # # # Mount as a network drive
2020-10-28 00:27:36 +00:00
By default , rclone will mount the remote as a normal , fixed disk drive . However ,
you can also mount it as a remote network drive , also known as a network share .
Unlike other operating systems , Microsoft Windows provides a different filesystem
type for network and fixed drives . It optimises access on the assumption fixed
disk drives are fast and reliable , while network drives have relatively high latency
and less reliability . Some settings can also be differentiated between the two types ,
for example that Windows Explorer should just display icons and not create preview
thumbnails for image and video files on network drives .
If you mount an rclone remote using the default , fixed drive mode and experience
unexpected program errors , freezes or other issues , consider mounting the remotes
as a network drive instead .
See also [ Limitations ] ( # limitations ) section below for more info .
To mount as network drive , add ` + " ` -- fuse - flag -- VolumePrefix = \ \ server \ \ share ` " + `
to your ` + commandName + ` command . You may replace the names "server" and "share"
with whatever you like , as long as the combination is unique when you are mounting
more than one drive ( or else the mount command will fail ) . The "share" name will
treated as the volume label for the mapped drive , shown in Windows Explorer etc , while
` + " ` \ \ \ \ server \ \ share ` " + ` will be reported as the remote UNC path by
` + " ` net use ` " + ` etc , just like a normal network drive mapping .
You must use the method of mounting to a drive letter , as mounting to a directory
path is not supported in this case ( a limitation Windows imposes on junctions ) .
2020-02-10 14:42:09 +00:00
[ Read more about drive mapping ] ( https : //en.wikipedia.org/wiki/Drive_mapping)
2018-01-18 19:16:21 +00:00
# # # Limitations
2017-06-19 12:44:49 +00:00
2020-10-28 00:27:36 +00:00
Without the use of ` + " ` -- vfs - cache - mode ` " + ` this can only write files
2018-02-10 09:28:20 +00:00
sequentially , it can only seek when reading . This means that many
applications won ' t work with their files on an rclone mount without
2020-10-28 00:27:36 +00:00
` + " ` -- vfs - cache - mode writes ` " + ` or ` + " ` -- vfs - cache - mode full ` " + ` .
See the [ File Caching ] ( # file - caching ) section for more info .
2017-06-19 12:44:49 +00:00
2020-10-13 21:49:58 +00:00
The bucket based remotes ( e . g . Swift , S3 , Google Compute Storage , B2 ,
2019-08-16 14:36:32 +00:00
Hubic ) do not support the concept of empty directories , so empty
2017-06-19 12:44:49 +00:00
directories will have a tendency to disappear once they fall out of
the directory cache .
Only supported on Linux , FreeBSD , OS X and Windows at the moment .
2018-01-18 19:16:21 +00:00
# # # rclone ` + commandName + ` vs rclone sync / copy
2017-06-19 12:44:49 +00:00
File systems expect things to be 100 % reliable , whereas cloud storage
systems are a long way from 100 % reliable . The rclone sync / copy
commands cope with this with lots of retries . However rclone ` + commandName + `
can ' t use retries in the same way without making local copies of the
2018-10-04 10:37:42 +00:00
uploads . Look at the [ file caching ] ( # file - caching )
2018-11-14 16:11:58 +00:00
for solutions to make ` + commandName + ` more reliable .
2017-06-19 12:44:49 +00:00
2018-03-02 16:39:42 +00:00
# # # Attribute caching
2020-10-28 00:27:36 +00:00
You can use the flag ` + " ` -- attr - timeout ` " + ` to set the time the kernel caches
2020-10-13 22:07:12 +00:00
the attributes ( size , modification time , etc . ) for directory entries .
2018-03-02 16:39:42 +00:00
2018-03-23 22:42:51 +00:00
The default is "1s" which caches files just long enough to avoid
too many callbacks to rclone from the kernel .
In theory 0 s should be the correct value for filesystems which can
change outside the control of the kernel . However this causes quite a
few problems such as
2019-07-28 17:47:38 +00:00
[ rclone using too much memory ] ( https : //github.com/rclone/rclone/issues/2157),
2018-03-23 22:42:51 +00:00
[ rclone not serving files to samba ] ( https : //forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112)
2019-07-28 17:47:38 +00:00
and [ excessive time listing directories ] ( https : //github.com/rclone/rclone/issues/2095#issuecomment-371141147).
2018-03-23 22:42:51 +00:00
The kernel can cache the info about a file for the time given by
2020-10-28 00:27:36 +00:00
` + " ` -- attr - timeout ` " + ` . You may see corruption if the remote file changes
2018-03-23 22:42:51 +00:00
length during this window . It will show up as either a truncated file
2020-10-28 00:27:36 +00:00
or a file with garbage on the end . With ` + " ` -- attr - timeout 1 s ` " + ` this is
very unlikely but not impossible . The higher you set ` + " ` -- attr - timeout ` " + `
2018-03-23 22:42:51 +00:00
the more likely it is . The default setting of "1s" is the lowest
setting which mitigates the problems above .
If you set it higher ( ' 10 s ' or ' 1 m ' say ) then the kernel will call
back to rclone less often making it more efficient , however there is
more chance of the corruption issue above .
If files don ' t change on the remote outside of the control of rclone
then there is no chance of corruption .
2018-03-02 16:39:42 +00:00
This is the same as setting the attr_timeout option in mount . fuse .
2018-01-18 19:16:21 +00:00
# # # Filters
2017-06-19 12:44:49 +00:00
Note that all the rclone filters can be used to select a subset of the
files to be visible in the mount .
2018-01-18 19:16:21 +00:00
# # # systemd
2017-11-19 22:03:49 +00:00
When running rclone ` + commandName + ` as a systemd service , it is possible
2018-01-18 19:16:21 +00:00
to use Type = notify . In this case the service will enter the started state
2017-11-19 22:03:49 +00:00
after the mountpoint has been successfully set up .
Units having the rclone ` + commandName + ` service specified as a requirement
will see all files and folders immediately in this mode .
2018-02-18 14:18:12 +00:00
# # # chunked reading # # #
2020-10-28 00:27:36 +00:00
` + " ` -- vfs - read - chunk - size ` " + ` will enable reading the source objects in parts .
2018-02-18 14:18:12 +00:00
This can reduce the used download quota for some remotes by requesting only chunks
from the remote that are actually read at the cost of an increased number of requests .
2020-10-28 00:27:36 +00:00
When ` + " ` -- vfs - read - chunk - size - limit ` " + ` is also specified and greater than
` + " ` -- vfs - read - chunk - size ` " + ` , the chunk size for each open file will get doubled
for each chunk read , until the specified value is reached . A value of - 1 will disable
the limit and the chunk size will grow indefinitely .
2018-02-18 14:18:12 +00:00
2020-10-28 00:27:36 +00:00
With ` + " ` -- vfs - read - chunk - size 100 M ` " + ` and ` + " ` -- vfs - read - chunk - size - limit 0 ` " + `
the following parts will be downloaded : 0 - 100 M , 100 M - 200 M , 200 M - 300 M , 300 M - 400 M and so on .
When ` + " ` -- vfs - read - chunk - size - limit 500 M ` " + ` is specified , the result would be
2018-02-18 14:18:12 +00:00
0 - 100 M , 100 M - 300 M , 300 M - 700 M , 700 M - 1200 M , 1200 M - 1700 M and so on .
2017-11-13 17:54:21 +00:00
` + vfs . Help ,
2017-06-19 12:44:49 +00:00
Run : func ( command * cobra . Command , args [ ] string ) {
cmd . CheckArgs ( 2 , 2 , command , args )
2020-07-29 13:23:00 +00:00
opt := Opt // make a copy of the options
2018-08-21 08:41:16 +00:00
2020-07-29 13:23:00 +00:00
if opt . Daemon {
2018-08-21 08:41:16 +00:00
config . PassConfigKeyForDaemonization = true
}
2019-01-10 14:18:00 +00:00
mountpoint := args [ 1 ]
2018-05-07 16:58:16 +00:00
fdst := cmd . NewFsDir ( args )
2019-01-10 14:18:00 +00:00
if fdst . Name ( ) == "" || fdst . Name ( ) == "local" {
err := checkMountpointOverlap ( fdst . Root ( ) , mountpoint )
if err != nil {
log . Fatalf ( "Fatal error: %v" , err )
}
}
2017-06-19 12:44:49 +00:00
// Show stats if the user has specifically requested them
if cmd . ShowStats ( ) {
2018-10-03 20:46:18 +00:00
defer cmd . StartStats ( ) ( )
2017-06-19 12:44:49 +00:00
}
2020-10-26 10:36:57 +00:00
// Inform about ignored flags on Windows,
// and if not on Windows and not --allow-non-empty flag is used
// verify that mountpoint is empty.
if runtime . GOOS == "windows" {
if opt . AllowNonEmpty {
fs . Logf ( nil , "--allow-non-empty flag does nothing on Windows" )
}
if opt . AllowRoot {
fs . Logf ( nil , "--allow-root flag does nothing on Windows" )
}
if opt . AllowOther {
fs . Logf ( nil , "--allow-other flag does nothing on Windows" )
}
} else if ! opt . AllowNonEmpty {
2019-01-10 14:18:00 +00:00
err := checkMountEmpty ( mountpoint )
2017-11-09 00:37:27 +00:00
if err != nil {
log . Fatalf ( "Fatal error: %v" , err )
}
}
2018-05-03 08:34:07 +00:00
// Work out the volume name, removing special
// characters from it if necessary
2020-07-29 13:23:00 +00:00
if opt . VolumeName == "" {
opt . VolumeName = fdst . Name ( ) + ":" + fdst . Root ( )
2018-05-03 08:34:07 +00:00
}
2020-07-29 13:23:00 +00:00
opt . VolumeName = strings . Replace ( opt . VolumeName , ":" , " " , - 1 )
opt . VolumeName = strings . Replace ( opt . VolumeName , "/" , " " , - 1 )
opt . VolumeName = strings . TrimSpace ( opt . VolumeName )
if runtime . GOOS == "windows" && len ( opt . VolumeName ) > 32 {
opt . VolumeName = opt . VolumeName [ : 32 ]
2020-03-03 18:59:47 +00:00
}
2018-05-03 08:34:07 +00:00
2018-03-02 13:30:04 +00:00
// Start background task if --background is specified
2020-07-29 13:23:00 +00:00
if opt . Daemon {
2018-03-02 13:30:04 +00:00
daemonized := startBackgroundMode ( )
if daemonized {
return
}
}
2020-07-22 16:58:49 +00:00
VFS := vfs . New ( fdst , & vfsflags . Opt )
2020-07-29 13:23:00 +00:00
err := Mount ( VFS , mountpoint , mount , & opt )
2017-06-19 12:44:49 +00:00
if err != nil {
log . Fatalf ( "Fatal error: %v" , err )
}
} ,
}
// Register the command
2019-10-11 15:58:11 +00:00
cmd . Root . AddCommand ( commandDefinition )
2017-06-19 12:44:49 +00:00
// Add flags
2019-10-11 15:55:04 +00:00
cmdFlags := commandDefinition . Flags ( )
2020-07-23 16:17:01 +00:00
AddFlags ( cmdFlags )
2019-10-11 15:55:04 +00:00
vfsflags . AddFlags ( cmdFlags )
2017-10-24 20:06:06 +00:00
2019-10-11 15:58:11 +00:00
return commandDefinition
2017-06-19 12:44:49 +00:00
}
2018-06-26 08:26:34 +00:00
2020-05-25 06:05:53 +00:00
// ClipBlocks clips the blocks pointed to the OS max
2018-06-26 08:26:34 +00:00
func ClipBlocks ( b * uint64 ) {
var max uint64
switch runtime . GOOS {
case "windows" :
2019-01-25 17:31:56 +00:00
if runtime . GOARCH == "386" {
max = ( 1 << 32 ) - 1
} else {
max = ( 1 << 43 ) - 1
}
2018-06-26 08:26:34 +00:00
case "darwin" :
// OSX FUSE only supports 32 bit number of blocks
// https://github.com/osxfuse/osxfuse/issues/396
max = ( 1 << 32 ) - 1
default :
// no clipping
return
}
if * b > max {
* b = max
}
}
2020-07-23 12:08:38 +00:00
// Mount mounts the remote at mountpoint.
//
// If noModTime is set then it
2020-07-23 16:17:01 +00:00
func Mount ( VFS * vfs . VFS , mountpoint string , mount MountFn , opt * Options ) error {
2020-07-27 14:24:28 +00:00
if opt == nil {
2020-07-23 16:17:01 +00:00
opt = & DefaultOpt
}
2020-07-23 12:08:38 +00:00
// Mount it
2020-07-23 16:17:01 +00:00
errChan , unmount , err := mount ( VFS , mountpoint , opt )
2020-07-23 12:08:38 +00:00
if err != nil {
return errors . Wrap ( err , "failed to mount FUSE fs" )
}
// Unmount on exit
2020-11-27 10:50:10 +00:00
var finaliseOnce sync . Once
finalise := func ( ) {
finaliseOnce . Do ( func ( ) {
_ = sysdnotify . Stopping ( )
_ = unmount ( )
} )
}
fnHandle := atexit . Register ( finalise )
2020-07-23 12:08:38 +00:00
defer atexit . Unregister ( fnHandle )
// Notify systemd
2020-09-18 15:37:54 +00:00
if err := sysdnotify . Ready ( ) ; err != nil {
2020-07-23 12:08:38 +00:00
return errors . Wrap ( err , "failed to notify systemd" )
}
// Reload VFS cache on SIGHUP
sigHup := make ( chan os . Signal , 1 )
signal . Notify ( sigHup , syscall . SIGHUP )
waitloop :
for {
select {
// umount triggered outside the app
case err = <- errChan :
break waitloop
// user sent SIGHUP to clear the cache
case <- sigHup :
root , err := VFS . Root ( )
if err != nil {
fs . Errorf ( VFS . Fs ( ) , "Error reading root: %v" , err )
} else {
root . ForgetAll ( )
}
}
}
2020-11-27 10:50:10 +00:00
finalise ( )
2020-07-23 12:08:38 +00:00
if err != nil {
return errors . Wrap ( err , "failed to umount FUSE fs" )
}
return nil
}