diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..f496074 Binary files /dev/null and b/.DS_Store differ diff --git a/.gitignore b/.gitignogre similarity index 99% rename from .gitignore rename to .gitignogre index 7604ea9..c3f3bbf 100644 --- a/.gitignore +++ b/.gitignogre @@ -1,3 +1,4 @@ +.idea/ aws_config/ # Byte-compiled / optimized / DLL files diff --git a/LICENSE b/LICENSE index 9cecc1d..6ec89f7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - 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. - - {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 . - -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: - - {project} Copyright (C) {year} {fullname} - 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 -. +MIT License + +Copyright (c) 2018 Justin Fu + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index eb33a0d..bb90c1e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ python scripts/ec2_setup.py - (Optional) Set up [Docker](https://docs.docker.com/engine/installation/). This is required on the target machine if running in a Docker-enabled mode. +- (Optional) Set up GCP + - https://cloud.google.com/sdk/docs/quickstart-debian-ubuntu + - https://cloud.google.com/compute/docs/tutorials/python-guide + - https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python + ## Example diff --git a/doodad/arg_parse.py b/doodad/arg_parse.py index c194814..e0a4c24 100644 --- a/doodad/arg_parse.py +++ b/doodad/arg_parse.py @@ -9,7 +9,7 @@ __ARGS = None -def __get_arg_config(): +def __get_unpickled_arg_config(): """ global __ARGS if __ARGS is not None: @@ -34,7 +34,7 @@ def __get_arg_config(): def get_args(key=None, default=None): - args = __get_arg_config() + args = __get_unpickled_arg_config() if args.args_data: if args.use_cloudpickle: diff --git a/doodad/gcp/gcp_util.py b/doodad/gcp/gcp_util.py new file mode 100644 index 0000000..940a049 --- /dev/null +++ b/doodad/gcp/gcp_util.py @@ -0,0 +1,55 @@ +import os + +from doodad.utils import hash_file, call_and_wait, CommandBuilder, REPO_DIR + +GCP_STARTUP_SCRIPT_PATH = os.path.join(REPO_DIR, "scripts/gcp/gcp_startup_script.sh") +GCP_SHUTDOWN_SCRIPT_PATH = os.path.join(REPO_DIR, "scripts/gcp/gcp_shutdown_script.sh") + +def upload_file_to_gcp_storage( + bucket_name, + file_name, + remote_filename=None, + dry=False, + check_exists=True +): + from google.cloud import storage + storage_client = storage.Client() + bucket = storage_client.get_bucket(bucket_name) + + if remote_filename is None: + remote_filename = os.path.basename(file_name) + remote_path = 'doodad/mount/' + remote_filename + blob = bucket.blob(remote_path) + if check_exists and blob.exists(storage_client): + print("{remote_path} already exists".format(remote_path=remote_path)) + return remote_path + blob.upload_from_filename(file_name) + return remote_path + +def get_machine_type(zone, instance_type): + return "zones/{zone}/machineTypes/{instance_type}".format( + zone=zone, + instance_type=instance_type, + ) + +def get_gpu_type(project, zone, gpu_model): + """ + Check the available gpu models for each zone + https://cloud.google.com/compute/docs/gpus/ + """ + assert gpu_model in [ + 'nvidia-tesla-p4', + 'nvidia-tesla-k80', + 'nvidia-tesla-v100', + 'nvidia-tesla-p100' + ] + + return ( + "https://www.googleapis.com/compute/v1/" + "projects/{project}/zones/{zone}/acceleratorTypes/{gpu_model}".format( + project=project, + zone=zone, + gpu_model=gpu_model + ) + ) + diff --git a/doodad/launch_tools.py b/doodad/launch_tools.py index c5e1e07..292f630 100644 --- a/doodad/launch_tools.py +++ b/doodad/launch_tools.py @@ -22,13 +22,12 @@ def launch_python( mode=LOCAL, mount_points=None, args=None, - env=None, - dry=False, fake_display=False, target_mount_dir='target', - verbose=False, use_cloudpickle=False, target_mount=None, + launch_locally=None, + **launch_command_kwargs ): """ @@ -37,7 +36,6 @@ def launch_python( :param mode: :param mount_points: :param args: - :param env: :param dry: :param fake_display: :param target_mount_dir: @@ -50,6 +48,8 @@ def launch_python( args = {} if mount_points is None: mount_points = [] + if launch_locally is None: + launch_locally = isinstance(mode, Local) if target_mount is None: # mount @@ -57,12 +57,12 @@ def launch_python( if not target_mount_dir: target_mount_dir = target_dir target_mount_dir = os.path.join(target_mount_dir, os.path.basename(target_dir)) - if isinstance(mode, Local): + if launch_locally: target_mount = MountLocal(local_dir=target_dir) else: target_mount = MountLocal(local_dir=target_dir, mount_point=target_mount_dir) mount_points = mount_points + [target_mount] - target_full_path = os.path.join(target_mount.docker_mount_dir(), os.path.basename(target)) + target_full_path = os.path.join(target_mount.mount_dir(), os.path.basename(target)) command = make_python_command( target_full_path, @@ -71,7 +71,8 @@ def launch_python( fake_display=fake_display, use_cloudpickle=use_cloudpickle, ) - mode.launch_command(command, mount_points=mount_points, dry=dry, verbose=verbose) + mode.launch_command(command, mount_points=mount_points, + **launch_command_kwargs) return target_mount HEADLESS = 'xvfb-run -a -s "-ac -screen 0 1400x900x24 +extension RANDR"' @@ -90,8 +91,8 @@ def make_python_command( args_encoded, cp_version = encode_args(args, cloudpickle=use_cloudpickle) if args: - cmd = '%s=%s %s=%s %s=%s %s' % (ARGS_DATA, args_encoded, - USE_CLOUDPICKLE, str(int(use_cloudpickle)), + cmd = '%s=%s %s=%s %s=%s %s' % (ARGS_DATA, args_encoded, + USE_CLOUDPICKLE, str(int(use_cloudpickle)), CLOUDPICKLE_VERSION, cp_version, cmd) diff --git a/doodad/mode.py b/doodad/mode.py index e729da5..a5a5571 100644 --- a/doodad/mode.py +++ b/doodad/mode.py @@ -1,31 +1,33 @@ import os +import stat import subprocess import tempfile import uuid import time import base64 - -from doodad.ec2.autoconfig import AUTOCONFIG +import json try: from StringIO import StringIO except ImportError: from io import StringIO -from .mount import * -from .utils import hash_file, call_and_wait, CommandBuilder +from .mount import MountLocal, MountS3, MountGCP +from .utils import hash_file, call_and_wait, CommandBuilder, REPO_DIR from .ec2.aws_util import s3_upload, s3_exists +from .gcp.gcp_util import GCP_STARTUP_SCRIPT_PATH, GCP_SHUTDOWN_SCRIPT_PATH, \ + upload_file_to_gcp_storage, get_machine_type, get_gpu_type class LaunchMode(object): def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): raise NotImplementedError() - class Local(LaunchMode): - def __init__(self): + def __init__(self, skip_wait=False): super(Local, self).__init__() self.env = {} + self.skip_wait = skip_wait def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): if dry: @@ -63,7 +65,8 @@ def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): commands.extend(cleanup_commands) # Call everything - commands.call_and_wait() + commands.call_and_wait(verbose=verbose, dry=dry, + skip_wait=self.skip_wait) LOCAL = Local() @@ -76,7 +79,7 @@ def __init__(self, image='ubuntu:16.04', gpu=False): self.gpu = gpu def get_docker_cmd(self, main_cmd, extra_args='', use_tty=True, verbose=True, pythonpath=None, pre_cmd=None, post_cmd=None, - checkpoint=False, no_root=False): + checkpoint=False, no_root=False, use_docker_generated_name=False): cmd_list= CommandBuilder() if pre_cmd: cmd_list.extend(pre_cmd) @@ -101,7 +104,7 @@ def get_docker_cmd(self, main_cmd, extra_args='', use_tty=True, verbose=True, py cmd_list.extend(post_cmd) docker_name = self.docker_name - if docker_name: + if docker_name and not use_docker_generated_name: extra_args += ' --name %s '%docker_name if checkpoint: @@ -121,9 +124,10 @@ def get_docker_cmd(self, main_cmd, extra_args='', use_tty=True, verbose=True, py class LocalDocker(DockerMode): - def __init__(self, checkpoints=None, **kwargs): + def __init__(self, checkpoints=None, skip_wait=False, **kwargs): super(LocalDocker, self).__init__(**kwargs) self.checkpoints = checkpoints + self.skip_wait = skip_wait def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): mnt_args = '' @@ -131,7 +135,7 @@ def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): for mount in mount_points: if isinstance(mount, MountLocal): #mount_pnt = os.path.expanduser(mount.mount_point) - mount_pnt = mount.docker_mount_dir() + mount_pnt = mount.mount_dir() mnt_args += ' -v %s:%s' % (mount.local_dir, mount_pnt) call_and_wait('mkdir -p %s' % mount.local_dir) if mount.pythonpath: @@ -141,9 +145,8 @@ def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): full_cmd = self.get_docker_cmd(cmd, extra_args=mnt_args, pythonpath=py_path, checkpoint=self.checkpoints) - if verbose: - print(full_cmd) - call_and_wait(full_cmd, dry=dry) + call_and_wait(full_cmd, verbose=verbose, dry=dry, + skip_wait=self.skip_wait) class SSHDocker(DockerMode): @@ -181,7 +184,7 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): remote_cmds.append('mkdir -p %s' % remote_mnt_dir) unzip_cmd = 'tar -xf %s -C %s' % (remote_tar, remote_mnt_dir) remote_cmds.append(unzip_cmd) - mount_point = mount.docker_mount_dir() + mount_point = mount.mount_dir() mnt_args += ' -v %s:%s' % (os.path.join(remote_mnt_dir, os.path.basename(mount.mount_point)) ,mount_point) else: #remote_cmds.append('mkdir -p %s' % mount.mount_point) @@ -235,8 +238,10 @@ def __init__(self, security_groups=None, aws_s3_path=None, extra_ec2_instance_kwargs=None, + num_exps=1, + swap_size=4096, **kwargs - ): + ): super(EC2SpotDocker, self).__init__(**kwargs) if security_group_ids is None: security_group_ids = [] @@ -257,6 +262,8 @@ def __init__(self, self.security_groups = security_groups self.iam_instance_profile_name = iam_instance_profile_name self.extra_ec2_instance_kwargs = extra_ec2_instance_kwargs + self.num_exps = num_exps + self.swap_size = swap_size self.checkpoint = None self.s3_mount_path = 's3://%s/doodad/mount' % self.s3_bucket @@ -304,9 +311,11 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): exp_name = self.s3_log_name exp_prefix = self.s3_log_prefix s3_base_dir = os.path.join(self.aws_s3_path, exp_prefix.replace("_", "-"), exp_name) + stdout_log_s3_path = os.path.join(s3_base_dir, 'stdout_$EC2_INSTANCE_ID.log') sio = StringIO() sio.write("#!/bin/bash\n") + sio.write("set -v") sio.write("truncate -s 0 /home/ubuntu/user_data.log\n") sio.write("{\n") sio.write('die() { status=$1; shift; echo "FATAL: $*"; exit $status; }\n') @@ -317,6 +326,20 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): sio.write(""" aws ec2 create-tags --resources $EC2_INSTANCE_ID --tags Key=exp_prefix,Value={exp_prefix} --region {aws_region} """.format(exp_prefix=exp_prefix, aws_region=self.region)) + + # Add swap file + if self.gpu: + swap_location = '/mnt/swapfile' + else: + swap_location = '/var/swap.1' + sio.write( + 'sudo dd if=/dev/zero of={swap_location} bs=1M count={swap_size}\n' + .format(swap_location=swap_location, swap_size=self.swap_size)) + sio.write('sudo mkswap {swap_location}\n'.format(swap_location=swap_location)) + sio.write('sudo chmod 600 {swap_location}\n'.format(swap_location=swap_location)) + sio.write('sudo swapon {swap_location}\n'.format(swap_location=swap_location)) + + sio.write("service docker start\n") sio.write("docker --config /home/ubuntu/.docker pull {docker_image}\n".format(docker_image=self.docker_image)) sio.write("export AWS_DEFAULT_REGION={aws_region}\n".format(aws_region=self.s3_bucket_region)) @@ -367,6 +390,8 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): # spot instance ec2_local_dir = mount.mount_point s3_path = os.path.join(s3_base_dir, mount.s3_path) + if self.num_exps == 1: + stdout_log_s3_path = os.path.join(s3_path, 'stdout_$EC2_INSTANCE_ID.log') if not mount.output: raise NotImplementedError() local_output_dir_and_s3_path.append( @@ -403,6 +428,7 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): then logger "Running shutdown hook." aws s3 cp --recursive {log_dir} {s3_path} + aws s3 cp /home/ubuntu/user_data.log {stdout_log_s3_path} break else # Spot instance not yet marked for termination. @@ -415,13 +441,20 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): """.format( log_dir=ec2_local_dir, s3_path=s3_path, + stdout_log_s3_path=stdout_log_s3_path, )) else: raise NotImplementedError() - - sio.write("aws ec2 create-tags --resources $EC2_INSTANCE_ID --tags Key=Name,Value={exp_name} --region {aws_region}\n".format( - exp_name=exp_name, aws_region=self.region)) + sio.write(""" + while /bin/true; do + aws s3 cp /home/ubuntu/user_data.log {stdout_log_s3_path} + sleep {periodic_sync_interval} + done & echo sync initiated + """.format( + stdout_log_s3_path=stdout_log_s3_path, + periodic_sync_interval=max_sync_interval + )) if self.gpu: #sio.write('echo "LSMOD NVIDIA:"\n') @@ -448,7 +481,10 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): if self.checkpoint and self.checkpoint.restore: raise NotImplementedError() else: - docker_cmd = self.get_docker_cmd(main_cmd, use_tty=False, extra_args=mnt_args, pythonpath=py_path) + docker_cmd = self.get_docker_cmd(main_cmd, use_tty=False, extra_args=mnt_args, pythonpath=py_path, use_docker_generated_name=True) + assert self.num_exps > 0 + for _ in range(self.num_exps - 1): + sio.write(docker_cmd+' &\n') sio.write(docker_cmd+'\n') # Sync all output mounts to s3 after running the user script @@ -460,7 +496,10 @@ def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): local_dir=local_output_dir, s3_dir=s3_dir_path )) - sio.write("aws s3 cp /home/ubuntu/user_data.log {s3_dir_path}/stdout.log\n".format(s3_dir_path=s3_base_dir)) + + sio.write("aws s3 cp /home/ubuntu/user_data.log {}\n".format( + stdout_log_s3_path, + )) # Wait for last sync if max_sync_interval > 0: @@ -588,8 +627,335 @@ def __init__(self, ) +class GCPDocker(DockerMode): + def __init__( + self, + zone="us-east4-a", + gcp_bucket_name=None, + instance_type='n1-standard-4', + image_name=None, + image_project=None, + disk_size:"Gb"=64, + terminate=True, + preemptible=True, + gcp_log_prefix='experiment', + gcp_log_name=None, + gcp_log_path=None, + gpu_kwargs=None, + **kwargs + ): + super(GCPDocker, self).__init__(**kwargs) + assert 'CLOUDSDK_CORE_PROJECT' in os.environ.keys() + self.project = os.environ['CLOUDSDK_CORE_PROJECT'] + self.zone = zone + self.gcp_bucket_name = gcp_bucket_name + self.instance_type = instance_type + self.terminate = terminate + self.disk_size = disk_size + self.image_project = image_project + self.image_name = image_name + self.preemptible = preemptible + + self.gcp_log_prefix = gcp_log_prefix + self.gcp_log_name = gcp_log_name + self.gcp_log_path = gcp_log_path or 'doodad/logs' + if self.gpu: + self.num_gpu = gpu_kwargs['num_gpu'] + self.gpu_model = gpu_kwargs['gpu_model'] + self.gpu_type = get_gpu_type(self.project, self.zone, self.gpu_model) + + import googleapiclient.discovery + self.compute = googleapiclient.discovery.build('compute', 'v1') + + def launch_command(self, main_cmd, mount_points=None, dry=False, verbose=False): + if self.gcp_log_name is None: + exp_name = "{}-{}".format(self.gcp_log_prefix, EC2SpotDocker.make_timekey(self)) + else: + exp_name = self.gcp_log_name + exp_prefix = self.gcp_log_prefix + gcp_base_dir = os.path.join(self.gcp_log_path, exp_prefix.replace("_", "-"), exp_name) + + mnt_args = '' + py_path = [] + gcp_mount_info = [] + max_sync_interval = 0 + local_mounts = [] + for mount in mount_points: + print('Handling mount: ', mount) + if isinstance(mount, MountLocal): # TODO: these should be mount_s3 objects + if mount.read_only: + if mount.path_on_remote is None: + with mount.gzip() as gzip_file: + gzip_path = os.path.realpath(gzip_file) + file_hash = hash_file(gzip_path) + gcp_path = upload_file_to_gcp_storage( + bucket_name=self.gcp_bucket_name, + file_name=gzip_path, + remote_filename=file_hash+'.tar' + ) + mount.path_on_remote = gcp_path + mount.local_file_hash = file_hash + else: + file_hash = mount.local_file_hash + gcp_path = mount.path_on_remote + remote_unpack_name = '/tmp/'+file_hash + mount_point = os.path.join('/mounts', mount.mount_point.replace('~/','')) + mnt_args += ' -v %s:%s' % (os.path.join(remote_unpack_name, os.path.basename(mount.local_dir)), mount_point) + if mount.pythonpath: + py_path.append(mount_point) + local_mounts.append(file_hash) + else: + raise ValueError() + elif isinstance(mount, MountGCP): + gcp_local_dir = mount.mount_point + gcp_path = os.path.join(gcp_base_dir, mount.gcp_path) + if not mount.output: + raise NotImplementedError() + gcp_mount_info.append( + (gcp_local_dir, gcp_path, mount.include_string, mount.sync_interval) + ) + mnt_args += ' -v %s:%s' % (gcp_local_dir, mount.mount_point) + else: + raise NotImplementedError() + + docker_cmd = self.get_docker_cmd(main_cmd, use_tty=False, extra_args=mnt_args, pythonpath=py_path) + + metadata = { + 'bucket_name': self.gcp_bucket_name, + 'docker_cmd': docker_cmd, + 'docker_image': self.docker_image, + 'local_mounts': json.dumps(local_mounts), + 'gcp_mounts': json.dumps(gcp_mount_info), + 'use_gpu': json.dumps(self.gpu), + 'terminate': json.dumps(self.terminate), + 'startup-script': open(GCP_STARTUP_SCRIPT_PATH, "r").read(), + 'shutdown-script': open(GCP_SHUTDOWN_SCRIPT_PATH, "r").read(), + } + # instance name must match regex '(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)'"> + unique_name= "doodad" + str(uuid.uuid4()).replace("-", "") + self.create_instance(metadata, unique_name, exp_name, exp_prefix) + if verbose: + print(unique_name) + print(metadata) + + def create_instance(self, metadata, name, exp_name="", exp_prefix=""): + image_response = self.compute.images().get( + project=self.image_project, + image=self.image_name, + ).execute() + source_disk_image = image_response['selfLink'] + config = { + 'name': name, + 'machineType': get_machine_type(self.zone, self.instance_type), + 'disks': [{ + 'boot': True, + 'autoDelete': True, + 'initializeParams': { + 'sourceImage': source_disk_image, + 'diskSizeGb': self.disk_size, + } + }], + 'networkInterfaces': [{ + 'network': 'global/networks/default', + 'accessConfigs': [ + {'type': 'ONE_TO_ONE_NAT', 'name': 'External NAT'} + ] + }], + 'serviceAccounts': [{ + 'email': 'default', + 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] + }], + 'metadata': { + 'items': [ + {'key': key, 'value': value} + for key, value in metadata.items() + ] + }, + 'scheduling': { + "onHostMaintenance": "terminate", + "automaticRestart": False, + "preemptible": self.preemptible, + }, + "labels": { + "exp_name": exp_name, + "exp_prefix": exp_prefix, + } + } + if self.gpu: + config["guestAccelerators"] = [{ + "acceleratorType": self.gpu_type, + "acceleratorCount": self.num_gpu, + }] + return self.compute.instances().insert( + project=self.project, + zone=self.zone, + body=config + ).execute() + class CodalabDocker(DockerMode): def __init__(self): super(CodalabDocker, self).__init__() raise NotImplementedError() + +class SingularityMode(LaunchMode): + def __init__(self, image, gpu=False, pre_cmd=None, + post_cmd=None, skip_wait=False): + super(SingularityMode, self).__init__() + self.singularity_image = image + self.gpu = gpu + self.pre_cmd = pre_cmd + self.post_cmd = post_cmd + self.skip_wait = skip_wait + + def get_singularity_cmd( + self, + main_cmd, + extra_args='', + verbose=True, + pythonpath=None, + ): + cmd_list= CommandBuilder() + if self.pre_cmd: + cmd_list.extend(self.pre_cmd) + + if verbose: + if self.gpu: + cmd_list.append('echo \"Running in singularity (gpu)\"') + else: + cmd_list.append('echo \"Running in singularity\"') + if pythonpath: + cmd_list.append('export PYTHONPATH=$PYTHONPATH:%s' % (':'.join(pythonpath))) + + cmd_list.append(main_cmd) + if self.post_cmd: + cmd_list.extend(self.post_cmd) + + if self.gpu: + extra_args += ' --nv ' + singularity_prefix = 'singularity exec %s %s /bin/bash -c ' % ( + extra_args, + self.singularity_image, + ) + main_cmd = cmd_list.to_string() + full_cmd = singularity_prefix + ("\'%s\'" % main_cmd) + return full_cmd + + +class LocalSingularity(SingularityMode): + def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): + py_path = [] + for mount in mount_points: + if isinstance(mount, MountLocal): + if mount.pythonpath: + py_path.append(mount.local_dir) + else: + raise NotImplementedError(type(mount)) + + full_cmd = self.get_singularity_cmd( + cmd, + pythonpath=py_path, + verbose=verbose, + ) + call_and_wait(full_cmd, verbose=verbose, dry=dry, + skip_wait=self.skip_wait) + + +class SlurmSingularity(LocalSingularity): + # TODO: set up an auto-config + def __init__( + self, image, account_name, partition, time_in_mins, + qos=None, + nodes=1, + n_tasks=1, + n_gpus=1, + **kwargs + ): + super(SlurmSingularity, self).__init__(image, **kwargs) + self.account_name = account_name + self.partition = partition + self.time_in_mins = time_in_mins + self.nodes = nodes + self.n_tasks = n_tasks + self.n_gpus = n_gpus + + def create_slurm_command(self, cmd, mount_points=None, verbose=False): + py_path = [] + for mount in mount_points: + if isinstance(mount, MountLocal): + if mount.pythonpath: + py_path.append(mount.local_dir) + else: + raise NotImplementedError(type(mount)) + + singularity_cmd = self.get_singularity_cmd( + cmd, + pythonpath=py_path, + verbose=verbose, + ) + if self.gpu: + full_cmd = ( + "sbatch -A {account_name} -p {partition} -t {time}" + " -N {nodes} -n {n_tasks} --cpus-per-task={cpus_per_task}" + " --gres=gpu:{n_gpus} {cmd}".format( + account_name=self.account_name, + partition=self.partition, + time=self.time_in_mins, + nodes=self.nodes, + n_tasks=self.n_tasks, + cpus_per_task=2*self.n_gpus, + n_gpus=self.n_gpus, + cmd=singularity_cmd, + ) + ) + else: + full_cmd = "sbatch -A {account_name} -p {partition} -t {time} {cmd}".format( + account_name=self.account_name, + partition=self.partition, + time=self.time_in_mins, + cmd=singularity_cmd, + ) + if verbose: + print(full_cmd) + + def launch_command(self, cmd, mount_points=None, dry=False, verbose=False): + full_cmd = self.create_slurm_command( + cmd, mount_points=mount_points, verbose=verbose, + ) + call_and_wait(full_cmd, dry=dry, skip_wait=self.skip_wait) + + +class ScriptSlurmSingularity(SlurmSingularity): + """ + Create or add to a script to run a bunch of slurm jobs. + """ + TMP_FILE = '/tmp/script_to_scp_over.sh' + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.is_first_time = False + + def set_first_time(self, is_first_time): + self.is_first_time = is_first_time + + def launch_command( + self, + cmd, + dry=False, + mount_points=None, + verbose=False, + ): + full_cmd = self.create_slurm_command( + cmd, mount_points=mount_points, verbose=verbose, + ) + if self.is_first_time: + with open(self.TMP_FILE, "w") as myfile: + myfile.write(full_cmd + '\n') + # make file executable + st = os.stat(self.TMP_FILE) + os.chmod(self.TMP_FILE, st.st_mode | stat.S_IEXEC) + print("Script generated! scp this script over:", self.TMP_FILE) + else: + with open(self.TMP_FILE, "a") as myfile: + myfile.write(full_cmd + '\n') + print("Script updated. scp this script over:", self.TMP_FILE) diff --git a/doodad/mount.py b/doodad/mount.py index c1eab15..1b72591 100644 --- a/doodad/mount.py +++ b/doodad/mount.py @@ -77,7 +77,7 @@ def filter_func(tar_info): def __str__(self): return 'MountLocal@%s'%self.local_dir - def docker_mount_dir(self): + def mount_dir(self): return os.path.join('/mounts', self.mount_point.replace('~/','')) @@ -89,6 +89,24 @@ def __init__(self, git_url, git_credentials=None, **kwargs): raise NotImplementedError() +class MountGCP(Mount): + def __init__(self, gcp_path, gcp_bucket_name, sync_interval=15, output=False, + include_types=('*.txt', '*.csv', '*.json', '*.gz', '*.tar', '*.log', '*.pkl'), **kwargs): + super(MountGCP, self).__init__(**kwargs) + self.gcp_bucket_name = gcp_bucket_name + self.gcp_path = gcp_path + self.output = output + self.sync_interval = sync_interval + self.sync_on_terminate = True + self.include_types = include_types + + def __str__(self): + return 'MountGCP@gcp://%s/%s'% (self.gcp_bucket_name, self.gcp_path) + + @property + def include_string(self): + return ' '.join(['--include \'%s\''%type_ for type_ in self.include_types]) + class MountS3(Mount): def __init__(self, s3_path, s3_bucket=None, sync_interval=15, output=False, include_types=('*.txt', '*.csv', '*.json', '*.gz', '*.tar', '*.log', '*.pkl'), **kwargs): diff --git a/doodad/utils.py b/doodad/utils.py index 5bafeb3..1989239 100644 --- a/doodad/utils.py +++ b/doodad/utils.py @@ -8,7 +8,7 @@ REPO_DIR = os.path.dirname(THIS_FILE_DIR) EXAMPLES_DIR = os.path.join(REPO_DIR, 'examples') -HASH_BUF_SIZE = 65536 +HASH_BUF_SIZE = 65536 def hash_file(filename): hasher = hashlib.md5() @@ -21,11 +21,13 @@ def hash_file(filename): return hasher.hexdigest() -def call_and_wait(cmd, verbose=False, dry=False): +def call_and_wait(cmd, verbose=False, dry=False, skip_wait=False): if dry or verbose: print(cmd) if not dry: p = subprocess.Popen(cmd, shell=True) + if skip_wait: + return try: p.wait() except KeyboardInterrupt: @@ -64,8 +66,13 @@ def __iter__(self): for cmd in self.cmds: yield cmd - def call_and_wait(self, verbose=False, dry=False): - return call_and_wait(self.to_string()) + def call_and_wait(self, verbose=False, dry=False, skip_wait=False): + return call_and_wait( + self.to_string(), + verbose=verbose, + dry=dry, + skip_wait=skip_wait, + ) @contextlib.contextmanager def as_script(self, suffix='.sh'): diff --git a/scripts/gcp/gcp_shutdown_script.sh b/scripts/gcp/gcp_shutdown_script.sh new file mode 100644 index 0000000..99cf3ff --- /dev/null +++ b/scripts/gcp/gcp_shutdown_script.sh @@ -0,0 +1,20 @@ +#!/bin/bash +query_metadata() { + attribute_name=$1 + curl http://metadata/computeMetadata/v1/instance/attributes/$attribute_name -H "Metadata-Flavor: Google" +} + +bucket_name=$(query_metadata bucket_name) +gcp_mounts=$(query_metadata gcp_mounts) +instance_name=$(curl http://metadata/computeMetadata/v1/instance/name -H "Metadata-Flavor: Google") + +num_gcp_mounts=$(jq length <<< $gcp_mounts) +for ((i=0;i<$num_gcp_mounts;i++)); do + gcp_mount_info=$(jq .[$i] <<< $gcp_mounts) + # assume gcp_mount_info is a (local_path, bucket_path, include_string, periodic_sync_interval) tuple + local_path=$(jq .[0] <<< $gcp_mount_info | tr -d '"') + gcp_bucket_path=$(jq .[1] <<< $gcp_mount_info | tr -d '"') + gsutil -m rsync -r $local_path gs://$bucket_name/$gcp_bucket_path +done + +gsutil cp /home/ubuntu/user_data.log gs://$bucket_name/$gcp_bucket_path/${instance_name}_stdout.log diff --git a/scripts/gcp/gcp_startup_script.sh b/scripts/gcp/gcp_startup_script.sh new file mode 100644 index 0000000..9338d87 --- /dev/null +++ b/scripts/gcp/gcp_startup_script.sh @@ -0,0 +1,95 @@ +#!/bin/bash +install_docker() { + sudo apt-get install -y --no-install-recommends \ + apt-transport-https \ + curl \ + software-properties-common + curl -fsSL 'https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e' | sudo apt-key add - + sudo add-apt-repository \ + "deb https://packages.docker.com/1.12/apt/repo/ \ + ubuntu-$(lsb_release -cs) \ + main" + sudo apt-get update + sudo apt-get -y install docker-engine + sudo usermod -a -G docker ubuntu +} + +query_metadata() { + attribute_name=$1 + curl http://metadata/computeMetadata/v1/instance/attributes/$attribute_name -H "Metadata-Flavor: Google" +} + +{ + bucket_name=$(query_metadata bucket_name) + docker_cmd=$(query_metadata docker_cmd) + docker_image=$(query_metadata docker_image) + local_mounts=$(query_metadata local_mounts) + gcp_mounts=$(query_metadata gcp_mounts) + use_gpu=$(query_metadata use_gpu) + terminate=$(query_metadata terminate) + instance_name=$(curl http://metadata/computeMetadata/v1/instance/name -H "Metadata-Flavor: Google") + echo "bucket_name:" $bucket_name + echo "docker_cmd:" $docker_cmd + echo "docker_image:" $docker_image + echo "local_mounts:" $local_mounts + echo "gcp_mounts:" $gcp_mounts + echo "use_gpu:" $use_gpu + echo "terminate:" $terminate + echo "instance_name:" $instance_name + + sudo apt-get update + #install_docker + while sudo fuser /var/{lib/{dpkg,apt/lists},cache/apt/archives}/lock >/dev/null 2>&1; do + sleep 1 + done + sudo apt-get install -y jq git unzip + die() { status=$1; shift; echo "FATAL: $*"; exit $status; } + service docker start + docker --config /home/ubuntu/.docker pull $docker_image + + num_local_mounts=$(jq length <<< $local_mounts) + for ((i=0;i<$num_local_mounts;i++)); do + local_mount=$(jq .[$i] <<< $local_mounts | tr -d '"') + echo "Mounting " $local_mount + gsutil cp gs://$bucket_name/doodad/mount/$local_mount.tar /tmp/$local_mount.tar + mkdir -p /tmp/$local_mount + tar -xvf /tmp/$local_mount.tar -C /tmp/$local_mount + done + + num_gcp_mounts=$(jq length <<< $gcp_mounts) + for ((i=0;i<$num_gcp_mounts;i++)); do + gcp_mount_info=$(jq .[$i] <<< $gcp_mounts) + # assume _mount_info is a (local_path, bucket_path, include_string, periodic_sync_interval) tuple + local_path=$(jq .[0] <<< $gcp_mount_info | tr -d '"') + gcp_bucket_path=$(jq .[1] <<< $gcp_mount_info | tr -d '"') + include_string=$(jq .[2] <<< $gcp_mount_info | tr -d '"') + periodic_sync_interval=$(jq .[3] <<< $gcp_mount_info | tr -d '"') + while /bin/true; do + gsutil -m rsync -r $local_path gs://$bucket_name/$gcp_bucket_path + sleep $periodic_sync_interval + done & echo sync from $local_path to gs://$bucket_name/$gcp_bucket_path initiated + done + while /bin/true; do + gsutil cp /home/ubuntu/user_data.log gs://$bucket_name/$gcp_bucket_path/${instance_name}_stdout.log + sleep 300 + done & + + if [ "$use_gpu" = "true" ]; then + for i in {1..800}; do su -c "nvidia-modprobe -u -c=0" ubuntu && break || sleep 3; done + systemctl start nvidia-docker + echo 'Testing nvidia-smi' + nvidia-smi + echo 'Testing nvidia-smi inside docker' + nvidia-docker run --rm $docker_image nvidia-smi + fi + + echo $docker_cmd >> run_docker_command.sh + bash run_docker_command.sh + + if [ "$terminate" = "true" ]; then + echo "Finished experiment. Terminating" + zone=$(curl http://metadata/computeMetadata/v1/instance/zone -H "Metadata-Flavor: Google") + zone="${zone##*/}" + gcloud compute instances delete $instance_name --zone $zone --quiet + fi +} >> /home/ubuntu/user_data.log 2>&1 diff --git a/scripts/setup_ec2.py b/scripts/setup_ec2.py index 6b4ece3..45ed52e 100644 --- a/scripts/setup_ec2.py +++ b/scripts/setup_ec2.py @@ -24,7 +24,7 @@ raise ValueError('Please set the $AWS_ACCESS_KEY environment variable') ACCESS_SECRET = os.environ.get("AWS_ACCESS_SECRET", None) if ACCESS_SECRET is None: - raise ValueError('Please set the $AWS_ACCESS_KEY environment variable') + raise ValueError('Please set the $AWS_ACCESS_SECRET environment variable') S3_BUCKET_NAME = os.environ.get("DOODAD_S3_BUCKET", None) if S3_BUCKET_NAME is None: raise ValueError('Please set the $DOODAD_S3_BUCKET environment variable') diff --git a/setup.py b/setup.py index e69de29..6914311 100644 --- a/setup.py +++ b/setup.py @@ -0,0 +1,7 @@ +from setuptools import setup + +setup(name='doodad', + version='0.0.1', + description="Doodad: easy setup of AWS EC2/S3", + install_requires=[], +) \ No newline at end of file