mkarchiso 17.3 KB
Newer Older
1
#!/bin/bash
2

3
4
5
6
7
set -e -u

app_name=${0##*/}
arch=$(uname -m)
pkg_list=""
8
run_cmd=""
9
10
11
12
13
14
quiet="y"
pacman_conf="/etc/pacman.conf"
export iso_label="ARCH_$(date +%Y%m)"
iso_publisher="Arch Linux <http://www.archlinux.org>"
iso_application="Arch Linux Live/Rescue CD"
install_dir="arch"
15
16
work_dir="work"
out_dir="out"
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

# Show an INFO message
# $1: message string
_msg_info() {
    local _msg="${1}"
    echo "[mkarchiso] INFO: ${_msg}"
}

# Show an ERROR message then exit with status
# $1: message string
# $2: exit code number (with 0 does not exit)
_msg_error() {
    local _msg="${1}"
    local _error=${2}
    echo
    echo "[mkarchiso] ERROR: ${_msg}"
    echo
    if [[ ${_error} -gt 0 ]]; then
        exit ${_error}
    fi
}

# Show space usage similar to df, but better formatted.
# $1: mount-point or mounted device.
_show_space_usage () {
    local _where="${1}"
    local _fs _total _used _avail _pct_u=0 _mnt
    read _fs _total _used _avail _pct_u _mnt < <(df -m "${_where}" | tail -1) &> /dev/null
    _msg_info "Total: ${_total} MiB (100%) | Used: ${_used} MiB (${_pct_u}) | Avail: ${_avail} MiB ($((100 - ${_pct_u%\%}))%)"
}

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
_chroot_mount () {
    mount -t devtmpfs dev "${work_dir}/root-image/dev"
    mount -t devpts devpts "${work_dir}/root-image/dev/pts"
    mount -t tmpfs devshm "${work_dir}/root-image/dev/shm"
    mount -t proc proc "${work_dir}/root-image/proc"
    mount -t tmpfs run "${work_dir}/root-image/run"
    mount -t sysfs sys "${work_dir}/root-image/sys"
    mount -t tmpfs tmp "${work_dir}/root-image/tmp"

    trap '_chroot_umount' EXIT HUP INT TERM
}

_chroot_umount () {
    umount "${work_dir}/root-image/tmp"
    umount "${work_dir}/root-image/sys"
    umount "${work_dir}/root-image/run"
    umount "${work_dir}/root-image/proc"
    umount "${work_dir}/root-image/dev/shm"
    umount "${work_dir}/root-image/dev/pts"
    umount "${work_dir}/root-image/dev"

    trap - EXIT HUP INT TERM
}

_chroot_init() {
    if [[ ! -d ${work_dir}/root-image/var/cache/pacman ]]; then
        mkdir -p ${work_dir}/root-image/{dev,proc,run,sys,tmp,var/lib/pacman}
        _pacman "base"
        _pacman "syslinux"
    fi
}

_chroot_run() {
    _chroot_mount
    eval chroot ${work_dir}/root-image "${run_cmd}"
    _chroot_umount
}

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
# Mount a filesystem (trap signals in case of error for unmounting it
# $1: source image
# $2: mount-point
_mount_fs() {
    local _src="${1}"
    local _dst="${2}"
    trap "_umount_fs ${_src}" EXIT HUP INT TERM
    mkdir -p "${_dst}"
    _msg_info "Mounting '${_src}' on '${_dst}'"
    mount "${_src}" "${_dst}"
    _show_space_usage "${_dst}"
}

# Unmount a filesystem (and untrap signals)
# $1: mount-point or device/image
_umount_fs() {
    local _dst="${1}"
    _show_space_usage "${_dst}"
    _msg_info "Unmounting '${_dst}'"
    umount "${_dst}"
    rmdir "${_dst}"
    trap - EXIT HUP INT TERM
}

# Compare if a file/directory (source) is newer than other file (target)
# $1: source file/directory
# $2: target file
# return: 0 if target does not exists or if target is older than source.
#         1 if target is newer than source
_is_directory_changed() {
    local _src="${1}"
    local _dst="${2}"

    if [ -e "${_dst}" ]; then
        if [[ $(find ${_src} -newer ${_dst} | wc -l) -gt 0 ]]; then
            _msg_info "Target '${_dst}' is older than '${_src}', updating."
            rm -f "${_dst}"
            return 0
        else
            _msg_info "Target '${_dst}' is up to date with '${_src}', skipping."
            return 1
        fi
    else
        _msg_info "Target '${_dst}' does not exist, making it from '${_src}'"
        return 0
    fi
}

# Show help usage, with an exit status.
# $1: exit status number.
_usage ()
137
{
138
    echo "usage ${app_name} [options] command <command options>"
139
    echo " general options:"
140
    echo "    -p PACKAGE(S)    Package(s) to install, can be used multiple times"
141
    echo "    -r <command>     Run <command> inside root-image"
142
143
    echo "    -C <file>        Config file for pacman."
    echo "                     Default: '${pacman_conf}'"
144
    echo "    -L <label>       Set a label for the disk"
145
    echo "                     Default: '${iso_label}'"
146
    echo "    -P <publisher>   Set a publisher for the disk"
147
    echo "                     Default: '${iso_publisher}'"
148
    echo "    -A <application> Set an application name for the disk"
149
    echo "                     Default: '${iso_application}'"
150
    echo "    -D <install_dir> Set an install_dir. All files will by located here."
151
    echo "                     Default: '${install_dir}'"
152
    echo "                     NOTE: Max 8 characters, use only [a-z0-9]"
153
    echo "    -w <work_dir>    Set the working directory"
154
    echo "                     Default: '${work_dir}'"
155
    echo "    -o <out_dir>     Set the output directory"
156
    echo "                     Default: '${out_dir}'"
157
158
    echo "    -v               Enable verbose output"
    echo "    -h               This message"
159
    echo " commands:"
160
161
162
163
164
165
    echo "   init"
    echo "      Make base layout and install base group"
    echo "   install"
    echo "      Install all specified packages (-p)"
    echo "   run"
    echo "      run command specified by -r"
166
    echo "   prepare"
167
    echo "      build all images"
168
    echo "   checksum"
169
    echo "      make a checksum.md5 for self-test"
170
    echo "   iso <image name>"
171
    echo "      build an iso image from the working dir"
172
    exit ${1}
173
174
}

175
# Shows configuration according to command mode.
176
# $1: init | install | run | prepare | checksum | iso
177
178
179
180
181
182
183
184
185
_show_config () {
    local _mode="$1"
    echo
    _msg_info "Configuration settings"
    _msg_info "                  Command:   ${command_name}"
    _msg_info "             Architecture:   ${arch}"
    _msg_info "        Working directory:   ${work_dir}"
    _msg_info "   Installation directory:   ${install_dir}"
    case "${_mode}" in
186
187
188
189
        init)
            _msg_info "       Pacman config file:   ${pacman_conf}"
            ;;
        install)
