VBoxGuest-netbsd.c@ 63409

Last change on this file since 63409 was 63409, checked in by vboxsync, 9 years ago
VBoxGuest-netbsd.c: Use func in Log messages instead of hardcoding the function name.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 19.3 KB

Line
1	/* $Id: VBoxGuest-netbsd.c 63409 2016-08-13 01:53:02Z vboxsync $ */
2	/** @file
3	* VirtualBox Guest Additions Driver for NetBSD.
4	*/
5
6	/*
7	* Copyright (C) 2007-2016 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
18	/** @todo r=bird: This must merge with SUPDrv-netbsd.c before long. The two
19	* source files should only differ on prefixes and the extra bits wrt to the
20	* pci device. I.e. it should be diffable so that fixes to one can easily be
21	* applied to the other. */
22
23
24	/*********************************************************************************************************************************
25	* Header Files *
26	*********************************************************************************************************************************/
27	#include <sys/param.h>
28	#include <sys/systm.h>
29	#include <sys/select.h>
30	#include <sys/conf.h>
31	#include <sys/kernel.h>
32	#include <sys/kmem.h>
33	#include <sys/module.h>
34	#include <sys/device.h>
35	#include <sys/bus.h>
36	#include <sys/poll.h>
37	#include <sys/proc.h>
38	#include <sys/stat.h>
39	#include <sys/selinfo.h>
40	#include <sys/queue.h>
41	#include <sys/lock.h>
42	#include <sys/types.h>
43	#include <sys/conf.h>
44	#include <sys/malloc.h>
45	#include <sys/uio.h>
46	#include <sys/file.h>
47	#include <sys/filedesc.h>
48	#include <sys/vfs_syscalls.h>
49	#include <dev/pci/pcivar.h>
50	#include <dev/pci/pcireg.h>
51	#include <dev/pci/pcidevs.h>
52
53	#ifdef PVM
54	# undef PVM
55	#endif
56	#include "VBoxGuestInternal.h"
57	#include <VBox/log.h>
58	#include <iprt/assert.h>
59	#include <iprt/initterm.h>
60	#include <iprt/process.h>
61	#include <iprt/mem.h>
62	#include <iprt/asm.h>
63
64
65	/*********************************************************************************************************************************
66	* Defined Constants And Macros *
67	*********************************************************************************************************************************/
68	/** The module name. */
69	#define DEVICE_NAME "vboxguest"
70
71
72	/*********************************************************************************************************************************
73	* Structures and Typedefs *
74	*********************************************************************************************************************************/
75	typedef struct VBoxGuestDeviceState
76	{
77	device_t sc_dev;
78	struct pci_attach_args *pa;
79	bus_space_tag_t io_tag;
80	bus_space_handle_t io_handle;
81	bus_addr_t uIOPortBase;
82	bus_size_t io_regsize;
83	bus_space_tag_t iVMMDevMemResId;
84	bus_space_handle_t VMMDevMemHandle;
85
86	/** Size of the memory area. */
87	bus_size_t VMMDevMemSize;
88	/** Mapping of the register space */
89	bus_addr_t pMMIOBase;
90
91	/** IRQ resource handle. */
92	pci_intr_handle_t ih;
93	/** Pointer to the IRQ handler. */
94	void *pfnIrqHandler;
95
96	/** Controller features, limits and status. */
97	u_int vboxguest_state;
98	} vboxguest_softc;
99
100
101	struct vboxguest_session
102	{
103	vboxguest_softc *sc;
104	PVBOXGUESTSESSION session;
105	};
106
107	#define VBOXGUEST_STATE_INITOK 1 << 0
108
109	/*********************************************************************************************************************************
110	* Internal Functions *
111	*********************************************************************************************************************************/
112	/*
113	* Character device file handlers.
114	*/
115	static int VBoxGuestNetBSDOpen(dev_t device, int flags, int fmt, struct lwp *process);
116	static int VBoxGuestNetBSDClose(struct file *fp);
117	static int VBoxGuestNetBSDIOCtl(struct file fp, u_long cmd, void addr);
118	static int VBoxGuestNetBSDPoll(struct file *fp, int events);
119	static void VBoxGuestNetBSDAttach(device_t, device_t, void*);
120	static int VBoxGuestNetBSDDetach(device_t pDevice, int flags);
121
122	/*
123	* IRQ related functions.
124	*/
125	static void VBoxGuestNetBSDRemoveIRQ(vboxguest_softc *sc);
126	static int VBoxGuestNetBSDAddIRQ(vboxguest_softc *pvState);
127	static int VBoxGuestNetBSDISR(void *pvState);
128
129
130	/*********************************************************************************************************************************
131	* Global Variables *
132	*********************************************************************************************************************************/
133	/*
134	* The /dev/vboxguest character device entry points.
135	*/
136	static struct cdevsw g_VBoxGuestNetBSDChrDevSW =
137	{
138	VBoxGuestNetBSDOpen,
139	noclose,
140	noread,
141	nowrite,
142	noioctl,
143	nostop,
144	notty,
145	nopoll,
146	nommap,
147	nokqfilter,
148	};
149
150	static const struct fileops vboxguest_fileops = {
151	.fo_read = fbadop_read,
152	.fo_write = fbadop_write,
153	.fo_ioctl = VBoxGuestNetBSDIOCtl,
154	.fo_fcntl = fnullop_fcntl,
155	.fo_poll = VBoxGuestNetBSDPoll,
156	.fo_stat = fbadop_stat,
157	.fo_close = VBoxGuestNetBSDClose,
158	.fo_kqfilter = fnullop_kqfilter,
159	.fo_restart = fnullop_restart
160	};
161
162	/** Device extention & session data association structure. */
163	static VBOXGUESTDEVEXT g_DevExt;
164	/** Reference counter */
165	static volatile uint32_t cUsers;
166	/** selinfo structure used for polling. */
167	static struct selinfo g_SelInfo;
168
169	CFDRIVER_DECL(vboxguest, DV_DULL, NULL);
170	extern struct cfdriver vboxguest_cd;
171
172	/**
173	* File open handler
174	*
175	*/
176	static int VBoxGuestNetBSDOpen(dev_t device, int flags, int fmt, struct lwp *process)
177	{
178	int rc;
179	vboxguest_softc *vboxguest;
180	struct vboxguest_session *session;
181	file_t *fp;
182	int fd, error;
183
184	LogFlow((DEVICE_NAME ": %s\n", __func__));
185
186	if ((vboxguest = device_lookup_private(&vboxguest_cd, minor(device))) == NULL) {
187	printf("device_lookup_private failed\n");
188	return (ENXIO);
189	}
190	if ((vboxguest->vboxguest_state & VBOXGUEST_STATE_INITOK) == 0) {
191	aprint_error_dev(vboxguest->sc_dev, "device not configured\n");
192	return (ENXIO);
193	}
194
195	session = kmem_alloc(sizeof(*session), KM_SLEEP);
196	if (session == NULL) {
197	return (ENOMEM);
198	}
199
200	session->sc = vboxguest;
201
202	if ((error = fd_allocfile(&fp, &fd)) != 0) {
203	kmem_free(session, sizeof(*session));
204	return error;
205	}
206
207	/*
208	* Create a new session.
209	*/
210	rc = VGDrvCommonCreateUserSession(&g_DevExt, &session->session);
211	if (! RT_SUCCESS(rc))
212	{
213	aprint_error_dev(vboxguest->sc_dev, "VBox session creation failed\n");
214	closef(fp); /* ??? */
215	kmem_free(session, sizeof(*session));
216	return RTErrConvertToErrno(rc);
217	}
218	ASMAtomicIncU32(&cUsers);
219	return fd_clone(fp, fd, flags, &vboxguest_fileops, session);
220
221	}
222
223	/**
224	* File close handler
225	*
226	*/
227	static int VBoxGuestNetBSDClose(struct file *fp)
228	{
229	struct vboxguest_session *session = fp->f_data;
230	vboxguest_softc *vboxguest = session->sc;
231
232	LogFlow((DEVICE_NAME ": %s\n", __func__));
233
234	VGDrvCommonCloseSession(&g_DevExt, session->session);
235	ASMAtomicDecU32(&cUsers);
236
237	kmem_free(session, sizeof(*session));
238
239	return 0;
240	}
241
242	/**
243	* IOCTL handler
244	*
245	*/
246	static int VBoxGuestNetBSDIOCtl(struct file fp, u_long command, void data)
247	{
248	struct vboxguest_session *session = fp->f_data;
249	vboxguest_softc *vboxguest = session->sc;
250
251	int rc = 0;
252
253	LogFlow((DEVICE_NAME ": %s\n", __func__));
254
255	/*
256	* Validate the request wrapper.
257	*/
258	if (IOCPARM_LEN(command) != sizeof(VBGLBIGREQ)) {
259	Log((DEVICE_NAME ": %s: bad request %lu size=%lu expected=%d\n",
260	__func__, command, IOCPARM_LEN(command), sizeof(VBGLBIGREQ)));
261	return ENOTTY;
262	}
263
264	PVBGLBIGREQ ReqWrap = (PVBGLBIGREQ)data;
265	if (ReqWrap->u32Magic != VBGLBIGREQ_MAGIC)
266	{
267	Log((DEVICE_NAME ": %s: bad magic %#x; pArg=%p Cmd=%lu.\n",
268	__func__, ReqWrap->u32Magic, data, command));
269	return EINVAL;
270	}
271	if (RT_UNLIKELY( ReqWrap->cbData == 0
272	\|\| ReqWrap->cbData > _1M*16))
273	{
274	printf(DEVICE_NAME ": VBoxGuestNetBSDIOCtl: bad size %#x; pArg=%p Cmd=%lu.\n", ReqWrap->cbData, data, command);
275	return EINVAL;
276	}
277
278	/*
279	* Read the request.
280	*/
281	void *pvBuf = RTMemTmpAlloc(ReqWrap->cbData);
282	if (RT_UNLIKELY(!pvBuf))
283	{
284	Log((DEVICE_NAME ": %s: RTMemTmpAlloc failed to alloc %d bytes.\n",
285	__func__, ReqWrap->cbData));
286	return ENOMEM;
287	}
288
289	rc = copyin((void *)(uintptr_t)ReqWrap->pvDataR3, pvBuf, ReqWrap->cbData);
290	if (RT_UNLIKELY(rc))
291	{
292	RTMemTmpFree(pvBuf);
293	Log((DEVICE_NAME ": %s: copyin failed; pvBuf=%p pArg=%p Cmd=%lu. rc=%d\n",
294	__func__, pvBuf, data, command, rc));
295	aprint_error_dev(vboxguest->sc_dev, "copyin failed\n");
296	return EFAULT;
297	}
298	if (RT_UNLIKELY( ReqWrap->cbData != 0
299	&& !VALID_PTR(pvBuf)))
300	{
301	RTMemTmpFree(pvBuf);
302	Log((DEVICE_NAME ": %s: pvBuf invalid pointer %p\n",
303	__func__, pvBuf));
304	return EINVAL;
305	}
306
307	/*
308	* Process the IOCtl.
309	*/
310	size_t cbDataReturned;
311	rc = VGDrvCommonIoCtl(command, &g_DevExt, session->session, pvBuf, ReqWrap->cbData, &cbDataReturned);
312	if (RT_SUCCESS(rc)) {
313	rc = 0;
314	if (RT_UNLIKELY(cbDataReturned > ReqWrap->cbData))
315	{
316	Log((DEVICE_NAME ": %s: too much output data %d expected %d\n",
317	cbDataReturned, ReqWrap->cbData));
318	cbDataReturned = ReqWrap->cbData;
319	}
320	if (cbDataReturned > 0)
321	{
322	rc = copyout(pvBuf, (void *)(uintptr_t)ReqWrap->pvDataR3, cbDataReturned);
323	if (RT_UNLIKELY(rc))
324	{
325	Log((DEVICE_NAME ": %s: copyout failed; pvBuf=%p pArg=%p. rc=%d\n",
326	__func__, pvBuf, data, rc));
327	}
328	}
329	} else {
330	Log((DEVICE_NAME ": %s: VGDrvCommonIoCtl failed. rc=%d\n",
331	__func__, rc));
332	rc = -rc;
333	}
334	RTMemTmpFree(pvBuf);
335	return rc;
336	}
337
338	static int VBoxGuestNetBSDPoll(struct file *fp, int events)
339	{
340	struct vboxguest_session *session = fp->f_data;
341	vboxguest_softc *vboxguest = session->sc;
342
343	int rc = 0;
344	int events_processed;
345
346	uint32_t u32CurSeq;
347
348	LogFlow((DEVICE_NAME ": %s\n", __func__));
349
350	u32CurSeq = ASMAtomicUoReadU32(&g_DevExt.u32MousePosChangedSeq);
351	if (session->session->u32MousePosChangedSeq != u32CurSeq) {
352	events_processed = events & (POLLIN \| POLLRDNORM);
353	session->session->u32MousePosChangedSeq = u32CurSeq;
354	} else {
355	events_processed = 0;
356
357	selrecord(curlwp, &g_SelInfo);
358	}
359
360	return events_processed;
361	}
362
363	static int VBoxGuestNetBSDDetach(device_t self, int flags)
364	{
365	vboxguest_softc *vboxguest;
366	vboxguest = device_private(self);
367
368	LogFlow((DEVICE_NAME ": %s\n", __func__));
369
370	if (cUsers > 0)
371	return EBUSY;
372
373	if ((vboxguest->vboxguest_state & VBOXGUEST_STATE_INITOK) == 0) {
374	return 0;
375	}
376
377	/*
378	* Reverse what we did in VBoxGuestNetBSDAttach.
379	*/
380
381	VBoxGuestNetBSDRemoveIRQ(vboxguest);
382
383	VGDrvCommonDeleteDevExt(&g_DevExt);
384
385	RTR0Term();
386
387	return 0;
388	}
389
390	/**
391	* Interrupt service routine.
392	*
393	* @returns Whether the interrupt was from VMMDev.
394	* @param pvState Opaque pointer to the device state.
395	*/
396	static int VBoxGuestNetBSDISR(void *pvState)
397	{
398	LogFlow((DEVICE_NAME ": %s: pvState=%p\n", __func__, pvState));
399
400	bool fOurIRQ = VGDrvCommonISR(&g_DevExt);
401
402	return fOurIRQ ? 0 : 1;
403	}
404
405	void VGDrvNativeISRMousePollEvent(PVBOXGUESTDEVEXT pDevExt)
406	{
407	LogFlow((DEVICE_NAME ": %s\n", __func__));
408
409	/*
410	* Wake up poll waiters.
411	*/
412	selnotify(&g_SelInfo, 0, 0);
413	}
414
415	/**
416	* Sets IRQ for VMMDev.
417	*
418	* @returns NetBSD error code.
419	* @param vboxguest Pointer to the state info structure.
420	*/
421	static int VBoxGuestNetBSDAddIRQ(vboxguest_softc *vboxguest)
422	{
423	int iResId = 0;
424	int rc = 0;
425	struct pci_attach_args *pa = vboxguest->pa;
426	const char *intrstr;
427	#if __NetBSD_Prereq__(6, 99, 39)
428	char intstrbuf[100];
429	#endif
430
431	LogFlow((DEVICE_NAME ": %s\n", __func__));
432
433	if (pci_intr_map(pa, &vboxguest->ih)) {
434	aprint_error_dev(vboxguest->sc_dev, "couldn't map interrupt.\n");
435	return VERR_DEV_IO_ERROR;
436	}
437	intrstr = pci_intr_string(vboxguest->pa->pa_pc, vboxguest->ih
438	#if __NetBSD_Prereq__(6, 99, 39)
439	, intstrbuf, sizeof(intstrbuf)
440	#endif
441	);
442	aprint_normal_dev(vboxguest->sc_dev, "interrupting at %s\n", intrstr);
443	vboxguest->pfnIrqHandler = pci_intr_establish(vboxguest->pa->pa_pc, vboxguest->ih, IPL_BIO, VBoxGuestNetBSDISR, vboxguest);
444	if (vboxguest->pfnIrqHandler == NULL) {
445	aprint_error_dev(vboxguest->sc_dev, "couldn't establish interrupt\n");
446	return VERR_DEV_IO_ERROR;
447	}
448
449	return VINF_SUCCESS;
450	}
451
452	/**
453	* Removes IRQ for VMMDev.
454	*
455	* @param vboxguest Opaque pointer to the state info structure.
456	*/
457	static void VBoxGuestNetBSDRemoveIRQ(vboxguest_softc *vboxguest)
458	{
459	LogFlow((DEVICE_NAME ": %s\n", __func__));
460
461	if (vboxguest->pfnIrqHandler)
462	{
463	pci_intr_disestablish(vboxguest->pa->pa_pc, vboxguest->pfnIrqHandler);
464	}
465	}
466
467	static void VBoxGuestNetBSDAttach(device_t parent, device_t self, void *aux)
468	{
469	int rc = VINF_SUCCESS;
470	int iResId = 0;
471	vboxguest_softc *vboxguest;
472	struct pci_attach_args *pa = aux;
473	bus_space_tag_t iot, memt;
474	bus_space_handle_t ioh, memh;
475	bus_dma_segment_t seg;
476	int ioh_valid, memh_valid;
477
478	cUsers = 0;
479
480	aprint_normal(": VirtualBox Guest\n");
481
482	vboxguest = device_private(self);
483	vboxguest->sc_dev = self;
484
485	/*
486	* Initialize IPRT R0 driver, which internally calls OS-specific r0 init.
487	*/
488	rc = RTR0Init(0);
489	if (RT_FAILURE(rc))
490	{
491	LogFunc(("RTR0Init failed.\n"));
492	aprint_error_dev(vboxguest->sc_dev, "RTR0Init failed\n");
493	return ;
494	}
495
496	vboxguest->pa = pa;
497
498	/*
499	* Allocate I/O port resource.
500	*/
501	ioh_valid = (pci_mapreg_map(pa, PCI_MAPREG_START, PCI_MAPREG_TYPE_IO, 0, &vboxguest->io_tag, &vboxguest->io_handle, &vboxguest->uIOPortBase, &vboxguest->io_regsize) == 0);
502
503	if (ioh_valid)
504	{
505
506	/*
507	* Map the MMIO region.
508	*/
509	memh_valid = (pci_mapreg_map(pa, PCI_MAPREG_START+4, PCI_MAPREG_TYPE_MEM, BUS_SPACE_MAP_LINEAR, &vboxguest->iVMMDevMemResId, &vboxguest->VMMDevMemHandle, &vboxguest->pMMIOBase, &vboxguest->VMMDevMemSize) == 0);
510	if (memh_valid)
511	{
512	/*
513	* Call the common device extension initializer.
514	*/
515	rc = VGDrvCommonInitDevExt(&g_DevExt, vboxguest->uIOPortBase,
516	bus_space_vaddr(vboxguest->iVMMDevMemResId,
517	vboxguest->VMMDevMemHandle),
518	vboxguest->VMMDevMemSize,
519	#if ARCH_BITS == 64
520	VBOXOSTYPE_NetBSD_x64,
521	#else
522	VBOXOSTYPE_NetBSD,
523	#endif
524	VMMDEV_EVENT_MOUSE_POSITION_CHANGED);
525	if (RT_SUCCESS(rc))
526	{
527	/*
528	* Add IRQ of VMMDev.
529	*/
530	rc = VBoxGuestNetBSDAddIRQ(vboxguest);
531	if (RT_SUCCESS(rc))
532	{
533	vboxguest->vboxguest_state \|= VBOXGUEST_STATE_INITOK;
534	return ;
535	}
536	VGDrvCommonDeleteDevExt(&g_DevExt);
537	} else {
538	aprint_error_dev(vboxguest->sc_dev, "init failed\n");
539	}
540	} else {
541	aprint_error_dev(vboxguest->sc_dev, "MMIO mapping failed\n");
542	}
543	} else {
544	aprint_error_dev(vboxguest->sc_dev, "IO mapping failed\n");
545	}
546
547	RTR0Term();
548	return ;
549	}
550
551	static int
552	VBoxGuestNetBSDMatch(device_t parent, cfdata_t match, void *aux)
553	{
554	const struct pci_attach_args *pa = aux;
555	if ((PCI_VENDOR(pa->pa_id) == VMMDEV_VENDORID)
556	&& (PCI_PRODUCT(pa->pa_id) == VMMDEV_DEVICEID)) {
557	return 1;
558	} else {
559	return 2;
560	}
561	}
562
563	/* Common code that depend on g_DevExt. */
564	#include "VBoxGuestIDC-unix.c.h"
565
566	CFATTACH_DECL_NEW(vboxguest, sizeof(vboxguest_softc),
567	VBoxGuestNetBSDMatch, VBoxGuestNetBSDAttach, VBoxGuestNetBSDDetach, NULL);
568
569	MODULE(MODULE_CLASS_DRIVER, vboxguest, "pci");
570
571	static int loc[2] = {-1, -1};
572
573	static const struct cfparent pspec = {
574	"pci", "pci", DVUNIT_ANY
575	};
576
577	static struct cfdata vboxguest_cfdata[] = {
578	{
579	.cf_name = "vboxguest",
580	.cf_atname = "vboxguest",
581	.cf_unit = 0, /* Only unit 0 is ever used */
582	.cf_fstate = FSTATE_STAR,
583	.cf_loc = loc,
584	.cf_flags = 0,
585	.cf_pspec = &pspec,
586	},
587	{ NULL, NULL, 0, 0, NULL, 0, NULL }
588	};
589
590	static int
591	vboxguest_modcmd(modcmd_t cmd, void *opaque)
592	{
593	devmajor_t bmajor, cmajor;
594	int error;
595	register_t retval;
596
597	LogFlow((DEVICE_NAME ": %s\n", __func__));
598
599	bmajor = cmajor = NODEVMAJOR;
600	switch (cmd) {
601	case MODULE_CMD_INIT:
602	error = config_cfdriver_attach(&vboxguest_cd);
603	if (error) {
604	printf("config_cfdriver_attach failed: %d", error);
605	break;
606	}
607	error = config_cfattach_attach(vboxguest_cd.cd_name, &vboxguest_ca);
608	if (error) {
609	config_cfdriver_detach(&vboxguest_cd);
610	printf("%s: unable to register cfattach\n", vboxguest_cd.cd_name);
611	break;
612	}
613
614	error = config_cfdata_attach(vboxguest_cfdata, 1);
615	if (error) {
616	printf("%s: unable to attach cfdata\n", vboxguest_cd.cd_name);
617	config_cfattach_detach(vboxguest_cd.cd_name, &vboxguest_ca);
618	config_cfdriver_detach(&vboxguest_cd);
619	break;
620	}
621
622	error = devsw_attach("vboxguest", NULL, &bmajor, &g_VBoxGuestNetBSDChrDevSW, &cmajor);
623
624	if (error == EEXIST)
625	error = 0; /* maybe built-in ... improve eventually */
626	if (error)
627	break;
628
629	error = do_sys_mknod(curlwp, "/dev/vboxguest", 0666\|S_IFCHR, makedev(cmajor, 0), &retval, UIO_SYSSPACE);
630	if (error == EEXIST)
631	error = 0;
632	break;
633	case MODULE_CMD_FINI:
634	error = config_cfdata_detach(vboxguest_cfdata);
635	if (error)
636	break;
637	error = config_cfattach_detach(vboxguest_cd.cd_name, &vboxguest_ca);
638	if (error)
639	break;
640	config_cfdriver_detach(&vboxguest_cd);
641	error = devsw_detach(NULL, &g_VBoxGuestNetBSDChrDevSW);
642	break;
643	default:
644	return ENOTTY;
645	}
646	return error;
647	}

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

source: vbox/trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest-netbsd.c@ 63409

Download in other formats: