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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
// Public types exported by FuseMT. // // Copyright (c) 2016-2017 by William R. Fraser // use std::ffi::{OsStr, OsString}; use std::path::Path; use fuse; use libc; use time::Timespec; /// Info about a request. #[derive(Clone, Copy, Debug)] pub struct RequestInfo { /// The unique ID assigned to this request by FUSE. pub unique: u64, /// The user ID of the process making the request. pub uid: u32, /// The group ID of the process making the request. pub gid: u32, /// The process ID of the process making the request. pub pid: u32, } /// A directory entry. #[derive(Clone, Debug)] pub struct DirectoryEntry { /// Name of the entry pub name: OsString, /// Kind of file (directory, file, pipe, etc.) pub kind: fuse::FileType, } /// Filesystem statistics. #[derive(Clone, Copy, Debug)] pub struct Statfs { /// Total data blocks in the filesystem pub blocks: u64, /// Free blocks in filesystem pub bfree: u64, /// Free blocks available to unprivileged user pub bavail: u64, /// Total file nodes in filesystem pub files: u64, /// Free file nodes in filesystem pub ffree: u64, /// Optimal transfer block size pub bsize: u32, /// Maximum length of filenames pub namelen: u32, /// Fragment size pub frsize: u32, } /// File attributes. #[derive(Clone, Copy, Debug)] pub struct FileAttr { /// Size in bytes pub size: u64, /// Size in blocks pub blocks: u64, /// Time of last access pub atime: Timespec, /// Time of last modification pub mtime: Timespec, /// Time of last metadata change pub ctime: Timespec, /// Time of creation (macOS only) pub crtime: Timespec, /// Kind of file (directory, file, pipe, etc.) pub kind: fuse::FileType, /// Permissions pub perm: u16, /// Number of hard links pub nlink: u32, /// User ID pub uid: u32, /// Group ID pub gid: u32, /// Device ID (if special file) pub rdev: u32, /// Flags (macOS only; see chflags(2)) pub flags: u32, } /// The return value for `create`: contains info on the newly-created file, as well as a handle to /// the opened file. #[derive(Clone, Debug)] pub struct CreatedEntry { pub ttl: Timespec, pub attr: FileAttr, pub fh: u64, pub flags: u32, } /// Represents the return value from the `listxattr` and `getxattr` calls, which can be either a /// size or contain data, depending on how they are called. #[derive(Clone, Debug)] pub enum Xattr { Size(u32), Data(Vec<u8>), } pub type ResultEmpty = Result<(), libc::c_int>; pub type ResultEntry = Result<(Timespec, FileAttr), libc::c_int>; pub type ResultOpen = Result<(u64, u32), libc::c_int>; pub type ResultReaddir = Result<Vec<DirectoryEntry>, libc::c_int>; pub type ResultData = Result<Vec<u8>, libc::c_int>; pub type ResultWrite = Result<u32, libc::c_int>; pub type ResultStatfs = Result<Statfs, libc::c_int>; pub type ResultCreate = Result<CreatedEntry, libc::c_int>; pub type ResultXattr = Result<Xattr, libc::c_int>; #[deprecated(since = "0.3.0", note = "use ResultEntry instead")] pub type ResultGetattr = ResultEntry; /// This trait must be implemented to implement a filesystem with FuseMT. pub trait FilesystemMT { /// Called on mount, before any other function. fn init(&self, _req: RequestInfo) -> ResultEmpty { Err(0) } /// Called on filesystem unmount. fn destroy(&self, _req: RequestInfo) { // Nothing. } /// Get the attributes of a filesystem entry. /// /// * `fh`: a file handle if this is called on an open file. fn getattr(&self, _req: RequestInfo, _path: &Path, _fh: Option<u64>) -> ResultEntry { Err(libc::ENOSYS) } // The following operations in the FUSE C API are all one kernel call: setattr // We split them out to match the C API's behavior. /// Change the mode of a filesystem entry. /// /// * `fh`: a file handle if this is called on an open file. /// * `mode`: the mode to change the file to. fn chmod(&self, _req: RequestInfo, _path: &Path, _fh: Option<u64>, _mode: u32) -> ResultEmpty { Err(libc::ENOSYS) } /// Change the owner UID and/or group GID of a filesystem entry. /// /// * `fh`: a file handle if this is called on an open file. /// * `uid`: user ID to change the file's owner to. If `None`, leave the UID unchanged. /// * `gid`: group ID to change the file's group to. If `None`, leave the GID unchanged. fn chown(&self, _req: RequestInfo, _path: &Path, _fh: Option<u64>, _uid: Option<u32>, _gid: Option<u32>) -> ResultEmpty { Err(libc::ENOSYS) } /// Set the length of a file. /// /// * `fh`: a file handle if this is called on an open file. /// * `size`: size in bytes to set as the file's length. fn truncate(&self, _req: RequestInfo, _path: &Path, _fh: Option<u64>, _size: u64) -> ResultEmpty { Err(libc::ENOSYS) } /// Set timestamps of a filesystem entry. /// /// * `fh`: a file handle if this is called on an open file. /// * `atime`: the time of last access. /// * `mtime`: the time of last modification. fn utimens(&self, _req: RequestInfo, _path: &Path, _fh: Option<u64>, _atime: Option<Timespec>, _mtime: Option<Timespec>) -> ResultEmpty { Err(libc::ENOSYS) } /// Set timestamps of a filesystem entry (with extra options only used on MacOS). #[allow(unknown_lints, too_many_arguments)] fn utimens_macos(&self, _req: RequestInfo, _path: &Path, _fh: Option<u64>, _crtime: Option<Timespec>, _chgtime: Option<Timespec>, _bkuptime: Option<Timespec>, _flags: Option<u32>) -> ResultEmpty { Err(libc::ENOSYS) } // END OF SETATTR FUNCTIONS /// Read a symbolic link. fn readlink(&self, _req: RequestInfo, _path: &Path) -> ResultData { Err(libc::ENOSYS) } /// Create a special file. /// /// * `parent`: path to the directory to make the entry under. /// * `name`: name of the entry. /// * `mode`: mode for the new entry. /// * `rdev`: if mode has the bits `S_IFCHR` or `S_IFBLK` set, this is the major and minor numbers for the device file. Otherwise it should be ignored. fn mknod(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr, _mode: u32, _rdev: u32) -> ResultEntry { Err(libc::ENOSYS) } /// Create a directory. /// /// * `parent`: path to the directory to make the directory under. /// * `name`: name of the directory. /// * `mode`: permissions for the new directory. fn mkdir(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr, _mode: u32) -> ResultEntry { Err(libc::ENOSYS) } /// Remove a file. /// /// * `parent`: path to the directory containing the file to delete. /// * `name`: name of the file to delete. fn unlink(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr) -> ResultEmpty { Err(libc::ENOSYS) } /// Remove a directory. /// /// * `parent`: path to the directory containing the directory to delete. /// * `name`: name of the directory to delete. fn rmdir(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr) -> ResultEmpty { Err(libc::ENOSYS) } /// Create a symbolic link. /// /// * `parent`: path to the directory to make the link in. /// * `name`: name of the symbolic link. /// * `target`: path (may be relative or absolute) to the target of the link. fn symlink(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr, _target: &Path) -> ResultEntry { Err(libc::ENOSYS) } /// Rename a filesystem entry. /// /// * `parent`: path to the directory containing the existing entry. /// * `name`: name of the existing entry. /// * `newparent`: path to the directory it should be renamed into (may be the same as `parent`). /// * `newname`: name of the new entry. fn rename(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr, _newparent: &Path, _newname: &OsStr) -> ResultEmpty { Err(libc::ENOSYS) } /// Create a hard link. /// /// * `path`: path to an existing file. /// * `newparent`: path to the directory for the new link. /// * `newname`: name for the new link. fn link(&self, _req: RequestInfo, _path: &Path, _newparent: &Path, _newname: &OsStr) -> ResultEntry { Err(libc::ENOSYS) } /// Open a file. /// /// * `path`: path to the file. /// * `flags`: one of `O_RDONLY`, `O_WRONLY`, or `O_RDWR`, plus maybe additional flags. /// /// Return a tuple of (file handle, flags). The file handle will be passed to any subsequent /// calls that operate on the file, and can be any value you choose, though it should allow /// your filesystem to identify the file opened even without any path info. fn open(&self, _req: RequestInfo, _path: &Path, _flags: u32) -> ResultOpen { Err(libc::ENOSYS) } /// Read from a file. /// /// Note that it is not an error for this call to request to read past the end of the file, and /// you should only return data up to the end of the file (i.e. the number of bytes returned /// will be fewer than requested; possibly even zero). Do not extend the file in this case. /// /// * `path`: path to the file. /// * `fh`: file handle returned from the `open` call. /// * `offset`: offset into the file to start reading. /// * `size`: number of bytes to read. /// /// Return the bytes read. fn read(&self, _req: RequestInfo, _path: &Path, _fh: u64, _offset: u64, _size: u32) -> ResultData { Err(libc::ENOSYS) } /// Write to a file. /// /// * `path`: path to the file. /// * `fh`: file handle returned from the `open` call. /// * `offset`: offset into the file to start writing. /// * `data`: the data to write /// * `flags`: /// /// Return the number of bytes written. fn write(&self, _req: RequestInfo, _path: &Path, _fh: u64, _offset: u64, _data: Vec<u8>, _flags: u32) -> ResultWrite { Err(libc::ENOSYS) } /// Called each time a program calls `close` on an open file. /// /// Note that because file descriptors can be duplicated (by `dup`, `dup2`, `fork`) this may be /// called multiple times for a given file handle. The main use of this function is if the /// filesystem would like to return an error to the `close` call. Note that most programs /// ignore the return value of `close`, though. /// /// * `path`: path to the file. /// * `fh`: file handle returned from the `open` call. /// * `lock_owner`: if the filesystem supports locking (`setlk`, `getlk`), remove all locks /// belonging to this lock owner. fn flush(&self, _req: RequestInfo, _path: &Path, _fh: u64, _lock_owner: u64) -> ResultEmpty { Err(libc::ENOSYS) } /// Called when an open file is closed. /// /// There will be one of these for each `open` call. After `release`, no more calls will be /// made with the given file handle. /// /// * `path`: path to the file. /// * `fh`: file handle returned from the `open` call. /// * `flags`: the flags passed when the file was opened. /// * `lock_owner`: if the filesystem supports locking (`setlk`, `getlk`), remove all locks /// belonging to this lock owner. /// * `flush`: whether pending data must be flushed or not. fn release(&self, _req: RequestInfo, _path: &Path, _fh: u64, _flags: u32, _lock_owner: u64, _flush: bool) -> ResultEmpty { Err(libc::ENOSYS) } /// Write out any pending changes of a file. /// /// When this returns, data should be written to persistent storage. /// /// * `path`: path to the file. /// * `fh`: file handle returned from the `open` call. /// * `datasync`: if `false`, also write metadata, otherwise just write file data. fn fsync(&self, _req: RequestInfo, _path: &Path, _fh: u64, _datasync: bool) -> ResultEmpty { Err(libc::ENOSYS) } /// Open a directory. /// /// Analogous to the `opend` call. /// /// * `path`: path to the directory. /// * `flags`: file access flags. Will contain `O_DIRECTORY` at least. /// /// Return a tuple of (file handle, flags). The file handle will be passed to any subsequent /// calls that operate on the directory, and can be any value you choose, though it should /// allow your filesystem to identify the directory opened even without any path info. fn opendir(&self, _req: RequestInfo, _path: &Path, _flags: u32) -> ResultOpen { Err(libc::ENOSYS) } /// Get the entries of a directory. /// /// * `path`: path to the directory. /// * `fh`: file handle returned from the `opendir` call. /// /// Return all the entries of the directory. fn readdir(&self, _req: RequestInfo, _path: &Path, _fh: u64) -> ResultReaddir { Err(libc::ENOSYS) } /// Close an open directory. /// /// This will be called exactly once for each `opendir` call. /// /// * `path`: path to the directory. /// * `fh`: file handle returned from the `opendir` call. /// * `flags`: the file access flags passed to the `opendir` call. fn releasedir(&self, _req: RequestInfo, _path: &Path, _fh: u64, _flags: u32) -> ResultEmpty { Err(libc::ENOSYS) } /// Write out any pending changes to a directory. /// /// Analogous to the `fsync` call. fn fsyncdir(&self, _req: RequestInfo, _path: &Path, _fh: u64, _datasync: bool) -> ResultEmpty { Err(libc::ENOSYS) } /// Get filesystem statistics. /// /// * `path`: path to some folder in the filesystem. /// /// See the `Statfs` struct for more details. fn statfs(&self, _req: RequestInfo, _path: &Path) -> ResultStatfs { Err(libc::ENOSYS) } /// Set a file extended attribute. /// /// * `path`: path to the file. /// * `name`: attribute name. /// * `value`: the data to set the value to. /// * `flags`: can be either `XATTR_CREATE` or `XATTR_REPLACE`. /// * `position`: offset into the attribute value to write data. fn setxattr(&self, _req: RequestInfo, _path: &Path, _name: &OsStr, _value: &[u8], _flags: u32, _position: u32) -> ResultEmpty { Err(libc::ENOSYS) } /// Get a file extended attribute. /// /// * `path`: path to the file /// * `name`: attribute name. /// * `size`: the maximum number of bytes to read. /// /// If `size` is 0, return `Xattr::Size(n)` where `n` is the size of the attribute data. /// Otherwise, return `Xattr::Data(data)` with the requested data. fn getxattr(&self, _req: RequestInfo, _path: &Path, _name: &OsStr, _size: u32) -> ResultXattr { Err(libc::ENOSYS) } /// List extended attributes for a file. /// /// * `path`: path to the file. /// * `size`: maximum number of bytes to return. /// /// If `size` is 0, return `Xattr::Size(n)` where `n` is the size required for the list of /// attribute names. /// Otherwise, return `Xattr::Data(data)` where `data` is all the null-terminated attribute /// names. fn listxattr(&self, _req: RequestInfo, _path: &Path, _size: u32) -> ResultXattr { Err(libc::ENOSYS) } /// Remove an extended attribute for a file. /// /// * `path`: path to the file. /// * `name`: name of the attribute to remove. fn removexattr(&self, _req: RequestInfo, _path: &Path, _name: &OsStr) -> ResultEmpty { Err(libc::ENOSYS) } /// Check for access to a file. /// /// * `path`: path to the file. /// * `mask`: mode bits to check for access to. /// /// Return `Ok(())` if all requested permissions are allowed, otherwise return `Err(EACCES)` /// or other error code as appropriate (e.g. `ENOENT` if the file doesn't exist). fn access(&self, _req: RequestInfo, _path: &Path, _mask: u32) -> ResultEmpty { Err(libc::ENOSYS) } /// Create and open a new file. /// /// * `parent`: path to the directory to create the file in. /// * `name`: name of the file to be created. /// * `mode`: the mode to set on the new file. /// * `flags`: flags like would be passed to `open`. /// /// Return a `CreatedEntry` (which contains the new file's attributes as well as a file handle /// -- see documentation on `open` for more info on that). fn create(&self, _req: RequestInfo, _parent: &Path, _name: &OsStr, _mode: u32, _flags: u32) -> ResultCreate { Err(libc::ENOSYS) } // getlk // setlk // bmap }