SUPDrv-linux.c@ 52576

Last change on this file since 52576 was 52576, checked in by vboxsync, 10 years ago
missing ';'.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 32.1 KB

Line
1	/* $Rev: 52576 $ */
2	/** @file
3	* VBoxDrv - The VirtualBox Support Driver - Linux specifics.
4	*/
5
6	/*
7	* Copyright (C) 2006-2012 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	* Header Files *
29	*******************************************************************************/
30	#define LOG_GROUP LOG_GROUP_SUP_DRV
31	#include "../SUPDrvInternal.h"
32	#include "the-linux-kernel.h"
33	#include "version-generated.h"
34	#include "product-generated.h"
35
36	#include <iprt/assert.h>
37	#include <iprt/spinlock.h>
38	#include <iprt/semaphore.h>
39	#include <iprt/initterm.h>
40	#include <iprt/process.h>
41	#include <VBox/err.h>
42	#include <iprt/mem.h>
43	#include <VBox/log.h>
44	#include <iprt/mp.h>
45
46	/** @todo figure out the exact version number */
47	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 16)
48	# include <iprt/power.h>
49	# define VBOX_WITH_SUSPEND_NOTIFICATION
50	#endif
51
52	#include <linux/sched.h>
53	#ifdef CONFIG_DEVFS_FS
54	# include <linux/devfs_fs_kernel.h>
55	#endif
56	#ifdef CONFIG_VBOXDRV_AS_MISC
57	# include <linux/miscdevice.h>
58	#endif
59	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
60	# include <linux/platform_device.h>
61	#endif
62	#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 28)) && defined(SUPDRV_WITH_MSR_PROBER)
63	# define SUPDRV_LINUX_HAS_SAFE_MSR_API
64	# include <asm/msr.h>
65	# include <iprt/asm-amd64-x86.h>
66	#endif
67
68
69
70	/*******************************************************************************
71	* Defined Constants And Macros *
72	*******************************************************************************/
73	/* check kernel version */
74	# ifndef SUPDRV_AGNOSTIC
75	# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
76	# error Unsupported kernel version!
77	# endif
78	# endif
79
80	/* devfs defines */
81	#if defined(CONFIG_DEVFS_FS) && !defined(CONFIG_VBOXDRV_AS_MISC)
82	# ifdef VBOX_WITH_HARDENING
83	# define VBOX_DEV_FMASK (S_IWUSR \| S_IRUSR)
84	# else
85	# define VBOX_DEV_FMASK (S_IRUGO \| S_IWUGO)
86	# endif
87	#endif /* CONFIG_DEV_FS && !CONFIG_VBOXDEV_AS_MISC */
88
89	#ifdef CONFIG_X86_HIGH_ENTRY
90	# error "CONFIG_X86_HIGH_ENTRY is not supported by VBoxDrv at this time."
91	#endif
92
93	/* to include the version number of VirtualBox into kernel backtraces */
94	#define VBoxDrvLinuxVersion RT_CONCAT3(RT_CONCAT(VBOX_VERSION_MAJOR, _), \
95	RT_CONCAT(VBOX_VERSION_MINOR, _), \
96	VBOX_VERSION_BUILD)
97	#define VBoxDrvLinuxIOCtl RT_CONCAT(VBoxDrvLinuxIOCtl_,VBoxDrvLinuxVersion)
98
99	/*******************************************************************************
100	* Internal Functions *
101	*******************************************************************************/
102	static int VBoxDrvLinuxInit(void);
103	static void VBoxDrvLinuxUnload(void);
104	static int VBoxDrvLinuxCreateSys(struct inode pInode, struct file pFilp);
105	static int VBoxDrvLinuxCreateUsr(struct inode pInode, struct file pFilp);
106	static int VBoxDrvLinuxClose(struct inode pInode, struct file pFilp);
107	#ifdef HAVE_UNLOCKED_IOCTL
108	static long VBoxDrvLinuxIOCtl(struct file *pFilp, unsigned int uCmd, unsigned long ulArg);
109	#else
110	static int VBoxDrvLinuxIOCtl(struct inode pInode, struct file pFilp, unsigned int uCmd, unsigned long ulArg);
111	#endif
112	static int VBoxDrvLinuxIOCtlSlow(struct file *pFilp, unsigned int uCmd, unsigned long ulArg, PSUPDRVSESSION pSession);
113	static int VBoxDrvLinuxErr2LinuxErr(int);
114	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
115	static int VBoxDrvProbe(struct platform_device *pDev);
116	# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
117	static int VBoxDrvSuspend(struct device *pDev);
118	static int VBoxDrvResume(struct device *pDev);
119	# else
120	static int VBoxDrvSuspend(struct platform_device *pDev, pm_message_t State);
121	static int VBoxDrvResume(struct platform_device *pDev);
122	# endif
123	static void VBoxDevRelease(struct device *pDev);
124	#endif
125
126
127	/*******************************************************************************
128	* Global Variables *
129	*******************************************************************************/
130	/**
131	* Device extention & session data association structure.
132	*/
133	static SUPDRVDEVEXT g_DevExt;
134
135	#ifndef CONFIG_VBOXDRV_AS_MISC
136	/** Module major number for vboxdrv. */
137	#define DEVICE_MAJOR_SYS 234
138	/** Saved major device number for vboxdrv. */
139	static int g_iModuleMajorSys;
140	/** Module major number for vboxdrvu. */
141	#define DEVICE_MAJOR_USR 235
142	/** Saved major device number for vboxdrvu. */
143	static int g_iModuleMajorUsr;
144	#endif /* !CONFIG_VBOXDRV_AS_MISC */
145
146	/** Module parameter.
147	* Not prefixed because the name is used by macros and the end of this file. */
148	static int force_async_tsc = 0;
149
150	/** The system device name. */
151	#define DEVICE_NAME_SYS "vboxdrv"
152	/** The user device name. */
153	#define DEVICE_NAME_USR "vboxdrvu"
154
155	#if (defined(RT_ARCH_AMD64) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 23)) \|\| defined(VBOX_WITH_TEXT_MODMEM_HACK)
156	/**
157	* Memory for the executable memory heap (in IPRT).
158	*/
159	# ifdef DEBUG
160	# define EXEC_MEMORY_SIZE 6291456 /* 6 MB */
161	# else
162	# define EXEC_MEMORY_SIZE 1572864 /* 1.5 MB */
163	# endif
164	extern uint8_t g_abExecMemory[EXEC_MEMORY_SIZE];
165	# ifndef VBOX_WITH_TEXT_MODMEM_HACK
166	__asm__(".section execmemory, \"awx\", @progbits\n\t"
167	".align 32\n\t"
168	".globl g_abExecMemory\n"
169	"g_abExecMemory:\n\t"
170	".zero " RT_XSTR(EXEC_MEMORY_SIZE) "\n\t"
171	".type g_abExecMemory, @object\n\t"
172	".size g_abExecMemory, " RT_XSTR(EXEC_MEMORY_SIZE) "\n\t"
173	".text\n\t");
174	# else
175	__asm__(".text\n\t"
176	".align 4096\n\t"
177	".globl g_abExecMemory\n"
178	"g_abExecMemory:\n\t"
179	".zero " RT_XSTR(EXEC_MEMORY_SIZE) "\n\t"
180	".type g_abExecMemory, @object\n\t"
181	".size g_abExecMemory, " RT_XSTR(EXEC_MEMORY_SIZE) "\n\t"
182	".text\n\t");
183	# endif
184	#endif
185
186	/** The file_operations structure. */
187	static struct file_operations gFileOpsVBoxDrvSys =
188	{
189	owner: THIS_MODULE,
190	open: VBoxDrvLinuxCreateSys,
191	release: VBoxDrvLinuxClose,
192	#ifdef HAVE_UNLOCKED_IOCTL
193	unlocked_ioctl: VBoxDrvLinuxIOCtl,
194	#else
195	ioctl: VBoxDrvLinuxIOCtl,
196	#endif
197	};
198
199	/** The file_operations structure. */
200	static struct file_operations gFileOpsVBoxDrvUsr =
201	{
202	owner: THIS_MODULE,
203	open: VBoxDrvLinuxCreateUsr,
204	release: VBoxDrvLinuxClose,
205	#ifdef HAVE_UNLOCKED_IOCTL
206	unlocked_ioctl: VBoxDrvLinuxIOCtl,
207	#else
208	ioctl: VBoxDrvLinuxIOCtl,
209	#endif
210	};
211
212	#ifdef CONFIG_VBOXDRV_AS_MISC
213	/** The miscdevice structure for vboxdrv. */
214	static struct miscdevice gMiscDeviceSys =
215	{
216	minor: MISC_DYNAMIC_MINOR,
217	name: DEVICE_NAME_SYS,
218	fops: &gFileOpsVBoxDrvSys,
219	# if LINUX_VERSION_CODE <= KERNEL_VERSION(2, 6, 17)
220	devfs_name: DEVICE_NAME_SYS,
221	# endif
222	};
223	/** The miscdevice structure for vboxdrvu. */
224	static struct miscdevice gMiscDeviceUsr =
225	{
226	minor: MISC_DYNAMIC_MINOR,
227	name: DEVICE_NAME_USR,
228	fops: &gFileOpsVBoxDrvUsr,
229	# if LINUX_VERSION_CODE <= KERNEL_VERSION(2, 6, 17)
230	devfs_name: DEVICE_NAME_USR,
231	# endif
232	};
233	#endif
234
235
236	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
237	# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
238	static struct dev_pm_ops gPlatformPMOps =
239	{
240	.suspend = VBoxDrvSuspend, /* before entering deep sleep */
241	.resume = VBoxDrvResume, /* after wakeup from deep sleep */
242	.freeze = VBoxDrvSuspend, /* before creating hibernation image */
243	.restore = VBoxDrvResume, /* after waking up from hibernation */
244	};
245	# endif
246
247	static struct platform_driver gPlatformDriver =
248	{
249	.probe = VBoxDrvProbe,
250	# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 30)
251	.suspend = VBoxDrvSuspend,
252	.resume = VBoxDrvResume,
253	# endif
254	/** @todo .shutdown? */
255	.driver =
256	{
257	.name = "vboxdrv",
258	# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
259	.pm = &gPlatformPMOps,
260	# endif
261	}
262	};
263
264	static struct platform_device gPlatformDevice =
265	{
266	.name = "vboxdrv",
267	.dev =
268	{
269	.release = VBoxDevRelease
270	}
271	};
272	#endif /* VBOX_WITH_SUSPEND_NOTIFICATION */
273
274
275	DECLINLINE(RTUID) vboxdrvLinuxUid(void)
276	{
277	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29)
278	# if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0)
279	return from_kuid(current_user_ns(), current->cred->uid);
280	# else
281	return current->cred->uid;
282	# endif
283	#else
284	return current->uid;
285	#endif
286	}
287
288	DECLINLINE(RTGID) vboxdrvLinuxGid(void)
289	{
290	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29)
291	# if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0)
292	return from_kgid(current_user_ns(), current->cred->gid);
293	# else
294	return current->cred->gid;
295	# endif
296	#else
297	return current->gid;
298	#endif
299	}
300
301	DECLINLINE(RTUID) vboxdrvLinuxEuid(void)
302	{
303	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29)
304	# if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0)
305	return from_kuid(current_user_ns(), current->cred->euid);
306	# else
307	return current->cred->euid;
308	# endif
309	#else
310	return current->euid;
311	#endif
312	}
313
314	/**
315	* Initialize module.
316	*
317	* @returns appropriate status code.
318	*/
319	static int __init VBoxDrvLinuxInit(void)
320	{
321	int rc;
322
323	/*
324	* Check for synchronous/asynchronous TSC mode.
325	*/
326	printk(KERN_DEBUG "vboxdrv: Found %u processor cores.\n", (unsigned)RTMpGetOnlineCount());
327	#ifdef CONFIG_VBOXDRV_AS_MISC
328	rc = misc_register(&gMiscDeviceSys);
329	if (rc)
330	{
331	printk(KERN_ERR "vboxdrv: Can't register system misc device! rc=%d\n", rc);
332	return rc;
333	}
334	rc = misc_register(&gMiscDeviceUsr);
335	if (rc)
336	{
337	printk(KERN_ERR "vboxdrv: Can't register user misc device! rc=%d\n", rc);
338	misc_deregister(&gMiscDeviceSys);
339	return rc;
340	}
341	#else /* !CONFIG_VBOXDRV_AS_MISC */
342	/*
343	* Register character devices and save the returned major numbers.
344	*/
345	/* /dev/vboxdrv */
346	g_iModuleMajorSys = DEVICE_MAJOR_SYS;
347	rc = register_chrdev((dev_t)g_iModuleMajorSys, DEVICE_NAME_SYS, &gFileOpsVBoxDrvSys);
348	if (rc < 0)
349	{
350	Log(("register_chrdev() failed with rc=%#x for vboxdrv!\n", rc));
351	return rc;
352	}
353	if (DEVICE_MAJOR_SYS != 0)
354	g_iModuleMajorSys = DEVICE_MAJOR_SYS;
355	else
356	g_iModuleMajorSys = rc;
357
358	/* /dev/vboxdrvu */
359	/** @todo Use a minor number of this bugger (not sure if this code is used
360	* though, so not bothering right now.) */
361	g_iModuleMajorUsr = DEVICE_MAJOR_USR;
362	rc = register_chrdev((dev_t)g_iModuleMajorUsr, DEVICE_NAME_USR, &gFileOpsVBoxDrvUsr);
363	if (rc < 0)
364	{
365	Log(("register_chrdev() failed with rc=%#x for vboxdrv!\n", rc));
366	return rc;
367	}
368	if (DEVICE_MAJOR_USR != 0)
369	g_iModuleMajorUsr = DEVICE_MAJOR_USR;
370	else
371	g_iModuleMajorUsr = rc;
372	rc = 0;
373
374	# ifdef CONFIG_DEVFS_FS
375	/*
376	* Register a device entry
377	*/
378	if ( devfs_mk_cdev(MKDEV(DEVICE_MAJOR_SYS, 0), S_IFCHR \| VBOX_DEV_FMASK, DEVICE_NAME_SYS) != 0
379	\|\| devfs_mk_cdev(MKDEV(DEVICE_MAJOR_USR, 0), S_IFCHR \| VBOX_DEV_FMASK, DEVICE_NAME_USR) != 0)
380	{
381	Log(("devfs_register failed!\n"));
382	rc = -EINVAL;
383	}
384	# endif
385	#endif /* !CONFIG_VBOXDRV_AS_MISC */
386	if (!rc)
387	{
388	/*
389	* Initialize the runtime.
390	* On AMD64 we'll have to donate the high rwx memory block to the exec allocator.
391	*/
392	rc = RTR0Init(0);
393	if (RT_SUCCESS(rc))
394	{
395	#if (defined(RT_ARCH_AMD64) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 23)) \|\| defined(VBOX_WITH_TEXT_MODMEM_HACK)
396	# ifdef VBOX_WITH_TEXT_MODMEM_HACK
397	set_memory_x(&g_abExecMemory[0], sizeof(g_abExecMemory) / PAGE_SIZE);
398	set_memory_rw(&g_abExecMemory[0], sizeof(g_abExecMemory) / PAGE_SIZE);
399	# endif
400	rc = RTR0MemExecDonate(&g_abExecMemory[0], sizeof(g_abExecMemory));
401	printk(KERN_DEBUG "VBoxDrv: dbg - g_abExecMemory=%p\n", (void *)&g_abExecMemory[0]);
402	#endif
403	Log(("VBoxDrv::ModuleInit\n"));
404
405	/*
406	* Initialize the device extension.
407	*/
408	if (RT_SUCCESS(rc))
409	rc = supdrvInitDevExt(&g_DevExt, sizeof(SUPDRVSESSION));
410	if (RT_SUCCESS(rc))
411	{
412	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
413	rc = platform_driver_register(&gPlatformDriver);
414	if (rc == 0)
415	{
416	rc = platform_device_register(&gPlatformDevice);
417	if (rc == 0)
418	#endif
419	{
420	printk(KERN_INFO "vboxdrv: TSC mode is %s, kernel timer mode is 'normal'.\n",
421	g_DevExt.pGip->u32Mode == SUPGIPMODE_SYNC_TSC ? "'synchronous'" : "'asynchronous'");
422	LogFlow(("VBoxDrv::ModuleInit returning %#x\n", rc));
423	printk(KERN_DEBUG "vboxdrv: Successfully loaded version "
424	VBOX_VERSION_STRING " (interface " RT_XSTR(SUPDRV_IOC_VERSION) ").\n");
425	return rc;
426	}
427	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
428	else
429	platform_driver_unregister(&gPlatformDriver);
430	}
431	#endif
432	}
433
434	rc = -EINVAL;
435	RTR0TermForced();
436	}
437	else
438	rc = -EINVAL;
439
440	/*
441	* Failed, cleanup and return the error code.
442	*/
443	#if defined(CONFIG_DEVFS_FS) && !defined(CONFIG_VBOXDRV_AS_MISC)
444	devfs_remove(DEVICE_NAME_SYS);
445	devfs_remove(DEVICE_NAME_USR);
446	#endif
447	}
448	#ifdef CONFIG_VBOXDRV_AS_MISC
449	misc_deregister(&gMiscDeviceSys);
450	misc_deregister(&gMiscDeviceUsr);
451	Log(("VBoxDrv::ModuleInit returning %#x (minor:%d & %d)\n", rc, gMiscDeviceSys.minor, gMiscDeviceUsr.minor));
452	#else
453	unregister_chrdev(g_iModuleMajorUsr, DEVICE_NAME_USR);
454	unregister_chrdev(g_iModuleMajorSys, DEVICE_NAME_SYS);
455	Log(("VBoxDrv::ModuleInit returning %#x (major:%d & %d)\n", rc, g_iModuleMajorSys, g_iModuleMajorUsr));
456	#endif
457	return rc;
458	}
459
460
461	/**
462	* Unload the module.
463	*/
464	static void __exit VBoxDrvLinuxUnload(void)
465	{
466	int rc;
467	Log(("VBoxDrvLinuxUnload\n"));
468	NOREF(rc);
469
470	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
471	platform_device_unregister(&gPlatformDevice);
472	platform_driver_unregister(&gPlatformDriver);
473	#endif
474
475	/*
476	* I Don't think it's possible to unload a driver which processes have
477	* opened, at least we'll blindly assume that here.
478	*/
479	#ifdef CONFIG_VBOXDRV_AS_MISC
480	rc = misc_deregister(&gMiscDeviceUsr);
481	if (rc < 0)
482	{
483	Log(("misc_deregister failed with rc=%#x on vboxdrvu\n", rc));
484	}
485	rc = misc_deregister(&gMiscDeviceSys);
486	if (rc < 0)
487	{
488	Log(("misc_deregister failed with rc=%#x on vboxdrv\n", rc));
489	}
490	#else /* !CONFIG_VBOXDRV_AS_MISC */
491	# ifdef CONFIG_DEVFS_FS
492	/*
493	* Unregister a device entry
494	*/
495	devfs_remove(DEVICE_NAME_USR);
496	devfs_remove(DEVICE_NAME_SYS);
497	# endif /* devfs */
498	unregister_chrdev(g_iModuleMajorUsr, DEVICE_NAME_USR);
499	unregister_chrdev(g_iModuleMajorSys, DEVICE_NAME_SYS);
500	#endif /* !CONFIG_VBOXDRV_AS_MISC */
501
502	/*
503	* Destroy GIP, delete the device extension and terminate IPRT.
504	*/
505	supdrvDeleteDevExt(&g_DevExt);
506	RTR0TermForced();
507	}
508
509
510	/**
511	* Common open code.
512	*
513	* @param pInode Pointer to inode info structure.
514	* @param pFilp Associated file pointer.
515	* @param fUnrestricted Indicates which device node which was opened.
516	*/
517	static int vboxdrvLinuxCreateCommon(struct inode pInode, struct file pFilp, bool fUnrestricted)
518	{
519	int rc;
520	PSUPDRVSESSION pSession;
521	Log(("VBoxDrvLinuxCreate: pFilp=%p pid=%d/%d %s\n", pFilp, RTProcSelf(), current->pid, current->comm));
522
523	#ifdef VBOX_WITH_HARDENING
524	/*
525	* Only root is allowed to access the unrestricted device, enforce it!
526	*/
527	if ( fUnrestricted
528	&& vboxdrvLinuxEuid() != 0 /* root */ )
529	{
530	Log(("VBoxDrvLinuxCreate: euid=%d, expected 0 (root)\n", vboxdrvLinuxEuid()));
531	return -EPERM;
532	}
533	#endif /* VBOX_WITH_HARDENING */
534
535	/*
536	* Call common code for the rest.
537	*/
538	rc = supdrvCreateSession(&g_DevExt, true /* fUser */, fUnrestricted, &pSession);
539	if (!rc)
540	{
541	pSession->Uid = vboxdrvLinuxUid();
542	pSession->Gid = vboxdrvLinuxGid();
543	}
544
545	pFilp->private_data = pSession;
546
547	Log(("VBoxDrvLinuxCreate: g_DevExt=%p pSession=%p rc=%d/%d (pid=%d/%d %s)\n",
548	&g_DevExt, pSession, rc, VBoxDrvLinuxErr2LinuxErr(rc),
549	RTProcSelf(), current->pid, current->comm));
550	return VBoxDrvLinuxErr2LinuxErr(rc);
551	}
552
553
554	/** /dev/vboxdrv. */
555	static int VBoxDrvLinuxCreateSys(struct inode pInode, struct file pFilp)
556	{
557	return vboxdrvLinuxCreateCommon(pInode, pFilp, true);
558	}
559
560
561	/** /dev/vboxdrvu. */
562	static int VBoxDrvLinuxCreateUsr(struct inode pInode, struct file pFilp)
563	{
564	return vboxdrvLinuxCreateCommon(pInode, pFilp, false);
565	}
566
567
568	/**
569	* Close device.
570	*
571	* @param pInode Pointer to inode info structure.
572	* @param pFilp Associated file pointer.
573	*/
574	static int VBoxDrvLinuxClose(struct inode pInode, struct file pFilp)
575	{
576	Log(("VBoxDrvLinuxClose: pFilp=%p pSession=%p pid=%d/%d %s\n",
577	pFilp, pFilp->private_data, RTProcSelf(), current->pid, current->comm));
578	supdrvSessionRelease((PSUPDRVSESSION)pFilp->private_data);
579	pFilp->private_data = NULL;
580	return 0;
581	}
582
583
584	#ifdef VBOX_WITH_SUSPEND_NOTIFICATION
585	/**
586	* Dummy device release function. We have to provide this function,
587	* otherwise the kernel will complain.
588	*
589	* @param pDev Pointer to the platform device.
590	*/
591	static void VBoxDevRelease(struct device *pDev)
592	{
593	}
594
595	/**
596	* Dummy probe function.
597	*
598	* @param pDev Pointer to the platform device.
599	*/
600	static int VBoxDrvProbe(struct platform_device *pDev)
601	{
602	return 0;
603	}
604
605	/**
606	* Suspend callback.
607	* @param pDev Pointer to the platform device.
608	* @param State message type, see Documentation/power/devices.txt.
609	*/
610	# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
611	static int VBoxDrvSuspend(struct device *pDev)
612	# else
613	static int VBoxDrvSuspend(struct platform_device *pDev, pm_message_t State)
614	# endif
615	{
616	RTPowerSignalEvent(RTPOWEREVENT_SUSPEND);
617	return 0;
618	}
619
620	/**
621	* Resume callback.
622	*
623	* @param pDev Pointer to the platform device.
624	*/
625	# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
626	static int VBoxDrvResume(struct device *pDev)
627	# else
628	static int VBoxDrvResume(struct platform_device *pDev)
629	# endif
630	{
631	RTPowerSignalEvent(RTPOWEREVENT_RESUME);
632	return 0;
633	}
634	#endif /* VBOX_WITH_SUSPEND_NOTIFICATION */
635
636
637	/**
638	* Device I/O Control entry point.
639	*
640	* @param pFilp Associated file pointer.
641	* @param uCmd The function specified to ioctl().
642	* @param ulArg The argument specified to ioctl().
643	*/
644	#ifdef HAVE_UNLOCKED_IOCTL
645	static long VBoxDrvLinuxIOCtl(struct file *pFilp, unsigned int uCmd, unsigned long ulArg)
646	#else
647	static int VBoxDrvLinuxIOCtl(struct inode pInode, struct file pFilp, unsigned int uCmd, unsigned long ulArg)
648	#endif
649	{
650	PSUPDRVSESSION pSession = (PSUPDRVSESSION)pFilp->private_data;
651
652	/*
653	* Deal with the two high-speed IOCtl that takes it's arguments from
654	* the session and iCmd, and only returns a VBox status code.
655	*/
656	#ifdef HAVE_UNLOCKED_IOCTL
657	if (RT_LIKELY( ( uCmd == SUP_IOCTL_FAST_DO_RAW_RUN
658	\|\| uCmd == SUP_IOCTL_FAST_DO_HM_RUN
659	\|\| uCmd == SUP_IOCTL_FAST_DO_NOP)
660	&& pSession->fUnrestricted == true))
661	return supdrvIOCtlFast(uCmd, ulArg, &g_DevExt, pSession);
662	return VBoxDrvLinuxIOCtlSlow(pFilp, uCmd, ulArg, pSession);
663
664	#else /* !HAVE_UNLOCKED_IOCTL */
665
666	int rc;
667	unlock_kernel();
668	if (RT_LIKELY( ( uCmd == SUP_IOCTL_FAST_DO_RAW_RUN
669	\|\| uCmd == SUP_IOCTL_FAST_DO_HM_RUN
670	\|\| uCmd == SUP_IOCTL_FAST_DO_NOP)
671	&& pSession->fUnrestricted == true))
672	rc = supdrvIOCtlFast(uCmd, ulArg, &g_DevExt, pSession);
673	else
674	rc = VBoxDrvLinuxIOCtlSlow(pFilp, uCmd, ulArg, pSession);
675	lock_kernel();
676	return rc;
677	#endif /* !HAVE_UNLOCKED_IOCTL */
678	}
679
680
681	/**
682	* Device I/O Control entry point.
683	*
684	* @param pFilp Associated file pointer.
685	* @param uCmd The function specified to ioctl().
686	* @param ulArg The argument specified to ioctl().
687	* @param pSession The session instance.
688	*/
689	static int VBoxDrvLinuxIOCtlSlow(struct file *pFilp, unsigned int uCmd, unsigned long ulArg, PSUPDRVSESSION pSession)
690	{
691	int rc;
692	SUPREQHDR Hdr;
693	PSUPREQHDR pHdr;
694	uint32_t cbBuf;
695
696	Log6(("VBoxDrvLinuxIOCtl: pFilp=%p uCmd=%#x ulArg=%p pid=%d/%d\n", pFilp, uCmd, (void *)ulArg, RTProcSelf(), current->pid));
697
698	/*
699	* Read the header.
700	*/
701	if (RT_UNLIKELY(copy_from_user(&Hdr, (void *)ulArg, sizeof(Hdr))))
702	{
703	Log(("VBoxDrvLinuxIOCtl: copy_from_user(,%#lx,) failed; uCmd=%#x.\n", ulArg, uCmd));
704	return -EFAULT;
705	}
706	if (RT_UNLIKELY((Hdr.fFlags & SUPREQHDR_FLAGS_MAGIC_MASK) != SUPREQHDR_FLAGS_MAGIC))
707	{
708	Log(("VBoxDrvLinuxIOCtl: bad header magic %#x; uCmd=%#x\n", Hdr.fFlags & SUPREQHDR_FLAGS_MAGIC_MASK, uCmd));
709	return -EINVAL;
710	}
711
712	/*
713	* Buffer the request.
714	*/
715	cbBuf = RT_MAX(Hdr.cbIn, Hdr.cbOut);
716	if (RT_UNLIKELY(cbBuf > _1M*16))
717	{
718	Log(("VBoxDrvLinuxIOCtl: too big cbBuf=%#x; uCmd=%#x\n", cbBuf, uCmd));
719	return -E2BIG;
720	}
721	if (RT_UNLIKELY(_IOC_SIZE(uCmd) ? cbBuf != _IOC_SIZE(uCmd) : Hdr.cbIn < sizeof(Hdr)))
722	{
723	Log(("VBoxDrvLinuxIOCtl: bad ioctl cbBuf=%#x _IOC_SIZE=%#x; uCmd=%#x.\n", cbBuf, _IOC_SIZE(uCmd), uCmd));
724	return -EINVAL;
725	}
726	pHdr = RTMemAlloc(cbBuf);
727	if (RT_UNLIKELY(!pHdr))
728	{
729	OSDBGPRINT(("VBoxDrvLinuxIOCtl: failed to allocate buffer of %d bytes for uCmd=%#x.\n", cbBuf, uCmd));
730	return -ENOMEM;
731	}
732	if (RT_UNLIKELY(copy_from_user(pHdr, (void *)ulArg, Hdr.cbIn)))
733	{
734	Log(("VBoxDrvLinuxIOCtl: copy_from_user(,%#lx, %#x) failed; uCmd=%#x.\n", ulArg, Hdr.cbIn, uCmd));
735	RTMemFree(pHdr);
736	return -EFAULT;
737	}
738	if (Hdr.cbIn < cbBuf)
739	RT_BZERO((uint8_t *)pHdr + Hdr.cbIn, cbBuf - Hdr.cbIn);
740
741	/*
742	* Process the IOCtl.
743	*/
744	rc = supdrvIOCtl(uCmd, &g_DevExt, pSession, pHdr, cbBuf);
745
746	/*
747	* Copy ioctl data and output buffer back to user space.
748	*/
749	if (RT_LIKELY(!rc))
750	{
751	uint32_t cbOut = pHdr->cbOut;
752	if (RT_UNLIKELY(cbOut > cbBuf))
753	{
754	OSDBGPRINT(("VBoxDrvLinuxIOCtl: too much output! %#x > %#x; uCmd=%#x!\n", cbOut, cbBuf, uCmd));
755	cbOut = cbBuf;
756	}
757	if (RT_UNLIKELY(copy_to_user((void *)ulArg, pHdr, cbOut)))
758	{
759	/* this is really bad! */
760	OSDBGPRINT(("VBoxDrvLinuxIOCtl: copy_to_user(%#lx,,%#x); uCmd=%#x!\n", ulArg, cbOut, uCmd));
761	rc = -EFAULT;
762	}
763	}
764	else
765	{
766	Log(("VBoxDrvLinuxIOCtl: pFilp=%p uCmd=%#x ulArg=%p failed, rc=%d\n", pFilp, uCmd, (void *)ulArg, rc));
767	rc = -EINVAL;
768	}
769	RTMemFree(pHdr);
770
771	Log6(("VBoxDrvLinuxIOCtl: returns %d (pid=%d/%d)\n", rc, RTProcSelf(), current->pid));
772	return rc;
773	}
774
775
776	/**
777	* The SUPDRV IDC entry point.
778	*
779	* @returns VBox status code, see supdrvIDC.
780	* @param iReq The request code.
781	* @param pReq The request.
782	*/
783	int VBOXCALL SUPDrvLinuxIDC(uint32_t uReq, PSUPDRVIDCREQHDR pReq)
784	{
785	PSUPDRVSESSION pSession;
786
787	/*
788	* Some quick validations.
789	*/
790	if (RT_UNLIKELY(!VALID_PTR(pReq)))
791	return VERR_INVALID_POINTER;
792
793	pSession = pReq->pSession;
794	if (pSession)
795	{
796	if (RT_UNLIKELY(!VALID_PTR(pSession)))
797	return VERR_INVALID_PARAMETER;
798	if (RT_UNLIKELY(pSession->pDevExt != &g_DevExt))
799	return VERR_INVALID_PARAMETER;
800	}
801	else if (RT_UNLIKELY(uReq != SUPDRV_IDC_REQ_CONNECT))
802	return VERR_INVALID_PARAMETER;
803
804	/*
805	* Do the job.
806	*/
807	return supdrvIDC(uReq, &g_DevExt, pSession, pReq);
808	}
809
810	EXPORT_SYMBOL(SUPDrvLinuxIDC);
811
812
813	void VBOXCALL supdrvOSCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
814	{
815	NOREF(pDevExt);
816	NOREF(pSession);
817	}
818
819
820	void VBOXCALL supdrvOSSessionHashTabInserted(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, void *pvUser)
821	{
822	NOREF(pDevExt); NOREF(pSession); NOREF(pvUser);
823	}
824
825
826	void VBOXCALL supdrvOSSessionHashTabRemoved(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, void *pvUser)
827	{
828	NOREF(pDevExt); NOREF(pSession); NOREF(pvUser);
829	}
830
831
832	/**
833	* Initializes any OS specific object creator fields.
834	*/
835	void VBOXCALL supdrvOSObjInitCreator(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession)
836	{
837	NOREF(pObj);
838	NOREF(pSession);
839	}
840
841
842	/**
843	* Checks if the session can access the object.
844	*
845	* @returns true if a decision has been made.
846	* @returns false if the default access policy should be applied.
847	*
848	* @param pObj The object in question.
849	* @param pSession The session wanting to access the object.
850	* @param pszObjName The object name, can be NULL.
851	* @param prc Where to store the result when returning true.
852	*/
853	bool VBOXCALL supdrvOSObjCanAccess(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession, const char pszObjName, int prc)
854	{
855	NOREF(pObj);
856	NOREF(pSession);
857	NOREF(pszObjName);
858	NOREF(prc);
859	return false;
860	}
861
862
863	bool VBOXCALL supdrvOSGetForcedAsyncTscMode(PSUPDRVDEVEXT pDevExt)
864	{
865	return force_async_tsc != 0;
866	}
867
868
869	int VBOXCALL supdrvOSLdrOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, const char *pszFilename)
870	{
871	NOREF(pDevExt); NOREF(pImage); NOREF(pszFilename);
872	return VERR_NOT_SUPPORTED;
873	}
874
875
876	void VBOXCALL supdrvOSLdrNotifyOpened(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage)
877	{
878	NOREF(pDevExt); NOREF(pImage);
879	}
880
881
882	int VBOXCALL supdrvOSLdrValidatePointer(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, void pv, const uint8_t pbImageBits)
883	{
884	NOREF(pDevExt); NOREF(pImage); NOREF(pv); NOREF(pbImageBits);
885	return VERR_NOT_SUPPORTED;
886	}
887
888
889	int VBOXCALL supdrvOSLdrLoad(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, const uint8_t *pbImageBits, PSUPLDRLOAD pReq)
890	{
891	NOREF(pDevExt); NOREF(pImage); NOREF(pbImageBits); NOREF(pReq);
892	return VERR_NOT_SUPPORTED;
893	}
894
895
896	void VBOXCALL supdrvOSLdrUnload(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage)
897	{
898	NOREF(pDevExt); NOREF(pImage);
899	}
900
901
902	#ifdef SUPDRV_WITH_MSR_PROBER
903
904	int VBOXCALL supdrvOSMsrProberRead(uint32_t uMsr, RTCPUID idCpu, uint64_t *puValue)
905	{
906	# ifdef SUPDRV_LINUX_HAS_SAFE_MSR_API
907	uint32_t u32Low, u32High;
908	int rc;
909
910	if (idCpu == NIL_RTCPUID)
911	rc = rdmsr_safe(uMsr, &u32Low, &u32High);
912	else if (RTMpIsCpuOnline(idCpu))
913	rc = rdmsr_safe_on_cpu(idCpu, uMsr, &u32Low, &u32High);
914	else
915	return VERR_CPU_OFFLINE;
916	if (rc == 0)
917	{
918	*puValue = RT_MAKE_U64(u32Low, u32High);
919	return VINF_SUCCESS;
920	}
921	return VERR_ACCESS_DENIED;
922	# else
923	return VERR_NOT_SUPPORTED;
924	# endif
925	}
926
927
928	int VBOXCALL supdrvOSMsrProberWrite(uint32_t uMsr, RTCPUID idCpu, uint64_t uValue)
929	{
930	# ifdef SUPDRV_LINUX_HAS_SAFE_MSR_API
931	int rc;
932
933	if (idCpu == NIL_RTCPUID)
934	rc = wrmsr_safe(uMsr, RT_LODWORD(uValue), RT_HIDWORD(uValue));
935	else if (RTMpIsCpuOnline(idCpu))
936	rc = wrmsr_safe_on_cpu(idCpu, uMsr, RT_LODWORD(uValue), RT_HIDWORD(uValue));
937	else
938	return VERR_CPU_OFFLINE;
939	if (rc == 0)
940	return VINF_SUCCESS;
941	return VERR_ACCESS_DENIED;
942	# else
943	return VERR_NOT_SUPPORTED;
944	# endif
945	}
946
947	# ifdef SUPDRV_LINUX_HAS_SAFE_MSR_API
948	/**
949	* Worker for supdrvOSMsrProberModify.
950	*/
951	static DECLCALLBACK(void) supdrvLnxMsrProberModifyOnCpu(RTCPUID idCpu, void pvUser1, void pvUser2)
952	{
953	PSUPMSRPROBER pReq = (PSUPMSRPROBER)pvUser1;
954	register uint32_t uMsr = pReq->u.In.uMsr;
955	bool const fFaster = pReq->u.In.enmOp == SUPMSRPROBEROP_MODIFY_FASTER;
956	uint64_t uBefore;
957	uint64_t uWritten;
958	uint64_t uAfter;
959	int rcBefore, rcWrite, rcAfter, rcRestore;
960	RTCCUINTREG fOldFlags;
961
962	/* Initialize result variables. */
963	uBefore = uWritten = uAfter = 0;
964	rcWrite = rcAfter = rcRestore = -EIO;
965
966	/*
967	* Do the job.
968	*/
969	fOldFlags = ASMIntDisableFlags();
970	ASMCompilerBarrier(); /* paranoia */
971	if (!fFaster)
972	ASMWriteBackAndInvalidateCaches();
973
974	rcBefore = rdmsrl_safe(uMsr, &uBefore);
975	if (rcBefore >= 0)
976	{
977	register uint64_t uRestore = uBefore;
978	uWritten = uRestore;
979	uWritten &= pReq->u.In.uArgs.Modify.fAndMask;
980	uWritten \|= pReq->u.In.uArgs.Modify.fOrMask;
981
982	rcWrite = wrmsr_safe(uMsr, RT_LODWORD(uWritten), RT_HIDWORD(uWritten));
983	rcAfter = rdmsrl_safe(uMsr, &uAfter);
984	rcRestore = wrmsr_safe(uMsr, RT_LODWORD(uRestore), RT_HIDWORD(uRestore));
985
986	if (!fFaster)
987	{
988	ASMWriteBackAndInvalidateCaches();
989	ASMReloadCR3();
990	ASMNopPause();
991	}
992	}
993
994	ASMCompilerBarrier(); /* paranoia */
995	ASMSetFlags(fOldFlags);
996
997	/*
998	* Write out the results.
999	*/
1000	pReq->u.Out.uResults.Modify.uBefore = uBefore;
1001	pReq->u.Out.uResults.Modify.uWritten = uWritten;
1002	pReq->u.Out.uResults.Modify.uAfter = uAfter;
1003	pReq->u.Out.uResults.Modify.fBeforeGp = rcBefore != 0;
1004	pReq->u.Out.uResults.Modify.fModifyGp = rcWrite != 0;
1005	pReq->u.Out.uResults.Modify.fAfterGp = rcAfter != 0;
1006	pReq->u.Out.uResults.Modify.fRestoreGp = rcRestore != 0;
1007	RT_ZERO(pReq->u.Out.uResults.Modify.afReserved);
1008	}
1009	# endif
1010
1011
1012	int VBOXCALL supdrvOSMsrProberModify(RTCPUID idCpu, PSUPMSRPROBER pReq)
1013	{
1014	# ifdef SUPDRV_LINUX_HAS_SAFE_MSR_API
1015	if (idCpu == NIL_RTCPUID)
1016	{
1017	supdrvLnxMsrProberModifyOnCpu(idCpu, pReq, NULL);
1018	return VINF_SUCCESS;
1019	}
1020	return RTMpOnSpecific(idCpu, supdrvLnxMsrProberModifyOnCpu, pReq, NULL);
1021	# else
1022	return VERR_NOT_SUPPORTED;
1023	# endif
1024	}
1025
1026	#endif /* SUPDRV_WITH_MSR_PROBER */
1027
1028
1029	/**
1030	* Converts a supdrv error code to an linux error code.
1031	*
1032	* @returns corresponding linux error code.
1033	* @param rc IPRT status code.
1034	*/
1035	static int VBoxDrvLinuxErr2LinuxErr(int rc)
1036	{
1037	switch (rc)
1038	{
1039	case VINF_SUCCESS: return 0;
1040	case VERR_GENERAL_FAILURE: return -EACCES;
1041	case VERR_INVALID_PARAMETER: return -EINVAL;
1042	case VERR_INVALID_MAGIC: return -EILSEQ;
1043	case VERR_INVALID_HANDLE: return -ENXIO;
1044	case VERR_INVALID_POINTER: return -EFAULT;
1045	case VERR_LOCK_FAILED: return -ENOLCK;
1046	case VERR_ALREADY_LOADED: return -EEXIST;
1047	case VERR_PERMISSION_DENIED: return -EPERM;
1048	case VERR_VERSION_MISMATCH: return -ENOSYS;
1049	case VERR_IDT_FAILED: return -1000;
1050	}
1051
1052	return -EPERM;
1053	}
1054
1055
1056	RTDECL(int) SUPR0Printf(const char *pszFormat, ...)
1057	{
1058	va_list va;
1059	char szMsg[512];
1060
1061	va_start(va, pszFormat);
1062	RTStrPrintfV(szMsg, sizeof(szMsg) - 1, pszFormat, va);
1063	va_end(va);
1064	szMsg[sizeof(szMsg) - 1] = '\0';
1065
1066	printk("%s", szMsg);
1067	return 0;
1068	}
1069
1070
1071	/**
1072	* Returns configuration flags of the host kernel.
1073	*/
1074	SUPR0DECL(uint32_t) SUPR0GetKernelFeatures(void)
1075	{
1076	uint32_t fFlags = 0;
1077	#ifdef CONFIG_PAX_KERNEXEC
1078	fFlags \|= SUPKERNELFEATURES_GDT_READ_ONLY;
1079	#endif
1080	return fFlags;
1081	}
1082
1083
1084	module_init(VBoxDrvLinuxInit);
1085	module_exit(VBoxDrvLinuxUnload);
1086
1087	MODULE_AUTHOR(VBOX_VENDOR);
1088	MODULE_DESCRIPTION(VBOX_PRODUCT " Support Driver");
1089	MODULE_LICENSE("GPL");
1090	#ifdef MODULE_VERSION
1091	MODULE_VERSION(VBOX_VERSION_STRING " (" RT_XSTR(SUPDRV_IOC_VERSION) ")");
1092	#endif
1093
1094	module_param(force_async_tsc, int, 0444);
1095	MODULE_PARM_DESC(force_async_tsc, "force the asynchronous TSC mode");
1096

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/HostDrivers/Support/linux/SUPDrv-linux.c@ 52576

Download in other formats: