1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
//! FUSE userspace library implementation //! //! This is an improved rewrite of the FUSE userspace library (lowlevel interface) to fully take //! advantage of Rust's architecture. The only thing we rely on in the real libfuse are mount //! and unmount calls which are needed to establish a fd to talk to the kernel driver. #![warn(missing_docs, bad_style, unused, unused_extern_crates, unused_import_braces, unused_qualifications, missing_debug_implementations)] extern crate libc; #[macro_use] extern crate log; extern crate time; extern crate thread_scoped; use std::convert::AsRef; use std::io; use std::ffi::OsStr; use std::path::Path; use std::os::unix::io::RawFd; use libc::{c_int, ENOSYS}; use time::Timespec; pub use kernel::FUSE_ROOT_ID; pub use kernel::consts; pub use reply::{Reply, ReplyEmpty, ReplyData, ReplyEntry, ReplyAttr, ReplyOpen}; pub use reply::{ReplyWrite, ReplyStatfs, ReplyCreate, ReplyLock, ReplyBmap, ReplyDirectory, ReplyDirectoryPlus}; pub use reply::{ReplyXattr, ReplyIoctl, ReplyLseek, ReplyRead}; #[cfg(target_os = "macos")] pub use reply::ReplyXTimes; pub use request::{Request, UtimeSpec}; pub use session::{Session, BackgroundSession}; mod argument; mod channel; mod kernel; #[cfg(feature = "libfuse")] mod libfuse; mod reply; mod request; mod session; mod sys; /// File types #[derive(Clone, Copy, Debug, Hash, PartialEq)] pub enum FileType { /// Named pipe (S_IFIFO) NamedPipe, /// Character device (S_IFCHR) CharDevice, /// Block device (S_IFBLK) BlockDevice, /// Directory (S_IFDIR) Directory, /// Regular file (S_IFREG) RegularFile, /// Symbolic link (S_IFLNK) Symlink, /// Unix domain socket (S_IFSOCK) Socket, } /// File attributes #[derive(Clone, Copy, Debug)] pub struct FileAttr { /// Inode number pub ino: u64, /// Size in bytes pub size: i64, /// Size in blocks pub blocks: u64, /// Time of last access pub atime: Timespec, /// Time of last modification pub mtime: Timespec, /// Time of last change pub ctime: Timespec, /// Time of creation (macOS only) pub crtime: Timespec, /// Kind of file (directory, file, pipe, etc) pub kind: FileType, /// Permissions pub perm: u16, /// Number of hard links pub nlink: u32, /// User id pub uid: u32, /// Group id pub gid: u32, /// Rdev pub rdev: u32, /// Flags (macOS only, see chflags(2)) pub flags: u32, } /// Filesystem trait. /// /// This trait must be implemented to provide a userspace filesystem via FUSE. /// These methods correspond to fuse_lowlevel_ops in libfuse. Reasonable default /// implementations are provided here to get a mountable filesystem that does /// nothing. pub trait Filesystem { /// Initialize filesystem. /// Called before any other filesystem method. fn init(&mut self, _req: &Request) -> Result<(), c_int> { Ok(()) } /// Clean up filesystem. /// Called on filesystem exit. fn destroy(&mut self, _req: &Request) {} /// Look up a directory entry by name and get its attributes. fn lookup(&mut self, _req: &Request, _parent: u64, _name: &OsStr, reply: ReplyEntry) { reply.error(ENOSYS); } /// Forget about an inode. /// The nlookup parameter indicates the number of lookups previously performed on /// this inode. If the filesystem implements inode lifetimes, it is recommended that /// inodes acquire a single reference on each lookup, and lose nlookup references on /// each forget. The filesystem may ignore forget calls, if the inodes don't need to /// have a limited lifetime. On unmount it is not guaranteed, that all referenced /// inodes will receive a forget message. fn forget(&mut self, _req: &Request, _ino: u64, _nlookup: u64) {} /// Like forget, but take multiple forget requests at once for performance. The default /// implementation will fallback to forget. fn forget_multi(&mut self, req: &Request, forget_data: &[kernel::fuse_forget_data]) { for inode in forget_data { self.forget(req, inode.ino, inode.nlookup); } } /// Get file attributes. fn getattr(&mut self, _req: &Request, _ino: u64, reply: ReplyAttr) { reply.error(ENOSYS); } /// Set file attributes. fn setattr(&mut self, _req: &Request, _ino: u64, _mode: Option<u32>, _uid: Option<u32>, _gid: Option<u32>, _size: Option<i64>, _atime: UtimeSpec, _mtime: UtimeSpec, _fh: Option<u64>, _crtime: Option<Timespec>, _chgtime: Option<Timespec>, _bkuptime: Option<Timespec>, _flags: Option<u32>, reply: ReplyAttr) { reply.error(ENOSYS); } /// Read symbolic link. fn readlink(&mut self, _req: &Request, _ino: u64, reply: ReplyData) { reply.error(ENOSYS); } /// Create file node. /// Create a regular file, character device, block device, fifo or socket node. fn mknod(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _mode: u32, _umask: u32, _rdev: u32, reply: ReplyEntry) { reply.error(ENOSYS); } /// Create a directory. fn mkdir(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _mode: u32, _umask: u32, reply: ReplyEntry) { reply.error(ENOSYS); } /// Remove a file. fn unlink(&mut self, _req: &Request, _parent: u64, _name: &OsStr, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Remove a directory. fn rmdir(&mut self, _req: &Request, _parent: u64, _name: &OsStr, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Create a symbolic link. fn symlink(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _link: &Path, reply: ReplyEntry) { reply.error(ENOSYS); } /// Rename a file. fn rename(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _newparent: u64, _newname: &OsStr, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Rename a file. fn rename2(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _newparent: u64, _newname: &OsStr, _flags: u32, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Create a hard link. fn link(&mut self, _req: &Request, _ino: u64, _newparent: u64, _newname: &OsStr, reply: ReplyEntry) { reply.error(ENOSYS); } /// Open a file. /// Open flags (with the exception of O_CREAT, O_EXCL, O_NOCTTY and O_TRUNC) are /// available in flags. Filesystem may store an arbitrary file handle (pointer, index, /// etc) in fh, and use this in other all other file operations (read, write, flush, /// release, fsync). Filesystem may also implement stateless file I/O and not store /// anything in fh. There are also some flags (direct_io, keep_cache) which the /// filesystem may set, to change the way the file is opened. See fuse_file_info /// structure in <fuse_common.h> for more details. fn open(&mut self, _req: &Request, _ino: u64, _flags: u32, reply: ReplyOpen) { reply.opened(0, 0); } /// Read data. /// Read should send exactly the number of bytes requested except on EOF or error, /// otherwise the rest of the data will be substituted with zeroes. An exception to /// this is when the file has been opened in 'direct_io' mode, in which case the /// return value of the read system call will reflect the return value of this /// operation. fh will contain the value set by the open method, or will be undefined /// if the open method didn't set any value. fn read(&mut self, _req: &Request, _ino: u64, _fh: u64, _offset: i64, _size: u32, reply: ReplyRead) { reply.error(ENOSYS); } /// Write data. /// Write should return exactly the number of bytes requested except on error. An /// exception to this is when the file has been opened in 'direct_io' mode, in /// which case the return value of the write system call will reflect the return /// value of this operation. fh will contain the value set by the open method, or /// will be undefined if the open method didn't set any value. fn write(&mut self, _req: &Request, _ino: u64, _fh: u64, _offset: i64, _source_file: Option<RawFd>, _data: &[u8], _size: u32, _flags: u32, reply: ReplyWrite) { reply.error(ENOSYS); } /// Flush method. /// This is called on each close() of the opened file. Since file descriptors can /// be duplicated (dup, dup2, fork), for one open call there may be many flush /// calls. Filesystems shouldn't assume that flush will always be called after some /// writes, or that if will be called at all. fh will contain the value set by the /// open method, or will be undefined if the open method didn't set any value. /// NOTE: the name of the method is misleading, since (unlike fsync) the filesystem /// is not forced to flush pending writes. One reason to flush data, is if the /// filesystem wants to return write errors. If the filesystem supports file locking /// operations (setlk, getlk) it should remove all locks belonging to 'lock_owner'. fn flush(&mut self, _req: &Request, _ino: u64, _fh: u64, _lock_owner: u64, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Release an open file. /// Release is called when there are no more references to an open file: all file /// descriptors are closed and all memory mappings are unmapped. For every open /// call there will be exactly one release call. The filesystem may reply with an /// error, but error values are not returned to close() or munmap() which triggered /// the release. fh will contain the value set by the open method, or will be undefined /// if the open method didn't set any value. flags will contain the same flags as for /// open. fn release(&mut self, _req: &Request, _ino: u64, _fh: u64, _flags: u32, _lock_owner: u64, _flush: bool, reply: ReplyEmpty) { reply.ok(); } /// Synchronize file contents. /// If the datasync parameter is non-zero, then only the user data should be flushed, /// not the meta data. fn fsync(&mut self, _req: &Request, _ino: u64, _fh: u64, _datasync: bool, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Open a directory. /// Filesystem may store an arbitrary file handle (pointer, index, etc) in fh, and /// use this in other all other directory stream operations (readdir, releasedir, /// fsyncdir). Filesystem may also implement stateless directory I/O and not store /// anything in fh, though that makes it impossible to implement standard conforming /// directory stream operations in case the contents of the directory can change /// between opendir and releasedir. fn opendir(&mut self, _req: &Request, _ino: u64, _flags: u32, reply: ReplyOpen) { reply.opened(0, 0); } /// Read directory. /// Send a buffer filled using buffer.fill(), with size not exceeding the /// requested size. Send an empty buffer on end of stream. fh will contain the /// value set by the opendir method, or will be undefined if the opendir method /// didn't set any value. fn readdir(&mut self, _req: &Request, _ino: u64, _fh: u64, _offset: i64, reply: ReplyDirectory) { reply.error(ENOSYS); } /// Read directory. /// Send a buffer filled using buffer.fill(), with size not exceeding the /// requested size. Send an empty buffer on end of stream. fh will contain the /// value set by the opendir method, or will be undefined if the opendir method /// didn't set any value. fn readdirplus(&mut self, _req: &Request, _ino: u64, _fh: u64, _offset: i64, reply: ReplyDirectoryPlus) { reply.error(ENOSYS); } /// Release an open directory. /// For every opendir call there will be exactly one releasedir call. fh will /// contain the value set by the opendir method, or will be undefined if the /// opendir method didn't set any value. fn releasedir(&mut self, _req: &Request, _ino: u64, _fh: u64, _flags: u32, reply: ReplyEmpty) { reply.ok(); } /// Synchronize directory contents. /// If the datasync parameter is set, then only the directory contents should /// be flushed, not the meta data. fh will contain the value set by the opendir /// method, or will be undefined if the opendir method didn't set any value. fn fsyncdir (&mut self, _req: &Request, _ino: u64, _fh: u64, _datasync: bool, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Get file system statistics. fn statfs(&mut self, _req: &Request, _ino: u64, reply: ReplyStatfs) { reply.statfs(0, 0, 0, 0, 0, 512, 255, 0); } /// Set an extended attribute. fn setxattr(&mut self, _req: &Request, _ino: u64, _name: &OsStr, _value: &[u8], _flags: u32, _position: u32, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Get an extended attribute. /// If `size` is 0, the size of the value should be sent with `reply.size()`. /// If `size` is not 0, and the value fits, send it with `reply.data()`, or /// `reply.error(ERANGE)` if it doesn't. fn getxattr(&mut self, _req: &Request, _ino: u64, _name: &OsStr, _size: u32, reply: ReplyXattr) { reply.error(ENOSYS); } /// List extended attribute names. /// If `size` is 0, the size of the value should be sent with `reply.size()`. /// If `size` is not 0, and the value fits, send it with `reply.data()`, or /// `reply.error(ERANGE)` if it doesn't. fn listxattr(&mut self, _req: &Request, _ino: u64, _size: u32, reply: ReplyXattr) { reply.error(ENOSYS); } /// Remove an extended attribute. fn removexattr(&mut self, _req: &Request, _ino: u64, _name: &OsStr, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Check file access permissions. /// This will be called for the access() system call. If the 'default_permissions' /// mount option is given, this method is not called. This method is not called /// under Linux kernel versions 2.4.x fn access(&mut self, _req: &Request, _ino: u64, _mask: u32, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Create and open a file. /// If the file does not exist, first create it with the specified mode, and then /// open it. Open flags (with the exception of O_NOCTTY) are available in flags. /// Filesystem may store an arbitrary file handle (pointer, index, etc) in fh, /// and use this in other all other file operations (read, write, flush, release, /// fsync). There are also some flags (direct_io, keep_cache) which the /// filesystem may set, to change the way the file is opened. See fuse_file_info /// structure in <fuse_common.h> for more details. If this method is not /// implemented or under Linux kernel versions earlier than 2.6.15, the mknod() /// and open() methods will be called instead. fn create(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _mode: u32, _umask: u32, _flags: u32, reply: ReplyCreate) { reply.error(ENOSYS); } /// Test for a POSIX file lock. fn getlk(&mut self, _req: &Request, _ino: u64, _fh: u64, _lock_owner: u64, _start: u64, _end: u64, _typ: u32, _pid: u32, reply: ReplyLock) { reply.error(ENOSYS); } /// Acquire, modify or release a POSIX file lock. /// For POSIX threads (NPTL) there's a 1-1 relation between pid and owner, but /// otherwise this is not always the case. For checking lock ownership, /// 'fi->owner' must be used. The l_pid field in 'struct flock' should only be /// used to fill in this field in getlk(). Note: if the locking methods are not /// implemented, the kernel will still allow file locking to work locally. /// Hence these are only interesting for network filesystems and similar. fn setlk(&mut self, _req: &Request, _ino: u64, _fh: u64, _lock_owner: u64, _start: u64, _end: u64, _typ: u32, _pid: u32, _sleep: bool, reply: ReplyEmpty) { reply.error(ENOSYS); } /// Map block index within file to block index within device. /// Note: This makes sense only for block device backed filesystems mounted /// with the 'blkdev' option fn bmap(&mut self, _req: &Request, _ino: u64, _blocksize: u32, _idx: u64, reply: ReplyBmap) { reply.error(ENOSYS); } /// control device fn ioctl(&mut self, _req: &Request, _ino: u64, _fh: u64, _flags: u32, _cmd: u32, _in_data: Option<&[u8]>, _out_size: u32, reply: ReplyIoctl) { reply.error(ENOSYS); } /// Preallocate or deallocate space to a file fn fallocate(&mut self, _req: &Request, _ino: u64, _fh: u64, _offset: i64, _length: i64, _mode: i32, reply: ReplyEmpty) { reply.error(ENOSYS); } /// macOS only: Rename the volume. Set fuse_init_out.flags during init to /// FUSE_VOL_RENAME to enable #[cfg(target_os = "macos")] fn setvolname(&mut self, _req: &Request, _name: &OsStr, reply: ReplyEmpty) { reply.error(ENOSYS); } /// macOS only (undocumented) #[cfg(target_os = "macos")] fn exchange(&mut self, _req: &Request, _parent: u64, _name: &OsStr, _newparent: u64, _newname: &OsStr, _options: u64, reply: ReplyEmpty) { reply.error(ENOSYS); } /// macOS only: Query extended times (bkuptime and crtime). Set fuse_init_out.flags /// during init to FUSE_XTIMES to enable #[cfg(target_os = "macos")] fn getxtimes(&mut self, _req: &Request, _ino: u64, reply: ReplyXTimes) { reply.error(ENOSYS); } /// Reposition read/write file offset fn lseek(&mut self, _req: &Request, _ino: u64, _fh: u64, _offset: i64, _whence: u32, reply: ReplyLseek) { reply.error(ENOSYS); } } /// Mount the given filesystem to the given mountpoint. This function will /// not return until the filesystem is unmounted. #[cfg(feature = "libfuse")] pub fn mount<FS: Filesystem, P: AsRef<Path>>(filesystem: FS, mountpoint: &P, options: &[&OsStr]) -> io::Result<()>{ Session::new(filesystem, mountpoint.as_ref(), options, false).and_then(|mut se| se.run()) } /// Mount the given filesystem to the given mountpoint. This function spawns /// a background thread to handle filesystem operations while being mounted /// and therefore returns immediately. The returned handle should be stored /// to reference the mounted filesystem. If it's dropped, the filesystem will /// be unmounted. #[cfg(feature = "libfuse")] pub unsafe fn spawn_mount<'a, FS: Filesystem+Send+'a, P: AsRef<Path>>(filesystem: FS, mountpoint: &P, options: &[&OsStr]) -> io::Result<BackgroundSession<'a>> { Session::new(filesystem, mountpoint.as_ref(), options, false).and_then(|se| se.spawn()) }