1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
/*********************************************************
* Copyright (C) 2008 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation version 2.1 and no later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*********************************************************/
#ifndef _VMWARE_TOOLS_UTILS_H_
#define _VMWARE_TOOLS_UTILS_H_
/**
* @file utils.h
*
* Public functions from the VMTools shared library, and other definitions.
*
* @defgroup vmtools_utils Utility Functions
* @{
*
* @brief A collection of useful functions.
*
* This module contains functions for loading configuration data and extensions
* to the glib API that are useful when writing applications.
*
*/
#define VMTOOLS_GUEST_SERVICE "vmsvc"
#define VMTOOLS_USER_SERVICE "vmusr"
#if defined(__cplusplus)
# define VMTOOLS_EXTERN_C extern "C"
#else
# define VMTOOLS_EXTERN_C
#endif
#include <glib.h>
#if defined(G_PLATFORM_WIN32)
# include <windows.h>
#else
# include <signal.h>
# include <sys/time.h>
#endif
/* Work around a glib limitation: it doesn't set G_INLINE_FUNC on Win32. */
#if defined(G_PLATFORM_WIN32)
# if defined(G_INLINE_FUNC)
# undef G_INLINE_FUNC
# endif
# define G_INLINE_FUNC static __inline
#endif
/**
* Converts an UTF-8 path to the local (i.e., glib) file name encoding.
* This is a no-op on Windows, since the local encoding is always UTF-8
* in glib. The returned value should not be freed directly; instead,
* use VMTOOLS_RELEASE_FILENAME_LOCAL.
*
* @param[in] path Path in UTF-8 (should not be NULL).
* @param[out] err Where to store errors (type: GError **; may be NULL).
*
* @return The path in glib's filename encoding, or NULL on error.
*/
#if defined(G_PLATFORM_WIN32)
# define VMTOOLS_GET_FILENAME_LOCAL(path, err) (gchar *) (path)
#else
# define VMTOOLS_GET_FILENAME_LOCAL(path, err) g_filename_from_utf8((path), \
-1, \
NULL, \
NULL, \
(err))
#endif
/**
* Frees a path allocated with VMTOOLS_GET_FILENAME_LOCAL. No-op on Windows.
*
* @param[in] path Path in UTF-8.
*/
#if defined(G_PLATFORM_WIN32)
# define VMTOOLS_RELEASE_FILENAME_LOCAL(path) (void) (path)
#else
# define VMTOOLS_RELEASE_FILENAME_LOCAL(path) g_free(path)
#endif
/** Convenience macro around VMTools_WrapArray. */
#define VMTOOLS_WRAP_ARRAY(a) VMTools_WrapArray((a), sizeof *(a), G_N_ELEMENTS(a))
G_BEGIN_DECLS
void
vm_free(void *ptr);
gboolean
VMTools_LoadConfig(const gchar *path,
GKeyFileFlags flags,
GKeyFile **config,
time_t *mtime);
gboolean
VMTools_WriteConfig(const gchar *path,
GKeyFile *config,
GError **err);
#if defined(G_PLATFORM_WIN32)
gboolean
VMTools_AttachConsole(void);
GSource *
VMTools_NewHandleSource(HANDLE h);
#else
/** Type of callback used by the signal event source. */
typedef gboolean (*SignalSourceCb)(const siginfo_t *, gpointer);
GSource *
VMTools_NewSignalSource(int signum);
gchar *
VMTools_GetLibdir(void);
#endif
GSource *
VMTools_CreateTimer(gint timeout);
void
VMTools_SetGuestSDKMode(void);
void
VMTools_StopLogging(void);
void
VMTools_RestartLogging(void);
GArray *
VMTools_WrapArray(gconstpointer data,
guint elemSize,
guint count);
G_END_DECLS
/** @} */
#endif /* _VMWARE_TOOLS_UTILS_H_ */
|
