1.0.24.7: CHAR-CODE type derivation
[sbcl.git] / OPTIMIZATIONS
1 #1
2 (defun mysl (s)
3     (declare (simple-string s))
4     (declare (optimize (speed 3) (safety 0) (debug 0)))
5     (let ((c 0))
6       (declare (fixnum c))
7       (dotimes (i (length s))
8         (when (eql (aref s i) #\1)
9           (incf c)))
10       c))
11
12 * On X86 I is represented as a tagged integer.
13
14 * Unnecessary move:
15   3: SLOT S!11[EDX] {SB-C::VECTOR-LENGTH 1 7} => t23[EAX]
16   4: MOVE t23[EAX] => t24[EBX]
17
18 --------------------------------------------------------------------------------
19 #2
20 (defun quux (v)
21   (declare (optimize (speed 3) (safety 0) (space 2) (debug 0)))
22   (declare (type (simple-array double-float 1) v))
23   (let ((s 0d0))
24     (declare (type double-float s))
25     (dotimes (i (length v))
26       (setq s (+ s (aref v i))))
27     s))
28
29 * Python does not combine + with AREF, so generates extra move and
30   allocates a register.
31
32 * On X86 Python thinks that all FP registers are directly accessible
33   and emits costy MOVE ... => FR1.
34
35 --------------------------------------------------------------------------------
36 #3
37 (defun bar (n)
38   (declare (optimize (speed 3) (safety 0) (space 2))
39            (type fixnum n))
40   (let ((v (make-list n)))
41     (setq v (make-array n))
42     (length v)))
43
44 * IR1 does not optimize away (MAKE-LIST N).
45 --------------------------------------------------------------------------------
46 #4
47 (defun bar (v1 v2)
48   (declare (optimize (speed 3) (safety 0) (space 2))
49            (type (simple-array base-char 1) v1 v2))
50   (dotimes (i (length v1))
51     (setf (aref v2 i) (aref v1 i))))
52
53 VOP DATA-VECTOR-SET/SIMPLE-STRING V2!14[EDI] t32[EAX] t30[S2]>t33[CL]
54                                   => t34[S2]<t35[AL] 
55         MOV     #<TN t33[CL]>, #<TN t30[S2]>
56         MOV     BYTE PTR [EDI+EAX+1], #<TN t33[CL]>
57         MOV     #<TN t35[AL]>, #<TN t33[CL]>
58         MOV     #<TN t34[S2]>, #<TN t35[AL]>
59
60 * The value of DATA-VECTOR-SET is not used, so there is no need in the
61   last two moves.
62
63 * And why two moves?
64 --------------------------------------------------------------------------------
65 #8
66 (defun foo (d)
67   (declare (optimize (speed 3) (safety 0) (debug 0)))
68   (declare (type (double-float 0d0 1d0) d))
69   (loop for i fixnum from 1 to 5
70         for x1 double-float = (sin d) ;;; !!!
71         do (loop for j fixnum from 1 to 4
72                  sum x1 double-float)))
73
74 Without the marked declaration Python will use boxed representation for X1.
75
76 This is equivalent to
77
78 (let ((x nil))
79   (setq x 0d0)
80   ;; use of X as DOUBLE-FLOAT
81 )
82
83 The initial binding is effectless, and without it X is of type
84 DOUBLE-FLOAT. Unhopefully, IR1 does not optimize away effectless
85 SETs/bindings, and IR2 does not perform type inference.
86 --------------------------------------------------------------------------------
87 #9 "Multi-path constant folding"
88 (defun foo (x)
89   (if (= (cond ((irgh x) 0)
90                ((buh x) 1)
91                (t 2))
92          0)
93       :yes
94       :no))
95
96 This code could be optimized to
97
98 (defun foo (x)
99   (cond ((irgh x) :yes)
100         ((buh x) :no)
101         (t :no)))
102 --------------------------------------------------------------------------------
103 #11
104 (inverted variant of #9)
105
106 (lambda (x)
107   (let ((y (sap-alien x c-string)))
108     (list (alien-sap y)
109           (alien-sap y))))
110
111 It could be optimized to
112
113 (lambda (x) (list x x))
114
115 (if Y were used only once, the current compiler would optimize it)
116 --------------------------------------------------------------------------------
117 #12
118 (typep (truly-the (simple-array * (*)) x) 'simple-vector)
119
120 tests lowtag.
121 --------------------------------------------------------------------------------
122 #13
123 FAST-+/FIXNUM and similar should accept unboxed arguments in interests
124 of representation selection. Problem: inter-TN dependencies.
125 --------------------------------------------------------------------------------
126 #14
127 The derived type of (/ (THE (DOUBLE-FLOAT (0D0)) X) (THE (DOUBLE-FLOAT
128 1D0) Y)) is (DOUBLE-FLOAT 0.0d0). While it might be reasonable, it is
129 better to derive (OR (MEMBER 0.0d0) (DOUBLE-FLOAT (0.0d0))).
130 --------------------------------------------------------------------------------
131 #15
132 On the alpha, the system is reluctant to refer directly to a constant bignum,
133 preferring to load a large constant through a slow sequence of instructions,
134 then cons up a bignum for it:
135
136 (LAMBDA (A)
137   (DECLARE (OPTIMIZE (SAFETY 1) (SPEED 3) (DEBUG 1))
138            (TYPE (INTEGER -10000 10000) A)
139            (IGNORABLE A))
140   (CASE A
141     ((89 125 16) (ASH A (MIN 18 -706)))
142     (T (DPB -3 (BYTE 30 30) -1))))
143 --------------------------------------------------------------------------------
144 #16
145 (do ((i 0 (1+ i)))
146     ((= i (the (integer 0 100) n)))
147   ...)
148
149 It is commonly expected for Python to derive (FIXNUMP I). (If ``='' is
150 replaced with ``>='', Python will do.)
151 --------------------------------------------------------------------------------
152 #17 
153 Type tests for (ARRAY BIT), (ARRAY T) and similar go through full
154 %TYPEP, even though it is relatively simple to establish the arrayness
155 of an object and also to obtain the element type of an array.  As of
156 sbcl-0.8.12.30, this affects at least DUMP-OBJECT through
157 COMPOUND-OBJECT-P, and (LABELS MAYBE-EMIT-MAKE-LOAD-FORMS GROVEL)
158 through TYPEP UNBOXED-ARRAY, within the compiler itself.
159 --------------------------------------------------------------------------------
160 #18
161 (lambda (x) (declare (null x)) (sxhash x)) goes through SYMBOL-HASH
162 rather than either constant-folding or manipulating NIL-VALUE or
163 NULL-TN directly.
164 --------------------------------------------------------------------------------
165 #20
166 (defun-with-dx foo (x)
167   (flet ((make (x)
168            (let ((l (list nil nil)))
169              (setf (first l) x)
170              (setf (second l) (1- x))
171              l)))
172     (let ((l (make x)))
173       (declare (dynamic-extent l))
174       (mapc #'print l))))
175
176 Result of MAKE is not stack allocated.
177 --------------------------------------------------------------------------------
178 #22
179 IR2 does not perform unused code flushing.
180 --------------------------------------------------------------------------------
181 #24
182 a. Iterations on &REST lists, returning them as VALUES could be
183    rewritten with &MORE vectors.
184 b. Implement local unknown-values mv-call (useful for fast type checking).
185 --------------------------------------------------------------------------------
186 #26
187 SBCL cannot derive upper bound for I and uses generic arithmetic here:
188
189 (defun foo (l)
190   (declare (vector l))
191   (dotimes (i (length l))
192     (if (block nil
193           (map-foo (lambda (x) (if x (return t)))
194                    l))
195         t
196         nil)))
197
198 (So the constraint propagator or a possible future SSA-convertor
199 should know the connection between an NLE and its CLEANUP.)
200 --------------------------------------------------------------------------------
201 #27
202 Initialization of stack-allocated arrays is inefficient: we always
203 fill the vector with zeroes, even when it is not needed (as for
204 platforms with conservative GC or for arrays of unboxed objectes) and
205 is performed later explicitely.
206
207 (This is harder than it might look at first glance, as MAKE-ARRAY is smart
208 enough to eliminate something like ':initial-element 0'.  Such an optimization
209 is valid if the vector is being allocated in the heap, but not if it is being
210 allocated on the stack.  You could remove this optimization, but that makes
211 the heap-allocated case somewhat slower...)
212 --------------------------------------------------------------------------------
213 #28
214 a. Accessing raw slots in structure instances is more inefficient than
215 it could be; if we placed raw slots before the header word, we would
216 not need to do arithmetic at runtime to access them.  (But beware:
217 this would complicate handling of the interior pointer).
218
219 b. (Also note that raw slots are currently disabled on HPPA)
220 --------------------------------------------------------------------------------
221 #29
222 Python is overly zealous when converting high-level CL functions, such
223 as MIN/MAX, LOGBITP, and LOGTEST, to low-level CL functions.  Reducing
224 Python's aggressiveness would make it easier to effect changes such as
225
226 x86-64:
227 * direct MIN/MAX on {SINGLE,DOUBLE}-FLOATs ({MIN,MAX}S{S,D})
228
229 x86-64:
230 * direct LOGBITP on word-sized integers and fixnums (BT + JC)
231
232 x86{,-64}/PPC:
233 * branch-free MIN/MAX on word-sized integers and fixnums (floats could
234   be handled too, modulo safety considerations on the PPC)
235
236 x86-64:
237 * efficient LOGTESTs on word-sized integers and fixnums (TEST)
238
239 etc., etc.
240
241 (The framework for this has been implemented as of 0.9.9.18; see the
242 vm-support-routine COMBINATION-IMPLEMENTATION-STYLE and its use in
243 src/compiler/ir1opt.lisp, IR1-OPTIMIZE-COMBINATION.  The above
244 optimizations are left as an exercise for the reader.)
245 --------------------------------------------------------------------------------
246 #30
247 (defun foo (x y)
248   (< x y))
249
250 FOO's IR1 representation is roughly:
251
252 (defun foo (x y)
253   (if (< x y)
254       T
255       NIL))
256
257 However, if a full call is generated for < (and similarly for other
258 predicate functions), then the IF is unnecessary, since the return value
259 of (< x y) is already T or NIL.
260 --------------------------------------------------------------------------------
261 #31
262 The typecheck generated for a declaration like (integer 0 45) on x86 looks
263 like:
264
265 ;      12B:       F6C203           TEST DL, 3
266 ;      12E:       753B             JNE L1
267 ;      130:       8BC2             MOV EAX, EDX
268 ;      132:       83F800           CMP EAX, 0
269 ;      135:       7C34             JL L1
270 ;      137:       8BC2             MOV EAX, EDX
271 ;      139:       3DB4000000       CMP EAX, 180
272 ;      13E:       7F2B             JNLE L1
273
274 A better code sequence for this would be:
275
276   TEST DL, 3
277   JNE L1
278   MOV EAX, EDX
279   CMP EAX, 180
280   JBE L1
281
282 Doing an unsigned comparison means that, similarly to %CHECK-BOUND, we can
283 combine the <0 and >=bound tests.  This sort of test is generated often
284 in SBCL and any array-based code that's serious about type-checking its
285 indices.
286 --------------------------------------------------------------------------------
287 #32
288 The code for a vector bounds check on x86 (similarly on x86-64) where
289 the vector is in EDX and the index in EAX looks like:
290
291 ;       49: L0:   8B5AFD           MOV EBX, [EDX-3]
292 ;       4C:       39C3             CMP EBX, EAX
293 ;       4E:       7632             JBE L2
294
295 because %CHECK-BOUND is used for bounds-checking any array dimension.
296 A more efficient specialization (%CHECK-BOUND/VECTOR) would produce:
297
298   CMP [EDX-3], EAX
299   JBE L2
300
301 Which is slightly shorter and avoids using a register.
302 --------------------------------------------------------------------------------
303 #33
304 Reports from the Java camp indicate that using an SSE2-based
305 floating-point backend on x86 when possible is highly preferable to
306 using the x86 FP stack.  It would be nice if SBCL included an SSE2-based
307 floating point backend with a compile-time option to switch between the
308 two.
309 --------------------------------------------------------------------------------
310 #35
311 Compiling
312
313 (defun foo (a i)
314   (declare (type simple-vector a))
315   (aref a i))
316
317 results in the following x86 code:
318
319 ; 115886E9:       F7C703000000     TEST EDI, 3                ; no-arg-parsing entry point
320 ;      6EF:       7510             JNE L0
321 ;      6F1:       8BC7             MOV EAX, EDI
322 ;      6F3:       83F800           CMP EAX, 0
323 ;      6F6:       7C09             JL L0
324 ;      6F8:       8BC7             MOV EAX, EDI
325 ;      6FA:       3DF8FFFF7F       CMP EAX, 2147483640
326 ;      6FF:       7E0F             JLE L1
327 ;      701: L0:   8B057C865811     MOV EAX, [#x1158867C]      ; '(MOD
328                                                               ;   536870911)
329 ;      707:       0F0B0A           BREAK 10                   ; error trap
330 ;      70A:       05               BYTE #X05
331 ;      70B:       1F               BYTE #X1F                  ; OBJECT-NOT-TYPE-ERROR
332 ;      70C:       FECE01           BYTE #XFE, #XCE, #X01      ; EDI
333 ;      70F:       0E               BYTE #X0E                  ; EAX
334 ;      710: L1:   8B42FD           MOV EAX, [EDX-3]
335 ;      713:       8BCF             MOV ECX, EDI
336 ;      715:       39C8             CMP EAX, ECX
337 ;      717:       7620             JBE L2
338 ;      719:       8B540A01         MOV EDX, [EDX+ECX+1]
339
340 ... plus the standard return sequence and some error blocks.  The
341 `TEST EDI, 3' and associated comparisons are to ensure that `I' is a
342 positive fixnum.  The associated comparisons are unnecessary, as the
343 %CHECK-BOUND VOP only requires its tested index to be a fixnum and takes
344 care of the negative fixnum case itself.
345
346 {HAIRY-,}DATA-VECTOR-REF are DEFKNOWN'd with EXPLICIT-CHECK, which would
347 seem to take care of this, but EXPLICIT-CHECK only seems to be used when
348 compiling calls to unknown functions or similar.  Furthermore,
349 EXPLICIT-CHECK, as NJF understands it, doesn't have the right
350 semantics--it suppresses all type checking of arguments, whereas what we
351 really want is to ensure that the argument is a fixnum, but not check
352 its positiveness.
353 --------------------------------------------------------------------------------
354 #36
355
356 In #35, the CMP EAX, $foo instructions are all preceded by a MOV.  They
357 appear to be unnecessary, but are necessary because in IR2, EDI is a
358 DESCRIPTOR-REG, whereas EAX is an ANY-REG--and the comparison VOPs only
359 accept ANY-REGs.  Therefore, the MOVs are "necessary" to ensure that the
360 comparison VOP receives an TN of the appropriate storage class.
361
362 Obviously, it would be better if a) we only performed one MOV prior to
363 all three comparisons or b) eliminated the necessity of the MOV(s)
364 altogether.  The former option is probably easier than the latter.
365
366 --------------------------------------------------------------------------------
367 #38
368
369 (setf (subseq s1 start1 end1) (subseq s2 start2 end1))
370
371 could be transformed into
372
373 (let ((#:s2 s2)
374       (#:start2 start2)
375       (#:end2 end2))
376  (replace s1 #:s2 :start1 start1 :end1 end1 :start2 #:start2 :end2 #:end2))
377
378 when the return value is unused, avoiding the need to cons up the new sequence.
379
380 --------------------------------------------------------------------------------
381 #39
382
383 (let ((*foo* 42)) ...)
384
385 currently compiles to code that ensures the TLS index at runtime, which
386 is both a decently large chunk of code and unnecessary, as we could ensure
387 the TLS index at load-time as well.
388
389 --------------------------------------------------------------------------------
390 #40
391
392 When FTYPE is declared -- to say (function (t t t t t) t), and
393 function has a compiler-macro,
394
395   (apply #'foo 'x1 x2 'x3 more)
396
397 can be transformed into
398
399   (apply (lambda (x2 x4 x5) (foo 'x1 x2 'x3 x4 x5)) x2 more)
400
401 which allows compiler-macro-expansion for FOO. (Only constant
402 arguments can be moved inside the new lambda -- otherwise evaluation
403 order is altered.)