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 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
// Copyright 2019 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
use std::mem;
use bitflags::bitflags;
use enumn::N;
use zerocopy::AsBytes;
use zerocopy::FromBytes;
use zerocopy::FromZeroes;
/// Version number of this interface.
pub const KERNEL_VERSION: u32 = 7;
/// Oldest supported minor version of the fuse interface.
pub const OLDEST_SUPPORTED_KERNEL_MINOR_VERSION: u32 = 27;
/// Minor version number of this interface.
pub const KERNEL_MINOR_VERSION: u32 = 31;
/// The ID of the inode corresponding to the root directory of the file system.
pub const ROOT_ID: u64 = 1;
// Bitmasks for `fuse_setattr_in.valid`.
const FATTR_MODE: u32 = 1;
const FATTR_UID: u32 = 2;
const FATTR_GID: u32 = 4;
const FATTR_SIZE: u32 = 8;
const FATTR_ATIME: u32 = 16;
const FATTR_MTIME: u32 = 32;
pub const FATTR_FH: u32 = 64;
const FATTR_ATIME_NOW: u32 = 128;
const FATTR_MTIME_NOW: u32 = 256;
pub const FATTR_LOCKOWNER: u32 = 512;
const FATTR_CTIME: u32 = 1024;
bitflags! {
#[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[repr(transparent)]
pub struct SetattrValid: u32 {
const MODE = FATTR_MODE;
const UID = FATTR_UID;
const GID = FATTR_GID;
const SIZE = FATTR_SIZE;
const ATIME = FATTR_ATIME;
const MTIME = FATTR_MTIME;
const ATIME_NOW = FATTR_ATIME_NOW;
const MTIME_NOW = FATTR_MTIME_NOW;
const CTIME = FATTR_CTIME;
}
}
// Flags returned by the OPEN request.
/// Bypass page cache for this open file.
const FOPEN_DIRECT_IO: u32 = 1 << 0;
/// Don't invalidate the data cache on open.
const FOPEN_KEEP_CACHE: u32 = 1 << 1;
/// The file is not seekable.
const FOPEN_NONSEEKABLE: u32 = 1 << 2;
/// Allow caching the directory entries.
const FOPEN_CACHE_DIR: u32 = 1 << 3;
/// This file is stream-like (i.e., no file position).
const FOPEN_STREAM: u32 = 1 << 4;
/// New file was created in atomic open
const FOPEN_FILE_CREATED: u32 = 1 << 7;
bitflags! {
/// Options controlling the behavior of files opened by the server in response
/// to an open or create request.
#[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[repr(transparent)]
pub struct OpenOptions: u32 {
const DIRECT_IO = FOPEN_DIRECT_IO;
const KEEP_CACHE = FOPEN_KEEP_CACHE;
const NONSEEKABLE = FOPEN_NONSEEKABLE;
const CACHE_DIR = FOPEN_CACHE_DIR;
const STREAM = FOPEN_STREAM;
const FILE_CREATED = FOPEN_FILE_CREATED;
}
}
// INIT request/reply flags.
/// Asynchronous read requests.
const ASYNC_READ: u64 = 1;
/// Remote locking for POSIX file locks.
const POSIX_LOCKS: u64 = 2;
/// Kernel sends file handle for fstat, etc... (not yet supported).
const FILE_OPS: u64 = 4;
/// Handles the O_TRUNC open flag in the filesystem.
const ATOMIC_O_TRUNC: u64 = 8;
/// FileSystem handles lookups of "." and "..".
const EXPORT_SUPPORT: u64 = 16;
/// FileSystem can handle write size larger than 4kB.
const BIG_WRITES: u64 = 32;
/// Don't apply umask to file mode on create operations.
const DONT_MASK: u64 = 64;
/// Kernel supports splice write on the device.
const SPLICE_WRITE: u64 = 128;
/// Kernel supports splice move on the device.
const SPLICE_MOVE: u64 = 256;
/// Kernel supports splice read on the device.
const SPLICE_READ: u64 = 512;
/// Remote locking for BSD style file locks.
const FLOCK_LOCKS: u64 = 1024;
/// Kernel supports ioctl on directories.
const HAS_IOCTL_DIR: u64 = 2048;
/// Automatically invalidate cached pages.
const AUTO_INVAL_DATA: u64 = 4096;
/// Do READDIRPLUS (READDIR+LOOKUP in one).
const DO_READDIRPLUS: u64 = 8192;
/// Adaptive readdirplus.
const READDIRPLUS_AUTO: u64 = 16384;
/// Asynchronous direct I/O submission.
const ASYNC_DIO: u64 = 32768;
/// Use writeback cache for buffered writes.
const WRITEBACK_CACHE: u64 = 65536;
/// Kernel supports zero-message opens.
const NO_OPEN_SUPPORT: u64 = 131072;
/// Allow parallel lookups and readdir.
const PARALLEL_DIROPS: u64 = 262144;
/// Fs handles killing suid/sgid/cap on write/chown/trunc.
const HANDLE_KILLPRIV: u64 = 524288;
/// FileSystem supports posix acls.
const POSIX_ACL: u64 = 1048576;
/// Reading the device after an abort returns `ECONNABORTED`.
const ABORT_ERROR: u64 = 2097152;
/// The reply to the `init` message contains the max number of request pages.
const MAX_PAGES: u64 = 4194304;
/// Cache `readlink` responses.
const CACHE_SYMLINKS: u64 = 8388608;
/// Kernel supports zero-message opens for directories.
const NO_OPENDIR_SUPPORT: u64 = 16777216;
/// Kernel supports explicit cache invalidation.
const EXPLICIT_INVAL_DATA: u64 = 33554432;
/// The `map_alignment` field of the `InitOut` struct is valid.
const MAP_ALIGNMENT: u64 = 67108864;
/// Extended fuse_init_in request to hold additional flags
const INIT_EXT: u64 = 1073741824;
/// The client should send the security context along with open, mkdir, create, and symlink
/// requests.
const SECURITY_CONTEXT: u64 = 4294967296;
bitflags! {
/// A bitfield passed in as a parameter to and returned from the `init` method of the
/// `FileSystem` trait.
#[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[repr(transparent)]
pub struct FsOptions: u64 {
/// Indicates that the filesystem supports asynchronous read requests.
///
/// If this capability is not requested/available, the kernel will ensure that there is at
/// most one pending read request per file-handle at any time, and will attempt to order
/// read requests by increasing offset.
///
/// This feature is enabled by default when supported by the kernel.
const ASYNC_READ = ASYNC_READ;
/// Indicates that the filesystem supports "remote" locking.
///
/// This feature is not enabled by default and should only be set if the filesystem
/// implements the `getlk` and `setlk` methods of the `FileSystem` trait.
const POSIX_LOCKS = POSIX_LOCKS;
/// Kernel sends file handle for fstat, etc... (not yet supported).
const FILE_OPS = FILE_OPS;
/// Indicates that the filesystem supports the `O_TRUNC` open flag. If disabled, and an
/// application specifies `O_TRUNC`, fuse first calls `setattr` to truncate the file and
/// then calls `open` with `O_TRUNC` filtered out.
///
/// This feature is enabled by default when supported by the kernel.
const ATOMIC_O_TRUNC = ATOMIC_O_TRUNC;
/// Indicates that the filesystem supports lookups of "." and "..".
///
/// This feature is disabled by default.
const EXPORT_SUPPORT = EXPORT_SUPPORT;
/// FileSystem can handle write size larger than 4kB.
const BIG_WRITES = BIG_WRITES;
/// Indicates that the kernel should not apply the umask to the file mode on create
/// operations.
///
/// This feature is disabled by default.
const DONT_MASK = DONT_MASK;
/// Indicates that the server should try to use `splice(2)` when writing to the fuse device.
/// This may improve performance.
///
/// This feature is not currently supported.
const SPLICE_WRITE = SPLICE_WRITE;
/// Indicates that the server should try to move pages instead of copying when writing to /
/// reading from the fuse device. This may improve performance.
///
/// This feature is not currently supported.
const SPLICE_MOVE = SPLICE_MOVE;
/// Indicates that the server should try to use `splice(2)` when reading from the fuse
/// device. This may improve performance.
///
/// This feature is not currently supported.
const SPLICE_READ = SPLICE_READ;
/// If set, then calls to `flock` will be emulated using POSIX locks and must
/// then be handled by the filesystem's `setlock()` handler.
///
/// If not set, `flock` calls will be handled by the FUSE kernel module internally (so any
/// access that does not go through the kernel cannot be taken into account).
///
/// This feature is disabled by default.
const FLOCK_LOCKS = FLOCK_LOCKS;
/// Indicates that the filesystem supports ioctl's on directories.
///
/// This feature is enabled by default when supported by the kernel.
const HAS_IOCTL_DIR = HAS_IOCTL_DIR;
/// Traditionally, while a file is open the FUSE kernel module only asks the filesystem for
/// an update of the file's attributes when a client attempts to read beyond EOF. This is
/// unsuitable for e.g. network filesystems, where the file contents may change without the
/// kernel knowing about it.
///
/// If this flag is set, FUSE will check the validity of the attributes on every read. If
/// the attributes are no longer valid (i.e., if the *attribute* timeout has expired) then
/// FUSE will first send another `getattr` request. If the new mtime differs from the
/// previous value, any cached file *contents* will be invalidated as well.
///
/// This flag should always be set when available. If all file changes go through the
/// kernel, *attribute* validity should be set to a very large number to avoid unnecessary
/// `getattr()` calls.
///
/// This feature is enabled by default when supported by the kernel.
const AUTO_INVAL_DATA = AUTO_INVAL_DATA;
/// Indicates that the filesystem supports readdirplus.
///
/// The feature is not enabled by default and should only be set if the filesystem
/// implements the `readdirplus` method of the `FileSystem` trait.
const DO_READDIRPLUS = DO_READDIRPLUS;
/// Indicates that the filesystem supports adaptive readdirplus.
///
/// If `DO_READDIRPLUS` is not set, this flag has no effect.
///
/// If `DO_READDIRPLUS` is set and this flag is not set, the kernel will always issue
/// `readdirplus()` requests to retrieve directory contents.
///
/// If `DO_READDIRPLUS` is set and this flag is set, the kernel will issue both `readdir()`
/// and `readdirplus()` requests, depending on how much information is expected to be
/// required.
///
/// This feature is not enabled by default and should only be set if the file system
/// implements both the `readdir` and `readdirplus` methods of the `FileSystem` trait.
const READDIRPLUS_AUTO = READDIRPLUS_AUTO;
/// Indicates that the filesystem supports asynchronous direct I/O submission.
///
/// If this capability is not requested/available, the kernel will ensure that there is at
/// most one pending read and one pending write request per direct I/O file-handle at any
/// time.
///
/// This feature is enabled by default when supported by the kernel.
const ASYNC_DIO = ASYNC_DIO;
/// Indicates that writeback caching should be enabled. This means that individual write
/// request may be buffered and merged in the kernel before they are sent to the file
/// system.
///
/// This feature is disabled by default.
const WRITEBACK_CACHE = WRITEBACK_CACHE;
/// Indicates support for zero-message opens. If this flag is set in the `capable` parameter
/// of the `init` trait method, then the file system may return `ENOSYS` from the open() handler
/// to indicate success. Further attempts to open files will be handled in the kernel. (If
/// this flag is not set, returning ENOSYS will be treated as an error and signaled to the
/// caller).
///
/// Setting (or not setting) the field in the `FsOptions` returned from the `init` method
/// has no effect.
const ZERO_MESSAGE_OPEN = NO_OPEN_SUPPORT;
/// Indicates support for parallel directory operations. If this flag is unset, the FUSE
/// kernel module will ensure that lookup() and readdir() requests are never issued
/// concurrently for the same directory.
///
/// This feature is enabled by default when supported by the kernel.
const PARALLEL_DIROPS = PARALLEL_DIROPS;
/// Indicates that the file system is responsible for unsetting setuid and setgid bits when a
/// file is written, truncated, or its owner is changed.
///
/// This feature is enabled by default when supported by the kernel.
const HANDLE_KILLPRIV = HANDLE_KILLPRIV;
/// Indicates support for POSIX ACLs.
///
/// If this feature is enabled, the kernel will cache and have responsibility for enforcing
/// ACLs. ACL will be stored as xattrs and passed to userspace, which is responsible for
/// updating the ACLs in the filesystem, keeping the file mode in sync with the ACL, and
/// ensuring inheritance of default ACLs when new filesystem nodes are created. Note that
/// this requires that the file system is able to parse and interpret the xattr
/// representation of ACLs.
///
/// Enabling this feature implicitly turns on the `default_permissions` mount option (even
/// if it was not passed to mount(2)).
///
/// This feature is disabled by default.
const POSIX_ACL = POSIX_ACL;
/// Indicates that the kernel may cache responses to `readlink` calls.
const CACHE_SYMLINKS = CACHE_SYMLINKS;
/// Indicates support for zero-message opens for directories. If this flag is set in the
/// `capable` parameter of the `init` trait method, then the file system may return `ENOSYS`
/// from the opendir() handler to indicate success. Further attempts to open directories
/// will be handled in the kernel. (If this flag is not set, returning ENOSYS will be
/// treated as an error and signaled to the caller).
///
/// Setting (or not setting) the field in the `FsOptions` returned from the `init` method
/// has no effect.
const ZERO_MESSAGE_OPENDIR = NO_OPENDIR_SUPPORT;
/// Indicates support for invalidating cached pages only on explicit request.
///
/// If this flag is set in the `capable` parameter of the `init` trait method, then the FUSE
/// kernel module supports invalidating cached pages only on explicit request by the
/// filesystem.
///
/// By setting this flag in the return value of the `init` trait method, the filesystem is
/// responsible for invalidating cached pages through explicit requests to the kernel.
///
/// Note that setting this flag does not prevent the cached pages from being flushed by OS
/// itself and/or through user actions.
///
/// Note that if both EXPLICIT_INVAL_DATA and AUTO_INVAL_DATA are set in the `capable`
/// parameter of the `init` trait method then AUTO_INVAL_DATA takes precedence.
///
/// This feature is disabled by default.
const EXPLICIT_INVAL_DATA = EXPLICIT_INVAL_DATA;
/// Indicates that the `map_alignment` field of the `InitOut` struct is valid.
///
/// The `MAP_ALIGNMENT` field is used by the FUSE kernel driver to ensure that its DAX
/// mapping requests are pagesize-aligned. This field automatically set by the server and
/// this feature is enabled by default.
const MAP_ALIGNMENT = MAP_ALIGNMENT;
/// Indicates that the `max_pages` field of the `InitOut` struct is valid.
///
/// This field is used by the kernel driver to determine the maximum number of pages that
/// may be used for any read or write requests.
const MAX_PAGES = MAX_PAGES;
/// Indicates that `InitIn`/`InitOut` struct is extended to hold additional flags.
const INIT_EXT = INIT_EXT;
/// Indicates support for sending the security context with creation requests.
const SECURITY_CONTEXT = SECURITY_CONTEXT;
}
}
// Release flags.
pub const RELEASE_FLUSH: u32 = 1;
pub const RELEASE_FLOCK_UNLOCK: u32 = 2;
// Getattr flags.
pub const GETATTR_FH: u32 = 1;
// Lock flags.
pub const LK_FLOCK: u32 = 1;
// Write flags.
/// Delayed write from page cache, file handle is guessed.
pub const WRITE_CACHE: u32 = 1;
/// `lock_owner` field is valid.
pub const WRITE_LOCKOWNER: u32 = 2;
/// Kill the suid and sgid bits.
pub const WRITE_KILL_PRIV: u32 = 3;
// Read flags.
pub const READ_LOCKOWNER: u32 = 2;
// Ioctl flags.
/// 32bit compat ioctl on 64bit machine
const IOCTL_COMPAT: u32 = 1;
/// Not restricted to well-formed ioctls, retry allowed
const IOCTL_UNRESTRICTED: u32 = 2;
/// Retry with new iovecs
const IOCTL_RETRY: u32 = 4;
/// 32bit ioctl
const IOCTL_32BIT: u32 = 8;
/// Is a directory
const IOCTL_DIR: u32 = 16;
/// 32-bit compat ioctl on 64-bit machine with 64-bit time_t.
const IOCTL_COMPAT_X32: u32 = 32;
/// Maximum of in_iovecs + out_iovecs
pub const IOCTL_MAX_IOV: usize = 256;
bitflags! {
#[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[repr(transparent)]
pub struct IoctlFlags: u32 {
/// 32bit compat ioctl on 64bit machine
const COMPAT = IOCTL_COMPAT;
/// Not restricted to well-formed ioctls, retry allowed
const UNRESTRICTED = IOCTL_UNRESTRICTED;
/// Retry with new iovecs
const RETRY = IOCTL_RETRY;
/// 32bit ioctl
const IOCTL_32BIT = IOCTL_32BIT;
/// Is a directory
const DIR = IOCTL_DIR;
/// 32-bit compat ioctl on 64-bit machine with 64-bit time_t.
const COMPAT_X32 = IOCTL_COMPAT_X32;
}
}
/// Request poll notify.
pub const POLL_SCHEDULE_NOTIFY: u32 = 1;
/// The read buffer is required to be at least 8k, but may be much larger.
pub const FUSE_MIN_READ_BUFFER: u32 = 8192;
pub const FUSE_COMPAT_ENTRY_OUT_SIZE: u32 = 120;
pub const FUSE_COMPAT_ATTR_OUT_SIZE: u32 = 96;
pub const FUSE_COMPAT_MKNOD_IN_SIZE: u32 = 8;
pub const FUSE_COMPAT_WRITE_IN_SIZE: u32 = 24;
pub const FUSE_COMPAT_STATFS_SIZE: u32 = 48;
pub const FUSE_COMPAT_INIT_OUT_SIZE: u32 = 8;
pub const FUSE_COMPAT_22_INIT_OUT_SIZE: u32 = 24;
const SETUPMAPPING_FLAG_WRITE: u64 = 1;
const SETUPMAPPING_FLAG_READ: u64 = 2;
bitflags! {
#[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[repr(transparent)]
pub struct SetUpMappingFlags: u64 {
/// Create writable mapping.
const WRITE = SETUPMAPPING_FLAG_WRITE;
/// Create readable mapping.
const READ = SETUPMAPPING_FLAG_READ;
}
}
// Request Extension Constants
/// Maximum security contexts in a request
pub const MAX_NR_SECCTX: u32 = 31;
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Attr {
pub ino: u64,
pub size: u64,
pub blocks: u64,
pub atime: u64,
pub mtime: u64,
pub ctime: u64,
pub atimensec: u32,
pub mtimensec: u32,
pub ctimensec: u32,
pub mode: u32,
pub nlink: u32,
pub uid: u32,
pub gid: u32,
pub rdev: u32,
pub blksize: u32,
pub padding: u32,
}
impl From<libc::stat64> for Attr {
fn from(st: libc::stat64) -> Attr {
Attr {
ino: st.st_ino,
size: st.st_size as u64,
blocks: st.st_blocks as u64,
atime: st.st_atime as u64,
mtime: st.st_mtime as u64,
ctime: st.st_ctime as u64,
atimensec: st.st_atime_nsec as u32,
mtimensec: st.st_mtime_nsec as u32,
ctimensec: st.st_ctime_nsec as u32,
mode: st.st_mode,
#[allow(clippy::unnecessary_cast)]
nlink: st.st_nlink as u32,
uid: st.st_uid,
gid: st.st_gid,
rdev: st.st_rdev as u32,
blksize: st.st_blksize as u32,
..Default::default()
}
}
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Kstatfs {
pub blocks: u64,
pub bfree: u64,
pub bavail: u64,
pub files: u64,
pub ffree: u64,
pub bsize: u32,
pub namelen: u32,
pub frsize: u32,
pub padding: u32,
pub spare: [u32; 6],
}
impl From<libc::statvfs64> for Kstatfs {
#[allow(clippy::unnecessary_cast)]
fn from(st: libc::statvfs64) -> Self {
Kstatfs {
blocks: st.f_blocks,
bfree: st.f_bfree,
bavail: st.f_bavail,
files: st.f_files,
ffree: st.f_ffree,
bsize: st.f_bsize as u32,
namelen: st.f_namemax as u32,
frsize: st.f_frsize as u32,
..Default::default()
}
}
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct FileLock {
pub start: u64,
pub end: u64,
pub type_: u32,
pub pid: u32, /* tgid */
}
#[repr(u32)]
#[derive(Debug, Copy, Clone, N, AsBytes)]
pub enum Opcode {
Lookup = 1,
Forget = 2, /* No Reply */
Getattr = 3,
Setattr = 4,
Readlink = 5,
Symlink = 6,
Mknod = 8,
Mkdir = 9,
Unlink = 10,
Rmdir = 11,
Rename = 12,
Link = 13,
Open = 14,
Read = 15,
Write = 16,
Statfs = 17,
Release = 18,
Fsync = 20,
Setxattr = 21,
Getxattr = 22,
Listxattr = 23,
Removexattr = 24,
Flush = 25,
Init = 26,
Opendir = 27,
Readdir = 28,
Releasedir = 29,
Fsyncdir = 30,
Getlk = 31,
Setlk = 32,
Setlkw = 33,
Access = 34,
Create = 35,
Interrupt = 36,
Bmap = 37,
Destroy = 38,
Ioctl = 39,
Poll = 40,
NotifyReply = 41,
BatchForget = 42,
Fallocate = 43,
Readdirplus = 44,
Rename2 = 45,
Lseek = 46,
CopyFileRange = 47,
SetUpMapping = 48,
RemoveMapping = 49,
// TODO(b/310102543): Update the opcode keep same with kernel patch after the atomic open
// kernel is merged to upstream.
OpenAtomic = u32::MAX - 1,
ChromeOsTmpfile = u32::MAX,
}
#[repr(u32)]
#[derive(Debug, Copy, Clone, N)]
pub enum NotifyOpcode {
Poll = 1,
InvalInode = 2,
InvalEntry = 3,
Store = 4,
Retrieve = 5,
Delete = 6,
CodeMax = 7,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct EntryOut {
pub nodeid: u64, /* Inode ID */
pub generation: u64, /* Inode generation: nodeid:gen must be unique for the fs's lifetime */
pub entry_valid: u64, /* Cache timeout for the name */
pub attr_valid: u64, /* Cache timeout for the attributes */
pub entry_valid_nsec: u32,
pub attr_valid_nsec: u32,
pub attr: Attr,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct ForgetIn {
pub nlookup: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct ForgetOne {
pub nodeid: u64,
pub nlookup: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct BatchForgetIn {
pub count: u32,
pub dummy: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct GetattrIn {
pub flags: u32,
pub dummy: u32,
pub fh: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct AttrOut {
pub attr_valid: u64, /* Cache timeout for the attributes */
pub attr_valid_nsec: u32,
pub dummy: u32,
pub attr: Attr,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct MknodIn {
pub mode: u32,
pub rdev: u32,
pub umask: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct MkdirIn {
pub mode: u32,
pub umask: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct ChromeOsTmpfileIn {
pub mode: u32,
pub umask: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct RenameIn {
pub newdir: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Rename2In {
pub newdir: u64,
pub flags: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct LinkIn {
pub oldnodeid: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct SetattrIn {
pub valid: u32,
pub padding: u32,
pub fh: u64,
pub size: u64,
pub lock_owner: u64,
pub atime: u64,
pub mtime: u64,
pub ctime: u64,
pub atimensec: u32,
pub mtimensec: u32,
pub ctimensec: u32,
pub mode: u32,
pub unused4: u32,
pub uid: u32,
pub gid: u32,
pub unused5: u32,
}
impl From<SetattrIn> for libc::stat64 {
fn from(s: SetattrIn) -> libc::stat64 {
// SAFETY: zero-initializing a struct with only POD fields.
let mut out: libc::stat64 = unsafe { mem::zeroed() };
out.st_mode = s.mode;
out.st_uid = s.uid;
out.st_gid = s.gid;
out.st_size = s.size as i64;
out.st_atime = s.atime as libc::time_t;
out.st_mtime = s.mtime as libc::time_t;
out.st_ctime = s.ctime as libc::time_t;
out.st_atime_nsec = s.atimensec as libc::c_long;
out.st_mtime_nsec = s.mtimensec as libc::c_long;
out.st_ctime_nsec = s.ctimensec as libc::c_long;
out
}
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct OpenIn {
pub flags: u32,
pub unused: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct CreateIn {
pub flags: u32,
pub mode: u32,
pub umask: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct OpenOut {
pub fh: u64,
pub open_flags: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct ReleaseIn {
pub fh: u64,
pub flags: u32,
pub release_flags: u32,
pub lock_owner: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct FlushIn {
pub fh: u64,
pub unused: u32,
pub padding: u32,
pub lock_owner: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct ReadIn {
pub fh: u64,
pub offset: u64,
pub size: u32,
pub read_flags: u32,
pub lock_owner: u64,
pub flags: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct WriteIn {
pub fh: u64,
pub offset: u64,
pub size: u32,
pub write_flags: u32,
pub lock_owner: u64,
pub flags: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct WriteOut {
pub size: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct StatfsOut {
pub st: Kstatfs,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct FsyncIn {
pub fh: u64,
pub fsync_flags: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct SetxattrIn {
pub size: u32,
pub flags: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct GetxattrIn {
pub size: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct GetxattrOut {
pub size: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct LkIn {
pub fh: u64,
pub owner: u64,
pub lk: FileLock,
pub lk_flags: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct LkOut {
pub lk: FileLock,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct AccessIn {
pub mask: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct InitIn {
pub major: u32,
pub minor: u32,
pub max_readahead: u32,
pub flags: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct InitInExt {
pub flags2: u32,
pub unused: [u32; 11],
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct InitOut {
pub major: u32,
pub minor: u32,
pub max_readahead: u32,
pub flags: u32,
pub max_background: u16,
pub congestion_threshold: u16,
pub max_write: u32,
pub time_gran: u32,
pub max_pages: u16,
pub map_alignment: u16,
pub flags2: u32,
pub unused: [u32; 7],
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct InterruptIn {
pub unique: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct BmapIn {
pub block: u64,
pub blocksize: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct BmapOut {
pub block: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct IoctlIn {
pub fh: u64,
pub flags: u32,
pub cmd: u32,
pub arg: u64,
pub in_size: u32,
pub out_size: u32,
}
/// Describes a region of memory in the address space of the process that made the ioctl syscall.
/// Similar to `libc::iovec` but uses `u64`s for the address and the length.
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct IoctlIovec {
/// The start address of the memory region. This must be in the address space of the process
/// that made the ioctl syscall.
pub base: u64,
/// The length of the memory region.
pub len: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct IoctlOut {
pub result: i32,
pub flags: u32,
pub in_iovs: u32,
pub out_iovs: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct PollIn {
pub fh: u64,
pub kh: u64,
pub flags: u32,
pub events: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct PollOut {
pub revents: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct NotifyPollWakeupOut {
pub kh: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct FallocateIn {
pub fh: u64,
pub offset: u64,
pub length: u64,
pub mode: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct InHeader {
pub len: u32,
pub opcode: u32,
pub unique: u64,
pub nodeid: u64,
pub uid: u32,
pub gid: u32,
pub pid: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct OutHeader {
pub len: u32,
pub error: i32,
pub unique: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Dirent {
pub ino: u64,
pub off: u64,
pub namelen: u32,
pub type_: u32,
// char name[];
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Direntplus {
pub entry_out: EntryOut,
pub dirent: Dirent,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct NotifyInvalInodeOut {
pub ino: u64,
pub off: i64,
pub len: i64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct NotifyInvalEntryOut {
pub parent: u64,
pub namelen: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct NotifyDeleteOut {
pub parent: u64,
pub child: u64,
pub namelen: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct NotifyStoreOut {
pub nodeid: u64,
pub offset: u64,
pub size: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Notify_Retrieve_Out {
pub notify_unique: u64,
pub nodeid: u64,
pub offset: u64,
pub size: u32,
pub padding: u32,
}
/* Matches the size of fuse_write_in */
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct NotifyRetrieveIn {
pub dummy1: u64,
pub offset: u64,
pub size: u32,
pub dummy2: u32,
pub dummy3: u64,
pub dummy4: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct LseekIn {
pub fh: u64,
pub offset: u64,
pub whence: u32,
pub padding: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct LseekOut {
pub offset: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct CopyFileRangeIn {
pub fh_src: u64,
pub off_src: u64,
pub nodeid_dst: u64,
pub fh_dst: u64,
pub off_dst: u64,
pub len: u64,
pub flags: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct SetUpMappingIn {
/* An already open handle */
pub fh: u64,
/* Offset into the file to start the mapping */
pub foffset: u64,
/* Length of mapping required */
pub len: u64,
/* Flags, FUSE_SETUPMAPPING_FLAG_* */
pub flags: u64,
/* Offset in Memory Window */
pub moffset: u64,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct RemoveMappingIn {
/* number of fuse_removemapping_one follows */
pub count: u32,
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct RemoveMappingOne {
/* Offset into the dax window start the unmapping */
pub moffset: u64,
/* Length of mapping required */
pub len: u64,
}
/// For each security context, send fuse_secctx with size of security context
/// fuse_secctx will be followed by security context name and this in turn
/// will be followed by actual context label.
/// fuse_secctx, name, context
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct Secctx {
pub size: u32,
pub padding: u32,
}
/// Contains the information about how many fuse_secctx structures are being
/// sent and what's the total size of all security contexts (including
/// size of fuse_secctx_header).
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, AsBytes, FromZeroes, FromBytes)]
pub struct SecctxHeader {
pub size: u32,
pub nr_secctx: u32,
}