source: trunk/source/compiler/vinsn.lisp @ 15094

Last change on this file since 15094 was 15076, checked in by gb, 9 years ago

VINSN-SEQUENCE-HAS-SOME-ATTRIBUTE-P.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 32.7 KB
Line 
1;;;-*- Mode: Lisp; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18
19(cl:eval-when (:compile-toplevel :load-toplevel :execute)
20  (require "DLL-NODE")
21  (require "BACKEND"))
22
23
24(cl:in-package "CCL")
25
26;;; Specifying the same name for a result and an argument basically
27;;; says that it's ok for the vinsn to clobber that argument.  (In all
28;;; other cases, arguments are assumed to be "read-only", and damned
29;;; well better be.)  Any results that are also arguments must follow
30;;; all results that aren't in the "results" list; any arguments that
31;;; are also results must precede all arguments that aren't in the
32;;; "arguments" list, and all hybrids must appear in the same order in
33;;; both lists. This is what "nhybrids" is about (and why it defaults
34;;; to 0 ...)  Sometimes (often) these hybrid "results" aren't very
35;;; interesting as results;;; it might be clearer to consider
36;;; "mutable" arguments as quasi-temporaries.
37(defstruct vinsn-template
38  name                                  ; a symbol in the target package
39  result-vreg-specs                     ; one or more vreg specs for values defined by the vinsn
40  argument-vreg-specs                   ; may ultimately overlap some result vreg(s)
41  ; one or more vreg specs for temporaries used in vinsn.
42  ; all such temporaries are assumed to have lifetimes which span all
43  ; machine instructions in the vinsn (e.g., they can't conflict with any
44  ; registers used for args/results and may have further constraints.
45  temp-vreg-specs                 
46  local-labels
47  body                                  ; list of target instructions, local labels
48  (nhybrids 0)
49  (nvp 0)
50  results&args                          ;
51  (attributes 0)                        ; attribute bitmask
52  opcode-alist                          ; ((number1 . name1) (number2 . name2) ...)
53)
54
55(defmethod make-load-form ((v vinsn-template) &optional env)
56  (make-load-form-saving-slots v :environment env))
57
58
59(defun get-vinsn-template-cell (name templates)
60  (let* ((n (intern (string name) *ccl-package*)))
61    (or (gethash n templates)
62        (setf (gethash n templates) (cons n nil)))))
63
64(defun need-vinsn-template (name templates)
65  (or (cdr (if (consp name) name (get-vinsn-template-cell name templates)))
66      (error "Unknown vinsn: ~s" name)))
67
68(defun set-vinsn-template (name template templates)
69  (setf (cdr (get-vinsn-template-cell name templates)) template))
70
71(defstruct (vinsn (:include dll-node)
72                  (:print-function print-vinsn)
73                  (:constructor %make-vinsn (template)))
74  template                              ; The vinsn-template of which this is an instance
75  variable-parts                        ; vector of result-vregs, arguments, temps, local-labels
76  annotation
77  (gprs-set 0)
78  (fprs-set 0)
79  (gprs-read 0)
80  (fprs-read 0)
81)
82
83(def-standard-initial-binding *vinsn-freelist* (make-dll-node-freelist))
84
85(defun make-vinsn (template)
86  (let* ((vinsn (alloc-dll-node *vinsn-freelist*)))
87    (loop
88      ;; Sometimes, the compiler seems to return its node list
89      ;; to the freelist without first removing the vinsn-labels in it.
90      #-bootstrapped (when (and (typep vinsn 'vinsn)
91                                (not (> (uvsize vinsn) 8)))
92                       (setf (pool.data *vinsn-freelist*) nil)
93                       (setq vinsn nil))
94      (if (or (null vinsn) (typep vinsn 'vinsn)) (return))
95      (setq vinsn (alloc-dll-node *vinsn-freelist*)))
96    (if vinsn
97      (progn
98        (setf (vinsn-template vinsn) template
99              (vinsn-variable-parts vinsn) nil
100              (vinsn-annotation vinsn) nil
101              (vinsn-gprs-set vinsn) 0
102              (vinsn-fprs-set vinsn) 0
103              (vinsn-gprs-read vinsn) 0
104              (vinsn-fprs-read vinsn) 0)
105        vinsn)
106      (%make-vinsn template))))
107
108(eval-when (:load-toplevel :execute)
109(defstruct (vinsn-label (:include dll-node)
110                        (:print-function print-vinsn-label)
111                        (:predicate %vinsn-label-p)
112                        (:constructor %make-vinsn-label (id)))
113  id
114  refs                                  ; vinsns in which this label appears as an operand
115  info                                  ; code-generation stuff
116)
117)
118
119(def-standard-initial-binding *vinsn-label-freelist* (make-dll-node-freelist))
120
121(defun make-vinsn-label (id)
122  (let* ((lab (alloc-dll-node *vinsn-label-freelist*)))
123    (if lab
124      (progn
125        (setf (vinsn-label-id lab) id
126              (vinsn-label-refs lab) nil
127              (vinsn-label-info lab) nil)
128        lab)
129      (%make-vinsn-label id))))
130
131; "Real" labels have fixnum IDs.
132(defun vinsn-label-p (l)
133  (if (%vinsn-label-p l) 
134    (typep (vinsn-label-id l) 'fixnum)))
135
136
137(defun print-vinsn-label (l s d)
138  (declare (ignore d))
139  (print-unreadable-object (l s :type t)
140    (format s "~d" (vinsn-label-id l))))
141
142;;; Notes are attached to (some) vinsns.  They're used to attach
143;;; semantic information to an execution point.  The vinsn
144;;; points to the note via its LABEL-ID; the note has a backpointer to
145;;; the vinsn.
146
147(defstruct (vinsn-note
148            (:constructor %make-vinsn-note)
149            (:print-function print-vinsn-note))
150  (label (make-vinsn-label nil))
151  (peer nil :type (or null vinsn-note))
152  (class nil)
153  (info nil :type (or null simple-vector)))
154
155
156(defun print-vinsn-note (n s d)
157  (declare (ignore d))
158  (print-unreadable-object (n s :type t)
159    (format s "~d" (vinsn-note-class n))
160    (let* ((info (vinsn-note-info n)))
161      (when info (format s " / ~S" info)))))
162 
163(defun make-vinsn-note (class info)
164  (let* ((n (%make-vinsn-note :class class :info (if info (apply #'vector info))))
165         (lab (vinsn-note-label n)))
166    (setf (vinsn-label-id lab) n)
167    n))
168
169(defun close-vinsn-note (n)
170  (let* ((end (%make-vinsn-note :peer n)))
171    (setf (vinsn-label-id (vinsn-note-label end)) end
172          (vinsn-note-peer end) n
173          (vinsn-note-peer n) end)
174    end))
175       
176
177(defun vinsn-vreg-description (value spec)
178  (case (cadr spec)
179    ((:u32 :s32 :u16 :s16 :u8 :s8 :lisp :address :imm)
180     (let* ((mode (if (typep value 'fixnum)
181                    (get-regspec-mode value))))
182       (if (and mode (not (eql 0 mode)))
183         (list (hard-regspec-value value)
184               (car (rassoc mode *mode-name-value-alist* :test #'eq)))
185         value)))
186    (t value)))
187
188(defun collect-vinsn-variable-parts (v start n &optional specs)
189  (declare (fixnum start n))
190  (let* ((varparts (vinsn-variable-parts v)))
191    (when varparts
192      (let* ((head (cons nil nil))
193             (tail head))
194        (declare (dynamic-extent head) (cons head tail))
195        (do* ((j start (1+ j))
196              (i 0 (1+ i)))
197             ((= i n) (cdr head))
198          (declare (fixnum i j))
199          (setq tail (cdr (rplacd tail (cons (vinsn-vreg-description (svref varparts j) (pop specs)) nil)))))))))
200
201     
202(defun collect-vinsn-results (v)
203  (let* ((template (vinsn-template v))
204         (result-specs (vinsn-template-result-vreg-specs template)))
205    (collect-vinsn-variable-parts v 0 (length result-specs) result-specs)))
206
207(defun collect-vinsn-arguments (v)
208  (let* ((template (vinsn-template v))
209         (arg-specs (vinsn-template-argument-vreg-specs template)))
210    (collect-vinsn-variable-parts v
211                                  (- (length (vinsn-template-result-vreg-specs template)) 
212                                     (vinsn-template-nhybrids template))
213                                  (length arg-specs)
214                                  arg-specs)))
215
216(defun collect-vinsn-temps (v)
217  (let* ((template (vinsn-template v)))
218    (collect-vinsn-variable-parts v 
219                                  (+
220                                   (length (vinsn-template-result-vreg-specs template)) 
221                                   (length (vinsn-template-argument-vreg-specs template)))
222                                  (length (vinsn-template-temp-vreg-specs template)))))
223
224(defun template-infix-p (template)
225  (declare (ignore template))
226  nil)
227
228(defun print-vinsn (v stream d)
229  (declare (ignore d))
230  (let* ((template (vinsn-template v))
231         (results (collect-vinsn-results v))
232         (args (collect-vinsn-arguments v))
233         (opsym (if (cdr results) :== :=))
234         (infix (and (= (length args) 2) (template-infix-p template)))
235         (opname (vinsn-template-name template)))
236    (print-unreadable-object (v stream)
237      (if results (format stream "~A ~S " (if (cdr results) results (car results)) opsym))
238      (if infix
239        (format stream "~A ~A ~A" (car args) opname (cadr args))
240        (format stream "~A~{ ~A~}" opname args))
241      (let* ((annotation (vinsn-annotation v)))
242        (when annotation
243          (format stream " ||~a|| " annotation))))))
244 
245(defparameter *known-vinsn-attributes*
246  '(
247    :jump                               ; an unconditional branch
248    :branch                             ; a conditional branch
249    :call                               ; a jump that returns
250    :funcall                            ; A full function call, assumed to bash all volatile registers
251    :subprim-call                       ; A subprimitive call; bashes some volatile registers
252    :jumpLR                             ; Jumps to the LR, possibly stopping off at a function along the way.
253    :lrsave                             ; saves LR in LOC-PC
254    :lrrestore                          ; restores LR from LOC-PC
255    :lispcontext                        ; references lisp frame LOC-PC, FN, and entry VSP
256    :node                               ; saves/restores a node value in stack-like memory
257    :word                               ; saves/restores an unboxed word in stack-like memory
258    :doubleword                         ; saves/restores an unboxed doubleword (fp-reg) in stack-like memory
259    :vsp                                ; uses the vsp to save/restore
260    :tsp                                ; uses the tsp to save/restore
261    :csp                                ; uses sp to save/restore
262    :push                               ; saves something
263    :pop                                ; restores something
264    :multiple                           ; saves/restores multiple nodes/words/doublewords
265    :ref                                ; references memory
266    :set                                ; sets memory
267    :outgoing-argument                  ; e.g., pushed as an argument, not to avoid clobbering
268    :xref                               ; makes some label externally visible
269    :jump-unknown                       ; Jumps, but we don't know where ...
270    :constant-ref
271    :sets-cc                            ; vinsn sets condition codes based on result
272    :discard                            ; adjusts a stack pointer
273    :sp
274    :predicatable                       ; all instructions can be predicated, no instructions set or test condition codes.
275    :sets-lr                            ; uses the link register, if there is one.
276    ))
277
278(defparameter *nvp-max* 10 "size of *vinsn-varparts* freelist elements")
279(def-standard-initial-binding *vinsn-varparts* (%cons-pool))
280
281(defun alloc-varparts-vector ()
282  (without-interrupts
283   (let* ((v (pool.data *vinsn-varparts*)))
284     (if v
285       (progn
286         (setf (pool.data *vinsn-varparts*)
287               (svref v 0))
288          (%init-misc 0 v)
289         v)
290       (make-array (the fixnum *nvp-max*) :initial-element 0)))))
291
292(defun free-varparts-vector (v)
293  (without-interrupts
294   (setf (svref v 0) (pool.data *vinsn-varparts*)
295         (pool.data *vinsn-varparts*) v)
296   nil))
297
298(defun elide-vinsn (vinsn)
299  (let* ((nvp (vinsn-template-nvp (vinsn-template vinsn)))
300         (vp (vinsn-variable-parts vinsn)))
301    (dotimes (i nvp)
302      (let* ((v (svref vp i)))
303        (when (typep v 'lreg)
304          (setf (lreg-defs v) (delete vinsn (lreg-defs v)))
305          (setf (lreg-refs v) (delete vinsn (lreg-refs v))))))
306    (free-varparts-vector vp)
307    (remove-dll-node vinsn)))
308   
309(defun encode-vinsn-attributes (attribute-list)
310  (flet ((attribute-weight (k)
311           (let* ((pos (position k *known-vinsn-attributes*)))
312             (if pos (ash 1 pos) (error "Unknown vinsn attribute: ~s" k)))))
313    (let* ((attr 0))
314      (declare (fixnum attr))
315      (dolist (a attribute-list attr)
316        (setq attr (logior attr (the fixnum (attribute-weight a))))))))
317
318
319(defun %define-vinsn (backend vinsn-name results args temps body)
320  (funcall (backend-define-vinsn backend)
321           backend
322           vinsn-name
323           results
324           args
325           temps
326           body))
327
328
329;; Fix the opnum's in the vinsn-template-body to agree with the
330;; backend's opcode hash table.
331(defun fixup-vinsn-template (orig-template opcode-hash)
332  (let ((template (cdr orig-template)))
333    (when template
334      (unless (vinsn-template-p template)
335        (setq template (require-type template 'vinsn-template)))
336      (let ((new-opcode-alist nil)
337            (changes nil)
338            (opcode-alist (vinsn-template-opcode-alist template)))
339        ;; this is patterned after ppc2-expand-vinsn
340        (labels ((walk-form (f)
341                   (unless (atom f)
342                     (if (fixnump (car f))
343                       (got-one f)
344                       (dolist (subform (cdr f))
345                         (walk-form subform)))))
346                 (got-one (f)
347                   (let* ((old-opcode (car f))
348                          (name (cdr (assq old-opcode opcode-alist)))
349                          (new-opcode (and name (gethash name opcode-hash))))
350                     (unless new-opcode
351                       (cerror "Continue" "Can't find new opcode number ~
352                                   for ~s in ~s" (car f) template))
353                     (setf (assq new-opcode new-opcode-alist) name)
354                     (unless (eq new-opcode old-opcode)
355                       (push (cons f new-opcode) changes)))))
356          (mapc #'walk-form (vinsn-template-body template))
357          (without-interrupts
358           (dolist (change changes)
359             (setf (caar change) (cdr change)))
360           (setf (vinsn-template-opcode-alist template)
361                 new-opcode-alist))))
362      orig-template)))
363
364(defun fixup-vinsn-templates (templates opcode-hash-table)
365  (maphash #'(lambda (name template)
366               (declare (ignore name))
367               (fixup-vinsn-template template opcode-hash-table))
368           templates))
369
370
371
372
373;;; Could probably split this up and do some arg checking at macroexpand time.
374(defun match-template-vregs (template vinsn supplied-vregs)
375  (declare (list supplied-vregs))
376  (let* ((nsupp (length supplied-vregs))
377         (results&args (vinsn-template-results&args template))
378         (nra (length results&args))
379         (temp-specs (vinsn-template-temp-vreg-specs template))
380         (ntemps (length temp-specs))
381         (nvp (vinsn-template-nvp template))
382         (vp (alloc-varparts-vector))
383         (*available-backend-node-temps* *available-backend-node-temps*)
384         (*available-backend-fp-temps* *available-backend-fp-temps*)
385         (*available-backend-imm-temps* *available-backend-imm-temps*)
386         (*available-backend-crf-temps* *available-backend-crf-temps*))
387    (declare (fixnum nvp ntemps nsupp)
388             (list temp-specs))
389    (unless (= nsupp nra)
390      (error "Vinsn ~A expects ~D result/argument specs, received ~D ."
391             (vinsn-template-name template) nra nsupp))
392    (do* ((i 0 (1+ i))
393          (supp supplied-vregs (cdr supp))
394          (spec results&args (cdr spec)))
395         ((null supp))
396      (declare (fixnum i) (list spec supp))
397      (setf (svref vp i) (match-vreg (car supp) (cadar spec) vinsn vp i)))
398    ;; Allocate some temporaries.
399    (do* ((i (- nvp ntemps) (1+ i))
400          (temps temp-specs (cdr temps)))
401         ((null temps) vp)
402      (declare (fixnum i))
403      (let* ((spec (cadar temps)))
404        (if (and (consp spec) (eq (car spec) :label))
405          (let* ((label (aref *backend-labels* (cadr spec))))
406            (push vinsn (vinsn-label-refs label))
407            (setf (svref vp i) label))
408          (let* ((lreg (allocate-temporary-vreg (car temps)))
409                 (class (hard-regspec-class lreg))
410                 (value (hard-regspec-value lreg)))
411            (when value
412              (case class
413                (#.hard-reg-class-gpr (note-vinsn-sets-gpr vinsn value))
414                (#.hard-reg-class-fpr (note-vinsn-sets-fpr-lreg vinsn lreg))))
415            (setf (svref vp i) lreg)
416            (pushnew vinsn (lreg-defs lreg))
417            (pushnew vinsn (lreg-refs lreg))))))))
418
419;;; "spec" is (<name> <class>).
420;;;  <class> is keyword or (<keyword> <val>)
421(defun allocate-temporary-vreg (spec)
422  (setq spec (cadr spec))
423  (let* ((class (if (atom spec) spec (car spec)))
424         (value (if (atom spec) nil (cadr spec))))
425    (if value
426      (ecase class
427        (:crf (make-wired-lreg (use-crf-temp value) :class hard-reg-class-crf))
428        ((:u8 :s8 :u16 :s16 :u32 :s32 :u64 :s64) 
429         (make-wired-lreg (use-imm-temp value)
430                          :class hard-reg-class-gpr
431                          :mode (gpr-mode-name-value class)))
432        (:lisp (make-wired-lreg 
433                (use-node-temp value) 
434                :class hard-reg-class-gpr
435                :mode hard-reg-class-gpr-mode-node))
436        (:double-float (let* ((lreg (make-wired-lreg
437                                     value
438                                     :class hard-reg-class-fpr
439                                     :mode hard-reg-class-fpr-mode-double)))
440                         (use-fp-reg lreg)
441                         lreg))
442        (:single-float (let* ((lreg (make-wired-lreg
443                                     value
444                                     :class hard-reg-class-fpr
445                                     :mode hard-reg-class-fpr-mode-single)))
446                         (use-fp-reg lreg)
447                         lreg)))
448      (ecase class
449        ((:imm :wordptr) 
450         (make-unwired-lreg
451          (if (= *available-backend-imm-temps* 0) (select-node-temp) (select-imm-temp))
452              :class hard-reg-class-gpr
453              :mode hard-reg-class-gpr-mode-node)) 
454        ((:u8 :s8 :u16 :s16 :u32 :s32 :u64 :s64 :address) 
455         (make-unwired-lreg (select-imm-temp)
456                            :class hard-reg-class-gpr
457                            :mode (gpr-mode-name-value class)))
458        (:double-float
459         (make-unwired-lreg (select-fp-temp :double-float)
460                            :class hard-reg-class-fpr
461                            :mode hard-reg-class-fpr-mode-double))
462        (:single-float
463         (make-unwired-lreg (select-fp-temp :single-float)
464                            :class hard-reg-class-fpr
465                            :mode hard-reg-class-fpr-mode-double))
466        (:lisp 
467         (make-unwired-lreg 
468          (select-node-temp) 
469          :class hard-reg-class-gpr
470          :mode hard-reg-class-gpr-mode-node))
471        (:crf 
472         (make-unwired-lreg (select-crf-temp) :class hard-reg-class-crf))))))
473
474
475
476(defun select-vinsn (template-or-name template-hash vregs)
477  (let* ((template (need-vinsn-template template-or-name template-hash))
478         (vinsn (make-vinsn template)))
479    (setf (vinsn-variable-parts vinsn) (match-template-vregs template vinsn vregs))
480    vinsn))
481
482(defun %emit-vinsn (vlist name vinsn-table &rest vregs)
483  (append-dll-node (select-vinsn name vinsn-table vregs) vlist))
484
485(defun varpart-matches-reg (varpart-value class regval spec)
486  (setq spec (if (atom spec) spec (car spec)))
487  (and
488   (or
489    (and (eq class hard-reg-class-fpr)
490         (memq spec '(:single-float :double-float)))
491    (and (eq class hard-reg-class-gpr)
492         (memq spec '(:u32 :s32 :u16 :s16 :u8 :s8 :lisp :address :imm))))
493   (eq (hard-regspec-value varpart-value) regval)))
494
495(defun vinsn-refs-reg-p (element reg)
496  (if (typep element 'vinsn)
497    (if (vinsn-attribute-p element :call)
498      t
499      (let* ((class (hard-regspec-class reg))
500             (value (hard-regspec-value reg)))
501        (if (eq class hard-reg-class-gpr)
502          (logbitp value (vinsn-gprs-read element))
503          (if (eq class hard-reg-class-fpr)
504            ;; The FPR is logically read in the vinsn if it or any
505            ;; conflicting FPR is physically read in the vinsn.
506            (logtest (fpr-mask-for-vreg reg) (vinsn-fprs-read element))))))))
507
508(defun vinsn-sets-reg-p (element reg)
509  (if (typep element 'vinsn)
510    (if (vinsn-attribute-p element :call)
511      t
512      (let* ((class (hard-regspec-class reg))
513             (value (hard-regspec-value reg)))
514        (if (eq class hard-reg-class-gpr)
515          (logbitp value (vinsn-gprs-set element))
516          (if (eq class hard-reg-class-fpr)
517            ;; The FPR is logically set in the vinsn if it or any
518            ;; conflicting FPR is physically set in the vinsn.
519            (logtest (fpr-mask-for-vreg reg) (vinsn-fprs-set element))))))))
520
521;;; Return bitmasks of all GPRs and all FPRs set in the vinsns between
522;;; START and END, exclusive.  Any :call vinsn implicitly clobbers
523;;; all registers.
524(defun regs-set-in-vinsn-sequence (start end)
525  (let* ((gprs-set 0)
526         (fprs-set 0))
527    (do* ((element (dll-node-succ start) (dll-node-succ element)))
528         ((eq element end) (values gprs-set fprs-set))
529      (if (typep element 'vinsn)
530        (if (vinsn-attribute-p element :call)
531          (return (values #xffffffff #xffffffff))
532          (setq gprs-set (logior gprs-set (vinsn-gprs-set element))
533                fprs-set (logior fprs-set (vinsn-fprs-set element))))))))
534
535
536     
537;;; If any vinsn between START and END (exclusive) sets REG, return
538;;; that vinsn; otherwise, return NIL.
539(defun vinsn-sequence-sets-reg-p (start end reg)
540  (do* ((element (dll-node-succ start) (dll-node-succ element)))
541       ((eq element end))
542    (if (vinsn-sets-reg-p element reg)
543      (return element))))
544       
545;;; If any vinsn between START and END (exclusive) refs REG, return
546;;; the last such vinsn; otherwise, return NIL.
547(defun vinsn-sequence-refs-reg-p (start end reg)
548  (do* ((element (dll-node-pred end) (dll-node-pred element)))
549       ((eq element start))
550    (if (vinsn-refs-reg-p element reg)
551      (return element))))
552
553
554;;; Return T if any vinsn between START and END (exclusive) has all
555;;; attributes set in ATTR set.
556(defun %vinsn-sequence-has-attribute-p (start end attr)
557  (do* ((element (dll-node-succ start) (dll-node-succ element)))
558       ((eq element end))
559    (when (typep element 'vinsn)
560      (when (eql attr (logand (vinsn-template-attributes (vinsn-template element)) attr))
561        (return t)))))
562
563;;; Return T if any vinsn between START and END (exclusive) has some
564;;; some attributes set in attr set.
565(defun %vinsn-sequence-has-some-attribute-p (start end attr)
566  (do* ((element (dll-node-succ start) (dll-node-succ element)))
567       ((eq element end))
568    (when (typep element 'vinsn)
569      (when (logtest attr (vinsn-template-attributes (vinsn-template element)))
570        (return t)))))
571
572(defmacro vinsn-sequence-has-attribute-p (start end &rest attrs)
573  `(%vinsn-sequence-has-attribute-p ,start ,end ,(encode-vinsn-attributes attrs)))
574
575(defmacro vinsn-sequence-has-some-attribute-p (start end &rest attrs)
576  `(%vinsn-sequence-has-some-attribute-p ,start ,end ,(encode-vinsn-attributes attrs)))
577
578;;; Return T iff vinsn is between START and END (exclusive).
579(defun vinsn-in-sequence-p (vinsn start end)
580  (do* ((element (dll-node-succ start) (dll-node-succ element)))
581       ((eq element end))
582    (when (eq vinsn element)
583      (return t))))
584
585(defun last-vinsn (seg)
586  ;; Try to find something that isn't a SOURCE-NOTE.  Go ahead.  I dare you.
587  (do* ((element (dll-header-last seg) (dll-node-pred element)))
588       ((eq element seg))               ;told ya!
589    (when (typep element 'vinsn)
590      (return element))))
591
592
593;;; Flow-graph nodes (FGNs)
594
595(defstruct (fgn (:include dll-header))
596  (id 0 :type unsigned-byte)
597  (inedges ())                          ; list of nodes which reference this node
598  (visited nil)                         ; Boolean
599)
600
601
602
603;;; FGNs which don't terminate with an "external jump"
604;;; (jump-return-pc/jump-subprim, etc) jump to their successor, either
605;;; explicitly or by falling through.  We can introduce or remove
606;;; jumps when linearizing the program.
607(defstruct (jumpnode (:include fgn)
608                     (:constructor %make-jumpnode (id)))
609  (outedge)                             ; the FGN we jump/fall in to.
610)
611
612(defun make-jumpnode (id)
613  (init-dll-header (%make-jumpnode id)))
614   
615;;; A node that ends in a conditional branch, followed by an implicit
616;;; or explicit jump.  Keep track of the conditional branch and the
617;;; node it targets.
618(defstruct (condnode (:include jumpnode)
619                     (:constructor %make-condnode (id)))
620  (condbranch)                          ; the :branch vinsn
621  (branchedge)                          ; the FGN it targets
622)
623
624(defun make-condnode (id)
625  (init-dll-header (%make-condnode id)))
626         
627;;; A node that terminates with a return i.e., a jump-return-pc or
628;;; jump-subprim.
629(defstruct (returnnode (:include fgn)
630                       (:constructor %make-returnnode (id)))
631)
632
633(defun make-returnnode (id)
634  (init-dll-header (%make-returnnode id)))
635
636;;; Some specified attribute is true.
637(defun %vinsn-attribute-p (vinsn mask)
638  (declare (fixnum mask))
639  (if (vinsn-p vinsn)
640    (let* ((template (vinsn-template vinsn)))
641      (not (eql 0 (logand mask (the fixnum (vinsn-template-attributes template))))))))
642
643;;; All specified attributes are true.
644(defun %vinsn-attribute-= (vinsn mask)
645  (declare (fixnum mask))
646  (if (vinsn-p vinsn)
647    (let* ((template (vinsn-template vinsn)))
648      (= mask (the fixnum (logand mask (the fixnum (vinsn-template-attributes template))))))))
649 
650(defmacro vinsn-attribute-p (vinsn &rest attrs)
651  `(%vinsn-attribute-p ,vinsn ,(encode-vinsn-attributes attrs)))
652
653(defmacro vinsn-attribute-= (vinsn &rest attrs)
654  `(%vinsn-attribute-= ,vinsn ,(encode-vinsn-attributes attrs)))
655
656;;; Ensure that conditional branches that aren't followed by jumps are
657;;; followed by (jump lab-next) @lab-next.  Ensure that JUMPs and
658;;; JUMPLRs are followed by labels.  It's easiest to do this by
659;;; walking backwards.  When we're all done, labels will mark the
660;;; start of each block.
661
662(defun normalize-vinsns (header)
663  (do* ((prevtype :label currtype)
664        (current (dll-header-last header) (dll-node-pred current))
665        (currtype nil))
666       ((eq current header)
667        (unless (eq prevtype :label)
668          (insert-dll-node-after
669           (aref *backend-labels* (backend-get-next-label))
670           current)))
671    (setq currtype (cond ((vinsn-label-p current) :label)
672                         ((vinsn-attribute-p current :branch) :branch)
673                         ((vinsn-attribute-p current :jump) :jump)
674                         ((vinsn-attribute-p current :jumplr) :jumplr)))
675    (case currtype
676      ((:jump :jumplr)
677       (unless (eq prevtype :label)
678         (let* ((lab (aref *backend-labels* (backend-get-next-label))))
679           (insert-dll-node-after lab current))))
680      (:branch
681       (unless (eq prevtype :jump)
682         (let* ((lab
683                 (if (eq prevtype :label)
684                   (dll-node-succ current)
685                   (aref *backend-labels* (backend-get-next-label))))
686                (jump (select-vinsn "JUMP" *backend-vinsns* (list lab))))
687           (unless (eq prevtype :label)
688             (insert-dll-node-after lab current))
689           (insert-dll-node-after jump current))))
690      ((nil)
691       (if (eq prevtype :label)
692         (let* ((lab (dll-node-succ current)))
693           (when (vinsn-label-p lab)
694             (insert-dll-node-after
695              (select-vinsn "JUMP" *backend-vinsns* (list lab))
696              current))))))))
697
698
699;;; Unless the header is empty, remove the last vinsn and all preceding
700;;; vinsns up to and including the preceding label.  (Since the vinsns
701;;; have been normalized, there will always be a preceding label.)
702;;; Return the label and the last vinsn, or (values nil nil.)
703(defun remove-last-basic-block (vinsns)
704  (do* ((i 1 (1+ i))
705        (current (dll-header-last vinsns) (dll-node-pred current)))
706       ((eq current vinsns) (values nil nil))
707    (declare (fixnum i))
708    (if (vinsn-label-p current)
709      (return (remove-dll-node current i)))))
710
711;;; Create a flow graph from vinsns and return the entry node.
712(defun create-flow-graph (vinsns)
713  (let* ((nodes ()))
714    (flet ((label->fgn (label) (dll-node-pred label)))
715      (loop
716          (multiple-value-bind (label last) (remove-last-basic-block vinsns)
717            (when (null label) (return))
718            (let* ((id (vinsn-label-id label))
719                   (node (if (vinsn-attribute-p last :jumpLR)
720                           (make-returnnode id)
721                           (if (vinsn-attribute-p (dll-node-pred last) :branch)
722                             (make-condnode id)
723                             (make-jumpnode id)))))
724              (declare (fixnum id))
725              (insert-dll-node-after label node last)
726              (push node nodes))))
727      (dolist (node nodes nodes)
728        (if (typep node 'jumpnode)
729          (let* ((jump (dll-header-last node))
730                 (jmptarget (branch-target-node jump)))
731            (setf (jumpnode-outedge node) jmptarget)
732            (pushnew node (fgn-inedges jmptarget))
733            (if (typep node 'condnode)  ; a subtype of jumpnode
734              (let* ((branch (dll-node-pred jump))
735                     (branchtarget (branch-target-node branch)))
736                (setf (condnode-condbranch node) branch)
737                (pushnew node (fgn-inedges branchtarget))))))))))
738 
739                         
740(defun delete-unreferenced-labels (labels)
741  (delete #'(lambda (l)
742              (unless (vinsn-label-refs l)
743                (when (vinsn-label-succ l)
744                  (remove-dll-node l))
745                t)) labels :test #'funcall))
746
747(defun branch-target-node (v)
748  (dll-node-pred (svref (vinsn-variable-parts v) 0)))
749
750(defun replace-label-refs (vinsn old-label new-label)
751  (let ((vp (vinsn-variable-parts vinsn)))
752    (dotimes (i (length vp))
753      (when (eq (svref vp i) old-label)
754        (setf (svref vp i) new-label)))))
755 
756;;; Try to remove jumps/branches to jumps.
757(defun maximize-jumps (header)
758  (do* ((prev nil next)
759        (next (dll-header-first header) (dll-node-succ next)))
760       ((eq next header))
761    (when (and (vinsn-attribute-p next :jump)
762               (vinsn-label-p  prev))
763      (let* ((target (svref (vinsn-variable-parts next) 0)))
764        (unless (eq target prev)
765          (dolist (ref (vinsn-label-refs prev) (setf (vinsn-label-refs prev) nil))
766            (replace-label-refs ref prev target)
767            (push ref (vinsn-label-refs target))))))))
768
769(defun optimize-vinsns (header)
770  ;; Delete unreferenced labels that the compiler might have emitted.
771  ;; Subsequent operations may cause other labels to become
772  ;; unreferenced.
773  (let* ((labels (collect ((labs)) 
774                   (do-dll-nodes (v header)
775                     (when (vinsn-label-p v) (labs v)))
776                   (labs))))
777    ;; Look for pairs of adjacent, referenced labels.
778    ;; Merge them together (so that one of them becomes unreferenced.)
779    ;; Repeat the process until no pairs are found.
780    (do* ((repeat t))
781         ((not repeat))
782      (setq repeat nil 
783            labels (delete-unreferenced-labels labels))
784      (dolist (l labels)
785        (let* ((succ (vinsn-label-succ l)))
786          (when (vinsn-label-p succ)
787            (backend-merge-labels l succ)
788            (setq repeat t)
789            (return)))))
790    (maximize-jumps header)
791    (delete-unreferenced-labels labels)
792    (normalize-vinsns header)
793  ))
794
795(defun show-vinsns (vinsns indent)
796  (do-dll-nodes (n vinsns)
797    (format t "~&~v@t~s" indent n)))
798
799(defun show-fgn (node)
800  (format t "~&~s (~d) {~a}" (type-of node) (fgn-id node) (mapcar #'fgn-id (fgn-inedges node)))
801  (show-vinsns node 2)
802  (terpri)
803  (terpri))
804
805(defun dfs-walk (fgns &key
806                      process-before process-after
807                      process-succ-before process-succ-after)
808  (labels ((dfs (node)
809             (when process-before
810               (funcall process-before node))
811             (setf (fgn-visited node) t)
812             (when (typep node 'jumpnode)
813               (let* ((outedge (jumpnode-outedge node)))
814                 (unless (fgn-visited outedge)
815                   (when process-succ-before
816                     (funcall process-succ-before outedge))
817                   (dfs outedge)
818                   (when process-succ-after
819                     (funcall process-succ-after outedge))))
820               (when (typep node 'condnode)
821                 (let* ((branchedge (branch-target-node
822                                     (condnode-condbranch node))))
823                   (unless (fgn-visited branchedge)
824                     (when process-succ-before
825                       (funcall process-succ-before branchedge))
826                     (dfs branchedge)
827                     (when process-succ-after
828                       (funcall process-succ-after branchedge))))))
829             (when process-after
830               (funcall process-after node))))
831    (dolist (n fgns)
832      (setf (fgn-visited n) nil))
833    (dfs (car fgns))))
834
835(defun dfs-postorder (fgns)
836  (let* ((n (length fgns))
837         (v (make-array n))
838         (p -1)
839         (process-after #'(lambda (node)
840                            (setf (svref v (incf p)) node))))
841    (declare (fixnum p) (dynamic-extent process-after))
842    (dfs-walk fgns :process-after process-after)
843    v))
844
845;;; This generally only gives a meaningful result if pass 2 of the
846;;; compiler has been compiled in the current session.
847;;; TODO (maybe): keep track of the "expected missing vinsns" for
848;;; each backend, call this function after compiling pass 2.  That's
849;;; a little weird, since it'd require modifying backend X whenever
850;;; backend Y changes, but it's probably better than blowing up when
851;;; compiling user code.
852(defun missing-vinsns (&optional (backend *target-backend*))
853  (let* ((missing ()))
854    (maphash #'(lambda (name info)
855                 (unless (cdr info)
856                   (push name missing)))
857             (backend-p2-vinsn-templates backend))
858    missing))
859                     
860(provide "VINSN")
Note: See TracBrowser for help on using the repository browser.