summaryrefslogtreecommitdiff
path: root/make-boot-image.sh
blob: 18cbe012011dda8b2f34de646b5cce426520cab0 (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
#!/bin/bash -xe
PS4='+ ($LINENO) ' # To ease debugging
VERSION="1.1-emac"

# Config #
##########
WORKDIR=./work		# Must not be with "nodev" mount option
                        # sudo rm -r this folder if you want to re-run everything
DLDIR=./downloads
OUTDIR=./out
#OUTUSB=/dev/sdb	# If enabled, it could wreck everything there !
LEGACY=n		# make USB bootable key compatible with non UEFI-BIOS
DEVEL_MODE=n		# Adds debugging tools in the generated image
INCLUDE_TCPDUMP=n	# tcpdump costs few Mb with libcrypto
ROOTCMD=sudo
WGET="wget"		 # "wget --no-check-certificate" could help but is a security concern
# You probably need to tweak version numbers if you have an HTTP 404 - Not found error
KERNEL_TARBALL_URL=https://cdn.kernel.org/pub/linux/kernel/v4.x/linux-4.19.17.tar.xz
KCONFIGLIB_MAIN_URL=https://raw.githubusercontent.com/ulfalizer/Kconfiglib/v10.36.0/kconfiglib.py
KCONFIGLIB_PATCH_URL=https://raw.githubusercontent.com/ulfalizer/Kconfiglib/master/makefile.patch
NIC_FIRMWARE_URL=http://fr.archive.ubuntu.com/ubuntu/pool/main/l/linux-firmware/linux-firmware_1.173.5_all.deb
BUSYBOX_BIN_URL=https://busybox.net/downloads/binaries/1.26.2-defconfig-multiarch/busybox-x86_64
PCI_IDS_URL=https://pci-ids.ucw.cz/v2.2/pci.ids
USB_IDS_URL=https://usb-ids.gowdy.us/usb.ids

# Utilities #
#############
function add_initrd_script
{
	( echo "#!/bin/busybox sh" ; cat ) > "$WORKDIR/initrd/$1"
	chmod +x "$WORKDIR/initrd/$1"
}

# From https://landley.net/writing/rootfs-programming.html
# Its first argument is the new directory, and the rest of its arguments are executables to copy.
function mkchroot
{
  [ $# -lt 2 ] && return 0
  dest=$1
  shift
  for i in "$@"
  do
    # Get an absolute path for the file
    p=$i
    [ "${p:0:1}" == "/" ] || p=$(which $i) || true
    if [ ! -e "$p" ]
    then echo "mkchoot not found: $i"
         return 1
    fi
    # Skip files that already exist at target.
    [ -s "$dest/$p" ] && continue
    # Create destination path
    d=$(echo "$p" | grep -o '.*/') &&
    mkdir -p "$dest/$d" &&
    # Copy file
    echo + cp --dereference --preserve=mode "$p" "$dest/$p" &&
    cp --dereference --preserve=mode "$p" "$dest/$p" &&
    # Recursively copy shared libraries' shared libraries.
    mkchroot "$dest" $(ldd "$p" | egrep -o '/.* ') || return $?
  done
}

# Environement and dependencies #
#################################
which lsb_release || $ROOTCMD apt install lsb-release
codename=$(lsb_release -sc || true)
if [ "x$codename" != "xbuster" ]
then	cat >&2 <<EOT
This script is tested only on GNU/Linux Debian 10 amd64 (aka Buster).
The fastest way to have the right environment is :
 * download Debian 10 amd64 live
   * here : http://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/
   * or here : http://cdimage.debian.org/mirror/cdimage/archive/
 * burn it or copy it on a USB stick (as raw, with "sudo cp XX.iso /dev/sdX")
   * alternatively launch a VM with it
 * run this script from there
EOT
	exit 1
fi

mkdir -p "$WORKDIR" "$DLDIR" "$OUTDIR"
umask 0022 # Needed for embeding initrd without "sudo make" in kernel dir

# When using sudo with password auth, ask and cache pass first
$ROOTCMD true

if [ ! -e "$DLDIR/apt-update-done" ]
then	$ROOTCMD apt-get update
	> "$DLDIR/apt-update-done"
fi

if [ ! -e "$WORKDIR/apt-install-done" ]
then	# Dependencies of this script (assuming default debian install or live)
	$ROOTCMD apt-get install wget libncurses5-dev coreutils
	[ "x$LEGACY" == "xy" ] && $ROOTCMD apt-get install mbr syslinux
	# Dependencies for kernel building
	$ROOTCMD apt-get install build-essential flex bison

	# Dependencies for kernel tools
	[ "x$DEVEL_MODE" == "xy" ] && $ROOTCMD apt-get install libelf-dev libunwind-dev \
		libdw-dev libaudit-dev libssl-dev libslang2-dev libnuma-dev \
		systemtap-sdt-dev python-dev binutils-dev libiberty-dev libbabeltrace-ctf-dev
	# Optionnally qemu to run the result for santity checking
	[ "x$DEVEL_MODE" = "xy" ] && $ROOTCMD apt-get install qemu-system-x86
	# Dependencies to put into the initrd
	# util-linux : fdisk, sfdisk, lsblk, setterm
	# net-tools : mii-tool
	# ncurses-bin : tput
	$ROOTCMD apt-get install dmidecode pciutils usbutils lshw sysstat iftop strace rsync \
		ntfs-3g e2fsprogs dosfstools exfat-utils partclone util-linux gdisk efibootmgr \
		pv bc figlet toilet-fonts ncurses-bin beep net-tools ethtool pigz tmux
	# Optionnal dependencies to put into the initrd
	[ "x$INCLUDE_TCPDUMP" == "xy" ] && $ROOTCMD apt-get install tcpdump
	> "$WORKDIR/apt-install-done"
fi

# Kernel build setup #
######################
kernel_tarball=$DLDIR/$(basename $KERNEL_TARBALL_URL)
[ -s "$kernel_tarball" ] || $WGET -O "$kernel_tarball" "$KERNEL_TARBALL_URL"
if [ ! -s "$WORKDIR/kernel/Makefile" ]
then	mkdir -p "$WORKDIR/kernel"
	tar xf "$kernel_tarball" --strip-components=1 -C "$WORKDIR/kernel"
fi

if [ ! -s "$WORKDIR/kernel/scripts/Kconfiglib/kconfiglib.py" ]
then
	[ -s "$DLDIR/kconfiglib.py" ] || $WGET -O "$DLDIR/kconfiglib.py" "$KCONFIGLIB_MAIN_URL"
	[ -s "$DLDIR/makefile.patch" ] || $WGET -O "$DLDIR/makefile.patch" "$KCONFIGLIB_PATCH_URL"
	mkdir -p "$WORKDIR/kernel/scripts/Kconfiglib"
	patch -t -p1 -d "$WORKDIR/kernel" < "$DLDIR/makefile.patch" && \
	cp "$DLDIR/kconfiglib.py" "$WORKDIR/kernel/scripts/Kconfiglib/kconfiglib.py"
	patch -t -p1 -d "$WORKDIR/kernel" < "$DLDIR/makefile.patch"
fi

cat >"$WORKDIR/kernel/scripts/Kconfiglib/customize.py" <<"EOT"
#!/usr/bin/env python
import sys
from kconfiglib import Kconfig, standard_config_filename, TRI_TO_STR, TRISTATE

def sset(sym, value=None):
    # Default value
    if value == None:
        if sym.assignable:
            # find highest possible assignable value (last item of modifiable sorted tuple)
            value = sym.assignable[-1]
        else:
            print('%s is not modifiable at all for now'%sym.name)
            return True
    # Sanity check
    if isinstance(value, (int, long)) and value not in sym.assignable:
        print('%s can\'t be set to %s for now'%(sym.name,TRI_TO_STR[value]))
        return True
    # Idempotency check
    if isinstance(value, (int, long)):
        old_value = sym.tri_value
    else:
        old_value = sym.str_value
    if old_value == value:
        # No more_work
        return False
    # Set value
    if isinstance(value, (int, long)):
        print('%s=%s [was: %s]'%(sym.name,TRI_TO_STR[value],TRI_TO_STR[old_value]))
    else:
        print('%s=%s [was: %s]'%(sym.name,value,old_value))
    sym.set_value(value)
    # plausible more_work to do
    return True

kconf = Kconfig(sys.argv[1])
kconf.load_config(standard_config_filename())
debug = '--debug' in sys.argv;
passes = 5

support_xz = 'HAVE_KERNEL_XZ' in kconf.syms
print('support_xz == %r'%support_xz)

i = 0
more_work = True
while more_work and i < passes:
    more_work = False
    i += 1
    print('Kconfiglib/customize.py pass %i'%i)

    for sym in kconf.defined_syms:
        # Default hostname is (none) and could make FreeBSD's dhcpd complain because unallowed '()'
        if sym.name == 'DEFAULT_HOSTNAME':
            more_work = sset(sym, 'eficast') or more_work

        # Embed initrd in the EFI bootable kernel
        if sym.name == 'INITRAMFS_SOURCE':
            more_work = sset(sym, '../initrd/') or more_work

        # Make kernel directly loadable by EFI, add USB3, Dell flash
        if sym.name in ['EFI_STUB', 'EARLY_PRINTK_EFI', 'EFI_VARS', 'DELL_RBU', 'USB_XHCI_HCD', 'IKCONFIG']:
            more_work = sset(sym) or more_work

        # Support FUSE, soft RAID (linux) and hard RAID (some cards)
        if sym.name in ['FUSE_FS', 'DM_RAID', 'SCSI_LOWLEVEL', 'MEGARAID_SAS', 'MEGARAID_NEWGEN']:
            more_work = sset(sym) or more_work

        # If --debug passed as arg, make kernel aware of virtual drivers (used for testing eficast on qemu/kvm)
        if debug and sym.name in ['VIRTIO_PCI', 'VIRTIO_MMIO', 'VIRTIO_NET', 'VIRTIO_BLK', 'SCSI_LOWLEVEL', 'SCSI_VIRTIO']:
            more_work = sset(sym) or more_work

        # Disable thing that are unneeded or annoying for the purpose of disk cloning
	# FIXME Need NFS v3 client
        if sym.name in [ 'HAMRADIO', 'HIBERNATION', 'LOGO', 'NETFILTER', # 'KEYS', 'NETWORK_FILESYSTEMS',
        'PCCARD', 'RFKILL', 'SECURITY', 'SOUND', 'SUSPEND', 'VIRTUALIZATION', 'WIRELESS', 'WLAN']:
            more_work = sset(sym, 0) or more_work

        # Compress everything with XZ if available (slower, smaller)
        if support_xz:
            if sym.name in ['KERNEL_XZ', 'RD_XZ']: # , 'INITRAMFS_COMPRESSION_XZ']:
                more_work = sset(sym) or more_work
            if sym.name in ['RD_GZIP', 'RD_BZIP2', 'RD_LZMA', 'RD_LZO', 'RD_LZ4']:
                more_work = sset(sym, 0) or more_work
            if sym.name == 'INITRAMFS_COMPRESSION':
                more_work = sset(sym, '.xz') or more_work

        # Following generic actions should done only on visible TRISTATE symbols
        if sym.type == TRISTATE and sym.visibility > 0:

            # Build all available net/ethernet drivers
            if True in [ ('drivers/net/ethernet' in node.filename) for node in sym.nodes ]:
                more_work = sset(sym) or more_work

            # Try to get everything in kernel, not as a module (1=='m')
            if sym.tri_value == 1 and sym.assignable and 2 in sym.assignable:
                more_work = sset(sym) or more_work

# Write .config even if some symbols are unset
res = kconf.write_config(standard_config_filename())

if i == passes:
    print('ERROR : can\'t set some of kernel config symbols after %i passes'%passes)
    res = 1
sys.exit(res)

EOT
chmod +x "$WORKDIR/kernel/scripts/Kconfiglib/customize.py"

# Kernel prepare + make tools #
###############################
(
	cd "$WORKDIR/kernel"
	if [ ! -s .config ]
	then	make defconfig
		if [ "x$DEVEL_MODE" == "xy" ]
		then extra="SCRIPT_ARG=--debug"
		else extra=""
		fi
		make scriptconfig SCRIPT=scripts/Kconfiglib/customize.py $extra
	fi
)

if [ "x$DEVEL_MODE" == "xy" -a ! -s "$WORKDIR/kernel/tools/perf/perf" ]
then	(
		cd "$WORKDIR/kernel"
		# Workaround : linux-3.16.57 (and others?) have make tools/perf broken, ignore it
		make tools/perf || true
	)
fi

# Initial Ram Disk building (embed in kernel) #
###############################################
if [ ! -s "$WORKDIR/initrd/etc/group" ]
then	mkdir -p "$WORKDIR/initrd/"{bin,dev,etc/rc.d,mnt/nfs,root,proc,root,sbin,sys,run/lock,run,tmp,usr/share/udhcpc,var/log}
	$ROOTCMD cp -a /dev/{null,console,tty1} "$WORKDIR/initrd/dev/"
	$ROOTCMD chmod 1777 "$WORKDIR/initrd/run/lock"
	touch "$WORKDIR/initrd/etc/fstab"
	ln -s "/proc/mounts" "$WORKDIR/initrd/etc/mtab"
	ln -s "../run" "$WORKDIR/initrd/var/run"
	ln -s "../run/lock" "$WORKDIR/initrd/var/lock"
	echo 'root::0:0:root:/root:/bin/sh' > "$WORKDIR/initrd/etc/passwd"
	echo 'root:x:0:' > "$WORKDIR/initrd/etc/group"
fi

# XXX workaround, kernel makefile's cpio preseves everything and it is not so cool for us
$ROOTCMD chown -R $USER: "$WORKDIR/initrd"

if [ ! -s "$WORKDIR/initrd/bin/busybox" ]
then	[ -s "$DLDIR/busybox" ] || $WGET -O "$DLDIR/busybox" "$BUSYBOX_BIN_URL"
	cp "$DLDIR/busybox" "$WORKDIR/initrd/bin/busybox"
	chmod +x "$WORKDIR/initrd/bin/busybox"
fi
if [ ! -L "$WORKDIR/initrd/init" ]
then	ln -s /bin/busybox "$WORKDIR/initrd/init"
fi

if [ ! -s "$WORKDIR/initrd/etc/keys.bmap" ]
then
	# FIXME fails on Debian 9 and 10
	$ROOTCMD dumpkeys | $ROOTCMD loadkeys -ub > "$WORKDIR/initrd/etc/keys.bmap"
	cp -a /etc/localtime "$WORKDIR/initrd/etc/"
fi

if [ ! -s "$WORKDIR/initrd/usr/share/figlet/standard" ]
then	(
		set +x
		PATH="$WORKDIR/kernel/tools/perf:/usr/sbin:/usr/bin:/sbin:/bin"
		# Diagnostic tools
		mkchroot "$WORKDIR/initrd" dmidecode iftop iostat lshw lspci lsblk lsusb mpstat
		# Console tools and manpages display
		mkchroot "$WORKDIR/initrd" tput setterm strace groff nroff troff grotty gtbl tmux bc pv figlet beep
		# Filesystem tools
		mkchroot "$WORKDIR/initrd" mkfs mke2fs /sbin/mkfs.ext* mkntfs mkfs.ntfs mkfs.fat mkexfatfs mkfs.exfat mkfs
		mkchroot "$WORKDIR/initrd" ntfs-3g mount.ntfs mount.fuse mount.exfat-fuse mount.exfat
		mkchroot "$WORKDIR/initrd" /sbin/ntfs* /bin/ntfs*
		# Network tools
		mkchroot "$WORKDIR/initrd" mii-tool ethtool
		# Disk tools
		mkchroot "$WORKDIR/initrd" fdisk gdisk sfdisk sgdisk
		# Cloning tools
		mkchroot "$WORKDIR/initrd" /usr/sbin/partclone* efibootmgr pigz scp rsync
		# Some dyn-loaded libraries (ldd will not display them)
		mkchroot "$WORKDIR/initrd" /lib/x86_64-linux-gnu/libusb-1.0.so.0 /lib/x86_64-linux-gnu/libusb-1.0.so.0.1.0

		if [ "x$INCLUDE_TCPDUMP" == "xy" ]
		then	# tcpdump costs few Mb with libcrypto
			mkchroot "$WORKDIR/initrd" tcpdump
		fi

		# Some needed data files
		cp -ra /lib/terminfo "$WORKDIR"/initrd/lib/
		mkdir -p "$WORKDIR"/initrd/usr/lib/locale "$WORKDIR"/initrd/usr/share/figlet
		cp -ra /usr/lib/locale/C.UTF-8 "$WORKDIR"/initrd/usr/lib/locale/
		cp -a /usr/share/figlet/{standard,mono12}* "$WORKDIR"/initrd/usr/share/figlet/
	)
fi

if [ "x$DEVEL_MODE" == "xy" ]
then	(
		# Perf tool
		p="$WORKDIR/kernel/tools/perf/perf"
		cp -a "$p" "$WORKDIR/initrd/sbin/"
		set +x
		mkchroot "$WORKDIR/initrd" $(ldd "$p" | egrep -o '/.* ')
	)
fi

if [ ! -f "$WORKDIR/initrd/usr/share/groff/current/man.local" ]
then	mkdir -p "$WORKDIR"/initrd/usr/man/man{1,6,8} "$WORKDIR"/initrd/usr/share/groff/current/font
	mkdir -p "$WORKDIR"/initrd/etc/groff/

	cp -a /usr/share/man/man1/{beep,iostat,lshw,mpstat,setterm,bc,pv,strace,tmux,pigz}* "$WORKDIR"/initrd/usr/man/man1/
	cp -a /usr/share/man/man6/figlet* "$WORKDIR"/initrd/usr/man/man6/
	cp -a /usr/share/man/man8/{dmidecode,iftop,lspci,lsblk,lsusb,partclone,efibootmgr,mkfs}* "$WORKDIR"/initrd/usr/man/man8/
	cp -a /usr/share/man/man8/{ntfs,mkntfs,mkexfatfs,mount.ntfs,mount.fuse,mount.exfat-fuse}* "$WORKDIR"/initrd/usr/man/man8/
	cp -a /usr/share/man/man8/{mount.exfat,fdisk,gdisk,sfdisk,sgdisk,tcpdump,mii-tool,ethtool}* "$WORKDIR"/initrd/usr/man/man8/

	cp -ra /usr/share/groff/current/font/devascii "$WORKDIR"/initrd/usr/share/groff/current/font/
	cp -ra /usr/share/groff/current/tmac "$WORKDIR"/initrd/usr/share/groff/current/
	cp -a /etc/groff/man.local "$WORKDIR"/initrd/etc/groff/
fi

p="$WORKDIR/kernel/tools/perf/perf"
if [ "x$KERNEL_TOOLS" == "xy" -a ! -s "$p" ]
then	(
		cp -a "$p" "$WORKDIR/initrd/sbin/"
		set +x
		mkchroot "$WORKDIR/initrd" $(ldd "$p" | egrep -o '/.* ')
	)
fi

if [ ! -s "$WORKDIR/initrd/usr/share/misc/pci.ids" ]
then	[ -s "$DLDIR/pci.ids" ] || $WGET -O "$DLDIR/pci.ids" "$PCI_IDS_URL"
	[ -s "$DLDIR/usb.ids" ] || $WGET -O "$DLDIR/usb.ids" "$USB_IDS_URL"
	mkdir -p "$WORKDIR/initrd/var/lib/usbutils" "$WORKDIR/initrd/usr/share/misc"
	cp "$DLDIR/usb.ids" "$WORKDIR/initrd/var/lib/usbutils/"
	cp "$DLDIR/pci.ids" "$WORKDIR/initrd/usr/share/misc/"
fi

if [ ! -d "$WORKDIR/firmware" ]
then	[ -s "$DLDIR/nic-firmware.deb" ] || $WGET -O "$DLDIR/nic-firmware.deb" "$NIC_FIRMWARE_URL"
	mkdir -p "$WORKDIR/firmware"
	dpkg -x "$DLDIR/nic-firmware.deb" "$WORKDIR/firmware/"
fi
if [ ! -d "$WORKDIR/initrd/lib/firmware/rtl_nic" ]
then	mkdir -p "$WORKDIR/initrd/lib/firmware"
	cp -r "$WORKDIR/firmware/lib/firmware/rtl_nic" "$WORKDIR/initrd/lib/firmware/"
fi

echo $VERSION > "$WORKDIR/initrd/etc/eficast_version"

cat > "$WORKDIR/initrd/etc/rc.d/funcs" <<"EOF"
# echo_color <foreground_color> <background_color> [prefix_string] <message>
echo_color() {
	setterm --foreground "$1" --background "$2"
	echo -n "$3"
	setterm --foreground white --background black
	[ "x$4" == "xversion" ] && echo " (eficast v"$(cat /etc/eficast_version)")" || echo
}

# no args, print colored message, wait 10 sec and reboot
eficast_end() {
	echo -e "\e]2;eficast_end\007"	# Term title (tmux), intentionnal carriage return
	echo_color white green "----- EFICAST end of execution  ------"
	( sfx_success ; touch /run/nosound ) &
	[ -r /run/eficast_end ] && action=$(cat /run/eficast_end)
	case $action in
		poweroff) 	read -t10 -p 'Ctrl+C to have a shell, Enter to skip wait time for poweroff...'
				poweroff
				;;
		reboot)		read -t10 -p 'Ctrl+C to have a shell, Enter to skip wait time for reboot...'
				reboot
				;;
		*)		echo "Dropping a shell (consider putting poweroff or reboot in /run/eficast_end)"
				PS1='\h:\w# ' HOME='/root/' /bin/busybox sh
				;;
	esac
}

