]> git.ipfire.org Git - thirdparty/open-vm-tools.git/commitdiff
Adding the libappmonitor source to the open-vm-tools distribution.
authorOliver Kurth <okurth@vmware.com>
Fri, 9 Nov 2018 22:59:39 +0000 (14:59 -0800)
committerOliver Kurth <okurth@vmware.com>
Fri, 9 Nov 2018 22:59:39 +0000 (14:59 -0800)
In response to customer requests that the libappmonitor library from
the VMwares Guest SDK be opensourced, the libappmonitor code has been
bundled in open-vm-tools.

open-vm-tools/Makefile.am
open-vm-tools/configure.ac
open-vm-tools/lib/include/vmGuestAppMonitorLib.h [new file with mode: 0644]
open-vm-tools/lib/rpcChannel/glib_stubs.c [new file with mode: 0644]
open-vm-tools/libappmonitor/COPYING [new file with mode: 0644]
open-vm-tools/libappmonitor/Makefile.am [new file with mode: 0644]
open-vm-tools/libappmonitor/appmonitor.pc.in [new file with mode: 0644]
open-vm-tools/libappmonitor/stub-debug.c [new file with mode: 0644]
open-vm-tools/libappmonitor/vmGuestAppMonitorLib.c [new file with mode: 0644]
open-vm-tools/libappmonitor/vmGuestAppMonitorLibInt.h [new file with mode: 0644]
open-vm-tools/libappmonitor/vmguestappmonitorlib_version.h [new file with mode: 0644]

index 893b224decfbcd390a833d2c7c3d1c1ae9a5c92d..5922981b80214c9997f27ae3c055115bddb27435 100644 (file)
@@ -1,5 +1,5 @@
 ################################################################################
-### Copyright (C) 2007-2016 VMware, Inc.  All rights reserved.
+### Copyright (C) 2007-2016,2018 VMware, Inc.  All rights reserved.
 ###
 ### Top-level Makefile for building the VMware OSS Tools.
 ###
@@ -64,7 +64,9 @@ if WITH_KERNEL_MODULES
    SUBDIRS += modules
 endif
 SUBDIRS += docs
-
+if ENABLE_LIBAPPMONITOR
+   SUBDIRS += libappmonitor
+endif
 
 if HAVE_UDEV
    SUBDIRS += udev
index 6b13e578a2ae7b6ac6555f3ccfe3c10f0eabceb7..eb250eaa5b4e9dbc973eecbddd045ec305f6a633 100644 (file)
@@ -406,6 +406,14 @@ if test "$enable_deploypkg" = "yes"; then
                    [AC_MSG_ERROR([mspack >= 0.0.20040308alpha is required.])])
 fi
 
