summaryrefslogtreecommitdiff
path: root/scripts/live-helpers
blob: f1ebe8625e070ac94418bfbffa22e08f2220785d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
# live-boot helper functions, used by live-boot on boot and by live-snapshot

if [ ! -x "/bin/fstype" ]
then
	# klibc not in path -> not in initramfs
	export PATH="${PATH}:/usr/lib/klibc/bin"
fi

# handle upgrade path from old udev (using udevinfo) to
# recent versions of udev (using udevadm info)
if [ -x /sbin/udevadm ]
then
	udevinfo='/sbin/udevadm info'
else
	udevinfo='udevinfo'
fi

sys2dev ()
{
	sysdev=${1#/sys}
	echo "/dev/$($udevinfo -q name -p ${sysdev} 2>/dev/null|| echo ${sysdev##*/})"
}

subdevices ()
{
	sysblock=${1}
	r=""

	for dev in "${sysblock}"/* "${sysblock}"
	do
		if [ -e "${dev}/dev" ]
		then
			r="${r} ${dev}"
		fi
	done

	echo ${r}
}

storage_devices()
{
	black_listed_devices="${1}"
	white_listed_devices="${2}"

	for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "loop|ram|fd")
	do
		fulldevname=$(sys2dev "${sysblock}")

		if echo "${black_listed_devices}" | grep -qe "\<${fulldevname}\>" || \
			[ -n "${white_listed_devices}" ] && \
			echo "${white_listed_devices}" | grep -qve "\<${fulldevname}\>"
		then
			# skip this device entirely
			continue
		fi

		for dev in $(subdevices "${sysblock}")
		do
			devname=$(sys2dev "${dev}")

			if echo "${black_listed_devices}" | grep -qe "\<${devname}\>"
			then
				# skip this subdevice
				continue
			else
				echo "${devname}"
			fi
		done
	done
}

is_supported_fs ()
{
	fstype="${1}"

	# Validate input first
	if [ -z "${fstype}" ]
	then
		return 1
	fi

	# Try to look if it is already supported by the kernel
	if grep -q ${fstype} /proc/filesystems
	then
		return 0
	else
		# Then try to add support for it the gentle way using the initramfs capabilities
		modprobe ${fstype}
		if grep -q ${fstype} /proc/filesystems
		then
			return 0
		# Then try the hard way if /root is already reachable
		else
			kmodule="/root/lib/modules/`uname -r`/${fstype}/${fstype}.ko"
			if [ -e "${kmodule}" ]
			then
				insmod "${kmodule}"
				if grep -q ${fstype} /proc/filesystems
				then
					return 0
				fi
			fi
		fi
	fi

	return 1
}

get_fstype ()
{
	/sbin/blkid -s TYPE -o value $1 2>/dev/null
}

where_is_mounted ()
{
	device=${1}

	if grep -q "^${device} " /proc/mounts
	then
		# return the first found
		grep -m1 "^${device} " /proc/mounts | cut -f2 -d ' '
	fi
}

lastline ()
{
	while read lines
	do
		line=${lines}
	done

	echo "${line}"
}

base_path ()
{
	testpath="${1}"
	mounts="$(awk '{print $2}' /proc/mounts)"
	testpath="$(busybox realpath ${testpath})"

	while true
	do
		if echo "${mounts}" | grep -qs "^${testpath}"
		then
			set -- $(echo "${mounts}" | grep "^${testpath}" | lastline)
			echo ${1}
			break
		else
			testpath=$(dirname $testpath)
		fi
	done
}

fs_size ()
{
	# Returns used/free fs kbytes + 5% more
	# You could pass a block device as ${1} or the mount point as ${2}

	dev="${1}"
	mountp="${2}"
	used="${3}"

	if [ -z "${mountp}" ]
	then
		mountp="$(where_is_mounted ${dev})"

		if [ -z "${mountp}" ]
		then
			mountp="/mnt/tmp_fs_size"

			mkdir -p "${mountp}"
			mount -t $(get_fstype "${dev}") -o ro "${dev}" "${mountp}" || log_warning_msg "cannot mount -t $(get_fstype ${dev}) -o ro ${dev} ${mountp}"

			doumount=1
		fi
	fi

	if [ "${used}" = "used" ]
	then
		size=$(du -ks ${mountp} | cut -f1)
		size=$(expr ${size} + ${size} / 20 ) # FIXME: 5% more to be sure
	else
		# free space
		size="$(df -k | grep -s ${mountp} | awk '{print $4}')"
	fi

	if [ -n "${doumount}" ]
	then
		umount "${mountp}" || log_warning_msg "cannot umount ${mountp}"
		rmdir "${mountp}"
	fi

	echo "${size}"
}

load_keymap ()
{
	# Load custom keymap
	if [ -x /bin/loadkeys -a -r /etc/boottime.kmap.gz ]
	then
		loadkeys /etc/boottime.kmap.gz
	fi
}

setup_loop ()
{
	local fspath=${1}
	local module=${2}
	local pattern=${3}
	local offset=${4}
	local encryption=${5}
	local readonly=${6}

	# the output of setup_loop is evaluated in other functions,
	# modprobe leaks kernel options like "libata.dma=0"
	# as "options libata dma=0" on stdout, causing serious
	# problems therefor, so instead always avoid output to stdout
	modprobe -q -b "${module}" 1>/dev/null

	udevadm settle

	for loopdev in ${pattern}
	do
		if [ "$(cat ${loopdev}/size)" -eq 0 ]
		then
			dev=$(sys2dev "${loopdev}")
			options=''

			if [ -n "${readonly}" ]
			then
				if losetup --help 2>&1 | grep -q -- "-r\b"
				then
					options="${options} -r"
				fi
			fi

			if [ -n "${offset}" ] && [ 0 -lt "${offset}" ]
			then
				options="${options} -o ${offset}"
			fi

			if [ -z "${encryption}" ]
			then
				losetup ${options} "${dev}" "${fspath}"
			else
				# Loop AES encryption
				while true
				do
					load_keymap

					echo -n "Enter passphrase for root filesystem: " >&6
					read -s passphrase
					echo "${passphrase}" > /tmp/passphrase
					unset passphrase
					exec 9</tmp/passphrase
					/sbin/losetup ${options} -e "${encryption}" -p 9 "${dev}" "${fspath}"
					error=${?}
					exec 9<&-
					rm -f /tmp/passphrase

					if [ 0 -eq ${error} ]
					then
						unset error
						break
					fi

					echo
					echo -n "There was an error decrypting the root filesystem ... Retry? [Y/n] " >&6
					read answer

					if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
					then
						unset answer
						break
					fi
				done
			fi

			echo "${dev}"
			return 0
		fi
	done

	panic "No loop devices available"
}

try_mount ()
{
	dev="${1}"
	mountp="${2}"
	opts="${3}"
	fstype="${4}"

	old_mountp="$(where_is_mounted ${dev})"

	if [ -n "${old_mountp}" ]
	then
		if [ "${opts}" != "ro" ]
		then
			mount -o remount,"${opts}" "${dev}" "${old_mountp}" || panic "Remounting ${dev} ${opts} on ${old_mountp} failed"
		fi

		mount -o bind "${old_mountp}" "${mountp}" || panic "Cannot bind-mount ${old_mountp} on ${mountp}"
	else
		if [ -z "${fstype}" ]
		then
			fstype=$(get_fstype "${dev}")
		fi
		mount -t "${fstype}" -o "${opts}" "${dev}" "${mountp}" || \
		( echo "SKIPPING: Cannot mount ${dev} on ${mountp}, fstype=${fstype}, options=${opts}" > live-boot.log && return 0 )
	fi
}

open_luks_device ()
{
	dev="${1}"
	name="$(basename ${dev})"
	opts="--key-file=-"
	if [ -n "${PERSISTENT_READONLY}" ]
	then
		opts="${opts} --readonly"
	fi

	load_keymap

	while true
	do
		/lib/cryptsetup/askpass "Enter passphrase for ${dev}: " | \
			/sbin/cryptsetup -T 1 luksOpen ${dev} ${name} ${opts}

		if [ 0 -eq ${?} ]
		then
			luks_device="/dev/mapper/${name}"
			echo ${luks_device}
			return 0
		fi

		echo >&6
		echo -n "There was an error decrypting ${dev} ... Retry? [Y/n] " >&6
		read answer

		if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
		then
			return 2
		fi
	done
}

find_persistent_media ()
{
	# Scans devices for overlays and snapshots, and returns a whitespace
	# separated list of how to use them. Only overlays with a partition
	# label or file name in ${overlays} are returned, and ditto for
	# snapshots with labels in ${snapshots}.
	#
	# When scanning a LUKS device, the user will be asked to enter the
	# passphrase; on failure to enter it, or if no persistent partitions
	# or files were found, the LUKS device is closed.
	#
	# For a snapshot file the return value is ${label}=${snapdata}", where
	# ${snapdata} is the parameter used for try_snap().
	#
	# For all other cases (overlay/snapshot partition and overlay file) the
	# return value is "${label}=${device}", where ${device} a device that
	# can mount the content. In the case of an overlay file, the device
	# containing the file will remain mounted as a side-effect.
	#
	# No devices in ${black_listed_devices} will be scanned, and if
	# ${white_list_devices} is non-empty, only devices in it will be
	# scanned.

	overlays="${1}"
	snapshots="${2}"
	black_listed_devices="${3}"
	white_listed_devices="${4}"

	for dev in $(storage_devices "${black_listed_devices}" "${white_listed_devices}")
	do
		luks_device=""

		# Checking for a luks device
		if echo ${PERSISTENT_ENCRYPTION} | grep -qe "\<luks\>" && \
		   /sbin/cryptsetup isLuks ${dev}
		then
			if luks_device=$(open_luks_device "${dev}")
			then
				dev="${luks_device}"
			else
				# skip $dev since we failed/chose not to open it
				continue
			fi
		elif echo ${PERSISTENT_ENCRYPTION} | grep -qve "\<none\>"
		then
			# skip $dev since we don't allow unencrypted storage
			continue
		fi

		if echo ${PERSISTENT_STORAGE} | grep -qe "\<filesystem\>"
		then
			for label in ${overlays} ${snapshots}
			do
				if [ "$(/sbin/blkid -s LABEL -o value $dev 2>/dev/null)" = "${label}" ]
				then
					echo "${label}=${dev}"
					# skip to the next device
					continue 2
				fi
			done
		fi

		if echo ${PERSISTENT_STORAGE} | grep -qe "\<file\>"
		then
			devfstype="$(get_fstype ${dev})"
			overlay_on_dev=""
			snapshot_on_dev=""
			backing="/$(basename ${dev})-backing"
			mkdir -p "${backing}"
			if is_supported_fs ${devfstype} && try_mount "${dev}" "${backing}" "rw" "${devfstype}"
			then
				for label in ${overlays}
				do
					path=${backing}/${PERSISTENT_PATH}${label}
					if [ -f "${path}" ]
					then
						overlay_on_dev="yes"
						echo "${label}=$(setup_loop "${path}" "loop" "/sys/block/loop*")"
					fi
				done

				for label in ${snapshots}
				do
					for ext in squashfs cpio.gz ext2 ext3 ext4 jffs2
					do
						path="${PERSISTENT_PATH}${label}.${ext}"
						if [ -f "${backing}/${path}" ]
						then
							snapshot_on_dev="yes"
							echo "${label}=${dev}:${backing}:${path}"
						fi
					done
				done
			fi
			if [ -z "${overlay_on_dev}" ]
			then
				umount ${backing} > /dev/null 2>&1 || true
				if [ -z "${snapshot_on_dev}" ] && [ -n "${luks_device}" ] && /sbin/cryptsetup status "${luks_device}" 1> /dev/null
				then
					/sbin/cryptsetup luksClose "${luks_device}"
				fi
			fi
		fi
	done
}

get_mac ()
{
	mac=""

	for adaptor in /sys/class/net/*
	do
		status="$(cat ${adaptor}/iflink)"

		if [ "${status}" -eq 2 ]
		then
			mac="$(cat ${adaptor}/address)"
			mac="$(echo ${mac} | sed 's/:/-/g' | tr '[a-z]' '[A-Z]')"
		fi
	done

	echo ${mac}
}

is_luks()
{
    devname="${1}"
    if [ -x /sbin/cryptsetup ]
    then
	/sbin/cryptsetup isLuks "${devname}" 2>/dev/null || ret=${?}
	return ${ret}
    else
	return 1
    fi

}

removable_dev ()
{
	output_format="${1}"
	want_usb="${2}"
	ret=

	for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
	do
		dev_ok=
		if [ "$(cat ${sysblock}/removable)" = "1" ]
		then
			if [ -z "${want_usb}" ]
			then
				dev_ok="yes"
			else
				if readlink ${sysblock} | grep -q usb
				then
					dev_ok="yes"
				fi
			fi
		fi

		if [ "${dev_ok}" = "yes" ]
		then
			case "${output_format}" in
				sys)
					ret="${ret} ${sysblock}"
					;;
				*)
					devname=$(sys2dev "${sysblock}")
					ret="${ret} ${devname}"
					;;
			esac
		fi
	done

	echo "${ret}"
}

removable_usb_dev ()
{
	output_format="${1}"

	removable_dev "${output_format}" "want_usb"
}

non_removable_dev ()
{
	output_format="${1}"
	ret=

	for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
	do
		if [ "$(cat ${sysblock}/removable)" = "0" ]
		then
			case "${output_format}" in
				sys)
					ret="${ret} ${sysblock}"
					;;
				*)
					devname=$(sys2dev "${sysblock}")
					ret="${ret} ${devname}"
					;;
			esac
		fi
	done

	echo "${ret}"
}

link_files ()
{
	# create source's directory structure in dest, and recursively
	# create symlinks in dest to to all files in source. if mask
	# is non-empty, remove mask from all source paths when
	# creating links (will be necessary if we change root, which
	# live-boot normally does (into $rootmnt)).

	# remove multiple /:s and ensure ending on /
	local src_dir="$(echo "${1}"/ | sed -e 's|/\+|/|g')"
	local dest_dir="$(echo "${2}"/ | sed -e 's|/\+|/|g')"
	local src_mask="${3}"

	# This check can only trigger on the inital, non-recursive call since
	# we create the destination before recursive calls
	if [ ! -d "${dest_dir}" ];
	then
		log_warning_msg "Must link_files into a directory"
		return
	fi

	find "${src_dir}" -mindepth 1 -maxdepth 1 | while read x; do
		local src="${x}"
		local dest="${dest_dir}$(basename "${x}")"
		if [ -d "${src}" ];
		then
			if [ -z "$(ls -A "${src}")" ];
			then
				continue
			fi
			if [ ! -d "${dest}" ];
			then
				mkdir -p "${dest}"
				prev="$(dirname "${dest}")"
				chown $(stat -c %u:%g "${prev}") "${dest}"
				chmod $(stat -c %a "${prev}") "${dest}"
			fi
			link_files "${src}" "${dest}" "${src_mask}"
		else
			if [ -n "${src_mask}" ]
			then
				src="$(echo ${src} | sed "s|^${src_mask}||")"
			fi
			rm -rf "${dest}" 2> /dev/null
			ln -s "${src}" "${dest}"
		fi
	done
}

do_union () {
	local unionmountpoint="${1}"	# directory where the union is mounted
	local unionrw="${2}"		# branch where the union changes are stored
	local unionro1="${3}"		# first underlying read-only branch (optional)
	local unionro2="${4}"		# second underlying read-only branch (optional)

	if [ "${UNIONTYPE}" = "aufs" ]
	then
		rw_opt="rw"
		ro_opt="rr+wh"
		noxino_opt="noxino"
	elif [ "${UNIONTYPE}" = "unionfs-fuse" ]
	then
		rw_opt="RW"
		ro_opt="RO"
	else
		rw_opt="rw"
		ro_opt="ro"
	fi

	case "${UNIONTYPE}" in
		unionfs-fuse)
			unionmountopts="-o cow -o noinitgroups -o default_permissions -o allow_other -o use_ino -o suid"
			unionmountopts="${unionmountopts} ${unionrw}=${rw_opt}"
			if [ -n "${unionro1}" ]
			then
				unionmountopts="${unionmountopts}:${unionro1}=${ro_opt}"
			fi
			if [ -n "${unionro2}" ]
			then
				unionmountopts="${unionmountopts}:${unionro2}=${ro_opt}"
			fi
			( sysctl -w fs.file-max=391524 ; ulimit -HSn 16384
			unionfs-fuse ${unionmountopts} "${unionmountpoint}" ) && \
			( mkdir -p /run/sendsigs.omit.d
			pidof unionfs-fuse >> /run/sendsigs.omit.d/unionfs-fuse || true )
			;;

		overlayfs)
			# XXX: can unionro2 be used? (overlayfs only handles two dirs, but perhaps they can be chained?)
			# XXX: and can unionro1 be optional? i.e. can overlayfs skip lowerdir?
			unionmountopts="-o noatime,lowerdir=${unionro1},upperdir=${unionrw}"
			mount -t ${UNIONTYPE} ${unionmountopts} ${UNIONTYPE} "${unionmountpoint}"
			;;

		*)
			unionmountopts="-o noatime,${noxino_opt},dirs=${unionrw}=${rw_opt}"
			if [ -n "${unionro1}" ]
			then
				unionmountopts="${unionmountopts}:${unionro1}=${ro_opt}"
			fi
			if [ -n "${unionro2}" ]
			then
				unionmountopts="${unionmountopts}:${unionro2}=${ro_opt}"
			fi
			mount -t ${UNIONTYPE} ${unionmountopts} ${UNIONTYPE} "${unionmountpoint}"
			;;
	esac
}

get_custom_mounts () {
	# Side-effect: leaves $devices with live.persist mounted in ${rootmnt}/live/persistent
	# Side-effect: prints info to file $custom_mounts

	local devices="${1}"
	local custom_mounts="${2}" # print result to this file
	local rootmnt="${3}"       # should be set empty post-live-boot

	local bindings="/bindings.list"
	local links="/links.list"
	rm -rf ${bindings} ${links} 2> /dev/null
	local persistent_backing="${rootmnt}/live/persistent"

	for device in ${devices}
	do
		if [ ! -b "${device}" ]
		then
			continue
		fi
		local device_name="$(basename ${device})"
		local backing="${persistent_backing}/${device_name}"
		mkdir -p "${backing}"
		local device_fstype="$(get_fstype ${device})"
		if [ -z "${PERSISTENT_READONLY}" ]
		then
			device_mount_opts="rw,noatime"
		else
			device_mount_opts="ro,noatime"
		fi
		local device_used=""
		mount -t "${device_fstype}" -o "${device_mount_opts}" "${device}" "${backing}"
		local include_list="${backing}/${persistence_list}"
		if [ ! -r "${include_list}" ]
		then
			umount "${backing}"
			rmdir "${backing}"
			continue
		fi

		[ "${DEBUG}" = "Yes" ] && cp ${include_list} ${persistent_backing}/${persistence_list}.${device_name}
		while read source dest options # < ${include_list}
		do
			if echo ${source} | grep -qe "^[[:space:]]*\(#.*\)\?$"
			then
				# skipping empty or commented lines
				continue
			fi

			if echo ${dest} | grep -qe "^[^/]"
			then
				options="${dest}"
				dest="${source}"
			elif [ -z "${dest}" ]
			then
				dest="${source}"
			fi

			if echo ${dest} | grep -qe "^/\+$\|^/\+live\(/.*\)\?$"
			then
				# mounting on / or /live could cause trouble
				log_warning_msg "Skipping unsafe custom mount on ${dest}"
				continue
			fi

			for opt in $(echo ${options} | tr ',' ' ');
			do
				case "${opt}" in
					linkfiles|union)
						;;
					*)
						log_warning_msg "Skipping custom mount with unkown option: ${opt}"
						continue 2
						;;
				esac
			done

			# FIXME: handle case: we already have /a/b in
			# $bindings added from current $device, but
			# now we find /a -- /a should replace /a/b in
			# $bindings.

			# FIXME: handle case: we have /a in $bindings
			# from current $device, now we find /a/b, so
			# we skip /a/b

			# ensure that no multiple-/ occur in paths
			local full_source="$(echo ${backing}/${source}/ | sed -e 's|/\+|/|g')"
			local full_dest="$(echo ${rootmnt}/${dest}/ | sed -e 's|/\+|/|g')"
			device_used="yes"
			if echo ${options} | grep -qe "\<linkfiles\>";
			then
				echo "${full_source} ${full_dest} ${options}" >> ${links}
			else
				echo "${full_source} ${full_dest} ${options}" >> ${bindings}
			fi
		done < ${include_list}

		if [ -z "${device_used}" ]
		then
			# this device was not used for / earlier, or
			# custom mount point now, so it's useless
			umount "${backing}"
			rmdir "${backing}"
		fi
	done

	# We sort the list according to destination so we're sure that
	# we won't hide a previous mount. We also ignore duplicate
	# destinations in a more or less arbitrary way.
	[ -e "${bindings}" ] && sort -k2 -sbu ${bindings} >> ${custom_mounts}
	rm ${bindings}

	# After all mounts are considered we add symlinks so they
	# won't be hidden by some mount.
	[ -e "${links}" ] && sort -k2 -sbu ${links} >> ${custom_mounts}
	rm ${links}

	rm -f ${bindings} ${links} 2> /dev/null
	echo ${custom_mounts}
}

do_custom_mounts () {
	local custom_mounts="${1}" # the ouput from get_custom_mounts()
	local rootmnt="${2}"       # should be set empty post-live-boot

	while read source dest options # < ${custom_mounts}
	do
		local opt_linkfiles=""
		local opt_union=""
		for opt in $(echo ${options} | tr ',' ' ');
		do
			 case "${opt}" in
				linkfiles)
					opt_linkfiles="yes"
					;;
				union)
					opt_union="yes"
					;;
			esac
		done

		if mountpoint -q "${dest}";
		then
			log_warning_msg "Skipping custom mount ${source} on ${dest}: destination is already a mount point"
			continue
		fi

		# FIXME: we don't handle already existing
		# non-directory files in the paths of both $source and
		# $dest.

		if [ ! -d "${dest}" ]
		then
			# if ${dest} is in /home/$user, try fixing
			# proper ownership
			# FIXME: this should really be handled by
			# live-config since we don't know for sure
			# which uid a certain user has until then
			if echo ${dest} | grep -qe "^${rootmnt}/*home/\+[^/]\+"
			then
				path="/"
				for dir in $(echo ${dest} | sed -e 's|/\+| |g')
				do
					path=${path}/${dir}
					if [ ! -e ${path} ]
					then
						mkdir -p ${path}
						# assume that the intended user is the first, which is usually the case
						chown 1000:1000 ${path}
					fi
				done
			else
				mkdir -p ${dest}
			fi
		fi

		# if ${source} doesn't exist on our persistent media
		# we bootstrap it with $dest from the live filesystem.
		# this both makes sense and is critical if we're
		# dealing with /etc or other system dir.
		if [ ! -d "${source}" ]
		then
			if [ -n "${PERSISTENT_READONLY}" ] || [ -n "${opt_linkfiles}" ]
			then
				continue
			elif [ -n "${opt_union}" ]
			then
				# union's don't need to be bootstrapped
				mkdir "${source}"
			else
				# ensure that $dest is not copied *into* $source
				mkdir -p "$(dirname ${source})"
				cp -a "${dest}" "${source}"
			fi
		fi

		rofs_dest_backing=""
		for d in ${rootmnt}/live/rofs/*
		do
			if [ -n "${rootmnt}" ]
			then
				rofs_dest_backing="${d}/$(echo ${dest} | sed -e "s|${rootmnt}||")"
			else
				rofs_dest_backing="${d}/${dest}"

			fi
			if [ -d "${rofs_dest_backing}" ]
			then
				break
			else
				rofs_dest_backing=""
			fi
		done

		if [ -z "${PERSISTENT_READONLY}" ]
		then
			if [ -n "${opt_linkfiles}" ]
			then
				links_source="${source}"
				links_dest="${dest}"
			elif [ -n "${opt_union}" ]
			then
				do_union ${dest} ${source} ${rofs_dest_backing}
			else
				mount --bind "${source}" "${dest}"
			fi
		else
			if [ -n "${opt_linkfiles}" ]
			then
				links_dest="${dest}"
				dest="$(mktemp -d ${persistent_backing}/links_source-XXXXXX)"
				links_source="${dest}"
			fi
			if [ -n "${rootmnt}" ]
			then
				cow_dir="$(echo ${dest} | sed -e "s|${rootmnt}|/cow/|")"
			else
				cow_dir="/live/cow/${dest}"
			fi
			mkdir -p ${cow_dir}
			do_union ${dest} ${cow_dir} ${source} ${rofs_dest_backing}
		fi

		if [ -n "${opt_linkfiles}" ]
		then
			link_files "${links_source}" "${links_dest}" "${rootmnt}"
		fi

		PERSISTENCE_IS_ON="1"
		export PERSISTENCE_IS_ON
	done < ${custom_mounts}
}