]> git.ipfire.org Git - thirdparty/open-vm-tools.git/commitdiff
Service Discovery plugin integration into open-vm-tools
authorOliver Kurth <okurth@vmware.com>
Tue, 17 Mar 2020 21:36:58 +0000 (14:36 -0700)
committerOliver Kurth <okurth@vmware.com>
Tue, 17 Mar 2020 21:36:58 +0000 (14:36 -0700)
open-vm-tools/configure.ac
open-vm-tools/services/plugins/Makefile.am
open-vm-tools/services/plugins/serviceDiscovery/COPYING [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/Makefile.am [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/get-connection-info.sh [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/get-listening-process-info.sh [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/get-listening-process-perf-metrics.sh [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/get-versions.sh [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/serviceDiscovery.c [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/serviceDiscovery.h [new file with mode: 0644]
open-vm-tools/services/plugins/serviceDiscovery/serviceDiscoveryPosix.c [new file with mode: 0644]

index 58f46a1e1789c5189e43fd48460da9f52b0eafc3..18cdc3d405854272ccb611c01509c44b181761ae 100644 (file)
@@ -437,6 +437,16 @@ AC_ARG_ENABLE([libappmonitor],
     enable_libappmonitor=no
    ])
 
+AC_ARG_ENABLE([servicediscovery],
+   [AS_HELP_STRING([--enable-servicediscovery],
+     [Build the Service Discovery Plugin.])],
+   [
+    enable_servicediscovery=$enableval
+   ],
+   [
+    enable_servicediscovery=no
+   ])
+
 #
 # Check for glib 2.34.0 or greater.
 #
@@ -1445,6 +1455,7 @@ AM_CONDITIONAL(HAVE_UDEV, test "$have_udev" = "yes")
 AM_CONDITIONAL(ENABLE_RESOLUTIONKMS, test "x$enable_resolutionkms" = "xyes")
 AM_CONDITIONAL(VGAUTH_USE_CXX, test "$with_icu" = "yes" -o "$use_xmlsec1" != "yes")
 AM_CONDITIONAL(ENABLE_LIBAPPMONITOR, test "$enable_libappmonitor" = "yes")
+AM_CONDITIONAL(ENABLE_SDMP, test "$enable_servicediscovery" = "yes")
 
 if test "$have_xsm" != "yes"; then
 AC_DEFINE([NO_XSM], 1, [])
@@ -1605,6 +1616,7 @@ AC_CONFIG_FILES([                      \
    services/vmtoolsd/Makefile          \
    services/plugins/Makefile           \
    services/plugins/appInfo/Makefile   \
+   services/plugins/serviceDiscovery/Makefile   \
    services/plugins/desktopEvents/Makefile \
    services/plugins/dndcp/Makefile     \
    services/plugins/guestInfo/Makefile \
index 5c5e8c212cd3b8abb9994fa972e776a10cdfc7ce..48cecc99ec412ca57ac523b4cb5d2ba9e3a37baf 100644 (file)
@@ -19,6 +19,9 @@ SUBDIRS =
 if LINUX
    SUBDIRS += appInfo
 endif
+if ENABLE_SDMP
+   SUBDIRS += serviceDiscovery
+endif
 if HAVE_X11
    SUBDIRS += desktopEvents
 endif
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/COPYING b/open-vm-tools/services/plugins/serviceDiscovery/COPYING
new file mode 100644 (file)
index 0000000..09f465a
--- /dev/null
@@ -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.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/Makefile.am b/open-vm-tools/services/plugins/serviceDiscovery/Makefile.am
new file mode 100644 (file)
index 0000000..f341f9b
--- /dev/null
@@ -0,0 +1,46 @@
+################################################################################
+### 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 = libserviceDiscovery.la
+
+libserviceDiscovery_la_CPPFLAGS =
+libserviceDiscovery_la_CPPFLAGS += @PLUGIN_CPPFLAGS@
+libserviceDiscovery_la_CPPFLAGS += -DVMTOOLS_SERVICE_DISCOVERY_SCRIPTS=\"$(pkglibdir)/serviceDiscovery/scripts\"
+
+libserviceDiscovery_la_LDFLAGS =
+libserviceDiscovery_la_LDFLAGS += @PLUGIN_LDFLAGS@
+
+libserviceDiscovery_la_LIBADD =
+libserviceDiscovery_la_LIBADD += @VMTOOLS_LIBS@
+libserviceDiscovery_la_LIBADD += @GOBJECT_LIBS@
+
+libserviceDiscovery_la_SOURCES =
+libserviceDiscovery_la_SOURCES += serviceDiscovery.c
+libserviceDiscovery_la_SOURCES += serviceDiscoveryPosix.c
+libserviceDiscovery_la_SOURCES += serviceDiscovery.h
+
+install-data-local:
+       $(INSTALL) -d $(DESTDIR)/$(libdir)/open-vm-tools/serviceDiscovery/scripts/
+       $(INSTALL) -m 755 $(srcdir)/get-connection-info.sh $(DESTDIR)/$(libdir)/open-vm-tools/serviceDiscovery/scripts/
+       $(INSTALL) -m 755 $(srcdir)/get-listening-process-info.sh $(DESTDIR)/$(libdir)/open-vm-tools/serviceDiscovery/scripts/
+       $(INSTALL) -m 755 $(srcdir)/get-listening-process-perf-metrics.sh $(DESTDIR)/$(libdir)/open-vm-tools/serviceDiscovery/scripts/
+       $(INSTALL) -m 755 $(srcdir)/get-versions.sh $(DESTDIR)/$(libdir)/open-vm-tools/serviceDiscovery/scripts/
+
+
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/get-connection-info.sh b/open-vm-tools/services/plugins/serviceDiscovery/get-connection-info.sh
new file mode 100644 (file)
index 0000000..1694514
--- /dev/null
@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# check if necesary commands exist
+command -v netstat >/dev/null 2>&1 || { echo >&2 "netstat doesn't exist"; exit 1; }
+command -v grep >/dev/null 2>&1 || { echo >&2 "grep doesn't exist"; exit 1; }
+command -v sort >/dev/null 2>&1 || { echo >&2 "sort doesn't exist"; exit 1; }
+command -v tr >/dev/null 2>&1 || { echo >&2 "tr doesn't exist"; exit 1; }
+
+# get pids of listening processes
+space_separated_pids=$(netstat -lntup | grep -Eo "[0-9]+/" | sort -u)
+
+# grep pattern
+pattern=$(echo $space_separated_pids | tr ' ' '|')
+
+# get matching lines
+netstat -antup | grep -E $pattern
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/get-listening-process-info.sh b/open-vm-tools/services/plugins/serviceDiscovery/get-listening-process-info.sh
new file mode 100644 (file)
index 0000000..173b1c0
--- /dev/null
@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# check if necesary commands exist
+command -v netstat >/dev/null 2>&1 || { echo >&2 "netstat doesn't exist"; exit 1; }
+command -v grep >/dev/null 2>&1 || { echo >&2 "grep doesn't exist"; exit 1; }
+command -v sort >/dev/null 2>&1 || { echo >&2 "sort doesn't exist"; exit 1; }
+command -v tr >/dev/null 2>&1 || { echo >&2 "tr doesn't exist"; exit 1; }
+command -v ps >/dev/null 2>&1 || { echo >&2 "ps doesn't exist"; exit 1; }
+
+# get pids of listening processes
+space_separated_pids=$(netstat -lntup | grep -Eo "[0-9]+/" | grep -Eo "[0-9]*" | sort -u)
+
+# ps accepts comma separated pids
+comma_separated_pids=$(echo $space_separated_pids | tr ' ' ',')
+
+# get information for each listening process
+ps --pid $comma_separated_pids -o pid=,ppid=,comm=,command=
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/get-listening-process-perf-metrics.sh b/open-vm-tools/services/plugins/serviceDiscovery/get-listening-process-perf-metrics.sh
new file mode 100644 (file)
index 0000000..ad83762
--- /dev/null
@@ -0,0 +1,113 @@
+#!/bin/sh
+
+# check if necesary commands exist
+command -v netstat >/dev/null 2>&1 || { echo >&2 "netstat doesn't exist"; exit 1; }
+command -v grep >/dev/null 2>&1 || { echo >&2 "grep doesn't exist"; exit 1; }
+command -v sort >/dev/null 2>&1 || { echo >&2 "sort doesn't exist"; exit 1; }
+command -v awk >/dev/null 2>&1 || { echo >&2 "awk doesn't exist"; exit 1; }
+command -v cat >/dev/null 2>&1 || { echo >&2 "cat doesn't exist"; exit 1; }
+command -v cut >/dev/null 2>&1 || { echo >&2 "cut doesn't exist"; exit 1; }
+command -v pgrep >/dev/null 2>&1 || { echo >&2 "pgrep doesn't exist"; exit 1; }
+command -v getconf >/dev/null 2>&1 || { echo >&2 "getconf doesn't exist"; exit 1; }
+
+ECHO="$(which echo)"
+
+if [ "$ECHO" = "" ]; then
+  ECHO=echo
+fi
+
+calculateCpuTimeForProcess() {
+  pidArray="$@"
+  cpuUsage=0
+  for i in $pidArray; do
+    pidStatArray=$(cat /proc/$i/stat)
+    uptimes=$(cat /proc/uptime)
+    uptime=$($ECHO ${uptimes} | cut -d' ' -f1)
+    utime=$($ECHO ${pidStatArray} | cut -d' ' -f14)
+    stime=$($ECHO ${pidStatArray} | cut -d' ' -f15)
+    cutime=$($ECHO ${pidStatArray} | cut -d' ' -f16)
+    cstime=$($ECHO ${pidStatArray} | cut -d' ' -f17)
+    starttime=$($ECHO ${pidStatArray} | cut -d' ' -f22)
+    pidCPU=$($ECHO - | awk -v ut=$utime -v st=$stime -v cut=$cutime -v cst=$cstime -v start=$starttime -v clk=$CLK_TCK -v up=$uptime '{print (ut+st+cut+cst)}')
+    cpuUsage=$($ECHO - | awk -v ti=$timeout -v clk=$CLK_TCK -v cpu=$cpuUsage -v pcpu=$pidCPU -v ccpu=$PROC_COUNT '{print (((cpu+pcpu)/(ti*clk)*100)/ccpu)}')
+  done
+  $ECHO $cpuUsage
+}
+
+calculateMemForAllProcesses() {
+  pids=$@
+  for k in $pids; do
+    pidArray="$k $(pgrep -P $k)"
+    length=$($ECHO -n $pidArray | wc -w)
+    PGPID=$k
+    if [ $length -eq 1 ]; then
+      memUsage=$(awk '/^Pss:/{A+=$2} END {print A}' $(for n in $($ECHO "$PGPID" | awk '{if (NR > 1 || $n!="") print "/proc/"$n"/smaps"}'); do $ECHO $n ; done) || exit 1)
+    else
+      memUsage=$(awk '/^Pss:/{A+=$2} END {print A}' $(for n in $($ECHO -e "\n$PGPID\n$(pgrep -P$PGPID)" | awk '{if (NR > 1 || $n !="") print "/proc/"$n"/smaps"}'); do $ECHO $n ; done) || exit 1)
+    fi
+    $ECHO MEM: $k  $memUsage
+  done
+}
+
+calculateIOForAllProcesses() {
+  pids=$@
+  for l in $pids; do
+    pidArray="$l $(pgrep -P $l)"
+    length=$($ECHO -n $pidArray | wc -w)
+    PGPID=$l
+    if [ $length -eq 1 ]; then
+      readBytes=$(awk '/^read_bytes:/{A+=$2} END {print A}' $(for n in $($ECHO "$PGPID" | awk '{if (NR > 1 || $n!="") print "/proc/"$n"/io"}'); do $ECHO "$n" ; done) || exit 1)
+      writeBytes=$(awk '/^write_bytes:/{A+=$2} END {print A}' $(for m in $($ECHO "$PGPID" | awk '{if (NR > 1 || $m!="") print "/proc/"$m"/io"}'); do $ECHO "$m" ; done) || exit 1)
+    else
+      readBytes=$(awk '/^read_bytes:/{A+=$2} END {print A}' $(for n in $($ECHO -e "\n$PGPID\n$(pgrep -P$PGPID)" | awk '{if (NR > 1 || $n !="") print "/proc/"$n"/io"}'); do $ECHO $n ; done) || exit 1)
+      writeBytes=$(awk '/^write_bytes:/{A+=$2} END {print A}' $(for m in $($ECHO -e "\n$PGPID\n$(pgrep -P$PGPID)" | awk '{if (NR > 1 || $m !="") print "/proc/"$m"/io"}'); do $ECHO $m ; done) || exit 1)
+    fi
+    $ECHO IO: $l $readBytes $writeBytes
+  done
+}
+
+calculateCpuForAllProcesses() {
+  pids=$@
+  for j in $pids; do
+    pidArray="$j $(pgrep -P $j)"
+    cpuUsage=$(calculateCpuTimeForProcess $pidArray)
+    $ECHO CPU: $j $cpuUsage
+  done
+}
+
+run() {
+  calculateCpuForAllProcesses $@
+
+  calculateIOForAllProcesses $@
+
+  sleep $timeout
+
+  # need to get CPU and IO for two different timestamps to calculate delta
+  calculateCpuForAllProcesses $@
+
+  calculateIOForAllProcesses $@
+
+  calculateMemForAllProcesses $@
+}
+
+get_performance_metrics() {
+  if [ $# -lt 1 ]; then
+    echo "No process id has been provided."
+    exit 1
+  fi
+
+  pids=$@
+  echo "#PIDs: - $pids"
+
+  timeout=1
+  CLK_TCK=$(getconf CLK_TCK)
+  [ -z "$CLK_TCK" ] && { echo "Failed to get conf variable CLK_TCK"; exit 1; }
+  PROC_COUNT=$(getconf _NPROCESSORS_ONLN)
+  [ -z "$PROC_COUNT" ] && { echo "Failed to get conf variable _NPROCESSORS_ONLN"; exit 1; }
+
+  run $pids
+}
+
+space_separated_pids=$(netstat -lntup | grep -Eo "[0-9]+/" | grep -Eo "[0-9]+" | sort -u)
+
+get_performance_metrics $space_separated_pids
\ No newline at end of file
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/get-versions.sh b/open-vm-tools/services/plugins/serviceDiscovery/get-versions.sh
new file mode 100644 (file)
index 0000000..496c95e
--- /dev/null
@@ -0,0 +1,94 @@
+#!/bin/sh
+
+# check if necesary commands exist
+command -v netstat >/dev/null 2>&1 || { echo >&2 "netstat doesn't exist"; exit 1; }
+command -v grep >/dev/null 2>&1 || { echo >&2 "grep doesn't exist"; exit 1; }
+command -v sort >/dev/null 2>&1 || { echo >&2 "sort doesn't exist"; exit 1; }
+command -v ps >/dev/null 2>&1 || { echo >&2 "ps doesn't exist"; exit 1; }
+
+space_separated_pids=$(netstat -lntup | grep -Eo "[0-9]+/" | grep -Eo "[0-9]*" | sort -u)
+
+get_command_line() {
+  ps --pid $1 -o command
+}
+
+get_version() {
+  PATTERN=$1
+  VERSION_OPTION=$2
+  for p in $space_separated_pids
+  do
+    COMMAND=$(get_command_line $p | grep -Eo "$PATTERN")
+    [ ! -z "$COMMAND" ] && echo VERSIONSTART "$p" "$($COMMAND $VERSION_OPTION 2>&1)" VERSIONEND
+  done
+}
+
+get_vcops_version() {
+  cat $ALIVE_BASE/user/conf/lastbuildversion.txt 2>/dev/null
+}
+
+get_srm_mgt_server_version() {
+  grep -oE "<version>.*</version>" /opt/vmware/etc/appliance-manifest.xml 2>/dev/null
+}
+
+get_vcenter_appliance_version() {
+  $(which vpxd 2>/dev/null) -v 2>/dev/null
+}
+
+get_vcloud_director_version() {
+  PATTERN="\-DVCLOUD_HOME=\S+"
+  for p in $space_separated_pids
+  do
+    VCLOUD_HOME=$(get_command_line $p | grep -Eo "$PATTERN" | cut -d'=' -f2)
+    [ ! -z "$VCLOUD_HOME" ] && echo VERSIONSTART "$p" "$(grep product.version ${VCLOUD_HOME}/etc/global.properties 2>/dev/null | cut -d'=' -f2 2>/dev/null)" VERSIONEND
+  done
+}
+
+get_weblogic_version() {
+  PATTERN="java\.security\.policy=.+/server/lib/weblogic\.policy"
+  for p in $space_separated_pids
+  do
+    WEBLOGIC_HOME=$(get_command_line $p | grep -Eo "$PATTERN" | cut -d'=' -f2)
+    WEBLOGIC_HOME="${WEBLOGIC_HOME%%/server/lib/weblogic.policy*}"
+    [ ! -z "$WEBLOGIC_HOME" ] && echo VERSIONSTART "$p" "$(java -cp ${WEBLOGIC_HOME}/server/lib/weblogic.jar weblogic.version 2>/dev/null)" VERSIONEND
+  done
+}
+
+get_apache_tomcat_version() {
+  PATTERN="/\S*tomcat\S*/bin/bootstrap\.jar.*\s+org\.apache\.catalina\.startup\.Bootstrap"
+  for p in $space_separated_pids
+  do
+    TOMCAT_HOME=$(get_command_line $p | grep -Eo "$PATTERN")
+    TOMCAT_HOME="${TOMCAT_HOME%%/bin/bootstrap.jar*}"
+    [ ! -z "$TOMCAT_HOME" ] && echo VERSIONSTART "$p" "$(java -cp ${TOMCAT_HOME}/lib/catalina.jar org.apache.catalina.util.ServerInfo 2>/dev/null)" VERSIONEND
+  done
+}
+
+get_jboss_version() {
+  PATTERN="jboss.home.dir=\S+"
+  for p in $space_separated_pids
+  do
+    JBOSS_HOME=$(get_command_line $p | grep -Eo "$PATTERN" | cut -d'=' -f2)
+    [ ! -z "$JBOSS_HOME" ] && echo VERSIONSTART "$p" "$(${JBOSS_HOME}/bin/standalone.sh --version 2>/dev/null)" VERSIONEND
+  done
+}
+
+get_db2_version() {
+  db2level 2>/dev/null | grep "DB2 v"
+}
+
+echo VERSIONSTART "vcops_version" "$(get_vcops_version)" VERSIONEND
+echo VERSIONSTART "srm_mgt_server_version" "$(get_srm_mgt_server_version)" VERSIONEND
+echo VERSIONSTART "vcenter_appliance_version" "$(get_vcenter_appliance_version)" VERSIONEND
+echo VERSIONSTART "db2_version" "$(get_db2_version)" VERSIONEND
+
+get_version "/\S+/(httpd-prefork|httpd|httpd2-prefork)($|\s)" -v
+get_version "/usr/(bin|sbin)/apache\S*" -v
+get_version "/\S+/mysqld($|\s)" -V
+get_version "\.?/\S*nginx($|\s)" -v
+get_version "/\S+/srm/bin/vmware-dr($|\s)" --version
+get_version "/\S+/dataserver($|\s)" -v
+
+get_vcloud_director_version
+get_weblogic_version
+get_apache_tomcat_version
+get_jboss_version
\ No newline at end of file
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/serviceDiscovery.c b/open-vm-tools/services/plugins/serviceDiscovery/serviceDiscovery.c
new file mode 100644 (file)
index 0000000..1ceae67
--- /dev/null
@@ -0,0 +1,854 @@
+/*********************************************************
+ * 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.
+ *
+ *********************************************************/
+
+/*
+ * serviceDiscovery.c --
+ *
+ * Captures the information about services inside the guest
+ * and writes it to Namespace DB.
+ */
+
+#include <string.h>
+
+#include "serviceDiscovery.h"
+#include "vmware.h"
+#include "conf.h"
+#include "dynbuf.h"
+#include "escape.h"
+#include "str.h"
+#include "util.h"
+#include "vm_atomic.h"
+#include "vmcheck.h"
+#include "vmware/tools/log.h"
+#include "vmware/tools/threadPool.h"
+#include "vmware/tools/utils.h"
+
+#include "vmware/tools/guestrpc.h"
+
+#if !defined(__APPLE__)
+#include "vm_version.h"
+#include "embed_version.h"
+#include "vmtoolsd_version.h"
+VM_EMBED_VERSION(VMTOOLSD_VERSION_STRING);
+#endif
+
+#define NSDB_PRIV_GET_VALUES_CMD "namespace-priv-get-values"
+#define NSDB_PRIV_SET_KEYS_CMD "namespace-priv-set-keys"
+
+/*
+ * Namespace DB used for service discovery
+ */
+#define SERVICE_DISCOVERY_NAMESPACE_DB_NAME "com.vmware.vrops.sdmp"
+
+/*
+ * ready - used to identify if data is succesfully written to Namespace DB
+ * signal - signal send by sdmp client for plugin to start data collection
+ */
+#define SERVICE_DISCOVERY_KEY_NAME_READY "ready"
+#define SERVICE_DISCOVERY_KEY_NAME_SIGNAL "signal"
+
+#if defined (_WIN32)
+
+/*
+ * keys for types of service data collected by plugin from Windows guest
+ */
+#define WIN_KEY_NAME_PROCESSES "listening-process-info"
+#define WIN_KEY_NAME_CONNECTIONS "connection-info"
+#define WIN_KEY_NAME_PERFORMANCE_METRICS "listening-process-perf-metrics"
+#define WIN_KEY_NAME_VERSIONS "versions"
+#define WIN_KEY_NAME_RELATIONSHIP "pid-to-ppid"
+#define WIN_KEY_NAME_NET "net"
+#define WIN_KEY_NAME_IIS_PORTS "iis-ports-info"
+
+/*
+ * scripts used by plugin to collect from Windows guest
+ */
+#define WIN_SCRIPT_NAME_PROCESSES "get-listening-process-info.bat"
+#define WIN_SCRIPT_NAME_CONNECTIONS "get-connection-info.bat"
+#define WIN_SCRIPT_NAME_PERFORMANCE_METRICS "get-performance-metrics.bat"
+#define WIN_SCRIPT_NAME_VERSIONS "get-versions.bat"
+#define WIN_SCRIPT_NAME_RELATIONSHIP "get-parent-child-rels.bat"
+#define WIN_SCRIPT_NAME_NET "net-share.bat"
+#define WIN_SCRIPT_NAME_IIS_PORTS "get-iis-ports-info.bat"
+
+#else
+
+/*
+ * keys for types of service data collected by plugin from Linux guest
+ */
+#define LIN_KEY_NAME_PROCESSES "listening-process-info"
+#define LIN_KEY_NAME_CONNECTIONS "connection-info"
+#define LIN_KEY_NAME_PERFORMANCE_METRICS "listening-process-perf-metrics"
+#define LIN_KEY_NAME_VERSIONS "versions"
+
+/*
+ * scripts used by plugin to collect from Linux guest
+ */
+#define LIN_SCRIPT_NAME_PROCESSES "get-listening-process-info.sh"
+#define LIN_SCRIPT_NAME_CONNECTIONS "get-connection-info.sh"
+#define LIN_SCRIPT_NAME_PERFORMANCE_METRICS "get-listening-process-perf-metrics.sh"
+#define LIN_SCRIPT_NAME_VERSIONS "get-versions.sh"
+
+#endif
+
+/*
+ * Default value for CONFNAME_SERVICE_DISCOVERY_DISABLED setting in
+ * tools configuration file.
+ */
+#define SERVICE_DISCOVERY_CONF_DEFAULT_DISABLED_VALUE FALSE
+
+/*
+ * Polling interval of service discovery plugin in milliseconds
+ */
+#define SERVICE_DISCOVERY_POLL_INTERVAL 300000
+
+/*
+ * Time shift for comparision of time read from the signal and
+ * current system time in milliseconds.
+ */
+#define SERVICE_DISCOVERY_WRITE_DELTA 60000
+
+
+typedef struct {
+   gchar *keyName;
+   gchar *val;
+} KeyNameValue;
+
+#if defined(_WIN32)
+static KeyNameValue gKeyScripts[] = {
+   { WIN_KEY_NAME_PROCESSES, WIN_SCRIPT_NAME_PROCESSES },
+   { WIN_KEY_NAME_CONNECTIONS, WIN_SCRIPT_NAME_CONNECTIONS },
+   { WIN_KEY_NAME_PERFORMANCE_METRICS, WIN_SCRIPT_NAME_PERFORMANCE_METRICS },
+   { WIN_KEY_NAME_VERSIONS, WIN_SCRIPT_NAME_VERSIONS },
+   { WIN_KEY_NAME_RELATIONSHIP, WIN_SCRIPT_NAME_RELATIONSHIP },
+   { WIN_KEY_NAME_IIS_PORTS, WIN_SCRIPT_NAME_IIS_PORTS },
+   { WIN_KEY_NAME_NET, WIN_SCRIPT_NAME_NET },
+};
+#else
+static KeyNameValue gKeyScripts[] = {
+   { LIN_KEY_NAME_PROCESSES, LIN_SCRIPT_NAME_PROCESSES },
+   { LIN_KEY_NAME_CONNECTIONS, LIN_SCRIPT_NAME_CONNECTIONS },
+   { LIN_KEY_NAME_PERFORMANCE_METRICS, LIN_SCRIPT_NAME_PERFORMANCE_METRICS },
+   { LIN_KEY_NAME_VERSIONS, LIN_SCRIPT_NAME_VERSIONS },
+};
+#endif
+
+static GSource *gServiceDiscoveryTimeoutSource = NULL;
+static gint64 gLastWriteTime = 0;
+
+static GArray *gFullPaths = NULL;
+static volatile Bool gTaskSubmitted = FALSE;
+
+
+/*
+*****************************************************************************
+* GetGuestTimeInMillis --
+*
+* Get system current time in millis.
+*
+* @retval time in millis.
+*
+*****************************************************************************
+*/
+
+static gint64
+GetGuestTimeInMillis(void)
+{
+   return g_get_real_time() / 1000;
+}
+
+
+/*
+ *****************************************************************************
+ * WriteData --
+ *
+ * Sends key-value update request to the Namespace DB.
+ *
+ * @param[in] ctx       Application context.
+ * @param[in] key       Key sent to the Namespace DB
+ * @param[in] value     Service data sent to the Namespace DB
+ * @param[in] len       Service data len
+ *
+ * @retval TRUE  Namespace DB write over RPC succeeded.
+ * @retval FALSE Namespace DB write over RPC failed.
+ *
+ *****************************************************************************
+ */
+
+Bool
+WriteData(ToolsAppCtx *ctx,
+          const char *key,
+          const char *data,
+          const size_t len)
+{
+   Bool status = FALSE;
+   DynBuf buf;
+   gchar *timeStamp = NULL;
+
+   if (data != NULL) {
+      timeStamp = g_strdup_printf("%" G_GINT64_FORMAT, gLastWriteTime);
+   }
+
+   DynBuf_Init(&buf);
+
+   /*
+    * Format is:
+    *
+    * namespace-set-keys <namespace>\0<numOps>\0<op>\0<key>\0<value>\0<oldVal>
+    *
+    * We have just a single op, and want to always set the value, clobbering
+    * anything already there.
+    */
+   if (!DynBuf_Append(&buf, NSDB_PRIV_SET_KEYS_CMD,
+                      strlen(NSDB_PRIV_SET_KEYS_CMD)) ||
+       !DynBuf_Append(&buf, " ", 1) ||
+       !DynBuf_AppendString(&buf, SERVICE_DISCOVERY_NAMESPACE_DB_NAME) ||
+       !DynBuf_AppendString(&buf, "1") || // numOps
+       !DynBuf_AppendString(&buf, "0") || // op 0 == setAlways
+       !DynBuf_AppendString(&buf, key)) {
+      g_warning("%s: Could not construct buffer header\n", __FUNCTION__);
+      goto out;
+   }
+
+   if (data != NULL) {
+      if (!DynBuf_Append(&buf, timeStamp, strlen(timeStamp)) ||
+          !DynBuf_Append(&buf, ",", 1) ||
+          !DynBuf_Append(&buf, data, len) ||
+          !DynBuf_Append(&buf, "", 1)) {
+         g_warning("%s: Could not construct write buffer\n", __FUNCTION__);
+         goto out;
+      }
+   } else {
+      if (!DynBuf_Append(&buf, "", 1)) {
+         g_warning("%s: Could not construct delete buffer\n", __FUNCTION__);
+         goto out;
+      }
+   }
+
+   if (!DynBuf_Append(&buf, "", 1)) {
+      g_warning("%s: Could not construct buffer footer\n", __FUNCTION__);
+      goto out;
+   } else {
+      char *result = NULL;
+      size_t resultLen;
+      status = RpcChannel_Send(ctx->rpc, DynBuf_Get(&buf),
+                               DynBuf_GetSize(&buf),
+                               &result, &resultLen);
+      if (!status) {
+         g_warning("%s: Failed to update %s, result = %s\n", __FUNCTION__,
+                   key, result);
+      }
+
+      if (result != NULL) {
+         free(result);
+      }
+   }
+
+out:
+   DynBuf_Destroy(&buf);
+   g_free(timeStamp);
+
+   return status;
+}
+
+
+/*
+ *****************************************************************************
+ * ReadData --
+ *
+ * Reads value from Namespace DB by given key.
+ *
+ * @param[in] ctx             Application context.
+ * @param[in] key             Key sent to the Namespace DB
+ * @param[out] resultData     Data fetched from Namespace DB, freed by callers
+ * @param[out] resultDataLen  Length of data fetched from Namespace DB
+ *
+ * @retval TRUE  Namespace DB read over RPC succeeded.
+ * @retval FALSE Namespace DB read over RPC failed.
+ *
+ *****************************************************************************
+ */
+
+static Bool
+ReadData(ToolsAppCtx *ctx,
+         const char *key,
+         char **resultData,
+         size_t *resultDataLen)
+{
+   DynBuf buf;
+   Bool status = FALSE;
+
+   ASSERT(key);
+
+   *resultData = NULL;
+   *resultDataLen = 0;
+
+   DynBuf_Init(&buf);
+
+   /*
+    * Format is
+    *
+    * namespace-get-values <namespace>\0<key>\0...
+    *
+    */
+   if (!DynBuf_Append(&buf, NSDB_PRIV_GET_VALUES_CMD,
+                      strlen(NSDB_PRIV_GET_VALUES_CMD)) ||
+       !DynBuf_Append(&buf, " ", 1) ||
+       !DynBuf_AppendString(&buf, SERVICE_DISCOVERY_NAMESPACE_DB_NAME) ||
+       !DynBuf_AppendString(&buf, key)) {
+      g_warning("%s: Could not construct request buffer\n", __FUNCTION__);
+      goto done;
+    }
+   status = RpcChannel_Send(ctx->rpc, DynBuf_Get(&buf),
+                            DynBuf_GetSize(&buf),
+                            resultData, resultDataLen);
+   if (!status) {
+      g_warning("%s: Read finished with status FALSE", __FUNCTION__);
+   }
+done:
+   DynBuf_Destroy(&buf);
+   return status;
+}
+
+
+/*
+*****************************************************************************
+* DeleteData --
+*
+* Deletes key/value from Namespace DB.
+*
+* @param[in] ctx       Application context.
+* @param[in] key       Key of entry to be deleted from the Namespace DB
+*
+* @retval TRUE  Namespace DB delete over RPC succeeded.
+* @retval FALSE Namespace DB delete over RPC failed.
+*
+*****************************************************************************
+*/
+
+static Bool
+DeleteData(ToolsAppCtx *ctx,
+           const char *key)
+{
+   return WriteData(ctx, key, NULL, 0);
+}
+
+
+/*
+*****************************************************************************
+* CleanupNamespaceDB --
+*
+* Deletes all the chunks written to the Namespace DB in previous cycle.
+*
+* @param[in] ctx       Application context.
+*
+*****************************************************************************
+*/
+
+static void
+CleanupNamespaceDB(ToolsAppCtx *ctx) {
+   int i;
+
+   g_debug("%s: Performing cleanup of previous data\n", __FUNCTION__);
+
+   ASSERT(gFullPaths);
+
+   for (i = 0; i < gFullPaths->len; i++) {
+      char *value = NULL;
+      size_t len = 0;
+      KeyNameValue tmp = g_array_index(gFullPaths, KeyNameValue, i);
+      /*
+       * Read count of chunks, ignore timestamp, iterate over chunks
+       * and remove them.
+       */
+      if (ReadData(ctx, tmp.keyName, &value, &len) && len > 1) {
+         char *token = NULL;
+         g_debug("%s: Read %s from Namespace DB\n", __FUNCTION__, value);
+
+         /*
+         * Delete this key anyways, afterwards check for chunks
+         */
+         if (!DeleteData(ctx, tmp.keyName)) {
+            g_warning("%s: Not able to delete entry %s", __FUNCTION__,
+                      tmp.keyName);
+         }
+
+         if (NULL == strtok(value, ",")) {
+            g_warning("%s: Malformed data for %s in Namespace DB",
+                      __FUNCTION__, tmp.keyName);
+            if (value) {
+               free(value);
+               value = NULL;
+            }
+            continue;
+         }
+         token = strtok(NULL, ",");
+         if (token != NULL) {
+            int count = (int) g_ascii_strtoll(token, NULL, 10);
+            int j;
+            gchar *msg = NULL;
+
+            for (j = 0; j < count; j++) {
+               msg = g_strdup_printf("%s-%d", tmp.keyName, j + 1);
+               g_debug("%s: Deleting entry %s",__FUNCTION__, msg);
+               if (!DeleteData(ctx, msg)) {
+                  g_warning("%s: Not able to delete entry %s",
+                            __FUNCTION__, msg);
+               }
+               g_free(msg);
+            }
+         } else {
+            g_warning("%s: Chunk count has invalid value %s", __FUNCTION__,
+                      value);
+         }
+      } else {
+         g_warning("%s: Key %s not found in Namespace DB\n", __FUNCTION__,
+                   tmp.keyName);
+      }
+
+      if (value) {
+         free(value);
+         value = NULL;
+      }
+   }
+}
+
+
+/*
+ *****************************************************************************
+ * ServiceDiscoveryTask --
+ *
+ * Task to gather discovered services' data and write to Namespace DB.
+ *
+ * @param[in] ctx             Application context.
+ * @param[in] data            Data pointer, not used.
+ *
+ *****************************************************************************
+ */
+
+static void
+ServiceDiscoveryTask(ToolsAppCtx *ctx,
+                     void *data)
+{
+   Bool status = FALSE;
+   int i;
+   gint64 previousWriteTime = gLastWriteTime;
+
+   gTaskSubmitted = TRUE;
+
+   /*
+    * We are going to write to Namespace DB, update glastWriteTime
+    */
+   gLastWriteTime = GetGuestTimeInMillis();
+
+   /*
+    * Reset "ready" flag to stop readers until all data is written
+    */
+   status = WriteData(ctx, SERVICE_DISCOVERY_KEY_NAME_READY, "FALSE", 5);
+   if (!status) {
+      gLastWriteTime = previousWriteTime;
+      g_warning("%s: Failed to reset %s flag", __FUNCTION__,
+                SERVICE_DISCOVERY_KEY_NAME_READY);
+      goto out;
+   }
+
+   /*
+    * Remove chunks written to DB in the previous iteration
+    */
+   CleanupNamespaceDB(ctx);
+
+   for (i = 0; i < gFullPaths->len; i++) {
+      KeyNameValue tmp = g_array_index(gFullPaths, KeyNameValue, i);
+      if (!PublishScriptOutputToNamespaceDB(ctx, tmp.keyName, tmp.val)) {
+         g_debug("%s: Failed to execute script %s or script output was empty",
+                 __FUNCTION__, tmp.val);
+      }
+   }
+
+   /*
+    * Update ready flag
+    */
+   status = WriteData(ctx, SERVICE_DISCOVERY_KEY_NAME_READY, "TRUE", 4);
+   if (!status) {
+      g_warning("%s: Failed to update ready flag", __FUNCTION__);
+   }
+
+out:
+   gTaskSubmitted = FALSE;
+}
+
+
+/*
+ *****************************************************************************
+ * checkForWrite --
+ *
+ * Performs needed checks to decide if Data should be written to Namespace DB
+ * or not.
+ *
+ * First check - checks if interval related information, stored in Namespace DB
+ * under key "signal" and in format of "interval,timestamp" is outdated or not.
+ *
+ * Second check - checks if time greater than interval read from Namespace DB
+ * has elapsed since the last write operation.
+ *
+ * @param[in] ctx     The application context.
+ *
+ * @retval TRUE  Execute scripts and write service data to Namespace DB.
+ * @retval FALSE Omit this cycle wihtout any script running.
+ *
+ *****************************************************************************
+ */
+
+static Bool
+checkForWrite(ToolsAppCtx *ctx)
+{
+   char *signal = NULL;
+   size_t signalLen = 0;
+   Bool result = FALSE;
+
+   /*
+    * Read signal from Namespace DB
+    */
+   if (!ReadData(ctx, SERVICE_DISCOVERY_KEY_NAME_SIGNAL, &signal, &signalLen)) {
+      g_debug("%s: Failed to read necessary information from Namespace DB\n",
+              __FUNCTION__);
+   } else {
+      gint64 clientTimestamp;
+      int clientInterval;
+      gint64 currentTime;
+
+      if ((signal != NULL) && (strcmp(signal, "")) && signalLen > 0) {
+         char *token1;
+         char *token2;
+         g_debug("%s: signal = %s last write time = %" G_GINT64_FORMAT "\n",
+                 __FUNCTION__, signal, gLastWriteTime);
+         /*
+          * parse signal, it should be in "interval,timestamp" format
+          */
+         token1 = strtok(signal, ",");
+         token2 = strtok(NULL, ",");
+         if (token1 != NULL && token2 != NULL) {
+            currentTime = GetGuestTimeInMillis();
+            clientInterval = (int) g_ascii_strtoll(token1, NULL, 10);
+            clientTimestamp = g_ascii_strtoll(token2, NULL, 10);
+
+            if (clientInterval == 0 || clientTimestamp == 0) {
+               g_warning("%s: Wrong value of interval and timestamp",
+                         __FUNCTION__);
+            } else if ((currentTime - clientTimestamp) < (5 * clientInterval)) {
+               if ((currentTime - gLastWriteTime +
+                   SERVICE_DISCOVERY_WRITE_DELTA) >= clientInterval) {
+                  result = TRUE;
+               }
+            } else {
+               /*
+               * Signal is outdated, reset the last write time
+               */
+               gLastWriteTime = 0;
+            }
+
+            g_debug("%s: result=%s client interval = %d "
+                    "client timestamp =% " G_GINT64_FORMAT
+                    " system time = %" G_GINT64_FORMAT
+                    " previous write time = %" G_GINT64_FORMAT "\n",
+                    __FUNCTION__, result ? "true" : "false", clientInterval,
+                    clientTimestamp, currentTime, gLastWriteTime);
+         } else {
+            g_warning("%s: Wrong value of signal", __FUNCTION__);
+         }
+      } else {
+         g_warning("%s: signal was NULL or empty", __FUNCTION__);
+      }
+   }
+
+   if (signal) {
+      free(signal);
+   }
+
+   return result;
+}
+
+
+/*
+ *****************************************************************************
+ * ServiceDiscoveryThread --
+ *
+ * Creates a new thread that collects all the desired application related
+ * information and updates the Namespace DB.
+ *
+ * @param[in]  data     The application context.
+ *
+ * @return TRUE to indicate that the timer should be rescheduled.
+ *
+ *****************************************************************************
+ */
+
+static Bool
+ServiceDiscoveryThread(gpointer data)
+{
+   ToolsAppCtx *ctx = data;
+
+   /*
+    * First check for taskSubmitted, if it is true automatically omit this
+    * cycle even without checking for write to avoid resetting last write
+    * time.
+    */
+   if (gTaskSubmitted || !checkForWrite(ctx)) {
+      g_debug("%s: Data should not be written taskSubmitted = %s\n",
+              __FUNCTION__, gTaskSubmitted ? "True" : "False");
+   } else {
+      g_debug("%s: Submitting task to write\n", __FUNCTION__);
+      if (!ToolsCorePool_SubmitTask(ctx, ServiceDiscoveryTask, NULL, NULL)) {
+         g_warning("%s: failed to start information gather thread\n",
+                   __FUNCTION__);
+      }
+   }
+
+   return TRUE;
+}
+
+
+/*
+ *****************************************************************************
+ * TweakDiscoveryLoop --
+ *
+ * @brief Start service discovery poll loop.
+ *
+ * @param[in] ctx  The app context.
+ *
+ *****************************************************************************
+ */
+
+static void
+TweakDiscoveryLoop(ToolsAppCtx *ctx)
+{
+   if (gServiceDiscoveryTimeoutSource == NULL) {
+      gServiceDiscoveryTimeoutSource =
+                      g_timeout_source_new(SERVICE_DISCOVERY_POLL_INTERVAL);
+      VMTOOLSAPP_ATTACH_SOURCE(ctx, gServiceDiscoveryTimeoutSource,
+                               ServiceDiscoveryThread, ctx, NULL);
+      g_source_unref(gServiceDiscoveryTimeoutSource);
+   }
+}
+
+
+/*
+******************************************************************************
+* ServiceDiscoveryServerConfReload --
+*
+* @brief Reconfigures the poll loop interval upon config file reload.
+*
+* @param[in]  src     Unused.
+* @param[in]  ctx     The application context.
+* @param[in]  data    Unused.
+*
+******************************************************************************
+*/
+
+static void
+ServiceDiscoveryServerConfReload(gpointer src,
+                                 ToolsAppCtx *ctx,
+                                 gpointer data)
+{
+   gboolean disabled =
+      VMTools_ConfigGetBoolean(ctx->config,
+                               CONFGROUPNAME_SERVICEDISCOVERY,
+                               CONFNAME_SERVICEDISCOVERY_DISABLED,
+                               SERVICE_DISCOVERY_CONF_DEFAULT_DISABLED_VALUE);
+   if (!disabled) {
+      g_info("%s: Service discovery loop started\n", __FUNCTION__);
+      TweakDiscoveryLoop(ctx);
+   } else if (gServiceDiscoveryTimeoutSource != NULL) {
+      gLastWriteTime = 0;
+      g_source_destroy(gServiceDiscoveryTimeoutSource);
+      gServiceDiscoveryTimeoutSource = NULL;
+      g_info("%s: Service discovery loop disabled\n", __FUNCTION__);
+   }
+}
+
+
+/*
+*****************************************************************************
+* ServiceDiscoveryServerShutdown --
+*
+* Cleanup internal data on shutdown.
+*
+* @param[in]  src     The source object.
+* @param[in]  ctx     Unused.
+* @param[in]  data    Unused.
+*
+*****************************************************************************
+*/
+
+static void
+ServiceDiscoveryServerShutdown(gpointer src,
+                               ToolsAppCtx *ctx,
+                               gpointer data)
+{
+   if (gServiceDiscoveryTimeoutSource != NULL) {
+      g_source_destroy(gServiceDiscoveryTimeoutSource);
+      gServiceDiscoveryTimeoutSource = NULL;
+   }
+
+   if (gFullPaths != NULL) {
+      int i = 0;
+      guint len = gFullPaths->len;
+      for (i = 0; i < len; ++i) {
+         g_free(g_array_index(gFullPaths, KeyNameValue, i).keyName);
+         g_free(g_array_index(gFullPaths, KeyNameValue, i).val);
+      }
+      g_array_free(gFullPaths, TRUE);
+   }
+}
+
+
+/*
+*****************************************************************************
+* ConstructScriptPaths --
+*
+* Construct final paths of the scripts that will be used for execution.
+*
+*****************************************************************************
+*/
+
+static void
+ConstructScriptPaths(void)
+{
+   int i;
+   gchar *scriptInstallDir;
+#if !defined(OPEN_VM_TOOLS)
+   gchar *toolsInstallDir;
+#endif
+
+   if (gFullPaths != NULL) {
+      return;
+   }
+
+   gFullPaths = g_array_sized_new(FALSE, TRUE, sizeof(KeyNameValue),
+                                  ARRAYSIZE(gKeyScripts));
+
+#if defined(OPEN_VM_TOOLS)
+   scriptInstallDir = Util_SafeStrdup(VMTOOLS_SERVICE_DISCOVERY_SCRIPTS);
+#else
+   toolsInstallDir = GuestApp_GetInstallPath();
+   scriptInstallDir = g_strdup_printf("%s%s%s%s%s", toolsInstallDir, DIRSEPS,
+                                      "serviceDiscovery", DIRSEPS, "scripts");
+   g_free(toolsInstallDir);
+#endif
+
+   for (i = 0; i < ARRAYSIZE(gKeyScripts); ++i) {
+      KeyNameValue tmp;
+      tmp.keyName = g_strdup_printf("%s", gKeyScripts[i].keyName);
+#if defined(_WIN32)
+      tmp.val = g_strdup_printf("\"%s%s%s\"", scriptInstallDir,
+                                DIRSEPS, gKeyScripts[i].val);
+#else
+      tmp.val = g_strdup_printf("%s%s%s", scriptInstallDir, DIRSEPS,
+                                gKeyScripts[i].val);
+#endif
+      g_array_insert_val(gFullPaths, i, tmp);
+   }
+
+   g_free(scriptInstallDir);
+}
+
+
+/*
+ *****************************************************************************
+ * ToolsOnLoad --
+ *
+ * Plugin entry point. Initializes internal plugin state.
+ *
+ * @param[in]  ctx   The app context.
+ *
+ * @return The registration data.
+ *
+ *****************************************************************************
+ */
+
+TOOLS_MODULE_EXPORT ToolsPluginData *
+ToolsOnLoad(ToolsAppCtx *ctx)
+{
+   static ToolsPluginData regData = {
+      "serviceDiscovery",
+      NULL,
+      NULL
+   };
+
+   uint32 vmxVersion = 0;
+   uint32 vmxType = VMX_TYPE_UNSET;
+
+   /*
+    * 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.
+    */
+   if (!VmCheck_GetVersion(&vmxVersion, &vmxType) ||
+       vmxType != VMX_TYPE_SCALABLE_SERVER) {
+      g_info("%s, VM is not running on ESX host.\n", __FUNCTION__);
+      return NULL;
+   }
+
+   /*
+    * 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;
+   }
+   if (ctx->rpc != NULL) {
+      ToolsPluginSignalCb sigs[] = {
+         { TOOLS_CORE_SIG_SHUTDOWN, ServiceDiscoveryServerShutdown, NULL },
+         { TOOLS_CORE_SIG_CONF_RELOAD, ServiceDiscoveryServerConfReload, NULL }
+      };
+      ToolsAppReg regs[] = {
+         { TOOLS_APP_SIGNALS,
+           VMTools_WrapArray(sigs, sizeof *sigs, ARRAYSIZE(sigs))
+         }
+      };
+      gboolean disabled;
+
+      regData.regs = VMTools_WrapArray(regs,
+                                       sizeof *regs,
+                                       ARRAYSIZE(regs));
+      /*
+       * Append scripts absolute paths based on installation dirs.
+       */
+      ConstructScriptPaths();
+
+      disabled =
+         VMTools_ConfigGetBoolean(ctx->config,
+                                  CONFGROUPNAME_SERVICEDISCOVERY,
+                                  CONFNAME_SERVICEDISCOVERY_DISABLED,
+                                  SERVICE_DISCOVERY_CONF_DEFAULT_DISABLED_VALUE);
+      if (!disabled) {
+         TweakDiscoveryLoop(ctx);
+      }
+
+      return &regData;
+   }
+
+   return NULL;
+}
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/serviceDiscovery.h b/open-vm-tools/services/plugins/serviceDiscovery/serviceDiscovery.h
new file mode 100644 (file)
index 0000000..445c20a
--- /dev/null
@@ -0,0 +1,48 @@
+/*********************************************************
+ * 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 _SERVICEDISCOVERY_H_
+#define _SERVICEDISCOVERY_H_
+
+/**
+ * @file serviceDiscovery.h
+ *
+ * Declares few constants for the serviceDiscovery plugin.
+ */
+
+#define G_LOG_DOMAIN "serviceDiscovery"
+
+#include <stdlib.h>
+
+#include "vm_basic_types.h"
+#include "vmware/tools/plugin.h"
+
+/*
+ * Maximum length of the data (either key or value) written to Namespace DB
+ */
+#define SERVICE_DISCOVERY_VALUE_MAX_SIZE (1024*15)
+
+Bool PublishScriptOutputToNamespaceDB(ToolsAppCtx *ctx,
+                                      const char *key,
+                                      const char *script);
+Bool WriteData(ToolsAppCtx *ctx,
+               const char *key,
+               const char *data,
+               const size_t len);
+
+#endif /* _SERVICEDISCOVERY_H_ */
\ No newline at end of file
diff --git a/open-vm-tools/services/plugins/serviceDiscovery/serviceDiscoveryPosix.c b/open-vm-tools/services/plugins/serviceDiscovery/serviceDiscoveryPosix.c
new file mode 100644 (file)
index 0000000..741b913
--- /dev/null
@@ -0,0 +1,203 @@
+/*********************************************************
+ * 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.
+ *
+ *********************************************************/
+
+/*
+ * serviceDiscoveryPosix.c --
+ *
+ * Captures the information about services inside the guest
+ * and writes it to Namespace DB.
+ */
+
+#ifndef __linux__
+#   error This file should not be compiled.
+#endif
+
+#include "serviceDiscovery.h"
+#include "dynbuf.h"
+
+#include <stdio.h>
+#include <errno.h>
+#include <unistd.h>
+
+/*
+*****************************************************************************
+* ReadFromHandle --
+*
+* Reads from handle and appends to provided buffer. Handle is closed inside the
+* function after read operation.
+*
+* @param[in] h             handle.
+* @param[out] out          output buffer.
+*
+*****************************************************************************
+*/
+
+static void
+ReadFromHandle(gint h,
+               DynBuf* out)
+{
+   FILE* f = fdopen(h, "r");
+
+   if (f == NULL) {
+      g_warning("%s: Failed to create file stream, errno=%d",
+                __FUNCTION__, errno);
+      if (close(h) != 0) {
+         g_warning("%s: Failed to close file handle, errno=%d",
+                   __FUNCTION__, errno);
+      }
+   } else {
+      for (;;) {
+         size_t readBytes;
+         char buf[SERVICE_DISCOVERY_VALUE_MAX_SIZE];
+         readBytes = fread(buf, 1, sizeof(buf), f);
+         g_debug("%s: readBytes = %" G_GSSIZE_FORMAT "\n", __FUNCTION__,
+                 readBytes);
+
+         if (readBytes > 0) {
+            DynBuf_Append(out, buf, readBytes);
+         }
+
+         if (readBytes < sizeof(buf)) {
+            break;
+         }
+      }
+      if (fclose(f) != 0) {
+         g_warning("%s: Failed to close file stream, errno=%d",
+                   __FUNCTION__, errno);
+      }
+   }
+}
+
+
+/*
+ *****************************************************************************
+ * PublishScriptOutputToNamespaceDB --
+ *
+ * Spawns child process for script, reads stdout from pipe, writes
+ * generated chunks to Namespace DB.
+ *
+ * Chunk count will be written to Namespace DB using received
+ * "key" (ie. get-listening-process-info).
+ *
+ * Chunks will be written to Namespace DB with keys constructed by "key-[i]"
+ * template (ie. get-listening-process-info-1, get-listening-process-info-2)
+ *
+ * @param[in] ctx             Application context.
+ * @param[in] key             Key used for chunk count
+ * @param[in] script          Script to be executed
+ *
+ * @retval TRUE  Script execution and Namespace DB write over RPC succeeded.
+ * @retval FALSE Either of script execution or Namespace DB write failed.
+ *
+ *****************************************************************************
+ */
+
+Bool
+PublishScriptOutputToNamespaceDB(ToolsAppCtx *ctx,
+                                 const char *key,
+                                 const char *script)
+{
+   Bool status = FALSE;
+   Bool stdoutIsEmpty = TRUE;
+   GPid pid;
+   gchar *command = g_strdup(script);
+   gchar *cmd[] = { command, NULL };
+   gint child_stdout = -1;
+   gint child_stderr = -1;
+   FILE* child_stdout_f;
+   GError *p_error = NULL;
+   DynBuf err;
+   int i = 0;
+
+   status = g_spawn_async_with_pipes(NULL, cmd, NULL, G_SPAWN_DEFAULT, NULL,
+                                     NULL, &pid, NULL, &child_stdout, &child_stderr,
+                                     &p_error);
+   if (!status) {
+      if (p_error != NULL) {
+         g_warning("%s: Error during script exec %s\n", p_error->message,
+                   __FUNCTION__);
+         g_error_free(p_error);
+      } else {
+         g_warning("%s: Command not run\n", __FUNCTION__);
+      }
+      g_free(command);
+      return status;
+   }
+
+   g_debug("%s: Child process spawned for %s\n", __FUNCTION__, key);
+
+   child_stdout_f = fdopen(child_stdout, "r");
+   if (child_stdout_f == NULL) {
+      g_warning("%s: Failed to create file stream for child stdout, errno=%d",
+                __FUNCTION__, errno);
+      goto out;
+   }
+
+   status = FALSE;
+   for (;;) {
+      char buf[SERVICE_DISCOVERY_VALUE_MAX_SIZE];
+      size_t readBytes = fread(buf, 1, sizeof(buf), child_stdout_f);
+
+      g_debug("%s: readBytes = %" G_GSSIZE_FORMAT "\n", __FUNCTION__, readBytes);
+
+      if (readBytes > 0) {
+         stdoutIsEmpty = FALSE;
+         gchar* msg = g_strdup_printf("%s-%d", key, ++i);
+         status = WriteData(ctx, msg, buf, readBytes);
+         g_free(msg);
+      }
+
+      if (!status || readBytes < sizeof(buf)) {
+         break;
+      }
+   }
+
+   if (status) {
+      gchar *chunkCount = g_strdup_printf("%d", i);
+      status = WriteData(ctx, key, chunkCount, strlen(chunkCount));
+      g_debug("%s: Written key %s chunks %s\n", __FUNCTION__, key, chunkCount);
+      g_free(chunkCount);
+   } else if (!stdoutIsEmpty) {
+      g_warning("%s: Was not able to capture or store data\n", __FUNCTION__);
+   }
+
+   DynBuf_Init(&err);
+   ReadFromHandle(child_stderr, &err);
+   child_stderr = -1;
+   if (DynBuf_GetSize(&err) != 0) {
+      DynBuf_AppendString(&err, "");
+      g_debug("%s: stderr=%s\n", __FUNCTION__, (const char *) DynBuf_Get(&err));
+   }
+   DynBuf_Destroy(&err);
+out:
+   g_free(command);
+   if (child_stdout_f != NULL) {
+      if (fclose(child_stdout_f) != 0) {
+         g_warning("%s: Failed to close child stdout file stream, errno=%d",
+                   __FUNCTION__, errno);
+      }
+   } else if (child_stdout != -1 && close(child_stdout) != 0) {
+      g_warning("%s: Failed to close child stdout handle, errno=%d",
+                __FUNCTION__, errno);
+   }
+   if (child_stderr != -1 && close(child_stderr) != 0) {
+      g_warning("%s: Failed to close child process stderr handle, errno=%d",
+                __FUNCTION__, errno);
+   }
+   return status;
+}
\ No newline at end of file