VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPR0IdcClient.c@ 86715

Last change on this file since 86715 was 82968, checked in by vboxsync, 5 years ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.5 KB
Line 
1/* $Id: SUPR0IdcClient.c 82968 2020-02-04 10:35:17Z vboxsync $ */
2/** @file
3 * VirtualBox Support Driver - IDC Client Lib, Core.
4 */
5
6/*
7 * Copyright (C) 2008-2020 Oracle Corporation
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 (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#include "SUPR0IdcClientInternal.h"
32#include <iprt/errcore.h>
33#include <iprt/asm.h>
34
35
36/*********************************************************************************************************************************
37* Global Variables *
38*********************************************************************************************************************************/
39static PSUPDRVIDCHANDLE volatile g_pMainHandle = NULL;
40
41
42/**
43 * Opens the IDC interface of the support driver.
44 *
45 * This will perform basic version negotiations and fail if the
46 * minimum requirements aren't met.
47 *
48 * @returns VBox status code.
49 * @param pHandle The handle structure (output).
50 * @param uReqVersion The requested version. Pass 0 for default.
51 * @param uMinVersion The minimum required version. Pass 0 for default.
52 * @param puSessionVersion Where to store the session version. Optional.
53 * @param puDriverVersion Where to store the session version. Optional.
54 * @param puDriverRevision Where to store the SVN revision of the driver. Optional.
55 */
56SUPR0DECL(int) SUPR0IdcOpen(PSUPDRVIDCHANDLE pHandle, uint32_t uReqVersion, uint32_t uMinVersion,
57 uint32_t *puSessionVersion, uint32_t *puDriverVersion, uint32_t *puDriverRevision)
58{
59 unsigned uDefaultMinVersion;
60 SUPDRVIDCREQCONNECT Req;
61 int rc;
62
63 /*
64 * Validate and set failure return values.
65 */
66 AssertPtrReturn(pHandle, VERR_INVALID_POINTER);
67 pHandle->s.pSession = NULL;
68
69 AssertPtrNullReturn(puSessionVersion, VERR_INVALID_POINTER);
70 if (puSessionVersion)
71 *puSessionVersion = 0;
72
73 AssertPtrNullReturn(puDriverVersion, VERR_INVALID_POINTER);
74 if (puDriverVersion)
75 *puDriverVersion = 0;
76
77 AssertPtrNullReturn(puDriverRevision, VERR_INVALID_POINTER);
78 if (puDriverRevision)
79 *puDriverRevision = 0;
80
81 AssertReturn(!uMinVersion || (uMinVersion & UINT32_C(0xffff0000)) == (SUPDRV_IDC_VERSION & UINT32_C(0xffff0000)), VERR_INVALID_PARAMETER);
82 AssertReturn(!uReqVersion || (uReqVersion & UINT32_C(0xffff0000)) == (SUPDRV_IDC_VERSION & UINT32_C(0xffff0000)), VERR_INVALID_PARAMETER);
83
84 /*
85 * Handle default version input and enforce minimum requirements made
86 * by this library.
87 *
88 * The clients will pass defaults (0), and only in the case that some
89 * special API feature was just added will they set an actual version.
90 * So, this is the place where can easily enforce a minimum IDC version
91 * on bugs and similar. It corresponds a bit to what SUPR3Init is
92 * responsible for.
93 */
94 uDefaultMinVersion = SUPDRV_IDC_VERSION & UINT32_C(0xffff0000);
95 if (!uMinVersion || uMinVersion < uDefaultMinVersion)
96 uMinVersion = uDefaultMinVersion;
97 if (!uReqVersion || uReqVersion < uDefaultMinVersion)
98 uReqVersion = uDefaultMinVersion;
99
100 /*
101 * Setup the connect request packet and call the OS specific function.
102 */
103 Req.Hdr.cb = sizeof(Req);
104 Req.Hdr.rc = VERR_WRONG_ORDER;
105 Req.Hdr.pSession = NULL;
106 Req.u.In.u32MagicCookie = SUPDRVIDCREQ_CONNECT_MAGIC_COOKIE;
107 Req.u.In.uMinVersion = uMinVersion;
108 Req.u.In.uReqVersion = uReqVersion;
109 rc = supR0IdcNativeOpen(pHandle, &Req);
110 if (RT_SUCCESS(rc))
111 {
112 pHandle->s.pSession = Req.u.Out.pSession;
113 if (puSessionVersion)
114 *puSessionVersion = Req.u.Out.uSessionVersion;
115 if (puDriverVersion)
116 *puDriverVersion = Req.u.Out.uDriverVersion;
117 if (puDriverRevision)
118 *puDriverRevision = Req.u.Out.uDriverRevision;
119
120 /*
121 * We don't really trust anyone, make sure the returned
122 * session and version values actually makes sense.
123 */
124 if ( VALID_PTR(Req.u.Out.pSession)
125 && Req.u.Out.uSessionVersion >= uMinVersion
126 && (Req.u.Out.uSessionVersion & UINT32_C(0xffff0000)) == (SUPDRV_IDC_VERSION & UINT32_C(0xffff0000)))
127 {
128 ASMAtomicCmpXchgPtr(&g_pMainHandle, pHandle, NULL);
129 return rc;
130 }
131
132 AssertMsgFailed(("pSession=%p uSessionVersion=0x%x (r%u)\n", Req.u.Out.pSession, Req.u.Out.uSessionVersion, Req.u.Out.uDriverRevision));
133 rc = VERR_VERSION_MISMATCH;
134 SUPR0IdcClose(pHandle);
135 }
136
137 return rc;
138}
139
140
141/**
142 * Closes a IDC connection established by SUPR0IdcOpen.
143 *
144 * @returns VBox status code.
145 * @param pHandle The IDC handle.
146 */
147SUPR0DECL(int) SUPR0IdcClose(PSUPDRVIDCHANDLE pHandle)
148{
149 SUPDRVIDCREQHDR Req;
150 int rc;
151
152 /*
153 * Catch closed handles and check that the session is valid.
154 */
155 AssertPtrReturn(pHandle, VERR_INVALID_POINTER);
156 if (!pHandle->s.pSession)
157 return VERR_INVALID_HANDLE;
158 AssertPtrReturn(pHandle->s.pSession, VERR_INVALID_HANDLE);
159
160 /*
161 * Create the request and hand it to the OS specific code.
162 */
163 Req.cb = sizeof(Req);
164 Req.rc = VERR_WRONG_ORDER;
165 Req.pSession = pHandle->s.pSession;
166 rc = supR0IdcNativeClose(pHandle, &Req);
167 if (RT_SUCCESS(rc))
168 {
169 pHandle->s.pSession = NULL;
170 ASMAtomicCmpXchgPtr(&g_pMainHandle, NULL, pHandle);
171 }
172 return rc;
173}
174
175
176/**
177 * Get the SUPDRV session for the IDC connection.
178 *
179 * This is for use with SUPDRV and component APIs that requires a valid
180 * session handle.
181 *
182 * @returns The session handle on success, NULL if the IDC handle is invalid.
183 *
184 * @param pHandle The IDC handle.
185 */
186SUPR0DECL(PSUPDRVSESSION) SUPR0IdcGetSession(PSUPDRVIDCHANDLE pHandle)
187{
188 PSUPDRVSESSION pSession;
189 AssertPtrReturn(pHandle, NULL);
190 pSession = pHandle->s.pSession;
191 AssertPtrReturn(pSession, NULL);
192 return pSession;
193}
194
195
196/**
197 * Looks up a IDC handle by session.
198 *
199 * @returns The IDC handle on success, NULL on failure.
200 * @param pSession The session to lookup.
201 *
202 * @internal
203 */
204PSUPDRVIDCHANDLE supR0IdcGetHandleFromSession(PSUPDRVSESSION pSession)
205{
206 PSUPDRVIDCHANDLE pHandle = ASMAtomicUoReadPtrT(&g_pMainHandle, PSUPDRVIDCHANDLE);
207 if ( VALID_PTR(pHandle)
208 && pHandle->s.pSession == pSession)
209 return pHandle;
210 return NULL;
211}
212
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