vboxadd.sh@ 89088

Last change on this file since 89088 was 86650, checked in by vboxsync, 4 years ago
Fixed bad commit. Hope this help.
Property svn:eol-style set to `LF` Property svn:executable set to ``* Property svn:keywords set to `Author Date Id Revision`
File size: 18.9 KB

Line
1	#! /bin/sh
2	# $Id: vboxadd.sh 86650 2020-10-20 14:26:02Z vboxsync $
3	## @file
4	# Linux Additions kernel module init script ($Revision: 86650 $)
5	#
6
7	#
8	# Copyright (C) 2006-2020 Oracle Corporation
9	#
10	# This file is part of VirtualBox Open Source Edition (OSE), as
11	# available from http://www.virtualbox.org. This file is free software;
12	# you can redistribute it and/or modify it under the terms of the GNU
13	# General Public License (GPL) as published by the Free Software
14	# Foundation, in version 2 as it comes in the "COPYING" file of the
15	# VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16	# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17	#
18
19	# X-Start-Before is a Debian Addition which we use when converting to
20	# a systemd unit. X-Service-Type is our own invention, also for systemd.
21
22	# chkconfig: 345 10 90
23	# description: VirtualBox Linux Additions kernel modules
24	#
25	### BEGIN INIT INFO
26	# Provides: vboxadd
27	# Required-Start:
28	# Required-Stop:
29	# Default-Start: 2 3 4 5
30	# Default-Stop: 0 1 6
31	# X-Start-Before: display-manager
32	# X-Service-Type: oneshot
33	# Description: VirtualBox Linux Additions kernel modules
34	### END INIT INFO
35
36	## @todo This file duplicates a lot of script with vboxdrv.sh. When making
37	# changes please try to reduce differences between the two wherever possible.
38
39	# Testing:
40	# * Should fail if the configuration file is missing or missing INSTALL_DIR or
41	# INSTALL_VER entries.
42	# * vboxadd user and vboxsf groups should be created if they do not exist - test
43	# by removing them before installing.
44	# * Shared folders can be mounted and auto-mounts accessible to vboxsf group,
45	# including on recent Fedoras with SELinux.
46	# * Setting INSTALL_NO_MODULE_BUILDS inhibits modules and module automatic
47	# rebuild script creation; otherwise modules, user, group, rebuild script,
48	# udev rule and shared folder mount helper should be created/set up.
49	# * Setting INSTALL_NO_MODULE_BUILDS inhibits module load and unload on start
50	# and stop.
51	# * Uninstalling the Additions and re-installing them does not trigger warnings.
52
53	export LC_ALL=C
54	PATH=$PATH:/bin:/sbin:/usr/sbin
55	PACKAGE=VBoxGuestAdditions
56	MODPROBE=/sbin/modprobe
57	OLDMODULES="vboxguest vboxadd vboxsf vboxvfs vboxvideo"
58	SERVICE="VirtualBox Guest Additions"
59	## systemd logs information about service status, otherwise do that ourselves.
60	QUIET=
61	test -z "${TARGET_VER}" && TARGET_VER=`uname -r`
62	# Marker to ignore a particular kernel version which was already installed.
63	SKIPFILE_BASE=/var/lib/VBoxGuestAdditions/skip
64	export VBOX_KBUILD_TYPE
65	export USERNAME
66
67	setup_log()
68	{
69	test -z "${LOG}" \|\| return 0
70	# Rotate log files
71	LOG="/var/log/vboxadd-setup.log"
72	mv "${LOG}.3" "${LOG}.4" 2>/dev/null
73	mv "${LOG}.2" "${LOG}.3" 2>/dev/null
74	mv "${LOG}.1" "${LOG}.2" 2>/dev/null
75	mv "${LOG}" "${LOG}.1" 2>/dev/null
76	}
77
78	if $MODPROBE -c 2>/dev/null \| grep -q '^allow_unsupported_modules *0'; then
79	MODPROBE="$MODPROBE --allow-unsupported-modules"
80	fi
81
82	# Preamble for Gentoo
83	if [ "`which $0`" = "/sbin/rc" ]; then
84	shift
85	fi
86
87	begin()
88	{
89	test -n "${QUIET}" \|\| echo "${SERVICE}: ${1}"
90	}
91
92	info()
93	{
94	if test -z "${QUIET}"; then
95	echo "${SERVICE}: $1" \| fold -s
96	else
97	echo "$1" \| fold -s
98	fi
99	}
100
101	fail()
102	{
103	log "${1}"
104	echo "$1" >&2
105	echo "The log file $LOG may contain further information." >&2
106	exit 1
107	}
108
109	log()
110	{
111	setup_log
112	echo "${1}" >> "${LOG}"
113	}
114
115	module_build_log()
116	{
117	log "Error building the module. Build output follows."
118	echo ""
119	echo "${1}" >> "${LOG}"
120	}
121
122	dev=/dev/vboxguest
123	userdev=/dev/vboxuser
124	config=/var/lib/VBoxGuestAdditions/config
125	owner=vboxadd
126	group=1
127
128	if test -r $config; then
129	. $config
130	else
131	fail "Configuration file $config not found"
132	fi
133	test -n "$INSTALL_DIR" -a -n "$INSTALL_VER" \|\|
134	fail "Configuration file $config not complete"
135	MODULE_SRC="$INSTALL_DIR/src/vboxguest-$INSTALL_VER"
136	BUILDINTMP="$MODULE_SRC/build_in_tmp"
137
138	running_vboxguest()
139	{
140	lsmod \| grep -q "vboxguest[^_-]"
141	}
142
143	running_vboxadd()
144	{
145	lsmod \| grep -q "vboxadd[^_-]"
146	}
147
148	running_vboxsf()
149	{
150	lsmod \| grep -q "vboxsf[^_-]"
151	}
152
153	running_vboxvideo()
154	{
155	lsmod \| grep -q "vboxvideo[^_-]"
156	}
157
158	do_vboxguest_non_udev()
159	{
160	if [ ! -c $dev ]; then
161	maj=`sed -n 's;$[0-9]\+$ vboxguest;\1;p' /proc/devices`
162	if [ ! -z "$maj" ]; then
163	min=0
164	else
165	min=`sed -n 's;$[0-9]\+$ vboxguest;\1;p' /proc/misc`
166	if [ ! -z "$min" ]; then
167	maj=10
168	fi
169	fi
170	test -n "$maj" \|\| {
171	rmmod vboxguest 2>/dev/null
172	fail "Cannot locate the VirtualBox device"
173	}
174
175	mknod -m 0664 $dev c $maj $min \|\| {
176	rmmod vboxguest 2>/dev/null
177	fail "Cannot create device $dev with major $maj and minor $min"
178	}
179	fi
180	chown $owner:$group $dev 2>/dev/null \|\| {
181	rm -f $dev 2>/dev/null
182	rm -f $userdev 2>/dev/null
183	rmmod vboxguest 2>/dev/null
184	fail "Cannot change owner $owner:$group for device $dev"
185	}
186
187	if [ ! -c $userdev ]; then
188	maj=10
189	min=`sed -n 's;$[0-9]\+$ vboxuser;\1;p' /proc/misc`
190	if [ ! -z "$min" ]; then
191	mknod -m 0666 $userdev c $maj $min \|\| {
192	rm -f $dev 2>/dev/null
193	rmmod vboxguest 2>/dev/null
194	fail "Cannot create device $userdev with major $maj and minor $min"
195	}
196	chown $owner:$group $userdev 2>/dev/null \|\| {
197	rm -f $dev 2>/dev/null
198	rm -f $userdev 2>/dev/null
199	rmmod vboxguest 2>/dev/null
200	fail "Cannot change owner $owner:$group for device $userdev"
201	}
202	fi
203	fi
204	}
205
206	restart()
207	{
208	stop && start
209	return 0
210	}
211
212	## Update the initramfs. Debian and Ubuntu put the graphics driver in, and
213	# need the touch(1) command below. Everyone else that I checked just need
214	# the right module alias file from depmod(1) and only use the initramfs to
215	# load the root filesystem, not the boot splash. update-initramfs works
216	# for the first two and dracut for every one else I checked. We are only
217	# interested in distributions recent enough to use the KMS vboxvideo driver.
218	update_initramfs()
219	{
220	## kernel version to update for.
221	version="${1}"
222	depmod "${version}"
223	rm -f "/lib/modules/${version}/initrd/vboxvideo"
224	test ! -d "/lib/modules/${version}/initrd" \|\|
225	test ! -f "/lib/modules/${version}/misc/vboxvideo.ko" \|\|
226	touch "/lib/modules/${version}/initrd/vboxvideo"
227
228	# Systems without systemd-inhibit probably don't need their initramfs
229	# rebuild here anyway.
230	type systemd-inhibit >/dev/null 2>&1 \|\| return
231	if type dracut >/dev/null 2>&1; then
232	systemd-inhibit --why="Installing VirtualBox Guest Additions" \
233	dracut -f --kver "${version}"
234	elif type update-initramfs >/dev/null 2>&1; then
235	systemd-inhibit --why="Installing VirtualBox Guest Additions" \
236	update-initramfs -u -k "${version}"
237	fi
238	}
239
240	# Remove any existing VirtualBox guest kernel modules from the disk, but not
241	# from the kernel as they may still be in use
242	cleanup_modules()
243	{
244	# Needed for Ubuntu and Debian, see update_initramfs
245	rm -f /lib/modules/*/initrd/vboxvideo
246	for i in /lib/modules/*/misc; do
247	KERN_VER="${i%/misc}"
248	KERN_VER="${KERN_VER#/lib/modules/}"
249	unset do_update
250	for j in ${OLDMODULES}; do
251	test -f "${i}/${j}.ko" && do_update=1 && rm -f "${i}/${j}.ko"
252	done
253	test -z "$do_update" \|\| update_initramfs "$KERN_VER"
254	# Remove empty /lib/modules folders which may have been kept around
255	rmdir -p "${i}" 2>/dev/null \|\| true
256	unset keep
257	for j in /lib/modules/"${KERN_VER}"/*; do
258	name="${j##*/}"
259	test -d "${name}" \|\| test "${name%%.*}" != modules && keep=1
260	done
261	if test -z "${keep}"; then
262	rm -rf /lib/modules/"${KERN_VER}"
263	rm -f /boot/initrd.img-"${KERN_VER}"
264	fi
265	done
266	for i in ${OLDMODULES}; do
267	# We no longer support DKMS, remove any leftovers.
268	rm -rf "/var/lib/dkms/${i}"*
269	done
270	rm -f /etc/depmod.d/vboxvideo-upstream.conf
271	rm -f "$SKIPFILE_BASE"-*
272	}
273
274	# Build and install the VirtualBox guest kernel modules
275	setup_modules()
276	{
277	KERN_VER="$1"
278	test -n "$KERN_VER" \|\| return 1
279	# Match (at least): vboxguest.o; vboxguest.ko; vboxguest.ko.xz
280	set /lib/modules/"$KERN_VER"/misc/vboxguest.o
281	test ! -f "$1" \|\| return 0
282	test -d /lib/modules/"$KERN_VER"/build \|\| return 0
283	export KERN_VER
284	info "Building the modules for kernel $KERN_VER."
285
286	log "Building the main Guest Additions $INSTALL_VER module for kernel $KERN_VER."
287	if ! myerr=`$BUILDINTMP \
288	--save-module-symvers /tmp/vboxguest-Module.symvers \
289	--module-source $MODULE_SRC/vboxguest \
290	--no-print-directory install 2>&1`; then
291	# If check_module_dependencies.sh fails it prints a message itself.
292	module_build_log "$myerr"
293	"${INSTALL_DIR}"/other/check_module_dependencies.sh 2>&1 &&
294	info "Look at $LOG to find out what went wrong"
295	return 0
296	fi
297	log "Building the shared folder support module."
298	if ! myerr=`$BUILDINTMP \
299	--use-module-symvers /tmp/vboxguest-Module.symvers \
300	--module-source $MODULE_SRC/vboxsf \
301	--no-print-directory install 2>&1`; then
302	module_build_log "$myerr"
303	info "Look at $LOG to find out what went wrong"
304	return 0
305	fi
306	log "Building the graphics driver module."
307	if ! myerr=`$BUILDINTMP \
308	--use-module-symvers /tmp/vboxguest-Module.symvers \
309	--module-source $MODULE_SRC/vboxvideo \
310	--no-print-directory install 2>&1`; then
311	module_build_log "$myerr"
312	info "Look at $LOG to find out what went wrong"
313	fi
314	[ -d /etc/depmod.d ] \|\| mkdir /etc/depmod.d
315	echo "override vboxguest * misc" > /etc/depmod.d/vboxvideo-upstream.conf
316	echo "override vboxsf * misc" >> /etc/depmod.d/vboxvideo-upstream.conf
317	echo "override vboxvideo * misc" >> /etc/depmod.d/vboxvideo-upstream.conf
318	update_initramfs "${KERN_VER}"
319	return 0
320	}
321
322	create_vbox_user()
323	{
324	# This is the LSB version of useradd and should work on recent
325	# distributions
326	useradd -d /var/run/vboxadd -g 1 -r -s /bin/false vboxadd >/dev/null 2>&1 \|\| true
327	# And for the others, we choose a UID ourselves
328	useradd -d /var/run/vboxadd -g 1 -u 501 -o -s /bin/false vboxadd >/dev/null 2>&1 \|\| true
329
330	}
331
332	create_udev_rule()
333	{
334	# Create udev description file
335	if [ -d /etc/udev/rules.d ]; then
336	udev_call=""
337	udev_app=`which udevadm 2> /dev/null`
338	if [ $? -eq 0 ]; then
339	udev_call="${udev_app} version 2> /dev/null"
340	else
341	udev_app=`which udevinfo 2> /dev/null`
342	if [ $? -eq 0 ]; then
343	udev_call="${udev_app} -V 2> /dev/null"
344	fi
345	fi
346	udev_fix="="
347	if [ "${udev_call}" != "" ]; then
348	udev_out=`${udev_call}`
349	udev_ver=`expr "$udev_out" : '[^0-9]$[0-9]$'`
350	if [ "$udev_ver" = "" -o "$udev_ver" -lt 55 ]; then
351	udev_fix=""
352	fi
353	fi
354	## @todo 60-vboxadd.rules -> 60-vboxguest.rules ?
355	echo "KERNEL=${udev_fix}\"vboxguest\", NAME=\"vboxguest\", OWNER=\"vboxadd\", MODE=\"0660\"" > /etc/udev/rules.d/60-vboxadd.rules
356	echo "KERNEL=${udev_fix}\"vboxuser\", NAME=\"vboxuser\", OWNER=\"vboxadd\", MODE=\"0666\"" >> /etc/udev/rules.d/60-vboxadd.rules
357	# Make sure the new rule is noticed.
358	udevadm control --reload >/dev/null 2>&1 \|\| true
359	udevcontrol reload_rules >/dev/null 2>&1 \|\| true
360	fi
361	}
362
363	create_module_rebuild_script()
364	{
365	# And a post-installation script for rebuilding modules when a new kernel
366	# is installed.
367	mkdir -p /etc/kernel/postinst.d /etc/kernel/prerm.d
368	cat << EOF > /etc/kernel/postinst.d/vboxadd
369	#!/bin/sh
370	# This only works correctly on Debian derivatives - Red Hat calls it before
371	# installing the right header files.
372	/sbin/rcvboxadd quicksetup "\${1}"
373	exit 0
374	EOF
375	cat << EOF > /etc/kernel/prerm.d/vboxadd
376	#!/bin/sh
377	for i in ${OLDMODULES}; do rm -f /lib/modules/"\${1}"/misc/"\${i}".ko; done
378	rmdir -p /lib/modules/"\$1"/misc 2>/dev/null \|\| true
379	exit 0
380	EOF
381	chmod 0755 /etc/kernel/postinst.d/vboxadd /etc/kernel/prerm.d/vboxadd
382	}
383
384	shared_folder_setup()
385	{
386	# Add a group "vboxsf" for Shared Folders access
387	# All users which want to access the auto-mounted Shared Folders have to
388	# be added to this group.
389	groupadd -r -f vboxsf >/dev/null 2>&1
390
391	# Put the mount.vboxsf mount helper in the right place.
392	## @todo It would be nicer if the kernel module just parsed parameters
393	# itself instead of needing a separate binary to do that.
394	ln -sf "${INSTALL_DIR}/other/mount.vboxsf" /sbin
395	# SELinux security context for the mount helper.
396	if test -e /etc/selinux/config; then
397	# This is correct. semanage maps this to the real path, and it aborts
398	# with an error, telling you what you should have typed, if you specify
399	# the real path. The "chcon" is there as a back-up for old guests.
400	command -v semanage > /dev/null &&
401	semanage fcontext -a -t mount_exec_t "${INSTALL_DIR}/other/mount.vboxsf"
402	chcon -t mount_exec_t "${INSTALL_DIR}/other/mount.vboxsf" 2>/dev/null
403	fi
404	}
405
406	# setup_script
407	setup()
408	{
409	# chcon is needed on old Fedora/Redhat systems. No one remembers which.
410	test ! -e /etc/selinux/config \|\|
411	chcon -t bin_t "$BUILDINTMP" 2>/dev/null
412
413	if test -z "$INSTALL_NO_MODULE_BUILDS"; then
414	info "Building the VirtualBox Guest Additions kernel modules. This may take a while."
415	info "To build modules for other installed kernels, run"
416	info " /sbin/rcvboxadd quicksetup <version>"
417	info "or"
418	info " /sbin/rcvboxadd quicksetup all"
419	if test -d /lib/modules/"$TARGET_VER"/build; then
420	setup_modules "$TARGET_VER"
421	depmod
422	else
423	info "Kernel headers not found for target kernel $TARGET_VER. \
424	Please install them and execute
425	/sbin/rcvboxadd setup"
426	fi
427	fi
428	create_vbox_user
429	create_udev_rule
430	test -n "${INSTALL_NO_MODULE_BUILDS}" \|\| create_module_rebuild_script
431	shared_folder_setup
432	if running_vboxguest \|\| running_vboxadd; then
433	info "Running kernel modules will not be replaced until the system is restarted"
434	fi
435
436	# Put the X.Org driver in place. This is harmless if it is not needed.
437	# Also set up the OpenGL library.
438	myerr=`"${INSTALL_DIR}/init/vboxadd-x11" setup 2>&1`
439	test -z "${myerr}" \|\| log "${myerr}"
440
441	return 0
442	}
443
444	# cleanup_script
445	cleanup()
446	{
447	if test -z "${INSTALL_NO_MODULE_BUILDS}"; then
448	# Delete old versions of VBox modules.
449	cleanup_modules
450	depmod
451
452	# Remove old module sources
453	for i in $OLDMODULES; do
454	rm -rf /usr/src/$i-*
455	done
456	fi
457
458	# Clean-up X11-related bits
459	"${INSTALL_DIR}/init/vboxadd-x11" cleanup
460
461	# Remove other files
462	if test -z "${INSTALL_NO_MODULE_BUILDS}"; then
463	rm -f /etc/kernel/postinst.d/vboxadd /etc/kernel/prerm.d/vboxadd
464	rmdir -p /etc/kernel/postinst.d /etc/kernel/prerm.d 2>/dev/null \|\| true
465	fi
466	rm -f /sbin/mount.vboxsf 2>/dev/null
467	rm -f /etc/udev/rules.d/60-vboxadd.rules 2>/dev/null
468	udevadm control --reload >/dev/null 2>&1 \|\| true
469	udevcontrol reload_rules >/dev/null 2>&1 \|\| true
470	}
471
472	start()
473	{
474	begin "Starting."
475	if test -z "${INSTALL_NO_MODULE_BUILDS}"; then
476	# We want to build modules for newly installed kernels on shutdown, so
477	# mark the ones already present. These will be ignored on shutdown.
478	rm -f "$SKIPFILE_BASE"-*
479	for setupi in /lib/modules/*; do
480	KERN_VER="${setupi##*/}"
481	# For a full setup, mark kernels we do not want to build.
482	touch "$SKIPFILE_BASE"-"$KERN_VER"
483	done
484	fi
485	setup
486	if test -z "${INSTALL_NO_MODULE_BUILDS}"; then
487	test -d /sys &&
488	ps -A -o comm \| grep -q '/*udevd$' 2>/dev/null \|\|
489	no_udev=1
490	running_vboxguest \|\| {
491	rm -f $dev \|\| {
492	fail "Cannot remove $dev"
493	}
494	rm -f $userdev \|\| {
495	fail "Cannot remove $userdev"
496	}
497	$MODPROBE vboxguest >/dev/null 2>&1 \|\|
498	fail "modprobe vboxguest failed"
499	case "$no_udev" in 1)
500	sleep .5;;
501	esac
502	$MODPROBE vboxsf > /dev/null 2>&1 \|\|
503	info "modprobe vboxsf failed"
504	}
505	case "$no_udev" in 1)
506	do_vboxguest_non_udev;;
507	esac
508	fi # INSTALL_NO_MODULE_BUILDS
509
510	return 0
511	}
512
513	stop()
514	{
515	begin "Stopping."
516	if test -z "${INSTALL_NO_MODULE_BUILDS}"; then
517	# We want to build modules for newly installed kernels on shutdown, so
518	# check which we marked at start-up.
519	for setupi in /lib/modules/*; do
520	KERN_VER="${setupi##*/}"
521	# For a full setup, mark kernels we do not want to build.
522	test -f "$SKIPFILE_BASE"-"$KERN_VER" \|\| setup_modules "$KERN_VER"
523	done
524	fi
525	if test -r /etc/ld.so.conf.d/00vboxvideo.conf; then
526	rm /etc/ld.so.conf.d/00vboxvideo.conf
527	ldconfig
528	fi
529	if ! umount -a -t vboxsf 2>/dev/null; then
530	# Make sure we only fail, if there are truly no more vboxsf
531	# mounts in the system.
532	[ -n "$(findmnt -t vboxsf)" ] && fail "Cannot unmount vboxsf folders"
533	fi
534	test -n "${INSTALL_NO_MODULE_BUILDS}" \|\|
535	info "You may need to restart your guest system to finish removing guest drivers."
536	return 0
537	}
538
539	dmnstatus()
540	{
541	if running_vboxguest; then
542	echo "The VirtualBox Additions are currently running."
543	else
544	echo "The VirtualBox Additions are not currently running."
545	fi
546	}
547
548	for i; do
549	case "$i" in quiet) QUIET=yes;; esac
550	done
551	case "$1" in
552	# Does setup without clean-up first and marks all kernels currently found on the
553	# system so that we can see later if any were added.
554	start)
555	start
556	;;
557	# Tries to build kernel modules for kernels added since start. Tries to unmount
558	# shared folders. Uninstalls our Chromium 3D libraries since we can't always do
559	# this fast enough at start time if we discover we do not want to use them.
560	stop)
561	stop
562	;;
563	restart)
564	restart
565	;;
566	# Setup does a clean-up (see below) and re-does all Additions-specific
567	# configuration of the guest system, including building kernel modules for the
568	# current kernel.
569	setup)
570	cleanup && start
571	;;
572	# Builds kernel modules for the specified kernels if they are not already built.
573	quicksetup)
574	if test x"$2" = xall; then
575	for topi in /lib/modules/*; do
576	KERN_VER="${topi%/misc}"
577	KERN_VER="${KERN_VER#/lib/modules/}"
578	setup_modules "$KERN_VER"
579	done
580	elif test -n "$2"; then
581	setup_modules "$2"
582	else
583	setup_modules "$TARGET_VER"
584	fi
585	;;
586	# Clean-up removes all Additions-specific configuration of the guest system,
587	# including all kernel modules.
588	cleanup)
589	cleanup
590	;;
591	status)
592	dmnstatus
593	;;
594	*)
595	echo "Usage: $0 {start\|stop\|restart\|status\|setup\|quicksetup\|cleanup} [quiet]"
596	exit 1
597	esac
598
599	exit

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

source: vbox/trunk/src/VBox/Additions/linux/installer/vboxadd.sh@ 89088

Download in other formats: