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
|
/*********************************************************
* Copyright (C) 1999 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.
*
*********************************************************/
/*
* message.h --
*
* Second layer of the internal communication channel between guest
* applications and vmware
*/
#ifndef __MESSAGE_H__
# define __MESSAGE_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "vm_basic_types.h"
typedef struct Message_Channel Message_Channel;
/*
* These functions must be implemented by any external Message
* transport implementation. Some examples include crossTalk,
* a network socket, or a Microsoft Hypervisor backdoor.
*
* These external functions mirror the same corresponding Message_*
* functions below.
*/
typedef Message_Channel *(*MessageOpenProcType)(uint32 proto);
typedef Bool (*MessageGetReadEventProcType)(Message_Channel *chan,
int64 *readEvent);
typedef Bool (*MessageSendProcType)(Message_Channel *chan,
const unsigned char *buf,
size_t bufSize);
typedef Bool (*MessageReceiveProcType)(Message_Channel *chan,
unsigned char **buf,
size_t *bufSize);
typedef Bool (*MessageCloseProcType)(Message_Channel *chan);
/*
* This tells the message layer to use an alternate transport
* for messages. By default, we use the backdoor, so this function
* overrides that default at runtime and switches everything over to
* an alternate transport.
*/
void Message_SetTransport(MessageOpenProcType openProc,
MessageGetReadEventProcType getReadEeventProc,
MessageSendProcType sendProc,
MessageReceiveProcType receiveProc,
MessageCloseProcType closeProc);
void MessageStub_RegisterTransport(void);
Message_Channel *
Message_Open(uint32 proto); // IN
/*
* This allows higher levels of the IPC stack to use an event to detect
* when a message has arrived. This allows an interrupt-model rather than
* continually calling Message_Receive in a busy loop. This may only be supported
* by some transports. The backdoor does not, so the IPC code will still
* have to poll in those cases.
*/
Bool
Message_GetReadEvent(Message_Channel *chan, // IN
int64 *event); // OUT
Bool
Message_Send(Message_Channel *chan, // IN/OUT
const unsigned char *buf, // IN
size_t bufSize); // IN
Bool
Message_Receive(Message_Channel *chan, // IN/OUT
unsigned char **buf, // OUT
size_t *bufSize); // OUT
Bool
Message_Close(Message_Channel *chan); // IN/OUT
#ifdef __cplusplus
}
#endif
#endif /* __MESSAGE_H__ */
|