190
191
192
            _msg_info "       Pacman config file:   ${pacman_conf}"
            _msg_info "                 Packages:   ${pkg_list}"
            ;;
193
194
195
        run)
            _msg_info "              Run command:   ${run_cmd}"
            ;;
196
197
        prepare)
            ;;
198
199
        checksum)
            ;;
200
201
202
203
204
205
        iso)
            _msg_info "               Image name:   ${img_name}"
            _msg_info "               Disk label:   ${iso_label}"
            _msg_info "           Disk publisher:   ${iso_publisher}"
            _msg_info "         Disk application:   ${iso_application}"
            ;;
206
    esac
207
208
    echo
}
209

210
# Install desired packages to root-image
211
212
_pacman ()
{
213
    _msg_info "Installing packages to '${work_dir}/root-image/'..."
214

215
216
    _chroot_mount

217
    if [[ "${quiet}" = "y" ]]; then
218
        pacman -Sy -r "${work_dir}/root-image" --config "${pacman_conf}" --needed --noconfirm $* &> /dev/null
219
    else
220
        pacman -Sy -r "${work_dir}/root-image" --config "${pacman_conf}" --needed --noconfirm $*
221
    fi
222

223
224
    _chroot_umount

225
    _msg_info "Packages installed successfully!"
226
227
}

228
229
230
# Cleanup root-image
_cleanup () {
    _msg_info "Cleaning up what we can on root-image"
231

232
233
234
235
236
237
    # remove the initcpio images that were generated for the host system
    if [[ -d "${work_dir}/root-image/boot" ]]; then 
        find "${work_dir}/root-image/boot" -name '*.img' -delete
    fi
    # Delete pacman database sync cache files (*.tar.gz)
    if [[ -d "${work_dir}/root-image/var/lib/pacman" ]]; then
238
        find "${work_dir}/root-image/var/lib/pacman" -maxdepth 1 -type f -delete
239
240
241
    fi
    # Delete pacman database sync cache
    if [[ -d "${work_dir}/root-image/var/lib/pacman/sync" ]]; then
242
        find "${work_dir}/root-image/var/lib/pacman/sync" -delete
243
244
245
    fi
    # Delete pacman package cache
    if [[ -d "${work_dir}/root-image/var/cache/pacman/pkg" ]]; then
246
        find "${work_dir}/root-image/var/cache/pacman/pkg" -type f -delete
247
248
249
    fi
    # Delete all log files, keeps empty dirs.
    if [[ -d "${work_dir}/root-image/var/log" ]]; then
250
        find "${work_dir}/root-image/var/log" -type f -delete
251
252
253
    fi
    # Delete all temporary files and dirs
    if [[ -d "${work_dir}/root-image/var/tmp" ]]; then
254
        find "${work_dir}/root-image/var/tmp" -mindepth 1 -delete
255
256
257
    fi
    # Delete all temporary files and dirs
    if [[ -d "${work_dir}/root-image/tmp" ]]; then
258
        find "${work_dir}/root-image/tmp" -mindepth 1 -delete
259
    fi
260
261
    # Delete package pacman related files.
    find "${work_dir}" -name "*.pacnew" -name "*.pacsave" -name "*.pacorig" -delete
262
    # Create etc/mtab if not is a symlink.
263
    if [[ ! -L "${work_dir}/root-image/etc/mtab" ]]; then
264
        ln -sf "/proc/self/mounts" "${work_dir}/root-image/etc/mtab"
265
    fi
266
}
267

268
269
270
271
272
273
# Makes a SquashFS filesystem image of file/directory passes as argument with desired compression.
# $1: Source file/directory
# $2: SquashFS compression type (gzip | lzo | xz)
_mksfs () {
    local _src="${1}"
    local _sfs_comp="${2}"
274

275
276
    if [[ ! -e "${work_dir}/${_src}" ]]; then
        _msg_error "The path '${work_dir}/${_src}' does not exist" 1
277
278
    fi

279
280
281
282
283
    local _sfs_img="${work_dir}/${_src}.sfs"

    _msg_info "Creating SquashFS image for '${work_dir}/${_src}', This may take some time..."
    local _seconds=${SECONDS}
    if [[ "${quiet}" = "y" ]]; then
284
        mksquashfs "${work_dir}/${_src}" "${_sfs_img}" -noappend -comp "${_sfs_comp}" -no-progress &> /dev/null
285
    else
286
        mksquashfs "${work_dir}/${_src}" "${_sfs_img}" -noappend -comp "${_sfs_comp}" -no-progress
287
    fi
288
289
    _seconds=$((SECONDS - _seconds))
    printf "[mkarchiso] INFO: Image creation done in %02d:%02d minutes\n" $((_seconds / 60)) $((_seconds % 60))
290
}
291

292
293
294
295
296
297
298
299
# Makes a filesystem from a source directory.
# $1: Source directory
# $2: Target filesystem type (ext4 | ext3 | ext2 | xfs)
# $3: Size of target filesystem. Can be an absolute value in MiB, or relative value of desired free space (1% - 99%)
_mkfs () {
    local _src="${1}"
    local _fs_type="${2}"
    local _fs_size="${3}"
300

301
302
    local _fs_src="${work_dir}/${_src}"
    local _fs_img="${work_dir}/${_src}.fs"
303

304
305
    if [[ ! -e "${_fs_src}" ]]; then
        _msg_error "The path '${_fs_src}' does not exist" 1
306
307
    fi

308
309
    local _spc_used
    _spc_used=$(du -sxm "${_fs_src}" | awk '{print $1}')
310

311
312
313
314
315
316
317
318
319
320
    # Caculate FS size with desired % of free space, adds 10% overhead to used space.
    if [[ ${_fs_size} != ${_fs_size%\%} ]]; then
        if [[ ${_fs_size%\%} -le 0 || ${_fs_size%\%} -ge 100 ]]; then
            _msg_error "Invalid percentage of free space specified '${_fs_size}' on '${_src}', should be 0% < x < 100%" 1
        fi
        _fs_size=$((_spc_used * 110 / (100 - ${_fs_size%\%})))
    else
        local _spc_used_over=$((_spc_used * 11 / 10))
        if [[ ${_fs_size} -lt ${_spc_used_over} ]]; then
            _msg_error "Filesystem size specified '${_fs_size}' MiB for '${_src}' is too small, must be at least '${_spc_used_over}' MiB" 1
321
322
323
        fi
    fi

324
    _msg_info "Creating ${_fs_type} image of ${_fs_size} MiB"
325
    rm -f "${_fs_img}"
326
327
328
329
    dd of="${_fs_img}" count=0 bs=1M seek=${_fs_size} &> /dev/null
    local _qflag=""
    if [[ ${quiet} == "y" ]]; then
        _qflag="-q"
330
    fi
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
    case "${_fs_type}" in
        ext4)
            mkfs.ext4 ${_qflag} -O ^has_journal -m 0 -F "${_fs_img}"
            tune2fs -c 0 -i 0 "${_fs_img}" &> /dev/null
            ;;
        ext3)
            mkfs.ext3 ${_qflag} -m 0 -F "${_fs_img}"
            tune2fs -c 0 -i 0 "${_fs_img}" &> /dev/null
            ;;
        ext2)
            mkfs.ext2 ${_qflag} -m 0 -F "${_fs_img}"
            tune2fs -c 0 -i 0 "${_fs_img}" &> /dev/null
            ;;
        xfs)
            mkfs.xfs ${_qflag} "${_fs_img}"
            ;;
        *)
            _msg_error "Invalid filesystem: ${_fs_type}" 1
            ;;
    esac
    _mount_fs "${_fs_img}" "${work_dir}/mnt/${_src}"
    _msg_info "Copying '${_fs_src}/' to '${work_dir}/mnt/${_src}/'"
    rsync -aH "${_fs_src}/" "${work_dir}/mnt/${_src}/"
    _umount_fs "${work_dir}/mnt/${_src}"
