test: Split-up Mescc scaffold test.
[mes.git] / guile / guix / make.scm
1 ;;; -*-scheme-*-
2
3 ;;; Mes --- Maxwell Equations of Software
4 ;;; Copyright © 2017 Jan Nieuwenhuizen <janneke@gnu.org>
5 ;;;
6 ;;; This file is part of Mes.
7 ;;;
8 ;;; Mes is free software; you can redistribute it and/or modify it
9 ;;; under the terms of the GNU General Public License as published by
10 ;;; the Free Software Foundation; either version 3 of the License, or (at
11 ;;; your option) any later version.
12 ;;;
13 ;;; Mes is distributed in the hope that it will be useful, but
14 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 ;;; GNU General Public License for more details.
17 ;;;
18 ;;; You should have received a copy of the GNU General Public License
19 ;;; along with Mes.  If not, see <http://www.gnu.org/licenses/>.
20
21 ;;; Commentary:
22
23 ;;; make
24
25 ;;; Code:
26
27 (define-module (guix make)
28   #:use-module (ice-9 curried-definitions)
29   #:use-module (ice-9 format)
30   #:use-module (ice-9 optargs)
31   #:use-module (ice-9 popen)
32   #:use-module (ice-9 pretty-print)
33   #:use-module (ice-9 rdelim)
34   #:use-module (ice-9 receive)
35
36   #:use-module (srfi srfi-1)
37   #:use-module (srfi srfi-26)
38
39   #:use-module (guix records)
40   #:use-module (guix shell-utils)
41
42   #:export (build
43             check
44             clean
45             group
46             target-prefix?
47             check-target?
48
49             cpp.mescc
50             compile.mescc
51             ld
52
53             bin.mescc
54             bin.gcc
55             snarf
56
57             libc-mes.E
58             mini-libc-mes.E
59             add-target
60             get-target
61
62             system**
63             target-file-name
64
65             target
66             %targets
67             %status))
68
69 (define %status 0)
70 (define %targets '())
71 (define %store-dir ".store")
72 (mkdir-p %store-dir)
73 (define %command-log (open-output-file "script"))
74
75 (define (base-name file-name suffix)
76   (string-drop-right file-name (string-length suffix)))
77
78 (define (system** . command)
79   (format %command-log "~a\n" (string-join command " "))
80   (apply system* command))
81
82 (define (gulp-pipe* . command)
83   (let* ((port (apply open-pipe* (cons OPEN_READ command)))
84          (foo (set-port-encoding! port "ISO-8859-1"))
85          (output (read-string port))
86          (status (close-pipe port)))
87     (format %command-log "~a\n" (string-join command " "))
88     (values output status)))
89
90 (define (assert-gulp-pipe* . command)
91   (receive (output status)
92       (apply gulp-pipe* command)
93     (if (zero? status) (string-trim-right output #\newline)
94         (error (format #f "pipe failed: ~d ~s"
95                        (or (status:exit-val status)
96                            (status:term-sig status)) command)))))
97
98 (define-record-type* <method>
99   method make-method
100   method?
101   (name       method-name)
102   (build      method-build (default (lambda _ #t)))
103   (inputs     method-inputs (default (list))))
104
105 (define-record-type* <target>
106   target make-target
107   target?
108   (file-name  target-file-name (default #f))       ; string
109   (file-names target-file-names (default '()))     ; (string)
110   (hash       target-hash (default #f))            ; string
111   (method     target-method (default method-file)) ; <method>
112   (inputs     target-inputs (default (list)))      ; list
113                                                    ; For check targets
114   (exit       target-exit (default #f))            ; number
115   (signal     target-signal (default #f)))         ; number
116
117 (define method-file (method (name "FILE")))
118 (define method-check
119   (method (name "CHECK")
120           (build (lambda (o t)
121                    (let* ((inputs (target-inputs t))
122                           (file-name (target-file-name (build (car inputs))))
123                           (run file-name)
124                           (exit (target-exit t))
125                           (signal (target-signal t))
126                           (log (string-append file-name "-check.log")))
127                      (format (current-error-port) "  CHECK\t~a" (basename file-name))
128                      (receive (output result)
129                          ;; FIXME: quiet MES tests are not fun
130                          (if (string-prefix? "tests/" run) (values #f (system** run))
131                              (gulp-pipe* run))
132                        (let ((status (if (string? result) 0
133                                          (or (status:term-sig result) (status:exit-val result)))))
134                          (if (not (string-null? output)) (with-output-to-file log (lambda _ (display output))))
135                          (store #:add-file log)
136                          (format (current-error-port) "\t[~a]\n"
137                                  (if (or (and signal (= status signal))
138                                          (and exit (= status exit))) "OK"
139                                          (begin (set! %status 1) "FAIL"))))))))))
140
141 (define (hash-target o)
142   (let ((inputs (target-inputs o)))
143     (if (null? inputs) (or (target-hash o) (target-hash (store #:add o)))
144         (let ((input-shas (map hash-target inputs)))
145           (and (every identity input-shas)
146                (let ((method (target-method o)))
147                  (string-hash (format #f "~s" (cons* (target-file-name o)
148                                                      (method-build method)
149                                                      (map target-hash (method-inputs method))
150                                                      input-shas)))))))))
151
152 (define (string-hash o)
153   (number->string (hash o (expt 2 63))))
154
155 (define (file-hash o)
156   (string-hash (with-input-from-file o read-string)))
157
158 (define (store-file-name o)
159   (string-append %store-dir "/" (if (string? o) o
160                                     (target-hash o))))
161
162 (define (assert-link existing-file new-file)
163   (if (not (file-exists? new-file)) (link existing-file new-file)))
164
165 (define store
166   (let ((*store* '()))
167     (define (prune? o)
168       (let ((t (cdr o)))
169         (pair? (target-inputs t))))
170     (define ((file-name? file-name) o)
171       (let ((t (cdr o)))
172         (equal? (target-file-name t) (target-file-name file-name))))
173     (lambda* (#:key add add-file delete get key print prune)
174       (cond ((and add key) (let ((value (target (inherit add) (hash key))))
175                              (set! *store* (assoc-set! (filter (negate (file-name? add)) *store*) key value))
176                              (let ((file-name (target-file-name value)))
177                                (if (and file-name (file-exists? file-name))
178                                    (assert-link file-name (store-file-name value))))
179                              value))
180             (add (let ((key (if (null? (target-inputs add)) (file-hash (target-file-name add))
181                                 (hash-target add))))
182                    (if (not key) (error "store: no hash for:" add))
183                    (store #:add add #:key key)))
184             (add-file (and (file-exists? add-file)
185                            (store #:add (target (file-name add-file)))))
186             ((and get key)
187              (or (assoc-ref *store* key)
188                  (let ((store-file (store-file-name key))
189                        (file-name (target-file-name get)))
190                    (and (file-exists? store-file)
191                         (if (file-exists? file-name) (delete-file file-name))
192                         (link store-file file-name)
193                         (store #:add get #:key key)))))
194             (get (assoc-ref *store* get))
195             (delete (and (assoc-ref *store* delete)
196                          (set! *store* (filter (lambda (e) (not (equal? (car e) delete))) *store*))))
197             (print (pretty-print (map (lambda (e) (cons (target-file-name (cdr e)) (car e))) *store*)))
198             ((eq? prune 'file-system)
199              (set! *store* (filter prune? *store*)))
200             (else (error "store: dunno"))))))
201
202 (define (build o)
203   (let ((hash (hash-target o)))
204     (or (and hash (store #:get o #:key hash))
205         (begin
206           ;;(format (current-error-port) "must rebuild hash=~s\n" hash)
207           (for-each build (target-inputs o))
208           (let ((method (target-method o)))
209             ((method-build method) method o))
210           (store #:add o #:key hash)))))
211
212 (define* (check name #:key (exit 0) (signal #f) (dependencies '()))
213   (target (file-name (string-append "check-" name))
214           (method method-check)
215           (inputs (cons (get-target name) dependencies))
216           (exit exit)
217           (signal signal)))
218
219 (define* (group name #:key (dependencies '()))
220   (target (file-name name)
221           (inputs (map get-target dependencies))))
222
223 (define (target->input-files o)
224   (let ((inputs (target-inputs o)))
225     (if (null? inputs) '()
226         (append (cons (target-file-name o) (target-file-names o)) (append-map target->input-files inputs)))))
227
228 (define* (clean #:optional targets)
229   (for-each
230    delete-file
231    (filter file-exists? (delete-duplicates (append-map (cut target->input-files <>) (or targets %targets))))))
232
233 (define (tree o)
234   (let ((inputs (target-inputs o)))
235     (if (null? inputs) o
236         (cons o (append (map tree inputs) (map tree (method-inputs (target-method o))))))))
237
238
239 (define (verbose fmt . o)
240   ;;(apply format (cons* (current-error-port) fmt o))
241   #t
242   )
243
244 (define (PATH-search-path name)
245   (or (search-path (string-split (getenv "PATH") #\:) name)
246       (and (format (current-error-port) "warning: not found: ~a\n" name)
247            name)))
248
249 (define %CC (PATH-search-path "gcc"))
250 (define %CC32 (PATH-search-path "i686-unknown-linux-gnu-gcc"))
251 (define %C-FLAGS
252   '("--std=gnu99"
253     "-O0"
254     "-g"
255     "-D"
256     "POSIX=1"
257     "-I" "src"
258     "-I" "mlibc/include"
259     "--include=mlibc/libc-gcc.c"
260     ))
261 (define %C32-FLAGS
262   '("--std=gnu99"
263     "-O0"
264     "-g"
265     "-I" "src"
266     "-I" "mlibc/include"
267     "--include=mlibc/libc-gcc.c"
268     ))
269
270 (define* (CC.gcc #:key (libc #t) (cc (if libc %CC %CC32)) (c-flags (if libc %C-FLAGS %C32-FLAGS)) (defines '()))
271   (method (name "CC.gcc")
272           (build (lambda (o t)
273                    (let* ((input-files (map target-file-name (target-inputs t)))
274                           (command `(,cc
275                                      "-c"
276                                      ,@(append-map (cut list "-D" <>) defines)
277                                      ,@(if libc '() '("-nostdinc" "-fno-builtin"))
278                                      ,@c-flags
279                                      "-o" ,(target-file-name t)
280                                      ,@input-files)))
281                      (format (current-error-port) "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
282                      (unless (zero? (apply system** command))
283                        (format (current-error-port) "FAILED:~s\n" command)
284                        (exit 1)))))
285           (inputs (list (store #:add-file "mlibc/libc-gcc.c"))))) ;; FIXME: FLAGS
286
287 (define* (CPP.mescc #:key (cc %MESCC) (defines '()))
288   (method (name "CPP.mescc")
289           (build (lambda (o t)
290                    (let ((input-files (map target-file-name (target-inputs t))))
291                      (format #t "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
292                      (apply system**
293                             `(,cc
294                               "-E"
295                               ,@(append-map (cut list "-D" <>) defines)
296                               "-o" ,(target-file-name t)
297                               ,@input-files)))))))
298
299 (define %MESCC "guile/mescc.scm")
300 (define* (CC.mescc #:key (cc %MESCC))
301   (method (name "CC.mescc")
302           (build (lambda (o t)
303                    (let ((input-files (map target-file-name (target-inputs t))))
304                      (format #t "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
305                      (apply system**
306                             `("guile/mescc.scm" "-c"
307                               "-o" ,(target-file-name t)
308                               ,@input-files)))))
309           (inputs (list (store #:add-file "guile/language/c99/compiler.go")
310                         (store #:add-file "guile/mes/as.go")
311                         (store #:add-file "guile/mes/as-i386.go")
312                         (store #:add-file "guile/mes/M1.go")))))
313
314 (define %M1 (PATH-search-path "M1"))
315 (define %M1-FLAGS
316   '("--LittleEndian"
317     "--Architecture=1"
318     ;;"--BaseAddress=0x1000000"
319     ))
320 (define* (M1.asm #:key (m1 %M1) (m1-flags %M1-FLAGS))
321   (method (name "M1")
322           (build (lambda (o t)
323                    (let* ((input-files (map target-file-name (target-inputs t)))
324                           (input-files (filter (lambda (f) (string-suffix? "M1" f))
325                                                input-files)))
326                      (format #t "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
327                      (with-output-to-file (target-file-name t)
328                        (lambda _
329                          (display
330                           (apply assert-gulp-pipe*
331                                  `(,m1
332                                    "-f"
333                                    "stage0/x86.M1"
334                                    ,@(append-map (cut list "-f" <>) input-files)
335                                    ,@m1-flags)))
336                          (newline))))))
337           (inputs (list (store #:add-file "stage0/x86.M1")))))
338
339 (define %HEX2-FLAGS
340   '("--LittleEndian"
341     "--Architecture=1"
342     "--BaseAddress=0x1000000"))
343 (define %HEX2 (PATH-search-path "hex2"))
344
345 (define* (LINK.hex2 #:key (hex2 %HEX2) (hex2-flags %HEX2-FLAGS) debug?)
346   (method (name "LINK.hex2")
347           (build (lambda (o t)
348                    (let* ((input-files (map target-file-name (target-inputs t)))
349                           ;; FIXME: snarf inputs
350                           (input-files (filter (lambda (f) (string-suffix? "hex2" f))
351                                                input-files)))
352                      (format #t "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
353                      (with-output-to-file (target-file-name t)
354                        (lambda _
355                          (set-port-encoding! (current-output-port) "ISO-8859-1")
356                          (display
357                           (apply assert-gulp-pipe*
358                                  `(,hex2
359                                    ,@hex2-flags
360                                    "-f"
361                                    ,(if (not debug?) "stage0/elf32-0header.hex2"
362                                         "stage0/elf32-header.hex2")
363                                    ,@(append-map (cut list "-f" <>) input-files)
364                                    "-f"
365                                    ,(if (not debug?) "stage0/elf-0footer.hex2"
366                                         "stage0/elf32-footer-single-main.hex2"))))))
367                      (chmod (target-file-name t) #o755))))
368           (inputs (list (store #:add-file "stage0/elf32-0header.hex2")
369                         (store #:add-file "stage0/elf-0footer.hex2")))))
370
371 (define* (LINK.gcc #:key (cc %CC) (c-flags %C-FLAGS) (libc #t))
372   (method (name "LINK.gcc")
373           (build (lambda (o t)
374                    (let* ((input-files (map target-file-name (target-inputs t)))
375                           (command `(,cc
376                                      ,@c-flags
377                                      ,@(if libc '() '("-nostdlib"))
378                                      "-o"
379                                      ,(target-file-name t)
380                                      ,@input-files)))
381                      (format #t "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
382                      (unless (zero? (apply system** command))
383                        (format (current-error-port) "FAILED:~s\n" command)
384                        (exit 1)))))))
385
386 (define SNARF "build-aux/mes-snarf.scm")
387 (define (SNARF.mes mes?)
388   (method (name "SNARF.mes")
389           (build (lambda (o t)
390                    (let* ((input-files (map target-file-name (target-inputs t)))
391                           (command `(,SNARF
392                                      ,@(if mes? '("--mes") '())
393                                      ,@input-files)))
394                      (format #t "  ~a\t ~a -> ~a\n" (method-name o) (string-join input-files) (target-file-name t))
395                      (unless (zero? (apply system** command))
396                        (format (current-error-port) "FAILED:~s\n" command)
397                        (exit 1)))))))
398
399 (define* (cpp.mescc input-file-name #:key (cc %MESCC) (defines '()))
400   (let* ((c-target (target (file-name input-file-name)))
401          (base-name (base-name input-file-name ".c"))
402          (suffix ".E")
403          (target-file-name (string-append base-name suffix)))
404     (target (file-name target-file-name)
405             (inputs (list c-target))
406             (method (CPP.mescc #:cc cc #:defines defines)))))
407
408 (define mini-libc-mes.E (cpp.mescc "mlibc/mini-libc-mes.c"))
409 (define libc-mes.E (cpp.mescc "mlibc/libc-mes.c"))
410
411 (define* (compile.gcc input-file-name #:key (libc #t) (cc (if libc %CC %CC32)) (defines '()))
412   (let* ((base-name (base-name input-file-name ".c"))
413          (cross (if libc "" "mlibc-"))
414          (suffix (string-append "." cross "o"))
415          (target-file-name (string-append base-name suffix))
416          (c-target (target (file-name input-file-name))))
417     (target (file-name target-file-name)
418             (inputs (list c-target))
419             (method (CC.gcc #:cc cc #:libc libc #:defines defines)))))
420
421 (define* (compile.mescc input-file-name #:key (cc %CC) (libc libc-mes.E) (defines '()))
422   (let* ((base-name (base-name input-file-name ".c"))
423          ;;(foo (format (current-error-port) "COMPILE[~s .c] base=~s\n" input-file-name base-name))
424          (suffix (cond ((not libc) ".0-M1")
425                        ((eq? libc libc-mes.E) ".M1")
426                        (else ".mini-M1")))
427          (target-file-name (string-append base-name suffix))
428          (E-target (cpp.mescc input-file-name #:cc cc #:defines defines)))
429     (target (file-name target-file-name)
430             (inputs `(,@(if libc (list libc) '()) ,E-target))
431             (method (CC.mescc #:cc cc)))))
432
433 (define* (m1-asm input-file-name #:key (cc %MESCC) (m1 %M1) (libc libc-mes.E) (defines '()))
434   (let* ((base-name (base-name input-file-name ".c"))
435          ;;(foo (format (current-error-port) "m1-asm[~s .m1] base=~s\n" input-file-name base-name))
436          (suffix (cond ((not libc) ".0-hex2")
437                        ((eq? libc libc-mes.E) ".hex2")
438                        (else ".mini-hex2")))
439          (target-file-name (string-append base-name suffix))
440          (m1-target (compile.mescc input-file-name #:cc cc #:libc libc #:defines defines))
441          (libc.m1 (cond ((eq? libc libc-mes.E)
442                          (compile.mescc "mlibc/libc-mes.c" #:libc #f #:defines defines))
443                         ((eq? libc mini-libc-mes.E)
444                          (compile.mescc "mlibc/mini-libc-mes.c" #:libc #f #:defines defines))
445                         (else #f))))
446     (target (file-name target-file-name)
447             ;;(inputs `(,@(if libc (list libc.m1) '()) ,m1-target))
448             (inputs `(,m1-target))
449             (method (M1.asm #:m1 m1)))))
450
451 (define* (bin.mescc input-file-name #:key (cc %MESCC) (hex2 %HEX2) (m1 %M1) (libc libc-mes.E) (dependencies '()) (defines '()))
452   (let* ((base-name (base-name input-file-name ".c"))
453          ;;(foo (format (current-error-port) "bin[~s .c] base=~s\n" input-file-name base-name))
454          (suffix (cond ((not libc) ".0-guile")
455                        ((eq? libc libc-mes.E) ".guile")
456                        (else ".mini-guile")))
457          (target-file-name (string-append base-name suffix))
458          (hex2-target (m1-asm input-file-name #:m1 m1 #:cc cc #:libc libc #:defines defines)))
459     (target (file-name target-file-name)
460             (inputs (cons hex2-target dependencies))
461             (method (LINK.hex2 #:hex2 hex2 #:debug? (eq? libc libc-mes.E))))))
462
463 (define* (bin.gcc input-file-name #:key (libc #t) (cc (if libc %CC %CC32)) (dependencies '()) (defines '()))
464   (let* ((base-name (base-name input-file-name ".c"))
465          (suffix (if libc ".gcc" ".mlibc-gcc"))
466          (target-file-name (string-append base-name suffix))
467          (o-target (compile.gcc input-file-name #:cc cc #:libc libc #:defines defines)))
468     (target (file-name target-file-name)
469             (inputs (list o-target))
470             (method (LINK.gcc #:cc cc #:libc libc)))))
471
472 (define* (snarf input-file-name #:key (dependencies '()) (mes? #t))
473   (let* ((base-name (base-name input-file-name ".c"))
474          (suffixes '(".h" ".i" ".environment.i" ".symbol-names.i" ".symbols.i"  ".symbols.h"))
475          (suffixes (if mes? (map (cut string-append ".mes" <>) suffixes) suffixes))
476          (target-file-names (map (cut string-append base-name <>) suffixes))
477          (snarf-target (target (file-name input-file-name))))
478     (target (file-name (car target-file-names))
479             (file-names (cdr target-file-names))
480             (inputs (cons snarf-target dependencies))
481             ;;(inputs (list snarf-target))
482             (method (SNARF.mes mes?)))))
483
484 (define ((target-prefix? prefix) o)
485   (string-prefix? prefix (target-file-name o)))
486
487 (define (check-target? o)
488   ((target-prefix? "check-") o))
489
490 (define (add-target o)
491   (set! %targets (append %targets (list o)))
492   o)
493 (define (get-target o)
494   (if (target? o) o
495       (find (lambda (t) (equal? (target-file-name t) o)) %targets)))