Use PERSISTENCE_PATH with a trailing "/".
[debian-live-boot.git] / components / 9990-misc-helpers.sh
blob570a12ad3c7a1cb56c77e6b16dfd75cb479d37d1
1 #!/bin/sh
3 #set -e
5 is_live_path()
7 DIRECTORY="${1}/${LIVE_MEDIA_PATH}"
8 for FILESYSTEM in squashfs ext2 ext3 ext4 xfs dir jffs
9 do
10 if ls "${DIRECTORY}/"*.${FILESYSTEM} > /dev/null 2>&1
11 then
12 return 0
14 done
15 return 1
18 matches_uuid ()
20 if [ "${IGNORE_UUID}" ] || [ ! -e /conf/uuid.conf ]
21 then
22 return 0
25 path="${1}"
26 uuid="$(cat /conf/uuid.conf)"
28 for try_uuid_file in "${path}/.disk/live-uuid"*
30 [ -e "${try_uuid_file}" ] || continue
32 try_uuid="$(cat "${try_uuid_file}")"
34 if [ "${uuid}" = "${try_uuid}" ]
35 then
36 return 0
38 done
40 return 1
43 get_backing_device ()
45 case "${1}" in
46 *.squashfs|*.ext2|*.ext3|*.ext4|*.jffs2)
47 echo $(setup_loop "${1}" "loop" "/sys/block/loop*" '0' "${LIVE_MEDIA_ENCRYPTION}" "${2}")
50 *.dir)
51 echo "directory"
55 panic "Unrecognized live filesystem: ${1}"
57 esac
60 mount_images_in_directory ()
62 directory="${1}"
63 rootmnt="${2}"
64 mac="${3}"
66 if is_live_path "${directory}"
67 then
68 [ -n "${mac}" ] && adddirectory="${directory}/${LIVE_MEDIA_PATH}/${mac}"
69 setup_unionfs "${directory}/${LIVE_MEDIA_PATH}" "${rootmnt}" "${adddirectory}"
70 else
71 panic "No supported filesystem images found at /${LIVE_MEDIA_PATH}."
75 is_nice_device ()
77 sysfs_path="${1#/sys}"
79 if udevadm test-builtin path_id "${sysfs_path}" | egrep -q "ID_PATH=(usb|pci-[^-]*-(ide|sas|scsi|usb|virtio)|platform-sata_mv|platform-orion-ehci|platform-mmc|platform-mxsdhci)"
80 then
81 return 0
82 elif echo "${sysfs_path}" | grep -q '^/block/vd[a-z]$'
83 then
84 return 0
85 elif echo ${sysfs_path} | grep -q "^/block/dm-"
86 then
87 return 0
88 elif echo ${sysfs_path} | grep -q "^/block/mtdblock"
89 then
90 return 0
93 return 1
96 check_dev ()
98 sysdev="${1}"
99 devname="${2}"
100 skip_uuid_check="${3}"
102 # support for fromiso=.../isofrom=....
103 if [ -n "$FROMISO" ]
104 then
105 ISO_DEVICE=$(dirname $FROMISO)
106 if ! [ -b $ISO_DEVICE ]
107 then
108 # to support unusual device names like /dev/cciss/c0d0p1
109 # as well we have to identify the block device name, let's
110 # do that for up to 15 levels
111 i=15
112 while [ -n "$ISO_DEVICE" ] && [ "$i" -gt 0 ]
114 ISO_DEVICE=$(dirname ${ISO_DEVICE})
115 [ -b "$ISO_DEVICE" ] && break
116 i=$(($i -1))
117 done
120 if [ "$ISO_DEVICE" = "/" ]
121 then
122 echo "Warning: device for bootoption fromiso= ($FROMISO) not found.">>/boot.log
123 else
124 fs_type=$(get_fstype "${ISO_DEVICE}")
125 if is_supported_fs ${fs_type}
126 then
127 mkdir /live/fromiso
128 mount -t $fs_type "$ISO_DEVICE" /live/fromiso
129 ISO_NAME="$(echo $FROMISO | sed "s|$ISO_DEVICE||")"
130 loopdevname=$(setup_loop "/live/fromiso/${ISO_NAME}" "loop" "/sys/block/loop*" "" '')
131 devname="${loopdevname}"
132 else
133 echo "Warning: unable to mount $ISO_DEVICE." >>/boot.log
138 if [ -z "${devname}" ]
139 then
140 devname=$(sys2dev "${sysdev}")
143 if [ -d "${devname}" ]
144 then
145 mount -o bind "${devname}" $mountpoint || continue
147 if is_live_path $mountpoint
148 then
149 echo $mountpoint
150 return 0
151 else
152 umount $mountpoint
156 IFS=","
157 for device in ${devname}
159 case "$device" in
160 *mapper*)
161 # Adding lvm support
162 if [ -x /scripts/local-top/lvm2 ]
163 then
164 ROOT="$device" resume="" /scripts/local-top/lvm2
168 /dev/md*)
169 # Adding raid support
170 if [ -x /scripts/local-top/mdadm ]
171 then
172 cp /conf/conf.d/md /conf/conf.d/md.orig
173 echo "MD_DEVS=$device " >> /conf/conf.d/md
174 /scripts/local-top/mdadm
175 mv /conf/conf.d/md.orig /conf/conf.d/md
178 esac
179 done
180 unset IFS
182 [ -n "$device" ] && devname="$device"
184 [ -e "$devname" ] || continue
186 if [ -n "${LIVE_MEDIA_OFFSET}" ]
187 then
188 loopdevname=$(setup_loop "${devname}" "loop" "/sys/block/loop*" "${LIVE_MEDIA_OFFSET}" '')
189 devname="${loopdevname}"
192 fstype=$(get_fstype "${devname}")
194 if is_supported_fs ${fstype}
195 then
196 devuid=$(blkid -o value -s UUID "$devname")
197 [ -n "$devuid" ] && grep -qs "\<$devuid\>" /var/lib/live/boot/devices-already-tried-to-mount && continue
198 mount -t ${fstype} -o ro,noatime "${devname}" ${mountpoint} || continue
199 [ -n "$devuid" ] && echo "$devuid" >> /var/lib/live/boot/devices-already-tried-to-mount
201 if [ -n "${FINDISO}" ]
202 then
203 if [ -f ${mountpoint}/${FINDISO} ]
204 then
205 umount ${mountpoint}
206 mkdir -p /live/findiso
207 mount -t ${fstype} -o ro,noatime "${devname}" /live/findiso
208 loopdevname=$(setup_loop "/live/findiso/${FINDISO}" "loop" "/sys/block/loop*" 0 "")
209 devname="${loopdevname}"
210 mount -t iso9660 -o ro,noatime "${devname}" ${mountpoint}
211 else
212 umount ${mountpoint}
216 if is_live_path ${mountpoint} && \
217 ([ "${skip_uuid_check}" ] || matches_uuid ${mountpoint})
218 then
219 echo ${mountpoint}
220 return 0
221 else
222 umount ${mountpoint} 2>/dev/null
226 if [ -n "${LIVE_MEDIA_OFFSET}" ]
227 then
228 losetup -d "${loopdevname}"
231 return 1
234 find_livefs ()
236 timeout="${1}"
238 # don't start autodetection before timeout has expired
239 if [ -n "${LIVE_MEDIA_TIMEOUT}" ]
240 then
241 if [ "${timeout}" -lt "${LIVE_MEDIA_TIMEOUT}" ]
242 then
243 return 1
247 # first look at the one specified in the command line
248 case "${LIVE_MEDIA}" in
249 removable-usb)
250 for sysblock in $(removable_usb_dev "sys")
252 for dev in $(subdevices "${sysblock}")
254 if check_dev "${dev}"
255 then
256 return 0
258 done
259 done
260 return 1
263 removable)
264 for sysblock in $(removable_dev "sys")
266 for dev in $(subdevices "${sysblock}")
268 if check_dev "${dev}"
269 then
270 return 0
272 done
273 done
274 return 1
278 if [ ! -z "${LIVE_MEDIA}" ]
279 then
280 if check_dev "null" "${LIVE_MEDIA}" "skip_uuid_check"
281 then
282 return 0
286 esac
288 # or do the scan of block devices
289 # prefer removable devices over non-removable devices, so scan them first
290 devices_to_scan="$(removable_dev 'sys') $(non_removable_dev 'sys')"
292 for sysblock in $devices_to_scan
294 devname=$(sys2dev "${sysblock}")
295 [ -e "$devname" ] || continue
296 fstype=$(get_fstype "${devname}")
298 if /lib/udev/cdrom_id ${devname} > /dev/null
299 then
300 if check_dev "null" "${devname}"
301 then
302 return 0
304 elif is_nice_device "${sysblock}"
305 then
306 for dev in $(subdevices "${sysblock}")
308 if check_dev "${dev}"
309 then
310 return 0
312 done
313 elif [ "${fstype}" = "squashfs" -o \
314 "${fstype}" = "btrfs" -o \
315 "${fstype}" = "ext2" -o \
316 "${fstype}" = "ext3" -o \
317 "${fstype}" = "ext4" -o \
318 "${fstype}" = "jffs2" ]
319 then
320 # This is an ugly hack situation, the block device has
321 # an image directly on it. It's hopefully
322 # live-boot, so take it and run with it.
323 ln -s "${devname}" "${devname}.${fstype}"
324 echo "${devname}.${fstype}"
325 return 0
327 done
329 return 1
332 is_in_list_separator_helper ()
334 local sep element list
335 sep=${1}
336 shift
337 element=${1}
338 shift
339 list=${*}
340 echo ${list} | grep -qe "^\(.*${sep}\)\?${element}\(${sep}.*\)\?$"
343 is_in_space_sep_list ()
345 local element
346 element=${1}
347 shift
348 is_in_list_separator_helper "[[:space:]]" "${element}" "${*}"
351 is_in_comma_sep_list ()
353 local element
354 element=${1}
355 shift
356 is_in_list_separator_helper "," "${element}" "${*}"
359 sys2dev ()
361 sysdev=${1#/sys}
362 echo "/dev/$(udevadm info -q name -p ${sysdev} 2>/dev/null|| echo ${sysdev##*/})"
365 subdevices ()
367 sysblock=${1}
368 r=""
370 for dev in "${sysblock}"/* "${sysblock}"
372 if [ -e "${dev}/dev" ]
373 then
374 r="${r} ${dev}"
376 done
378 echo ${r}
381 storage_devices()
383 black_listed_devices="${1}"
384 white_listed_devices="${2}"
386 for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "loop|ram|fd")
388 fulldevname=$(sys2dev "${sysblock}")
390 if is_in_space_sep_list ${fulldevname} ${black_listed_devices} || \
391 [ -n "${white_listed_devices}" ] && \
392 ! is_in_space_sep_list ${fulldevname} ${white_listed_devices}
393 then
394 # skip this device entirely
395 continue
398 for dev in $(subdevices "${sysblock}")
400 devname=$(sys2dev "${dev}")
402 if is_in_space_sep_list ${devname} ${black_listed_devices}
403 then
404 # skip this subdevice
405 continue
406 else
407 echo "${devname}"
409 done
410 done
413 is_supported_fs ()
415 fstype="${1}"
417 # Validate input first
418 if [ -z "${fstype}" ]
419 then
420 return 1
423 # Try to look if it is already supported by the kernel
424 if grep -q ${fstype} /proc/filesystems
425 then
426 return 0
427 else
428 # Then try to add support for it the gentle way using the initramfs capabilities
429 modprobe ${fstype}
430 if grep -q ${fstype} /proc/filesystems
431 then
432 return 0
433 # Then try the hard way if /root is already reachable
434 else
435 kmodule="/root/lib/modules/`uname -r`/${fstype}/${fstype}.ko"
436 if [ -e "${kmodule}" ]
437 then
438 insmod "${kmodule}"
439 if grep -q ${fstype} /proc/filesystems
440 then
441 return 0
447 return 1
450 get_fstype ()
452 /sbin/blkid -s TYPE -o value $1 2>/dev/null
455 where_is_mounted ()
457 device=${1}
458 # return first found
459 grep -m1 "^${device} " /proc/mounts | cut -f2 -d ' '
462 trim_path ()
464 # remove all unnecessary /:s in the path, including last one (except
465 # if path is just "/")
466 echo ${1} | sed 's|//\+|/|g' | sed 's|^\(.*[^/]\)/$|\1|'
469 what_is_mounted_on ()
471 local dir
472 dir="$(trim_path ${1})"
473 grep -m1 "^[^ ]\+ ${dir} " /proc/mounts | cut -d' ' -f1
476 chown_ref ()
478 local reference targets owner
479 reference="${1}"
480 shift
481 targets=${@}
482 owner=$(stat -c %u:%g "${reference}")
483 chown -h ${owner} ${targets}
486 chmod_ref ()
488 local reference targets rights
489 reference="${1}"
490 shift
491 targets=${@}
492 rights=$(stat -c %a "${reference}")
493 chmod ${rights} ${targets}
496 lastline ()
498 while read lines
500 line=${lines}
501 done
503 echo "${line}"
506 base_path ()
508 testpath="${1}"
509 mounts="$(awk '{print $2}' /proc/mounts)"
510 testpath="$(busybox realpath ${testpath})"
512 while true
514 if echo "${mounts}" | grep -qs "^${testpath}"
515 then
516 set -- $(echo "${mounts}" | grep "^${testpath}" | lastline)
517 echo ${1}
518 break
519 else
520 testpath=$(dirname $testpath)
522 done
525 fs_size ()
527 # Returns used/free fs kbytes + 5% more
528 # You could pass a block device as ${1} or the mount point as ${2}
530 dev="${1}"
531 mountp="${2}"
532 used="${3}"
534 if [ -z "${mountp}" ]
535 then
536 mountp="$(where_is_mounted ${dev})"
538 if [ -z "${mountp}" ]
539 then
540 mountp="/mnt/tmp_fs_size"
542 mkdir -p "${mountp}"
543 mount -t $(get_fstype "${dev}") -o ro "${dev}" "${mountp}" || log_warning_msg "cannot mount -t $(get_fstype ${dev}) -o ro ${dev} ${mountp}"
545 doumount=1
549 if [ "${used}" = "used" ]
550 then
551 size=$(du -ks ${mountp} | cut -f1)
552 size=$(expr ${size} + ${size} / 20 ) # FIXME: 5% more to be sure
553 else
554 # free space
555 size="$(df -kP | grep -s ${mountp} | awk '{print $4}')"
558 if [ -n "${doumount}" ]
559 then
560 umount "${mountp}" || log_warning_msg "cannot umount ${mountp}"
561 rmdir "${mountp}"
564 echo "${size}"
567 load_keymap ()
569 # Load custom keymap
570 if [ -x /bin/loadkeys -a -r /etc/boottime.kmap.gz ]
571 then
572 loadkeys --quiet /etc/boottime.kmap.gz
576 setup_loop ()
578 local fspath module pattern offset encryption readonly
579 fspath=${1}
580 module=${2}
581 pattern=${3}
582 offset=${4}
583 encryption=${5}
584 readonly=${6}
586 # the output of setup_loop is evaluated in other functions,
587 # modprobe leaks kernel options like "libata.dma=0"
588 # as "options libata dma=0" on stdout, causing serious
589 # problems therefor, so instead always avoid output to stdout
590 modprobe -q -b "${module}" 1>/dev/null
592 udevadm settle
594 for loopdev in ${pattern}
596 if [ "$(cat ${loopdev}/size)" -eq 0 ]
597 then
598 dev=$(sys2dev "${loopdev}")
599 options=''
601 if [ -n "${readonly}" ]
602 then
603 if losetup --help 2>&1 | grep -q -- "-r\b"
604 then
605 options="${options} -r"
609 if [ -n "${offset}" ] && [ 0 -lt "${offset}" ]
610 then
611 options="${options} -o ${offset}"
614 if [ -z "${encryption}" ]
615 then
616 losetup ${options} "${dev}" "${fspath}"
617 else
618 # Loop AES encryption
619 while true
621 load_keymap
623 echo -n "Enter passphrase for root filesystem: " >&6
624 read -s passphrase
625 echo "${passphrase}" > /tmp/passphrase
626 unset passphrase
627 exec 9</tmp/passphrase
628 /sbin/losetup ${options} -e "${encryption}" -p 9 "${dev}" "${fspath}"
629 error=${?}
630 exec 9<&-
631 rm -f /tmp/passphrase
633 if [ 0 -eq ${error} ]
634 then
635 unset error
636 break
639 echo
640 echo -n "There was an error decrypting the root filesystem ... Retry? [Y/n] " >&6
641 read answer
643 if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
644 then
645 unset answer
646 break
648 done
651 echo "${dev}"
652 return 0
654 done
656 panic "No loop devices available"
659 try_mount ()
661 dev="${1}"
662 mountp="${2}"
663 opts="${3}"
664 fstype="${4}"
666 old_mountp="$(where_is_mounted ${dev})"
668 if [ -n "${old_mountp}" ]
669 then
670 if [ "${opts}" != "ro" ]
671 then
672 mount -o remount,"${opts}" "${dev}" "${old_mountp}" || panic "Remounting ${dev} ${opts} on ${old_mountp} failed"
675 mount -o bind "${old_mountp}" "${mountp}" || panic "Cannot bind-mount ${old_mountp} on ${mountp}"
676 else
677 if [ -z "${fstype}" ]
678 then
679 fstype=$(get_fstype "${dev}")
681 mount -t "${fstype}" -o "${opts}" "${dev}" "${mountp}" || \
682 ( echo "SKIPPING: Cannot mount ${dev} on ${mountp}, fstype=${fstype}, options=${opts}" > boot.log && return 0 )
686 # Try to mount $device to the place expected by live-boot. If $device
687 # is already mounted somewhere, move it to the expected place. If
688 # we're only probing $device (to check if it has custom persistence)
689 # $probe should be set, which suppresses warnings upon failure. On
690 # success, print the mount point for $device.
691 mount_persistence_media ()
693 local device probe backing old_backing fstype mount_opts
694 device=${1}
695 probe=${2}
697 backing="/live/persistence/$(basename ${device})"
699 mkdir -p "${backing}"
700 old_backing="$(where_is_mounted ${device})"
701 if [ -z "${old_backing}" ]
702 then
703 fstype="$(get_fstype ${device})"
704 mount_opts="rw,noatime"
705 if [ -n "${PERSISTENCE_READONLY}" ]
706 then
707 mount_opts="ro,noatime"
709 if mount -t "${fstype}" -o "${mount_opts}" "${device}" "${backing}" >/dev/null
710 then
711 echo ${backing}
712 return 0
713 else
714 [ -z "${probe}" ] && log_warning_msg "Failed to mount persistence media ${device}"
715 rmdir "${backing}"
716 return 1
718 elif [ "${backing}" != "${old_backing}" ]
719 then
720 if mount --move ${old_backing} ${backing} >/dev/null
721 then
722 echo ${backing}
723 return 0
724 else
725 [ -z "${probe}" ] && log_warning_msg "Failed to move persistence media ${device}"
726 rmdir "${backing}"
727 return 1
729 else
730 # This means that $device has already been mounted on
731 # the place expected by live-boot, so we're done.
732 echo ${backing}
733 return 0
737 close_persistence_media ()
739 local device backing
740 device=${1}
741 backing="$(where_is_mounted ${device})"
743 if [ -d "${backing}" ]
744 then
745 umount "${backing}" >/dev/null 2>&1
746 rmdir "${backing}" >/dev/null 2>&1
749 if is_active_luks_mapping ${device}
750 then
751 /sbin/cryptsetup luksClose ${device}
755 open_luks_device ()
757 dev="${1}"
758 name="$(basename ${dev})"
759 opts="--key-file=-"
760 if [ -n "${PERSISTENCE_READONLY}" ]
761 then
762 opts="${opts} --readonly"
765 if /sbin/cryptsetup status "${name}" >/dev/null 2>&1
766 then
767 re="^[[:space:]]*device:[[:space:]]*\([^[:space:]]*\)$"
768 opened_dev=$(cryptsetup status ${name} 2>/dev/null | grep "${re}" | sed "s|${re}|\1|")
769 if [ "${opened_dev}" = "${dev}" ]
770 then
771 luks_device="/dev/mapper/${name}"
772 echo ${luks_device}
773 return 0
774 else
775 log_warning_msg "Cannot open luks device ${dev} since ${opened_dev} already is opened with its name"
776 return 1
780 load_keymap
782 while true
784 /lib/cryptsetup/askpass "Enter passphrase for ${dev}: " | \
785 /sbin/cryptsetup -T 1 luksOpen ${dev} ${name} ${opts}
787 if [ 0 -eq ${?} ]
788 then
789 luks_device="/dev/mapper/${name}"
790 echo ${luks_device}
791 return 0
794 echo >&6
795 echo -n "There was an error decrypting ${dev} ... Retry? [Y/n] " >&6
796 read answer
798 if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
799 then
800 return 2
802 done
805 get_gpt_name ()
807 local dev
808 dev="${1}"
809 /sbin/blkid -s PART_ENTRY_NAME -p -o value ${dev} 2>/dev/null
812 is_gpt_device ()
814 local dev
815 dev="${1}"
816 [ "$(/sbin/blkid -s PART_ENTRY_SCHEME -p -o value ${dev} 2>/dev/null)" = "gpt" ]
819 probe_for_gpt_name ()
821 local overlays dev gpt_dev gpt_name
822 overlays="${1}"
823 dev="${2}"
825 gpt_dev="${dev}"
826 if is_active_luks_mapping ${dev}
827 then
828 # if $dev is an opened luks device, we need to check
829 # GPT stuff on the backing device
830 gpt_dev=$(get_luks_backing_device "${dev}")
833 if ! is_gpt_device ${gpt_dev}
834 then
835 return
838 gpt_name=$(get_gpt_name ${gpt_dev})
839 for label in ${overlays}
841 if [ "${gpt_name}" = "${label}" ]
842 then
843 echo "${label}=${dev}"
845 done
848 probe_for_fs_label ()
850 local overlays dev
851 overlays="${1}"
852 dev="${2}"
854 for label in ${overlays}
856 if [ "$(/sbin/blkid -s LABEL -o value $dev 2>/dev/null)" = "${label}" ]
857 then
858 echo "${label}=${dev}"
860 done
863 probe_for_file_name ()
865 local overlays dev ret backing
866 overlays="${1}"
867 dev="${2}"
869 ret=""
870 backing="$(mount_persistence_media ${dev} probe)"
871 if [ -z "${backing}" ]
872 then
873 return
876 for label in ${overlays}
878 path=${backing}/${PERSISTENCE_PATH}/${label}
879 if [ -f "${path}" ]
880 then
881 local loopdev
882 loopdev=$(setup_loop "${path}" "loop" "/sys/block/loop*")
883 ret="${ret} ${label}=${loopdev}"
885 done
887 if [ -n "${ret}" ]
888 then
889 echo ${ret}
890 else
891 # unmount and remove mountpoint
892 umount ${backing} > /dev/null 2>&1 || true
893 rmdir ${backing} > /dev/null 2>&1 || true
897 find_persistence_media ()
899 # Scans devices for overlays, and returns a whitespace
900 # separated list of how to use them. Only overlays with a partition
901 # label or file name in ${overlays} are returned.
903 # When scanning a LUKS device, the user will be asked to enter the
904 # passphrase; on failure to enter it, or if no persistence partitions
905 # or files were found, the LUKS device is closed.
907 # For all other cases (overlay partition and overlay file) the
908 # return value is "${label}=${device}", where ${device} a device that
909 # can mount the content. In the case of an overlay file, the device
910 # containing the file will remain mounted as a side-effect.
912 # No devices in ${black_listed_devices} will be scanned, and if
913 # ${white_list_devices} is non-empty, only devices in it will be
914 # scanned.
916 local overlays white_listed_devices ret black_listed_devices
917 overlays="${1}"
918 white_listed_devices="${2}"
919 ret=""
921 black_listed_devices="$(what_is_mounted_on /live/medium) $(what_is_mounted_on /live/findiso) $(what_is_mounted_on /live/fromiso)"
923 for dev in $(storage_devices "${black_listed_devices}" "${white_listed_devices}")
925 local result luks_device
926 result=""
928 luks_device=""
929 # Check if it's a luks device; we'll have to open the device
930 # in order to probe any filesystem it contains, like we do
931 # below. activate_custom_mounts() also depends on that any luks
932 # device already has been opened.
933 if is_in_comma_sep_list luks ${PERSISTENCE_ENCRYPTION} && is_luks_partition ${dev}
934 then
935 if luks_device=$(open_luks_device "${dev}")
936 then
937 dev="${luks_device}"
938 else
939 # skip $dev since we failed/chose not to open it
940 continue
942 elif ! is_in_comma_sep_list none ${PERSISTENCE_ENCRYPTION}
943 then
944 # skip $dev since we don't allow unencrypted storage
945 continue
948 # Probe for matching GPT partition names or filesystem labels
949 if is_in_comma_sep_list filesystem ${PERSISTENCE_STORAGE}
950 then
951 result=$(probe_for_gpt_name "${overlays}" ${dev})
952 if [ -n "${result}" ]
953 then
954 ret="${ret} ${result}"
955 continue
958 result=$(probe_for_fs_label "${overlays}" ${dev})
959 if [ -n "${result}" ]
960 then
961 ret="${ret} ${result}"
962 continue
966 # Probe for files with matching name on mounted partition
967 if is_in_comma_sep_list file ${PERSISTENCE_STORAGE}
968 then
969 result=$(probe_for_file_name "${overlays}" ${dev})
970 if [ -n "${result}" ]
971 then
972 local loopdevice
973 loopdevice=${result##*=}
974 if is_in_comma_sep_list luks ${PERSISTENCE_ENCRYPTION} && is_luks_partition ${loopdevice}
975 then
976 local luksfile
977 luksfile=""
978 if luksfile=$(open_luks_device "${loopdevice}")
979 then
980 result=${result%%=*}
981 result="${result}=${luksfile}"
982 else
983 losetup -d $loopdevice
984 result=""
987 ret="${ret} ${result}"
988 continue
992 # Close luks device if it isn't used
993 if [ -z "${result}" ] && [ -n "${luks_device}" ] && is_active_luks_mapping "${luks_device}"
994 then
995 /sbin/cryptsetup luksClose "${luks_device}"
997 done
999 if [ -n "${ret}" ]
1000 then
1001 echo ${ret}
1005 get_mac ()
1007 mac=""
1009 for adaptor in /sys/class/net/*
1011 status="$(cat ${adaptor}/iflink)"
1013 if [ "${status}" -eq 2 ]
1014 then
1015 mac="$(cat ${adaptor}/address)"
1016 mac="$(echo ${mac} | sed 's/:/-/g' | tr '[a-z]' '[A-Z]')"
1018 done
1020 echo ${mac}
1023 is_luks_partition ()
1025 device="${1}"
1026 /sbin/cryptsetup isLuks "${device}" 1>/dev/null 2>&1
1029 is_active_luks_mapping ()
1031 device="${1}"
1032 /sbin/cryptsetup status "${device}" 1>/dev/null 2>&1
1035 get_luks_backing_device ()
1037 device=${1}
1038 cryptsetup status ${device} 2> /dev/null | \
1039 awk '{if ($1 == "device:") print $2}'
1042 removable_dev ()
1044 output_format="${1}"
1045 want_usb="${2}"
1046 ret=
1048 for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
1050 dev_ok=
1051 if [ "$(cat ${sysblock}/removable)" = "1" ]
1052 then
1053 if [ -z "${want_usb}" ]
1054 then
1055 dev_ok="true"
1056 else
1057 if readlink ${sysblock} | grep -q usb
1058 then
1059 dev_ok="true"
1064 if [ "${dev_ok}" = "true" ]
1065 then
1066 case "${output_format}" in
1067 sys)
1068 ret="${ret} ${sysblock}"
1071 devname=$(sys2dev "${sysblock}")
1072 ret="${ret} ${devname}"
1074 esac
1076 done
1078 echo "${ret}"
1081 removable_usb_dev ()
1083 output_format="${1}"
1085 removable_dev "${output_format}" "want_usb"
1088 non_removable_dev ()
1090 output_format="${1}"
1091 ret=
1093 for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
1095 if [ "$(cat ${sysblock}/removable)" = "0" ]
1096 then
1097 case "${output_format}" in
1098 sys)
1099 ret="${ret} ${sysblock}"
1102 devname=$(sys2dev "${sysblock}")
1103 ret="${ret} ${devname}"
1105 esac
1107 done
1109 echo "${ret}"
1112 link_files ()
1114 # create source's directory structure in dest, and recursively
1115 # create symlinks in dest to to all files in source. if mask
1116 # is non-empty, remove mask from all source paths when
1117 # creating links (will be necessary if we change root, which
1118 # live-boot normally does (into $rootmnt)).
1119 local src_dir dest_dir src_transform
1121 # remove multiple /:s and ensure ending on /
1122 src_dir="$(trim_path ${1})/"
1123 dest_dir="$(trim_path ${2})/"
1124 src_transform="${3}"
1126 # This check can only trigger on the inital, non-recursive call since
1127 # we create the destination before recursive calls
1128 if [ ! -d "${dest_dir}" ]
1129 then
1130 log_warning_msg "Must link_files into a directory"
1131 return
1134 find "${src_dir}" -mindepth 1 -maxdepth 1 | \
1135 while read src
1137 local dest final_src
1138 dest="${dest_dir}$(basename "${src}")"
1139 if [ -d "${src}" ]
1140 then
1141 if [ -z "$(ls -A "${src}")" ]
1142 then
1143 continue
1145 if [ ! -d "${dest}" ]
1146 then
1147 mkdir -p "${dest}"
1148 chown_ref "${src}" "${dest}"
1149 chmod_ref "${src}" "${dest}"
1151 link_files "${src}" "${dest}" "${src_transform}"
1152 else
1153 final_src=${src}
1154 if [ -n "${src_transform}" ]
1155 then
1156 final_src="$(echo ${final_src} | sed "${src_transform}")"
1158 rm -rf "${dest}" 2> /dev/null
1159 ln -s "${final_src}" "${dest}"
1160 chown_ref "${src}" "${dest}"
1162 done
1165 do_union ()
1167 local unionmountpoint unionrw unionro
1168 unionmountpoint="${1}" # directory where the union is mounted
1169 shift
1170 unionrw="${1}" # branch where the union changes are stored
1171 shift
1172 unionro="${*}" # space separated list of read-only branches (optional)
1174 case "${UNIONTYPE}" in
1175 aufs)
1176 rw_opt="rw"
1177 ro_opt="rr+wh"
1178 noxino_opt="noxino"
1181 unionfs-fuse)
1182 rw_opt="RW"
1183 ro_opt="RO"
1187 rw_opt="rw"
1188 ro_opt="ro"
1190 esac
1192 case "${UNIONTYPE}" in
1193 unionfs-fuse)
1194 unionmountopts="-o cow -o noinitgroups -o default_permissions -o allow_other -o use_ino -o suid"
1195 unionmountopts="${unionmountopts} ${unionrw}=${rw_opt}"
1196 if [ -n "${unionro}" ]
1197 then
1198 for rofs in ${unionro}
1200 unionmountopts="${unionmountopts}:${rofs}=${ro_opt}"
1201 done
1203 ( sysctl -w fs.file-max=391524 ; ulimit -HSn 16384
1204 unionfs-fuse ${unionmountopts} "${unionmountpoint}" ) && \
1205 ( mkdir -p /run/sendsigs.omit.d
1206 pidof unionfs-fuse >> /run/sendsigs.omit.d/unionfs-fuse || true )
1209 overlayfs)
1210 # XXX: can multiple unionro be used? (overlayfs only handles two dirs, but perhaps they can be chained?)
1211 # XXX: and can unionro be optional? i.e. can overlayfs skip lowerdir?
1212 if echo ${unionro} | grep -q " "
1213 then
1214 panic "Multiple lower filesystems are currently not supported with overlayfs (unionro = ${unionro})."
1215 elif [ -z "${unionro}" ]
1216 then
1217 panic "Overlayfs needs at least one lower filesystem (read-only branch)."
1219 unionmountopts="-o noatime,lowerdir=${unionro},upperdir=${unionrw}"
1220 mount -t ${UNIONTYPE} ${unionmountopts} ${UNIONTYPE} "${unionmountpoint}"
1224 unionmountopts="-o noatime,${noxino_opt},dirs=${unionrw}=${rw_opt}"
1225 if [ -n "${unionro}" ]
1226 then
1227 for rofs in ${unionro}
1229 unionmountopts="${unionmountopts}:${rofs}=${ro_opt}"
1230 done
1232 mount -t ${UNIONTYPE} ${unionmountopts} ${UNIONTYPE} "${unionmountpoint}"
1234 esac
1237 get_custom_mounts ()
1239 # Side-effect: leaves $devices with persistence.conf mounted in /live/persistence
1240 # Side-effect: prints info to file $custom_mounts
1242 local custom_mounts devices bindings links
1243 custom_mounts=${1}
1244 shift
1245 devices=${@}
1247 bindings="/tmp/bindings.list"
1248 links="/tmp/links.list"
1249 rm -rf ${bindings} ${links} 2> /dev/null
1251 for device in ${devices}
1253 if [ ! -b "${device}" ]
1254 then
1255 continue
1258 local device_name backing include_list
1259 device_name="$(basename ${device})"
1260 backing=$(mount_persistence_media ${device})
1261 if [ -z "${backing}" ]
1262 then
1263 continue
1266 if [ -r "${backing}/${persistence_list}" ]
1267 then
1268 include_list="${backing}/${persistence_list}"
1269 else
1270 continue
1273 if [ -n "${LIVE_BOOT_DEBUG}" ] && [ -e "${include_list}" ]
1274 then
1275 cp ${include_list} /live/persistence/${persistence_list}.${device_name}
1278 while read dir options # < ${include_list}
1280 if echo ${dir} | grep -qe "^[[:space:]]*\(#.*\)\?$"
1281 then
1282 # skipping empty or commented lines
1283 continue
1286 if trim_path ${dir} | grep -q -e "^[^/]" -e "^/lib" -e "^/lib/live\(/.*\)\?$" -e "^/\(.*/\)\?\.\.\?\(/.*\)\?$"
1287 then
1288 log_warning_msg "Skipping unsafe custom mount ${dir}: must be an absolute path containing neither the \".\" nor \"..\" special dirs, and cannot be \"/lib\", or \"/lib/live\" or any of its sub-directories."
1289 continue
1292 local opt_source opt_link source full_source full_dest
1293 opt_source=""
1294 opt_link=""
1295 for opt in $(echo ${options} | tr ',' ' ');
1297 case "${opt}" in
1298 source=*)
1299 opt_source=${opt#source=}
1301 link)
1302 opt_link="true"
1304 union|bind)
1307 log_warning_msg "Skipping custom mount with unkown option: ${opt}"
1308 continue 2
1310 esac
1311 done
1313 source="${dir}"
1314 if [ -n "${opt_source}" ]
1315 then
1316 if echo ${opt_source} | grep -q -e "^/" -e "^\(.*/\)\?\.\.\?\(/.*\)\?$" && [ "${opt_source}" != "." ]
1317 then
1318 log_warning_msg "Skipping unsafe custom mount with option source=${opt_source}: must be either \".\" (the media root) or a relative path w.r.t. the media root that contains neither comas, nor the special \".\" and \"..\" path components"
1319 continue
1320 else
1321 source="${opt_source}"
1325 full_source="$(trim_path ${backing}/${source})"
1326 full_dest="$(trim_path ${rootmnt}/${dir})"
1327 if [ -n "${opt_link}" ]
1328 then
1329 echo "${device} ${full_source} ${full_dest} ${options}" >> ${links}
1330 else
1331 echo "${device} ${full_source} ${full_dest} ${options}" >> ${bindings}
1333 done < ${include_list}
1334 done
1336 # We sort the list according to destination so we're sure that
1337 # we won't hide a previous mount. We also ignore duplicate
1338 # destinations in a more or less arbitrary way.
1339 [ -e "${bindings}" ] && sort -k3 -sbu ${bindings} >> ${custom_mounts} && rm ${bindings}
1341 # After all mounts are considered we add symlinks so they
1342 # won't be hidden by some mount.
1343 [ -e "${links}" ] && cat ${links} >> ${custom_mounts} && rm ${links}
1345 # We need to make sure that no two custom mounts have the same sources
1346 # or are nested; if that is the case, too much weird stuff can happen.
1347 local prev_source prev_dest
1348 prev_source="impossible source" # first iteration must not match
1349 prev_dest=""
1350 # This sort will ensure that a source /a comes right before a source
1351 # /a/b so we only need to look at the previous source
1352 sort -k2 -b ${custom_mounts} |
1353 while read device source dest options
1355 if echo ${source} | grep -qe "^${prev_source}\(/.*\)\?$"
1356 then
1357 panic "Two persistence mounts have the same or nested sources: ${source} on ${dest}, and ${prev_source} on ${prev_dest}"
1359 prev_source=${source}
1360 prev_dest=${dest}
1361 done
1364 activate_custom_mounts ()
1366 local custom_mounts used_devices
1367 custom_mounts="${1}" # the ouput from get_custom_mounts()
1368 used_devices=""
1370 while read device source dest options # < ${custom_mounts}
1372 local opt_bind opt_link opt_union
1373 opt_bind="true"
1374 opt_link=""
1375 opt_union=""
1376 for opt in $(echo ${options} | tr ',' ' ');
1378 case "${opt}" in
1379 bind)
1380 opt_bind="true"
1381 unset opt_link opt_union
1383 link)
1384 opt_link="true"
1385 unset opt_bind opt_union
1387 union)
1388 opt_union="true"
1389 unset opt_bind opt_link
1391 esac
1392 done
1394 if [ -n "$(what_is_mounted_on "${dest}")" ]
1395 then
1396 if [ "${dest}" = "${rootmnt}" ]
1397 then
1398 umount "${dest}"
1399 else
1400 log_warning_msg "Skipping custom mount ${dest}: $(what_is_mounted_on "${dest}") is already mounted there"
1401 continue
1405 if [ ! -d "${dest}" ]
1406 then
1407 # create the destination and delete existing files in
1408 # its path that are in the way
1409 path="/"
1410 for dir in $(echo ${dest} | sed -e 's|/\+| |g')
1412 path=$(trim_path ${path}/${dir})
1413 if [ -f ${path} ]
1414 then
1415 rm -f ${path}
1417 if [ ! -e ${path} ]
1418 then
1419 mkdir -p ${path}
1420 if echo ${path} | grep -qe "^${rootmnt}/*home/[^/]\+"
1421 then
1422 # if ${dest} is in /home try fixing proper ownership by assuming that the intended user is the first, which is usually the case
1423 # FIXME: this should really be handled by live-config since we don't know for sure which uid a certain user has until then
1424 chown 1000:1000 ${path}
1427 done
1430 # if ${source} doesn't exist on our persistence media
1431 # we bootstrap it with $dest from the live filesystem.
1432 # this both makes sense and is critical if we're
1433 # dealing with /etc or other system dir.
1434 if [ ! -d "${source}" ]
1435 then
1436 if [ -n "${PERSISTENCE_READONLY}" ]
1437 then
1438 continue
1439 elif [ -n "${opt_union}" ] || [ -n "${opt_link}" ]
1440 then
1441 # unions and don't need to be bootstrapped
1442 # link dirs can't be bootstrapped in a sensible way
1443 mkdir -p "${source}"
1444 chown_ref "${dest}" "${source}"
1445 chmod_ref "${dest}" "${source}"
1446 elif [ -n "${opt_bind}" ]
1447 then
1448 # ensure that $dest is not copied *into* $source
1449 mkdir -p "$(dirname ${source})"
1450 cp -a "${dest}" "${source}"
1454 # XXX: If CONFIG_AUFS_ROBR is added to the Debian kernel we can
1455 # ignore the loop below and set rootfs_dest_backing=$dest
1456 local rootfs_dest_backing
1457 rootfs_dest_backing=""
1458 if [ -n "${opt_link}" ] || [ -n "${opt_union}" ]
1459 then
1460 for d in /live/rootfs/*
1462 if [ -n "${rootmnt}" ]
1463 then
1464 fs="${d}/$(echo ${dest} | sed -e "s|${rootmnt}||")"
1465 else
1466 fs="${d}/${dest}"
1468 if [ -d "${fs}" ]
1469 then
1470 rootfs_dest_backing="${rootfs_dest_backing} ${fs}"
1472 done
1475 local cow_dir links_source
1476 if [ -n "${opt_link}" ] && [ -z "${PERSISTENCE_READONLY}" ]
1477 then
1478 link_files ${source} ${dest} "s|^/live/|/lib/live/mount/|"
1479 elif [ -n "${opt_link}" ] && [ -n "${PERSISTENCE_READONLY}" ]
1480 then
1481 mkdir -p ${rootmnt}/lib/live/mount/persistence
1482 links_source=$(mktemp -d ${rootmnt}/lib/live/mount/persistence/links-source-XXXXXX)
1483 chown_ref ${source} ${links_source}
1484 chmod_ref ${source} ${links_source}
1485 # We put the cow dir in the below strange place to
1486 # make it absolutely certain that the link source
1487 # has its own directory and isn't nested with some
1488 # other custom mount (if so that mount's files would
1489 # be linked, causing breakage.
1490 cow_dir="/live/overlay/lib/live/mount/persistence/$(basename ${links_source})"
1491 mkdir -p ${cow_dir}
1492 chown_ref "${source}" "${cow_dir}"
1493 chmod_ref "${source}" "${cow_dir}"
1494 do_union ${links_source} ${cow_dir} ${source} ${rootfs_dest_backing}
1495 link_files ${links_source} ${dest} "s|^${rootmnt}||"
1496 elif [ -n "${opt_union}" ] && [ -z "${PERSISTENCE_READONLY}" ]
1497 then
1498 do_union ${dest} ${source} ${rootfs_dest_backing}
1499 elif [ -n "${opt_bind}" ] && [ -z "${PERSISTENCE_READONLY}" ]
1500 then
1501 mount --bind "${source}" "${dest}"
1502 elif [ -n "${opt_bind}" -o -n "${opt_union}" ] && [ -n "${PERSISTENCE_READONLY}" ]
1503 then
1504 # bind-mount and union mount are handled the same
1505 # in read-only mode, but note that rootfs_dest_backing
1506 # is non-empty (and necessary) only for unions
1507 cow_dir="/live/overlay/${dest}"
1508 if [ -e "${cow_dir}" ] && [ -z "${opt_link}" ]
1509 then
1510 # If an earlier custom mount has files here
1511 # it will "block" the current mount's files
1512 # which is undesirable
1513 rm -rf "${cow_dir}"
1515 mkdir -p ${cow_dir}
1516 chown_ref "${source}" "${cow_dir}"
1517 chmod_ref "${source}" "${cow_dir}"
1518 do_union ${dest} ${cow_dir} ${source} ${rootfs_dest_backing}
1521 PERSISTENCE_IS_ON="1"
1522 export PERSISTENCE_IS_ON
1524 if echo ${used_devices} | grep -qve "^\(.* \)\?${device}\( .*\)\?$"
1525 then
1526 used_devices="${used_devices} ${device}"
1528 done < ${custom_mounts}
1530 echo ${used_devices}
1533 is_mountpoint ()
1535 directory="$1"
1537 [ $(stat -fc%d:%D "${directory}") != $(stat -fc%d:%D "${directory}/..") ]