open-vm-tools 10.1.5

plugin.h
Go to the documentation of this file.
1 /*********************************************************
2 * Copyright (C) 2008-2016 VMware, Inc. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation version 2.1 and no later version.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
10 * or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public
11 * License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
16 *
17 *********************************************************/
18
19 #ifndef _VMWARE_TOOLS_PLUGIN_H_
20 #define _VMWARE_TOOLS_PLUGIN_H_
21
32 #include <glib.h>
33 #if defined(G_PLATFORM_WIN32)
34 # include <windows.h>
35 # include <objbase.h>
36 #endif
37 #include "vmware/guestrpc/capabilities.h"
38 #include "vmware/tools/guestrpc.h"
39 #include "vmware/tools/utils.h"
40
49 #define VMTOOLSAPP_ERROR(ctx, err) do { \
50 ASSERT((err) != 0); \
51 (ctx)->errorCode = (err); \
52 g_main_loop_quit((ctx)->mainLoop); \
53 } while (0)
54
55
65 #define VMTOOLSAPP_ATTACH_SOURCE(ctx, src, cb, data, destroy) do { \
66 GSource *__src = (src); \
67 g_source_set_callback(__src, (GSourceFunc) (cb), (data), (destroy)); \
68 g_source_attach(__src, g_main_loop_get_context((ctx)->mainLoop)); \
69 } while (0)
70
75 #define TOOLS_IS_MAIN_SERVICE(ctx) (strcmp((ctx)->name, \
76 VMTOOLS_GUEST_SERVICE) == 0)
77
82 #define TOOLS_IS_USER_SERVICE(ctx) (strcmp((ctx)->name, \
83 VMTOOLS_USER_SERVICE) == 0)
84
85 /* Indentation levels for the state log function below. */
86 #define TOOLS_STATE_LOG_ROOT 0
87 #define TOOLS_STATE_LOG_CONTAINER 1
88 #define TOOLS_STATE_LOG_PLUGIN 2
89
100 static inline void
101 ToolsCore_LogState(guint level,
102 const char *fmt,
103 ...)
104 {
105 gchar *indented = g_strdup_printf("%*s%s", 3 * level, "", fmt);
106
107 va_list args;
108 va_start(args, fmt);
109 g_logv("state", G_LOG_LEVEL_INFO, indented, args);
110 va_end(args);
111
112 g_free(indented);
113 }
114
115
127 #define TOOLS_CORE_SIG_CAPABILITIES "tcs_capabilities"
128
136 #define TOOLS_CORE_SIG_CONF_RELOAD "tcs_conf_reload"
137
147 #define TOOLS_CORE_SIG_DUMP_STATE "tcs_dump_state"
148
156 #define TOOLS_CORE_SIG_RESET "tcs_reset"
157
170 #define TOOLS_CORE_SIG_SET_OPTION "tcs_set_option"
171
179 #define TOOLS_CORE_SIG_SHUTDOWN "tcs_shutdown"
180
181 #if defined(G_PLATFORM_WIN32)
182
209 #define TOOLS_CORE_SIG_SERVICE_CONTROL "tcs_service_control"
210
211 #endif
212
220 #define TOOLS_CORE_PROP_CTX "tcs_app_ctx"
221
222
232 typedef enum {
233 TOOLS_CORE_API_V1 = 0x1,
234 } ToolsCoreAPI;
235
236
241 typedef struct ToolsAppCtx {
243 ToolsCoreAPI version;
245 const gchar *name;
247 gboolean isVMware;
249 int errorCode;
251 GMainLoop *mainLoop;
253 RpcChannel *rpc;
255 GKeyFile *config;
256 #if defined(G_PLATFORM_WIN32)
257
258 gboolean comInitialized;
259 #else
260
261 int blockFD;
263 const char **envp;
264 #endif
265
271 gpointer serviceObj;
272 } ToolsAppCtx;
273
274 #if defined(G_PLATFORM_WIN32)
275
282 G_INLINE_FUNC gboolean
283 ToolsCore_InitializeCOM(ToolsAppCtx *ctx)
284 {
285 if (!ctx->comInitialized) {
286 HRESULT ret = CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
287 ctx->comInitialized = SUCCEEDED(ret);
288 if (!ctx->comInitialized) {
289 g_log(ctx->name, G_LOG_LEVEL_WARNING,
290 "COM initialization failed(0x%x)\n", ret);
291 }
292 }
293 return ctx->comInitialized;
294 }
295 #endif
296
297
298 /* Capabilities. */
299
301 typedef enum {
302 TOOLS_CAP_OLD = 0,
303 TOOLS_CAP_OLD_NOVAL = 1,
304 TOOLS_CAP_NEW = 2
305 } ToolsCapabilityType;
306
316 typedef struct ToolsAppCapability {
318 ToolsCapabilityType type;
323 const gchar *name;
328 GuestCapabilities index;
330 guint value;
331 } ToolsAppCapability;
332
333
334 /* Application registration. */
335
337 typedef enum {
341 TOOLS_APP_GUESTRPC = 1,
346 TOOLS_APP_SIGNALS = 2,
352 TOOLS_APP_PROVIDER = 3,
357 TOOLS_SVC_PROPERTY = 4,
358 } ToolsAppType;
359
360
361 struct ToolsPluginData;
362
371 typedef struct ToolsAppProvider {
373 const gchar *name;
380 ToolsAppType regType;
382 size_t regSize;
392 void (*activate)(ToolsAppCtx *ctx, struct ToolsAppProvider *prov, GError **err);
404 gboolean (*registerApp)(ToolsAppCtx *ctx,
405 struct ToolsAppProvider *prov,
406 struct ToolsPluginData *plugin,
407 gpointer reg);
418 void (*shutdown)(ToolsAppCtx *ctx, struct ToolsAppProvider *prov);
431 void (*dumpState)(ToolsAppCtx *ctx, struct ToolsAppProvider *prov, gpointer reg);
432 } ToolsAppProvider;
433
434
445 typedef struct ToolsAppReg {
446 ToolsAppType type;
447 GArray *data;
448 } ToolsAppReg;
449
450
464 typedef struct ToolsServiceProperty {
465 const char *name;
466 } ToolsServiceProperty;
467
468
478 typedef struct ToolsPluginSignalCb {
479 const gchar *signame;
480 gpointer callback;
481 gpointer clientData;
482 } ToolsPluginSignalCb;
483
484
499 typedef struct ToolsPluginData {
501 char const *name;
506 GArray *regs;
537 gboolean (*errorCb)(ToolsAppCtx *ctx,
538 ToolsAppType type,
539 gpointer data,
540 struct ToolsPluginData *plugin);
542 gpointer _private;
543 } ToolsPluginData;
544
550 #if defined(G_PLATFORM_WIN32)
551 # define TOOLS_MODULE_EXPORT VMTOOLS_EXTERN_C __declspec(dllexport)
552 #elif defined(GCC_EXPLICIT_EXPORT)
553 # define TOOLS_MODULE_EXPORT VMTOOLS_EXTERN_C __attribute__((visibility("default")))
554 #else
555 # define TOOLS_MODULE_EXPORT VMTOOLS_EXTERN_C
556 #endif
557
569 typedef ToolsPluginData *(*ToolsPluginOnLoad)(ToolsAppCtx *ctx);
570
573 #endif /* _VMWARE_TOOLS_PLUGIN_H_ */
574
ToolsPluginSignalCb
struct ToolsPluginSignalCb ToolsPluginSignalCb
ToolsAppCapability
Definition: plugin.h:316
TOOLS_APP_GUESTRPC
Definition: plugin.h:341
ToolsAppCapability::index
GuestCapabilities index
Definition: plugin.h:328
ToolsAppCtx::config
GKeyFile * config
Definition: plugin.h:255
ToolsAppCtx::isVMware
gboolean isVMware
Definition: plugin.h:247
ToolsAppCtx::rpc
RpcChannel * rpc
Definition: plugin.h:253
ToolsPluginSignalCb
Definition: plugin.h:478
ToolsAppCtx
struct ToolsAppCtx ToolsAppCtx
ToolsAppCtx::errorCode
int errorCode
Definition: plugin.h:249
ToolsAppProvider::regType
ToolsAppType regType
Definition: plugin.h:380
ToolsAppCapability::type
ToolsCapabilityType type
Definition: plugin.h:318
ToolsAppProvider
struct ToolsAppProvider ToolsAppProvider
ToolsServiceProperty
Definition: plugin.h:464
ToolsAppCtx::mainLoop
GMainLoop * mainLoop
Definition: plugin.h:251
ToolsAppProvider::dumpState
void(* dumpState)(ToolsAppCtx *ctx, struct ToolsAppProvider *prov, gpointer reg)
Definition: plugin.h:431
ToolsAppCtx::blockFD
int blockFD
Definition: plugin.h:261
TOOLS_SVC_PROPERTY
Definition: plugin.h:357
utils.h
ToolsAppCapability::value
guint value
Definition: plugin.h:330
ToolsAppProvider::registerApp
gboolean(* registerApp)(ToolsAppCtx *ctx, struct ToolsAppProvider *prov, struct ToolsPluginData *plugin, gpointer reg)
Definition: plugin.h:404
ToolsAppCtx::name
const gchar * name
Definition: plugin.h:245
ToolsPluginData::_private
gpointer _private
Definition: plugin.h:542
guestrpc.h
ToolsCapabilityType
ToolsCapabilityType
Definition: plugin.h:301
ToolsPluginData::regs
GArray * regs
Definition: plugin.h:506
ToolsPluginData
struct ToolsPluginData ToolsPluginData
ToolsAppReg
Definition: plugin.h:445
ToolsAppType
ToolsAppType
Definition: plugin.h:337
ToolsAppProvider
Definition: plugin.h:371
TOOLS_APP_SIGNALS
Definition: plugin.h:346
ToolsAppCtx::serviceObj
gpointer serviceObj
Definition: plugin.h:271
ToolsAppProvider::name
const gchar * name
Definition: plugin.h:373
ToolsPluginData
Definition: plugin.h:499
ToolsAppCapability
struct ToolsAppCapability ToolsAppCapability
TOOLS_APP_PROVIDER
Definition: plugin.h:352
ToolsAppCtx
Definition: plugin.h:241
ToolsAppCtx::version
ToolsCoreAPI version
Definition: plugin.h:243
ToolsAppCapability::name
const gchar * name
Definition: plugin.h:323
ToolsAppCtx::envp
const char ** envp
Definition: plugin.h:263
ToolsCoreAPI
ToolsCoreAPI
Definition: plugin.h:232
ToolsPluginData::name
char const * name
Definition: plugin.h:501
ToolsAppProvider::regSize
size_t regSize
Definition: plugin.h:382
ToolsAppReg
struct ToolsAppReg ToolsAppReg
ToolsServiceProperty
struct ToolsServiceProperty ToolsServiceProperty