From: John Wolfe Date: Tue, 27 Oct 2020 00:29:53 +0000 (-0700) Subject: Check in tools gdp plugin OVT installer code. X-Git-Tag: stable-11.3.0~288 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=00531302d7e56bddaa037e5e4ae006135a34cca8;p=thirdparty%2Fopen-vm-tools.git Check in tools gdp plugin OVT installer code. --- diff --git a/open-vm-tools/configure.ac b/open-vm-tools/configure.ac index 192dc3676..4f2e7bcf9 100644 --- a/open-vm-tools/configure.ac +++ b/open-vm-tools/configure.ac @@ -1,5 +1,5 @@ ################################################################################ -### Copyright (C) 2007-2020 VMware, Inc. All rights reserved. +### Copyright (c) 2007-2020 VMware, Inc. All rights reserved. ### ### Configure script for building the VMware OSS Tools. ### @@ -1626,6 +1626,7 @@ AC_CONFIG_FILES([ \ services/Makefile \ services/vmtoolsd/Makefile \ services/plugins/Makefile \ + services/plugins/gdp/Makefile \ services/plugins/appInfo/Makefile \ services/plugins/serviceDiscovery/Makefile \ services/plugins/desktopEvents/Makefile \ diff --git a/open-vm-tools/lib/include/vmware/tools/gdp.h b/open-vm-tools/lib/include/vmware/tools/gdp.h new file mode 100644 index 000000000..6f3996ed3 --- /dev/null +++ b/open-vm-tools/lib/include/vmware/tools/gdp.h @@ -0,0 +1,159 @@ +/********************************************************* + * Copyright (C) 2020 VMware, Inc. All rights reserved. + * + * This program 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 version 2.1 and no 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 Lesser GNU General Public + * License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + *********************************************************/ + +#ifndef _VMWARE_TOOLS_GDP_H_ +#define _VMWARE_TOOLS_GDP_H_ + +/** + * @file gdp.h + * + * Public interface of the "gdp" plugin service. + */ + +#include +#include "vmware/tools/plugin.h" + +/* + * Size in bytes: + * 17 * 4096 - Maximum VMCI datagram size + * 24 - VMCI datagram header size + */ +#define GDP_MAX_USER_DATA_LEN (17 * 4096 - 24) +#define GDP_SEND_RECV_BUF_LEN (17 * 4096) + +/* + * Property name of the gdp plugin service in the tools + * applicatin context service object. + */ +#define TOOLS_PLUGIN_SVC_PROP_GDP "tps_prop_gdp" + +/* + * GdpError definitions. + */ +#define GDP_ERR_LIST \ + GDP_ERR_ITEM(GDP_ERROR_SUCCESS = 0, \ + "No error") \ + GDP_ERR_ITEM(GDP_ERROR_INTERNAL, \ + "Internal system error") \ + GDP_ERR_ITEM(GDP_ERROR_STOP, \ + "Stopped for vmtoolsd shutdown") \ + GDP_ERR_ITEM(GDP_ERROR_UNREACH, \ + "Host daemon unreachable") \ + GDP_ERR_ITEM(GDP_ERROR_TIMEOUT, \ + "Operation timed out") \ + GDP_ERR_ITEM(GDP_ERROR_SEND_SIZE, \ + "Message to host too large") \ + GDP_ERR_ITEM(GDP_ERROR_RECV_SIZE, \ + "Receive buffer too small") + +/* + * GdpError codes. + */ +#define GDP_ERR_ITEM(a, b) a, +typedef enum GdpError { + GDP_ERR_LIST + GDP_ERR_MAX +} GdpError; +#undef GDP_ERR_ITEM + +/** + * @brief Type of the public interface of the gdp plugin service. + * + * This struct is published in the tools application context service object's + * TOOLS_PLUGIN_SVC_PROP_GDP property. + */ +typedef struct ToolsPluginSvcGdp { + GdpError (*publish)(const char *msg, + int msgLen, + char *reply, + int *replyLen); + GdpError (*stop)(void); +} ToolsPluginSvcGdp; + + +/* + ****************************************************************************** + * ToolsPluginSvcGdp_Publish -- */ /** + * + * @brief Publishes guest data to host side gdp daemon. + * + * This function is thread-safe and blocking, it should be called by vmtoolsd + * pool threads started by ToolsCorePool_StartThread. Do not call the function + * in ToolsOnLoad nor in/after TOOLS_CORE_SIG_SHUTDOWN handler. + * + * @param[in] ctx The app context + * @param[in] msg Buffer containing guest data to publish + * @param[in] msgLen Guest data length + * @param[out,optional] reply Buffer to receive reply from gdp daemon + * @param[in,out,optional] replyLen NULL when param reply is NULL, otherwise: + * reply buffer length on input, + * reply length on output + * + * @return GDP_ERROR_SUCCESS on success. + * @return Other GdpError codes otherwise. + * + ****************************************************************************** + */ + +static inline GdpError +ToolsPluginSvcGdp_Publish(ToolsAppCtx *ctx, // IN + const char *msg, // IN + int msgLen, // IN + char *reply, // OUT, OPTIONAL + int *replyLen) // IN/OUT, OPTIONAL +{ + ToolsPluginSvcGdp *svcGdp = NULL; + g_object_get(ctx->serviceObj, TOOLS_PLUGIN_SVC_PROP_GDP, &svcGdp, NULL); + if (svcGdp != NULL && svcGdp->publish != NULL) { + return svcGdp->publish(msg, msgLen, reply, replyLen); + } + return GDP_ERROR_INTERNAL; +} + + +/* + ****************************************************************************** + * ToolsPluginSvcGdp_Stop -- */ /** + * + * @brief Stops guest data publishing. + * + * This function notifies the pool thread in publish call to stop and return + * immediately. It is intended to be called by the interrupt callback passed + * to ToolsCorePool_StartThread. At vmtoolsd shutdown time, main thread will + * call ToolsCorePool_Shutdown which invokes the interrupt callback. + * + * @param[in] ctx The app context + * + * @return GDP_ERROR_SUCCESS on success. + * @return GDP_ERROR_INTERNAL otherwise. + * + ****************************************************************************** + */ + +static inline GdpError +ToolsPluginSvcGdp_Stop(ToolsAppCtx *ctx) // IN +{ + ToolsPluginSvcGdp *svcGdp = NULL; + g_object_get(ctx->serviceObj, TOOLS_PLUGIN_SVC_PROP_GDP, &svcGdp, NULL); + if (svcGdp != NULL && svcGdp->stop != NULL) { + return svcGdp->stop(); + } + return GDP_ERROR_INTERNAL; +} + +#endif /* _VMWARE_TOOLS_GDP_H_ */ diff --git a/open-vm-tools/services/plugins/Makefile.am b/open-vm-tools/services/plugins/Makefile.am index 48cecc99e..08b7c81b4 100644 --- a/open-vm-tools/services/plugins/Makefile.am +++ b/open-vm-tools/services/plugins/Makefile.am @@ -1,5 +1,5 @@ ################################################################################ -### Copyright (C) 2009-2019 VMware, Inc. All rights reserved. +### Copyright (c) 2009-2020 VMware, Inc. All rights reserved. ### ### This program is free software; you can redistribute it and/or modify ### it under the terms of version 2 of the GNU General Public License as @@ -17,6 +17,7 @@ SUBDIRS = if LINUX + SUBDIRS += gdp SUBDIRS += appInfo endif if ENABLE_SDMP diff --git a/open-vm-tools/services/plugins/gdp/COPYING b/open-vm-tools/services/plugins/gdp/COPYING new file mode 100644 index 000000000..09f465ab7 --- /dev/null +++ b/open-vm-tools/services/plugins/gdp/COPYING @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. 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 not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the 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 +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library 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 2.1 of the License, or (at your option) any later version. + + This library 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 this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/open-vm-tools/services/plugins/gdp/Makefile.am b/open-vm-tools/services/plugins/gdp/Makefile.am new file mode 100644 index 000000000..fcf5431f6 --- /dev/null +++ b/open-vm-tools/services/plugins/gdp/Makefile.am @@ -0,0 +1,34 @@ +################################################################################ +### Copyright (c) 2020 VMware, Inc. All rights reserved. +### +### This program is free software; you can redistribute it and/or modify +### it under the terms of version 2 of the GNU General Public License as +### published by the Free Software Foundation. +### +### 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, write to the Free Software +### Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +################################################################################ + +SUBDIRS = + +plugindir = @VMSVC_PLUGIN_INSTALLDIR@ +plugin_LTLIBRARIES = libgdp.la + +libgdp_la_CPPFLAGS = +libgdp_la_CPPFLAGS += @PLUGIN_CPPFLAGS@ + +libgdp_la_LDFLAGS = +libgdp_la_LDFLAGS += @PLUGIN_LDFLAGS@ + +libgdp_la_LIBADD = +libgdp_la_LIBADD += @VMTOOLS_LIBS@ +libgdp_la_LIBADD += @GOBJECT_LIBS@ + +libgdp_la_SOURCES = +libgdp_la_SOURCES += gdpPlugin.c diff --git a/open-vm-tools/services/plugins/gdp/gdpPlugin.c b/open-vm-tools/services/plugins/gdp/gdpPlugin.c new file mode 100644 index 000000000..71095ef8f --- /dev/null +++ b/open-vm-tools/services/plugins/gdp/gdpPlugin.c @@ -0,0 +1,1063 @@ +/********************************************************* + * Copyright (C) 2020 VMware, Inc. All rights reserved. + * + * This program 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 version 2.1 and no 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 Lesser GNU General Public + * License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + *********************************************************/ + +/* + * gdpPlugin.c -- + * + * Publishes guest data to host side gdp daemon. + */ + +#include +#include +#include + +#if defined(_WIN32) +#include +#else +#include +#include +#include +#include +#include +#endif + +#include "vm_assert.h" +#include "vm_atomic.h" +#include "vm_basic_types.h" +#define G_LOG_DOMAIN "gdp" +#include "vmware/tools/log.h" +#include "vmware/tools/plugin.h" +#include "vmware/tools/utils.h" +#include "vmware/tools/gdp.h" +#include "vmci_defs.h" +#include "vmci_sockets.h" +#include "vmcheck.h" + +#include "vm_version.h" +#include "embed_version.h" +#include "vmtoolsd_version.h" +VM_EMBED_VERSION(VMTOOLSD_VERSION_STRING); + + +#if defined(_WIN32) +# define GetSockErr() WSAGetLastError() + +# define SYSERR_EADDRINUSE WSAEADDRINUSE +# define SYSERR_EHOSTUNREACH WSAEHOSTUNREACH +# define SYSERR_EINTR WSAEINTR +# define SYSERR_EMSGSIZE WSAEMSGSIZE +# define SYSERR_WOULDBLOCK(e) (e == WSAEWOULDBLOCK) + + typedef int socklen_t; +# define CloseSocket closesocket + +# define SOCK_READ FD_READ +# define SOCK_WRITE FD_WRITE +#else +# define GetSockErr() errno + +# define SYSERR_EADDRINUSE EADDRINUSE +# define SYSERR_EHOSTUNREACH EHOSTUNREACH +# define SYSERR_EINTR EINTR +# define SYSERR_EMSGSIZE EMSGSIZE +# define SYSERR_WOULDBLOCK(e) (e == EAGAIN || e == EWOULDBLOCK) + + typedef int SOCKET; +# define SOCKET_ERROR (-1) +# define INVALID_SOCKET ((SOCKET) -1) +# define CloseSocket close + +# define SOCK_READ POLLIN +# define SOCK_WRITE POLLOUT +#endif + +#define PRIVILEGED_PORT_MAX 1023 +#define PRIVILEGED_PORT_MIN 1 + +#define GDPD_LISTEN_PORT 7777 + +#define GDP_SEND_TIMEOUT 1000 // ms +#define GDP_RECV_TIMEOUT 3000 // ms + + +/* + * GdpError message table. + */ +#define GDP_ERR_ITEM(a, b) b, +static const char * const gdpErrMsgs[] = { +GDP_ERR_LIST +}; +#undef GDP_ERR_ITEM + + +typedef struct PluginData { + ToolsAppCtx *ctx; /* The application context */ +#if defined(_WIN32) + Bool wsaStarted; /* TRUE : WSAStartup succeeded, WSACleanup required + FALSE: otherwise */ + WSAEVENT eventSendRecv; /* The send-recv event object: + Event object to associate with + network send/recv ready event */ + WSAEVENT eventStop; /* The stop event object: + Event object signalled to stop guest data + publishing for vmtoolsd shutdown */ +#else + int eventStop; /* The stop event fd: + Event fd signalled to stop guest data + publishing for vmtoolsd shutdown */ +#endif + int vmciFd; /* vSocket address family value fd */ + int vmciFamily; /* vSocket address family value */ + SOCKET sock; /* Datagram socket for publishing guest data */ + Atomic_Bool stopped; /* TRUE : Guest data publishing is stopped + for vmtoolsd shutdown + FALSE: otherwise */ +} PluginData; + +static PluginData pluginData; + + +static Bool GdpInit(ToolsAppCtx *ctx); +static void GdpDestroy(void); +static void GdpSetStopEvent(void); +static Bool GdpCreateSocket(void); +static void GdpCloseSocket(void); +static GdpError GdpEmptyRecvQueue(void); +static GdpError GdpWaitForEvent(int netEvent, int timeout); +static GdpError GdpSend(const char *buf, int len, int timeout); +static GdpError GdpRecv(char *buf, int *len, int timeout); + + +/* + ****************************************************************************** + * GdpInit -- + * + * Initializes internal plugin data. + * + * @param[in] ctx The application context + * + * @return TRUE on success. + * @return FALSE otherwise. + * + ****************************************************************************** + */ + +static Bool +GdpInit(ToolsAppCtx *ctx) // IN +{ + Bool retVal = FALSE; + + pluginData.ctx = ctx; +#if defined(_WIN32) + pluginData.wsaStarted = FALSE; + pluginData.eventSendRecv = WSA_INVALID_EVENT; + pluginData.eventStop = WSA_INVALID_EVENT; +#else + pluginData.eventStop = -1; +#endif + pluginData.vmciFd = -1; + pluginData.vmciFamily = -1; + pluginData.sock = INVALID_SOCKET; + Atomic_WriteBool(&pluginData.stopped, FALSE); + +#if defined(_WIN32) + { + WSADATA wsaData; + int res = WSAStartup(MAKEWORD(2, 2), &wsaData); + if (res != 0) { + g_critical("%s: WSAStartup failed: error=%d.\n", + __FUNCTION__, res); + return FALSE; + } + + pluginData.wsaStarted = TRUE; + } + + pluginData.eventSendRecv = WSACreateEvent(); + if (pluginData.eventSendRecv == WSA_INVALID_EVENT) { + g_critical("%s: WSACreateEvent for send/recv failed: error=%d.\n", + __FUNCTION__, WSAGetLastError()); + goto exit; + } + + pluginData.eventStop = WSACreateEvent(); + if (pluginData.eventStop == WSA_INVALID_EVENT) { + g_critical("%s: WSACreateEvent for stop failed: error=%d.\n", + __FUNCTION__, WSAGetLastError()); + goto exit; + } +#else + pluginData.eventStop = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK); + if (pluginData.eventStop == -1) { + g_critical("%s: eventfd for stop failed: error=%d.\n", + __FUNCTION__, errno); + goto exit; + } +#endif + + pluginData.vmciFamily = VMCISock_GetAFValueFd(&pluginData.vmciFd); + if (pluginData.vmciFamily == -1) { + g_critical("%s: Failed to get vSocket address family value.\n", + __FUNCTION__); + goto exit; + } + + retVal = TRUE; + +exit: + if (!retVal) { + GdpDestroy(); + } + + return retVal; +} + + +/* + ****************************************************************************** + * GdpDestroy -- + * + * Destroys internal plugin data. + * + ****************************************************************************** + */ + +static void +GdpDestroy(void) +{ + GdpCloseSocket(); + + if (pluginData.vmciFd != -1) { + VMCISock_ReleaseAFValueFd(pluginData.vmciFd); + pluginData.vmciFd = -1; + } + +#if defined(_WIN32) + if (pluginData.eventStop != WSA_INVALID_EVENT) { + WSACloseEvent(pluginData.eventStop); + pluginData.eventStop = WSA_INVALID_EVENT; + } + + if (pluginData.eventSendRecv != WSA_INVALID_EVENT) { + WSACloseEvent(pluginData.eventSendRecv); + pluginData.eventSendRecv = WSA_INVALID_EVENT; + } + + if (pluginData.wsaStarted) { + WSACleanup(); + pluginData.wsaStarted = FALSE; + } +#else + if (pluginData.eventStop != -1) { + close(pluginData.eventStop); + pluginData.eventStop = -1; + } +#endif + + pluginData.ctx = NULL; +} + + +/* + ****************************************************************************** + * GdpSetStopEvent -- + * + * Signals the stop event object/fd. + * + ****************************************************************************** + */ + +static void +GdpSetStopEvent(void) +{ +#if defined(_WIN32) + ASSERT(pluginData.eventStop != WSA_INVALID_EVENT); + WSASetEvent(pluginData.eventStop); +#else + eventfd_t val = 1; + ASSERT(pluginData.eventStop != -1); + eventfd_write(pluginData.eventStop, val); +#endif +} + + +/* + ****************************************************************************** + * GdpCreateSocket -- + * + * Creates a non-blocking datagram socket for guest data publishing. + * + * The socket is bound to a local privileged port with default remote address + * set to host side gdp daemon endpoint. + * + * @return TRUE on success. + * @return FALSE otherwise. + * + ****************************************************************************** + */ + +static Bool +GdpCreateSocket(void) +{ + struct sockaddr_vm localAddr; + struct sockaddr_vm remoteAddr; + int sockErr; + Bool retVal = FALSE; +#if defined(_WIN32) + u_long nbMode = 1; // Non-blocking mode +# define SOCKET_TYPE_PARAM SOCK_DGRAM +#else + /* + * Requires Linux kernel version >= 2.6.27. + */ +# define SOCKET_TYPE_PARAM SOCK_DGRAM | SOCK_NONBLOCK | SOCK_CLOEXEC +#endif + + ASSERT(pluginData.sock == INVALID_SOCKET); + + pluginData.sock = socket(pluginData.vmciFamily, SOCKET_TYPE_PARAM, 0); +#undef SOCKET_TYPE_PARAM + + if (pluginData.sock == INVALID_SOCKET) { + g_warning("%s: socket failed: error=%d.\n", __FUNCTION__, GetSockErr()); + return FALSE; + } + +#if defined(_WIN32) + /* + * Set socket to nonblocking mode. + * Note: WSAEventSelect automatically does this if not done. + */ + if (ioctlsocket(pluginData.sock, FIONBIO, &nbMode) != 0) { + sockErr = GetSockErr(); + g_warning("%s: ioctlsocket failed: error=%d.\n", __FUNCTION__, sockErr); + goto exit; + } +#endif + + memset(&localAddr, 0, sizeof localAddr); + localAddr.svm_family = pluginData.vmciFamily; + localAddr.svm_cid = VMCISock_GetLocalCID(); + localAddr.svm_port = PRIVILEGED_PORT_MAX; // No htons + + do { + if (bind(pluginData.sock, (struct sockaddr *)&localAddr, + (socklen_t) sizeof localAddr) == 0) { + sockErr = 0; + break; + } + + sockErr = GetSockErr(); + if (sockErr == SYSERR_EADDRINUSE) { + g_info("%s: Local port %d is in use, retry the next one.\n", + __FUNCTION__, localAddr.svm_port); + localAddr.svm_port--; + } else { + g_warning("%s: bind failed: error=%d.\n", __FUNCTION__, sockErr); + goto exit; + } + } while (localAddr.svm_port >= PRIVILEGED_PORT_MIN); + + if (sockErr != 0) { + goto exit; + } + + memset(&remoteAddr, 0, sizeof remoteAddr); + remoteAddr.svm_family = pluginData.vmciFamily; + remoteAddr.svm_cid = VMCI_HOST_CONTEXT_ID; + remoteAddr.svm_port = GDPD_LISTEN_PORT; // No htons + + /* + * Set default remote address to send to/recv from datagrams. + */ + if (connect(pluginData.sock, (struct sockaddr *)&remoteAddr, + (socklen_t) sizeof remoteAddr) != 0) { + sockErr = GetSockErr(); + g_warning("%s: connect failed: error=%d.\n", __FUNCTION__, sockErr); + goto exit; + } + + g_debug("%s: Socket created and bound to local port %d.\n", + __FUNCTION__, localAddr.svm_port); + + retVal = TRUE; + +exit: + if (!retVal) { + CloseSocket(pluginData.sock); + pluginData.sock = INVALID_SOCKET; + } + + return retVal; +} + + +/* + ****************************************************************************** + * GdpCloseSocket -- + * + * Closes the guest data publishing socket. + * + ****************************************************************************** + */ + +static void +GdpCloseSocket(void) +{ + if (pluginData.sock != INVALID_SOCKET) { + g_debug("%s: Closing socket.\n", __FUNCTION__); + if (CloseSocket(pluginData.sock) != 0) { + g_warning("%s: CloseSocket failed: fd=%d, error=%d.\n", + __FUNCTION__, pluginData.sock, GetSockErr()); + } + + pluginData.sock = INVALID_SOCKET; + } +} + + +/* + ****************************************************************************** + * GdpEmptyRecvQueue -- + * + * Empties receive queue before publishing new data to host side gdp daemon. + * This is required in case previous receive from daemon timed out and daemon + * did reply later. + * + * @return GDP_ERROR_SUCCESS on success. + * @return Other GdpError codes otherwise. + * + ****************************************************************************** + */ + +static GdpError +GdpEmptyRecvQueue(void) +{ + GdpError retVal; + + ASSERT(pluginData.sock != INVALID_SOCKET); + + do { + long res; + int sockErr; + char buf[1]; // OK to truncate, case of SYSERR_EMSGSIZE. + + /* + * Windows: recv returns -1, first with SYSERR_EMSGSIZE, + * then SYSERR_WOULDBLOCK. + * Linux : recv returns 1 first, then -1 with SYSERR_WOULDBLOCK. + */ + res = recv(pluginData.sock, buf, (int) sizeof buf, 0); + if (res >= 0) { + g_debug("%s: recv returns %d.\n", __FUNCTION__, (int)res); + continue; + } + + sockErr = GetSockErr(); + if (sockErr == SYSERR_EINTR) { + continue; + } else if (sockErr == SYSERR_EMSGSIZE) { + g_debug("%s: recv truncated.\n", __FUNCTION__); + continue; + } else if (SYSERR_WOULDBLOCK(sockErr)) { + retVal = GDP_ERROR_SUCCESS; // No more message in the recv queue. + } else { + /* + * Note: recv does not return SYSERR_EHOSTUNREACH. + */ + g_info("%s: recv failed: error=%d.\n", __FUNCTION__, sockErr); + retVal = GDP_ERROR_INTERNAL; + } + + break; + + } while (TRUE); + + return retVal; +} + + +/* + ****************************************************************************** + * GdpWaitForEvent -- + * + * Waits for the stop event object/fd signalled for vmtoolsd shutdown, + * network send/receive event ready or timeout. + * + * @param[in] netEvent GOS specific network send/receive event flag + * @param[in] timeout Timeout value in milliseconds, + * negative value means an infinite timeout, + * zero means no wait + * + * @return GDP_ERROR_SUCCESS on specified network event ready. + * @return Other GdpError codes otherwise. + * + ****************************************************************************** + */ + +static GdpError +GdpWaitForEvent(int netEvent, int timeout) +{ +#if defined(_WIN32) + int res; + DWORD localTimeout; + gint64 startTime; + GdpError retVal; + + ASSERT(netEvent == FD_READ || netEvent == FD_WRITE); + ASSERT(pluginData.sock != INVALID_SOCKET); + + /* + * Reset the send-recv event object. + */ + WSAResetEvent(pluginData.eventSendRecv); + + /* + * Associate the send-recv event object with the specified network event + * in the socket. + */ + res = WSAEventSelect(pluginData.sock, pluginData.eventSendRecv, netEvent); + if (res != 0) { + g_info("%s: WSAEventSelect failed: error=%d.\n", + __FUNCTION__, WSAGetLastError()); + return GDP_ERROR_INTERNAL; + } + + localTimeout = (DWORD)(timeout >= 0 ? timeout : WSA_INFINITE); + if (timeout > 0) { + startTime = g_get_monotonic_time(); + } else { + startTime = 0; // Deal with [-Werror=maybe-uninitialized] + } + + while (TRUE) { + WSAEVENT eventObjects[] = {pluginData.eventStop, + pluginData.eventSendRecv}; + DWORD waitRes; + + waitRes = WSAWaitForMultipleEvents((DWORD)ARRAYSIZE(eventObjects), + eventObjects, + FALSE, localTimeout, TRUE); + if (waitRes == WSA_WAIT_EVENT_0) { + /* + * Main thread has set the stop event object to interrupt + * pool thread for vmtoolsd shutdown. + */ + retVal = GDP_ERROR_STOP; + break; + } else if (waitRes == (WSA_WAIT_EVENT_0 + 1)) { + WSANETWORKEVENTS networkEvents; + res = WSAEnumNetworkEvents(pluginData.sock, NULL, &networkEvents); + if (res != 0) { + g_info("%s: WSAEnumNetworkEvents failed: error=%d.\n", + __FUNCTION__, WSAGetLastError()); + retVal = GDP_ERROR_INTERNAL; + break; + } + + /* + * Not checking networkEvents.iErrorCode[FD_READ_BIT]/ + * networkEvents.iErrorCode[FD_WRITE_BIT] for WSAENETDOWN, + * since WSAEnumNetworkEvents should have returned WSAENETDOWN + * if the error condition exists. + */ + if (networkEvents.lNetworkEvents & netEvent) { + retVal = GDP_ERROR_SUCCESS; + } else { // Not expected + g_info("%s: Unexpected network event from WSAEnumNetworkEvents.\n", + __FUNCTION__); + retVal = GDP_ERROR_INTERNAL; + } + + break; + } else if (waitRes == WSA_WAIT_IO_COMPLETION) { + gint64 curTime; + gint64 passedTime; + + if (localTimeout == 0 || + localTimeout == WSA_INFINITE) { + continue; + } + + curTime = g_get_monotonic_time(); + passedTime = (curTime - startTime) / 1000; + if (passedTime >= localTimeout) { + retVal = GDP_ERROR_TIMEOUT; + break; + } + + startTime = curTime; + localTimeout -= (DWORD)passedTime; + continue; + } else if (waitRes == WSA_WAIT_TIMEOUT) { + retVal = GDP_ERROR_TIMEOUT; + break; + } else { // WSA_WAIT_FAILED + g_info("%s: WSAWaitForMultipleEvents failed: error=%d.\n", + __FUNCTION__, WSAGetLastError()); + retVal = GDP_ERROR_INTERNAL; + break; + } + } + + /* + * Cancel the association. + */ + WSAEventSelect(pluginData.sock, NULL, 0); + + return retVal; + +#else + + gint64 startTime; + GdpError retVal; + + ASSERT(netEvent == POLLIN || netEvent == POLLOUT); + ASSERT(pluginData.sock != INVALID_SOCKET); + + if (timeout > 0) { + startTime = g_get_monotonic_time(); + } else { + startTime = 0; // Deal with [-Werror=maybe-uninitialized] + } + + while (TRUE) { + struct pollfd fds[2]; + int res; + + fds[0].fd = pluginData.eventStop; + fds[0].events = POLLIN; + fds[0].revents = 0; + fds[1].fd = pluginData.sock; + fds[1].events = (short)netEvent; + fds[1].revents = 0; + + res = poll(fds, ARRAYSIZE(fds), timeout); + if (res > 0) { + if (fds[0].revents & POLLIN) { + /* + * Check comments in _WIN32. + */ + retVal = GDP_ERROR_STOP; + } else if (fds[1].revents & netEvent) { + retVal = GDP_ERROR_SUCCESS; + } else { // Not expected + g_info("%s: Unexpected event from poll.\n", __FUNCTION__); + retVal = GDP_ERROR_INTERNAL; + } + + break; + } else if (res == -1) { + int err = errno; + if (err == EINTR) { + gint64 curTime; + gint64 passedTime; + + if (timeout <= 0) { + continue; + } + + curTime = g_get_monotonic_time(); + passedTime = (curTime - startTime) / 1000; + if (passedTime >= (gint64)timeout) { + retVal = GDP_ERROR_TIMEOUT; + break; + } + + startTime = curTime; + timeout -= (int)passedTime; + continue; + } else { + g_info("%s: poll failed: error=%d.\n", __FUNCTION__, err); + retVal = GDP_ERROR_INTERNAL; + break; + } + } else if (res == 0) { + retVal = GDP_ERROR_TIMEOUT; + break; + } else { + g_info("%s: Unexpected poll return: %d.\n", __FUNCTION__, res); + retVal = GDP_ERROR_INTERNAL; + break; + } + } + + return retVal; +#endif +} + + +/* + ****************************************************************************** + * GdpSend -- + * + * Sends guest data to host side gdp daemon. + * + * @param[in] buf Send data buffer pointer + * @param[in] len Send data buffer length + * @param[in] timeout Timeout value in milliseconds, + * negative value means an infinite timeout, + * zero means no wait + * + * @return GDP_ERROR_SUCCESS on success. + * @return Other GdpError codes otherwise. + * + ****************************************************************************** + */ + +static GdpError +GdpSend(const char *buf, // IN + int len, // IN + int timeout) // IN +{ + GdpError retVal; + + ASSERT(buf != NULL && len > 0); + ASSERT(pluginData.sock != INVALID_SOCKET); + + do { + long res; + int sockErr; + + res = send(pluginData.sock, buf, len, 0); + if (res >= 0) { + retVal = GDP_ERROR_SUCCESS; + break; + } + + sockErr = GetSockErr(); + if (sockErr == SYSERR_EINTR) { + continue; + } else if (SYSERR_WOULDBLOCK(sockErr)) { + /* + * Datagram send is not buffered, if host daemon is not running, + * send returns error EHOSTUNREACH. In theory, this case should + * not happen, we just follow standard async socket programming + * paradigm here. + */ + GdpError err; + + g_info("%s: Gdp send would block.\n", __FUNCTION__); + + err = GdpWaitForEvent(SOCK_WRITE, timeout); + if (err == GDP_ERROR_SUCCESS) { + continue; + } + + retVal = err; + } else if (sockErr == SYSERR_EHOSTUNREACH) { + g_info("%s: send failed: host daemon unreachable.\n", __FUNCTION__); + retVal = GDP_ERROR_UNREACH; + } else if (sockErr == SYSERR_EMSGSIZE) { + g_info("%s: send failed: message too large.\n", __FUNCTION__); + retVal = GDP_ERROR_SEND_SIZE; + } else { + g_info("%s: send failed: error=%d.\n", __FUNCTION__, sockErr); + retVal = GDP_ERROR_INTERNAL; + } + + break; + + } while (TRUE); + + return retVal; +} + + +/* + ****************************************************************************** + * GdpRecv -- + * + * Receives reply from host side gdp daemon. + * + * @param[out] buf Receive buffer pointer + * @param[in,out] len Receive buffer length on input, + * reply data length on output + * @param[in] timeout Timeout value in milliseconds, + * negative value means an infinite timeout, + * zero means no wait + * + * @return GDP_ERROR_SUCCESS on success. + * @return Other GdpError codes otherwise. + * + ****************************************************************************** + */ + +static GdpError +GdpRecv(char *buf, // OUT + int *len, // IN/OUT + int timeout) // IN +{ + GdpError retVal; + + ASSERT(buf != NULL && len != NULL && *len > 0); + ASSERT(pluginData.sock != INVALID_SOCKET); + + do { + long res; + int sockErr; + + res = recv(pluginData.sock, buf, *len, 0); + if (res >= 0) { + *len = (int)res; + retVal = GDP_ERROR_SUCCESS; + break; + } + + sockErr = GetSockErr(); + if (sockErr == SYSERR_EINTR) { + continue; + } else if (SYSERR_WOULDBLOCK(sockErr)) { + GdpError err = GdpWaitForEvent(SOCK_READ, timeout); + if (err == GDP_ERROR_SUCCESS) { + continue; + } + + retVal = err; + } else if (sockErr == SYSERR_EMSGSIZE) { + g_info("%s: recv failed: buffer size too small.\n", __FUNCTION__); + retVal = GDP_ERROR_RECV_SIZE; + } else { + g_info("%s: recv failed: error=%d.\n", __FUNCTION__, sockErr); + retVal = GDP_ERROR_INTERNAL; + } + + break; + + } while (TRUE); + + return retVal; +} + + +/* + ****************************************************************************** + * GdpPublish -- + * + * Publishes guest data to host side gdp daemon. + * + * @param[in] msg Buffer containing guest data to publish + * @param[in] msgLen Guest data length + * @param[out,optional] reply Buffer to receive reply from gdp daemon + * @param[in,out,optional] replyLen NULL when param reply is NULL, otherwise: + * reply buffer length on input, + * reply data length on output + * + * @return GDP_ERROR_SUCCESS on success. + * @return Other GdpError codes otherwise. + * + ****************************************************************************** + */ + +static GdpError +GdpPublish(const char *msg, // IN + int msgLen, // IN + char *reply, // OUT, OPTIONAL + int *replyLen) // IN/OUT, OPTIONAL +{ + static GMutex mutex; + + GdpError err; + char altRecvBuf[GDP_SEND_RECV_BUF_LEN]; // Enough for maximum size datagram + int altRecvBufLen = (int) sizeof altRecvBuf; + char *recvBuf; + int *recvBufLen; + + g_debug("%s: Entering ...\n", __FUNCTION__); + + ASSERT((reply == NULL && replyLen == NULL) || + (reply != NULL && replyLen != NULL && *replyLen > 0)); + + g_mutex_lock(&mutex); + + if (Atomic_ReadBool(&pluginData.stopped)) { + /* + * Main thread has interrupted pool thread for vmtoolsd shutdown. + */ + err = GDP_ERROR_STOP; + goto exit; + } + + if (pluginData.sock == INVALID_SOCKET && !GdpCreateSocket()) { + err = GDP_ERROR_INTERNAL; + goto exit; + } + + err = GdpEmptyRecvQueue(); + if (err != GDP_ERROR_SUCCESS) { + goto exit; + } + + err = GdpSend(msg, msgLen, + GDP_SEND_TIMEOUT); // Should not time out in theory + if (err != GDP_ERROR_SUCCESS) { + g_info("%s: GdpSend failed: %s.\n", __FUNCTION__, gdpErrMsgs[err]); + goto exit; + } + + if (reply != NULL) { + recvBuf = reply; + recvBufLen = replyLen; + } else { + recvBuf = altRecvBuf; + recvBufLen = &altRecvBufLen; + } + + err = GdpRecv(recvBuf, recvBufLen, GDP_RECV_TIMEOUT); + if (err != GDP_ERROR_SUCCESS) { + g_info("%s: GdpRecv failed: %s.\n", __FUNCTION__, gdpErrMsgs[err]); + } + +exit: + if (err == GDP_ERROR_INTERNAL) { + /* + * No need to close and recreate socket for these errors: + * + * GDP_ERROR_UNREACH + * GDP_ERROR_TIMEOUT + * GDP_ERROR_SEND_SIZE + * GDP_ERROR_RECV_SIZE + */ + GdpCloseSocket(); + } + + g_mutex_unlock(&mutex); + + g_debug("%s: Return: %s.\n", __FUNCTION__, gdpErrMsgs[err]); + + return err; +} + + +/* + ****************************************************************************** + * GdpStop -- + * + * Stops guest data publishing for vmtoolsd shutdown, called by main thread. + * + * @return GDP_ERROR_SUCCESS. + * + ****************************************************************************** + */ + +static GdpError +GdpStop(void) +{ + g_debug("%s: Entering ...\n", __FUNCTION__); + Atomic_WriteBool(&pluginData.stopped, TRUE); + GdpSetStopEvent(); + return GDP_ERROR_SUCCESS; +} + + +/* + ****************************************************************************** + * GdpShutdown -- + * + * Cleans up on shutdown. + * + * @param[in] src The source object, unused + * @param[in] ctx The application context + * @param[in] data Unused + * + ****************************************************************************** + */ + +static void +GdpShutdown(gpointer src, // IN + ToolsAppCtx *ctx, // IN + gpointer data) // IN +{ + g_debug("%s: Entering ...\n", __FUNCTION__); + g_object_set(ctx->serviceObj, TOOLS_PLUGIN_SVC_PROP_GDP, NULL, NULL); + GdpDestroy(); +} + + +/* + ****************************************************************************** + * ToolsOnLoad -- + * + * Plugin entry point. Initializes internal plugin state. + * + * @param[in] ctx The application context + * + * @return The registration data. + * + ****************************************************************************** + */ + +TOOLS_MODULE_EXPORT ToolsPluginData * +ToolsOnLoad(ToolsAppCtx *ctx) // IN +{ + /* + * Return NULL to disable the plugin if not running in vmsvc daemon. + */ + if (!TOOLS_IS_MAIN_SERVICE(ctx)) { + g_info("%s: Not running in vmsvc daemon: container name='%s'.\n", + __FUNCTION__, ctx->name); + return NULL; + } + + /* + * Return NULL to disable the plugin if not running in a VMware VM. + */ + if (!ctx->isVMware) { + g_info("%s: Not running in a VMware VM.\n", __FUNCTION__); + return NULL; + } + + /* + * Return NULL to disable the plugin if VM is not running on ESX host. + */ + { + uint32 vmxVersion = 0; + uint32 vmxType = VMX_TYPE_UNSET; + if (!VmCheck_GetVersion(&vmxVersion, &vmxType) || + vmxType != VMX_TYPE_SCALABLE_SERVER) { + g_info("%s: VM is not running on ESX host.\n", __FUNCTION__); + return NULL; + } + } + + if (!GdpInit(ctx)) { + g_info("%s: Failed to init plugin.\n", __FUNCTION__); + return NULL; + } + + { + static ToolsPluginSvcGdp svcGdp = { GdpPublish, GdpStop }; + static ToolsPluginData regData = { "gdp", NULL, NULL, NULL }; + + ToolsServiceProperty propGdp = { TOOLS_PLUGIN_SVC_PROP_GDP }; + + ToolsPluginSignalCb sigs[] = { + { TOOLS_CORE_SIG_SHUTDOWN, GdpShutdown, NULL }, + }; + ToolsAppReg regs[] = { + { TOOLS_APP_SIGNALS, + VMTools_WrapArray(sigs, sizeof *sigs, ARRAYSIZE(sigs)) } + }; + + ctx->registerServiceProperty(ctx->serviceObj, &propGdp); + g_object_set(ctx->serviceObj, TOOLS_PLUGIN_SVC_PROP_GDP, &svcGdp, NULL); + + regData.regs = VMTools_WrapArray(regs, sizeof *regs, ARRAYSIZE(regs)); + return ®Data; + } +}