1 ;;;; tags which are set during the build process and which end up in
2 ;;;; CL:*FEATURES* in the target SBCL, plus some comments about other
3 ;;;; CL:*FEATURES* tags which have special meaning to SBCL or which
4 ;;;; have a special conventional meaning
6 ;;;; Note that the recommended way to customize the features of a
7 ;;;; local build of SBCL is not to edit this file, but instead to
8 ;;;; tweak customize-target-features.lisp. If you define a function
9 ;;;; in customize-target-features.lisp, it will be used to transform
10 ;;;; the target features list after it's read and before it's used.
11 ;;;; E.g. you can use code like this:
13 ;;;; (flet ((enable (x) (pushnew x list))
14 ;;;; (disable (x) (setf list (remove x list))))
15 ;;;; #+nil (enable :sb-show)
16 ;;;; (enable :sb-after-xc-core)
17 ;;;; #+nil (disable :sb-doc)
19 ;;;; By thus editing a local file (one which is not in the source
20 ;;;; distribution, and which is in .cvsignore) your customizations
21 ;;;; will remain local even if you do things like "cvs update",
22 ;;;; will not show up if you try to submit a patch with "cvs diff",
23 ;;;; and might even stay out of the way if you use other non-CVS-based
24 ;;;; methods to upgrade the files or store your configuration.
26 ;;;; This software is part of the SBCL system. See the README file for
27 ;;;; more information.
29 ;;;; This software is derived from the CMU CL system, which was
30 ;;;; written at Carnegie Mellon University and released into the
31 ;;;; public domain. The software is in the public domain and is
32 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
33 ;;;; files for more information.
37 ;; features present in all builds
42 ;; FIXME: Isn't there a :x3jsomething feature which we should set too?
47 ;; Douglas Thomas Crosher's conservative generational GC (the only one
48 ;; we currently support for X86)
51 ;; We're running under a UNIX. This is sort of redundant, and it was also
52 ;; sort of redundant under CMU CL, which we inherited it from: neither SBCL
53 ;; nor CMU CL supports anything but UNIX (and "technically not UNIX"es
54 ;; such as *BSD and Linux). But someday, maybe we might, and in that case
55 ;; we'd presumably remove this, so its presence conveys the information
56 ;; that the system isn't one which follows such a change.
60 ;; features present in this particular build
63 ;; Setting this enables the compilation of documentation strings
64 ;; from the system sources into the target Lisp executable.
65 ;; Traditional Common Lisp folk will want this option set.
66 ;; I (WHN) made it optional because I came to Common Lisp from
67 ;; C++ through Scheme, so I'm accustomed to asking
68 ;; Emacs about things that I'm curious about instead of asking
69 ;; the executable I'm running.
72 ;; Do regression and other tests when building the system. You
73 ;; might or might not want this if you're not a developer,
74 ;; depending on how paranoid you are. You probably do want it if
75 ;; you are a developer.
78 ;; Make more debugging information available (for debugging SBCL
79 ;; itself). If you aren't hacking or troubleshooting SBCL itself,
80 ;; you probably don't want this set.
82 ;; At least two varieties of debugging information are enabled by this
84 ;; * SBCL is compiled with a higher level of OPTIMIZE DEBUG, so that
85 ;; the debugger can tell more about the state of the system.
86 ;; * Various code to print debugging messages, and similar debugging code,
87 ;; is compiled only when this feature is present.
89 ;; Note that the extra information recorded by the compiler at
90 ;; this higher level of OPTIMIZE DEBUG includes the source location
91 ;; forms. In order for the debugger to use this information, it has to
92 ;; re-READ the source file. In an ordinary installation of SBCL, this
93 ;; re-READing may not work very well, for either of two reasons:
94 ;; * The sources aren't present on the system in the same location that
95 ;; they were on the system where SBCL was compiled.
96 ;; * SBCL is using the standard readtable, without the added hackage
97 ;; which allows it to handle things like target features.
98 ;; If you want to be able to use the extra debugging information,
99 ;; therefore, be sure to keep the sources around, and run with the
100 ;; readtable configured so that the system sources can be read.
103 ;; Build SBCL with the old CMU CL low level debugger, "ldb". If
104 ;; are aren't messing with CMU CL at a very low level (e.g.
105 ;; trying to diagnose GC problems) you shouldn't need this.
108 ;; This isn't really a target Lisp feature at all, but controls
109 ;; whether the build process produces an after-xc.core file. This
110 ;; can be useful for shortening the edit/compile/debug cycle if
111 ;; you're messing around with low-level internals of the system,
112 ;; as in slam.sh. Otherwise you don't need it.
115 ;; Enable extra debugging output in the assem.lisp assembler/scheduler
116 ;; code. (This is the feature which was called :DEBUG in the
117 ;; original CMU CL code.)
120 ;; Setting this makes SBCL more "fluid", i.e. more amenable to
121 ;; modification at runtime, by suppressing various INLINE declarations,
122 ;; compiler macro definitions, FREEZE-TYPE declarations; and by
123 ;; suppressing various burning-our-ships-behind-us actions after
124 ;; initialization is complete; and so forth. This tends to clobber the
125 ;; performance of the system, so unless you have some special need for
126 ;; this when hacking SBCL itself, you don't want this set.
129 ;; Enable code for collecting statistics on usage of various operations,
130 ;; useful for performance tuning of the SBCL system itself. This code
131 ;; is probably pretty stale (having not been tested since the fork from
132 ;; base CMU CL) but might nonetheless be a useful starting point for
133 ;; anyone who wants to collect such statistics in the future.
136 ;; Peter Van Eynde's increase-bulletproofness code
138 ;; This is not maintained or tested in current SBCL, but I haven't
139 ;; gone out of my way to remove or break it, either.
142 ; :high-security-support
144 ;; multiprocessing support
146 ;; This is not maintained or tested in current SBCL. I haven't gone out
147 ;; of my way to break it, but since it's derived from an old version of
148 ;; CMU CL where multiprocessing was pretty shaky, it's likely to be very
150 ;; :MP enables multiprocessing
151 ;; :MP-I486 is used, only within the multiprocessing code, to control
152 ;; what seems to control processor-version-specific code. It's
153 ;; probably for 486 or later, i.e. could be set as long as
154 ;; you know you're not running on a 386, but it doesn't seem
155 ;; to be documented anywhere, so that's just a guess.
159 ;; This affects the definition of a lot of things in bignum.lisp. It
160 ;; doesn't seem to be documented anywhere what systems it might apply
161 ;; to. It doesn't seem to be needed for X86 systems anyway.
164 ;; This is probably true for some processor types, but not X86. It
165 ;; affects a lot of floating point code.
166 ; :negative-zero-is-not-zero
168 ;; This is set in classic CMU CL, and presumably there it means
169 ;; that the floating point arithmetic implementation
170 ;; conforms to IEEE's standard. Here it definitely means that the
171 ;; floating point arithmetic implementation conforms to IEEE's standard.
172 ;; I (WHN 19990702) haven't tried to verify
173 ;; that it does conform, but it should at least mostly conform (because
174 ;; the underlying x86 hardware tries).
177 ;; CMU CL had, and we inherited, code to support 80-bit LONG-FLOAT on the x86
178 ;; architecture. Nothing has been done to actively destroy the long float
179 ;; support, but it hasn't been thoroughly maintained, and needs at least
180 ;; some maintenance before it will work. (E.g. the LONG-FLOAT-only parts of
181 ;; genesis are still implemented in terms of unportable CMU CL functions
182 ;; which are not longer available at genesis time in SBCL.) A deeper
183 ;; problem is SBCL's bootstrap process implicitly assumes that the
184 ;; cross-compilation host will be able to make the same distinctions
185 ;; between floating point types that it does. This assumption is
186 ;; fundamentally sleazy, even though in practice it's unlikely to break down
187 ;; w.r.t. distinguishing SINGLE-FLOAT from DOUBLE-FLOAT; it's much more
188 ;; likely to break down w.r.t. distinguishing DOUBLE-FLOAT from LONG-FLOAT.
189 ;; Still it's likely to be quite doable to get LONG-FLOAT support working
190 ;; again, if anyone's sufficiently motivated.
194 ;; miscellaneous notes on other things which could have special significance
195 ;; in the *FEATURES* list
198 ;; notes on the :NIL and :IGNORE features:
200 ;; #+NIL is used to comment out forms. Occasionally #+IGNORE is used
201 ;; for this too. So don't use :NIL or :IGNORE as the names of features..
203 ;; notes on :SB-XC and :SB-XC-HOST features (which aren't controlled by this
204 ;; file, but are instead temporarily pushed onto *FEATURES* or
205 ;; *TARGET-FEATURES* during some phases of cross-compilation):
207 ;; :SB-XC-HOST stands for "cross-compilation host" and is in *FEATURES*
208 ;; during the first phase of cross-compilation bootstrapping, when the
209 ;; host Lisp is being used to compile the cross-compiler.
211 ;; :SB-XC stands for "cross compiler", and is in *FEATURES* during the second
212 ;; phase of cross-compilation bootstrapping, when the cross-compiler is
213 ;; being used to create the first target Lisp.
215 ;; notes on the :SB-ASSEMBLING feature (which isn't controlled by
218 ;; This is a flag for whether we're in the assembler. It's
219 ;; temporarily pushed onto the *FEATURES* list in the setup for
220 ;; the ASSEMBLE-FILE function. It would be a bad idea
221 ;; to use it as a name for a permanent feature.
223 ;; notes on local features (which are set automatically by the
224 ;; configuration script, and should not be set here unless you
225 ;; really, really know what you're doing):
227 ;; machine architecture features:
229 ;; any Intel 386 or better, or compatibles like the AMD K6 or K7
231 ;; DEC/Compaq Alpha CPU
232 ;; (No other CPUs are supported by SBCL as of 0.6.12.15, but SPARC or
233 ;; PowerPC support could be ported from CMU CL if anyone is
234 ;; sufficiently motivated to do so, or if you're *really* motivated,
235 ;; you could write a port from scratch for a new CPU architecture.)
236 ;; (CMU CL also had a :pentium feature, which affected the definition
237 ;; of some floating point vops. It was present but not enabled or
238 ;; documented in the CMU CL code that SBCL is derived from, and is
239 ;; present but stale in SBCL as of 0.6.12.)
241 ;; operating system features:
242 ;; :linux = We're intended to run under some version of Linux.
243 ;; :bsd = We're intended to run under some version of BSD Unix. (This
244 ;; is not exclusive with the features which indicate which
245 ;; particular version of BSD we're intended to run under.)
246 ;; :freebsd = We're intended to run under FreeBSD.
247 ;; :openbsd = We're intended to run under FreeBSD.
248 ;; (No others are supported by SBCL as of 0.6.7, but :hpux or
249 ;; :solaris support could be ported from CMU CL if anyone is
250 ;; sufficiently motivated to do so, and it'd even be possible,
251 ;; though harder, to port the system to Microsoft Windows.)