Fixing persistence-media option when no devices are attached.
[live-boot-grml.git] / scripts / boot / 9990-overlay.sh
1 #!/bin/sh
2
3 #set -e
4
5 setup_unionfs ()
6 {
7         image_directory="${1}"
8         rootmnt="${2}"
9         addimage_directory="${3}"
10
11         case ${UNIONTYPE} in
12                 aufs|unionfs|overlayfs)
13                         modprobe -q -b ${UNIONTYPE}
14
15                         if ! cut -f2 /proc/filesystems | grep -q "^${UNIONTYPE}\$" && [ -x /bin/unionfs-fuse ]
16                         then
17                                 echo "${UNIONTYPE} not available, falling back to unionfs-fuse."
18                                 echo "This might be really slow."
19
20                                 UNIONTYPE="unionfs-fuse"
21                         fi
22                         ;;
23         esac
24
25         case "${UNIONTYPE}" in
26                 unionfs-fuse)
27                         modprobe fuse
28                         ;;
29         esac
30
31         # run-init can't deal with images in a subdir, but we're going to
32         # move all of these away before it runs anyway.  No, we're not,
33         # put them in / since move-mounting them into / breaks mono and
34         # some other apps.
35
36         croot="/"
37
38         # Let's just mount the read-only file systems first
39         rootfslist=""
40
41         if [ -z "${PLAIN_ROOT}" ]
42         then
43                 # Read image names from ${MODULE}.module if it exists
44                 if [ -e "${image_directory}/filesystem.${MODULE}.module" ]
45                 then
46                         for IMAGE in $(cat ${image_directory}/filesystem.${MODULE}.module)
47                         do
48                                 image_string="${image_string} ${image_directory}/${IMAGE}"
49                         done
50                 elif [ -e "${image_directory}/${MODULE}.module" ]
51                 then
52                         for IMAGE in $(cat ${image_directory}/${MODULE}.module)
53                         do
54                                 image_string="${image_string} ${image_directory}/${IMAGE}"
55                         done
56                 else
57                         # ${MODULE}.module does not exist, create a list of images
58                         for FILESYSTEM in squashfs ext2 ext3 ext4 xfs jffs2 dir
59                         do
60                                 for IMAGE in "${image_directory}"/*."${FILESYSTEM}"
61                                 do
62                                         if [ -e "${IMAGE}" ]
63                                         then
64                                                 image_string="${image_string} ${IMAGE}"
65                                         fi
66                                 done
67                         done
68
69                         if [ -n "${addimage_directory}" ] && [ -d "${addimage_directory}" ]
70                         then
71                                 for FILESYSTEM in squashfs ext2 ext3 ext4 xfs jffs2 dir
72                                 do
73                                         for IMAGE in "${addimage_directory}"/*."${FILESYSTEM}"
74                                         do
75                                                 if [ -e "${IMAGE}" ]
76                                                 then
77                                                         image_string="${image_string} ${IMAGE}"
78                                                 fi
79                                         done
80                                 done
81                         fi
82
83                         # Now sort the list
84                         image_string="$(echo ${image_string} | sed -e 's/ /\n/g' | sort )"
85                 fi
86
87                 [ -n "${MODULETORAMFILE}" ] && image_string="${image_directory}/$(basename ${MODULETORAMFILE})"
88
89                 mkdir -p "${croot}"
90
91                 for image in ${image_string}
92                 do
93                         imagename=$(basename "${image}")
94
95                         export image devname
96                         maybe_break live-realpremount
97                         log_begin_msg "Running /scripts/live-realpremount"
98                         run_scripts /scripts/live-realpremount
99                         log_end_msg
100
101                         if [ -d "${image}" ]
102                         then
103                                 # it is a plain directory: do nothing
104                                 rootfslist="${image} ${rootfslist}"
105                         elif [ -f "${image}" ]
106                         then
107                                 if losetup --help 2>&1 | grep -q -- "-r\b"
108                                 then
109                                         backdev=$(get_backing_device "${image}" "-r")
110                                 else
111                                         backdev=$(get_backing_device "${image}")
112                                 fi
113                                 fstype=$(get_fstype "${backdev}")
114
115                                 case "${fstype}" in
116                                         unknown)
117                                                 panic "Unknown file system type on ${backdev} (${image})"
118                                                 ;;
119
120                                         "")
121                                                 fstype="${imagename##*.}"
122                                                 log_warning_msg "Unknown file system type on ${backdev} (${image}), assuming ${fstype}."
123                                                 ;;
124                                 esac
125
126                                 case "${UNIONTYPE}" in
127                                         unionmount)
128                                                 mpoint="${rootmnt}"
129                                                 rootfslist="${rootmnt} ${rootfslist}"
130                                                 ;;
131
132                                         *)
133                                                 mpoint="${croot}/${imagename}"
134                                                 rootfslist="${mpoint} ${rootfslist}"
135                                                 ;;
136                                 esac
137
138                                 mkdir -p "${mpoint}"
139                                 log_begin_msg "Mounting \"${image}\" on \"${mpoint}\" via \"${backdev}\""
140                                 mount -t "${fstype}" -o ro,noatime "${backdev}" "${mpoint}" || panic "Can not mount ${backdev} (${image}) on ${mpoint}"
141                                 log_end_msg
142                         fi
143                 done
144         else
145                 # we have a plain root system
146                 mkdir -p "${croot}/filesystem"
147                 log_begin_msg "Mounting \"${image_directory}\" on \"${croot}/filesystem\""
148                 mount -t $(get_fstype "${image_directory}") -o ro,noatime "${image_directory}" "${croot}/filesystem" || \
149                         panic "Can not mount ${image_directory} on ${croot}/filesystem" && \
150                         rootfslist="${croot}/filesystem ${rootfslist}"
151                 # probably broken:
152                 mount -o bind ${croot}/filesystem $mountpoint
153                 log_end_msg
154         fi
155
156         # tmpfs file systems
157         touch /etc/fstab
158         mkdir -p /live/overlay
159         mount -t tmpfs tmpfs /live/overlay
160
161         # Looking for persistence devices or files
162         if [ -n "${PERSISTENCE}" ] && [ -z "${NOPERSISTENCE}" ]
163         then
164
165                 if [ -z "${QUICKUSBMODULES}" ]
166                 then
167                         # Load USB modules
168                         num_block=$(ls -l /sys/block | wc -l)
169                         for module in sd_mod uhci-hcd ehci-hcd ohci-hcd usb-storage
170                         do
171                                 modprobe -q -b ${module}
172                         done
173
174                         udevadm trigger
175                         udevadm settle
176
177                         # For some reason, udevsettle does not block in this scenario,
178                         # so we sleep for a little while.
179                         #
180                         # See https://bugs.launchpad.net/ubuntu/+source/casper/+bug/84591
181                         for timeout in 5 4 3 2 1
182                         do
183                                 sleep 1
184
185                                 if [ $(ls -l /sys/block | wc -l) -gt ${num_block} ]
186                                 then
187                                         break
188                                 fi
189                         done
190                 fi
191
192                 local whitelistdev=""
193                 if [ -n "${PERSISTENCE_MEDIA}" ]
194                 then
195                         case "${PERSISTENCE_MEDIA}" in
196                                 removable)
197                                         whitelistdev="$(removable_dev)"
198                                         ;;
199
200                                 removable-usb)
201                                         whitelistdev="$(removable_usb_dev)"
202                                         ;;
203                         esac
204                         if [ -z "${whitelistdev}" ]
205                         then
206                                 whitelistdev="ignore_all_devices"
207                         fi
208                 fi
209
210                 if is_in_comma_sep_list overlay ${PERSISTENCE_METHOD}
211                 then
212                         overlays="${custom_overlay_label}"
213                 fi
214
215                 local overlay_devices=""
216                 if [ "${whitelistdev}" != "ignore_all_devices" ]
217                 then
218                         for media in $(find_persistence_media "${overlays}" "${whitelistdev}")
219                         do
220                                 media="$(echo ${media} | tr ":" " ")"
221
222                                 case ${media} in
223                                         ${custom_overlay_label}=*)
224                                                 device="${media#*=}"
225                                                 overlay_devices="${overlay_devices} ${device}"
226                                                 ;;
227                                  esac
228                         done
229                 fi
230         elif [ -n "${NFS_COW}" ] && [ -z "${NOPERSISTENCE}" ]
231         then
232                 # check if there are any nfs options
233                 if echo ${NFS_COW} | grep -q ','
234                 then
235                         nfs_cow_opts="-o nolock,$(echo ${NFS_COW}|cut -d, -f2-)"
236                         nfs_cow=$(echo ${NFS_COW}|cut -d, -f1)
237                 else
238                         nfs_cow_opts="-o nolock"
239                         nfs_cow=${NFS_COW}
240                 fi
241
242                 if [ -n "${PERSISTENCE_READONLY}" ]
243                 then
244                         nfs_cow_opts="${nfs_cow_opts},nocto,ro"
245                 fi
246
247                 mac="$(get_mac)"
248                 if [ -n "${mac}" ]
249                 then
250                         cowdevice=$(echo ${nfs_cow} | sed "s/client_mac_address/${mac}/")
251                         cow_fstype="nfs"
252                 else
253                         panic "unable to determine mac address"
254                 fi
255         fi
256
257         if [ -z "${cowdevice}" ]
258         then
259                 cowdevice="tmpfs"
260                 cow_fstype="tmpfs"
261                 cow_mountopt="rw,noatime,mode=755"
262         fi
263
264         if [ "${UNIONTYPE}" != "unionmount" ]
265         then
266                 if [ -n "${PERSISTENCE_READONLY}" ] && [ "${cowdevice}" != "tmpfs" ]
267                 then
268                         mount -t tmpfs -o rw,noatime,mode=755 tmpfs "/live/overlay"
269                         root_backing="/live/persistence/$(basename ${cowdevice})-root"
270                         mkdir -p ${root_backing}
271                 else
272                         root_backing="/live/overlay"
273                 fi
274
275                 if [ "${cow_fstype}" = "nfs" ]
276                 then
277                         log_begin_msg \
278                                 "Trying nfsmount ${nfs_cow_opts} ${cowdevice} ${root_backing}"
279                         nfsmount ${nfs_cow_opts} ${cowdevice} ${root_backing} || \
280                                 panic "Can not mount ${cowdevice} (n: ${cow_fstype}) on ${root_backing}"
281                 else
282                         mount -t ${cow_fstype} -o ${cow_mountopt} ${cowdevice} ${root_backing} || \
283                                 panic "Can not mount ${cowdevice} (o: ${cow_fstype}) on ${root_backing}"
284                 fi
285         fi
286
287         rootfscount=$(echo ${rootfslist} |wc -w)
288
289         rootfs=${rootfslist%% }
290
291         if [ -n "${EXPOSED_ROOT}" ]
292         then
293                 if [ ${rootfscount} -ne 1 ]
294                 then
295                         panic "only one RO file system supported with exposedroot: ${rootfslist}"
296                 fi
297
298                 mount --bind ${rootfs} ${rootmnt} || \
299                         panic "bind mount of ${rootfs} failed"
300
301                 if [ -z "${SKIP_UNION_MOUNTS}" ]
302                 then
303                         cow_dirs='/var/tmp /var/lock /var/run /var/log /var/spool /home /var/lib/live'
304                 else
305                         cow_dirs=''
306                 fi
307         else
308                 cow_dirs="/"
309         fi
310
311         if [ "${cow_fstype}" != "tmpfs" ] && [ "${cow_dirs}" != "/" ] && [ "${UNIONTYPE}" = "unionmount" ]
312         then
313                 true # FIXME: Maybe it does, I don't really know.
314                 #panic "unionmount does not support subunions (${cow_dirs})."
315         fi
316
317         for dir in ${cow_dirs}; do
318                 unionmountpoint="${rootmnt}${dir}"
319                 mkdir -p ${unionmountpoint}
320                 if [ "${UNIONTYPE}" = "unionmount" ]
321                 then
322                         # FIXME: handle PERSISTENCE_READONLY
323                         unionmountopts="-t ${cow_fstype} -o noatime,union,${cow_mountopt} ${cowdevice}"
324                         mount_full $unionmountopts "${unionmountpoint}"
325                 else
326                         cow_dir="/live/overlay${dir}"
327                         rootfs_dir="${rootfs}${dir}"
328                         mkdir -p ${cow_dir}
329                         if [ -n "${PERSISTENCE_READONLY}" ] && [ "${cowdevice}" != "tmpfs" ]
330                         then
331                                 do_union ${unionmountpoint} ${cow_dir} ${root_backing} ${rootfs_dir}
332                         else
333                                 do_union ${unionmountpoint} ${cow_dir} ${rootfs_dir}
334                         fi
335                 fi || panic "mount ${UNIONTYPE} on ${unionmountpoint} failed with option ${unionmountopts}"
336         done
337
338         # Correct the permissions of /:
339         chmod 0755 "${rootmnt}"
340
341         # Correct the permission of /tmp:
342         if [ -d "${rootmnt}/tmp" ]
343         then
344                 chmod 1777 "${rootmnt}"/tmp
345         fi
346
347         live_rootfs_list=""
348         for d in ${rootfslist}
349         do
350                 live_rootfs="/live/rootfs/${d##*/}"
351                 live_rootfs_list="${live_rootfs_list} ${live_rootfs}"
352                 mkdir -p "${live_rootfs}"
353                 case d in
354                         *.dir)
355                                 # do nothing # mount -o bind "${d}" "${live_rootfs}"
356                                 ;;
357                         *)
358                                 case "${UNIONTYPE}" in
359                                         unionfs-fuse)
360                                                 mount -o bind "${d}" "${live_rootfs}"
361                                                 ;;
362
363                                         *)
364                                                 mount -o move "${d}" "${live_rootfs}"
365                                                 ;;
366                                 esac
367                                 ;;
368                 esac
369         done
370
371         # move all /live mountpoints that the custom persistence
372         # system depends on into /lib/live on the root filesystem
373         for _DIRECTORY in rootfs
374         do
375                 if [ -d "/live/${_DIRECTORY}" ]
376                 then
377                         mkdir -p "${rootmnt}/lib/live/mount/${_DIRECTORY}"
378
379                         for _MOUNT in $(ls /live/${_DIRECTORY})
380                         do
381                                 mkdir -p "${rootmnt}/lib/live/mount/${_DIRECTORY}/${_MOUNT}"
382                                 mount -o move "/live/${_DIRECTORY}/${_MOUNT}" "${rootmnt}/lib/live/mount/${_DIRECTORY}/${_MOUNT}" > /dev/null 2>&1 || \
383                                         mount -o bind "/live/${_DIRECTORY}/${_MOUNT}" "${rootmnt}/lib/live/mount/${_DIRECTORY}/${_MOUNT}" || \
384                                         log_warning_msg "W: failed to mount /live/${_DIRECTORY}/${_MOUNT} to ${rootmnt}/lib/live/mount/${_DIRECTORY}/${_MOUNT}"
385                         done
386                 fi
387         done
388
389         mkdir -p "${rootmnt}/lib/live/mount/overlay"
390         mount -o move /live/overlay "${rootmnt}/lib/live/mount/overlay" > /dev/null 2>&1 || \
391                 mount -o bind /live/overlay "${rootmnt}/lib/live/mount/overlay" || \
392                 log_warning_msg "W: failed to mount /live/overlay to ${rootmnt}/lib/live/mount/overlay"
393
394         # Adding custom persistence
395         if [ -n "${PERSISTENCE}" ] && [ -z "${NOPERSISTENCE}" ]
396         then
397                 local custom_mounts="/tmp/custom_mounts.list"
398                 rm -rf ${custom_mounts} 2> /dev/null
399
400                 # Gather information about custom mounts from devies detected as overlays
401                 get_custom_mounts ${custom_mounts} ${overlay_devices}
402
403                 [ -n "${DEBUG}" ] && cp ${custom_mounts} "/lib/live/mount/persistence"
404
405                 # Now we do the actual mounting (and symlinking)
406                 local used_overlays=""
407                 used_overlays=$(activate_custom_mounts ${custom_mounts})
408                 rm ${custom_mounts}
409
410                 # Close unused overlays (e.g. due to missing $persistence_list)
411                 for overlay in ${overlay_devices}
412                 do
413                         if echo ${used_overlays} | grep -qve "^\(.* \)\?${device}\( .*\)\?$"
414                         then
415                                 close_persistence_media ${overlay}
416                         fi
417                 done
418         fi
419
420         # ensure that a potentially stray tmpfs gets removed
421         # otherways, initramfs-tools is unable to remove /live
422         # and fails to boot
423         umount /live/overlay || true
424 }