diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Network/HTTP/MicroClient.hs b/Network/HTTP/MicroClient.hs new file mode 100644 --- /dev/null +++ b/Network/HTTP/MicroClient.hs @@ -0,0 +1,501 @@ +{-# LANGUAGE BangPatterns, CPP, OverloadedStrings #-} + +-- |Minimal HTTP client implementation +-- +-- Note: this implementation only supports a subset of the HTTP +-- protocol for performance-reasons. This implementation is not +-- meant to be used for more than benchmarking purposes. +-- +-- See @doReq@ in @src-exe/uhttpc-bench.hs@ for an usage example of this API +-- +module Network.HTTP.MicroClient + ( -- * /Socket Stream/ abstract data type + SockStream + , ssFromSocket + , ssConnect + , ssToSocket + , ssClose + , ssId + , ssRead + , ssPeek + , ssPeekBuf + , ssRead' + , ssReadN + , ssUnRead + , ssWrite + , ssReadCnt + , ssWriteCnt + -- * HTTP Protocol Handling + , HttpResponse(..) + , HttpCode + , Method(..) + , ReqURI + , HostPort + , MsgHeader + , TransferEncoding(..) + , mkHttp11Req + , mkHttp11GetReq + , recvHttpResponse + -- ** internal helpers of 'recvHttpResponse' + , recvHttpHeaders + , httpHeaderGetInfos + , recvChunk + -- * Utilities + , getSockAddr + , splitUrl + , getPOSIXTimeSecs + , getPOSIXTimeUSecs + ) where + +import Control.Applicative +import Control.DeepSeq (NFData(rnf),deepseq) +import Control.Exception +import Control.Monad +import Data.ByteString (ByteString) +import qualified Data.ByteString as B +import Data.ByteString.Lex.Integral (packDecimal, readDecimal,readHexadecimal) +import qualified Data.ByteString.Unsafe as B +import Data.IORef +import Data.Maybe +import Data.Monoid +import Data.Tuple +import Data.Word +import Network +import Network.BSD +import Network.Socket hiding (send, sendTo, recv, recvFrom) +import Network.Socket.ByteString +import Network.URI +import System.IO.Error +import System.IO.Unsafe (unsafePerformIO) + +-- |Minimal socket input-stream abstraction w/ single pushback & consumed byte-count +-- +-- This abstraction is inspired by io-streams but is tuned for low-overhead +data SockStream = SockStream {-# NOUNPACK #-} !Socket + {-# UNPACK #-} !(IORef ByteString) + {-# UNPACK #-} !(IORef Word64) -- note: does contain readbuf's size + {-# UNPACK #-} !(IORef Word64) -- data written + {-# UNPACK #-} !Int -- hack: connection-id + +-- |Internal debug tracing helper +ssDebug :: String -> SockStream -> IO a -> IO a +#if 0 +ssDebug msg (SockStream _ bufref cntref _) act = do + cnt <- readIORef cntref + buf <- readIORef bufref + putStrLn $ "DEBUG: " ++ msg ++ " SockStream _ " ++ show buf ++ " " ++ show cnt + act +#else +ssDebug _ _ act = act +#endif + +-- hack +ssIdCounter :: IORef Int +ssIdCounter = unsafePerformIO $ newIORef 1 +{-# NOINLINE ssIdCounter #-} + +getSsCounterId :: IO Int +getSsCounterId = atomicModifyIORef' ssIdCounter (\n -> (n+1,n)) + +-- |Convert an existing 'Socket' into a 'SockStream' +ssFromSocket :: Socket -> IO SockStream +ssFromSocket s = SockStream s <$> newIORef B.empty <*> newIORef 0 <*> newIORef 0 <*> getSsCounterId + +-- |Access underlying 'Socket' +ssToSocket :: SockStream -> Socket +ssToSocket (SockStream s _ _ _ _) = s + +-- |Access 'SockStream' counter id +-- +-- Each created 'SockStream' wrapper has an unique counter id value associated +ssId :: SockStream -> Int +ssId (SockStream _ _ _ _ i) = i + +ssClose :: SockStream -> IO () +ssClose = close . ssToSocket + +-- |Wrapper that creates TCP/IP IPv4 'SocketStream' and connects to 'SockAddr' created with 'getSockAddr' +-- +-- If provided, the @Maybe SockAddr@ argument allows to locally +-- bind the socket to a specific source address. +ssConnect :: Maybe SockAddr -> SockAddr -> IO SockStream +ssConnect lsa rsa = + bracketOnError (socket AF_INET Stream tcpProtoNum) close $ \sock -> do + whenJust lsa (bind sock) + connect sock rsa + ssFromSocket sock +{-# INLINE ssConnect #-} + +-- |Read data from stream. +-- +-- Note: Returns empty string on EOF. It's often better to use 'ssRead'' instead. +ssRead :: SockStream -> IO ByteString +ssRead ss@(SockStream s bufref rcntref _ _) = ssDebug "ssRead" ss $ do + buf <- readIORef bufref + if B.null buf + then do + buf' <- recv s 32752 -- 32KiB - 16byte bytestring-overhead + modifyIORef' rcntref (+ (fromIntegral $ B.length buf')) + return buf' + else do + writeIORef bufref B.empty + return buf + +-- |Version of 'ssRead' that throws +ssRead' :: SockStream -> IO ByteString +ssRead' ss = do + buf <- ssRead ss + if B.null buf then ioError eofEx else return buf + where + eofEx = mkIOError eofErrorType "ssRead'" Nothing Nothing + +-- |Version of 'ssRead' which does not consume the data returned +-- +-- That is, @ssPeek ss@ is semantically equivalent to +-- @do { b <- ssRead ss; ssUnRead b ss; return b}@. +-- +-- 'ssPeek' is idempotent, i.e. @ssPeek ss == ssPeek ss >> ssPeek ss@ +ssPeek :: SockStream -> IO ByteString +ssPeek ss@(SockStream s bufref rcntref _ _) = ssDebug "ssPeek" ss $ do + buf <- readIORef bufref + if B.null buf + then do + buf' <- recv s 32752 -- 32KiB - 16byte bytestring-overhead + modifyIORef' rcntref (+ (fromIntegral $ B.length buf')) + writeIORef bufref buf' + return buf' + else do + return buf + +-- |May return empty string if no data has been buffered yet +ssPeekBuf :: SockStream -> IO ByteString +ssPeekBuf ss@(SockStream _ bufref _ _ _) = + ssDebug "ssPeekBuf" ss $ readIORef bufref + +-- |Read exactly n bytes from 'SocketStream'; throws exception if connection is closed +ssReadN :: SockStream -> Word64 -> IO ByteString +ssReadN ss@(SockStream s bufref rcntref _ _) l0 = ssDebug "ssRead'" ss $ do + buf <- readIORef bufref + let l = fromIntegral l0 + need = l - B.length buf + + if need <= 0 + then + atomicModifyIORef' bufref (swap . B.splitAt l) + else do + (res,buf') <- go need buf + let rcntdelta = B.length buf' + B.length res - B.length buf + writeIORef bufref $! buf' + modifyIORef' rcntref (+ fromIntegral rcntdelta) + return res + + where + go n bufa + | n > 0 = do + buf <- recv s 32752 + let l = B.length buf + if l > n + then -- more than enough (this is an optimization) + return (bufa <> B.unsafeTake n buf, B.unsafeDrop n buf) + else do -- not enough + unless (l>0) $ ioError eofEx + go (n-l) (bufa <> buf) + | n == 0 = return (bufa,B.empty) + | otherwise = return $ B.splitAt n bufa + + eofEx = mkIOError eofErrorType "ssReadN" Nothing Nothing + +-- |Push-back read data into 'SockStream' +ssUnRead :: ByteString -> SockStream -> IO () +ssUnRead buf0 ss@(SockStream _ bufref _ _ _) = + ssDebug "ssUnRead" ss $ modifyIORef' bufref (<> buf0) + +-- |Returns length of data consumed (i.e. w/o 'ssUnRead' data) +ssReadCnt :: SockStream -> IO Word64 +ssReadCnt ss@(SockStream _ bufref rcntref _ _) = ssDebug "ssReadCnt" ss $ do + buf <- readIORef bufref + rcnt <- readIORef rcntref + return $! rcnt - fromIntegral (B.length buf) + +-- |Write data out to socket (uses 'sendAll' internally) +ssWrite :: ByteString -> SockStream -> IO () +ssWrite buf ss@(SockStream s _ _ wcntref _) = ssDebug "ssWrite" ss $ + when (buflen /= 0) $ do + sendAll s buf + modifyIORef' wcntref (+ buflen) + where + buflen = fromIntegral $ B.length buf + +-- |Returns length of data written to stream +ssWriteCnt :: SockStream -> IO Word64 +ssWriteCnt (SockStream _ _ _ wcntref _) = readIORef wcntref + +---------------------------------------------------------------------------- +-- Helpers + +-- |Used by 'ssConnect' +tcpProtoNum :: ProtocolNumber +tcpProtoNum = unsafePerformIO $ getProtocolNumber "tcp" +{-# NOINLINE tcpProtoNum #-} + +-- |Construct IPv4 'SockAddr' +getSockAddr :: HostName -> PortNumber -> IO SockAddr +getSockAddr hostname port = do + he <- getHostByName hostname + return $! SockAddrInet port (hostAddress he) + +-- |HTTP status code +type HttpCode = Int + +-- |transfer-encoding/content-length information +data TransferEncoding = TeIdentity !Word64 -- ^ identity w/ content length + | TeChunked -- ^ chunked transfer + | TeInvalid + deriving (Show,Eq) + +instance NFData TransferEncoding + +-- |Extract information from the header lines as returned by 'recvHttpHeaders' +-- +-- returns: (status-code, close-conn, Just content-length /or/ Nothing (i.e. chunked)) +httpHeaderGetInfos :: [ByteString] -> (HttpCode, Bool, TransferEncoding) +httpHeaderGetInfos hds0 + | ver /= "HTTP/1.1" = error "unsupported HTTP version" + | otherwise = (code, connClose, if chunkTx then TeChunked else clen) + where + hds = init hds0 + (ver:code':_) = B.split 0x20 (last hds0) -- FIXME + + code | Just (n,_) <- readDecimal code' = n + | otherwise = -1 + + -- FIXME/TODO: find an efficient way to perform case-insensitive header-matching + connClose = "Connection: close" `elem` hds + chunkTx = "Transfer-Encoding: chunked" `elem` hds + + clen | (h:_) <- filter ("Content-Length: " `B.isPrefixOf`) hds = + case readDecimal (B.unsafeDrop 16 h) of + Just (n,_) -> TeIdentity n + Nothing -> TeInvalid + | otherwise = TeInvalid -- FIXME + + -- toLowerW8 w | 65 <= w, w <= 90 = w + 32 :: Word8 + -- | otherwise = w + +-- |Receive/consume HTTP response from 'SockStream' +-- +-- If no exception occured during 'recvHttpHeaders' the 'SockStream' +-- is left at the beginning of the (potentially empty) HTTP response +-- body. +recvHttpHeaders :: SockStream -> IO [ByteString] +recvHttpHeaders ss = do + res <- ssRead' ss + (buf,h0:hds) <- go $ httpParseHeader (res,[]) + unless (B.null h0) $ fail "recvHttpHeaders" + ssUnRead buf ss + return hds + where + go st@(res,hds) -- result of httpParseHeader invocation + | httpParseHeaderDone st = return st -- header parsing finished + | otherwise = do + buf <- ssRead' ss + go $ httpParseHeader (res <> buf,hds) + + -- note: headers are in reverse + httpParseHeader :: (ByteString,[ByteString]) -> (ByteString,[ByteString]) + httpParseHeader (s0,acc) + | Just i <- B.elemIndex 10 s0 = + let (line1,rest1) = (stripCR $ B.unsafeTake i s0, B.unsafeDrop (i+1) s0) + in (if B.null line1 then id else httpParseHeader) (rest1,line1:acc) + | otherwise = (s0, acc) -- need more data + + httpParseHeaderDone :: (ByteString,[ByteString]) -> Bool + httpParseHeaderDone (_,l:_) | B.null l = True + httpParseHeaderDone _ = False + +data HttpResponse = HttpResponse + { respCode :: !HttpCode -- ^ status code + , respKeepalive :: !Bool -- ^ whether server keeps connection open + , respContentLen :: !Word64 -- ^ content length + , respHeader :: [MsgHeader] -- ^ list of header lines w/o CRLF + , respContent :: [ByteString] -- ^ list of chunks + } deriving Show + +instance NFData HttpResponse where + rnf (HttpResponse _ _ _ h c) = h `deepseq` c `deepseq` () + +-- | Receive full HTTP response +recvHttpResponse :: SockStream -> IO HttpResponse +recvHttpResponse ss = do + hds <- recvHttpHeaders ss + let (code, needClose, te) = httpHeaderGetInfos hds + + (clen',body) <- case te of + TeIdentity n -> recvIdentityBody n + TeChunked -> recvChunkedBody + TeInvalid -> fail "invalid response w/ invalid transfer-encoding/content-length" + + return $! HttpResponse code (not needClose) clen' hds body + where + recvIdentityBody n = do + res <- ssReadN ss n + return (n, [res]) + + recvChunkedBody = do + res <- go' + return (fI $ sum $ map B.length res, res) + where + go' = do + bs <- recvChunk ss + if B.null bs + then return [] + else fmap (bs:) go' + +-- | Receive single HTTP chunk +recvChunk :: SockStream -> IO ByteString +recvChunk ss = go B.empty + where + go buf + | Just j <- B.elemIndex 10 buf = do + let (chunksize',rest) = (stripCR $ B.unsafeTake j buf, B.unsafeDrop (j+1) buf) + ssUnRead rest ss + chunksize <- maybe (fail "invalid chunk-size") return $ readHex chunksize' + bs <- ssReadN ss chunksize + dropCrLf + return bs + | otherwise = do -- no '\n' seen yet... need more data + buf' <- ssRead' ss + go (buf<>buf') + + dropCrLf = do + tmp <- ssReadN ss 2 + unless (tmp == "\r\n") $ fail "dropCrLf: expected CRLF" + + -- read positive hex + readHex bs | Just (n,rest) <- readHexadecimal bs, B.null rest, n>=0 = Just n + | otherwise = Nothing +{-# INLINE recvChunk #-} + +-- |Split HTTP URL into (hostname,port,url-path) +splitUrl :: String -> Either String (String,PortNumber,String) +splitUrl url0 = do + uri <- note "invalid URI" $ parseAbsoluteURI url0 + + unless (uriScheme uri == "http:") $ + Left "URI must have 'http' scheme" + + urlauth <- note "missing host-part in URI" $ uriAuthority uri + let hostname = uriRegName urlauth + + when (null hostname) $ + Left "empty hostname in URL" + + unless (null . uriUserInfo $ urlauth) $ + Left "user/pass in URL not supported" + + portnum <- case uriPort urlauth of + "" -> return 80 + ':':tmp -> return $! fromIntegral (read tmp :: Word) + _ -> Left "invalid port-number" + + return (hostname,portnum,if null (uriPath uri) then "/" else uriPath uri) + +-- | RFC2616 sec 5.1.1 @Method@ +data Method = GET | POST | HEAD | PUT | DELETE | TRACE | CONNECT | OPTIONS + deriving (Show,Eq,Enum) + +type ReqURI = ByteString -- ^ RFC2616 sec 5.1.2 @Request-URI@ (e.g. @"/pub/index.html"@) +type HostPort = ByteString -- ^ RFC2616 sec 14.3 @host [ ":" port ]@ (e.g. @"localhost:8001"@) +type MsgHeader = ByteString -- ^ RFC2616 sec 4.2 @message-header@ (e.g. @"Content-Type: text/plain"@ + +-- | Construct general HTTP/1.1 request. +mkHttp11Req :: Method + -> ReqURI + -> HostPort + -> Bool -- ^ if @False@ sets @Connection: close@ header + -> [MsgHeader] -- ^ additional HTTP request headers + -> (Maybe ByteString) -- ^ optional request body + -> ByteString -- ^ Request constructed as a 'ByteString' ready to be sent over the wire +mkHttp11Req method urlpath hostport keepalive xhdrs mbody = mconcat request + where + request = methStr:urlpath:" HTTP/1.1\r\nHost: ":hostport: + (if keepalive then "\r\n" else "\r\nConnection: close\r\n"): + addCrLf' bodydat xhdrs + + bodydat | Just body <- mbody = [ "Content-Length: ", (fromJust . packDecimal . B.length) body + , "\r\n\r\n" + , body + ] + | otherwise = ["\r\n"] + + addCrLf' :: [ByteString] -> [ByteString] -> [ByteString] + addCrLf' tl = go + where + go (x:xs) = x:"\r\n":go xs + go [] = tl + + methStr = case method of + GET -> "GET " + POST -> "POST " + HEAD -> "HEAD " + PUT -> "PUT " + DELETE -> "DELETE " + TRACE -> "TRACE " + CONNECT -> "CONNECT " + OPTIONS -> "OPTIONS " + +-- | Construct HTTP/1.1 @GET@ request. See 'mkHttp11Req' for constructing more general requests. +mkHttp11GetReq :: ReqURI -> HostPort -> Bool -> [MsgHeader] -> ByteString +mkHttp11GetReq urlpath hostport keepalive xhdrs = mkHttp11Req GET urlpath hostport keepalive xhdrs Nothing + +-- internal helpers + +-- | 'when' meets 'maybe' +whenJust :: Monad m => Maybe a -> (a -> m ()) -> m () +whenJust mb f = maybe (return ()) f mb +{-# INLINE whenJust #-} + +-- | Tag the 'Nothing' value of a 'Maybe' +note :: a -> Maybe b -> Either a b +note a = maybe (Left a) Right + +-- | Alias for 'fromIntegral' +fI :: (Integral a, Num b) => a -> b +fI = fromIntegral + +-- | Strip one trailing CR if there is one +stripCR :: ByteString -> ByteString +stripCR s + | B.null s = s +#if MIN_VERSION_bytestring(0,10,2) + | B.unsafeLast s == 0x0d = B.unsafeInit s +#else + | B.last s == 0x0d = B.init s +#endif + | otherwise = s + + +-- | Return the time as the number of seconds (with up to microsecond +-- precision) since the Epoch, @1970-01-01 00:00:00 +0000 (UTC)@. +-- +-- This is a faster implementation the code below useful for +-- benchmarking purposes. +-- +-- > import Data.Time.Clock.POSIX (getPOSIXTime) +-- > +-- > getPOSIXTimeSecs :: IO Double +-- > getPOSIXTimeSecs = fmap realToFrac getPOSIXTime +-- +-- Note: this function returns /NaN/ in case the underlying +-- @gettimeofday(2)@ call fails. +foreign import ccall "get_posix_time_secs" getPOSIXTimeSecs :: IO Double + +-- | Return the time as the number of microseconds since the Epoch, +-- @1970-01-01 00:00:00 +0000 (UTC)@. +-- +-- +-- Note: this function returns @0@ in case the underlying +-- @gettimeofday(2)@ call fails. +-- +-- See also 'getPOSIXTimeSecs' +foreign import ccall "get_posix_time_secs" getPOSIXTimeUSecs :: IO Word64 diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/cbits/get_posix_time.c b/cbits/get_posix_time.c new file mode 100644 --- /dev/null +++ b/cbits/get_posix_time.c @@ -0,0 +1,30 @@ +#include +#include +#include +#include + +// get POSIX time as FP value in seconds; returns NaN in case of error +double get_posix_time_secs(void) +{ + struct timeval tval = { 0, 0, }; + + if (gettimeofday(&tval, NULL)) +#ifdef NAN + return (NAN); +#else + return (0.0/0.0); +#endif + + return (((double) tval.tv_sec) + (((double) tval.tv_usec) / 1e6)); +} + +// returns number of microseconds since epoch; returns 0 in case of error +uint64_t get_posix_time_usecs(void) +{ + struct timeval tval = { 0, 0, }; + + if (gettimeofday(&tval, NULL)) + return 0; + + return ((((uint64_t)tval.tv_sec) * 1000000) + ((uint64_t) tval.tv_usec)); +} diff --git a/src-exe/uhttpc-bench.hs b/src-exe/uhttpc-bench.hs new file mode 100644 --- /dev/null +++ b/src-exe/uhttpc-bench.hs @@ -0,0 +1,337 @@ +{-# LANGUAGE OverloadedStrings, DeriveDataTypeable, RecordWildCards, BangPatterns #-} + +module Main (main) where + +import Control.Concurrent +import Control.Concurrent.Async +import Control.Monad +import Data.ByteString (ByteString) +import qualified Data.ByteString as B +import qualified Data.ByteString.Char8 as B8 +import Data.Data +import Data.IORef +import Data.List +import Data.Maybe +import Data.Monoid +import Data.Ord +import Data.Word +import GHC.Conc.Sync (numCapabilities,getNumProcessors) +import Network.HTTP.MicroClient +import Network.Socket hiding (send, sendTo, recv, recvFrom) +import System.Console.CmdArgs.Implicit +import System.IO +import System.Mem (performGC) +import Text.Printf + +-- |Timestamp in seconds since POSIX epoch +getTS :: IO TS +getTS = getPOSIXTimeSecs + +type TS = Double + +timeIO :: IO t -> IO (TS, TS, t) +timeIO act = do + ts0 <- getTS + res <- act + tsd <- fmap (subtract ts0) getTS + return $! tsd `seq` (ts0,tsd,res) + +fI :: (Integral a, Num b) => a -> b +fI = fromIntegral + +data Args = Args + { argNumReq :: Word + , argThrCnt :: Int + , argClnCnt :: Word + , argKeepAlive :: Bool + , argCsv :: FilePath + , argUA :: String + , argHdrs :: [String] + , argVerbose :: Bool + , argNoStats :: Bool + , argLAddr :: String + , argWait :: Double + , argUrl :: String + , argPostFn :: FilePath + } deriving (Show,Data,Typeable) + +defaultArgs :: Args +defaultArgs = Args + { argNumReq = 1 &= typ "num" &= name "n" &= explicit + &= help "number of requests (default: 1)" + , argThrCnt = numCapabilities &= typ "num" &= explicit &= name "t" + &= help ("threadcount (default: " ++ show numCapabilities ++ ")") + , argClnCnt = 1 &= typ "num" &= name "c" &= explicit + &= help "concurrent clients (default: 1)" + , argKeepAlive = def &= name "k" &= explicit + &= help "enable keep alive" + , argHdrs = def &= typ "str" &= name "H" &= explicit + &= help "add header to request" + , argUA = "uhttpc-bench" &= name "user-agent" &= explicit + &= help "specify User-Agent (default: \"httpc-bench\")" + , argCsv = def &= typFile &= name "csv" &= explicit + &= help "dump request timings as CSV (RFC4180) file" + , argVerbose = def &= name "v" &= name "verbose" &= explicit + &= help "enable more verbose statistics and output" + , argNoStats = def &= name "no-stats" &= explicit + &= help "disable statistics" + , argPostFn = def &= typFile &= name "p" &= explicit + &= help "perform POST request with file-content as body" + , argLAddr = def &= typ "addr" &= name "local-addr" &= explicit + &= help "set specific source address for TCP connections" + , argWait = def &= typ "sec" &= name "wait" &= explicit + &= help "wait time between requests (per client) in seconds" + , argUrl = def &= argPos 0 &= typ "" + } &= program "uttpc-bench" + &= summary "Simple HTTP benchmarking tool similiar to 'ab' and 'weighttp'" + + +main :: IO () +main = runInUnboundThread $ do + putStrLn "uhttpc-bench - a Haskell-based ab/weighttp-style webserver benchmarking tool\n" + + pargs <- cmdArgs defaultArgs + let verbose = argVerbose pargs + + (hostname,portnum,urlpath) <- either fail return $ splitUrl (argUrl pargs) + + -- sanity-check CLI arguments + unless (argNumReq pargs > 0) $ + fail "request-count must be > 0" + + unless (argClnCnt pargs > 0) $ + fail "client-count must be > 0" + + unless (argThrCnt pargs > 0) $ + fail "thread-count must be > 0" + + unless (argNumReq pargs >= argClnCnt pargs) $ + fail "request-count must be >= client-count" + + -- setup socket address + sa <- getSockAddr hostname portnum + lsa <- if null (argLAddr pargs) + then return Nothing + else fmap Just $ getSockAddr (argLAddr pargs) aNY_PORT + + when verbose $ + printf "connecting to %s (using local address %s)\n" (show sa) (maybe "*:*" show lsa) + + -- set up worker threads + when (fI (argThrCnt pargs) /= numCapabilities) $ + setNumCapabilities (fI $ argThrCnt pargs) + thrcnt' <- getNumCapabilities + + when (argThrCnt pargs > 1 && thrcnt' /= argThrCnt pargs) $ + fail "failed to set worker tread-count" + + numCpus <- getNumProcessors + + when (thrcnt' > numCpus) $ + printf "*WARNING* thread-count (%u) > cpu cores (%u)\n" thrcnt' numCpus + + when (thrcnt' > 1) $ + printf "using up to %u Haskell execution threads\n" thrcnt' + + unless (fI (argClnCnt pargs) >= thrcnt') $ + putStrLn "*WARNING* client-count should be >= thread-count" + + ---------------------------------------------------------------------------- + let isPost = not $ null (argPostFn pargs) + + rawreqb <- if isPost + then fmap Just $ B.readFile (argPostFn pargs) + else return Nothing + + let hdrs | null (argUA pargs) = map B8.pack (argHdrs pargs) + | otherwise = "User-Agent: " <> B8.pack (argUA pargs) : + map B8.pack (argHdrs pargs) + + rawreqblen = maybe 0 B.length rawreqb + rawreq = mkHttp11Req (if isPost then POST else GET) + (B8.pack urlpath) + ("Host: " <> B8.pack hostname <> ":" <> B8.pack (show portnum)) + (argKeepAlive pargs) + hdrs + rawreqb + + when verbose $ + printf "using %d-byte request message (%d-byte body):\n %s\n\n" (B.length rawreq) rawreqblen (show rawreq) + + putStrLn "starting benchmark..." + + reqCounter <- newIORef (fI (argNumReq pargs) :: Int) + + performGC + ts0' <- getTS + tss <- mapConcurrently (\() -> timeIO (doReqs lsa sa reqCounter rawreq (argWait pargs))) + (replicate (fI $ argClnCnt pargs) ()) + ts1' <- getTS + performGC + + numReqs' <- readIORef reqCounter + unless (numReqs' + fI (argClnCnt pargs) == 0) $ + fail "virtual clients exited prematurely!" + + unless (argNoStats pargs) $ do + when verbose $ do + putStrLn "\nper-client stats:\n" + + forM_ tss $ \(ts0,tdelta,ents') -> do + let n' = length ts' + ts' = map (\e -> entRespDone e - entConnect e) ents' + conncnt = length [ () | Entry {..} <- ents', entConnect /= entReqStart ] + + _ <- printf " client spawned +%.6f s, %d reqs (%d conns), %.1f req/s, finished in %.6f s\n" + (ts0-ts0') n' conncnt (fI n' / tdelta) tdelta + + unless (null ts') $ + printf " rtt min/avg/med/max = %.3f/%.3f/%.3f/%.3f ms\n" + (1000*minimum ts') (1000*avg ts') (1000*med ts') (1000*maximum ts') + putStrLn "" + + let allents = concatMap (\(_,_,ents) -> ents) tss + (rlen,clen) = foldl' (\(!r,!c) e -> (r + entRespRLen e,c + entRespCLen e)) (0,0) allents + conncnt = length [ () | Entry {..} <- allents, entConnect /= entReqStart ] + allts = [ entRespDone - entConnect | Entry {..} <- allents ] + statcodes = hist $ map entRespCode allents + + _ <- printf "finished in %.6f seconds, %d reqs (%d conns), %.1f req/s received\n" + (ts1'-ts0') (length allents) conncnt (fI (argNumReq pargs) / (ts1'-ts0')) + + putStrLn $ "status codes: " ++ intercalate ", " [ show y ++ " HTTP-" ++ show x | (x,y) <- statcodes ] + + _ <- printf "data received: %.3f KiB/s, %u bytes total (%u bytes http + %u bytes content)\n" + (fI rlen / (1024 * (ts1'-ts0'))) rlen (rlen-clen) clen + + when verbose $ do + let [q2,q9,q25,q50,q75,q91,q98] = summary7 (map (*1000) allts) + printf "rtt 2/9|25/50/75|91/98-th quantile = %.3f/%.3f | %.3f/%.3f/%.3f | %.3f/%.3f ms\n" q2 q9 q25 q50 q75 q91 q98 + + printf "rtt min/avg/max = %.3f/%.3f/%.3f ms\n" + (1000*minimum allts) (1000*avg allts) (1000*maximum allts) + + ---------------------------------------------------------------------------- + -- CSV dumping + unless (null $ argCsv pargs) $ do + putStrLn "dumping CSV..." + let allents = sortBy (comparing entConnect) $ concatMap (\(_,_,ents) -> ents) tss + withFile (argCsv pargs) WriteMode $ \h -> do + _ <- hPrintf h "timestamp_s,connect_ms,req_send_ms,resp_wait_ms,resp_recv_ms,resp_status,resp_total_bytes,resp_content_bytes,conn_id\r\n" + forM_ allents $ \Entry {..} -> + hPrintf h "%.6f,%.4f,%.4f,%.4f,%.4f,%d,%u,%u,%d\r\n" + entConnect + (1000 * (entReqStart - entConnect)) + (1000 * (entReqDone - entReqStart)) + (1000 * (entRespStart - entReqDone)) + (1000 * (entRespDone - entRespStart)) + entRespCode + entRespRLen + entRespCLen + entConnId + + ---------------------------------------------------------------------------- + + return () + where + avg :: [Double] -> Double + avg xs = sn / fI ln + where + (sn,ln) = foldl' go (0,0::Int) xs + go (!s,!l) x = (s+x,l+1) + + med :: [Double] -> Double + med xs = sort xs !! (l `div` 2) + where + l = length xs + + summary7 :: [Double] -> [Double] + summary7 xs = atIndices (sort xs) is + where + l = length xs + is = [ ((l-1)*q) `div` 100 | q <- [2,9,25,50,75,91,98] ] + + atIndices :: [a] -> [Int] -> [a] + atIndices _ [] = [] + atIndices [] _ = error "atIndices" + atIndices xs (i:is) = head xs' : atIndices xs' (map (subtract i) is) + where + xs' | i >= 0 = drop i xs + | otherwise = error "atIndices2" + + hist xs = [ (head g, length g) | g <- group (sort xs) ] + +-- |repeat executing 'doReq' until req-counter goes below 0 +doReqs :: Maybe SockAddr -> SockAddr -> IORef Int -> ByteString -> Double -> IO [Entry] +doReqs lsa sa cntref req wtime = go Nothing [] + where + go ss a = do + notDone <- decReqCounter cntref + if notDone + then do + (ss',r) <- doReq lsa sa ss req + when (wtimeUsecs > 0) $ threadDelay wtimeUsecs + go ss' (r:a) + else do + maybe (return ()) ssClose ss + return a + + wtimeUsecs = floor $ 1000000 * wtime + + decReqCounter cnt = atomicModifyIORef' cnt (\n -> (n-1,n>0)) + +-- |single measurement entry +data Entry = Entry + { entConnId :: {-# UNPACK #-} !Int -- each connections gets a new id + , entRespCode :: {-# UNPACK #-} !HttpCode + , entRespRLen :: {-# UNPACK #-} !Word64 -- total amount of data received + , entRespCLen :: {-# UNPACK #-} !Word64 -- payload content-length + , entConnect :: {-# UNPACK #-} !TS -- ts at connection-startup + , entReqStart :: {-# UNPACK #-} !TS -- ts before sending request + , entReqDone :: {-# UNPACK #-} !TS -- ts after sending request + , entRespStart :: {-# UNPACK #-} !TS -- ts when response starts being received + , entRespDone :: {-# UNPACK #-} !TS -- ts when full response has been received + } deriving (Show) + +doReq :: Maybe SockAddr -> SockAddr -> Maybe SockStream -> ByteString -> IO (Maybe SockStream,Entry) +doReq lsa sa mss rawreq = do + (ss,mt0) <- case mss of + Just ss' -> return (ss',Nothing) + Nothing -> do + t0' <- getTS + ss' <- ssConnect lsa sa + return (ss',Just t0') + + t1 <- getTS -- before request is sent (and socket is already connected) + ssWrite rawreq ss + t1' <- getTS -- after request has been sent + + _ <- ssPeek ss + t2 <- getTS -- after first packet of response has been received + + rcnt0 <- ssReadCnt ss + + -- read HTTP response + HttpResponse {..} <- recvHttpResponse ss + + t2' <- getTS -- after full response has been received + rcnt1 <- ssReadCnt ss + + -- sanity check + tmp <- ssPeekBuf ss + unless (B.null tmp) $ + fail "trailing garbage detected in server response -- aborting" + + -- keep-alive handling + ss' <- if respKeepalive + then + return (Just ss) + else do + ssClose ss + return Nothing + + let ent = Entry (ssId ss) respCode (rcnt1-rcnt0) respContentLen (fromMaybe t1 mt0) t1 t1' t2 t2' + + return $! strictPair ss' ent + where + strictPair !a !b = (a,b) diff --git a/uhttpc.cabal b/uhttpc.cabal new file mode 100644 --- /dev/null +++ b/uhttpc.cabal @@ -0,0 +1,69 @@ +name: uhttpc +version: 0.1.0.0 +synopsis: Minimal HTTP client library optimized for benchmarking +homepage: https://github.com/hvr/uhttpc +license: GPL-3 +license-file: LICENSE +author: Herbert Valerio Riedel +maintainer: hvr@gnu.org +copyright: © 2013 Herbert Valerio Riedel +category: Network +build-type: Simple +cabal-version: >=1.10 +description: + @uhttpc@ contains a simple low-level and lightweight Haskell + + library optimized for providing the bare minimum required for HTTP + benchmarking purposes and allowing for time measurements of the + individual phases of the HTTP transaction. + . + This package also provides the command-line tool @uhttpc-bench@ as an + usage example which mimics the popular + HTTP benchmarking tool's + CLI. + . + WARNING: @uhttpc@ was originally developed for evaluating the new + + introduced with GHC 7.8 and provide a base-line for HTTP client libraries. + However, this is not a fully RFC compliant HTTP client library and + therefore ought not be used as a general purpose HTTP + implementation; Use libraries such as + + instead which aim toward full RFC compliance as well as having good + performance. + +library + default-language: Haskell2010 + other-extensions: BangPatterns, CPP, OverloadedStrings + exposed-modules: Network.HTTP.MicroClient + ghc-options: -Wall -fwarn-tabs + c-sources: cbits/get_posix_time.c + build-depends: + base >=4.6 && <4.8, + bytestring ==0.10.*, + network >=2.4.0.1 && <2.6, + bytestring-lexing ==0.4.*, + deepseq ==1.3.* + +executable uhttpc-bench + default-language: Haskell2010 + other-extensions: BangPatterns, DeriveDataTypeable, OverloadedStrings, RecordWildCards + hs-source-dirs: src-exe + main-is: uhttpc-bench.hs + ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -threaded -rtsopts + build-depends: + uhttpc, + -- uhttpc-lib's build-deps don't need to restate version bounds + base, + bytestring, + bytestring-lexing, + network, + -- build-deps which need version bounds + async ==2.0.*, + bytestring-lexing ==0.4.*, + cmdargs ==0.10.* + + +Source-Repository head + Type: git + Location: https://github.com/hvr/uhttpc.git