+AC_ARG_ENABLE([libappmonitor],
+   [AS_HELP_STRING([--enable-libappmonitor],
+     [Build the libappmonitor library.])],
+   [],
+   [
+    enable_libappmonitor=no
+   ])
+
 AC_ARG_ENABLE([grabbitmqproxy],
    [AS_HELP_STRING([--disable-grabbitmqproxy],
      [do not build grabbitmqproxy plugin.])],
@@ -1431,6 +1439,7 @@ AM_CONDITIONAL(HAVE_MKDTEMP, test "$have_mkdtemp" = "yes")
 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")
 
 if test "$have_xsm" != "yes"; then
 AC_DEFINE([NO_XSM], 1, [])
@@ -1636,6 +1645,8 @@ AC_CONFIG_FILES([                      \
    scripts/Makefile                    \
    scripts/build/rpcgen_wrapper.sh     \
    udev/Makefile                       \
+   libappmonitor/Makefile              \
+   libappmonitor/appmonitor.pc         \
 ])
 
 ###
diff --git a/open-vm-tools/lib/include/vmGuestAppMonitorLib.h b/open-vm-tools/lib/include/vmGuestAppMonitorLib.h
new file mode 100644 (file)
index 0000000..26f813b
--- /dev/null
@@ -0,0 +1,187 @@
+/*********************************************************
+ * Copyright (C) 2009-2016 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.
+ *
+ *********************************************************/
+
+/**
+ * @file vmGuestAppMonitorLib.h
+ *
+ * This is the VMware Guest Application Monitor Lib,
+ * an API used to communicate the health of one or more applications
+ * running in a virtual machine to VMware infrastructure.
+ *
+ * @defgroup VMGuestAppMonitor
+ *
+ * @brief VMGuestAppMonitorLib A collection of routines used in the guest
+ *                             by an application monitoring agent to
+ *                             indicate the liveness of a monitored set of
+ *                             applications.
+ *
+ *  @code
+ *  VMGuestAppMonitor_Enable();
+ *
+ *  -- Call at least every 30 seconds
+ *  VMGuestAppMonitor_MarkActive();
+ *
+ *  -- When finished monitoring
+ *  VMGuestAppMonitor_Disable();
+ *  @endcode
+ *
+ *  To signal an application failure, simply do not call
+ *  VMGuestAppMonitor_MarkActive().
+ *
+ *  @endcode
+ *
+ *  @addtogroup VMGuestAppMonitor
+ * @{
+ */
+
+#ifndef _VM_GUEST_APP_MONITOR_LIB_H_
+#define _VM_GUEST_APP_MONITOR_LIB_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * VMGuestAppMonitorLib error codes.
+ */
+
+typedef enum {
+   VMGUESTAPPMONITORLIB_ERROR_SUCCESS      = 0,  /**< No error. */
+   VMGUESTAPPMONITORLIB_ERROR_OTHER,             /**< Other error */
+   VMGUESTAPPMONITORLIB_ERROR_NOT_RUNNING_IN_VM, /**< Not running in a VM */
+   VMGUESTAPPMONITORLIB_ERROR_NOT_ENABLED,       /**< Monitoring is not enabled */
+   VMGUESTAPPMONITORLIB_ERROR_NOT_SUPPORTED,     /**< Monitoring is not supported */
+} VMGuestAppMonitorLibError;
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_Enable --                                          */ /**
+ *
+ * Enable application monitoring. After this call, the agent must
+ * call VMGuestAppMonitor_MarkActive() at least once every 30
+ * seconds or the application will be viewed as having failed.
+ *
+ * @return VMGUESTAPPMONITORLIB_ERROR_SUCCESS if monitoring has been enabled.
+ *
+ ******************************************************************************
+ */
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_Enable(void);
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_Disable --                                         */ /**
+ *
+ * Disable application monitoring.
+ *
+ * @return  TRUE if monitoring has been disabled.
+ *
+ ******************************************************************************
+ */
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_Disable(void);
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_IsEnabled --                                       */ /**
+ *
+ * Return the current state of application monitoring.
+ *
+ * @return  1 (TRUE) if monitoring is enabled.
+ *
+ ******************************************************************************
+ */
+
+int
+VMGuestAppMonitor_IsEnabled(void);
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_MarkActive --                                      */ /**
+ *
+ * Marks the application as active. This function needs to be called
+ * at least once every 30 seconds while application monitoring is
+ * enabled or HA will determine that the application has failed.
+ *
+ * @return  VMGUESTAPPMONITORLIB_ERROR_SUCCESS if successful and
+ *          VMGUESTAPPMONITORLIB_ERROR_NOT_ENABLED if monitoring is not enabled.
+ *
+ ******************************************************************************
+ */
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_MarkActive(void);
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_GetAppStatus --                                    */ /**
+ *
+ * Return the current status recorded for the application.
+ *
+ * @return  the application status. The caller must free the result.
+ *
+ ******************************************************************************
+ */
+
+char *
+VMGuestAppMonitor_GetAppStatus(void);
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_PostAppState --                                    */ /**
+ *
+ * Post application state.
+ *
+ * @return  VMGUESTAPPMONITORLIB_ERROR_SUCCESS if successful
+ *
+ ******************************************************************************
+ */
+
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_PostAppState(const char *state);
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_Free --                                            */ /**
+ *
+ * Free the result of VMGuestAppMonitor_GetAppStatus.
+ *
+ * @param[in] str  Pointer to the memory to be freed.
+ *
+ ******************************************************************************
+ */
+
+void
+VMGuestAppMonitor_Free(char *str);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _VM_GUEST_APP_MONITOR_LIB_H_ */
+
+/** @} */
diff --git a/open-vm-tools/lib/rpcChannel/glib_stubs.c b/open-vm-tools/lib/rpcChannel/glib_stubs.c
new file mode 100644 (file)
index 0000000..5a7db56
--- /dev/null
@@ -0,0 +1,45 @@
+/*********************************************************
+ * Copyright (C) 2018 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.
+ *
+ *********************************************************/
+
+/**
+ * @file glib_stubs.c
+ *
+ *    rpcChannel uses glib. If anyone wants to build rpcChannel without
+ *    having any dependency on glib, we need to use this stubs file.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <glib.h>
+
+#include "util.h"
+
+#if !defined(USE_RPCI_ONLY)
+#error "This file should be compiled for RPCI-only channel!"
+#endif
+
+void *g_malloc0(size_t s) { return Util_SafeCalloc(1, s); }
+void *g_malloc0_n(size_t n, size_t s) { return Util_SafeCalloc(n, s); }
+void g_free(void *p) { free(p); }
+
+GMutex* g_static_mutex_get_mutex_impl(GStaticMutex *mutex) { return NULL; }
+
+void g_static_mutex_free(GStaticMutex *mutex) { }
+void g_static_mutex_init(GStaticMutex *mutex) { }
+void g_mutex_lock(GMutex *mutex) { }
+void g_mutex_unlock(GMutex *mutex) { }
diff --git a/open-vm-tools/libappmonitor/COPYING b/open-vm-tools/libappmonitor/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/libappmonitor/Makefile.am b/open-vm-tools/libappmonitor/Makefile.am
new file mode 100644 (file)
index 0000000..2681eb7
--- /dev/null
@@ -0,0 +1,74 @@
+################################################################################
+### Copyright (C) 2018 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
+################################################################################
+
+lib_LTLIBRARIES = libappmonitor.la
+
+AM_CFLAGS =
+AM_CFLAGS += -I$(top_srcdir)/lib/include
+
+libappmonitor_la_LIBADD =
+libappmonitor_la_LIBADD += ../lib/backdoor/libBackdoor.la
+libappmonitor_la_LIBADD += ../lib/dataMap/libDataMap.la
+libappmonitor_la_LIBADD += ../lib/err/libErr.la
+libappmonitor_la_LIBADD += ../lib/hashMap/libHashMap.la
+libappmonitor_la_LIBADD += ../lib/message/libMessage.la
+libappmonitor_la_LIBADD += ../lib/misc/libMisc.la
+libappmonitor_la_LIBADD += ../lib/rpcOut/libRpcOut.la
+libappmonitor_la_LIBADD += ../lib/string/libString.la
+libappmonitor_la_LIBADD += ../lib/unicode/libUnicode.la
+libappmonitor_la_LIBADD += ../lib/vmCheck/libVmCheck.la
+libappmonitor_la_LIBADD += ../lib/vmSignal/libVmSignal.la
+libappmonitor_la_LIBADD += @ICU_LIBS@
+
+libappmonitor_rpcchanneldir = $(top_srcdir)/lib/rpcChannel
+
+libappmonitor_la_SOURCES =
+libappmonitor_la_SOURCES += vmGuestAppMonitorLib.c
+libappmonitor_la_SOURCES += stub-debug.c
+libappmonitor_la_SOURCES += $(top_srcdir)/lib/stubs/stub-panic.c
+libappmonitor_la_SOURCES += $(libappmonitor_rpcchanneldir)/bdoorChannel.c
+libappmonitor_la_SOURCES += $(libappmonitor_rpcchanneldir)/rpcChannel.c
+libappmonitor_la_SOURCES += $(libappmonitor_rpcchanneldir)/glib_stubs.c
+if HAVE_VSOCK
+libappmonitor_la_SOURCES += $(libappmonitor_rpcchanneldir)/vsockChannel.c
+libappmonitor_la_SOURCES += $(libappmonitor_rpcchanneldir)/simpleSocket.c
+endif
+
+libappmonitor_la_LDFLAGS =
+libappmonitor_la_LDFLAGS += -Wl,-ldl
+libappmonitor_la_LDFLAGS += -Wl,-lrt
+# We require GCC, so we're fine passing compiler-specific flags.
+# Needed for OS's that don't link shared libraries against libc by default, e.g. FreeBSD
+libappmonitor_la_LDFLAGS += -Wl,-lc
+
+libappmonitor_includedir = $(includedir)/libappmonitor
+
+libappmonitor_include_HEADERS =
+libappmonitor_include_HEADERS += $(top_srcdir)/lib/include/vmGuestAppMonitorLib.h
+
+libappmonitor_la_CPPFLAGS =
+libappmonitor_la_CPPFLAGS += -DVMTOOLS_USE_GLIB
+libappmonitor_la_CPPFLAGS += -DUSE_RPCI_ONLY
+libappmonitor_la_CPPFLAGS += @GLIB2_CPPFLAGS@
+
+EXTRA_DIST = appmonitor.pc.in
+
+pkgconfigdir   = $(libdir)/pkgconfig
+pkgconfig_DATA = appmonitor.pc
+
+$(pkgconfig_DATA): $(top_builddir)/config.status
+
diff --git a/open-vm-tools/libappmonitor/appmonitor.pc.in b/open-vm-tools/libappmonitor/appmonitor.pc.in
new file mode 100644 (file)
index 0000000..dc217f9
--- /dev/null
@@ -0,0 +1,13 @@
+# VMware AppMonitorLib pkgconfig data.
+
+prefix=@prefix@
+exec_prefix=@exec_prefix@
+libdir=@libdir@
+includedir=@includedir@
+
+Name:          VMware AppMonitorLib
+Description:   Library for guest app agents to communicate with vSphere HA about the guest app's liveness
+Version:       @VERSION@
+Libs:          -L${libdir} -lappmonitor
+Cflags:        -I${includedir}/libappmonitor
+
diff --git a/open-vm-tools/libappmonitor/stub-debug.c b/open-vm-tools/libappmonitor/stub-debug.c
new file mode 100644 (file)
index 0000000..27c232e
--- /dev/null
@@ -0,0 +1,67 @@
+/*********************************************************
+ * Copyright (C) 2013 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.
+ *
+ *********************************************************/
+
+/*
+ * stub-debug.c --
+ *
+ *   Stub for Debug().
+ *
+ */
+
+#include <stdio.h>
+#include "str.h"
+
+
+void
+Debug(const char *fmt, ...)
+{
+#ifdef VMX86_LOG /* only do logging on OBJ builds */
+   va_list args;
+
+   va_start(args, fmt);
+   vfprintf(stderr, fmt, args);
+   va_end(args);
+#endif
+}
+
+
+void
+Log(const char *fmt, ...)
+{
+#ifdef VMX86_LOG /* only do logging on OBJ builds */
+   va_list args;
+
+   va_start(args, fmt);
+   vfprintf(stderr, fmt, args);
+   va_end(args);
+#endif
+}
+
+
+void
+Warning(const char *fmt, ...)
+{
+#ifdef VMX86_LOG /* only do logging on OBJ builds */
+   va_list args;
+
+   va_start(args, fmt);
+   vfprintf(stderr, fmt, args);
+   va_end(args);
+#endif
+}
+
diff --git a/open-vm-tools/libappmonitor/vmGuestAppMonitorLib.c b/open-vm-tools/libappmonitor/vmGuestAppMonitorLib.c
new file mode 100644 (file)
index 0000000..74a0506
--- /dev/null
@@ -0,0 +1,462 @@
+/*********************************************************
+ * Copyright (C) 2009-2018 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.
+ *
+ *********************************************************/
+
+/**
+ * @file vmGuestAppMonitorLib.c
+ *
+ * @brief  This file contains the functions used by an application monitoring
+ *         agent to communicate to HA via VMX that the application(s) that it
+ *         is monitoring is alive. The general flow is as follows:
+ *
+ *  @code
+ *  VMGuestAppMonitor_Enable();
+ *
+ *  -- Call at least every 30 seconds
+ *  VMGuestAppMonitor_MarkActive();
+ *
+ *  -- When finished monitoring
+ *  VMGuestAppMonitor_Disable();
+ *  @endcode
+ *
+ *  To signal an application failure, simply do not call
+ *  VMGuestAppMonitor_MarkActive().
+ *
+ *  @endcode
+ *
+ *  @addtogroup VMGuestAppMonitor
+ *  @{
+ *
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "vmware.h"
+#include "str.h"
+#include "util.h"
+#include "vmGuestAppMonitorLib.h"
+#include "vmGuestAppMonitorLibInt.h"
+#include "rpcout.h"
+#include "vmcheck.h"
+#include "debug.h"
+#include "vmguestappmonitorlib_version.h"
+#include "vm_version.h"
+#include "embed_version.h"
+#include "vmware/tools/guestrpc.h"
+
+VM_EMBED_VERSION(VMGUESTAPPMONITORLIB_VERSION_STRING);
+
+/**
+ * @cond INTERNAL
+ * @{
+ */
+
+static VMGuestAppMonitorLibError
+RunGuestAppMonitorCmd(const char *cmd);
+
+static VMGuestAppMonitorLibError
+RunGuestAppMonitorCmdWithResult(const char *cmd,
+                                char **result);
+
+static Bool
+CreateSecRpcChannel();
+
+static void
+DestroySecRpcChannel();
+
+static void
+DestroyChannel();
+
+#if defined(VMX86_DEBUG) && defined(linux)
+static void
+LogChannelType(const char *filePath, const char *chanType);
+#endif
+
+static RpcChannel *gChan = NULL;
+
+static Bool isHeartbeatingOnly = FALSE;
+
+/**
+ * @}
+ * @endcond
+ */
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_Enable --
+ ******************************************************************************
+ */
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_Enable(void)
+{
+   VMGuestAppMonitorLibError rc;
+   isHeartbeatingOnly = TRUE;
+   rc = RunGuestAppMonitorCmd(VMGUESTAPPMONITOR_BD_CMD_ENABLE);
+   return rc;
+}
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_Disable --
+ ******************************************************************************
+ */
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_Disable(void)
+{
+   VMGuestAppMonitorLibError rc;
+   rc = RunGuestAppMonitorCmd(VMGUESTAPPMONITOR_BD_CMD_DISABLE);
+   if (rc == VMGUESTAPPMONITORLIB_ERROR_SUCCESS) {
+      DestroySecRpcChannel();
+      gChan = NULL;
+      Debug("Destroyed the secure rpc channel.\n");
+      isHeartbeatingOnly = FALSE;
+   }
+   return rc;
+}
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_IsEnabled --
+ ******************************************************************************
+ */
+
+int
+VMGuestAppMonitor_IsEnabled(void)
+{
+   VMGuestAppMonitorLibError rc;
+   char *status = NULL;
+
+   rc = RunGuestAppMonitorCmdWithResult(VMGUESTAPPMONITOR_BD_CMD_IS_ENABLED,
+                                        &status);
+
+   if (rc == VMGUESTAPPMONITORLIB_ERROR_SUCCESS && status != NULL) {
+      Bool isEnabled = Str_Strncmp(status, "true", sizeof("true")) == 0;
+
+      free(status);
+      return isEnabled;
+   } else {
+      return FALSE;
+   }
+}
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_MarkActive --
+ ******************************************************************************
+ */
+
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_MarkActive(void)
+{
+   return RunGuestAppMonitorCmd(VMGUESTAPPMONITOR_BD_CMD_MARK_ACTIVE);
+}
+
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_GetAppStatus --
+ ******************************************************************************
+ */
+
+char *
+VMGuestAppMonitor_GetAppStatus(void)
+{
+   VMGuestAppMonitorLibError rc;
+   char *status = NULL;
+
+   rc = RunGuestAppMonitorCmdWithResult(VMGUESTAPPMONITOR_BD_CMD_GET_APP_STATUS,
+                                        &status);
+
+   return status;
+}
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_PostAppState --
+ ******************************************************************************
+ */
+VMGuestAppMonitorLibError
+VMGuestAppMonitor_PostAppState(const char *state)
+{
+   char *cmd = Str_Asprintf(NULL, "%s %s",
+                            VMGUESTAPPMONITOR_BD_CMD_POST_APP_STATE,
+                            state);
+   VMGuestAppMonitorLibError rc;
+
+   rc = RunGuestAppMonitorCmd(cmd);
+   free(cmd);
+
+   return rc;
+}
+
+/*
+ ******************************************************************************
+ * VMGuestAppMonitor_Free --                                            */ /**
+ ******************************************************************************
+ */
+
+void
+VMGuestAppMonitor_Free(char *str)
+{
+   if (str != NULL) {
+      free(str);
+   }
+}
+
+/*
+ ******************************************************************************
+ * DestroyChannel --                                             */ /**
+ *
+ * Destroy the channel if conditions are met.
+ * Do not destroy the channel otherwise.
+ *
+ ******************************************************************************
+ */
+static void
+DestroyChannel()
+{
+   Bool isBackdoorChannel;
+  /*
+   * Destroying the channel here if a client is using anything other
+   * than markActive. Channels using markActive need to be persisted
+   * since we want to prevent any false VM resets triggered by a client
+   * not being able to post heartbeats because it was not able to
+   * acquire a channel. We also close and destroy all backdoor channels
+   * irrespective of whether they are being used for markActive or not.
+   */
+   isBackdoorChannel = (RpcChannel_GetType(gChan) == RPCCHANNEL_TYPE_BKDOOR);
+   Debug("isBackdoorChannel is set to %d.\n", isBackdoorChannel);
+   Debug("isHeartbeatingOnly is set to %d.\n", isHeartbeatingOnly);
+   if(!isHeartbeatingOnly || isBackdoorChannel) {
+      DestroySecRpcChannel();
+      gChan = NULL;
+      Debug("Destroyed the secure rpc channel.\n");
+   }
+}
+
+/*
+ ******************************************************************************
+ * CreateSecRpcChannel --                                             */ /**
+ *
+ * Create a new secure RpcChannel if not already created.
+ *
+ * @return  TRUE if successful or FALSE otherwise.
+ *
+ ******************************************************************************
+ */
+static Bool
+CreateSecRpcChannel()
+{
+   Bool start;
+   if(gChan == NULL) {
+      Debug("VMGuestAppMonitor: Creating a new Secure Rpc channel.\n");
+      gChan = RpcChannel_New();
+      start = RpcChannel_Start(gChan);
+      /*
+       * Logging the channel type so we can verify the same via the
+       * VMAppmon unit tests. Changing this log message/file path
+       * will break the unit tests.
+       */
+      #if defined(VMX86_DEBUG) && defined(linux)
+      LogChannelType("/tmp/chanType.txt", (RpcChannel_GetType(gChan) == RPCCHANNEL_TYPE_BKDOOR ? "BACKDOOR" : "VSOCK"));
+      #endif
+      return start;
+   }
+   else {
+      Debug("VMGuestAppMonitor: Secure Rpc channel already present.\n");
+      return TRUE;
+   }
+}
+
+/*
+ ******************************************************************************
+ * DestroySecRpcChannel --                                               */ /**
+ *
+ * Destroy a secure RpcChannel only if it has been created.
+ *
+ ******************************************************************************
+ */
+static void
+DestroySecRpcChannel()
+{
+   if(gChan != NULL) {
+      RpcChannel_Destroy(gChan);
+   }
+}
+
+#if defined(VMX86_DEBUG) && defined(linux)
+/*
+ ******************************************************************************
+ * LogChannelType --                                               */ /**
+ *
+ * Open a file on linux and log the channel type.
+ *
+ ******************************************************************************
+ */
+static void
+LogChannelType(const char *filePath, const char *chanType)
+{
+   FILE *fp = fopen(filePath, "wb");
+   if (fp != NULL)
+   {
+      fputs(chanType, fp);
+      fclose(fp);
+   }
+}
+#endif
+
+/*
+ ******************************************************************************
+ * RunGuestAppMonitorCmd --                                             */ /**
+ *
+ * Execute a Guest App Monitoring RPC.
+ *
+ * @param[in]  cmd     The RPC command.
+ *
+ * @return  VMGUESTAPPMONITORLIB_ERROR_SUCCESS if successful or
+ *          the error code otherwise.
+ *
+ ******************************************************************************
+ */
+static VMGuestAppMonitorLibError
+RunGuestAppMonitorCmd(const char *cmd)
+{
+   char *reply = NULL;
+   size_t replyLen;
+   VMGuestAppMonitorLibError rc;
+
+   ASSERT(cmd != NULL);
+
+   if (!VmCheck_IsVirtualWorld()) {
+      Debug("VMGuestAppMonitor: Not running in a VM.\n");
+      return VMGUESTAPPMONITORLIB_ERROR_NOT_RUNNING_IN_VM;
+   }
+
+   //Init channel here if not already init
+   if (!CreateSecRpcChannel()) {
+      Debug("Error starting the Rpc Channel\n");
+      return VMGUESTAPPMONITORLIB_ERROR_NOT_ENABLED;
+   }
+   Debug("VMGuestAppMonitor: Sending via secure Rpc channel.\n");
+   if (!RpcChannel_Send(gChan, cmd, strlen(cmd), &reply, &replyLen)) {
+      Debug("Failed to run %s command: %s\n", cmd, reply ? reply : "NULL");
+
+      if (Str_Strncmp(reply, "Unknown command",
+                      sizeof "Unknown command") == 0) {
+         /* Host does not support application monitoring */
+         rc = VMGUESTAPPMONITORLIB_ERROR_NOT_SUPPORTED;
+      } else {
+         rc = VMGUESTAPPMONITORLIB_ERROR_OTHER;
+      }
+   } else {
+      if (Str_Strncmp(reply, VMGUESTAPPMONITOR_BD_RC_OK,
+                      sizeof VMGUESTAPPMONITOR_BD_RC_OK) == 0) {
+         rc = VMGUESTAPPMONITORLIB_ERROR_SUCCESS;
+      } else {
+         rc = VMGUESTAPPMONITORLIB_ERROR_OTHER;
+      }
+   }
+
+   if (reply) {
+      free(reply);
+   }
+
+   DestroyChannel();
+
+   return rc;
+}
+
+
+/*
+ ******************************************************************************
+ * RunGuestAppMonitorCmdWithResult --                                   */ /**
+ *
+ * Execute a Guest App Monitoring RPC and return the command's result.
+ *
+ * @param[in]   cmd     The RPC command.
+ * @param[out]  result  The result returned by the command or NULL if an
+ *                      error occurred..
+ *
+ * @return  VMGUESTAPPMONITORLIB_ERROR_SUCCESS if successful or
+ *          the error code otherwise.
+ *
+ ******************************************************************************
+ */
+
+static VMGuestAppMonitorLibError
+RunGuestAppMonitorCmdWithResult(const char *cmd,
+                                char **result)
+{
+   char *reply = NULL;
+   size_t replyLen;
+   VMGuestAppMonitorLibError rc;
+
+   ASSERT(cmd != NULL);
+   ASSERT(result != NULL);
+
+   if (!VmCheck_IsVirtualWorld()) {
+      Debug("VMGuestAppMonitor: Not running in a VM.\n");
+      return VMGUESTAPPMONITORLIB_ERROR_NOT_RUNNING_IN_VM;
+   }
+
+   //Init channel here if not already init
+   if (!CreateSecRpcChannel()) {
+      Debug("Error starting the Rpc Channel\n");
+      return VMGUESTAPPMONITORLIB_ERROR_NOT_ENABLED;
+   }
+   Debug("VMGuestAppMonitor: Sending via secure Rpc channel.\n");
+   if (!RpcChannel_Send(gChan, cmd, strlen(cmd), &reply, &replyLen)) {
+      Debug("Failed to run %s command: %s\n", cmd,  reply ? reply : "NULL");
+
+      if (Str_Strncmp(reply, "Unknown command",
+                      sizeof "Unknown command") == 0) {
+         /* Host does not support application monitoring */
+         rc = VMGUESTAPPMONITORLIB_ERROR_NOT_SUPPORTED;
+      } else {
+         rc = VMGUESTAPPMONITORLIB_ERROR_OTHER;
+      }
+   } else {
+      Debug("Ran %s command, Reply is %s\n", cmd, reply ? reply : "NULL");
+      rc = VMGUESTAPPMONITORLIB_ERROR_SUCCESS;
+      if (replyLen > 0) {
+         *result = Util_SafeMalloc(replyLen + 1);
+         Str_Strcpy(*result, reply, replyLen + 1);
+      } else {
+         *result = NULL;
+      }
+   }
+
+   if (reply) {
+      free(reply);
+   }
+
+   DestroyChannel();
+
+   return rc;
+}
+
+
+/**
+ * @}
+ */
diff --git a/open-vm-tools/libappmonitor/vmGuestAppMonitorLibInt.h b/open-vm-tools/libappmonitor/vmGuestAppMonitorLibInt.h
new file mode 100644 (file)
index 0000000..0441008
--- /dev/null
@@ -0,0 +1,56 @@
+/*********************************************************
+ * Copyright (C) 2009-2016,2018 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 _VM_GUEST_APP_MONITOR_LIB_INT_H_
+#define _VM_GUEST_APP_MONITOR_LIB_INT_H_
+
+#define INCLUDE_ALLOW_USERLEVEL
+#include "includeCheck.h"
+
+#include "vmware.h"
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+/*
+ * Backdoor command
+ */
+
+#define VMGUESTAPPMONITOR_BD_CMD_ENABLE "GuestAppMonitor.Cmd.Enable"
+#define VMGUESTAPPMONITOR_BD_CMD_DISABLE "GuestAppMonitor.Cmd.Disable"
+#define VMGUESTAPPMONITOR_BD_CMD_IS_ENABLED "GuestAppMonitor.Cmd.IsEnabled"
+#define VMGUESTAPPMONITOR_BD_CMD_MARK_ACTIVE "GuestAppMonitor.Cmd.MarkActive"
+#define VMGUESTAPPMONITOR_BD_CMD_GET_APP_STATUS \
+   "GuestAppMonitor.Cmd.GetAppStatus"
+#define VMGUESTAPPMONITOR_BD_CMD_POST_APP_STATE \
+   "GuestAppMonitor.Cmd.PostAppState"
+
+
+#define VMGUESTAPPMONITOR_BD_RC_OK "0"
+#define VMGUESTAPPMONITOR_BD_RC_INTERNAL_ERROR "1"
+#define VMGUESTAPPMONITOR_BD_RC_NOT_ENABLED "2"
+#define VMGUESTAPPMONITOR_BD_RC_ARGUMENT_EXPECTED "3"
+#define VMGUESTAPPMONITOR_BD_RC_NULL_ARGUMENT "4"
+#define VMGUESTAPPMONITOR_BD_RC_BAD_ARGUMENT "5"
+
+#if defined(__cplusplus)
+}  // extern "C"
+#endif
+
+#endif /* _VM_GUEST_APP_MONITOR_LIB_INT_H_ */
diff --git a/open-vm-tools/libappmonitor/vmguestappmonitorlib_version.h b/open-vm-tools/libappmonitor/vmguestappmonitorlib_version.h
new file mode 100644 (file)
index 0000000..14d4044
--- /dev/null
@@ -0,0 +1,35 @@
+/*********************************************************
+ * Copyright (C) 2009 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.
+ *
+ *********************************************************/
+
+/*
+ * vmguestappmonitorlib_version.h --
+ *
+ * Version definitions for VMGuestAppMonitorLib.
+ */
+
+#ifndef _VMGUESTAPPMONITORLIB_VERSION_H_
+#define _VMGUESTAPPMONITORLIB_VERSION_H_
+
+/*
+ * This component's version is manually versioned.
+ */
+
+#define VMGUESTAPPMONITORLIB_VERSION_COMMAS   2,0,0
+#define VMGUESTAPPMONITORLIB_VERSION_STRING   "2.0.0"
+
+#endif /* _VMGUESTAPPMONITORLIB_VERSION_H_ */