From patchwork Wed Jan 6 15:57:19 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: raid5atemyhomework X-Patchwork-Id: 26247 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 4689827BC0F; Wed, 6 Jan 2021 15:58:34 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL, SPF_HELO_PASS,T_DKIM_INVALID,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 7879927BC0E for ; Wed, 6 Jan 2021 15:58:33 +0000 (GMT) Received: from localhost ([::1]:45526 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kxBCi-0003Sb-MW for patchwork@mira.cbaines.net; Wed, 06 Jan 2021 10:58:32 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:44692) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kxBCE-0003Aq-V6 for guix-patches@gnu.org; Wed, 06 Jan 2021 10:58:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:33770) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kxBCE-0007Pc-CO for guix-patches@gnu.org; Wed, 06 Jan 2021 10:58:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kxBCE-00027j-BQ for guix-patches@gnu.org; Wed, 06 Jan 2021 10:58:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#45692] [PATCH 4/4] gnu: Add ZFS service. References: In-Reply-To: Resent-From: raid5atemyhomework Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 06 Jan 2021 15:58:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 45692 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: "45692@debbugs.gnu.org" <45692@debbugs.gnu.org> Received: via spool by 45692-submit@debbugs.gnu.org id=B45692.16099486598123 (code B ref 45692); Wed, 06 Jan 2021 15:58:02 +0000 Received: (at 45692) by debbugs.gnu.org; 6 Jan 2021 15:57:39 +0000 Received: from localhost ([127.0.0.1]:45316 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kxBBr-00026v-6W for submit@debbugs.gnu.org; Wed, 06 Jan 2021 10:57:39 -0500 Received: from mail-40137.protonmail.ch ([185.70.40.137]:58035) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kxBBo-00026g-BU for 45692@debbugs.gnu.org; Wed, 06 Jan 2021 10:57:37 -0500 Date: Wed, 06 Jan 2021 15:57:19 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail; t=1609948650; bh=+sTyLZEtmpxQDhHBaG434JA++LcD2ayQQpzePuQHEZA=; h=Date:To:From:Reply-To:Subject:From; b=pDHYImwpaLjyZKWrvu29YmIeXLLBERImkycZhPKKsQY8wxoEGwFv9CZBk9gJc6W8L Wsx9OptfvpV592a2cuCo9Aoe8lTMtBvqfKFotPtY3OPXklyIqyRZjiB6fFBVWrYNDS YMk0s/18a3u7CYDmfxK/QHJODP5ZGUNj32uvhtyM= Message-ID: <6wemXB-PfHUqbuVr5-XRf0-tY4cKGGtKiUqrZPrIZYXoBw17L3xRuZrGOJQfTo5PKfFNCM8KyRTllidoc7asPE2x98BTiJSPVR7OSjxCuw8=@protonmail.com> MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" Reply-to: raid5atemyhomework , raid5atemyhomework via Guix-patches X-Patchwork-Original-From: raid5atemyhomework via Guix-patches via From: raid5atemyhomework X-getmail-retrieved-from-mailbox: Patches From deded39fe88c44a18b0b66bab8c4300aca4c387e Mon Sep 17 00:00:00 2001 From: raid5atemyhomework Date: Wed, 6 Jan 2021 09:24:20 +0800 Subject: [PATCH 4/4] gnu: Add ZFS service. * gnu/services/file-systems.scm: New file. (zfs-service-type): New variable. (zfs-configuration): New variable. (zfs-configuration?): New procedure. * gnu/local.mk: Add gnu/services/file-systems.scm. * doc/guix.texi (ZFS file system): New subsection. --- doc/guix.texi | 107 ++++++++++++++++++++++++++ gnu/local.mk | 2 + gnu/services/file-systems.scm | 136 ++++++++++++++++++++++++++++++++++ 3 files changed, 245 insertions(+) create mode 100644 gnu/services/file-systems.scm -- 2.29.2 diff --git a/doc/guix.texi b/doc/guix.texi index 78770151e3..62437083cb 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -13885,6 +13885,113 @@ a file system declaration such as: compress-force=zstd,space_cache=v2")) @end lisp +@node ZFS file system +@subsection ZFS file system + +The ZFS file system has a license incompatible with the Linux kernel, +and thus cannot be distributed with the kernel. However, as a user +you have the right to do whatever you want on your own hardware, +including download the ZFS source code, compile it, link it to your +own private copy of Linux, and run it. You can even use the Guix build +system to automate this. + +As a large and complex kernel module, ZFS on Linux has to be compiled +with a specific version of the kernel. Often even the latest ZFS +package available cannot be compiled with the latest Linux kernel +package provided by Guix System. Thus, installing the @code{zfs} +package is likely to fail. + +Instead, you have to use an older long-term-support Linux kernel. +Do not use @code{linux-libre-lts} as the latest long-term-support +kernel might be too new for the ZFS package; instead, explicitly +select the version number, like @code{linux-libre-5.4}. + +Then, you have to modify your system configuration file and use the +selected older kernel, and add the @code{zfs-service-type} service. + +@lisp +(use-modules (gnu)) +(use-package-modules + ; @dots{} + linux) +(use-service-modules + ; @dots{} + file-systems) + +(define my-kernel linux-libre-5.4) + +(operating-system + (kernel my-kernel) + ;; @dots{} + (services + (cons* (service zfs-service-type + (zfs-configuration + (kernel my-kernel))) + ; @dots{} + %desktop-services)) + ;; @dots{} + ) +@end lisp + +@defvr {Scheme Variable} zfs-service-type +This is the type of the service to compile and install OpenZFS to +your operating system. It loads the ZFS module at startup, imports +pools, mounts automounted ZFS datasets, installs the ZFS command +line tools, and can provide module options for the ZFS module. Its +value must be a @code{zfs-configuration} record (see below). + +Here is an example use: + +@lisp +(service zfs-service-type + (zfs-configuration + (kernel linux-libre-5.4) + (options '("zfs_arc_max=5000000000")))) +@end lisp +@end defvr + +@deftp {Data Type} zfs-configuration +This data type represents the configuration of the ZFS service. +The available fields are: + +@table @asis +@item @code{kernel} +The package of the Linux kernel to compile ZFS for. Required. + +@item @code{base-zfs} (default: @code{zfs}) +The ZFS package to use. It will be modified to use the indicated +kernel. + +@item @code{options} (default: @code{'()}) +A list of string options to pass as options to the ZFS module. +These will be put in a @file{/etc/modprobe.d/zfs.conf} file, +for example setting this to @code{'("zfs_admin_snapshot=1" +"zfs_trim_extent_bytes_min=0")} will create the following file: + +@example +options zfs zfs_admin_snapshot=1 zfs_trim_extent_bytes_min=0 +@end example +@end table +@end deftp + +Once your system has been configured to include the ZFS service +and you have restarted the system, you can manage ZFS pools and +datasets with @code{zpool} and @code{zfs} commands. + +ZFS datasets with an appropriate @code{mountpoint} property will +be automounted at startup after the root file system is started. +Encrypted datasets that are automounted will cause boot to pause +and prompt for the password to be provided on the console. + +It's possible to have a ZFS dataset as your @code{/home} by simply +setting the @code{mountpoint} property. However, note that ZFS will +refuse to mount over a non-empty directory, so if your root +filesystem already has a non-empty @code{/home}, you should remove +it and its contents, then restart the system. + +Having ZFS as a root filesystem or as @code{/boot} is not supported +yet. + @node Mapped Devices @section Mapped Devices diff --git a/gnu/local.mk b/gnu/local.mk index 53a67e6ffe..49073ac2ac 100644 --- a/gnu/local.mk +++ b/gnu/local.mk @@ -39,6 +39,7 @@ # Copyright © 2020 Martin Becze # Copyright © 2020 Malte Frank Gerdes # Copyright © 2020 Vinicius Monego +# Copyright © 2021 raid5atemyhomework # # This file is part of GNU Guix. # @@ -601,6 +602,7 @@ GNU_SYSTEM_MODULES = \ %D%/services/dict.scm \ %D%/services/dns.scm \ %D%/services/docker.scm \ + %D%/services/file-systems.scm \ %D%/services/authentication.scm \ %D%/services/games.scm \ %D%/services/ganeti.scm \ diff --git a/gnu/services/file-systems.scm b/gnu/services/file-systems.scm new file mode 100644 index 0000000000..7a92a2b9d5 --- /dev/null +++ b/gnu/services/file-systems.scm @@ -0,0 +1,136 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2021 raid5atemyhomework +;;; +;;; 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 . + +(define-module (gnu services file-systems) + #:use-module (gnu packages file-systems) + #:use-module (gnu services) + #:use-module (gnu services base) + #:use-module (gnu services shepherd) + #:use-module (guix gexp) + #:use-module (guix packages) + #:use-module (guix records) + #:export (zfs-service-type + zfs-configuration + zfs-configuration?)) + +(define-record-type* + zfs-configuration make-zfs-configuration zfs-configuration? + ; kernel you want to compile the base-zfs module for. + (kernel zfs-configuration-kernel) + ; base package that will be compiled for the kernel + (base-zfs zfs-configuration-base-zfs (default zfs)) + ; list of string options. + (options zfs-configuration-options (default '()))) + +(define (make-zfs-package conf) + (let ((base-zfs (zfs-configuration-base-zfs conf)) + (kernel (zfs-configuration-kernel conf))) + (package + (inherit base-zfs) + (name (string-join (list (package-name base-zfs) + "for" + (package-name kernel) + (package-version kernel) + "version") + "-")) + (arguments (cons* #:linux kernel (package-arguments base-zfs)))))) + +(define (zfs-loadable-module conf) + (list (list (make-zfs-package conf) "module"))) + +(define (zfs-shepherd-services conf) + (let* ((zfs-package (make-zfs-package conf)) + (zpool (file-append zfs-package "/sbin/zpool"))) + (list + (shepherd-service + (documentation "Scans for ZFS pools and automounts filesystems.") + (provision '(zfs-scan-automount)) + (requirement '(root-file-system)) + (modules `((srfi srfi-1) + (srfi srfi-34) + (srfi srfi-35) + (rnrs io ports) + ,@%default-modules)) + (start #~(lambda _ + (and + ;; You'd think we could've used kernel-module-loader-service-type, + ;; but the kernel-module-loader shepherd service is dependent on + ;; file-systems, and file-systems is made dependent on this + ;; service. And we need the kernel module to be loaded before we + ;; scan for ZFS pools. So break the dependency loop by just + ;; loading ZFS module here by ourselves. + (or (file-exists? "/proc/sys/kernel/modprobe") + (begin + (format (current-error-port) "error loading 'zfs' module: ~a~%" + "Kernel is missing loadable module support.") + #f)) + (guard (c ((message-condition? c) + (format (current-error-port) + "error loading 'zfs' module: ~a~%" + (condition-message c)) + #f)) + (let ((modprobe (call-with-input-file "/proc/sys/kernel/modprobe" + get-line))) + (invoke/quiet modprobe "--" "zfs"))) + + ; scan for pools and automount contained datasets. + (guard (c ((message-condition? c) + (format (current-error-port) + "error importing zpools: ~a~%" + (condition-message?)) + #f)) + ;; (current-output-port) is typically connected to /dev/klog, + ;; so redirect it to (current-error-port) so that user can see + ;; prompts for passphrases on console + (with-output-to-port (current-error-port) + (lambda () + (invoke #$zpool "import" "-a" "-l"))))))) + (stop #~(const #t)))))) + +(define (zfs-profile-service conf) + (list (make-zfs-package conf))) + +(define (zfs-etc-service conf) + (let ((options (zfs-configuration-options conf))) + (if (null? options) + '() + `(("modprobe.d/zfs.conf" + ,(plain-file "zfs.conf" + (string-join (cons "options zfs" options) " "))))))) + +(define zfs-service-type + (service-type (name 'zfs) + (extensions + (list + ; install the kernel module + (service-extension kernel-loadable-module-service-type + zfs-loadable-module) + ; load ZFS module, scan ZFS pools, and automount filesystems + (service-extension shepherd-root-service-type + zfs-shepherd-services) + ; make sure automount occurs before file-systems target is reached + (service-extension file-systems-target-service-type + (const '(zfs-scan-automount))) + ; install ZFS management tools + (service-extension profile-service-type + zfs-profile-service) + ; install ZFS module options + (service-extension etc-service-type + zfs-etc-service))) + (description + "Install ZFS, an advanced filesystem and volume manager.")))