;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu build bootloader)
  #:use-module (guix build utils)
  #:use-module (guix utils)
  #:use-module (ice-9 binary-ports)
  #:use-module (ice-9 format)
  #:export (write-file-on-device
            install-efi-loader))


;;;
;;; Writing utils.
;;;

(define (write-file-on-device file size device offset)
  "Write SIZE bytes from FILE to DEVICE starting at OFFSET."
  (call-with-input-file file
    (lambda (input)
      (let ((bv (get-bytevector-n input size)))
        (call-with-output-file device
          (lambda (output)
            (seek output offset SEEK_SET)
            (put-bytevector output bv))
          #:binary #t)))))


;;;
;;; EFI bootloader.
;;;

(define (install-efi grub grub-config esp)
  "Write a self-contained GRUB EFI loader to the mounted ESP using GRUB-CONFIG."
  (let* ((system %host-type)
         ;; Hard code the output location to a well-known path recognized by
         ;; compliant firmware. See "3.5.1.1 Removable Media Boot Behaviour":
         ;; http://www.uefi.org/sites/default/files/resources/UEFI%20Spec%202_6.pdf
         (grub-mkstandalone (string-append grub "/bin/grub-mkstandalone"))
         (efi-directory (string-append esp "/EFI/BOOT"))
         ;; Map grub target names to boot file names.
         (efi-targets (cond ((string-prefix? "x86_64" system)
                             '("x86_64-efi" . "BOOTX64.EFI"))
                            ((string-prefix? "i686" system)
                             '("i386-efi" . "BOOTIA32.EFI"))
                            ((string-prefix? "armhf" system)
                             '("arm-efi" . "BOOTARM.EFI"))
                            ((string-prefix? "aarch64" system)
                             '("arm64-efi" . "BOOTAA64.EFI")))))
    ;; grub-mkstandalone requires a TMPDIR to prepare the firmware image.
    (setenv "TMPDIR" esp)

    (mkdir-p efi-directory)
    (invoke grub-mkstandalone "-O" (car efi-targets)
            "-o" (string-append efi-directory "/"
                                (cdr efi-targets))
            ;; Graft the configuration file onto the image.
            (string-append "boot/grub/grub.cfg=" grub-config))))

(define (install-efi-loader grub-efi esp)
  "Install in ESP directory the given GRUB-EFI bootloader.  Configure it to
load the Grub bootloader located in the 'Guix_image' root partition."
  (let ((grub-config "grub.cfg"))
    (call-with-output-file grub-config
      (lambda (port)
        ;; Create a tiny configuration file telling the embedded grub where to
        ;; load the real thing.  XXX This is quite fragile, and can prevent
        ;; the image from booting when there's more than one volume with this
        ;; label present.  Reproducible almost-UUIDs could reduce the risk
        ;; (not eliminate it).
        (format port
                "insmod part_msdos~@
               search --set=root --label Guix_image~@
               configfile /boot/grub/grub.cfg~%")))
    (install-efi grub-efi grub-config esp)
    (delete-file grub-config)))
edde3de550e692440'>services: Introduce extensible services.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-08-30 19:20:12 +0200'>2015-08-30</span></td><td><a href='/guix/commit/.gitignore?id=bd6163d13f6445b9a1ec0f85e4a19b9f73ab74ea'>build: Produce 'guix-config' instead of using compile-time tricks.</a><span class='msg-avail'>...</span></td><td>Mathieu Lirzin</td></tr>
<tr><td><span title='2015-08-27 00:49:23 +0200'>2015-08-27</span></td><td><a href='/guix/commit/.gitignore?id=888569161c0cb55a2700806aded7128cfe605857'>Add 'guix graph'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-07-15 23:57:01 +0200'>2015-07-15</span></td><td><a href='/guix/commit/.gitignore?id=d2825c96141c7b6844d9e04f982919c0509165e1'>Add 'guix-daemon.service' file for systemd.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-07-07 20:01:35 +0200'>2015-07-07</span></td><td><a href='/guix/commit/.gitignore?id=7eff42432b2ae3a030bfd0bf8d572b771f8d8a2b'>Prevent Git from silently ignoring new files.</a><span class='msg-avail'>...</span></td><td>Mathieu Lirzin</td></tr>
<tr><td><span title='2015-06-02 20:58:37 -0400'>2015-06-02</span></td><td><a href='/guix/commit/.gitignore?id=a26d3ba357d286727df899b3df4442901c866e36'>Ignore man page build artifacts.</a></td><td>David Thompson</td></tr>
<tr><td><span title='2015-05-25 22:56:57 +0200'>2015-05-25</span></td><td><a href='/guix/commit/.gitignore?id=6dc67c02f7083ad739935139aabaa94a442c2706'>Augment '.gitignore'.</a></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-05-09 23:53:36 +0200'>2015-05-09</span></td><td><a href='/guix/commit/.gitignore?id=dd51caac55f052cecc61c7b8ab16654e3ace569f'>doc: Show both the "bare-bones" and the "desktop" configurations.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-03-25 10:46:22 +0100'>2015-03-25</span></td><td><a href='/guix/commit/.gitignore?id=2c74fde00e4e721c6a73646935ab0cfe19dd9188'>Rename 'guix substitute-binary' to 'guix substitute'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-01-07 21:47:51 -0500'>2015-01-07</span></td><td><a href='/guix/commit/.gitignore?id=aa1e19477b2d78884fc500fef497cd6677604d9b'>gnu: Add bootstrap binaries for 'armhf-linux'.</a><span class='msg-avail'>...</span></td><td>Mark H Weaver</td></tr>
<tr><td><span title='2014-12-02 22:09:22 +0300'>2014-12-02</span></td><td><a href='/guix/commit/.gitignore?id=3db349cb09844e2770be3d0dee4e990f1228c2b6'>emacs: Move profiles code to "guix-profiles.el.in".</a><span class='msg-avail'>...</span></td><td>Alex Kost</td></tr>
<tr><td><span title='2014-09-03 23:50:35 +0400'>2014-09-03</span></td><td><a href='/guix/commit/.gitignore?id=457f60fa068c7becf60841daa2b6fc5121aedead'>Add Emacs user interface.</a><span class='msg-avail'>...</span></td><td>Alex Kost</td></tr>
<tr><td><span title='2014-06-13 17:30:40 +0200'>2014-06-13</span></td><td><a href='/guix/commit/.gitignore?id=ee76417972b3a749a28a627c2858c09311d9c0c5'>Separate package description translations from string translations.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2014-06-13 16:31:18 +0200'>2014-06-13</span></td><td><a href='/guix/commit/.gitignore?id=ef1a9bb7d6fd64f05607042fdb266ee974d16e26'>Move gettext files to 'po/guix'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>