diff --git a/.cargo/config b/.cargo/config index 131fb70..94478c3 100644 --- a/.cargo/config +++ b/.cargo/config @@ -1,8 +1,11 @@ -[source.crates-io] -replace-with = 'tuna' +[net] +git-fetch-with-cli = true -[source.tuna] -registry = "https://mirrors.tuna.tsinghua.edu.cn/git/crates.io-index.git" +# [source.crates-io] +# replace-with = 'tuna' +# +# [source.tuna] +# registry = "https://mirrors.tuna.tsinghua.edu.cn/git/crates.io-index.git" -# [target.x86_64-unknown-linux-musl] -# linker = "musl-gcc" +[target.x86_64-unknown-linux-musl] +linker = "musl-gcc" diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..b2568f6 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,37 @@ +name: Rust + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +env: + CARGO_TERM_COLOR: always + +jobs: + # coverage: + # runs-on: ubuntu-latest + # steps: + # - uses: actions/checkout@v2 + # - uses: actions-rs/toolchain@v1 + # with: + # toolchain: stable + # components: llvm-tools-preview + # - name: Install cargo-llvm-cov + # uses: taiki-e/install-action@cargo-llvm-cov + # - name: Generate code coverage + # run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info + # - name: Upload coverage to Codecov + # uses: codecov/codecov-action@v1 + # with: + # files: lcov.info + # fail_ci_if_error: true + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Build + run: rustup update stable; make ci + - name: Run tests + run: rustup update stable; make test diff --git a/.gitignore b/.gitignore index 6ade143..33cbd9b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,26 +1,24 @@ -# Generated by Cargo -# will have compiled files and executables -target/ +debug/ +release/ -# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries -# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html -Cargo.lock +target -# These are backup files generated by rustfmt **/*.rs.bk +.DS_Store +**/*~ +**/.vscode +.*.sw* +.stack-work +stack.yaml.lock +**/history.txt +**/__pycache__ +.idea + +node_modules +package-lock.json - -#Added by cargo - -/target - - -#Added by cargo -# -#already existing elements were commented out - -#/target -#Cargo.lock - +Cargo.lock +*.tar.gz nohup.out -tt.*.*z + +log_tester.tar.gz* diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 93a53cc..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,23 +0,0 @@ -stages: - - build - - test - - deploy - -job_build: - stage: build - script: - - make lint - tags: - - rust - -job_test: - stage: test - script: - - make test - - export PATH=$PATH:~/.cargo/bin - - cargo kcov --all - - COVERAGE=$(grep -Po '(?<="covered":")\d+(?:\.\d+)?(?=")' target/cov/index.js) - # Tips: use '^Coverage:\s+(\d+(?:\.\d+)?)' on gitlab to capture the result - - echo "Coverage:" ${COVERAGE} - tags: - - rust diff --git a/Cargo.toml b/Cargo.toml index d90be51..e6215fa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,15 +1,21 @@ [workspace] members = [ - "src/core_def", - "src/core", - "src/server_def", - "src/server", - "src/proxy", + "src/tt", "src/client", - "src/rexec", - "src/utils", + "src/server", + "src/framework", + "src/engine", ] +[workspace.dependencies] +ruc = "4.1.0" +once_cell = "1.17.1" +parking_lot = "0.12.1" +serde = { version = "1.0.160", features = ["derive"] } + +tt-engine = { path = "src/engine", version = "0.1.0" } +tt-framework = { path = "src/framework", version = "0.1.0" } + [profile.dev] overflow-checks = true panic = "unwind" diff --git a/LICENSE b/LICENSE index a0aa749..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2020 范辉 - -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. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile index ad519fe..f3ca2e7 100644 --- a/Makefile +++ b/Makefile @@ -1,108 +1,42 @@ -CARGO = ~/.cargo/bin/cargo -BUILD_DIR = /tmp/.__tt_build_dir__ -PACK_NAME = tt -PACK_DIR = $(BUILD_DIR)/$(PACK_NAME) -TARGET = $(shell rustup toolchain list | grep default | sed 's/^[^-]\+-//' | sed 's/ \+(default).*//') +export CARGO_NET_GIT_FETCH_WITH_CLI = true -all: pack +all: fmt ci -build: - $(CARGO) build --bins - -release: - $(CARGO) build --bins --release - -pack: release - -@ rm -rf $(PACK_DIR) - mkdir -p $(PACK_DIR) - cd target/release && cp tt ttserver ttproxy $(PACK_DIR)/ - cp tools/install.sh $(PACK_DIR)/ - \ - git submodule update --init --recursive - cd tools/firecracker \ - && cargo build --release --target=$(TARGET) --target-dir=$(BUILD_DIR) \ - && cp $(BUILD_DIR)/$(TARGET)/release/firecracker $(PACK_DIR)/ - \ - chmod -R +x $(PACK_DIR) - tar -C $(BUILD_DIR) -zcf $(PACK_NAME).tar.gz $(PACK_NAME) +ci: lint release install: - $(CARGO) install -f --bins --path src/rexec --root=/usr/local/ - $(CARGO) install -f --bins --path src/client --root=/usr/local/ - $(CARGO) install -f --bins --path src/server --root=/usr/local/ # will fail on MacOS - $(CARGO) install -f --bins --path src/proxy --root=/usr/local/ # will fail on MacOS + cargo install --path src/tt -lint: githook - $(CARGO) clippy - cd src/core && $(CARGO) clippy --features="testmock" - cd src/core && $(CARGO) clippy --no-default-features - cd src/core && $(CARGO) clippy --no-default-features --features="zfs" - cd src/core && $(CARGO) clippy --no-default-features --features="cow" - cd src/core && $(CARGO) clippy --no-default-features --features="nft" - cd src/core && $(CARGO) clippy --no-default-features --features="cow nft" - cd src/server && $(CARGO) clippy --features="testmock" - cd src/server && $(CARGO) clippy --no-default-features - cd src/server && $(CARGO) clippy --no-default-features --features="zfs" - cd src/server && $(CARGO) clippy --no-default-features --features="cow" - cd src/server && $(CARGO) clippy --no-default-features --features="nft" - cd src/server && $(CARGO) clippy --no-default-features --features="cow nft" - cd src/proxy && $(CARGO) clippy --features="testmock" +release: + cargo build --release --bins -test: test_debug +lint: + cargo clippy --workspace --bins + cargo check --workspace --tests + cargo check --workspace --benches + @# cargo check --workspace --examples -test_debug: stop - $(CARGO) test -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --features="testmock" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --features="testmock, cow" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --no-default-features --features="testmock" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --no-default-features --features="testmock, cow" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/proxy && $(CARGO) test --features="testmock" -- --test-threads=1 --nocapture - -@ pkill -9 integration +test: + cargo test --workspace --tests --bins -- --test-threads=1 --nocapture + cargo test --workspace --release --tests --bins -- --test-threads=1 --nocapture -test_release: stop - $(CARGO) test --release -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --release --features="testmock" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --release --features="testmock, cow" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --release --no-default-features --features="testmock" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/server && $(CARGO) test --release --no-default-features --features="testmock, cow" -- --test-threads=1 --nocapture - -@ pkill -9 integration - cd src/proxy && $(CARGO) test --release --features="testmock" -- --test-threads=1 --nocapture - -@ pkill -9 integration +bench: + cargo bench --workspace fmt: - @ ./tools/fmt.sh + cargo +nightly fmt -doc: - $(CARGO) doc --open -p tt - $(CARGO) doc --open -p ttrexec - $(CARGO) doc --open -p ttproxy - $(CARGO) doc --open -p ttserver # will fail on MacOS - $(CARGO) doc --open -p ttcore # will fail on MacOS - -githook: - @mkdir -p ./.git/hooks # play with online gitlab-ci - @cp ./tools/githooks/pre-commit ./.git/hooks/ +fmtall: + bash tools/fmt.sh -stop: - -@ pkill -9 ttproxy - -@ pkill -9 ttserver - -@ pkill -9 ttrexec-daemon +update: + cargo update clean: - @ git clean -fdx - @ $(CARGO) clean - @ find . -type f -name "Cargo.lock" | xargs rm -f + cargo clean + git stash + git clean -fdx -cleanall: clean - @ rm -rf client core core_def server server_def proxy rexec - @ find . -type d -name "target" | xargs rm -rf +doc: + cargo doc --open diff --git a/README.md b/README.md index 4d6476a..d4f115d 100644 --- a/README.md +++ b/README.md @@ -1,199 +1,17 @@ -# tt - -![](https://tokei.rs/b1/github/rustcc/ttstack) -![pipeline status](https://gitlab.com/ktmlm/ttstack/badges/master/pipeline.svg) -![coverage report](https://gitlab.com/ktmlm/ttstack/badges/master/coverage.svg) - -A light-weight 'private cloud solution' for SMEs, it can bring huge help and commercial value to start-up companies. - -面向中小型企业的轻量级私有云平台, 可快速生成各种虚拟机环境, 为产品兼容性验证和自动化测试等场景提供高效的基础环境. - -> #### 中小企业的效率悖论 -> -> 初创的中小企业, 技术实力薄弱, 很多生产手段都停留在刀耕火种的蛮荒时代. -> -> **这就形成了一个悖论:** -> -> > 原理上来讲, 初创公司要赶超大型公司, 必须要赢在效率; 确实, 在"人"的主观效率上, 如"管理流程"等方面, 大多数初创公司因为业务场景简单, 都能做到这一点；但"技术流程"上, 却是落后地一塌糊涂, 其结果当然是惨不忍睹, 尤如二战中的波兰骑兵, 高扬着马刀(原始工具)冲向德国人的坦克(现代工具), 不管马背上的骑士如何迅捷("人"的效率高), 都干不过坐在坦克("工具"的效率高)中的德国兵. -> > -> > 同时, 由于初创公司资金短缺, 很少有第三方的公司愿意去开拓这一块市场(无利可图); 而初创公司本身, 又没有足够的资源去自己解决, 这样就进入一个恶性循环, 永远处在"头痛医头, 脚痛医脚"的低效状态 , 直到公司倒闭, 或出现某个牛人以一己之力改变现状. -> -> 本项目以简洁易用为宗旨, 志在解决这个"无人问津"的悖论: -> -> - 专门面向中小企业设计, 分布式架构, 可扩展, 可伸缩 -> - 充分利用硬件资源: 通过云平台统一调度所有硬件资源, 大幅提升资源利用率和灵活性 -> - 极低的系统架设和维护成本: 运维人员通常只需半小时即可搭建起一套完整的 TT 私有云平台 -> - 极低的学习和使用成本: 终端用户通常只需十分钟即可熟练使用 TT 客户端创建需要的虚拟环境 -> - **省钱, 是的! 很省钱!** 你无需耗费巨资养活一个专门的云团队(OpenStack/K8S 专业人员的身价通常都很高) -> - 公有云真的很便宜? 很便利? 很安全? 用过的都知道答案 -> - ... - -## 主要用途 - -1. 广泛的平台兼容性验证 - - 可在如下两个方向上做任意的交叉组合 - 1. Linux、BSD、Windows、MacOS 等各种 OS 类别与版本 - 2. AMD64、X86、AArch64、ARM、MIPS、RISC-V、SPARC 等各种硬件平台 -2. 与 DevOps 系统配合, 实现自动化的 CI\CD 功能 -3. 用作原生编译平台 - - 直接申请全量的原生 OS 环境, 避免交叉编译的复杂度和潜在问题 -4. 用作短期或长期的调试环境 - - 可将 TT 视为传统的云平台, 申请虚拟机用于开发和测试 -5. 其它... - -## 技术特性 - -- 整洁高效的资源管理 - - 每个 VM 存在于独立的 Cgroup 中, 资源清理准确无误 - - [可选] 使用 FireCracker 快速创建大量的轻量级 MicroVM - - [默认] 使用 zfs 的 `snapshot\clone` 机制使 VM 获得原生 IO 性能 - - [默认] 使用 nftables 的 `SET\MAP` 等高级数据结构管理网络端口 - - 服务进程运行在单独的 `PID NS` 中, 服务退出会自动销毁所有资源 - - 通过 `Rust Drop` 机制自动管理 VM 生命周期 - - ... -- 分布式可扩展架构 - - 后端支持多机分布式架构, 对用户完全透明 -- 轻量级的通信模型 - - C\S 两端基于 UDP\SCTP 进行通信 - - 自研的远程命令执行工具, 效率远超 SSH 协议 -- 镜像源与服务解耦 - - 可随时增加受支持的系统镜像, 服务端不需要停机 - - 支持多种虚拟机引擎, 如: Qemu\FireCracker\Bhyve 等 - - 以镜像名称前缀识别虚拟机类型, 如: fire:centos-7.3:3.10.e17.x86_64 -- 使用`Rust`语言开发 - - 安全稳定 - - 高效运行 - - 文档齐备 - - 原生跨平台 - - ... - -## Quick Start - -#### 编译 - -```shell -make install -export PATH=~/.cargo/bin:$PATH -``` - -#### 启动服务端 - -> **注意** -> -> 镜像文件一定**不**能存放在'/tmp'或其子目录下, 会导致无法扫描到镜像信息(ttserver 的'/tmp'路径私有的, 与外界环境互相隔离). - -```shell -# Slave Server 1 -ttserver \ - --image-path /home/images \ - --cfgdb-path /tmp \ - --cpu-total 2 \ - --mem-total $[4 * 1024 * 1024] \ - --disk-total $[40 * 1024 * 1024] \ - --serv-addr 127.0.0.1 \ - --serv-port 20000 +![GitHub top language](https://img.shields.io/github/languages/top/rust-util-collections/tt) +![Minimum rustc version](https://img.shields.io/badge/rustc-1.63+-lightgray.svg) +![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rust-util-collections/tt/rust.yml?branch=master) -# Slave Server 2 -ttserver \ - --image-path /home/images \ - --cfgdb-path /tmp \ - --cpu-total 2 \ - --mem-total $[4 * 1024 * 1024] \ - --disk-total $[40 * 1024 * 1024] \ - --serv-addr 127.0.0.1 \ - --serv-port 20001 - -# Proxy, 分布式代理服务, 负责调度各 Slave Server 的资源 -ttproxy \ - --proxy-addr 127.0.0.1:20002 \ - --server-set 127.0.0.1:20000,127.0.0.1:20001 -``` - -#### 客户端操作 - -> **Tips** -> - 完整的客户端操作文档, 参见: [《用户指南》](./documents/user_guide.md) -> - "/home/images" 路径下需要存在可正常启动的 Qemu 镜像文件 -> - 镜像文件中的 "/etc/rc.local" 文件需要替换为本项目定制的 "[rc.local](./tools/images/linux_vm/rc.local)" - -```shell -# 配置服务端地址, -# 既可以是 Proxy 的地址, -# 也可以是各个独立的 Slave Server 地址, -# 这里配置成 Proxy 的地址, 以演示分布式架构的调度效果 -tt config --serv-addr 127.0.0.1 --serv-port 20002 - -# 查看客户端本地信息 -tt status - -# 查看服务端资源信息 -tt status --server - -# 创建一个 "ENV", -# TT 中的基本管理单位为 ENV (一组 VM 的集合), -# 创建的 VM 类别是以系统前缀匹配的, 不区分大小写, -# 如: -# - cent 会匹配到所有 CentOS 系统 -# - ubuntu2004 只会匹配到 Ubuntu2004 一个系统 -tt env add TEST --os-prefix=cent,ubuntu2004 - -# 查看已创建的 ENV 列表 -tt env list - -# 查看已创建的某个 ENV 的详情 -tt env show TEST - -# 在 ENV 的所有 VM 上执行相同的命令 -tt env run TEST --use-ssh --cmd 'ls /' - -# 删除 ENV, -# 其中所有的 VM 及其相关数据都会被清理 -tt env del TEST -``` - -## 详细文档 - -- [开发路线(RoadMap)](./documents/roadmap.md) -- [终端用户指南](./documents/user_guide.md) -- [系统管理指南](./documents/system_admin.md) -- [架构设计与技术选型](./documents/arch_design.md) -- [项目结构与代码规模](./documents/code_about.md) - -> #### 接口文档 -> -> ```shell -> # 在 Rust 开发环境下执行 -> make doc -> ``` +# tt -## BUG +tt, **t**esting **t**ools ? -- 单个 ENV 超过 400+ VM 时, 可能出现异常 - - 原因是太大的 ENV 会超过 UDP 单次通信的最大载荷 - - 目前采用了数据压缩的方式予以缓解, 后续将改用 HTTP\SCTP +A lightweight private(local) cloud solution for developers and SMEs. -## Statistics +### Gratitude -``` -# Tips: cargo install tokei +Thanks to all the people who already contributed! -(git)-[master]-% tokei -=============================================================================== - Language Files Lines Code Comments Blanks -=============================================================================== - BASH 1 5 2 1 2 - Makefile 1 108 92 0 16 - Shell 8 278 198 30 50 - TOML 10 234 192 1 41 -------------------------------------------------------------------------------- - Markdown 10 662 0 492 170 - |- Shell 4 372 333 23 16 - (Total) 1034 333 515 186 -------------------------------------------------------------------------------- - Rust 77 9182 7770 287 1125 - |- Markdown 71 803 41 707 55 - (Total) 9985 7811 994 1180 -=============================================================================== - Total 107 11644 8628 1541 1475 -=============================================================================== -``` + + + diff --git a/documents/arch_design.md b/documents/arch_design.md deleted file mode 100644 index a98b4ba..0000000 --- a/documents/arch_design.md +++ /dev/null @@ -1,72 +0,0 @@ -# System Design - -## 架构说明 - -### 上层逻辑 - -TT 中的基本管理单位为 “环境(ENV)”, 如下以时序图的方式展现一个 “环境” 的创建过程. - -```mermaid -sequenceDiagram - autonumber - - participant C as Client - participant P as Proxy - participant S as Server[s] - participant R as Core - - C->>P: 创建 VM 的请求 - par 分发请求 - P-->>S: 计算可用资源, 并行分发 - end - - S->>R: 调用 Core 创建 VM - Note right of S: 配置网络及生命周期 - R->>S: return - - par 返回结果 - S->>P: 异步返回 - end - - P->>C: 聚合各 Server 的结果 - - loop 资源管理 - R-->>R: 定时清理过期的 VM - end -``` - -### Core 内部实现 - -#### On Linux - -```mermaid -sequenceDiagram - autonumber - - participant C as Core - participant K as Kernel - participant Q as Qemu/FireCracker - participant N as Nftables - - C->>K: 创建 PID NS 与 CGROUP - C->>Q: 增量(COW)创建运行时镜像 - C->>N: 使用 Nftables 的哈希表结构管理 NAT 规则 -``` - -## Why NOT - -### Why NOT K8S - -K8S 主要用于调度容器, 不适于对隔离性要求较高的场景. - -### Why NOT OpenStack - -OpenStack 太过复杂, 需要专门的团队维护, 成本太高. - -### Why NOT Ansible - -Ansible 只是一个批量管理工具, 不具备虚拟方案的管理与调度功能. - -### Why NOT Libvirt - -Libvirt 在安装系统及远程管理方面非常便捷, 但不具备自动化调度的能力. 当前 TT 系统使用 Libvirt 做为基础系统镜像的安装工具. diff --git a/documents/code_about.md b/documents/code_about.md deleted file mode 100644 index d11ba94..0000000 --- a/documents/code_about.md +++ /dev/null @@ -1,71 +0,0 @@ -# tt - -tt 主要代码使用 Rust 编写. - -Rust 是一门风格**紧凑**、运行**高效**的现代开发语言, 以**最少的代码量**实现**最高的性能**, 打破了几十年来的旷世难题: 静态语言与动态语言两者的优势不能兼得. - -## 项目结构 - -``` -$ (git)-[master]-% tree -F -I 'target' -L 1 -. -├── Cargo.toml # 项目配置文件 -├── README.md # 项目主文档 -├── documents/ # 项目详细文档 -├── src/core/ # 服务端的核心逻辑实现 -├── src/core_def/ # 从 core 模块中提取出的通用定义, 供 server 模块使用 -├── src/server/ # 后端 Server 的代码实现, 可独立运行, 也可挂靠在 Proxy 之后 -├── src/server_def/ # 从 server 模块中提取出的通用定义, 供 proxy 模块使用 -├── src/proxy/ # 分布式架构后端, 负责统筹调度多个 Server 的资源 -├── src/rexec/ # 一个轻量级的"远程命令执行和文件转输"方案 -├── src/client/ # 客户端 tt 命令的代码实现 -├── tools/ # 外围脚本工具 -└── ... -``` - -## 代码规模 - -``` -$ (git)-[master]-% find . -type f \ - | grep -Ev 'target|tools/(.*kernel_config|firecracker)|\.(git|lock)' \ - | xargs wc -l \ - | grep -Ev '^ +[0-9]{1,2} ' - - 108 ./Makefile - 194 ./README.md - 482 ./documents/user_guide.md - 169 ./src/rexec/tests/integration.rs - 117 ./src/rexec/src/bin/cli.rs - 149 ./src/rexec/src/client.rs - 272 ./src/rexec/src/server.rs - 164 ./src/rexec/src/common.rs - 1220 ./src/core/src/def.rs - 293 ./src/core/src/linux/nat/mod.rs - 205 ./src/core/src/linux/mod.rs - 150 ./src/core/src/linux/vm/cgroup.rs - 357 ./src/core/src/linux/vm/engine/qemu.rs - 245 ./src/core/src/linux/vm/engine/firecracker/suitable_env.rs - 312 ./src/proxy/tests/knead/mod.rs - 220 ./src/proxy/tests/standalone/mod.rs - 179 ./src/proxy/tests/env/mod.rs - 151 ./src/proxy/src/util.rs - 102 ./src/proxy/src/def.rs - 145 ./src/proxy/src/hdr/add_env.rs - 424 ./src/proxy/src/hdr/mod.rs - 265 ./src/proxy/src/lib.rs - 198 ./src/core_def/src/lib.rs - 267 ./src/server/tests/knead/mod.rs - 193 ./src/server/tests/standalone/mod.rs - 107 ./src/server/tests/env/mod.rs - 100 ./src/server/src/bin/ttserver.rs - 329 ./src/server/src/hdr/mod.rs - 120 ./src/server/src/lib.rs - 231 ./src/server_def/src/lib.rs - 555 ./src/client/src/cmd_line.rs - 157 ./src/client/src/ops/env/update.rs - 253 ./src/client/src/ops/env/run/mod.rs - 114 ./src/client/src/ops/env/run/ssh.rs - 131 ./src/client/src/ops/mod.rs - 149 ./src/client/src/cfg_file.rs - 12034 total -``` diff --git a/documents/firecracker_kernel_notes.md b/documents/firecracker_kernel_notes.md deleted file mode 100644 index 4ab7ba3..0000000 --- a/documents/firecracker_kernel_notes.md +++ /dev/null @@ -1,34 +0,0 @@ -# Kernel - -## Configs MUST be Built In - -#### file system - -- CONFIG_EXT4_FS - -#### virtio basic - -- CONFIG_VIRTIO_PCI -- CONFIG_VIRTIO_INPUT -- CONFIG_VIRTIO_MMIO -- CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES - -#### virtio block device - -- CONFIG_VIRTIO_BLK - -#### virtio network device - -- CONFIG_VSOCKETS -- CONFIG_VIRTIO_VSOCKETS -- CONFIG_VIRTIO_NET - -#### make script[s] exectuable - -- BINFMT_MISC - -## Configs MUST be disabled - -#### accept stripped modular[s] - -- CONFIG_MODULE_SIG diff --git a/documents/gitlab-runner.config.toml b/documents/gitlab-runner.config.toml deleted file mode 100644 index 235f482..0000000 --- a/documents/gitlab-runner.config.toml +++ /dev/null @@ -1,12 +0,0 @@ -concurrent = 1 -check_interval = 0 - -[session_server] - session_timeout = 1800 - -[[runners]] - name = "YourHostName" - url = "https://gitlab.com/" - token = "YourGitLabToken" - executor = "shell" - cache_dir = "/home/gitlab-runner/build-cache" diff --git a/documents/roadmap.md b/documents/roadmap.md deleted file mode 100644 index 96d7b46..0000000 --- a/documents/roadmap.md +++ /dev/null @@ -1,41 +0,0 @@ -# 开发路线 (RoadMap) - -## v0.1.x - -- [Y] 单点架构, 基本功能可用 - -## v0.2.x - -- [Y] 分布式架构, 核心功能可用 - -## v0.3.x - -- [Y] v0.3.1: 优化资源调度算法 -- [Y] v0.3.1: 支持服务重启后恢复已有的 ENV -- [-] 优化系统布署流程, 提供配置的自动化工具集 -- [-] 优化基础镜像制作流程, 提供配置的自动化工具集 -- [-] 提高核心模块的测试覆盖率 -- [-] 提供视频演示教程 - -## v0.4.x - -- [-] 优化命令行客户端的用户提示信息 - - 当前显示给用户的是开发端的信息 -- [-] 提供前端界面 - - 初步规划是基于 Yew/Seed 等 Rust 前端框架实现 -- [-] 完善英文文档 - -## v0.5.x - -- [-] 优化前端界面实现, 增强特性 - - 如: Web Terminal 等功能 -- [-] 提供一个实时体验的网址 - -## v0.6.x - -- [-] 支持将运行时镜像保存为基础镜像(模板镜像) -- [-] 支持对已创建的 ENV 打快照(多级快照如何高效管理?) - -## v0.7.x - -- [-] 待定... diff --git a/documents/system_admin.md b/documents/system_admin.md deleted file mode 100644 index 771dd44..0000000 --- a/documents/system_admin.md +++ /dev/null @@ -1,77 +0,0 @@ -# TT 系统管理员指南 - -Guide for system admin. - -## 环境准备 - -> If use zfs, should do this: `zfs create -V 1M zroot/tt/__sample__`. - -镜像相关: -- [Linux, MUST] `systemctl disable NetworkManager` -- [Linux, Optional] `systemctl disable firewalld` -- [Linux, Optional] `sed -i 's/SELINUX=.*/SELINUX=disabled/' /etc/selinux/config` -- 保证本项目定制的 "[rc.local](../tools/images/linux_vm/rc.local)" 文件开机启动 -- [ FireCracker ] 内核模块只能 `strip --strip-debug`, strip 过度会导致无法载入 -- [ FireCracker ] 关闭内核的模块签名校验功能, 因为签名信息存在于已被 strip 的 debug 信息中 -- [ FireCracker ] `firecracker` 二进制文件要使用 `musl-libc` 编译 - - 由于 `Rust` 动态链接 `glibc` , 故运行时存在更多的不确定性因素, 参见: [issue #2044](https://github.com/firecracker-microvm/firecracker/issues/2044) - -#### On Linux - -> 使用 Qemu\FireCracker 做为 VM 引擎, 使用 Nftables 做 NAT 端口转发. -> -> - `firecracker` 程序路径必须是 `/usr/sbin/firecracker` - -环境配置: - -- `modprobe tun vhost_net` - -组件安装 - -- `qemu` -- `nftables` -- `ZOL: zfs on linux` - -## ttserver 配置 - -```shell -USAGE: - ttserver [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - -V, --version Prints version information - -OPTIONS: - --cpu-total 可以使用的 CPU 核心总数. - --disk-total 可以使用的磁盘总量, 单位: MB. - --image-path 镜像存放路径. - --cfgdb-path ENV 配置信息存放路径. - --log-path 日志存储路径. - --mem-total 可以使用的内存总量, 单位: MB. - --serv-addr 服务监听地址. - --serv-port 服务监听端口. -``` - -## ttproxy 配置 - -```shell -USAGE: - ttproxy [OPTIONS] - -FLAGS: - -h, --help Prints help information - -V, --version Prints version information - -OPTIONS: - --proxy-addr ttproxy 地址, eg: 127.0.0.1:19527. - --server-set ... ttserver 地址, eg: 127.0.0.1:9527,10.10.10.101:9527. -``` - -## gitlab CI/CD - -shell 模式下, 需要将 `~gitlab-runner/.bash_logout` 删除: - -```shell -rm ~gitlab-runner/.bash_logout -``` diff --git a/documents/user_guide.md b/documents/user_guide.md deleted file mode 100644 index b184ca1..0000000 --- a/documents/user_guide.md +++ /dev/null @@ -1,482 +0,0 @@ -# tt client - -用户用来与 TT 服务端进行交互的工具. - -> **仅支持 Linux 与 MacOS** - -## 安装 - -```shell -sudo make install -chmod +x /usr/local/bin/tt -``` - -## 使用 - -```shell -USAGE: - tt [SUBCOMMAND] - -FLAGS: - -h, --help Prints help information - -V, --version Prints version information - -SUBCOMMANDS: - config - env - help Prints this message or the help of the given subcommand(s) - status -``` - -#### 配置 tt 服务端的地址 - -##### 命令参数 - -> ```shell -> tt-config -> -> USAGE: -> tt config [OPTIONS] -> -> FLAGS: -> -h, --help Prints help information -> -V, --version Prints version information -> -> OPTIONS: -> -n, --client-id 客户端别名. -> -a, --server-addr 服务端的监听地址. -> -p, --server-port 服务端的监听端口. -> ``` - -##### 示例 - -> ```shell -> tt config --server-addr=10.10.10.22 [--server-port=9527] -> ``` - -#### 创建环境 - -##### 命令参数 - -> ```shell -> tt-env-add -> -> USAGE: -> tt env add [FLAGS] [OPTIONS] -> tt env add [FLAGS] [OPTIONS] -- -> -> FLAGS: -> -n, --deny-outgoing 禁止虚拟机对外连网. -> -h, --help Prints help information -> --same-uuid 所有虚拟机都使用同一个 UUID. -> -V, --version Prints version information -> -> OPTIONS: -> -C, --cpu-num 虚拟机的 CPU 核心数量. -> -D, --disk-size 虚拟机的磁盘容量, 单位: MB. -> -d, --dup-each 每种虚拟机类型启动的实例数量. -> -l, --life-time