1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
# Build flavours
Hadrian supports a few predefined _build flavours_, i.e. collections of build
settings that fully define a GHC build (see `src/Flavour.hs`). Users can add their
own build flavours if need be, as described
[here](https://gitlab.haskell.org/ghc/ghc/blob/master/hadrian/doc/user-settings.md#build-flavour).
## Arguments
The following table summarises extra arguments passed to GHC in different build flavours.
There are four groups of arguments: arguments in `hsDefault` are passed to GHC for all Haskell
source files, `hsLibrary` arguments are added when compiling libraries, `hsCompiler`
when compiling the `compiler` library, and `hsGhc` when compiling/linking the GHC program.
<table>
<tr>
<th rowspan="3">Flavour</th>
<th colspan="8">Extra arguments</th>
</tr>
<tr>
<th colspan="2">hsDefault</td>
<th colspan="2">hsLibrary</td>
<th colspan="2">hsCompiler</td>
<th colspan="2">hsGhc</td>
</tr>
<tr>
<th>stage0</td>
<th>stage1+</td>
<th>stage0</td>
<th>stage1+</td>
<th>stage0</td>
<th>stage1+</td>
<th>stage0</td>
<th>stage1+</td>
</tr>
<tr>
<th>default<br></td>
<td>-O<br>-H32m<br></td>
<td>-O2<br>-H32m</td>
<td></td>
<td>-haddock</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<th>quick</td>
<td>-O0<br>-H64m</td>
<td>-O0<br>-H64m</td>
<td></td>
<td>-O</td>
<td>-O2</td>
<td>-O</td>
<td>-O</td>
<td></td>
</tr>
<tr>
<th>quick-validate</td>
<td>-O0<br>-H64m<br>-Werror</td>
<td>-O0<br>-H64m<br>-Werror</td>
<td></td>
<td>-O</td>
<td>-O2</td>
<td>-O</td>
<td>-O</td>
<td></td>
</tr>
<tr>
<th>quick-debug</td>
<td>-O0<br>-H64m</td>
<td>-O0<br>-H64m</td>
<td></td>
<td>-O</td>
<td>-O2</td>
<td>-O</td>
<td>-O</td>
<td>-debug (link)</td>
</tr>
<tr>
<th>quickest</td>
<td>-O0<br>-H64m</td>
<td>-O0<br>-H64m</td>
<td></td>
<td></td>
<td>-O</td>
<td></td>
<td>-O</td>
<td></td>
</tr>
<tr>
<th>perf</td>
<td>-O<br>-H64m</td>
<td>-O<br>-H64m</td>
<td></td>
<td>-O2</td>
<td>-O2</td>
<td>-O2</td>
<td>-O</td>
<td>-O2</td>
</tr>
<tr>
<th>release (same as perf with -haddock)</td>
<td> Yes (on supported platforms) </td>
<td>-O<br>-H64m</td>
<td>-O<br>-H64m</td>
<td></td>
<td>-O2</td>
<td>-O2</td>
<td>-O2</td>
<td>-O</td>
<td>-O2</td>
</tr>
<tr>
<th>bench</td>
<td>-O<br>-H64m</td>
<td>-O<br>-H64m</td>
<td></td>
<td>-O2</td>
<td>-O2</td>
<td>-O0</td>
<td>-O2</td>
<td>-O2</td>
</tr>
<tr>
<th>devel1</td>
<td>-O<br>-H64m</td>
<td>-O<br>-H64m</td>
<td></td>
<td>-dcore-lint</td>
<td>-O0<br>-DDEBUG</td>
<td></td>
<td>-O0<br>-DDEBUG</td>
<td></td>
</tr>
<tr>
<th>devel2</td>
<td>-O<br>-H64m</td>
<td>-O<br>-H64m</td>
<td></td>
<td>-dcore-lint</td>
<td>-O2</td>
<td>-O0<br>-DDEBUG</td>
<td></td>
<td>-O0<br>-DDEBUG</td>
</tr>
<tr>
<th>validate</td>
<td>-O0<br>-H64m</td>
<td>-fllvm-fill-undef-with-garbage</td>
<td></td>
<td>-O<br>-dcore-lint<br>-dno-debug-output</td>
<td>-O2<br>-DDEBUG</td>
<td>-O<br>-dcore-lint<br>-dno-debug-output</td>
<td>-O</td>
<td>-O</td>
</tr>
<tr>
<th>slow-validate</td>
<td>-O0<br>-H64m</td>
<td>-fllvm-fill-undef-with-garbage</td>
<td></td>
<td>-O<br>-dcore-lint<br>-dno-debug-output</td>
<td>-O2<br>-DDEBUG</td>
<td>-O<br>-DDEBUG<br>-dcore-lint<br>-dno-debug-output</td>
<td>-O</td>
<td>-O</td>
</tr>
<tr>
<th>static</td>
<td>-O<br>-H64m<br>-fPIC -static</td>
<td>-O<br>-H64m<br>-fPIC -static</td>
<td></td>
<td>-O2</td>
<td>-O2</td>
<td>-O2</td>
<td>-O<br>-optl -static</td>
<td>-O2<br>-optl -static</td>
</tr>
</table>
## Flavour transformers
Each of the flavours described above is intended as a starting-point for
configuring your GHC build. In addition, Hadrian supports a number of "flavour
transformers" which modify the configuration in various ways.
These can be appended to the flavour name passed via the `--flavour`
command-line flag, separated by the `+` character. For instance,
```
hadrian --flavour=perf+thread_sanitizer
```
The supported transformers are listed below:
<table>
<tr>
<th>Transformer name</th>
<th>Effect</th>
</tr>
<tr>
<td><code>werror</code></td>
<td>Use the `-Werror` flag for all stage1+ compilation.</td>
</tr>
<tr>
<td><code>debug_info</code></td>
<td>Enable production of native debugging information (via GHC/GCC's `-g3`)
during stage1+ compilations.</td>
</tr>
<tr>
<td><code>ticky_ghc</code></td>
<td>Compile the GHC executable with Ticky-Ticky profiler support.</td>
</tr>
<tr>
<td><code>split_sections</code></td>
<td>Enable section splitting for all libraries (except for the GHC
library due to the long linking times that this causes).</td>
</tr>
<tr>
<td><code>thread_sanitizer</code></td>
<td>Build the runtime system with ThreadSanitizer support</td>
</tr>
<tr>
<td><code>llvm</code></td>
<td>Use GHC's LLVM backend (`-fllvm`) for all stage1+ compilation.</td>
</tr>
<tr>
<td><code>profiled_ghc</code></td>
<td>Build the GHC executable with cost-centre profiling support.
It is recommended that you use this in conjunction with `no_dynamic_ghc` since
GHC does not support loading of profiled libraries with the
dynamic linker. You should use a flavour that builds profiling libs and rts,
i.e. not <code>quick</code>. <br>
This flag adds cost centres with the -fprof-late flag.</td>
</tr>
<tr>
<td><code>no_dynamic_ghc</code></td>
<td>Linked GHC against the statically-linked RTS. This causes GHC to
default to loading static rather than dynamic library when,
e.g., loading libraries during TemplateHaskell evaluations.</td>
</tr>
<tr>
<td><code>no_profiled_libs</code></td>
<td>Disables building of libraries in profiled build ways.</td>
</tr>
<tr>
<td><code>omit_pragmas</code></td>
<td>Build the stage2 compiler with -fomit-interface-pragmas to reduce
recompilation.</td>
</tr>
<tr>
<td><code>ipe</code></td>
<td>Build the stage2 libraries with IPE debugging information for use with -hi profiling.</td>
</tr>
<tr>
<td><code>debug_ghc</code></td>
<td>Build the stage2 compiler linked against the debug rts</td>
</tr>
<tr>
<td><code>debug_stage1_ghc</code></td>
<td>Build the stage1 compiler linked against the debug rts</td>
</tr>
<tr>
<td><code>assertions</code></td>
<td>Build the stage2 compiler with assertions enabled. </td>
</tr>
<tr>
<td><code>fully_static</code></td>
<td>Produce fully statically-linked executables and build libraries suitable for static linking.</td>
</tr>
<tr>
<td><code>collect_timings</code></td>
<td>Collects timings while building the stage2+ compiler by adding the
flags <code>-ddump-to-file -ddump-timings</code>.</td>
</tr>
<tr>
<td><code>lint</code></td>
<td>Enable Core, STG, and C-- linting in all compilation with the stage1
compiler.</td>
</tr>
</table>
### Static
The `static` flavour does not strictly follow the groupings in the table
above because it links all the executables statically, not just GHC
itself, and because it passes `-optc -static` when delegating to a C
compiler. It also turns off dynamic linking at runtime by by adding the
`-dynamic-system-linker` cabal flag to the `ghc` package build because
`musl` doesn't allow dynamic linking in executables that were statically
linked against `libc`. Static flags are only added when building in a
non-dynamic _way_. Some of the considerations for a static build aren't
a great fit for the flavour system, so it's a little bit hacky.
## Ways
Libraries and GHC can be built in different _ways_, e.g. with or without profiling
information. The following table lists ways that are built in different flavours.
<table>
<tr>
<th rowspan="2">Flavour</th>
<th colspan="2">Library ways</th>
<th colspan="2">RTS ways</th>
</tr>
<tr>
<th>stage0</th>
<th>stage1+</th>
<th>stage0</th>
<th>stage1+</th>
<th>stage0</th>
<th>stage1+</th>
</tr>
<tr>
<th>default<br>perf<br>prof<br>devel1<br>devel2</td>
<td>vanilla</td>
<td>vanilla<br>profiling<br>dynamic</td>
<td>debug<br>threaded<br>threadedDebug<br>debugDynamic<br>threadedDynamic<br>threadedDebugDynamic</td>
<td>debug<br>threaded<br>threadedDebug<br>threadedProfiling<br>debugDynamic<br>threadedDynamic<br>threadedDebugDynamic</td>
</tr>
<tr>
<th>static</td>
<td>vanilla</td>
<td>vanilla<br>profiling</td>
<td>debug<br>threaded<br>threadedDebug</td>
<td>
debug<br>threaded<br>threadedDebug<br>threadedProfiling
</td>
<td>Only in<br>prof<br>flavour</td>
<td>Only in<br>prof<br>flavour</td>
</tr>
<tr>
<th>quick<br>quick-validate<br>quick-debug</th>
<td>vanilla</td>
<td>vanilla<br>dynamic</td>
<td>debug<br>threaded<br>threadedDebug<br>debugDynamic<br>threadedDynamic<br>threadedDebugDynamic</td>
<td>debug<br>threaded<br>threadedDebug<br>debugDynamic<br>threadedDynamic<br>threadedDebugDynamic</td>
</tr>
<tr>
<th>quickest<br>bench</th>
<td>vanilla</td>
<td>vanilla</td>
<td>vanilla<br>threaded</td>
<td>vanilla<br>threaded</td>
</tr>
</table>
|
