aboutsummaryrefslogtreecommitdiff
path: root/gnu/services/science.scm
blob: 1414789de973e48035647a52385be0562120d71a (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
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2020 Efraim Flashner <efraim@flashner.co.il>
;;;
;;; 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 science)
  #:export (<rshiny-configuration>
            rshiny-configuration
            rshiny-configuration?
            rshiny-configuration-package
            rshiny-configuration-binary
            rshiny-shepherd-service
            rshiny-service-type))

(use-modules (gnu)
             (guix records)
             (ice-9 match))
(use-service-modules shepherd)
(use-package-modules cran)

(define-record-type* <rshiny-configuration>
  rshiny-configuration
  make-rshiny-configuration
  rshiny-configuration?
  (package          rshiny-configuration-package    ; file-like
                    (default r-shiny))
  (binary           rshiny-configuration-binary     ; string
                    (default "rshiny")))

(define rshiny-shepherd-service
  (match-lambda
    (($ <rshiny-configuration> package binary)
     (list
       (shepherd-service
         (documentation (string-append "R-Shiny service for " binary))
         (provision (list (symbol-append 'rshiny- (string->symbol
                                                    (string-take binary 9)))))
         (requirement '(networking))
         (start
           #~(exec-command
               (list
                 #$(string-append "/run/current-system/profile/bin/" binary))
               ;#:log-file #$(string-append "/var/log/" binary ".log") ; kills shepherd
               #:environment-variables
               (list "R_LIBS_USER=/run/current-system/profile/site-library/")))
         (stop #~(make-kill-destructor)))))))

(define rshiny-service-type
  (service-type
    (name 'rshiny)
    (extensions
      (list
        (service-extension shepherd-root-service-type
                           rshiny-shepherd-service)
        (service-extension profile-service-type
                           ;; We want the package installed so that it
                           ;; pulls in the propagated inputs as well.
                           (lambda (config)
                             (list
                               (rshiny-configuration-package config))))))
    (description
     "Run an R-Shiny webapp as a Guix Service.")))
(('reply ('version 0 x ...) ('result y) ('error error) ('messages messages)) (for-each display-message messages) (raise-shepherd-error error) #f) (x ;; invalid reply #f)))) (define-syntax-rule (with-shepherd-action service (action args ...) result body ...) "Invoke ACTION on SERVICE with the given ARGS, and evaluate BODY with RESULT bound to the action's result." (invoke-action service action (list args ...) (lambda (result) body ...))) (define-syntax alist-let* (syntax-rules () "Bind the given KEYs in EXP to the corresponding items in ALIST. ALIST is assumed to be a list of two-element tuples rather than a traditional list of pairs." ((_ alist (key ...) exp ...) (let ((key (and=> (assoc-ref alist 'key) car)) ...) exp ...)))) ;; Information about live Shepherd services. (define-record-type <live-service> (live-service provision requirement transient? running) live-service? (provision live-service-provision) ;list of symbols (requirement live-service-requirement) ;list of symbols (transient? live-service-transient?) ;Boolean (running live-service-running)) ;#f | object (define (live-service-canonical-name service) "Return the 'canonical name' of SERVICE." (first (live-service-provision service))) (define (current-service name) "Return the currently defined Shepherd service NAME, as a <live-service> object. Return #f if the service could not be obtained. As a special case, @code{(current-service 'root)} returns all the current services." (define (process-services services) (resolve-transients (map (lambda (service) (alist-let* service (provides requires running transient?) ;; The Shepherd 0.9.0 would not provide 'transient?' in ;; its status sexp. Thus, when it's missing, query it ;; via an "eval" request. (live-service provides requires (if (sloppy-assq 'transient? service) transient? (and running *unspecified*)) running))) services))) (with-shepherd-action name ('status) results ;; We get a list of results, one for each service with the name NAME. ;; In practice there's only one such service though. (match results ((services _ ...) (match services ((('service ('version 0 _ ...) _ ...) ...) ;; Summary of all services (when NAME is 'root or 'shepherd). (process-services services)) (('service ('version 0 _ ...) _ ...) ;single service (first (process-services (list services)))) (x #f)))))) ;singleton (define (current-services) "Return the list of currently defined Shepherd services, represented as <live-service> objects. Return #f if the list of services could not be obtained." (current-service 'root)) (define (resolve-transients services) "Resolve the subset of SERVICES whose 'transient?' field is undefined. This is necessary to deal with Shepherd 0.9.0, which did not communicate whether a service is transient." ;; All the fuss here is to make sure we make a single "eval root" request ;; for all of SERVICES. (let* ((unresolved (filter (compose unspecified? live-service-transient?) services)) (values (or (and (pair? unresolved) (eval-there `(and (defined? 'transient?) ;shepherd >= 0.9.0 (map (compose transient? lookup-running) ',(map (compose first live-service-provision) unresolved))))) (make-list (length unresolved) #f))) (resolved (map (lambda (unresolved transient?) (cons unresolved (set-field unresolved (live-service-transient?) transient?))) unresolved values))) (map (lambda (service) (or (assq-ref resolved service) service)) services))) (define (unload-service service) "Unload SERVICE, a symbol name; return #t on success." (with-shepherd-action 'root ('unload (symbol->string service)) result (first result))) (define (%load-file file) "Load FILE in the Shepherd." (with-shepherd-action 'root ('load file) result (first result))) (define (eval-there exp) "Eval EXP in the Shepherd." (with-shepherd-action 'root ('eval (object->string exp)) result (first result))) (define (load-services files) "Load and register the services from FILES, where FILES contain code that returns a shepherd <service> object." (eval-there `(register-services ,@(map (lambda (file) `(primitive-load ,file)) files)))) (define load-services/safe ;; Deprecated. It used to behave differently before service replacements ;; were a thing. load-services) (define* (start-service name #:optional (arguments '())) (invoke-action name 'start arguments (lambda (result) result))) (define (stop-service name) (with-shepherd-action name ('stop) result result)) (define (restart-service name) (with-shepherd-action name ('restart) result result)) (define* (wait-for-service name #:key (timeout 20)) "Wait for the service providing NAME, a symbol, to be up and running, and return its \"running value\". Give up after TIMEOUT seconds and raise a '&shepherd-error' exception. Raise a '&service-not-found-error' exception when NAME is not found." (define (relevant-service? service) (memq name (live-service-provision service))) (define start (car (gettimeofday))) ;; Note: As of Shepherd 0.9.1, we cannot just call the 'start' method and ;; wait for it: it would spawn an additional elogind process. Thus, poll. (let loop ((attempts 0)) (define services (current-services)) (define now (car (gettimeofday))) (when (>= (- now start) timeout) (raise (condition (&shepherd-error)))) ;XXX: better exception? (match (find relevant-service? services) (#f (raise (condition (&service-not-found-error (service name))))) (service (or (live-service-running service) (begin (sleep 1) (loop (+ attempts 1)))))))) ;; Local Variables: ;; eval: (put 'alist-let* 'scheme-indent-function 2) ;; eval: (put 'with-shepherd 'scheme-indent-function 1) ;; eval: (put 'with-shepherd-action 'scheme-indent-function 3) ;; End: ;;; herd.scm ends here