diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4cd4e8a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/swaptop +bin/ +*.test diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b04b4f0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +# Changelog + +## 1.0.0 — 2026-10-07 + +First release. + +- htop-style header: swap split into process-owned, swap cache (reserved but + in RAM) and tmpfs/shm; zswap and zram figures; per-device usage. +- Per-process SWAP, SWPPSS, DELTA, RSS and SWAPPED columns; per-mapping + breakdown; search, sort, tree view. +- Actions: swap a process in, page a process out, flush every swap device, + send a signal. +- Settings persist in `~/.config/swaptop/config`. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..53d1f3d --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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 +. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9d300ca --- /dev/null +++ b/Makefile @@ -0,0 +1,44 @@ +BIN := bin +VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo dev) +LDFLAGS := -s -w -X main.version=$(VERSION:v%=%) +PREFIX ?= /usr/local + +.PHONY: build install man test vet fmt brew-formula repo clean + +build: + go build -trimpath -ldflags '$(LDFLAGS)' -o $(BIN)/swaptop . + +install: build + install -Dm755 $(BIN)/swaptop $(DESTDIR)$(PREFIX)/bin/swaptop + install -Dm644 docs/swaptop.1 $(DESTDIR)$(PREFIX)/share/man/man1/swaptop.1 + +man: + man -l docs/swaptop.1 + +test: + go test ./... + +vet: + go vet ./... + +fmt: + gofmt -w . + +# Homebrew formula for the tagged release. The tag must already be pushed: +# the checksum is of GitHub's source tarball for that tag. +BREW_REPO := https://github.com/andydixon/swaptop +brew-formula: + @set -e; v=$(VERSION); v=$${v#v}; \ + case $$v in *-*) echo "brew-formula: HEAD is not exactly a release tag ($$v)"; exit 1;; esac; \ + url=$(BREW_REPO)/archive/refs/tags/v$$v.tar.gz; \ + sum=$$(curl -fsSL "$$url" | sha256sum | cut -d' ' -f1) || { echo "cannot fetch $$url (tag pushed?)"; exit 1; }; \ + mkdir -p $(BIN)/homebrew; \ + sed -e '/^#/d' -e "s/@VERSION@/$$v/g" -e "s/@SHA256@/$$sum/" packaging/homebrew/swaptop.rb.in > $(BIN)/homebrew/swaptop.rb; \ + echo "wrote $(BIN)/homebrew/swaptop.rb (v$$v, sha256 $$sum)" + +# Build .deb/.rpm/Arch packages for the newest tag and publish to repo.dixon.cx. +repo: + packaging/repo.sh + +clean: + rm -rf $(BIN) diff --git a/README.md b/README.md index 86cf334..1a4b131 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,63 @@ # swaptop -htop-style view of who is using swap and how. Linux only. +htop-style view of which processes are using swap, and how. Linux only. - go build -o swaptop . && sudo ./swaptop +![swaptop](https://img.shields.io/badge/platform-linux-blue) -Without root you only see full detail for your own processes, and the actions need root. +The header splits swap in use into memory owned by processes (green), swap +cache (yellow: pages that are in RAM *and* still hold a swap slot, so +reserved rather than really swapped out) and tmpfs/shm (magenta). zswap and +zram figures appear when present. Each process shows its SWAP, proportional +SWPPSS, DELTA since the last refresh, RSS and how much of it is in swap; +`Enter` breaks a process down by mapping (heap, stacks, libraries, files). -Header: swap bar split into green (owned by processes), yellow (swap cache: in RAM *and* holding a swap slot, i.e. reserved but not really swapped out) and magenta (tmpfs/shm, not owned by a process). zswap and zram figures appear when present. +Actions, each confirmed first: swap a process back in (`F7`), page a process +out (`F8`, `process_madvise`, Linux 5.10+), flush every swap device with +swapoff+swapon (`F2`), send a signal (`F9`). Search (`/`), sort (`F6`), tree +view (`F5`), zero-swap toggle (`z`), full command line (`c`). Settings +persist in `~/.config/swaptop/config`. See `man swaptop`. -Columns: SWAP (in swap now), SWPPSS (proportional share of shared pages), DELTA (change since last refresh), RSS, SWAPPED (share of the process that is in swap). +Run it as root to see every process and use the actions: -Keys: `Enter` per-mapping breakdown · `F7` swap a process back in · `F8` page a process out (`process_madvise`, Linux 5.10+) · `F2` flush every swap device (swapoff+swapon) · `F9` kill · `F3` `/` search · `F6` `s` sort · `z` show zero-swap processes · `c` full command line · `F1` help · `q` quit. +```sh +sudo swaptop +``` + +## Install + +```sh +# Homebrew (Linux) +brew install andydixon/tap/swaptop + +# Debian, Ubuntu +sudo install -d -m 0755 /etc/apt/keyrings +curl -fsSL https://repo.dixon.cx/dixon.gpg | sudo tee /etc/apt/keyrings/dixon.gpg >/dev/null +echo "deb [signed-by=/etc/apt/keyrings/dixon.gpg] https://repo.dixon.cx/apt stable main" | + sudo tee /etc/apt/sources.list.d/dixon.list +sudo apt update && sudo apt install swaptop + +# Fedora, RHEL, AlmaLinux, Rocky +sudo curl -fsSL -o /etc/yum.repos.d/dixon.repo https://repo.dixon.cx/rpm/dixon.repo +sudo dnf install swaptop + +# openSUSE +sudo zypper addrepo https://repo.dixon.cx/rpm/dixon.repo +sudo zypper install swaptop + +# Arch Linux +curl -fsSL https://repo.dixon.cx/dixon.asc | sudo pacman-key --add - +sudo pacman-key --lsign-key C22FF7330668417C62C7A304CBC7951D7F2234D1 +printf '\n[dixon]\nServer = https://repo.dixon.cx/arch/$arch\n' | sudo tee -a /etc/pacman.conf +sudo pacman -Sy swaptop + +# From source +go install github.com/andydixon/swaptop@latest +# or +git clone https://github.com/andydixon/swaptop && cd swaptop && make && sudo make install +``` + +More at [repo.dixon.cx](https://repo.dixon.cx). + +## Licence + +GPL-3.0-or-later. Andy Dixon, [www.dixon.cx](https://www.dixon.cx). diff --git a/config.go b/config.go new file mode 100644 index 0000000..ba90377 --- /dev/null +++ b/config.go @@ -0,0 +1,69 @@ +package main + +import ( + "fmt" + "os" + "path/filepath" + "strconv" + "strings" +) + +// config is ~/.config/swaptop/config: "key = value" lines, rewritten on exit. +type config struct { + Sort string + HideZero bool + FullCmd bool + Tree bool + Refresh float64 // seconds +} + +var defaults = config{Sort: "SWAP", HideZero: true, Refresh: 2} + +func configPath() string { + dir := os.Getenv("XDG_CONFIG_HOME") + if dir == "" { + home, _ := os.UserHomeDir() + dir = filepath.Join(home, ".config") + } + return filepath.Join(dir, "swaptop", "config") +} + +func loadConfig() config { + c := defaults + b, err := os.ReadFile(configPath()) + if err != nil { + return c + } + for _, line := range strings.Split(string(b), "\n") { + k, v, ok := strings.Cut(line, "=") + if !ok || strings.HasPrefix(strings.TrimSpace(line), "#") { + continue + } + k, v = strings.TrimSpace(k), strings.TrimSpace(v) + switch k { + case "sort": + c.Sort = strings.ToUpper(v) + case "hide_zero": + c.HideZero = v == "true" + case "full_cmd": + c.FullCmd = v == "true" + case "tree": + c.Tree = v == "true" + case "refresh": + if f, err := strconv.ParseFloat(v, 64); err == nil && f > 0 { + c.Refresh = f + } + } + } + return c +} + +func (c config) save() error { + p := configPath() + if err := os.MkdirAll(filepath.Dir(p), 0o755); err != nil { + return err + } + return os.WriteFile(p, []byte(fmt.Sprintf( + "# swaptop configuration; rewritten when swaptop exits. See swaptop(1).\nsort = %s\nhide_zero = %t\nfull_cmd = %t\ntree = %t\nrefresh = %g\n", + c.Sort, c.HideZero, c.FullCmd, c.Tree, c.Refresh)), 0o644) +} diff --git a/docs/swaptop.1 b/docs/swaptop.1 new file mode 100644 index 0000000..34c15e4 --- /dev/null +++ b/docs/swaptop.1 @@ -0,0 +1,277 @@ +.\" Manual page for swaptop. View with: man -l docs/swaptop.1 +.TH SWAPTOP 1 "October 2026" "swaptop 1.0.0" "User Commands" +.SH NAME +swaptop \- htop\-style view of which processes are using swap, and how +.SH SYNOPSIS +.B swaptop +[\fB\-d\fR \fISECONDS\fR] [\fB\-s\fR \fICOLUMN\fR] [\fB\-t\fR] [\fB\-z\fR] +.br +.B swaptop +\fB\-\-version\fR +.SH DESCRIPTION +.B swaptop +is a full\-screen terminal monitor, laid out like +.BR htop (1), +that breaks swap usage down by process and by kind. It answers three +questions: how much swap is in use, which processes own it, and how much of +that is really swapped out to the device rather than merely reserved. +.PP +It reads +.IR /proc/meminfo , +.IR /proc/swaps +and, for every process, +.IR /proc/PID/status , +.IR /proc/PID/smaps_rollup +and +.IR /proc/PID/smaps . +Nothing is written anywhere except the configuration file (see +.BR FILES ). +Actions that change memory placement are available from the function keys +and always ask for confirmation first. +.PP +Running as root (\fBsudo swaptop\fR) is recommended: without it the kernel +hides the detailed figures and memory of other users' processes (see +.BR PERMISSIONS ). +.SH OPTIONS +Every option overrides the value loaded from the configuration file. +.TP +.BI \-d " SECONDS" +Refresh interval. Fractions are allowed. Default 2. +.TP +.BI \-s " COLUMN" +Sort column, one of +.BR SWAP , +.BR SWPPSS , +.BR DELTA , +.BR RSS , +.BR SWAPPED , +.BR PID , +.BR USER , +.BR COMMAND . +Default \fBSWAP\fR. +.TP +.B \-t +Start in tree view, processes arranged under their parents. +.TP +.B \-z +Show every process, not only those with memory in swap. +.TP +.B \-\-version +Print the version and exit. +.TP +.B \-h +Print a short usage message and exit. +.SH DISPLAY +.SS Header +.TP +.B Swp +Swap in use out of the total, as a bar coloured by kind: +.RS +.TP +green +attributed to processes. +.TP +yellow +swap cache: pages that are in RAM \fIand\fR still hold a swap slot. They +have been read back in (or were written out ahead of time) and the slot is +kept so they need not be written again. This is "reserved" swap: it costs +nothing to drop and the kernel does so as soon as the device fills up. +.TP +magenta +owned by no process: swapped tmpfs and shared memory files, or slots whose +owner cannot be read without root. +.RE +.TP +.B Mem +RAM in use, buffers and page cache, as in +.BR htop . +.TP +.B zswap +Shown when zswap is active: how much of the used swap is actually held +compressed in RAM rather than on the device. +.TP +Devices +One line per entry in +.IR /proc/swaps +with size, usage and priority. zram devices also show the uncompressed and +compressed sizes. +.TP +Commit +Committed address space against the commit limit, then the number of +processes with memory in swap and the current sort order. +.SS Columns +.TP +.B PID +Process ID. +.TP +.B USER +Owner. +.TP +.B SWAP +Swapped memory this process maps: its own anonymous pages plus any shared +memory (shmem, tmpfs, SysV) it has mapped. Shared memory is counted in every +process that maps it. +.TP +.B SWPPSS +Proportional set size of the process's anonymous swap: pages shared with +other processes (after +.BR fork (2)) +are split between them, so this column sums to the real total. Shared +memory files are not counted. Shown as \fB\-\fR when it cannot be read. +.TP +.B DELTA +Change in \fBSWAP\fR since the previous refresh. Red means the process is +being swapped out, green that it is coming back in. +.TP +.B RSS +Resident memory, in RAM. +.TP +.B SWAPPED +Share of the process's memory (\fBSWAP\fR plus \fBRSS\fR) that is in swap +right now, as a bar and a percentage. +.TP +.B COMMAND +Command name, or the full command line after pressing \fBc\fR. In tree +view it is indented under the parent process. +.SS Detail view +.B Enter +opens a breakdown of the selected process by memory mapping, sorted by +swap: heap, stacks, shared libraries, anonymous regions and files, each with +its swap, proportional swap and resident sizes. This shows \fIwhat\fR has +been swapped out, not just how much. +.SH KEYS +.TP +.B Up, Down, PgUp, PgDn, Home, End +Move the selection. +.TP +.B Enter +Per\-mapping breakdown of the selected process. \fBEsc\fR or \fBq\fR returns. +.TP +.B F1, h, ? +Help. +.TP +.B F3, / +Incremental search over command line, name, user and PID. \fBEnter\fR keeps +the filter, \fBEsc\fR clears it. +.TP +.B F5, t +Toggle tree view. In tree view a process is shown when it or any of its +descendants matches, so parents stay for context; processes without swap are +dimmed. +.TP +.B F6, s +Cycle the sort column. +.TP +.B z +Toggle between processes with swap only (the default) and all processes. +.TP +.B c +Toggle between the command name and the full command line. +.TP +.B F10, q +Quit, saving the current settings. +.SH ACTIONS +Each action asks for confirmation before doing anything. +.TP +.B F7, i \(em swap in +Faults every swapped page of the selected process back into RAM by reading +it through +.IR /proc/PID/mem . +The pages to read are found with +.IR /proc/PID/pagemap +so nothing else is touched. Afterwards the process runs at full speed again. +Its swap slots usually remain allocated as swap cache (yellow in the bar) +until the kernel needs them or the device is flushed. +.TP +.B F8, o \(em swap out +Asks the kernel to reclaim the selected process's resident memory now, with +.BR process_madvise (2) +.BR MADV_PAGEOUT +(Linux 5.10 or later). Anonymous memory is written to swap; clean file\-backed +pages are simply dropped. The process keeps running and faults its memory +back as it touches it. Useful for parking an idle but large process. +.TP +.B F2, F \(em flush +Empties every swap device completely by calling +.BR swapoff (2) +and then +.BR swapon (2) +on each, in order. Everything in swap is pulled back into RAM and every slot, +including swap cache, is released. +.B swaptop +refuses if available RAM is smaller than the swap in use. Each device's +priority is kept; other +.BR swapon (8) +options such as discard are not reapplied. Needs root. +.TP +.B F9, k \(em signal +Opens a picker of common signals (TERM, KILL, INT, HUP, QUIT, USR1, USR2, +STOP, CONT) to send to the selected process. +.SH PERMISSIONS +Reading another user's +.IR smaps_rollup , +.IR smaps , +.IR mem +and +.I pagemap +requires ptrace access to that process, which on most systems +(\fIkernel.yama.ptrace_scope\fR = 1) means root or +.BR CAP_SYS_PTRACE . +Without it the header reports how many swapped processes could not be read, +their \fBSWPPSS\fR shows \fB\-\fR and their \fBSWAP\fR counts anonymous +memory only; swap in and the detail view fail with a hint to use +.BR sudo . +Swap out additionally needs +.BR CAP_SYS_NICE , +and flush needs +.BR CAP_SYS_ADMIN . +.SH CONFIGURATION +Settings are read from the file below at start\-up and written back when +.B swaptop +exits, so the sort order, tree view, zero\-swap filter, command\-line display +and refresh interval persist between runs. The file holds one +.I key = value +per line and may be edited by hand: +.PP +.nf + sort = SWAP # see \-s for the names + hide_zero = true # false shows every process + full_cmd = false + tree = false + refresh = 2 # seconds +.fi +.SH FILES +.TP +.I $XDG_CONFIG_HOME/swaptop/config +Configuration, normally +.IR ~/.config/swaptop/config . +When run under +.BR sudo (8) +this is root's home unless \fBXDG_CONFIG_HOME\fR is passed through. +.TP +.IR /proc/meminfo ", " /proc/swaps ", " /proc/PID/* +Data sources. See +.BR proc (5). +.SH EXIT STATUS +0 on a normal quit, 1 if the terminal cannot be initialised, 2 on a bad +option. +.SH NOTES +Swap cache explains most apparent mismatches: a process can show 0 in +\fBSWAP\fR while the device's usage barely drops, because the slots are kept +until needed. Flushing (\fBF2\fR) is the only way to release them on demand. +.PP +The \fBSWAP\fR column of processes sharing memory (database workers, for +example) double counts that memory, by design, so that each process shows +what it would have to fault in. The header's "in processes" figure uses +\fBSWPPSS\fR and does not double count. +.SH SEE ALSO +.BR htop (1), +.BR free (1), +.BR vmstat (8), +.BR swapon (8), +.BR proc (5), +.BR process_madvise (2) +.SH AUTHOR +Andy Dixon , https://www.dixon.cx +.SH BUGS +Report at https://github.com/andydixon/swaptop/issues diff --git a/go.mod b/go.mod index dc6c919..82b99c6 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module swaptop +module github.com/andydixon/swaptop go 1.24.0 diff --git a/main.go b/main.go index b549f7c..2c69385 100644 --- a/main.go +++ b/main.go @@ -1,6 +1,7 @@ package main import ( + "flag" "fmt" "os" "sort" @@ -12,6 +13,8 @@ import ( "github.com/gdamore/tcell/v2" ) +var version = "dev" + type view int const ( @@ -22,14 +25,28 @@ const ( var sortNames = []string{"SWAP", "SWPPSS", "DELTA", "RSS", "SWAPPED", "PID", "USER", "COMMAND"} +var signals = []struct { + name string + sig syscall.Signal +}{ + {"SIGTERM", syscall.SIGTERM}, {"SIGKILL", syscall.SIGKILL}, {"SIGINT", syscall.SIGINT}, {"SIGHUP", syscall.SIGHUP}, + {"SIGQUIT", syscall.SIGQUIT}, {"SIGUSR1", syscall.SIGUSR1}, {"SIGUSR2", syscall.SIGUSR2}, + {"SIGSTOP", syscall.SIGSTOP}, {"SIGCONT", syscall.SIGCONT}, +} + +// modal is a yes/no question (onYes), an info box (neither) or a picker (items/onPick). type modal struct { - title string - lines []string - onYes func() // nil = info box + title string + lines []string + onYes func() + items []string + pick int + onPick func(int) } type app struct { scr tcell.Screen + cfg config sys *Sys prev map[int]uint64 rows []Proc @@ -39,6 +56,7 @@ type app struct { searching bool hideZero bool fullCmd bool + tree bool view view detail Proc maps []Mapping @@ -67,7 +85,37 @@ var ( stRed = tcell.StyleDefault.Foreground(tcell.ColorRed) ) +func sortIndex(name string) int { + for i, n := range sortNames { + if n == strings.ToUpper(name) { + return i + } + } + return 0 +} + func main() { + cfg := loadConfig() + flag.Usage = func() { + fmt.Fprintf(os.Stderr, "Usage: swaptop [-d SECONDS] [-s COLUMN] [-t] [-z] [--version]\n\nhtop-style view of swap usage per process. Press F1 inside for keys.\n\n") + flag.PrintDefaults() + } + delay := flag.Float64("d", cfg.Refresh, "refresh interval in seconds") + sortFlag := flag.String("s", cfg.Sort, "sort column: "+strings.Join(sortNames, ", ")) + tree := flag.Bool("t", cfg.Tree, "show the process tree") + all := flag.Bool("z", !cfg.HideZero, "show processes with no swap too") + ver := flag.Bool("version", false, "print the version and exit") + flag.Parse() + if *ver { + fmt.Println("swaptop", version) + return + } + if *delay <= 0 { + fmt.Fprintln(os.Stderr, "swaptop: -d must be positive") + os.Exit(2) + } + cfg.Refresh = *delay + scr, err := tcell.NewScreen() if err == nil { err = scr.Init() @@ -76,8 +124,7 @@ func main() { fmt.Fprintln(os.Stderr, "swaptop:", err) os.Exit(1) } - defer scr.Fini() - a := &app{scr: scr, hideZero: true} + a := &app{scr: scr, cfg: cfg, sortBy: sortIndex(*sortFlag), tree: *tree, hideZero: !*all, fullCmd: cfg.FullCmd} a.sample() events := make(chan tcell.Event, 64) go func() { @@ -89,18 +136,24 @@ func main() { events <- ev } }() - tick := time.NewTicker(2 * time.Second) + tick := time.NewTicker(time.Duration(cfg.Refresh * float64(time.Second))) +loop: for { a.draw() select { case ev := <-events: if a.handle(ev) { - return + break loop } case <-tick.C: a.sample() } } + scr.Fini() + cfg.Sort, cfg.HideZero, cfg.FullCmd, cfg.Tree = sortNames[a.sortBy], a.hideZero, a.fullCmd, a.tree + if err := cfg.save(); err != nil { + fmt.Fprintln(os.Stderr, "swaptop: saving config:", err) + } } func (a *app) sample() { @@ -127,42 +180,50 @@ func pct(p Proc) int { return int(p.Swap * 100 / (p.Swap + p.RSS)) } +func (a *app) less(x, y Proc) bool { + switch sortNames[a.sortBy] { + case "SWPPSS": + return x.SwapPss > y.SwapPss + case "DELTA": + return x.Delta > y.Delta + case "RSS": + return x.RSS > y.RSS + case "SWAPPED": + return pct(x) > pct(y) + case "PID": + return x.PID < y.PID + case "USER": + return x.User < y.User + case "COMMAND": + return x.Comm < y.Comm + } + return x.Swap > y.Swap +} + +func (a *app) visible(p Proc) bool { + if a.hideZero && p.Swap == 0 { + return false + } + f := strings.ToLower(a.filter) + return f == "" || strings.Contains(strings.ToLower(p.Cmd+" "+p.Comm+" "+p.User+" "+fmt.Sprint(p.PID)), f) +} + func (a *app) rebuild() { selPID := -1 if a.sel < len(a.rows) { selPID = a.rows[a.sel].PID } a.rows = a.rows[:0] - f := strings.ToLower(a.filter) - for _, p := range a.sys.Procs { - if a.hideZero && p.Swap == 0 { - continue + if a.tree { + a.buildTree() + } else { + for _, p := range a.sys.Procs { + if a.visible(p) { + a.rows = append(a.rows, p) + } } - if f != "" && !strings.Contains(strings.ToLower(p.Cmd+" "+p.Comm+" "+p.User+" "+fmt.Sprint(p.PID)), f) { - continue - } - a.rows = append(a.rows, p) + sort.SliceStable(a.rows, func(i, j int) bool { return a.less(a.rows[i], a.rows[j]) }) } - sort.SliceStable(a.rows, func(i, j int) bool { - x, y := a.rows[i], a.rows[j] - switch sortNames[a.sortBy] { - case "SWPPSS": - return x.SwapPss > y.SwapPss - case "DELTA": - return x.Delta > y.Delta - case "RSS": - return x.RSS > y.RSS - case "SWAPPED": - return pct(x) > pct(y) - case "PID": - return x.PID < y.PID - case "USER": - return x.User < y.User - case "COMMAND": - return x.Comm < y.Comm - } - return x.Swap > y.Swap - }) a.sel = 0 for i, p := range a.rows { if p.PID == selPID { @@ -171,6 +232,71 @@ func (a *app) rebuild() { } } +// buildTree lays processes out by parent, htop style. A process is shown if it +// or any descendant passes the filter, so ancestors stay for context. +func (a *app) buildTree() { + kids := map[int][]Proc{} + present := map[int]bool{} + for _, p := range a.sys.Procs { + present[p.PID] = true + } + for _, p := range a.sys.Procs { + kids[p.PPID] = append(kids[p.PPID], p) + } + for _, k := range kids { + sort.SliceStable(k, func(i, j int) bool { return a.less(k[i], k[j]) }) + } + keep := map[int]bool{} + var mark func(p Proc) bool + mark = func(p Proc) bool { + ok := a.visible(p) + for _, c := range kids[p.PID] { + if mark(c) { + ok = true + } + } + keep[p.PID] = ok + return ok + } + var walk func(p Proc, prefix string, branch string) + walk = func(p Proc, prefix, branch string) { + p.Tree = prefix + branch + a.rows = append(a.rows, p) + var shown []Proc + for _, c := range kids[p.PID] { + if keep[c.PID] { + shown = append(shown, c) + } + } + childPrefix := prefix + if branch != "" { + childPrefix += "│ " + if branch == "└─ " { + childPrefix = prefix + " " + } + } + for i, c := range shown { + b := "├─ " + if i == len(shown)-1 { + b = "└─ " + } + walk(c, childPrefix, b) + } + } + var roots []Proc + for _, p := range a.sys.Procs { + if !present[p.PPID] || p.PPID == p.PID { + roots = append(roots, p) + } + } + sort.SliceStable(roots, func(i, j int) bool { return a.less(roots[i], roots[j]) }) + for _, r := range roots { + if mark(r) { + walk(r, "", "") + } + } +} + // ---- input ---- func (a *app) handle(ev tcell.Event) (quit bool) { @@ -188,18 +314,39 @@ func (a *app) handle(ev tcell.Event) (quit bool) { return false } +func (a *app) modalKey(ev *tcell.EventKey) { + m := a.modal + switch { + case m.items != nil: + switch ev.Key() { + case tcell.KeyUp: + m.pick = max(m.pick-1, 0) + case tcell.KeyDown: + m.pick = min(m.pick+1, len(m.items)-1) + case tcell.KeyEnter: + a.modal = nil + m.onPick(m.pick) + case tcell.KeyEscape: + a.modal = nil + case tcell.KeyRune: + if ev.Rune() == 'q' { + a.modal = nil + } + } + case m.onYes != nil && (ev.Rune() == 'y' || ev.Rune() == 'Y'): + a.modal = nil + m.onYes() + case m.onYes == nil || ev.Key() == tcell.KeyEscape || ev.Rune() == 'n' || ev.Rune() == 'N' || ev.Rune() == 'q': + a.modal = nil + } +} + func (a *app) key(ev *tcell.EventKey) bool { if ev.Key() == tcell.KeyCtrlC { return true } - if m := a.modal; m != nil { - switch { - case m.onYes != nil && (ev.Rune() == 'y' || ev.Rune() == 'Y'): - a.modal = nil - m.onYes() - case m.onYes == nil || ev.Key() == tcell.KeyEscape || ev.Rune() == 'n' || ev.Rune() == 'N' || ev.Rune() == 'q': - a.modal = nil - } + if a.modal != nil { + a.modalKey(ev) return false } if a.searching { @@ -223,12 +370,9 @@ func (a *app) key(ev *tcell.EventKey) bool { return false } n := len(a.rows) - if a.view == viewDetail { - n = len(a.maps) - } pos := &a.sel if a.view == viewDetail { - pos = &a.dtop + n, pos = len(a.maps), &a.dtop } _, h := a.scr.Size() pg := max(h-10, 1) @@ -261,9 +405,10 @@ func (a *app) key(ev *tcell.EventKey) bool { a.askFlush() case tcell.KeyF3: a.searching = true + case tcell.KeyF5: + a.toggleTree() case tcell.KeyF6: - a.sortBy = (a.sortBy + 1) % len(sortNames) - a.rebuild() + a.cycleSort() case tcell.KeyF7: a.askSwapIn() case tcell.KeyF8: @@ -284,8 +429,9 @@ func (a *app) key(ev *tcell.EventKey) bool { case '/': a.searching = true case 's': - a.sortBy = (a.sortBy + 1) % len(sortNames) - a.rebuild() + a.cycleSort() + case 't': + a.toggleTree() case 'z': a.hideZero = !a.hideZero a.rebuild() @@ -305,6 +451,16 @@ func (a *app) key(ev *tcell.EventKey) bool { return false } +func (a *app) cycleSort() { + a.sortBy = (a.sortBy + 1) % len(sortNames) + a.rebuild() +} + +func (a *app) toggleTree() { + a.tree = !a.tree + a.rebuild() +} + func (a *app) current() (Proc, bool) { if a.view == viewDetail { return a.detail, true @@ -393,10 +549,18 @@ func (a *app) askKill() { if !ok { return } - a.modal = &modal{title: "Kill", lines: []string{fmt.Sprintf("Send SIGTERM to %s (%d)?", p.Comm, p.PID)}, onYes: func() { - if err := syscall.Kill(p.PID, syscall.SIGTERM); err != nil { - a.info("Kill failed", err.Error()+permHint(err)) + items := make([]string, len(signals)) + for i, s := range signals { + items[i] = fmt.Sprintf("%2d %s", int(s.sig), s.name) + } + a.modal = &modal{title: fmt.Sprintf("Send signal to %s (%d)", p.Comm, p.PID), items: items, onPick: func(i int) { + if err := syscall.Kill(p.PID, signals[i].sig); err != nil { + a.info("Signal failed", err.Error()+permHint(err)) + return } + a.mu.Lock() + a.status = fmt.Sprintf("Sent %s to %s (%d).", signals[i].name, p.Comm, p.PID) + a.mu.Unlock() }} } @@ -542,8 +706,11 @@ func (a *app) drawHeader(w int) int { } line := fmt.Sprintf("Commit %s / %s %d of %d processes in swap sort: %s", human(m["Committed_AS"]), human(m["CommitLimit"]), a.sys.Swapped, len(a.sys.Procs), sortNames[a.sortBy]) + if a.tree { + line += " tree" + } if a.hideZero { - line += " (z: show all)" + line += " (z: show all)" } if a.filter != "" { line += " filter: " + a.filter @@ -631,6 +798,14 @@ func (a *app) drawList(w, h int) { if a.fullCmd { cmd = p.Cmd } + tst := stDim + if i == a.sel { + tst = stSel + } + x = a.put(x, y, p.Tree, tst) + if a.tree && p.Swap == 0 && i != a.sel { + st = stDim + } a.put(x, y, cmd, st) y++ } @@ -671,7 +846,7 @@ func (a *app) drawDetail(w, h int) { func (a *app) drawHelp() { lines := []string{ - "swaptop - who is using swap, and how", + "swaptop " + version + " - who is using swap, and how", "", "Columns", " SWAP swapped memory this process maps: its anonymous pages plus any shared memory (shmem/tmpfs) it has mapped", @@ -689,12 +864,13 @@ func (a *app) drawHelp() { " F7 i swap in: fault every swapped page of the process back into RAM (reads /proc/PID/mem)", " F8 o swap out: ask the kernel to reclaim the process's pages now (process_madvise MADV_PAGEOUT, Linux 5.10+)", " F2 F flush: swapoff + swapon every device, emptying swap completely (root, needs enough free RAM)", - " F9 k kill (SIGTERM)", + " F9 k send a signal (picker)", "", "Keys", " Up/Down PgUp/PgDn Home/End move Enter per-mapping breakdown of the selected process", - " F3 / search F6 s sort z show/hide processes with no swap c full command line F10 q quit", + " F3 / search F6 s sort F5 t tree view z show/hide processes with no swap c full command line F10 q quit", "", + "Settings (sort, tree, z, c, refresh) are saved to " + configPath() + " on exit.", "Non-root: SWPPSS and actions only work for your own processes (kernel.yama.ptrace_scope).", "", "Press any key to return.", @@ -715,7 +891,7 @@ func (a *app) drawBottom(w, h int) { a.put(0, y, "Search: "+a.filter+"_", stWarn) return } - keys := [][2]string{{"F1", "Help"}, {"F2", "Flush"}, {"F3", "Search"}, {"F6", "SortBy"}, {"F7", "SwapIn"}, {"F8", "SwapOut"}, {"F9", "Kill"}, {"F10", "Quit"}} + keys := [][2]string{{"F1", "Help"}, {"F2", "Flush"}, {"F3", "Search"}, {"F5", "Tree"}, {"F6", "SortBy"}, {"F7", "SwapIn"}, {"F8", "SwapOut"}, {"F9", "Kill"}, {"F10", "Quit"}} if a.view != viewList { keys = [][2]string{{"Esc", "Back"}, {"F7", "SwapIn"}, {"F8", "SwapOut"}, {"F9", "Kill"}, {"F10", "Quit"}} } @@ -729,9 +905,13 @@ func (a *app) drawBottom(w, h int) { func (a *app) drawModal(w, h int) { m := a.modal lines := append([]string{}, m.lines...) - if m.onYes != nil { + switch { + case m.items != nil: + lines = append(lines, m.items...) + lines = append(lines, "", "[Enter] send [Esc] cancel") + case m.onYes != nil: lines = append(lines, "", "[y] yes [n] no") - } else { + default: lines = append(lines, "", "[Enter] ok") } bw := len(m.title) @@ -749,7 +929,14 @@ func (a *app) drawModal(w, h int) { } a.put(x0+2, y0, m.title, st.Bold(true)) for i, l := range lines { - a.put(x0+2, y0+1+i, l, st) + ls := st + if m.items != nil && i >= len(m.lines) && i-len(m.lines) == m.pick { + ls = stSel + for x := x0 + 1; x < x0+bw-1; x++ { + a.scr.SetContent(x, y0+1+i, ' ', nil, ls) + } + } + a.put(x0+2, y0+1+i, l, ls) } } diff --git a/packaging/homebrew/swaptop.rb.in b/packaging/homebrew/swaptop.rb.in new file mode 100644 index 0000000..7acc2d9 --- /dev/null +++ b/packaging/homebrew/swaptop.rb.in @@ -0,0 +1,24 @@ +# Homebrew formula template for swaptop. `make brew-formula` fills in the +# version and the checksum of the GitHub source tarball and writes the +# result to bin/homebrew/swaptop.rb; copy that into your tap +# (github.com/andydixon/homebrew-tap, Formula/swaptop.rb). +class Swaptop < Formula + desc "Htop-style view of which processes are using swap, and how" + homepage "https://github.com/andydixon/swaptop" + url "https://github.com/andydixon/swaptop/archive/refs/tags/v@VERSION@.tar.gz" + sha256 "@SHA256@" + license "GPL-3.0-or-later" + head "https://github.com/andydixon/swaptop.git", branch: "master" + + depends_on "go" => :build + depends_on :linux + + def install + system "go", "build", *std_go_args(ldflags: "-s -w -X main.version=#{version}") + man1.install "docs/swaptop.1" + end + + test do + assert_match version.to_s, shell_output("#{bin}/swaptop --version") + end +end diff --git a/packaging/repo.sh b/packaging/repo.sh new file mode 100755 index 0000000..792d2a6 --- /dev/null +++ b/packaging/repo.sh @@ -0,0 +1,196 @@ +#!/usr/bin/env bash +# Build Linux packages (.deb, .rpm, Arch .pkg.tar.zst) for a release tag and +# publish them to the signed apt, dnf and pacman repositories served at +# https://repo.dixon.cx. +# +# packaging/repo.sh # the newest tag +# packaging/repo.sh v1.0.0 # a given tag +# +# Builds from a clean export of the tag, so the working tree doesn't matter. +# Every index is rebuilt over all the packages in the repository, so other +# projects publishing there with their copy of this script are kept. +# +# Needs: go, docker, gpg, apt-ftparchive (apt-utils), flock. +# REPO_DIR where the repository lives (default below) +# REPO_GNUPGHOME GnuPG home holding the signing key (default below) +# ARCHS Go architectures to package (default below) +# +# The same script, with its own project block, is in mapsize and vault. +set -euo pipefail + +# ---- project --------------------------------------------------------------- +NAME=swaptop # the command +PACKAGE=swaptop +CONFLICTS= +SUMMARY="htop-style view of which processes are using swap, and how" +HOMEPAGE=https://github.com/andydixon/swaptop +LICENSE=GPL-3.0-or-later +MANPAGES=docs/*.1 +DOCS="README.md CHANGELOG.md LICENSE" +# build OUT: build the binary to OUT, in the source tree, with GOOS, GOARCH +# and GOARM set and VERSION the release. +build() { + CGO_ENABLED=0 go build -trimpath \ + -ldflags "-s -w -X main.version=$VERSION" \ + -o "$1" . +} +# ---------------------------------------------------------------------------- + +REPO_DIR=${REPO_DIR:-/home/andy/domains/repo.dixon.cx/public_html} +REPO_GNUPGHOME=${REPO_GNUPGHOME:-$HOME/.config/repo.dixon.cx/gnupg} +ARCHS=${ARCHS:-"amd64 arm64 arm 386 riscv64"} +NFPM="go run github.com/goreleaser/nfpm/v2/cmd/nfpm@v2.41.1" +SUITE=stable +COMPONENT=main +ARCH_REPO=dixon # the pacman repository name: [dixon] + +say() { echo "repo: $*" >&2; } +die() { say "$*"; exit 1; } + +for tool in go docker gpg apt-ftparchive flock; do + command -v $tool >/dev/null || die "needs $tool" +done +[[ -d $REPO_DIR ]] || die "$REPO_DIR does not exist" +export GNUPGHOME=$REPO_GNUPGHOME +KEY=$(gpg --list-secret-keys --with-colons 2>/dev/null | awk -F: '/^fpr/{print $10; exit}') +[[ -n $KEY ]] || die "no signing key in $GNUPGHOME" + +cd "$(git rev-parse --show-toplevel)" +TAG=${1:-$(git describe --tags --abbrev=0)} +git rev-parse -q --verify "refs/tags/$TAG" >/dev/null || die "no tag $TAG" +VERSION=${TAG#v} +export VERSION + +WORK=$(mktemp -d) +trap 'rm -rf "$WORK"' EXIT +git archive "$TAG" | tar -x -C "$WORK" --one-top-level=src +gpg --batch --armor --export-secret-keys "$KEY" >"$WORK/signing.asc" + +# ---- build ----------------------------------------------------------------- +say "building $PACKAGE $VERSION for $ARCHS" +mkdir -p "$WORK/out" +for arch in $ARCHS; do + goarm= nfarch=$arch + [[ $arch == arm ]] && goarm=7 nfarch=arm7 + (cd "$WORK/src" && GOOS=linux GOARCH=$arch GOARM=$goarm build "$WORK/bin-$arch/$NAME") + { + cat <<-EOF + name: $PACKAGE + arch: $nfarch + platform: linux + version: $VERSION + release: 1 + maintainer: Andy Dixon + description: $SUMMARY + homepage: $HOMEPAGE + license: $LICENSE + conflicts: [${CONFLICTS:-}] + contents: + - src: $WORK/bin-$arch/$NAME + dst: /usr/bin/$NAME + file_info: {mode: 0755} + EOF + for m in $(cd "$WORK/src" && ls $MANPAGES); do + printf ' - src: %s\n dst: /usr/share/man/man1/%s\n file_info: {mode: 0644}\n' \ + "$WORK/src/$m" "$(basename "$m")" + done + for d in $DOCS; do + printf ' - src: %s\n dst: /usr/share/doc/%s/%s\n file_info: {mode: 0644}\n' \ + "$WORK/src/$d" "$PACKAGE" "$d" + done + printf 'rpm:\n signature:\n key_file: %s\n' "$WORK/signing.asc" + } >"$WORK/nfpm-$arch.yaml" + for fmt in deb rpm archlinux; do + $NFPM pkg -f "$WORK/nfpm-$arch.yaml" -p $fmt -t "$WORK/out/" >/dev/null + done +done + +# ---- publish --------------------------------------------------------------- +# One publisher at a time: the indexes cover every project's packages. +exec 9>"$REPO_DIR/../.publish.lock" +flock 9 +say "publishing to $REPO_DIR" +gpg --batch --armor --export "$KEY" >"$REPO_DIR/dixon.asc" +gpg --batch --export "$KEY" >"$REPO_DIR/dixon.gpg" +sign() { gpg --batch --yes --local-user "$KEY" "$@"; } + +# apt: pool/main///, indexed by apt-ftparchive. +pool=$REPO_DIR/apt/pool/$COMPONENT/${PACKAGE:0:1}/$PACKAGE +mkdir -p "$pool" +cp "$WORK"/out/*.deb "$pool/" +( + cd "$REPO_DIR/apt" + # Built beside the live suite and swapped in, so clients never see half. + dists=dists/.$SUITE.new + rm -rf "$dists" + debarchs=$(find pool -name '*.deb' | sed -E 's/.*_([^_]+)\.deb$/\1/' | sort -u | tr '\n' ' ') + for a in $debarchs; do + d=$dists/$COMPONENT/binary-$a + mkdir -p "$d" + apt-ftparchive --arch "$a" packages pool >"$d/Packages" + gzip -9kn "$d/Packages" + done + apt-ftparchive \ + -o APT::FTPArchive::Release::Origin=repo.dixon.cx \ + -o APT::FTPArchive::Release::Label=repo.dixon.cx \ + -o APT::FTPArchive::Release::Suite=$SUITE \ + -o APT::FTPArchive::Release::Codename=$SUITE \ + -o APT::FTPArchive::Release::Components=$COMPONENT \ + -o "APT::FTPArchive::Release::Architectures=${debarchs% }" \ + release "$dists" >"$WORK/Release" + mv "$WORK/Release" "$dists/Release" + sign --clearsign -o "$dists/InRelease" "$dists/Release" + sign --armor --detach-sign -o "$dists/Release.gpg" "$dists/Release" + rm -rf "dists/.$SUITE.old" + [[ -d dists/$SUITE ]] && mv "dists/$SUITE" "dists/.$SUITE.old" + mv "$dists" "dists/$SUITE" + rm -rf "dists/.$SUITE.old" +) + +# dnf: every architecture in one directory; dnf picks its own. +mkdir -p "$REPO_DIR/rpm" +cp "$WORK"/out/*.rpm "$REPO_DIR/rpm/" +docker image inspect repo-tools:fedora >/dev/null 2>&1 || + docker build -q -t repo-tools:fedora - >/dev/null <<-'EOF' + FROM fedora:42 + RUN dnf -y install createrepo_c && dnf clean all + EOF +docker run --rm --user "$(id -u):$(id -g)" -v "$REPO_DIR/rpm:/repo" repo-tools:fedora \ + createrepo_c --quiet --update --general-compress-type=gz /repo +sign --armor --detach-sign -o "$REPO_DIR/rpm/repodata/repomd.xml.asc" "$REPO_DIR/rpm/repodata/repomd.xml" +cat >"$REPO_DIR/rpm/dixon.repo" <&1 | + { grep -v "newer version\|^$" >&2 || true; } + for db in $ARCH_REPO.db $ARCH_REPO.files; do + sign --detach-sign -o "$dir/$db.tar.gz.sig" "$dir/$db.tar.gz" + ln -sfn "$db.tar.gz.sig" "$dir/$db.sig" + done + rm -f "$dir"/*.old "$dir"/*.old.sig +done + +say "published $PACKAGE $VERSION: $(cd "$WORK/out" && ls | wc -l) packages" diff --git a/proc.go b/proc.go index 85a103f..b0899d5 100644 --- a/proc.go +++ b/proc.go @@ -19,7 +19,8 @@ type SwapDev struct { } type Proc struct { - PID, UID int + PID, PPID, UID int + Tree string // tree-view prefix, display only User, Comm, Cmd string Swap, SwapPss, RSS uint64 Delta int64 // change in Swap since previous sample @@ -88,6 +89,8 @@ func readProc(pid int) (Proc, bool) { switch k { case "Name": p.Comm = v + case "PPid": + p.PPID, _ = strconv.Atoi(v) case "Uid": p.UID, _ = strconv.Atoi(strings.Fields(v)[0]) case "VmRSS": diff --git a/proc_test.go b/proc_test.go index 8d9b486..6c051d5 100644 --- a/proc_test.go +++ b/proc_test.go @@ -21,3 +21,28 @@ Swap: 0 kB t.Fatal("parseKV") } } + +func TestTree(t *testing.T) { + a := &app{hideZero: true, sys: &Sys{Procs: []Proc{ + {PID: 1, PPID: 0, Comm: "init"}, + {PID: 2, PPID: 1, Comm: "a", Swap: 10}, + {PID: 3, PPID: 2, Comm: "b", Swap: 5}, + {PID: 4, PPID: 1, Comm: "c"}, // no swap anywhere below: hidden + }}, tree: true} + a.rebuild() + if len(a.rows) != 3 || a.rows[0].PID != 1 || a.rows[1].Tree != "└─ " || a.rows[2].Tree != " └─ " { + t.Fatalf("bad tree: %+v", a.rows) + } +} + +func TestConfig(t *testing.T) { + t.Setenv("XDG_CONFIG_HOME", t.TempDir()) + c := defaults + c.Sort, c.Tree, c.Refresh = "RSS", true, 0.5 + if err := c.save(); err != nil { + t.Fatal(err) + } + if got := loadConfig(); got != c { + t.Fatalf("round trip: %+v != %+v", got, c) + } +}