aboutsummaryrefslogtreecommitdiff
path: root/gnu/services/mcron.scm
blob: 1b232b6cba6765e9c5d2de64d1f2940ae2b2a73e (about) (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
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2016, 2017, 2018, 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 services mcron)
  #:use-module (gnu services)
  #:use-module (gnu services base)
  #:use-module (gnu services shepherd)
  #:autoload   (gnu packages guile-xyz) (mcron)
  #:use-module (guix deprecation)
  #:use-module (guix records)
  #:use-module (guix gexp)
  #:use-module (srfi srfi-1)
  #:use-module (ice-9 match)
  #:use-module (ice-9 vlist)
  #:export (mcron-configuration
            mcron-configuration?
            mcron-configuration-mcron
            mcron-configuration-jobs

            mcron-service-type
            mcron-service))

;;; Commentary:
;;;
;;; This module implements a service that to run instances of GNU mcron, a
;;; periodic job execution daemon.  Example of a service:
;;
;;  (service mcron-service-type
;;           (mcron-configuration
;;            (jobs (list #~(job next-second-from
;;                               (lambda ()
;;                                 (call-with-output-file "/dev/console"
;;                                   (lambda (port)
;;                                     (display "hello!\n" port)))))))))
;;;
;;; Code:

(define-record-type* <mcron-configuration> mcron-configuration
  make-mcron-configuration
  mcron-configuration?
  (mcron             mcron-configuration-mcron    ;package
                     (default mcron))
  (jobs              mcron-configuration-jobs     ;list of <mcron-job>
                     (default '())))

(define (job-file job)
  (scheme-file "mcron-job" job))

(define (shepherd-schedule-action mcron files)
  "Return a Shepherd action that runs MCRON with '--schedule' for the given
files."
  (shepherd-action
   (name 'schedule)
   (documentation
    "Display jobs that are going to be scheduled.")
   (procedure
    #~(lambda* (_ #:optional (n "5"))
        ;; XXX: This is a global side effect.
        (setenv "GUILE_AUTO_COMPILE" "0")

        ;; Run 'mcron' in a pipe so we can explicitly redirect its output to
        ;; 'current-output-port', which at this stage is bound to the client
        ;; connection.
        (let ((pipe (open-pipe* OPEN_READ
                                #$(file-append mcron "/bin/mcron")
                                (string-append "--schedule=" n)
                                #$@files)))
          (let loop ()
            (match (read-line pipe 'concat)
              ((? eof-object?)
               (catch 'system-error
                 (lambda ()
                   (zero? (close-pipe pipe)))
                 (lambda args
                   ;; There's a race with the SIGCHLD handler, which
                   ;; could call 'waitpid' before 'close-pipe' above does.  If
                   ;; we get ECHILD, that means we lost the race, but that's
                   ;; fine.
                   (or (= ECHILD (system-error-errno args))
                       (apply throw args)))))
              (line
               (display line)
               (loop)))))))))

(define mcron-shepherd-services
  (match-lambda
    (($ <mcron-configuration> mcron ())           ;nothing to do!
     '())
    (($ <mcron-configuration> mcron jobs)
     (let ((files (map job-file jobs)))
       (list (shepherd-service
              (provision '(mcron))
              (requirement '(user-processes))
              (modules `((srfi srfi-1)
                         (srfi srfi-26)
                         (ice-9 popen)            ;for the 'schedule' action
                         (ice-9 rdelim)
                         (ice-9 match)
                         ,@%default-modules))
              (start #~(make-forkexec-constructor
                        (list (string-append #$mcron "/bin/mcron") #$@files)

                        ;; Disable auto-compilation of the job files and set a
                        ;; sane value for 'PATH'.
                        #:environment-variables
                        (cons* "GUILE_AUTO_COMPILE=0"
                               "PATH=/run/current-system/profile/bin"
                               (remove (cut string-prefix? "PATH=" <>)
                                       (environ)))))
              (stop #~(make-kill-destructor))

              (actions
               (list (shepherd-schedule-action mcron files)))))))))

(define mcron-service-type
  (service-type (name 'mcron)
                (extensions
                 (list (service-extension shepherd-root-service-type
                                          mcron-shepherd-services)
                       (service-extension profile-service-type
                                          (compose list
                                                   mcron-configuration-mcron))))
                (compose concatenate)
                (extend (lambda (config jobs)
                          (mcron-configuration
                           (inherit config)
                           (jobs (append (mcron-configuration-jobs config)
                                         jobs)))))
                (default-value (mcron-configuration)))) ;empty job list

(define-deprecated (mcron-service jobs #:optional (mcron mcron))
  mcron-service-type
  "Return an mcron service running @var{mcron} that schedules @var{jobs}, a
list of gexps denoting mcron job specifications.

This is a shorthand for:
@example
  (service mcron-service-type
           (mcron-configuration (mcron mcron) (jobs jobs)))
@end example
"
  (service mcron-service-type
           (mcron-configuration (mcron mcron) (jobs jobs))))

;;; mcron.scm ends here
system-label->string device))) (else device)) mount-point type flags options mount-may-fail? check? skip-check-if-clean? repair)))) (define (spec->file-system sexp) "Deserialize SEXP, a list, to the corresponding <file-system> object." (match sexp ((device mount-point type flags options mount-may-fail? check? skip-check-if-clean? repair _ ...) ;placeholder for new fields (file-system (device (match device (('uuid (? symbol? type) (? bytevector? bv)) (bytevector->uuid bv type)) (('file-system-label (? string? label)) (file-system-label label)) (_ device))) (mount-point mount-point) (type type) (flags flags) (options options) (mount-may-fail? mount-may-fail?) (check? check?) (skip-check-if-clean? skip-check-if-clean?) (repair repair))))) (define (specification->file-system-mapping spec writable?) "Read the SPEC and return the corresponding <file-system-mapping>. SPEC is a string of the form \"SOURCE\" or \"SOURCE=TARGET\". The former specifies that SOURCE from the host should be mounted at SOURCE in the other system. The latter format specifies that SOURCE from the host should be mounted at TARGET in the other system." (let ((index (string-index spec #\=))) (if index (file-system-mapping (source (substring spec 0 index)) (target (substring spec (+ 1 index))) (writable? writable?)) (file-system-mapping (source spec) (target spec) (writable? writable?))))) ;;; ;;; Common file systems. ;;; (define %pseudo-file-system-types ;; List of know pseudo file system types. This is used when validating file ;; system definitions. '("binfmt_misc" "cgroup" "cgroup2" "debugfs" "devpts" "devtmpfs" "efivarfs" "fusectl" "hugetlbfs" "overlay" "proc" "securityfs" "sysfs" "tmpfs" "tracefs" "virtiofs" "xenfs")) (define %fuse-control-file-system ;; Control file system for Linux' file systems in user-space (FUSE). (file-system (device "fusectl") (mount-point "/sys/fs/fuse/connections") (type "fusectl") (check? #f))) (define %binary-format-file-system ;; Support for arbitrary executable binary format. (file-system (device "binfmt_misc") (mount-point "/proc/sys/fs/binfmt_misc") (type "binfmt_misc") (check? #f))) (define %debug-file-system (file-system (type "debugfs") (device "none") (mount-point "/sys/kernel/debug") (check? #f) (create-mount-point? #t))) (define %efivars-file-system ;; Support for EFI variables file system. (file-system (device "efivarfs") (mount-point "/sys/firmware/efi/efivars") (type "efivarfs") (mount-may-fail? #t) (needed-for-boot? #f) (check? #f))) (define %tty-gid ;; ID of the 'tty' group. Allocate it statically to make it easy to refer ;; to it from here and from the 'tty' group definitions. 996) (define %pseudo-terminal-file-system ;; The pseudo-terminal file system. It needs to be mounted so that ;; statfs(2) returns DEVPTS_SUPER_MAGIC like libc's getpt(3) expects (and ;; thus openpty(3) and its users, such as xterm.) (file-system (device "none") (mount-point "/dev/pts") (type "devpts") (check? #f) (needed-for-boot? #f) (create-mount-point? #t) (options (string-append "gid=" (number->string %tty-gid) ",mode=620")))) (define %shared-memory-file-system ;; Shared memory. (file-system (device "tmpfs") (mount-point "/dev/shm") (type "tmpfs") (check? #f) (flags '(no-suid no-dev)) (options "size=50%") ;TODO: make size configurable (create-mount-point? #t))) (define %immutable-store ;; Read-only store to avoid users or daemons accidentally modifying it. ;; 'guix-daemon' has provisions to remount it read-write in its own name ;; space. (file-system (device (%store-prefix)) (mount-point (%store-prefix)) (type "none") (check? #f) (flags '(read-only bind-mount no-atime)))) (define %control-groups ;; The cgroup2 file system. (list (file-system (device "none") (mount-point "/sys/fs/cgroup") (type "cgroup2") (check? #f) (create-mount-point? #f)))) (define %elogind-file-systems ;; We don't use systemd, but these file systems are needed for elogind, ;; which was extracted from systemd. (append (list (file-system (device "none") (mount-point "/run/systemd") (type "tmpfs") (check? #f) (flags '(no-suid no-dev no-exec)) (options "mode=0755") (create-mount-point? #t)) (file-system (device "none") (mount-point "/run/user") (type "tmpfs") (check? #f) (flags '(no-suid no-dev no-exec)) (options "mode=0755") (create-mount-point? #t)) ;; Elogind uses cgroups to organize processes, allowing it to map PIDs ;; to sessions. Elogind's cgroup hierarchy isn't associated with any ;; resource controller ("subsystem"). (file-system (device "cgroup") (mount-point "/sys/fs/cgroup/elogind") (type "cgroup") (check? #f) (options "none,name=elogind") (create-mount-point? #t) (dependencies (list (car %control-groups))))) %control-groups)) (define %base-file-systems ;; List of basic file systems to be mounted. Note that /proc and /sys are ;; currently mounted by the initrd. (list %pseudo-terminal-file-system %debug-file-system %shared-memory-file-system %efivars-file-system %immutable-store)) (define %base-live-file-systems ;; This is the bare minimum to use live file-systems. ;; Used in installation-os. (list (file-system (mount-point "/") (device (file-system-label "Guix_image")) (type "ext4")) ;; Make /tmp a tmpfs instead of keeping the overlayfs. This ;; originally was used for unionfs because FUSE creates ;; '.fuse_hiddenXYZ' files for each open file, and this confuses ;; Guix's test suite, for instance (see ;; <http://bugs.gnu.org/23056>). We keep this for overlayfs to be ;; on the safe side. (file-system (mount-point "/tmp") (device "none") (type "tmpfs") (check? #f)))) ;; File systems for Linux containers differ from %base-file-systems in that ;; they impose additional restrictions such as no-exec or need different ;; options to function properly. ;; ;; The file system flags and options conform to the libcontainer ;; specification: ;; https://github.com/docker/libcontainer/blob/master/SPEC.md#filesystem (define %container-file-systems (list ;; Pseudo-terminal file system. (file-system (device "none") (mount-point "/dev/pts") (type "devpts") (flags '(no-exec no-suid)) (needed-for-boot? #t) (create-mount-point? #t) (check? #f) (options "newinstance,ptmxmode=0666,mode=620")) ;; Shared memory file system. (file-system (device "tmpfs") (mount-point "/dev/shm") (type "tmpfs") (flags '(no-exec no-suid no-dev)) (options "mode=1777,size=65536k") (needed-for-boot? #t) (create-mount-point? #t) (check? #f)) ;; Message queue file system. (file-system (device "mqueue") (mount-point "/dev/mqueue") (type "mqueue") (flags '(no-exec no-suid no-dev)) (needed-for-boot? #t) (create-mount-point? #t) (check? #f)))) ;;; ;;; Shared file systems, for VMs/containers. ;;; ;; Mapping of host file system SOURCE to mount point TARGET in the guest. (define-record-type* <file-system-mapping> file-system-mapping make-file-system-mapping file-system-mapping? (source file-system-mapping-source) ;string (target file-system-mapping-target) ;string (writable? file-system-mapping-writable? ;Boolean (default #f))) (define (file-system-mapping->bind-mount mapping) "Return a file system that realizes MAPPING, a <file-system-mapping>, using a bind mount." (match mapping (($ <file-system-mapping> source target writable?) (file-system (mount-point target) (device source) (type "none") (flags (if writable? '(bind-mount) '(bind-mount read-only))) (check? #f) (create-mount-point? #t))))) (define %store-mapping ;; Mapping of the host's store into the guest. (file-system-mapping (source (%store-prefix)) (target (%store-prefix)) (writable? #f))) (define %network-configuration-files ;; List of essential network configuration files. '("/etc/resolv.conf" "/etc/nsswitch.conf" "/etc/services" "/etc/hosts")) (define %network-file-mappings ;; List of file mappings for essential network files. (filter-map (lambda (file) (file-system-mapping (source file) (target file) ;; XXX: On some GNU/Linux systems, /etc/resolv.conf is a ;; symlink to a file in a tmpfs which, for an unknown reason, ;; cannot be bind mounted read-only within the container. (writable? (string=? file "/etc/resolv.conf")))) %network-configuration-files)) (define (file-system-type-predicate type) "Return a predicate that, when passed a file system, returns #t if that file system has the given TYPE." (lambda (fs) (string=? (file-system-type fs) type))) (define (file-system-mount-point-predicate mount-point) "Return a predicate that, when passed a file system, returns #t if that file system has the given MOUNT-POINT." (lambda (fs) (string=? (file-system-mount-point fs) mount-point))) ;;; ;;; Btrfs specific helpers. ;;; (define (btrfs-subvolume? fs) "Predicate to check if FS, a file-system object, is a Btrfs subvolume." (and-let* ((btrfs-file-system? (string= "btrfs" (file-system-type fs))) (option-keys (map (match-lambda ((key . value) key) (key key)) (file-system-options->alist (file-system-options fs))))) (find (cut string-prefix? "subvol" <>) option-keys))) (define (btrfs-store-subvolume-file-name file-systems) "Return the subvolume file name within the Btrfs top level onto which the store is located, else #f." (define (prepend-slash/maybe s) (if (string=? "/" (string-take s 1)) s (string-append "/" s))) (and-let* ((btrfs-subvolume-fs (filter btrfs-subvolume? file-systems)) (btrfs-subvolume-fs* (sort btrfs-subvolume-fs (lambda (fs1 fs2) (> (file-name-depth (file-system-mount-point fs1)) (file-name-depth (file-system-mount-point fs2)))))) (store-subvolume-fs (find (lambda (fs) (file-prefix? (file-system-mount-point fs) (%store-prefix))) btrfs-subvolume-fs*)) (options (file-system-options->alist (file-system-options store-subvolume-fs)))) ;; XXX: Deriving the subvolume name based from a subvolume ID is not ;; supported, as we'd need to query the actual file system. (or (and=> (assoc-ref options "subvol") prepend-slash/maybe) (raise (condition (&message (message "The store is on a Btrfs subvolume, but the \ subvolume name is unknown.")) (&fix-hint (hint (G_ "Use the @code{subvol} Btrfs file system option.")))))))) ;;; ;;; Swap space ;;; (define-record-type* <swap-space> swap-space make-swap-space swap-space? this-swap-space (target swap-space-target) (dependencies swap-space-dependencies (default '())) (priority swap-space-priority (default #f)) (discard? swap-space-discard? (default #f))) ;;; file-systems.scm ends here