VirtualBox

source: vbox/trunk/include/VBox/hgcmsvc.h@ 480

Last change on this file since 480 was 1, checked in by vboxsync, 55 years ago

import

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.7 KB
Line 
1/** @file
2 * VBox - Host-Guest Communication Manager (HGCM):
3 * Service library definitions.
4 */
5
6/*
7 * Copyright (C) 2006 InnoTek Systemberatung GmbH
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * If you received this file as part of a commercial VirtualBox
18 * distribution, then only the terms of your commercial VirtualBox
19 * license agreement apply instead of the previous paragraph.
20 */
21
22#ifndef __VBox_hgcm_h__
23#define __VBox_hgcm_h__
24
25#include <VBox/cdefs.h>
26#include <VBox/types.h>
27
28/** @todo proper comments. */
29
30/**
31 * Service interface version.
32 *
33 * Includes layout of both VBOXHGCMSVCFNTABLE and VBOXHGCMSVCHELPERS.
34 *
35 * A service can work with these structures if major version
36 * is equal and minor version of service is <= version of the
37 * structures.
38 *
39 * For example when a new helper is added at the end of helpers
40 * structure, then the minor version will be increased. All older
41 * services still can work because they have their old helpers
42 * unchanged.
43 *
44 * Revision history.
45 * 1.1->2.1 Because the pfnConnect now also has the pvClient parameter.
46 */
47#define VBOX_HGCM_SVC_VERSION_MINOR (0x0001)
48#define VBOX_HGCM_SVC_VERSION_MAJOR (0x0002)
49#define VBOX_HGCM_SVC_VERSION ((VBOX_HGCM_SVC_VERSION_MAJOR << 16) + VBOX_HGCM_SVC_VERSION_MINOR)
50
51
52/** Typed pointer to distinguish a call to service. */
53struct VBOXHGCMCALLHANDLE_TYPEDEF;
54typedef struct VBOXHGCMCALLHANDLE_TYPEDEF *VBOXHGCMCALLHANDLE;
55
56/** Service helpers pointers table. */
57typedef struct _VBOXHGCMSVCHELPERS
58{
59 /** The service has processed the Call request. */
60 DECLCALLBACKMEMBER(void, pfnCallComplete) (VBOXHGCMCALLHANDLE callHandle, int32_t rc);
61
62 void *pvInstance;
63} VBOXHGCMSVCHELPERS;
64
65typedef VBOXHGCMSVCHELPERS *PVBOXHGCMSVCHELPERS;
66
67
68#define VBOX_HGCM_SVC_PARM_INVALID (0U)
69#define VBOX_HGCM_SVC_PARM_32BIT (1U)
70#define VBOX_HGCM_SVC_PARM_64BIT (2U)
71#define VBOX_HGCM_SVC_PARM_PTR (3U)
72
73typedef struct VBOXHGCMSVCPARM
74{
75 /** VBOX_HGCM_SVC_PARM_* values. */
76 uint32_t type;
77
78 union
79 {
80 uint32_t uint32;
81 uint64_t uint64;
82 struct
83 {
84 uint32_t size;
85 void *addr;
86 } pointer;
87 } u;
88} VBOXHGCMSVCPARM;
89
90typedef VBOXHGCMSVCPARM *PVBOXHGCMSVCPARM;
91
92/** The Service DLL entry points.
93 *
94 * HGCM will call the DLL "VBoxHGCMSvcLoad"
95 * function and the DLL must fill in the VBOXHGCMSVCFNTABLE
96 * with function pointers.
97 */
98
99/* The structure is used in separately compiled binaries so an explicit packing is required. */
100#pragma pack(1)
101typedef struct _VBOXHGCMSVCFNTABLE
102{
103 /** Filled by HGCM */
104
105 /** Size of the structure. */
106 uint32_t cbSize;
107
108 /** Version of the structure, including the helpers. */
109 uint32_t u32Version;
110
111 PVBOXHGCMSVCHELPERS pHelpers;
112
113 /** Filled by the service. */
114
115 /** Size of client information the service want to have. */
116 uint32_t cbClient;
117#if ARCH_BITS == 64
118 /** Ensure that the following pointers are properly aligned on 64-bit system.
119 * To counter harm done by the paranoid #pragma pack(1). */
120 uint32_t u32Alignment0;
121#endif
122
123 /** Uninitialize service */
124 DECLCALLBACKMEMBER(int, pfnUnload) (void);
125
126 /** Inform the service about a client connection. */
127 DECLCALLBACKMEMBER(int, pfnConnect) (uint32_t u32ClientID, void *pvClient);
128
129 /** Inform the service that the client wants to disconnect. */
130 DECLCALLBACKMEMBER(int, pfnDisconnect) (uint32_t u32ClientID, void *pvClient);
131
132 /** Service entry point.
133 * Return code is passed to pfnCallComplete callback.
134 */
135 DECLCALLBACKMEMBER(void, pfnCall) (VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID, void *pvClient, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
136
137 /** Host Service entry point meant for privileged features invisible to the guest.
138 * Return code is passed to pfnCallComplete callback.
139 */
140 DECLCALLBACKMEMBER(void, pfnHostCall) (VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID, void *pvClient, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
141
142} VBOXHGCMSVCFNTABLE;
143#pragma pack()
144
145
146/** Service initialization entry point. */
147typedef DECLCALLBACK(int) VBOXHGCMSVCLOAD(VBOXHGCMSVCFNTABLE *ptable);
148typedef VBOXHGCMSVCLOAD *PFNVBOXHGCMSVCLOAD;
149#define VBOX_HGCM_SVCLOAD_NAME "VBoxHGCMSvcLoad"
150
151#endif /* !__VBox_hgcmsvc_h__ */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette