diff options
| -rw-r--r-- | COPYING | 674 | ||||
| -rw-r--r-- | Makefile | 59 | ||||
| -rw-r--r-- | README.md | 155 | ||||
| -rw-r--r-- | include/codexion.h | 142 | ||||
| -rw-r--r-- | src/destroy.c | 66 | ||||
| -rw-r--r-- | src/forks.c | 75 | ||||
| -rw-r--r-- | src/free_memory.c | 38 | ||||
| -rw-r--r-- | src/init.c | 66 | ||||
| -rw-r--r-- | src/main.c | 39 | ||||
| -rw-r--r-- | src/monitoring.c | 44 | ||||
| -rw-r--r-- | src/philos.c | 83 | ||||
| -rw-r--r-- | src/print.c | 45 | ||||
| -rw-r--r-- | src/queue.c | 55 | ||||
| -rw-r--r-- | src/routine.c | 57 | ||||
| -rw-r--r-- | src/scheduler.c | 86 | ||||
| -rw-r--r-- | src/sim.c | 23 | ||||
| -rw-r--r-- | src/starve.c | 84 | ||||
| -rw-r--r-- | src/threads.c | 93 | ||||
| -rw-r--r-- | src/time.c | 29 | ||||
| -rw-r--r-- | src/utils.c | 20 | ||||
| -rw-r--r-- | src/utils_routine.c | 81 | ||||
| -rw-r--r-- | src/validate_parameters.c | 30 |
22 files changed, 2044 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..597fa29 --- /dev/null +++ b/Makefile @@ -0,0 +1,59 @@ +# Program name +NAME := philo + +# Directories +SRC_DIR := src +BUILD_DIR := ./build +INC_DIR := ./include + +SRCS := $(addprefix $(SRC_DIR)/, \ +main.c \ +time.c \ +print.c \ +starve.c \ +free_memory.c \ +forks.c \ +philos.c \ +routine.c \ +monitoring.c \ +threads.c \ +queue.c \ +init.c \ +destroy.c \ +utils.c \ +utils_routine.c \ +validate_parameters.c \ +scheduler.c \ +sim.c) + +OBJS := $(SRCS:%.c=$(BUILD_DIR)/%.o) + +# Automatically generated dependency files +DEPS := $(SRCS:%.c=$(BUILD_DIR)/%.d) + +# -MMD and -MP will assist the rule to create the dependencies using -include ... +#CFLAGS := -Wall -Wextra -Werror -static-libasan -fsanitize=address -g3 -pthread +#CFLAGS := -Wall -Wextra -Werror -static-libasan -fsanitize=thread -g3 -pthread -fno-sanitize=thread +#CFLAGS_DEBUG := -Wall -Wextra -Werror -g3 -O0 -MMD -MP -pthread +CFLAGS := -Wall -Wextra -Werror -MMD -MP -pthread -I$(INC_DIR) + +.DEFAULT_GOAL = all +all: $(NAME) + +# that goes along with DEPS := $(OBJS:.o=.d) +-include $(DEPS) + +$(BUILD_DIR)/%.o: %.c + mkdir -p $(dir $@) + $(CC) -c -o $@ $< $(CFLAGS) + +$(NAME) : $(OBJS) + $(CC) -o $@ $^ $(CFLAGS) + +.PHONY: clean fclean re all + +clean: + rm -rf $(BUILD_DIR) +fclean: clean + rm -f $(NAME) +re: fclean all diff --git a/README.md b/README.md new file mode 100644 index 0000000..bff6e47 --- /dev/null +++ b/README.md @@ -0,0 +1,155 @@ +# The Dining Philosophers Problem in C + +## Description + +This repository carries the source code of a project similar to the Dining +Philosophers Problem. + +I wrote this program to learn about C and pthreads. + +There are a couple more 'features' in addition to the original requirements of +the dining philosophers problem: + +- 'fork cooldown': a philosopher has to wait x numbers of milliseconds before + she can pick up a fork +- a scheduler; a heap queue with two priority methods: 'first in first out' + (fifo) or 'earliest deadline first' (edf); the priority queue lives on the +fork. + +## Instructions + +To compile: + + $ make + +To run: + + $ ./philo number_of_philos time_to_starve time_to_eat time_to_reflect +time_to_think number_of_eats_required fork_cooldown scheduler + +To delete ./build: + + $ make clean + +To delete ./build and the binaries: + + $ make fclean + +To delete and recompile: + + $ make re + +From the school subject: + +- number\_of\_philos: The number of philosophers and also the number of forks. +- time\_to\_starve (in milliseconds): If a philosopher did not start eating + within time\_to\_starve milliseconds since the beginning of the last time +they ate or the beginning of the simulation, they starve. +- time\_to\_eat (in milliseconds): The time it takes for a philosopher to eat. + During that time, they must hold two forks. +- time\_to\_reflect (in milliseconds): The time a philosopher will spend + reflecting. +- time\_to\_think (in milliseconds): The time a philosopher will spend + thinking. After completing the thinking phase, the philosopher will +immediately attempt to acquire forks and start eating again. +- number\_of\_eats\_required: If all philosophers have eaten at least this many + times, the simulation stops. Otherwise, it stops when a philosopher burns +out. +- fork\_cooldown (in milliseconds): After being released, a fork is unavailable + until its cooldown has passed. +- scheduler: The arbitration policy used by forks to decide who gets them when + multiple philosophers request them. The value must be exactly one of: fifo +or edf. fifo means First In, First Out: the fork is granted to the philosopher +whose request arrived first. edf means Earliest Deadline First with deadline = +last\_eat\_start + time\_to\_burnout. + +## Resources + +- Advanced Programming in the UNIX Environment, third edition, W. Richard + Stevens, Stephen A. Rago, Chapter 11 on pthread +- on pthreads: + https://www.cs.cmu.edu/afs/cs/academic/class/15492-f07/www/pthreads.html +- on valgrind: https://bytes.usc.edu/cs104/wiki/valgrind/ +- on valgrind: https://valgrind.org/docs/manual/mc-manual.html +- on drd: https://valgrind.org/docs/manual/drd-manual.html +- the man pages of pthread\_create, pthread\_mutex\_lock, + pthread\_cond\_and\_wait, pthread\_join, pthread\_mutex\_destroy + +## Blocking cases handled + +Deadlock: I use the parity solution. To prevent deadlocks, odd-numbered and +even-numbered philosophers pick up their forks in different orders. + +Starvation prevention: whether it be with fifo or edf schedulers, a philosopher +may only eat when their ticket is first in the queue. + +Cooldown handling: forks record the last time at which they were released. +Before a philosopher checks whether their ticket is first in queue, or attempts +to lock the mutex of a fork, a function computes how much time is left until a +fork has cooled down, that is the waiting time. usleep() is then called with +the waiting time passed as a parameter. There is also one more call of that +function after a mutex is locked to deal with a hedge-case. + +Precise starving detection: to detect whether a philosopher has starved, a +monitoring thread runs. In the routine of this thread, there is a loop calling +a function check\_for\_starves which checks whether a philosopher has starves. + check\_for\_starves computes that no more than the time it takes for a +philosopher to burn out has elapsed since she last ate. If so, +check\_for\_starves updates the value of the variable philosopher\_starved +to 1. Concurrently, each time a philosopher is about to eat or each time the +log is about to print, a call to the the function +check\_if\_philosopher\_starved is made to check the value of +philosopher\_starved. If the value is equal to 1, the threads returns and +then join. + +Log serialization: all prints go through the function print\_log. A mutex +guards access to printf(). + +## Thread synchronization mechanisms + +The program uses pthread\_create, pthread\_join, pthread\_mutex\_init, +pthread\_mutex\_lock, pthread\_mutex\_unlock, pthread\_mutex\_destroy. It +creates one thread per philosopher and a monitoring thread. About +thread-safety: each variable accessed throughout the program by multiple +threads is protected by a mutex to prevent race conditions. + +## To do, to improve + +- the function create\_philosopher returns a pointer to a t\_philosopher. The function + could return a philosopher to reduce the number of malloc() this program +uses. However, I made create\_philosopher return a pointer because I wanted to +practice working with pointers. +- write a unique function to free all malloc +- use bzero instead of malloc to initialize all variables with 0 +- think of how to refactor cooldown checks +- move library headers from .h to .c files + +## Troubleshooting, testing + +Some commands I used to troubleshoot or test this program: + + $ strace -f ./program args + $ valgrind --tool=drd ./program args + $ valgrind --tool=helgrind ./pogram args + # Ctrl + C and then 'thread apply all bt' in GDB when the program hangs + $ echo $? to see the exit value + $ addr2line -e ./codexion -f -C 0x4030F2 0x402001 + $ ldd codexion to check which lib is used for compiling + +## License + +Copyright (C) 2026 yctct + +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 <https://www.gnu.org/licenses/>. + +See the file COPYING. diff --git a/include/codexion.h b/include/codexion.h new file mode 100644 index 0000000..51c606f --- /dev/null +++ b/include/codexion.h @@ -0,0 +1,142 @@ +#ifndef CODEXION_H + +# define CODEXION_H + +# include <pthread.h> // for pthread_* +//# include <stdio.h> // for printf() +//# include <stdlib.h> // for atoi(), malloc() +//# include <string.h> // for strlen() +//# include <sys/time.h> // for getimeofday() +//# include <unistd.h> // for usleep() +# define MAX 2 + +typedef struct s_sim t_sim; +typedef struct s_queue t_queue; +typedef struct s_fork t_fork; + +typedef struct s_philo +{ + int id; + int ticket; + pthread_t thread_id; + t_fork *left_fork; + t_fork *right_fork; + long beginning_last_eat_time; + t_sim *sim; + int number_of_eats_done; + pthread_mutex_t mutex_number_of_eats_done; + pthread_mutex_t mutex_beginning_last_eat_time; + pthread_mutex_t mutex_ticket; + pthread_mutex_t mutex_id; + pthread_mutex_t mutex_sim; +} t_philo; + +typedef struct s_ticket +{ + int num; +} t_ticket; + +typedef struct s_queue +{ + t_ticket items[MAX]; + int size; +} t_queue; + +typedef struct s_fork +{ + int id; + size_t ticket_next; + int last_released; + t_philo *left_philo; + t_philo *right_philo; + t_sim *sim; + pthread_mutex_t mutex; + pthread_mutex_t mutex_left_philo; + pthread_mutex_t mutex_right_philo; + pthread_mutex_t mutex_ticket_next; + pthread_mutex_t mutex_cond; + pthread_mutex_t mutex_sim; + pthread_mutex_t mutex_last_released; + pthread_cond_t cond_signal; + t_queue pq; + pthread_mutex_t mutex_pq; + +} t_fork; + +typedef struct s_sim +{ + int number_of_philos; + int time_to_starve; + int time_to_eat; + int time_to_reflect; + int time_to_think; + int number_of_eat_required; + int fork_cooldown; + char *scheduler; + t_fork **forks; + t_philo **philos; + long start_time; + pthread_t monitor_thread; + int philo_starved; + int number_of_forks_actual; + int number_of_philos_actual; + pthread_mutex_t mutex_philo_starved; + pthread_mutex_t mutex_print_log; + pthread_mutex_t mutex_cooldown; + pthread_mutex_t mutex_start_time; + pthread_mutex_t mutex_number_of_eat_done; + pthread_mutex_t mutex_philos; + pthread_mutex_t mutex_number_of_philos; + pthread_mutex_t mutex_number_of_eat_required; + pthread_mutex_t mutex_time_to_starve; + pthread_mutex_t mutex_time_to_think; + pthread_mutex_t mutex_time_to_reflect; + pthread_mutex_t mutex_time_to_eat; + pthread_mutex_t mutex_scheduler; + pthread_mutex_t mutex_forks; + +} t_sim; + +long time_ms(void); +int check_if_philo_starved(t_sim *sim); +void print_log(t_philo *philo, char *msg, int flag); +int check_for_starves(t_sim *sim); +void print_usage(void); +void free_philos(t_sim *sim); +void free_forks(t_sim *sim); +t_fork *create_fork(t_sim *sim); +t_fork **create_arr_forks(t_sim *sim); +t_philo *create_philo(t_sim *sim); +t_philo **create_arr_philos(t_sim *sim); +void start_timer(t_sim *sim); +t_philo *who_is_near(t_philo *philo, t_fork *fork); +void *routine(void *arg); +void *monitoring_routine(void *arg); +void init_mutex(t_sim *sim); +void destroy_mutex(t_sim *sim); +int run_threads(t_sim *sim); +t_philo **assign_forks(t_sim *sim); +t_fork **assign_philos(t_sim *sim); +t_sim *create_sim(char **argv); +int valid_params(char **argv); +int main(int argc, char **argv); +int philo_routine(t_philo *philo, + t_fork *left_fork, t_fork *right_fork); +void swap(t_ticket a, t_ticket b); +int time_until_starve(t_philo *philo); +int get_id(t_philo *philo); +void eat(t_philo *philo); +void reflect_and_think(t_philo *philo); +int wait_for_fork(t_philo *philo, t_fork *fork); +void wait_for_longest_cooldown(t_philo *philo, + t_fork *left_fork, t_fork *right_fork); +void update_last_released(t_sim *sim, + t_fork *fork1, t_fork *fork2); +int get_rel_time(t_sim *sim); +void dequeue(t_fork *fork); +int queue_routine(t_philo *philo, + t_fork *f1, t_fork *f2); +void enqueue(t_fork *fork, t_ticket ticket); +void heapify(t_fork *fork); + +#endif diff --git a/src/destroy.c b/src/destroy.c new file mode 100644 index 0000000..6a274ad --- /dev/null +++ b/src/destroy.c @@ -0,0 +1,66 @@ +#include "codexion.h" + +static void destroy_mutex_philos(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int number_of_philos; + + number_of_philos = sim->number_of_philos; + philos = sim->philos; + while (number_of_philos-- > 0) + { + philo = *philos++; + (void)pthread_mutex_destroy(&philo->mutex_number_of_eats_done); + (void)pthread_mutex_destroy(&philo->mutex_beginning_last_eat_time); + (void)pthread_mutex_destroy(&philo->mutex_id); + (void)pthread_mutex_destroy(&philo->mutex_sim); + } +} + +static void destroy_mutex_forks(t_sim *sim) +{ + t_fork **forks; + t_fork *fork; + int number_of_philos; + + number_of_philos = sim->number_of_philos; + forks = sim->forks; + while (number_of_philos-- > 0) + { + fork = *forks++; + (void)pthread_mutex_destroy(&fork->mutex); + (void)pthread_mutex_destroy(&fork->mutex_last_released); + (void)pthread_mutex_destroy(&fork->mutex_right_philo); + (void)pthread_mutex_destroy(&fork->mutex_left_philo); + (void)pthread_mutex_destroy(&fork->mutex_ticket_next); + (void)pthread_mutex_destroy(&fork->mutex_cond); + (void)pthread_mutex_destroy(&fork->mutex_sim); + (void)pthread_cond_destroy(&fork->cond_signal); + (void)pthread_mutex_destroy(&fork->mutex_pq); + } +} + +static void destroy_mutex_sim(t_sim *sim) +{ + (void)pthread_mutex_destroy(&sim->mutex_philo_starved); + (void)pthread_mutex_destroy(&sim->mutex_print_log); + (void)pthread_mutex_destroy(&sim->mutex_cooldown); + (void)pthread_mutex_destroy(&sim->mutex_start_time); + (void)pthread_mutex_destroy(&sim->mutex_number_of_eat_required); + (void)pthread_mutex_destroy(&sim->mutex_philos); + (void)pthread_mutex_destroy(&sim->mutex_number_of_philos); + (void)pthread_mutex_destroy(&sim->mutex_time_to_starve); + (void)pthread_mutex_destroy(&sim->mutex_time_to_think); + (void)pthread_mutex_destroy(&sim->mutex_time_to_reflect); + (void)pthread_mutex_destroy(&sim->mutex_time_to_eat); + (void)pthread_mutex_destroy(&sim->mutex_scheduler); + (void)pthread_mutex_destroy(&sim->mutex_forks); +} + +void destroy_mutex(t_sim *sim) +{ + destroy_mutex_philos(sim); + destroy_mutex_forks(sim); + destroy_mutex_sim(sim); +} diff --git a/src/forks.c b/src/forks.c new file mode 100644 index 0000000..534ccc4 --- /dev/null +++ b/src/forks.c @@ -0,0 +1,75 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() + +/* +fork's last used is a negative value of waiting time so first philos can +start compiling at the start of the simulation +*/ + +t_fork *create_fork(t_sim *sim) +{ + t_fork *fork; + t_queue pq; + + fork = (t_fork *)malloc(sizeof(t_fork)); + if (!fork) + { + free_forks(sim); + free(sim); + return (NULL); + } + fork->last_released = -1 * sim->fork_cooldown; + fork->ticket_next = 1; + fork->sim = sim; + pq.size = 0; + fork->pq = pq; + return (fork); +} + +t_fork **create_arr_forks(t_sim *sim) +{ + t_fork **forks; + t_fork *fork; + int i; + int number_of_philos; + + i = 0; + number_of_philos = sim->number_of_philos; + forks = (t_fork **)malloc((sizeof(t_fork *) * (number_of_philos + + 1))); + if (!forks) + { + free(sim); + return (NULL); + } + while (number_of_philos-- > 0) + { + fork = create_fork(sim); + fork->id = i + 1; + forks[i++] = fork; + } + forks[i] = NULL; + sim->number_of_forks_actual = i; + sim->forks = forks; + return (forks); +} + +t_philo **assign_forks(t_sim *sim) +{ + t_philo **philos; + t_fork **forks; + int number_of_philos; + int i; + + philos = sim->philos; + forks = sim->forks; + number_of_philos = sim->number_of_philos; + i = 0; + while (philos[i]) + { + philos[i]->left_fork = forks[i]; + philos[i]->right_fork = forks[(i + 1) % number_of_philos]; + i++; + } + return (philos); +} diff --git a/src/free_memory.c b/src/free_memory.c new file mode 100644 index 0000000..3853e33 --- /dev/null +++ b/src/free_memory.c @@ -0,0 +1,38 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() + +void free_philos(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int number_of_philos; + + philos = sim->philos; + number_of_philos = sim->number_of_philos_actual; + while (number_of_philos-- > 0) + { + philo = *philos++; + free(philo); + } + philos = sim->philos; + free(philos); + sim->philos = NULL; +} + +void free_forks(t_sim *sim) +{ + t_fork **forks; + t_fork *fork; + int number_of_forks; + + forks = sim->forks; + number_of_forks = sim->number_of_forks_actual; + while (number_of_forks-- > 0) + { + fork = *forks++; + free(fork); + } + forks = sim->forks; + free(forks); + sim->forks = NULL; +} diff --git a/src/init.c b/src/init.c new file mode 100644 index 0000000..623a7bb --- /dev/null +++ b/src/init.c @@ -0,0 +1,66 @@ +#include "codexion.h" + +static void init_mutex_philos(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int number_of_philos; + + number_of_philos = sim->number_of_philos; + philos = sim->philos; + while (number_of_philos-- > 0) + { + philo = *philos++; + (void)pthread_mutex_init(&philo->mutex_number_of_eats_done, NULL); + (void)pthread_mutex_init(&philo->mutex_beginning_last_eat_time, NULL); + (void)pthread_mutex_init(&philo->mutex_id, NULL); + (void)pthread_mutex_init(&philo->mutex_sim, NULL); + } +} + +static void init_mutex_forks(t_sim *sim) +{ + t_fork **forks; + t_fork *fork; + int number_of_philos; + + number_of_philos = sim->number_of_philos; + forks = sim->forks; + while (number_of_philos-- > 0) + { + fork = *forks++; + (void)pthread_mutex_init(&fork->mutex, NULL); + (void)pthread_mutex_init(&fork->mutex_last_released, NULL); + (void)pthread_mutex_init(&fork->mutex_left_philo, NULL); + (void)pthread_mutex_init(&fork->mutex_right_philo, NULL); + (void)pthread_mutex_init(&fork->mutex_ticket_next, NULL); + (void)pthread_mutex_init(&fork->mutex_cond, NULL); + (void)pthread_mutex_init(&fork->mutex_sim, NULL); + (void)pthread_cond_init(&fork->cond_signal, NULL); + (void)pthread_mutex_init(&fork->mutex_pq, NULL); + } +} + +static void init_mutex_sim(t_sim *sim) +{ + (void)pthread_mutex_init(&sim->mutex_philo_starved, NULL); + (void)pthread_mutex_init(&sim->mutex_print_log, NULL); + (void)pthread_mutex_init(&sim->mutex_cooldown, NULL); + (void)pthread_mutex_init(&sim->mutex_start_time, NULL); + (void)pthread_mutex_init(&sim->mutex_number_of_eat_required, NULL); + (void)pthread_mutex_init(&sim->mutex_philos, NULL); + (void)pthread_mutex_init(&sim->mutex_number_of_philos, NULL); + (void)pthread_mutex_init(&sim->mutex_time_to_starve, NULL); + (void)pthread_mutex_init(&sim->mutex_time_to_think, NULL); + (void)pthread_mutex_init(&sim->mutex_time_to_reflect, NULL); + (void)pthread_mutex_init(&sim->mutex_time_to_eat, NULL); + (void)pthread_mutex_init(&sim->mutex_scheduler, NULL); + (void)pthread_mutex_init(&sim->mutex_forks, NULL); +} + +void init_mutex(t_sim *sim) +{ + init_mutex_philos(sim); + init_mutex_forks(sim); + init_mutex_sim(sim); +} diff --git a/src/main.c b/src/main.c new file mode 100644 index 0000000..216e903 --- /dev/null +++ b/src/main.c @@ -0,0 +1,39 @@ +#include "codexion.h" +# include <stdlib.h> // or atoi(), malloc() + +int main(int argc, char **argv) +{ + t_sim *sim; + t_philo **philos; + t_fork **forks; + int ret; + + if (argc != 9) + { + print_usage(); + return (0); + } + if (!valid_params(argv)) + return (0); + sim = create_sim(argv); + if (sim == NULL) + return (1); + start_timer(sim); + philos = create_arr_philos(sim); + if (philos == NULL) + return (1); + forks = create_arr_forks(sim); + if (forks == NULL) + return (1); + init_mutex(sim); + assign_forks(sim); + assign_philos(sim); + ret = run_threads(sim); + if (ret != 0) + return (1); + destroy_mutex(sim); + free_forks(sim); + free_philos(sim); + free(sim); + return (0); +} diff --git a/src/monitoring.c b/src/monitoring.c new file mode 100644 index 0000000..7c74b4d --- /dev/null +++ b/src/monitoring.c @@ -0,0 +1,44 @@ +#include "codexion.h" +# include <unistd.h> // for usleep() + +static int check_if_philos_done(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int number_of_philos; + int diff; + + (void)pthread_mutex_lock(&sim->mutex_philos); + philos = sim->philos; + (void)pthread_mutex_unlock(&sim->mutex_philos); + (void)pthread_mutex_lock(&sim->mutex_number_of_philos); + number_of_philos = sim->number_of_philos; + (void)pthread_mutex_unlock(&sim->mutex_number_of_philos); + while (number_of_philos-- > 0) + { + philo = *philos++; + (void)pthread_mutex_lock(&sim->mutex_number_of_eat_required); + (void)pthread_mutex_lock(&philo->mutex_number_of_eats_done); + diff = philo->number_of_eats_done + != sim->number_of_eat_required; + (void)pthread_mutex_unlock(&philo->mutex_number_of_eats_done); + (void)pthread_mutex_unlock(&sim->mutex_number_of_eat_required); + if (diff != 0) + return (0); + } + return (1); +} + +void *monitoring_routine(void *arg) +{ + t_sim *sim; + + sim = (t_sim *)arg; + while (check_if_philos_done(sim) == 0) + { + if (check_for_starves(sim) == 1) + return (NULL); + usleep(100); + } + return (NULL); +} diff --git a/src/philos.c b/src/philos.c new file mode 100644 index 0000000..17cb34d --- /dev/null +++ b/src/philos.c @@ -0,0 +1,83 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() + +t_philo *create_philo(t_sim *sim) +{ + t_philo *philo; + + philo = NULL; + philo = (t_philo *)malloc(sizeof(t_philo)); + if (!philo) + { + free_philos(sim); + free(sim); + return (NULL); + } + philo->beginning_last_eat_time = 0; + philo->number_of_eats_done = 0; + philo->ticket = 0; + philo->sim = sim; + return (philo); +} + +t_philo **create_arr_philos(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int i; + int number_of_philos; + + number_of_philos = sim->number_of_philos; + philos = (t_philo **)malloc(sizeof(t_philo *) * (number_of_philos + 1)); + if (!philos) + { + free(sim); + return (NULL); + } + i = 0; + while (i < number_of_philos) + { + philo = create_philo(sim); + if (!philo) + return (NULL); + philo->id = i + 1; + philos[i++] = philo; + } + sim->number_of_philos_actual = i; + philos[i] = NULL; + sim->philos = philos; + return (philos); +} + +/* this function assigns 2 philos to each forks */ +/* the 'if' is used to assign the last philo to the */ +/* first fork. Then, in the 'else', the i is offset */ +/* by minus 1 to assign the first philo to the second */ +/* fork */ +t_fork **assign_philos(t_sim *sim) +{ + t_fork **forks; + t_philo **philos; + int number_of_philos; + int i; + + forks = sim->forks; + philos = sim->philos; + number_of_philos = sim->number_of_philos; + i = 0; + while (forks[i]) + { + if (i == 0) + { + forks[i]->left_philo = philos[number_of_philos - 1]; + forks[i]->right_philo = philos[i]; + } + else + { + forks[i]->left_philo = philos[i - 1]; + forks[i]->right_philo = philos[(i) % number_of_philos]; + } + i++; + } + return (forks); +} diff --git a/src/print.c b/src/print.c new file mode 100644 index 0000000..db8cf69 --- /dev/null +++ b/src/print.c @@ -0,0 +1,45 @@ +#include "codexion.h" +# include <stdio.h> // for printf() + +/* +This functions deal with all log printing activities. Logs are serialized by +usage of mutex_print_log. There are 2 scenarios for printing. The first one +scenarios applies if no philo has starved, the second one only prints if a +philo has starved; that is when flag = 1. +*/ +void print_log(t_philo *philo, char *msg, int flag) +{ + int id; + long start; + t_sim *sim; + + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + (void)pthread_mutex_lock(&philo->mutex_id); + id = philo->id; + (void)pthread_mutex_unlock(&philo->mutex_id); + (void)pthread_mutex_lock(&philo->sim->mutex_start_time); + start = philo->sim->start_time; + (void)pthread_mutex_unlock(&philo->sim->mutex_start_time); + (void)pthread_mutex_lock(&philo->sim->mutex_print_log); + if (!check_if_philo_starved(sim) && flag == 0) + printf("%d %i %s\n", get_rel_time(sim), id, msg); + else if (flag == 1) + printf("%lu %d %d %s\n", time_ms() - start, get_rel_time(sim), id, msg); + (void)pthread_mutex_unlock(&philo->sim->mutex_print_log); +} + +/* +This function prints usage when the program is ran without parameters +*/ +void print_usage(void) +{ + printf("Usage: $ ./codexion number_of_philos " + "time_to_starve " + "time_to_eat " + "time_to_reflect " + "time_to_think " + "number_of_eats_required " + "fork_cooldown scheduler"); +} diff --git a/src/queue.c b/src/queue.c new file mode 100644 index 0000000..76907d9 --- /dev/null +++ b/src/queue.c @@ -0,0 +1,55 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() +# include <stdio.h> // for printf() + +void heapify(t_fork *fork) +{ + t_ticket t1; + t_ticket t2; + + (void)pthread_mutex_lock(&fork->mutex_pq); + if (fork->pq.size < 2) + { + (void)pthread_mutex_unlock(&fork->mutex_pq); + return ; + } + (void)pthread_mutex_unlock(&fork->mutex_pq); + t1 = fork->pq.items[0]; + t2 = fork->pq.items[1]; + if (t1.num > t2.num) + swap(t1, t2); +} + +void enqueue(t_fork *fork, t_ticket ticket) +{ + int queue_size; + + (void)pthread_mutex_lock(&fork->mutex_pq); + queue_size = fork->pq.size; + (void)pthread_mutex_unlock(&fork->mutex_pq); + if (queue_size == MAX) + { + printf("Priority queue is full\n"); + return ; + } + (void)pthread_mutex_lock(&fork->mutex_pq); + fork->pq.items[fork->pq.size++] = ticket; + (void)pthread_mutex_unlock(&fork->mutex_pq); +} + +void dequeue(t_fork *fork) +{ + int queue_size; + + (void)pthread_mutex_lock(&fork->mutex_pq); + queue_size = fork->pq.size; + (void)pthread_mutex_unlock(&fork->mutex_pq); + if (!queue_size) + { + printf("Priority queue is empty\n"); + return ; + } + (void)pthread_mutex_lock(&fork->mutex_pq); + fork->pq.items[0] = fork->pq.items[--fork->pq.size]; + (void)pthread_mutex_unlock(&fork->mutex_pq); +} diff --git a/src/routine.c b/src/routine.c new file mode 100644 index 0000000..6d867cf --- /dev/null +++ b/src/routine.c @@ -0,0 +1,57 @@ +#include "codexion.h" +# include <unistd.h> // for usleep() +# include <stdio.h> // for printf() + +static void send_signal(t_fork *fork) +{ + (void)pthread_mutex_lock(&fork->mutex_cond); + pthread_cond_signal(&fork->cond_signal); + (void)pthread_mutex_unlock(&fork->mutex_cond); +} + +static void lock_forks(t_philo *philo, t_fork *f1, + t_fork *f2) +{ + if (get_id(philo) % 2 == 0) + { + (void)pthread_mutex_lock(&f1->mutex); + (void)pthread_mutex_lock(&f2->mutex); + } + else + { + if (philo->number_of_eats_done < 1) + usleep(50); + (void)pthread_mutex_lock(&f2->mutex); + (void)pthread_mutex_lock(&f1->mutex); + } + wait_for_longest_cooldown(philo, f1, f2); +} + +int philo_routine(t_philo *philo, t_fork *f1, + t_fork *f2) +{ + t_sim *sim; + + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + if (check_if_philo_starved(sim)) + return (1); + if (queue_routine(philo, f1, f2) == 1) + return (1); + if (check_if_philo_starved(sim)) + return (1); + lock_forks(philo, f1, f2); + print_log(philo, "has taken a fork", 0); + print_log(philo, "has taken a fork", 0); + update_last_released(sim, f1, f2); + eat(philo); + (void)pthread_mutex_unlock(&f2->mutex); + dequeue(f2); + send_signal(f2); + (void)pthread_mutex_unlock(&f1->mutex); + dequeue(f1); + send_signal(f1); + reflect_and_think(philo); + return (0); +} diff --git a/src/scheduler.c b/src/scheduler.c new file mode 100644 index 0000000..76c2f8d --- /dev/null +++ b/src/scheduler.c @@ -0,0 +1,86 @@ +#include "codexion.h" +# include <unistd.h> // for usleep() +# include <string.h> // for strcmp() + +static t_ticket take_ticket(t_philo *philo, t_fork *fork) +{ + t_ticket my_ticket; + char *scheduler; + t_sim *sim; + + (void)pthread_mutex_lock(&philo->sim->mutex_scheduler); + scheduler = philo->sim->scheduler; + (void)pthread_mutex_unlock(&philo->sim->mutex_scheduler); + if (strcmp(scheduler, "fifo") == 0) + { + (void)pthread_mutex_lock(&fork->mutex_ticket_next); + my_ticket.num = fork->ticket_next++; + (void)pthread_mutex_unlock(&fork->mutex_ticket_next); + } + if (strcmp(scheduler, "edf") == 0) + { + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + my_ticket.num = get_rel_time(sim) + sim->time_to_starve; + } + enqueue(fork, my_ticket); + heapify(fork); + return (my_ticket); +} + +int get_first_item_queue(t_fork *fork) +{ + int first_item; + + (void)pthread_mutex_lock(&fork->mutex_pq); + first_item = fork->pq.items[0].num; + (void)pthread_mutex_unlock(&fork->mutex_pq); + return (first_item); +} + +static int is_ticket_first(t_philo *philo, t_fork *f1, + t_fork *f2, t_ticket ticket) +{ + t_sim *sim; + + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + wait_for_longest_cooldown(philo, f1, f2); + (void)pthread_mutex_lock(&f1->mutex_cond); + while (ticket.num != get_first_item_queue(f1)) + { + if (check_if_philo_starved(sim)) + { + (void)pthread_mutex_unlock(&f1->mutex_cond); + return (1); + } + pthread_cond_wait(&f1->cond_signal, &f1->mutex_cond); + wait_for_longest_cooldown(philo, f1, f2); + } + (void)pthread_mutex_unlock(&f1->mutex_cond); + return (0); +} + +int queue_routine(t_philo *philo, t_fork *f1, t_fork *f2) +{ + t_ticket t1; + t_ticket t2; + //t_sim *sim; + + //(void)pthread_mutex_lock(&philo->mutex_sim); + //sim = philo->sim; + //(void)pthread_mutex_unlock(&philo->mutex_sim); + if (get_id(philo) % 2 != 0 && philo->number_of_eats_done < 1) + { + usleep(100); + } + t1 = take_ticket(philo, f1); + t2 = take_ticket(philo, f2); + if (is_ticket_first(philo, f1, f2, t1) == 1) + return (1); + if (is_ticket_first(philo, f2, f1, t2) == 1) + return (1); + return (0); +} diff --git a/src/sim.c b/src/sim.c new file mode 100644 index 0000000..5b84be9 --- /dev/null +++ b/src/sim.c @@ -0,0 +1,23 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() + +t_sim *create_sim(char **argv) +{ + t_sim *sim; + + sim = NULL; + sim = (t_sim *)malloc(sizeof(t_sim)); + if (!sim) + return (NULL); + sim->number_of_philos = atoi(argv[1]); + sim->time_to_starve = atoi(argv[2]); + sim->time_to_eat = atoi(argv[3]); + sim->time_to_reflect = atoi(argv[4]); + sim->time_to_think = atoi(argv[5]); + sim->number_of_eat_required = atoi(argv[6]); + sim->philo_starved = 0; + sim->fork_cooldown = atoi(argv[7]); + sim->scheduler = argv[8]; + sim->start_time = 0; + return (sim); +} diff --git a/src/starve.c b/src/starve.c new file mode 100644 index 0000000..3dba831 --- /dev/null +++ b/src/starve.c @@ -0,0 +1,84 @@ +#include "codexion.h" +# include <stdio.h> // for printf() + +static void broadcast_signals(t_sim *sim) +{ + t_fork **forks; + t_fork *fork; + int number_of_philos; + + (void)pthread_mutex_lock(&sim->mutex_forks); + forks = sim->forks; + (void)pthread_mutex_unlock(&sim->mutex_forks); + (void)pthread_mutex_lock(&sim->mutex_number_of_philos); + number_of_philos = sim->number_of_philos; + (void)pthread_mutex_unlock(&sim->mutex_number_of_philos); + while (number_of_philos-- > 0) + { + fork = *forks++; + (void)pthread_mutex_lock(&fork->mutex_cond); + pthread_cond_broadcast(&fork->cond_signal); + (void)pthread_mutex_unlock(&fork->mutex_cond); + } +} + +/* Computes a philo's time until he/she burns out */ +int time_until_starve(t_philo *philo) +{ + int time_until_starve; + int time_to_starve; + int beginning_last_eat_time; + t_sim *sim; + + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + (void)pthread_mutex_lock(&sim->mutex_time_to_starve); + time_to_starve = sim->time_to_starve; + (void)pthread_mutex_unlock(&sim->mutex_time_to_starve); + (void)pthread_mutex_lock(&philo->mutex_beginning_last_eat_time); + beginning_last_eat_time = philo->beginning_last_eat_time; + (void)pthread_mutex_unlock(&philo->mutex_beginning_last_eat_time); + time_until_starve = time_to_starve - (get_rel_time(sim) + - beginning_last_eat_time); + return (time_until_starve); +} + +int check_if_philo_starved(t_sim *sim) +{ + int starved_status; + + (void)pthread_mutex_lock(&sim->mutex_philo_starved); + starved_status = sim->philo_starved; + (void)pthread_mutex_unlock(&sim->mutex_philo_starved); + return (starved_status); +} + +int check_for_starves(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int number_of_philos; + + (void)pthread_mutex_lock(&sim->mutex_philos); + philos = sim->philos; + (void)pthread_mutex_unlock(&sim->mutex_philos); + philo = *philos; + (void)pthread_mutex_lock(&sim->mutex_number_of_philos); + number_of_philos = sim->number_of_philos; + (void)pthread_mutex_unlock(&sim->mutex_number_of_philos); + while (number_of_philos-- > 0) + { + philo = *philos++; + if (time_until_starve(philo) == 0) + { + (void)pthread_mutex_lock(&sim->mutex_philo_starved); + sim->philo_starved = 1; + (void)pthread_mutex_unlock(&sim->mutex_philo_starved); + print_log(philo, "starved", 1); + broadcast_signals(sim); + return (1); + } + } + return (0); +} diff --git a/src/threads.c b/src/threads.c new file mode 100644 index 0000000..4d8776d --- /dev/null +++ b/src/threads.c @@ -0,0 +1,93 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() + +void *routine(void *arg) +{ + t_philo *philo; + int number_of_eat_required; + + philo = (t_philo *)arg; + if (philo->sim->number_of_philos == 1) + { + print_log(philo, "has taken a fork", 0); + return (0); + } + (void)pthread_mutex_lock(&philo->sim->mutex_number_of_eat_required); + number_of_eat_required = philo->sim->number_of_eat_required; + (void)pthread_mutex_unlock(&philo->sim->mutex_number_of_eat_required); + while (philo->number_of_eats_done != number_of_eat_required) + { + (void)pthread_mutex_lock(&philo->sim->mutex_number_of_eat_required); + number_of_eat_required = philo->sim->number_of_eat_required; + (void)pthread_mutex_unlock(&philo->sim->mutex_number_of_eat_required); + if (philo_routine(philo, philo->right_fork, philo->left_fork) != 0) + return (NULL); + } + return (0); +} + +int create_threads(t_sim *sim) +{ + t_philo **philos; + int number_of_philos; + t_philo *philo; + + philos = sim->philos; + number_of_philos = sim->number_of_philos; + if (pthread_create(&sim->monitor_thread, NULL, monitoring_routine, + sim) != 0) + { + free_philos(sim); + free(sim); + return (1); + } + while (number_of_philos-- > 0) + { + philo = *philos++; + if (pthread_create(&philo->thread_id, NULL, routine, philo) != 0) + { + free_philos(sim); + free(sim); + return (1); + } + } + return (0); +} + +int join_threads(t_sim *sim) +{ + t_philo **philos; + t_philo *philo; + int threads; + + philos = sim->philos; + threads = sim->number_of_philos; + while (threads-- > 0) + { + philo = *philos++; + if (pthread_join(philo->thread_id, NULL) != 0) + { + free_philos(sim); + free_forks(sim); + free(sim); + return (1); + } + } + if (pthread_join(sim->monitor_thread, NULL) != 0) + { + free_philos(sim); + free_forks(sim); + free(sim); + return (1); + } + return (0); +} + +int run_threads(t_sim *sim) +{ + if (create_threads(sim) != 0) + return (1); + if (join_threads(sim) != 0) + return (1); + return (0); +} diff --git a/src/time.c b/src/time.c new file mode 100644 index 0000000..76f3528 --- /dev/null +++ b/src/time.c @@ -0,0 +1,29 @@ +#include "codexion.h" +# include <sys/time.h> // for getimeofday() + +long time_ms(void) +{ + long current_time_ms; + struct timeval current_t; + + gettimeofday(¤t_t, NULL); + current_time_ms = current_t.tv_sec * 1000L + current_t.tv_usec / 1000L; + return (current_time_ms); +} + +void start_timer(t_sim *sim) +{ + sim->start_time = time_ms(); +} + +int get_rel_time(t_sim *sim) +{ + int current_rel_time; + long start_time; + + (void)pthread_mutex_lock(&sim->mutex_start_time); + start_time = sim->start_time; + (void)pthread_mutex_unlock(&sim->mutex_start_time); + current_rel_time = time_ms() - start_time; + return (current_rel_time); +} diff --git a/src/utils.c b/src/utils.c new file mode 100644 index 0000000..e409f7d --- /dev/null +++ b/src/utils.c @@ -0,0 +1,20 @@ +#include "codexion.h" + +void swap(t_ticket a, t_ticket b) +{ + t_ticket temp; + + temp = a; + a = b; + b = temp; +} + +int get_id(t_philo *philo) +{ + int id; + + (void)pthread_mutex_lock(&philo->mutex_id); + id = philo->id; + (void)pthread_mutex_unlock(&philo->mutex_id); + return (id); +} diff --git a/src/utils_routine.c b/src/utils_routine.c new file mode 100644 index 0000000..37e3f3d --- /dev/null +++ b/src/utils_routine.c @@ -0,0 +1,81 @@ +#include "codexion.h" +# include <stdio.h> // for printf() +# include <unistd.h> // for usleep() + +void eat(t_philo *philo) +{ + t_sim *sim; + + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + (void)pthread_mutex_lock(&philo->mutex_beginning_last_eat_time); + philo->beginning_last_eat_time = get_rel_time(sim); + (void)pthread_mutex_unlock(&philo->mutex_beginning_last_eat_time); + print_log(philo, "is eating", 0); + usleep(philo->sim->time_to_eat * 1000); + (void)pthread_mutex_lock(&philo->mutex_number_of_eats_done); + philo->number_of_eats_done++; + (void)pthread_mutex_unlock(&philo->mutex_number_of_eats_done); +} + +void reflect_and_think(t_philo *philo) +{ + print_log(philo, "is reflecting", 0); + usleep(philo->sim->time_to_reflect * 1000); + print_log(philo, "is thinking", 0); + usleep(philo->sim->time_to_think * 1000); +} + +int wait_for_fork(t_philo *philo, t_fork *fork) +{ + int cooldown; + int wait; + int last_released; + t_sim *sim; + + (void)pthread_mutex_lock(&philo->mutex_sim); + sim = philo->sim; + (void)pthread_mutex_unlock(&philo->mutex_sim); + (void)pthread_mutex_lock(&philo->sim->mutex_cooldown); + cooldown = philo->sim->fork_cooldown; + (void)pthread_mutex_unlock(&philo->sim->mutex_cooldown); + (void)pthread_mutex_lock(&fork->mutex_last_released); + last_released = fork->last_released; + (void)pthread_mutex_unlock(&fork->mutex_last_released); + wait = cooldown - (get_rel_time(sim) - last_released); + return (wait); +} + +void wait_for_longest_cooldown(t_philo *philo, t_fork *f1, t_fork *f2) +{ + int w1; + int w2; + int wait; + + wait = 0; + if (get_id(philo) % 2 != 0 && philo->number_of_eats_done < 1) + usleep(50); + w1 = wait_for_fork(philo, f1); + w2 = wait_for_fork(philo, f2); + if (w1 >= w2 && w1 > 0) + wait = w1; + else if (w2 >= w1 && w2 > 0) + wait = w2; + usleep(wait * 1000); +} + +void update_last_released(t_sim *sim, t_fork *f1, t_fork *f2) +{ + int time_to_eat; + + (void)pthread_mutex_lock(&sim->mutex_time_to_eat); + time_to_eat = sim->time_to_eat; + (void)pthread_mutex_unlock(&sim->mutex_time_to_eat); + (void)pthread_mutex_lock(&f1->mutex_last_released); + f1->last_released = get_rel_time(sim) + time_to_eat; + (void)pthread_mutex_unlock(&f1->mutex_last_released); + (void)pthread_mutex_lock(&f2->mutex_last_released); + f2->last_released = get_rel_time(sim) + time_to_eat; + (void)pthread_mutex_unlock(&f2->mutex_last_released); +} diff --git a/src/validate_parameters.c b/src/validate_parameters.c new file mode 100644 index 0000000..9f09250 --- /dev/null +++ b/src/validate_parameters.c @@ -0,0 +1,30 @@ +#include "codexion.h" +# include <stdlib.h> // for atoi(), malloc() +# include <string.h> // for strlen() +# include <stdio.h> // for printf() + +int valid_params(char **argv) +{ + int i; + + if (atoi(argv[1]) < 1) + { + printf("Not enough philos\n"); + return (0); + } + i = 2; + while (i <= 7) + { + if (atoi(argv[i++]) < 0) + { + printf("Input cannot be negative\n"); + return (0); + } + } + if (strcmp(argv[8], "fifo") != 0 && strcmp(argv[8], "edf") != 0) + { + printf("Scheduler must be either 'fifo' or 'edf'\n"); + return (0); + } + return (1); +} |