# note : rcS rescue_shell is slighly different because most of the env is not ready in rcS
rescue_shell() {
	echo -e "\e]2;rescue_shell\007"	# Term title (tmux), intentionnal carriage return
	echo_color white red "Something went wrong. Dropping to a shell." version
	( sfx_failure ; touch /run/nosound ) &
	PS1='\h:\w# ' HOME='/root/' /bin/busybox sh
}

machine_info() {
	setterm -bold on
	grep -F MemTotal: /proc/meminfo
	for k in system-manufacturer system-product-name \
		baseboard-manufacturer baseboard-product-name \
		bios-version bios-release-date
	do
		echo $k: $(dmidecode -s $k)
	done
	lspci -nn | cut -d' ' -f2- | sed -ne 's/^Ethernet[^:]*/network-card/p'
	ip -o l | sed -ne 's/[0-9]*: \([^:]*\):[^\\]*\\\s*link\/ether\s/network-mac-\1: /p'
	lsblk -dnl | sed 's/^/disk: /'
	lsusb 2>/dev/null | grep -vE hub$ | cut -d: -f2- | sed 's/^ ID/usb-device:/'
	setterm -bold off
}

network_conf() {
	pidof udhcpc >/dev/null && killall udhcpc # Reap background udhcpc in case of rc2 retry
	ip -oneline link | grep LOWER_UP | cut -d: -f2 | grep -v sit | grep -v lo | while read iface
	do
		udhcpc -b $iface -t 15
	done
}

