pax_global_header00006660000000000000000000000064150525212540014513gustar00rootroot0000000000000052 comment=79d89c6d745f44f86deac47c3324d35f975efa1d fatrace-0.19.0/000077500000000000000000000000001505252125400132075ustar00rootroot00000000000000fatrace-0.19.0/.editorconfig000066400000000000000000000001271505252125400156640ustar00rootroot00000000000000# 4-space indent .editorconfig root = true [*.c] indent_style = space indent_size = 4 fatrace-0.19.0/.fmf/000077500000000000000000000000001505252125400140355ustar00rootroot00000000000000fatrace-0.19.0/.fmf/version000066400000000000000000000000021505252125400154350ustar00rootroot000000000000001 fatrace-0.19.0/.github/000077500000000000000000000000001505252125400145475ustar00rootroot00000000000000fatrace-0.19.0/.github/workflows/000077500000000000000000000000001505252125400166045ustar00rootroot00000000000000fatrace-0.19.0/.github/workflows/release.yml000066400000000000000000000005671505252125400207570ustar00rootroot00000000000000name: tag on: push: tags: # this is a glob, not a regexp - '[0-9]*' jobs: release: runs-on: ubuntu-latest steps: - name: Clone repository uses: actions/checkout@v4 - name: Create GitHub release env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: gh release create "$GITHUB_REF_NAME" --notes-from-tag fatrace-0.19.0/.github/workflows/tests.yml000066400000000000000000000017651505252125400205020ustar00rootroot00000000000000name: tests on: push: pull_request: schedule: - cron: 0 4 * * MON,FRI jobs: vm: runs-on: ubuntu-latest steps: - name: Clone repository uses: actions/checkout@v4 - name: Install build and test dependencies run: | sudo apt-get update sudo apt-get install -y build-essential python3-pip pip install ruff mypy - name: Build run: make - name: Run tests run: sudo python3 -m unittest -v - name: Run linters run: make lint container: runs-on: ubuntu-latest strategy: fail-fast: false matrix: container: - docker.io/amd64/ubuntu:devel - docker.io/amd64/debian:sid - registry.fedoraproject.org/fedora:latest - registry.fedoraproject.org/fedora:rawhide steps: - name: Clone repository uses: actions/checkout@v4 - name: Run container test run: sudo tests/run-container "${{ matrix.container }}" fatrace-0.19.0/.gitignore000066400000000000000000000000361505252125400151760ustar00rootroot00000000000000*.o *.so /fatrace __pycache__ fatrace-0.19.0/COPYING000066400000000000000000001045131505252125400142460ustar00rootroot00000000000000 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. Copyright (C) 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: Copyright (C) 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 . fatrace-0.19.0/Makefile000066400000000000000000000012211505252125400146430ustar00rootroot00000000000000CFLAGS ?= -O2 -g -Wall -Wextra -Werror PREFIX ?= /usr/local all: fatrace tests/slow-exit.so fatrace: fatrace.o $(CC) $(LDFLAGS) -o $@ $< clean: rm -f *.o fatrace tests/slow-exit.so distclean: clean install: fatrace install -m 755 -D fatrace $(DESTDIR)$(PREFIX)/sbin/fatrace install -m 755 power-usage-report $(DESTDIR)$(PREFIX)/sbin/ install -d $(DESTDIR)$(PREFIX)/share/man/man8/ install -m 644 *.8 $(DESTDIR)$(PREFIX)/share/man/man8/ tests/slow-exit.so: tests/slow-exit.c $(CC) -shared -fPIC -o $@ $< -ldl lint: ruff check power-usage-report ruff check tests mypy power-usage-report mypy tests .PHONY: all clean distclean install lint fatrace-0.19.0/README.md000066400000000000000000000013761505252125400144750ustar00rootroot00000000000000# fatrace `fatrace` reports file access events from all running processes. Its main purpose is to find processes which keep waking up the disk unnecessarily and thus prevent some power saving. ## Testing Like `fatrace` itself, the integration tests have to run as root: ```sh sudo python3 -m unittest -v ``` You can also run them in a privileged root container, with giving it an image name of a Debian-ish (`apt`) or Fedora-ish (`dnf`) distribution: ```sh sudo tests/run-container registry.fedoraproject.org/fedora:latest sudo tests/run-container docker.io/amd64/debian:sid ``` By default, it runs in latest Fedora. Run the test with `DEBUG=1` to sleep on failures. You can then attach to the container and inspect it: ```sh sudo podman exec -itl bash ``` fatrace-0.19.0/fatrace.8000066400000000000000000000133251505252125400147110ustar00rootroot00000000000000.TH fatrace 8 "August 20, 2020" "Martin Pitt" .SH NAME fatrace \- report system wide file access events .SH SYNOPSIS .B fatrace [ .I OPTIONS ] .SH DESCRIPTION .B fatrace reports file access events from all running processes. It does not report file access by fatrace itself, to avoid logging events caused by writing the output into a file. It also ignores events on virtual and kernel file systems such as sysfs, proc, and devtmpfs. Its main purpose is to find processes which keep waking up the disk unnecessarily and thus prevent some power saving. By default, events are reported to stdout. This will cause some loops if you run this tool in e. g. gnome-terminal, as this causes a disk access for every output line. To avoid this, redirect the output into a file. .SH OUTPUT FORMAT There are two output formats. The default text format is easier on human eyes, while the JSONL format is more suitable for automatic processing. In text format, a typical event looks like .RS 4 rsyslogd(875): W /var/log/auth.log .br compiz(1971): O device 8:2 inode 658203 .RE In text format, the line has the following fields: .IP \(bu 2 The current time, if you specify the \fB\-\-timestamp\fR option. .IP \(bu 2 Process name. This is read from /proc/pid/comm, which might be abbreviated for long process names. .IP \(bu 2 Process ID .IP \(bu 2 UID and GID, if you specify the \fB\-\-user\fR option. It is formatted as "[uid:gid]". .IP \(bu 2 Event type: \fBO\fRpen, \fBR\fRead, \fBW\fRrite, \fBC\fRlose. Events on directories are \fB+\fR (create), \fBD\fRelete, \fB<\fR (moved from), or \fB>\fR (moved to). Combinations are possible, such as \fBCW\fR for closing a written file, or \fB<>\fR for renaming a file within the same directory. Directory events can only be detected on Linux 5.1 or higher. .IP \(bu 2 Affected file. In some cases the path and name cannot be determined, e. g. because it is a temporary file which is already deleted. In that case, it prints the devices' major and minor number and the inode number. To examine such a process in more detail, you should consider using .BR strace (1). .IP \(bu 2 Path to executable, if you specify the \fB\-\-exe\fR option. This is read from /proc/pid/exe. .IP \(bu 2 Parent process information, if you specify the \fB\-\-parents\fR option. This information includes, for each successive parent process, the process ID, the process name, and the executable path if you specify the \fB\-\-exe\fR option. If fatrace fails to determine some of this information, fields may be missing or the list may end before the process with ID 1. .RE In JSONL format, the line is a JSON-encoded object with the following fields: .TP .B timestamp The current time, if you specify the .B \-\-timestamp option. .TP .B comm Process name. This is read from /proc/pid/comm, which might be abbreviated for long process names. .TP .B comm_raw The raw bytes of the process name, in case it is invalid UTF-8 or would require escaping. .TP .B pid Process ID .TP .B uid UID, if you specify the \fB\-\-user\fR option. .TP .B gid GID, if you specify the \fB\-\-user\fR option. .TP .B types Event type: \fBO\fRpen, \fBR\fRead, \fBW\fRrite, \fBC\fRlose. Events on directories are \fB+\fR (create), \fBD\fRelete, \fB<\fR (moved from), or \fB>\fR (moved to). Combinations are possible, such as \fBCW\fR for closing a written file, or \fB<>\fR for renaming a file within the same directory. Directory events can only be detected on Linux 5.1 or higher. .TP .B device device ID in \fB{"major":major,"minor":minor}\fR form. .TP .B inode The file inode. .TP .B path The path to the affected file. .TP .B path_raw The raw bytes of the path to the affected file, in case it is invalid UTF-8 or would require escaping. .TP .B exe The path to the executable, if you specify the \fB\-\-exe\fR option. .TP .B exe_raw The raw bytes of the executable path, in case it is not valid UTF-8 or would require escaping. .TP .B parents An array of parent processes, if you specify the \fB\-\-parents\fR option. Each item is an object containing \fBpid\fR, \fBcomm\fR, \fBcomm_raw\fR, \fBexe\fR and \fBexe_raw\fR fields as appropriate. If fatrace fails to determine some of this information, fields may be missing or the list may end before the process with ID 1. .SH OPTIONS .TP .B \-c\fR, \fB\-\-current-mount Only record events on partition/mount of current directory. Without this option, all (real) partitions/mount points are being watched. .TP .B \-o \fIFILE\fR, \fB\-\-output=\fIFILE Write events to given file instead of standard output. .TP .B \-s \fISECONDS\fR, \fB\-\-seconds=\fISECONDS Stop after the given number of seconds. .TP .B \-t\fR, \fB\-\-timestamp Add timestamp to events. When this option is given once, the format will be a human readable hour:minute:second.microsecond; when given twice, the timestamp is printed as seconds/microseconds since the epoch. .TP .B \-u\fR, \fB\-\-user Add process user information to events. .TP .B \-p \fIPID\fR, \fB\-\-ignore\-pid=\fIPID Ignore events for this process ID. Can be specified multiple times. .TP .B \-f \fITYPES\fR, \fB\-\-filter=\fITYPES Show only the given event types. \fBTYPES\fR is a list of .BR C ", " R ", " O ", " W ", " D ", " + ", or " < with the above meanings. \fB<\fR and \fB>\fR both mean "move" and will always enable both directions. E. g. use \fB\-\-filter=OC\fR to only show open and close events. .TP .B \-C \fICOMMAND\fR, \fB\-\-command=\fICOMMAND Show only events for this command. .TP .B \-j\fR, \fB\-\-json Write events in JSONL format (see definition above). .TP .B \-P\fR, \fB\-\-parents Print information about all parent processes. .TP .B \-e\fR, \fB\-\-exe Print executable path. .TP .B \-h \fR, \fB\-\-help Print help and exit. .SH AUTHOR .B fatrace is developed by Martin Pitt . fatrace-0.19.0/fatrace.c000066400000000000000000000703021505252125400147620ustar00rootroot00000000000000/** * fatrace - Trace system wide file access events. * * (C) 2012 Canonical Ltd. * Author: Martin Pitt * * 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 . */ #define _LARGEFILE64_SOURCE #define _GNU_SOURCE #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* for MIN() */ #include #include #include #include #include #include #define BUFSIZE 256*1024 /* https://man7.org/linux/man-pages/man5/proc_pid_comm.5.html ; not defined in any include file */ #ifndef TASK_COMM_LEN #define TASK_COMM_LEN 16 #endif #define DEBUG 0 #if DEBUG #define debug(fmt, ...) fprintf (stderr, "DEBUG: " fmt "\n", ##__VA_ARGS__) #else #define debug(...) {} #endif /* command line options */ static char* option_output = NULL; static long option_filter_mask = 0xffffffff; static long option_timeout = -1; static bool option_current_mount = false; static int option_timestamp = 0; static bool option_user = false; static pid_t ignored_pids[1024]; static unsigned int ignored_pids_len = 0; static char* option_comm = NULL; static bool option_json = false; static bool option_parents = false; static bool option_exe = false; /* --time alarm sets this to 0 */ static volatile int running = 1; static volatile int signaled = 0; /* FAN_MARK_FILESYSTEM got introduced in Linux 4.20; do_mark falls back to _MOUNT */ #ifdef FAN_MARK_FILESYSTEM static int mark_mode = FAN_MARK_ADD | FAN_MARK_FILESYSTEM; #else static int mark_mode = FAN_MARK_ADD | FAN_MARK_MOUNT; #endif /* FAN_REPORT_FID mode got introduced in Linux 5.1 */ #ifdef FAN_REPORT_FID static int fid_mode; /* fsid → mount fd map */ #define MAX_MOUNTS 100 static struct { fsid_t fsid; int mount_fd; } fsids[MAX_MOUNTS]; static size_t fsids_len; /** * add_fsid: * * Add fsid → mount fd map entry for a particular mount point */ static void add_fsid (const char* mount_point) { struct statfs s; int fd; if (fsids_len == MAX_MOUNTS) { warnx ("Too many mounts, not resolving fd paths for %s", mount_point); return; } fd = open (mount_point, O_RDONLY | O_NOFOLLOW); if (fd < 0) { warn ("Failed to open mount point %s", mount_point); return; } if (fstatfs (fd, &s) < 0) { warn ("Failed to stat mount point %s", mount_point); close (fd); return; } memcpy (&fsids[fsids_len].fsid, &s.f_fsid, sizeof (s.f_fsid)); fsids[fsids_len++].mount_fd = fd; debug ("mount %s fd %i", mount_point, fd); } static int get_mount_id (const fsid_t *fsid) { for (size_t i = 0; i < fsids_len; ++i) { if (memcmp (fsid, &fsids[i].fsid, sizeof (fsids[i].fsid)) == 0) { debug ("mapped fsid to fd %i", fsids[i].mount_fd); return fsids[i].mount_fd; } } debug ("fsid not found, default to AT_FDCWD\n"); return AT_FDCWD; } /** * get_fid_event_fd: * * In FAN_REPORT_FID mode, return an fd for the event's target. */ static int get_fid_event_fd (const struct fanotify_event_metadata *data) { const struct fanotify_event_info_fid *fid = (const struct fanotify_event_info_fid *) (data + 1); int fd; if (fid->hdr.info_type != FAN_EVENT_INFO_TYPE_FID) { warnx ("Received unexpected event info type %i, cannot get affected file", fid->hdr.info_type); return -1; } /* get affected file fd from fanotify_event_info_fid */ fd = open_by_handle_at (get_mount_id ((const fsid_t *) &fid->fsid), (struct file_handle *) fid->handle, O_RDONLY|O_NONBLOCK|O_LARGEFILE|O_PATH); /* ignore ESTALE for deleted fds between the notification and handling it */ if (fd < 0 && errno != ESTALE) warn ("open_by_handle_at"); return fd; } #else /* defined(FAN_REPORT_FID) */ #define add_fsid(...) #endif /* defined(FAN_REPORT_FID) */ /** * mask2str: * * Convert a fanotify_event_metadata mask into a human readable string. * * Returns: decoded mask; only valid until the next call, do not free. */ static const char* mask2str (uint64_t mask) { static char buffer[10]; int offset = 0; if (mask & FAN_ACCESS) buffer[offset++] = 'R'; if (mask & FAN_CLOSE_WRITE || mask & FAN_CLOSE_NOWRITE) buffer[offset++] = 'C'; if (mask & FAN_MODIFY || mask & FAN_CLOSE_WRITE) buffer[offset++] = 'W'; if (mask & FAN_OPEN) buffer[offset++] = 'O'; #ifdef FAN_REPORT_FID if (mask & FAN_CREATE) buffer[offset++] = '+'; if (mask & FAN_DELETE) buffer[offset++] = 'D'; if (mask & FAN_MOVED_FROM) buffer[offset++] = '<'; if (mask & FAN_MOVED_TO) buffer[offset++] = '>'; #endif buffer[offset] = '\0'; return buffer; } /** * show_pid: * * Check if events for given PID should be logged. * * Returns: true if PID is to be logged, false if not. */ static bool show_pid (pid_t pid) { unsigned int i; for (i = 0; i < ignored_pids_len; ++i) if (pid == ignored_pids[i]) return false; return true; } /* if str is a valid UTF-8 string without need of any JSON escaping, return the byte length, otherwise -1. */ static inline int nonfunny_utf8_len (const char* str) { const unsigned char* s = (unsigned char*)str; int i = 0; while (str[i] != 0) { unsigned char c = s[i]; // Unescaped ASCII if (0x20 <= c && c != '"' && c != '\\' && c <= 0x7e) { i++; continue; } // it's ok to read s[i+1] since we know s[i] != 0 uint32_t mbc = c<<8 | s[i+1]; if (// 2-char: 110xxxxx 10xxxxxx (mbc & 0xe0c0) == 0xc080 && // but not 1100000x 10xxxxxx (overlong) (mbc & 0xfec0) != 0xc080) { i+=2; continue; } if (s[i+1] == 0) return -1; // it's ok to read s[i+2] since we know s[i+1] != 0 mbc = mbc<<8 | s[i+2]; if (// 3-char: 1110xxxx 10xxxxxx 10xxxxxx (mbc & 0xf0c0c0) == 0xe08080 && // but not 11100000 100xxxxx 10xxxxxx (overlong) (mbc & 0xffe0c0) != 0xe08080 && // neither 11101101 101xxxxx 10xxxxxx (reserved for surrogates) (mbc & 0xffe0c0) != 0xeda080) { i+=3; continue; } if (s[i+2] == 0) return -1; // it's ok to read s[i+3] since we know s[i+2] != 0 mbc = mbc<<8 | s[i+3]; if (// 4-char: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx (mbc & 0xf8c0c0c0) == 0xf0808080 && // but not 11110000 1000xxxx 10xxxxxx 10xxxxxx (overlong) (mbc & 0xfff0c0c0) != 0xf0808080 && // neither 11110PPP 10PPxxxx 10xxxxxx 10xxxxxx, PPPPP>0x10 (too big) (mbc & 0x07300000) <= 0x04000000) { i+=4; continue; } return -1; } return i; } static void print_json_str (const char* key, const char* value) { int value_len = nonfunny_utf8_len (value); int key_len = strlen(key); if (value_len >= 0) { putchar('"'); fwrite (key, 1, key_len, stdout); putchar('"'); putchar(':'); putchar('"'); fwrite (value, 1, value_len, stdout); putchar ('"'); } else { putchar('"'); fwrite (key, 1, key_len, stdout); fwrite ("_raw\":[", 1, 7, stdout); for (int i = 0; value[i] != 0; i++) printf (i ? ",%d" : "%d", (unsigned int)(unsigned char)(value[i])); putchar (']'); } } /* given an fd to /proc/PID and a buffer of size TASK_COMM_LEN, try to read the process name. Return true on success. */ static bool get_procname (int proc_fd, pid_t pid, char *procname, size_t procname_size) { int fd = openat (proc_fd, "comm", O_RDONLY); if (fd < 0) { warn ("failed to open /proc/%u/comm", pid); return false; } ssize_t len = read (fd, procname, procname_size - 1); close (fd); if (len < 0) { warn ("failed to read /proc/%u/comm", pid); return false; } while (len > 0 && procname[len-1] == '\n') len--; procname[len] = '\0'; return true; } /* given an fd to /proc/PID, return the parent PID if it can be determined, otherwise 0. */ static pid_t get_ppid (int proc_fd, pid_t pid) { static char statbuf[4096]; int stat_fd = openat (proc_fd, "stat", O_RDONLY); if (stat_fd < 0) { warn ("failed to open /proc/%u/stat", pid); return 0; } ssize_t len = read (stat_fd, statbuf, sizeof (statbuf)); close (stat_fd); if (len < 0) { warn ("failed to read /proc/%u/stat", pid); return 0; } /* buffer is static, and read() does not nul terminate */ statbuf[MIN(len, sizeof (statbuf) - 1)] = '\0'; pid_t ret; if (sscanf(statbuf, "%*d (%*[^)]) %*c %d", &ret) == 1) return ret; /* this *really* should not happen, kernel API change */ warnx ("failed to parse /proc/%u/stat, please file a bug: %s", pid, statbuf); return 0; } /** * print_event: * * Print data from fanotify_event_metadata struct to stdout. */ static void print_event (const struct fanotify_event_metadata *data, const struct timeval *event_time) { int event_fd = data->fd; static char printbuf[100]; static char procname[TASK_COMM_LEN]; static int procname_pid = -1; static char pathname[PATH_MAX]; bool got_procname = false; static char exepath[PATH_MAX]; bool got_exepath = false; struct stat proc_fd_stat = { .st_uid = -1 }; int ppid = 0; if ((data->mask & option_filter_mask) == 0 || !show_pid (data->pid)) { if (event_fd >= 0) close (event_fd); return; } snprintf (printbuf, sizeof (printbuf), "/proc/%i", data->pid); int proc_fd = open (printbuf, O_RDONLY | O_DIRECTORY); if (proc_fd >= 0) { /* get ppid */ if (option_parents) ppid = get_ppid (proc_fd, data->pid); /* read process name */ if (get_procname (proc_fd, data->pid, procname, sizeof (procname))) { procname_pid = data->pid; got_procname = true; } /* get user and group */ if (option_user) { if (fstat (proc_fd, &proc_fd_stat) < 0) warn ("failed to stat /proc/%i", data->pid); } /* get exe */ if (option_exe) { ssize_t len = readlinkat (proc_fd, "exe", exepath, sizeof (exepath)); if (len >= 0) { exepath[len] = '\0'; got_exepath = true; } else { warn ("failed to readlink /proc/%i/exe", data->pid); } } close (proc_fd); } else { warn ("failed to open /proc/%u", data->pid); } /* /proc/pid/comm often goes away before processing the event; reuse previously cached value if pid still matches */ if (!got_procname) { if (data->pid == procname_pid) { debug ("re-using cached procname value %s for pid %i", procname, procname_pid); } else if (procname_pid >= 0) { debug ("invalidating previously cached procname %s for pid %i", procname, procname_pid); procname_pid = -1; procname[0] = '\0'; } } if (option_comm && strcmp (option_comm, procname) != 0 && procname[0] != '\0') { if (event_fd >= 0) close (event_fd); return; } #ifdef FAN_REPORT_FID if (fid_mode) event_fd = get_fid_event_fd (data); #endif bool got_path = false; struct stat st = { .st_uid = -1 }; if (event_fd >= 0) { if (option_json && fstat (event_fd, &st) < 0) warn ("stat"); /* try to figure out the path name */ snprintf (printbuf, sizeof (printbuf), "/proc/self/fd/%i", event_fd); ssize_t len = readlink (printbuf, pathname, sizeof (pathname)); if (len >= 0) { pathname[len] = '\0'; got_path = true; } else if (option_json) { // no fallback, device/inode will always be printed } else { /* fall back to the device/inode */ if (fstat (event_fd, &st) < 0) { warn ("stat"); pathname[0] = '\0'; } else { snprintf (pathname, sizeof (pathname), "device %i:%i inode %ld\n", major (st.st_dev), minor (st.st_dev), st.st_ino); } } close (event_fd); } else { snprintf (pathname, sizeof (pathname), "(deleted)"); } if (option_json) putchar('{'); /* print event */ if (option_timestamp == 1) { strftime (printbuf, sizeof (printbuf), "%H:%M:%S", localtime (&event_time->tv_sec)); printf (option_json ? "\"timestamp\":\"%s.%06li\"," : "%s.%06li ", printbuf, event_time->tv_usec); } else if (option_timestamp == 2) { printf (option_json ? "\"timestamp\":%li.%06li," : "%li.%06li ", event_time->tv_sec, event_time->tv_usec); } /* print user and group */ if (option_user && proc_fd_stat.st_uid != (uid_t)-1) snprintf(printbuf, sizeof printbuf, option_json ? "\"uid\":%u,\"gid\":%u," : " [%u:%u]", proc_fd_stat.st_uid, proc_fd_stat.st_gid); else printbuf[0] = '\0'; if (option_json) { if (procname_pid >= 0) { print_json_str("comm", procname); putchar(','); } printf ("\"pid\":%i,%s\"types\":\"%s\"", data->pid, printbuf, mask2str (data->mask)); if (st.st_uid != (uid_t)-1) printf(",\"device\":{\"major\":%i,\"minor\":%i},\"inode\":%ld" , major (st.st_dev), minor (st.st_dev), st.st_ino); if (got_path) { putchar(','); print_json_str("path", pathname); } if (option_exe && got_exepath) { putchar(','); print_json_str("exe", exepath); } } else { printf ("%s(%i)%s: %-3s %s", procname[0] == '\0' ? "unknown" : procname, data->pid, printbuf, mask2str (data->mask), pathname); if (option_exe && got_exepath) printf (" exe=%s", exepath); } if (option_parents && ppid) { printf(option_json ? ",\"parents\":" : ", parents"); char sep = option_json ? '[' : '='; do { printf(option_json ? "%c{\"pid\":%i" : "%c(pid=%i", sep, ppid); sep = ','; snprintf (printbuf, sizeof (printbuf), "/proc/%i", ppid); int ppid_dir_fd = open (printbuf, O_RDONLY | O_DIRECTORY); if (ppid_dir_fd >= 0) { char p_procname[TASK_COMM_LEN]; if (get_procname (ppid_dir_fd, ppid, p_procname, sizeof (p_procname))) { if (option_json) { putchar(','); print_json_str("comm", p_procname); } else printf(" comm=%s", p_procname); } if (option_exe) { ssize_t len = readlinkat (ppid_dir_fd, "exe", exepath, sizeof (exepath) - 1); if (len >= 0) { exepath[len] = '\0'; if (option_json) { putchar(','); print_json_str("exe", exepath); } else printf(" exe=%s", exepath); } } /* get next parent */ if (ppid == 1) ppid = 0; else ppid = get_ppid (ppid_dir_fd, ppid); close (ppid_dir_fd); } else { warn ("failed to open %s", printbuf); ppid = 0; } putchar(option_json ? '}' : ')'); } while (ppid > 0); if (option_json) putchar(']'); } printf(option_json ? "}\n" : "\n"); } static void do_mark (int fan_fd, const char *dir, bool fatal) { int res; uint64_t mask = FAN_ACCESS | FAN_MODIFY | FAN_OPEN | FAN_CLOSE | FAN_ONDIR | FAN_EVENT_ON_CHILD; #ifdef FAN_REPORT_FID if (fid_mode) mask |= FAN_CREATE | FAN_DELETE | FAN_MOVE; #endif res = fanotify_mark (fan_fd, mark_mode, mask, AT_FDCWD, dir); #ifdef FAN_MARK_FILESYSTEM /* fallback for Linux < 4.20 */ if (res < 0 && errno == EINVAL && mark_mode & FAN_MARK_FILESYSTEM) { debug ("FAN_MARK_FILESYSTEM not supported; falling back to FAN_MARK_MOUNT"); mark_mode = FAN_MARK_ADD | FAN_MARK_MOUNT; do_mark (fan_fd, dir, fatal); return; } #endif if (res < 0) { if (fatal) err (EXIT_FAILURE, "Failed to add watch for %s", dir); else warn ("Failed to add watch for %s", dir); } } /** * setup_fanotify: * * @fan_fd: fanotify file descriptor as returned by fanotify_init(). * * Set up fanotify watches on all mount points, or on the current directory * mount if --current-mount is given. */ static void setup_fanotify (int fan_fd) { FILE* mounts; struct mntent* mount; if (option_current_mount) { do_mark (fan_fd, ".", true); return; } /* iterate over all mounts; explicitly start with the root dir, to get * the shortest possible paths on fsid resolution on e. g. OSTree */ do_mark (fan_fd, "/", false); add_fsid ("/"); mounts = setmntent ("/proc/self/mounts", "r"); if (mounts == NULL) err (EXIT_FAILURE, "setmntent"); while ((mount = getmntent (mounts)) != NULL) { /* Only consider mounts which have an actual device or bind mount * point. The others are stuff like proc, sysfs, binfmt_misc etc. which * are virtual and do not actually cause disk access. */ if (mount->mnt_fsname == NULL || access (mount->mnt_fsname, F_OK) != 0 || mount->mnt_fsname[0] != '/') { /* zfs mount point don't start with a "/" so allow them anyway */ if (strcmp(mount->mnt_type, "zfs") != 0) { debug ("ignore: fsname: %s dir: %s type: %s", mount->mnt_fsname, mount->mnt_dir, mount->mnt_type); continue; } } /* root dir already added above */ if (strcmp (mount->mnt_dir, "/") == 0) continue; debug ("add watch for %s mount %s", mount->mnt_type, mount->mnt_dir); do_mark (fan_fd, mount->mnt_dir, false); add_fsid (mount->mnt_dir); } endmntent (mounts); } /** * help: * * Show help. */ static void help (void) { puts ("Usage: fatrace [options...] \n" "\n" "Options:\n" " -c, --current-mount\t\tOnly record events on partition/mount of current directory.\n" " -o FILE, --output=FILE\tWrite events to a file instead of standard output.\n" " -s SECONDS, --seconds=SECONDS\tStop after the given number of seconds.\n" " -t, --timestamp\t\tAdd timestamp to events. Give twice for seconds since the epoch.\n" " -u, --user\t\t\tAdd user ID and group ID to events.\n" " -p PID, --ignore-pid PID\tIgnore events for this process ID. Can be specified multiple times.\n" " -f TYPES, --filter=TYPES\tShow only the given event types; choose from C, R, O, W, +, D, < or >, e. g. --filter=OC.\n" " -C COMM, --command=COMM\tShow only events for this command.\n" " -j, --json\t\t\tWrite events in JSONL format.\n" " -P, --parents\t\t\tInclude information about all parent processes.\n" " -e, --exe\t\t\tAdd executable path to events.\n" " -h, --help\t\t\tShow help."); } /** * parse_args: * * Parse command line arguments and set the global option_* variables. */ static void parse_args (int argc, char** argv) { int c; int j; long pid; char *endptr; static struct option long_options[] = { {"current-mount", no_argument, 0, 'c'}, {"output", required_argument, 0, 'o'}, {"seconds", required_argument, 0, 's'}, {"timestamp", no_argument, 0, 't'}, {"user", no_argument, 0, 'u'}, {"ignore-pid", required_argument, 0, 'p'}, {"filter", required_argument, 0, 'f'}, {"command", required_argument, 0, 'C'}, {"json", no_argument, 0, 'j'}, {"parents", no_argument, 0, 'P'}, {"exe", no_argument, 0, 'e'}, {"help", no_argument, 0, 'h'}, {0, 0, 0, 0 } }; while (1) { c = getopt_long (argc, argv, "C:co:s:tup:f:jPeh", long_options, NULL); if (c == -1) break; switch (c) { case 'C': option_comm = strdup (optarg); if (!option_comm) err(EXIT_FAILURE, "memory allocation failed for --command"); /* see https://man7.org/linux/man-pages/man5/proc_pid_comm.5.html */ if (strlen (option_comm) > TASK_COMM_LEN - 1) { option_comm[TASK_COMM_LEN - 1] = '\0'; warnx ("--command truncated to %i characters: %s", TASK_COMM_LEN - 1, option_comm); } break; case 'c': option_current_mount = true; break; case 'o': option_output = strdup (optarg); if (!option_output) err(EXIT_FAILURE, "memory allocation failed for --output"); break; case 'u': option_user = true; break; case 'f': j = 0; option_filter_mask = 0; while (optarg[j] != '\0') { switch (toupper (optarg[j])) { case 'R': option_filter_mask |= FAN_ACCESS; break; case 'C': option_filter_mask |= FAN_CLOSE_WRITE; option_filter_mask |= FAN_CLOSE_NOWRITE; break; case 'W': option_filter_mask |= FAN_CLOSE_WRITE; option_filter_mask |= FAN_MODIFY; break; case 'O': option_filter_mask |= FAN_OPEN; break; #ifdef FAN_REPORT_FID case '+': option_filter_mask |= FAN_CREATE; break; case 'D': option_filter_mask |= FAN_DELETE; break; case '<': case '>': option_filter_mask |= FAN_MOVE; break; #endif default: errx (EXIT_FAILURE, "Error: Unknown --filter type '%c'", optarg[j]); } j++; } break; case 's': option_timeout = strtol (optarg, &endptr, 10); if (*endptr != '\0' || option_timeout <= 0) errx (EXIT_FAILURE, "Error: Invalid number of seconds"); break; case 'p': pid = strtol (optarg, &endptr, 10); if (*endptr != '\0' || pid <= 0) errx (EXIT_FAILURE, "Error: Invalid PID"); if (ignored_pids_len < (sizeof (ignored_pids) / sizeof (ignored_pids[0]))) ignored_pids[ignored_pids_len++] = pid; else errx (EXIT_FAILURE, "Error: Too many ignored PIDs"); break; case 't': if (++option_timestamp > 2) errx (EXIT_FAILURE, "Error: --timestamp option can be given at most two times"); break; case 'j': option_json = true; break; case 'P': option_parents = true; break; case 'e': option_exe = true; break; case 'h': help (); exit (EXIT_SUCCESS); case '?': /* getopt_long() already prints error message */ exit (EXIT_FAILURE); default: errx (EXIT_FAILURE, "Internal error: unexpected option '%c'", c); } } } static void signal_handler (int signal) { (void)signal; /* ask the main loop to stop */ running = 0; signaled++; /* but if stuck in some others functions, just quit now */ if (signaled > 1) _exit (EXIT_FAILURE); } int main (int argc, char** argv) { int fan_fd = -1; int res; void *buffer; struct fanotify_event_metadata *data; struct sigaction sa; struct timeval event_time; /* always ignore events from ourselves (writing log file) */ ignored_pids[ignored_pids_len++] = getpid (); parse_args (argc, argv); #ifdef FAN_REPORT_FID fan_fd = fanotify_init (FAN_CLASS_NOTIF | FAN_REPORT_FID, O_LARGEFILE); if (fan_fd >= 0) fid_mode = 1; if (fan_fd < 0 && errno == EINVAL) debug ("FAN_REPORT_FID not available"); #endif if (fan_fd < 0) fan_fd = fanotify_init (0, O_LARGEFILE); if (fan_fd < 0) { int e = errno; perror ("Cannot initialize fanotify"); if (e == EPERM) fputs ("You need to run this program as root.\n", stderr); exit (EXIT_FAILURE); } setup_fanotify (fan_fd); /* allocate memory for fanotify */ buffer = NULL; res = posix_memalign (&buffer, 4096, BUFSIZE); if (res != 0 || buffer == NULL) err (EXIT_FAILURE, "Failed to allocate buffer"); /* output file? */ if (option_output) { int fd = open (option_output, O_CREAT|O_WRONLY|O_EXCL, 0666); if (fd < 0) err (EXIT_FAILURE, "Failed to open output file"); fflush (stdout); dup2 (fd, STDOUT_FILENO); close (fd); } /* useful for live tailing and multiple writers */ setlinebuf (stdout); /* setup signal handler to cleanly stop the program */ sa.sa_handler = signal_handler; sigemptyset (&sa.sa_mask); sa.sa_flags = 0; if (sigaction (SIGINT, &sa, NULL) < 0) err (EXIT_FAILURE, "sigaction"); /* set up --time alarm */ if (option_timeout > 0) { sa.sa_handler = signal_handler; sigemptyset (&sa.sa_mask); sa.sa_flags = 0; if (sigaction (SIGALRM, &sa, NULL) < 0) err (EXIT_FAILURE, "sigaction"); alarm (option_timeout); } /* clear event time if timestamp is not required */ if (!option_timestamp) { memset (&event_time, 0, sizeof (struct timeval)); } /* read all events in a loop */ while (running) { res = read (fan_fd, buffer, BUFSIZE); if (res == 0) { fprintf (stderr, "No more fanotify event (EOF)\n"); break; } if (res < 0) { if (errno == EINTR) continue; err (EXIT_FAILURE, "read"); } /* get event time, if requested */ if (option_timestamp) { if (gettimeofday (&event_time, NULL) < 0) err (EXIT_FAILURE, "gettimeofday"); } data = (struct fanotify_event_metadata *) buffer; while (FAN_EVENT_OK (data, res)) { if (data->vers != FANOTIFY_METADATA_VERSION) errx (EXIT_FAILURE, "Mismatch of fanotify metadata version"); print_event (data, &event_time); data = FAN_EVENT_NEXT (data, res); } } return 0; } fatrace-0.19.0/packaging/000077500000000000000000000000001505252125400151335ustar00rootroot00000000000000fatrace-0.19.0/packaging/fatrace.spec000066400000000000000000000015121505252125400174130ustar00rootroot00000000000000Name: fatrace Version: 0 Release: %autorelease Summary: Reports file access events from all running processes License: GPL-3.0-or-later URL: https://github.com/martinpitt/fatrace Source0: https://github.com/martinpitt/fatrace/archive/refs/tags/%{version}.tar.gz BuildRequires: gcc BuildRequires: make %description fatrace reports file access events from all running processes. Its main purpose is to find processes which keep waking up the disk unnecessarily and thus prevent some power saving. %prep %autosetup %build export CFLAGS="%{optflags}" make %{?_smp_mflags} %install export PREFIX=%{_prefix} make install DESTDIR=%{buildroot} # move /sbin to /bin mv %{buildroot}%{_prefix}/sbin %{buildroot}%{_bindir} %files %doc COPYING %{_bindir}/fatrace %{_bindir}/power-usage-report %{_mandir}/man*/* %changelog %autochangelog fatrace-0.19.0/packit.yaml000066400000000000000000000035541505252125400153550ustar00rootroot00000000000000# See the documentation for more information: # https://packit.dev/docs/configuration/ upstream_project_url: https://github.com/martinpitt/fatrace issue_repository: https://github.com/martinpitt/fatrace copy_upstream_release_description: true upstream_package_name: fatrace downstream_package_name: fatrace srpm_build_deps: - make - gcc packages: fatrace-fedora: specfile_path: packaging/fatrace.spec fatrace-centos: specfile_path: packaging/fatrace.spec pkg_tool: centpkg jobs: - job: copr_build trigger: pull_request packages: [fatrace-fedora] targets: - fedora-development-x86_64 - fedora-development-i386 - fedora-development-aarch64 - fedora-development-ppc64le - fedora-development-s390x - fedora-latest - job: copr_build trigger: pull_request packages: [fatrace-centos] targets: - centos-stream-9-x86_64 - centos-stream-10-x86_64 - job: tests trigger: pull_request packages: [fatrace-fedora] targets: - fedora-latest - fedora-development-x86_64 - job: tests trigger: pull_request packages: [fatrace-centos] targets: - centos-stream-9-x86_64 - centos-stream-10-x86_64 # needs coordination with Fedora maintainer first, and handling the sbin patch # - job: propose_downstream # trigger: release # packages: [fatrace-fedora] # dist_git_branches: # - fedora-development # - fedora-stable # # - job: propose_downstream # trigger: release # packages: [fatrace-centos] # dist_git_branches: # - c9s # - c10s # # - job: koji_build # trigger: commit # packages: [fatrace-fedora] # dist_git_branches: # - fedora-all # # - job: bodhi_update # trigger: commit # packages: [fatrace-fedora] # dist_git_branches: # # rawhide updates are created automatically # - fedora-branched fatrace-0.19.0/plans/000077500000000000000000000000001505252125400143245ustar00rootroot00000000000000fatrace-0.19.0/plans/all.fmf000066400000000000000000000001101505252125400155560ustar00rootroot00000000000000summary: Run all tests discover: how: fmf execute: how: tmt fatrace-0.19.0/power-usage-report000077500000000000000000000140231505252125400167040ustar00rootroot00000000000000#!/usr/bin/python3 # (C) 2012, 2013 Canonical Ltd. # Author: Martin Pitt # # 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 . import subprocess import sys import os import time import re import functools import tempfile import json # standard time for measuring in seconds DURATION = 60 def check_dependencies(): '''Check if necessary programs are installed and privileges are available.''' err = '' if os.geteuid() != 0: err += 'You need to run this program as root.\n\n' if subprocess.call(['which', 'powertop'], stdout=subprocess.PIPE) != 0: err += 'powertop not found, please install it.\n\n' if err: sys.stderr.write(err) sys.exit(1) def probe(): '''Call probes and return their output in a dict.''' # ensure that programs run without translations, to avoid breaking parsing env = os.environ.copy() env['LC_MESSAGES'] = 'C' sys.stderr.write('Starting measurement for %i seconds...\n' % DURATION) (fd, powertop_csv) = tempfile.mkstemp(suffix='.csv', prefix='powertop') os.close(fd) powertop = subprocess.Popen(['powertop', '--csv=' + powertop_csv, '--time=' + str(DURATION + 1)], stdout=subprocess.PIPE, env=env) # let powertop initialize; calls lspci and some shell scripts which skew # the fatrace results time.sleep(1) output = {} fatrace = subprocess.Popen(['fatrace', '-jtts', str(DURATION), '-p', str(powertop.pid)], stdout=subprocess.PIPE, env=env) output['fatrace'] = fatrace.communicate()[0].decode('UTF-8', errors='ignore') powertop.communicate() with open(powertop_csv, 'rb') as f: output['powertop'] = f.read().decode('UTF-8', errors='ignore') os.unlink(powertop_csv) return output def parse_fatrace_events(lines): '''Parse fatrace output lines. Split lines into fields, filter out bursts of identical events (usually from reading/writing larger blocks). Return array of (program, pid, mode, file) tuples. ''' prev_timestamp = None events = [] for line in lines: event = json.loads(line) timestamp = event['timestamp'] if prev_timestamp and (timestamp - prev_timestamp < 0.01) and event == events[-1]: continue prev_timestamp = timestamp events.append(event) return events def group_fatrace_events(events): '''Group fatrace events. Return dict program -> file > [#reads,#writes] ''' groups = {} for event in events: if event['types'] == 'C': # ignore read-close events for now continue comm = event['comm'] if 'comm' in event else 'unknown' if 'path' in event: path = event['path'] elif 'device' in event: path = 'device %i:%i inode %i' % (*event['device'], event['inode']) else: path = 'unknown' stat = groups.setdefault(comm, {}).setdefault(path, [0, 0]) if 'W' in event['types']: stat[1] += 1 elif event['types'] in ('R', 'O', 'RO'): stat[0] += 1 return groups def fatrace_report(raw_out): '''Generate disk access report from raw fatrace output''' lines = raw_out.splitlines() event_lines = parse_fatrace_events(lines) events = group_fatrace_events(event_lines) # sort programs by number of events events_per_prog = [] for prog, filemap in events.items(): count = functools.reduce(lambda sum, rw: sum + rw[0] + rw[1], filemap.values(), 0) events_per_prog.append((prog, count)) events_per_prog.sort(key=lambda i: i[1], reverse=True) for (prog, count) in events_per_prog: print('======= %s: %i file access events ======' % (prog, count)) for file, (r, w) in events[prog].items(): s = file + ':' if r > 0: s += ' %i reads' % r if w > 0: s += ' %i writes' % w print(s) print('') def powertop_report(raw_out): '''Generate report from raw powertop output''' # map powertop's headers to our headers for interesting parts blocks = [ ('overview of software power consumers', 'Wakeups'), ('device power report', 'Devices'), ('process device activity', 'Process Device Activity'), ] # filter out multiple empty lines lines = re.sub('\n{3,}', '\n\n', raw_out).splitlines() i = 0 for (search_header, print_header) in blocks: # skip until search_header while i < len(lines) and search_header not in lines[i].lower(): i += 1 i += 1 # skip header # skip empty lines while not lines[i]: i += 1 print('====== %s ======' % print_header) while i < len(lines) and lines[i] and not lines[i].startswith('_____'): print(lines[i]) i += 1 print('') def main(): check_dependencies() # Announce that we are about to start sys.stderr.write('''Measurement will begin in 5 seconds. Please make sure that the computer is idle, i. e. do not press keys, start or operate programs, and that programs are not busy with active tasks other than the one you want to examine.\n''') time.sleep(5) output = probe() sys.stderr.write('Measurement complete. Generating report...\n') fatrace_report(output['fatrace']) powertop_report(output['powertop']) if __name__ == '__main__': main() fatrace-0.19.0/tests/000077500000000000000000000000001505252125400143515ustar00rootroot00000000000000fatrace-0.19.0/tests/__init__.py000066400000000000000000000000001505252125400164500ustar00rootroot00000000000000fatrace-0.19.0/tests/main.fmf000066400000000000000000000004121505252125400157640ustar00rootroot00000000000000summary: integration test duration: 10m require: - fatrace - python3 - make - gcc test: | set -ex # need to be in project root dir cd .. # build so that we get the slow-exit.so preload lib make env FATRACE_INSTALLED_TEST=1 python3 -m unittest -v fatrace-0.19.0/tests/run-container000077500000000000000000000012321505252125400170610ustar00rootroot00000000000000#!/bin/sh set -eu IMAGE="${1:-registry.fedoraproject.org/fedora:latest}" podman run --interactive --rm --privileged -v "$(pwd):/src" -w /src "$IMAGE" </dev/null 2>&1; then apt-get update DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends gcc libc-dev make python3 btrfs-progs else dnf install -y gcc glibc-devel make python3 util-linux btrfs-progs fi make python3 -m unittest -v || { if [ -n "${DEBUG:-}" ]; then echo "Tests failed; run this to debug: podman exec -itl bash" sleep infinity fi exit 1 } EOF fatrace-0.19.0/tests/slow-exit.c000066400000000000000000000004011505252125400164430ustar00rootroot00000000000000/* * LD_PRELOAD library to slow down program exits * This gives fatrace enough time to read process metadata from /proc */ #define _GNU_SOURCE #include __attribute__((destructor)) static void slow_exit_cleanup(void) { usleep (100000); } fatrace-0.19.0/tests/test.py000066400000000000000000000573411505252125400157140ustar00rootroot00000000000000#!/usr/bin/env python3 import json import os import pwd import re import shutil import subprocess import tempfile import time import unittest import sys from pathlib import Path from typing import Callable TESTDIR = Path(__file__).parent.resolve() ROOTDIR = TESTDIR.parent.resolve() exe = subprocess.check_call # check if root fs is btrfs root_is_btrfs = subprocess.check_output(["findmnt", "--noheadings", "--output=FSTYPE", "/"]).strip() == b"btrfs" def slow_exe(argv: list[str], **kwargs) -> None: """Run a command with tests/slow-exit.so Use this for test commands under fatrace, not for setup. """ env = os.environ.copy() env["LD_PRELOAD"] = str(TESTDIR / "slow-exit.so") exe(argv, env=env, **kwargs) def which(cmd: str) -> str: w = shutil.which(cmd) assert w return str(Path(w).resolve()) def retry_unmount(path: str) -> None: for _ in range(5): try: subprocess.call(["umount", path]) break except subprocess.CalledProcessError as e: print(f"Retrying umount {path}: {e}") time.sleep(0.5) else: raise RuntimeError(f"Failed to unmount {path}") class FatraceRunner: def __init__(self, args: list[str]): # we want to support multiple parallel FatraceRunners, so create our own private log dir self.log_dir = tempfile.TemporaryDirectory() self.output_file = os.path.join(self.log_dir.name, "fatrace.log") self.log_content: str | None = None fatrace_bin = "fatrace" if os.getenv("FATRACE_INSTALLED_TEST") else str(ROOTDIR / "fatrace") self.process = subprocess.Popen([fatrace_bin, "-o", str(self.output_file)] + args) # wait until fatrace starts while not os.path.exists(self.output_file): time.sleep(0.1) def finish(self) -> None: """Wait for fatrace to finish and read the log content.""" # fallback timeout; tests should use -s self.process.wait(timeout=10) with open(self.output_file, 'r') as f: self.log_content = f.read() self.log_dir.cleanup() def assert_log(self, pattern: str) -> None: """Check if a regex pattern exists in the log content.""" assert self.log_content, "Need to call run() first" if not re.search(pattern, self.log_content, re.MULTILINE): raise AssertionError(f"""Pattern not found in log: {pattern} ---- Log content ---- {self.log_content} -----------------""") def assert_json(self, condition_func: Callable[[dict], bool]) -> None: """Check if any JSON line matches the condition function.""" assert self.log_content, "Need to call run() first" for line in self.log_content.strip().split('\n'): if not line: continue entry = json.loads(line) try: if condition_func(entry): return except KeyError: # Ignore entries that do not match the expected structure pass raise AssertionError(f"""No JSON entry matched condition ---- Log content ---- {self.log_content} -----------------""") class FatraceTests(unittest.TestCase): def setUp(self): self.tmp_dir = tempfile.TemporaryDirectory() self.addCleanup(self.tmp_dir.cleanup) self.tmp_path = Path(self.tmp_dir.name) # isolated mount, so that --current-mount is shielded from other actions in the OS, # in particular writing our log file exe(["mount", "-t", "tmpfs", "-o", "size=250M", "tmpfs", str(self.tmp_path)]) self.addCleanup(retry_unmount, str(self.tmp_path)) # change away from mount to avoid EBUSY self.addCleanup(os.chdir, TESTDIR) os.chdir(self.tmp_path) def test_currentmount(self): f = FatraceRunner(["--current-mount", "-s", "2"]) f_json = FatraceRunner(["--current-mount", "-s", "2", "--json"]) # Create/write/remove a file test_file = self.tmp_path / "test.txt" slow_exe(["touch", str(test_file)]) slow_exe(["bash", "-c", f"echo hello > '{test_file}'"]) slow_exe(["head", str(test_file)], stdout=subprocess.DEVNULL) slow_exe(["rm", str(test_file)]) # moving within same directory slow_exe(["touch", str(test_file)]) test_file_2 = self.tmp_path / "test.txt.2" slow_exe(["mv", str(test_file), str(test_file_2)]) # Create destination directory and move file there dest_dir = self.tmp_path / "dest" slow_exe(["mkdir", str(dest_dir)]) dest_file = dest_dir / "test.txt.2" slow_exe(["mv", str(test_file_2), str(dest_file)]) slow_exe(["rm", str(dest_file)]) slow_exe(["rmdir", str(dest_dir)]) # Test robustness against ELOOP link_file = self.tmp_path / "link" slow_exe(["ln", "-s", "nothing", str(link_file)]) slow_exe(["rm", str(link_file)]) f.finish() f_json.finish() cwd = str(self.tmp_path) cwd_re = re.escape(cwd) test_file_str = str(test_file) # file creation f.assert_log(rf"^touch.*\sC?W?O\s+{re.escape(test_file_str)}") f.assert_log(rf"^touch.*\sC?WO?\s+{re.escape(test_file_str)}") f.assert_log(rf"^bash.*\sC?WO?\s+{re.escape(test_file_str)}") f_json.assert_json(lambda e: e["comm"] == "touch" and e["path"] == test_file_str and "O" in e["types"]) f_json.assert_json(lambda e: e["comm"] == "touch" and e["path"] == test_file_str and "W" in e["types"]) f_json.assert_json(lambda e: e["comm"] == "bash" and e["path"] == test_file_str and "W" in e["types"]) # file reading f.assert_log(rf"^head.*\sRC?O?\s+{re.escape(test_file_str)}") f_json.assert_json(lambda e: e["comm"] == "head" and e["path"] == test_file_str and "R" in e["types"]) # file deletion f.assert_log(rf"^rm.*:\s+D\s+{cwd_re}$") f_json.assert_json(lambda e: e["comm"] == "rm" and e["path"] == cwd and e["types"] == "D") # directory creation f.assert_log(rf"^touch.*:\s+\+\s+{cwd_re}$") f.assert_log(rf"^mkdir.*:\s+\+\s+{cwd_re}$") f_json.assert_json(lambda e: e["comm"] == "touch" and e["path"] == cwd and e["types"] == "+") f_json.assert_json(lambda e: e["comm"] == "mkdir" and e["path"] == cwd and e["types"] == "+") # file renaming (can be one or two events) f.assert_log(rf"^mv.*:\s+<>?\s+{cwd_re}$") f.assert_log(rf"^mv.*:\s+\s+{cwd_re}$") f_json.assert_json(lambda e: e["comm"] == "mv" and e["path"] == cwd and "<" in e["types"]) f_json.assert_json(lambda e: e["comm"] == "mv" and e["path"] == cwd and ">" in e["types"]) # file moving between directories f.assert_log(rf"^mv.*:\s+<\s+{cwd_re}$") f.assert_log(rf"^mv.*:\s+>\s+{re.escape(str(dest_dir))}$") f_json.assert_json(lambda e: e["comm"] == "mv" and e["path"] == cwd and e["types"] == "<") f_json.assert_json(lambda e: e["comm"] == "mv" and e["path"] == str(dest_dir) and e["types"] == ">") # ELOOP symlink operations f.assert_log(rf"^ln.*:\s+\+\s+{cwd_re}$") f.assert_log(rf"^rm.*:\s+D\s+{cwd_re}$") f_json.assert_json(lambda e: e["comm"] == "ln" and e["path"] == cwd and e["types"] == "+") f_json.assert_json(lambda e: e["comm"] == "rm" and e["path"] == cwd and e["types"] == "D") def test_command(self): f = FatraceRunner(["--current-mount", "--command", "touch", "-s", "2"]) f_json = FatraceRunner(["--current-mount", "--command", "touch", "-s", "2", "--json"]) # Create files with different programs slow_exe(["touch", str(self.tmp_path / "includeme")]) slow_exe(["dd", "if=/dev/zero", f"of={self.tmp_path}/notme", "bs=1", "count=1", "status=none"]) f.finish() f_json.finish() assert f.log_content assert f_json.log_content # Check text log: should find touch command, but not dd nor the file it created f.assert_log(r"^touch.*includeme$") self.assertNotIn("notme", f.log_content) self.assertNotRegex(f.log_content, re.compile(r"^dd", re.MULTILINE)) # Check JSON log includeme_path = str(self.tmp_path / "includeme") f_json.assert_json(lambda e: e["path"] == includeme_path) self.assertNotIn("notme", f_json.log_content) self.assertNotIn('"dd"', f_json.log_content) def test_command_long_name(self): # command name that exceeds TASK_COMM_LEN (16 chars) long_cmd = self.tmp_path / "VeryLongTouchCommand" exe(["cp", "/usr/bin/touch", str(long_cmd)]) f = FatraceRunner(["--current-mount", "--command", "VeryLongTouchCommand", "-s", "2"]) slow_exe([str(long_cmd), str(self.tmp_path / "hello.txt")]) f.finish() # Should find the truncated command name (first 15 chars per TASK_COMM_LEN-1) f.assert_log(rf"^VeryLongTouchCo\(.*C?WO?\s+{str(self.tmp_path)}/hello\.txt$") def test_btrfs(self): if not shutil.which("mkfs.btrfs"): self.skipTest("mkfs.btrfs not installed") # Create btrfs filesystem image_file = self.tmp_path / "btrfs.img" mount_dir = self.tmp_path / "mount" exe(["dd", "if=/dev/zero", f"of={image_file}", "bs=1M", "count=200", "status=none"]) exe(["mkfs.btrfs", "--quiet", str(image_file)]) mount_dir.mkdir() exe(["mount", "-o", "loop", str(image_file), str(mount_dir)]) self.addCleanup(retry_unmount, str(mount_dir)) # Change away from mount point self.addCleanup(os.chdir, self.tmp_path) # Create subvolume os.chdir(mount_dir) exe(["btrfs", "subvolume", "create", str(mount_dir / "subv1")]) # create initial file slow_exe(["bash", "-c", "echo hello > world.txt"]) f = FatraceRunner(["--current-mount", "-s", "2"]) # Read existing file slow_exe(["head", str(mount_dir / "world.txt")], stdout=subprocess.DEVNULL) # Standard file operations test_file = mount_dir / "test.txt" slow_exe(["touch", str(test_file)]) slow_exe(["bash", "-c", f"echo hello > '{test_file}'"]) slow_exe(["rm", str(test_file)]) # Move a file within the same directory slow_exe(["touch", str(test_file)]) test_file_2 = mount_dir / "test.txt.2" slow_exe(["mv", str(test_file), str(test_file_2)]) dest_dir = mount_dir / "dest" slow_exe(["mkdir", str(dest_dir)]) dest_file = dest_dir / "test.txt.2" slow_exe(["mv", str(test_file_2), str(dest_file)]) slow_exe(["rm", str(dest_file)]) slow_exe(["rmdir", str(dest_dir)]) # Create file on subvolume subvol_file = mount_dir / "subv1" / "sub.txt" slow_exe(["touch", str(subvol_file)]) f.finish() mount_str = str(mount_dir) # world.txt access f.assert_log(rf"RC?O?\s+{re.escape(str(mount_dir / 'world.txt'))}$") # file operations on main filesystem test_file_str = str(test_file) f.assert_log(rf"^touch.*\sC?W?O\s+{re.escape(test_file_str)}") f.assert_log(rf"^touch.*\sC?WO?\s+{re.escape(test_file_str)}") f.assert_log(rf"^bash.*\sC?WO?\s+{re.escape(test_file_str)}") f.assert_log(rf"^rm.*\sD?\s+{re.escape(mount_str)}") # directory creation f.assert_log(rf"^touch.*:\s+\+\s+{re.escape(mount_str)}$") f.assert_log(rf"^mkdir.*:\s+\+\s+{re.escape(mount_str)}$") # file renaming (can be one or two events) f.assert_log(rf"^mv.*:\s+<>?\s+{re.escape(mount_str)}$") f.assert_log(rf"^mv.*:\s+\s+{re.escape(mount_str)}$") # file moving f.assert_log(rf"^mv.*:\s+<\s+{re.escape(mount_str)}$") f.assert_log(rf"^mv.*:\s+>\s+{re.escape(str(dest_dir))}$") # subvolume file creation f.assert_log(rf"^touch.*\sC?W?O\s+{re.escape(str(subvol_file))}") def test_exe_parents(self): f = FatraceRunner(["--current-mount", "-s", "2", "--parents", "--exe"]) f_json = FatraceRunner(["--current-mount", "-s", "2", "--json", "--parents", "--exe"]) # Create complex parent chain: touch → bash → python3 → test test_file = self.tmp_path / "file.tmp" bash_pid_file = self.tmp_path / "bash.pid" python_pid_file = self.tmp_path / "python.pid" python_script = f''' import os, subprocess subprocess.run(["bash", "-c", "touch {test_file}; echo $$ > {bash_pid_file}"]) with open("{python_pid_file}", "w") as f: f.write(f"{{os.getpid()}}\\n") ''' slow_exe([sys.executable, "-c", python_script]) f.finish() f_json.finish() # Read process information bash_pid = int(bash_pid_file.read_text().strip()) python_pid = int(python_pid_file.read_text().strip()) test_pid = os.getpid() # Get executable paths touch_exe = which("touch") bash_exe = which("bash") python_exe = which("python3") test_exe = Path("/proc/self/exe").resolve() init_comm = Path("/proc/1/comm").read_text().strip() init_exe = Path("/proc/1/exe").resolve() # Check text log for parent chain f.assert_log( rf"^touch.*exe={re.escape(str(touch_exe))}, " rf"parents=\(pid={bash_pid} comm=bash exe={re.escape(str(bash_exe))}\)," rf"\(pid={python_pid} comm=python3 exe={re.escape(str(python_exe))}\)," rf"\(pid={test_pid} .* exe={re.escape(str(test_exe))}\),.*" rf"\(pid=1 comm={init_comm} exe={re.escape(str(init_exe))}\)" ) # Check JSON log for parent chain f_json.assert_json(lambda e: ( e["comm"] == "touch" and e["path"] == str(test_file) and e["exe"] == str(touch_exe) and len(e["parents"]) >= 4 and e["parents"][0] == {"pid": bash_pid, "comm": "bash", "exe": str(bash_exe)} and e["parents"][1] == {"pid": python_pid, "comm": "python3", "exe": str(python_exe)} and e["parents"][2] == {"pid": test_pid, "comm": "python3", "exe": str(python_exe)} and e["parents"][-1] == {"pid": 1, "comm": init_comm, "exe": str(init_exe)} )) def test_user(self): nobody_user = pwd.getpwnam('nobody') nobody_uid = nobody_user.pw_uid nobody_gid = nobody_user.pw_gid test_file = self.tmp_path / "testfile.txt" test_file.write_text("test content") # Test user tracking functionality f = FatraceRunner(["--current-mount", "--user", "-s", "4"]) f_json = FatraceRunner(["--current-mount", "--user", "-s", "4", "--json"]) def slow_exe_nobody(argv: list[str], **kwargs) -> None: exe(["runuser", "-u", "nobody", "env", "LD_PRELOAD=" + str(TESTDIR / "slow-exit.so")] + argv, **kwargs) # read test file as root slow_exe(["head", str(test_file)], stdout=subprocess.DEVNULL) # read test file as nobody slow_exe_nobody(["tail", str(test_file)], stdout=subprocess.DEVNULL) # Create/remove a file as root test_file_root = self.tmp_path / "testroot.txt" slow_exe(["touch", str(test_file_root)]) slow_exe(["rm", str(test_file_root)]) # Create a world-writable directory for user operations user_tmp = self.tmp_path / "user_tmp" user_tmp.mkdir() user_tmp.chmod(0o1777) # Create/remove a file as user 'nobody' test_file_user = user_tmp / "testnobody.txt" slow_exe_nobody(["touch", str(test_file_user)]) slow_exe_nobody(["rm", str(test_file_user)]) f.finish() f_json.finish() assert f.log_content assert f_json.log_content test_file_str = str(test_file) test_file_root_str = str(test_file_root) test_file_user_str = str(test_file_user) # Reading the test file as root [0:0] f.assert_log(rf"^head.*\[0:0\].*RC?O?\s+{re.escape(test_file_str)}$") f_json.assert_json(lambda e: ( e["comm"] == "head" and e["uid"] == 0 and e["gid"] == 0 and re.match(r"^RC?O?$", e["types"]) is not None and e["path"] == test_file_str )) # Reading the test file as user nobody [uid:gid] f.assert_log(rf"^tail.*\[{nobody_uid}:{nobody_gid}\].*RC?O?\s+{re.escape(test_file_str)}$") f_json.assert_json(lambda e: ( e["comm"] == "tail" and e["uid"] == nobody_uid and e["gid"] == nobody_gid and re.match(r"^RC?O?$", e["types"]) is not None and e["path"] == test_file_str )) # File creation as root [0:0] f.assert_log(rf"^touch.*\[0:0\].*C?W?O\s+{re.escape(test_file_root_str)}$") f_json.assert_json(lambda e: ( e["comm"] == "touch" and e["uid"] == 0 and e["gid"] == 0 and re.match(r"^C?W?O$", e["types"]) is not None and e["path"] == test_file_root_str )) # File creation as user nobody [uid:gid] f.assert_log(rf"^touch.*\[{nobody_uid}:{nobody_gid}\].*C?W?O\s+{re.escape(test_file_user_str)}$") f_json.assert_json(lambda e: ( e["comm"] == "touch" and e["uid"] == nobody_uid and e["gid"] == nobody_gid and re.match(r"^C?W?O$", e["types"]) is not None and e["path"] == test_file_user_str )) def test_json(self): """JSON-specific features like path_raw, UTF-8 handling, device/inode, etc.""" f_json = FatraceRunner(["--current-mount", "--user", "-s", "10", "--json"]) # Test 1: Basic path tracking good_file = self.tmp_path / "1-good.tmp" slow_exe(["touch", str(good_file)]) # Test 2: path_raw for non-UTF8 paths bad_file = self.tmp_path / f"2-bad-{chr(1)}.tmp" slow_exe(["touch", str(bad_file)]) # Test 3: pid tracking pid_file = self.tmp_path / "3-pid" slow_exe(["bash", "-c", f"echo $$ > '{pid_file}'"]) # Test 4: device and inode tracking device_file = self.tmp_path / "4-good.tmp" slow_exe(["touch", str(device_file)]) # Test 5: UTF-8 test cases - keep as raw bytes for bad cases # (expected_result, filename_bytes, description) utf8_test_cases = [ ("bad", b"\x05-tmp", "0x05"), ("bad", b"\x1f-tmp", "0x1f"), ("good", b"\x20-tmp", "0x20 space"), ("good", b"\x21-tmp", "0x21 !"), ("bad", b"\x22-tmp", "0x22 \""), ("good", b"\x23-tmp", "0x23 #"), ("good", b"\x5b-tmp", "0x5b ["), ("bad", b"\x5c-tmp", "0x5c \\"), ("good", b"\x5d-tmp", "0x5d ]"), ("good", b"\x7e-tmp", "0x7e ~"), ("bad", b"\x7f-tmp", "0x7f"), # 2-char UTF-8 ("good", "\u0080-tmp".encode(), "U+0080"), ("good", "\u00c5-tmp".encode(), "U+00c5 Å"), ("bad", b"\xc3-tmp", "incomplete UTF-8"), ("good", "\u07ff-tmp".encode(), "U+07ff ߿"), # 3-char UTF-8 ("good", "\u0800-tmp".encode(), "U+0800 ࠀ"), ("good", "\u0bf5-tmp".encode(), "U+0bf5 ௵"), ("bad", b"\xe0\xaf-tmp", "incomplete UTF-8"), ("good", "\ud7ff-tmp".encode(), "U+d7ff"), ("bad", b"\xed\xa0\x80-tmp", "surrogate U+d800"), ("good", "\ue000-tmp".encode(), "U+e000"), ("good", "\uffff-tmp".encode(), "U+ffff"), # 4-char UTF-8 ("good", "\U00010000-tmp".encode(), "U+10000 𐀀"), ("good", "\U0001f005-tmp".encode(), "U+1f005 🀅"), ("bad", b"\xf0\x9f\x80-tmp", "incomplete UTF-8"), ("good", "\U0010ffff-tmp".encode(), "U+10ffff"), # continuation bytes ("bad", b"\x80-tmp", "0x80"), ("bad", b"\xbf-tmp", "0xbf"), ] created_utf8_files = [] for expected, filename_bytes, description in utf8_test_cases: full_filename_bytes = b"utf8-" + expected.encode('ascii') + b"-" + filename_bytes # Use printf to create the exact filename with byte sequences printf_arg = ''.join(f'\\{b:03o}' for b in full_filename_bytes) slow_exe(["bash", "-c", f"touch \"$(printf '{printf_arg}')\""]) created_utf8_files.append((expected, full_filename_bytes, description)) f_json.finish() assert f_json.log_content # Test 1: Basic path tracking f_json.assert_json(lambda e: e["comm"] == "touch" and e["path"] == str(good_file)) # Test 2: path_raw for non-UTF8 paths # For files with invalid UTF-8, should have path_raw instead of path f_json.assert_json(lambda e: e["comm"] == "touch" and e["path_raw"] == list(str(bad_file).encode('utf-8')) and "path" not in e) # Test 3: pid tracking recorded_pid = int(pid_file.read_text().strip()) f_json.assert_json(lambda e: e["comm"] == "bash" and e["pid"] == recorded_pid and e["path"] == str(pid_file)) # Test 4: device and inode tracking stat_result = device_file.stat() f_json.assert_json(lambda e: ( e["comm"] == "touch" and e["path"] == str(device_file) and e["device"] == {"major": os.major(stat_result.st_dev), "minor": os.minor(stat_result.st_dev)} and e["inode"] == stat_result.st_ino )) # Test 5: UTF-8 validation - test both good and bad cases properly for expected, filename_bytes, description in created_utf8_files: # Calculate the full path bytes full_path_bytes = str(self.tmp_path).encode('utf-8') + b"/" + filename_bytes if expected == "good": # Good UTF-8: should be decodable and have "path" field, should NOT have "path_raw" file_path_str = full_path_bytes.decode('utf-8') f_json.assert_json(lambda e, filepath=file_path_str: ( e["comm"] == "touch" and "comm_raw" not in e and e["path"] == filepath and "path_raw" not in e )) elif expected == "bad": # Bad UTF-8: should NOT be decodable and should have "path_raw" field as byte array file_bytes_list = list(full_path_bytes) f_json.assert_json(lambda e, filebytes=file_bytes_list: ( e["comm"] == "touch" and "comm_raw" not in e and e["path_raw"] == filebytes and "path" not in e )) @unittest.skipIf("container" in os.environ, "Not supported in container environment") @unittest.skipIf(os.path.exists("/sysroot/ostree"), "Test does not work on OSTree") @unittest.skipIf(root_is_btrfs, "FANOTIFY does not work on btrfs, https://github.com/martinpitt/fatrace/issues/3") def test_all_mounts(self): f = FatraceRunner(["-s", "2"]) # read a system file slow_exe(["head", "/etc/passwd"], stdout=subprocess.DEVNULL) # create file test_file = Path("/tmp/fatrace-test.txt") slow_exe(["touch", str(test_file)]) slow_exe(["bash", "-c", f"echo hello > '{test_file}'"]) # remove file slow_exe(["rm", str(test_file)]) f.finish() head_binary = which("head") # opening the head binary f.assert_log(rf"RC?O?\s+{re.escape(head_binary)}$") # head accessing /etc/passwd f.assert_log(r"RC?O?\s+/etc/passwd$") # create a file test_file_str = str(test_file) f.assert_log(rf"^touch.*C?W?O\s+{re.escape(test_file_str)}") f.assert_log(rf"^touch.*C?WO?\s+{re.escape(test_file_str)}") f.assert_log(rf"^bash.*C?WO?\s+{re.escape(test_file_str)}") # remove file f.assert_log(r"^touch.*:\s+\+\s+/tmp$") f.assert_log(r"^rm.*:\s+D\s+/tmp$")