commit f5989a61b05f0c04956347ab633772883d84d2e5 Author: ge Date: Tue Jun 10 00:04:11 2025 +0300 init diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..01072ca --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.v] +indent_style = tab diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9a98968 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +* text=auto eol=lf +*.bat eol=crlf + +*.v linguist-language=V +*.vv linguist-language=V +*.vsh linguist-language=V +v.mod linguist-language=V +.vdocignore linguist-language=ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5db401b --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Binaries for programs and plugins +main +qga +*.exe +*.exe~ +*.so +*.dylib +*.dll + +# Ignore binary output folders +bin/ + +# Ignore common editor/system specific metadata +.DS_Store +.idea/ +.vscode/ +*.iml + +# ENV +.env + +# vweb and database +*.db +*.js diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + 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/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f037eb --- /dev/null +++ b/README.md @@ -0,0 +1,97 @@ +# QEMU Guest Agent Protocol client for V + +`qga` is full featured QGA client for interacting with guest operating systems +in QEMU-powered virtual machine from virtualisation host. + +See also: + +- Guest Agent in QEMU Wiki: https://wiki.qemu.org/Features/GuestAgent +- QEMU Guest Agent Protocol Reference: https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html + +## Usage + +Run the virtual machine. In this example `disk.qcow2` contains Debian 12 Bookworm +with `qemu-guest-agent` package installed. + +``` +/usr/bin/qemu-system-x86_64 \ + -name testvm \ + -accel kvm \ + -cpu host \ + -smp 1 \ + -m 1024M \ + -drive file=disk.qcow2,media=disk,if=virtio \ + -chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \ + -device virtio-serial \ + -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0 +``` + +Then connect to a guest agent server socket `/tmp/gqa.sock`: + +```v +import qga + +fn main() { + ga := qga.Client.new('/tmp/qga.sock')! + agent_version := ga.info()!.version + println('everything is fine! guest agent version is ${agent_version}') +} +``` + +## Error handling + +`GuestAgentError` contains extended error information. See the description of +the structure fields. + +The error can be returned either directly by the guest agent or when trying to +communicating it. `GuestAgentError` has an explicit flag to distinguish such +errors. If for some reason the guest agent could not be reached, `is_unreachable` +will be true. The error information will be in the underlying error stored in the +`err` field and in the error text itself. + +```v +module main + +import qga + +fn main() { + mut ga := qga.Client.new('/tmp/qga.sock')! + ga.get_devices() or { + if err is qga.GuestAgentError { + if err.is_unreachable { + println('agent is unreachable') + return + } else { + println('error info from guest agent: class=${err.class} desc=${err.desc}') + return + } + } + } +} +``` + +Prints this (so `guest-get-devices` is disabled on Debian): + +``` +error info from guest agent: class=CommandNotFound desc=Command guest-get-devices has been disabled +``` + +In addition, `qga` module provides a small set of specific error codes. +They can be checked in this way without `err` smartcasting: + +```v ignore +ga.ping() or { + match err.code() { + qga.err_no_connect { panic('socket connection error') } + qga.err_timed_out { panic('timeout reached') } + qga.err_from_agent { panic('error ocurred in guest agent') } + else { panic(err) } + } +} +``` + +## License + +`LGPL-3.0-or-later` + +See [COPYING](COPYING) and [COPYING.LESSER](COPYING.LESSER) for information. diff --git a/client.v b/client.v new file mode 100644 index 0000000..4e9a429 --- /dev/null +++ b/client.v @@ -0,0 +1,162 @@ +// This file is part of qga. +// +// qga is free software: you can redistribute it and/or modify it under +// the terms of the GNU Lesser General Public License as published by the +// Free Software Foundation, either version 3 of the License, or (at your +// option) any later version. +// +// qga 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 Lesser General Public +// License for more details. +// +// You should have received a copy of the GNU Lesser General Public License +// along with qga. If not, see . + +module qga + +import json +import net.unix +import time + +// Client holds a connection to the QEMU Guest Agent socket. +struct Client { +mut: + stream unix.StreamConn + read_buffer_size int +} + +// Client.new creates new Client instance connected to provided UNIX domain socket address. +// Example: +// ``` +// mut ga := qga.Client.new('/tmp/qga0.sock')! +// ga.ping()! +// ``` +pub fn Client.new(addr string, params ClientParams) !Client { + mut stream := unix.connect_stream(addr) or { + return GuestAgentError{ + msg: 'unable to connect to socket at ${addr}: ${err}' + code: err_no_connect + err: err + is_unreachable: true + } + } + stream.set_write_timeout(params.timeout) + stream.set_read_timeout(params.timeout) + return Client{stream, params.read_buffer_size} +} + +// Client.from_handle creates new Client instance connected to socket handle. +pub fn Client.from_handle(handle int, params ClientParams) !Client { + mut sock := unix.stream_socket_from_handle(handle) or { + return GuestAgentError{ + msg: 'unable to connect to socket at ${handle}: ${err}' + code: err_no_connect + err: err + is_unreachable: true + } + } + mut stream := unix.StreamConn{ + sock: sock + } + stream.set_write_timeout(params.timeout) + stream.set_read_timeout(params.timeout) + return Client{stream, params.read_buffer_size} +} + +@[params] +pub struct ClientParams { + timeout time.Duration = 5 * time.second // socket write and read timeout + read_buffer_size int = 4096 // read buffer size in bytes +} + +// Request represents a common QEMU Guest Agent Protocol request schema. +struct Request[T] { + execute string + arguments ?T +} + +// Response represents a common QEMU Guest Agent Protocol response schema. +struct Response[T] { + return T + error ?struct { + class string + desc string + } +} + +// execute is generic function to run arbitrary QGA commands. +fn (mut c Client) execute[T, R](name string, args ?T, params ExecuteParams) !Response[R] { + request := Request[T]{ + execute: name + arguments: args + } + encoded := json.encode(request) + c.stream.wait_for_write() or { + return GuestAgentError{ + msg: 'socket write timeout reached' + code: err_timed_out + err: err + is_unreachable: true + } + } + c.stream.write(encoded.bytes()) or { + return GuestAgentError{ + msg: 'cannot write data to socket at ${c.stream.sock.handle}: ${err}' + code: err_cannot_write + err: err + is_unreachable: true + } + } + $if trace_guest_agent ? { + eprintln('>>> ${@MOD}.${@METHOD} Sent: ${encoded}') + } + if params.no_return { + $if trace_guest_agent ? { + eprintln('<<< ${@MOD}.${@METHOD} command ${name} is no return, skip reading response') + } + return Response[R]{} + } + mut buf := []u8{len: c.read_buffer_size} + c.stream.wait_for_read() or { + return GuestAgentError{ + msg: 'socket read timeout reached' + code: err_timed_out + err: err + is_unreachable: true + } + } + c.stream.read(mut buf) or { + return GuestAgentError{ + msg: 'cannot read from socket at ${c.stream.sock.handle}: ${err}' + code: err_cannot_read + err: err + is_unreachable: true + } + } + // trim trailing null bytes + mut idx := buf.len - 1 + for idx >= 0 && buf[idx] == 0 { + idx-- + } + str := buf[..idx + 1].bytestr().trim_space() + $if trace_guest_agent ? { + eprintln('<<< ${@MOD}.${@METHOD} Recv: ${str}') + } + decoded := json.decode(Response[R], str)! + if decoded.error != none { + return GuestAgentError{ + msg: 'guest agent command failed' + code: err_from_agent + class: decoded.error.class + desc: decoded.error.desc + } + } + return decoded +} + +@[params] +struct ExecuteParams { +pub: + no_return bool +} diff --git a/commands.v b/commands.v new file mode 100644 index 0000000..2b2c6b5 --- /dev/null +++ b/commands.v @@ -0,0 +1,771 @@ +// This file is part of qga. +// +// qga is free software: you can redistribute it and/or modify it under +// the terms of the GNU Lesser General Public License as published by the +// Free Software Foundation, either version 3 of the License, or (at your +// option) any later version. +// +// qga 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 Lesser General Public +// License for more details. +// +// You should have received a copy of the GNU Lesser General Public License +// along with qga. If not, see . + +module qga + +import encoding.base64 + +// Empty is used for guest-ping and other commands with no arguments or no return. +struct Empty {} + +struct GuestExec { + pid int +} + +struct GuestExecRequest { +mut: + path string + arg ?[]string + env ?[]string + input_data ?string @[json: 'input-data'] + capture_output ?bool @[json: 'capture-output'] +} + +@[params] +pub struct GuestExecParams { +pub: + args ?[]string + env ?[]string + input_data ?string + capture_output ?bool +} + +// exec executes [guest-exec](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-exec) command. +pub fn (mut c Client) exec(path string, params GuestExecParams) !int { + req := GuestExecRequest{ + path: path + arg: params.args + env: params.env + input_data: params.input_data + capture_output: params.capture_output + } + res := c.execute[GuestExecRequest, GuestExec]('guest-exec', req)! + return res.return.pid +} + +pub struct GuestExecStatus { +pub: + exited bool + exitcode ?int + signal ?int + out_data ?string @[json: 'out-data'] + err_data ?string @[json: 'err-data'] + out_truncated ?bool @[json: 'out-truncated'] + err_truncated ?bool @[json: 'err-truncated'] +} + +struct GuestExecStatusRequest { + pid int +} + +// exec_status executes [guest-exec-status](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-exec-status) command. +pub fn (mut c Client) exec_status(pid int) !GuestExecStatus { + req := GuestExecStatusRequest{pid} + return c.execute[GuestExecStatusRequest, GuestExecStatus]('guest-exec-status', req)!.return +} + +struct GuestFileCloseRequest { + handle int +} + +// file_close executes [guest-file-close](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-file-close) command. +pub fn (mut c Client) file_close(handle int) ! { + req := GuestFileCloseRequest{handle} + c.execute[GuestFileCloseRequest, Empty]('guest-file-close', req)! +} + +struct GuestFileFlushRequest { + handle int +} + +// file_flush executes [guest-file-flush](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-file-flush) command. +pub fn (mut c Client) file_flush(handle int) ! { + req := GuestFileFlushRequest{handle} + c.execute[GuestFileFlushRequest, Empty]('guest-file-flush', req)! +} + +struct GuestFileOpenRequest { + path string + mode string +} + +// file_open executes [guest-file-open](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-file-open) command. +pub fn (mut c Client) file_open(path string, mode string) !int { + req := GuestFileOpenRequest{path, mode} + return c.execute[GuestFileOpenRequest, int]('guest-file-open', req)!.return +} + +struct GuestFileReadRequest { + handle int + count int +} + +pub struct GuestFileRead { +pub: + count int + buf_b64 string @[json: 'buf-b64'] + eof bool +} + +// file_read executes [guest-file-read](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-file-read) command. +pub fn (mut c Client) file_read(handle int, count int) !GuestFileRead { + req := GuestFileReadRequest{handle, count} + return c.execute[GuestFileReadRequest, GuestFileRead]('guest-file-read', req)!.return +} + +struct GuestFileSeekRequest { + handle int + offset int + whence GuestAgentWhence +} + +pub struct GuestFileSeek { +pub: + position int + eof bool +} + +pub struct GuestAgentWhence { +pub: + value int + name QGASeek +} + +pub enum QGASeek { + set + cur + end +} + +// file_seek executes [guest-file-seek](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-file-seek) command. +pub fn (mut c Client) file_seek(handle int, offset int, whence GuestAgentWhence) !GuestFileSeek { + req := GuestFileSeekRequest{handle, offset, whence} + return c.execute[GuestFileSeekRequest, GuestFileSeek]('guest-file-seek', req)!.return +} + +struct GuestFileWriteRequest { +mut: + handle int + buf_b64 string + count int +} + +pub struct GuestFileWrite { +pub: + count int + eof bool +} + +pub struct GuestFileWriteParams { +pub: + is_encoded bool + count ?int +} + +// file_write executes [guest-file-write](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-file-write) command. +pub fn (mut c Client) file_write(handle int, buf string, params GuestFileWriteParams) !GuestFileWrite { + mut req := GuestFileWriteRequest{ + handle: handle + } + if params.is_encoded { + req.buf_b64 = buf + } else { + req.buf_b64 = base64.encode_str(buf) + } + if params.count == none { + req.count = req.buf_b64.len + } else { + req.count = params.count + } + return c.execute[GuestFileWriteRequest, GuestFileWrite]('guest-file-write', req)!.return +} + +// fsfreeze_freeze executes [guest-fsfreeze-freeze](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-fsfreeze-freeze) command. +pub fn (mut c Client) fsfreeze_freeze() !int { + return c.execute[Empty, int]('guest-fsfreeze-freeze', none)!.return +} + +struct GuestFsfreezeFsfreezeList { +mut: + mountpoints ?[]string +} + +// fsfreeze_freeze_list executes [guest-fsfreeze-freeze-list](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-fsfreeze-freeze-list) command. +// An empty `mountpoints` array will freeze all filesystems. +pub fn (mut c Client) fsfreeze_freeze_list(mountpoints []string) !int { + mut req := GuestFsfreezeFsfreezeList{} + if mountpoints.len > 0 { + req.mountpoints = mountpoints + } + return c.execute[GuestFsfreezeFsfreezeList, int]('guest-fsfreeze-freeze-list', req)!.return +} + +pub enum GuestFsfreezeStatus { + thawed + frozen +} + +// fsfreeze_status executes [guest-fsfreeze-status](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-fsfreeze-status) command. +pub fn (mut c Client) fsfreeze_status() !GuestFsfreezeStatus { + return c.execute[Empty, GuestFsfreezeStatus]('guest-fsfreeze-status', none)!.return +} + +// fsfreeze_thaw executes [guest-fsfreeze-thaw](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-fsfreeze-thaw) command. +pub fn (mut c Client) fsfreeze_thaw() !int { + return c.execute[Empty, int]('guest-fsfreeze-thaw', none)!.return +} + +struct GuestFilesystemTrimRequest { + minimun u64 +} + +pub struct GuestFilesystemTrimResponse { +pub: + paths []GuestFilesystemTrimResult +} + +pub struct GuestFilesystemTrimResult { + path string + error ?string + trimmed ?u64 + minimum ?u64 +} + +// fstrim executes [guest-fstrim](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-fstrim) command. +// Set `minimum` to zero to discard every free block. +pub fn (mut c Client) fstrim(minimum u64) !GuestFilesystemTrimResponse { + req := GuestFilesystemTrimRequest{minimum} + return c.execute[GuestFilesystemTrimRequest, GuestFilesystemTrimResponse]('guest-fstrim', + req)!.return +} + +pub struct GuestCpuStats { + GuestLinuxCpuStats +pub: + type GuestCpuStatsType +} + +pub enum GuestCpuStatsType { + linux +} + +pub struct GuestLinuxCpuStats { +pub: + cpu int + user int + nice int + system int + idle int + iowait ?int + irq ?int + sofirq ?int + steal ?int + guest ?int + guestnice ?int +} + +// get_cpustats executes [guest-get-cpustats](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-cpustats) command. +pub fn (mut c Client) get_cpustats() ![]GuestCpuStats { + return c.execute[Empty, []GuestCpuStats]('guest-get-cpustats', none)!.return +} + +pub struct GuestDeviceInfo { + driver_name string + driver_data ?string + driver_version ?string + id ?GuestDeviceId +} + +pub struct GuestDeviceId { +pub: + type GuestDeviceType + vendor_id int @[json: 'vendor-id'] + device_id int @[json: 'device-id'] +} + +pub enum GuestDeviceType { + pci +} + +// get_devices executes [guest-get-devices](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-devices) command. +pub fn (mut c Client) get_devices() ![]GuestDeviceInfo { + return c.execute[Empty, []GuestDeviceInfo]('guest-get-devices', none)!.return +} + +pub struct GuestDiskInfo { +pub: + name string + partition bool + dependencies ?[]string + address ?GuestDiskAddress + alias ?string + smart ?GuestDiskSmart +} + +pub struct GuestDiskAddress { +pub: + pci_controller GuestPCIAddress @[json: 'pci-controller'] + bus_type GuestDiskBusType @[json: 'bus-type'] + bus int + target int + unit int + serial ?string + dev ?string + ccw_address ?GuestCCWAddress +} + +pub struct GuestPCIAddress { +pub: + domain int + bus int + slot int + function int +} + +pub enum GuestDiskBusType { + ide + fdc + scsi + virtio + xen + usb + uml + sata + sd + unknown + ieee1394 + ssa + fibre + raid + iscsi + sas + mmc + virtual + file_backed_virtual @[json: 'file-backed-virtual'] + nvme +} + +pub struct GuestCCWAddress { +pub: + cssid int + ssid int + subchno int + devno int +} + +pub struct GuestDiskSmart { +pub: + critical_warning int @[json: 'critical-warning'] + temperature int @[json: 'temperature'] + available_spare int @[json: 'available-spare'] + available_spare_threshold int @[json: 'available-spare-threshold'] + percentage_used int @[json: 'percentage-used'] + data_units_read_lo int @[json: 'data-units-read-lo'] + data_units_read_hi int @[json: 'data-units-read-hi'] + data_units_written_lo int @[json: 'data-units-written-lo'] + data_units_written_hi int @[json: 'data-units-written-hi'] + host_read_commands_lo int @[json: 'host-read-commands-lo'] + host_read_commands_hi int @[json: 'host-read-commands-hi'] + host_write_commands_lo int @[json: 'host-write-commands-lo'] + host_write_commands_hi int @[json: 'host-write-commands-hi'] + controller_busy_time_lo int @[json: 'controller-busy-time-lo'] + controller_busy_time_hi int @[json: 'controller-busy-time-hi'] + power_cycles_lo int @[json: 'power-cycles-lo'] + power_cycles_hi int @[json: 'power-cycles-hi'] + power_on_hours_lo int @[json: 'power-on-hours-lo'] + power_on_hours_hi int @[json: 'power-on-hours-hi'] + unsafe_shutdowns_lo int @[json: 'unsafe-shutdowns-lo'] + unsafe_shutdowns_hi int @[json: 'unsafe-shutdowns-hi'] + media_errors_lo int @[json: 'media-errors-lo'] + media_errors_hi int @[json: 'media-errors-hi'] + number_of_error_log_entries_lo int @[json: 'number-of-error-log-entries-lo'] + number_of_error_log_entries_hi int @[json: 'number-of-error-log-entries-hi'] +} + +// get_disks executes [guest-get-disks](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-disks) command. +pub fn (mut c Client) get_disks() ![]GuestDiskInfo { + return c.execute[Empty, []GuestDiskInfo]('guest-get-disks', none)!.return +} + +pub struct GuestDiskStatsInfo { +pub: + name string + major int + minor int + stats GuestDiskStats +} + +pub struct GuestDiskStats { + read_sectors ?int @[json: 'read-sectors'] + read_ios ?int @[json: 'read-ios'] + read_merges ?int @[json: 'read-merges'] + write_sectors ?int @[json: 'write-sectors'] + write_ios ?int @[json: 'write-ios'] + write_merges ?int @[json: 'write-merges'] + discard_sectors ?int @[json: 'discard-sectors'] + discard_ios ?int @[json: 'discard-ios'] + discard_merges ?int @[json: 'discard-merges'] + flush_ios ?int @[json: 'flush-ios'] + read_ticks ?int @[json: 'read-ticks'] + write_ticks ?int @[json: 'write-ticks'] + discard_ticks ?int @[json: 'discard-ticks'] + flush_ticks ?int @[json: 'flush-ticks'] + ios_pgr ?int @[json: 'ios-pgr'] + total_ticks ?int @[json: 'total-ticks'] + weight_ticks ?int @[json: 'weight-ticks'] +} + +// get_diskstats executes [guest-get-diskstats](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-diskstats) command. +pub fn (mut c Client) get_diskstats() ![]GuestDiskStatsInfo { + return c.execute[Empty, []GuestDiskStatsInfo]('guest-get-diskstats', none)!.return +} + +pub struct GuestFilesystemInfo { +pub: + name string + mountpoint string + type string + used_bytes ?u64 @[json: 'used-bytes'] + total_bytes ?u64 @[json: 'total-bytes'] + total_bytes_privileged ?u64 @[json: 'total-bytes-privileged'] + disk []GuestDiskAddress +} + +// get_fsinfo executes [guest-get-fsinfo](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-fsinfo) command. +pub fn (mut c Client) get_fsinfo() ![]GuestFilesystemInfo { + return c.execute[Empty, []GuestFilesystemInfo]('guest-get-fsinfo', none)!.return +} + +struct GuestHostName { + host_name string @[json: 'host-name'] +} + +// get_host_name executes [guest-get-host-name](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-host-name) command. +pub fn (mut c Client) get_host_name() !string { + return c.execute[Empty, GuestHostName]('guest-get-host-name', none)!.return.host_name +} + +pub struct GuestLoadAverage { + load1m f64 + load5m f64 + load15m f64 +} + +// get_load executes [guest-get-load](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-load) command. +pub fn (mut c Client) get_load() !GuestLoadAverage { + return c.execute[Empty, GuestLoadAverage]('guest-get-load', none)!.return +} + +pub struct GuestMemoryBlockInfo { + size int +} + +// get_memory_block_info executes [guest-get-memory-block-info](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-memory-block-info) command. +pub fn (mut c Client) get_memory_block_info() !GuestMemoryBlockInfo { + return c.execute[Empty, GuestMemoryBlockInfo]('guest-get-memory-block-info', none)!.return +} + +pub struct GuestMemoryBlock { +pub: + phys_index int @[json: 'phys-index'] + online bool + can_offline ?bool @[json: 'can-offline'] +} + +// get_memory_blocks executes [guest-get-memory-blocks](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-memory-blocks) command. +pub fn (mut c Client) get_memory_blocks() ![]GuestMemoryBlock { + return c.execute[Empty, []GuestMemoryBlock]('guest-get-memory-blocks', none)!.return +} + +pub struct GuestOSInfo { +pub: + kernel_release ?string @[json: 'kernel-release'] + kernel_version ?string @[json: 'kernel-version'] + machine ?string + id ?string + name ?string + pretty_name ?string @[json: 'pretty-name'] + version ?string + version_id ?string @[json: 'version-id'] + variant ?string + variant_id ?string @[json: 'variant-id'] +} + +// get_osinfo executes [guest-get-osinfo](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-osinfo) command. +pub fn (mut c Client) get_osinfo() !GuestOSInfo { + return c.execute[Empty, GuestOSInfo]('guest-get-osinfo', none)!.return +} + +// get_time executes [guest-get-time](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-time) command. +pub fn (mut c Client) get_time() !i64 { + return c.execute[Empty, i64]('guest-get-time', none)!.return +} + +pub struct GuestTimezone { + zone ?string + offset int +} + +// get_timezone executes [guest-get-timezone](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-timezone) command. +pub fn (mut c Client) get_timezone() !GuestTimezone { + return c.execute[Empty, GuestTimezone]('guest-get-timezone', none)!.return +} + +pub struct GuestUser { +pub: + user string + domain string + login_time f64 @[json: 'login-time'] +} + +// get_users executes [guest-get-users](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-users) command. +pub fn (mut c Client) get_users() ![]GuestUser { + return c.execute[Empty, []GuestUser]('guest-get-users', none)!.return +} + +pub struct GuestLogicalProcessor { +pub: + logical_id int @[json: 'logical-id'] + online bool + can_offline ?bool @[json: 'can-offline'] +} + +// get_vcpus executes [guest-get-vcpus](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-get-vcpus) command. +pub fn (mut c Client) get_vcpus() ![]GuestLogicalProcessor { + return c.execute[Empty, []GuestLogicalProcessor]('guest-get-vcpus', none)!.return +} + +pub struct GuestAgentInfo { +pub: + version string + supported_commands []GuestAgentCommandInfo +} + +pub struct GuestAgentCommandInfo { +pub: + name string + enbled bool + success_response bool @[json: 'success-response'] +} + +// info executes [guest-info](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-info) command. +pub fn (mut c Client) info() !GuestAgentInfo { + return c.execute[Empty, GuestAgentInfo]('guest-info', none)!.return +} + +pub struct GuestNetworkInterface { +pub: + name string + hardware_address ?string @[json: 'hardware-address'] + ip_addresses ?[]GuestIpAddress @[json: 'ip-addresses'] + statistics ?GuestNetworkInterfaceStat +} + +pub struct GuestIpAddress { +pub: + ip_address string @[json: 'ip-address'] + ip_address_type GuestIpAddressType @[json: 'ip-address-type'] + prefix int +} + +pub enum GuestIpAddressType { + ipv4 + ipv6 +} + +pub struct GuestNetworkInterfaceStat { +pub: + rx_bytes int @[json: 'rx-bytes'] + rx_packets int @[json: 'rx-packets'] + rx_errs int @[json: 'rx-errs'] + rx_dropped int @[json: 'rx-dropped'] + tx_bytes int @[json: 'tx-bytes'] + tx_packets int @[json: 'tx-packets'] + tx_errs int @[json: 'tx-errs'] + tx_dropped int @[json: 'tx-dropped'] +} + +// network_get_interfaces executes [guest-network-get-interfaces](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-network-get-interfaces) command. +pub fn (mut c Client) network_get_interfaces() ![]GuestNetworkInterface { + return c.execute[Empty, []GuestNetworkInterface]('guest-network-get-interfaces', none)!.return +} + +pub struct GuestNetworkRoute { +pub: + iface string + destination string + metric int + gateway ?string + mask ?string + irtt ?int + flags ?int + refcnt ?int + use ?int + window ?int + mtu ?int + desprefixlen ?string + source ?string + srcprefixlen ?string + nexthop ?string + version int +} + +// network_get_route executes [guest-network-get-route](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-network-get-route) command. +pub fn (mut c Client) network_get_route() ![]GuestNetworkRoute { + return c.execute[Empty, []GuestNetworkRoute]('guest-network-get-route', none)!.return +} + +// ping executes [guest-ping](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-ping) command, a non-error return implies success. +pub fn (mut c Client) ping() ! { + c.execute[Empty, Empty]('guest-ping', none)! +} + +struct GuestSetMemoryBlocksRequest { + mem_blks []GuestMemoryBlock @[json: 'mem-blks'] +} + +pub struct GuestMemoryBlockResponse { +pub: + phys_index int @[json: 'phys-index'] + response GuestMemoryBlockResponseType + error_code ?int @[json: 'error-code'] +} + +pub enum GuestMemoryBlockResponseType { + success + not_found @[json: 'not-found'] + operation_not_supported @[json: 'operation-not-supported'] + operation_failed @[json: 'operation-failed'] +} + +// set_memory_blocks executes [guest-set-memory-blocks](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-set-memory-blocks) command. +pub fn (mut c Client) set_memory_blocks(blocks []GuestMemoryBlock) ![]GuestMemoryBlockResponse { + req := GuestSetMemoryBlocksRequest{blocks} + return c.execute[GuestSetMemoryBlocksRequest, []GuestMemoryBlockResponse]('guest-set-memory-blocks', + req)!.return +} + +struct GuestSetTimeRequest { + time i64 +} + +// set_time executes [guest-set-time](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-set-time) command. +pub fn (mut c Client) set_time(epoch i64) ! { + req := GuestSetTimeRequest{epoch} + c.execute[GuestSetTimeRequest, Empty]('guest-set-time', req)! +} + +struct GuestSetUserPasswordRequest { + username string + password string + crypted bool +} + +// set_user_password executes [guest-set-user-password](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-set-user-password) command. +pub fn (mut c Client) set_user_password(username string, password string, crypted bool) ! { + req := GuestSetUserPasswordRequest{username, password, crypted} + c.execute[GuestSetUserPasswordRequest, Empty]('guest-set-user-password', req)! +} + +struct GuestSetVcpusRequest { + vcpus []GuestLogicalProcessor +} + +// set_vcpus executes [guest-set-vcpus](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-set-vcpus) command. +pub fn (mut c Client) set_vcpus(vcpus []GuestLogicalProcessor) !int { + req := GuestSetVcpusRequest{vcpus} + return c.execute[GuestSetVcpusRequest, int]('guest-set-vcpus', req)!.return +} + +pub enum GuestShutdownMode { + halt + powerdown + reboot +} + +struct GuestShutdownRequest { + mode GuestShutdownMode +} + +// shutdown executes [guest-shutdown](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-shutdown) command. +pub fn (mut c Client) shutdown(mode GuestShutdownMode) ! { + req := GuestShutdownRequest{mode} + c.execute[GuestShutdownRequest, Empty]('guest-shutdown', req, no_return: true)! +} + +struct GuestSSHAddAuthorizedKeysRequest { + username string + keys []string + reset ?bool +} + +// ssh_add_authorized_keys executes [guest-ssh-add-authorized-keys](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-ssh-add-authorized-keys) command. +pub fn (mut c Client) ssh_add_authorized_keys(username string, keys []string, reset bool) ! { + req := GuestSSHAddAuthorizedKeysRequest{username, keys, reset} + c.execute[GuestSSHAddAuthorizedKeysRequest, Empty]('guest-ssh-add-authorized-keys', + req)! +} + +struct GuestAuthorizedKeys { + keys []string +} + +// ssh_get_authorized_keys executes [guest-ssh-get-authorized-keys](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-ssh-get-authorized-keys) command. +pub fn (mut c Client) ssh_get_authorized_keys() ![]string { + return c.execute[Empty, GuestAuthorizedKeys]('guest-ssh-get-authorized-keys', none)!.return.keys +} + +// ssh_remove_authorized_keys executes [guest-ssh-remove-authorized-keys](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-ssh-remove-authorized-keys) command. +pub fn (mut c Client) ssh_remove_authorized_keys(username string, keys []string) ! { + req := GuestSSHAddAuthorizedKeysRequest{ + username: username + keys: keys + } + c.execute[GuestSSHAddAuthorizedKeysRequest, Empty]('guest-ssh-remove-authorized-keys', + req)! +} + +// suspend_disk executes [guest-suspend-disk](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-suspend-disk) command. +pub fn (mut c Client) suspend_disk() ! { + c.execute[Empty, Empty]('guest-suspend-disk', none, no_return: true)! +} + +// suspend_hybrid executes [guest-suspend-hybrid](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-suspend-hybrid) command. +pub fn (mut c Client) suspend_hybrid() ! { + c.execute[Empty, Empty]('guest-suspend-hybrid', none, no_return: true)! +} + +// suspend_ram executes [guest-suspend-ram](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-suspend-ram) command. +pub fn (mut c Client) suspend_ram() ! { + c.execute[Empty, Empty]('guest-suspend-ram', none, no_return: true)! +} + +struct GuestSyncRequest { + id u64 +} + +// sync executes the [guest-sync](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-sync) command. +pub fn (mut c Client) sync(id u64) !u64 { + req := GuestSyncRequest{id} + res := c.execute[GuestSyncRequest, u64]('guest-sync', req)! + return res.return +} + +// sync_delimited executes [guest-sync-delimited](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html#command-QGA-qapi-schema.guest-sync-delimited) command. +pub fn (mut c Client) sync_delimited(id u64) !u64 { + req := GuestSyncRequest{id} + res := c.execute[GuestSyncRequest, u64]('guest-sync-delimited', req)! + return res.return +} diff --git a/error.v b/error.v new file mode 100644 index 0000000..d0befb0 --- /dev/null +++ b/error.v @@ -0,0 +1,49 @@ +// This file is part of qga. +// +// qga is free software: you can redistribute it and/or modify it under +// the terms of the GNU Lesser General Public License as published by the +// Free Software Foundation, either version 3 of the License, or (at your +// option) any later version. +// +// qga 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 Lesser General Public +// License for more details. +// +// You should have received a copy of the GNU Lesser General Public License +// along with qga. If not, see . + +module qga + +// Connection to socket failed. +pub const err_no_connect = 1000 + +// Cannot read data from socket. +pub const err_cannot_read = 1001 + +// Cannot write to socket. +pub const err_cannot_write = 1002 + +// Read or write timeout reached. This may cause if guest agent daemon is shut off in guest. +pub const err_timed_out = 1003 + +// Guest agent returned an error. See details in `class` and `desc` fields of `GuestAgentError`. +pub const err_from_agent = 1004 + +pub struct GuestAgentError { +pub: + msg string // human-readable error message + code int // error code (see err_* constants in this module) + class string // error class provided by QEMU Guest Agent Protocol + desc string // error desc provided by QEMU Guest Agent Protocol + is_unreachable bool // true if the error means the guest agent could not be reached + err ?IError // the underlying error if available +} + +pub fn (e GuestAgentError) msg() string { + return if e.is_unreachable { e.msg } else { '${e.msg}: class=${e.class} desc=${e.desc}' } +} + +pub fn (e GuestAgentError) code() int { + return e.code +} diff --git a/v.mod b/v.mod new file mode 100644 index 0000000..6c092aa --- /dev/null +++ b/v.mod @@ -0,0 +1,7 @@ +Module { + name: 'qga' + description: 'QEMU Guest Agent Protocol client' + version: '0.1.0' + license: 'LGPL-3.0-or-later' + dependencies: [] +}