Abstracted predefined routine invocation, it is now more straightforward.
[sixpic.git] / code-generation.scm
blob737476a005f748b61651bdf4fac2c1017b94163c
1 ;; address after which memory is allocated by the user, therefore not used for
2 ;; register allocation
3 ;; in programs, located in the SIXPIC_MEMORY_DIVIDE variable
4 (define memory-divide #f)
6 (define (interference-graph cfg)
8   (define all-live '())
10   (define (interfere x y)
11     (if (not (memq x (byte-cell-interferes-with y)))
12         (begin
13           (byte-cell-interferes-with-set!
14            x
15            (cons y (byte-cell-interferes-with x)))
16           (byte-cell-interferes-with-set!
17            y
18            (cons x (byte-cell-interferes-with y))))))
20   (define (interfere-pairwise live)
21     (set! all-live (union all-live live))
22     (for-each (lambda (x)
23                 (for-each (lambda (y)
24                             (if (not (eq? x y))
25                                 (interfere x y)))
26                           live))
27               live))
29   (define (instr-interference-graph instr)
30     (let ((dst (instr-dst instr)))
31       (if (byte-cell? dst)
32           (let ((src1 (instr-src1 instr))
33                 (src2 (instr-src2 instr)))
34             (if (byte-cell? src1)
35                 (begin
36                   (byte-cell-coalesceable-with-set!
37                    dst
38                    (union (byte-cell-coalesceable-with dst)
39                           (list src1)))
40                   (byte-cell-coalesceable-with-set!
41                    src1
42                    (union (byte-cell-coalesceable-with src1)
43                           (list dst)))))
44             (if (byte-cell? src2)
45                 (begin
46                   (byte-cell-coalesceable-with-set!
47                    dst
48                    (union (byte-cell-coalesceable-with dst)
49                           (list src2)))
50                   (byte-cell-coalesceable-with-set!
51                    src2
52                    (union (byte-cell-coalesceable-with src2)
53                           (list dst))))))))
54     (let ((live-before (instr-live-before instr)))
55       (interfere-pairwise live-before)))
57   (define (bb-interference-graph bb)
58     (for-each instr-interference-graph (bb-rev-instrs bb)))
60   (analyze-liveness cfg)
62   (for-each bb-interference-graph (cfg-bbs cfg))
64   all-live)
66 (define (allocate-registers cfg)
67   (let ((all-live (interference-graph cfg)))
69     (define (color byte-cell)
70       (let ((coalesce-candidates ; TODO right now, no coalescing is done
71              (keep byte-cell-adr
72                    (diff (byte-cell-coalesceable-with byte-cell)
73                          (byte-cell-interferes-with byte-cell)))))
74         '
75         (pp (list byte-cell: byte-cell;;;;;;;;;;;;;;;
76                   coalesce-candidates
77 ;                  interferes-with: (byte-cell-interferes-with byte-cell)
78 ;                  coalesceable-with: (byte-cell-coalesceable-with byte-cell)
79                   ))
81         (if #f #;(not (null? coalesce-candidates))
82             (let ((adr (byte-cell-adr (car coalesce-candidates))))
83               (byte-cell-adr-set! byte-cell adr))
84             (let ((neighbours (byte-cell-interferes-with byte-cell)))
85               (let loop1 ((adr 0))
86                 (if (and memory-divide ; the user wants his own zone
87                          (>= adr memory-divide)) ; and we'd use it
88                     (error "register allocation would cross the memory divide") ;; TODO fallback ?
89                     (let loop2 ((lst neighbours))
90                       (if (null? lst)
91                           (byte-cell-adr-set! byte-cell adr)
92                           (let ((x (car lst)))
93                             (if (= adr (byte-cell-adr x))
94                                 (loop1 (+ adr 1))
95                                 (loop2 (cdr lst))))))))))))
97     (define (delete byte-cell1 neighbours)
98       (for-each (lambda (byte-cell2)
99                   (let ((lst (byte-cell-interferes-with byte-cell2)))
100                     (byte-cell-interferes-with-set!
101                      byte-cell2
102                      (remove byte-cell1 lst))))
103                 neighbours))
105     (define (undelete byte-cell1 neighbours)
106       (for-each (lambda (byte-cell2)
107                   (let ((lst (byte-cell-interferes-with byte-cell2)))
108                     (byte-cell-interferes-with-set!
109                      byte-cell2
110                      (cons byte-cell1 lst))))
111                 neighbours))
113     (define (find-min-neighbours graph)
114       (let loop ((lst graph) (m #f) (byte-cell #f))
115         (if (null? lst)
116             byte-cell
117             (let* ((x (car lst))
118                    (n (length (byte-cell-interferes-with x))))
119               (if (or (not m) (< n m))
120                   (loop (cdr lst) n x)
121                   (loop (cdr lst) m byte-cell))))))
123     (define (alloc-reg graph)
124       (if (not (null? graph))
125           (let* ((byte-cell (find-min-neighbours graph))
126                  (neighbours (byte-cell-interferes-with byte-cell)))
127             (let ((new-graph (remove byte-cell graph)))
128               (delete byte-cell neighbours)
129               (alloc-reg new-graph)
130               (undelete byte-cell neighbours))
131             (if (not (byte-cell-adr byte-cell))
132                 (color byte-cell)))))
134     (alloc-reg all-live)))
137 (define (linearize-and-cleanup cfg)
139   (define bbs-vector (cfg->vector cfg))
141   (define todo '())
143   (define (add-todo bb)
144     (set! todo (cons bb todo)))
146   (define rev-code '())
148   (define (emit instr)
149     (set! rev-code (cons instr rev-code)))
151   (define (movlw val)
152     (emit (list 'movlw val)))
153   (define (movwf adr)
154     (emit (list 'movwf adr)))
155   (define (movfw adr)
156     (emit (list 'movfw adr)))
157   (define (movff src dst)
158     (emit (list 'movff src dst)))
160   (define (clrf adr)
161     (emit (list 'clrf adr)))
162   (define (setf adr)
163     (emit (list 'setf adr)))
165   (define (incf adr)
166     (emit (list 'incf adr)))
167   (define (decf adr)
168     (emit (list 'decf adr)))
170   (define (addwf adr)
171     (emit (list 'addwf adr)))
172   (define (addwfc adr)
173     (emit (list 'addwfc adr)))
175   (define (subwf adr)
176     (emit (list 'subwf adr)))
177   (define (subwfb adr)
178     (emit (list 'subwfb adr)))
180   (define (mullw adr)
181     (emit (list 'mullw adr)))
182   (define (mulwf adr)
183     (emit (list 'mulwf adr)))
185   (define (andwf adr)
186     (emit (list 'andwf adr)))
187   (define (iorwf adr)
188     (emit (list 'iorwf adr)))
189   (define (xorwf adr)
190     (emit (list 'xorwf adr)))
192   (define (rlcf adr)
193     (emit (list 'rlcf adr)))
194   (define (rrcf adr)
195     (emit (list 'rrcf adr)))
197   (define (bcf adr bit)
198     (emit (list 'bcf adr bit)))
199   (define (bsf adr bit)
200     (emit (list 'bsf adr bit)))
201   (define (btf adr bit)
202     (emit (list 'btf adr bit)))
204   (define (comf adr)
205     (emit (list 'comf adr)))
206   
207   (define (cpfseq adr)
208     (emit (list 'cpfseq adr)))
209   (define (cpfslt adr)
210     (emit (list 'cpfslt adr)))
211   (define (cpfsgt adr)
212     (emit (list 'cpfsgt adr)))
214   (define (bra label)
215     (emit (list 'bra label)))
217   (define (rcall label)
218     (emit (list 'rcall label)))
220   (define (return)
221     (if (and #f (and (not (null? rev-code))
222                      (eq? (caar rev-code) 'rcall)))
223         (let ((label (cadar rev-code)))
224           (set! rev-code (cdr rev-code))
225           (bra label))
226         (emit (list 'return))))
228   (define (label lab)
229     (if (and #f (and (not (null? rev-code))
230              (eq? (caar rev-code) 'bra)
231              (eq? (cadar rev-code) lab)))
232         (begin
233           (set! rev-code (cdr rev-code))
234           (label lab))
235         (emit (list 'label lab))))
237   (define (sleep)
238     (emit (list 'sleep)))
239   
240   (define (move-reg src dst)
241     (cond ((= src dst))
242           ((= src WREG)
243            (movwf dst))
244           ((= dst WREG)
245            (movfw src))
246           (else
247 ;;         (movfw src)
248 ;;         (movwf dst)
249            ;; takes 2 cycles (as much as movfw src ; movwf dst), but takes
250            ;; only 1 instruction
251            (movff src dst))))
253   (define (bb-linearize bb)
254     (let ((label-num (bb-label-num bb)))
255       (let ((bb (vector-ref bbs-vector label-num)))
257         (define (move-lit n adr)
258           (cond ((= n 0)
259                  (clrf adr))
260                 ((= n #xff)
261                  (setf adr))
262                 (else
263                  (movlw n)
264                  (movwf adr))))
265         
266         (define (dump-instr instr)
267           (cond ((call-instr? instr)
268                  (let* ((def-proc (call-instr-def-proc instr))
269                         (entry (def-procedure-entry def-proc)))
270                    (if (bb? entry)
271                        (begin
272                          (add-todo entry)
273                          (let ((label (bb-label entry)))
274                            (rcall label)))
275                        (rcall entry))))
276                 ((return-instr? instr)
277                  (return))
278                 (else
279                  (let ((src1 (instr-src1 instr))
280                        (src2 (instr-src2 instr))
281                        (dst (instr-dst instr)))
282                    (if (and (or (not (byte-cell? dst))
283                                 (byte-cell-adr dst))
284                             (or (not (byte-cell? src1))
285                                 (byte-cell-adr src1))
286                             (or (not (byte-cell? src2))
287                                 (byte-cell-adr src2)))
289                        (case (instr-id instr)
290                          
291                          ((move)
292                           (if (byte-lit? src1)
293                               (let ((n (byte-lit-val src1))
294                                     (z (byte-cell-adr dst)))
295                                 (move-lit n z))
296                               (let ((x (byte-cell-adr src1))
297                                     (z (byte-cell-adr dst)))
298                                 (move-reg x z))))
299                          
300                          ((add addc sub subb)
301                           (if (byte-lit? src2)
302                               (let ((n (byte-lit-val src2))
303                                     (z (byte-cell-adr dst)))
304                                 (if (byte-lit? src1)
305                                     (move-lit (byte-lit-val src1) z)
306                                     (move-reg (byte-cell-adr src1) z))
307                                 (case (instr-id instr)
308                                   ((add)  (cond ((= n 1)    (incf z))
309                                                 ((= n #xff) (decf z))
310                                                 (else       (movlw n)
311                                                             (addwf z))))
312                                   ((addc) (movlw n) (addwfc z))
313                                   ((sub)  (cond ((= n 1)    (decf z))
314                                                 ((= n #xff) (incf z))
315                                                 (else       (movlw n)
316                                                             (subwf z))))
317                                   ((subb) (movlw n) (subwfb z))))
318                               (let ((x (byte-cell-adr src1))
319                                     (y (byte-cell-adr src2))
320                                     (z (byte-cell-adr dst)))
321                                 (cond ((and (not (= x y))
322                                             (= y z)
323                                             (memq (instr-id instr)
324                                                   '(add addc)))
325                                        ;; since this basically swaps the
326                                        ;; arguments, it can't be used for
327                                        ;; subtraction
328                                        (move-reg x WREG))
329                                       ((and (not (= x y))
330                                             (= y z))
331                                        ;; for subtraction, preserves argument
332                                        ;; order
333                                        (move-reg y WREG)
334                                        ;; this NEEDS to be done with movff, or
335                                        ;; else wreg will get clobbered and this
336                                        ;; won't work
337                                        (move-reg x z))
338                                       (else ;; TODO check if it could be merged with the previous case
339                                        (move-reg x z)
340                                        (move-reg y WREG)))
341                                 (case (instr-id instr)
342                                   ((add)  (addwf z))
343                                   ((addc) (addwfc z))
344                                   ((sub)  (subwf z))
345                                   ((subb) (subwfb z))
346                                   (else   (error "..."))))))
347                          
348                          ((mul) ; 8 by 8 multiplication
349                           (if (byte-lit? src2)
350                               ;; since multiplication is commutative, the
351                               ;; arguments are set up so the second one will
352                               ;; be a literal if the operator is applied on a
353                               ;; literal and a variable
354                               (let ((n (byte-lit-val src2)))
355                                 (if (byte-lit? src1)
356                                     (movlw   (byte-lit-val src1))
357                                     (movereg (byte-cell-adr src1) WREG))
358                                 ;; literal multiplication
359                                 (mullw n))
360                               (let ((x (byte-cell-adr src1))
361                                     (y (byte-cell-adr src2)))
362                                 (move-reg x WREG)
363                                 (mulwf y))))
364                          
365                          ((and ior xor)
366                           ;; no instructions for bitwise operations involving
367                           ;; literals exist on the PIC18
368                           (let ((x (if (byte-lit? src1)
369                                        (byte-lit-val src1)
370                                        (byte-cell-adr src1)))
371                                 (y (if (byte-lit? src2)
372                                        (byte-lit-val src2)
373                                        (byte-cell-adr src2)))
374                                 (z (byte-cell-adr dst)))
375                             (cond ((byte-lit? src1)
376                                    (if (byte-lit? src2)
377                                        (move-lit y z)
378                                        (move-reg y z))
379                                    (movlw x))
380                                   ((and (not (= x y)) (= y z))
381                                    (move-reg x WREG))
382                                   (else
383                                    (move-reg x z)
384                                    (move-reg y WREG)))
385                             (case (instr-id instr)
386                               ((and) (andwf z))
387                               ((ior) (iorwf z))
388                               ((xor) (xorwf z))
389                               (else (error "...")))))
391                          ((shl shr)
392                           (let ((x (if (byte-lit? src1)
393                                        (byte-lit-val src1)
394                                        (byte-cell-adr src1)))
395                                 (z (byte-cell-adr dst)))
396                             (cond ((byte-lit? src1) (move-lit x z))
397                                   ((not (= x z))    (move-reg x z)))
398                             (case (instr-id instr)
399                               ((shl) (rlcf z))
400                               ((shr) (rrcf z)))))
402                          ((set clear toggle)
403                           ;; bit operations
404                           (if (not (byte-lit? src2))
405                               (error "bit offset must be a literal"))
406                           (let ((x (byte-cell-adr src1))
407                                 (y (byte-lit-val src2)))
408                             (case (instr-id instr)
409                               ((set)    (bsf x y))
410                               ((clear)  (bcf x y))
411                               ((toggle) (btf x y)))))
413                          ((not)
414                           (let ((z (byte-cell-adr dst)))
415                             (if (byte-lit? src1)
416                                 (move-lit (byte-lit-val  src1) z)
417                                 (move-reg (byte-cell-adr src1) z))
418                             (comf z)))
419                          
420                          ((goto)
421                           (if (null? (bb-succs bb))
422                               (error "I think you might have given me an empty source file."))
423                           (let* ((succs (bb-succs bb))
424                                  (dest (car succs)))
425                             (bra (bb-label dest))
426                             (add-todo dest)))
427                          ((x==y x<y x>y)
428                           (let* ((succs (bb-succs bb))
429                                  (dest-true (car succs))
430                                  (dest-false (cadr succs)))
432                             (define (compare flip adr)
433                               (case (instr-id instr)
434                                 ((x<y) (if flip (cpfsgt adr) (cpfslt adr)))
435                                 ((x>y) (if flip (cpfslt adr) (cpfsgt adr)))
436                                 (else (cpfseq adr)))
437                               (bra (bb-label dest-false))
438                               (bra (bb-label dest-true))
439                               (add-todo dest-false)
440                               (add-todo dest-true))
442                             (cond ((byte-lit? src1)
443                                    (let ((n (byte-lit-val src1))
444                                          (y (byte-cell-adr src2)))
445                                      (if #f #;(and (or (= n 0) (= n 1) (= n #xff))
446                                               (eq? (instr-id instr) 'x==y))
447                                          (special-compare-eq-lit n x)
448                                          (begin
449                                            (movlw n)
450                                            (compare #t y)))))
451                                   ((byte-lit? src2)
452                                    (let ((x (byte-cell-adr src1))
453                                          (n (byte-lit-val src2)))
454                                      (if #f #;(and (or (= n 0) (= n 1) (= n #xff))
455                                               (eq? (instr-id instr) 'x==y))
456                                          (special-compare-eq-lit n x)
457                                          (begin
458                                            (movlw n)
459                                            (compare #f x)))))
460                                   (else
461                                    (let ((x (byte-cell-adr src1))
462                                          (y (byte-cell-adr src2)))
463                                      (move-reg y WREG)
464                                      (compare #f x))))))
465                          (else
466                           ;...
467                           (emit (list (instr-id instr))))))))))
469         (if bb
470             (begin
471               (vector-set! bbs-vector label-num #f)
472               (label (bb-label bb))
473               (for-each dump-instr (reverse (bb-rev-instrs bb)))
474               (for-each add-todo (bb-succs bb)))))))
475   
476   (let ((prog-label (asm-make-label 'PROG)))
477     (rcall prog-label)
478     (sleep)
479     (label prog-label))
481   (add-todo (vector-ref bbs-vector 0))
483   (let loop ()
484     (if (null? todo)
485         (reverse rev-code)
486         (let ((bb (car todo)))
487           (set! todo (cdr todo))
488           (bb-linearize bb)
489           (loop)))))
492 (define (assembler-gen filename cfg)
494   (define (gen instr)
495     (case (car instr)
496       ((movlw)
497        (movlw (cadr instr)))
498       ((movwf)
499        (movwf (cadr instr)))
500       ((movfw)
501        (movf (cadr instr) 'w))
502       ((movff)
503        (movff (cadr instr) (caddr instr)))
504       ((clrf)
505        (clrf (cadr instr)))
506       ((setf)
507        (setf (cadr instr)))
508       ((incf)
509        (incf (cadr instr)))
510       ((decf)
511        (decf (cadr instr)))
512       ((addwf)
513        (addwf (cadr instr)))
514       ((addwfc)
515        (addwfc (cadr instr)))
516       ((subwf)
517        (subwf (cadr instr)))
518       ((subwfb)
519        (subwfb (cadr instr)))
520       ((mullw)
521        (mullw (cadr instr)))
522       ((mulwf)
523        (mulwf (cadr instr)))
524       ((andwf)
525        (andwf (cadr instr)))
526       ((iorwf)
527        (iorwf (cadr instr)))
528       ((xorwf)
529        (xorwf (cadr instr)))
530       ((rlcf)
531        (rlcf (cadr instr)))
532       ((rrcf)
533        (rrcf (cadr instr)))
534       ((bcf)
535        (bcf (cadr instr) (caddr instr)))
536       ((bsf)
537        (bsf (cadr instr) (caddr instr)))
538       ((btf)
539        (btf (cadr instr) (caddr instr)))
540       ((comf)
541        (comf (cadr instr)))
542       ((cpfseq)
543        (cpfseq (cadr instr)))
544       ((cpfslt)
545        (cpfslt (cadr instr)))
546       ((cpfsgt)
547        (cpfsgt (cadr instr)))
548       ((bra)
549        (bra (cadr instr)))
550       ((rcall)
551        (rcall (cadr instr)))
552       ((return)
553        (return))
554       ((label)
555        (asm-listing
556         (string-append (symbol->string (asm-label-id (cadr instr))) ":"))
557        (asm-label (cadr instr)))
558       ((sleep)
559        (sleep))
560       (else
561        (error "unknown instruction" instr))))
563   (asm-begin! 0 #f)
565 ;  (pretty-print cfg)
567   (let ((code (linearize-and-cleanup cfg)))
568 ;    (pretty-print code)
569     (for-each gen code)))
571 (define (code-gen filename cfg)
572   (allocate-registers cfg)
573   (assembler-gen filename cfg))