From: Ralph Ronnquist Date: Sat, 1 Jul 2023 12:42:07 +0000 (+1000) Subject: Starting a debian build branch. X-Git-Tag: debian/1.0-1~9 X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=861d2b689157f7fb749e1bbbdc3e51664b7ace37;p=rrq%2Ffusefile.git Starting a debian build branch. --- diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 3710bef..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 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 General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is 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. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - 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. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - 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 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. Use with the GNU Affero General Public License. - - 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 Affero 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 special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU 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 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 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 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. - - fusefile - Copyright (C) 2019 Ralph Ronnquist - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU 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 General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - fusefile Copyright (C) 2019 Ralph Ronnquist - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - 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 GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/Makefile b/Makefile deleted file mode 100644 index 9f02adc..0000000 --- a/Makefile +++ /dev/null @@ -1,41 +0,0 @@ -BINS = fusefile - -default: $(BINS) - -ifneq (${DEBUG},) -${BINS}: CFLAGS += -DDEBUG=1 -g -endif - -${BINS}: CFLAGS += -Wall -D_FILE_OFFSET_BITS=64 -fusefile: LDFLAGS = -lfuse -pthread - -.INTERMEDIATE: fusefile.o -fusefile.o: fusefile.c - -fusefile: fusefile.o - $(CC) $(CFLAGS) $(CPPFLAGS) $? $(LDFLAGS) $(TARGET_ARCH) -o $@ - -clean: - rm -f $(BINS) - -README.html: README.adoc - asciidoctor $< > $@ - -# Building a debian package - -SBINDIR = $(DESTDIR)/usr/sbin -MAN8DIR = $(DESTDIR)/usr/share/man/man8 - -SBINFILES = fusefile fusedisk -MAN8FILES = fusefile.8 - -INSTALLTARGETS = $(addprefix $(SBINDIR)/,$(SBINFILES)) -INSTALLTARGETS += $(addprefix $(MAN8DIR)/,$(MAN8FILES)) - -$(SBINDIR)/% $(MAN8DIR)/%: % - install -D -T $< $@ - -install: $(INSTALLTARGETS) - -deb: - PREFIX= INCLUDE_PREFIX=/usr dpkg-buildpackage --build=full -uc -us diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 7bf9049..0000000 --- a/README.adoc +++ /dev/null @@ -1,29 +0,0 @@ -# fusefile -:author: Ralph Ronnquist -:revdate: Sun, 30 Apr 2023 21:18:34 +1000 - -This project implements a "fuse" device to mount a concatenation of -fragments of one or more files as a single file. - -The __fused file__ allows writing to fragments (without changing their -sizes); of course only for writable fragment files. The fused file may -be set up with an __overlay file__ to capture changes instead of -writing the underlying fragment files. - -==== -This is a usage example to set up a fused file C consisting of files A -and B: ----- -$ fusefile C A B ----- -==== - -==== -This is an example of tearing down a fused file C: ----- -$ fusermount -u C ----- -==== - -See the +man page+ for usage details and some more examples. - diff --git a/debian/source/format b/debian/source/format index 89ae9db..163aaf8 100644 --- a/debian/source/format +++ b/debian/source/format @@ -1 +1 @@ -3.0 (native) +3.0 (quilt) diff --git a/fusedisk b/fusedisk deleted file mode 100755 index f7df50e..0000000 --- a/fusedisk +++ /dev/null @@ -1,42 +0,0 @@ -#!/bin/sh -# -# Set up a fusefile as a disk device using device mapper. -# Note that this requires root access. - -if [ $(id -u) != 0 ] ; then - echo "block device set up requires root." >&2 - exit 1 -fi - -# fuse blkdev mounting needs to sniff an existing but unmounted block -# device node for setup. However the device mapping has an empty table -# and the content is only accessible via the fuse mount that links it -# to the fusefile process. The device node (major:minor) are still -# considered in use by the kernel and, and the device node is "open" -# while mounted. - -[ -e /dev/mapper/control ] || modprobe dm_mod || exit 1 - -# Create up to N fusedisk named as fusedisk0..fusediskN, the device -# mapper also creates its dm-X device nodes and we also force -# /dev/mapper/$NAME nodes for them. -N=15 -DEV= -for I in $(seq 0 $N) ; do - NAME=fusedisk$I - C="$(dmsetup info --noheadings -c -o open $NAME 2>/dev/null)" - if [ "$C" != "1" ] ; then - if [ -z "$C" ] ; then - dmsetup create $NAME --notable || exit 1 - dmsetup mknodes $NAME || exit 1 - fi - DEV=/dev/mapper/$NAME - break - fi -done -if [ -z "$DEV" ] ; then - echo "** No more fusedisk devices" >&2 - exit 1 -fi -echo "using $DEV for $*" | logger -t fusedisk -exec fusefile -oblkdev,fsname=$DEV -oallow_other $* diff --git a/fusefile.8 b/fusefile.8 deleted file mode 100644 index 6af36f4..0000000 --- a/fusefile.8 +++ /dev/null @@ -1,226 +0,0 @@ -.mso www.tmac -.TH fusefile 8 -.SH NAME -fusefile, fusedisk \- FUSE file mount for combining file fragments - -.SH SYNOPSIS -.B fusefile \fR[\fIfuse-opts\fR] \fBmountpoint\fR \fR[\fIoverlay\fR] \fIfilename/from-to\fR ... -.br -.B fusefile \fB-dump\fR \fR[\fIfuse-opts\fR] \fBmountpoint\fR \fR[\fIoverlay\fR] \fIfilename/from-to\fR ... -.br -.B fusedisk \fR[\fIfuse-opts\fR] \fBmountpoint\fR \fR[\fIoverlay\fR] \fIfilename/from-to\fR ... - -.SH DESCRIPTION - -\fBfusefile\fR is a FUSE \fIfile mount\fR that presents a series of -fragments of other files as a contiguous concatenation. Technically it -bind mounts a driver on top of the filename mountpoint to provide -access to the given file fragments as if in a single, contiguous file. - -\fBfusefile\fR accepts over-writing on the fused file (i.e. the -mountpoint) which gets distributed accordingly to the fragments. But -neither the fused file nor the fragments can change size; any writing -thus merely over-writes content without truncating fragments. All -fragment files are held open while \fBfusefile\fR is active. - -By using the optional \fB-overlay:\fIfilename\fR argument between the -mount point and the fragments, an overlay file may be set up. The -overlay file will then be used by \fBfusefile\fR for capturing writes -to the fused file (i.e. the mountpoint). The overlay file will contain -any new written fused file regions followed by meta data to -distinguish between new, written content and old content that comes -from the fragments. - -The option \fB-dump\fR as first argument together with a fusefile -setup will print the setup to standard output rather than establishing -a fusefile mount. This is of most use with a prior overlay setup, -where then the printout includes the portions of updates that have -been captured in the overlay. The printout is the series of fusefile -fragment argments to give in order to intersperse the captured overlay -portions according to the overlay table. - -\fBfusedisk\fR is a helper script to set up a \fBfusefile\fR as a -block device (via \fIfuseblk\fR) by using the device mapper -(\fBdmsetup\fR) to manage an empty block device mapping where content -is handled at the mountpoint via \fBfusefile\fR. (Note that the same -thing may be done with the device manager directly, but then all -fragments need to be in sectors of N*512 bytes whereas with -\fBfusedisk\fR, only the fused file as a whole is "clipped" at nearest -N*512 bytes below actual size) - -.SH FRAGMENT ARGUMENTS - -The fragment arguments include the filename of a source file, and -optionally start and end byte positions. All in all there five -variations: - -.TP -\fIfilename\fR or \fIfilename/\fR -include all of the file. A pathname that includes "/" must be ended -with an extra "/" since that last "/" separates the filename from the -range detail. - -.TP -\fIfilename/start:end\fR -include the range from the given start to end. Either "start" or "end" -or both may be omitted, to mean the beginning and end of the file -respectively. If "start" or "end" are less than 0 then it means -relative to the end of the file. - -.TP -\fIfilename/start+length\fR -include "length" bytes from the given start. A negative "start" means -relative to the end of the file. If "length" is negative or omitted it -means that position relative to the end. - -.TP -\fIfilename/start\fR include bytes from the given start. This is the -same as "/start+" - -.P -Note that a negative start position is clipped to 0 and a too large -end position is clipped to the end of the file. - -.P -Character devices are treated as being of any given finite size, but -have size 0 by default. For example, "/dev/zero/:100" means a fragment -of 100 NUL bytes. - -.SH OPTIONS - -This section enumerates the most interesting options to use with -\fBfuesfile\fR. See "man fuse" and "man mount" for more options. - -.TP -\fB-dump\fR - -The \fB-dump\fR "option" tells \fBfusefile\fR to print out the -applicable fragment sequence for the current setup, including the -overlay table, if any. The printout is done instead of setting up a -mount point. - -.TP -\fB-o\fIallow_other\fB - -The fuse option \fI-oallow_other\fR is needed for sharing the fused -file with other users who otherwise will not have access to it -(including "root"). Note however that this must first be enabled in -\fI/etc/fuse.conf\fR. - -.TP -\fB-o\fInonempty\fR - -The fuse option \fI-ononempty\fR may need to be used when reusing an -existing file as mountpoint. - -.TP -\fB-o\fIuid=...\fR and \fB-o\fIgid=...\fR, - -These mount options, where \fI...\fR is a user or group id -respectively, are useful for root when using \fBfusedisk\fR and -thereby give user or group ownership for the mount to the nominated -user or group. - -.SH EXAMPLES -This section illustrates uses of \fBfusefile\fR. - -.SS Exanple 1. -Insert a file "y" into a file "x" at position 1200. -.RS -\fB$ fusefile -ononempty x x/:1200 y x/1200:\fR -.RE -This also shadows the original file "x" and presents the fused file -instead. - -.SS Example 2. -Make fused file y be a swap of the beginning and end of file "x", at -position 2442. -.RS -\fB$ fusefile y x/2442: x/:2442\fR -.RE - -.SS Example 3. -Replace partition 2 of an image file, \fIA\fR, with a different -file, \fIX\fR. For this example the partition table looks as follows. -.RS -\fB$ partx -oNR,START,SECTORS \fIA\fR - NR START SECTORS - 1 2048 2097152 - 2 2099200 409600 - 3 2508800 14268383 -.RE -.br -As each sector is 512 bytes the clipping points around partition 2 are -1074790400 and 1284505600 and the insertion size is 209715200 bytes. -The \fBfusefile\fR comman will therefore be as follows. -.RS -\fB$ fusefile -ononempty \fIA\fB \fIA\fB/:1074790400 \fIX\fB/:209715200 \fIA\fB/1284505600\fR -.RE -Note that the fused file shadows the original file \fIA\fR. - -.SS Example 4. -Protect raw disk image file with an overlay: -.RS -\fB$ fusefile -ononempty disk.raw -overlay:today disk.raw\fR -.RE -By that set up, the overlay file, "today", will protect the disk image -file, "disk.raw" from changes, and also override the pathname -"disk.raw" to be the fused file. - -.SS Example 5. -A fusefile mount with an \fIoverlay file\fR is writable regardless of -the fused fragments, but all updates are written to the overlay file -instead of to the fragments. - -.RS -\fB$ fusefile -ononempty \fIA\fR \fB-overlay:\fIB\fB \fIA\fR -.RE - -The overlay file, \fIB\fR in the example, contains all changes to the -shadowed original file, \fIA\fR. The overlay file contains only the -newly written regions and content is otherwise obtained from the -original file. - -To that end, the overlay file also contains a "marker table" at the -end as if appended to the fused file. That part of the file is outside -of the fused file; and it's simply an element count followed by pairs -of byte addresses that tell which regions of the fused file have been -captured into the overlay file. (The marker table is of course -maintained so that adjoining regions are collapsed) - -Thus, an overlay file may be reused to later re-establish the same -fused file with overlay as previously, to continue capturing more -changes. - -.SS Example 6. -As final example, we set up a fused block device \fIy\fR as a swap of -the beginning and end of file "x", at position 2442: -.RS -\fB$ sudo fusedisk -ouid=1000 y x/2442: x/:2442\fR -.RE -Note the use of \fBsudo\fR for becoming \fIroot\fR, which is required -for block device handling, and also the \fB-ouid=1000\fR option so as -to make the block device \fIy\fR be owned by the user with id 1000. - -.SH NOTES - -\fBfusefile\fR opens the nominated source files before any bind -mounting. With the fuse option \fI-ononempty\fR it will bind over an -non-empty file, which may be useful. The source files remain open, but -the source fragments are not recomputed. If a source file changes the -fused file will present the new content. If a source is reduced in -size, access will be inconsistent. - -If the mountpoint file doesn't exist, then \fBfusefile\fR creates it. - -Unmounting is done with "\fBfusermount -u\fR \fImountpoint\fR" as -usual. A \fBfusedisk\fR mount is unmounted by \fIroot\fR using -\fBumount\fR. - -.SH SEE ALSO -\fBfuse, fusermount, mount, dmsetup\fR - -.SH AUTHOR - -Ralph Rönnquist . - diff --git a/fusefile.c b/fusefile.c deleted file mode 100644 index 5f7850b..0000000 --- a/fusefile.c +++ /dev/null @@ -1,984 +0,0 @@ -/*** - fusefile - overlay a file path with a concatenation of parts of - other files. - - Copyright (C) 2019- Ralph Ronnquist - - This program is free software: you can redistribute it and/or - modify it under the terms of the GNU 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 - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see - . - - This source was inspired by the "null.c" example of the libfuse - sources, which is distributed under GPL2, and copyright (C) - 2001-2007 Miklos Szeredi . -*/ - -#define FUSE_USE_VERSION 33 - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -struct Region { - off_t beg; - off_t end; -}; - -struct Source { - char *filename; - ssize_t from; - ssize_t to; - ssize_t start; // starting position in concatenated file - int fd; - int dirty; -}; - -static struct { - struct Source *array; - int count; - ssize_t size; -} sources; - -static struct { - time_t atime; - time_t mtime; - time_t ctime; -} times; - -/** - * Overlay - */ -static struct { - struct Source source; - struct Region *table; - size_t count; - size_t limit; -} overlay; - -static void usage(); - -/** - * Find the nearest overlay.table region below pos. Returns the index, - * or -1 if there is none, i.e. pos < overlay.table[0]. - */ -static ssize_t overlay_prior_fragment(off_t pos) { - size_t lo = 0, hi = overlay.count; - while ( lo < hi ) { - size_t m = ( lo + hi ) / 2; - if ( m == lo ) { - return overlay.table[m].beg <= pos? m : -1; - } - if ( overlay.table[m].beg <= pos ) { - lo = m; - } else { - hi = m; - } - } - return -1; -} - -/** - * Save the entry count for overlay.table as 64-bit integer - * immediately following the overlay content at the index - * corresponding to the fused file size. - */ -static void overlay_save_count() { - lseek( overlay.source.fd, overlay.source.to, SEEK_SET ); - size_t size = sizeof( overlay.count ); - char *p = (char *) &overlay.count ; - while ( size > 0 ) { - size_t n = write( overlay.source.fd, p, size ); - if ( n < 0 ) { - perror( overlay.source.filename ); - exit( 1 ); - } - size -= n; - p += n; - } - if ( overlay.source.dirty++ > 1000 ) { - fsync( overlay.source.fd ); - overlay.source.dirty = 0; - } -} - -/** - * Update the on-disk cache of overlay.table between the given - * indexes. The table is laid out immediately following the table - * count with each region saved as two 64-bit unsigned integers. - */ -static void overlay_save_table(size_t lo,size_t hi) { - char *p = (char *) &overlay.table[ lo ]; - size_t pos = overlay.source.to + sizeof( overlay.count ) + - lo * sizeof( struct Region ); - size_t size = ( hi - lo ) * sizeof( struct Region ); - if ( pos != lseek( overlay.source.fd, pos, SEEK_SET ) ) { - fprintf( stderr, "%s: seek error\n", overlay.source.filename ); - exit( 1 ); - } - while ( size > 0 ) { - size_t n = write( overlay.source.fd, p, size ); - if ( n < 0 ) { - perror( overlay.source.filename ); - exit( 1 ); - } - size -= n; - p += n; - } - if ( overlay.source.dirty++ > 1000 ) { - fsync( overlay.source.fd ); - overlay.source.dirty = 0; - } -} - -/** - * Insert a new region at index p, with previous portion [p,count] - * moved up to make space. - */ -static void overlay_insert(size_t p,off_t beg,off_t end) { - size_t bytes; - // Grow the table if needed - if ( overlay.count >= overlay.limit ) { - overlay.limit = overlay.count + 10; - bytes = overlay.limit * sizeof( struct Region ); - overlay.table = overlay.table? - realloc( overlay.table, bytes ) : malloc( bytes ); - } - bytes = ( overlay.count++ - p ) * sizeof( struct Region ); - if ( bytes ) { - memmove( (char*) &overlay.table[ p+1 ], - (char*) &overlay.table[ p ], - bytes ); - } - overlay.table[ p ].beg = beg; - overlay.table[ p ].end = end; - overlay_save_count(); -} - -/** - * Delete the region entry at p by moving the portion [p+1,count] - * down. - */ -static void overlay_delete(size_t p) { - size_t bytes = ( --overlay.count - p ) * sizeof( struct Region ); - if ( bytes ) { - memmove( (char*) &overlay.table[ p ], - (char*) &overlay.table[ p+1 ], - bytes ); - } -} - -/** - * Mark the given region as updated, i.e. written to the overlay. The - * mark region may attach to prior marked regions or be a new, - * separate region. If attaching, it causes the prior regions to - * expand and the table adjusted by deleting any regions that become - * fully contained in other regions. - */ -static void overlay_mark(off_t beg,off_t end) { -#if DEBUG - fprintf( stderr, "overlay_mark( %ld, %ld )\n", beg, end ); -#endif - int deleted = 0; - ssize_t q; - ssize_t p = overlay_prior_fragment( beg ); - // p is the nearest region below or at beg (or -1) - if ( p >= 0 && beg <= overlay.table[p].end ) { - // p overlaps mark region - if ( end <= overlay.table[p].end ) { - // region p covers mark region already -#if DEBUG - fprintf( stderr, "overlay covering ( %ld %ld )\n", - overlay.table[p].beg, overlay.table[p].end ); -#endif - return; - } - // the new mark region extends region p - overlay.table[p].end = end; - q = p+1; - while ( q < overlay.count && - overlay.table[q].beg <= overlay.table[p].end ) { - // Extended region merges with subsequent region - if ( overlay.table[p].end < overlay.table[q].end ) { - overlay.table[p].end = overlay.table[q].end; - } - overlay_delete( q ); - deleted++; - } - if ( deleted ) { - overlay_save_count(); - q = overlay.count; - } - overlay_save_table( p, q ); -#if DEBUG - fprintf( stderr, "overlay expand ( %ld %ld ) deleted %d\n", - overlay.table[p].beg, overlay.table[p].end, deleted ); -#endif - return; - } - // The prior region p does not expand into new mark region - p++; // subsequent region - if ( p >= overlay.count || end < overlay.table[p].beg ) { - // New mark region is a separate region at p - overlay_insert( p, beg, end ); -#if DEBUG - fprintf( stderr, "overlay new ( %ld %ld )\n", - overlay.table[p].beg, overlay.table[p].end ); -#endif - overlay_save_table( p, overlay.count ); - return; - } - // New marks start before and overlap with region p => change p - // and handle any subsequent regions being covered - overlay.table[p].beg = beg; - q = p+1; - if ( overlay.table[p].end < end ) { - overlay.table[p].end = end; - while ( q < overlay.count && - overlay.table[q].beg <= overlay.table[p].end ) { - if ( overlay.table[p].end < overlay.table[q].end ) { - overlay.table[p].end = overlay.table[q].end; - } - overlay_delete( q ); - deleted++; - } - if ( deleted ) { - overlay_save_count(); - q = overlay.count; - } - } - overlay_save_table( p, q ); -#if DEBUG - fprintf( stderr, "overlay before ( %ld %ld ) deleted %d\n", - overlay.table[p].beg, overlay.table[p].end, deleted ); -#endif -} - -static void setup_overlay(char *filename) { - overlay.source.filename = filename; - overlay.source.fd = open( filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR ); - if ( overlay.source.fd < 0 ) { - perror( filename ); - usage(); - } -} - -#if DEBUG -static void print_source(struct Source *p) { - fprintf( stderr, "%p { %s, %ld, %ld, %ld, %d }\n", - p, p->filename, p->from, p->to, p->start, p-> fd ); -} -#endif - -static char *range; -static unsigned int c; -static int RANGE(int s,int n ) { - return ( s == n ) && *(range+c) == 0; -} - -static int setup_source(struct Source *p,char *frag) { - struct stat filestat; - // Open the fragment file rw if possible, else ro - range = strrchr( frag, '/' ); // last '/' - p->filename = range? strndup( frag, range - frag ) : frag; - p->fd = open( p->filename, O_RDWR ); - int rdonly = 0; - if ( p->fd < 0 ) { - rdonly = 1; - p->fd = open( p->filename, O_RDONLY ); - } - if ( p->fd < 0 ) { - perror( p->filename ); - return 1; // Error return - } - if ( stat( p->filename, &filestat ) ) { - perror( p->filename ); - return 1; - } - if ( rdonly ) { - fprintf( stderr, "** %s opened read-only\n", p->filename ); - } - p->from = 0; - if ( S_ISBLK( filestat.st_mode ) ) { - // Block devices report size differently: - if ( ioctl( p->fd, BLKGETSIZE64, &filestat.st_size ) < 0 ) { - perror( p->filename ); - } -#if DEBUG - fprintf( stderr, "block device size = %ld\n", filestat.st_size ); -#endif - } - p->to = filestat.st_size; - // Process any range variation - if ( range && *(++range) ) { - int a,b; - if ( 0 ) { - } else if ( RANGE( sscanf( range, "%d:%d%n", &a, &b, &c ), 2 )) { - p->from = ( a < 0 )? ( p->to + a ) : a; - p->to = ( b < 0 )? ( p->to + b ) : b; - } else if ( RANGE( sscanf( range, "%d+%d%n", &a, &b, &c ), 2 )) { - p->from = ( a < 0 )? ( p->to + a ) : a; - p->to = ( ( b < 0 )? p->to : p->from ) + b; - } else if ( RANGE( sscanf( range, "%d+%n", &a, &c ), 1 )) { - p->from = ( a < 0 )? ( p->to + a ) : a; - } else if ( RANGE( sscanf( range, ":%d%n", &b, &c ), 1 )) { - p->to = ( b < 0 )? ( p->to + b ) : b; - } else if ( RANGE( sscanf( range, "%d:%n", &a, &c ), 1 )) { - p->from = ( a < 0 )? ( p->to + a ) : a; - } else if ( RANGE( sscanf( range, "%d%n", &a, &c ), 1 )) { - if ( a >= 0 ) { - p->from = a; - } else { - p->from = p->to + a; - } - } else if ( RANGE( sscanf( range, ":%n", &c), 0 ) ) { - // to end from start - } else { - fprintf( stderr, "** BAD RANGE: %s\n", frag ); - return 1; - } - } - if ( ( filestat.st_mode & S_IFMT ) == S_IFCHR ) { - filestat.st_size = p->to; // Pretend size of character device - } - if ( p->from < 0 ) { - p->from = 0; - } - if ( p->to > filestat.st_size ) { - p->to = filestat.st_size; - } - if ( p->from >= p->to || p->from >= filestat.st_size ) { - fprintf( stderr, "** BAD RANGE: %s [%ld:%ld]\n", - frag, p->from, p->to ); - return 1; - } - p->start = sources.size; // the fusefile position of fragment - sources.size += p->to - p->from; - return 0; -} - -static int setup_sources(char **argv,int i,int n) { - sources.array = calloc( n, sizeof( struct Source ) ); - if ( sources.array == 0 ) { - return 1; - } - sources.count = n; - int j = 0; - sources.size = 0; - for ( ; j < n; i++, j++ ) { - struct Source *p = sources.array + j; - if ( setup_source( p, argv[i] ) ) { - return 1; - } -#if DEBUG - print_source( p ); -#endif - } - return 0; -} - -static int fusefile_getattr(const char *path,struct stat *stbuf) { -#if DEBUG - fprintf( stderr, "fusefile_getattr( %s )\n", path ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } -#if DEBUG - fprintf( stderr, "getattr %ld\n", sources.size ); -#endif - memset( stbuf, 0, sizeof( struct stat ) ); - stbuf->st_mode = S_IFREG | 0644; // Hmmm - stbuf->st_nlink = 1; - stbuf->st_size = sources.size; - stbuf->st_atime = times.atime; - stbuf->st_mtime = times.mtime; - stbuf->st_ctime = times.ctime; - stbuf->st_uid = getuid(); - stbuf->st_gid = getgid(); - return 0; -} - -static int fusefile_chmod(const char *path,mode_t m) { -#if DEBUG - fprintf( stderr, "fusefile_chmod( %s, %d )\n", path, m ); -#endif - return -1; -} - -static int fusefile_open(const char *path,struct fuse_file_info *fi) { -#if DEBUG - fprintf( stderr, "fusefile_open( %s, %d )\n", path, fi->flags ); - fprintf( stderr, "fixing( %d )\n", fi->flags | O_CLOEXEC ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - // set O-CLOEXEC for this opening? - times.atime = time( 0 ); - return 0; -} - -static int find_source(off_t offset) { - int lo = 0; - int hi = sources.count; - if ( offset >= sources.size ) { - return -1; - } -#if DEBUG - fprintf( stderr, "find_source( %ld )\n", offset ); -#endif - while ( lo + 1 < hi ) { - int m = ( lo + hi ) / 2; - if ( offset < sources.array[ m ].start ) { -#if DEBUG - fprintf( stderr, " offset < [%d].start: %ld\n", - m, sources.array[ m ].start ); -#endif - hi = m; - } else { -#if DEBUG - fprintf( stderr, " offset >= [%d].start: %ld\n", - m, sources.array[ m ].start ); -#endif - lo = m; - } - } -#if DEBUG - fprintf( stderr, "found %d\n", lo ); -#endif - return lo; -} - -static int overlay_merge(char *buf,off_t beg,off_t end) { -#if DEBUG - fprintf( stderr, "merge %ld %ld\n", beg, end ); -#endif - // Find nearest overlay data before or at beg - ssize_t p = overlay_prior_fragment( beg ); - if ( p < 0 ) { - p = 0; - } - for ( ; p < overlay.count && overlay.table[p].beg < end; p++ ) { - if ( overlay.table[p].end < beg ) { - continue; - } - if ( overlay.table[p].beg > beg ) { - size_t delta = overlay.table[p].beg - beg; - buf += delta; - beg += delta; - } - size_t size = ( overlay.table[p].end <= end )? - ( overlay.table[p].end - beg ) : ( end - beg ); - lseek( overlay.source.fd, beg, SEEK_SET ); - while ( size > 0 ) { - size_t n = read( overlay.source.fd, buf, size ); - size -= n; - buf += n; - beg += n; // - } - } - return 0; -} - -// Read bytes from in file -static int fusefile_read(const char *path, char *buf, size_t size, - off_t off, struct fuse_file_info *fi) -{ -#if DEBUG - fprintf( stderr, "fusefile_read( %s )\n", path ); -#endif - if( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } -#if DEBUG - fprintf( stderr, "read %ld %ld\n", off, size ); -#endif - size_t rr = 0; // total reading - while ( size > 0 ) { -#if DEBUG - fprintf( stderr, " find_source %ld %ld\n", off, size ); -#endif - int i = find_source( off ); - if ( i < 0 ) { - return ( off == sources.size )? rr : -ENOENT; - } - if ( sources.array[i].fd < 0 ) { - return -ENOENT; - } -#if DEBUG - print_source( &sources.array[i] ); -#endif - times.atime = time( 0 ); - size_t b = off - sources.array[i].start + sources.array[i].from; - size_t n = sources.array[i].to - b; - if ( n > size ) { - n = size; - } - if ( sources.array[i].dirty ) { - fsync( sources.array[i].fd ); - sources.array[i].dirty = 0; - } -#if DEBUG - fprintf( stderr, " seek fd=%d to %ld\n", sources.array[i].fd, b ); -#endif - if ( lseek( sources.array[i].fd, b, SEEK_SET ) < 0 ) { - perror( sources.array[i].filename ); - return -ENOENT; - } -#if DEBUG - fprintf( stderr, " now read %ld from fd=%d\n", - n, sources.array[i].fd ); -#endif - ssize_t r = read( sources.array[i].fd, buf + rr, n ); -#if DEBUG - fprintf( stderr, " got %ld bytes\n", r ); -#endif - if ( r < 0 ) { - perror( sources.array[i].filename ); - return -ENOENT; - } - if ( r == 0 ) { - break; - } - if ( overlay.source.filename ) { - if ( overlay.source.dirty ) { - fsync( overlay.source.fd ); - overlay.source.dirty = 0; - } - int x = overlay_merge( buf + rr, off + rr, off + rr + r ); - if ( x ) { - return x; - } - } - rr += r; - off += r; - size -= r; - } -#if DEBUG - fprintf( stderr, " total reading %ld bytes\n", rr ); -#endif - return rr; -} - -/** - * Poll for IO readiness. - */ -int fusefile_poll(const char *path, struct fuse_file_info *fi, - struct fuse_pollhandle *ph, unsigned *reventsp ) -{ -#if DEBUG - fprintf( stderr, "fusefile_poll( %s ) %p %d\n", path, ph, *reventsp ); -#endif - if( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - if ( ph ) { - return fuse_notify_poll( ph ); - } - return 0; -} - -static void overlay_load() { - lseek( overlay.source.fd, overlay.source.to, SEEK_SET ); - size_t x = 0; - size_t size = sizeof( overlay.count ); - if ( read( overlay.source.fd, &x, size ) != size ) { - return; - } -#if DEBUG - fprintf( stderr, "overlay: %s with %ld regions\n", - overlay.source.filename, x ); -#endif - struct Region f = { 0, 0 }; - size = sizeof( struct Region ); - while ( x-- > 0 ) { - if ( read( overlay.source.fd, &f, size ) != size ) { - fprintf( stderr, "%s: bad meta data\n", overlay.source.filename ); - exit( 1 ); - } -#if DEBUG - fprintf( stderr, "overlay region: %ld %ld\n", f.beg, f.end ); -#endif - overlay_mark( f.beg, f.end ); - } -} - -/** - * Write a full block of data over the sources at the offset - */ -static int write_block(off_t off,const char *buf,size_t size) { -#if DEBUG - fprintf( stderr, "write_block( %ld, ?, %ld )\n", off, size ); -#endif - if ( overlay.source.filename ) { - overlay_mark( off, off + size ); // Mark region as written - } - while ( size > 0 ) { - int index = find_source( off ); // index of source file - if ( index < 0 ) { - return -EIO; // past EOF - } - struct Source *source = overlay.source.filename? - &overlay.source : &sources.array[ index ]; - off_t from = off - source->start + source->from; - off_t max = source->to - from; - if ( lseek( source->fd, from, SEEK_SET ) < 0 ) { - return -EIO; - } - ssize_t todo = ( size < max )? size : max; - while ( todo > 0 ) { - times.mtime = time( 0 ); - ssize_t n = write( source->fd, buf, todo ); - if ( n <= 0 ) { - return -EIO; // Something wrong - } - buf += n; - todo -= n; - size -= n; - off += n; - } - if ( source->dirty++ >= 1000 ) { - fsync( source->fd ); - source->dirty = 0; - } - } - return 0; -} - -static int fusefile_write_buf(const char *path, struct fuse_bufvec *buf, - off_t off, struct fuse_file_info *fi) { -#if DEBUG - fprintf( stderr, "fusefile_write_buf( %s )\n", path ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - - size_t size = 0; - int i; - for ( i = 0; i < buf->count; i++ ) { - struct fuse_buf *p = &buf->buf[i]; - if ( p->flags & FUSE_BUF_IS_FD ) { -#if DEBUG - fprintf( stderr, "Content held in a file ... HELP!!\n" ); -#endif - return -EIO; - } - if ( write_block( off, (char*) p->mem, p->size ) < 0 ) { - return -EIO; - } - size += p->size; - } -#if DEBUG - fprintf( stderr, "fusefile_write_buf written %ld\n", size ); -#endif - return size; -} - -/** - * Write a fragment at . This overwrites files. - */ -static int fusefile_write(const char *path, const char *buf, size_t size, - off_t off, struct fuse_file_info *fi) -{ -#if DEBUG - fprintf( stderr, "fusefile_write( %s %ld )\n", path, size ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - - if ( write_block( off, buf, size ) < 0 ) { - return -EIO; - } - return size; -} - -static void fusefile_destroy(void *data) { - char *mnt = (char*) data; // As passed to fuse_main -#if DEBUG - fprintf( stderr, "fusefile_destroy( %s )\n", mnt? mnt : "" ); -#endif - if ( mnt ) { - unlink( mnt ); - } -} - -static void fsync_all_dirty() { - int i = 0; - for ( ; i < sources.count; i++ ) { - if ( sources.array[i].dirty ) { - fsync( sources.array[i].fd ); - sources.array[i].dirty = 0; - } - } - if ( overlay.source.filename && overlay.source.dirty ) { - fsync( overlay.source.fd ); - overlay.source.dirty = 0; - } -} - -static int fusefile_flush(const char *path, struct fuse_file_info *info) { -#if DEBUG - fprintf( stderr, "fusefile_flush( %s )\n", path ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - fsync_all_dirty(); - return 0; -} - -static int fusefile_release(const char *path, struct fuse_file_info *fi) { -#if DEBUG - fprintf( stderr, "fusefile_release( %s, %d )\n", path, fi->flags ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - return 0; -} - -static int fusefile_fsync(const char *path, int x, struct fuse_file_info *fi) { -#if DEBUG - fprintf( stderr, "fusefile_fsync( %s, %d )\n", path, x ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - fsync_all_dirty(); - return 0; -} - -/** - * - */ -static int fusefile_truncate(const char *path, off_t len) { -#if DEBUG - fprintf( stderr, "fusefile_truncate( %s, %ld )\n", path, len ); -#endif - if ( strcmp( path, "/" ) != 0 ) { - return -ENOENT; - } - return -EIO; -} - -void *fusefile_init(struct fuse_conn_info *fci) { -#if DEBUG - fprintf( stderr, "fusefile_init( %d, %d )\n", fci->async_read, fci->want ); -#endif - // Disable asynchronous reading - fci->async_read = 0; - fci->want &= ~FUSE_CAP_ASYNC_READ; -#if DEBUG - fprintf( stderr, "fusefile_init( %d, %d )\n", fci->async_read, fci->want ); -#endif - return 0; -} - -#define ENDSOURCE( S ) ( S.start + ( S.to - S.from ) ) - -/** - * Dump the current fragmentation to stdout. - */ -static int dump_fragments() { - int oly = 0; - int src = 0; - size_t pos = 0; - while ( src < sources.count ) { - size_t x = ( oly < overlay.count )? - overlay.table[ oly ].beg : sources.size; - for ( ; src < sources.count && - ENDSOURCE( sources.array[ src ] ) <= x; src++ ) { - // Dump sources.array[src] in full - fprintf( stdout, "%s/%ld:%ld\n", - sources.array[ src ].filename, - pos - sources.array[ src ].start, - sources.array[ src ].to ); - pos = ENDSOURCE( sources.array[ src ] ); - } - if ( sources.array[ src ].start < x ) { - // Dump sources.array[src] up to x; - fprintf( stdout, "%s/%ld:%ld\n", - sources.array[ src ].filename, - pos - sources.array[ src ].start, - x - sources.array[ src ].start ); - pos = ENDSOURCE( sources.array[ src ] ); - } - if ( oly < overlay.count ) { - fprintf( stdout, "%s/%ld:%ld\n", - overlay.source.filename, - overlay.table[ oly ].beg, - overlay.table[ oly ].end ); - pos = overlay.table[ oly++ ].end; - } - for ( ; src < sources.count && - ENDSOURCE( sources.array[ src ] ) <= pos; src++ ) { - // Just skip these fragments. - } - } - return( 0 ); -} - -static struct fuse_operations fusefile_oper = { - .getattr = fusefile_getattr, - // NYI .fgetattr = fusefile_fgetattr, - .chmod = fusefile_chmod, - .open = fusefile_open, - .read = fusefile_read, - .poll = fusefile_poll, - .write = fusefile_write, - .write_buf = fusefile_write_buf, - .destroy = fusefile_destroy, - // NYI .access = fusefile_access, - .flush = fusefile_flush, - .release = fusefile_release, - .fsync = fusefile_fsync, - // NYI .ftruncate = fusefile_ftruncate, - .truncate = fusefile_truncate, - //.truncate = fusefile_truncate, - //.release = fusefile_release, - .init = fusefile_init, -}; - -static void usage() { - char *usage = -"Usage: fusefile [ ] ... \n" -"Mounts a virtual, file that is a concatenation of file fragments\n" - ; - fprintf( stderr, "%s", usage ); - exit( 1 ); -} - -/** - * Set up the arguments for the fuse_main call, adding our own. - * argv[argc] is the mount point argument - */ -static int setup_argv(int argc,char ***argv) { - // note: (*argv)[ argc ] is the mount point argument - char *OURS[] = { - "-odefault_permissions", - (*argv)[ argc ] - }; -#define OURSN ( sizeof( OURS ) / sizeof( char* ) ) - int N = argc + OURSN; - // Allocate new arg array plus terminating null pointer - char **out = malloc( ( N + 1 ) * sizeof( char* ) ); - int i; - for ( i = 0; i < argc; i++ ) { - out[ i ] = (*argv)[i]; - //fprintf( stderr, " %s", out[ i ] ); - } - for ( i = 0; i < OURSN; i++ ) { - out[ argc + i ] = OURS[i]; - //fprintf( stderr, " %s", out[ i ] ); - } - out[ N ] = 0; - //fprintf( stderr, "\n" ); - (*argv) = out; - return N; // Don't include the terminating null pointer -} - -/** - * Mount a concatenation of files, - * [ ] ... - */ -int main(int argc, char *argv[]) -{ - char *mnt; - int mt; - int fg; - int i; - int fuseargc; - struct stat stbuf; - int temporary = 0; - // Scan past options - for ( i = 1; i < argc; i++ ) { - if ( *argv[i] != '-' ) { - break; - } - } - if ( i > argc - 2 ) { // At least mount point plus one source - usage(); - } - fuseargc = i; - mnt = argv[ i++ ]; // First non-option argument is the mount pount - char *overlaytag = "-overlay:"; - int overlaytagsize = strlen( overlaytag ); - if ( strncmp( argv[i], overlaytag, overlaytagsize ) == 0 ) { - // consume "-overlay:filename" - setup_overlay( argv[i++] + overlaytagsize ); // Need a writable file - if ( i >= argc ) { - usage(); - } - } - if ( setup_sources( argv, i, argc-i ) ) { - return 1; - } - if ( overlay.source.filename ) { - overlay.source.to = sources.size; // Register total size. - overlay_load(); - } - if ( stat( mnt, &stbuf ) == -1 ) { - int fd = open( mnt, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR ); - if ( fd < 0 ) { - perror( mnt ); - return 1; - } - time_t now = time( 0 ); - times.atime = now; - times.mtime = now; - times.ctime = now; - temporary = 1; - close( fd ); - } else if ( ! S_ISREG( stbuf.st_mode ) ) { - fprintf( stderr, "mountpoint is not a regular file\n" ); - return 1; - } else { - times.atime = stbuf.st_atime; - times.mtime = stbuf.st_mtime; - times.ctime = stbuf.st_ctime; - } - - { - int fd = open( mnt, O_RDWR, S_IRUSR | S_IWUSR ); - if ( fd < 0 ) { - perror( mnt ); - return 1; - } - if ( lseek( fd, sources.size, SEEK_SET ) < 0 ) { - return -EIO; - } - } - fuseargc = setup_argv( fuseargc, &argv ); - if ( strcmp( "-dump", argv[ 1 ] ) == 0 ) { - return dump_fragments(); - } - struct fuse_args args = FUSE_ARGS_INIT( fuseargc, argv ); - if ( fuse_parse_cmdline( &args, &mnt, &mt, &fg ) ) { - return 1; - } - fuse_opt_free_args( &args ); - if ( ! mnt ) { - fprintf( stderr, "missing mountpoint parameter\n" ); - return 1; - } - return fuse_main( fuseargc, argv, &fusefile_oper, temporary? mnt : NULL ); -} diff --git a/overlaytest.lsp b/overlaytest.lsp deleted file mode 100755 index f9aa9ae..0000000 --- a/overlaytest.lsp +++ /dev/null @@ -1,112 +0,0 @@ -#!/usr/bin/newlisp -# -# This is a test script for the overlay function of fusefile. -# -# 1) prepare a base image -# 2) set up a fusefile overlay -# 3) run tests -# 4) dismantle the fusefile overlay -# 5) remove test images - -; ID is hour, minute and second values packed into a string -(constant - 'ID (apply string (3 3 (now))) - 'BASE (format "%s.raw" ID) - 'OLY (format "%s.oly" ID) - 'SEGSZ 17000 - 'SEGN 40 - ) - -(constant - 'LIBC6 "/lib/x86_64-linux-gnu/libc.so.6" - 'MINE "mine" - ) - -(import LIBC6 "on_exit" "int" "void*" "void*") - -;; Set up a fusefile -(define (onexit x y) - (write-line 2 (string "terminating: " x " " (get-string y))) - (! (format "fusermount -u %s" BASE)) - (delete-file OLY) - (delete-file BASE) - ) -## note: BASE is set up as a holes file with SEGN segments of size SEGSZ -(! (format "dd if=/dev/zero of=%s bs=%d seek=%d count=0 status=none" - BASE SEGSZ SEGN)) -(unless (= (! (format "fusefile %s %s -overlay:%s %s" - "-ononempty -oallow_other" BASE OLY BASE))) - (exit 1)) -(on_exit (callback 'onexit "void" "int" "void*") MINE) - -(println (list BASE OLY)) - -(define (die) (write-line 2 (apply string (args)))) - -(define (prog1 x) x) - -(define (pos X (OFF 0)) - (+ (* SEGSZ X) OFF)) - -(define (read-segment FILE X (OFF 0) (N SEGSZ)) - (let ((FD (open FILE "r")) (BUFFER "")) - (seek FD (pos X OFF)) - (prog1 (when (= N (read FD BUFFER N)) BUFFER) - (close FD)))) - -(define (write-segment FILE X DATA (OFF 0)) - (let ((FD (open FILE "u"))) - (seek FD (pos X OFF)) - (write FD DATA) - ;(seek FD -1) - (close FD))) - -(define (read-ulong FD) - (let ((BUFFER "")) - (when (= 8 (read FD BUFFER 8)) ((unpack "ld" BUFFER) 0)))) - -(define (read-table) - (let ((AT (file-info BASE 0)) (FD (open OLY "r")) (COUNT 0) (OUT '())) - (seek FD AT) - (unless (setf COUNT (read-ulong FD)) - (write-line 2 "** Bad count") - (exit 1)) - (push COUNT OUT -1) - (dotimes (i COUNT) - (push (list (read-ulong FD) (read-ulong FD)) OUT -1)) - OUT)) - -(define (check-segment AT DATA (OFF 0)) - (write-segment BASE AT DATA OFF) - (println - (format "check %2d %d: %s %s %s" AT - (length DATA) - (if (= (read-segment BASE AT OFF (length DATA)) DATA) "ok" "error") - (if (= (read-segment OLY AT OFF (length DATA)) DATA) "ok" "error") - (string (read-table)))) - ) - -;; Test 1 -(seed (date-value)) -(setf - DATA (pack (dup "b" SEGSZ) (rand 256 SEGSZ)) - DATB (pack (dup "b" (* 4 SEGSZ)) (rand 256 (* 4 SEGSZ))) - AT (- SEGN 4)) -(check-segment 0 DATA 0) - -(check-segment AT DATA) -(check-segment (+ AT 2) DATA) -(check-segment (+ AT 1) DATA) -(check-segment (- AT 1) DATA -10) -(check-segment (- AT 1) DATA 10) - -(check-segment 0 DATA 0) -(check-segment 1 DATA 1) -(check-segment 2 DATA 2) -(check-segment 0 DATB 10) - -(check-segment (- SEGN 1) DATA 0) - -;(setf DATA (pack (dup "b" SEGSZ) (rand 256 SEGSZ)) AT (- SEGN 4)) - -(exit 0)