commit ff1b918e82bfe657026f20e29c8b171614efff3c Author: moparisthebest Date: Wed Aug 3 22:23:09 2022 -0400 First working version diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..54b3647 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +/target/ +/target +**/*.rs.bk +.idea +**/*.kate-swp +**/out/ +**/core.* +todo.txt +conflict/ +orig/ \ No newline at end of file diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..8cbe220 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,257 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "aho-corasick" +version = "0.7.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e37cfd5e7657ada45f742d6e99ca5788580b5c529dc78faf11ece6dc702656f" +dependencies = [ + "memchr", +] + +[[package]] +name = "atty" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" +dependencies = [ + "hermit-abi", + "libc", + "winapi", +] + +[[package]] +name = "bincode" +version = "1.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f45e9417d87227c7a56d22e471c6206462cba514c7590c09aff4cf6d1ddcad" +dependencies = [ + "serde", +] + +[[package]] +name = "cache-fs" +version = "0.1.0" +dependencies = [ + "bincode", + "env_logger", + "fuse", + "libc", + "log", + "serde", +] + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "env_logger" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aafcde04e90a5226a6443b7aabdb016ba2f8307c847d524724bd9b346dd1a2d3" +dependencies = [ + "atty", + "humantime", + "log", + "regex", + "termcolor", +] + +[[package]] +name = "fuse" +version = "0.4.0-dev" +source = "git+https://github.com/zargony/fuse-rs#39fde4a5c47ce370d228ac190f950bd835db7f47" +dependencies = [ + "fuse-abi", + "fuse-sys", + "libc", + "log", + "thread-scoped", +] + +[[package]] +name = "fuse-abi" +version = "0.4.0-dev" +source = "git+https://github.com/zargony/fuse-rs#39fde4a5c47ce370d228ac190f950bd835db7f47" + +[[package]] +name = "fuse-sys" +version = "0.4.0-dev" +source = "git+https://github.com/zargony/fuse-rs#39fde4a5c47ce370d228ac190f950bd835db7f47" +dependencies = [ + "pkg-config", +] + +[[package]] +name = "hermit-abi" +version = "0.1.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33" +dependencies = [ + "libc", +] + +[[package]] +name = "humantime" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df004cfca50ef23c36850aaaa59ad52cc70d0e90243c3c7737a4dd32dc7a3c4f" +dependencies = [ + "quick-error", +] + +[[package]] +name = "libc" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836" + +[[package]] +name = "log" +version = "0.4.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + +[[package]] +name = "pkg-config" +version = "0.3.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1df8c4ec4b0627e53bdf214615ad287367e482558cf84b109250b37464dc03ae" + +[[package]] +name = "proc-macro2" +version = "1.0.43" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0a2ca2c61bc9f3d74d2886294ab7b9853abd9c1ad903a3ac7815c58989bb7bab" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quick-error" +version = "1.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0" + +[[package]] +name = "quote" +version = "1.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbe448f377a7d6961e30f5955f9b8d106c3f5e449d493ee1b125c1d43c2b5179" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "regex" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c4eb3267174b8c6c2f654116623910a0fef09c4753f8dd83db29c48a0df988b" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.6.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3f87b73ce11b1619a3c6332f45341e0047173771e8b8b73f87bfeefb7b56244" + +[[package]] +name = "serde" +version = "1.0.142" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e590c437916fb6b221e1d00df6e3294f3fccd70ca7e92541c475d6ed6ef5fee2" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.142" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34b5b8d809babe02f538c2cfec6f2c1ed10804c0e5a6a041a049a4f5588ccc2e" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "syn" +version = "1.0.99" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "58dbef6ec655055e20b86b15a8cc6d439cca19b667537ac6a1369572d151ab13" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "termcolor" +version = "1.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bab24d30b911b2376f3a13cc2cd443142f0c81dda04c118693e35b3835757755" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "thread-scoped" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bcbb6aa301e5d3b0b5ef639c9a9c7e2f1c944f177b460c04dc24c69b1fa2bd99" + +[[package]] +name = "unicode-ident" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4f5b37a154999a8f3f98cc23a628d850e154479cd94decf3414696e12e31aaf" + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" +dependencies = [ + "winapi", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..6268357 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "cache-fs" +version = "0.1.0" +edition = "2021" +authors = ["moparisthebest "] + +description = "caching fs to use over immutable network filesystems" +repository = "https://code.moparisthebest.com/moparisthebest/cache-fs" +keywords = ["cache", "filesystem", "nfs"] + +license = "AGPL-3.0-or-later" +readme = "README.md" + +include = [ + "**/*.rs", + "Cargo.toml", + "*.md", +] + +[dependencies] +#fuse = "0.3" +fuse = { git = "https://github.com/zargony/fuse-rs" } +env_logger = "0.6" +libc = "0.2" +log = "0.4" + +serde = { version="1.0", features = [ "derive" ] } +bincode = "1.3" diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..cba6f6a --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,660 @@ +### GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..0f7ce7f --- /dev/null +++ b/src/main.rs @@ -0,0 +1,649 @@ +use fuse::{ + FileAttr, FileType, Filesystem, ReplyAttr, ReplyData, ReplyDirectory, ReplyEmpty, ReplyEntry, + ReplyOpen, Request, +}; +use libc::{ + c_int, EINVAL, EIO, ENOENT, EPERM, O_ACCMODE, O_APPEND, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, + O_TRUNC, O_WRONLY, +}; +use log::{debug, error, warn}; +use serde::{Deserialize, Serialize}; +use std::{ + collections::HashMap, + env, + ffi::{OsStr, OsString}, + fmt::{Debug, Formatter}, + fs::File, + io::{BufReader, BufWriter, Error, ErrorKind}, + ops::Deref, + os::unix::{ + ffi::OsStrExt, + fs::{MetadataExt, PermissionsExt}, + }, + path::{Path, PathBuf}, + time::{Duration, SystemTime, UNIX_EPOCH}, +}; + +type Result = std::result::Result; +type SerdeResult = std::result::Result>; + +const TTL: Duration = Duration::from_secs(120); + +#[derive(Serialize, Deserialize)] +#[serde(remote = "FileType")] +enum FileTypeDef { + NamedPipe, + CharDevice, + BlockDevice, + Directory, + RegularFile, + Symlink, + Socket, +} + +#[derive(Serialize, Deserialize)] +#[serde(remote = "FileAttr")] +struct FileAttrDef { + pub ino: u64, + pub size: u64, + pub blocks: u64, + pub atime: SystemTime, + pub mtime: SystemTime, + pub ctime: SystemTime, + pub crtime: SystemTime, + #[serde(with = "FileTypeDef")] + pub kind: FileType, + pub perm: u16, + pub nlink: u32, + pub uid: u32, + pub gid: u32, + pub rdev: u32, + pub flags: u32, +} + +#[derive(Serialize, Deserialize)] +enum TypeExtra { + RegularFile, + Symlink(OsString), + Directory(HashMap), +} + +#[derive(Serialize, Deserialize)] +struct FileInfo { + parent: u64, + path: PathBuf, + #[serde(with = "FileAttrDef")] + attr: FileAttr, + type_extra: TypeExtra, +} + +#[derive(Default, Serialize, Deserialize)] +struct FileTree { + inode_to_path: HashMap, +} + +impl Debug for FileTree { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + writeln!(f, "FileTree")?; + // dumb way to always print this in inode order + let mut inode_to_path = std::collections::BTreeMap::default(); + inode_to_path.extend(self.inode_to_path.iter()); + for (key, val) in inode_to_path.iter() { + writeln!( + f, + "-- {key}: [parent: {}, {:?}, {:?}]", + val.parent, val.attr.kind, val.path + )?; + match &val.type_extra { + TypeExtra::Directory(children) => writeln!(f, "---- children: {:?}", children)?, + TypeExtra::Symlink(link) => writeln!(f, "---- link to: {:?}", link)?, + TypeExtra::RegularFile => (), + } + } + Ok(()) + } +} + +impl FileTree { + fn load_or_build(root_path: &Path, cache_path: &Path) -> SerdeResult { + let path = cache_path.join("cache-fs.tree"); + match FileTree::load(&path) { + Ok(tree) => return Ok(tree), + Err(e) => warn!("error loading {:?}: {:?}", path, e), + } + let tree = FileTree::build(root_path); + tree.save(&path)?; + Ok(tree) + } + + fn load(path: &Path) -> SerdeResult { + let file = File::open(path)?; + let file = BufReader::new(file); + + Ok(bincode::deserialize_from(file)?) + } + + fn save(&self, path: &Path) -> SerdeResult<()> { + let file = File::create(path)?; + let file = BufWriter::new(file); + + Ok(bincode::serialize_into(file, self)?) + } + + fn build(root_path: &Path) -> Self { + let mut tree = FileTree::default(); + + let mut ino = 1; + let root = FileInfo { + parent: 0, // probably should be None but this is the only file without a parent + path: PathBuf::new(), + attr: std::fs::symlink_metadata(root_path) + .and_then(|m| meta2attr(&m, ino)) + .expect("cannot read root dir"), + type_extra: TypeExtra::Directory(Default::default()), + }; + tree.inode_to_path.insert(1, root); + ino += 1; + + let mut dirs = vec![1]; + while !dirs.is_empty() { + let mut all_dirs = Vec::new(); + for dir in dirs { + tree.process_dir(root_path, &mut ino, &mut all_dirs, dir); + } + dirs = all_dirs; + } + + debug!("build tree: {:?}", tree); + tree + } + + fn process_dir( + &mut self, + root_path: &Path, + ino_counter: &mut u64, + dirs: &mut Vec, + ino: u64, + ) { + let dir = self + .inode_to_path + .get_mut(&ino) + .expect("missing dir ino, programming error"); + if let Ok(x) = std::fs::read_dir(root_path.join(&dir.path)) { + if let TypeExtra::Directory(children) = &mut dir.type_extra { + children.reserve(x.size_hint().0); + } else { + panic!("impossible") + }; + let dir_path = dir.path.clone(); + for de in x.flatten() { + if let Ok(attr) = de.metadata().and_then(|m| meta2attr(&m, *ino_counter)) { + let path = dir_path.join(de.file_name()); + let type_extra = match attr.kind { + FileType::RegularFile => TypeExtra::RegularFile, + FileType::Directory => { + dirs.push(attr.ino); + TypeExtra::Directory(Default::default()) + } + FileType::Symlink => { + let entry_path = root_path.join(&path); + match std::fs::read_link(entry_path) { + Err(e) => { + // I guess on error we just ignore this symlink like it doesn't exist + error!("bad symlink? {:?}", e); + continue; + } + Ok(x) => TypeExtra::Symlink(x.into_os_string()), + } + } + _ => panic!("impossible to happen, we filter other types out"), + }; + let child = FileInfo { + parent: ino, + path, + attr, + type_extra, + }; + // avoid this lookup each time with something better? + if let Some(TypeExtra::Directory(children)) = + &mut self.inode_to_path.get_mut(&ino).map(|f| &mut f.type_extra) + { + children.insert(de.file_name(), child.attr.ino); + } else { + unreachable!("this should be impossible"); + } + self.inode_to_path.insert(child.attr.ino, child); + *ino_counter += 1; + } + } + } + } + + pub fn lookup(&self, parent: u64, child: &OsStr) -> Option<&FileAttr> { + let (_, children) = self.folder(parent)?; + let child = children.get(child)?; + let child = self.inode_to_path.get(child)?; + Some(&child.attr) + } + + pub fn getattr(&self, ino: u64) -> Option<&FileAttr> { + Some(&self.inode_to_path.get(&ino)?.attr) + } + + pub fn folder(&self, ino: u64) -> Option<(&FileInfo, &HashMap)> { + self.inode_to_path.get(&ino).and_then(|f| { + if let TypeExtra::Directory(children) = &f.type_extra { + Some((f, children)) + } else { + None + } + }) + } + + pub fn symlink(&self, ino: u64) -> Option<(&FileInfo, &OsString)> { + self.inode_to_path.get(&ino).and_then(|f| { + if let TypeExtra::Symlink(link) = &f.type_extra { + Some((f, link)) + } else { + None + } + }) + } + + pub fn file(&self, ino: u64) -> Option<&FileInfo> { + self.inode_to_path.get(&ino) + } +} + +#[derive(Debug)] +struct FileHandle { + file: File, + count: usize, +} + +impl FileHandle { + fn new(file: File) -> Self { + FileHandle { file, count: 1 } + } + + fn open(&mut self) { + self.count += 1; + } + + fn close(&mut self) -> bool { + self.count -= 1; + self.count == 0 + } +} + +impl Deref for FileHandle { + type Target = File; + + fn deref(&self) -> &Self::Target { + &self.file + } +} + +struct CacheFs { + remote_dir: PathBuf, + cache_dir: PathBuf, + cache_tmp_file: PathBuf, + tree: FileTree, + opened_files: HashMap, + read_buffer: Vec, +} + +impl CacheFs { + pub fn new(remote_dir: PathBuf, cache_dir: PathBuf, tree: FileTree) -> CacheFs { + CacheFs { + remote_dir, + cache_dir: cache_dir.join("root"), + cache_tmp_file: cache_dir.join("tmp.file"), + tree, + opened_files: HashMap::with_capacity(2), + read_buffer: Vec::with_capacity(4096), + } + } +} + +fn ft2ft(t: std::fs::FileType) -> Result { + match t { + x if x.is_symlink() => Ok(FileType::Symlink), + x if x.is_dir() => Ok(FileType::Directory), + x if x.is_file() => Ok(FileType::RegularFile), + _ => Err(Error::from(ErrorKind::NotFound)), + } +} + +fn meta2attr(m: &std::fs::Metadata, ino: u64) -> Result { + Ok(FileAttr { + kind: ft2ft(m.file_type())?, + ino, + size: m.size(), + blocks: m.blocks(), + atime: m.accessed().unwrap_or(UNIX_EPOCH), + mtime: m.modified().unwrap_or(UNIX_EPOCH), + ctime: UNIX_EPOCH + Duration::from_secs(m.ctime().try_into().unwrap_or(0)), + crtime: m.created().unwrap_or(UNIX_EPOCH), + perm: m.permissions().mode() as u16, + nlink: m.nlink() as u32, + uid: m.uid(), + gid: m.gid(), + rdev: m.rdev() as u32, + flags: 0, + }) +} + +fn errhandle(e: Error) -> libc::c_int { + match e.kind() { + ErrorKind::PermissionDenied => EPERM, + ErrorKind::NotFound => ENOENT, + e => { + error!("{:?}", e); + EIO + } + } +} + +impl Filesystem for CacheFs { + fn lookup(&mut self, _req: &Request, parent: u64, name: &OsStr, reply: ReplyEntry) { + debug!("lookup: parent: {parent}, name: {:?}", name); + match self.tree.lookup(parent, name) { + None => reply.error(ENOENT), + Some(attr) => reply.entry(&TTL, attr, 1), + } + } + + fn getattr(&mut self, _req: &Request, ino: u64, reply: ReplyAttr) { + debug!("getattr: ino: {ino}"); + match self.tree.getattr(ino) { + None => reply.error(ENOENT), + Some(attr) => reply.attr(&TTL, attr), + } + } + + fn open(&mut self, _req: &Request, ino: u64, flags: u32, reply: ReplyOpen) { + debug!("open: ino: {ino}, flags: {flags}"); + + if let Some(file_handle) = self.opened_files.get_mut(&ino) { + file_handle.open(); + return reply.opened(ino, 0); + } + + let entry_path = match self.tree.file(ino) { + None => return reply.error(ENOENT), + Some(file) => &file.path, + }; + + debug!("open: entry_path: {:?}", entry_path); + + let fl = flags as c_int; + + if !matches!(fl & O_ACCMODE, O_RDONLY | O_WRONLY | O_RDWR) { + return reply.error(EINVAL); + } + + if (fl & (O_EXCL | O_CREAT) != 0) || fl & O_APPEND == O_APPEND || fl & O_TRUNC == O_TRUNC { + error!("Wrong flags on open"); + return reply.error(EIO); + } + + let mut oo = std::fs::OpenOptions::new(); + oo.read(true); + oo.write(false); + oo.create(false); + oo.append(false); + oo.truncate(false); + + let cache_path = self.cache_dir.join(&entry_path); + if !&cache_path.exists() { + // copy the file into place + // todo: handle these errors + if let Some(parent) = cache_path.parent() { + if let Err(e) = std::fs::create_dir_all(parent) { + error!("cannot create cache dir {:?} to copy into: {:?}", parent, e); + return reply.error(EIO); + } + } + let remote_path = self.remote_dir.join(entry_path); + debug!( + "copying from {:?} to {:?}", + remote_path, self.cache_tmp_file + ); + if let Err(e) = std::fs::copy(&remote_path, &self.cache_tmp_file) { + error!( + "failed to copy from {:?} to {:?}: {:?}", + &remote_path, self.cache_tmp_file, e + ); + return reply.error(EIO); + } + debug!("moving from {:?} to {:?}", self.cache_tmp_file, cache_path); + if let Err(e) = std::fs::rename(&self.cache_tmp_file, &cache_path) { + error!( + "failed to move from {:?} to {:?}: {:?}", + self.cache_tmp_file, cache_path, e + ); + // try to delete it in case it partially moved or something (shouldn't happen, should always be atomic) + // but ignore any error deleting it because what could we do anyway? + std::fs::remove_file(cache_path).ok(); + return reply.error(EIO); + } + } + + match oo.open(cache_path) { + Err(e) => reply.error(errhandle(e)), + Ok(f) => { + self.opened_files.insert(ino, FileHandle::new(f)); + reply.opened(ino, 0); + } + } + } + + fn read( + &mut self, + _req: &Request, + ino: u64, + fh: u64, + offset: i64, + size: u32, + reply: ReplyData, + ) { + debug!("read: ino: {ino}, fh: {fh}, offset: {offset}, size: {size}"); + let f = match self.opened_files.get(&fh) { + None => return reply.error(EIO), + Some(x) => x, + }; + + let size = size as usize; + + let b = &mut self.read_buffer; + if b.len() != size { + b.resize(size, 0); + } + + use std::os::unix::fs::FileExt; + + let mut bo = 0; + while bo < size { + match f.read_at(&mut b[bo..], offset as u64) { + Err(e) => return reply.error(errhandle(e)), + Ok(0) => { + b.resize(bo, 0); + break; + } + Ok(ret) => { + bo += ret; + } + }; + } + + reply.data(&b[..]); + } + + fn release( + &mut self, + _req: &Request, + ino: u64, + fh: u64, + _flags: u32, + _lock_owner: u64, + _flush: bool, + reply: ReplyEmpty, + ) { + debug!("release: ino: {ino}, fh: {fh}"); + // we have 2 choices here: + // 1. optimize for many simultaneously opened files in which case we'd get_mut, and then remove if required + // 2. optimize for normally only 1 simultaneously opened file, so removing and then only adding back if keeping is best + // we pick #2 + let mut file_handle = match self.opened_files.remove(&fh) { + None => return reply.error(EIO), + Some(x) => x, + }; + + if !file_handle.close() { + self.opened_files.insert(fh, file_handle); + } + + reply.ok(); + } + + fn opendir(&mut self, _req: &Request, ino: u64, flags: u32, reply: ReplyOpen) { + debug!("opendir: ino: {ino}, flags: {flags}"); + match self.tree.getattr(ino) { + None => reply.error(ENOENT), + Some(attr) => reply.opened(attr.ino, 0), + } + } + + fn readdir( + &mut self, + _req: &Request, + ino: u64, + fh: u64, + offset: i64, + mut reply: ReplyDirectory, + ) { + debug!("readdir: ino: {ino}, fh: {fh}, offset: {offset}"); + + let (dir, children) = match self.tree.folder(ino) { + None => return reply.error(EIO), + Some(x) => x, + }; + + if offset == 0 + && reply.add( + dir.attr.ino, + 1, + FileType::Directory, + OsStr::from_bytes(b"."), + ) + { + return reply.ok(); + } + + if offset <= 1 && reply.add(dir.parent, 2, FileType::Directory, OsStr::from_bytes(b"..")) { + return reply.ok(); + } + + let offset = if offset <= 1 { 0 } else { offset as usize - 2 }; + + for (i, (name, ino)) in children.iter().enumerate().skip(offset) { + let file = match self.tree.file(*ino) { + Some(file) => file, + None => { + error!("should be impossible to not be able to find a child"); + return reply.error(EIO); + } + }; + // i + 3 means the index of the next entry + let offset = (i + 3) as i64; + debug!( + "sending ino: {}, offset: {}, kind: {:?}, name: {:?}", + *ino, offset, file.attr.kind, name + ); + if reply.add(*ino, offset, file.attr.kind, name) { + break; + } + } + reply.ok(); + } + + fn releasedir(&mut self, _req: &Request, ino: u64, fh: u64, flags: u32, reply: ReplyEmpty) { + debug!("releasedir: ino: {ino}, fh: {fh}, flags: {flags}"); + // or could just always return ok() ? + match self.tree.file(ino) { + None => reply.error(EIO), + Some(_) => reply.ok(), + }; + } + + fn readlink(&mut self, _req: &Request, ino: u64, reply: ReplyData) { + debug!("readlink: ino: {ino}"); + let (_, link) = match self.tree.symlink(ino) { + None => return reply.error(ENOENT), + Some(x) => x, + }; + reply.data(link.as_bytes()); + } +} + +fn main() { + env_logger::init(); + let mut args = env::args_os().skip(1); + if args.next() != Some(OsStr::from_bytes(b"-o").to_os_string()) { + panic!("-o must be second argument"); + } + let mut cmd_opts = "ro".to_string(); + + let mut cache_dir = "".to_string(); + let mut default_permissions = true; + let opts = args.next().expect("found -o but missing opts"); + let opts = opts.to_str().expect("non-utf8 opts").split(','); + for opt in opts { + if opt.starts_with("cache_dir=") { + let mut split_opt = opt.splitn(2, '='); + if let Some(dir) = split_opt.nth(1) { + cache_dir.clear(); + cache_dir.push_str(dir); + } + continue; + } + match opt { + "ro" => (), + "no_default_permissions" => default_permissions = false, + "rw" => panic!("rw is not supported"), + opt => { + cmd_opts.push(','); + cmd_opts.push_str(opt); + } + } + } + if cache_dir.is_empty() { + panic!("must supply cache_dir=/path/to/cache to -o") + } + if !cmd_opts.contains(",fsname=") { + cmd_opts.push_str(",fsname=cachefs"); + } + if default_permissions && !cmd_opts.contains(",default_permissions,") { + cmd_opts.push_str(",default_permissions"); + } + + let remote_dir = PathBuf::from(args.next().expect("missing dir")); + let mountpoint = args.next().expect("missing mountpoint"); + let cache_dir = PathBuf::from(cache_dir); + + debug!( + "mounting {:?} on {:?} with cache_dir: {:?}, opts: {cmd_opts}", + remote_dir, mountpoint, cache_dir + ); + + std::fs::create_dir_all(&cache_dir).expect("could not create cache_dir"); + let tree = FileTree::load_or_build(remote_dir.deref(), cache_dir.deref()) + .expect("could not build file tree"); + + let cache = CacheFs::new(remote_dir, cache_dir, tree); + + let cmd_opts = OsString::from(cmd_opts); + let options = [OsStr::new("-o"), cmd_opts.as_os_str()]; + fuse::mount(cache, mountpoint, &options).expect("mount failed"); +}