Add safepoint mechanism
[sbcl.git] / src / compiler / policies.lisp
1 ;;;; aimed optimization qualities
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5 ;;;;
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
11
12 (in-package "SB!C")
13
14 (define-optimization-quality check-constant-modification
15     safety
16   ("no" "maybe" "yes" "yes")
17   "Control whether the compiler should check for constant
18 modification. Defaults to SAFETY.")
19
20 (define-optimization-quality type-check
21     ;; FIXME: grepping the tree for "policy.*safety" yields some
22     ;; places which might want to use this instead -- or
23     ;; some other derived policy.
24     (cond ((= safety 0) 0)
25           ((and (< safety 2) (< safety speed)) 2)
26           (t 3))
27   ("no" "maybe" "weak" "full")
28   "Control the way to perform runtime type checking:
29 0: declared types are simply trusted; no runtime checks are performed;
30 2: fast checks are performed: declared types are weakened to
31    FIXNUM/SINGLE-FLOAT/FLOAT/NUMBER/structure/specialized array etc.;
32 3: declared types are fully checked (several exceptions exist;
33    see \"SBCL User Manual\", Compiler->Handling of Types->
34    Implementation Limitations for details).")
35
36 (define-optimization-quality check-tag-existence
37     (cond ((= safety 0) 0)
38           (t 3))
39   ("no" "maybe" "yes" "yes")
40   "Control whether GO and RETURN-FROM check liveness of the destination tag.
41 Enabling this option can increase heap consing of closures.")
42
43 (define-optimization-quality let-conversion
44     (if (<= debug speed) 3 0)
45   ("off" "maybe" "on" "on")
46   "Control inline-substitution of used-once local functions.")
47
48 (define-optimization-quality rest-conversion
49     (if (= debug 3) 0 3)
50   ("off" "maybe" "on" "on")
51   "Control conversion of &REST argments to &MORE arguments when
52 only used as the final argument to APPLY.")
53
54 (define-optimization-quality alien-funcall-saves-fp-and-pc
55     (if (<= speed debug) 3 0)
56   ("no" "maybe" "yes" "yes")
57   "Control ALIEN-FUNCALL saving frame-pointer and program counter for
58 more reliable bactracing across foreign calls.")
59
60 (define-optimization-quality verify-arg-count
61     (if (zerop safety) 0 3)
62   ("no" "maybe" "yes" "yes"))
63
64 (define-optimization-quality insert-debug-catch
65     (if (> debug (max speed space))
66         3
67         0)
68   ("no" "maybe" "yes" "yes")
69   "Enables possibility of returning from stack frames with the debugger.
70 Enabling this option causes apparent tail calls to no longer be in a tail
71 position -- effectively disabling tail-merging, hence causing apparently tail
72 recursive functions to no longer execute in constant stack space")
73
74 (define-optimization-quality recognize-self-calls
75     (if (> (max speed space) debug)
76         3
77         0)
78   ("no" "maybe" "yes" "yes")
79   "When enabled, reference to a function FOO inside the body of (DEFUN
80 FOO ...) is considered to be the reference to the function being
81 defined. Calls to FOO are compiled as local. This allows better
82 optimization and type checking, but TRACE will not show recursive
83 calls. If the function object is bound to another name BAR, and FOO is
84 bound to another function, calls to FOO inside BAR will remain to be
85 recursive.
86
87 When disabled, internal references to a function FOO will be
88 considered ti be a call of a function, bound to the symbol at
89 run-time, which is less efficient. TRACE will show recursive calls. In
90 case of renaming described above, calls to FOO will not be recursive
91 and will refer to the new function, bound to FOO.")
92
93 (define-optimization-quality float-accuracy
94     3
95   ("degraded" "full" "full" "full"))
96
97 (define-optimization-quality insert-step-conditions
98     (if (> debug (max speed space compilation-speed))
99         debug
100         0)
101   ("no" "no" "partial" "full")
102   "Control instrumentation of code, enabling single-stepping through
103 it in the debugger.
104
105 This option has no effect without COMPUTE-DEBUG-FUN.")
106
107 (define-optimization-quality compute-debug-fun
108     debug
109   ("no" "minimal" "yes" "yes"))
110
111 (define-optimization-quality preserve-single-use-debug-variables
112     (if (and (>= debug 2)
113              (< speed 3))
114         3
115         0)
116   ("no" "no" "no" "yes")
117   "When disabled, LET variable, which is never set and is referenced
118 exactly once, is eliminated and the reference is substituted with the
119 initial value. This allows better type inference and some algebraic
120 optimizations.
121
122 When enabled, the variable is preserved and can be seen in the
123 debugger.")
124
125 (define-optimization-quality insert-array-bounds-checks
126     (if (= safety 0) 0 3)
127   ("no" "yes" "yes" "yes"))
128
129 (define-optimization-quality store-xref-data
130     (if (= space 3)
131         0
132         3)
133   ("no" "yes" "yes" "yes"))
134
135 (define-optimization-quality store-coverage-data
136     0
137   ("no" "no" "yes" "yes"))
138
139 #!+sb-safepoint
140 (define-optimization-quality inhibit-safepoints
141     0
142   ("no" "no" "yes" "yes")
143   "When disabled, the compiler will insert safepoints at strategic
144 points (loop edges, function prologues) to ensure that potentially
145 long-running code can be interrupted.
146
147 When enabled, no safepoints will be inserted explicitly.  Note that
148 this declaration does not prevent out-of-line function calls, which
149 will encounter safepoints unless the target function has also been
150 compiled with this declaration in effect.")