commit fcb577f386e43e59c70613236bf9e8e992fa4dba Author: Randy Jordan Date: Sat Nov 16 13:48:36 2024 -0600 Initial Commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..53d1f3d --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2b7d9da --- /dev/null +++ b/Makefile @@ -0,0 +1,61 @@ +# Compiler Flags +CC := gcc +CFLAGS := -g -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer + +# Directory variables +LIBDIR := lib +OBJ := obj +INC := include +SRC := src +TEST := tests + +# Filepath Pattern Matching +LIB := $(LIBDIR)/lib.a +SRCS := $(wildcard $(SRC)/*.c) +OBJS := $(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SRCS)) +TESTS := $(wildcard $(TEST)/*.c) +TESTBINS := $(patsubst $(TEST)/%.c, $(TEST)/bin/%, $(TESTS)) + +# Commands must be labeled PHONY +.PHONY: all release clean test + +# Target for compilation. +all: $(LIB) + +# Compiler Release Flags +release: CFLAGS := -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer -O2 -DNDEBUG +release: clean $(LIB) + +# Dependancies +$(LIB): $(OBJS) | $(LIBDIR) + $(RM) $(LIB) + ar -cvrs $@ $^ + +$(OBJ)/%.o: $(SRC)/%.c $(SRC)/%.h | $(OBJ) + $(CC) $(CFLAGS) -c $< -o $@ + +$(OBJ)/%.o: $(SRC)/%.c | $(OBJ) + $(CC) $(CFLAGS) -c $< -o $@ + +$(TEST)/bin/%: $(TEST)/%.c $(LIB) | $(TEST)/bin + $(CC) $(CFLAGS) $< $(LIB) -o $@ + +# Make directories if none. +$(LIBDIR): + mkdir $@ + +$(INC): + mkdir $@ + +$(OBJ): + mkdir $@ + +$(TEST)/bin: + mkdir $@ + +# Run the tests in the bin folder. Parent folder is working dir, not test | bin. +test: $(LIB) $(TEST)/bin $(TESTBINS) + for test in $(TESTBINS); do ./$$test ; done + +clean: + $(RM) -r $(LIBDIR) $(OBJ) $(TEST)/bin/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..77cc4d1 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# onbsd + +## Description +Server / Client socket library, written in C. + +## Table of Contents + +- [Description](#description) +- [Features](#features) +- [Usage](#usage) +- [Credits / Resources](#credits--resources) +- [License](#license) + +## Features / TODOS + +- [ ] Select +- [ ] Epoll +- [ ] Server +- [ ] Client +- [ ] Custom Event Handling +- [ ] Distributed Task Queue + + +## Usage +`make` - to build project.
+`make test` - to build and test project.
+ +## Credits / Resources +[David Hanson - Interfaces and Implementations Repo](https://github.com/drh/cii)
+[Jacob Sorber](https://www.youtube.com/@JacobSorber)
+[Mongoose Webserver](https://mongoose.ws/)
+[Beej's Networking Guide](https://beej.us/guide/bgnet/)
+Unix Networking Programming - Richard Stevens, Bill Fenner, & Andrew Rudoff
+ +## License +This project is licensed under GPLv3 - see the [LICENSE](LICENSE) file for details. diff --git a/include/except.h b/include/except.h new file mode 100644 index 0000000..3034c5a --- /dev/null +++ b/include/except.h @@ -0,0 +1,96 @@ +#ifndef EXCEPT_INCLUDED +#define EXCEPT_INCLUDED + +#include +#include +#include +#include +#include +#include + +struct Exception { + const char *reason; +}; +typedef struct Exception Exception; + +struct ExceptFrame { + struct ExceptFrame *prev; // Exception Stack + jmp_buf env; // Enviroment Buffer + const char *file; // Exception File + int line; // Exception Line + const Exception *exception; // Exception Reason +}; +typedef struct ExceptFrame ExceptFrame; + +// Exception States +enum { EXCEPT_ENTERED=0, EXCEPT_RAISED, EXCEPT_HANDLED, EXCEPT_FINALIZED}; + +void except_raise(const Exception *e, const char *file,int line); // Raise exceptions +void hard_fail(const char* fmt, ...); // Errno and exit + +// External declarations +extern ExceptFrame *except_stack; // Global exception stack +extern const Exception assert_failed; // Forward declaration for assert. + +#undef ASSERT +#ifdef NDEBUG +#define ASSERT(e) ((void)0) +#define TEST(expr) +#else +extern void assert(int e); +#define ASSERT(e) ((void)((e)||(RAISE(assert_failed),0))) +#define TEST(expr) \ + do { \ + if (expr) { \ + printf(__DATE__" " __TIME__ " [%s@%d] " "\x1b[32m" "| PASSED | " "(%s)" "\x1b[0m \n", __FILE__, __LINE__, #expr); \ + } else { \ + printf(__DATE__" " __TIME__ " [%s@%d] " "\x1b[31m" "| FAILED | " "(%s)" "\x1b[0m \n", __FILE__, __LINE__, #expr); \ + } \ + } while (0) +#endif + +// Raise an Exception. +#define RAISE(e) except_raise(&(e), __FILE__, __LINE__) + +// Reraise the currect exception. +#define RERAISE except_raise(except_frame.exception, \ + except_frame.file, except_frame.line) + +// Switch to the previous exception frame and return. +#define RETURN switch (except_stack = except_stack->prev,0) default: return + +// Start a try block. +#define TRY do { \ + volatile int except_flag; \ + ExceptFrame except_frame; \ + except_frame.prev = except_stack; \ + except_stack = &except_frame; \ + except_flag = setjmp(except_frame.env); \ + if (except_flag == EXCEPT_ENTERED) { + +// Handle specific example. +#define EXCEPT(e) \ + if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \ + } else if (except_frame.exception == &(e)) { \ + except_flag = EXCEPT_HANDLED; + +// Catch all other exceptions. +#define ELSE \ + if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \ + } else { \ + except_flag = EXCEPT_HANDLED; + +// Execute finalization code. +#define FINALLY \ + if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \ + } { \ + if (except_flag == EXCEPT_ENTERED) \ + except_flag = EXCEPT_FINALIZED; + +// End Try block. +#define END_TRY \ + if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \ + } if (except_flag == EXCEPT_RAISED) RERAISE; \ +} while (0) + +#endif diff --git a/include/exectd.h b/include/exectd.h new file mode 100644 index 0000000..67477c5 --- /dev/null +++ b/include/exectd.h @@ -0,0 +1,46 @@ +#ifndef EXT_INCLUDED +#define EXT_INCLUDED + +#include +#include +#include +#include +#include +#include +#include +#include + +#define SA struct sockaddr +#define SA_IN struct sockaddr_in +#define MAX_EVENTS 10 + + +int ext_open(const char *path, int flags); +int ext_close(int fd); +int ext_invalidate(int *fd); + +FILE* ext_fopen(const char *path, const char *mode); +FILE* ext_fdopen(int fd, const char *mode); +int ext_fclose(FILE *stream); + +pid_t ext_fork(void); +int ext_dup2(int oldfd, int newfd); +int ext_pipe(int fds[2]); + +int bi_popen(const char* const command, FILE** const in, FILE** const out); +int bi_pclose(FILE** const in, FILE** const out, const int to_child[2], const int to_parent[2]); +int execute_job(const char *path, char *const argv[], char *const envp[]); + +int ext_socket(int domain, int type, int protocol); +int ext_bind(int sockfd, const SA *addr,socklen_t addrlen); +int ext_listen(int sockfd, int backlog); +int ext_connect(int sockfd,const SA *addr, socklen_t addrlen); +int ext_accept(int socket, SA *addr,socklen_t *addrlen); + +// Epoll or Fail +int ext_epoll_create(int flags); +int ext_epoll_ctl(int epfd, int op, int fd, uint32_t events); +int ext_setnonblocking(int fd); +int ext_epoll_wait(int epfd, struct epoll_event *events,int maxevents, int timeout); + +#endif diff --git a/include/mem.h b/include/mem.h new file mode 100644 index 0000000..c0d2808 --- /dev/null +++ b/include/mem.h @@ -0,0 +1,20 @@ +#ifndef MEM_INCLUDED +#define MEM_INCLUDED + +#include "except.h" +#include + +extern const Exception out_of_memory; // OOM Exception +extern void *mem_alloc (size_t nbytes,const char *file, int line); +extern void *mem_calloc(size_t count, size_t nbytes,const char *file, int line); +extern void mem_free(void *ptr, const char *file, int line); +extern void *mem_realloc(void *ptr, size_t nbytes, const char *file, int line); + +#define ALLOC(nbytes) mem_alloc((nbytes), __FILE__, __LINE__) +#define CALLOC(count, nbytes) mem_calloc((count), (nbytes), __FILE__, __LINE__) +#define NEW(p) ((p) = ALLOC((size_t)sizeof *(p))) +#define NEW0(p) ((p) = CALLOC(1, (size_t)sizeof *(p))) +#define FREE(ptr) ((void)(mem_free((ptr), __FILE__, __LINE__), (ptr) = 0)) +#define REALLOC(ptr, nbytes) ((ptr) = mem_realloc((ptr), (nbytes), __FILE__, __LINE__)) + +#endif diff --git a/include/onbsd.h b/include/onbsd.h new file mode 100644 index 0000000..9008db4 --- /dev/null +++ b/include/onbsd.h @@ -0,0 +1,54 @@ +#ifndef ONBSD_INCLUDED +#define ONBSD_INCLUDED +#include "exectd.h" + +enum { // Events we care about + EV_ERROR, // Error char *error_message + EV_OPEN, // Connection created NULL + EV_POLL, // mg_mgr_poll iteration uint64_t *uptime_millis + EV_CONNECT, // Connection established NULL + EV_ACCEPT, // Connection accepted NULL + EV_READ, // Data received from socket long *bytes_read + EV_WRITE, // Data written to socket long *bytes_written + EV_CLOSE, // Connection closed NULL + EV_HTTP_MSG, // Full HTTP request/response struct mg_http_message * + EV_READY // Epoll interest list is ready. +}; + +struct Mgr { // Manager for all of our connections. + struct Conn *conns; // List of active connections +}; +typedef struct Mgr Mgr; + +typedef struct Conn Conn; // Connection forward declaration. +typedef void (*CbFn)(struct Conn *, int ev,void *fn_data);// Conn EV Callback + +struct Conn { + struct Conn *next; // Linked list of connections + struct Mgr *mgr; // Our Context Manager + CbFn fn; // Our Connection Callback + void *fn_data; // Callback variable + struct sockaddr_in loc; // Local Address + struct sockaddr_in rem; // Remote Address + int fd; // Main File Descriptor + int epfd; // Epoll File Descriptor + unsigned long id; // Auto-incrementing unique connection ID + struct epoll_event ev; // Events we wait for + struct epoll_event events[MAX_EVENTS];// Event buffer + unsigned is_listening : 1; // Listening Server Connection + unsigned is_client : 1; // Outbound Client Connection + unsigned is_accepted : 1; // Accepted Server/Remote Connection + unsigned is_closing : 1; // Closing connection + unsigned is_working : 1; // Is busy +}; + +// Mgr and Connections +void init_mgr(Mgr *m); +Conn *mgr_listen(Mgr *m, int port, int interface, CbFn fn, void *fn_data); +Conn *mgr_accept(Conn *c, int fd, SA_IN addr); +Conn *mgr_connect(Mgr *m, CbFn fn, void *fn_data); +void handle_ev(Conn *c, int events); +void mgr_poll(Mgr *m, int timeout); +void use_fd(Mgr *m, Conn *c,int n); + +#endif diff --git a/src/except.c b/src/except.c new file mode 100644 index 0000000..f3c5119 --- /dev/null +++ b/src/except.c @@ -0,0 +1,46 @@ +#include "../include/except.h" +#include + +ExceptFrame *except_stack = NULL; // Global exception stack. +const Exception assert_failed = { "Assertion failed" }; // If ASSERT fails. + +void hard_fail(const char *fmt, ...){ // Error msg and exit. + int errno_save; + va_list ap; + // Any syscall or library can change errno, need to save it. + errno_save = errno; + + // Print out error fmt+args to stderr + va_start(ap,fmt); + vfprintf(stderr,fmt,ap); + fprintf(stderr,"\n"); + fflush(stderr); + + // Print out errno if it was set + if(errno_save != 0){ + fprintf(stderr,"ERRNO %d : %s\n",errno_save,strerror(errno_save)); + fflush(stderr); + } + va_end(ap); + exit(EXIT_FAILURE); +} +void except_raise(const Exception *e, const char *file,int line) { + // An exception was raised, grab the exception stack. + ExceptFrame *p = except_stack; + assert(e != NULL); // Ensure exception pointer is not NULL + if (p == NULL) { // Uncaught Exception + const char *msg = e->reason ? e->reason : "Uncaught Exception"; + hard_fail("%s | Address: 0x%p | Raised at %s@%d" ,msg,(void *)e,file,line); + } + // Set the exception details to the current frame. + p->exception = e; // Exception reason + p->file = file; + p->line = line; + // Move to the previous frame in the stack. + except_stack = except_stack->prev; + // Jump to the saved context environment. + longjmp(p->env, EXCEPT_RAISED); +} +void (assert)(int e) { + ASSERT(e); +} diff --git a/src/exectd.c b/src/exectd.c new file mode 100644 index 0000000..840a2aa --- /dev/null +++ b/src/exectd.c @@ -0,0 +1,277 @@ +#include "../include/exectd.h" +#include "../include/except.h" +#include +#include + +static const int READ_END = 0; +static const int WRITE_END = 1; +static const int INVALID_FD = -1; + +/*--------- FILE DESCRIPTORS ----------- */ +int ext_open(const char *path, int flags){ + int status = open(path,flags); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} +int ext_close(int fd){ + int status = close(fd); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} +int ext_invalidate(int *fd){ + int status = -1; + if (*fd != INVALID_FD) { + status = ext_close(*fd); + *fd = INVALID_FD; + } + return status; +} + +/*---------- FILE STREAMS ------------- */ +FILE *ext_fopen(const char *path, const char *mode){ + FILE *status = fopen(path,mode); + + if(status == NULL){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; + + +} +FILE *ext_fdopen(int fd, const char *mode){ + FILE *status = fdopen(fd,mode); + + if(status == NULL){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} +int ext_fclose(FILE *stream){ + int status = fclose(stream); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} + +/*---------- InterProcessComm ----------*/ +pid_t ext_fork(void){ + pid_t status = fork(); + + if (status < 0) { + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} +int ext_dup2(int oldfd, int newfd){ + int status = dup2(oldfd,newfd); + + if(status == -1 ){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} +int ext_pipe(int fds[2]){ + int status = pipe(fds); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} + +/*---------- Bi-directional Pipes -----*/ +int bi_pclose(FILE** const in, FILE** const out, const int to_child[2], const int to_parent[2]){ + if (*in != NULL) { + fclose(*in); + } + + if (*out != NULL) { + fclose(*out); + } + + for (int i = 0; i < 2; ++i) { + if (to_child[i] != INVALID_FD) { + close(to_child[i]); + } + if (to_parent[i] != INVALID_FD) { + close(to_parent[i]); + } + } + return EXIT_SUCCESS; +} +int bi_popen(const char* const command, FILE** const in, FILE** const out){ + // Exception error = { "bi_popen error"}; + int to_child[2] = { INVALID_FD, INVALID_FD }; + int to_parent[2] = { INVALID_FD, INVALID_FD }; + + *in = NULL; + *out = NULL; + pid_t pid = INVALID_FD; + + TRY { + ext_pipe(to_child); + ext_pipe(to_parent); + pid = ext_fork(); + + if(pid == 0 ){ // Child Process. + ext_dup2(to_child[READ_END], STDIN_FILENO); + ext_dup2(to_parent[WRITE_END], STDOUT_FILENO); + + execlp(command, command, NULL); + Exception e = { strerror(errno) }; + RAISE(e); + } + // Parent process. + ext_invalidate(&to_child[READ_END]); + ext_invalidate(&to_parent[WRITE_END]); + *in = ext_fdopen(to_parent[READ_END], "r"); + *out = ext_fdopen(to_child[WRITE_END], "w"); + } ELSE { + bi_pclose(in, out,to_child, to_parent); + exit(EXIT_FAILURE); + } END_TRY; + + to_parent[READ_END] = INVALID_FD; + to_child[WRITE_END] = INVALID_FD; + + setvbuf(*out, NULL, _IONBF, BUFSIZ); + return pid; +} +int execute_job( const char *path, char *const argv[], char *const envp[]){ + int result = -1; + TRY{ + + pid_t pid = ext_fork(); + + if(pid == 0){ // Child process + execve(path, argv, envp); + Exception e = { strerror(errno) }; + RAISE(e); + + } else { // Parent process + int wstatus; + wait(&wstatus); + + if(WIFEXITED(wstatus)){ // Normal exit + result = WEXITSTATUS(wstatus); + } + } + } ELSE { + exit(EXIT_FAILURE); + } END_TRY; + + return result; +} + +/*---------- Networking Sockets --------*/ +int ext_socket(int domain, int type, int protocol){ + int status = socket(domain,type,protocol); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + return status; +} +int ext_bind(int sockfd, const SA *addr,socklen_t addrlen){ + int status = bind(sockfd,addr,addrlen); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + + return status; +} +int ext_listen(int sockfd, int backlog){ + int status = listen(sockfd,backlog); + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + return status; +} +int ext_connect(int sockfd, const SA *addr, socklen_t addrlen){ + int status = connect(sockfd, addr,addrlen); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + }; + + return status; +} +int ext_accept(int sockfd, SA *addr, socklen_t *addrlen){ + int status = accept(sockfd,addr,addrlen); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + return status; +} + +/*---------- Epoll ---------------------*/ +int ext_epoll_create(int flags){ + int status = epoll_create1(flags); + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + return status; +} +int ext_epoll_ctl(int epfd, int op, int fd, uint32_t events){ + struct epoll_event ev; + ev.events = events; + ev.data.fd = fd; + int status = epoll_ctl(epfd, op, fd, &ev); + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + return status; + +} +int ext_setnonblocking(int fd){ + int status = fcntl(fd, F_SETFL, fcntl(fd, F_GETFL, 0) | O_NONBLOCK); + if(status == -1) { + Exception e = { strerror(errno) }; + RAISE(e); + + } + return status; +} +int ext_epoll_wait(int epfd, struct epoll_event *events,int maxevents, int timeout){ + int status = epoll_wait(epfd, events,maxevents,timeout); + + if(status == -1){ + Exception e = { strerror(errno) }; + RAISE(e); + } + return status; +} + diff --git a/src/mem.c b/src/mem.c new file mode 100644 index 0000000..7e03841 --- /dev/null +++ b/src/mem.c @@ -0,0 +1,58 @@ +#include "../include/except.h" +#include "../include/mem.h" +#include + +#define sizeof(x) (ptrdiff_t)sizeof(x) +#define NELEMS(a) (sizeof(a) / sizeof(*(a))) +#define LEN(s) (NELEMS(s) - 1) +const Exception out_of_memory = { "Out Of Memory" }; // OOM Exception. + + +void *mem_alloc(size_t nbytes, const char *file, int line){ + void *ptr; // Memory to allocate. + ASSERT(nbytes > 0); + ptr = malloc(nbytes); // Attempt allocation. + if (ptr == NULL){ // Out of memory, raise exception . + if (file == NULL) // Wasn't called by macro. + RAISE(out_of_memory); + else // Called by macro. + except_raise(&out_of_memory, file, line); + } + // Success, return allocated memory. + return ptr; +} +void *mem_calloc(size_t count, size_t nbytes,const char *file, int line) { + void *ptr; // Memory to allocate. + ASSERT(count > 0); + ASSERT(nbytes > 0); + ptr = calloc(count, nbytes);// Attempt allocation and zero out memory. + if (ptr == NULL){ // Out of memory raise exception. + if (file == NULL) // Wasn't called by macro. + RAISE(out_of_memory); + else // Was called by macro. + except_raise(&out_of_memory, file, line); + } + // Success, return allocated and zeroed memory. + return ptr; +} +void mem_free(void *ptr, const char *file, int line) { + (void) file; + (void) line; + if (ptr){// If we have valid pointer, free and null. + free(ptr); + ptr = NULL; + } +} +void *mem_realloc(void *ptr, size_t nbytes, const char *file, int line) { + ASSERT(ptr); + ASSERT(nbytes > 0); + ptr = realloc(ptr, nbytes); // Attempt reallocation. + if (ptr == NULL){ // Out of memory, raise exception. + if (file == NULL) // Wasn't called by macro. + RAISE(out_of_memory); + else // Called by macro. + except_raise(&out_of_memory, file, line); + } + // Success, return reallocated memory. + return ptr; +} diff --git a/src/onbsd.c b/src/onbsd.c new file mode 100644 index 0000000..6a8761d --- /dev/null +++ b/src/onbsd.c @@ -0,0 +1,150 @@ +#include "../include/onbsd.h" +#include "../include/exectd.h" +#include "../include/mem.h" + +#include + +void init_mgr(Mgr *m){ + memset(m, 0, sizeof(*m)); + m->conns = NULL; +} +Conn *mgr_listen(Mgr *m, int port, int interface, CbFn fn, void * fn_data){ + // Allocate listening connection. + Conn *c = CALLOC(1, sizeof(*c)); + c->is_listening = 1; + int on = 1; + + // Set the address options + c->loc.sin_family = AF_INET; + c->loc.sin_port = htons(port); + c->loc.sin_addr.s_addr = htonl(interface); + + // Create file descriptor for connection + c->fd = ext_socket(AF_INET, SOCK_STREAM, 0); + setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)); + ext_bind(c->fd, (SA *)&c->loc,sizeof(c->loc)); + ext_setnonblocking(c->fd); + ext_listen(c->fd, SOMAXCONN); + + // Create epollfd and subscribe events to connfd + c->fn = fn; + c->fn_data = fn_data; + c->epfd = ext_epoll_create(0); + c->ev.events = EPOLLIN|EPOLLET; + c->ev.data.fd = c->fd; + ext_epoll_ctl(c->epfd, EPOLL_CTL_ADD, c->fd, c->ev.events); + + // Pair the manager with the connection and then add it. + c->mgr = m; + c->next = m->conns; + m->conns = c; + fn(c,EV_OPEN,fn_data); + + return c; +} +Conn *mgr_accept(Conn *c, int fd, SA_IN addr){ + // Allocate and accept new remote connection. + Conn *nc = CALLOC(1,sizeof(*nc)); + nc->is_accepted = 1; + nc->fd = fd; + nc->rem = addr; + nc->loc = c->loc; + ext_setnonblocking(nc->fd); + + // Create epoll fd and subscribe to events. + nc->epfd = ext_epoll_create(0); + nc->ev.events = EPOLLIN | EPOLLOUT | EPOLLET | EPOLLRDHUP | EPOLLHUP | EPOLLERR; + nc->ev.data.fd = nc->fd; + ext_epoll_ctl(nc->epfd, EPOLL_CTL_ADD, nc->fd, nc->ev.events); + + // Set options and inherit connection details. + nc->mgr = c->mgr; + nc->fn = c->fn; + nc->fn_data = c->fn_data; + nc->next = c->mgr->conns; + c->mgr->conns = nc; + nc->fn(nc,EV_OPEN,nc->fn_data); + + return nc; +} +Conn *mgr_connect(Mgr *m, CbFn fn, void *fn_data){ + // Allocate listening connection. + Conn *c = CALLOC(1, sizeof(*c)); + c->is_client = 1; + + // Create file descriptor for connection + c->fd = ext_socket(AF_INET, SOCK_STREAM, 0); + SA_IN addr; + socklen_t addrlen = sizeof(addr); + addr.sin_family = AF_INET; + addr.sin_port = htons(3000); + c->loc.sin_port = htons(3000); + inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr); + c->loc.sin_addr = addr.sin_addr; + + ext_connect(c->fd, (SA *)&addr,addrlen); + ext_setnonblocking(c->fd); + c->rem = addr; + // Create epollfd and subscribe events to connfd + c->fn = fn; + c->fn_data = fn_data; + c->epfd = ext_epoll_create(0); + c->ev.events = EPOLLIN|EPOLLET|EPOLLOUT|EPOLLERR|EPOLLHUP|EPOLLRDHUP; + c->ev.data.fd = c->fd; + ext_epoll_ctl(c->epfd, EPOLL_CTL_ADD, c->fd, c->ev.events); + + // Pair the manager with the connection and then add it. + c->mgr = m; + c->next = m->conns; + m->conns = c; + fn(c,EV_OPEN,fn_data); + + return c; +} +void use_fd(Mgr *m, Conn *c, int n){ + (void)m; + if (c->events[n].events & EPOLLIN) { + // Accepted connection: read requests, write responses + char *buf[BUFSIZ]; + int b = read(c->fd, buf, BUFSIZ); + if (b < 0 && errno == EAGAIN) { + // No data yet, do nothing + } else if (b <= 0) { + c->is_closing = 1; + } else { + + c->fn(c, EV_READ,NULL); + } + } +} +void mgr_poll(Mgr *m, int timeout){ + Conn **head = &m->conns; + while (*head != NULL) { // Iterate over all connections. + Conn *c = *head; + if (c->is_closing) { // If they are closing we don't care about events + *head = c->next; // Remove connection from the list + c->fn(c, EV_CLOSE,c->fn_data); + ext_close(c->fd); + FREE(c); + } else { // Connection isn't closing, iterate over events on connection. + int nfds = ext_epoll_wait(c->epfd, c->events, MAX_EVENTS, timeout); + for (int n = 0; n < nfds; ++n) { + // Handle Listening Events + if(c->events[n].data.fd == c->fd && c->is_listening){ + SA_IN addr; + socklen_t addrlen = sizeof(addr); + int cli = ext_accept(c->events[n].data.fd,(SA *)&addr, &addrlen); + Conn *nc = mgr_accept(c, cli, addr); + (void)nc; + } else{ + use_fd(m,c,n); + + } + + } + c->fn(c,EV_POLL,c->fn_data); + head = &c->next; // Move to next connection + } + + } +} diff --git a/tests/01_server.c b/tests/01_server.c new file mode 100644 index 0000000..e870529 --- /dev/null +++ b/tests/01_server.c @@ -0,0 +1,59 @@ +#define DEBUG +#include "../include/onbsd.h" +#include + +void ev_handler(Conn *c, int events, void *ptr){ + (void)ptr; + switch(events){ + case EV_POLL: + if(c->is_listening){ + fprintf(stdout,"EV_POLL - Listening for connections on %s:%hu", inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port)); + } + if(c->is_accepted){ + fprintf(stdout,"EV_POLL - Remote connection %s:%hu", inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + } + if(c->is_client){ + fprintf(stdout,"EV_POLL - Local connection %s:%hu", inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port)); + } + break; + case EV_OPEN: + if(c->is_listening){ + fprintf(stdout,"EV_OPEN - Listening for connections on %s:%hu", inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port)); + } + if(c->is_accepted){ + fprintf(stdout,"EV_OPEN - Opening connection on %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + } + if(c->is_client){ + fprintf(stdout,"EV_OPEN - Opening connection on %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + } + break; + case EV_READ: + fprintf(stdout,"EV_READ - Reading connection %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + break; + case EV_CLOSE: + fprintf(stdout,"EV_CLOSE - Closing connections on %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + break; + default: + break; + } + fprintf(stdout,"\n"); + fflush(stdout); +} +int main(void){ + Mgr m; + init_mgr(&m); + mgr_listen(&m, 3000, INADDR_LOOPBACK, ev_handler, NULL); + + for(;;){ + mgr_poll(&m,5000); + } + return EXIT_SUCCESS; +} diff --git a/tests/02_client.c b/tests/02_client.c new file mode 100644 index 0000000..d876022 --- /dev/null +++ b/tests/02_client.c @@ -0,0 +1,62 @@ +#include "../include/onbsd.h" + +#include +#define PORT 3000 +#define DEBUG + +void ev_handler(Conn *c, int events, void *ptr){ + (void)ptr; + switch(events){ + case EV_POLL: + if(c->is_listening){ + fprintf(stdout,"EV_POLL - Listening for connections on %s:%hu", inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port)); + } + if(c->is_accepted){ + fprintf(stdout,"EV_POLL - Remote connection %s:%hu", inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + } + if(c->is_client){ + fprintf(stdout,"EV_POLL - Local connection %s:%hu", inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port)); + } + break; + case EV_OPEN: + if(c->is_listening){ + fprintf(stdout,"EV_OPEN - Listening for connections on %s:%hu", inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port)); + } + if(c->is_accepted){ + fprintf(stdout,"EV_OPEN - Opening connection on %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + } + if(c->is_client){ + fprintf(stdout,"EV_OPEN - Opening connection on %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + } + break; + case EV_READ: + fprintf(stdout,"EV_READ - Reading connection %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + break; + case EV_CLOSE: + fprintf(stdout,"EV_CLOSE - Closing connections on %s:%hu from %s:%hu", + inet_ntoa(c->loc.sin_addr), ntohs(c->loc.sin_port), + inet_ntoa(c->rem.sin_addr), ntohs(c->rem.sin_port)); + break; + default: + break; + } + fprintf(stdout,"\n"); + fflush(stdout); +} + +int main(void){ + Mgr c; + init_mgr(&c); + mgr_connect(&c,ev_handler,NULL); + + for(;;){ + mgr_poll(&c,3000); + } + return 0; + }