network_show() {
	setterm -bold on
	ip -o addr show | sed -ne 's/[0-9]*:\s*\(\S*\)\s*inet6*\s\(\S*\)\s.*$/\1: \2/p'
	setterm -bold off
}

autorun_cleanup() {
	if [ -f /run/rescue ]
	then	rm /run/rescue
		echo_color green black "function autorun() is exiting. Spawn rescue_shell now"
		rescue_shell
	fi
}

autorun() {
	trap autorun_cleanup INT TERM EXIT
	echo_color green black "$1-autorun.sh script will run on now"
	read -t10 -p 'Ctrl+C to have a shell, Enter to skip wait time...'

	case $1 in
		initrd)	echo -ne "\e]2;initrd-autorun.sh\007" # Term title (tmux)
			message initrd autorun
			source /etc/rc.d/initrd-autorun.sh
			;;
		nfs)	source nfs-mount
			if [ $? -ne 0 ]
			then	echo_color white red "----- NFS server : not mounted ------"
				echo_color green black "Check for failure above. Exiting rescue shell will retry everything"
				false; cleanup
			fi
			if ! [ -x /mnt/nfs/nfs-autorun.sh ]
			then	echo_color white red "----- NFS server : missing script ------"
				echo_color green black "Check nfs-autorun.sh : should be present, readable and executable"
				ls -l /mnt/nfs
				false; cleanup
			fi
			echo_color white green "----- NFS server ready ------"
			message nfs autorun
			echo -ne "\e]2;nfs-autorun.sh\007" # Term title (tmux)
			cd /mnt/nfs
			# don't use source here, exit in inner script will skip cleanup routine (and rescue_shell)
			./nfs-autorun.sh
			;;
		*)	echo "Usage : $0 (nfs|initrd)"
			false;;
	esac
	res=$?
	[ $res -eq 0 ] || touch /run/rescue
	echo_color green black "function autorun() return code : $res"
}

