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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2012, 2013, 2015, 2016, 2017, 2018 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 (guix scripts gc)
#:use-module (guix ui)
#:use-module (guix scripts)
#:use-module (guix store)
#:autoload (guix build syscalls) (free-disk-space)
#:use-module (ice-9 match)
#:use-module (ice-9 regex)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-11)
#:use-module (srfi srfi-26)
#:use-module (srfi srfi-37)
#:export (guix-gc))
;;;
;;; Command-line options.
;;;
(define %default-options
;; Alist of default option values.
`((action . collect-garbage)))
(define (show-help)
(display (G_ "Usage: guix gc [OPTION]... PATHS...
Invoke the garbage collector.\n"))
(display (G_ "
-C, --collect-garbage[=MIN]
collect at least MIN bytes of garbage"))
(display (G_ "
-F, --free-space=FREE attempt to reach FREE available space in the store"))
(display (G_ "
-d, --delete attempt to delete PATHS"))
(display (G_ "
--optimize optimize the store by deduplicating identical files"))
(display (G_ "
--list-dead list dead paths"))
(display (G_ "
--list-live list live paths"))
(newline)
(display (G_ "
--references list the references of PATHS"))
(display (G_ "
-R, --requisites list the requisites of PATHS"))
(display (G_ "
--referrers list the referrers of PATHS"))
(display (G_ "
--derivers list the derivers of PATHS"))
(newline)
(display (G_ "
--verify[=OPTS] verify the integrity of the store; OPTS is a
comma-separated combination of 'repair' and
'contents'"))
(display (G_ "
--list-failures list cached build failures"))
(display (G_ "
--clear-failures remove PATHS from the set of cached failures"))
(newline)
(display (G_ "
-h, --help display this help and exit"))
(display (G_ "
-V, --version display version information and exit"))
(newline)
(show-bug-report-information))
(define argument->verify-options
(let ((not-comma (char-set-complement (char-set #\,)))
(validate (lambda (option)
(unless (memq option '(repair contents))
(leave (G_ "~a: invalid '--verify' option~%")
option)))))
(lambda (arg)
"Turn ARG into a list of symbols denoting '--verify' options."
(if arg
(let ((lst (map string->symbol
(string-tokenize arg not-comma))))
(for-each validate lst)
lst)
'()))))
(define %options
;; Specification of the command-line options.
(list (option '(#\h "help") #f #f
(lambda args
(show-help)
(exit 0)))
(option '(#\V "version") #f #f
(lambda args
(show-version-and-exit "guix gc")))
(option '(#\C "collect-garbage") #f #t
(lambda (opt name arg result)
(let ((result (alist-cons 'action 'collect-garbage
(alist-delete 'action result))))
(match arg
((? string?)
(let ((amount (size->number arg)))
(if arg
(alist-cons 'min-freed amount result)
(leave (G_ "invalid amount of storage: ~a~%")
arg))))
(#f result)))))
(option '(#\F "free-space") #t #f
(lambda (opt name arg result)
(alist-cons 'free-space (size->number arg) result)))
(option '(#\d "delete") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'delete
(alist-delete 'action result))))
(option '("optimize") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'optimize
(alist-delete 'action result))))
(option '("verify") #f #t
(lambda (opt name arg result)
(let ((options (argument->verify-options arg)))
(alist-cons 'action 'verify
(alist-cons 'verify-options options
(alist-delete 'action
result))))))
(option '("list-dead") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-dead
(alist-delete 'action result))))
(option '("list-live") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-live
(alist-delete 'action result))))
(option '("references") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-references
(alist-delete 'action result))))
(option '(#\R "requisites") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-requisites
(alist-delete 'action result))))
(option '("referrers") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-referrers
(alist-delete 'action result))))
(option '("derivers") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-derivers
(alist-delete 'action result))))
(option '("list-failures") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'list-failures
(alist-delete 'action result))))
(option '("clear-failures") #f #f
(lambda (opt name arg result)
(alist-cons 'action 'clear-failures
(alist-delete 'action result))))))
;;;
;;; Entry point.
;;;
(define (guix-gc . args)
(define (parse-options)
;; Return the alist of option values.
(parse-command-line args %options (list %default-options)
#:build-options? #f))
(define (symlink-target file)
(let ((s (false-if-exception (lstat file))))
(if (and s (eq? 'symlink (stat:type s)))
(symlink-target (readlink file))
file)))
(define (store-directory file)
;; Return the store directory that holds FILE if it's in the store,
;; otherwise return FILE.
(or (and=> (string-match (string-append "^" (regexp-quote (%store-prefix))
"/([^/]+)")
file)
(compose (cut string-append (%store-prefix) "/" <>)
(cut match:substring <> 1)))
file))
(define (ensure-free-space store space)
;; Attempt to have at least SPACE bytes available in STORE.
(let ((free (free-disk-space (%store-prefix))))
(if (> free space)
(info (G_ "already ~h bytes available on ~a, nothing to do~%")
free (%store-prefix))
(let ((to-free (- space free)))
(info (G_ "freeing ~h bytes~%") to-free)
(collect-garbage store to-free)))))
(with-error-handling
(let* ((opts (parse-options))
(store (open-connection))
(paths (filter-map (match-lambda
(('argument . arg) arg)
(_ #f))
opts)))
(define (assert-no-extra-arguments)
(unless (null? paths)
(leave (G_ "extraneous arguments: ~{~a ~}~%") paths)))
(define (list-relatives relatives)
(for-each (compose (lambda (path)
(for-each (cut simple-format #t "~a~%" <>)
(relatives store path)))
store-directory
symlink-target)
paths))
(case (assoc-ref opts 'action)
((collect-garbage)
(assert-no-extra-arguments)
(let ((min-freed (assoc-ref opts 'min-freed))
(free-space (assoc-ref opts 'free-space)))
(cond
(free-space
(ensure-free-space store free-space))
(min-freed
(let-values (((paths freed) (collect-garbage store min-freed)))
(info (G_ "freed ~h bytes~%") freed)))
(else
(let-values (((paths freed) (collect-garbage store)))
(info (G_ "freed ~h bytes~%") freed))))))
((delete)
(delete-paths store (map direct-store-path paths)))
((list-references)
(list-relatives references))
((list-requisites)
(list-relatives (lambda (store item)
(requisites store (list item)))))
((list-referrers)
(list-relatives referrers))
((list-derivers)
(list-relatives valid-derivers))
((optimize)
(assert-no-extra-arguments)
(optimize-store store))
((verify)
(assert-no-extra-arguments)
(let ((options (assoc-ref opts 'verify-options)))
(exit
(verify-store store
#:check-contents? (memq 'contents options)
#:repair? (memq 'repair options)))))
((list-failures)
(for-each (cut simple-format #t "~a~%" <>)
(query-failed-paths store)))
((clear-failures)
(clear-failed-paths store (map direct-store-path paths)))
((list-dead)
(for-each (cut simple-format #t "~a~%" <>)
(dead-paths store)))
((list-live)
(for-each (cut simple-format #t "~a~%" <>)
(live-paths store)))))))
|