355
356
}

357
358
359
command_checksum () {
    _show_config checksum

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
    local _chk_arch

    for _chk_arch in i686 x86_64; do
        if _is_directory_changed "${work_dir}/iso/${install_dir}" "${work_dir}/iso/${install_dir}/checksum.${_chk_arch}.md5"; then
            _msg_info "Creating checksum file for self-test (${_chk_arch})"
            cd "${work_dir}/iso/${install_dir}"
            if [[ -d "${_chk_arch}" ]]; then
                md5sum aitab > checksum.${_chk_arch}.md5
                find ${_chk_arch} -type f -print0 | xargs -0 md5sum >> checksum.${_chk_arch}.md5
                if [[ -d "any" ]]; then
                    find any -type f -print0 | xargs -0 md5sum >> checksum.${_chk_arch}.md5
                fi
            fi
            cd ${OLDPWD}
            _msg_info "Done!"
        fi
    done
377
378
}

379
# Create an ISO9660 filesystem from "iso" directory.
380
command_iso () {
381
382
383
    if [[ ! -f "${work_dir}/iso/isolinux/isolinux.bin" ]]; then
         _msg_error "The file '${work_dir}/iso/isolinux/isolinux.bin' does not exist." 1
    fi
384
385
386
    if [[ ! -f "${work_dir}/iso/isolinux/isohdpfx.bin" ]]; then
         _msg_error "The file '${work_dir}/iso/isolinux/isohdpfx.bin' does not exist." 1
    fi
387
388
389

    _show_config iso

390
391
    if _is_directory_changed "${work_dir}/iso" "${out_dir}/${img_name}"; then
        mkdir -p ${out_dir}
392
393
394
395
396
        _msg_info "Creating ISO image..."
        local _qflag=""
        if [[ ${quiet} == "y" ]]; then
            _qflag="-quiet"
        fi
397
        xorriso -as mkisofs ${_qflag} -r -l \
398
            -b isolinux/isolinux.bin -c isolinux/boot.cat \
399
            -iso-level 3 \
400
            -no-emul-boot -boot-load-size 4 -boot-info-table \
401
402
            -isohybrid-mbr ${work_dir}/iso/isolinux/isohdpfx.bin \
            -p "prepared by mkarchiso" \
403
404
405
            -publisher "${iso_publisher}" \
            -A "${iso_application}" \
            -V "${iso_label}" \
406
407
            -o "${out_dir}/${img_name}" "${work_dir}/iso/"
        _msg_info "Done! | $(ls -sh ${out_dir}/${img_name})"
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
    fi
}