notes() {
  echo 'print "n=CCDEEFFGAABB\na=nsnbnnsnbnbn\n(\n"; for (d=21;d<109;d++) {
      scale=20; f=440*e((d-69)/12*l(2)); fr=f+0.5; scale=0; fr=fr/1; o=d/12-1; t=d%12;
      print "echo ${n:",t,":1}${a:",t,":1}",o,"=",fr,"\n"
    }; print ") | tr -d n"' | bc -l | busybox sh
}

sound() {
	[ -f /run/nosound ] && return 0
	mode=$1; dur=$2; shift 2; args="-l0"
	while [ -n "$1" ]; do
		case $mode in
			1) args="$args -n -f$1 -l$dur";;
			2) args="$args -n -f$1 -l$(($2*dur))";;
			3) args="$args -n -f$1 -l$(($2*dur)) -D$(($3*dur))";;
		esac
		shift $mode
	done
	beep $args
}

sfx_question() { sound 2 50 $E7 2 $C7 2 $E7 2 $C7 3; }
sfx_success() { sound 1 140 $E6 $G6 $E7 $C7 $D7 $G7 ; }
sfx_failure() { sound 3 100 $C5 1 3 $G4 1 3 $E4 3 0 $A4 2 0 $B4 2 0 $A4 2 0 $Ab4 3 0 $Bb4 3 0 $Ab4 3 0 $G4 6 0 ; }
sfx_starting() { sound 1 25 $C5 $G4 $C5 $E5 $G5 $C6 $G5 $Ab4 $C5 $Eb5 $Ab5 $Eb5 $Ab5 $C6 $Eb6 $Ab6 $Eb6 $Bb4 $D5 $F5 $Bb5 $D6 $F6 $Bb6 $F6 ; }

eval $(notes)
EOF

# All shell spawned here must be login-shell, will load /etc/profile
cat > "$WORKDIR/initrd/etc/inittab" <<"EOF"
# Custom init scripts
::sysinit:/etc/rc.d/rcS
# Standard things follow
::ctrlaltdel:/sbin/reboot -f
::shutdown:/sbin/swapoff -a
::shutdown:/bin/umount -a -r
::restart:/sbin/init
tty1::respawn:/bin/sh -lc /etc/rc.d/rc2-or-rescue
tty2::askfirst:/bin/sh -l
tty3::askfirst:/bin/sh -l
EOF
cat > "$WORKDIR/initrd/etc/profile" <<"EOF"
export LC_ALL=C.UTF-8
export TERM=linux # busybox on qemu set vt102, then tmux segfaults
# https://git.busybox.net/busybox/tree/init/init.c, search for VT_OPENQRY
# happens if qemu pass "-append console=ttyS0" or similar to the kernel
EOF

add_initrd_script "/etc/rc.d/rcS" <<"EOF"
echo -e '\e[37;42m'----- EFICAST start of execution  ------'\e[0m'
echo -e '\e[32m/etc/rc.d/rcS script will run on /dev/console now\e[0m'
echo -e '\e[37;43m'----- rcS script started -----'\e[0m'	# Hint for user about boot steps if its hangs

