From 2f39c58d6ca72cd869ba69e03d639f36d497e9a8 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 19 Nov 2024 18:43:43 +0000 Subject: [PATCH 001/112] Initial commit --- .gitignore | 19 ++ COPYING | 674 +++++++++++++++++++++++++++++++++++++++ Makefile.am | 17 + README | 4 + bootstrap | 3 + configure.ac | 19 ++ guile.am | 21 ++ guix-dev.scm | 50 +++ knots.scm | 21 ++ knots/non-blocking.scm | 63 ++++ knots/parallelism.scm | 197 ++++++++++++ knots/promise.scm | 78 +++++ knots/queue.scm | 47 +++ knots/resource-pool.scm | 485 ++++++++++++++++++++++++++++ knots/timeout.scm | 200 ++++++++++++ knots/web-server.scm | 263 +++++++++++++++ knots/worker-threads.scm | 577 +++++++++++++++++++++++++++++++++ pre-inst-env.in | 13 + tests.scm | 28 ++ tests/non-blocking.scm | 31 ++ tests/parallelism.scm | 15 + tests/promise.scm | 20 ++ tests/queue.scm | 22 ++ tests/resource-pool.scm | 18 ++ tests/timeout.scm | 22 ++ tests/web-server.scm | 30 ++ tests/worker-threads.scm | 32 ++ 27 files changed, 2969 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 Makefile.am create mode 100644 README create mode 100755 bootstrap create mode 100644 configure.ac create mode 100644 guile.am create mode 100644 guix-dev.scm create mode 100644 knots.scm create mode 100644 knots/non-blocking.scm create mode 100644 knots/parallelism.scm create mode 100644 knots/promise.scm create mode 100644 knots/queue.scm create mode 100644 knots/resource-pool.scm create mode 100644 knots/timeout.scm create mode 100644 knots/web-server.scm create mode 100644 knots/worker-threads.scm create mode 100644 pre-inst-env.in create mode 100644 tests.scm create mode 100644 tests/non-blocking.scm create mode 100644 tests/parallelism.scm create mode 100644 tests/promise.scm create mode 100644 tests/queue.scm create mode 100644 tests/resource-pool.scm create mode 100644 tests/timeout.scm create mode 100644 tests/web-server.scm create mode 100644 tests/worker-threads.scm diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..10520ac --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +*.go +Makefile.in +Makefile +aclocal.m4 +autom4te.cache +config.log +config.status +configure + +build-aux/install-sh +build-aux/missing + +*.log +tests/*.log +tests/*.trs + +pre-inst-env + +.local.envrc diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + 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.am b/Makefile.am new file mode 100644 index 0000000..5643873 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,17 @@ +include guile.am + +SOURCES = \ + knots.scm \ + knots/non-blocking.scm \ + knots/parallelism.scm \ + knots/promise.scm \ + knots/queue.scm \ + knots/resource-pool.scm \ + knots/timeout.scm \ + knots/web-server.scm \ + knots/worker-threads.scm + +EXTRA_DIST = \ + README \ + bootstrap \ + pre-inst-env.in diff --git a/README b/README new file mode 100644 index 0000000..e593a79 --- /dev/null +++ b/README @@ -0,0 +1,4 @@ +-*- mode: org -*- + +This Guile library provides useful patterns and functionality to use +Guile Fibers. diff --git a/bootstrap b/bootstrap new file mode 100755 index 0000000..5af6611 --- /dev/null +++ b/bootstrap @@ -0,0 +1,3 @@ +#! /bin/sh + +autoreconf --verbose --install --force diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..fe1cb2f --- /dev/null +++ b/configure.ac @@ -0,0 +1,19 @@ +AC_INIT([guile-knots], [0.1]) +AC_CONFIG_AUX_DIR([build-aux]) +AM_INIT_AUTOMAKE([-Wall -Werror foreign]) + +GUILE_PKG([3.0]) +GUILE_PROGS +if test "x$GUILD" = "x"; then + AC_MSG_ERROR(['guild' binary not found; please check your guile 3 installation.]) +fi + +if test "$cross_compiling" != no; then + GUILE_TARGET="--target=$host_alias" + AC_SUBST([GUILE_TARGET]) +fi + +AC_CONFIG_FILES([Makefile]) +AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env]) + +AC_OUTPUT diff --git a/guile.am b/guile.am new file mode 100644 index 0000000..743bdea --- /dev/null +++ b/guile.am @@ -0,0 +1,21 @@ +moddir=$(datadir)/guile/site/$(GUILE_EFFECTIVE_VERSION) +godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache + +GOBJECTS = $(SOURCES:%.scm=%.go) + +nobase_dist_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES) +nobase_go_DATA = $(GOBJECTS) + +# Make sure source files are installed first, so that the mtime of +# installed compiled files is greater than that of installed source +# files. See +# +# for details. +guile_install_go_files = install-nobase_goDATA +$(guile_install_go_files): install-nobase_dist_modDATA + +CLEANFILES = $(GOBJECTS) +GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat +SUFFIXES = .scm .go +.scm.go: + $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILD) compile $(GUILE_TARGET) $(GUILE_WARNINGS) -o "$@" "$<" diff --git a/guix-dev.scm b/guix-dev.scm new file mode 100644 index 0000000..6b51e8a --- /dev/null +++ b/guix-dev.scm @@ -0,0 +1,50 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +;;; Run the following command to enter a development environment for +;;; Guile Knots: +;;; +;;; $ guix environment -l guix-dev.scm + +(use-modules ((guix licenses) #:prefix license:) + (guix packages) + (guix build-system gnu) + (gnu packages) + (gnu packages autotools) + (gnu packages guile) + (gnu packages guile-xyz) + (gnu packages pkg-config) + (srfi srfi-1)) + +(package + (name "guile-knots") + (version "0.0.0") + (source #f) + (build-system gnu-build-system) + (inputs + (list guile-3.0 + guile-fibers)) + (native-inputs + (list autoconf + automake + pkg-config)) + (synopsis "TODO") + (description "TODO") + (home-page "TODO") + (license license:gpl3+)) diff --git a/knots.scm b/knots.scm new file mode 100644 index 0000000..d545770 --- /dev/null +++ b/knots.scm @@ -0,0 +1,21 @@ +(define-module (knots) + #:use-module (ice-9 suspendable-ports) + #:export (call-with-default-io-waiters + + wait-when-system-clock-behind)) + +(define (call-with-default-io-waiters thunk) + (parameterize + ((current-read-waiter (@@ (ice-9 suspendable-ports) + default-read-waiter)) + (current-write-waiter (@@ (ice-9 suspendable-ports) + default-write-waiter))) + (thunk))) + +(define (wait-when-system-clock-behind) + (let ((start-of-the-year-2000 946684800)) + (while (< (current-time) + start-of-the-year-2000) + (simple-format (current-error-port) + "warning: system clock potentially behind, waiting\n") + (sleep 20)))) diff --git a/knots/non-blocking.scm b/knots/non-blocking.scm new file mode 100644 index 0000000..5914143 --- /dev/null +++ b/knots/non-blocking.scm @@ -0,0 +1,63 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots non-blocking) + #:use-module (web uri) + #:use-module (web client) + #:export (non-blocking-port + nonblocking-open-socket-for-uri)) + +(define (non-blocking-port port) + "Make PORT non-blocking and return it." + (let ((flags (fcntl port F_GETFL))) + (when (zero? (logand O_NONBLOCK flags)) + (fcntl port F_SETFL (logior O_NONBLOCK flags))) + port)) + +(define* (nonblocking-open-socket-for-uri uri + #:key (verify-certificate? #t)) + (define tls-wrap + (@@ (web client) tls-wrap)) + + (define https? + (eq? 'https (uri-scheme uri))) + + (define plain-uri + (if https? + (build-uri + 'http + #:userinfo (uri-userinfo uri) + #:host (uri-host uri) + #:port (or (uri-port uri) 443) + #:path (uri-path uri) + #:query (uri-query uri) + #:fragment (uri-fragment uri)) + uri)) + + (let ((s (open-socket-for-uri plain-uri))) + (if https? + (let ((port + (tls-wrap s (uri-host uri) + #:verify-certificate? verify-certificate?))) + ;; Guile/guile-gnutls don't handle the handshake happening on a non + ;; blocking socket, so change the behavior here. + (non-blocking-port s) + port) + (non-blocking-port s)))) + diff --git a/knots/parallelism.scm b/knots/parallelism.scm new file mode 100644 index 0000000..b5b03d5 --- /dev/null +++ b/knots/parallelism.scm @@ -0,0 +1,197 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots parallelism) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-71) + #:use-module (ice-9 match) + #:use-module (fibers) + #:use-module (fibers channels) + #:use-module (fibers operations) + #:export (fibers-batch-map + fibers-map + + fibers-map-with-progress + + fibers-batch-for-each + fibers-for-each + + fibers-parallel + fibers-let)) + +;; Like split-at, but don't care about the order of the resulting lists, and +;; don't error if the list is shorter than i elements +(define (split-at* lst i) + (let lp ((l lst) (n i) (acc '())) + (if (or (<= n 0) (null? l)) + (values (reverse! acc) l) + (lp (cdr l) (- n 1) (cons (car l) acc))))) + +;; As this can be called with lists with tens of thousands of items in them, +;; batch the +(define (get-batch batch-size lists) + (let ((split-lists + (map (lambda (lst) + (let ((batch rest (split-at* lst batch-size))) + (cons batch rest))) + lists))) + (values (map car split-lists) + (map cdr split-lists)))) + +(define (defer-to-parallel-fiber thunk) + (let ((reply (make-channel))) + (spawn-fiber + (lambda () + (with-exception-handler + (lambda (exn) + (put-message reply (cons 'exception exn))) + (lambda () + (call-with-values + (lambda () + (with-throw-handler #t + thunk + (lambda _ + (backtrace)))) + (lambda vals + (put-message reply vals)))) + #:unwind? #t)) + #:parallel? #t) + reply)) + +(define (fetch-result-of-defered-thunks . reply-channels) + (let ((responses (map get-message + reply-channels))) + (map + (match-lambda + (('exception . exn) + (raise-exception exn)) + (result + (apply values result))) + responses))) + +(define (fibers-batch-map proc batch-size . lists) + (let loop ((lists lists) + (result '())) + (let ((batch + rest + (get-batch batch-size lists))) + (if (any null? batch) + result + (let ((response-channels + (apply map + (lambda args + (defer-to-parallel-fiber + (lambda () + (apply proc args)))) + batch))) + (loop rest + (append! result + (apply fetch-result-of-defered-thunks + response-channels)))))))) + +(define (fibers-map proc . lists) + (apply fibers-batch-map proc 20 lists)) + +(define (fibers-batch-for-each proc batch-size . lists) + (let loop ((lists lists)) + (let ((batch + rest + (get-batch batch-size lists))) + (if (any null? batch) + *unspecified* + (let ((response-channels + (apply map + (lambda args + (defer-to-parallel-fiber + (lambda () + (apply proc args)))) + batch))) + (apply fetch-result-of-defered-thunks + response-channels) + (loop rest)))))) + +(define (fibers-for-each proc . lists) + (apply fibers-batch-for-each proc 20 lists)) + +(define-syntax fibers-parallel + (lambda (x) + (syntax-case x () + ((_ e0 ...) + (with-syntax (((tmp0 ...) (generate-temporaries (syntax (e0 ...))))) + #'(let ((tmp0 (defer-to-parallel-fiber + (lambda () + e0))) + ...) + (apply values (fetch-result-of-defered-thunks tmp0 ...)))))))) + +(define-syntax-rule (fibers-let ((v e) ...) b0 b1 ...) + (call-with-values + (lambda () (fibers-parallel e ...)) + (lambda (v ...) + b0 b1 ...))) + +(define* (fibers-map-with-progress proc lists #:key report) + (let loop ((channels-to-results + (apply map + (lambda args + (cons (defer-to-parallel-fiber + (lambda () + (apply proc args))) + #f)) + lists))) + (let ((active-channels + (filter-map car channels-to-results))) + (when report + (report (apply map + list + (map cdr channels-to-results) + lists))) + (if (null? active-channels) + (map + (match-lambda + ((#f . ('exception . exn)) + (raise-exception exn)) + ((#f . ('result . val)) + val)) + channels-to-results) + (loop + (perform-operation + (apply + choice-operation + (filter-map + (lambda (p) + (match p + ((channel . _) + (if channel + (wrap-operation + (get-operation channel) + (lambda (result) + (map (match-lambda + ((c . r) + (if (eq? channel c) + (cons #f + (match result + (('exception . exn) + result) + (_ + (cons 'result result)))) + (cons c r)))) + channels-to-results))) + #f)))) + channels-to-results)))))))) diff --git a/knots/promise.scm b/knots/promise.scm new file mode 100644 index 0000000..3eb0a81 --- /dev/null +++ b/knots/promise.scm @@ -0,0 +1,78 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots promise) + #:use-module (srfi srfi-9) + #:use-module (ice-9 atomic) + #:use-module (fibers) + #:use-module (fibers conditions) + #:export (fibers-delay + fibers-force + fibers-promise-reset)) + +(define-record-type + (make-fibers-promise thunk values-box evaluated-condition) + fibers-promise? + (thunk fibers-promise-thunk) + (values-box fibers-promise-values-box) + (evaluated-condition fibers-promise-evaluated-condition)) + +(define (fibers-delay thunk) + (make-fibers-promise + thunk + (make-atomic-box #f) + (make-condition))) + +(define (fibers-force fp) + (let ((res (atomic-box-compare-and-swap! + (fibers-promise-values-box fp) + #f + 'started))) + (if (eq? #f res) + (call-with-values + (lambda () + (with-exception-handler + (lambda (exn) + (atomic-box-set! (fibers-promise-values-box fp) + exn) + (signal-condition! + (fibers-promise-evaluated-condition fp)) + (raise-exception exn)) + (fibers-promise-thunk fp) + #:unwind? #t)) + (lambda vals + (atomic-box-set! (fibers-promise-values-box fp) + vals) + (signal-condition! + (fibers-promise-evaluated-condition fp)) + (apply values vals))) + (if (eq? res 'started) + (begin + (wait (fibers-promise-evaluated-condition fp)) + (let ((result (atomic-box-ref (fibers-promise-values-box fp)))) + (if (exception? result) + (raise-exception result) + (apply values result)))) + (if (exception? res) + (raise-exception res) + (apply values res)))))) + +(define (fibers-promise-reset fp) + (atomic-box-set! (fibers-promise-values-box fp) + #f)) diff --git a/knots/queue.scm b/knots/queue.scm new file mode 100644 index 0000000..ec9f703 --- /dev/null +++ b/knots/queue.scm @@ -0,0 +1,47 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots queue) + #:use-module (ice-9 q) + #:use-module (fibers) + #:use-module (fibers channels) + #:use-module (fibers operations) + #:export (spawn-queueing-fiber)) + +(define (spawn-queueing-fiber dest-channel) + (define queue (make-q)) + + (let ((queue-channel (make-channel))) + (spawn-fiber + (lambda () + (while #t + (if (q-empty? queue) + (enq! queue + (perform-operation + (get-operation queue-channel))) + (let ((front (q-front queue))) + (perform-operation + (choice-operation + (wrap-operation (get-operation queue-channel) + (lambda (val) + (enq! queue val))) + (wrap-operation (put-operation dest-channel front) + (lambda _ + (q-pop! queue)))))))))) + queue-channel)) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm new file mode 100644 index 0000000..67e9292 --- /dev/null +++ b/knots/resource-pool.scm @@ -0,0 +1,485 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots resource-pool) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-9) + #:use-module (ice-9 match) + #:use-module (ice-9 exceptions) + #:use-module (fibers) + #:use-module (fibers timers) + #:use-module (fibers channels) + #:use-module (fibers scheduler) + #:use-module (fibers operations) + #:export (resource-pool? + + make-resource-pool + destroy-resource-pool + + resource-pool-default-timeout + resource-pool-retry-checkout-timeout + + &resource-pool-timeout + resource-pool-timeout-error? + + resource-pool-default-timeout-handler + + call-with-resource-from-pool + with-resource-from-pool + + resource-pool-stats)) + +(define-record-type + (make-resource-pool-record name channel) + resource-pool? + (name resource-pool-name) + (channel resource-pool-channel)) + +(define* (make-resource-pool initializer max-size + #:key (min-size max-size) + (idle-seconds #f) + (delay-logger (const #f)) + (duration-logger (const #f)) + destructor + lifetime + scheduler + (name "unnamed") + ;; Add options for customizing timeouts + ) + (define (initializer/safe) + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running ~A resource pool initializer: ~A:\n ~A\n" + name + initializer + exn) + #f) + (lambda () + (with-throw-handler #t + initializer + (lambda args + (backtrace)))) + #:unwind? #t)) + + (define (destructor/safe args) + (let ((success? + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running resource pool destructor (~A): ~A:\n ~A\n" + name + destructor + exn) + #f) + (lambda () + (with-throw-handler #t + (lambda () + (destructor args) + #t) + (lambda _ + (backtrace)))) + #:unwind? #t))) + + (or success? + #t + (begin + (sleep 5) + (destructor/safe args))))) + + (let ((channel (make-channel)) + (checkout-failure-count 0)) + (spawn-fiber + (lambda () + (when idle-seconds + (spawn-fiber + (lambda () + (while #t + (sleep idle-seconds) + (put-message channel '(check-for-idle-resources)))))) + + (while #t + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception in the ~A pool fiber: ~A\n" + name + exn)) + (lambda () + (let loop ((resources '()) + (available '()) + (waiters '()) + (resources-last-used '())) + + (match (get-message channel) + (('checkout reply) + (if (null? available) + (if (= (length resources) max-size) + (loop resources + available + (cons reply waiters) + resources-last-used) + (let ((new-resource (initializer/safe))) + (if new-resource + (let ((checkout-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply new-resource) + (const #t)) + (wrap-operation (sleep-operation 1) + (const #f)))))) + (unless checkout-success? + (set! checkout-failure-count + (+ 1 checkout-failure-count))) + + (loop (cons new-resource resources) + (if checkout-success? + available + (cons new-resource available)) + waiters + (cons (get-internal-real-time) + resources-last-used))) + (loop resources + available + (cons reply waiters) + resources-last-used)))) + (let ((checkout-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply (car available)) + (const #t)) + (wrap-operation (sleep-operation 1) + (const #f)))))) + (unless checkout-success? + (set! checkout-failure-count + (+ 1 checkout-failure-count))) + + (if checkout-success? + (loop resources + (cdr available) + waiters + resources-last-used) + (loop resources + available + waiters + resources-last-used))))) + (('return resource) + (if (null? waiters) + (loop resources + (cons resource available) + waiters + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used)) + (let ((checkout-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation (last waiters) + resource) + (const #t)) + (wrap-operation (sleep-operation 1) + (const #f)))))) + (unless checkout-success? + (set! checkout-failure-count + (+ 1 checkout-failure-count))) + + (if checkout-success? + (loop resources + available + (drop-right! waiters 1) + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used)) + (begin + (for-each + (lambda (waiter) + (spawn-fiber + (lambda () + (perform-operation + (choice-operation + (put-operation waiter 'resource-pool-retry-checkout) + (sleep-operation 10)))))) + waiters) + + (loop resources + (cons resource available) + '() + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used))))))) + (('stats reply) + (let ((stats + `((resources . ,(length resources)) + (available . ,(length available)) + (waiters . ,(length waiters)) + (checkout-failure-count . ,checkout-failure-count)))) + + (spawn-fiber + (lambda () + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply stats) + (const #t)) + (wrap-operation (sleep-operation 1) + (const #f))))))) + + (loop resources + available + waiters + resources-last-used)) + (('check-for-idle-resources) + (let* ((resources-last-used-seconds + (map + (lambda (internal-time) + (/ (- (get-internal-real-time) internal-time) + internal-time-units-per-second)) + resources-last-used)) + (resources-to-destroy + (filter-map + (lambda (resource last-used-seconds) + (if (and (member resource available) + (> last-used-seconds idle-seconds)) + resource + #f)) + resources + resources-last-used-seconds))) + + (for-each + (lambda (resource) + (destructor/safe resource)) + resources-to-destroy) + + (loop (lset-difference eq? resources resources-to-destroy) + (lset-difference eq? available resources-to-destroy) + waiters + (filter-map + (lambda (resource last-used) + (if (memq resource resources-to-destroy) + #f + last-used)) + resources + resources-last-used)))) + (('destroy reply) + (if (= (length resources) (length available)) + (begin + (for-each + (lambda (resource) + (destructor/safe resource)) + resources) + (put-message reply 'destroy-success)) + (begin + (spawn-fiber + (lambda () + (perform-operation + (choice-operation + (put-operation reply 'resource-pool-destroy-failed) + (sleep-operation 10))))) + (loop resources + available + waiters + resources-last-used)))) + (unknown + (simple-format + (current-error-port) + "unrecognised message to ~A resource pool channel: ~A\n" + name + unknown) + (loop resources + available + waiters + resources-last-used))))) + #:unwind? #t))) + (or scheduler + (current-scheduler))) + + (make-resource-pool-record name channel))) + +(define (destroy-resource-pool pool) + (let ((reply (make-channel))) + (put-message (resource-pool-channel pool) + (list 'destroy reply)) + (let ((msg (get-message reply))) + (unless (eq? msg 'destroy-success) + (error msg))))) + +(define resource-pool-default-timeout + (make-parameter #f)) + +(define resource-pool-retry-checkout-timeout + (make-parameter 5)) + +(define &resource-pool-timeout + (make-exception-type '&recource-pool-timeout + &error + '(name))) + +(define make-resource-pool-timeout-error + (record-constructor &resource-pool-timeout)) + +(define resource-pool-timeout-error? + (record-predicate &resource-pool-timeout)) + +(define resource-pool-default-timeout-handler + (make-parameter #f)) + +(define* (call-with-resource-from-pool + pool proc #:key (timeout 'default) + (timeout-handler (resource-pool-default-timeout-handler))) + "Call PROC with a resource from POOL, blocking until a resource becomes +available. Return the resource once PROC has returned." + + (define retry-timeout + (resource-pool-retry-checkout-timeout)) + + (define timeout-or-default + (if (eq? timeout 'default) + (resource-pool-default-timeout) + timeout)) + + (let ((resource + (let ((reply (make-channel))) + (let loop ((start-time (get-internal-real-time))) + (let ((request-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation (resource-pool-channel pool) + `(checkout ,reply)) + (const #t)) + (wrap-operation (sleep-operation (or timeout-or-default + retry-timeout)) + (const #f)))))) + (if request-success? + (let ((time-remaining + (- (or timeout-or-default + retry-timeout) + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second)))) + (if (> time-remaining 0) + (let ((response + (perform-operation + (choice-operation + (get-operation reply) + (wrap-operation (sleep-operation time-remaining) + (const #f)))))) + (if (or (not response) + (eq? response 'resource-pool-retry-checkout)) + (if (> (- (or timeout-or-default + retry-timeout) + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second)) + 0) + (loop start-time) + (if (eq? timeout-or-default #f) + (loop (get-internal-real-time)) + #f)) + response)) + (if (eq? timeout-or-default #f) + (loop (get-internal-real-time)) + #f))) + (if (eq? timeout-or-default #f) + (loop (get-internal-real-time)) + #f))))))) + + (when (or (not resource) + (eq? resource 'resource-pool-retry-checkout)) + (when timeout-handler + (timeout-handler pool proc timeout)) + + (raise-exception + (make-resource-pool-timeout-error (resource-pool-name pool)))) + + (with-exception-handler + (lambda (exception) + (put-message (resource-pool-channel pool) + `(return ,resource)) + (raise-exception exception)) + (lambda () + (call-with-values + (lambda () + (with-throw-handler #t + (lambda () + (proc resource)) + (lambda _ + (backtrace)))) + (lambda vals + (put-message (resource-pool-channel pool) + `(return ,resource)) + (apply values vals)))) + #:unwind? #t))) + +(define-syntax-rule (with-resource-from-pool pool resource exp ...) + (call-with-resource-from-pool + pool + (lambda (resource) exp ...))) + +(define* (resource-pool-stats pool #:key (timeout 5)) + (let ((reply (make-channel)) + (start-time (get-internal-real-time))) + (perform-operation + (choice-operation + (wrap-operation + (put-operation (resource-pool-channel pool) + `(stats ,reply)) + (const #t)) + (wrap-operation (sleep-operation timeout) + (lambda _ + (raise-exception + (make-resource-pool-timeout-error)))))) + + (let ((time-remaining + (- timeout + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second)))) + (if (> time-remaining 0) + (perform-operation + (choice-operation + (get-operation reply) + (wrap-operation (sleep-operation time-remaining) + (lambda _ + (raise-exception + (make-resource-pool-timeout-error)))))) + (raise-exception + (make-resource-pool-timeout-error)))))) + diff --git a/knots/timeout.scm b/knots/timeout.scm new file mode 100644 index 0000000..8f8a2fb --- /dev/null +++ b/knots/timeout.scm @@ -0,0 +1,200 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots timeout) + #:use-module (srfi srfi-71) + #:use-module (ice-9 match) + #:use-module (ice-9 atomic) + #:use-module (ice-9 exceptions) + #:use-module (ice-9 ports internal) + #:use-module (ice-9 suspendable-ports) + #:use-module (fibers) + #:use-module (fibers timers) + #:use-module (fibers channels) + #:use-module (fibers scheduler) + #:use-module (fibers operations) + #:export (with-fibers-timeout + + &port-timeout + port-timeout-error? + + &port-read-timeout + port-read-timeout-error + + &port-write-timeout + port-write-timeout-error? + + with-port-timeouts)) + +(define* (with-fibers-timeout thunk #:key timeout on-timeout) + (let ((channel (make-channel))) + (spawn-fiber + (lambda () + (with-exception-handler + (lambda (exn) + (perform-operation + (choice-operation + (put-operation channel (cons 'exception exn)) + (sleep-operation timeout)))) + (lambda () + (call-with-values thunk + (lambda vals + (perform-operation + (choice-operation + (put-operation channel vals) + (sleep-operation timeout)))))) + #:unwind? #t))) + + (match (perform-operation + (choice-operation + (get-operation channel) + (wrap-operation (sleep-operation timeout) + (const 'timeout)))) + ('timeout + (on-timeout)) + (('exception . exn) + (raise-exception exn)) + (vals + (apply values vals))))) + +(define &port-timeout + (make-exception-type '&port-timeout + &external-error + '(thunk port))) + +(define make-port-timeout-error + (record-constructor &port-timeout)) + +(define port-timeout-error? + (record-predicate &port-timeout)) + +(define &port-read-timeout + (make-exception-type '&port-read-timeout + &port-timeout + '())) + +(define make-port-read-timeout-error + (record-constructor &port-read-timeout)) + +(define port-read-timeout-error? + (record-predicate &port-read-timeout)) + +(define &port-write-timeout + (make-exception-type '&port-write-timeout + &port-timeout + '())) + +(define make-port-write-timeout-error + (record-constructor &port-write-timeout)) + +(define port-write-timeout-error? + (record-predicate &port-write-timeout)) + +(define (readable? port) + "Test if PORT is writable." + (= 1 (port-poll port "r" 0))) + +(define (writable? port) + "Test if PORT is writable." + (= 1 (port-poll port "w" 0))) + +(define (make-wait-operation ready? schedule-when-ready port + port-ready-fd this-procedure) + (make-base-operation #f + (lambda _ + (and (ready? port) values)) + (lambda (flag sched resume) + (define (commit) + (match (atomic-box-compare-and-swap! flag 'W 'S) + ('W (resume values)) + ('C (commit)) + ('S #f))) + (schedule-when-ready + sched (port-ready-fd port) commit)))) + +(define (wait-until-port-readable-operation port) + "Make an operation that will succeed when PORT is readable." + (unless (input-port? port) + (error "refusing to wait forever for input on non-input port")) + (make-wait-operation readable? schedule-task-when-fd-readable port + port-read-wait-fd + wait-until-port-readable-operation)) + +(define (wait-until-port-writable-operation port) + "Make an operation that will succeed when PORT is writable." + (unless (output-port? port) + (error "refusing to wait forever for output on non-output port")) + (make-wait-operation writable? schedule-task-when-fd-writable port + port-write-wait-fd + wait-until-port-writable-operation)) + +(define* (with-port-timeouts thunk + #:key timeout + (read-timeout timeout) + (write-timeout timeout)) + (define (no-fibers-wait thunk port mode timeout) + (define poll-timeout-ms 200) + + ;; When the GC runs, it restarts the poll syscall, but the timeout + ;; remains unchanged! When the timeout is longer than the time + ;; between the syscall restarting, I think this renders the + ;; timeout useless. Therefore, this code uses a short timeout, and + ;; repeatedly calls poll while watching the clock to see if it has + ;; timed out overall. + (let ((timeout-internal + (+ (get-internal-real-time) + (* internal-time-units-per-second timeout)))) + (let loop ((poll-value + (port-poll port mode poll-timeout-ms))) + (if (= poll-value 0) + (if (> (get-internal-real-time) + timeout-internal) + (raise-exception + (if (string=? mode "r") + (make-port-read-timeout-error thunk port) + (make-port-write-timeout-error thunk port))) + (loop (port-poll port mode poll-timeout-ms))) + poll-value)))) + + (parameterize + ((current-read-waiter + (lambda (port) + (if (current-scheduler) + (perform-operation + (choice-operation + (wait-until-port-readable-operation port) + (wrap-operation + (sleep-operation read-timeout) + (lambda () + (raise-exception + (make-port-read-timeout-error thunk port)))))) + (no-fibers-wait thunk port "r" read-timeout)))) + (current-write-waiter + (lambda (port) + (if (current-scheduler) + (perform-operation + (choice-operation + (wait-until-port-writable-operation port) + (wrap-operation + (sleep-operation write-timeout) + (lambda () + (raise-exception + (make-port-write-timeout-error thunk port)))))) + (no-fibers-wait thunk port "w" write-timeout))))) + (thunk))) diff --git a/knots/web-server.scm b/knots/web-server.scm new file mode 100644 index 0000000..b94106f --- /dev/null +++ b/knots/web-server.scm @@ -0,0 +1,263 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; Copyright (C) 2010-2013,2015,2017 Free Software Foundation, Inc. + +;; This library is free software; you can redistribute it and/or +;; modify it under the terms of the GNU Lesser General Public +;; License as published by the Free Software Foundation; either +;; version 3 of the License, or (at your option) any later version. +;; +;; This library 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 +;; Lesser General Public License for more details. +;; +;; You should have received a copy of the GNU Lesser General Public License +;; along with this program. If not, see . + +(define-module (knots web-server) + #:use-module (srfi srfi-9) + #:use-module (srfi srfi-71) + #:use-module (fibers) + #:use-module (fibers conditions) + #:use-module (rnrs bytevectors) + #:use-module (ice-9 binary-ports) + #:use-module (ice-9 textual-ports) + #:use-module (ice-9 iconv) + #:use-module (ice-9 match) + #:use-module ((srfi srfi-9 gnu) #:select (set-field)) + #:use-module (system repl error-handling) + #:use-module (web http) + #:use-module (web request) + #:use-module (web response) + #:use-module (knots non-blocking) + #:export (run-knots-web-server + + web-server? + web-server-socket + web-server-port)) + +(define (make-default-socket family addr port) + (let ((sock (socket PF_INET SOCK_STREAM 0))) + (setsockopt sock SOL_SOCKET SO_REUSEADDR 1) + (fcntl sock F_SETFD FD_CLOEXEC) + (bind sock family addr port) + sock)) + +(define (extend-response r k v . additional) + (define (extend-alist alist k v) + (let ((pair (assq k alist))) + (acons k v (if pair (delq pair alist) alist)))) + (let ((r (set-field r (response-headers) + (extend-alist (response-headers r) k v)))) + (if (null? additional) + r + (apply extend-response r additional)))) + +;; -> response body +(define (sanitize-response request response body) + "\"Sanitize\" the given response and body, making them appropriate for +the given request. + +As a convenience to web handler authors, RESPONSE may be given as +an alist of headers, in which case it is used to construct a default +response. Ensures that the response version corresponds to the request +version. If BODY is a string, encodes the string to a bytevector, +in an encoding appropriate for RESPONSE. Adds a +‘content-length’ and ‘content-type’ header, as necessary. + +If BODY is a procedure, it is called with a port as an argument, +and the output collected as a bytevector. In the future we might try to +instead use a compressing, chunk-encoded port, and call this procedure +later, in the write-client procedure. Authors are advised not to rely +on the procedure being called at any particular time." + (cond + ((list? response) + (sanitize-response request + (build-response #:version (request-version request) + #:headers response) + body)) + ((not (equal? (request-version request) (response-version response))) + (sanitize-response request + (adapt-response-version response + (request-version request)) + body)) + ((not body) + (values response #vu8())) + ((string? body) + (let* ((type (response-content-type response + '(text/plain))) + (declared-charset (assq-ref (cdr type) 'charset)) + (charset (or declared-charset "utf-8"))) + (sanitize-response + request + (if declared-charset + response + (extend-response response 'content-type + `(,@type (charset . ,charset)))) + (string->bytevector body charset)))) + ((not (or (bytevector? body) + (procedure? body))) + (error "unexpected body type")) + ((and (response-must-not-include-body? response) + body + ;; FIXME make this stricter: even an empty body should be prohibited. + (not (zero? (bytevector-length body)))) + (error "response with this status code must not include body" response)) + (else + ;; check length; assert type; add other required fields? + (values (if (procedure? body) + (if (response-content-length response) + response + (extend-response response + 'transfer-encoding + '((chunked)))) + (let ((rlen (response-content-length response)) + (blen (bytevector-length body))) + (cond + (rlen (if (= rlen blen) + response + (error "bad content-length" rlen blen))) + (else (extend-response response 'content-length blen))))) + (if (eq? (request-method request) 'HEAD) + ;; Responses to HEAD requests must not include bodies. + ;; We could raise an error here, but it seems more + ;; appropriate to just do something sensible. + #f + body))))) + +(define (with-stack-and-prompt thunk) + (call-with-prompt (default-prompt-tag) + (lambda () (start-stack #t (thunk))) + (lambda (k proc) + (with-stack-and-prompt (lambda () (proc k)))))) + +(define (keep-alive? response) + (let ((v (response-version response))) + (and (or (< (response-code response) 400) + (= (response-code response) 404)) + (case (car v) + ((1) + (case (cdr v) + ((1) (not (memq 'close (response-connection response)))) + ((0) (memq 'keep-alive (response-connection response))))) + (else #f))))) + +(define (handle-request handler client) + (let ((request + (catch #t + (lambda () + (read-request client)) + (lambda (key . args) + (display "While reading request:\n" (current-error-port)) + (print-exception (current-error-port) #f key args) + #f)))) + (let ((response + body + (cond + ((not request) + ;; Bad request. + (values (build-response #:version '(1 . 0) #:code 400 + #:headers '((content-length . 0))) + #vu8())) + (else + (call-with-error-handling + (lambda () + (call-with-values (lambda () + (with-stack-and-prompt + (lambda () + (handler request)))) + (lambda (response body) + (sanitize-response request response body)))) + #:on-error 'backtrace + #:post-error (lambda _ + (values (build-response #:code 500) #f))))))) + (write-response response client) + (when body + (if (procedure? body) + (if (response-content-length response) + (body client) + (let ((chunked-port + (make-chunked-output-port client + #:keep-alive? #t))) + (body chunked-port) + (close-port chunked-port))) + (put-bytevector client body))) + (force-output client) + + (keep-alive? response)))) + +(define (client-loop client handler) + ;; Always disable Nagle's algorithm, as we handle buffering + ;; ourselves; when we force-output, we really want the data to go + ;; out. + (setvbuf client 'block 1024) + (setsockopt client IPPROTO_TCP TCP_NODELAY 1) + (with-throw-handler #t + (lambda () + (let loop () + (cond + ((catch #t + (lambda () (eof-object? (lookahead-u8 client))) + (lambda _ #t)) + (close-port client)) + (else + (let ((keep-alive? (handle-request handler client))) + (if keep-alive? + (loop) + (close-port client))))))) + (lambda (k . args) + (close-port client)))) + +(define-record-type + (make-web-server socket port) + web-server? + (socket web-server-socket) + (port web-server-port)) + +(define* (run-knots-web-server handler #:key + (host #f) + (family AF_INET) + (addr (if host + (inet-pton family host) + INADDR_LOOPBACK)) + (port 8080) + (socket (make-default-socket family addr port))) + "Run the fibers web server. + +HANDLER should be a procedure that takes one argument, the HTTP +request and returns two values, the response and response body. + +For example, here is a simple \"Hello, World!\" server: + +@example + (define (handler request) + (let ((body (read-request-body request))) + (values '((content-type . (text/plain))) + \"Hello, World!\"))) + (run-server handler) +@end example + +The response and body will be run through ‘sanitize-response’ +before sending back to the client." + (non-blocking-port socket) + ;; We use a large backlog by default. If the server is suddenly hit + ;; with a number of connections on a small backlog, clients won't + ;; receive confirmation for their SYN, leading them to retry -- + ;; probably successfully, but with a large latency. + (listen socket 1024) + (sigaction SIGPIPE SIG_IGN) + + (spawn-fiber + (lambda () + (let loop () + (match (accept socket (logior SOCK_NONBLOCK SOCK_CLOEXEC)) + ((client . sockaddr) + (spawn-fiber (lambda () + (client-loop client handler)) + #:parallel? #t) + (loop)))))) + + (make-web-server socket + (vector-ref (getsockname socket) + 2))) ; Not sure what this structure is diff --git a/knots/worker-threads.scm b/knots/worker-threads.scm new file mode 100644 index 0000000..f4116e9 --- /dev/null +++ b/knots/worker-threads.scm @@ -0,0 +1,577 @@ +;;; Guile Knots +;;; Copyright © 2020 Christopher Baines +;;; +;;; This file is part of Guile Knots. +;;; +;;; The Guile Knots 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. +;;; +;;; The Guile Knots 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 the guix-data-service. If not, see +;;; . + +(define-module (knots worker-threads) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-19) + #:use-module (srfi srfi-71) + #:use-module (system foreign) + #:use-module (system base target) + #:use-module (rnrs bytevectors) + #:use-module (ice-9 q) + #:use-module (ice-9 match) + #:use-module (ice-9 threads) + #:use-module (fibers) + #:use-module (fibers timers) + #:use-module (fibers channels) + #:use-module (fibers operations) + #:export (set-thread-name + thread-name + + make-worker-thread-channel + call-with-worker-thread + + &worker-thread-timeout + worker-thread-timeout-error? + + %worker-thread-default-timeout + + create-work-queue)) + +(define* (syscall->procedure return-type name argument-types + #:key library) + "Return a procedure that wraps the C function NAME using the dynamic FFI, +and that returns two values: NAME's return value, and errno. When LIBRARY is +specified, look up NAME in that library rather than in the global symbol name +space. + +If an error occurs while creating the binding, defer the error report until +the returned procedure is called." + (catch #t + (lambda () + ;; Note: When #:library is set, try it first and fall back to libc + ;; proper. This is because libraries like libutil.so have been subsumed + ;; by libc.so with glibc >= 2.34. + (let ((ptr (dynamic-func name + (if library + (or (false-if-exception + (dynamic-link library)) + (dynamic-link)) + (dynamic-link))))) + ;; The #:return-errno? facility was introduced in Guile 2.0.12. + (pointer->procedure return-type ptr argument-types + #:return-errno? #t))) + (lambda args + (lambda _ + (throw 'system-error name "~A" (list (strerror ENOSYS)) + (list ENOSYS)))))) + +(define %prctl + ;; Should it win the API contest against 'ioctl'? You tell us! + (syscall->procedure int "prctl" + (list int unsigned-long unsigned-long + unsigned-long unsigned-long))) + +(define PR_SET_NAME 15) ; +(define PR_GET_NAME 16) +(define PR_SET_CHILD_SUBREAPER 36) + +(define (set-child-subreaper!) + "Set the CHILD_SUBREAPER capability for the current process." + (%prctl PR_SET_CHILD_SUBREAPER 1 0 0 0)) + +(define %max-thread-name-length + ;; Maximum length in bytes of the process name, including the terminating + ;; zero. + 16) + +(define (set-thread-name!/linux name) + "Set the name of the calling thread to NAME. NAME is truncated to 15 +bytes." + (let ((ptr (string->pointer name))) + (let ((ret + err + (%prctl PR_SET_NAME + (pointer-address ptr) 0 0 0))) + (unless (zero? ret) + (throw 'set-process-name "set-process-name" + "set-process-name: ~A" + (list (strerror err)) + (list err)))))) + +(define (bytes->string bytes) + "Read BYTES, a list of bytes, and return the null-terminated string decoded +from there, or #f if that would be an empty string." + (match (take-while (negate zero?) bytes) + (() + #f) + (non-zero + (list->string (map integer->char non-zero))))) + +(define (thread-name/linux) + "Return the name of the calling thread as a string." + (let ((buf (make-bytevector %max-thread-name-length))) + (let ((ret + err + (%prctl PR_GET_NAME + (pointer-address (bytevector->pointer buf)) + 0 0 0))) + (if (zero? ret) + (bytes->string (bytevector->u8-list buf)) + (throw 'process-name "process-name" + "process-name: ~A" + (list (strerror err)) + (list err)))))) + +(define set-thread-name + (if (string-contains %host-type "linux") + set-thread-name!/linux + (const #f))) + +(define thread-name + (if (string-contains %host-type "linux") + thread-name/linux + (const ""))) + +(define %worker-thread-args + (make-parameter #f)) + +(define* (make-worker-thread-channel initializer + #:key (parallelism 1) + (delay-logger (lambda _ #f)) + (duration-logger (const #f)) + destructor + lifetime + (log-exception? (const #t)) + (expire-on-exception? #f) + (name "unnamed")) + "Return a channel used to offload work to a dedicated thread. ARGS are the +arguments of the worker thread procedure." + (define thread-proc-vector + (make-vector parallelism #f)) + + (define (initializer/safe) + (let ((args + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running initializer in worker thread (~A): ~A:\n ~A\n" + name + initializer + exn) + #f) + (lambda () + (with-throw-handler #t + initializer + (lambda args + (backtrace)))) + #:unwind? #t))) + + (if args + args + ;; never give up, just keep retrying + (begin + (sleep 1) + (initializer/safe))))) + + (define (destructor/safe args) + (let ((success? + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running destructor in worker thread (~A): ~A:\n ~A\n" + name + destructor + exn) + #f) + (lambda () + (with-throw-handler #t + (lambda () + (apply destructor args) + #t) + (lambda _ + (backtrace)))) + #:unwind? #t))) + + (or success? + #t + (begin + (sleep 1) + (destructor/safe args))))) + + (define (process thread-index channel args) + (let loop ((current-lifetime lifetime)) + (let ((exception? + (match (get-message channel) + (((? channel? reply) sent-time (? procedure? proc)) + (let ((time-delay + (- (get-internal-real-time) + sent-time))) + (delay-logger (/ time-delay + internal-time-units-per-second)) + + (let* ((start-time (get-internal-real-time)) + (response + (with-exception-handler + (lambda (exn) + (list 'worker-thread-error + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second) + exn)) + (lambda () + (vector-set! thread-proc-vector + thread-index + proc) + (with-throw-handler #t + (lambda () + (call-with-values + (lambda () + (start-stack + 'worker-thread + (apply proc args))) + (lambda vals + (cons (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second) + vals)))) + (lambda args + (when (match args + (('%exception exn) + (log-exception? exn)) + (_ #t)) + (simple-format + (current-error-port) + "worker-thread: exception: ~A\n" args) + (backtrace))))) + #:unwind? #t))) + (put-message reply + response) + + (vector-set! thread-proc-vector + thread-index + #f) + + (match response + (('worker-thread-error duration _) + (when duration-logger + (duration-logger duration proc)) + #t) + ((duration . _) + (when duration-logger + (duration-logger duration proc)) + #f)))))))) + (unless (and expire-on-exception? + exception?) + (if (number? current-lifetime) + (unless (< current-lifetime 0) + (loop (if current-lifetime + (- current-lifetime 1) + #f))) + (loop #f)))))) + + (let ((channel (make-channel))) + (for-each + (lambda (thread-index) + (call-with-new-thread + (lambda () + (catch 'system-error + (lambda () + (set-thread-name + (string-append + name " w t " + (number->string thread-index)))) + (const #t)) + + (let init ((args (initializer/safe))) + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "worker-thread-channel: exception: ~A\n" exn)) + (lambda () + (parameterize ((%worker-thread-args args)) + (process thread-index channel args))) + #:unwind? #t) + + (when destructor + (destructor/safe args)) + + (init (initializer/safe)))))) + (iota parallelism)) + + (values channel + thread-proc-vector))) + +(define &worker-thread-timeout + (make-exception-type '&worker-thread-timeout + &error + '())) + +(define make-worker-thread-timeout-error + (record-constructor &worker-thread-timeout)) + +(define worker-thread-timeout-error? + (record-predicate &worker-thread-timeout)) + +(define %worker-thread-default-timeout + (make-parameter 30)) + +(define* (call-with-worker-thread channel proc #:key duration-logger + (timeout (%worker-thread-default-timeout))) + "Send PROC to the worker thread through CHANNEL. Return the result of PROC. +If already in the worker thread, call PROC immediately." + (let ((args (%worker-thread-args))) + (if args + (apply proc args) + (let* ((reply (make-channel)) + (operation-success? + (perform-operation + (let ((put + (wrap-operation + (put-operation channel + (list reply + (get-internal-real-time) + proc)) + (const #t)))) + + (if timeout + (choice-operation + put + (wrap-operation (sleep-operation timeout) + (const #f))) + put))))) + + (unless operation-success? + (raise-exception + (make-worker-thread-timeout-error))) + + (match (get-message reply) + (('worker-thread-error duration exn) + (when duration-logger + (duration-logger duration)) + (raise-exception exn)) + ((duration . result) + (when duration-logger + (duration-logger duration)) + (apply values result))))))) + +(define* (create-work-queue thread-count-parameter proc + #:key thread-start-delay + (thread-stop-delay + (make-time time-duration 0 0)) + (name "unnamed") + priority= running-jobs-count + desired-thread-count))) + + (define (thread-idle-for-too-long? last-job-finished-at) + (time>=? + (time-difference (current-time time-monotonic) + last-job-finished-at) + thread-stop-delay)) + + (define (stop-thread) + (hash-remove! running-job-args + thread-index) + (unlock-mutex queue-mutex)) + + (call-with-new-thread + (lambda () + (catch 'system-error + (lambda () + (set-thread-name + (string-append name " q t " + (number->string thread-index)))) + (const #t)) + + (let loop ((last-job-finished-at (current-time time-monotonic))) + (lock-mutex queue-mutex) + + (if (too-many-threads?) + (stop-thread) + (let ((job-args + (if (q-empty? queue) + ;; #f from wait-condition-variable indicates a timeout + (if (wait-condition-variable + job-available + queue-mutex + (+ 9 (time-second (current-time)))) + ;; Another thread could have taken + ;; the job in the mean time + (if (q-empty? queue) + #f + (if priority threads-to-start 0) + (for-each + (lambda (thread-index) + (when (eq? (hash-ref running-job-args + thread-index + 'slot-free) + 'slot-free) + (let* ((now (current-time time-monotonic)) + (elapsed (time-difference now + previous-thread-started-at))) + (when (or (eq? #f thread-start-delay) + (time>=? elapsed thread-start-delay)) + (set! previous-thread-started-at now) + (hash-set! running-job-args + thread-index + #f) + (start-thread thread-index))))) + (iota desired-count))))))) + + (if (procedure? thread-count-parameter) + (call-with-new-thread + (lambda () + (catch 'system-error + (lambda () + (set-thread-name + (string-append name " q t"))) + (const #t)) + + (while #t + (sleep 15) + (with-mutex queue-mutex + (let ((idle-threads (hash-count (lambda (index val) + (eq? #f val)) + running-job-args))) + (when (= 0 idle-threads) + (start-new-threads-if-necessary (get-thread-count)))))))) + (start-new-threads-if-necessary (get-thread-count))) + + (values process-job count-jobs count-threads list-jobs))) diff --git a/pre-inst-env.in b/pre-inst-env.in new file mode 100644 index 0000000..ebf1a05 --- /dev/null +++ b/pre-inst-env.in @@ -0,0 +1,13 @@ +#!/bin/sh + +abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd`" +abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd`" + +GUILE_LOAD_COMPILED_PATH="$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH" +GUILE_LOAD_PATH="$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH" +export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH + +PATH="$abs_top_builddir:$PATH" +export PATH + +exec "$@" diff --git a/tests.scm b/tests.scm new file mode 100644 index 0000000..6c07374 --- /dev/null +++ b/tests.scm @@ -0,0 +1,28 @@ +(define-module (tests) + #:use-module (ice-9 exceptions) + #:use-module (fibers) + #:export (run-fibers-for-tests + assert-no-heap-growth)) + +(define (run-fibers-for-tests thunk) + (let ((result + (run-fibers + (lambda () + (with-exception-handler + (lambda (exn) + exn) + (lambda () + (with-throw-handler #t + thunk + (lambda _ + (backtrace))) + #t) + #:unwind? #t)) + #:hz 0 + #:parallelism 1))) + (if (exception? result) + (raise-exception result) + result))) + +(define (assert-no-heap-growth thunk) + (thunk)) diff --git a/tests/non-blocking.scm b/tests/non-blocking.scm new file mode 100644 index 0000000..0f81f58 --- /dev/null +++ b/tests/non-blocking.scm @@ -0,0 +1,31 @@ +(use-modules (tests) + (fibers) + (unit-test) + (web uri) + (web client) + (web response) + (knots web-server) + (knots non-blocking)) + +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + (values '((content-type . (text/plain))) + "Hello, World!")) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + + (assert-equal + 200 + (response-code + (http-get + uri + #:port (nonblocking-open-socket-for-uri uri))))))) + +(display "non-blocking test finished successfully\n") diff --git a/tests/parallelism.scm b/tests/parallelism.scm new file mode 100644 index 0000000..8249d68 --- /dev/null +++ b/tests/parallelism.scm @@ -0,0 +1,15 @@ +(use-modules (tests) + (fibers) + (unit-test) + (knots parallelism)) + +(run-fibers-for-tests + (lambda () + (assert-equal + 1122 + (apply + (fibers-map + (lambda (i) + (* 2 i)) + (iota 34)))))) + +(display "parallelism test finished successfully\n") diff --git a/tests/promise.scm b/tests/promise.scm new file mode 100644 index 0000000..b7dec73 --- /dev/null +++ b/tests/promise.scm @@ -0,0 +1,20 @@ +(use-modules (tests) + (fibers) + (unit-test) + (knots parallelism) + (knots promise)) + +(run-fibers-for-tests + (lambda () + (let ((promises + (map (lambda (i) + (fibers-delay + (lambda () + (* i 2)))) + (iota 10)))) + + (assert-equal + 90 + (apply + (fibers-map fibers-force promises)))))) + +(display "promise test finished successfully\n") diff --git a/tests/queue.scm b/tests/queue.scm new file mode 100644 index 0000000..c80e5fd --- /dev/null +++ b/tests/queue.scm @@ -0,0 +1,22 @@ +(use-modules (tests) + (fibers) + (fibers channels) + (unit-test) + (knots queue)) + +(run-fibers-for-tests + (lambda () + (let* ((dest-channel + (make-channel)) + (queue-channel + (spawn-queueing-fiber dest-channel))) + + (put-message queue-channel 1) + (put-message queue-channel 2) + (put-message queue-channel 3) + + (assert-equal 1 (get-message dest-channel)) + (assert-equal 2 (get-message dest-channel)) + (assert-equal 3 (get-message dest-channel))))) + +(display "queue test finished successfully\n") diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm new file mode 100644 index 0000000..ebd4682 --- /dev/null +++ b/tests/resource-pool.scm @@ -0,0 +1,18 @@ +(use-modules (tests) + (fibers) + (unit-test) + (knots resource-pool)) + +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + (lambda () + 2) + 1))) + (assert-equal + (with-resource-from-pool resource-pool + res + res) + 2)))) + +(display "resource-pool test finished successfully\n") diff --git a/tests/timeout.scm b/tests/timeout.scm new file mode 100644 index 0000000..bab39d2 --- /dev/null +++ b/tests/timeout.scm @@ -0,0 +1,22 @@ +(use-modules (tests) + (fibers) + (unit-test) + (knots timeout)) + +(run-fibers-for-tests + (lambda () + (assert-equal + 1 + (with-fibers-timeout + (const 1) + #:timeout 10)) + + (assert-equal + 2 + (with-fibers-timeout + (lambda () + (sleep 10)) + #:timeout 0.1 + #:on-timeout (const 2))))) + +(display "timeout test finished successfully\n") diff --git a/tests/web-server.scm b/tests/web-server.scm new file mode 100644 index 0000000..5a76d0f --- /dev/null +++ b/tests/web-server.scm @@ -0,0 +1,30 @@ +(use-modules (tests) + (fibers) + (unit-test) + (web uri) + (web client) + (web response) + (knots web-server) + (knots non-blocking)) + +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + (values '((content-type . (text/plain))) + "Hello, World!")) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (assert-equal + 200 + (response-code + (http-get + uri + #:port (nonblocking-open-socket-for-uri uri))))))) + +(display "web-server test finished successfully\n") diff --git a/tests/worker-threads.scm b/tests/worker-threads.scm new file mode 100644 index 0000000..72a56dc --- /dev/null +++ b/tests/worker-threads.scm @@ -0,0 +1,32 @@ +(use-modules (tests) + (srfi srfi-71) + (fibers) + (unit-test) + (knots worker-threads)) + +(let ((worker-thread-channel + (make-worker-thread-channel + (const '()) + #:parallelism 2))) + + (run-fibers-for-tests + (lambda () + (assert-equal + (call-with-worker-thread + worker-thread-channel + (lambda () + 4)) + 4)))) + +(let ((process-job + count-jobs + count-threads + list-jobs + (create-work-queue + 2 + (lambda (i) + (* i 2))))) + + (process-job 3)) + +(display "worker-threads test finished successfully\n") From dc2fe732ea12e849d1ac51d2cfe34988ef55cf34 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 22 Dec 2024 12:24:49 +0000 Subject: [PATCH 002/112] Make the parallel operations more continuous Instead of batching the list items, change the batch size to a parallelism limit and run up to that many fibers. When the processing of one list item finishes, another will then start immediately after, rather than when the whole batch is finished. These changes also make the fibers-map and fibers-for-each operations work with vectors as well as lists. --- knots/parallelism.scm | 131 ++++++++++++++++++++++++------------------ tests/parallelism.scm | 31 ++++++++++ 2 files changed, 107 insertions(+), 55 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index b5b03d5..9331757 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -35,25 +35,6 @@ fibers-parallel fibers-let)) -;; Like split-at, but don't care about the order of the resulting lists, and -;; don't error if the list is shorter than i elements -(define (split-at* lst i) - (let lp ((l lst) (n i) (acc '())) - (if (or (<= n 0) (null? l)) - (values (reverse! acc) l) - (lp (cdr l) (- n 1) (cons (car l) acc))))) - -;; As this can be called with lists with tens of thousands of items in them, -;; batch the -(define (get-batch batch-size lists) - (let ((split-lists - (map (lambda (lst) - (let ((batch rest (split-at* lst batch-size))) - (cons batch rest))) - lists))) - (values (map car split-lists) - (map cdr split-lists)))) - (define (defer-to-parallel-fiber thunk) (let ((reply (make-channel))) (spawn-fiber @@ -85,46 +66,86 @@ (apply values result))) responses))) -(define (fibers-batch-map proc batch-size . lists) - (let loop ((lists lists) - (result '())) - (let ((batch - rest - (get-batch batch-size lists))) - (if (any null? batch) - result - (let ((response-channels - (apply map - (lambda args - (defer-to-parallel-fiber - (lambda () - (apply proc args)))) - batch))) - (loop rest - (append! result - (apply fetch-result-of-defered-thunks - response-channels)))))))) +(define (fibers-batch-map proc parallelism-limit . lists) + (define vecs (map (lambda (list-or-vec) + (if (vector? list-or-vec) + list-or-vec + (list->vector list-or-vec))) + lists)) + + (define vecs-length + (vector-length (first vecs))) + + (define result-vec + (make-vector vecs-length)) + + (let loop ((next-to-process-index 0) + (channel-indexes '())) + (if (and (eq? #f next-to-process-index) + (null? channel-indexes)) + (if (vector? (first lists)) + result-vec + (vector->list result-vec)) + + (if (or (= (length channel-indexes) + (min parallelism-limit vecs-length)) + (eq? #f next-to-process-index)) + (let ((new-index + new-channel-indexes + (perform-operation + (apply + choice-operation + (map + (lambda (index) + (wrap-operation + (get-operation + (vector-ref result-vec index)) + (lambda (result) + (match result + (('exception . exn) + (raise-exception exn)) + (_ + (vector-set! result-vec + index + (first result)) + + (values next-to-process-index + (lset-difference = + channel-indexes + (list index)))))))) + channel-indexes))))) + (loop new-index + new-channel-indexes)) + + (loop (if (= (+ 1 next-to-process-index) + vecs-length) + #f + (+ 1 next-to-process-index)) + (begin + (vector-set! + result-vec + next-to-process-index + (defer-to-parallel-fiber + (lambda () + (apply proc + (map (lambda (vec) + (vector-ref vec next-to-process-index)) + vecs))))) + (cons next-to-process-index + channel-indexes))))))) (define (fibers-map proc . lists) (apply fibers-batch-map proc 20 lists)) -(define (fibers-batch-for-each proc batch-size . lists) - (let loop ((lists lists)) - (let ((batch - rest - (get-batch batch-size lists))) - (if (any null? batch) - *unspecified* - (let ((response-channels - (apply map - (lambda args - (defer-to-parallel-fiber - (lambda () - (apply proc args)))) - batch))) - (apply fetch-result-of-defered-thunks - response-channels) - (loop rest)))))) +(define (fibers-batch-for-each proc parallelism-limit . lists) + (apply fibers-batch-map + (lambda args + (apply proc args) + *unspecified*) + parallelism-limit + lists) + + *unspecified*) (define (fibers-for-each proc . lists) (apply fibers-batch-for-each proc 20 lists)) diff --git a/tests/parallelism.scm b/tests/parallelism.scm index 8249d68..0901b3c 100644 --- a/tests/parallelism.scm +++ b/tests/parallelism.scm @@ -3,6 +3,7 @@ (unit-test) (knots parallelism)) +;; Test fibers-map (run-fibers-for-tests (lambda () (assert-equal @@ -12,4 +13,34 @@ (* 2 i)) (iota 34)))))) +;; Test fibers-batch-map with a large batch size +(run-fibers-for-tests + (lambda () + (assert-equal + 1122 + (apply + (fibers-batch-map + (lambda (i) + (* 2 i)) + 100 + (iota 34)))))) + +;; Test fibers-map with vectors +(run-fibers-for-tests + (lambda () + (assert-equal + 1122 + (apply + (vector->list + (fibers-map + (lambda (i) + (* 2 i)) + (list->vector (iota 34)))))))) + +;; Test fibers-for-each +(run-fibers-for-tests + (lambda () + (fibers-for-each + (lambda (i) + (* 2 i)) + (iota 34)))) + (display "parallelism test finished successfully\n") From e8ab6f23d8611c6ebb308007306a9ec5752cfbf0 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 25 Dec 2024 20:35:40 +0000 Subject: [PATCH 003/112] Add call-with-sigint --- knots.scm | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/knots.scm b/knots.scm index d545770..4d1765b 100644 --- a/knots.scm +++ b/knots.scm @@ -1,8 +1,11 @@ (define-module (knots) #:use-module (ice-9 suspendable-ports) + #:use-module (fibers conditions) #:export (call-with-default-io-waiters - wait-when-system-clock-behind)) + wait-when-system-clock-behind + + call-with-sigint)) (define (call-with-default-io-waiters thunk) (parameterize @@ -19,3 +22,18 @@ (simple-format (current-error-port) "warning: system clock potentially behind, waiting\n") (sleep 20)))) + +;; Copied from (fibers web server) +(define (call-with-sigint thunk cvar) + (let ((handler #f)) + (dynamic-wind + (lambda () + (set! handler + (sigaction SIGINT (lambda (sig) (signal-condition! cvar))))) + thunk + (lambda () + (if handler + ;; restore Scheme handler, SIG_IGN or SIG_DFL. + (sigaction SIGINT (car handler) (cdr handler)) + ;; restore original C handler. + (sigaction SIGINT #f)))))) From 4e791aff6814e38da8b431b8ddb8444a32e34fe6 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 27 Dec 2024 22:14:51 +0000 Subject: [PATCH 004/112] Fix a bug in fibers-batch-map (and related procedures) And add more tests. --- knots/parallelism.scm | 5 ++++- tests/parallelism.scm | 17 +++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 9331757..8f3ec39 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -79,7 +79,10 @@ (define result-vec (make-vector vecs-length)) - (let loop ((next-to-process-index 0) + (let loop ((next-to-process-index + (if (= 0 vecs-length) + #f + 0)) (channel-indexes '())) (if (and (eq? #f next-to-process-index) (null? channel-indexes)) diff --git a/tests/parallelism.scm b/tests/parallelism.scm index 0901b3c..7d8dea7 100644 --- a/tests/parallelism.scm +++ b/tests/parallelism.scm @@ -24,6 +24,16 @@ 100 (iota 34)))))) +;; Test fibers-map with an empty list +(run-fibers-for-tests + (lambda () + (fibers-map identity '()))) + +;; Test fibers-map with an empty vector +(run-fibers-for-tests + (lambda () + (fibers-map identity #()))) + ;; Test fibers-map with vectors (run-fibers-for-tests (lambda () @@ -43,4 +53,11 @@ (* 2 i)) (iota 34)))) +;; Test fibers-map-with-progress with an empty list +(run-fibers-for-tests + (lambda () + (fibers-map-with-progress + identity + '(())))) + (display "parallelism test finished successfully\n") From 4e564b48146136474539fd5c598283154751caf8 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 28 Dec 2024 08:47:03 +0000 Subject: [PATCH 005/112] Allow nesting worker thread calls Incorporating changes from the nar-herder. --- knots/worker-threads.scm | 53 ++++++++++++++++++++++++++-------------- tests/worker-threads.scm | 6 ++--- 2 files changed, 38 insertions(+), 21 deletions(-) diff --git a/knots/worker-threads.scm b/knots/worker-threads.scm index f4116e9..cc1b571 100644 --- a/knots/worker-threads.scm +++ b/knots/worker-threads.scm @@ -19,6 +19,7 @@ (define-module (knots worker-threads) #:use-module (srfi srfi-1) + #:use-module (srfi srfi-9) #:use-module (srfi srfi-19) #:use-module (srfi srfi-71) #:use-module (system foreign) @@ -34,7 +35,12 @@ #:export (set-thread-name thread-name - make-worker-thread-channel + worker-thread-set? + worker-thread-set-channel + worker-thread-set-arguments-parameter + worker-thread-set-thread-proc-vector + + make-worker-thread-set call-with-worker-thread &worker-thread-timeout @@ -139,20 +145,29 @@ from there, or #f if that would be an empty string." thread-name/linux (const ""))) -(define %worker-thread-args - (make-parameter #f)) +(define-record-type + (worker-thread-set channel + arguments-parameter + thread-proc-vector) + worker-thread-set? + (channel worker-thread-set-channel) + (arguments-parameter worker-thread-set-arguments-parameter) + (thread-proc-vector worker-thread-set-thread-proc-vector)) -(define* (make-worker-thread-channel initializer - #:key (parallelism 1) - (delay-logger (lambda _ #f)) - (duration-logger (const #f)) - destructor - lifetime - (log-exception? (const #t)) - (expire-on-exception? #f) - (name "unnamed")) +(define* (make-worker-thread-set initializer + #:key (parallelism 1) + (delay-logger (lambda _ #f)) + (duration-logger (const #f)) + destructor + lifetime + (log-exception? (const #t)) + (expire-on-exception? #f) + (name "unnamed")) "Return a channel used to offload work to a dedicated thread. ARGS are the arguments of the worker thread procedure." + (define param + (make-parameter #f)) + (define thread-proc-vector (make-vector parallelism #f)) @@ -298,7 +313,7 @@ arguments of the worker thread procedure." (current-error-port) "worker-thread-channel: exception: ~A\n" exn)) (lambda () - (parameterize ((%worker-thread-args args)) + (parameterize ((param args)) (process thread-index channel args))) #:unwind? #t) @@ -308,8 +323,9 @@ arguments of the worker thread procedure." (init (initializer/safe)))))) (iota parallelism)) - (values channel - thread-proc-vector))) + (worker-thread-set channel + param + thread-proc-vector))) (define &worker-thread-timeout (make-exception-type '&worker-thread-timeout @@ -325,11 +341,12 @@ arguments of the worker thread procedure." (define %worker-thread-default-timeout (make-parameter 30)) -(define* (call-with-worker-thread channel proc #:key duration-logger - (timeout (%worker-thread-default-timeout))) +(define* (call-with-worker-thread record proc #:key duration-logger + (timeout (%worker-thread-default-timeout)) + (channel (worker-thread-set-channel record))) "Send PROC to the worker thread through CHANNEL. Return the result of PROC. If already in the worker thread, call PROC immediately." - (let ((args (%worker-thread-args))) + (let ((args ((worker-thread-set-arguments-parameter record)))) (if args (apply proc args) (let* ((reply (make-channel)) diff --git a/tests/worker-threads.scm b/tests/worker-threads.scm index 72a56dc..cfdfbf8 100644 --- a/tests/worker-threads.scm +++ b/tests/worker-threads.scm @@ -4,8 +4,8 @@ (unit-test) (knots worker-threads)) -(let ((worker-thread-channel - (make-worker-thread-channel +(let ((worker-thread-set + (make-worker-thread-set (const '()) #:parallelism 2))) @@ -13,7 +13,7 @@ (lambda () (assert-equal (call-with-worker-thread - worker-thread-channel + worker-thread-set (lambda () 4)) 4)))) From 7e55db0de7ae09f1ac4e437baa1bf78e92a6f4a7 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 28 Dec 2024 10:43:00 +0000 Subject: [PATCH 006/112] Consistently use non-blocking --- knots/non-blocking.scm | 6 +++--- tests/non-blocking.scm | 2 +- tests/web-server.scm | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/knots/non-blocking.scm b/knots/non-blocking.scm index 5914143..f29713a 100644 --- a/knots/non-blocking.scm +++ b/knots/non-blocking.scm @@ -21,7 +21,7 @@ #:use-module (web uri) #:use-module (web client) #:export (non-blocking-port - nonblocking-open-socket-for-uri)) + non-blocking-open-socket-for-uri)) (define (non-blocking-port port) "Make PORT non-blocking and return it." @@ -30,8 +30,8 @@ (fcntl port F_SETFL (logior O_NONBLOCK flags))) port)) -(define* (nonblocking-open-socket-for-uri uri - #:key (verify-certificate? #t)) +(define* (non-blocking-open-socket-for-uri uri + #:key (verify-certificate? #t)) (define tls-wrap (@@ (web client) tls-wrap)) diff --git a/tests/non-blocking.scm b/tests/non-blocking.scm index 0f81f58..25efee8 100644 --- a/tests/non-blocking.scm +++ b/tests/non-blocking.scm @@ -26,6 +26,6 @@ (response-code (http-get uri - #:port (nonblocking-open-socket-for-uri uri))))))) + #:port (non-blocking-open-socket-for-uri uri))))))) (display "non-blocking test finished successfully\n") diff --git a/tests/web-server.scm b/tests/web-server.scm index 5a76d0f..0254795 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -25,6 +25,6 @@ (response-code (http-get uri - #:port (nonblocking-open-socket-for-uri uri))))))) + #:port (non-blocking-open-socket-for-uri uri))))))) (display "web-server test finished successfully\n") From 6119ece5cba6cbdc638ccfb19aba52ea246dfe50 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 29 Dec 2024 10:45:41 +0000 Subject: [PATCH 007/112] Enable the Makefile to run tests --- .gitignore | 1 + Makefile.am | 16 ++++++++++++++++ configure.ac | 1 + test-env.in | 15 +++++++++++++++ 4 files changed, 33 insertions(+) create mode 100644 test-env.in diff --git a/.gitignore b/.gitignore index 10520ac..f20754d 100644 --- a/.gitignore +++ b/.gitignore @@ -15,5 +15,6 @@ tests/*.log tests/*.trs pre-inst-env +test-env .local.envrc diff --git a/Makefile.am b/Makefile.am index 5643873..77fa98b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -11,7 +11,23 @@ SOURCES = \ knots/web-server.scm \ knots/worker-threads.scm +SCM_TESTS = \ + tests/non-blocking.scm \ + tests/promise.scm \ + tests/timeout.scm \ + tests/non-blocking.scm \ + tests/queue.scm \ + tests/web-server.scm \ + tests/parallelism.scm \ + tests/resource-pool.scm \ + tests/worker-threads.scm + +TESTS_GOBJECTS = $(SCM_TESTS:%.scm=%.go) + EXTRA_DIST = \ README \ bootstrap \ pre-inst-env.in + +check: $(GOBJECTS) $(TESTS_GOBJECTS) + find tests -name "*.scm" | xargs -t -L1 ./test-env guile diff --git a/configure.ac b/configure.ac index fe1cb2f..e69f479 100644 --- a/configure.ac +++ b/configure.ac @@ -15,5 +15,6 @@ fi AC_CONFIG_FILES([Makefile]) AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env]) +AC_CONFIG_FILES([test-env], [chmod +x test-env]) AC_OUTPUT diff --git a/test-env.in b/test-env.in new file mode 100644 index 0000000..2633beb --- /dev/null +++ b/test-env.in @@ -0,0 +1,15 @@ +#!/bin/sh + +abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd`" +abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd`" + +GUILE_LOAD_COMPILED_PATH="${abs_top_builddir}/tests${GUILE_LOAD_COMPILED_PATH:+:}$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH" +GUILE_LOAD_PATH="$abs_top_builddir/tests:$abs_top_srcdir${GUILE_LOAD_PATH:+:}$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH" +export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH + +export GUILE_AUTO_COMPILE=0 + +PATH="$abs_top_builddir:$PATH" +export PATH + +exec "$@" From 97a3116b810fbd848b4a1dc46ab0d0d68f4326dc Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 6 Jan 2025 19:04:06 +0000 Subject: [PATCH 008/112] Support getting the pool from the timeout error --- knots/resource-pool.scm | 16 +++++++++++----- tests/resource-pool.scm | 8 ++++++++ 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 67e9292..9865ba7 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -36,6 +36,7 @@ resource-pool-retry-checkout-timeout &resource-pool-timeout + resource-pool-timeout-error-pool resource-pool-timeout-error? resource-pool-default-timeout-handler @@ -349,7 +350,12 @@ (define &resource-pool-timeout (make-exception-type '&recource-pool-timeout &error - '(name))) + '(pool))) + +(define resource-pool-timeout-error-pool + (exception-accessor + &resource-pool-timeout + (record-accessor &resource-pool-timeout 'pool))) (define make-resource-pool-timeout-error (record-constructor &resource-pool-timeout)) @@ -427,7 +433,7 @@ available. Return the resource once PROC has returned." (timeout-handler pool proc timeout)) (raise-exception - (make-resource-pool-timeout-error (resource-pool-name pool)))) + (make-resource-pool-timeout-error pool))) (with-exception-handler (lambda (exception) @@ -465,7 +471,7 @@ available. Return the resource once PROC has returned." (wrap-operation (sleep-operation timeout) (lambda _ (raise-exception - (make-resource-pool-timeout-error)))))) + (make-resource-pool-timeout-error pool)))))) (let ((time-remaining (- timeout @@ -479,7 +485,7 @@ available. Return the resource once PROC has returned." (wrap-operation (sleep-operation time-remaining) (lambda _ (raise-exception - (make-resource-pool-timeout-error)))))) + (make-resource-pool-timeout-error pool)))))) (raise-exception - (make-resource-pool-timeout-error)))))) + (make-resource-pool-timeout-error pool)))))) diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index ebd4682..b6db98f 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -15,4 +15,12 @@ res) 2)))) +(let* ((error-constructor + (record-constructor &resource-pool-timeout)) + (err + (error-constructor 'foo))) + (assert-equal + (resource-pool-timeout-error-pool err) + 'foo)) + (display "resource-pool test finished successfully\n") From 0771a41fe0359445d12cb34bc4b240bf16a85f0e Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 6 Jan 2025 19:22:50 +0000 Subject: [PATCH 009/112] Print resource pools without the channel Since the channel printer prints quite a lot of text. --- knots/resource-pool.scm | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 9865ba7..f0b56f6 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -20,6 +20,7 @@ (define-module (knots resource-pool) #:use-module (srfi srfi-1) #:use-module (srfi srfi-9) + #:use-module (srfi srfi-9 gnu) #:use-module (ice-9 match) #:use-module (ice-9 exceptions) #:use-module (fibers) @@ -52,6 +53,14 @@ (name resource-pool-name) (channel resource-pool-channel)) +(set-record-type-printer! + + (lambda (resource-pool port) + (display + (simple-format #f "#" + (resource-pool-name resource-pool)) + port))) + (define* (make-resource-pool initializer max-size #:key (min-size max-size) (idle-seconds #f) From 66e0c52bf42a3f32cfeb253cfeed01c3c3235d11 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 8 Jan 2025 12:23:08 +0000 Subject: [PATCH 010/112] Export resource-pool-name --- knots/resource-pool.scm | 1 + 1 file changed, 1 insertion(+) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index f0b56f6..23bc9eb 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -31,6 +31,7 @@ #:export (resource-pool? make-resource-pool + resource-pool-name destroy-resource-pool resource-pool-default-timeout From 409fa1df5c884389f863a6194b64ffafda476a60 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 8 Jan 2025 12:23:18 +0000 Subject: [PATCH 011/112] Allow customising the resource-pool put-message timeout --- knots/resource-pool.scm | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 23bc9eb..9b2dce4 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -71,8 +71,7 @@ lifetime scheduler (name "unnamed") - ;; Add options for customizing timeouts - ) + (put-message-timeout 0.5)) (define (initializer/safe) (with-exception-handler (lambda (exn) @@ -157,7 +156,8 @@ (wrap-operation (put-operation reply new-resource) (const #t)) - (wrap-operation (sleep-operation 1) + (wrap-operation (sleep-operation + put-message-timeout) (const #f)))))) (unless checkout-success? (set! checkout-failure-count @@ -180,7 +180,8 @@ (wrap-operation (put-operation reply (car available)) (const #t)) - (wrap-operation (sleep-operation 1) + (wrap-operation (sleep-operation + put-message-timeout) (const #f)))))) (unless checkout-success? (set! checkout-failure-count @@ -215,7 +216,8 @@ (put-operation (last waiters) resource) (const #t)) - (wrap-operation (sleep-operation 1) + (wrap-operation (sleep-operation + put-message-timeout) (const #f)))))) (unless checkout-success? (set! checkout-failure-count @@ -269,7 +271,8 @@ (wrap-operation (put-operation reply stats) (const #t)) - (wrap-operation (sleep-operation 1) + (wrap-operation (sleep-operation + put-message-timeout) (const #f))))))) (loop resources From 59c183b13fc10e0d3c0b682d1db7eec4ae24659f Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 8 Jan 2025 15:57:15 +0000 Subject: [PATCH 012/112] Add fiberize Not sure about the name yet, but this is useful. --- knots/parallelism.scm | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 8f3ec39..c829254 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -33,7 +33,9 @@ fibers-for-each fibers-parallel - fibers-let)) + fibers-let + + fiberize)) (define (defer-to-parallel-fiber thunk) (let ((reply (make-channel))) @@ -219,3 +221,40 @@ channels-to-results))) #f)))) channels-to-results)))))))) + +(define* (fiberize proc #:key (parallelism 1) + (show-backtrace? (const #t))) + (let ((channel (make-channel))) + (for-each + (lambda _ + (spawn-fiber + (lambda () + (while #t + (let ((reply-channel args (car+cdr + (get-message channel)))) + (put-message + reply-channel + (with-exception-handler + (lambda (exn) + (cons 'exception exn)) + (lambda () + (with-throw-handler #t + (lambda () + (call-with-values + (lambda () + (apply proc args)) + (lambda vals + (cons 'result vals)))) + (lambda args + (when (apply show-backtrace? args) + (backtrace))))) + #:unwind? #t))))) + #:parallel? #t)) + (iota parallelism)) + + (lambda args + (let ((reply-channel (make-channel))) + (put-message channel (cons reply-channel args)) + (match (get-message reply-channel) + (('result . vals) (apply values vals)) + (('exception . exn) (raise-exception exn))))))) From dcb56ee2c5ac3e283cb46841766e7282f3c2c52e Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 8 Jan 2025 15:57:30 +0000 Subject: [PATCH 013/112] Tweak the resource pool Mostly to no longer sleep in the main fiber. Now the main fiber just spawns other fibers when it would previously block on put-operation and these other fibers communicate back to the main resource pool fiber when necessary. This should mean that the resource pool is more responsive. --- knots/resource-pool.scm | 585 ++++++++++++++++++++++------------------ tests/resource-pool.scm | 13 + 2 files changed, 340 insertions(+), 258 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 9b2dce4..355cfa9 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -28,10 +28,13 @@ #:use-module (fibers channels) #:use-module (fibers scheduler) #:use-module (fibers operations) + #:use-module (knots parallelism) #:export (resource-pool? make-resource-pool resource-pool-name + resource-pool-channel + resource-pool-configuration destroy-resource-pool resource-pool-default-timeout @@ -48,11 +51,23 @@ resource-pool-stats)) +(define &resource-pool-abort-add-resource + (make-exception-type '&recource-pool-abort-add-resource + &error + '())) + +(define make-resource-pool-abort-add-resource-error + (record-constructor &resource-pool-abort-add-resource)) + +(define resource-pool-abort-add-resource-error? + (record-predicate &resource-pool-abort-add-resource)) + (define-record-type - (make-resource-pool-record name channel) + (make-resource-pool-record name channel configuration) resource-pool? - (name resource-pool-name) - (channel resource-pool-channel)) + (name resource-pool-name) + (channel resource-pool-channel) + (configuration resource-pool-configuration)) (set-record-type-printer! @@ -62,7 +77,7 @@ (resource-pool-name resource-pool)) port))) -(define* (make-resource-pool initializer max-size +(define* (make-resource-pool return-new-resource max-size #:key (min-size max-size) (idle-seconds #f) (delay-logger (const #f)) @@ -71,280 +86,334 @@ lifetime scheduler (name "unnamed") - (put-message-timeout 0.5)) - (define (initializer/safe) - (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception running ~A resource pool initializer: ~A:\n ~A\n" - name - initializer - exn) - #f) + (reply-timeout 0.5) + add-resources-parallelism) + (define channel (make-channel)) + + (define pool + (make-resource-pool-record + name + channel + `((max-size . ,max-size) + (min-size . ,min-size) + (idle-seconds . ,idle-seconds) + (delay-logger . ,delay-logger) + (duration-logger . ,duration-logger) + (destructor . ,destructor) + (lifetime . ,lifetime) + (scheduler . ,scheduler) + (name . ,name) + (reply-timeout . ,reply-timeout)))) + + (define checkout-failure-count 0) + + (define spawn-fiber-to-return-new-resource + (let ((thunk + (if add-resources-parallelism + (fiberize + (lambda () + (let ((max-size + (assq-ref (resource-pool-configuration pool) + 'max-size)) + (size (assq-ref (resource-pool-stats pool) + 'resources))) + (if (= size max-size) + (raise-exception + (make-resource-pool-abort-add-resource-error)) + (return-new-resource)))) + #:parallelism add-resources-parallelism + #:show-backtrace? + (lambda (key . args) + (not + (and (eq? key '%exception) + (resource-pool-abort-add-resource-error? + (car args)))))) + return-new-resource))) (lambda () - (with-throw-handler #t - initializer - (lambda args - (backtrace)))) - #:unwind? #t)) + (spawn-fiber + (lambda () + (let ((new-resource + (with-exception-handler + (lambda (exn) + (unless (resource-pool-abort-add-resource-error? exn) + (simple-format + (current-error-port) + "exception adding resource to pool ~A: ~A:\n ~A\n" + name + return-new-resource + exn)) + #f) + (lambda () + (with-throw-handler #t + thunk + (lambda (key . args) + (unless (and (eq? key '%exception) + (resource-pool-abort-add-resource-error? + (car args))) + (backtrace))))) + #:unwind? #t))) + (when new-resource + (put-message channel + (list 'add-resource new-resource))))))))) - (define (destructor/safe args) - (let ((success? - (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception running resource pool destructor (~A): ~A:\n ~A\n" - name - destructor - exn) - #f) - (lambda () - (with-throw-handler #t - (lambda () - (destructor args) - #t) - (lambda _ - (backtrace)))) - #:unwind? #t))) - - (or success? - #t - (begin - (sleep 5) - (destructor/safe args))))) - - (let ((channel (make-channel)) - (checkout-failure-count 0)) + (define (spawn-fiber-to-destroy-resource resource) (spawn-fiber (lambda () - (when idle-seconds - (spawn-fiber - (lambda () - (while #t - (sleep idle-seconds) - (put-message channel '(check-for-idle-resources)))))) + (let loop () + (let ((success? + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running resource pool destructor (~A): ~A:\n ~A\n" + name + destructor + exn) + #f) + (lambda () + (with-throw-handler #t + (lambda () + (destructor resource) + #t) + (lambda _ + (backtrace)))) + #:unwind? #t))) - (while #t - (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception in the ~A pool fiber: ~A\n" - name - exn)) - (lambda () - (let loop ((resources '()) - (available '()) - (waiters '()) - (resources-last-used '())) + (unless success? + (sleep 5) - (match (get-message channel) - (('checkout reply) - (if (null? available) - (if (= (length resources) max-size) - (loop resources - available - (cons reply waiters) - resources-last-used) - (let ((new-resource (initializer/safe))) - (if new-resource - (let ((checkout-success? - (perform-operation - (choice-operation - (wrap-operation - (put-operation reply new-resource) - (const #t)) - (wrap-operation (sleep-operation - put-message-timeout) - (const #f)))))) - (unless checkout-success? - (set! checkout-failure-count - (+ 1 checkout-failure-count))) + (loop))))))) - (loop (cons new-resource resources) - (if checkout-success? - available - (cons new-resource available)) - waiters - (cons (get-internal-real-time) - resources-last-used))) - (loop resources - available - (cons reply waiters) - resources-last-used)))) - (let ((checkout-success? - (perform-operation - (choice-operation - (wrap-operation - (put-operation reply (car available)) - (const #t)) - (wrap-operation (sleep-operation - put-message-timeout) - (const #f)))))) - (unless checkout-success? - (set! checkout-failure-count - (+ 1 checkout-failure-count))) + (define (spawn-fiber-for-checkout reply-channel resource) + (spawn-fiber + (lambda () + (let ((checkout-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply-channel resource) + (const #t)) + (wrap-operation (sleep-operation + reply-timeout) + (const #f)))))) + (unless checkout-success? + (put-message + channel + (list 'return-failed-checkout resource))))))) + + (spawn-fiber + (lambda () + (when idle-seconds + (spawn-fiber + (lambda () + (while #t + (sleep idle-seconds) + (put-message channel '(check-for-idle-resources)))))) + + (with-throw-handler #t + (lambda () + (let loop ((resources '()) + (available '()) + (waiters '()) + (resources-last-used '())) + + (match (get-message channel) + (('add-resource resource) + (if (= (length resources) max-size) + (begin + (spawn-fiber-to-destroy-resource resource) + + (loop resources + available + waiters + resources-last-used)) - (if checkout-success? - (loop resources - (cdr available) - waiters - resources-last-used) - (loop resources - available - waiters - resources-last-used))))) - (('return resource) (if (null? waiters) - (loop resources + (loop (cons resource resources) (cons resource available) waiters - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used)) - (let ((checkout-success? - (perform-operation - (choice-operation - (wrap-operation - (put-operation (last waiters) - resource) - (const #t)) - (wrap-operation (sleep-operation - put-message-timeout) - (const #f)))))) - (unless checkout-success? - (set! checkout-failure-count - (+ 1 checkout-failure-count))) + (cons (get-internal-real-time) + resources-last-used)) - (if checkout-success? - (loop resources - available - (drop-right! waiters 1) - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used)) - (begin - (for-each - (lambda (waiter) - (spawn-fiber - (lambda () - (perform-operation - (choice-operation - (put-operation waiter 'resource-pool-retry-checkout) - (sleep-operation 10)))))) - waiters) + (begin + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout (last waiters) + resource) + (put-message (last waiters) resource)) - (loop resources - (cons resource available) - '() - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used))))))) - (('stats reply) - (let ((stats - `((resources . ,(length resources)) - (available . ,(length available)) - (waiters . ,(length waiters)) - (checkout-failure-count . ,checkout-failure-count)))) + (loop (cons resource resources) + available + (drop-right! waiters 1) + (cons (get-internal-real-time) + resources-last-used)))))) + (('checkout reply) + (if (null? available) + (begin + (unless (= (length resources) max-size) + (spawn-fiber-to-return-new-resource)) + + (loop resources + available + (cons reply waiters) + resources-last-used)) + + (let ((resource (car available))) + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout reply resource) + (put-message reply resource)) + + (loop resources + (cdr available) + waiters + resources-last-used)))) + + (((and (or 'return + 'return-failed-checkout) + return-type) + resource) + + (when (eq? 'return-failed-checkout + return-type) + (set! checkout-failure-count + (+ 1 checkout-failure-count))) + + (if (null? waiters) + (loop resources + (cons resource available) + waiters + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used)) + + (begin + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout (last waiters) + resource) + (put-message (last waiters) resource)) + + (loop resources + available + (drop-right! waiters 1) + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used))))) + + (('stats reply) + (let ((stats + `((resources . ,(length resources)) + (available . ,(length available)) + (waiters . ,(length waiters)) + (checkout-failure-count . ,checkout-failure-count)))) + + (spawn-fiber + (lambda () + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply stats) + (const #t)) + (wrap-operation (sleep-operation + reply-timeout) + (const #f))))))) + + (loop resources + available + waiters + resources-last-used)) + + (('check-for-idle-resources) + (let* ((resources-last-used-seconds + (map + (lambda (internal-time) + (/ (- (get-internal-real-time) internal-time) + internal-time-units-per-second)) + resources-last-used)) + (resources-to-destroy + (filter-map + (lambda (resource last-used-seconds) + (if (and (member resource available) + (> last-used-seconds idle-seconds)) + resource + #f)) + resources + resources-last-used-seconds))) + + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + resources-to-destroy) + + (loop (lset-difference eq? resources resources-to-destroy) + (lset-difference eq? available resources-to-destroy) + waiters + (filter-map + (lambda (resource last-used) + (if (memq resource resources-to-destroy) + #f + last-used)) + resources + resources-last-used)))) + + (('destroy reply) + (if (= (length resources) (length available)) + (begin + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + resources) + (put-message reply 'destroy-success)) + (begin (spawn-fiber (lambda () (perform-operation (choice-operation - (wrap-operation - (put-operation reply stats) - (const #t)) - (wrap-operation (sleep-operation - put-message-timeout) - (const #f))))))) - - (loop resources - available - waiters - resources-last-used)) - (('check-for-idle-resources) - (let* ((resources-last-used-seconds - (map - (lambda (internal-time) - (/ (- (get-internal-real-time) internal-time) - internal-time-units-per-second)) - resources-last-used)) - (resources-to-destroy - (filter-map - (lambda (resource last-used-seconds) - (if (and (member resource available) - (> last-used-seconds idle-seconds)) - resource - #f)) - resources - resources-last-used-seconds))) - - (for-each - (lambda (resource) - (destructor/safe resource)) - resources-to-destroy) - - (loop (lset-difference eq? resources resources-to-destroy) - (lset-difference eq? available resources-to-destroy) + (put-operation reply 'resource-pool-destroy-failed) + (sleep-operation 10))))) + (loop resources + available waiters - (filter-map - (lambda (resource last-used) - (if (memq resource resources-to-destroy) - #f - last-used)) - resources - resources-last-used)))) - (('destroy reply) - (if (= (length resources) (length available)) - (begin - (for-each - (lambda (resource) - (destructor/safe resource)) - resources) - (put-message reply 'destroy-success)) - (begin - (spawn-fiber - (lambda () - (perform-operation - (choice-operation - (put-operation reply 'resource-pool-destroy-failed) - (sleep-operation 10))))) - (loop resources - available - waiters - resources-last-used)))) - (unknown - (simple-format - (current-error-port) - "unrecognised message to ~A resource pool channel: ~A\n" - name - unknown) - (loop resources - available - waiters - resources-last-used))))) - #:unwind? #t))) - (or scheduler - (current-scheduler))) + resources-last-used)))) - (make-resource-pool-record name channel))) + (unknown + (simple-format + (current-error-port) + "unrecognised message to ~A resource pool channel: ~A\n" + name + unknown) + (loop resources + available + waiters + resources-last-used))))) + (lambda (key . args) + (simple-format (current-error-port) + "exception in the ~A pool fiber\n" name)))) + (or scheduler + (current-scheduler))) + + pool) (define (destroy-resource-pool pool) (let ((reply (make-channel))) diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index b6db98f..33f5a0c 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -15,6 +15,19 @@ res) 2)))) +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + (lambda () + 2) + 1 + #:add-resources-parallelism 1))) + (assert-equal + (with-resource-from-pool resource-pool + res + res) + 2)))) + (let* ((error-constructor (record-constructor &resource-pool-timeout)) (err From d572f591a3c136bfc7b23160e16381c92588f8d9 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 13 Jan 2025 12:22:27 +0000 Subject: [PATCH 014/112] Rename worker threads to thread pool I think this needs more work, maybe the thread pool should be more similar to the resource pool, but I think the name change is still helpful. Maybe there's a need for a variable size thread pool and that can better integrate with the work queue. --- Makefile.am | 4 +- knots/{worker-threads.scm => thread-pool.scm} | 128 +++++++++--------- tests/thread-pool.scm | 44 ++++++ tests/worker-threads.scm | 32 ----- 4 files changed, 111 insertions(+), 97 deletions(-) rename knots/{worker-threads.scm => thread-pool.scm} (86%) create mode 100644 tests/thread-pool.scm delete mode 100644 tests/worker-threads.scm diff --git a/Makefile.am b/Makefile.am index 77fa98b..21851ae 100644 --- a/Makefile.am +++ b/Makefile.am @@ -9,7 +9,7 @@ SOURCES = \ knots/resource-pool.scm \ knots/timeout.scm \ knots/web-server.scm \ - knots/worker-threads.scm + knots/thread-pool.scm SCM_TESTS = \ tests/non-blocking.scm \ @@ -20,7 +20,7 @@ SCM_TESTS = \ tests/web-server.scm \ tests/parallelism.scm \ tests/resource-pool.scm \ - tests/worker-threads.scm + tests/thread-pool.scm TESTS_GOBJECTS = $(SCM_TESTS:%.scm=%.go) diff --git a/knots/worker-threads.scm b/knots/thread-pool.scm similarity index 86% rename from knots/worker-threads.scm rename to knots/thread-pool.scm index cc1b571..24260cd 100644 --- a/knots/worker-threads.scm +++ b/knots/thread-pool.scm @@ -17,7 +17,7 @@ ;;; along with the guix-data-service. If not, see ;;; . -(define-module (knots worker-threads) +(define-module (knots thread-pool) #:use-module (srfi srfi-1) #:use-module (srfi srfi-9) #:use-module (srfi srfi-19) @@ -35,18 +35,18 @@ #:export (set-thread-name thread-name - worker-thread-set? - worker-thread-set-channel - worker-thread-set-arguments-parameter - worker-thread-set-thread-proc-vector + thread-pool? + thread-pool-channel + thread-pool-arguments-parameter + thread-pool-proc-vector - make-worker-thread-set - call-with-worker-thread + make-thread-pool + call-with-thread - &worker-thread-timeout - worker-thread-timeout-error? + &thread-pool-timeout + thread-pool-timeout-error? - %worker-thread-default-timeout + %thread-pool-default-timeout create-work-queue)) @@ -145,31 +145,30 @@ from there, or #f if that would be an empty string." thread-name/linux (const ""))) -(define-record-type - (worker-thread-set channel - arguments-parameter - thread-proc-vector) - worker-thread-set? - (channel worker-thread-set-channel) - (arguments-parameter worker-thread-set-arguments-parameter) - (thread-proc-vector worker-thread-set-thread-proc-vector)) +(define-record-type + (thread-pool channel arguments-parameter proc-vector) + thread-pool? + (channel thread-pool-channel) + (arguments-parameter thread-pool-arguments-parameter) + (proc-vector thread-pool-proc-vector)) -(define* (make-worker-thread-set initializer - #:key (parallelism 1) - (delay-logger (lambda _ #f)) - (duration-logger (const #f)) - destructor - lifetime - (log-exception? (const #t)) - (expire-on-exception? #f) - (name "unnamed")) +(define* (make-thread-pool size + #:key + thread-initializer + thread-destructor + (delay-logger (lambda _ #f)) + (duration-logger (const #f)) + thread-lifetime + (log-exception? (const #t)) + (expire-on-exception? #f) + (name "unnamed")) "Return a channel used to offload work to a dedicated thread. ARGS are the -arguments of the worker thread procedure." +arguments of the thread pool procedure." (define param (make-parameter #f)) (define thread-proc-vector - (make-vector parallelism #f)) + (make-vector size #f)) (define (initializer/safe) (let ((args @@ -177,14 +176,14 @@ arguments of the worker thread procedure." (lambda (exn) (simple-format (current-error-port) - "exception running initializer in worker thread (~A): ~A:\n ~A\n" + "exception running initializer in thread pool (~A): ~A:\n ~A\n" name - initializer + thread-initializer exn) #f) (lambda () (with-throw-handler #t - initializer + thread-initializer (lambda args (backtrace)))) #:unwind? #t))) @@ -202,15 +201,15 @@ arguments of the worker thread procedure." (lambda (exn) (simple-format (current-error-port) - "exception running destructor in worker thread (~A): ~A:\n ~A\n" + "exception running destructor in thread pool (~A): ~A:\n ~A\n" name - destructor + thread-destructor exn) #f) (lambda () (with-throw-handler #t (lambda () - (apply destructor args) + (apply thread-destructor args) #t) (lambda _ (backtrace)))) @@ -223,7 +222,7 @@ arguments of the worker thread procedure." (destructor/safe args))))) (define (process thread-index channel args) - (let loop ((current-lifetime lifetime)) + (let loop ((current-lifetime thread-lifetime)) (let ((exception? (match (get-message channel) (((? channel? reply) sent-time (? procedure? proc)) @@ -231,13 +230,14 @@ arguments of the worker thread procedure." (- (get-internal-real-time) sent-time))) (delay-logger (/ time-delay - internal-time-units-per-second)) + internal-time-units-per-second) + proc) (let* ((start-time (get-internal-real-time)) (response (with-exception-handler (lambda (exn) - (list 'worker-thread-error + (list 'thread-pool-error (/ (- (get-internal-real-time) start-time) internal-time-units-per-second) @@ -251,7 +251,7 @@ arguments of the worker thread procedure." (call-with-values (lambda () (start-stack - 'worker-thread + 'thread-pool (apply proc args))) (lambda vals (cons (/ (- (get-internal-real-time) @@ -265,7 +265,7 @@ arguments of the worker thread procedure." (_ #t)) (simple-format (current-error-port) - "worker-thread: exception: ~A\n" args) + "thread-pool: exception: ~A\n" args) (backtrace))))) #:unwind? #t))) (put-message reply @@ -276,7 +276,7 @@ arguments of the worker thread procedure." #f) (match response - (('worker-thread-error duration _) + (('thread-pool-error duration _) (when duration-logger (duration-logger duration proc)) #t) @@ -306,47 +306,49 @@ arguments of the worker thread procedure." (number->string thread-index)))) (const #t)) - (let init ((args (initializer/safe))) + (let init ((args (if thread-initializer + (initializer/safe) + '()))) (with-exception-handler (lambda (exn) (simple-format (current-error-port) - "worker-thread-channel: exception: ~A\n" exn)) + "knots: thread-pool: internal exception: ~A\n" exn)) (lambda () (parameterize ((param args)) (process thread-index channel args))) #:unwind? #t) - (when destructor + (when thread-destructor (destructor/safe args)) (init (initializer/safe)))))) - (iota parallelism)) + (iota size)) - (worker-thread-set channel - param - thread-proc-vector))) + (thread-pool channel + param + thread-proc-vector))) -(define &worker-thread-timeout - (make-exception-type '&worker-thread-timeout +(define &thread-pool-timeout + (make-exception-type '&thread-pool-timeout &error '())) -(define make-worker-thread-timeout-error - (record-constructor &worker-thread-timeout)) +(define make-thread-pool-timeout-error + (record-constructor &thread-pool-timeout)) -(define worker-thread-timeout-error? - (record-predicate &worker-thread-timeout)) +(define thread-pool-timeout-error? + (record-predicate &thread-pool-timeout)) -(define %worker-thread-default-timeout +(define %thread-pool-default-timeout (make-parameter 30)) -(define* (call-with-worker-thread record proc #:key duration-logger - (timeout (%worker-thread-default-timeout)) - (channel (worker-thread-set-channel record))) - "Send PROC to the worker thread through CHANNEL. Return the result of PROC. -If already in the worker thread, call PROC immediately." - (let ((args ((worker-thread-set-arguments-parameter record)))) +(define* (call-with-thread record proc #:key duration-logger + (timeout (%thread-pool-default-timeout)) + (channel (thread-pool-channel record))) + "Send PROC to the thread pool through CHANNEL. Return the result of PROC. +If already in the thread pool, call PROC immediately." + (let ((args ((thread-pool-arguments-parameter record)))) (if args (apply proc args) (let* ((reply (make-channel)) @@ -369,10 +371,10 @@ If already in the worker thread, call PROC immediately." (unless operation-success? (raise-exception - (make-worker-thread-timeout-error))) + (make-thread-pool-timeout-error))) (match (get-message reply) - (('worker-thread-error duration exn) + (('thread-pool-error duration exn) (when duration-logger (duration-logger duration)) (raise-exception exn)) diff --git a/tests/thread-pool.scm b/tests/thread-pool.scm new file mode 100644 index 0000000..71b4494 --- /dev/null +++ b/tests/thread-pool.scm @@ -0,0 +1,44 @@ +(use-modules (tests) + (srfi srfi-71) + (fibers) + (unit-test) + (knots thread-pool)) + +(let ((thread-pool + (make-thread-pool 2))) + + (run-fibers-for-tests + (lambda () + (assert-equal + (call-with-thread + thread-pool + (lambda () + 4)) + 4)))) + +(let ((thread-pool + (make-thread-pool + 2 + #:thread-initializer (const '(2))))) + + (run-fibers-for-tests + (lambda () + (assert-equal + (call-with-thread + thread-pool + (lambda (num) + (* 2 num))) + 4)))) + +(let ((process-job + count-jobs + count-threads + list-jobs + (create-work-queue + 2 + (lambda (i) + (* i 2))))) + + (process-job 3)) + +(display "thread-pool test finished successfully\n") diff --git a/tests/worker-threads.scm b/tests/worker-threads.scm deleted file mode 100644 index cfdfbf8..0000000 --- a/tests/worker-threads.scm +++ /dev/null @@ -1,32 +0,0 @@ -(use-modules (tests) - (srfi srfi-71) - (fibers) - (unit-test) - (knots worker-threads)) - -(let ((worker-thread-set - (make-worker-thread-set - (const '()) - #:parallelism 2))) - - (run-fibers-for-tests - (lambda () - (assert-equal - (call-with-worker-thread - worker-thread-set - (lambda () - 4)) - 4)))) - -(let ((process-job - count-jobs - count-threads - list-jobs - (create-work-queue - 2 - (lambda (i) - (* i 2))))) - - (process-job 3)) - -(display "worker-threads test finished successfully\n") From 42d885c5539840ce63421771f8d4bb612d4446a5 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 23 Jan 2025 09:34:54 +0100 Subject: [PATCH 015/112] Try to better handle exceptions in the web server --- knots/web-server.scm | 161 +++++++++++++++++++++++++++++++++---------- tests/web-server.scm | 41 ++++++++++- 2 files changed, 166 insertions(+), 36 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index b94106f..58c1883 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -25,6 +25,7 @@ #:use-module (ice-9 textual-ports) #:use-module (ice-9 iconv) #:use-module (ice-9 match) + #:use-module (ice-9 exceptions) #:use-module ((srfi srfi-9 gnu) #:select (set-field)) #:use-module (system repl error-handling) #:use-module (web http) @@ -33,6 +34,8 @@ #:use-module (knots non-blocking) #:export (run-knots-web-server + default-write-response-exception-handler + web-server? web-server-socket web-server-port)) @@ -98,12 +101,20 @@ on the procedure being called at any particular time." (string->bytevector body charset)))) ((not (or (bytevector? body) (procedure? body))) - (error "unexpected body type")) + (raise-exception + (make-exception-with-irritants + (list (make-exception-with-message + "unexpected body type") + body)))) ((and (response-must-not-include-body? response) body ;; FIXME make this stricter: even an empty body should be prohibited. (not (zero? (bytevector-length body)))) - (error "response with this status code must not include body" response)) + (raise-exception + (make-exception-with-irritants + (list (make-exception-with-message + "response with this status code must not include body") + response)))) (else ;; check length; assert type; add other required fields? (values (if (procedure? body) @@ -120,10 +131,11 @@ on the procedure being called at any particular time." (error "bad content-length" rlen blen))) (else (extend-response response 'content-length blen))))) (if (eq? (request-method request) 'HEAD) - ;; Responses to HEAD requests must not include bodies. - ;; We could raise an error here, but it seems more - ;; appropriate to just do something sensible. - #f + (raise-exception + (make-exception-with-irritants + (list (make-exception-with-message + "unexpected body type") + body))) body))))) (define (with-stack-and-prompt thunk) @@ -143,7 +155,16 @@ on the procedure being called at any particular time." ((0) (memq 'keep-alive (response-connection response))))) (else #f))))) -(define (handle-request handler client) +(define (default-write-response-exception-handler exn) + (simple-format + (current-error-port) + "knots web server: exception replying to client: ~A\n" exn) + + ;; Close the client port + #f) + +(define (handle-request handler client + write-response-exception-handler) (let ((request (catch #t (lambda () @@ -161,33 +182,99 @@ on the procedure being called at any particular time." #:headers '((content-length . 0))) #vu8())) (else - (call-with-error-handling - (lambda () - (call-with-values (lambda () - (with-stack-and-prompt - (lambda () - (handler request)))) - (lambda (response body) - (sanitize-response request response body)))) - #:on-error 'backtrace - #:post-error (lambda _ - (values (build-response #:code 500) #f))))))) - (write-response response client) - (when body - (if (procedure? body) - (if (response-content-length response) - (body client) - (let ((chunked-port - (make-chunked-output-port client - #:keep-alive? #t))) - (body chunked-port) - (close-port chunked-port))) - (put-bytevector client body))) - (force-output client) + (with-exception-handler + (lambda (exn) + (values (build-response #:code 500) + ;; TODO Make this configurable + (string->utf8 + "internal server error"))) + (lambda () + (call-with-values (lambda () + (with-stack-and-prompt + (lambda () + (with-throw-handler #t + (lambda () + (handler request)) + (lambda (key . args) + (let ((stack (make-stack #t))) + (print-exception + (current-error-port) + (stack-ref stack 2) + key + args) + (display-backtrace + stack + (current-error-port) + 2))))))) + (lambda (response body) + (sanitize-response request response body)))) + #:unwind? #t))))) + (with-exception-handler + write-response-exception-handler + (lambda () + (write-response response client) - (keep-alive? response)))) + (let ((body-written? + (if (procedure? body) + (if (response-content-length response) + (with-exception-handler + (lambda (exn) + #f) + (lambda () + (with-stack-and-prompt + (lambda () + (with-throw-handler #t + (lambda () + (body client)) + (lambda (key . args) + (let ((stack (make-stack #t))) + (print-exception + (current-error-port) + (stack-ref stack 2) + key + args) + (display-backtrace + stack + (current-error-port) + 2)))))) + #t) + #:unwind? #t) + (let ((chunked-port + (make-chunked-output-port client + #:keep-alive? #t))) + (with-exception-handler + (lambda (exn) + #f) + (lambda () + (with-throw-handler #t + (lambda () + (body chunked-port) + (close-port chunked-port)) + (lambda (key . args) + (let ((stack (make-stack #t))) + (print-exception + (current-error-port) + (stack-ref stack 2) + key + args) + (display-backtrace + stack + (current-error-port) + 2)))) + #t) + #:unwind? #t))) + (begin + (put-bytevector client body) + #t)))) + (if body-written? + (begin + (force-output client) + (keep-alive? response)) + #f))) + #:unwind? #t)))) -(define (client-loop client handler) +(define (client-loop client handler + write-response-exception-handler) ;; Always disable Nagle's algorithm, as we handle buffering ;; ourselves; when we force-output, we really want the data to go ;; out. @@ -202,7 +289,8 @@ on the procedure being called at any particular time." (lambda _ #t)) (close-port client)) (else - (let ((keep-alive? (handle-request handler client))) + (let ((keep-alive? (handle-request handler client + write-response-exception-handler))) (if keep-alive? (loop) (close-port client))))))) @@ -222,7 +310,9 @@ on the procedure being called at any particular time." (inet-pton family host) INADDR_LOOPBACK)) (port 8080) - (socket (make-default-socket family addr port))) + (socket (make-default-socket family addr port)) + (write-response-exception-handler + default-write-response-exception-handler)) "Run the fibers web server. HANDLER should be a procedure that takes one argument, the HTTP @@ -254,7 +344,8 @@ before sending back to the client." (match (accept socket (logior SOCK_NONBLOCK SOCK_CLOEXEC)) ((client . sockaddr) (spawn-fiber (lambda () - (client-loop client handler)) + (client-loop client handler + write-response-exception-handler)) #:parallel? #t) (loop)))))) diff --git a/tests/web-server.scm b/tests/web-server.scm index 0254795..00cd8c3 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -1,8 +1,11 @@ -(use-modules (tests) +(use-modules (srfi srfi-71) + (tests) (fibers) + (fibers channels) (unit-test) (web uri) (web client) + (web request) (web response) (knots web-server) (knots non-blocking)) @@ -27,4 +30,40 @@ uri #:port (non-blocking-open-socket-for-uri uri))))))) +(run-fibers-for-tests + (lambda () + (let* ((exception-handled-sucecssfully-channel + (make-channel)) + (port-closed-channel (make-channel)) + (web-server + (run-knots-web-server + (lambda (request) + ;; TODO Not sure why buffering makes a difference here + (setvbuf (request-port request) 'none) + (get-message port-closed-channel) + (values '((content-type . (text/plain))) + "Hello, World!")) + #:write-response-exception-handler + (lambda (exn) + (spawn-fiber + (lambda () + (put-message exception-handled-sucecssfully-channel + #t))) + #f) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (let ((request-port (non-blocking-open-socket-for-uri uri))) + (write-request + (build-request uri) + request-port) + (close-port request-port)) + (put-message port-closed-channel #t) + + (assert-equal (get-message exception-handled-sucecssfully-channel) + #t)))) + (display "web-server test finished successfully\n") From 8a99f51bf9390e488b97f6d40cfa0a94d38aa7a4 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 23 Jan 2025 19:46:43 +0100 Subject: [PATCH 016/112] Handle when the wrong number of values is returned in the web server --- knots/web-server.scm | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 58c1883..0c2d3fb 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -206,8 +206,25 @@ on the procedure being called at any particular time." stack (current-error-port) 2))))))) - (lambda (response body) - (sanitize-response request response body)))) + (match-lambda* + ((response body) + (sanitize-response request response body)) + (other + (let ((stack (make-stack #t)) + (exception + (make-exception-with-irritants + (list (make-exception-with-message + (simple-format + #f + "wrong number of values returned from handler, expecting 2, got ~A" + (length other))) + handler)))) + (print-exception + (current-error-port) + (stack-ref stack 2) + '%exception + (list exception)) + (raise-exception exception)))))) #:unwind? #t))))) (with-exception-handler write-response-exception-handler From d2ee45581b9f2cdac93e17673d8faaf02f0ef060 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 23 Jan 2025 19:48:39 +0100 Subject: [PATCH 017/112] Export the wait-until-port operations --- knots/timeout.scm | 3 +++ 1 file changed, 3 insertions(+) diff --git a/knots/timeout.scm b/knots/timeout.scm index 8f8a2fb..552d079 100644 --- a/knots/timeout.scm +++ b/knots/timeout.scm @@ -31,6 +31,9 @@ #:use-module (fibers operations) #:export (with-fibers-timeout + wait-until-port-readable-operation + wait-until-port-writable-operation + &port-timeout port-timeout-error? From 88052652438a6b3f7af9a32f95ca164328d98fbe Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 23 Jan 2025 19:49:08 +0100 Subject: [PATCH 018/112] Don't wait indefinitely for new requests in the web server Inspired by the similar changes in Cuirass. --- knots/web-server.scm | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 0c2d3fb..3eb97a2 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -19,6 +19,8 @@ #:use-module (srfi srfi-9) #:use-module (srfi srfi-71) #:use-module (fibers) + #:use-module (fibers timers) + #:use-module (fibers operations) #:use-module (fibers conditions) #:use-module (rnrs bytevectors) #:use-module (ice-9 binary-ports) @@ -31,6 +33,7 @@ #:use-module (web http) #:use-module (web request) #:use-module (web response) + #:use-module (knots timeout) #:use-module (knots non-blocking) #:export (run-knots-web-server @@ -290,8 +293,9 @@ on the procedure being called at any particular time." #f))) #:unwind? #t)))) -(define (client-loop client handler - write-response-exception-handler) +(define* (client-loop client handler + write-response-exception-handler + connection-idle-timeout) ;; Always disable Nagle's algorithm, as we handle buffering ;; ourselves; when we force-output, we really want the data to go ;; out. @@ -302,7 +306,18 @@ on the procedure being called at any particular time." (let loop () (cond ((catch #t - (lambda () (eof-object? (lookahead-u8 client))) + (lambda () + (or + (if (eq? #f connection-idle-timeout) + #f + (perform-operation + (choice-operation (wrap-operation + (wait-until-port-readable-operation client) + (const #f)) + (wrap-operation + (sleep-operation connection-idle-timeout) + (const #t))))) + (eof-object? (lookahead-u8 client)))) (lambda _ #t)) (close-port client)) (else @@ -329,7 +344,8 @@ on the procedure being called at any particular time." (port 8080) (socket (make-default-socket family addr port)) (write-response-exception-handler - default-write-response-exception-handler)) + default-write-response-exception-handler) + (connection-idle-timeout 60)) "Run the fibers web server. HANDLER should be a procedure that takes one argument, the HTTP @@ -362,7 +378,8 @@ before sending back to the client." ((client . sockaddr) (spawn-fiber (lambda () (client-loop client handler - write-response-exception-handler)) + write-response-exception-handler + connection-idle-timeout)) #:parallel? #t) (loop)))))) From 675d8c32589f18758406a7eb1910444e56cb6837 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 23 Jan 2025 19:54:50 +0100 Subject: [PATCH 019/112] Make the web server exception handler configurable --- knots/web-server.scm | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 3eb97a2..bd0d9f9 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -166,8 +166,15 @@ on the procedure being called at any particular time." ;; Close the client port #f) +(define (default-exception-handler exn) + (values (build-response #:code 500) + ;; TODO Make this configurable + (string->utf8 + "internal server error"))) + (define (handle-request handler client - write-response-exception-handler) + write-response-exception-handler + exception-handler) (let ((request (catch #t (lambda () @@ -186,11 +193,7 @@ on the procedure being called at any particular time." #vu8())) (else (with-exception-handler - (lambda (exn) - (values (build-response #:code 500) - ;; TODO Make this configurable - (string->utf8 - "internal server error"))) + exception-handler (lambda () (call-with-values (lambda () (with-stack-and-prompt @@ -294,6 +297,7 @@ on the procedure being called at any particular time." #:unwind? #t)))) (define* (client-loop client handler + exception-handler write-response-exception-handler connection-idle-timeout) ;; Always disable Nagle's algorithm, as we handle buffering @@ -322,7 +326,8 @@ on the procedure being called at any particular time." (close-port client)) (else (let ((keep-alive? (handle-request handler client - write-response-exception-handler))) + write-response-exception-handler + exception-handler))) (if keep-alive? (loop) (close-port client))))))) @@ -343,6 +348,8 @@ on the procedure being called at any particular time." INADDR_LOOPBACK)) (port 8080) (socket (make-default-socket family addr port)) + (exception-handler + default-exception-handler) (write-response-exception-handler default-write-response-exception-handler) (connection-idle-timeout 60)) @@ -378,6 +385,7 @@ before sending back to the client." ((client . sockaddr) (spawn-fiber (lambda () (client-loop client handler + exception-handler write-response-exception-handler connection-idle-timeout)) #:parallel? #t) From c1796f0081cef266cbbc494cbf0791b4105d5b89 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 25 Jan 2025 18:17:38 +0000 Subject: [PATCH 020/112] Update run-knots-web-server docstring --- knots/web-server.scm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index bd0d9f9..c5ec246 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -353,7 +353,7 @@ on the procedure being called at any particular time." (write-response-exception-handler default-write-response-exception-handler) (connection-idle-timeout 60)) - "Run the fibers web server. + "Run the knots web server. HANDLER should be a procedure that takes one argument, the HTTP request and returns two values, the response and response body. @@ -365,7 +365,7 @@ For example, here is a simple \"Hello, World!\" server: (let ((body (read-request-body request))) (values '((content-type . (text/plain))) \"Hello, World!\"))) - (run-server handler) + (run-knots-web-server handler) @end example The response and body will be run through ‘sanitize-response’ From c90cc88da76cefbc30897042ec88eff5cf0d6264 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 29 Jan 2025 16:16:35 +0000 Subject: [PATCH 021/112] Add fibers-promise-result-available? --- knots/promise.scm | 8 +++++++- tests/promise.scm | 10 +++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/knots/promise.scm b/knots/promise.scm index 3eb0a81..235640b 100644 --- a/knots/promise.scm +++ b/knots/promise.scm @@ -24,7 +24,8 @@ #:use-module (fibers conditions) #:export (fibers-delay fibers-force - fibers-promise-reset)) + fibers-promise-reset + fibers-promise-result-available?)) (define-record-type (make-fibers-promise thunk values-box evaluated-condition) @@ -76,3 +77,8 @@ (define (fibers-promise-reset fp) (atomic-box-set! (fibers-promise-values-box fp) #f)) + +(define (fibers-promise-result-available? fp) + (let ((val (atomic-box-ref (fibers-promise-values-box fp)))) + (not (or (eq? val #f) + (eq? val 'started))))) diff --git a/tests/promise.scm b/tests/promise.scm index b7dec73..1c0e235 100644 --- a/tests/promise.scm +++ b/tests/promise.scm @@ -13,8 +13,16 @@ (* i 2)))) (iota 10)))) + (assert-equal + #f + (fibers-promise-result-available? (car promises))) + (assert-equal 90 - (apply + (fibers-map fibers-force promises)))))) + (apply + (fibers-map fibers-force promises))) + + (assert-equal + #t + (fibers-promise-result-available? (car promises)))))) (display "promise test finished successfully\n") From b5cc5fd07762ee3d8cca2c1d3c8ca4f3f487a439 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 29 Jan 2025 16:17:56 +0000 Subject: [PATCH 022/112] Make the web server buffer size configurable --- knots/web-server.scm | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index c5ec246..75ccd09 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -299,11 +299,12 @@ on the procedure being called at any particular time." (define* (client-loop client handler exception-handler write-response-exception-handler - connection-idle-timeout) + connection-idle-timeout + buffer-size) ;; Always disable Nagle's algorithm, as we handle buffering ;; ourselves; when we force-output, we really want the data to go ;; out. - (setvbuf client 'block 1024) + (setvbuf client 'block buffer-size) (setsockopt client IPPROTO_TCP TCP_NODELAY 1) (with-throw-handler #t (lambda () @@ -352,7 +353,8 @@ on the procedure being called at any particular time." default-exception-handler) (write-response-exception-handler default-write-response-exception-handler) - (connection-idle-timeout 60)) + (connection-idle-timeout 60) + (connection-buffer-size 1024)) "Run the knots web server. HANDLER should be a procedure that takes one argument, the HTTP @@ -387,7 +389,8 @@ before sending back to the client." (client-loop client handler exception-handler write-response-exception-handler - connection-idle-timeout)) + connection-idle-timeout + connection-buffer-size)) #:parallel? #t) (loop)))))) From c641c19ce42876b16186ea82f3803a56a43a5f91 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 29 Jan 2025 16:18:15 +0000 Subject: [PATCH 023/112] Call web server exception handlers with the request So that this can be used when reporting the exception. --- knots/web-server.scm | 10 ++++++---- tests/web-server.scm | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 75ccd09..392a5ff 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -158,7 +158,7 @@ on the procedure being called at any particular time." ((0) (memq 'keep-alive (response-connection response))))) (else #f))))) -(define (default-write-response-exception-handler exn) +(define (default-write-response-exception-handler exn request) (simple-format (current-error-port) "knots web server: exception replying to client: ~A\n" exn) @@ -166,7 +166,7 @@ on the procedure being called at any particular time." ;; Close the client port #f) -(define (default-exception-handler exn) +(define (default-exception-handler exn request) (values (build-response #:code 500) ;; TODO Make this configurable (string->utf8 @@ -193,7 +193,8 @@ on the procedure being called at any particular time." #vu8())) (else (with-exception-handler - exception-handler + (lambda (exn) + (exception-handler exn request)) (lambda () (call-with-values (lambda () (with-stack-and-prompt @@ -233,7 +234,8 @@ on the procedure being called at any particular time." (raise-exception exception)))))) #:unwind? #t))))) (with-exception-handler - write-response-exception-handler + (lambda (exn) + (write-response-exception-handler exn request)) (lambda () (write-response response client) diff --git a/tests/web-server.scm b/tests/web-server.scm index 00cd8c3..3eebd1d 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -44,7 +44,7 @@ (values '((content-type . (text/plain))) "Hello, World!")) #:write-response-exception-handler - (lambda (exn) + (lambda (exn request) (spawn-fiber (lambda () (put-message exception-handled-sucecssfully-channel From eebb42e7a778eb21342fcd861e313bf21f0afc94 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 30 Jan 2025 09:57:14 +0100 Subject: [PATCH 024/112] Default to an resource-pool add-resources-parallelism of 1 So that there aren't issues with concurrent resource addition, at least by default. --- knots/resource-pool.scm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 355cfa9..6501191 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -87,7 +87,7 @@ scheduler (name "unnamed") (reply-timeout 0.5) - add-resources-parallelism) + (add-resources-parallelism 1)) (define channel (make-channel)) (define pool From 61451907a90893f6442bfa7bc135aa2610178873 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 31 Jan 2025 12:33:50 +0100 Subject: [PATCH 025/112] Improve resource pool destruction --- knots/resource-pool.scm | 84 ++++++++++++++++++++++++++++++----------- tests/resource-pool.scm | 72 ++++++++++++++++++++++++++--------- 2 files changed, 116 insertions(+), 40 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 6501191..3c5fb23 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -21,6 +21,7 @@ #:use-module (srfi srfi-1) #:use-module (srfi srfi-9) #:use-module (srfi srfi-9 gnu) + #:use-module (srfi srfi-71) #:use-module (ice-9 match) #:use-module (ice-9 exceptions) #:use-module (fibers) @@ -179,10 +180,13 @@ (backtrace)))) #:unwind? #t))) - (unless success? - (sleep 5) + (if success? + (put-message channel + (list 'remove resource)) + (begin + (sleep 5) - (loop))))))) + (loop)))))))) (define (spawn-fiber-for-checkout reply-channel resource) (spawn-fiber @@ -221,12 +225,20 @@ (('add-resource resource) (if (= (length resources) max-size) (begin - (spawn-fiber-to-destroy-resource resource) + (if destructor + (begin + (spawn-fiber-to-destroy-resource resource) - (loop resources - available - waiters - resources-last-used)) + (loop (cons resource resources) + available + waiters + (cons (get-internal-real-time) + resources-last-used))) + (loop resources + available + waiters + (cons (get-internal-real-time) + resources-last-used)))) (if (null? waiters) (loop (cons resource resources) @@ -321,6 +333,26 @@ (get-internal-real-time)) resources-last-used))))) + (('remove resource) + (let ((index + (list-index (lambda (x) + (eq? x resource)) + resources))) + (define (remove-at-index! lst i) + (let ((start + end + (split-at! lst i))) + (append + start + (cdr end)))) + + (loop (remove-at-index! resources index) + available ; resource shouldn't be in this list + waiters + (remove-at-index! + resources-last-used + index)))) + (('stats reply) (let ((stats `((resources . ,(length resources)) @@ -361,10 +393,11 @@ resources resources-last-used-seconds))) - (for-each - (lambda (resource) - (spawn-fiber-to-destroy-resource resource)) - resources-to-destroy) + (when destructor + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + resources-to-destroy)) (loop (lset-difference eq? resources resources-to-destroy) (lset-difference eq? available resources-to-destroy) @@ -378,22 +411,29 @@ resources-last-used)))) (('destroy reply) - (if (= (length resources) (length available)) + (if (null? resources) + (put-message reply 'destroy-success) + (begin (for-each (lambda (resource) - (spawn-fiber-to-destroy-resource resource)) - resources) - (put-message reply 'destroy-success)) - (begin + (if destructor + (spawn-fiber-to-destroy-resource resource) + (spawn-fiber + (lambda () + (put-message channel + (list 'remove resource))) + #:parallel? #t))) + available) + (spawn-fiber (lambda () - (perform-operation - (choice-operation - (put-operation reply 'resource-pool-destroy-failed) - (sleep-operation 10))))) + (sleep 0.1) + (put-message channel + (list 'destroy reply)))) + (loop resources - available + '() waiters resources-last-used)))) diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index 33f5a0c..24a4f53 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -1,32 +1,37 @@ (use-modules (tests) (fibers) (unit-test) + (knots parallelism) (knots resource-pool)) -(run-fibers-for-tests - (lambda () - (let ((resource-pool (make-resource-pool - (lambda () - 2) - 1))) - (assert-equal - (with-resource-from-pool resource-pool - res - res) - 2)))) +(define new-number + (let ((val 0)) + (lambda () + (set! val (1+ val)) + val))) (run-fibers-for-tests (lambda () (let ((resource-pool (make-resource-pool - (lambda () - 2) + new-number + 1))) + (assert-true + (number? + (with-resource-from-pool resource-pool + res + res)))))) + +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + new-number 1 #:add-resources-parallelism 1))) - (assert-equal - (with-resource-from-pool resource-pool - res - res) - 2)))) + (assert-true + (number? + (with-resource-from-pool resource-pool + res + res)))))) (let* ((error-constructor (record-constructor &resource-pool-timeout)) @@ -36,4 +41,35 @@ (resource-pool-timeout-error-pool err) 'foo)) +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + new-number + 2))) + (fibers-for-each + (lambda _ + (with-resource-from-pool resource-pool + res + res)) + (iota 20)) + + (destroy-resource-pool resource-pool)))) + +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + new-number + 2 + #:destructor + (lambda (res) + #t)))) + (fibers-for-each + (lambda _ + (with-resource-from-pool resource-pool + res + res)) + (iota 20)) + + (destroy-resource-pool resource-pool)))) + (display "resource-pool test finished successfully\n") From 2910e6615008febfe93a2167aa46f690b9f268dd Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 31 Jan 2025 17:55:18 +0100 Subject: [PATCH 026/112] Fix issue with parallel creating resource pool resources --- knots/resource-pool.scm | 75 +++++++++++++++++++---------------------- tests/resource-pool.scm | 23 +++++++++++++ 2 files changed, 58 insertions(+), 40 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 3c5fb23..17919a6 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -109,8 +109,8 @@ (define checkout-failure-count 0) (define spawn-fiber-to-return-new-resource - (let ((thunk - (if add-resources-parallelism + (if add-resources-parallelism + (let ((thunk (fiberize (lambda () (let ((max-size @@ -118,44 +118,38 @@ 'max-size)) (size (assq-ref (resource-pool-stats pool) 'resources))) - (if (= size max-size) - (raise-exception - (make-resource-pool-abort-add-resource-error)) - (return-new-resource)))) - #:parallelism add-resources-parallelism - #:show-backtrace? - (lambda (key . args) - (not - (and (eq? key '%exception) - (resource-pool-abort-add-resource-error? - (car args)))))) - return-new-resource))) - (lambda () - (spawn-fiber - (lambda () - (let ((new-resource - (with-exception-handler - (lambda (exn) - (unless (resource-pool-abort-add-resource-error? exn) + (unless (= size max-size) + (let ((new-resource + (return-new-resource))) + (put-message channel + (list 'add-resource new-resource)))))) + #:parallelism add-resources-parallelism))) + (lambda () + (spawn-fiber thunk))) + (lambda () + (spawn-fiber + (lambda () + (let ((new-resource + (with-exception-handler + (lambda (exn) (simple-format (current-error-port) "exception adding resource to pool ~A: ~A:\n ~A\n" name return-new-resource - exn)) - #f) - (lambda () - (with-throw-handler #t - thunk - (lambda (key . args) - (unless (and (eq? key '%exception) - (resource-pool-abort-add-resource-error? - (car args))) - (backtrace))))) - #:unwind? #t))) - (when new-resource - (put-message channel - (list 'add-resource new-resource))))))))) + exn) + #f) + (lambda () + (with-exception-handler + (lambda (exn) + (backtrace) + (raise-exception exn)) + (lambda () + (start-stack #t (return-new-resource))))) + #:unwind? #t))) + (when new-resource + (put-message channel + (list 'add-resource new-resource))))))))) (define (spawn-fiber-to-destroy-resource resource) (spawn-fiber @@ -172,12 +166,13 @@ exn) #f) (lambda () - (with-throw-handler #t + (with-exception-handler + (lambda (exn) + (backtrace) + (raise-exception exn)) (lambda () - (destructor resource) - #t) - (lambda _ - (backtrace)))) + (start-stack #t (destructor resource)) + #t))) #:unwind? #t))) (if success? diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index 24a4f53..1d998ef 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -72,4 +72,27 @@ (destroy-resource-pool resource-pool)))) +(run-fibers-for-tests + (lambda () + (let* ((counter 0) + (resource-pool (make-resource-pool + (lambda () + (let ((start-val counter)) + (sleep 0.05) + (if (= start-val counter) + (set! counter (+ 1 counter)) + (error "collision detected"))) + (new-number)) + 1))) + (fibers-for-each + (lambda _ + (with-resource-from-pool + resource-pool res + (let ((start-val counter)) + (sleep 0.05) + (if (= start-val counter) + (set! counter (+ 1 counter)) + (error "collision detected"))))) + (iota 50))))) + (display "resource-pool test finished successfully\n") From 823cd956285308b3565d366e7edb51542299822b Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 09:55:57 +0100 Subject: [PATCH 027/112] Guard against the remove message not working --- knots/resource-pool.scm | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 17919a6..ac536cc 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -341,7 +341,14 @@ start (cdr end)))) - (loop (remove-at-index! resources index) + (loop (if index + (remove-at-index! resources index) + (begin + (simple-format + (current-error-port) + "resource pool error: unable to remove ~A\n" + resource) + resources)) available ; resource shouldn't be in this list waiters (remove-at-index! From dc98ef9dcc55edd294bd9c03cccf36f66b0c123a Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 10:30:16 +0100 Subject: [PATCH 028/112] Improve exception reporting in the resource pool --- knots/resource-pool.scm | 508 +++++++++++++++++++++------------------- 1 file changed, 266 insertions(+), 242 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index ac536cc..094eadb 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -200,6 +200,246 @@ channel (list 'return-failed-checkout resource))))))) + (define (main-loop) + (let loop ((resources '()) + (available '()) + (waiters '()) + (resources-last-used '())) + + (match (get-message channel) + (('add-resource resource) + (if (= (length resources) max-size) + (begin + (if destructor + (begin + (spawn-fiber-to-destroy-resource resource) + + (loop (cons resource resources) + available + waiters + (cons (get-internal-real-time) + resources-last-used))) + (loop resources + available + waiters + (cons (get-internal-real-time) + resources-last-used)))) + + (if (null? waiters) + (loop (cons resource resources) + (cons resource available) + waiters + (cons (get-internal-real-time) + resources-last-used)) + + (begin + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout (last waiters) + resource) + (put-message (last waiters) resource)) + + (loop (cons resource resources) + available + (drop-right! waiters 1) + (cons (get-internal-real-time) + resources-last-used)))))) + + (('checkout reply) + (if (null? available) + (begin + (unless (= (length resources) max-size) + (spawn-fiber-to-return-new-resource)) + + (loop resources + available + (cons reply waiters) + resources-last-used)) + + (let ((resource (car available))) + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout reply resource) + (put-message reply resource)) + + (loop resources + (cdr available) + waiters + resources-last-used)))) + + (((and (or 'return + 'return-failed-checkout) + return-type) + resource) + + (when (eq? 'return-failed-checkout + return-type) + (set! checkout-failure-count + (+ 1 checkout-failure-count))) + + (if (null? waiters) + (loop resources + (cons resource available) + waiters + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used)) + + (begin + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout (last waiters) + resource) + (put-message (last waiters) resource)) + + (loop resources + available + (drop-right! waiters 1) + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used))))) + + (('remove resource) + (let ((index + (list-index (lambda (x) + (eq? x resource)) + resources))) + (define (remove-at-index! lst i) + (let ((start + end + (split-at! lst i))) + (append + start + (cdr end)))) + + (loop (if index + (remove-at-index! resources index) + (begin + (simple-format + (current-error-port) + "resource pool error: unable to remove ~A\n" + resource) + resources)) + available ; resource shouldn't be in this list + waiters + (remove-at-index! + resources-last-used + index)))) + + (('stats reply) + (let ((stats + `((resources . ,(length resources)) + (available . ,(length available)) + (waiters . ,(length waiters)) + (checkout-failure-count . ,checkout-failure-count)))) + + (spawn-fiber + (lambda () + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply stats) + (const #t)) + (wrap-operation (sleep-operation + reply-timeout) + (const #f))))))) + + (loop resources + available + waiters + resources-last-used)) + + (('check-for-idle-resources) + (let* ((resources-last-used-seconds + (map + (lambda (internal-time) + (/ (- (get-internal-real-time) internal-time) + internal-time-units-per-second)) + resources-last-used)) + (resources-to-destroy + (filter-map + (lambda (resource last-used-seconds) + (if (and (member resource available) + (> last-used-seconds idle-seconds)) + resource + #f)) + resources + resources-last-used-seconds))) + + (when destructor + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + resources-to-destroy)) + + (loop (lset-difference eq? resources resources-to-destroy) + (lset-difference eq? available resources-to-destroy) + waiters + (filter-map + (lambda (resource last-used) + (if (memq resource resources-to-destroy) + #f + last-used)) + resources + resources-last-used)))) + + (('destroy reply) + (if (null? resources) + (put-message reply 'destroy-success) + + (begin + (for-each + (lambda (resource) + (if destructor + (spawn-fiber-to-destroy-resource resource) + (spawn-fiber + (lambda () + (put-message channel + (list 'remove resource))) + #:parallel? #t))) + available) + + (spawn-fiber + (lambda () + (sleep 0.1) + (put-message channel + (list 'destroy reply)))) + + (loop resources + '() + waiters + resources-last-used)))) + + (unknown + (simple-format + (current-error-port) + "unrecognised message to ~A resource pool channel: ~A\n" + name + unknown) + (loop resources + available + waiters + resources-last-used))))) + (spawn-fiber (lambda () (when idle-seconds @@ -209,249 +449,33 @@ (sleep idle-seconds) (put-message channel '(check-for-idle-resources)))))) - (with-throw-handler #t + (with-exception-handler + (lambda (exn) + #f) (lambda () - (let loop ((resources '()) - (available '()) - (waiters '()) - (resources-last-used '())) - - (match (get-message channel) - (('add-resource resource) - (if (= (length resources) max-size) - (begin - (if destructor - (begin - (spawn-fiber-to-destroy-resource resource) - - (loop (cons resource resources) - available - waiters - (cons (get-internal-real-time) - resources-last-used))) - (loop resources - available - waiters - (cons (get-internal-real-time) - resources-last-used)))) - - (if (null? waiters) - (loop (cons resource resources) - (cons resource available) - waiters - (cons (get-internal-real-time) - resources-last-used)) - - (begin - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a new - ;; fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout (last waiters) - resource) - (put-message (last waiters) resource)) - - (loop (cons resource resources) - available - (drop-right! waiters 1) - (cons (get-internal-real-time) - resources-last-used)))))) - - (('checkout reply) - (if (null? available) - (begin - (unless (= (length resources) max-size) - (spawn-fiber-to-return-new-resource)) - - (loop resources - available - (cons reply waiters) - resources-last-used)) - - (let ((resource (car available))) - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout reply resource) - (put-message reply resource)) - - (loop resources - (cdr available) - waiters - resources-last-used)))) - - (((and (or 'return - 'return-failed-checkout) - return-type) - resource) - - (when (eq? 'return-failed-checkout - return-type) - (set! checkout-failure-count - (+ 1 checkout-failure-count))) - - (if (null? waiters) - (loop resources - (cons resource available) - waiters - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used)) - - (begin - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a new - ;; fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout (last waiters) - resource) - (put-message (last waiters) resource)) - - (loop resources - available - (drop-right! waiters 1) - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used))))) - - (('remove resource) - (let ((index - (list-index (lambda (x) - (eq? x resource)) - resources))) - (define (remove-at-index! lst i) - (let ((start - end - (split-at! lst i))) - (append - start - (cdr end)))) - - (loop (if index - (remove-at-index! resources index) - (begin - (simple-format - (current-error-port) - "resource pool error: unable to remove ~A\n" - resource) - resources)) - available ; resource shouldn't be in this list - waiters - (remove-at-index! - resources-last-used - index)))) - - (('stats reply) - (let ((stats - `((resources . ,(length resources)) - (available . ,(length available)) - (waiters . ,(length waiters)) - (checkout-failure-count . ,checkout-failure-count)))) - - (spawn-fiber - (lambda () - (perform-operation - (choice-operation - (wrap-operation - (put-operation reply stats) - (const #t)) - (wrap-operation (sleep-operation - reply-timeout) - (const #f))))))) - - (loop resources - available - waiters - resources-last-used)) - - (('check-for-idle-resources) - (let* ((resources-last-used-seconds - (map - (lambda (internal-time) - (/ (- (get-internal-real-time) internal-time) - internal-time-units-per-second)) - resources-last-used)) - (resources-to-destroy - (filter-map - (lambda (resource last-used-seconds) - (if (and (member resource available) - (> last-used-seconds idle-seconds)) - resource - #f)) - resources - resources-last-used-seconds))) - - (when destructor - (for-each - (lambda (resource) - (spawn-fiber-to-destroy-resource resource)) - resources-to-destroy)) - - (loop (lset-difference eq? resources resources-to-destroy) - (lset-difference eq? available resources-to-destroy) - waiters - (filter-map - (lambda (resource last-used) - (if (memq resource resources-to-destroy) - #f - last-used)) - resources - resources-last-used)))) - - (('destroy reply) - (if (null? resources) - (put-message reply 'destroy-success) - - (begin - (for-each - (lambda (resource) - (if destructor - (spawn-fiber-to-destroy-resource resource) - (spawn-fiber - (lambda () - (put-message channel - (list 'remove resource))) - #:parallel? #t))) - available) - - (spawn-fiber - (lambda () - (sleep 0.1) - (put-message channel - (list 'destroy reply)))) - - (loop resources - '() - waiters - resources-last-used)))) - - (unknown - (simple-format - (current-error-port) - "unrecognised message to ~A resource pool channel: ~A\n" - name - unknown) - (loop resources - available - waiters - resources-last-used))))) - (lambda (key . args) - (simple-format (current-error-port) - "exception in the ~A pool fiber\n" name)))) + (with-exception-handler + (lambda (exn) + (let* ((stack (make-stack #t)) + (error-string + (call-with-output-string + (lambda (port) + (simple-format + port + "exception in the ~A pool fiber, " name) + (print-exception + port + (stack-ref stack 3) + '%exception + (list exn)) + (display-backtrace stack port 3))))) + (display error-string + (current-error-port))) + (raise-exception exn)) + (lambda () + (start-stack + #t + (main-loop))))) + #:unwind? #t)) (or scheduler (current-scheduler))) From 40cf026ea4df3733eebeb5cd37524c2a6d225e4b Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 11:19:52 +0100 Subject: [PATCH 029/112] Rework exception handling in the web server --- knots/web-server.scm | 92 ++++++++++++++++++++++++-------------------- 1 file changed, 51 insertions(+), 41 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 392a5ff..4a9bc0e 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -18,6 +18,7 @@ (define-module (knots web-server) #:use-module (srfi srfi-9) #:use-module (srfi srfi-71) + #:use-module (ice-9 control) #:use-module (fibers) #:use-module (fibers timers) #:use-module (fibers operations) @@ -30,6 +31,7 @@ #:use-module (ice-9 exceptions) #:use-module ((srfi srfi-9 gnu) #:select (set-field)) #:use-module (system repl error-handling) + #:use-module (web uri) #:use-module (web http) #:use-module (web request) #:use-module (web response) @@ -167,6 +169,24 @@ on the procedure being called at any particular time." #f) (define (default-exception-handler exn request) + (let* ((stack (make-stack #t)) + (error-string + (call-with-output-string + (lambda (port) + (simple-format + port + "exception when processing: ~A ~A\n" + (request-method request) + (uri-path (request-uri request))) + (display-backtrace stack port 4) + (print-exception + port + (stack-ref stack 4) + '%exception + (list exn)))))) + (display error-string + (current-error-port))) + (values (build-response #:code 500) ;; TODO Make this configurable (string->utf8 @@ -192,47 +212,37 @@ on the procedure being called at any particular time." #:headers '((content-length . 0))) #vu8())) (else - (with-exception-handler - (lambda (exn) - (exception-handler exn request)) - (lambda () - (call-with-values (lambda () - (with-stack-and-prompt - (lambda () - (with-throw-handler #t - (lambda () - (handler request)) - (lambda (key . args) - (let ((stack (make-stack #t))) - (print-exception - (current-error-port) - (stack-ref stack 2) - key - args) - (display-backtrace - stack - (current-error-port) - 2))))))) - (match-lambda* - ((response body) - (sanitize-response request response body)) - (other - (let ((stack (make-stack #t)) - (exception - (make-exception-with-irritants - (list (make-exception-with-message - (simple-format - #f - "wrong number of values returned from handler, expecting 2, got ~A" - (length other))) - handler)))) - (print-exception - (current-error-port) - (stack-ref stack 2) - '%exception - (list exception)) - (raise-exception exception)))))) - #:unwind? #t))))) + (call-with-values + (lambda () + (call-with-escape-continuation + (lambda (return) + (with-exception-handler + (lambda (exn) + (call-with-values + (lambda () + (exception-handler exn request)) + return)) + (lambda () + (start-stack #t (handler request))))))) + (match-lambda* + ((response body) + (sanitize-response request response body)) + (other + (let ((stack (make-stack #t)) + (exception + (make-exception-with-irritants + (list (make-exception-with-message + (simple-format + #f + "wrong number of values returned from handler, expecting 2, got ~A" + (length other))) + handler)))) + (print-exception + (current-error-port) + (stack-ref stack 2) + '%exception + (list exception)) + (raise-exception exception))))))))) (with-exception-handler (lambda (exn) (write-response-exception-handler exn request)) From 41974a681796ff425e4f7034ea352ba8e390e6e7 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 11:25:11 +0100 Subject: [PATCH 030/112] Rework handling of using a proc for the web server response body To address encoding issues and improve exception handling. --- knots/web-server.scm | 130 +++++++++++++++++++++++++++---------------- tests/web-server.scm | 52 +++++++++++++++++ 2 files changed, 134 insertions(+), 48 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 4a9bc0e..bd53a99 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -39,6 +39,8 @@ #:use-module (knots non-blocking) #:export (run-knots-web-server + make-chunked-output-port/knots + default-write-response-exception-handler web-server? @@ -52,6 +54,37 @@ (bind sock family addr port) sock)) +(define* (make-chunked-output-port/knots port #:key (keep-alive? #f) + (buffering 1200) + (encoding "ISO-8859-1")) + "Returns a new port which translates non-encoded data into a HTTP +chunked transfer encoded data and writes this to PORT. Data written to +this port is buffered until the port is flushed, at which point it is +all sent as one chunk. The port will otherwise be flushed every +BUFFERING bytes, which defaults to 1200. Take care to close the port +when done, as it will output the remaining data, and encode the final +zero chunk. When the port is closed it will also close PORT, unless +KEEP-ALIVE? is true." + (define (write! bv start count) + (put-string port (number->string count 16)) + (put-string port "\r\n") + (put-bytevector port bv start count) + (put-string port "\r\n") + (force-output port) + count) + + (define (close) + (put-string port "0\r\n\r\n") + (force-output port) + (unless keep-alive? + (close-port port))) + + (define ret + (make-custom-binary-output-port "chunked http" write! #f #f close)) + (set-port-encoding! ret encoding) + (setvbuf ret 'block buffering) + ret) + (define (extend-response r k v . additional) (define (extend-alist alist k v) (let ((pair (assq k alist))) @@ -249,61 +282,62 @@ on the procedure being called at any particular time." (lambda () (write-response response client) - (let ((body-written? + (let* ((change-client-port-encoding? + (and (procedure? body) + (not (response-content-length response)))) + (body-written? (if (procedure? body) - (if (response-content-length response) - (with-exception-handler - (lambda (exn) - #f) - (lambda () - (with-stack-and-prompt - (lambda () - (with-throw-handler #t - (lambda () - (body client)) - (lambda (key . args) - (let ((stack (make-stack #t))) - (print-exception - (current-error-port) - (stack-ref stack 2) - key - args) - (display-backtrace - stack - (current-error-port) - 2)))))) - #t) - #:unwind? #t) - (let ((chunked-port - (make-chunked-output-port client - #:keep-alive? #t))) - (with-exception-handler - (lambda (exn) - #f) - (lambda () - (with-throw-handler #t - (lambda () - (body chunked-port) - (close-port chunked-port)) - (lambda (key . args) - (let ((stack (make-stack #t))) - (print-exception - (current-error-port) - (stack-ref stack 2) - key - args) - (display-backtrace - stack - (current-error-port) - 2)))) - #t) - #:unwind? #t))) + (let* ((type (response-content-type response + '(text/plain))) + (declared-charset (assq-ref (cdr type) 'charset)) + (charset (or declared-charset "ISO-8859-1")) + (body-port + (if (response-content-length response) + client + (make-chunked-output-port/knots + client + #:keep-alive? #t + #:encoding charset)))) + (when change-client-port-encoding? + (set-port-encoding! client charset)) + (let ((body-written? + (with-exception-handler + (lambda (exn) + #f) + (lambda () + (with-exception-handler + (lambda (exn) + (let* ((stack (make-stack #t)) + (error-string + (call-with-output-string + (lambda (port) + (print-exception + port + (stack-ref stack 2) + '%exception + (list exn)) + (display-backtrace + stack + port + 2))))) + (display error-string + (current-error-port))) + (raise-exception exn)) + (lambda () + (body body-port))) + #t) + #:unwind? #t))) + (unless (response-content-length response) + (close-port body-port)) + body-written?)) (begin (put-bytevector client body) #t)))) (if body-written? (begin (force-output client) + (when change-client-port-encoding? + (set-port-encoding! client "ISO-8859-1")) (keep-alive? response)) #f))) #:unwind? #t)))) diff --git a/tests/web-server.scm b/tests/web-server.scm index 3eebd1d..21d90f9 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -1,4 +1,7 @@ (use-modules (srfi srfi-71) + (rnrs bytevectors) + (ice-9 binary-ports) + (ice-9 textual-ports) (tests) (fibers) (fibers channels) @@ -30,6 +33,55 @@ uri #:port (non-blocking-open-socket-for-uri uri))))))) +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + (values '((content-type . (text/plain)) + (content-length . 3)) + (lambda (port) + (display "foo" port)))) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (let ((response + body + (http-get + uri + #:port (non-blocking-open-socket-for-uri uri)))) + (assert-equal + "foo" + body))))) + +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + (values '((content-type . (text/plain + (charset . "utf-8")))) + (lambda (port) + (display "☺" port)))) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (let ((response + body + (http-get + uri + #:port (non-blocking-open-socket-for-uri uri)))) + (assert-equal + "☺" + body))))) + +;; Test hanlding of exceptions when writing the response to a client (run-fibers-for-tests (lambda () (let* ((exception-handled-sucecssfully-channel From 92bb4b8d850af6032e01e072bf4d493ed7dc930e Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 12:06:10 +0100 Subject: [PATCH 031/112] Export the default-exception-handler --- knots/web-server.scm | 1 + 1 file changed, 1 insertion(+) diff --git a/knots/web-server.scm b/knots/web-server.scm index bd53a99..3a5bb5e 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -41,6 +41,7 @@ make-chunked-output-port/knots + default-exception-handler default-write-response-exception-handler web-server? From a2ab77053619e9edb551d673970b8b7bd248cd76 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 12:16:07 +0100 Subject: [PATCH 032/112] Tweak resource pool backtraces --- knots/resource-pool.scm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 094eadb..d08749b 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -459,6 +459,7 @@ (error-string (call-with-output-string (lambda (port) + (display-backtrace stack port 3) (simple-format port "exception in the ~A pool fiber, " name) @@ -466,8 +467,7 @@ port (stack-ref stack 3) '%exception - (list exn)) - (display-backtrace stack port 3))))) + (list exn)))))) (display error-string (current-error-port))) (raise-exception exn)) From bddc6c04adf0aad5db6b5a28b54a93608043ffc2 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 12:16:16 +0100 Subject: [PATCH 033/112] Fix idle resource removal in the resource pool --- knots/resource-pool.scm | 10 ++-------- tests/resource-pool.scm | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index d08749b..de03f50 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -391,16 +391,10 @@ (spawn-fiber-to-destroy-resource resource)) resources-to-destroy)) - (loop (lset-difference eq? resources resources-to-destroy) + (loop resources (lset-difference eq? available resources-to-destroy) waiters - (filter-map - (lambda (resource last-used) - (if (memq resource resources-to-destroy) - #f - last-used)) - resources - resources-last-used)))) + resources-last-used))) (('destroy reply) (if (null? resources) diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index 1d998ef..50dadbd 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -72,6 +72,27 @@ (destroy-resource-pool resource-pool)))) +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + new-number + 2 + #:idle-seconds 0.5 + #:destructor + (lambda (res) + #t)))) + (fibers-for-each + (lambda _ + (with-resource-from-pool resource-pool + res + res)) + (iota 20)) + + (let loop ((stats (resource-pool-stats resource-pool))) + (unless (= 0 (assq-ref stats 'resources)) + (sleep 0.1) + (loop (resource-pool-stats resource-pool))))))) + (run-fibers-for-tests (lambda () (let* ((counter 0) From 893299ba249266a7a22215377c227457506f2689 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Feb 2025 15:44:51 +0000 Subject: [PATCH 034/112] Start trying to improve exceptions and backtraces When using knots utilities. --- knots.scm | 72 +++++++++++++++++++++++++++++++++++++- knots/parallelism.scm | 80 ++++++++++++++++++++++++++----------------- knots/web-server.scm | 13 +++---- 3 files changed, 125 insertions(+), 40 deletions(-) diff --git a/knots.scm b/knots.scm index 4d1765b..5d152a8 100644 --- a/knots.scm +++ b/knots.scm @@ -1,11 +1,21 @@ (define-module (knots) + #:use-module (srfi srfi-1) + #:use-module (ice-9 match) #:use-module (ice-9 suspendable-ports) #:use-module (fibers conditions) + #:use-module (system repl debug) #:export (call-with-default-io-waiters wait-when-system-clock-behind - call-with-sigint)) + call-with-sigint + + &knots-exception + make-knots-exception + knots-exception? + knots-exception-stack + + print-backtrace-and-exception/knots)) (define (call-with-default-io-waiters thunk) (parameterize @@ -37,3 +47,63 @@ (sigaction SIGINT (car handler) (cdr handler)) ;; restore original C handler. (sigaction SIGINT #f)))))) + +(define &knots-exception + (make-exception-type '&knots-exception + &exception + '(stack))) + +(define make-knots-exception + (record-constructor &knots-exception)) + +(define knots-exception? + (record-predicate &knots-exception)) + +(define knots-exception-stack + (exception-accessor + &knots-exception + (record-accessor &knots-exception 'stack))) + +(define* (print-backtrace-and-exception/knots + exn + #:key (port (current-error-port))) + (let* ((stack (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))))) + (error-string + (call-with-output-string + (lambda (port) + (let ((knots-stacks + (map knots-exception-stack + (filter knots-exception? + (simple-exceptions exn))))) + + (let ((stack-vec + (stack->vector stack))) + (print-frames (list->vector + (drop + (vector->list stack-vec) + 6)) + port + #:count (stack-length stack))) + (for-each + (lambda (stack) + (let ((stack-vec + (stack->vector stack))) + (print-frames (list->vector + (drop + (vector->list stack-vec) + 3)) + port + #:count (stack-length stack)))) + knots-stacks) + (print-exception + port + (if (null? knots-stacks) + (stack-ref stack 1) + (stack-ref (last knots-stacks) 3)) + '%exception + (list exn))))))) + (display error-string port))) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index c829254..99f41b3 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -21,9 +21,11 @@ #:use-module (srfi srfi-1) #:use-module (srfi srfi-71) #:use-module (ice-9 match) + #:use-module (ice-9 control) #:use-module (fibers) #:use-module (fibers channels) #:use-module (fibers operations) + #:use-module (knots) #:export (fibers-batch-map fibers-map @@ -41,19 +43,23 @@ (let ((reply (make-channel))) (spawn-fiber (lambda () - (with-exception-handler - (lambda (exn) - (put-message reply (cons 'exception exn))) - (lambda () - (call-with-values - (lambda () - (with-throw-handler #t - thunk - (lambda _ - (backtrace)))) - (lambda vals - (put-message reply vals)))) - #:unwind? #t)) + (call-with-escape-continuation + (lambda (return) + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (put-message reply (list 'exception exn stack))))) + (return)) + (lambda () + (call-with-values + (lambda () + (start-stack #t (thunk))) + (lambda vals + (put-message reply vals)))))))) #:parallel? #t) reply)) @@ -62,8 +68,13 @@ reply-channels))) (map (match-lambda - (('exception . exn) - (raise-exception exn)) + (('exception exn stack) + (let ((knots-exn + (make-knots-exception stack))) + (raise-exception + (make-exception + knots-exn + exn)))) (result (apply values result))) responses))) @@ -234,21 +245,22 @@ (get-message channel)))) (put-message reply-channel - (with-exception-handler - (lambda (exn) - (cons 'exception exn)) - (lambda () - (with-throw-handler #t - (lambda () - (call-with-values - (lambda () - (apply proc args)) - (lambda vals - (cons 'result vals)))) - (lambda args - (when (apply show-backtrace? args) - (backtrace))))) - #:unwind? #t))))) + (call-with-escape-continuation + (lambda (return) + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (return (list 'exception exn stack)))))) + (lambda () + (call-with-values + (lambda () + (start-stack #t (apply proc args))) + (lambda vals + (cons 'result vals))))))))))) #:parallel? #t)) (iota parallelism)) @@ -257,4 +269,10 @@ (put-message channel (cons reply-channel args)) (match (get-message reply-channel) (('result . vals) (apply values vals)) - (('exception . exn) (raise-exception exn))))))) + (('exception exn stack) + (let ((knots-exn + (make-knots-exception stack))) + (raise-exception + (make-exception + knots-exn + exn))))))))) diff --git a/knots/web-server.scm b/knots/web-server.scm index 3a5bb5e..a0d2412 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -35,6 +35,7 @@ #:use-module (web http) #:use-module (web request) #:use-module (web response) + #:use-module (knots) #:use-module (knots timeout) #:use-module (knots non-blocking) #:export (run-knots-web-server @@ -203,8 +204,7 @@ on the procedure being called at any particular time." #f) (define (default-exception-handler exn request) - (let* ((stack (make-stack #t)) - (error-string + (let* ((error-string (call-with-output-string (lambda (port) (simple-format @@ -212,12 +212,9 @@ on the procedure being called at any particular time." "exception when processing: ~A ~A\n" (request-method request) (uri-path (request-uri request))) - (display-backtrace stack port 4) - (print-exception - port - (stack-ref stack 4) - '%exception - (list exn)))))) + (print-backtrace-and-exception/knots + exn + #:port port))))) (display error-string (current-error-port))) From aadbee0d0e452670719d030e5a40ff115ba10c68 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 4 Feb 2025 11:13:15 +0000 Subject: [PATCH 035/112] Improve handling of idle resources in the resource pool --- knots/resource-pool.scm | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index de03f50..fddbb60 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -79,7 +79,7 @@ port))) (define* (make-resource-pool return-new-resource max-size - #:key (min-size max-size) + #:key (min-size 0) (idle-seconds #f) (delay-logger (const #f)) (duration-logger (const #f)) @@ -375,7 +375,7 @@ (/ (- (get-internal-real-time) internal-time) internal-time-units-per-second)) resources-last-used)) - (resources-to-destroy + (candidate-resources-to-destroy (filter-map (lambda (resource last-used-seconds) (if (and (member resource available) @@ -385,16 +385,28 @@ resources resources-last-used-seconds))) - (when destructor - (for-each - (lambda (resource) - (spawn-fiber-to-destroy-resource resource)) - resources-to-destroy)) + (let* ((available-resources-to-destroy + (lset-intersection eq? + available + candidate-resources-to-destroy)) + (max-resources-to-destroy + (max 0 + (- (length resources) + min-size))) + (resources-to-destroy + (take available-resources-to-destroy + (min max-resources-to-destroy + (length available-resources-to-destroy))))) + (when destructor + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + resources-to-destroy)) - (loop resources - (lset-difference eq? available resources-to-destroy) - waiters - resources-last-used))) + (loop resources + (lset-difference eq? available resources-to-destroy) + waiters + resources-last-used)))) (('destroy reply) (if (null? resources) From a11cd24e57ad334c26700691dca0164f410cc392 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 4 Feb 2025 12:52:12 +0000 Subject: [PATCH 036/112] Improve resource pool performance when there are lots of waiters --- knots/resource-pool.scm | 319 +++++++++++++++++++++++----------------- tests/resource-pool.scm | 40 ++++- 2 files changed, 221 insertions(+), 138 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index fddbb60..8f7bcc9 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -29,6 +29,7 @@ #:use-module (fibers channels) #:use-module (fibers scheduler) #:use-module (fibers operations) + #:use-module (knots) #:use-module (knots parallelism) #:export (resource-pool? @@ -38,9 +39,6 @@ resource-pool-configuration destroy-resource-pool - resource-pool-default-timeout - resource-pool-retry-checkout-timeout - &resource-pool-timeout resource-pool-timeout-error-pool resource-pool-timeout-error? @@ -87,8 +85,9 @@ lifetime scheduler (name "unnamed") - (reply-timeout 0.5) - (add-resources-parallelism 1)) + (reply-timeout 1) + (add-resources-parallelism 1) + default-checkout-timeout) (define channel (make-channel)) (define pool @@ -104,7 +103,8 @@ (lifetime . ,lifetime) (scheduler . ,scheduler) (name . ,name) - (reply-timeout . ,reply-timeout)))) + (reply-timeout . ,reply-timeout) + (default-checkout-timeout . ,default-checkout-timeout)))) (define checkout-failure-count 0) @@ -232,23 +232,38 @@ (cons (get-internal-real-time) resources-last-used)) - (begin - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a new - ;; fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout (last waiters) - resource) - (put-message (last waiters) resource)) + (let* ((current-internal-time (get-internal-real-time)) + (alive-waiters + dead-waiters + (partition! + (match-lambda + ((reply . timeout) + (or (not timeout) + (> timeout current-internal-time)))) + waiters))) + (if (null? alive-waiters) + (loop (cons resource resources) + (cons resource available) + '() + (cons (get-internal-real-time) + resources-last-used)) + (begin + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout (car (last alive-waiters)) + resource) + (put-message (car (last alive-waiters)) resource)) - (loop (cons resource resources) - available - (drop-right! waiters 1) - (cons (get-internal-real-time) - resources-last-used)))))) + (loop (cons resource resources) + available + (drop-right! alive-waiters 1) + (cons (get-internal-real-time) + resources-last-used)))))))) - (('checkout reply) + (('checkout reply timeout-time) (if (null? available) (begin (unless (= (length resources) max-size) @@ -256,22 +271,31 @@ (loop resources available - (cons reply waiters) + (cons (cons reply timeout-time) + waiters) resources-last-used)) - (let ((resource (car available))) - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout reply resource) - (put-message reply resource)) + ;; If this client is still waiting + (if (> timeout-time + (get-internal-real-time)) + (let ((resource (car available))) + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout reply + resource) + (put-message reply resource)) - (loop resources - (cdr available) - waiters - resources-last-used)))) + (loop resources + (cdr available) + waiters + resources-last-used)) + (loop resources + available + waiters + resources-last-used)))) (((and (or 'return 'return-failed-checkout) @@ -296,27 +320,49 @@ (get-internal-real-time)) resources-last-used)) - (begin - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a new - ;; fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout (last waiters) - resource) - (put-message (last waiters) resource)) + (let* ((current-internal-time (get-internal-real-time)) + (alive-waiters + dead-waiters + (partition! + (match-lambda + ((reply . timeout) + (or (not timeout) + (> timeout current-internal-time)))) + waiters))) + (if (null? alive-waiters) + (loop resources + (cons resource available) + '() + (begin + (when (eq? return-type 'return) + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time))) + resources-last-used)) + (begin + (if reply-timeout + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout (car (last alive-waiters)) + resource) + (put-message (car (last alive-waiters)) resource)) - (loop resources - available - (drop-right! waiters 1) - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used))))) + (loop resources + available + (drop-right! alive-waiters 1) + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used))))))) (('remove resource) (let ((index @@ -359,8 +405,8 @@ (wrap-operation (put-operation reply stats) (const #t)) - (wrap-operation (sleep-operation - reply-timeout) + (wrap-operation (sleep-operation (or reply-timeout + 5)) (const #f))))))) (loop resources @@ -495,12 +541,6 @@ (unless (eq? msg 'destroy-success) (error msg))))) -(define resource-pool-default-timeout - (make-parameter #f)) - -(define resource-pool-retry-checkout-timeout - (make-parameter 5)) - (define &resource-pool-timeout (make-exception-type '&recource-pool-timeout &error @@ -526,87 +566,104 @@ "Call PROC with a resource from POOL, blocking until a resource becomes available. Return the resource once PROC has returned." - (define retry-timeout - (resource-pool-retry-checkout-timeout)) - (define timeout-or-default (if (eq? timeout 'default) - (resource-pool-default-timeout) + (assq-ref (resource-pool-configuration pool) + 'default-checkout-timeout) timeout)) - (let ((resource - (let ((reply (make-channel))) - (let loop ((start-time (get-internal-real-time))) - (let ((request-success? - (perform-operation - (choice-operation - (wrap-operation - (put-operation (resource-pool-channel pool) - `(checkout ,reply)) - (const #t)) - (wrap-operation (sleep-operation (or timeout-or-default - retry-timeout)) - (const #f)))))) - (if request-success? - (let ((time-remaining - (- (or timeout-or-default - retry-timeout) - (/ (- (get-internal-real-time) - start-time) - internal-time-units-per-second)))) - (if (> time-remaining 0) - (let ((response - (perform-operation - (choice-operation - (get-operation reply) - (wrap-operation (sleep-operation time-remaining) - (const #f)))))) - (if (or (not response) - (eq? response 'resource-pool-retry-checkout)) - (if (> (- (or timeout-or-default - retry-timeout) - (/ (- (get-internal-real-time) - start-time) - internal-time-units-per-second)) - 0) - (loop start-time) - (if (eq? timeout-or-default #f) - (loop (get-internal-real-time)) - #f)) - response)) - (if (eq? timeout-or-default #f) - (loop (get-internal-real-time)) - #f))) - (if (eq? timeout-or-default #f) - (loop (get-internal-real-time)) - #f))))))) + (define resource-pool-reply-timeout + (assq-ref (resource-pool-configuration pool) + 'reply-timeout)) - (when (or (not resource) - (eq? resource 'resource-pool-retry-checkout)) + (let ((resource + (if timeout-or-default + (let loop ((reply (make-channel)) + (start-time (get-internal-real-time))) + (let ((request-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation (resource-pool-channel pool) + (list 'checkout + reply + (+ start-time + (* timeout-or-default + internal-time-units-per-second)))) + (const #t)) + (wrap-operation (sleep-operation timeout-or-default) + (const #f)))))) + (if request-success? + (let ((time-remaining + (- timeout-or-default + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second)))) + (if (> time-remaining 0) + (let ((response + (perform-operation + (choice-operation + (get-operation reply) + (wrap-operation (sleep-operation time-remaining) + (const #f)))))) + (if (or (not response) + (eq? response 'resource-pool-retry-checkout)) + (if (> (- timeout-or-default + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second)) + 0) + (loop (make-channel) + start-time) + #f) + response)) + #f))))) + (let loop ((reply (make-channel))) + (put-message (resource-pool-channel pool) + (list 'checkout + reply + (if resource-pool-reply-timeout + (+ (get-internal-real-time) + (* resource-pool-reply-timeout + internal-time-units-per-second)) + #f))) + (if resource-pool-reply-timeout + (let ((resource-or-timeout + (perform-operation + (choice-operation + (get-operation reply) + (wrap-operation + (sleep-operation resource-pool-reply-timeout) + (const 'resource-pool-reply-timeout)))))) + (if (or (eq? resource-or-timeout + 'resource-pool-reply-timeout) + (eq? resource-or-timeout + 'resource-pool-retry-checkout)) + (loop (make-channel)) + resource-or-timeout)) + (get-message reply)))))) + + (when (not resource) (when timeout-handler (timeout-handler pool proc timeout)) (raise-exception (make-resource-pool-timeout-error pool))) - (with-exception-handler - (lambda (exception) - (put-message (resource-pool-channel pool) - `(return ,resource)) - (raise-exception exception)) - (lambda () - (call-with-values + (call-with-values + (lambda () + (with-exception-handler + (lambda (exn) + (print-backtrace-and-exception/knots exn) + (put-message (resource-pool-channel pool) + `(return ,resource)) + (raise-exception exn)) (lambda () - (with-throw-handler #t - (lambda () - (proc resource)) - (lambda _ - (backtrace)))) - (lambda vals - (put-message (resource-pool-channel pool) - `(return ,resource)) - (apply values vals)))) - #:unwind? #t))) + (proc resource)))) + (lambda vals + (put-message (resource-pool-channel pool) + `(return ,resource)) + (apply values vals))))) (define-syntax-rule (with-resource-from-pool pool resource exp ...) (call-with-resource-from-pool diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index 50dadbd..cf108de 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -105,15 +105,41 @@ (error "collision detected"))) (new-number)) 1))) - (fibers-for-each + (fibers-batch-for-each (lambda _ (with-resource-from-pool - resource-pool res - (let ((start-val counter)) - (sleep 0.05) - (if (= start-val counter) - (set! counter (+ 1 counter)) - (error "collision detected"))))) + resource-pool res + (let ((start-val counter)) + (sleep 0.05) + (if (= start-val counter) + (set! counter (+ 1 counter)) + (error "collision detected"))))) + 20 + (iota 50))))) + +(run-fibers-for-tests + (lambda () + (let* ((counter 0) + (resource-pool (make-resource-pool + (lambda () + (let ((start-val counter)) + (sleep 0.05) + (if (= start-val counter) + (set! counter (+ 1 counter)) + (error "collision detected"))) + (new-number)) + 1 + #:reply-timeout #f))) + (fibers-batch-for-each + (lambda _ + (with-resource-from-pool + resource-pool res + (let ((start-val counter)) + (sleep 0.05) + (if (= start-val counter) + (set! counter (+ 1 counter)) + (error "collision detected"))))) + 20 (iota 50))))) (display "resource-pool test finished successfully\n") From 6337103525d482c3ed844e37724b44269d2b45dc Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 4 Feb 2025 13:12:57 +0000 Subject: [PATCH 037/112] Remove the resource pool reply timeout By being smarter about how long to wait for replies. --- knots/resource-pool.scm | 160 ++++++++++++++++++++-------------------- tests/resource-pool.scm | 2 +- 2 files changed, 81 insertions(+), 81 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 8f7bcc9..8bfef2b 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -85,7 +85,6 @@ lifetime scheduler (name "unnamed") - (reply-timeout 1) (add-resources-parallelism 1) default-checkout-timeout) (define channel (make-channel)) @@ -103,7 +102,6 @@ (lifetime . ,lifetime) (scheduler . ,scheduler) (name . ,name) - (reply-timeout . ,reply-timeout) (default-checkout-timeout . ,default-checkout-timeout)))) (define checkout-failure-count 0) @@ -183,7 +181,9 @@ (loop)))))))) - (define (spawn-fiber-for-checkout reply-channel resource) + (define (spawn-fiber-for-checkout reply-channel + reply-timeout + resource) (spawn-fiber (lambda () (let ((checkout-success? @@ -247,21 +247,27 @@ '() (cons (get-internal-real-time) resources-last-used)) - (begin - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a new - ;; fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout (car (last alive-waiters)) - resource) - (put-message (car (last alive-waiters)) resource)) + (match (last alive-waiters) + ((waiter-channel . waiter-timeout) + (if waiter-timeout + (let ((reply-timeout + (/ (- waiter-timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn + ;; a new fiber to handle handing over + ;; the resource, and returning it if + ;; there's a timeout + (spawn-fiber-for-checkout waiter-channel + reply-timeout + resource)) + (put-message waiter-channel resource)) - (loop (cons resource resources) - available - (drop-right! alive-waiters 1) - (cons (get-internal-real-time) - resources-last-used)))))))) + (loop (cons resource resources) + available + (drop-right! alive-waiters 1) + (cons (get-internal-real-time) + resources-last-used))))))))) (('checkout reply timeout-time) (if (null? available) @@ -275,27 +281,38 @@ waiters) resources-last-used)) - ;; If this client is still waiting - (if (> timeout-time - (get-internal-real-time)) - (let ((resource (car available))) - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout reply - resource) - (put-message reply resource)) + (if timeout-time + (let ((current-internal-time + (get-internal-real-time))) + ;; If this client is still waiting + (if (> timeout-time + current-internal-time) + (let ((reply-timeout + (/ (- timeout-time + current-internal-time) + internal-time-units-per-second))) + + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the resource, + ;; and returning it if there's a timeout + (spawn-fiber-for-checkout reply + reply-timeout + (car available)) + (loop resources + (cdr available) + waiters + resources-last-used)) + (loop resources + available + waiters + resources-last-used))) + (begin + (put-message reply (car available)) (loop resources (cdr available) waiters - resources-last-used)) - (loop resources - available - waiters - resources-last-used)))) + resources-last-used))))) (((and (or 'return 'return-failed-checkout) @@ -342,27 +359,33 @@ resources) (get-internal-real-time))) resources-last-used)) - (begin - (if reply-timeout - ;; Don't sleep in this fiber, so spawn a new - ;; fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout (car (last alive-waiters)) - resource) - (put-message (car (last alive-waiters)) resource)) + (match (last alive-waiters) + ((waiter-channel . waiter-timeout) + (if waiter-timeout + (let ((reply-timeout + (/ (- waiter-timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout waiter-channel + reply-timeout + resource)) + (put-message waiter-channel resource)) - (loop resources - available - (drop-right! alive-waiters 1) - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used))))))) + (loop resources + available + (drop-right! alive-waiters 1) + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used)))))))) (('remove resource) (let ((index @@ -405,8 +428,7 @@ (wrap-operation (put-operation reply stats) (const #t)) - (wrap-operation (sleep-operation (or reply-timeout - 5)) + (wrap-operation (sleep-operation 5) (const #f))))))) (loop resources @@ -572,10 +594,6 @@ available. Return the resource once PROC has returned." 'default-checkout-timeout) timeout)) - (define resource-pool-reply-timeout - (assq-ref (resource-pool-configuration pool) - 'reply-timeout)) - (let ((resource (if timeout-or-default (let loop ((reply (make-channel)) @@ -622,26 +640,8 @@ available. Return the resource once PROC has returned." (put-message (resource-pool-channel pool) (list 'checkout reply - (if resource-pool-reply-timeout - (+ (get-internal-real-time) - (* resource-pool-reply-timeout - internal-time-units-per-second)) - #f))) - (if resource-pool-reply-timeout - (let ((resource-or-timeout - (perform-operation - (choice-operation - (get-operation reply) - (wrap-operation - (sleep-operation resource-pool-reply-timeout) - (const 'resource-pool-reply-timeout)))))) - (if (or (eq? resource-or-timeout - 'resource-pool-reply-timeout) - (eq? resource-or-timeout - 'resource-pool-retry-checkout)) - (loop (make-channel)) - resource-or-timeout)) - (get-message reply)))))) + #f)) + (get-message reply))))) (when (not resource) (when timeout-handler diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index cf108de..1251429 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -129,7 +129,7 @@ (error "collision detected"))) (new-number)) 1 - #:reply-timeout #f))) + #:default-checkout-timeout 120))) (fibers-batch-for-each (lambda _ (with-resource-from-pool From 7de5901a948685c4b98081425a18a5ff0121d413 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 6 Feb 2025 16:45:22 +0000 Subject: [PATCH 038/112] Simplify exception handling in the web server --- knots/web-server.scm | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index a0d2412..7ed65c5 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -305,21 +305,7 @@ on the procedure being called at any particular time." (lambda () (with-exception-handler (lambda (exn) - (let* ((stack (make-stack #t)) - (error-string - (call-with-output-string - (lambda (port) - (print-exception - port - (stack-ref stack 2) - '%exception - (list exn)) - (display-backtrace - stack - port - 2))))) - (display error-string - (current-error-port))) + (print-backtrace-and-exception/knots exn) (raise-exception exn)) (lambda () (body body-port))) From b0d8618705c91be015d1d88baa9610f4cb8fc69c Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 6 Feb 2025 17:02:54 +0000 Subject: [PATCH 039/112] Fix exception handling for fibers-batch-map --- knots/parallelism.scm | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 99f41b3..41ae676 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -118,8 +118,13 @@ (vector-ref result-vec index)) (lambda (result) (match result - (('exception . exn) - (raise-exception exn)) + (('exception exn stack) + (let ((knots-exn + (make-knots-exception stack))) + (raise-exception + (make-exception + knots-exn + exn)))) (_ (vector-set! result-vec index From 025449ea0d0f8e4742e6a96a5eacecf514c4002c Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 7 Feb 2025 10:43:24 +0000 Subject: [PATCH 040/112] Remove the fiberize show-backtrace? option This is no longer relevant now that the stack is added to the compound exception. --- knots/parallelism.scm | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 41ae676..fc3d039 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -238,8 +238,7 @@ #f)))) channels-to-results)))))))) -(define* (fiberize proc #:key (parallelism 1) - (show-backtrace? (const #t))) +(define* (fiberize proc #:key (parallelism 1)) (let ((channel (make-channel))) (for-each (lambda _ From 19c1fe235ba70e95c2efe356995dafd2dc3ccc67 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 7 Feb 2025 10:48:50 +0000 Subject: [PATCH 041/112] Allow customising the web server read request exception handler --- knots/web-server.scm | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 7ed65c5..6e57b12 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -195,6 +195,16 @@ on the procedure being called at any particular time." ((0) (memq 'keep-alive (response-connection response))))) (else #f))))) +(define (default-read-request-exception-handler exn) + (display "While reading request:\n" (current-error-port)) + (print-exception + (current-error-port) + #f + '%exception + (list exn)) + + #f) + (define (default-write-response-exception-handler exn request) (simple-format (current-error-port) @@ -224,16 +234,15 @@ on the procedure being called at any particular time." "internal server error"))) (define (handle-request handler client + read-request-exception-handler write-response-exception-handler exception-handler) (let ((request - (catch #t + (with-exception-handler + read-request-exception-handler (lambda () (read-request client)) - (lambda (key . args) - (display "While reading request:\n" (current-error-port)) - (print-exception (current-error-port) #f key args) - #f)))) + #:unwind? #t))) (let ((response body (cond @@ -328,6 +337,7 @@ on the procedure being called at any particular time." (define* (client-loop client handler exception-handler + read-request-exception-handler write-response-exception-handler connection-idle-timeout buffer-size) @@ -357,6 +367,7 @@ on the procedure being called at any particular time." (close-port client)) (else (let ((keep-alive? (handle-request handler client + read-request-exception-handler write-response-exception-handler exception-handler))) (if keep-alive? @@ -381,6 +392,8 @@ on the procedure being called at any particular time." (socket (make-default-socket family addr port)) (exception-handler default-exception-handler) + (read-request-exception-handler + default-read-request-exception-handler) (write-response-exception-handler default-write-response-exception-handler) (connection-idle-timeout 60) @@ -418,6 +431,7 @@ before sending back to the client." (spawn-fiber (lambda () (client-loop client handler exception-handler + read-request-exception-handler write-response-exception-handler connection-idle-timeout connection-buffer-size)) From b0bb65dbedc35ea885579fe43a8b3b7059417dd0 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 7 Feb 2025 10:54:59 +0000 Subject: [PATCH 042/112] Tweak some web server exception handling --- knots/web-server.scm | 111 ++++++++++++++++++++----------------------- 1 file changed, 51 insertions(+), 60 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 6e57b12..463578c 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -252,37 +252,32 @@ on the procedure being called at any particular time." #:headers '((content-length . 0))) #vu8())) (else - (call-with-values - (lambda () - (call-with-escape-continuation - (lambda (return) - (with-exception-handler - (lambda (exn) - (call-with-values - (lambda () - (exception-handler exn request)) - return)) - (lambda () - (start-stack #t (handler request))))))) - (match-lambda* - ((response body) - (sanitize-response request response body)) - (other - (let ((stack (make-stack #t)) - (exception - (make-exception-with-irritants - (list (make-exception-with-message - (simple-format - #f - "wrong number of values returned from handler, expecting 2, got ~A" - (length other))) - handler)))) - (print-exception - (current-error-port) - (stack-ref stack 2) - '%exception - (list exception)) - (raise-exception exception))))))))) + (call-with-escape-continuation + (lambda (return) + (with-exception-handler + (lambda (exn) + (call-with-values + (lambda () + (exception-handler exn request)) + return)) + (lambda () + (start-stack + #t + (call-with-values + (lambda () + (handler request)) + (match-lambda* + ((response body) + (sanitize-response request response body)) + (other + (raise-exception + (make-exception-with-irritants + (list (make-exception-with-message + (simple-format + #f + "wrong number of values returned from handler, expecting 2, got ~A" + (length other))) + handler))))))))))))))) (with-exception-handler (lambda (exn) (write-response-exception-handler exn request)) @@ -346,35 +341,31 @@ on the procedure being called at any particular time." ;; out. (setvbuf client 'block buffer-size) (setsockopt client IPPROTO_TCP TCP_NODELAY 1) - (with-throw-handler #t - (lambda () - (let loop () - (cond - ((catch #t - (lambda () - (or - (if (eq? #f connection-idle-timeout) - #f - (perform-operation - (choice-operation (wrap-operation - (wait-until-port-readable-operation client) - (const #f)) - (wrap-operation - (sleep-operation connection-idle-timeout) - (const #t))))) - (eof-object? (lookahead-u8 client)))) - (lambda _ #t)) - (close-port client)) - (else - (let ((keep-alive? (handle-request handler client - read-request-exception-handler - write-response-exception-handler - exception-handler))) - (if keep-alive? - (loop) - (close-port client))))))) - (lambda (k . args) - (close-port client)))) + (let loop () + (cond + ((with-exception-handler + (lambda _ #t) + (lambda () + (or + (if (eq? #f connection-idle-timeout) + #f + (perform-operation + (choice-operation (wrap-operation + (wait-until-port-readable-operation client) + (const #f)) + (wrap-operation + (sleep-operation connection-idle-timeout) + (const #t))))) + (eof-object? (lookahead-u8 client))))) + (close-port client)) + (else + (let ((keep-alive? (handle-request handler client + read-request-exception-handler + write-response-exception-handler + exception-handler))) + (if keep-alive? + (loop) + (close-port client))))))) (define-record-type (make-web-server socket port) From cb2085b6848d25f71f90103abb919ea7914c606e Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 7 Feb 2025 16:09:42 +0000 Subject: [PATCH 043/112] Make more web server encoding tweaks --- knots/web-server.scm | 17 +++++------------ tests/web-server.scm | 28 ++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 12 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 463578c..cc47284 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -57,8 +57,7 @@ sock)) (define* (make-chunked-output-port/knots port #:key (keep-alive? #f) - (buffering 1200) - (encoding "ISO-8859-1")) + (buffering 1200)) "Returns a new port which translates non-encoded data into a HTTP chunked transfer encoded data and writes this to PORT. Data written to this port is buffered until the port is flushed, at which point it is @@ -83,7 +82,6 @@ KEEP-ALIVE? is true." (define ret (make-custom-binary-output-port "chunked http" write! #f #f close)) - (set-port-encoding! ret encoding) (setvbuf ret 'block buffering) ret) @@ -284,10 +282,7 @@ on the procedure being called at any particular time." (lambda () (write-response response client) - (let* ((change-client-port-encoding? - (and (procedure? body) - (not (response-content-length response)))) - (body-written? + (let ((body-written? (if (procedure? body) (let* ((type (response-content-type response '(text/plain))) @@ -298,10 +293,8 @@ on the procedure being called at any particular time." client (make-chunked-output-port/knots client - #:keep-alive? #t - #:encoding charset)))) - (when change-client-port-encoding? - (set-port-encoding! client charset)) + #:keep-alive? #t)))) + (set-port-encoding! body-port charset) (let ((body-written? (with-exception-handler (lambda (exn) @@ -324,7 +317,7 @@ on the procedure being called at any particular time." (if body-written? (begin (force-output client) - (when change-client-port-encoding? + (when (procedure? body) (set-port-encoding! client "ISO-8859-1")) (keep-alive? response)) #f))) diff --git a/tests/web-server.scm b/tests/web-server.scm index 21d90f9..74f81ea 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -81,6 +81,34 @@ "☺" body))))) +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + (values '((content-type . (text/plain + (charset . "utf-8"))) + (content-length . 3)) + (lambda (port) + (display "☺" port)))) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (let ((response + body + (http-get + uri + ;; TODO Remove once using Guile 3.0.10 + #:streaming? #t + #:port (non-blocking-open-socket-for-uri uri)))) + (assert-equal + "☺" + (utf8->string + (get-bytevector-n body 3))))))) + ;; Test hanlding of exceptions when writing the response to a client (run-fibers-for-tests (lambda () From ee2a93fbcac71f38a1ae92ef015a842c35228bf5 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 7 Feb 2025 17:02:37 +0000 Subject: [PATCH 044/112] Avoid needlessly setting the encoding --- knots/web-server.scm | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index cc47284..2482a79 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -317,7 +317,8 @@ on the procedure being called at any particular time." (if body-written? (begin (force-output client) - (when (procedure? body) + (when (and (procedure? body) + (response-content-length response)) (set-port-encoding! client "ISO-8859-1")) (keep-alive? response)) #f))) From 6c083bdebd96fa6c8f5ee2d28b0c291fd9c6fe72 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 10 Feb 2025 15:13:30 +0000 Subject: [PATCH 045/112] Use default io waiters in the thread pool To allow creating thread pools from fibers. --- knots/thread-pool.scm | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 24260cd..9f3dd2d 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -32,6 +32,7 @@ #:use-module (fibers timers) #:use-module (fibers channels) #:use-module (fibers operations) + #:use-module (knots) #:export (set-thread-name thread-name @@ -161,7 +162,8 @@ from there, or #f if that would be an empty string." thread-lifetime (log-exception? (const #t)) (expire-on-exception? #f) - (name "unnamed")) + (name "unnamed") + (use-default-io-waiters? #t)) "Return a channel used to offload work to a dedicated thread. ARGS are the arguments of the thread pool procedure." (define param @@ -293,7 +295,7 @@ arguments of the thread pool procedure." #f))) (loop #f)))))) - (let ((channel (make-channel))) + (define (start-threads channel) (for-each (lambda (thread-index) (call-with-new-thread @@ -323,7 +325,14 @@ arguments of the thread pool procedure." (destructor/safe args)) (init (initializer/safe)))))) - (iota size)) + (iota size))) + + (let ((channel (make-channel))) + (if use-default-io-waiters? + (call-with-default-io-waiters + (lambda () + (start-threads channel))) + (start-threads channel)) (thread-pool channel param From d597b77fcb4eb1f776e84337d7086e9e7a729abd Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 10 Feb 2025 15:16:37 +0000 Subject: [PATCH 046/112] Use the thread-pool record for the default timeout Rather than a parameter. --- knots/thread-pool.scm | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 9f3dd2d..69010c6 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -151,7 +151,9 @@ from there, or #f if that would be an empty string." thread-pool? (channel thread-pool-channel) (arguments-parameter thread-pool-arguments-parameter) - (proc-vector thread-pool-proc-vector)) + (proc-vector thread-pool-proc-vector) + (default-checkout-timeout + thread-pool-default-checkout-timeout)) (define* (make-thread-pool size #:key @@ -163,7 +165,8 @@ from there, or #f if that would be an empty string." (log-exception? (const #t)) (expire-on-exception? #f) (name "unnamed") - (use-default-io-waiters? #t)) + (use-default-io-waiters? #t) + default-checkout-timeout) "Return a channel used to offload work to a dedicated thread. ARGS are the arguments of the thread pool procedure." (define param @@ -349,11 +352,9 @@ arguments of the thread pool procedure." (define thread-pool-timeout-error? (record-predicate &thread-pool-timeout)) -(define %thread-pool-default-timeout - (make-parameter 30)) - (define* (call-with-thread record proc #:key duration-logger - (timeout (%thread-pool-default-timeout)) + (timeout (thread-pool-default-checkout-timeout + record)) (channel (thread-pool-channel record))) "Send PROC to the thread pool through CHANNEL. Return the result of PROC. If already in the thread pool, call PROC immediately." From ca3d5a17810c8f6e30e182c60dd31328ee38941d Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 19 Feb 2025 12:44:47 +0000 Subject: [PATCH 047/112] Fix handling of client-loop exceptions Maybe other things can go wrong here, so log so that there's some information available. --- knots/web-server.scm | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 2482a79..ab16b80 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -338,7 +338,18 @@ on the procedure being called at any particular time." (let loop () (cond ((with-exception-handler - (lambda _ #t) + (lambda (exn) + (unless (and (exception-with-origin? exn) + (string=? (exception-origin exn) + "fport_write")) + (display "knots web-server, exception in client loop:\n" + (current-error-port)) + (print-exception + (current-error-port) + #f + '%exception + (list exn))) + #t) (lambda () (or (if (eq? #f connection-idle-timeout) @@ -350,7 +361,8 @@ on the procedure being called at any particular time." (wrap-operation (sleep-operation connection-idle-timeout) (const #t))))) - (eof-object? (lookahead-u8 client))))) + (eof-object? (lookahead-u8 client)))) + #:unwind? #t) (close-port client)) (else (let ((keep-alive? (handle-request handler client From 99245034ea4b138a617191981b01784f1f29092a Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 19 Feb 2025 12:46:51 +0000 Subject: [PATCH 048/112] Allow passing custom channels to fiberize This allows customising the behevaiour, for example by using a queue. --- knots/parallelism.scm | 84 ++++++++++++++++++++++--------------------- 1 file changed, 43 insertions(+), 41 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index fc3d039..1210c19 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -238,45 +238,47 @@ #f)))) channels-to-results)))))))) -(define* (fiberize proc #:key (parallelism 1)) - (let ((channel (make-channel))) - (for-each - (lambda _ - (spawn-fiber - (lambda () - (while #t - (let ((reply-channel args (car+cdr - (get-message channel)))) - (put-message - reply-channel - (call-with-escape-continuation - (lambda (return) - (with-exception-handler - (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (return (list 'exception exn stack)))))) - (lambda () - (call-with-values - (lambda () - (start-stack #t (apply proc args))) - (lambda vals - (cons 'result vals))))))))))) - #:parallel? #t)) - (iota parallelism)) +(define* (fiberize proc + #:key (parallelism 1) + (input-channel (make-channel)) + (process-channel input-channel)) + (for-each + (lambda _ + (spawn-fiber + (lambda () + (while #t + (let ((reply-channel args (car+cdr + (get-message process-channel)))) + (put-message + reply-channel + (call-with-escape-continuation + (lambda (return) + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (return (list 'exception exn stack)))))) + (lambda () + (call-with-values + (lambda () + (start-stack #t (apply proc args))) + (lambda vals + (cons 'result vals))))))))))) + #:parallel? #t)) + (iota parallelism)) - (lambda args - (let ((reply-channel (make-channel))) - (put-message channel (cons reply-channel args)) - (match (get-message reply-channel) - (('result . vals) (apply values vals)) - (('exception exn stack) - (let ((knots-exn - (make-knots-exception stack))) - (raise-exception - (make-exception - knots-exn - exn))))))))) + (lambda args + (let ((reply-channel (make-channel))) + (put-message input-channel (cons reply-channel args)) + (match (get-message reply-channel) + (('result . vals) (apply values vals)) + (('exception exn stack) + (let ((knots-exn + (make-knots-exception stack))) + (raise-exception + (make-exception + knots-exn + exn)))))))) From 1fbd1f334a456eb50b68b6b33bb91442f6bbe02c Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 19 Feb 2025 17:34:45 +0000 Subject: [PATCH 049/112] Fix exception origin in the knots web server --- knots/web-server.scm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index ab16b80..ea53ba2 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -341,7 +341,7 @@ on the procedure being called at any particular time." (lambda (exn) (unless (and (exception-with-origin? exn) (string=? (exception-origin exn) - "fport_write")) + "fport_read")) (display "knots web-server, exception in client loop:\n" (current-error-port)) (print-exception From 239cb88f93cee37aefd88f30041f5d13a0edc99f Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 20 Feb 2025 13:42:12 +0000 Subject: [PATCH 050/112] Rework handling connection persistance in the web server Change to setting the connection header in the response based on the request, and then closing the connection in the server based on the response headers. Stop closing the response based on the response code, as I don't know why this is necessary. --- knots/web-server.scm | 64 +++++++++++++++++++++++++++----------------- 1 file changed, 40 insertions(+), 24 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index ea53ba2..123763d 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -95,6 +95,25 @@ KEEP-ALIVE? is true." r (apply extend-response r additional)))) +(define (response-maybe-add-connection-header-value request response) + (if (memq 'close (response-connection response)) + ;; Nothing to do + response + (let* ((v (request-version request)) + (add-close-header? + (case (car v) + ((1) + (case (cdr v) + ((1) (memq 'close (request-connection request))) + ((0) (not (memq 'keep-alive (request-connection request)))))) + (else #t)))) + (if add-close-header? + (extend-response response 'connection '(close)) + (if (and (= 1 (car v)) + (= 0 (cdr v))) + (extend-response response 'connection '(keep-alive)) + response))))) + ;; -> response body (define (sanitize-response request response body) "\"Sanitize\" the given response and body, making them appropriate for @@ -155,19 +174,21 @@ on the procedure being called at any particular time." response)))) (else ;; check length; assert type; add other required fields? - (values (if (procedure? body) - (if (response-content-length response) - response - (extend-response response - 'transfer-encoding - '((chunked)))) - (let ((rlen (response-content-length response)) - (blen (bytevector-length body))) - (cond - (rlen (if (= rlen blen) - response - (error "bad content-length" rlen blen))) - (else (extend-response response 'content-length blen))))) + (values (response-maybe-add-connection-header-value + request + (if (procedure? body) + (if (response-content-length response) + response + (extend-response response + 'transfer-encoding + '((chunked)))) + (let ((rlen (response-content-length response)) + (blen (bytevector-length body))) + (cond + (rlen (if (= rlen blen) + response + (error "bad content-length" rlen blen))) + (else (extend-response response 'content-length blen)))))) (if (eq? (request-method request) 'HEAD) (raise-exception (make-exception-with-irritants @@ -183,15 +204,7 @@ on the procedure being called at any particular time." (with-stack-and-prompt (lambda () (proc k)))))) (define (keep-alive? response) - (let ((v (response-version response))) - (and (or (< (response-code response) 400) - (= (response-code response) 404)) - (case (car v) - ((1) - (case (cdr v) - ((1) (not (memq 'close (response-connection response)))) - ((0) (memq 'keep-alive (response-connection response))))) - (else #f))))) + (not (memq 'close (response-connection response)))) (define (default-read-request-exception-handler exn) (display "While reading request:\n" (current-error-port)) @@ -246,8 +259,11 @@ on the procedure being called at any particular time." (cond ((not request) ;; Bad request. - (values (build-response #:version '(1 . 0) #:code 400 - #:headers '((content-length . 0))) + (values (build-response + #:version '(1 . 0) + #:code 400 + #:headers '((content-length . 0) + (connection . (close)))) #vu8())) (else (call-with-escape-continuation From 13f11185765b436aaa96b070b31b7b093a2122b7 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 20 Feb 2025 14:20:25 +0000 Subject: [PATCH 051/112] Use #f as the default web server connection-idle-timeout As it's not efficient yet and seems to cause excessive memory use. --- knots/web-server.scm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 123763d..0ba8fd8 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -409,7 +409,7 @@ on the procedure being called at any particular time." default-read-request-exception-handler) (write-response-exception-handler default-write-response-exception-handler) - (connection-idle-timeout 60) + (connection-idle-timeout #f) (connection-buffer-size 1024)) "Run the knots web server. From f549bee282e108bc5f68ba885a0b2ba53b82e373 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 26 Feb 2025 10:07:54 +0000 Subject: [PATCH 052/112] Improve thread pool exception logging --- knots/thread-pool.scm | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 69010c6..7c25498 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -251,7 +251,15 @@ arguments of the thread pool procedure." (vector-set! thread-proc-vector thread-index proc) - (with-throw-handler #t + (with-exception-handler + (lambda (exn) + (when (log-exception? exn) + (simple-format + (current-error-port) + "thread-pool: exception running ~A\n" proc) + (print-backtrace-and-exception/knots + exn)) + (raise-exception exn)) (lambda () (call-with-values (lambda () @@ -262,16 +270,7 @@ arguments of the thread pool procedure." (cons (/ (- (get-internal-real-time) start-time) internal-time-units-per-second) - vals)))) - (lambda args - (when (match args - (('%exception exn) - (log-exception? exn)) - (_ #t)) - (simple-format - (current-error-port) - "thread-pool: exception: ~A\n" args) - (backtrace))))) + vals)))))) #:unwind? #t))) (put-message reply response) From 60bfe0d7a3bc3402c90debc76b84ed0db93ac1f9 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 27 Feb 2025 12:07:16 +0000 Subject: [PATCH 053/112] Remove trailing whitespace --- knots/non-blocking.scm | 1 - 1 file changed, 1 deletion(-) diff --git a/knots/non-blocking.scm b/knots/non-blocking.scm index f29713a..4473b63 100644 --- a/knots/non-blocking.scm +++ b/knots/non-blocking.scm @@ -60,4 +60,3 @@ (non-blocking-port s) port) (non-blocking-port s)))) - From d8bc09755e10e492bfa8e42f510b91948e8ceb4c Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 27 Feb 2025 12:18:17 +0000 Subject: [PATCH 054/112] Fix knots-exception? --- knots.scm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/knots.scm b/knots.scm index 5d152a8..8e31c6b 100644 --- a/knots.scm +++ b/knots.scm @@ -57,7 +57,7 @@ (record-constructor &knots-exception)) (define knots-exception? - (record-predicate &knots-exception)) + (exception-predicate &knots-exception)) (define knots-exception-stack (exception-accessor From ed4113af513ea5f130e5e46d99b5d82bbd85c492 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 27 Feb 2025 12:08:41 +0000 Subject: [PATCH 055/112] Simplify and extend using the knots exception with stack --- knots/parallelism.scm | 31 ++++++++++--------------------- knots/thread-pool.scm | 18 ++++++++++-------- tests/thread-pool.scm | 18 ++++++++++++++++++ 3 files changed, 38 insertions(+), 29 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 1210c19..f9be4ff 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -52,7 +52,11 @@ (let ((stack (make-stack #t 0 prompt-tag 0 (and prompt-tag 1)))) - (put-message reply (list 'exception exn stack))))) + (put-message reply + (list 'exception + (make-exception + exn + (make-knots-exception stack))))))) (return)) (lambda () (call-with-values @@ -69,12 +73,7 @@ (map (match-lambda (('exception exn stack) - (let ((knots-exn - (make-knots-exception stack))) - (raise-exception - (make-exception - knots-exn - exn)))) + (raise-exception exn)) (result (apply values result))) responses))) @@ -118,13 +117,8 @@ (vector-ref result-vec index)) (lambda (result) (match result - (('exception exn stack) - (let ((knots-exn - (make-knots-exception stack))) - (raise-exception - (make-exception - knots-exn - exn)))) + (('exception exn) + (raise-exception exn)) (_ (vector-set! result-vec index @@ -275,10 +269,5 @@ (put-message input-channel (cons reply-channel args)) (match (get-message reply-channel) (('result . vals) (apply values vals)) - (('exception exn stack) - (let ((knots-exn - (make-knots-exception stack))) - (raise-exception - (make-exception - knots-exn - exn)))))))) + (('exception exn) + (raise-exception exn)))))) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 7c25498..3b87be1 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -253,18 +253,20 @@ arguments of the thread pool procedure." proc) (with-exception-handler (lambda (exn) - (when (log-exception? exn) - (simple-format - (current-error-port) - "thread-pool: exception running ~A\n" proc) - (print-backtrace-and-exception/knots - exn)) - (raise-exception exn)) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))))) (lambda () (call-with-values (lambda () (start-stack - 'thread-pool + #t (apply proc args))) (lambda vals (cons (/ (- (get-internal-real-time) diff --git a/tests/thread-pool.scm b/tests/thread-pool.scm index 71b4494..93a49ce 100644 --- a/tests/thread-pool.scm +++ b/tests/thread-pool.scm @@ -2,6 +2,7 @@ (srfi srfi-71) (fibers) (unit-test) + (knots) (knots thread-pool)) (let ((thread-pool @@ -41,4 +42,21 @@ (process-job 3)) +(let ((thread-pool + (make-thread-pool 2))) + + (run-fibers-for-tests + (lambda () + (assert-equal + #t + (with-exception-handler + (lambda (exn) + (knots-exception? exn)) + (lambda () + (call-with-thread + thread-pool + (lambda () + (+ 1 'a)))) + #:unwind? #t))))) + (display "thread-pool test finished successfully\n") From 21e328aebb9633211b8bb8376cdd429ab706d20c Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 27 Feb 2025 12:09:04 +0000 Subject: [PATCH 056/112] Improve exception reporting --- knots/resource-pool.scm | 32 +++++++++----------- knots/thread-pool.scm | 67 +++++++++++++++++++---------------------- tests.scm | 9 +++--- 3 files changed, 50 insertions(+), 58 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 8bfef2b..f4522be 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -129,18 +129,16 @@ (lambda () (let ((new-resource (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception adding resource to pool ~A: ~A:\n ~A\n" - name - return-new-resource - exn) - #f) + (lambda _ #f) (lambda () (with-exception-handler (lambda (exn) - (backtrace) + (simple-format + (current-error-port) + "exception adding resource to pool ~A: ~A\n\n" + name + return-new-resource) + (print-backtrace-and-exception/knots exn) (raise-exception exn)) (lambda () (start-stack #t (return-new-resource))))) @@ -155,18 +153,16 @@ (let loop () (let ((success? (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception running resource pool destructor (~A): ~A:\n ~A\n" - name - destructor - exn) - #f) + (lambda _ #f) (lambda () (with-exception-handler (lambda (exn) - (backtrace) + (simple-format + (current-error-port) + "exception running resource pool destructor (~A): ~A\n" + name + destructor) + (print-backtrace-and-exception/knots exn) (raise-exception exn)) (lambda () (start-stack #t (destructor resource)) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 3b87be1..f2f174e 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -178,19 +178,18 @@ arguments of the thread pool procedure." (define (initializer/safe) (let ((args (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception running initializer in thread pool (~A): ~A:\n ~A\n" - name - thread-initializer - exn) - #f) + (lambda _ #f) (lambda () - (with-throw-handler #t - thread-initializer - (lambda args - (backtrace)))) + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running initializer in thread pool (~A): ~A\n" + name + thread-initializer) + (print-backtrace-and-exception/knots exn) + (raise-exception exn)) + thread-initializer)) #:unwind? #t))) (if args @@ -203,21 +202,20 @@ arguments of the thread pool procedure." (define (destructor/safe args) (let ((success? (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception running destructor in thread pool (~A): ~A:\n ~A\n" - name - thread-destructor - exn) - #f) + (lambda _ #f) (lambda () - (with-throw-handler #t + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running destructor in thread pool (~A): ~A\n" + name + thread-destructor) + (print-backtrace-and-exception/knots exn) + (raise-exception exn)) (lambda () (apply thread-destructor args) - #t) - (lambda _ - (backtrace)))) + #t))) #:unwind? #t))) (or success? @@ -465,20 +463,17 @@ If already in the thread pool, call PROC immediately." (define (thread-process-job job-args) (with-exception-handler - (lambda (exn) - (simple-format (current-error-port) - "~A work queue, job raised exception ~A: ~A\n" - name job-args exn)) + (lambda _ #f) (lambda () - (with-throw-handler #t + (with-exception-handler + (lambda (exn) + (simple-format (current-error-port) + "~A work queue, job raised exception ~A\n" + name job-args) + (print-backtrace-and-exception/knots exn) + (raise-exception exn)) (lambda () - (apply proc job-args)) - (lambda (key . args) - (simple-format - (current-error-port) - "~A work queue, exception when handling job: ~A ~A\n" - name key args) - (backtrace)))) + (apply proc job-args)))) #:unwind? #t)) (define (start-thread thread-index) diff --git a/tests.scm b/tests.scm index 6c07374..2b24c6a 100644 --- a/tests.scm +++ b/tests.scm @@ -12,10 +12,11 @@ (lambda (exn) exn) (lambda () - (with-throw-handler #t - thunk - (lambda _ - (backtrace))) + (with-exception-handler + (lambda (exn) + (backtrace) + (raise-exception exn)) + thunk) #t) #:unwind? #t)) #:hz 0 From f41d1853ceb9f8d297fc756925a08f6d11d30d10 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 27 Feb 2025 13:23:06 +0000 Subject: [PATCH 057/112] Use module-ref for make-base-operation As the implementation of this changed in fibers, and that's causing issues here when mixing the version of fibers used for knots and different versions of fibers. --- knots/timeout.scm | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/knots/timeout.scm b/knots/timeout.scm index 552d079..21c2267 100644 --- a/knots/timeout.scm +++ b/knots/timeout.scm @@ -119,17 +119,19 @@ (define (make-wait-operation ready? schedule-when-ready port port-ready-fd this-procedure) - (make-base-operation #f - (lambda _ - (and (ready? port) values)) - (lambda (flag sched resume) - (define (commit) - (match (atomic-box-compare-and-swap! flag 'W 'S) - ('W (resume values)) - ('C (commit)) - ('S #f))) - (schedule-when-ready - sched (port-ready-fd port) commit)))) + ((module-ref (resolve-interface '(fibers operations)) + 'make-base-operation) + #f + (lambda _ + (and (ready? port) values)) + (lambda (flag sched resume) + (define (commit) + (match (atomic-box-compare-and-swap! flag 'W 'S) + ('W (resume values)) + ('C (commit)) + ('S #f))) + (schedule-when-ready + sched (port-ready-fd port) commit)))) (define (wait-until-port-readable-operation port) "Make an operation that will succeed when PORT is readable." From a6c96aa1daf879b089c5eb505c1858fd2e32830f Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 3 Mar 2025 10:56:36 +0000 Subject: [PATCH 058/112] Better handle the web server exception handler not returning 2 values --- knots/web-server.scm | 28 +++++++++++++++++++++++++++- tests/web-server.scm | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 1 deletion(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 0ba8fd8..4ab59e3 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -273,7 +273,33 @@ on the procedure being called at any particular time." (call-with-values (lambda () (exception-handler exn request)) - return)) + (match-lambda* + ((response body) + (call-with-values + (lambda () + (sanitize-response request response body)) + return)) + (other + (call-with-values + (lambda () + (default-exception-handler + (make-exception-with-irritants + (list (make-exception-with-message + (simple-format + #f + "wrong number of values returned from exception handler, expecting 2, got ~A" + (length other))) + exception-handler)) + request)) + (match-lambda* + ((response body) + (call-with-values + (lambda () + (sanitize-response + request + response + body)) + return)))))))) (lambda () (start-stack #t diff --git a/tests/web-server.scm b/tests/web-server.scm index 74f81ea..205d6a2 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -33,6 +33,47 @@ uri #:port (non-blocking-open-socket-for-uri uri))))))) +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + "Hello, World!") + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (assert-equal + 500 + (response-code + (http-get + uri + #:port (non-blocking-open-socket-for-uri uri))))))) + +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + "Hello, World!") + #:port 0 + #:exception-handler + (lambda (exn request) + "Error"))) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (assert-equal + 500 + (response-code + (http-get + uri + #:port (non-blocking-open-socket-for-uri uri))))))) + (run-fibers-for-tests (lambda () (let* ((web-server From 3aab1be1e7ece854ff20e4e5b84c1be2165c0234 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 4 Mar 2025 14:09:31 +0000 Subject: [PATCH 059/112] Revert "Use module-ref for make-base-operation" This isn't working, with make-base-operation changing from part of a macro to a procedure, I'm not sure how to maintain compatability. I think just switching to guile-fibers-next everywhere is the approach to take. This reverts commit f41d1853ceb9f8d297fc756925a08f6d11d30d10. --- knots/timeout.scm | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/knots/timeout.scm b/knots/timeout.scm index 21c2267..552d079 100644 --- a/knots/timeout.scm +++ b/knots/timeout.scm @@ -119,19 +119,17 @@ (define (make-wait-operation ready? schedule-when-ready port port-ready-fd this-procedure) - ((module-ref (resolve-interface '(fibers operations)) - 'make-base-operation) - #f - (lambda _ - (and (ready? port) values)) - (lambda (flag sched resume) - (define (commit) - (match (atomic-box-compare-and-swap! flag 'W 'S) - ('W (resume values)) - ('C (commit)) - ('S #f))) - (schedule-when-ready - sched (port-ready-fd port) commit)))) + (make-base-operation #f + (lambda _ + (and (ready? port) values)) + (lambda (flag sched resume) + (define (commit) + (match (atomic-box-compare-and-swap! flag 'W 'S) + ('W (resume values)) + ('C (commit)) + ('S #f))) + (schedule-when-ready + sched (port-ready-fd port) commit)))) (define (wait-until-port-readable-operation port) "Make an operation that will succeed when PORT is readable." From 4e33da98aa421d80dfd3e0e4cb29863c6f087fd4 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 8 Mar 2025 09:39:27 +0000 Subject: [PATCH 060/112] Fix some exception handling issues --- knots/parallelism.scm | 7 +++++-- tests/parallelism.scm | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 2 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index f9be4ff..77272dd 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -72,7 +72,7 @@ reply-channels))) (map (match-lambda - (('exception exn stack) + (('exception exn) (raise-exception exn)) (result (apply values result))) @@ -254,7 +254,10 @@ (let ((stack (make-stack #t 0 prompt-tag 0 (and prompt-tag 1)))) - (return (list 'exception exn stack)))))) + (return (list 'exception + (make-exception + exn + (make-knots-exception stack)))))))) (lambda () (call-with-values (lambda () diff --git a/tests/parallelism.scm b/tests/parallelism.scm index 7d8dea7..f005d71 100644 --- a/tests/parallelism.scm +++ b/tests/parallelism.scm @@ -1,6 +1,7 @@ (use-modules (tests) (fibers) (unit-test) + (ice-9 exceptions) (knots parallelism)) ;; Test fibers-map @@ -60,4 +61,36 @@ identity '(())))) +(run-fibers-for-tests + (lambda () + (with-exception-handler + (lambda (exn) + (unless (and (exception-with-message? exn) + (string=? (exception-message exn) + "foo")) + (raise-exception exn))) + (lambda () + (fibers-for-each + (lambda (i) + (raise-exception + (make-exception-with-message "foo"))) + (iota 2))) + #:unwind? #t))) + +(run-fibers-for-tests + (lambda () + (with-exception-handler + (lambda (exn) + (unless (and (exception-with-message? exn) + (string=? (exception-message exn) + "foo")) + (raise-exception exn))) + (lambda () + ((fiberize + (lambda (i) + (raise-exception + (make-exception-with-message "foo")))) + 1)) + #:unwind? #t))) + (display "parallelism test finished successfully\n") From 3841b452a4488879d98cf64f29878f8a97719f1b Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 8 Mar 2025 10:14:33 +0000 Subject: [PATCH 061/112] Use guile-next and guile-fibers-next for development --- guix-dev.scm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guix-dev.scm b/guix-dev.scm index 6b51e8a..f9faef3 100644 --- a/guix-dev.scm +++ b/guix-dev.scm @@ -38,8 +38,8 @@ (source #f) (build-system gnu-build-system) (inputs - (list guile-3.0 - guile-fibers)) + (list guile-next + guile-fibers-next)) (native-inputs (list autoconf automake From 759ff87c0cfc1d6fda444ede92906b6fe9cc88d3 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 8 Mar 2025 10:14:54 +0000 Subject: [PATCH 062/112] Remove GUILE_AUTO_COMPILE=0 from test-env.in As I'm not sure this helps with backtraces. --- test-env.in | 2 -- 1 file changed, 2 deletions(-) diff --git a/test-env.in b/test-env.in index 2633beb..694f93d 100644 --- a/test-env.in +++ b/test-env.in @@ -7,8 +7,6 @@ GUILE_LOAD_COMPILED_PATH="${abs_top_builddir}/tests${GUILE_LOAD_COMPILED_PATH:+: GUILE_LOAD_PATH="$abs_top_builddir/tests:$abs_top_srcdir${GUILE_LOAD_PATH:+:}$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH" export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH -export GUILE_AUTO_COMPILE=0 - PATH="$abs_top_builddir:$PATH" export PATH From e3bc3c12b046d50bfd42960ec7649d0173bd0cc5 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 8 Mar 2025 10:15:25 +0000 Subject: [PATCH 063/112] Add some helpers for handling request bodies --- knots/web-server.scm | 75 ++++++++++++++++++++++++++++++++++++++++++++ tests/web-server.scm | 68 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 143 insertions(+) diff --git a/knots/web-server.scm b/knots/web-server.scm index 4ab59e3..10845e6 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -42,6 +42,12 @@ make-chunked-output-port/knots + &request-body-ended-prematurely + request-body-ended-prematurely-error? + + request-body-port/knots + read-request-body/knots + default-exception-handler default-write-response-exception-handler @@ -85,6 +91,75 @@ KEEP-ALIVE? is true." (setvbuf ret 'block buffering) ret) +(define* (make-delimited-input-port port len fail + #:key (keep-alive? #t)) + "Return an input port that reads from PORT, and makes sure that +exactly LEN bytes are available from PORT. Closing the returned port +closes PORT, unless KEEP-ALIVE? is true." + (define bytes-read 0) + + (define (read! bv start count) + (let ((count (min count (- len bytes-read)))) + (let loop ((ret (get-bytevector-n! port bv start count))) + (cond ((eof-object? ret) + (if (= bytes-read len) + 0 ; EOF + (fail bytes-read))) + ((and (zero? ret) (> count 0)) + ;; Do not return zero since zero means EOF, so try again. + (loop (get-bytevector-n! port bv start count))) + (else + (set! bytes-read (+ bytes-read ret)) + ret))))) + + (define close + (and (not keep-alive?) + (lambda () + (close-port port)))) + + (make-custom-binary-input-port "delimited input port" read! #f #f close)) + +;; Chunked Responses +(define &request-body-ended-prematurely + (make-exception-type '&request-body-ended-prematurely + &external-error + '(bytes-read))) + +(define make-request-body-ended-prematurely-error + (record-constructor &request-body-ended-prematurely)) + +(define request-body-ended-prematurely-error? + (record-predicate &request-body-ended-prematurely)) + +(define (request-body-port/knots r) + (cond + ((member '(chunked) (request-transfer-encoding r)) + (make-chunked-input-port (request-port r) + #:keep-alive? #t)) + (else + (let ((content-length + (request-content-length r))) + (make-delimited-input-port + (request-port r) + content-length + (lambda (bytes-read) + (raise-exception + (make-request-body-ended-prematurely-error bytes-read)))))))) + +(define (read-request-body/knots r) + (cond + ((member '(chunked) (request-transfer-encoding r)) + (get-bytevector-all + (request-body-port/knots r))) + (else + (let ((content-length + (request-content-length r))) + (if content-length + (get-bytevector-n + (request-body-port/knots r) + content-length) + #f))))) + (define (extend-response r k v . additional) (define (extend-alist alist k v) (let ((pair (assq k alist))) diff --git a/tests/web-server.scm b/tests/web-server.scm index 205d6a2..c21851e 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -150,6 +150,74 @@ (utf8->string (get-bytevector-n body 3))))))) +(run-fibers-for-tests + (lambda () + (let* ((web-server + (run-knots-web-server + (lambda (request) + (if (string=? (utf8->string + (read-request-body/knots request)) + "☺") + (values (build-response #:code 200) + "") + (values (build-response #:code 500) + ""))) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (let ((response + body + (http-post + uri + #:body "☺" + #:port (non-blocking-open-socket-for-uri uri)))) + (assert-equal + 200 + (response-code response)))))) + +(run-fibers-for-tests + (lambda () + (let* ((channel (make-channel)) + (web-server + (run-knots-web-server + (lambda (request) + (with-exception-handler + (lambda (exn) + (put-message channel exn)) + (lambda () + (read-request-body/knots request)) + #:unwind? #t)) + #:port 0)) ;; Bind to any port + (port + (web-server-port web-server)) + (uri + (build-uri 'http #:host "127.0.0.1" #:port port))) + + (let* ((port (non-blocking-open-socket-for-uri uri)) + (request + (build-request + uri + #:method 'POST + #:version '(1 . 1) + #:headers `((connection close) + (content-length . 20) + (Content-Type . "application/octet-stream")) + #:port port))) + + (set-port-encoding! port "ISO-8859-1") + (let ((request (write-request request port))) + (display "12") + (force-output port) + + (close-port port))) + + (assert-true + (request-body-ended-prematurely-error? + (get-message channel)))))) + ;; Test hanlding of exceptions when writing the response to a client (run-fibers-for-tests (lambda () From 710972691b26204e586320a7fe1cf2f215c526f3 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 8 Mar 2025 18:43:44 +0000 Subject: [PATCH 064/112] Fix exception handling for the web server exception handler Don't crash if it returns a response with invalid headers. --- knots/web-server.scm | 82 ++++++++++++++++++++++++++++---------------- 1 file changed, 52 insertions(+), 30 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 10845e6..92e8db6 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -345,36 +345,58 @@ on the procedure being called at any particular time." (lambda (return) (with-exception-handler (lambda (exn) - (call-with-values - (lambda () - (exception-handler exn request)) - (match-lambda* - ((response body) - (call-with-values - (lambda () - (sanitize-response request response body)) - return)) - (other - (call-with-values - (lambda () - (default-exception-handler - (make-exception-with-irritants - (list (make-exception-with-message - (simple-format - #f - "wrong number of values returned from exception handler, expecting 2, got ~A" - (length other))) - exception-handler)) - request)) - (match-lambda* - ((response body) - (call-with-values - (lambda () - (sanitize-response - request - response - body)) - return)))))))) + (with-exception-handler + (lambda (exn) + (call-with-values + (lambda () + (default-exception-handler + (make-exception + exn + (make-exception-with-message + "exception in exception handler") + (make-exception-with-irritants + exception-handler)) + request)) + (match-lambda* + ((response body) + (call-with-values + (lambda () + (sanitize-response + request + response + body)) + return))))) + (lambda () + (call-with-values + (lambda () + (exception-handler exn request)) + (match-lambda* + ((response body) + (call-with-values + (lambda () + (sanitize-response request response body)) + return)) + (other + (call-with-values + (lambda () + (default-exception-handler + (make-exception-with-irritants + (list (make-exception-with-message + (simple-format + #f + "wrong number of values returned from exception handler, expecting 2, got ~A" + (length other))) + exception-handler)) + request)) + (match-lambda* + ((response body) + (call-with-values + (lambda () + (sanitize-response + request + response + body)) + return)))))))))) (lambda () (start-stack #t From 47ff45d96331cf885e1e3d3ad8748295d182f882 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 10 Mar 2025 21:32:55 +0000 Subject: [PATCH 065/112] Abbreviate the fport_writer error message From the web server. --- knots/web-server.scm | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 92e8db6..9b98018 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -292,9 +292,20 @@ on the procedure being called at any particular time." #f) (define (default-write-response-exception-handler exn request) - (simple-format - (current-error-port) - "knots web server: exception replying to client: ~A\n" exn) + (if (and (exception-with-origin? exn) + (string=? (exception-origin exn) + "fport_write")) + (simple-format + (current-error-port) + "~A ~A: error replying to client\n" + (request-method request) + (uri-path (request-uri request))) + (simple-format + (current-error-port) + "knots web server: ~A ~A: exception replying to client: ~A\n" + (request-method request) + (uri-path (request-uri request)) + exn)) ;; Close the client port #f) From a73fd1ca5091e2eb089cf63583ce54b6415561f5 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 10 Mar 2025 21:33:29 +0000 Subject: [PATCH 066/112] Add a fibers-parallel test --- tests/parallelism.scm | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/tests/parallelism.scm b/tests/parallelism.scm index f005d71..9881a4d 100644 --- a/tests/parallelism.scm +++ b/tests/parallelism.scm @@ -93,4 +93,22 @@ 1)) #:unwind? #t))) +(run-fibers-for-tests + (lambda () + (let ((a 0)) + (call-with-values + (lambda () + (fibers-parallel + (begin + (sleep 1) + 1) + (begin + (set! a 1) + 2))) + (lambda (a b) + (assert-equal a 1) + (assert-equal b 2))) + + (assert-equal a 1)))) + (display "parallelism test finished successfully\n") From da69fd19f3072a405e394881a11c345704f31806 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 11 Mar 2025 11:55:42 +0000 Subject: [PATCH 067/112] Unwind before calling put-message As I think this might be more reliable in case the stack contains something that would introduce a continuation barrier. --- knots/parallelism.scm | 87 +++++++++++++++++++++++-------------------- 1 file changed, 47 insertions(+), 40 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 77272dd..ab398f8 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -22,6 +22,7 @@ #:use-module (srfi srfi-71) #:use-module (ice-9 match) #:use-module (ice-9 control) + #:use-module (ice-9 exceptions) #:use-module (fibers) #:use-module (fibers channels) #:use-module (fibers operations) @@ -43,27 +44,30 @@ (let ((reply (make-channel))) (spawn-fiber (lambda () - (call-with-escape-continuation - (lambda (return) - (with-exception-handler - (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (put-message reply - (list 'exception - (make-exception - exn - (make-knots-exception stack))))))) - (return)) - (lambda () - (call-with-values - (lambda () - (start-stack #t (thunk))) - (lambda vals - (put-message reply vals)))))))) + (with-exception-handler + (lambda (exn) + (put-message + reply + (list 'exception exn))) + (lambda () + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))))) + (lambda () + (call-with-values + (lambda () + (start-stack #t (thunk))) + (lambda vals + (put-message reply vals)))))) + #:unwind? #t)) #:parallel? #t) reply)) @@ -245,25 +249,28 @@ (get-message process-channel)))) (put-message reply-channel - (call-with-escape-continuation - (lambda (return) - (with-exception-handler - (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (return (list 'exception - (make-exception - exn - (make-knots-exception stack)))))))) - (lambda () - (call-with-values - (lambda () - (start-stack #t (apply proc args))) - (lambda vals - (cons 'result vals))))))))))) + (with-exception-handler + (lambda (exn) + (list 'exception exn)) + (lambda () + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))))) + (lambda () + (call-with-values + (lambda () + (start-stack #t (apply proc args))) + (lambda vals + (cons 'result vals)))))) + #:unwind? #t))))) #:parallel? #t)) (iota parallelism)) From e1858dfff5e360b36b167cd94c806759f9b4e7e8 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 14 Mar 2025 14:27:29 +0000 Subject: [PATCH 068/112] Remove the web-server exception handler This turned out not to be useful, since I wanted to handle exceptions happening in the exception handler, so it didn't really help in the end to allow customising it. --- knots/web-server.scm | 69 ++++++-------------------------------------- tests/web-server.scm | 22 -------------- 2 files changed, 9 insertions(+), 82 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 9b98018..14d32f6 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -48,7 +48,6 @@ request-body-port/knots read-request-body/knots - default-exception-handler default-write-response-exception-handler web-server? @@ -310,7 +309,7 @@ on the procedure being called at any particular time." ;; Close the client port #f) -(define (default-exception-handler exn request) +(define (exception-handler exn request) (let* ((error-string (call-with-output-string (lambda (port) @@ -332,8 +331,7 @@ on the procedure being called at any particular time." (define (handle-request handler client read-request-exception-handler - write-response-exception-handler - exception-handler) + write-response-exception-handler) (let ((request (with-exception-handler read-request-exception-handler @@ -356,58 +354,14 @@ on the procedure being called at any particular time." (lambda (return) (with-exception-handler (lambda (exn) - (with-exception-handler - (lambda (exn) - (call-with-values - (lambda () - (default-exception-handler - (make-exception - exn - (make-exception-with-message - "exception in exception handler") - (make-exception-with-irritants - exception-handler)) - request)) - (match-lambda* - ((response body) - (call-with-values - (lambda () - (sanitize-response - request - response - body)) - return))))) - (lambda () + (call-with-values + (lambda () + (exception-handler exn request)) + (lambda (response body) (call-with-values (lambda () - (exception-handler exn request)) - (match-lambda* - ((response body) - (call-with-values - (lambda () - (sanitize-response request response body)) - return)) - (other - (call-with-values - (lambda () - (default-exception-handler - (make-exception-with-irritants - (list (make-exception-with-message - (simple-format - #f - "wrong number of values returned from exception handler, expecting 2, got ~A" - (length other))) - exception-handler)) - request)) - (match-lambda* - ((response body) - (call-with-values - (lambda () - (sanitize-response - request - response - body)) - return)))))))))) + (sanitize-response request response body)) + return)))) (lambda () (start-stack #t @@ -475,7 +429,6 @@ on the procedure being called at any particular time." #:unwind? #t)))) (define* (client-loop client handler - exception-handler read-request-exception-handler write-response-exception-handler connection-idle-timeout @@ -517,8 +470,7 @@ on the procedure being called at any particular time." (else (let ((keep-alive? (handle-request handler client read-request-exception-handler - write-response-exception-handler - exception-handler))) + write-response-exception-handler))) (if keep-alive? (loop) (close-port client))))))) @@ -537,8 +489,6 @@ on the procedure being called at any particular time." INADDR_LOOPBACK)) (port 8080) (socket (make-default-socket family addr port)) - (exception-handler - default-exception-handler) (read-request-exception-handler default-read-request-exception-handler) (write-response-exception-handler @@ -577,7 +527,6 @@ before sending back to the client." ((client . sockaddr) (spawn-fiber (lambda () (client-loop client handler - exception-handler read-request-exception-handler write-response-exception-handler connection-idle-timeout diff --git a/tests/web-server.scm b/tests/web-server.scm index c21851e..9ac58bb 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -52,28 +52,6 @@ uri #:port (non-blocking-open-socket-for-uri uri))))))) -(run-fibers-for-tests - (lambda () - (let* ((web-server - (run-knots-web-server - (lambda (request) - "Hello, World!") - #:port 0 - #:exception-handler - (lambda (exn request) - "Error"))) ;; Bind to any port - (port - (web-server-port web-server)) - (uri - (build-uri 'http #:host "127.0.0.1" #:port port))) - - (assert-equal - 500 - (response-code - (http-get - uri - #:port (non-blocking-open-socket-for-uri uri))))))) - (run-fibers-for-tests (lambda () (let* ((web-server From 8c0f04be4f5fcdf9d1ec9b6a99df5f3b571de256 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 1 Apr 2025 17:46:39 +0300 Subject: [PATCH 069/112] Don't call put-message without unwinding the stack When handling exceptions, as this is error prone. --- knots/resource-pool.scm | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index f4522be..1b50482 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -650,12 +650,27 @@ available. Return the resource once PROC has returned." (lambda () (with-exception-handler (lambda (exn) - (print-backtrace-and-exception/knots exn) + ;; Unwind the stack before calling put-message, as + ;; this avoids inconsistent behaviour with + ;; continuation barriers (put-message (resource-pool-channel pool) `(return ,resource)) (raise-exception exn)) (lambda () - (proc resource)))) + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))))) + (lambda () + (proc resource)))) + #:unwind? #t)) (lambda vals (put-message (resource-pool-channel pool) `(return ,resource)) From 4f0eafef0a2f6b613b24f260da8fdcda48574a11 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 27 Apr 2025 09:41:56 +0100 Subject: [PATCH 070/112] Resource pool max waiters and destroy changes Add the ability to specify the max number of waiters for a resource pool, this provides a more efficient way of avoiding waiters for a resource pool continually rising. This commit also improves the destroy behaviour. --- knots/resource-pool.scm | 351 +++++++++++++++++++++++++++++++++------- tests/resource-pool.scm | 44 +++++ 2 files changed, 333 insertions(+), 62 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 1b50482..c9aab02 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -43,6 +43,15 @@ resource-pool-timeout-error-pool resource-pool-timeout-error? + &resource-pool-too-many-waiters + resource-pool-too-many-waiters-error-pool + resource-pool-too-many-waiters-error-waiters-count + resource-pool-too-many-waiters-error? + + &resource-pool-destroyed + resource-pool-destroyed-error-pool + resource-pool-destroyed-error? + resource-pool-default-timeout-handler call-with-resource-from-pool @@ -86,7 +95,8 @@ scheduler (name "unnamed") (add-resources-parallelism 1) - default-checkout-timeout) + default-checkout-timeout + default-max-waiters) (define channel (make-channel)) (define pool @@ -102,7 +112,8 @@ (lifetime . ,lifetime) (scheduler . ,scheduler) (name . ,name) - (default-checkout-timeout . ,default-checkout-timeout)))) + (default-checkout-timeout . ,default-checkout-timeout) + (default-max-waiters . ,default-max-waiters)))) (define checkout-failure-count 0) @@ -186,7 +197,8 @@ (perform-operation (choice-operation (wrap-operation - (put-operation reply-channel resource) + (put-operation reply-channel + (cons 'success resource)) (const #t)) (wrap-operation (sleep-operation reply-timeout) @@ -196,6 +208,116 @@ channel (list 'return-failed-checkout resource))))))) + (define (destroy-loop resources destroy-waiters) + (let loop ((resources resources) + (destroy-waiters destroy-waiters)) + (match (get-message channel) + (('add-resource resource) + (when destructor + (spawn-fiber-to-destroy-resource resource)) + + (loop resources + destroy-waiters)) + (('checkout reply timeout-time max-waiters) + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'resource-pool-destroyed + #f)))) + (perform-operation + (if timeout-time + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op))))) + (loop resources + destroy-waiters)) + (((and (or 'return + 'return-failed-checkout + 'remove) + return-type) + resource) + (when destructor + (spawn-fiber-to-destroy-resource resource)) + + (let ((index + (list-index (lambda (x) + (eq? x resource)) + resources))) + (define (remove-at-index! lst i) + (let ((start + end + (split-at! lst i))) + (append + start + (cdr end)))) + + (let ((new-resources + (if index + (remove-at-index! resources index) + (begin + (simple-format + (current-error-port) + "resource pool error: unable to remove ~A\n" + resource) + resources)))) + (if (null? new-resources) + (begin + (for-each + (lambda (destroy-waiter) + (spawn-fiber + (lambda () + (put-message destroy-waiter 'destroy-success)))) + destroy-waiters) + + ;; No loop + *unspecified*) + (loop new-resources + destroy-waiters))))) + + (('stats reply) + (let ((stats + `((resources . ,(length resources)) + (available . 0) + (waiters . 0) + (checkout-failure-count . ,checkout-failure-count)))) + + (spawn-fiber + (lambda () + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply stats) + (const #t)) + (wrap-operation (sleep-operation 5) + (const #f))))))) + + (loop resources + destroy-waiters)) + + (('check-for-idle-resources) + (loop resources + destroy-waiters)) + + (('destroy reply) + (loop resources + (cons reply destroy-waiters))) + (unknown + (simple-format + (current-error-port) + "unrecognised message to ~A resource pool channel: ~A\n" + name + unknown) + (loop resources + destroy-waiters))))) + (define (main-loop) (let loop ((resources '()) (available '()) @@ -257,7 +379,8 @@ (spawn-fiber-for-checkout waiter-channel reply-timeout resource)) - (put-message waiter-channel resource)) + (put-message waiter-channel (cons 'success + resource))) (loop (cons resource resources) available @@ -265,17 +388,45 @@ (cons (get-internal-real-time) resources-last-used))))))))) - (('checkout reply timeout-time) + (('checkout reply timeout-time max-waiters) (if (null? available) (begin (unless (= (length resources) max-size) (spawn-fiber-to-return-new-resource)) - (loop resources - available - (cons (cons reply timeout-time) - waiters) - resources-last-used)) + (let ((waiters-count + (length waiters))) + (if (and max-waiters + (>= waiters-count + max-waiters)) + (begin + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'too-many-waiters + waiters-count)))) + (perform-operation + (if timeout-time + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op))))) + (loop resources + available + waiters + resources-last-used)) + (loop resources + available + (cons (cons reply timeout-time) + waiters) + resources-last-used)))) (if timeout-time (let ((current-internal-time @@ -303,7 +454,8 @@ waiters resources-last-used))) (begin - (put-message reply (car available)) + (put-message reply (cons 'success + (car available))) (loop resources (cdr available) @@ -369,7 +521,8 @@ (spawn-fiber-for-checkout waiter-channel reply-timeout resource)) - (put-message waiter-channel resource)) + (put-message waiter-channel (cons 'success + resource))) (loop resources available @@ -473,7 +626,8 @@ resources-last-used)))) (('destroy reply) - (if (null? resources) + (if (and (null? resources) + (null? waiters)) (put-message reply 'destroy-success) (begin @@ -488,16 +642,34 @@ #:parallel? #t))) available) - (spawn-fiber - (lambda () - (sleep 0.1) - (put-message channel - (list 'destroy reply)))) + (let ((current-internal-time (get-internal-real-time))) + (for-each + (match-lambda + ((reply . timeout) + (when (or (not timeout) + (> timeout current-internal-time)) + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'resource-pool-destroyed + #f)))) + (perform-operation + (if timeout + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op)))))))) + waiters)) - (loop resources - '() - waiters - resources-last-used)))) + (destroy-loop resources + (list reply))))) (unknown (simple-format @@ -575,12 +747,50 @@ (define resource-pool-timeout-error? (record-predicate &resource-pool-timeout)) +(define &resource-pool-too-many-waiters + (make-exception-type '&recource-pool-too-many-waiters + &error + '(pool waiters-count))) + +(define resource-pool-too-many-waiters-error-pool + (exception-accessor + &resource-pool-too-many-waiters + (record-accessor &resource-pool-too-many-waiters 'pool))) + +(define resource-pool-too-many-waiters-error-waiters-count + (exception-accessor + &resource-pool-too-many-waiters + (record-accessor &resource-pool-too-many-waiters 'waiters-count))) + +(define make-resource-pool-too-many-waiters-error + (record-constructor &resource-pool-too-many-waiters)) + +(define resource-pool-too-many-waiters-error? + (record-predicate &resource-pool-too-many-waiters)) + +(define &resource-pool-destroyed + (make-exception-type '&recource-pool-destroyed + &error + '(pool))) + +(define resource-pool-destroyed-error-pool + (exception-accessor + &resource-pool-destroyed + (record-accessor &resource-pool-destroyed 'pool))) + +(define make-resource-pool-destroyed-error + (record-constructor &resource-pool-destroyed)) + +(define resource-pool-destroyed-error? + (record-predicate &resource-pool-destroyed)) + (define resource-pool-default-timeout-handler (make-parameter #f)) (define* (call-with-resource-from-pool pool proc #:key (timeout 'default) - (timeout-handler (resource-pool-default-timeout-handler))) + (timeout-handler (resource-pool-default-timeout-handler)) + (max-waiters 'default)) "Call PROC with a resource from POOL, blocking until a resource becomes available. Return the resource once PROC has returned." @@ -590,7 +800,13 @@ available. Return the resource once PROC has returned." 'default-checkout-timeout) timeout)) - (let ((resource + (define max-waiters-or-default + (if (eq? max-waiters 'default) + (assq-ref (resource-pool-configuration pool) + 'default-max-waiters) + max-waiters)) + + (let ((reply (if timeout-or-default (let loop ((reply (make-channel)) (start-time (get-internal-real-time))) @@ -603,7 +819,8 @@ available. Return the resource once PROC has returned." reply (+ start-time (* timeout-or-default - internal-time-units-per-second)))) + internal-time-units-per-second)) + max-waiters-or-default)) (const #t)) (wrap-operation (sleep-operation timeout-or-default) (const #f)))))) @@ -629,52 +846,62 @@ available. Return the resource once PROC has returned." 0) (loop (make-channel) start-time) - #f) + 'timeout) response)) - #f))))) + 'timeout))))) (let loop ((reply (make-channel))) (put-message (resource-pool-channel pool) (list 'checkout reply - #f)) + #f + max-waiters-or-default)) (get-message reply))))) - (when (not resource) - (when timeout-handler - (timeout-handler pool proc timeout)) + (match reply + ('timeout + (when timeout-handler + (timeout-handler pool proc timeout)) - (raise-exception - (make-resource-pool-timeout-error pool))) + (raise-exception + (make-resource-pool-timeout-error pool))) + (('too-many-waiters . count) - (call-with-values - (lambda () - (with-exception-handler - (lambda (exn) - ;; Unwind the stack before calling put-message, as - ;; this avoids inconsistent behaviour with - ;; continuation barriers - (put-message (resource-pool-channel pool) - `(return ,resource)) - (raise-exception exn)) - (lambda () - (with-exception-handler - (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (raise-exception - (make-exception - exn - (make-knots-exception stack))))))) - (lambda () - (proc resource)))) - #:unwind? #t)) - (lambda vals - (put-message (resource-pool-channel pool) - `(return ,resource)) - (apply values vals))))) + (raise-exception + (make-resource-pool-too-many-waiters-error pool + count))) + (('resource-pool-destroyed . #f) + (raise-exception + (make-resource-pool-destroyed-error pool))) + (('success . resource) + (call-with-values + (lambda () + (with-exception-handler + (lambda (exn) + ;; Unwind the stack before calling put-message, as + ;; this avoids inconsistent behaviour with + ;; continuation barriers + (put-message (resource-pool-channel pool) + `(return ,resource)) + (raise-exception exn)) + (lambda () + (with-exception-handler + (lambda (exn) + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (let ((stack (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1)))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))))) + (lambda () + (proc resource)))) + #:unwind? #t)) + (lambda vals + (put-message (resource-pool-channel pool) + `(return ,resource)) + (apply values vals))))))) (define-syntax-rule (with-resource-from-pool pool resource exp ...) (call-with-resource-from-pool diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index 1251429..1bc09e5 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -142,4 +142,48 @@ 20 (iota 50))))) +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-resource-pool + (lambda () #f) + 1 + #:default-max-waiters 1))) + (call-with-resource-from-pool + resource-pool + (lambda (res) + + ;; 1st waiter + (spawn-fiber + (lambda () + (with-exception-handler + (lambda (exn) + (if (resource-pool-destroyed-error? exn) + #t + (raise-exception exn))) + (lambda () + (call-with-resource-from-pool + resource-pool + (lambda (res) + (error 'should-not-be-reached)))) + #:unwind? #t))) + + (while (= 0 + (assq-ref + (resource-pool-stats resource-pool) + 'waiters)) + (sleep 0)) + + (with-exception-handler + (lambda (exn) + (if (resource-pool-too-many-waiters-error? exn) + #t + (raise-exception exn))) + (lambda () + ;; 2nd waiter + (call-with-resource-from-pool + resource-pool + (lambda (res) + (error 'should-not-be-reached)))) + #:unwind? #t)))))) + (display "resource-pool test finished successfully\n") From 68cfbe0380085735086b8952e7e700fda0028ad0 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 27 Apr 2025 10:03:06 +0100 Subject: [PATCH 071/112] Use a condition for destroying resource pools This avoids the situation where the resource pool is destroyed, so there's no fiber to listen to the destroy request. --- knots/resource-pool.scm | 70 +++++++++++++++++++---------------------- 1 file changed, 33 insertions(+), 37 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index c9aab02..5c96eef 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -29,6 +29,7 @@ #:use-module (fibers channels) #:use-module (fibers scheduler) #:use-module (fibers operations) + #:use-module (fibers conditions) #:use-module (knots) #:use-module (knots parallelism) #:export (resource-pool? @@ -71,11 +72,12 @@ (record-predicate &resource-pool-abort-add-resource)) (define-record-type - (make-resource-pool-record name channel configuration) + (make-resource-pool-record name channel destroy-condition configuration) resource-pool? - (name resource-pool-name) - (channel resource-pool-channel) - (configuration resource-pool-configuration)) + (name resource-pool-name) + (channel resource-pool-channel) + (destroy-condition resource-pool-destroy-condition) + (configuration resource-pool-configuration)) (set-record-type-printer! @@ -98,11 +100,14 @@ default-checkout-timeout default-max-waiters) (define channel (make-channel)) + (define destroy-condition + (make-condition)) (define pool (make-resource-pool-record name channel + destroy-condition `((max-size . ,max-size) (min-size . ,min-size) (idle-seconds . ,idle-seconds) @@ -208,16 +213,14 @@ channel (list 'return-failed-checkout resource))))))) - (define (destroy-loop resources destroy-waiters) - (let loop ((resources resources) - (destroy-waiters destroy-waiters)) + (define (destroy-loop resources) + (let loop ((resources resources)) (match (get-message channel) (('add-resource resource) (when destructor (spawn-fiber-to-destroy-resource resource)) - (loop resources - destroy-waiters)) + (loop resources)) (('checkout reply timeout-time max-waiters) (spawn-fiber (lambda () @@ -237,8 +240,7 @@ internal-time-units-per-second)) (const #f))) op))))) - (loop resources - destroy-waiters)) + (loop resources)) (((and (or 'return 'return-failed-checkout 'remove) @@ -270,17 +272,11 @@ resources)))) (if (null? new-resources) (begin - (for-each - (lambda (destroy-waiter) - (spawn-fiber - (lambda () - (put-message destroy-waiter 'destroy-success)))) - destroy-waiters) + (signal-condition! destroy-condition) ;; No loop *unspecified*) - (loop new-resources - destroy-waiters))))) + (loop new-resources))))) (('stats reply) (let ((stats @@ -299,24 +295,20 @@ (wrap-operation (sleep-operation 5) (const #f))))))) - (loop resources - destroy-waiters)) + (loop resources)) (('check-for-idle-resources) - (loop resources - destroy-waiters)) + (loop resources)) (('destroy reply) - (loop resources - (cons reply destroy-waiters))) + (loop resources)) (unknown (simple-format (current-error-port) "unrecognised message to ~A resource pool channel: ~A\n" name unknown) - (loop resources - destroy-waiters))))) + (loop resources))))) (define (main-loop) (let loop ((resources '()) @@ -625,10 +617,11 @@ waiters resources-last-used)))) - (('destroy reply) + (('destroy) (if (and (null? resources) (null? waiters)) - (put-message reply 'destroy-success) + (signal-condition! + destroy-condition) (begin (for-each @@ -668,8 +661,7 @@ op)))))))) waiters)) - (destroy-loop resources - (list reply))))) + (destroy-loop resources)))) (unknown (simple-format @@ -724,12 +716,16 @@ pool) (define (destroy-resource-pool pool) - (let ((reply (make-channel))) - (put-message (resource-pool-channel pool) - (list 'destroy reply)) - (let ((msg (get-message reply))) - (unless (eq? msg 'destroy-success) - (error msg))))) + (perform-operation + (choice-operation + (wrap-operation + (put-operation (resource-pool-channel pool) + (list 'destroy)) + (lambda _ + (wait (resource-pool-destroy-condition pool)))) + (wait-operation + (resource-pool-destroy-condition pool)))) + #t) (define &resource-pool-timeout (make-exception-type '&recource-pool-timeout From 1dca6d755e910b67636b791242f0948356cf8c4d Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 27 Apr 2025 10:52:36 +0100 Subject: [PATCH 072/112] Allow specifying the resource-pool-channel --- knots/resource-pool.scm | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 5c96eef..ea87a79 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -786,7 +786,8 @@ (define* (call-with-resource-from-pool pool proc #:key (timeout 'default) (timeout-handler (resource-pool-default-timeout-handler)) - (max-waiters 'default)) + (max-waiters 'default) + (channel (resource-pool-channel pool))) "Call PROC with a resource from POOL, blocking until a resource becomes available. Return the resource once PROC has returned." @@ -810,7 +811,7 @@ available. Return the resource once PROC has returned." (perform-operation (choice-operation (wrap-operation - (put-operation (resource-pool-channel pool) + (put-operation channel (list 'checkout reply (+ start-time @@ -846,7 +847,7 @@ available. Return the resource once PROC has returned." response)) 'timeout))))) (let loop ((reply (make-channel))) - (put-message (resource-pool-channel pool) + (put-message channel (list 'checkout reply #f From 838ee6f1e368b28724c41f35d06ccf62a700c424 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 28 Apr 2025 09:20:33 +0100 Subject: [PATCH 073/112] Enable destroying individual resources in a resource pool --- knots/resource-pool.scm | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index ea87a79..bd69f95 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -53,6 +53,10 @@ resource-pool-destroyed-error-pool resource-pool-destroyed-error? + &resource-pool-destroy-resource + make-resource-pool-destroy-resource-exception + resource-pool-destroy-resource-exception? + resource-pool-default-timeout-handler call-with-resource-from-pool @@ -555,6 +559,14 @@ resources-last-used index)))) + (('destroy resource) + (spawn-fiber-to-destroy-resource resource) + + (loop resources + available + waiters + resources-last-used)) + (('stats reply) (let ((stats `((resources . ,(length resources)) @@ -780,6 +792,17 @@ (define resource-pool-destroyed-error? (record-predicate &resource-pool-destroyed)) +(define &resource-pool-destroy-resource + (make-exception-type '&recource-pool-destroy-resource + &exception + '())) + +(define make-resource-pool-destroy-resource-exception + (record-constructor &resource-pool-destroy-resource)) + +(define resource-pool-destroy-resource-exception? + (record-predicate &resource-pool-destroy-resource)) + (define resource-pool-default-timeout-handler (make-parameter #f)) @@ -787,7 +810,8 @@ pool proc #:key (timeout 'default) (timeout-handler (resource-pool-default-timeout-handler)) (max-waiters 'default) - (channel (resource-pool-channel pool))) + (channel (resource-pool-channel pool)) + (destroy-resource-on-exception? #f)) "Call PROC with a resource from POOL, blocking until a resource becomes available. Return the resource once PROC has returned." @@ -877,9 +901,15 @@ available. Return the resource once PROC has returned." ;; Unwind the stack before calling put-message, as ;; this avoids inconsistent behaviour with ;; continuation barriers - (put-message (resource-pool-channel pool) - `(return ,resource)) - (raise-exception exn)) + (put-message + (resource-pool-channel pool) + (list (if (or destroy-resource-on-exception? + (resource-pool-destroy-resource-exception? exn)) + 'destroy + 'return) + resource)) + (unless (resource-pool-destroy-resource-exception? exn) + (raise-exception exn))) (lambda () (with-exception-handler (lambda (exn) From 8c63ed7b4e9bae10e956672ac0d021739823c395 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 28 Apr 2025 10:08:00 +0100 Subject: [PATCH 074/112] Support listing resource pool resources --- knots/resource-pool.scm | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index bd69f95..76c11e6 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -567,6 +567,16 @@ waiters resources-last-used)) + (('list-resources reply) + (spawn-fiber + (lambda () + (put-message reply (list-copy resources)))) + + (loop resources + available + waiters + resources-last-used)) + (('stats reply) (let ((stats `((resources . ,(length resources)) @@ -965,3 +975,8 @@ available. Return the resource once PROC has returned." (raise-exception (make-resource-pool-timeout-error pool)))))) +(define (resource-pool-list-resources pool) + (let ((reply (make-channel))) + (put-message (resource-pool-channel pool) + (list 'list-resources reply)) + (get-message reply))) From 7ba77010ae98e675340a7ea22b400f0dcc20ef65 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 15 May 2025 09:25:30 +0100 Subject: [PATCH 075/112] Handle %stacks not being a pair Not sure when this would happen, but guard against it. --- knots.scm | 13 ++++++++----- knots/parallelism.scm | 42 +++++++++++++++++++++++------------------ knots/resource-pool.scm | 15 +++++++++------ knots/thread-pool.scm | 21 ++++++++++++--------- 4 files changed, 53 insertions(+), 38 deletions(-) diff --git a/knots.scm b/knots.scm index 8e31c6b..42f2af7 100644 --- a/knots.scm +++ b/knots.scm @@ -67,11 +67,14 @@ (define* (print-backtrace-and-exception/knots exn #:key (port (current-error-port))) - (let* ((stack (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1))))) + (let* ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t)))) (error-string (call-with-output-string (lambda (port) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index ab398f8..f8b2b8b 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -52,15 +52,18 @@ (lambda () (with-exception-handler (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (raise-exception - (make-exception - exn - (make-knots-exception stack))))))) + (let ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t))))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))) (lambda () (call-with-values (lambda () @@ -255,15 +258,18 @@ (lambda () (with-exception-handler (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (raise-exception - (make-exception - exn - (make-knots-exception stack))))))) + (let ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t))))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))) (lambda () (call-with-values (lambda () diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 76c11e6..da52051 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -923,15 +923,18 @@ available. Return the resource once PROC has returned." (lambda () (with-exception-handler (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) + (let ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t))))) (raise-exception (make-exception exn - (make-knots-exception stack))))))) + (make-knots-exception stack))))) (lambda () (proc resource)))) #:unwind? #t)) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index f2f174e..14a8125 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -251,15 +251,18 @@ arguments of the thread pool procedure." proc) (with-exception-handler (lambda (exn) - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (let ((stack (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1)))) - (raise-exception - (make-exception - exn - (make-knots-exception stack))))))) + (let ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t))))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))) (lambda () (call-with-values (lambda () From 016f37f108ca19da3664516baa97e907aa972b90 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 16 May 2025 11:48:41 +0100 Subject: [PATCH 076/112] Rework thread pools Allow the thread pool to vary in size by basing it on a resource pool of fixed size thread pools, which are similar to the previous thread pool implementation. Fixed size thread pools don't require fibers, but thread pools now do. Some procedures work with either thread pool implementation. --- knots/thread-pool.scm | 705 +++++++++++++++++++----------------------- tests/thread-pool.scm | 74 +++-- 2 files changed, 360 insertions(+), 419 deletions(-) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 14a8125..029a34b 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -27,29 +27,38 @@ #:use-module (rnrs bytevectors) #:use-module (ice-9 q) #:use-module (ice-9 match) + #:use-module (ice-9 atomic) #:use-module (ice-9 threads) #:use-module (fibers) #:use-module (fibers timers) #:use-module (fibers channels) #:use-module (fibers operations) #:use-module (knots) + #:use-module (knots resource-pool) #:export (set-thread-name thread-name - thread-pool? - thread-pool-channel - thread-pool-arguments-parameter - thread-pool-proc-vector - - make-thread-pool - call-with-thread - - &thread-pool-timeout + &thread-pool-timeout-error + thread-pool-timeout-error-pool thread-pool-timeout-error? - %thread-pool-default-timeout + make-thread-pool + thread-pool? + thread-pool-resource-pool - create-work-queue)) + make-fixed-size-thread-pool + fixed-size-thread-pool? + fixed-size-thread-pool-channel + fixed-size-thread-pool-current-procedures + + ;; These procedures work for thread pools and fixed size + ;; thread pools + thread-pool-arguments-parameter + thread-pool-default-checkout-timeout + + destroy-thread-pool + + call-with-thread)) (define* (syscall->procedure return-type name argument-types #:key library) @@ -147,28 +156,64 @@ from there, or #f if that would be an empty string." (const ""))) (define-record-type - (thread-pool channel arguments-parameter proc-vector) + (thread-pool resource-pool arguments-parameter) thread-pool? - (channel thread-pool-channel) - (arguments-parameter thread-pool-arguments-parameter) - (proc-vector thread-pool-proc-vector) - (default-checkout-timeout - thread-pool-default-checkout-timeout)) + (resource-pool thread-pool-resource-pool) + (arguments-parameter thread-pool-arguments-parameter-accessor)) + +(define-record-type + (fixed-size-thread-pool channel arguments-parameter current-procedures + default-checkout-timeout) + fixed-size-thread-pool? + (channel fixed-size-thread-pool-channel) + (arguments-parameter fixed-size-thread-pool-arguments-parameter) + (current-procedures fixed-size-thread-pool-current-procedures) + (default-checkout-timeout fixed-size-thread-pool-default-checkout-timeout)) + +;; Since both thread pool records have this field, use a procedure +;; than handles the appropriate accessor +(define (thread-pool-arguments-parameter pool) + (if (fixed-size-thread-pool? pool) + (fixed-size-thread-pool-arguments-parameter pool) + (thread-pool-arguments-parameter-accessor pool))) + +(define (thread-pool-default-checkout-timeout pool) + (if (fixed-size-thread-pool? pool) + (fixed-size-thread-pool-default-checkout-timeout pool) + (assq-ref (resource-pool-configuration + (thread-pool-resource-pool pool)) + 'default-checkout-timeout))) + +(define &thread-pool-timeout + (make-exception-type '&thread-pool-timeout + &error + '(pool))) + +(define make-thread-pool-timeout-error + (record-constructor &thread-pool-timeout)) + +(define thread-pool-timeout-error-pool + (exception-accessor + &thread-pool-timeout + (record-accessor &thread-pool-timeout 'pool))) + +(define thread-pool-timeout-error? + (record-predicate &thread-pool-timeout)) + +(define* (make-fixed-size-thread-pool size + #:key + thread-initializer + thread-destructor + delay-logger + duration-logger + thread-lifetime + (expire-on-exception? #f) + (name "unnamed") + (use-default-io-waiters? #t) + default-checkout-timeout) + (define channel + (make-channel)) -(define* (make-thread-pool size - #:key - thread-initializer - thread-destructor - (delay-logger (lambda _ #f)) - (duration-logger (const #f)) - thread-lifetime - (log-exception? (const #t)) - (expire-on-exception? #f) - (name "unnamed") - (use-default-io-waiters? #t) - default-checkout-timeout) - "Return a channel used to offload work to a dedicated thread. ARGS are the -arguments of the thread pool procedure." (define param (make-parameter #f)) @@ -224,382 +269,252 @@ arguments of the thread pool procedure." (sleep 1) (destructor/safe args))))) - (define (process thread-index channel args) - (let loop ((current-lifetime thread-lifetime)) - (let ((exception? - (match (get-message channel) - (((? channel? reply) sent-time (? procedure? proc)) - (let ((time-delay - (- (get-internal-real-time) - sent-time))) - (delay-logger (/ time-delay - internal-time-units-per-second) - proc) + (define (process channel args) + (let loop () + (match (get-message channel) + ('destroy #f) + ((reply sent-time proc) + (when delay-logger + (let ((time-delay + (- (get-internal-real-time) + sent-time))) + (delay-logger (/ time-delay + internal-time-units-per-second) + proc))) - (let* ((start-time (get-internal-real-time)) - (response - (with-exception-handler - (lambda (exn) - (list 'thread-pool-error - (/ (- (get-internal-real-time) - start-time) - internal-time-units-per-second) - exn)) - (lambda () - (vector-set! thread-proc-vector - thread-index - proc) - (with-exception-handler - (lambda (exn) - (let ((stack - (match (fluid-ref %stacks) - ((stack-tag . prompt-tag) - (make-stack #t - 0 prompt-tag - 0 (and prompt-tag 1))) - (_ - (make-stack #t))))) - (raise-exception - (make-exception - exn - (make-knots-exception stack))))) - (lambda () - (call-with-values - (lambda () - (start-stack - #t - (apply proc args))) - (lambda vals - (cons (/ (- (get-internal-real-time) - start-time) - internal-time-units-per-second) - vals)))))) - #:unwind? #t))) - (put-message reply - response) + (let* ((start-time (get-internal-real-time)) + (response + (with-exception-handler + (lambda (exn) + (list 'thread-pool-error + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second) + exn)) + (lambda () + (with-exception-handler + (lambda (exn) + (let ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t))))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))) + (lambda () + (call-with-values + (lambda () + (start-stack + #t + (apply proc args))) + (lambda vals + (cons (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second) + vals)))))) + #:unwind? #t))) - (vector-set! thread-proc-vector - thread-index - #f) + (put-message reply + response) - (match response - (('thread-pool-error duration _) - (when duration-logger - (duration-logger duration proc)) - #t) - ((duration . _) - (when duration-logger - (duration-logger duration proc)) - #f)))))))) - (unless (and expire-on-exception? - exception?) - (if (number? current-lifetime) - (unless (< current-lifetime 0) - (loop (if current-lifetime - (- current-lifetime 1) - #f))) - (loop #f)))))) + (let ((exception? + (match response + (('thread-pool-error duration _) + (when duration-logger + (duration-logger duration proc)) + #t) + ((duration . _) + (when duration-logger + (duration-logger duration proc)) + #f)))) + (if (and exception? + expire-on-exception?) + #t + (loop)))))))) - (define (start-threads channel) - (for-each - (lambda (thread-index) - (call-with-new-thread - (lambda () - (catch 'system-error - (lambda () - (set-thread-name - (string-append - name " w t " - (number->string thread-index)))) - (const #t)) - - (let init ((args (if thread-initializer - (initializer/safe) - '()))) - (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "knots: thread-pool: internal exception: ~A\n" exn)) - (lambda () - (parameterize ((param args)) - (process thread-index channel args))) - #:unwind? #t) - - (when thread-destructor - (destructor/safe args)) - - (init (initializer/safe)))))) - (iota size))) - - (let ((channel (make-channel))) - (if use-default-io-waiters? - (call-with-default-io-waiters + (define (start-thread index channel) + (call-with-new-thread + (lambda () + (catch 'system-error (lambda () - (start-threads channel))) - (start-threads channel)) + (set-thread-name + (string-append + name " w t " (number->string index)))) + (const #t)) - (thread-pool channel - param - thread-proc-vector))) + (let init ((args (if thread-initializer + (initializer/safe) + '()))) + (let ((continue? + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "knots: thread-pool: internal exception: ~A\n" exn)) + (lambda () + (parameterize ((param args)) + (process channel args))) + #:unwind? #t))) -(define &thread-pool-timeout - (make-exception-type '&thread-pool-timeout - &error - '())) + (when thread-destructor + (destructor/safe args)) -(define make-thread-pool-timeout-error - (record-constructor &thread-pool-timeout)) + (when continue? + (init (if thread-initializer + (initializer/safe) + '())))))))) -(define thread-pool-timeout-error? - (record-predicate &thread-pool-timeout)) + (for-each + (lambda (i) + (start-thread i channel)) + (iota size)) -(define* (call-with-thread record proc #:key duration-logger - (timeout (thread-pool-default-checkout-timeout - record)) - (channel (thread-pool-channel record))) + (fixed-size-thread-pool channel + param + thread-proc-vector + default-checkout-timeout)) + +(define* (make-thread-pool max-size + #:key + (min-size max-size) + scheduler + thread-initializer + thread-destructor + (delay-logger (lambda _ #f)) + (duration-logger (const #f)) + thread-lifetime + (expire-on-exception? #f) + (name "unnamed") + (use-default-io-waiters? #t) + default-checkout-timeout) + "Return a channel used to offload work to a dedicated thread. ARGS are the +arguments of the thread pool procedure." + (define param + (make-parameter #f)) + + (let ((resource-pool + (make-resource-pool + (lambda () + (make-fixed-size-thread-pool + 1 + #:thread-initializer thread-initializer + #:thread-destructor thread-destructor + #:thread-lifetime thread-lifetime + #:expire-on-exception? expire-on-exception? + #:name name + #:use-default-io-waiters? use-default-io-waiters?)) + max-size + #:destructor destroy-thread-pool + #:min-size min-size + #:delay-logger delay-logger + #:scheduler scheduler + #:duration-logger duration-logger + #:default-checkout-timeout default-checkout-timeout))) + + (thread-pool resource-pool + param))) + +(define* (call-with-thread thread-pool + proc + #:key + duration-logger + checkout-timeout + channel + destroy-thread-on-exception? + (max-waiters 'default)) "Send PROC to the thread pool through CHANNEL. Return the result of PROC. If already in the thread pool, call PROC immediately." - (let ((args ((thread-pool-arguments-parameter record)))) + (define (handle-proc fixed-size-thread-pool + reply-channel + start-time + timeout) + (let* ((request-channel + (or channel + (fixed-size-thread-pool-channel + fixed-size-thread-pool))) + (operation-success? + (perform-operation + (let ((put + (wrap-operation + (put-operation request-channel + (list reply-channel + start-time + proc)) + (const #t)))) + + (if timeout + (choice-operation + put + (wrap-operation (sleep-operation timeout) + (const #f))) + put))))) + + (unless operation-success? + (raise-exception + (make-thread-pool-timeout-error))) + + (let ((reply (get-message reply-channel))) + (match reply + (('thread-pool-error duration exn) + (when duration-logger + (duration-logger duration)) + (raise-exception exn)) + ((duration . result) + (when duration-logger + (duration-logger duration)) + (apply values result)))))) + + (let ((args ((thread-pool-arguments-parameter thread-pool)))) (if args (apply proc args) - (let* ((reply (make-channel)) - (operation-success? - (perform-operation - (let ((put - (wrap-operation - (put-operation channel - (list reply - (get-internal-real-time) - proc)) - (const #t)))) + (let ((start-time (get-internal-real-time)) + (reply-channel (make-channel))) + (if (fixed-size-thread-pool? thread-pool) + (handle-proc thread-pool + reply-channel + start-time + checkout-timeout) + (with-exception-handler + (lambda (exn) + (if (and (resource-pool-timeout-error? exn) + (eq? (resource-pool-timeout-error-pool exn) + (thread-pool-resource-pool thread-pool))) + (raise-exception + (make-thread-pool-timeout-error thread-pool)) + (raise-exception exn))) + (lambda () + (call-with-resource-from-pool (thread-pool-resource-pool + thread-pool) + (lambda (fixed-size-thread-pool) + (if checkout-timeout + (let ((remaining-time + (/ (- (get-internal-real-time) start-time) + internal-time-units-per-second))) + (if (< remaining-time checkout-timeout) + (handle-proc fixed-size-thread-pool + reply-channel + start-time + remaining-time) + (raise-exception + (make-thread-pool-timeout-error thread-pool)))) + (handle-proc fixed-size-thread-pool + reply-channel + start-time + #f))) + #:max-waiters max-waiters + #:timeout checkout-timeout + #:destroy-resource-on-exception? + destroy-thread-on-exception?)))))))) - (if timeout - (choice-operation - put - (wrap-operation (sleep-operation timeout) - (const #f))) - put))))) - - (unless operation-success? - (raise-exception - (make-thread-pool-timeout-error))) - - (match (get-message reply) - (('thread-pool-error duration exn) - (when duration-logger - (duration-logger duration)) - (raise-exception exn)) - ((duration . result) - (when duration-logger - (duration-logger duration)) - (apply values result))))))) - -(define* (create-work-queue thread-count-parameter proc - #:key thread-start-delay - (thread-stop-delay - (make-time time-duration 0 0)) - (name "unnamed") - priority= running-jobs-count - desired-thread-count))) - - (define (thread-idle-for-too-long? last-job-finished-at) - (time>=? - (time-difference (current-time time-monotonic) - last-job-finished-at) - thread-stop-delay)) - - (define (stop-thread) - (hash-remove! running-job-args - thread-index) - (unlock-mutex queue-mutex)) - - (call-with-new-thread - (lambda () - (catch 'system-error - (lambda () - (set-thread-name - (string-append name " q t " - (number->string thread-index)))) - (const #t)) - - (let loop ((last-job-finished-at (current-time time-monotonic))) - (lock-mutex queue-mutex) - - (if (too-many-threads?) - (stop-thread) - (let ((job-args - (if (q-empty? queue) - ;; #f from wait-condition-variable indicates a timeout - (if (wait-condition-variable - job-available - queue-mutex - (+ 9 (time-second (current-time)))) - ;; Another thread could have taken - ;; the job in the mean time - (if (q-empty? queue) - #f - (if priority threads-to-start 0) - (for-each - (lambda (thread-index) - (when (eq? (hash-ref running-job-args - thread-index - 'slot-free) - 'slot-free) - (let* ((now (current-time time-monotonic)) - (elapsed (time-difference now - previous-thread-started-at))) - (when (or (eq? #f thread-start-delay) - (time>=? elapsed thread-start-delay)) - (set! previous-thread-started-at now) - (hash-set! running-job-args - thread-index - #f) - (start-thread thread-index))))) - (iota desired-count))))))) - - (if (procedure? thread-count-parameter) - (call-with-new-thread - (lambda () - (catch 'system-error - (lambda () - (set-thread-name - (string-append name " q t"))) - (const #t)) - - (while #t - (sleep 15) - (with-mutex queue-mutex - (let ((idle-threads (hash-count (lambda (index val) - (eq? #f val)) - running-job-args))) - (when (= 0 idle-threads) - (start-new-threads-if-necessary (get-thread-count)))))))) - (start-new-threads-if-necessary (get-thread-count))) - - (values process-job count-jobs count-threads list-jobs))) +(define (destroy-thread-pool pool) + (if (fixed-size-thread-pool? pool) + (put-message + (fixed-size-thread-pool-channel pool) + 'destroy) + (destroy-resource-pool + (thread-pool-resource-pool pool)))) diff --git a/tests/thread-pool.scm b/tests/thread-pool.scm index 93a49ce..1c51cb3 100644 --- a/tests/thread-pool.scm +++ b/tests/thread-pool.scm @@ -6,10 +6,47 @@ (knots thread-pool)) (let ((thread-pool - (make-thread-pool 2))) + (make-fixed-size-thread-pool 2))) + + (assert-equal + (call-with-thread + thread-pool + (lambda () + 4)) + 4)) + +(let ((thread-pool + (make-fixed-size-thread-pool + 2 + #:thread-initializer (const '(2))))) + + (assert-equal + (call-with-thread + thread-pool + (lambda (num) + (* 2 num))) + 4)) + +(let ((thread-pool + (make-fixed-size-thread-pool 2))) + + (assert-equal + #t + (with-exception-handler + (lambda (exn) + (knots-exception? exn)) + (lambda () + (call-with-thread + thread-pool + (lambda () + (+ 1 'a)))) + #:unwind? #t))) + +(run-fibers-for-tests + (lambda () + (let ((thread-pool + (make-thread-pool 2))) - (run-fibers-for-tests - (lambda () (assert-equal (call-with-thread thread-pool @@ -17,13 +54,13 @@ 4)) 4)))) -(let ((thread-pool - (make-thread-pool - 2 - #:thread-initializer (const '(2))))) +(run-fibers-for-tests + (lambda () + (let ((thread-pool + (make-thread-pool + 2 + #:thread-initializer (const '(2))))) - (run-fibers-for-tests - (lambda () (assert-equal (call-with-thread thread-pool @@ -31,22 +68,11 @@ (* 2 num))) 4)))) -(let ((process-job - count-jobs - count-threads - list-jobs - (create-work-queue - 2 - (lambda (i) - (* i 2))))) +(run-fibers-for-tests + (lambda () + (let ((thread-pool + (make-thread-pool 2))) - (process-job 3)) - -(let ((thread-pool - (make-thread-pool 2))) - - (run-fibers-for-tests - (lambda () (assert-equal #t (with-exception-handler From cbafdb8668f33c7d3eabeebc60731df0d585636a Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 25 May 2025 15:34:07 +0100 Subject: [PATCH 077/112] Respect use-default-io-waiters? for the fixed size thread pools --- knots/thread-pool.scm | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 029a34b..7dad3d8 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -371,7 +371,11 @@ from there, or #f if that would be an empty string." (for-each (lambda (i) - (start-thread i channel)) + (if use-default-io-waiters? + (call-with-default-io-waiters + (lambda () + (start-thread i channel))) + (start-thread i channel))) (iota size)) (fixed-size-thread-pool channel From 8e582a2d7346e5de4b31b19fc660213c69b43706 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 26 May 2025 14:45:58 +0100 Subject: [PATCH 078/112] Improve promise exception reporting And guard against calling fibers-force not on a fibers promise record. --- knots/promise.scm | 86 +++++++++++++++++++++++++++++++---------------- 1 file changed, 57 insertions(+), 29 deletions(-) diff --git a/knots/promise.scm b/knots/promise.scm index 235640b..9df376b 100644 --- a/knots/promise.scm +++ b/knots/promise.scm @@ -19,10 +19,15 @@ (define-module (knots promise) #:use-module (srfi srfi-9) + #:use-module (ice-9 match) #:use-module (ice-9 atomic) + #:use-module (ice-9 exceptions) #:use-module (fibers) #:use-module (fibers conditions) - #:export (fibers-delay + #:use-module (knots) + #:export (fibers-promise? + + fibers-delay fibers-force fibers-promise-reset fibers-promise-result-available?)) @@ -41,38 +46,61 @@ (make-condition))) (define (fibers-force fp) + (unless (fibers-promise? fp) + (raise-exception + (make-exception + (make-exception-with-message "fibers-force: not a fibers promise") + (make-exception-with-irritants fp)))) + (let ((res (atomic-box-compare-and-swap! (fibers-promise-values-box fp) #f 'started))) - (if (eq? #f res) - (call-with-values - (lambda () - (with-exception-handler - (lambda (exn) - (atomic-box-set! (fibers-promise-values-box fp) - exn) - (signal-condition! - (fibers-promise-evaluated-condition fp)) - (raise-exception exn)) - (fibers-promise-thunk fp) - #:unwind? #t)) - (lambda vals - (atomic-box-set! (fibers-promise-values-box fp) - vals) - (signal-condition! - (fibers-promise-evaluated-condition fp)) - (apply values vals))) - (if (eq? res 'started) - (begin - (wait (fibers-promise-evaluated-condition fp)) - (let ((result (atomic-box-ref (fibers-promise-values-box fp)))) - (if (exception? result) - (raise-exception result) - (apply values result)))) - (if (exception? res) - (raise-exception res) - (apply values res)))))) + (cond + ((eq? #f res) + (call-with-values + (lambda () + (with-exception-handler + (lambda (exn) + (atomic-box-set! (fibers-promise-values-box fp) + exn) + (signal-condition! + (fibers-promise-evaluated-condition fp)) + (raise-exception exn)) + (lambda () + (with-exception-handler + (lambda (exn) + (let ((stack + (match (fluid-ref %stacks) + ((stack-tag . prompt-tag) + (make-stack #t + 0 prompt-tag + 0 (and prompt-tag 1))) + (_ + (make-stack #t))))) + (raise-exception + (make-exception + exn + (make-knots-exception stack))))) + (fibers-promise-thunk fp))) + #:unwind? #t)) + (lambda vals + (atomic-box-set! (fibers-promise-values-box fp) + vals) + (signal-condition! + (fibers-promise-evaluated-condition fp)) + (apply values vals)))) + ((eq? res 'started) + (begin + (wait (fibers-promise-evaluated-condition fp)) + (let ((result (atomic-box-ref (fibers-promise-values-box fp)))) + (if (exception? result) + (raise-exception result) + (apply values result))))) + (else + (if (exception? res) + (raise-exception res) + (apply values res)))))) (define (fibers-promise-reset fp) (atomic-box-set! (fibers-promise-values-box fp) From 123c9201227a2c7ac66c98a7601524c8fd15f6fe Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 9 Jun 2025 12:19:32 +0100 Subject: [PATCH 079/112] Export sanitize-response As this is useful. --- knots/web-server.scm | 2 ++ 1 file changed, 2 insertions(+) diff --git a/knots/web-server.scm b/knots/web-server.scm index 14d32f6..453db44 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -45,6 +45,8 @@ &request-body-ended-prematurely request-body-ended-prematurely-error? + sanitize-response + request-body-port/knots read-request-body/knots From 78d22d1accce74191bbfd68dce9e6ac11bc04fcc Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 9 Jun 2025 12:19:56 +0100 Subject: [PATCH 080/112] Tweak display of stack traces Tweak the frames to display and try to harden the code to crash less. --- knots.scm | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/knots.scm b/knots.scm index 42f2af7..05b2a1a 100644 --- a/knots.scm +++ b/knots.scm @@ -75,6 +75,8 @@ 0 (and prompt-tag 1))) (_ (make-stack #t)))) + (stack-len + (stack-length stack)) (error-string (call-with-output-string (lambda (port) @@ -83,30 +85,46 @@ (filter knots-exception? (simple-exceptions exn))))) - (let ((stack-vec - (stack->vector stack))) + (let* ((stack-vec + (stack->vector stack)) + (stack-vec-length + (vector-length stack-vec))) (print-frames (list->vector (drop (vector->list stack-vec) - 6)) + (if (< stack-vec-length 5) + 0 + 4))) port #:count (stack-length stack))) (for-each (lambda (stack) - (let ((stack-vec - (stack->vector stack))) + (let* ((stack-vec + (stack->vector stack)) + (stack-vec-length + (vector-length stack-vec))) (print-frames (list->vector (drop (vector->list stack-vec) - 3)) + (if (< stack-vec-length 4) + 0 + 3))) port #:count (stack-length stack)))) knots-stacks) (print-exception port (if (null? knots-stacks) - (stack-ref stack 1) - (stack-ref (last knots-stacks) 3)) + (stack-ref stack + (if (< stack-len 4) + stack-len + 4)) + (let* ((stack (last knots-stacks)) + (stack-len (stack-length stack))) + (stack-ref stack + (if (< stack-len 3) + stack-len + 3)))) '%exception (list exn))))))) (display error-string port))) From 8f669f133f35be6ca6a2156c9c98d271c29ee9b7 Mon Sep 17 00:00:00 2001 From: Efraim Flashner Date: Wed, 18 Jun 2025 13:22:03 +0300 Subject: [PATCH 081/112] Fix typo --- tests/web-server.scm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/web-server.scm b/tests/web-server.scm index 9ac58bb..e456bf3 100644 --- a/tests/web-server.scm +++ b/tests/web-server.scm @@ -196,7 +196,7 @@ (request-body-ended-prematurely-error? (get-message channel)))))) -;; Test hanlding of exceptions when writing the response to a client +;; Test handling of exceptions when writing the response to a client (run-fibers-for-tests (lambda () (let* ((exception-handled-sucecssfully-channel From 5663a5f2e91d02911301001de1e2eb1ab0695fe4 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sat, 21 Jun 2025 09:43:19 +0100 Subject: [PATCH 082/112] Address exception naming inconsistencies --- knots/thread-pool.scm | 12 ++++++------ knots/timeout.scm | 36 ++++++++++++++++++------------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index 7dad3d8..b176162 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -184,21 +184,21 @@ from there, or #f if that would be an empty string." (thread-pool-resource-pool pool)) 'default-checkout-timeout))) -(define &thread-pool-timeout - (make-exception-type '&thread-pool-timeout +(define &thread-pool-timeout-error + (make-exception-type '&thread-pool-timeout-error &error '(pool))) (define make-thread-pool-timeout-error - (record-constructor &thread-pool-timeout)) + (record-constructor &thread-pool-timeout-error)) (define thread-pool-timeout-error-pool (exception-accessor - &thread-pool-timeout - (record-accessor &thread-pool-timeout 'pool))) + &thread-pool-timeout-error + (record-accessor &thread-pool-timeout-error 'pool))) (define thread-pool-timeout-error? - (record-predicate &thread-pool-timeout)) + (record-predicate &thread-pool-timeout-error)) (define* (make-fixed-size-thread-pool size #:key diff --git a/knots/timeout.scm b/knots/timeout.scm index 552d079..58306e0 100644 --- a/knots/timeout.scm +++ b/knots/timeout.scm @@ -34,13 +34,13 @@ wait-until-port-readable-operation wait-until-port-writable-operation - &port-timeout + &port-timeout-error port-timeout-error? - &port-read-timeout - port-read-timeout-error + &port-read-timeout-error + port-read-timeout-error? - &port-write-timeout + &port-write-timeout-error port-write-timeout-error? with-port-timeouts)) @@ -76,38 +76,38 @@ (vals (apply values vals))))) -(define &port-timeout - (make-exception-type '&port-timeout +(define &port-timeout-error + (make-exception-type '&port-timeout-error &external-error '(thunk port))) (define make-port-timeout-error - (record-constructor &port-timeout)) + (record-constructor &port-timeout-error)) (define port-timeout-error? - (record-predicate &port-timeout)) + (record-predicate &port-timeout-error)) -(define &port-read-timeout - (make-exception-type '&port-read-timeout - &port-timeout +(define &port-read-timeout-error + (make-exception-type '&port-read-timeout-error + &port-timeout-error '())) (define make-port-read-timeout-error - (record-constructor &port-read-timeout)) + (record-constructor &port-read-timeout-error)) (define port-read-timeout-error? - (record-predicate &port-read-timeout)) + (record-predicate &port-read-timeout-error)) -(define &port-write-timeout - (make-exception-type '&port-write-timeout - &port-timeout +(define &port-write-timeout-error + (make-exception-type '&port-write-timeout-error + &port-timeout-error '())) (define make-port-write-timeout-error - (record-constructor &port-write-timeout)) + (record-constructor &port-write-timeout-error)) (define port-write-timeout-error? - (record-predicate &port-write-timeout)) + (record-predicate &port-write-timeout-error)) (define (readable? port) "Test if PORT is writable." From abd865acd36513ea8f0ecac720faadba9d52ae4b Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 24 Jun 2025 10:55:10 +0200 Subject: [PATCH 083/112] Initial pages commit --- index.html | 1537 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1537 insertions(+) create mode 100644 index.html diff --git a/index.html b/index.html new file mode 100644 index 0000000..73c16cf --- /dev/null +++ b/index.html @@ -0,0 +1,1537 @@ + + + + +Untitled Document + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1 API

+

The following is the list of modules provided by this library. +

+ + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.1 (knots non-blocking)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.1.1 Procedures

+ + +
+
Procedure: non-blocking-open-socket-for-uri uri KEY: #:verify-certificate?
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: non-blocking-port port
+

Make PORT non-blocking and return it. +

+
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.2 (knots parallelism)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.2.1 Macros

+ + +
+
Macro: fibers-let x
+

Undocumented macro. +

+
+ + + + +
+
Macro: fibers-parallel x
+

Undocumented macro. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.2.2 Procedures

+ + +
+
Procedure: fiberize proc KEY: #:parallelism #:input-channel #:process-channel
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-batch-for-each proc parallelism-limit . lists
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-batch-map proc parallelism-limit . lists
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-for-each proc . lists
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-map proc . lists
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-map-with-progress proc lists KEY: #:report
+

Undocumented procedure. +

+
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.3 (knots promise)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.3.1 Macros

+ + +
+
Macro: fibers-promise? x
+

Undocumented macro. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.3.2 Procedures

+ + +
+
Procedure: fibers-delay thunk
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-force fp
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-promise-reset fp
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: fibers-promise-result-available? fp
+

Undocumented procedure. +

+
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.4 (knots queue)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.4.1 Procedures

+ + +
+
Procedure: spawn-queueing-fiber dest-channel
+

Undocumented procedure. +

+
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.5 (knots resource-pool)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.5.1 Macros

+ + +
+
Macro: resource-pool-channel x
+

Undocumented macro. +

+
+ + + + +
+
Macro: resource-pool-configuration x
+

Undocumented macro. +

+
+ + + + +
+
Macro: resource-pool-name x
+

Undocumented macro. +

+
+ + + + +
+
Macro: resource-pool? x
+

Undocumented macro. +

+
+ + + + +
+
Macro: with-resource-from-pool x
+

Undocumented macro. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.5.2 Parameters

+ + +
+
Parameter: resource-pool-default-timeout-handler
+

Default value: +

+
#f
+
+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.5.3 Procedures

+ + +
+
Procedure: call-with-resource-from-pool pool proc KEY: #:timeout #:timeout-handler #:max-waiters #:channel #:destroy-resource-on-exception?
+

Call PROC with a resource from POOL, blocking until a resource becomes +available. Return the resource once PROC has returned. +

+
+ + + + +
+
Procedure: destroy-resource-pool pool
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: make-resource-pool return-new-resource max-size KEY: #:min-size #:idle-seconds #:delay-logger #:duration-logger #:destructor #:lifetime #:scheduler #:name #:add-resources-parallelism #:default-checkout-timeout #:default-max-waiters
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: make-resource-pool-destroy-resource-exception
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-destroy-resource-exception? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-destroyed-error-pool obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-destroyed-error? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-stats pool KEY: #:timeout
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-timeout-error-pool obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-timeout-error? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-too-many-waiters-error-pool obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-too-many-waiters-error-waiters-count obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: resource-pool-too-many-waiters-error? obj
+

Undocumented procedure. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.5.4 Record Types

+ + +
+
Record type: &resource-pool-destroy-resource
+

This record type has the following fields: +

+
    +
+ +
+ + + + +
+
Record type: &resource-pool-destroyed
+

This record type has the following fields: +

+
    +
  • +pool
+ +
+ + + + +
+
Record type: &resource-pool-timeout
+

This record type has the following fields: +

+
    +
  • +pool
+ +
+ + + + +
+
Record type: &resource-pool-too-many-waiters
+

This record type has the following fields: +

+
    +
  • +pool
  • +waiters-count
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.6 (knots thread-pool)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.6.1 Macros

+ + +
+
Macro: fixed-size-thread-pool-channel x
+

Undocumented macro. +

+
+ + + + +
+
Macro: fixed-size-thread-pool-current-procedures x
+

Undocumented macro. +

+
+ + + + +
+
Macro: fixed-size-thread-pool? x
+

Undocumented macro. +

+
+ + + + +
+
Macro: thread-pool-resource-pool x
+

Undocumented macro. +

+
+ + + + +
+
Macro: thread-pool? x
+

Undocumented macro. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.6.2 Procedures

+ + +
+
Procedure: call-with-thread thread-pool proc KEY: #:duration-logger #:checkout-timeout #:channel #:destroy-thread-on-exception? #:max-waiters
+

Send PROC to the thread pool through CHANNEL. Return the result of +PROC. If already in the thread pool, call PROC immediately. +

+
+ + + + +
+
Procedure: destroy-thread-pool pool
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: make-fixed-size-thread-pool size KEY: #:thread-initializer #:thread-destructor #:delay-logger #:duration-logger #:thread-lifetime #:expire-on-exception? #:name #:use-default-io-waiters? #:default-checkout-timeout
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: make-thread-pool max-size KEY: #:min-size #:scheduler #:thread-initializer #:thread-destructor #:delay-logger #:duration-logger #:thread-lifetime #:expire-on-exception? #:name #:use-default-io-waiters? #:default-checkout-timeout
+

Return a channel used to offload work to a dedicated thread. ARGS are +the arguments of the thread pool procedure. +

+
+ + + + +
+
Procedure: set-thread-name name
+

Set the name of the calling thread to NAME. NAME is truncated to 15 +bytes. +

+
+ + + + +
+
Procedure: thread-name
+

Return the name of the calling thread as a string. +

+
+ + + + +
+
Procedure: thread-pool-arguments-parameter pool
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: thread-pool-default-checkout-timeout pool
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: thread-pool-timeout-error-pool obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: thread-pool-timeout-error? obj
+

Undocumented procedure. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.6.3 Record Types

+ + +
+
Record type: &thread-pool-timeout-error
+

This record type has the following fields: +

+
    +
  • +pool
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.7 (knots timeout)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.7.1 Procedures

+ + +
+
Procedure: port-read-timeout-error? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: port-timeout-error? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: port-write-timeout-error? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: wait-until-port-readable-operation port
+

Make an operation that will succeed when PORT is readable. +

+
+ + + + +
+
Procedure: wait-until-port-writable-operation port
+

Make an operation that will succeed when PORT is writable. +

+
+ + + + +
+
Procedure: with-fibers-timeout thunk KEY: #:timeout #:on-timeout
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: with-port-timeouts thunk KEY: #:timeout #:read-timeout #:write-timeout
+

Undocumented procedure. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.7.2 Record Types

+ + +
+
Record type: &port-read-timeout-error
+

This record type has the following fields: +

+
    +
  • +thunk
  • +port
+ +
+ + + + +
+
Record type: &port-timeout-error
+

This record type has the following fields: +

+
    +
  • +thunk
  • +port
+ +
+ + + + +
+
Record type: &port-write-timeout-error
+

This record type has the following fields: +

+
    +
  • +thunk
  • +port
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+ +

1.8 (knots web-server)

+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.8.1 Macros

+ + +
+
Macro: web-server-port x
+

Undocumented macro. +

+
+ + + + +
+
Macro: web-server-socket x
+

Undocumented macro. +

+
+ + + + +
+
Macro: web-server? x
+

Undocumented macro. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.8.2 Procedures

+ + +
+
Procedure: default-write-response-exception-handler exn request
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: make-chunked-output-port/knots port KEY: #:keep-alive? #:buffering
+

Returns a new port which translates non-encoded data into a HTTP chunked +transfer encoded data and writes this to PORT. Data written to this +port is buffered until the port is flushed, at which point it is all +sent as one chunk. The port will otherwise be flushed every BUFFERING +bytes, which defaults to 1200. Take care to close the port when done, +as it will output the remaining data, and encode the final zero chunk. +When the port is closed it will also close PORT, unless KEEP-ALIVE? is +true. +

+
+ + + + +
+
Procedure: read-request-body/knots r
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: request-body-ended-prematurely-error? obj
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: request-body-port/knots r
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: run-knots-web-server handler KEY: #:host #:family #:addr #:port #:socket #:read-request-exception-handler #:write-response-exception-handler #:connection-idle-timeout #:connection-buffer-size
+

Run the knots web server. +

+

HANDLER should be a procedure that takes one argument, the HTTP request +and returns two values, the response and response body. +

+

For example, here is a simple "Hello, World!" server: +

+
+
 (define (handler request)
+   (let ((body (read-request-body request)))
+     (values '((content-type . (text/plain)))
+             "Hello, World!")))
+ (run-knots-web-server handler)
+
+ +

The response and body will be run through ‘sanitize-response’ before +sending back to the client. +

+
+ + + + +
+
Procedure: sanitize-response request response body
+

"Sanitize" the given response and body, making them appropriate for the +given request. +

+

As a convenience to web handler authors, RESPONSE may be given as an +alist of headers, in which case it is used to construct a default +response. Ensures that the response version corresponds to the request +version. If BODY is a string, encodes the string to a bytevector, in an +encoding appropriate for RESPONSE. Adds a ‘content-length’ and +‘content-type’ header, as necessary. +

+

If BODY is a procedure, it is called with a port as an argument, and the +output collected as a bytevector. In the future we might try to instead +use a compressing, chunk-encoded port, and call this procedure later, in +the write-client procedure. Authors are advised not to rely on the +procedure being called at any particular time. +

+
+ + + + + +
+ + + + + + + + + + + + + + + +
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
+

1.8.3 Record Types

+ + +
+
Record type: &request-body-ended-prematurely
+

This record type has the following fields: +

+
    +
  • +bytes-read
+ +
+ + + + + +
+ + + + + + +
[Top][Contents][Index][ ? ]
+

About This Document

+ +

+ This document was generated on June 24, 2025 using texi2html 5.0. +

+

+ The buttons in the navigation panels have the following meaning: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Button Name Go to From 1.2.3 go to
[ << ] FastBackBeginning of this chapter or previous chapter1
[ < ] BackPrevious section in reading order1.2.2
[ Up ] UpUp section1.2
[ > ] ForwardNext section in reading order1.2.4
[ >> ] FastForwardNext chapter2
[Top] TopCover (top) of document  
[Contents] ContentsTable of contents  
[Index] IndexIndex  
[ ? ] AboutAbout (help)  
+ +

+ where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure: +

+ +
    +
  • 1. Section One +
      +
    • 1.1 Subsection One-One +
        +
      • ...
        • +
      +
      • +
    • 1.2 Subsection One-Two +
        +
      • 1.2.1 Subsubsection One-Two-One
        • +
      • 1.2.2 Subsubsection One-Two-Two
        • +
      • 1.2.3 Subsubsection One-Two-Three     + <== Current Position
        • +
      • 1.2.4 Subsubsection One-Two-Four
        • +
      +
      • +
    • 1.3 Subsection One-Three +
        +
      • ...
        • +
      +
      • +
    • 1.4 Subsection One-Four
      • +
    +
    • +
+ +
+

+ + This document was generated on June 24, 2025 using texi2html 5.0. + +
+ +

+ + From 7d31d5163d616458b137dcfe9d2ed55ff79253a7 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 24 Jun 2025 13:10:17 +0200 Subject: [PATCH 084/112] Add guile-documenta as a native input --- guix-dev.scm | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/guix-dev.scm b/guix-dev.scm index f9faef3..62b170c 100644 --- a/guix-dev.scm +++ b/guix-dev.scm @@ -43,7 +43,8 @@ (native-inputs (list autoconf automake - pkg-config)) + pkg-config + guile-documenta)) (synopsis "TODO") (description "TODO") (home-page "TODO") From f7eae5a3bcf4b87aa0a5ad1d60e6a2f3adc0224b Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 24 Jun 2025 20:50:44 +0200 Subject: [PATCH 085/112] Add texinfo to guix-dev.scm --- guix-dev.scm | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/guix-dev.scm b/guix-dev.scm index 62b170c..68d7763 100644 --- a/guix-dev.scm +++ b/guix-dev.scm @@ -30,6 +30,7 @@ (gnu packages guile) (gnu packages guile-xyz) (gnu packages pkg-config) + (gnu packages texinfo) (srfi srfi-1)) (package @@ -44,7 +45,8 @@ (list autoconf automake pkg-config - guile-documenta)) + guile-documenta + texinfo)) (synopsis "TODO") (description "TODO") (home-page "TODO") From 1b7732c95845b7bb704e162be516855e143bc801 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 24 Jun 2025 20:58:04 +0200 Subject: [PATCH 086/112] Add manual index --- doc/index.texi | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 doc/index.texi diff --git a/doc/index.texi b/doc/index.texi new file mode 100644 index 0000000..925cf43 --- /dev/null +++ b/doc/index.texi @@ -0,0 +1,96 @@ +\input texinfo +@setfilename guile-knots + + +@c HEADER +@settitle Guile Knots +@documentlanguage en +@documentencoding UTF-8 +@afourpaper +@c END HEADER + + + +@c MASTER MENU +@node Top +@top Overview + +Guile Knots is a library providing tools and patterns for programming +with @url{https://github.com/wingo/fibers, Guile Fibers}. Guile Knots +provides higher level building blocks for writing programs using Guile +Fibers, including managing code that can't run in a thread used by +fibers. Also included is a web server implementation using Fibers, +which while being similar to the web server provided by Fibers, can +provide some benefits in specific circumstances. + +@c END MASTER MENU + + +@c TABLE OF CONTENTS +@contents +@c END TABLE OF CONTENTS + + +@c CHAPTER: API +@include api/index.texi +@c END CHAPTER: API + + + +@c APPENDICES +@node Version History +@appendix Version History + +@table @dfn + +@item Version 0.Y.0, Month DD, 20YY +@itemize +@item +No initial release has yet been made. +@end itemize + +@end table + + + +@node Copying Information +@appendix Copying Information + +Copyright © 2024, 2025 Christopher Baines + +This library is free software; you can redistribute it and/or modify +it under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 3 of the +License, or (at your option) any later version. + +@c END APPENDICES + + + +@c INDICES +@node Concept Index +@unnumbered Concept Index + +@printindex cp + + +@node Data Type Index +@unnumbered Data Type Index + +@printindex tp + + +@node Procedure Index +@unnumbered Procedure Index + +@printindex fn + + +@node Variable Index +@unnumbered Variable Index + +@printindex vr +@c END INDICES + + +@bye From 591487ae09e9605871e03bd8c1cab68eaeff0652 Mon Sep 17 00:00:00 2001 From: Automatic website updater <> Date: Tue, 24 Jun 2025 20:01:11 +0100 Subject: [PATCH 087/112] Automatic website update --- index.html | 1499 ++++++++++++++++++++++++---------------------------- 1 file changed, 684 insertions(+), 815 deletions(-) diff --git a/index.html b/index.html index 73c16cf..ada69a3 100644 --- a/index.html +++ b/index.html @@ -1,46 +1,34 @@ - + - + -Untitled Document + +Guile Knots - - + + - - + + + + + + + @@ -48,76 +36,135 @@ ul.no-bullet {list-style: none} - + - - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1 API

+ + + + +
+
+

+Next:   [Contents][Index]

+
+

Overview

+ +

Guile Knots is a library providing tools and patterns for programming +with Guile Fibers. Guile Knots +provides higher level building blocks for writing programs using Guile +Fibers, including managing code that can’t run in a thread used by +fibers. Also included is a web server implementation using Fibers, +which while being similar to the web server provided by Fibers, can +provide some benefits in specific circumstances. +

+ + + + + + + +
+
+
+

+Next: , Previous: , Up: Overview   [Contents][Index]

+
+

1 API

The following is the list of modules provided by this library.

+
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.1 (knots non-blocking)

+
+
+

+Next: , Up: API   [Contents][Index]

+
+

1.1 (knots non-blocking)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.1.1 Procedures

+ +
+

1.1.1 Procedures

-
-
Procedure: non-blocking-open-socket-for-uri uri KEY: #:verify-certificate?
+
+
Procedure: non-blocking-open-socket-for-uri _ KEY: #:verify-certificate?

Undocumented procedure.

@@ -125,8 +172,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: non-blocking-port port
+
+
Procedure: non-blocking-port a

Make PORT non-blocking and return it.

@@ -137,51 +184,29 @@ ul.no-bullet {list-style: none}
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.2 (knots parallelism)

+
+
+
+
+

+Next: , Previous: , Up: API   [Contents][Index]

+
+

1.2 (knots parallelism)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.2.1 Macros

+ +
+

1.2.1 Macros

-
-
Macro: fibers-let x
+
+
Macro: fibers-let a

Undocumented macro.

@@ -189,8 +214,8 @@ ul.no-bullet {list-style: none} -
-
Macro: fibers-parallel x
+
+
Macro: fibers-parallel a

Undocumented macro.

@@ -199,28 +224,13 @@ ul.no-bullet {list-style: none} -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.2.2 Procedures

+
+
+

1.2.2 Procedures

-
-
Procedure: fiberize proc KEY: #:parallelism #:input-channel #:process-channel
+
+
Procedure: fiberize _ KEY: #:parallelism #:input-channel #:process-channel

Undocumented procedure.

@@ -228,8 +238,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-batch-for-each proc parallelism-limit . lists
+
+
Procedure: fibers-batch-for-each a b . rest

Undocumented procedure.

@@ -237,8 +247,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-batch-map proc parallelism-limit . lists
+
+
Procedure: fibers-batch-map a b . rest

Undocumented procedure.

@@ -246,8 +256,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-for-each proc . lists
+
+
Procedure: fibers-for-each a . rest

Undocumented procedure.

@@ -255,8 +265,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-map proc . lists
+
+
Procedure: fibers-map a . rest

Undocumented procedure.

@@ -264,8 +274,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-map-with-progress proc lists KEY: #:report
+
+
Procedure: fibers-map-with-progress _ _ KEY: #:report

Undocumented procedure.

@@ -276,51 +286,29 @@ ul.no-bullet {list-style: none}
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.3 (knots promise)

+
+
+
+
+

+Next: , Previous: , Up: API   [Contents][Index]

+
+

1.3 (knots promise)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.3.1 Macros

+ +
+

1.3.1 Macros

-
-
Macro: fibers-promise? x
+
+
Macro: fibers-promise? a

Undocumented macro.

@@ -329,28 +317,13 @@ ul.no-bullet {list-style: none} -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.3.2 Procedures

+
+
+

1.3.2 Procedures

-
-
Procedure: fibers-delay thunk
+
+
Procedure: fibers-delay a

Undocumented procedure.

@@ -358,8 +331,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-force fp
+
+
Procedure: fibers-force a

Undocumented procedure.

@@ -367,8 +340,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-promise-reset fp
+
+
Procedure: fibers-promise-reset a

Undocumented procedure.

@@ -376,8 +349,8 @@ ul.no-bullet {list-style: none} -
-
Procedure: fibers-promise-result-available? fp
+
+
Procedure: fibers-promise-result-available? a

Undocumented procedure.

@@ -388,51 +361,28 @@ ul.no-bullet {list-style: none}
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.4 (knots queue)

+
+
+
+
+

+Next: , Previous: , Up: API   [Contents][Index]

+
+

1.4 (knots queue)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.4.1 Procedures

+ +
+

1.4.1 Procedures

-
-
Procedure: spawn-queueing-fiber dest-channel
+
+
Procedure: spawn-queueing-fiber a

Undocumented procedure.

@@ -443,51 +393,31 @@ ul.no-bullet {list-style: none}
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.5 (knots resource-pool)

+
+
+
+
+

+Next: , Previous: , Up: API   [Contents][Index]

+
+

1.5 (knots resource-pool)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.5.1 Macros

+ +
+

1.5.1 Macros

-
-
Macro: resource-pool-channel x
+
+
Macro: resource-pool-channel a

Undocumented macro.

@@ -495,8 +425,8 @@ ul.no-bullet {list-style: none} -
-
Macro: resource-pool-configuration x
+
+
Macro: resource-pool-configuration a

Undocumented macro.

@@ -504,8 +434,8 @@ ul.no-bullet {list-style: none} -
-
Macro: resource-pool-name x
+
+
Macro: resource-pool-name a

Undocumented macro.

@@ -513,8 +443,8 @@ ul.no-bullet {list-style: none} -
-
Macro: resource-pool? x
+
+
Macro: resource-pool? a

Undocumented macro.

@@ -522,8 +452,8 @@ ul.no-bullet {list-style: none} -
-
Macro: with-resource-from-pool x
+
+
Macro: with-resource-from-pool a

Undocumented macro.

@@ -532,28 +462,13 @@ ul.no-bullet {list-style: none} -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.5.2 Parameters

+
+
+

1.5.2 Parameters

-
-
Parameter: resource-pool-default-timeout-handler
+
+
Parameter: resource-pool-default-timeout-handler

Default value: 

#f
@@ -564,28 +479,13 @@ ul.no-bullet {list-style: none}
 
 
 
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
[ << ][ < ][ Up ][ > ][ >> ]            [Top][Contents][Index][ ? ]

-
1.5.3 Procedures

+
+
+

1.5.3 Procedures

-
-
Procedure: call-with-resource-from-pool pool proc KEY: #:timeout #:timeout-handler #:max-waiters #:channel #:destroy-resource-on-exception?
+
+
Procedure: call-with-resource-from-pool _ _ KEY: #:timeout #:timeout-handler #:max-waiters #:channel #:destroy-resource-on-exception?

Call PROC with a resource from POOL, blocking until a resource becomes available. Return the resource once PROC has returned.

@@ -594,8 +494,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: destroy-resource-pool pool
+
+
Procedure: destroy-resource-pool a

Undocumented procedure.

@@ -603,8 +503,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: make-resource-pool return-new-resource max-size KEY: #:min-size #:idle-seconds #:delay-logger #:duration-logger #:destructor #:lifetime #:scheduler #:name #:add-resources-parallelism #:default-checkout-timeout #:default-max-waiters
+
+
Procedure: make-resource-pool _ _ KEY: #:min-size #:idle-seconds #:delay-logger #:duration-logger #:destructor #:lifetime #:scheduler #:name #:add-resources-parallelism #:default-checkout-timeout #:default-max-waiters

Undocumented procedure.

@@ -612,8 +512,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: make-resource-pool-destroy-resource-exception
+
+
Procedure: make-resource-pool-destroy-resource-exception

Undocumented procedure.

@@ -621,8 +521,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-destroy-resource-exception? obj
+
+
Procedure: resource-pool-destroy-resource-exception? obj

Undocumented procedure.

@@ -630,8 +530,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-destroyed-error-pool obj
+
+
Procedure: resource-pool-destroyed-error-pool obj

Undocumented procedure.

@@ -639,8 +539,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-destroyed-error? obj
+
+
Procedure: resource-pool-destroyed-error? obj

Undocumented procedure.

@@ -648,8 +548,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-stats pool KEY: #:timeout
+
+
Procedure: resource-pool-stats _ KEY: #:timeout

Undocumented procedure.

@@ -657,8 +557,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-timeout-error-pool obj
+
+
Procedure: resource-pool-timeout-error-pool obj

Undocumented procedure.

@@ -666,8 +566,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-timeout-error? obj
+
+
Procedure: resource-pool-timeout-error? obj

Undocumented procedure.

@@ -675,8 +575,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-too-many-waiters-error-pool obj
+
+
Procedure: resource-pool-too-many-waiters-error-pool obj

Undocumented procedure.

@@ -684,8 +584,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-too-many-waiters-error-waiters-count obj
+
+
Procedure: resource-pool-too-many-waiters-error-waiters-count obj

Undocumented procedure.

@@ -693,8 +593,8 @@ available. Return the resource once PROC has returned. -
-
Procedure: resource-pool-too-many-waiters-error? obj
+
+
Procedure: resource-pool-too-many-waiters-error? obj

Undocumented procedure.

@@ -703,31 +603,16 @@ available. Return the resource once PROC has returned. -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.5.4 Record Types

+
+
+

1.5.4 Record Types

-
-
Record type: &resource-pool-destroy-resource
+
+
Record type: &resource-pool-destroy-resource

This record type has the following fields:

-
    +
@@ -735,40 +620,36 @@ available. Return the resource once PROC has returned. -
-
Record type: &resource-pool-destroyed
+
+
Record type: &resource-pool-destroyed

This record type has the following fields:

-
    -
  • -pool
+
    +
  • pool
-
-
Record type: &resource-pool-timeout
+
+
Record type: &resource-pool-timeout

This record type has the following fields:

-
    -
  • -pool
+
    +
  • pool
-
-
Record type: &resource-pool-too-many-waiters
+
+
Record type: &resource-pool-too-many-waiters

This record type has the following fields:

-
    -
  • -pool
  • -waiters-count
+
    +
  • pool
  • waiters-count
@@ -778,51 +659,30 @@ available. Return the resource once PROC has returned.
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.6 (knots thread-pool)

+
+
+
+
+

+Next: , Previous: , Up: API   [Contents][Index]

+
+

1.6 (knots thread-pool)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.6.1 Macros

+ +
+

1.6.1 Macros

-
-
Macro: fixed-size-thread-pool-channel x
+
+
Macro: fixed-size-thread-pool-channel a

Undocumented macro.

@@ -830,8 +690,8 @@ available. Return the resource once PROC has returned. -
-
Macro: fixed-size-thread-pool-current-procedures x
+
+
Macro: fixed-size-thread-pool-current-procedures a

Undocumented macro.

@@ -839,8 +699,8 @@ available. Return the resource once PROC has returned. -
-
Macro: fixed-size-thread-pool? x
+
+
Macro: fixed-size-thread-pool? a

Undocumented macro.

@@ -848,8 +708,8 @@ available. Return the resource once PROC has returned. -
-
Macro: thread-pool-resource-pool x
+
+
Macro: thread-pool-resource-pool a

Undocumented macro.

@@ -857,8 +717,8 @@ available. Return the resource once PROC has returned. -
-
Macro: thread-pool? x
+
+
Macro: thread-pool? a

Undocumented macro.

@@ -867,28 +727,13 @@ available. Return the resource once PROC has returned. -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.6.2 Procedures

+
+
+

1.6.2 Procedures

-
-
Procedure: call-with-thread thread-pool proc KEY: #:duration-logger #:checkout-timeout #:channel #:destroy-thread-on-exception? #:max-waiters
+
+
Procedure: call-with-thread _ _ KEY: #:duration-logger #:checkout-timeout #:channel #:destroy-thread-on-exception? #:max-waiters

Send PROC to the thread pool through CHANNEL. Return the result of PROC. If already in the thread pool, call PROC immediately.

@@ -897,8 +742,8 @@ PROC. If already in the thread pool, call PROC immediately. -
-
Procedure: destroy-thread-pool pool
+
+
Procedure: destroy-thread-pool a

Undocumented procedure.

@@ -906,8 +751,8 @@ PROC. If already in the thread pool, call PROC immediately. -
-
Procedure: make-fixed-size-thread-pool size KEY: #:thread-initializer #:thread-destructor #:delay-logger #:duration-logger #:thread-lifetime #:expire-on-exception? #:name #:use-default-io-waiters? #:default-checkout-timeout
+
+
Procedure: make-fixed-size-thread-pool _ KEY: #:thread-initializer #:thread-destructor #:delay-logger #:duration-logger #:thread-lifetime #:expire-on-exception? #:name #:use-default-io-waiters? #:default-checkout-timeout

Undocumented procedure.

@@ -915,8 +760,8 @@ PROC. If already in the thread pool, call PROC immediately. -
-
Procedure: make-thread-pool max-size KEY: #:min-size #:scheduler #:thread-initializer #:thread-destructor #:delay-logger #:duration-logger #:thread-lifetime #:expire-on-exception? #:name #:use-default-io-waiters? #:default-checkout-timeout
+
+
Procedure: make-thread-pool _ KEY: #:min-size #:scheduler #:thread-initializer #:thread-destructor #:delay-logger #:duration-logger #:thread-lifetime #:expire-on-exception? #:name #:use-default-io-waiters? #:default-checkout-timeout

Return a channel used to offload work to a dedicated thread. ARGS are the arguments of the thread pool procedure.

@@ -925,8 +770,8 @@ the arguments of the thread pool procedure. -
-
Procedure: set-thread-name name
+
+
Procedure: set-thread-name a

Set the name of the calling thread to NAME. NAME is truncated to 15 bytes.

@@ -935,8 +780,8 @@ bytes. -
-
Procedure: thread-name
+
+
Procedure: thread-name

Return the name of the calling thread as a string.

@@ -944,8 +789,8 @@ bytes. -
-
Procedure: thread-pool-arguments-parameter pool
+
+
Procedure: thread-pool-arguments-parameter a

Undocumented procedure.

@@ -953,8 +798,8 @@ bytes. -
-
Procedure: thread-pool-default-checkout-timeout pool
+
+
Procedure: thread-pool-default-checkout-timeout a

Undocumented procedure.

@@ -962,8 +807,8 @@ bytes. -
-
Procedure: thread-pool-timeout-error-pool obj
+
+
Procedure: thread-pool-timeout-error-pool obj

Undocumented procedure.

@@ -971,8 +816,8 @@ bytes. -
-
Procedure: thread-pool-timeout-error? obj
+
+
Procedure: thread-pool-timeout-error? obj

Undocumented procedure.

@@ -981,33 +826,17 @@ bytes. -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.6.3 Record Types

+
+
+

1.6.3 Record Types

-
-
Record type: &thread-pool-timeout-error
+
+
Record type: &thread-pool-timeout-error

This record type has the following fields:

-
    -
  • -pool
+
    +
  • pool
@@ -1017,51 +846,29 @@ bytes.
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.7 (knots timeout)

+
+
+
+
+

+Next: , Previous: , Up: API   [Contents][Index]

+
+

1.7 (knots timeout)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.7.1 Procedures

+ +
+

1.7.1 Procedures

-
-
Procedure: port-read-timeout-error? obj
+
+
Procedure: port-read-timeout-error? obj

Undocumented procedure.

@@ -1069,8 +876,8 @@ bytes. -
-
Procedure: port-timeout-error? obj
+
+
Procedure: port-timeout-error? obj

Undocumented procedure.

@@ -1078,8 +885,8 @@ bytes. -
-
Procedure: port-write-timeout-error? obj
+
+
Procedure: port-write-timeout-error? obj

Undocumented procedure.

@@ -1087,8 +894,8 @@ bytes. -
-
Procedure: wait-until-port-readable-operation port
+
+
Procedure: wait-until-port-readable-operation a

Make an operation that will succeed when PORT is readable.

@@ -1096,8 +903,8 @@ bytes. -
-
Procedure: wait-until-port-writable-operation port
+
+
Procedure: wait-until-port-writable-operation a

Make an operation that will succeed when PORT is writable.

@@ -1105,8 +912,8 @@ bytes. -
-
Procedure: with-fibers-timeout thunk KEY: #:timeout #:on-timeout
+
+
Procedure: with-fibers-timeout _ KEY: #:timeout #:on-timeout

Undocumented procedure.

@@ -1114,8 +921,8 @@ bytes. -
-
Procedure: with-port-timeouts thunk KEY: #:timeout #:read-timeout #:write-timeout
+
+
Procedure: with-port-timeouts _ KEY: #:timeout #:read-timeout #:write-timeout

Undocumented procedure.

@@ -1124,62 +931,41 @@ bytes. -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.7.2 Record Types

+
+
+

1.7.2 Record Types

-
-
Record type: &port-read-timeout-error
+
+
Record type: &port-read-timeout-error

This record type has the following fields:

-
    -
  • -thunk
  • -port
+
    +
  • thunk
  • port
-
-
Record type: &port-timeout-error
+
+
Record type: &port-timeout-error

This record type has the following fields:

-
    -
  • -thunk
  • -port
+
    +
  • thunk
  • port
-
-
Record type: &port-write-timeout-error
+
+
Record type: &port-write-timeout-error

This record type has the following fields:

-
    -
  • -thunk
  • -port
+
    +
  • thunk
  • port
@@ -1189,51 +975,30 @@ bytes.
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
- -

1.8 (knots web-server)

+
+
+
+
+

+Previous: , Up: API   [Contents][Index]

+
+

1.8 (knots web-server)

-
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.8.1 Macros

+ +
+

1.8.1 Macros

-
-
Macro: web-server-port x
+
+
Macro: web-server-port a

Undocumented macro.

@@ -1241,8 +1006,8 @@ bytes. -
-
Macro: web-server-socket x
+
+
Macro: web-server-socket a

Undocumented macro.

@@ -1250,8 +1015,8 @@ bytes. -
-
Macro: web-server? x
+
+
Macro: web-server? a

Undocumented macro.

@@ -1260,28 +1025,13 @@ bytes. -
- - - - - - - - - - - - - - - -
[ << ][ < ][ Up ][ > ][ >> ]         [Top][Contents][Index][ ? ]
-

1.8.2 Procedures

+
+
+

1.8.2 Procedures

-
-
Procedure: default-write-response-exception-handler exn request
+
+
Procedure: default-write-response-exception-handler a b

Undocumented procedure.

@@ -1289,8 +1039,8 @@ bytes. -
-
Procedure: make-chunked-output-port/knots port KEY: #:keep-alive? #:buffering
+
+
Procedure: make-chunked-output-port/knots _ KEY: #:keep-alive? #:buffering

Returns a new port which translates non-encoded data into a HTTP chunked transfer encoded data and writes this to PORT. Data written to this port is buffered until the port is flushed, at which point it is all @@ -1305,8 +1055,8 @@ true. -

-
Procedure: read-request-body/knots r
+
+
Procedure: read-request-body/knots a

Undocumented procedure.

@@ -1314,8 +1064,8 @@ true. -
-
Procedure: request-body-ended-prematurely-error? obj
+
+
Procedure: request-body-ended-prematurely-error? obj

Undocumented procedure.

@@ -1323,8 +1073,8 @@ true. -
-
Procedure: request-body-port/knots r
+
+
Procedure: request-body-port/knots a

Undocumented procedure.

@@ -1332,8 +1082,8 @@ true. -
-
Procedure: run-knots-web-server handler KEY: #:host #:family #:addr #:port #:socket #:read-request-exception-handler #:write-response-exception-handler #:connection-idle-timeout #:connection-buffer-size
+
+
Procedure: run-knots-web-server _ KEY: #:host #:family #:addr #:port #:socket #:read-request-exception-handler #:write-response-exception-handler #:connection-idle-timeout #:connection-buffer-size

Run the knots web server.

HANDLER should be a procedure that takes one argument, the HTTP request @@ -1342,7 +1092,7 @@ and returns two values, the response and response body.

For example, here is a simple "Hello, World!" server:

-
 (define (handler request)
+
 (define (handler request)
    (let ((body (read-request-body request)))
      (values '((content-type . (text/plain)))
              "Hello, World!")))
@@ -1357,8 +1107,8 @@ sending back to the client.
 
 
 
-

-
Procedure: sanitize-response request response body

+

+
Procedure: sanitize-response a b c

 
"Sanitize" the given response and body, making them appropriate for the
 given request.
 

@@ -1381,33 +1131,17 @@ procedure being called at any particular time.
 
 
 
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
[ << ][ < ][ Up ][ > ][ >> ]            [Top][Contents][Index][ ? ]

-
1.8.3 Record Types

+
+
+

1.8.3 Record Types

-
-
Record type: &request-body-ended-prematurely
+
+
Record type: &request-body-ended-prematurely

This record type has the following fields:

-
    -
  • -bytes-read
+
    +
  • bytes-read
@@ -1415,123 +1149,258 @@ procedure being called at any particular time. -
- - - - - - -
[Top][Contents][Index][ ? ]
-

About This Document

-

- This document was generated on June 24, 2025 using texi2html 5.0. -

-

- The buttons in the navigation panels have the following meaning: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Button Name Go to From 1.2.3 go to
[ << ] FastBackBeginning of this chapter or previous chapter1
[ < ] BackPrevious section in reading order1.2.2
[ Up ] UpUp section1.2
[ > ] ForwardNext section in reading order1.2.4
[ >> ] FastForwardNext chapter2
[Top] TopCover (top) of document  
[Contents] ContentsTable of contents  
[Index] IndexIndex  
[ ? ] AboutAbout (help)  
-

- where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure: -

- -
    -
  • 1. Section One -
      -
    • 1.1 Subsection One-One -
        -
      • ...
        • -
      -
      • -
    • 1.2 Subsection One-Two -
        -
      • 1.2.1 Subsubsection One-Two-One
        • -
      • 1.2.2 Subsubsection One-Two-Two
        • -
      • 1.2.3 Subsubsection One-Two-Three     - <== Current Position
        • -
      • 1.2.4 Subsubsection One-Two-Four
        • -
      -
      • -
    • 1.3 Subsection One-Three -
        -
      • ...
        • -
      -
      • -
    • 1.4 Subsection One-Four
      • -
    -
    • -
+
+
+
+
+

- - This document was generated on June 24, 2025 using texi2html 5.0. - -
+Next: , Previous: , Up: Overview   [Contents][Index]

+
+

Appendix A Version History

+
+
Version 0.Y.0, Month DD, 20YY
+
    +
  • No initial release has yet been made. +
+ +
+
+ + + +
+
+
+
+

+Next: , Previous: , Up: Overview   [Contents][Index]

+
+

Appendix B Copying Information

+ +

Copyright © 2024, 2025 Christopher Baines <mail@cbaines.net>

+

This library is free software; you can redistribute it and/or modify +it under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 3 of the +License, or (at your option) any later version. +

+ + + +
+
+
+
+

+Next: , Previous: , Up: Overview   [Contents][Index]

+
+

Concept Index

+ + + +
+
+ +
+
+

+Next: , Previous: , Up: Overview   [Contents][Index]

+
+

Procedure Index

+ +
+
Jump to:   C +   +D +   +F +   +M +   +N +   +P +   +R +   +S +   +T +   +W +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index EntrySection
C
call-with-resource-from-poolknots_resource-pool
call-with-threadknots_thread-pool
D
default-write-response-exception-handlerknots_web-server
destroy-resource-poolknots_resource-pool
destroy-thread-poolknots_thread-pool
F
fiberizeknots_parallelism
fibers-batch-for-eachknots_parallelism
fibers-batch-mapknots_parallelism
fibers-delayknots_promise
fibers-for-eachknots_parallelism
fibers-forceknots_promise
fibers-letknots_parallelism
fibers-mapknots_parallelism
fibers-map-with-progressknots_parallelism
fibers-parallelknots_parallelism
fibers-promise-resetknots_promise
fibers-promise-result-available?knots_promise
fibers-promise?knots_promise
fixed-size-thread-pool-channelknots_thread-pool
fixed-size-thread-pool-current-proceduresknots_thread-pool
fixed-size-thread-pool?knots_thread-pool
M
make-chunked-output-port/knotsknots_web-server
make-fixed-size-thread-poolknots_thread-pool
make-resource-poolknots_resource-pool
make-resource-pool-destroy-resource-exceptionknots_resource-pool
make-thread-poolknots_thread-pool
N
non-blocking-open-socket-for-uriknots_non-blocking
non-blocking-portknots_non-blocking
P
port-read-timeout-error?knots_timeout
port-timeout-error?knots_timeout
port-write-timeout-error?knots_timeout
R
read-request-body/knotsknots_web-server
request-body-ended-prematurely-error?knots_web-server
request-body-port/knotsknots_web-server
resource-pool-channelknots_resource-pool
resource-pool-configurationknots_resource-pool
resource-pool-destroy-resource-exception?knots_resource-pool
resource-pool-destroyed-error-poolknots_resource-pool
resource-pool-destroyed-error?knots_resource-pool
resource-pool-nameknots_resource-pool
resource-pool-statsknots_resource-pool
resource-pool-timeout-error-poolknots_resource-pool
resource-pool-timeout-error?knots_resource-pool
resource-pool-too-many-waiters-error-poolknots_resource-pool
resource-pool-too-many-waiters-error-waiters-countknots_resource-pool
resource-pool-too-many-waiters-error?knots_resource-pool
resource-pool?knots_resource-pool
run-knots-web-serverknots_web-server
S
sanitize-responseknots_web-server
set-thread-nameknots_thread-pool
spawn-queueing-fiberknots_queue
T
thread-nameknots_thread-pool
thread-pool-arguments-parameterknots_thread-pool
thread-pool-default-checkout-timeoutknots_thread-pool
thread-pool-resource-poolknots_thread-pool
thread-pool-timeout-error-poolknots_thread-pool
thread-pool-timeout-error?knots_thread-pool
thread-pool?knots_thread-pool
W
wait-until-port-readable-operationknots_timeout
wait-until-port-writable-operationknots_timeout
web-server-portknots_web-server
web-server-socketknots_web-server
web-server?knots_web-server
with-fibers-timeoutknots_timeout
with-port-timeoutsknots_timeout
with-resource-from-poolknots_resource-pool
+
Jump to:   C +   +D +   +F +   +M +   +N +   +P +   +R +   +S +   +T +   +W +   +
+
+ + +
+
+
+
+

+Previous: , Up: Overview   [Contents][Index]

+
+

Variable Index

+ +
+ + + + + + +
Index EntrySection
R
resource-pool-default-timeout-handlerknots_resource-pool
+
+ + +
+
+ + + From 5ae38d5d67572d7d329afeb903387bd93db790ed Mon Sep 17 00:00:00 2001 From: Automatic website updater <> Date: Tue, 24 Jun 2025 20:03:56 +0100 Subject: [PATCH 088/112] Automatic website update --- index.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/index.html b/index.html index ada69a3..7839641 100644 --- a/index.html +++ b/index.html @@ -21,6 +21,7 @@ a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter-printindex {text-decoration: none} div.example {margin-left: 3.2em} +h1.settitle {text-align:center} span:hover a.copiable-link {visibility: visible} strong.def-name {font-family: monospace; font-weight: bold; font-size: larger} td.printindex-index-entry {vertical-align: top} @@ -37,6 +38,8 @@ ul.toc-numbered-mark {list-style: none} +

Guile Knots

+
From 2e25c3b074ff218498631108559cdcb014e289c4 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 24 Jun 2025 21:07:29 +0200 Subject: [PATCH 089/112] Add workflow for building the website --- .forgejo/workflows/build-website.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .forgejo/workflows/build-website.yaml diff --git a/.forgejo/workflows/build-website.yaml b/.forgejo/workflows/build-website.yaml new file mode 100644 index 0000000..ac6261f --- /dev/null +++ b/.forgejo/workflows/build-website.yaml @@ -0,0 +1,22 @@ +on: + push: + branches: + - trunk +jobs: + test: + runs-on: host + steps: + - run: git clone --depth=1 https://$FORGEJO_TOKEN@forge.cbaines.net/cbaines/guile-knots.git knots-trunk + - run: git clone --depth=1 https://$FORGEJO_TOKEN@forge.cbaines.net/cbaines/guile-knots.git --branch=pages knots-pages + - run: | + cd knots-trunk + guix shell -D -f guix-dev.scm -- documenta api knots + guix shell texinfo -- makeinfo --css-ref=https://luis-felipe.gitlab.io/texinfo-css/static/css/texinfo-7.css --no-split --html -c SHOW_TITLE=true -o ../knots-pages/index.html doc/index.texi + + - run: | + cd knots-pages + git add . + git config user.email "" + git config user.name "Automatic website updater" + git commit -m "Automatic website update" + git push From edf62414eebb661729b6b6f564c6ce7a1be27d07 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 24 Jun 2025 21:14:52 +0200 Subject: [PATCH 090/112] Avoid workflow erroring if there's nothing to change --- .forgejo/workflows/build-website.yaml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.forgejo/workflows/build-website.yaml b/.forgejo/workflows/build-website.yaml index ac6261f..d859b76 100644 --- a/.forgejo/workflows/build-website.yaml +++ b/.forgejo/workflows/build-website.yaml @@ -16,7 +16,11 @@ jobs: - run: | cd knots-pages git add . - git config user.email "" - git config user.name "Automatic website updater" - git commit -m "Automatic website update" - git push + if [[ -z "$(git status -s)" ]]; then + echo "Nothing to push" + else + git config user.email "" + git config user.name "Automatic website updater" + git commit -m "Automatic website update" + git push + fi From 6ec3d0d039453af71a37a2e83970b2fa762ae63f Mon Sep 17 00:00:00 2001 From: Automatic website updater <> Date: Wed, 25 Jun 2025 17:52:47 +0100 Subject: [PATCH 091/112] Automatic website update --- index.html | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/index.html b/index.html index 7839641..0629ccb 100644 --- a/index.html +++ b/index.html @@ -226,12 +226,48 @@ Next: , +
+
Macro: parallelism-limiter? a
+

Undocumented macro. +

+
+ + + + +
+
Macro: with-parallelism-limiter a
+

Undocumented macro. +

+
+ + + +

1.2.2 Procedures

+
+
Procedure: call-with-parallelism-limiter a b
+

Undocumented procedure. +

+
+ + + + +
+
Procedure: destroy-parallelism-limiter a
+

Undocumented procedure. +

+
+ + + +
Procedure: fiberize _ KEY: #:parallelism #:input-channel #:process-channel

Undocumented procedure. @@ -286,6 +322,15 @@ Next: , +

+
Procedure: make-parallelism-limiter _ KEY: #:name
+

Undocumented procedure. +

+
+ + + +
@@ -506,6 +551,15 @@ available. Return the resource once PROC has returned. +
+
Procedure: make-fixed-size-resource-pool _ KEY: #:delay-logger #:duration-logger #:destructor #:scheduler #:name #:default-checkout-timeout #:default-max-waiters
+

Undocumented procedure. +

+
+ + + +
Procedure: make-resource-pool _ _ KEY: #:min-size #:idle-seconds #:delay-logger #:duration-logger #:destructor #:lifetime #:scheduler #:name #:add-resources-parallelism #:default-checkout-timeout #:default-max-waiters

Undocumented procedure. @@ -1270,11 +1324,13 @@ Next: , Pre Index EntrySection

C +call-with-parallelism-limiterknots_parallelism call-with-resource-from-poolknots_resource-pool call-with-threadknots_thread-pool
D default-write-response-exception-handlerknots_web-server +destroy-parallelism-limiterknots_parallelism destroy-resource-poolknots_resource-pool destroy-thread-poolknots_thread-pool
@@ -1298,7 +1354,9 @@ Next: , Pre
M make-chunked-output-port/knotsknots_web-server +make-fixed-size-resource-poolknots_resource-pool make-fixed-size-thread-poolknots_thread-pool +make-parallelism-limiterknots_parallelism make-resource-poolknots_resource-pool make-resource-pool-destroy-resource-exceptionknots_resource-pool make-thread-poolknots_thread-pool @@ -1308,6 +1366,7 @@ Next: , Pre non-blocking-portknots_non-blocking
P +parallelism-limiter?knots_parallelism port-read-timeout-error?knots_timeout port-timeout-error?knots_timeout port-write-timeout-error?knots_timeout @@ -1352,6 +1411,7 @@ Next: , Pre web-server-socketknots_web-server web-server?knots_web-server with-fibers-timeoutknots_timeout +with-parallelism-limiterknots_parallelism with-port-timeoutsknots_timeout with-resource-from-poolknots_resource-pool
From ab5411da423043f2b8a0e27c7507f8d9c34686a2 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 25 Jun 2025 18:46:46 +0200 Subject: [PATCH 092/112] Make resource pool changes and add parallelism limiter This was motivated by trying to allow for completely cleaning up resource pools, which involved removing their use of fiberize which currently has no destroy mechanism. As part of this, there's a new parallelism limiter mechanism using resource pools rather than fibers, and also a fixed size resource pool. The tests now drain? and destroy the resource pools to check cleaning up. --- knots/parallelism.scm | 38 ++- knots/resource-pool.scm | 719 ++++++++++++++++++++++++++++++++-------- tests.scm | 6 +- tests/parallelism.scm | 12 + tests/resource-pool.scm | 47 ++- 5 files changed, 669 insertions(+), 153 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index f8b2b8b..9e80f5b 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -20,6 +20,8 @@ (define-module (knots parallelism) #:use-module (srfi srfi-1) #:use-module (srfi srfi-71) + #:use-module (srfi srfi-9) + #:use-module (srfi srfi-9 gnu) #:use-module (ice-9 match) #:use-module (ice-9 control) #:use-module (ice-9 exceptions) @@ -27,6 +29,7 @@ #:use-module (fibers channels) #:use-module (fibers operations) #:use-module (knots) + #:use-module (knots resource-pool) #:export (fibers-batch-map fibers-map @@ -38,7 +41,13 @@ fibers-parallel fibers-let - fiberize)) + fiberize + + make-parallelism-limiter + parallelism-limiter? + destroy-parallelism-limiter + call-with-parallelism-limiter + with-parallelism-limiter)) (define (defer-to-parallel-fiber thunk) (let ((reply (make-channel))) @@ -287,3 +296,30 @@ (('result . vals) (apply values vals)) (('exception exn) (raise-exception exn)))))) + +(define-record-type + (make-parallelism-limiter-record resource-pool) + parallelism-limiter? + (resource-pool parallelism-limiter-resource-pool)) + +(define* (make-parallelism-limiter limit #:key (name "unnamed")) + (make-parallelism-limiter-record + (make-fixed-size-resource-pool + (iota limit) + #:name name))) + +(define (destroy-parallelism-limiter parallelism-limiter) + (destroy-resource-pool + (parallelism-limiter-resource-pool + parallelism-limiter))) + +(define* (call-with-parallelism-limiter parallelism-limiter thunk) + (call-with-resource-from-pool + (parallelism-limiter-resource-pool parallelism-limiter) + (lambda _ + (thunk)))) + +(define-syntax-rule (with-parallelism-limiter parallelism-limiter exp ...) + (call-with-parallelism-limiter + parallelism-limiter + (lambda () exp ...))) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index da52051..71c378c 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -32,9 +32,10 @@ #:use-module (fibers conditions) #:use-module (knots) #:use-module (knots parallelism) - #:export (resource-pool? - + #:export (make-fixed-size-resource-pool make-resource-pool + + resource-pool? resource-pool-name resource-pool-channel resource-pool-configuration @@ -91,6 +92,429 @@ (resource-pool-name resource-pool)) port))) +(define (remove-at-index! lst i) + (let ((start + end + (split-at! lst i))) + (append + start + (cdr end)))) + +(define* (make-fixed-size-resource-pool resources + #:key + (delay-logger (const #f)) + (duration-logger (const #f)) + destructor + scheduler + (name "unnamed") + default-checkout-timeout + default-max-waiters) + (define channel (make-channel)) + (define destroy-condition + (make-condition)) + + (define pool + (make-resource-pool-record + name + channel + destroy-condition + `((delay-logger . ,delay-logger) + (duration-logger . ,duration-logger) + (destructor . ,destructor) + (scheduler . ,scheduler) + (name . ,name) + (default-checkout-timeout . ,default-checkout-timeout) + (default-max-waiters . ,default-max-waiters)))) + + (define checkout-failure-count 0) + + (define (spawn-fiber-to-destroy-resource resource) + (spawn-fiber + (lambda () + (let loop () + (let ((success? + (with-exception-handler + (lambda _ #f) + (lambda () + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception running resource pool destructor (~A): ~A\n" + name + destructor) + (print-backtrace-and-exception/knots exn) + (raise-exception exn)) + (lambda () + (start-stack #t (destructor resource)) + #t))) + #:unwind? #t))) + + (if success? + (put-message channel + (list 'remove resource)) + (begin + (sleep 5) + + (loop)))))))) + + (define (spawn-fiber-for-checkout reply-channel + reply-timeout + resource) + (spawn-fiber + (lambda () + (let ((checkout-success? + (perform-operation + (choice-operation + (wrap-operation + (put-operation reply-channel + (cons 'success resource)) + (const #t)) + (wrap-operation (sleep-operation + reply-timeout) + (const #f)))))) + (unless checkout-success? + (put-message + channel + (list 'return-failed-checkout resource))))))) + + (define (destroy-loop resources) + (let loop ((resources resources)) + (match (get-message channel) + (('checkout reply timeout-time max-waiters) + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'resource-pool-destroyed + #f)))) + (perform-operation + (if timeout-time + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op))))) + (loop resources)) + (((and (or 'return + 'return-failed-checkout + 'remove) + return-type) + resource) + (when (and (not (eq? return-type 'remove)) + destructor) + (spawn-fiber-to-destroy-resource resource)) + + (let ((index + (list-index (lambda (x) + (eq? x resource)) + resources))) + (let ((new-resources + (if index + (remove-at-index! resources index) + (begin + (simple-format + (current-error-port) + "resource pool error: unable to remove ~A\n" + resource) + resources)))) + (if (null? new-resources) + (begin + (signal-condition! destroy-condition) + + ;; No loop + *unspecified*) + (loop new-resources))))) + + (('stats reply timeout-time) + (let ((stats + `((resources . ,(length resources)) + (available . 0) + (waiters . 0) + (checkout-failure-count . ,checkout-failure-count)))) + + (spawn-fiber + (lambda () + (let ((op + (put-operation reply stats))) + (perform-operation + (if timeout-time + (choice-operation + op + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second))) + op)))))) + + (loop resources)) + + (('destroy reply) + (loop resources)) + (unknown + (simple-format + (current-error-port) + "unrecognised message to ~A resource pool channel: ~A\n" + name + unknown) + (loop resources))))) + + (define (main-loop) + (let loop ((resources resources) + (available resources) + (waiters '())) + + (match (get-message channel) + (('checkout reply timeout-time max-waiters) + (if (null? available) + (let ((waiters-count + (length waiters))) + (if (and max-waiters + (>= waiters-count + max-waiters)) + (begin + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'too-many-waiters + waiters-count)))) + (perform-operation + (if timeout-time + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op))))) + (loop resources + available + waiters)) + (loop resources + available + (cons (cons reply timeout-time) + waiters)))) + + (if timeout-time + (let ((current-internal-time + (get-internal-real-time))) + ;; If this client is still waiting + (if (> timeout-time + current-internal-time) + (let ((reply-timeout + (/ (- timeout-time + current-internal-time) + internal-time-units-per-second))) + + ;; Don't sleep in this fiber, so spawn a new + ;; fiber to handle handing over the resource, + ;; and returning it if there's a timeout + (spawn-fiber-for-checkout reply + reply-timeout + (car available)) + (loop resources + (cdr available) + waiters)) + (loop resources + available + waiters))) + (begin + (put-message reply (cons 'success + (car available))) + + (loop resources + (cdr available) + waiters))))) + + (((and (or 'return + 'return-failed-checkout) + return-type) + resource) + + (when (eq? 'return-failed-checkout + return-type) + (set! checkout-failure-count + (+ 1 checkout-failure-count))) + + (if (null? waiters) + (loop resources + (cons resource available) + waiters) + + (let* ((current-internal-time (get-internal-real-time)) + (alive-waiters + dead-waiters + (partition! + (match-lambda + ((reply . timeout) + (or (not timeout) + (> timeout current-internal-time)))) + waiters))) + (if (null? alive-waiters) + (loop resources + (cons resource available) + '()) + (match (last alive-waiters) + ((waiter-channel . waiter-timeout) + (if waiter-timeout + (let ((reply-timeout + (/ (- waiter-timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's a + ;; timeout + (spawn-fiber-for-checkout waiter-channel + reply-timeout + resource)) + (put-message waiter-channel (cons 'success + resource))) + + (loop resources + available + (drop-right! alive-waiters 1)))))))) + + (('list-resources reply) + (spawn-fiber + (lambda () + (put-message reply (list-copy resources)))) + + (loop resources + available + waiters)) + + (('stats reply timeout-time) + (let ((stats + `((resources . ,(length resources)) + (available . ,(length available)) + (waiters . ,(length waiters)) + (checkout-failure-count . ,checkout-failure-count)))) + + (spawn-fiber + (lambda () + (let ((op + (put-operation reply stats))) + (perform-operation + (if timeout-time + (choice-operation + op + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second))) + op)))))) + + (loop resources + available + waiters)) + + (('destroy) + (if (and (null? resources) + (null? waiters)) + (signal-condition! + destroy-condition) + + (let ((current-internal-time (get-internal-real-time))) + (for-each + (match-lambda + ((reply . timeout) + (when (or (not timeout) + (> timeout current-internal-time)) + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'resource-pool-destroyed + #f)))) + (perform-operation + (if timeout + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op)))))))) + waiters) + + (if destructor + (begin + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + available) + (destroy-loop resources)) + (let dl ((resources resources) + (available available)) + (if (null? available) + (if (null? resources) + (signal-condition! + destroy-condition) + (destroy-loop resources)) + (let ((index + (list-index (lambda (x) + (eq? x (car available))) + resources))) + (dl (remove-at-index! resources index) + (cdr available))))))))) + + (unknown + (simple-format + (current-error-port) + "unrecognised message to ~A resource pool channel: ~A\n" + name + unknown) + (loop resources + available + waiters))))) + + (spawn-fiber + (lambda () + (with-exception-handler + (lambda (exn) + #f) + (lambda () + (with-exception-handler + (lambda (exn) + (let* ((stack (make-stack #t)) + (error-string + (call-with-output-string + (lambda (port) + (display-backtrace stack port 3) + (simple-format + port + "exception in the ~A pool fiber, " name) + (print-exception + port + (stack-ref stack 3) + '%exception + (list exn)))))) + (display error-string + (current-error-port))) + (raise-exception exn)) + (lambda () + (start-stack + #t + (main-loop))))) + #:unwind? #t)) + (or scheduler + (current-scheduler))) + + pool) + (define* (make-resource-pool return-new-resource max-size #:key (min-size 0) (idle-seconds #f) @@ -126,46 +550,52 @@ (define checkout-failure-count 0) - (define spawn-fiber-to-return-new-resource - (if add-resources-parallelism - (let ((thunk - (fiberize - (lambda () - (let ((max-size - (assq-ref (resource-pool-configuration pool) - 'max-size)) - (size (assq-ref (resource-pool-stats pool) - 'resources))) - (unless (= size max-size) - (let ((new-resource - (return-new-resource))) - (put-message channel - (list 'add-resource new-resource)))))) - #:parallelism add-resources-parallelism))) - (lambda () - (spawn-fiber thunk))) - (lambda () - (spawn-fiber - (lambda () - (let ((new-resource + (define return-new-resource/parallelism-limiter + (make-parallelism-limiter + (or add-resources-parallelism + max-size) + #:name + (string-append + name + " resource pool new resource parallelism limiter"))) + + (define (spawn-fiber-to-return-new-resource) + (spawn-fiber + (lambda () + (with-exception-handler + (lambda (exn) + ;; This can happen if the resource pool is destroyed very + ;; quickly + (unless (resource-pool-destroyed-error? exn) + (raise-exception exn))) + (lambda () + (with-parallelism-limiter + return-new-resource/parallelism-limiter + (let ((max-size + (assq-ref (resource-pool-configuration pool) + 'max-size)) + (size (assq-ref (resource-pool-stats pool #:timeout #f) + 'resources))) + (unless (= size max-size) + (with-exception-handler + (lambda _ #f) + (lambda () (with-exception-handler - (lambda _ #f) + (lambda (exn) + (simple-format + (current-error-port) + "exception adding resource to pool ~A: ~A\n\n" + name + return-new-resource) + (print-backtrace-and-exception/knots exn) + (raise-exception exn)) (lambda () - (with-exception-handler - (lambda (exn) - (simple-format - (current-error-port) - "exception adding resource to pool ~A: ~A\n\n" - name - return-new-resource) - (print-backtrace-and-exception/knots exn) - (raise-exception exn)) - (lambda () - (start-stack #t (return-new-resource))))) - #:unwind? #t))) - (when new-resource - (put-message channel - (list 'add-resource new-resource))))))))) + (let ((new-resource + (start-stack #t (return-new-resource)))) + (put-message channel + (list 'add-resource new-resource)))))) + #:unwind? #t))))) + #:unwind? #t)))) (define (spawn-fiber-to-destroy-resource resource) (spawn-fiber @@ -250,21 +680,14 @@ 'remove) return-type) resource) - (when destructor + (when (and (not (eq? return-type 'remove)) + destructor) (spawn-fiber-to-destroy-resource resource)) (let ((index (list-index (lambda (x) (eq? x resource)) resources))) - (define (remove-at-index! lst i) - (let ((start - end - (split-at! lst i))) - (append - start - (cdr end)))) - (let ((new-resources (if index (remove-at-index! resources index) @@ -276,13 +699,16 @@ resources)))) (if (null? new-resources) (begin + (and=> return-new-resource/parallelism-limiter + destroy-parallelism-limiter) + (signal-condition! destroy-condition) ;; No loop *unspecified*) (loop new-resources))))) - (('stats reply) + (('stats reply timeout-time) (let ((stats `((resources . ,(length resources)) (available . 0) @@ -291,13 +717,17 @@ (spawn-fiber (lambda () - (perform-operation - (choice-operation - (wrap-operation - (put-operation reply stats) - (const #t)) - (wrap-operation (sleep-operation 5) - (const #f))))))) + (let ((op + (put-operation reply stats))) + (perform-operation + (if timeout-time + (choice-operation + op + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second))) + op)))))) (loop resources)) @@ -537,14 +967,6 @@ (list-index (lambda (x) (eq? x resource)) resources))) - (define (remove-at-index! lst i) - (let ((start - end - (split-at! lst i))) - (append - start - (cdr end)))) - (loop (if index (remove-at-index! resources index) (begin @@ -577,7 +999,7 @@ waiters resources-last-used)) - (('stats reply) + (('stats reply timeout-time) (let ((stats `((resources . ,(length resources)) (available . ,(length available)) @@ -586,13 +1008,17 @@ (spawn-fiber (lambda () - (perform-operation - (choice-operation - (wrap-operation - (put-operation reply stats) - (const #t)) - (wrap-operation (sleep-operation 5) - (const #f))))))) + (let ((op + (put-operation reply stats))) + (perform-operation + (if timeout-time + (choice-operation + op + (sleep-operation + (/ (- timeout-time + (get-internal-real-time)) + internal-time-units-per-second))) + op)))))) (loop resources available @@ -645,46 +1071,52 @@ (signal-condition! destroy-condition) - (begin + (let ((current-internal-time (get-internal-real-time))) (for-each - (lambda (resource) - (if destructor - (spawn-fiber-to-destroy-resource resource) - (spawn-fiber - (lambda () - (put-message channel - (list 'remove resource))) - #:parallel? #t))) - available) - - (let ((current-internal-time (get-internal-real-time))) - (for-each - (match-lambda - ((reply . timeout) - (when (or (not timeout) - (> timeout current-internal-time)) - (spawn-fiber - (lambda () - (let ((op - (put-operation - reply - (cons 'resource-pool-destroyed - #f)))) - (perform-operation - (if timeout - (choice-operation - op - (wrap-operation - (sleep-operation - (/ (- timeout - (get-internal-real-time)) - internal-time-units-per-second)) - (const #f))) - op)))))))) - waiters)) - - (destroy-loop resources)))) + (match-lambda + ((reply . timeout) + (when (or (not timeout) + (> timeout current-internal-time)) + (spawn-fiber + (lambda () + (let ((op + (put-operation + reply + (cons 'resource-pool-destroyed + #f)))) + (perform-operation + (if timeout + (choice-operation + op + (wrap-operation + (sleep-operation + (/ (- timeout + (get-internal-real-time)) + internal-time-units-per-second)) + (const #f))) + op)))))))) + waiters) + (if destructor + (begin + (for-each + (lambda (resource) + (spawn-fiber-to-destroy-resource resource)) + available) + (destroy-loop resources)) + (let dl ((resources resources) + (available available)) + (if (null? available) + (if (null? resources) + (signal-condition! + destroy-condition) + (destroy-loop resources)) + (let ((index + (list-index (lambda (x) + (eq? x (car available))) + resources))) + (dl (remove-at-index! resources index) + (cdr available))))))))) (unknown (simple-format (current-error-port) @@ -744,7 +1176,8 @@ (put-operation (resource-pool-channel pool) (list 'destroy)) (lambda _ - (wait (resource-pool-destroy-condition pool)))) + (wait + (resource-pool-destroy-condition pool)))) (wait-operation (resource-pool-destroy-condition pool)))) #t) @@ -949,34 +1382,42 @@ available. Return the resource once PROC has returned." (lambda (resource) exp ...))) (define* (resource-pool-stats pool #:key (timeout 5)) - (let ((reply (make-channel)) - (start-time (get-internal-real-time))) - (perform-operation - (choice-operation - (wrap-operation - (put-operation (resource-pool-channel pool) - `(stats ,reply)) - (const #t)) - (wrap-operation (sleep-operation timeout) - (lambda _ - (raise-exception - (make-resource-pool-timeout-error pool)))))) + (if timeout + (let* ((reply (make-channel)) + (start-time (get-internal-real-time)) + (timeout-time + (+ start-time + (* internal-time-units-per-second timeout)))) + (perform-operation + (choice-operation + (wrap-operation + (put-operation (resource-pool-channel pool) + `(stats ,reply ,timeout-time)) + (const #t)) + (wrap-operation (sleep-operation timeout) + (lambda _ + (raise-exception + (make-resource-pool-timeout-error pool)))))) - (let ((time-remaining - (- timeout - (/ (- (get-internal-real-time) - start-time) - internal-time-units-per-second)))) - (if (> time-remaining 0) - (perform-operation - (choice-operation - (get-operation reply) - (wrap-operation (sleep-operation time-remaining) - (lambda _ - (raise-exception - (make-resource-pool-timeout-error pool)))))) - (raise-exception - (make-resource-pool-timeout-error pool)))))) + (let ((time-remaining + (- timeout + (/ (- (get-internal-real-time) + start-time) + internal-time-units-per-second)))) + (if (> time-remaining 0) + (perform-operation + (choice-operation + (get-operation reply) + (wrap-operation (sleep-operation time-remaining) + (lambda _ + (raise-exception + (make-resource-pool-timeout-error pool)))))) + (raise-exception + (make-resource-pool-timeout-error pool))))) + (let ((reply (make-channel))) + (put-message (resource-pool-channel pool) + `(stats ,reply #f)) + (get-message reply)))) (define (resource-pool-list-resources pool) (let ((reply (make-channel))) diff --git a/tests.scm b/tests.scm index 2b24c6a..a58eff0 100644 --- a/tests.scm +++ b/tests.scm @@ -4,7 +4,7 @@ #:export (run-fibers-for-tests assert-no-heap-growth)) -(define (run-fibers-for-tests thunk) +(define* (run-fibers-for-tests thunk #:key (drain? #t)) (let ((result (run-fibers (lambda () @@ -12,6 +12,7 @@ (lambda (exn) exn) (lambda () + (simple-format #t "running ~A\n" thunk) (with-exception-handler (lambda (exn) (backtrace) @@ -20,7 +21,8 @@ #t) #:unwind? #t)) #:hz 0 - #:parallelism 1))) + #:parallelism 1 + #:drain? drain?))) (if (exception? result) (raise-exception result) result))) diff --git a/tests/parallelism.scm b/tests/parallelism.scm index 9881a4d..03ec376 100644 --- a/tests/parallelism.scm +++ b/tests/parallelism.scm @@ -111,4 +111,16 @@ (assert-equal a 1)))) +(run-fibers-for-tests + (lambda () + (let ((parallelism-limiter (make-parallelism-limiter 2))) + (fibers-for-each + (lambda _ + (with-parallelism-limiter + parallelism-limiter + #f)) + (iota 50)) + + (destroy-parallelism-limiter parallelism-limiter)))) + (display "parallelism test finished successfully\n") diff --git a/tests/resource-pool.scm b/tests/resource-pool.scm index 1bc09e5..461d04b 100644 --- a/tests/resource-pool.scm +++ b/tests/resource-pool.scm @@ -19,7 +19,21 @@ (number? (with-resource-from-pool resource-pool res - res)))))) + res))) + + (destroy-resource-pool resource-pool)))) + +(run-fibers-for-tests + (lambda () + (let ((resource-pool (make-fixed-size-resource-pool + (list 1)))) + (assert-true + (number? + (with-resource-from-pool resource-pool + res + res))) + + (destroy-resource-pool resource-pool)))) (run-fibers-for-tests (lambda () @@ -31,7 +45,9 @@ (number? (with-resource-from-pool resource-pool res - res)))))) + res))) + + (destroy-resource-pool resource-pool)))) (let* ((error-constructor (record-constructor &resource-pool-timeout)) @@ -88,10 +104,13 @@ res)) (iota 20)) - (let loop ((stats (resource-pool-stats resource-pool))) + (let loop ((stats (resource-pool-stats resource-pool + #:timeout #f))) (unless (= 0 (assq-ref stats 'resources)) (sleep 0.1) - (loop (resource-pool-stats resource-pool))))))) + (loop (resource-pool-stats resource-pool #:timeout #f)))) + + (destroy-resource-pool resource-pool)))) (run-fibers-for-tests (lambda () @@ -115,7 +134,9 @@ (set! counter (+ 1 counter)) (error "collision detected"))))) 20 - (iota 50))))) + (iota 50)) + + (destroy-resource-pool resource-pool)))) (run-fibers-for-tests (lambda () @@ -129,7 +150,7 @@ (error "collision detected"))) (new-number)) 1 - #:default-checkout-timeout 120))) + #:default-checkout-timeout 5))) (fibers-batch-for-each (lambda _ (with-resource-from-pool @@ -140,7 +161,9 @@ (set! counter (+ 1 counter)) (error "collision detected"))))) 20 - (iota 50))))) + (iota 50)) + + (destroy-resource-pool resource-pool)))) (run-fibers-for-tests (lambda () @@ -164,14 +187,14 @@ (call-with-resource-from-pool resource-pool (lambda (res) - (error 'should-not-be-reached)))) + #f))) #:unwind? #t))) (while (= 0 (assq-ref - (resource-pool-stats resource-pool) + (resource-pool-stats resource-pool #:timeout #f) 'waiters)) - (sleep 0)) + (sleep 0.1)) (with-exception-handler (lambda (exn) @@ -184,6 +207,8 @@ resource-pool (lambda (res) (error 'should-not-be-reached)))) - #:unwind? #t)))))) + #:unwind? #t))) + + (destroy-resource-pool resource-pool)))) (display "resource-pool test finished successfully\n") From 09ca6cfb6bb24b94684f67daee5b1a8eae4aa3cb Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 26 Jun 2025 21:27:32 +0200 Subject: [PATCH 093/112] Fix resource-pool-destroy-resource-exception Raising the exception is more consistent, and avoids returning the resource. --- knots/resource-pool.scm | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 71c378c..e55bdac 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -1351,8 +1351,7 @@ available. Return the resource once PROC has returned." 'destroy 'return) resource)) - (unless (resource-pool-destroy-resource-exception? exn) - (raise-exception exn))) + (raise-exception exn)) (lambda () (with-exception-handler (lambda (exn) From 8f3e0a9a1d8572f4e96651ec0ded21717644c6bb Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 26 Jun 2025 22:53:15 +0200 Subject: [PATCH 094/112] Fix exception handling in fibers-map-with-progress --- knots/parallelism.scm | 8 ++++---- tests/parallelism.scm | 18 ++++++++++++++++++ 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index 9e80f5b..a3b04c7 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -217,9 +217,9 @@ (if (null? active-channels) (map (match-lambda - ((#f . ('exception . exn)) + ((#f . ('exception exn)) (raise-exception exn)) - ((#f . ('result . val)) + ((#f . ('result val)) val)) channels-to-results) (loop @@ -239,10 +239,10 @@ (if (eq? channel c) (cons #f (match result - (('exception . exn) + (('exception exn) result) (_ - (cons 'result result)))) + (list 'result result)))) (cons c r)))) channels-to-results))) #f)))) diff --git a/tests/parallelism.scm b/tests/parallelism.scm index 03ec376..91b2f3d 100644 --- a/tests/parallelism.scm +++ b/tests/parallelism.scm @@ -61,6 +61,24 @@ identity '(())))) +(run-fibers-for-tests + (lambda () + (with-exception-handler + (lambda (exn) + (unless (and (exception-with-message? exn) + (string=? (exception-message exn) + "foo")) + (raise-exception exn))) + (lambda () + (fibers-map-with-progress + (lambda _ + (raise-exception + (make-exception-with-message "foo"))) + '((1))) + + (error 'should-not-reach-here)) + #:unwind? #t))) + (run-fibers-for-tests (lambda () (with-exception-handler From 163d775496f8413fe5c1edb5ed22289df9d4fd01 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 27 Jun 2025 00:16:18 +0200 Subject: [PATCH 095/112] Fix record-predicate that should be exception-predicate --- knots/resource-pool.scm | 10 +++++----- knots/thread-pool.scm | 2 +- knots/timeout.scm | 6 +++--- knots/web-server.scm | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index e55bdac..7da76b0 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -74,7 +74,7 @@ (record-constructor &resource-pool-abort-add-resource)) (define resource-pool-abort-add-resource-error? - (record-predicate &resource-pool-abort-add-resource)) + (exception-predicate &resource-pool-abort-add-resource)) (define-record-type (make-resource-pool-record name channel destroy-condition configuration) @@ -1196,7 +1196,7 @@ (record-constructor &resource-pool-timeout)) (define resource-pool-timeout-error? - (record-predicate &resource-pool-timeout)) + (exception-predicate &resource-pool-timeout)) (define &resource-pool-too-many-waiters (make-exception-type '&recource-pool-too-many-waiters @@ -1217,7 +1217,7 @@ (record-constructor &resource-pool-too-many-waiters)) (define resource-pool-too-many-waiters-error? - (record-predicate &resource-pool-too-many-waiters)) + (exception-predicate &resource-pool-too-many-waiters)) (define &resource-pool-destroyed (make-exception-type '&recource-pool-destroyed @@ -1233,7 +1233,7 @@ (record-constructor &resource-pool-destroyed)) (define resource-pool-destroyed-error? - (record-predicate &resource-pool-destroyed)) + (exception-predicate &resource-pool-destroyed)) (define &resource-pool-destroy-resource (make-exception-type '&recource-pool-destroy-resource @@ -1244,7 +1244,7 @@ (record-constructor &resource-pool-destroy-resource)) (define resource-pool-destroy-resource-exception? - (record-predicate &resource-pool-destroy-resource)) + (exception-predicate &resource-pool-destroy-resource)) (define resource-pool-default-timeout-handler (make-parameter #f)) diff --git a/knots/thread-pool.scm b/knots/thread-pool.scm index b176162..70d7292 100644 --- a/knots/thread-pool.scm +++ b/knots/thread-pool.scm @@ -198,7 +198,7 @@ from there, or #f if that would be an empty string." (record-accessor &thread-pool-timeout-error 'pool))) (define thread-pool-timeout-error? - (record-predicate &thread-pool-timeout-error)) + (exception-predicate &thread-pool-timeout-error)) (define* (make-fixed-size-thread-pool size #:key diff --git a/knots/timeout.scm b/knots/timeout.scm index 58306e0..a65a095 100644 --- a/knots/timeout.scm +++ b/knots/timeout.scm @@ -85,7 +85,7 @@ (record-constructor &port-timeout-error)) (define port-timeout-error? - (record-predicate &port-timeout-error)) + (exception-predicate &port-timeout-error)) (define &port-read-timeout-error (make-exception-type '&port-read-timeout-error @@ -96,7 +96,7 @@ (record-constructor &port-read-timeout-error)) (define port-read-timeout-error? - (record-predicate &port-read-timeout-error)) + (exception-predicate &port-read-timeout-error)) (define &port-write-timeout-error (make-exception-type '&port-write-timeout-error @@ -107,7 +107,7 @@ (record-constructor &port-write-timeout-error)) (define port-write-timeout-error? - (record-predicate &port-write-timeout-error)) + (exception-predicate &port-write-timeout-error)) (define (readable? port) "Test if PORT is writable." diff --git a/knots/web-server.scm b/knots/web-server.scm index 453db44..a0a3641 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -130,7 +130,7 @@ closes PORT, unless KEEP-ALIVE? is true." (record-constructor &request-body-ended-prematurely)) (define request-body-ended-prematurely-error? - (record-predicate &request-body-ended-prematurely)) + (exception-predicate &request-body-ended-prematurely)) (define (request-body-port/knots r) (cond From d8f64399cd572fb1c6b19303ee710ce6529e77b4 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 27 Jun 2025 00:16:37 +0200 Subject: [PATCH 096/112] Tweak spacing --- knots/parallelism.scm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index a3b04c7..c98ca3f 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -217,9 +217,9 @@ (if (null? active-channels) (map (match-lambda - ((#f . ('exception exn)) + ((#f . ('exception exn)) (raise-exception exn)) - ((#f . ('result val)) + ((#f . ('result val)) val)) channels-to-results) (loop From 6f6d57b189a7073718407df263bbe3c1245f2e51 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 27 Jun 2025 00:16:41 +0200 Subject: [PATCH 097/112] Use the knots backtrace printer for tests --- tests.scm | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tests.scm b/tests.scm index a58eff0..0cca3b4 100644 --- a/tests.scm +++ b/tests.scm @@ -1,6 +1,7 @@ (define-module (tests) #:use-module (ice-9 exceptions) #:use-module (fibers) + #:use-module (knots) #:export (run-fibers-for-tests assert-no-heap-growth)) @@ -15,9 +16,10 @@ (simple-format #t "running ~A\n" thunk) (with-exception-handler (lambda (exn) - (backtrace) + (print-backtrace-and-exception/knots exn) (raise-exception exn)) - thunk) + (lambda () + (start-stack #t (thunk)))) #t) #:unwind? #t)) #:hz 0 From 4140ef0bd67dfed419203713df497f94b0ac2e45 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 27 Jun 2025 22:43:25 +0200 Subject: [PATCH 098/112] More consistently handle results and exceptions In the parallelism module. --- knots/parallelism.scm | 62 +++++++++++++++++++++---------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index c98ca3f..f15dbe8 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -22,6 +22,7 @@ #:use-module (srfi srfi-71) #:use-module (srfi srfi-9) #:use-module (srfi srfi-9 gnu) + #:use-module (srfi srfi-43) #:use-module (ice-9 match) #:use-module (ice-9 control) #:use-module (ice-9 exceptions) @@ -57,7 +58,7 @@ (lambda (exn) (put-message reply - (list 'exception exn))) + (cons 'exception exn))) (lambda () (with-exception-handler (lambda (exn) @@ -78,7 +79,7 @@ (lambda () (start-stack #t (thunk))) (lambda vals - (put-message reply vals)))))) + (put-message reply (cons 'result vals))))))) #:unwind? #t)) #:parallel? #t) reply)) @@ -88,10 +89,10 @@ reply-channels))) (map (match-lambda - (('exception exn) + (('exception . exn) (raise-exception exn)) - (result - (apply values result))) + (('result . vals) + (apply values vals))) responses))) (define (fibers-batch-map proc parallelism-limit . lists) @@ -114,9 +115,18 @@ (channel-indexes '())) (if (and (eq? #f next-to-process-index) (null? channel-indexes)) - (if (vector? (first lists)) - result-vec - (vector->list result-vec)) + (let ((processed-result-vec + (vector-map + (lambda (_ result-or-exn) + (match result-or-exn + (('exception . exn) + (raise-exception exn)) + (('result . vals) + (car vals)))) + result-vec))) + (if (vector? (first lists)) + processed-result-vec + (vector->list processed-result-vec))) (if (or (= (length channel-indexes) (min parallelism-limit vecs-length)) @@ -132,18 +142,13 @@ (get-operation (vector-ref result-vec index)) (lambda (result) - (match result - (('exception exn) - (raise-exception exn)) - (_ - (vector-set! result-vec - index - (first result)) - - (values next-to-process-index - (lset-difference = - channel-indexes - (list index)))))))) + (vector-set! result-vec + index + result) + (values next-to-process-index + (lset-difference = + channel-indexes + (list index)))))) channel-indexes))))) (loop new-index new-channel-indexes)) @@ -217,10 +222,10 @@ (if (null? active-channels) (map (match-lambda - ((#f . ('exception exn)) + ((#f . ('exception . exn)) (raise-exception exn)) - ((#f . ('result val)) - val)) + ((#f . ('result . vals)) + (car vals))) channels-to-results) (loop (perform-operation @@ -237,12 +242,7 @@ (map (match-lambda ((c . r) (if (eq? channel c) - (cons #f - (match result - (('exception exn) - result) - (_ - (list 'result result)))) + (cons #f result) (cons c r)))) channels-to-results))) #f)))) @@ -263,7 +263,7 @@ reply-channel (with-exception-handler (lambda (exn) - (list 'exception exn)) + (cons 'exception exn)) (lambda () (with-exception-handler (lambda (exn) @@ -294,7 +294,7 @@ (put-message input-channel (cons reply-channel args)) (match (get-message reply-channel) (('result . vals) (apply values vals)) - (('exception exn) + (('exception . exn) (raise-exception exn)))))) (define-record-type From 0fa6737a39f866bdbffc11fd16348c5411c11a7c Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Fri, 27 Jun 2025 23:28:47 +0200 Subject: [PATCH 099/112] Document some things --- knots/parallelism.scm | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/knots/parallelism.scm b/knots/parallelism.scm index f15dbe8..7631055 100644 --- a/knots/parallelism.scm +++ b/knots/parallelism.scm @@ -96,6 +96,9 @@ responses))) (define (fibers-batch-map proc parallelism-limit . lists) + "Map PROC over LISTS in parallel, with a PARALLELISM-LIMIT. If any of +the invocations of PROC raise an exception, this will be raised once +all of the calls to PROC have finished." (define vecs (map (lambda (list-or-vec) (if (vector? list-or-vec) list-or-vec @@ -171,9 +174,14 @@ channel-indexes))))))) (define (fibers-map proc . lists) + "Map PROC over LISTS in parallel, running up to 20 fibers in + PARALLEL. If any of the invocations of PROC raise an exception, this +will be raised once all of the calls to PROC have finished." (apply fibers-batch-map proc 20 lists)) (define (fibers-batch-for-each proc parallelism-limit . lists) + "Call PROC on LISTS, running up to PARALLELISM-LIMIT fibers in +parallel." (apply fibers-batch-map (lambda args (apply proc args) @@ -184,10 +192,13 @@ *unspecified*) (define (fibers-for-each proc . lists) + "Call PROC on LISTS, running up to 20 fibers in parallel." (apply fibers-batch-for-each proc 20 lists)) (define-syntax fibers-parallel (lambda (x) + "Run each expression in parallel. If any expression raises an + exception, this will be raised after all exceptions have finished." (syntax-case x () ((_ e0 ...) (with-syntax (((tmp0 ...) (generate-temporaries (syntax (e0 ...))))) @@ -198,12 +209,16 @@ (apply values (fetch-result-of-defered-thunks tmp0 ...)))))))) (define-syntax-rule (fibers-let ((v e) ...) b0 b1 ...) + "Let, but run each binding in a fiber in parallel." (call-with-values (lambda () (fibers-parallel e ...)) (lambda (v ...) b0 b1 ...))) (define* (fibers-map-with-progress proc lists #:key report) + "Map PROC over LISTS, calling #:REPORT if specified after each +invocation of PROC finishes. REPORT is passed the results for each + element of LISTS, or #f if no result has been received yet." (let loop ((channels-to-results (apply map (lambda args From adcb79ccd7e7db6fdaabaee36b7c30b59cd00266 Mon Sep 17 00:00:00 2001 From: Automatic website updater <> Date: Fri, 27 Jun 2025 23:40:31 +0100 Subject: [PATCH 100/112] Automatic website update --- index.html | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/index.html b/index.html index 0629ccb..34ccfa5 100644 --- a/index.html +++ b/index.html @@ -210,7 +210,7 @@ Next: ,
Macro: fibers-let a
-

Undocumented macro. +

Let, but run each binding in a fiber in parallel.

@@ -219,7 +219,8 @@ Next: ,
Macro: fibers-parallel a
-

Undocumented macro. +

Run each expression in parallel. If any expression raises an exception, +this will be raised after all exceptions have finished.

@@ -279,7 +280,7 @@ Next: ,
Procedure: fibers-batch-for-each a b . rest
-

Undocumented procedure. +

Call PROC on LISTS, running up to PARALLELISM-LIMIT fibers in parallel.

@@ -288,7 +289,9 @@ Next: ,
Procedure: fibers-batch-map a b . rest
-

Undocumented procedure. +

Map PROC over LISTS in parallel, with a PARALLELISM-LIMIT. If any of +the invocations of PROC raise an exception, this will be raised once all +of the calls to PROC have finished.

@@ -297,7 +300,7 @@ Next: ,
Procedure: fibers-for-each a . rest
-

Undocumented procedure. +

Call PROC on LISTS, running up to 20 fibers in parallel.

@@ -306,7 +309,9 @@ Next: ,
Procedure: fibers-map a . rest
-

Undocumented procedure. +

Map PROC over LISTS in parallel, running up to 20 fibers in PARALLEL. If +any of the invocations of PROC raise an exception, this will be raised +once all of the calls to PROC have finished.

@@ -315,7 +320,9 @@ Next: ,
Procedure: fibers-map-with-progress _ _ KEY: #:report
-

Undocumented procedure. +

Map PROC over LISTS, calling #:REPORT if specified after each invocation +of PROC finishes. REPORT is passed the results for each element of +LISTS, or #f if no result has been received yet.

From deae518b528485638bef89b4230616024f5009d7 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 29 Jun 2025 08:35:28 +0200 Subject: [PATCH 101/112] Use the buffer size for chunked output ports --- knots/web-server.scm | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index a0a3641..fec349e 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -333,7 +333,8 @@ on the procedure being called at any particular time." (define (handle-request handler client read-request-exception-handler - write-response-exception-handler) + write-response-exception-handler + buffer-size) (let ((request (with-exception-handler read-request-exception-handler @@ -399,7 +400,8 @@ on the procedure being called at any particular time." client (make-chunked-output-port/knots client - #:keep-alive? #t)))) + #:keep-alive? #t + #:buffering buffer-size)))) (set-port-encoding! body-port charset) (let ((body-written? (with-exception-handler @@ -472,7 +474,8 @@ on the procedure being called at any particular time." (else (let ((keep-alive? (handle-request handler client read-request-exception-handler - write-response-exception-handler))) + write-response-exception-handler + buffer-size))) (if keep-alive? (loop) (close-port client))))))) From 7709ffe1d33ac9da62189f725a64d59f729b4463 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 30 Jun 2025 15:41:04 +0200 Subject: [PATCH 102/112] Tweak the knots chunked output port To try and reduce the number of write syscalls. --- knots/web-server.scm | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index fec349e..3e5f388 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -63,6 +63,14 @@ (bind sock family addr port) sock)) +(define crlf-bv + (string->utf8 "\r\n")) + +(define (chunked-output-port-overhead-bytes write-size) + (+ (string-length (number->string write-size 16)) + (bytevector-length crlf-bv) + (bytevector-length crlf-bv))) + (define* (make-chunked-output-port/knots port #:key (keep-alive? #f) (buffering 1200)) "Returns a new port which translates non-encoded data into a HTTP @@ -74,10 +82,12 @@ when done, as it will output the remaining data, and encode the final zero chunk. When the port is closed it will also close PORT, unless KEEP-ALIVE? is true." (define (write! bv start count) - (put-string port (number->string count 16)) - (put-string port "\r\n") + (let ((len-string + (number->string count 16))) + (put-string port len-string)) + (put-bytevector port crlf-bv 0 2) (put-bytevector port bv start count) - (put-string port "\r\n") + (put-bytevector port crlf-bv 0 2) (force-output port) count) @@ -401,7 +411,10 @@ on the procedure being called at any particular time." (make-chunked-output-port/knots client #:keep-alive? #t - #:buffering buffer-size)))) + #:buffering + (- buffer-size + (chunked-output-port-overhead-bytes + buffer-size)))))) (set-port-encoding! body-port charset) (let ((body-written? (with-exception-handler From ce1b710bcf4b1874bdd06a6f96cb3e268f4b5895 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Mon, 30 Jun 2025 22:57:08 +0100 Subject: [PATCH 103/112] Use a queue for the resource pool waiters As this will maybe improve performance. --- knots/resource-pool.scm | 277 ++++++++++++++++++++-------------------- 1 file changed, 141 insertions(+), 136 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 7da76b0..b27f329 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -22,6 +22,7 @@ #:use-module (srfi srfi-9) #:use-module (srfi srfi-9 gnu) #:use-module (srfi srfi-71) + #:use-module (ice-9 q) #:use-module (ice-9 match) #:use-module (ice-9 exceptions) #:use-module (fibers) @@ -267,13 +268,13 @@ (define (main-loop) (let loop ((resources resources) (available resources) - (waiters '())) + (waiters (make-q))) (match (get-message channel) (('checkout reply timeout-time max-waiters) (if (null? available) (let ((waiters-count - (length waiters))) + (q-length waiters))) (if (and max-waiters (>= waiters-count max-waiters)) @@ -301,8 +302,7 @@ waiters)) (loop resources available - (cons (cons reply timeout-time) - waiters)))) + (enq! waiters (cons reply timeout-time))))) (if timeout-time (let ((current-internal-time @@ -345,44 +345,46 @@ (set! checkout-failure-count (+ 1 checkout-failure-count))) - (if (null? waiters) + (if (q-empty? waiters) (loop resources (cons resource available) waiters) - (let* ((current-internal-time (get-internal-real-time)) - (alive-waiters - dead-waiters - (partition! - (match-lambda - ((reply . timeout) - (or (not timeout) - (> timeout current-internal-time)))) - waiters))) - (if (null? alive-waiters) - (loop resources - (cons resource available) - '()) - (match (last alive-waiters) - ((waiter-channel . waiter-timeout) - (if waiter-timeout - (let ((reply-timeout - (/ (- waiter-timeout - current-internal-time) - internal-time-units-per-second))) - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout waiter-channel - reply-timeout - resource)) - (put-message waiter-channel (cons 'success - resource))) - - (loop resources - available - (drop-right! alive-waiters 1)))))))) + (let ((current-internal-time + (get-internal-real-time))) + (with-exception-handler + (lambda (exn) + (if (eq? (exception-kind exn) 'q-empty) + (loop resources + (cons resource available) + waiters) + (raise-exception exn))) + (lambda () + (let waiter-loop ((waiter (deq! waiters))) + (match waiter + ((reply . timeout) + (if (and timeout + (< timeout current-internal-time)) + (waiter-loop (deq! waiters)) + (begin + (if timeout + (let ((reply-timeout + (/ (- timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's + ;; a timeout + (spawn-fiber-for-checkout reply + reply-timeout + resource)) + (put-message reply (cons 'success + resource))) + (loop resources + available + waiters))))))) + #:unwind? #t)))) (('list-resources reply) (spawn-fiber @@ -397,7 +399,7 @@ (let ((stats `((resources . ,(length resources)) (available . ,(length available)) - (waiters . ,(length waiters)) + (waiters . ,(q-length waiters)) (checkout-failure-count . ,checkout-failure-count)))) (spawn-fiber @@ -420,7 +422,7 @@ (('destroy) (if (and (null? resources) - (null? waiters)) + (q-empty? waiters)) (signal-condition! destroy-condition) @@ -448,7 +450,7 @@ internal-time-units-per-second)) (const #f))) op)))))))) - waiters) + (car waiters)) (if destructor (begin @@ -747,7 +749,7 @@ (define (main-loop) (let loop ((resources '()) (available '()) - (waiters '()) + (waiters (make-q)) (resources-last-used '())) (match (get-message channel) @@ -769,50 +771,52 @@ (cons (get-internal-real-time) resources-last-used)))) - (if (null? waiters) + (if (q-empty? waiters) (loop (cons resource resources) (cons resource available) waiters (cons (get-internal-real-time) resources-last-used)) - (let* ((current-internal-time (get-internal-real-time)) - (alive-waiters - dead-waiters - (partition! - (match-lambda - ((reply . timeout) - (or (not timeout) - (> timeout current-internal-time)))) - waiters))) - (if (null? alive-waiters) - (loop (cons resource resources) - (cons resource available) - '() - (cons (get-internal-real-time) - resources-last-used)) - (match (last alive-waiters) - ((waiter-channel . waiter-timeout) - (if waiter-timeout - (let ((reply-timeout - (/ (- waiter-timeout - current-internal-time) - internal-time-units-per-second))) - ;; Don't sleep in this fiber, so spawn - ;; a new fiber to handle handing over - ;; the resource, and returning it if - ;; there's a timeout - (spawn-fiber-for-checkout waiter-channel - reply-timeout - resource)) - (put-message waiter-channel (cons 'success - resource))) - - (loop (cons resource resources) - available - (drop-right! alive-waiters 1) - (cons (get-internal-real-time) - resources-last-used))))))))) + (let ((current-internal-time + (get-internal-real-time))) + (with-exception-handler + (lambda (exn) + (if (eq? (exception-kind exn) 'q-empty) + (loop (cons resource resources) + (cons resource available) + waiters + (cons current-internal-time + resources-last-used)) + (raise-exception exn))) + (lambda () + (let waiter-loop ((waiter (deq! waiters))) + (match waiter + ((reply . timeout) + (if (and timeout + (< timeout current-internal-time)) + (waiter-loop (deq! waiters)) + (begin + (if timeout + (let ((reply-timeout + (/ (- timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's + ;; a timeout + (spawn-fiber-for-checkout reply + reply-timeout + resource)) + (put-message reply (cons 'success + resource))) + (loop (cons resource resources) + available + waiters + (cons current-internal-time + resources-last-used))))))) + #:unwind? #t)))))) (('checkout reply timeout-time max-waiters) (if (null? available) @@ -821,7 +825,7 @@ (spawn-fiber-to-return-new-resource)) (let ((waiters-count - (length waiters))) + (q-length waiters))) (if (and max-waiters (>= waiters-count max-waiters)) @@ -850,8 +854,7 @@ resources-last-used)) (loop resources available - (cons (cons reply timeout-time) - waiters) + (enq! waiters (cons reply timeout-time)) resources-last-used)))) (if timeout-time @@ -898,7 +901,7 @@ (set! checkout-failure-count (+ 1 checkout-failure-count))) - (if (null? waiters) + (if (q-empty? waiters) (loop resources (cons resource available) waiters @@ -911,56 +914,58 @@ (get-internal-real-time)) resources-last-used)) - (let* ((current-internal-time (get-internal-real-time)) - (alive-waiters - dead-waiters - (partition! - (match-lambda - ((reply . timeout) - (or (not timeout) - (> timeout current-internal-time)))) - waiters))) - (if (null? alive-waiters) - (loop resources - (cons resource available) - '() - (begin - (when (eq? return-type 'return) - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time))) - resources-last-used)) - (match (last alive-waiters) - ((waiter-channel . waiter-timeout) - (if waiter-timeout - (let ((reply-timeout - (/ (- waiter-timeout - current-internal-time) - internal-time-units-per-second))) - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's a - ;; timeout - (spawn-fiber-for-checkout waiter-channel - reply-timeout - resource)) - (put-message waiter-channel (cons 'success - resource))) - - (loop resources - available - (drop-right! alive-waiters 1) + (let ((current-internal-time + (get-internal-real-time))) + (with-exception-handler + (lambda (exn) + (if (eq? (exception-kind exn) 'q-empty) + (loop resources + (cons resource available) + waiters + (begin + (when (eq? return-type 'return) + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + current-internal-time)) + resources-last-used)) + (raise-exception exn))) + (lambda () + (let waiter-loop ((waiter (deq! waiters))) + (match waiter + ((reply . timeout) + (if (and timeout + (< timeout current-internal-time)) + (waiter-loop (deq! waiters)) (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used)))))))) + (if timeout + (let ((reply-timeout + (/ (- timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's + ;; a timeout + (spawn-fiber-for-checkout reply + reply-timeout + resource)) + (put-message reply (cons 'success + resource))) + (loop resources + available + waiters + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + current-internal-time) + resources-last-used)))))))) + #:unwind? #t)))) (('remove resource) (let ((index @@ -1003,7 +1008,7 @@ (let ((stats `((resources . ,(length resources)) (available . ,(length available)) - (waiters . ,(length waiters)) + (waiters . ,(q-length waiters)) (checkout-failure-count . ,checkout-failure-count)))) (spawn-fiber @@ -1067,7 +1072,7 @@ (('destroy) (if (and (null? resources) - (null? waiters)) + (q-empty? waiters)) (signal-condition! destroy-condition) @@ -1095,7 +1100,7 @@ internal-time-units-per-second)) (const #f))) op)))))))) - waiters) + (car waiters)) (if destructor (begin From ff93dc144284044255957de8870f0d848f8fa844 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 1 Jul 2025 12:45:12 +0100 Subject: [PATCH 104/112] Add a post-request-hook to the web server --- knots/web-server.scm | 51 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 41 insertions(+), 10 deletions(-) diff --git a/knots/web-server.scm b/knots/web-server.scm index 3e5f388..4d7240b 100644 --- a/knots/web-server.scm +++ b/knots/web-server.scm @@ -341,16 +341,19 @@ on the procedure being called at any particular time." (string->utf8 "internal server error"))) -(define (handle-request handler client - read-request-exception-handler - write-response-exception-handler - buffer-size) +(define* (handle-request handler client + read-request-exception-handler + write-response-exception-handler + buffer-size + #:key post-request-hook) (let ((request (with-exception-handler read-request-exception-handler (lambda () (read-request client)) - #:unwind? #t))) + #:unwind? #t)) + (read-request-time + (get-internal-real-time))) (let ((response body (cond @@ -399,7 +402,9 @@ on the procedure being called at any particular time." (lambda () (write-response response client) - (let ((body-written? + (let ((response-start-time + (get-internal-real-time)) + (body-written? (if (procedure? body) (let* ((type (response-content-type response '(text/plain))) @@ -438,6 +443,11 @@ on the procedure being called at any particular time." (if body-written? (begin (force-output client) + (when post-request-hook + (post-request-hook request + #:read-request-time read-request-time + #:response-start-time response-start-time + #:response-end-time (get-internal-real-time))) (when (and (procedure? body) (response-content-length response)) (set-port-encoding! client "ISO-8859-1")) @@ -449,7 +459,8 @@ on the procedure being called at any particular time." read-request-exception-handler write-response-exception-handler connection-idle-timeout - buffer-size) + buffer-size + post-request-hook) ;; Always disable Nagle's algorithm, as we handle buffering ;; ourselves; when we force-output, we really want the data to go ;; out. @@ -488,11 +499,28 @@ on the procedure being called at any particular time." (let ((keep-alive? (handle-request handler client read-request-exception-handler write-response-exception-handler - buffer-size))) + buffer-size + #:post-request-hook + post-request-hook))) (if keep-alive? (loop) (close-port client))))))) +(define (post-request-hook/safe post-request-hook) + (if post-request-hook + (lambda args + (with-exception-handler + (lambda (exn) #f) + (lambda () + (with-exception-handler + (lambda (exn) + (print-backtrace-and-exception/knots exn) + (raise-exception exn)) + (lambda () + (apply post-request-hook args)))) + #:unwind? #t)) + #f)) + (define-record-type (make-web-server socket port) web-server? @@ -512,7 +540,8 @@ on the procedure being called at any particular time." (write-response-exception-handler default-write-response-exception-handler) (connection-idle-timeout #f) - (connection-buffer-size 1024)) + (connection-buffer-size 1024) + post-request-hook) "Run the knots web server. HANDLER should be a procedure that takes one argument, the HTTP @@ -548,7 +577,9 @@ before sending back to the client." read-request-exception-handler write-response-exception-handler connection-idle-timeout - connection-buffer-size)) + connection-buffer-size + (post-request-hook/safe + post-request-hook))) #:parallel? #t) (loop)))))) From 4f0ddf2264de591ba6a4320df4277481397d3f35 Mon Sep 17 00:00:00 2001 From: Automatic website updater <> Date: Tue, 1 Jul 2025 12:45:46 +0100 Subject: [PATCH 105/112] Automatic website update --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 34ccfa5..df996f6 100644 --- a/index.html +++ b/index.html @@ -1147,7 +1147,7 @@ true.
-
Procedure: run-knots-web-server _ KEY: #:host #:family #:addr #:port #:socket #:read-request-exception-handler #:write-response-exception-handler #:connection-idle-timeout #:connection-buffer-size
+
Procedure: run-knots-web-server _ KEY: #:host #:family #:addr #:port #:socket #:read-request-exception-handler #:write-response-exception-handler #:connection-idle-timeout #:connection-buffer-size #:post-request-hook

Run the knots web server.

HANDLER should be a procedure that takes one argument, the HTTP request From ec2f2489a2394a9f426931cee2b7a4856349603e Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Tue, 1 Jul 2025 23:13:31 +0100 Subject: [PATCH 106/112] Fix resource pool bug And remove unnecessary named let. --- knots/resource-pool.scm | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index b27f329..6b28a27 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -1317,8 +1317,9 @@ available. Return the resource once PROC has returned." start-time) 'timeout) response)) - 'timeout))))) - (let loop ((reply (make-channel))) + 'timeout)) + 'timeout))) + (let ((reply (make-channel))) (put-message channel (list 'checkout reply From f4b48a149923fd5cb4ff77772f2fdcc0b694f676 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Sun, 6 Jul 2025 18:49:09 +0100 Subject: [PATCH 107/112] Avoid calling deq! if the queue is empty --- knots/resource-pool.scm | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 6b28a27..640978f 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -365,7 +365,11 @@ ((reply . timeout) (if (and timeout (< timeout current-internal-time)) - (waiter-loop (deq! waiters)) + (if (q-empty? waiters) + (loop resources + (cons resource available) + waiters) + (waiter-loop (deq! waiters))) (begin (if timeout (let ((reply-timeout @@ -795,7 +799,13 @@ ((reply . timeout) (if (and timeout (< timeout current-internal-time)) - (waiter-loop (deq! waiters)) + (if (q-empty? waiters) + (loop (cons resource resources) + (cons resource available) + waiters + (cons (get-internal-real-time) + resources-last-used)) + (waiter-loop (deq! waiters))) (begin (if timeout (let ((reply-timeout @@ -938,7 +948,19 @@ ((reply . timeout) (if (and timeout (< timeout current-internal-time)) - (waiter-loop (deq! waiters)) + (if (q-empty? waiters) + (loop resources + (cons resource available) + waiters + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + (get-internal-real-time)) + resources-last-used)) + (waiter-loop (deq! waiters))) (begin (if timeout (let ((reply-timeout From d18b5b8d5de5beff3b9f84cfb359b73a4dcf2070 Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Wed, 9 Jul 2025 12:06:20 +0100 Subject: [PATCH 108/112] Don't loop inside exception handlers The resource pools seemed to become slower and slower over time, this might help? --- knots/resource-pool.scm | 159 +++++++++++++++++----------------------- 1 file changed, 67 insertions(+), 92 deletions(-) diff --git a/knots/resource-pool.scm b/knots/resource-pool.scm index 640978f..6e9c353 100644 --- a/knots/resource-pool.scm +++ b/knots/resource-pool.scm @@ -365,30 +365,25 @@ ((reply . timeout) (if (and timeout (< timeout current-internal-time)) - (if (q-empty? waiters) - (loop resources - (cons resource available) - waiters) - (waiter-loop (deq! waiters))) - (begin - (if timeout - (let ((reply-timeout - (/ (- timeout - current-internal-time) - internal-time-units-per-second))) - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's - ;; a timeout - (spawn-fiber-for-checkout reply - reply-timeout - resource)) - (put-message reply (cons 'success - resource))) - (loop resources - available - waiters))))))) - #:unwind? #t)))) + (waiter-loop (deq! waiters)) + (if timeout + (let ((reply-timeout + (/ (- timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's + ;; a timeout + (spawn-fiber-for-checkout reply + reply-timeout + resource)) + (put-message reply (cons 'success + resource)))))))) + #:unwind? #t) + (loop resources + available + waiters)))) (('list-resources reply) (spawn-fiber @@ -799,34 +794,27 @@ ((reply . timeout) (if (and timeout (< timeout current-internal-time)) - (if (q-empty? waiters) - (loop (cons resource resources) - (cons resource available) - waiters - (cons (get-internal-real-time) - resources-last-used)) - (waiter-loop (deq! waiters))) - (begin - (if timeout - (let ((reply-timeout - (/ (- timeout - current-internal-time) - internal-time-units-per-second))) - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's - ;; a timeout - (spawn-fiber-for-checkout reply - reply-timeout - resource)) - (put-message reply (cons 'success - resource))) - (loop (cons resource resources) - available - waiters - (cons current-internal-time - resources-last-used))))))) - #:unwind? #t)))))) + (waiter-loop (deq! waiters)) + (if timeout + (let ((reply-timeout + (/ (- timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's + ;; a timeout + (spawn-fiber-for-checkout reply + reply-timeout + resource)) + (put-message reply (cons 'success + resource)))))))) + #:unwind? #t) + (loop (cons resource resources) + available + waiters + (cons current-internal-time + resources-last-used)))))) (('checkout reply timeout-time max-waiters) (if (null? available) @@ -948,46 +936,33 @@ ((reply . timeout) (if (and timeout (< timeout current-internal-time)) - (if (q-empty? waiters) - (loop resources - (cons resource available) - waiters - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - (get-internal-real-time)) - resources-last-used)) - (waiter-loop (deq! waiters))) - (begin - (if timeout - (let ((reply-timeout - (/ (- timeout - current-internal-time) - internal-time-units-per-second))) - ;; Don't sleep in this fiber, so spawn a - ;; new fiber to handle handing over the - ;; resource, and returning it if there's - ;; a timeout - (spawn-fiber-for-checkout reply - reply-timeout - resource)) - (put-message reply (cons 'success - resource))) - (loop resources - available - waiters - (begin - (list-set! - resources-last-used - (list-index (lambda (x) - (eq? x resource)) - resources) - current-internal-time) - resources-last-used)))))))) - #:unwind? #t)))) + (waiter-loop (deq! waiters)) + (if timeout + (let ((reply-timeout + (/ (- timeout + current-internal-time) + internal-time-units-per-second))) + ;; Don't sleep in this fiber, so spawn a + ;; new fiber to handle handing over the + ;; resource, and returning it if there's + ;; a timeout + (spawn-fiber-for-checkout reply + reply-timeout + resource)) + (put-message reply (cons 'success + resource)))))))) + #:unwind? #t) + (loop resources + available + waiters + (begin + (list-set! + resources-last-used + (list-index (lambda (x) + (eq? x resource)) + resources) + current-internal-time) + resources-last-used))))) (('remove resource) (let ((index From 4468a3ef6d27556db35b0c6d07f7c5110ae362cc Mon Sep 17 00:00:00 2001 From: Christopher Baines Date: Thu, 10 Jul 2025 16:11:45 +0100 Subject: [PATCH 109/112] Generate documentation for (knots) as well As enabled by Guile Documenta 0.4. --- .forgejo/workflows/build-website.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.forgejo/workflows/build-website.yaml b/.forgejo/workflows/build-website.yaml index d859b76..ab24066 100644 --- a/.forgejo/workflows/build-website.yaml +++ b/.forgejo/workflows/build-website.yaml @@ -10,7 +10,7 @@ jobs: - run: git clone --depth=1 https://$FORGEJO_TOKEN@forge.cbaines.net/cbaines/guile-knots.git --branch=pages knots-pages - run: | cd knots-trunk - guix shell -D -f guix-dev.scm -- documenta api knots + guix shell -D -f guix-dev.scm -- documenta api knots.scm knots guix shell texinfo -- makeinfo --css-ref=https://luis-felipe.gitlab.io/texinfo-css/static/css/texinfo-7.css --no-split --html -c SHOW_TITLE=true -o ../knots-pages/index.html doc/index.texi - run: | From a5f4c9feca654633e93213c3a9c7ffcb4a7c8ffa Mon Sep 17 00:00:00 2001 From: Automatic website updater <> Date: Thu, 10 Jul 2025 16:13:11 +0100 Subject: [PATCH 110/112] Automatic website update --- index.html | 1177 ++-------------------------------------------------- 1 file changed, 28 insertions(+), 1149 deletions(-) diff --git a/index.html b/index.html index df996f6..7039d11 100644 --- a/index.html +++ b/index.html @@ -20,7 +20,6 @@