Commit | Line | Data |
---|---|---|
db4fdc04 | 1 | ;;; GNU Guix --- Functional package management for GNU |
223ede4e | 2 | ;;; Copyright © 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> |
4d343a14 | 3 | ;;; Copyright © 2016 Chris Marusich <cmmarusich@gmail.com> |
db4fdc04 LC |
4 | ;;; |
5 | ;;; This file is part of GNU Guix. | |
6 | ;;; | |
7 | ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
8 | ;;; under the terms of the GNU General Public License as published by | |
9 | ;;; the Free Software Foundation; either version 3 of the License, or (at | |
10 | ;;; your option) any later version. | |
11 | ;;; | |
12 | ;;; GNU Guix is distributed in the hope that it will be useful, but | |
13 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | ;;; GNU General Public License for more details. | |
16 | ;;; | |
17 | ;;; You should have received a copy of the GNU General Public License | |
18 | ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
19 | ||
20 | (define-module (gnu services) | |
bebc8681 | 21 | #:use-module (guix gexp) |
0adfe95a LC |
22 | #:use-module (guix monads) |
23 | #:use-module (guix store) | |
db4fdc04 | 24 | #:use-module (guix records) |
af4c3fd5 | 25 | #:use-module (guix profiles) |
0c0c1b21 | 26 | #:use-module (guix discovery) |
d466b1fc | 27 | #:use-module (guix combinators) |
33b7cb7a LC |
28 | #:use-module (guix channels) |
29 | #:use-module (guix describe) | |
0adfe95a LC |
30 | #:use-module (guix sets) |
31 | #:use-module (guix ui) | |
1bb895ea | 32 | #:use-module ((guix utils) #:select (source-properties->location)) |
232ccbef | 33 | #:use-module (guix modules) |
0adfe95a LC |
34 | #:use-module (gnu packages base) |
35 | #:use-module (gnu packages bash) | |
36 | #:use-module (srfi srfi-1) | |
37 | #:use-module (srfi srfi-9) | |
38 | #:use-module (srfi srfi-9 gnu) | |
39 | #:use-module (srfi srfi-26) | |
40 | #:use-module (srfi srfi-34) | |
41 | #:use-module (srfi srfi-35) | |
42 | #:use-module (ice-9 vlist) | |
43 | #:use-module (ice-9 match) | |
33b7cb7a | 44 | #:autoload (ice-9 pretty-print) (pretty-print) |
0adfe95a LC |
45 | #:export (service-extension |
46 | service-extension? | |
7d8b5913 CB |
47 | service-extension-target |
48 | service-extension-compute | |
0adfe95a LC |
49 | |
50 | service-type | |
51 | service-type? | |
5152d13b LC |
52 | service-type-name |
53 | service-type-extensions | |
54 | service-type-compose | |
55 | service-type-extend | |
1bb895ea | 56 | service-type-default-value |
b714395a LC |
57 | service-type-description |
58 | service-type-location | |
59 | ||
0c0c1b21 LC |
60 | %service-type-path |
61 | fold-service-types | |
49483f71 | 62 | lookup-service-types |
0adfe95a | 63 | |
db4fdc04 | 64 | service |
0adfe95a LC |
65 | service? |
66 | service-kind | |
efe7d19a LC |
67 | service-value |
68 | service-parameters ;deprecated | |
0adfe95a | 69 | |
71654dfd | 70 | simple-service |
cd6f6c22 | 71 | modify-services |
5152d13b | 72 | service-back-edges |
d466b1fc | 73 | instantiate-missing-services |
0adfe95a LC |
74 | fold-services |
75 | ||
76 | service-error? | |
1bb895ea LC |
77 | missing-value-service-error? |
78 | missing-value-service-error-type | |
79 | missing-value-service-error-location | |
0adfe95a LC |
80 | missing-target-service-error? |
81 | missing-target-service-error-service | |
82 | missing-target-service-error-target-type | |
83 | ambiguous-target-service-error? | |
84 | ambiguous-target-service-error-service | |
85 | ambiguous-target-service-error-target-type | |
86 | ||
d62e201c | 87 | system-service-type |
33b7cb7a | 88 | provenance-service-type |
0adfe95a | 89 | boot-service-type |
be7be9e8 | 90 | cleanup-service-type |
0adfe95a LC |
91 | activation-service-type |
92 | activation-service->script | |
a241a7ac | 93 | %linux-bare-metal-service |
387e1754 LC |
94 | special-files-service-type |
95 | extra-special-file | |
0adfe95a LC |
96 | etc-service-type |
97 | etc-directory | |
98 | setuid-program-service-type | |
af4c3fd5 | 99 | profile-service-type |
0adfe95a | 100 | firmware-service-type |
e0b47290 | 101 | gc-root-service-type |
0adfe95a LC |
102 | |
103 | %boot-service | |
104 | %activation-service | |
d298c815 | 105 | etc-service)) |
0adfe95a LC |
106 | |
107 | ;;; Comment: | |
108 | ;;; | |
109 | ;;; This module defines a broad notion of "service types" and "services." | |
db4fdc04 | 110 | ;;; |
0adfe95a LC |
111 | ;;; A service type describe how its instances extend instances of other |
112 | ;;; service types. For instance, some services extend the instance of | |
113 | ;;; ACCOUNT-SERVICE-TYPE by providing it with accounts and groups to create; | |
d4053c71 AK |
114 | ;;; others extend SHEPHERD-ROOT-SERVICE-TYPE by passing it instances of |
115 | ;;; <shepherd-service>. | |
0adfe95a LC |
116 | ;;; |
117 | ;;; When applicable, the service type defines how it can itself be extended, | |
118 | ;;; by providing one procedure to compose extensions, and one procedure to | |
119 | ;;; extend itself. | |
120 | ;;; | |
d62e201c LC |
121 | ;;; A notable service type is SYSTEM-SERVICE-TYPE, which has a single |
122 | ;;; instance, which is the root of the service DAG. Its value is the | |
123 | ;;; derivation that produces the 'system' directory as returned by | |
124 | ;;; 'operating-system-derivation'. | |
0adfe95a LC |
125 | ;;; |
126 | ;;; The 'fold-services' procedure can be passed a list of procedures, which it | |
127 | ;;; "folds" by propagating extensions down the graph; it returns the root | |
128 | ;;; service after the applying all its extensions. | |
db4fdc04 LC |
129 | ;;; |
130 | ;;; Code: | |
131 | ||
0adfe95a LC |
132 | (define-record-type <service-extension> |
133 | (service-extension target compute) | |
134 | service-extension? | |
135 | (target service-extension-target) ;<service-type> | |
136 | (compute service-extension-compute)) ;params -> params | |
137 | ||
1bb895ea LC |
138 | (define &no-default-value |
139 | ;; Value used to denote service types that have no associated default value. | |
140 | '(no default value)) | |
141 | ||
0adfe95a LC |
142 | (define-record-type* <service-type> service-type make-service-type |
143 | service-type? | |
144 | (name service-type-name) ;symbol (for debugging) | |
145 | ||
146 | ;; Things extended by services of this type. | |
147 | (extensions service-type-extensions) ;list of <service-extensions> | |
148 | ||
149 | ;; Given a list of extensions, "compose" them. | |
150 | (compose service-type-compose ;list of Any -> Any | |
151 | (default #f)) | |
152 | ||
153 | ;; Extend the services' own parameters with the extension composition. | |
154 | (extend service-type-extend ;list of Any -> parameters | |
1bb895ea LC |
155 | (default #f)) |
156 | ||
157 | ;; Optional default value for instances of this type. | |
158 | (default-value service-type-default-value ;Any | |
b714395a LC |
159 | (default &no-default-value)) |
160 | ||
161 | ;; Meta-data. | |
162 | (description service-type-description ;string | |
163 | (default #f)) | |
164 | (location service-type-location ;<location> | |
165 | (default (and=> (current-source-location) | |
166 | source-properties->location)) | |
167 | (innate))) | |
0adfe95a LC |
168 | |
169 | (define (write-service-type type port) | |
170 | (format port "#<service-type ~a ~a>" | |
171 | (service-type-name type) | |
172 | (number->string (object-address type) 16))) | |
173 | ||
174 | (set-record-type-printer! <service-type> write-service-type) | |
175 | ||
0c0c1b21 LC |
176 | (define %distro-root-directory |
177 | ;; Absolute file name of the module hierarchy. | |
178 | (dirname (search-path %load-path "guix.scm"))) | |
179 | ||
180 | (define %service-type-path | |
181 | ;; Search path for service types. | |
182 | (make-parameter `((,%distro-root-directory . "gnu/services") | |
183 | (,%distro-root-directory . "gnu/system")))) | |
184 | ||
3943913f LC |
185 | (define (all-service-modules) |
186 | "Return the default set of service modules." | |
187 | (cons (resolve-interface '(gnu services)) | |
3c0128b0 LC |
188 | (all-modules (%service-type-path) |
189 | #:warn warn-about-load-error))) | |
3943913f | 190 | |
0c0c1b21 LC |
191 | (define* (fold-service-types proc seed |
192 | #:optional | |
3943913f | 193 | (modules (all-service-modules))) |
0c0c1b21 LC |
194 | "For each service type exported by one of MODULES, call (PROC RESULT). SEED |
195 | is used as the initial value of RESULT." | |
196 | (fold-module-public-variables (lambda (object result) | |
197 | (if (service-type? object) | |
198 | (proc object result) | |
199 | result)) | |
a3d37f3a | 200 | seed |
0c0c1b21 LC |
201 | modules)) |
202 | ||
49483f71 LC |
203 | (define lookup-service-types |
204 | (let ((table | |
205 | (delay (fold-service-types (lambda (type result) | |
206 | (vhash-consq (service-type-name type) | |
207 | type result)) | |
208 | vlist-null)))) | |
209 | (lambda (name) | |
210 | "Return the list of services with the given NAME (a symbol)." | |
211 | (vhash-foldq* cons '() name (force table))))) | |
212 | ||
0adfe95a LC |
213 | ;; Services of a given type. |
214 | (define-record-type <service> | |
1bb895ea | 215 | (make-service type value) |
db4fdc04 | 216 | service? |
0adfe95a | 217 | (type service-kind) |
efe7d19a LC |
218 | (value service-value)) |
219 | ||
1bb895ea LC |
220 | (define-syntax service |
221 | (syntax-rules () | |
222 | "Return a service instance of TYPE. The service value is VALUE or, if | |
223 | omitted, TYPE's default value." | |
224 | ((_ type value) | |
225 | (make-service type value)) | |
226 | ((_ type) | |
227 | (%service-with-default-value (current-source-location) | |
228 | type)))) | |
229 | ||
230 | (define (%service-with-default-value location type) | |
231 | "Return a instance of service type TYPE with its default value, if any. If | |
232 | TYPE does not have a default value, an error is raised." | |
233 | ;; TODO: Currently this is a run-time error but with a little bit macrology | |
234 | ;; we could turn it into an expansion-time error. | |
235 | (let ((default (service-type-default-value type))) | |
236 | (if (eq? default &no-default-value) | |
237 | (let ((location (source-properties->location location))) | |
238 | (raise | |
239 | (condition | |
240 | (&missing-value-service-error (type type) (location location)) | |
241 | (&message | |
69daee23 | 242 | (message (format #f (G_ "~a: no value specified \ |
1bb895ea LC |
243 | for service of type '~a'") |
244 | (location->string location) | |
245 | (service-type-name type))))))) | |
246 | (service type default)))) | |
247 | ||
248 | (define-condition-type &service-error &error | |
249 | service-error?) | |
250 | ||
251 | (define-condition-type &missing-value-service-error &service-error | |
252 | missing-value-service-error? | |
253 | (type missing-value-service-error-type) | |
254 | (location missing-value-service-error-location)) | |
255 | ||
256 | ||
257 | \f | |
258 | ;;; | |
259 | ;;; Helpers. | |
260 | ;;; | |
261 | ||
efe7d19a LC |
262 | (define service-parameters |
263 | ;; Deprecated alias. | |
264 | service-value) | |
0adfe95a | 265 | |
71654dfd LC |
266 | (define (simple-service name target value) |
267 | "Return a service that extends TARGET with VALUE. This works by creating a | |
268 | singleton service type NAME, of which the returned service is an instance." | |
269 | (let* ((extension (service-extension target identity)) | |
270 | (type (service-type (name name) | |
271 | (extensions (list extension))))) | |
272 | (service type value))) | |
0adfe95a | 273 | |
cd6f6c22 LC |
274 | (define-syntax %modify-service |
275 | (syntax-rules (=>) | |
276 | ((_ service) | |
277 | service) | |
278 | ((_ svc (kind param => exp ...) clauses ...) | |
279 | (if (eq? (service-kind svc) kind) | |
efe7d19a | 280 | (let ((param (service-value svc))) |
cd6f6c22 LC |
281 | (service (service-kind svc) |
282 | (begin exp ...))) | |
283 | (%modify-service svc clauses ...))))) | |
284 | ||
285 | (define-syntax modify-services | |
286 | (syntax-rules () | |
4d343a14 CM |
287 | "Modify the services listed in SERVICES according to CLAUSES and return |
288 | the resulting list of services. Each clause must have the form: | |
cd6f6c22 LC |
289 | |
290 | (TYPE VARIABLE => BODY) | |
291 | ||
292 | where TYPE is a service type, such as 'guix-service-type', and VARIABLE is an | |
293 | identifier that is bound within BODY to the value of the service of that | |
294 | TYPE. Consider this example: | |
295 | ||
296 | (modify-services %base-services | |
297 | (guix-service-type config => | |
298 | (guix-configuration | |
299 | (inherit config) | |
300 | (use-substitutes? #f) | |
301 | (extra-options '(\"--gc-keep-derivations\")))) | |
302 | (mingetty-service-type config => | |
303 | (mingetty-configuration | |
304 | (inherit config) | |
305 | (motd (plain-file \"motd\" \"Hi there!\"))))) | |
306 | ||
307 | It changes the configuration of the GUIX-SERVICE-TYPE instance, and that of | |
308 | all the MINGETTY-SERVICE-TYPE instances. | |
309 | ||
310 | This is a shorthand for (map (lambda (svc) ...) %base-services)." | |
311 | ((_ services clauses ...) | |
312 | (map (lambda (service) | |
313 | (%modify-service service clauses ...)) | |
314 | services)))) | |
0adfe95a LC |
315 | |
316 | \f | |
317 | ;;; | |
318 | ;;; Core services. | |
319 | ;;; | |
320 | ||
0e5c2d5e | 321 | (define (system-derivation entries mextensions) |
d62e201c LC |
322 | "Return as a monadic value the derivation of the 'system' directory |
323 | containing the given entries." | |
0e5c2d5e | 324 | (mlet %store-monad ((extensions (mapm/accumulate-builds identity |
223ede4e | 325 | mextensions))) |
d62e201c LC |
326 | (lower-object |
327 | (file-union "system" | |
328 | (append entries (concatenate extensions)))))) | |
329 | ||
330 | (define system-service-type | |
331 | ;; This is the ultimate service type, the root of the service DAG. The | |
332 | ;; service of this type is extended by monadic name/item pairs. These items | |
333 | ;; end up in the "system directory" as returned by | |
334 | ;; 'operating-system-derivation'. | |
335 | (service-type (name 'system) | |
336 | (extensions '()) | |
337 | (compose identity) | |
636bb2b5 LC |
338 | (extend system-derivation) |
339 | (description | |
340 | "Build the operating system top-level directory, which in | |
341 | turn refers to everything the operating system needs: its kernel, initrd, | |
342 | system profile, boot script, and so on."))) | |
d62e201c | 343 | |
378daa8c LC |
344 | (define (compute-boot-script _ gexps) |
345 | ;; Reverse GEXPS so that extensions appear in the boot script in the right | |
661c237b LC |
346 | ;; order. That is, user extensions would come first, and extensions added |
347 | ;; by 'essential-services' (e.g., running shepherd) are guaranteed to come | |
348 | ;; last. | |
378daa8c LC |
349 | (gexp->file "boot" |
350 | ;; Clean up and activate the system, then spawn shepherd. | |
351 | #~(begin #$@(reverse gexps)))) | |
0adfe95a | 352 | |
d62e201c LC |
353 | (define (boot-script-entry mboot) |
354 | "Return, as a monadic value, an entry for the boot script in the system | |
355 | directory." | |
356 | (mlet %store-monad ((boot mboot)) | |
357 | (return `(("boot" ,boot))))) | |
358 | ||
0adfe95a | 359 | (define boot-service-type |
378daa8c LC |
360 | ;; The service of this type is extended by being passed gexps. It |
361 | ;; aggregates them in a single script, as a monadic value, which becomes its | |
362 | ;; value. | |
0adfe95a | 363 | (service-type (name 'boot) |
d62e201c LC |
364 | (extensions |
365 | (list (service-extension system-service-type | |
366 | boot-script-entry))) | |
7874e9e0 | 367 | (compose identity) |
636bb2b5 LC |
368 | (extend compute-boot-script) |
369 | (description | |
370 | "Produce the operating system's boot script, which is spawned | |
371 | by the initrd once the root file system is mounted."))) | |
0adfe95a LC |
372 | |
373 | (define %boot-service | |
d62e201c | 374 | ;; The service that produces the boot script. |
0adfe95a | 375 | (service boot-service-type #t)) |
be7be9e8 | 376 | |
33b7cb7a LC |
377 | \f |
378 | ;;; | |
379 | ;;; Provenance tracking. | |
380 | ;;; | |
381 | ||
382 | (define (object->pretty-string obj) | |
383 | "Like 'object->string', but using 'pretty-print'." | |
384 | (call-with-output-string | |
385 | (lambda (port) | |
386 | (pretty-print obj port)))) | |
387 | ||
388 | (define (channel->code channel) | |
389 | "Return code to build CHANNEL, ready to be dropped in a 'channels.scm' | |
390 | file." | |
391 | `(channel (name ',(channel-name channel)) | |
392 | (url ,(channel-url channel)) | |
393 | (branch ,(channel-branch channel)) | |
394 | (commit ,(channel-commit channel)))) | |
395 | ||
396 | (define (channel->sexp channel) | |
397 | "Return an sexp describing CHANNEL. The sexp is _not_ code and is meant to | |
398 | be parsed by tools; it's potentially more future-proof than code." | |
399 | `(channel (name ,(channel-name channel)) | |
400 | (url ,(channel-url channel)) | |
401 | (branch ,(channel-branch channel)) | |
402 | (commit ,(channel-commit channel)))) | |
403 | ||
404 | (define (provenance-file channels config-file) | |
405 | "Return a 'provenance' file describing CHANNELS, a list of channels, and | |
406 | CONFIG-FILE, which can be either #f or a <local-file> containing the OS | |
407 | configuration being used." | |
408 | (scheme-file "provenance" | |
409 | #~(provenance | |
410 | (version 0) | |
411 | (channels #+@(if channels | |
412 | (map channel->sexp channels) | |
413 | '())) | |
414 | (configuration-file #+config-file)))) | |
415 | ||
416 | (define (provenance-entry config-file) | |
417 | "Return system entries describing the operating system provenance: the | |
418 | channels in use and CONFIG-FILE, if it is true." | |
419 | (define profile | |
420 | (current-profile)) | |
421 | ||
422 | (define channels | |
423 | (and=> profile profile-channels)) | |
424 | ||
425 | (mbegin %store-monad | |
426 | (let ((config-file (cond ((string? config-file) | |
427 | (local-file config-file "configuration.scm")) | |
428 | ((not config-file) | |
429 | #f) | |
430 | (else | |
431 | config-file)))) | |
432 | (return `(("provenance" ,(provenance-file channels config-file)) | |
433 | ,@(if channels | |
434 | `(("channels.scm" | |
435 | ,(plain-file "channels.scm" | |
436 | (object->pretty-string | |
437 | `(list | |
438 | ,@(map channel->code channels)))))) | |
439 | '()) | |
440 | ,@(if config-file | |
441 | `(("configuration.scm" ,config-file)) | |
442 | '())))))) | |
443 | ||
444 | (define provenance-service-type | |
445 | (service-type (name 'provenance) | |
446 | (extensions | |
447 | (list (service-extension system-service-type | |
448 | provenance-entry))) | |
449 | (default-value #f) ;the OS config file | |
450 | (description | |
451 | "Store provenance information about the system in the system | |
452 | itself: the channels used when building the system, and its configuration | |
453 | file, when available."))) | |
454 | ||
455 | \f | |
456 | ;;; | |
457 | ;;; Cleanup. | |
458 | ;;; | |
459 | ||
be7be9e8 | 460 | (define (cleanup-gexp _) |
378daa8c LC |
461 | "Return a gexp to clean up /tmp and similar places upon boot." |
462 | (with-imported-modules '((guix build utils)) | |
463 | #~(begin | |
464 | (use-modules (guix build utils)) | |
465 | ||
466 | ;; Clean out /tmp and /var/run. | |
467 | ;; | |
468 | ;; XXX This needs to happen before service activations, so it | |
469 | ;; has to be here, but this also implicitly assumes that /tmp | |
470 | ;; and /var/run are on the root partition. | |
471 | (letrec-syntax ((fail-safe (syntax-rules () | |
472 | ((_ exp rest ...) | |
473 | (begin | |
474 | (catch 'system-error | |
475 | (lambda () exp) | |
476 | (const #f)) | |
477 | (fail-safe rest ...))) | |
478 | ((_) | |
479 | #t)))) | |
480 | ;; Ignore I/O errors so the system can boot. | |
481 | (fail-safe | |
482 | ;; Remove stale Shadow lock files as they would lead to | |
483 | ;; failures of 'useradd' & co. | |
484 | (delete-file "/etc/group.lock") | |
485 | (delete-file "/etc/passwd.lock") | |
486 | (delete-file "/etc/.pwd.lock") ;from 'lckpwdf' | |
487 | ||
488 | ;; Force file names to be decoded as UTF-8. See | |
489 | ;; <https://bugs.gnu.org/26353>. | |
490 | (setenv "GUIX_LOCPATH" | |
491 | #+(file-append glibc-utf8-locales "/lib/locale")) | |
492 | (setlocale LC_CTYPE "en_US.utf8") | |
493 | (delete-file-recursively "/tmp") | |
494 | (delete-file-recursively "/var/run") | |
495 | ||
496 | (mkdir "/tmp") | |
497 | (chmod "/tmp" #o1777) | |
498 | (mkdir "/var/run") | |
499 | (chmod "/var/run" #o755) | |
500 | (delete-file-recursively "/run/udev/watch.old")))))) | |
be7be9e8 LC |
501 | |
502 | (define cleanup-service-type | |
503 | ;; Service that cleans things up in /tmp and similar. | |
504 | (service-type (name 'cleanup) | |
505 | (extensions | |
506 | (list (service-extension boot-service-type | |
636bb2b5 LC |
507 | cleanup-gexp))) |
508 | (description | |
509 | "Delete files from @file{/tmp}, @file{/var/run}, and other | |
510 | temporary locations at boot time."))) | |
0adfe95a | 511 | |
0adfe95a LC |
512 | (define* (activation-service->script service) |
513 | "Return as a monadic value the activation script for SERVICE, a service of | |
514 | ACTIVATION-SCRIPT-TYPE." | |
efe7d19a | 515 | (activation-script (service-value service))) |
0adfe95a LC |
516 | |
517 | (define (activation-script gexps) | |
518 | "Return the system's activation script, which evaluates GEXPS." | |
378daa8c | 519 | (define actions |
03cbd94d JK |
520 | (map (cut program-file "activate-service.scm" <>) gexps)) |
521 | ||
522 | (program-file "activate.scm" | |
523 | (with-imported-modules (source-module-closure | |
524 | '((gnu build activation) | |
525 | (guix build utils))) | |
526 | #~(begin | |
527 | (use-modules (gnu build activation) | |
528 | (guix build utils)) | |
529 | ||
530 | ;; Make sure the user accounting database exists. If it | |
531 | ;; does not exist, 'setutxent' does not create it and | |
532 | ;; thus there is no accounting at all. | |
533 | (close-port (open-file "/var/run/utmpx" "a0")) | |
534 | ||
535 | ;; Same for 'wtmp', which is populated by mingetty et | |
536 | ;; al. | |
537 | (mkdir-p "/var/log") | |
538 | (close-port (open-file "/var/log/wtmp" "a0")) | |
539 | ||
540 | ;; Set up /run/current-system. Among other things this | |
541 | ;; sets up locales, which the activation snippets | |
542 | ;; executed below may expect. | |
543 | (activate-current-system) | |
544 | ||
545 | ;; Run the services' activation snippets. | |
546 | ;; TODO: Use 'load-compiled'. | |
547 | (for-each primitive-load '#$actions))))) | |
0adfe95a LC |
548 | |
549 | (define (gexps->activation-gexp gexps) | |
550 | "Return a gexp that runs the activation script containing GEXPS." | |
378daa8c | 551 | #~(primitive-load #$(activation-script gexps))) |
0adfe95a | 552 | |
3a391e68 LC |
553 | (define (second-argument a b) b) |
554 | ||
0adfe95a LC |
555 | (define activation-service-type |
556 | (service-type (name 'activate) | |
557 | (extensions | |
558 | (list (service-extension boot-service-type | |
559 | gexps->activation-gexp))) | |
7874e9e0 | 560 | (compose identity) |
636bb2b5 LC |
561 | (extend second-argument) |
562 | (description | |
563 | "Run @dfn{activation} code at boot time and upon | |
564 | @command{guix system reconfigure} completion."))) | |
0adfe95a LC |
565 | |
566 | (define %activation-service | |
567 | ;; The activation service produces the activation script from the gexps it | |
568 | ;; receives. | |
569 | (service activation-service-type #t)) | |
570 | ||
a241a7ac LC |
571 | (define %modprobe-wrapper |
572 | ;; Wrapper for the 'modprobe' command that knows where modules live. | |
573 | ;; | |
574 | ;; This wrapper is typically invoked by the Linux kernel ('call_modprobe', | |
575 | ;; in kernel/kmod.c), a situation where the 'LINUX_MODULE_DIRECTORY' | |
576 | ;; environment variable is not set---hence the need for this wrapper. | |
577 | (let ((modprobe "/run/current-system/profile/bin/modprobe")) | |
578 | (program-file "modprobe" | |
579 | #~(begin | |
580 | (setenv "LINUX_MODULE_DIRECTORY" | |
581 | "/run/booted-system/kernel/lib/modules") | |
8c88e242 BW |
582 | ;; FIXME: Remove this crutch when the patch #40422, |
583 | ;; updating to kmod 27 is merged. | |
584 | (setenv "MODPROBE_OPTIONS" | |
585 | "-C /etc/modprobe.d") | |
a241a7ac LC |
586 | (apply execl #$modprobe |
587 | (cons #$modprobe (cdr (command-line)))))))) | |
588 | ||
589 | (define %linux-kernel-activation | |
590 | ;; Activation of the Linux kernel running on the bare metal (as opposed to | |
591 | ;; running in a container.) | |
592 | #~(begin | |
593 | ;; Tell the kernel to use our 'modprobe' command. | |
594 | (activate-modprobe #$%modprobe-wrapper) | |
595 | ||
596 | ;; Let users debug their own processes! | |
597 | (activate-ptrace-attach))) | |
598 | ||
a241a7ac LC |
599 | (define %linux-bare-metal-service |
600 | ;; The service that does things that are needed on the "bare metal", but not | |
601 | ;; necessary or impossible in a container. | |
6ddf4fcf LC |
602 | (simple-service 'linux-bare-metal |
603 | activation-service-type | |
604 | %linux-kernel-activation)) | |
605 | ||
a241a7ac | 606 | |
387e1754 LC |
607 | (define special-files-service-type |
608 | ;; Service to install "special files" such as /bin/sh and /usr/bin/env. | |
609 | (service-type | |
610 | (name 'special-files) | |
611 | (extensions | |
612 | (list (service-extension activation-service-type | |
613 | (lambda (files) | |
614 | #~(activate-special-files '#$files))))) | |
615 | (compose concatenate) | |
636bb2b5 LC |
616 | (extend append) |
617 | (description | |
618 | "Add special files to the root file system---e.g., | |
619 | @file{/usr/bin/env}."))) | |
387e1754 LC |
620 | |
621 | (define (extra-special-file file target) | |
622 | "Use TARGET as the \"special file\" FILE. For example, TARGET might be | |
623 | (file-append coreutils \"/bin/env\") | |
624 | and FILE could be \"/usr/bin/env\"." | |
625 | (simple-service (string->symbol (string-append "special-file-" file)) | |
626 | special-files-service-type | |
627 | `((,file ,target)))) | |
628 | ||
0adfe95a LC |
629 | (define (etc-directory service) |
630 | "Return the directory for SERVICE, a service of type ETC-SERVICE-TYPE." | |
efe7d19a | 631 | (files->etc-directory (service-value service))) |
0adfe95a LC |
632 | |
633 | (define (files->etc-directory files) | |
a322e9d1 LC |
634 | (define (assert-no-duplicates files) |
635 | (let loop ((files files) | |
636 | (seen (set))) | |
637 | (match files | |
638 | (() #t) | |
639 | (((file _) rest ...) | |
640 | (when (set-contains? seen file) | |
641 | (raise (condition | |
642 | (&message | |
643 | (message (format #f (G_ "duplicate '~a' entry for /etc") | |
644 | file)))))) | |
645 | (loop rest (set-insert file seen)))))) | |
646 | ||
647 | ;; Detect duplicates early instead of letting them through, eventually | |
648 | ;; leading to a build failure of "etc.drv". | |
649 | (assert-no-duplicates files) | |
650 | ||
0adfe95a LC |
651 | (file-union "etc" files)) |
652 | ||
d62e201c LC |
653 | (define (etc-entry files) |
654 | "Return an entry for the /etc directory consisting of FILES in the system | |
655 | directory." | |
656 | (with-monad %store-monad | |
657 | (return `(("etc" ,(files->etc-directory files)))))) | |
658 | ||
0adfe95a LC |
659 | (define etc-service-type |
660 | (service-type (name 'etc) | |
661 | (extensions | |
662 | (list | |
663 | (service-extension activation-service-type | |
664 | (lambda (files) | |
665 | (let ((etc | |
666 | (files->etc-directory files))) | |
d62e201c LC |
667 | #~(activate-etc #$etc)))) |
668 | (service-extension system-service-type etc-entry))) | |
0adfe95a | 669 | (compose concatenate) |
636bb2b5 LC |
670 | (extend append) |
671 | (description "Populate the @file{/etc} directory."))) | |
0adfe95a LC |
672 | |
673 | (define (etc-service files) | |
674 | "Return a new service of ETC-SERVICE-TYPE that populates /etc with FILES. | |
675 | FILES must be a list of name/file-like object pairs." | |
676 | (service etc-service-type files)) | |
677 | ||
678 | (define setuid-program-service-type | |
679 | (service-type (name 'setuid-program) | |
680 | (extensions | |
681 | (list (service-extension activation-service-type | |
682 | (lambda (programs) | |
683 | #~(activate-setuid-programs | |
684 | (list #$@programs)))))) | |
685 | (compose concatenate) | |
636bb2b5 LC |
686 | (extend append) |
687 | (description | |
688 | "Populate @file{/run/setuid-programs} with the specified | |
689 | executables, making them setuid-root."))) | |
0adfe95a | 690 | |
af4c3fd5 LC |
691 | (define (packages->profile-entry packages) |
692 | "Return a system entry for the profile containing PACKAGES." | |
45bd9133 LC |
693 | (with-monad %store-monad |
694 | (return `(("profile" ,(profile | |
695 | (content (packages->manifest | |
696 | (delete-duplicates packages eq?))))))))) | |
af4c3fd5 LC |
697 | |
698 | (define profile-service-type | |
699 | ;; The service that populates the system's profile---i.e., | |
700 | ;; /run/current-system/profile. It is extended by package lists. | |
701 | (service-type (name 'profile) | |
702 | (extensions | |
703 | (list (service-extension system-service-type | |
704 | packages->profile-entry))) | |
705 | (compose concatenate) | |
636bb2b5 LC |
706 | (extend append) |
707 | (description | |
708 | "This is the @dfn{system profile}, available as | |
709 | @file{/run/current-system/profile}. It contains packages that the sysadmin | |
710 | wants to be globally available to all the system users."))) | |
af4c3fd5 | 711 | |
0adfe95a LC |
712 | (define (firmware->activation-gexp firmware) |
713 | "Return a gexp to make the packages listed in FIRMWARE loadable by the | |
714 | kernel." | |
715 | (let ((directory (directory-union "firmware" firmware))) | |
716 | ;; Tell the kernel where firmware is. | |
717 | #~(activate-firmware (string-append #$directory "/lib/firmware")))) | |
718 | ||
719 | (define firmware-service-type | |
720 | ;; The service that collects firmware. | |
721 | (service-type (name 'firmware) | |
722 | (extensions | |
723 | (list (service-extension activation-service-type | |
724 | firmware->activation-gexp))) | |
725 | (compose concatenate) | |
636bb2b5 LC |
726 | (extend append) |
727 | (description | |
728 | "Make ``firmware'' files loadable by the operating system | |
729 | kernel. Firmware may then be uploaded to some of the machine's devices, such | |
730 | as Wifi cards."))) | |
0adfe95a | 731 | |
e0b47290 LC |
732 | (define (gc-roots->system-entry roots) |
733 | "Return an entry in the system's output containing symlinks to ROOTS." | |
734 | (mlet %store-monad ((entry (gexp->derivation | |
735 | "gc-roots" | |
736 | #~(let ((roots '#$roots)) | |
737 | (mkdir #$output) | |
738 | (chdir #$output) | |
739 | (for-each symlink | |
740 | roots | |
741 | (map number->string | |
742 | (iota (length roots)))))))) | |
743 | (return (if (null? roots) | |
744 | '() | |
745 | `(("gc-roots" ,entry)))))) | |
746 | ||
747 | (define gc-root-service-type | |
748 | ;; A service to associate extra garbage-collector roots to the system. This | |
749 | ;; is a simple hack that guarantees that the system retains references to | |
750 | ;; the given list of roots. Roots must be "lowerable" objects like | |
751 | ;; packages, or derivations. | |
752 | (service-type (name 'gc-roots) | |
753 | (extensions | |
754 | (list (service-extension system-service-type | |
755 | gc-roots->system-entry))) | |
756 | (compose concatenate) | |
636bb2b5 LC |
757 | (extend append) |
758 | (description | |
759 | "Register garbage-collector roots---i.e., store items that | |
dc5729a8 LC |
760 | will not be reclaimed by the garbage collector.") |
761 | (default-value '()))) | |
e0b47290 | 762 | |
0adfe95a LC |
763 | \f |
764 | ;;; | |
765 | ;;; Service folding. | |
766 | ;;; | |
767 | ||
0adfe95a LC |
768 | (define-condition-type &missing-target-service-error &service-error |
769 | missing-target-service-error? | |
770 | (service missing-target-service-error-service) | |
771 | (target-type missing-target-service-error-target-type)) | |
772 | ||
773 | (define-condition-type &ambiguous-target-service-error &service-error | |
774 | ambiguous-target-service-error? | |
775 | (service ambiguous-target-service-error-service) | |
776 | (target-type ambiguous-target-service-error-target-type)) | |
777 | ||
d466b1fc LC |
778 | (define (missing-target-error service target-type) |
779 | (raise | |
780 | (condition (&missing-target-service-error | |
781 | (service service) | |
782 | (target-type target-type)) | |
783 | (&message | |
784 | (message | |
785 | (format #f (G_ "no target of type '~a' for service '~a'") | |
786 | (service-type-name target-type) | |
787 | (service-type-name | |
788 | (service-kind service)))))))) | |
789 | ||
0adfe95a LC |
790 | (define (service-back-edges services) |
791 | "Return a procedure that, when passed a <service>, returns the list of | |
792 | <service> objects that depend on it." | |
793 | (define (add-edges service edges) | |
794 | (define (add-edge extension edges) | |
795 | (let ((target-type (service-extension-target extension))) | |
796 | (match (filter (lambda (service) | |
797 | (eq? (service-kind service) target-type)) | |
798 | services) | |
799 | ((target) | |
800 | (vhash-consq target service edges)) | |
801 | (() | |
d466b1fc | 802 | (missing-target-error service target-type)) |
0adfe95a LC |
803 | (x |
804 | (raise | |
805 | (condition (&ambiguous-target-service-error | |
806 | (service service) | |
807 | (target-type target-type)) | |
808 | (&message | |
809 | (message | |
810 | (format #f | |
69daee23 | 811 | (G_ "more than one target service of type '~a'") |
0adfe95a LC |
812 | (service-type-name target-type)))))))))) |
813 | ||
814 | (fold add-edge edges (service-type-extensions (service-kind service)))) | |
815 | ||
816 | (let ((edges (fold add-edges vlist-null services))) | |
817 | (lambda (node) | |
818 | (reverse (vhash-foldq* cons '() node edges))))) | |
819 | ||
d466b1fc LC |
820 | (define (instantiate-missing-services services) |
821 | "Return SERVICES, a list, augmented with any services targeted by extensions | |
822 | and missing from SERVICES. Only service types with a default value can be | |
823 | instantiated; other missing services lead to a | |
824 | '&missing-target-service-error'." | |
825 | (define (adjust-service-list svc result instances) | |
826 | (fold2 (lambda (extension result instances) | |
827 | (define target-type | |
828 | (service-extension-target extension)) | |
829 | ||
830 | (match (vhash-assq target-type instances) | |
831 | (#f | |
832 | (let ((default (service-type-default-value target-type))) | |
833 | (if (eq? &no-default-value default) | |
834 | (missing-target-error svc target-type) | |
835 | (let ((new (service target-type))) | |
836 | (values (cons new result) | |
837 | (vhash-consq target-type new instances)))))) | |
838 | (_ | |
839 | (values result instances)))) | |
840 | result | |
841 | instances | |
842 | (service-type-extensions (service-kind svc)))) | |
843 | ||
9b6c4355 LC |
844 | (let loop ((services services)) |
845 | (define instances | |
846 | (fold (lambda (service result) | |
847 | (vhash-consq (service-kind service) service | |
848 | result)) | |
849 | vlist-null services)) | |
850 | ||
851 | (define adjusted | |
852 | (fold2 adjust-service-list | |
853 | services instances | |
854 | services)) | |
855 | ||
856 | ;; If we instantiated services, they might in turn depend on missing | |
857 | ;; services. Loop until we've reached fixed point. | |
858 | (if (= (length adjusted) (vlist-length instances)) | |
859 | adjusted | |
860 | (loop adjusted)))) | |
d466b1fc | 861 | |
d62e201c LC |
862 | (define* (fold-services services |
863 | #:key (target-type system-service-type)) | |
0adfe95a LC |
864 | "Fold SERVICES by propagating their extensions down to the root of type |
865 | TARGET-TYPE; return the root service adjusted accordingly." | |
866 | (define dependents | |
867 | (service-back-edges services)) | |
868 | ||
869 | (define (matching-extension target) | |
870 | (let ((target (service-kind target))) | |
871 | (match-lambda | |
872 | (($ <service-extension> type) | |
873 | (eq? type target))))) | |
874 | ||
875 | (define (apply-extension target) | |
876 | (lambda (service) | |
877 | (match (find (matching-extension target) | |
878 | (service-type-extensions (service-kind service))) | |
879 | (($ <service-extension> _ compute) | |
efe7d19a | 880 | (compute (service-value service)))))) |
0adfe95a LC |
881 | |
882 | (match (filter (lambda (service) | |
883 | (eq? (service-kind service) target-type)) | |
884 | services) | |
885 | ((sink) | |
2a4309de LC |
886 | ;; Use the state monad to keep track of already-visited services in the |
887 | ;; graph and to memoize their value once folded. | |
888 | (run-with-state | |
889 | (let loop ((sink sink)) | |
890 | (mlet %state-monad ((visited (current-state))) | |
891 | (match (vhash-assq sink visited) | |
892 | (#f | |
893 | (mlet* %state-monad | |
894 | ((dependents (mapm %state-monad loop (dependents sink))) | |
895 | (visited (current-state)) | |
896 | (extensions -> (map (apply-extension sink) dependents)) | |
897 | (extend -> (service-type-extend (service-kind sink))) | |
898 | (compose -> (service-type-compose (service-kind sink))) | |
899 | (params -> (service-value sink)) | |
900 | (service | |
901 | -> | |
902 | ;; Distinguish COMPOSE and EXTEND because PARAMS typically | |
903 | ;; has a different type than the elements of EXTENSIONS. | |
904 | (if extend | |
905 | (service (service-kind sink) | |
906 | (extend params (compose extensions))) | |
907 | sink))) | |
908 | (mbegin %state-monad | |
909 | (set-current-state (vhash-consq sink service visited)) | |
910 | (return service)))) | |
911 | ((_ . service) ;SINK was already visited | |
912 | (return service))))) | |
913 | vlist-null)) | |
0adfe95a LC |
914 | (() |
915 | (raise | |
916 | (condition (&missing-target-service-error | |
917 | (service #f) | |
918 | (target-type target-type)) | |
919 | (&message | |
69daee23 | 920 | (message (format #f (G_ "service of type '~a' not found") |
0adfe95a LC |
921 | (service-type-name target-type))))))) |
922 | (x | |
923 | (raise | |
924 | (condition (&ambiguous-target-service-error | |
925 | (service #f) | |
926 | (target-type target-type)) | |
927 | (&message | |
928 | (message | |
929 | (format #f | |
69daee23 | 930 | (G_ "more than one target service of type '~a'") |
0adfe95a | 931 | (service-type-name target-type))))))))) |
db4fdc04 LC |
932 | |
933 | ;;; services.scm ends here. |