# Declare some funcs to have a tidy output with trace mode
# note : rc.d/funcs rescue_shell is slighly different the environnement is ready to go
rescue_shell() {
	busybox echo -e '\e[37;41m'Something went wrong. Dropping to a shell.'\e[0m'
	busybox beep
	PS1='\h:\w# ' busybox setsid busybox cttyhack busybox sh
	busybox sync; busybox umount /dev/pts /dev /sys /proc
	busybox reboot -f
}

mount_pseudofilesystems() {
	# Mount pseudo-filesystems
	mount -t proc none /proc || return $?
	mount -t sysfs none /sys || return $?
	mount -t devtmpfs -o size=1m none /dev || return $?
	mkdir /dev/pts || return $?
	mount -t devpts none /dev/pts || return $?
	ln -s /proc/self/fd/2 /dev/stderr
	return 0
}

coldplugging() {
	echo 4 > /proc/sys/kernel/printk
	for d in /sys/bus/*/devices/*
	do
		cd $d
		[ -r driver ] || echo add > uevent
	done
	sleep 3
	cut -f4 /proc/sys/kernel/printk > /proc/sys/kernel/printk
}

network_up() {
	ip -oneline link | grep DOWN | cut -d: -f2 | grep -v sit | grep -v lo | while read iface
	do
		# BugFix Intel 217LM + WakeOnLan + dual-boot Windows 10
		# After Windows hibernation or fast boot powerdown, link goes up but no network packets go out of the chip
		d=/sys/class/net/$iface/device
		if [ 0x153a = $(cat $d/device) ]
		then	echo 1 \> $d/reset
			echo 1 > $d/reset
		fi
		# BugFix Realtek 8168 + dual-boot Windows 10
		# After reboot to linux, linux kernel don't load firmware, link never came up
		if [ 0x8168 = $(cat $d/device) ]
		then	echo 1 \> $d/reset
			echo 1 > $d/reset
		fi

		echo ip link set dev $iface up
		ip link set dev $iface up
	done
}

# Trace execution
set -v
/bin/busybox --install -s||rescue_shell	# Setup busybox symlinks for all applets
mount_pseudofilesystems || rescue_shell	# Setup /dev, /proc, /sys and so
klogd; syslogd				# Start logging in /var/log/messages
mount -o remount -o size=80% /		# Allow using most of RAM for rootfs
coldplugging				# Load modules for cold-plugged peripherials
network_up				# Bring net interfaces up (no config) 
loadkmap < /etc/keys.bmap		# Load keyboard layout
sleep 5 	# Wait for physical link detection + STP + IPv6 DAD & Autoconf
set +v
# Hint users about boot steps to help them if it hangs
echo -e '\e[32m/etc/rc.d/rc2-or-rescue script will run on /dev/tty1 now\e[0m'
echo -e '\e[37;43m----- rcS script ended -----\e[0m'
EOF
add_initrd_script "/etc/rc.d/rc2" <<"EOF"
echo -e '\e[37;43m'----- rc2 script started -----'\e[0m'	# Hint for user about boot steps if its hangs
. /etc/rc.d/funcs		# Load helper functions
setterm -blank 60		# screen sleep mode after 60 minutes
set -v				# Trace execution

network_conf
network_show
machine_info

#touch /run/nosound
autorun nfs && eficast_end
#autorun initrd && eficast_end
set +v
echo -e '\e[37;43m'----- rc2 script ended -----'\e[0m'	# Hint for user about boot steps if its hangs
EOF
add_initrd_script "/etc/rc.d/initrd-autorun.sh" <<"EOF"
read -t60 -p 'Dummy script. Ctrl+C to have a shell, Enter to skip wait time...'
EOF
add_initrd_script "/etc/rc.d/rc2-or-rescue" <<"EOF"
. /etc/rc.d/funcs		# Load helper functions
if [ -f /run/rescue ]
then	rm /run/rescue
	echo_color green black "/etc/rc.d/rc2 dead. Spawn rescue_shell run on /dev/tty1 now"
	rescue_shell
else	touch /run/rescue
	echo_color green black "/etc/rc.d/rc2 script will run on /dev/tty1 now"
	/etc/rc.d/rc2
fi
EOF
add_initrd_script "/sbin/hotplug" <<"EOF"
# Be verbose for PCI cards, be silent for the rest (many many things), log everything
# No support for change or remove events
# Could run very early, before busybox links installation
if [ "x$ACTION" = "xadd" ]
then	if [ -n "$PCI_ID" ]
	then	if [ -n "$MODALIAS" ]
		then	echo "$0: PCI_ID==$PCI_ID, starting 'modprobe $MODALIAS'"
		else	echo -e "\e[37;43m$0: PCI_ID==$PCI_ID, no MODALIAS found\e[0m"
		fi
		modprobe -v $MODALIAS 2>&1 | busybox awk -vT="$0: DEVPATH=$DEVPATH PCI_ID==$PCI_ID " '{print T $0 }' | tee -a /var/log/hotplug-pci.log

	else	if [ -n "$MODALIAS" ]
		then	modprobe -v $MODALIAS 2>&1 | busybox awk -vT="$0: DEVPATH=$DEVPATH MODALIAS==$MODALIAS " '{print T $0 }' >> /var/log/hotplug-non-pci.log
		else	echo "$0: DEVPATH=$DEVPATH no MODALIAS found" >> /var/log/hotplug-non-pci.log
		fi
	fi
else	echo "$0: DEVPATH=$DEVPATH : no support for '$ACTION'" >> /var/log/hotplug-unsupported.log
fi > /dev/console 2>&1
EOF
add_initrd_script "/bin/nfs-mount" <<"EOF"
echo -ne "\e]2;$0\007"	# Term title (tmux)
mount | grep -q /mnt/nfs && umount /mnt/nfs
set -v			# Trace execution
mount -v -t nfs -o nolock 172.16.2.28:/masters /mnt/nfs
EOF
add_initrd_script "/bin/iftop-watch" <<"EOF"
echo -ne "\e]2;$*\007" # Term title (tmux)
iftop -nNl
EOF
add_initrd_script "/bin/iostat-watch" <<"EOF"
# Emulates watch command with iostat (filtered info, minimal height)
echo -ne "\e]2;$*\007" # Term title (tmux)
iostat -cdmz 1 | awk '$1=="avg-cpu:"{system("clear")} length($0)>0{print}'
EOF
add_initrd_script "/bin/mpstat-watch" <<"EOF"
# Emulates watch command with mpstat
echo -ne "\e]2;$*\007" # Term title (tmux)
while true; do
	mpstat -I SCPU | grep -vE '^(Linux.*|)$'
	sleep 1
done
EOF
add_initrd_script "/bin/pigz-watch" <<"EOF"
# Emulate watch command using pipeview (pv) for a running pigz
echo -ne "\e]2;$*\007" # Term title (tmux)
while true; do
	pid=$(pidof -s pigz)
	[ -n "$pid" ] && pv -F "%N %b %T %t %r %a %p %I" -d $pid
	sleep 1
done
EOF
add_initrd_script "/bin/pstree-watch" <<"EOF"
echo -ne "\e]2;$*\007" # Term title (tmux)
while true; do
	watch -t "pstree"
	sleep 1
done
EOF
add_initrd_script "/bin/lsblk-watch" <<"EOF"
echo -ne "\e]2;$*\007" # Term title (tmux)
watch -t lsblk -o NAME,SIZE,MODEL,SERIAL,FSTYPE,LABEL,MOUNTPOINT
EOF
add_initrd_script "/usr/share/udhcpc/default.script" <<"EOF"
#!/bin/sh
case $1 in
	bound)
		# Configure interface and default gateway
		busybox ifconfig $interface ${mtu:+mtu $mtu} $ip netmask $subnet ${broadcast:+broadcast $broadcast}
		busybox ip -4 route add default via $router dev $interface

		# Update resolver configuration file
		[ -n "$domain" ] && R="domain $domain" || R=""
		for i in $dns; do
			R="$R\nnameserver $i"
		done
		echo -e "$R" > /etc/resolv.conf

		# Update in-kernel-memory hostname
		[ -n "$hostname" ] && hostname $hostname
	;;
	renew | deconf) echo "no action taken: $1: $interface" >&2 ;;
	leasefail | nak) echo "configuration failed: $1: $message" >&2 ;;
esac
EOF
add_initrd_script "/bin/message" <<"EOF"
# Output some center ASCII-art text, one line per argument
printf '\e]2;'"$*"'\e\\' # Term title (tmux)
CMDFIG="figlet -t -f mono12"
while [ -n "$1" ]; do
	termwidth=$(tput cols)
	textlen=$(echo $1 | $CMDFIG | head -n1 | wc -c)
	offset=$(( (termwidth-textlen)/2 ))
	echo $1 | $CMDFIG | awk "{printf \"%${offset}s\"; print}"
	shift
done
EOF

# Kernel build (with embed initramfs) #
#######################################
(
	cd "$WORKDIR/kernel"
	nproc=$(nproc --all)
	nproc=${nproc:-4}
	# This make will produce a kernel with embed initrd without modules
	make -j $((nproc+1))
	# This will complete the inird tree with modules
	INSTALL_MOD_PATH=../initrd/ make modules_install
	# XXX workaround, kernel makefile s cpio preseves everything and it is not so cool for us
	$ROOTCMD chown -R root: ../initrd
	# XXX Workaround : some kernel version forget to update embed initramfs in certain cases
	[ -f usr/initramfs_data.cpio.gz ] && rm usr/initramfs_data.cpio.gz
	$ROOTCMD chmod -R go+rX ../initrd/lib/modules
	# This produce the final image
	make
)

# Copy / run result EFI file #
##############################
# Workaround : direct kernel boot with libvirt/virt-manager do a chown on BOOTX64.EFI and cp won't overwrite
[ -f "$OUTDIR/BOOTX64.EFI" ] && rm -f "$OUTDIR/BOOTX64.EFI"
cp "$WORKDIR/kernel/arch/x86/boot/bzImage" "$OUTDIR/BOOTX64.EFI"

# Prepare an USB bootable disk if $OUTUSB is set and is has at least 1 primary partition
if [ -n "$OUTUSB" -a -b "${OUTUSB}1" ]
then	[ -d "$WORKDIR/mountpoint" ] || mkdir "$WORKDIR/mountpoint"
	mount | grep -E "^${OUTUSB}1" -q && $ROOTCMD umount "${OUTUSB}1"
	if [ "x$LEGACY" == "xy" ]
	then	$ROOTCMD install-mbr -f "${OUTUSB}"
		$ROOTCMD sfdisk --activate "$OUTUSB" 1
		sleep 1 # XXX do a proper udev wait
		$ROOTCMD mount "${OUTUSB}1" "$WORKDIR/mountpoint"
		$ROOTCMD tee "$WORKDIR/mountpoint/syslinux.cfg" > /dev/null <<"EOT"
default eficast
label eficast
 kernel /EFI/BOOT/BOOTX64.EFI
 append from=syslinux
label debug
 kernel /EFI/BOOT/BOOTX64.EFI
 append debug ignore_loglevel bootmem_debug apic=debug show_lapic=all acpi.debug_layer=0xffffffff acpi.debug_level=0xffffffff debugpat initcall_debug pnp.debug=1 sched_debug
label noacpi
 kernel /EFI/BOOT/BOOTX64.EFI
 append noacpi
timeout 10
prompt 1
EOT
	else	$ROOTCMD mount "${OUTUSB}1" "$WORKDIR/mountpoint"
	fi
	[ -d "$WORKDIR/mountpoint/BOOT/EFI" ] || $ROOTCMD mkdir -p "$WORKDIR/mountpoint/EFI/BOOT"
	$ROOTCMD cp "$OUTDIR/BOOTX64.EFI" "$WORKDIR/mountpoint/EFI/BOOT"
	$ROOTCMD umount "$WORKDIR/mountpoint"
fi

[ "x$DEVEL_MODE" == "xy" ] && qemu-system-x86_64 -M q35 -m 256 -kernel "$OUTDIR/BOOTX64.EFI" -enable-kvm -serial stdio -append "console=ttyAMA0 console=ttyS0"