# Parse aitab and create each filesystem specified on that, and push it in "iso" directory.
command_prepare () {
    if [[ ! -f "${work_dir}/iso/${install_dir}/aitab" ]]; then
         _msg_error "The file '${work_dir}/iso/${install_dir}/aitab' does not exist." 1
    fi
    _show_config prepare

    _cleanup
    local _aitab_img _aitab_mnt _aitab_arch _aitab_sfs_comp _aitab_fs_type _aitab_fs_size
    while read _aitab_img _aitab_mnt _aitab_arch _aitab_sfs_comp _aitab_fs_type _aitab_fs_size ; do
        if [[ ${_aitab_img} =~ ^# ]]; then
            continue
        fi
        local _src="${work_dir}/${_aitab_img}"
        local _dst="${work_dir}/iso/${install_dir}/${_aitab_arch}"
        mkdir -p "${_dst}"
        if [[ ${_aitab_fs_type} != "none" ]]; then
428
429
430
431
432
            if _is_directory_changed "${_src}" "${_dst}/${_aitab_img}.fs.sfs"; then
                _mkfs ${_aitab_img} ${_aitab_fs_type} ${_aitab_fs_size}
                _mksfs ${_aitab_img}.fs ${_aitab_sfs_comp}
                mv "${_src}.fs.sfs" "${_dst}"
                rm "${_src}.fs"
433
434
435
436
437
438
439
440
441
442
443
444
            fi
        else
            if _is_directory_changed "${_src}" "${_dst}/${_aitab_img}.sfs"; then
                _mksfs ${_aitab_img} ${_aitab_sfs_comp}
                mv "${work_dir}/${_aitab_img}.sfs" "${_dst}"
            fi
        fi
    done < "${work_dir}/iso/${install_dir}/aitab"
}

# Install packages on root-image.
# A basic check to avoid double execution/reinstallation is done via hashing package names.
445
command_install () {
446
447
448
449
450
451
452
453
454
455
456
457
    if [[ ! -f "${pacman_conf}" ]]; then
        _msg_error "Pacman config file '${pacman_conf}' does not exist" 1
    fi

    #trim spaces
    pkg_list="$(echo ${pkg_list})"

    if [[ -z ${pkg_list} ]]; then
        _msg_error "Packages must be specified" 0
        _usage 1
    fi

458
    _show_config install
459
460
461

    local _pkg_list_hash
    _pkg_list_hash=$(echo ${pkg_list} | sort -u | md5sum | cut -c1-32)
462
    if [[ -f "${work_dir}/install.${_pkg_list_hash}" ]]; then
463
464
465
        _msg_info "These packages are already installed, skipping."
    else
        _pacman "${pkg_list}"
466
        : > "${work_dir}/install.${_pkg_list_hash}"
467
    fi
468
469
}

470
471
472
473
474
475
476
477
478
command_init() {
    _show_config init
    _chroot_init
}

command_run() {
    _show_config run
    _chroot_run
}
479
480
481
482
483

if [[ ${EUID} -ne 0 ]]; then
    _msg_error "This script must be run as root." 1
fi

484
while getopts 'p:r:C:L:P:A:D:w:o:vh' arg; do
485
486
    case "${arg}" in
        p) pkg_list="${pkg_list} ${OPTARG}" ;;
487
        r) run_cmd="${OPTARG}" ;;
488
489
490
491
492
        C) pacman_conf="${OPTARG}" ;;
        L) iso_label="${OPTARG}" ;;
        P) iso_publisher="${OPTARG}" ;;
        A) iso_application="${OPTARG}" ;;
        D) install_dir="${OPTARG}" ;;
493
494
        w) work_dir="${OPTARG}" ;;
        o) out_dir="${OPTARG}" ;;
495
496
497
498
499
500
501
502
503
504
505
506
507
508
        v) quiet="n" ;;
        h|?) _usage 0 ;;
        *)
            _msg_error "Invalid argument '${arg}'" 0
            _usage 1
            ;;
    esac
done

shift $((OPTIND - 1))

if [[ $# -lt 1 ]]; then
    _msg_error "No command specified" 0
    _usage 1
509
fi
510
511
512
command_name="${1}"

case "${command_name}" in
513
514
515
516
517
518
519
520
    init)
        command_init
        ;;
    install)
        command_install
        ;;
    run)
        command_run
521
522
523
524
        ;;
    prepare)
        command_prepare
        ;;
525
526
527
    checksum)
        command_checksum
        ;;
528
    iso)
529
        if [[ $# -lt 2 ]]; then
530
531
532
            _msg_error "No image specified" 0
            _usage 1
        fi
533
        img_name="${2}"
534
535
536
537
538
539
540
        command_iso
        ;;
    *)
        _msg_error "Invalid command name '${command_name}'" 0
        _usage 1
        ;;
esac
541
542

# vim:ts=4:sw=4:et: