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
|
/* @file
*
* Host Channel
*/
/*
* Copyright (C) 2012-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* 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, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef VBOX_INCLUDED_SRC_HostChannel_HostChannel_h
#define VBOX_INCLUDED_SRC_HostChannel_HostChannel_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/list.h>
#define LOG_GROUP LOG_GROUP_HGCM
#include <VBox/log.h>
#include <VBox/HostServices/VBoxHostChannel.h>
#define HOSTCHLOG Log
#ifdef DEBUG_sunlover
# undef HOSTCHLOG
# define HOSTCHLOG LogRel
#endif /* DEBUG_sunlover */
struct VBOXHOSTCHCTX;
typedef struct VBOXHOSTCHCTX VBOXHOSTCHCTX;
typedef struct VBOXHOSTCHCLIENT
{
RTLISTNODE nodeClient;
VBOXHOSTCHCTX *pCtx;
uint32_t u32ClientID;
RTLISTANCHOR listChannels;
uint32_t volatile u32HandleSrc;
RTLISTANCHOR listContexts; /* Callback contexts. */
RTLISTANCHOR listEvents;
bool fAsync; /* Guest is waiting for a message. */
struct {
VBOXHGCMCALLHANDLE callHandle;
VBOXHGCMSVCPARM *paParms;
} async;
} VBOXHOSTCHCLIENT;
/*
* The service functions. Locking is between the service thread and the host channel provider thread.
*/
int vboxHostChannelLock(void);
void vboxHostChannelUnlock(void);
int vboxHostChannelInit(void);
void vboxHostChannelDestroy(void);
int vboxHostChannelClientConnect(VBOXHOSTCHCLIENT *pClient);
void vboxHostChannelClientDisconnect(VBOXHOSTCHCLIENT *pClient);
int vboxHostChannelAttach(VBOXHOSTCHCLIENT *pClient,
uint32_t *pu32Handle,
const char *pszName,
uint32_t u32Flags);
int vboxHostChannelDetach(VBOXHOSTCHCLIENT *pClient,
uint32_t u32Handle);
int vboxHostChannelSend(VBOXHOSTCHCLIENT *pClient,
uint32_t u32Handle,
const void *pvData,
uint32_t cbData);
int vboxHostChannelRecv(VBOXHOSTCHCLIENT *pClient,
uint32_t u32Handle,
void *pvData,
uint32_t cbData,
uint32_t *pu32DataReceived,
uint32_t *pu32DataRemaining);
int vboxHostChannelControl(VBOXHOSTCHCLIENT *pClient,
uint32_t u32Handle,
uint32_t u32Code,
void *pvParm,
uint32_t cbParm,
void *pvData,
uint32_t cbData,
uint32_t *pu32SizeDataReturned);
int vboxHostChannelEventWait(VBOXHOSTCHCLIENT *pClient,
bool *pfEvent,
VBOXHGCMCALLHANDLE callHandle,
VBOXHGCMSVCPARM *paParms);
int vboxHostChannelEventCancel(VBOXHOSTCHCLIENT *pClient);
int vboxHostChannelQuery(VBOXHOSTCHCLIENT *pClient,
const char *pszName,
uint32_t u32Code,
void *pvParm,
uint32_t cbParm,
void *pvData,
uint32_t cbData,
uint32_t *pu32SizeDataReturned);
int vboxHostChannelRegister(const char *pszName,
const VBOXHOSTCHANNELINTERFACE *pInterface,
uint32_t cbInterface);
int vboxHostChannelUnregister(const char *pszName);
void vboxHostChannelEventParmsSet(VBOXHGCMSVCPARM *paParms,
uint32_t u32ChannelHandle,
uint32_t u32Id,
const void *pvEvent,
uint32_t cbEvent);
void vboxHostChannelReportAsync(VBOXHOSTCHCLIENT *pClient,
uint32_t u32ChannelHandle,
uint32_t u32Id,
const void *pvEvent,
uint32_t cbEvent);
#endif /* !VBOX_INCLUDED_SRC_HostChannel_HostChannel_h */
|
