VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp

Last change on this file was 99739, checked in by vboxsync, 13 months ago

*: doxygen corrections (mostly about removing @returns from functions returning void).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.4 KB
Line 
1/* $Id: krnlmod-solaris.cpp 99739 2023-05-11 01:01:08Z vboxsync $ */
2/** @file
3 * IPRT - Kernel module, Linux.
4 */
5
6/*
7 * Copyright (C) 2017-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#define LOG_GROUP RTLOGGROUP_SYSTEM
42#include <iprt/krnlmod.h>
43#include <iprt/asm.h>
44#include <iprt/assert.h>
45#include <iprt/dir.h>
46#include <iprt/errcore.h>
47#include <iprt/mem.h>
48#include <iprt/string.h>
49#include <iprt/types.h>
50
51#include <iprt/stream.h>
52
53#include <sys/modctl.h>
54#include <errno.h>
55
56/**
57 * Internal kernel information record state.
58 */
59typedef struct RTKRNLMODINFOINT
60{
61 /** Reference counter. */
62 volatile uint32_t cRefs;
63 /** Load address of the kernel module. */
64 RTR0UINTPTR uLoadAddr;
65 /** Size of the kernel module. */
66 size_t cbKrnlMod;
67 /** Size of the name in characters including the zero terminator. */
68 size_t cchName;
69 /** Module name - variable in size. */
70 char achName[1];
71} RTKRNLMODINFOINT;
72/** Pointer to the internal kernel module information record. */
73typedef RTKRNLMODINFOINT *PRTKRNLMODINFOINT;
74/** Pointer to a const internal kernel module information record. */
75typedef const RTKRNLMODINFOINT *PCRTKRNLMODINFOINT;
76
77
78
79/**
80 * Destroy the given kernel module information record.
81 *
82 * @param pThis The record to destroy.
83 */
84static void rtKrnlModInfoDestroy(PRTKRNLMODINFOINT pThis)
85{
86 RTMemFree(pThis);
87}
88
89
90/**
91 * Creates a new kernel module information record for the given module.
92 *
93 * @returns IPRT status code.
94 * @param pModInfo The Solaris kernel module information.
95 * @param phKrnlModInfo Where to store the handle to the kernel module information record
96 * on success.
97 */
98static int rtKrnlModSolInfoCreate(struct modinfo *pModInfo, PRTKRNLMODINFO phKrnlModInfo)
99{
100 int rc = VINF_SUCCESS;
101 size_t cchName = strlen(&pModInfo->mi_name[0]) + 1;
102 PRTKRNLMODINFOINT pThis = (PRTKRNLMODINFOINT)RTMemAllocZ(RT_UOFFSETOF_DYN(RTKRNLMODINFOINT, achName[cchName]));
103 if (RT_LIKELY(pThis))
104 {
105 memcpy(&pThis->achName[0], &pModInfo->mi_name[0], cchName);
106 pThis->cchName = cchName;
107 pThis->cRefs = 1;
108 pThis->cbKrnlMod = pModInfo->mi_size;
109 pThis->uLoadAddr = (RTR0UINTPTR)pModInfo->mi_base;
110
111 *phKrnlModInfo = pThis;
112 }
113 else
114 rc = VERR_NO_MEMORY;
115
116 return rc;
117}
118
119
120RTDECL(int) RTKrnlModQueryLoaded(const char *pszName, bool *pfLoaded)
121{
122 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
123 AssertPtrReturn(pfLoaded, VERR_INVALID_POINTER);
124
125 RTKRNLMODINFO hKrnlModInfo = NIL_RTKRNLMODINFO;
126 int rc = RTKrnlModLoadedQueryInfo(pszName, &hKrnlModInfo);
127 if (RT_SUCCESS(rc))
128 {
129 *pfLoaded = true;
130 RTKrnlModInfoRelease(hKrnlModInfo);
131 }
132 else if (rc == VERR_NOT_FOUND)
133 {
134 *pfLoaded = false;
135 rc = VINF_SUCCESS;
136 }
137
138 return rc;
139}
140
141
142RTDECL(int) RTKrnlModLoadedQueryInfo(const char *pszName, PRTKRNLMODINFO phKrnlModInfo)
143{
144 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
145 AssertPtrReturn(phKrnlModInfo, VERR_INVALID_POINTER);
146
147 int rc = VERR_NOT_FOUND;
148 int iId = -1;
149 struct modinfo ModInfo;
150
151 ModInfo.mi_info = MI_INFO_ALL | MI_INFO_CNT;
152 ModInfo.mi_id = iId;
153 ModInfo.mi_nextid = iId;
154 do
155 {
156 int rcSol = modctl(MODINFO, iId, &ModInfo);
157 if (rcSol < 0)
158 {
159 rc = RTErrConvertFromErrno(errno);
160 break;
161 }
162
163 if (ModInfo.mi_id != -1)
164 {
165 ModInfo.mi_name[MODMAXNAMELEN - 1] = '\0'; /* Paranoia. */
166 if (!RTStrCmp(pszName, &ModInfo.mi_name[0]))
167 {
168 rc = rtKrnlModSolInfoCreate(&ModInfo, phKrnlModInfo);
169 break;
170 }
171 }
172
173 iId = ModInfo.mi_id;
174 } while (iId != -1);
175
176 return rc;
177}
178
179
180RTDECL(uint32_t) RTKrnlModLoadedGetCount(void)
181{
182 uint32_t cKmodsLoaded = 0;
183 int iId = -1;
184 struct modinfo ModInfo;
185
186 ModInfo.mi_info = MI_INFO_ALL | MI_INFO_CNT;
187 ModInfo.mi_id = iId;
188 ModInfo.mi_nextid = iId;
189 do
190 {
191 int rcSol = modctl(MODINFO, iId, &ModInfo);
192 if (rcSol < 0)
193 break;
194
195 cKmodsLoaded++;
196
197 iId = ModInfo.mi_id;
198 } while (iId != -1);
199
200 return cKmodsLoaded;
201}
202
203
204RTDECL(int) RTKrnlModLoadedQueryInfoAll(PRTKRNLMODINFO pahKrnlModInfo, uint32_t cEntriesMax,
205 uint32_t *pcEntries)
206{
207 if (cEntriesMax > 0)
208 AssertPtrReturn(pahKrnlModInfo, VERR_INVALID_POINTER);
209
210 uint32_t cKmodsLoaded = RTKrnlModLoadedGetCount();
211 if (cEntriesMax < cKmodsLoaded)
212 {
213 if (*pcEntries)
214 *pcEntries = cKmodsLoaded;
215 return VERR_BUFFER_OVERFLOW;
216 }
217
218 int rc = VINF_SUCCESS;
219 int iId = -1;
220 unsigned idxKrnlModInfo = 0;
221 struct modinfo ModInfo;
222
223 ModInfo.mi_info = MI_INFO_ALL | MI_INFO_CNT;
224 ModInfo.mi_id = iId;
225 ModInfo.mi_nextid = iId;
226 do
227 {
228 int rcSol = modctl(MODINFO, iId, &ModInfo);
229 if (rcSol < 0)
230 {
231 rc = RTErrConvertFromErrno(errno);
232 if (rc == VERR_INVALID_PARAMETER && idxKrnlModInfo > 0)
233 rc = VINF_SUCCESS;
234 break;
235 }
236
237 ModInfo.mi_name[MODMAXNAMELEN - 1] = '\0'; /* Paranoia. */
238 rc = rtKrnlModSolInfoCreate(&ModInfo, &pahKrnlModInfo[idxKrnlModInfo]);
239 if (RT_SUCCESS(rc))
240 idxKrnlModInfo++;
241
242 iId = ModInfo.mi_id;
243 } while (iId != -1);
244
245 if (RT_FAILURE(rc))
246 {
247 /* Rollback */
248 while (idxKrnlModInfo-- > 0)
249 RTKrnlModInfoRelease(pahKrnlModInfo[idxKrnlModInfo]);
250 }
251 else if (pcEntries)
252 *pcEntries = idxKrnlModInfo;
253
254 return rc;
255}
256
257
258RTDECL(uint32_t) RTKrnlModInfoRetain(RTKRNLMODINFO hKrnlModInfo)
259{
260 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
261 AssertPtrReturn(pThis, UINT32_MAX);
262
263 uint32_t cRefs = ASMAtomicIncU32(&pThis->cRefs);
264 AssertMsg(cRefs > 1 && cRefs < _1M, ("%#x %p\n", cRefs, pThis));
265 return cRefs;
266}
267
268
269RTDECL(uint32_t) RTKrnlModInfoRelease(RTKRNLMODINFO hKrnlModInfo)
270{
271 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
272 if (!pThis)
273 return 0;
274 AssertPtrReturn(pThis, UINT32_MAX);
275
276 uint32_t cRefs = ASMAtomicDecU32(&pThis->cRefs);
277 AssertMsg(cRefs < _1M, ("%#x %p\n", cRefs, pThis));
278 if (cRefs == 0)
279 rtKrnlModInfoDestroy(pThis);
280 return cRefs;
281}
282
283
284RTDECL(uint32_t) RTKrnlModInfoGetRefCnt(RTKRNLMODINFO hKrnlModInfo)
285{
286 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
287 AssertPtrReturn(pThis, 0);
288
289 return 0;
290}
291
292
293RTDECL(const char *) RTKrnlModInfoGetName(RTKRNLMODINFO hKrnlModInfo)
294{
295 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
296 AssertPtrReturn(pThis, NULL);
297
298 return &pThis->achName[0];
299}
300
301
302RTDECL(const char *) RTKrnlModInfoGetFilePath(RTKRNLMODINFO hKrnlModInfo)
303{
304 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
305 AssertPtrReturn(pThis, NULL);
306
307 return NULL;
308}
309
310
311RTDECL(size_t) RTKrnlModInfoGetSize(RTKRNLMODINFO hKrnlModInfo)
312{
313 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
314 AssertPtrReturn(pThis, 0);
315
316 return pThis->cbKrnlMod;
317}
318
319
320RTDECL(RTR0UINTPTR) RTKrnlModInfoGetLoadAddr(RTKRNLMODINFO hKrnlModInfo)
321{
322 PRTKRNLMODINFOINT pThis = hKrnlModInfo;
323 AssertPtrReturn(pThis, 0);
324
325 return pThis->uLoadAddr;
326}
327
328
329RTDECL(int) RTKrnlModInfoQueryRefModInfo(RTKRNLMODINFO hKrnlModInfo, uint32_t idx,
330 PRTKRNLMODINFO phKrnlModInfoRef)
331{
332 RT_NOREF3(hKrnlModInfo, idx, phKrnlModInfoRef);
333 return VERR_NOT_IMPLEMENTED;
334}
335
336
337RTDECL(int) RTKrnlModLoadByName(const char *pszName)
338{
339 AssertPtrReturn(pszName, VERR_INVALID_PARAMETER);
340
341 return VERR_NOT_SUPPORTED;
342}
343
344
345RTDECL(int) RTKrnlModLoadByPath(const char *pszPath)
346{
347 AssertPtrReturn(pszPath, VERR_INVALID_PARAMETER);
348
349 return VERR_NOT_SUPPORTED;
350}
351
352
353RTDECL(int) RTKrnlModUnloadByName(const char *pszName)
354{
355 AssertPtrReturn(pszName, VERR_INVALID_PARAMETER);
356
357 return VERR_NOT_SUPPORTED;
358}
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use