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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*********************************************************
* Copyright (C) 2008,2014-2015 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_GUESTRPC_H_
#define _VMWARE_TOOLS_GUESTRPC_H_
/**
* @file guestrpc.h
*
* Defines the interface between applications and the underlying GuestRPC
* channel. The goal is to have an abstraction so applications can run over
* the backdoor, vSockets or TCP/IP sockets by just picking up the
* desired channel at runtime, without the need to modify the code.
*
* For this reason, the behavior of all channels is modeled after the RpcIn
* channel currently used in Tools, so the socket-based channels won't
* provide much better functionality than what the backdoor provides (aside
* from being interrupt-based rather than poll-based).
*
* @addtogroup vmtools_guestrpc
* @{
*/
#include <glib.h>
#include "vmware/tools/utils.h"
G_BEGIN_DECLS
/** Aliases. */
#define RPCIN_SETRETVALS RpcChannel_SetRetVals
#define RPCIN_SETRETVALSF RpcChannel_SetRetValsF
typedef struct _RpcChannel RpcChannel;
/** Data structure passed to RPC callbacks. */
typedef struct RpcInData {
/** RPC name. */
const char *name;
/**
* RPC arguments. Either the raw argument data, or de-serialized XDR data
* in case @a xdrIn was provided in the registration data.
*/
const char *args;
/** Size of raw argument data, in bytes. */
size_t argsSize;
/**
* Data to be returned to the caller, or pointer to XDR structure if
* @a xdrOut was provided in the registration data.
*/
char *result;
/** Length in bytes of raw data being returned (ignored for XDR structures). */
size_t resultLen;
/**
* Whether the RPC library should free the contents of the @a result
* field (using vm_free()).
*/
gboolean freeResult;
/** Application context. */
void *appCtx;
/** Client data specified in the registration data. */
void *clientData;
} RpcInData;
typedef enum RpcChannelType {
RPCCHANNEL_TYPE_INACTIVE,
RPCCHANNEL_TYPE_BKDOOR,
RPCCHANNEL_TYPE_PRIV_VSOCK,
RPCCHANNEL_TYPE_UNPRIV_VSOCK
} RpcChannelType;
/**
* Type for RpcIn callbacks. The callback function is responsible for
* allocating memory for the result string.
*/
typedef gboolean (*RpcIn_Callback)(RpcInData *data);
/** Defines the registration data for a GuestRPC application. */
typedef struct RpcChannelCallback {
/** String identifying the RPC message. */
const char *name;
/** Function to call when data arrives. */
RpcIn_Callback callback;
/** Data to provide to callback function. */
gpointer clientData;
/** If not NULL, the input data will be deserialized using this function. */
gpointer xdrIn;
/**
* If not NULL, the output data will be serialized using this function. The
* output data should be stored in the @a result field of the RpcInData
* structure, and should have been allocated with glib's @a g_malloc() if
* @a freeResult is TRUE.
*/
gpointer xdrOut;
/**
* If xdrIn is not NULL, this should be the amount of memory to allocate
* for deserializing the input data.
*/
size_t xdrInSize;
} RpcChannelCallback;
/**
* Signature for the callback function called after a channel reset.
*
* @param[in] chan The RPC channel.
* @param[in] success Whether reset was successful.
* @param[in] data Client data.
*/
typedef void (*RpcChannelResetCb)(RpcChannel *chan,
gboolean success,
gpointer data);
gboolean
RpcChannel_Start(RpcChannel *chan);
void
RpcChannel_Stop(RpcChannel *chan);
RpcChannelType
RpcChannel_GetType(RpcChannel *chan);
gboolean
RpcChannel_Send(RpcChannel *chan,
char const *data,
size_t dataLen,
char **result,
size_t *resultLen);
void
RpcChannel_Free(void *ptr);
gboolean
RpcChannel_BuildXdrCommand(const char *cmd,
void *xdrProc,
void *xdrData,
char **result,
size_t *resultLen);
RpcChannel *
RpcChannel_Create(void);
void
RpcChannel_Shutdown(RpcChannel *chan);
gboolean
RpcChannel_Destroy(RpcChannel *chan);
gboolean
RpcChannel_Dispatch(RpcInData *data);
void
RpcChannel_Setup(RpcChannel *chan,
const gchar *appName,
GMainContext *mainCtx,
gpointer appCtx,
RpcChannelResetCb resetCb,
gpointer resetData);
void
RpcChannel_RegisterCallback(RpcChannel *chan,
RpcChannelCallback *rpc);
gboolean
RpcChannel_SetRetVals(RpcInData *data,
char const *result,
gboolean retVal);
gboolean
RpcChannel_SetRetValsF(RpcInData *data,
char *result,
gboolean retVal);
void
RpcChannel_UnregisterCallback(RpcChannel *chan,
RpcChannelCallback *rpc);
gboolean
RpcChannel_SendOneRaw(const char *data,
size_t dataLen,
char **result,
size_t *resultLen);
gboolean
RpcChannel_SendOne(char **reply,
size_t *repLen,
const char *reqFmt,
...);
RpcChannel *
RpcChannel_New(void);
void
RpcChannel_SetBackdoorOnly(void);
G_END_DECLS
/** @} */
#endif
|
