1 -----------------------------------------------------------------------------
2 -- $Id: DriverFlags.hs,v 1.23 2000/11/22 12:19:29 simonmar Exp $
6 -- (c) Simon Marlow 2000
8 -----------------------------------------------------------------------------
10 module DriverFlags where
12 #include "HsVersions.h"
14 import PackageMaintenance
17 import TmpFiles ( v_TmpDir )
29 -----------------------------------------------------------------------------
32 -- Flag parsing is now done in stages:
34 -- * parse the initial list of flags and remove any flags understood
35 -- by the driver only. Determine whether we're in multi-compilation
36 -- or single-compilation mode.
38 -- * gather the list of "static" hsc flags, and assign them to the global
39 -- static hsc flags variable.
41 -- * build the inital DynFlags from the remaining flags.
43 -- * complain if we've got any flags left over.
45 -- * for each source file: grab the OPTIONS, and build a new DynFlags
46 -- to pass to the compiler.
48 -----------------------------------------------------------------------------
49 -- Process command-line
52 = NoArg (IO ()) -- flag with no argument
53 | HasArg (String -> IO ()) -- flag has an argument (maybe prefix)
54 | SepArg (String -> IO ()) -- flag has a separate argument
55 | Prefix (String -> IO ()) -- flag is a prefix only
56 | OptPrefix (String -> IO ()) -- flag may be a prefix
57 | AnySuffix (String -> IO ()) -- flag is a prefix, pass whole arg to fn
58 | PassFlag (String -> IO ()) -- flag with no arg, pass flag to fn
59 | PrefixPred (String -> Bool) (String -> IO ())
60 | AnySuffixPred (String -> Bool) (String -> IO ())
62 processArgs :: [(String,OptKind)] -> [String] -> [String]
63 -> IO [String] -- returns spare args
64 processArgs _spec [] spare = return (reverse spare)
65 processArgs spec args@(('-':arg):args') spare = do
66 case findArg spec arg of
68 do args' <- processOneArg action rest args
69 processArgs spec args' spare
71 processArgs spec args' (('-':arg):spare)
72 processArgs spec (arg:args) spare =
73 processArgs spec args (arg:spare)
75 processOneArg :: OptKind -> String -> [String] -> IO [String]
76 processOneArg action rest (dash_arg@('-':arg):args) =
80 then io >> return args
81 else unknownFlagErr dash_arg
85 then fio rest >> return args
87 [] -> unknownFlagErr dash_arg
88 (arg1:args1) -> fio arg1 >> return args1
92 [] -> unknownFlagErr dash_arg
93 (arg1:args1) -> fio arg1 >> return args1
97 then fio rest >> return args
98 else unknownFlagErr dash_arg
102 then fio rest >> return args
103 else unknownFlagErr dash_arg
105 OptPrefix fio -> fio rest >> return args
107 AnySuffix fio -> fio dash_arg >> return args
109 AnySuffixPred p fio -> fio dash_arg >> return args
113 then unknownFlagErr dash_arg
114 else fio dash_arg >> return args
116 findArg :: [(String,OptKind)] -> String -> Maybe (String,OptKind)
118 = case [ (remove_spaces rest, k)
119 | (pat,k) <- spec, Just rest <- [my_prefix_match pat arg],
125 arg_ok (NoArg _) rest arg = null rest
126 arg_ok (HasArg _) rest arg = True
127 arg_ok (SepArg _) rest arg = null rest
128 arg_ok (Prefix _) rest arg = not (null rest)
129 arg_ok (PrefixPred p _) rest arg = not (null rest) && p rest
130 arg_ok (OptPrefix _) rest arg = True
131 arg_ok (PassFlag _) rest arg = null rest
132 arg_ok (AnySuffix _) rest arg = True
133 arg_ok (AnySuffixPred p _) rest arg = p arg
135 -----------------------------------------------------------------------------
138 -- note that ordering is important in the following list: any flag which
139 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
140 -- flags further down the list with the same prefix.
143 [ ------- help -------------------------------------------------------
144 ( "?" , NoArg long_usage)
145 , ( "-help" , NoArg long_usage)
148 ------- version ----------------------------------------------------
149 , ( "-version" , NoArg (do hPutStrLn stdout (cProjectName
150 ++ ", version " ++ cProjectVersion)
151 exitWith ExitSuccess))
152 , ( "-numeric-version", NoArg (do hPutStrLn stdout cProjectVersion
153 exitWith ExitSuccess))
155 ------- verbosity ----------------------------------------------------
156 , ( "n" , NoArg (writeIORef v_Dry_run True) )
158 ------- recompilation checker --------------------------------------
159 , ( "recomp" , NoArg (writeIORef v_Recomp True) )
160 , ( "no-recomp" , NoArg (writeIORef v_Recomp False) )
162 ------- ways --------------------------------------------------------
163 , ( "prof" , NoArg (addNoDups v_Ways WayProf) )
164 , ( "unreg" , NoArg (addNoDups v_Ways WayUnreg) )
165 , ( "ticky" , NoArg (addNoDups v_Ways WayTicky) )
166 , ( "parallel" , NoArg (addNoDups v_Ways WayPar) )
167 , ( "gransim" , NoArg (addNoDups v_Ways WayGran) )
168 , ( "smp" , NoArg (addNoDups v_Ways WaySMP) )
169 , ( "debug" , NoArg (addNoDups v_Ways WayDebug) )
172 ------ Debugging ----------------------------------------------------
173 , ( "dppr-noprags", PassFlag (add v_Opt_C) )
174 , ( "dppr-debug", PassFlag (add v_Opt_C) )
175 , ( "dppr-user-length", AnySuffix (add v_Opt_C) )
176 -- rest of the debugging flags are dynamic
178 ------- Interface files ---------------------------------------------
179 , ( "hi" , NoArg (writeIORef v_ProduceHi True) )
180 , ( "nohi" , NoArg (writeIORef v_ProduceHi False) )
182 --------- Profiling --------------------------------------------------
183 , ( "auto-dicts" , NoArg (add v_Opt_C "-fauto-sccs-on-dicts") )
184 , ( "auto-all" , NoArg (add v_Opt_C "-fauto-sccs-on-all-toplevs") )
185 , ( "auto" , NoArg (add v_Opt_C "-fauto-sccs-on-exported-toplevs") )
186 , ( "caf-all" , NoArg (add v_Opt_C "-fauto-sccs-on-individual-cafs") )
187 -- "ignore-sccs" doesn't work (ToDo)
189 , ( "no-auto-dicts" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-dicts") )
190 , ( "no-auto-all" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-all-toplevs") )
191 , ( "no-auto" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-exported-toplevs") )
192 , ( "no-caf-all" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-individual-cafs") )
194 ------- Miscellaneous -----------------------------------------------
195 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
197 ------- Output Redirection ------------------------------------------
198 , ( "odir" , HasArg (writeIORef v_Output_dir . Just) )
199 , ( "o" , SepArg (writeIORef v_Output_file . Just) )
200 , ( "osuf" , HasArg (writeIORef v_Object_suf . Just) )
201 , ( "hisuf" , HasArg (writeIORef v_Hi_suf) )
202 , ( "tmpdir" , HasArg (writeIORef v_TmpDir . (++ "/")) )
203 , ( "ohi" , HasArg (\s -> case s of
204 "-" -> writeIORef v_Hi_on_stdout True
205 _ -> writeIORef v_Output_hi (Just s)) )
208 , ( "keep-hc-file" , AnySuffix (\_ -> writeIORef v_Keep_hc_files True) )
209 , ( "keep-s-file" , AnySuffix (\_ -> writeIORef v_Keep_s_files True) )
210 , ( "keep-raw-s-file", AnySuffix (\_ -> writeIORef v_Keep_raw_s_files True) )
211 , ( "keep-tmp-files" , AnySuffix (\_ -> writeIORef v_Keep_tmp_files True) )
213 , ( "split-objs" , NoArg (if can_split
214 then do writeIORef v_Split_object_files True
215 add v_Opt_C "-fglobalise-toplev-names"
216 else hPutStrLn stderr
217 "warning: don't know how to split \
218 \object files on this architecture"
221 ------- Include/Import Paths ----------------------------------------
222 , ( "i" , OptPrefix (addToDirList v_Import_paths) )
223 , ( "I" , Prefix (addToDirList v_Include_paths) )
225 ------- Libraries ---------------------------------------------------
226 , ( "L" , Prefix (addToDirList v_Library_paths) )
227 , ( "l" , Prefix (add v_Cmdline_libraries) )
229 ------- Packages ----------------------------------------------------
230 , ( "package-name" , HasArg (\s -> add v_Opt_C ("-inpackage="++s)) )
232 , ( "package" , HasArg (addPackage) )
233 , ( "syslib" , HasArg (addPackage) ) -- for compatibility w/ old vsns
235 , ( "-list-packages" , NoArg (listPackages) )
236 , ( "-add-package" , NoArg (newPackage) )
237 , ( "-delete-package" , SepArg (deletePackage) )
239 ------- Specific phases --------------------------------------------
240 , ( "pgmL" , HasArg (writeIORef v_Pgm_L) )
241 , ( "pgmP" , HasArg (writeIORef v_Pgm_P) )
242 , ( "pgmc" , HasArg (writeIORef v_Pgm_c) )
243 , ( "pgmm" , HasArg (writeIORef v_Pgm_m) )
244 , ( "pgms" , HasArg (writeIORef v_Pgm_s) )
245 , ( "pgma" , HasArg (writeIORef v_Pgm_a) )
246 , ( "pgml" , HasArg (writeIORef v_Pgm_l) )
248 , ( "optdep" , HasArg (add v_Opt_dep) )
249 , ( "optl" , HasArg (add v_Opt_l) )
250 , ( "optdll" , HasArg (add v_Opt_dll) )
252 ------ Warning opts -------------------------------------------------
253 , ( "W" , NoArg (writeIORef v_Warning_opt W_) )
254 , ( "Wall" , NoArg (writeIORef v_Warning_opt W_all) )
255 , ( "Wnot" , NoArg (writeIORef v_Warning_opt W_not) )
256 , ( "w" , NoArg (writeIORef v_Warning_opt W_not) )
258 ----- Linker --------------------------------------------------------
259 , ( "static" , NoArg (writeIORef v_Static True) )
261 ----- RTS opts ------------------------------------------------------
263 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
266 ------ Compiler flags -----------------------------------------------
267 , ( "O2-for-C" , NoArg (writeIORef v_minus_o2_for_C True) )
268 , ( "O" , OptPrefix (setOptLevel) )
270 , ( "fno-asm-mangling" , NoArg (writeIORef v_Do_asm_mangling False) )
272 , ( "fmax-simplifier-iterations",
273 Prefix (writeIORef v_MaxSimplifierIterations . read) )
275 , ( "fusagesp" , NoArg (do writeIORef v_UsageSPInf True
276 add v_Opt_C "-fusagesp-on") )
278 , ( "fexcess-precision" , NoArg (do writeIORef v_Excess_precision True
279 add v_Opt_C "-fexcess-precision"))
281 -- flags that are "active negatives"
282 , ( "fno-implicit-prelude" , PassFlag (add v_Opt_C) )
283 , ( "fno-prune-tydecls" , PassFlag (add v_Opt_C) )
284 , ( "fno-prune-instdecls" , PassFlag (add v_Opt_C) )
285 , ( "fno-pre-inlining" , PassFlag (add v_Opt_C) )
287 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
288 , ( "fno-", PrefixPred (\s -> isStaticHscFlag ("f"++s))
289 (\s -> add v_Anti_opt_C ("-f"++s)) )
291 -- Pass all remaining "-f<blah>" options to hsc
292 , ( "f", AnySuffixPred (isStaticHscFlag) (add v_Opt_C) )
295 -----------------------------------------------------------------------------
296 -- parse the dynamic arguments
299 -- is the "baseline" dynamic flags, initialised from
300 -- the defaults and command line options.
303 -- is the dynamic flags for the current compilation. It is reset
304 -- to the value of v_InitDynFlags before each compilation, then
305 -- updated by reading any OPTIONS pragma in the current module.
307 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
308 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
311 dfs <- readIORef v_DynFlags
312 writeIORef v_DynFlags (f dfs)
314 getDynFlags :: IO DynFlags
315 getDynFlags = readIORef v_DynFlags
317 dynFlag :: (DynFlags -> a) -> IO a
318 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
320 setDynFlag f = updDynFlags (\dfs -> dfs{ flags = f : flags dfs })
321 unSetDynFlag f = updDynFlags (\dfs -> dfs{ flags = filter (/= f) (flags dfs) })
323 -- we can only change HscC to HscAsm and vice-versa with dynamic flags
324 -- (-fvia-C and -fasm).
326 dfs <- readIORef v_DynFlags
328 HscC -> writeIORef v_DynFlags dfs{ hscLang = l }
329 HscAsm -> writeIORef v_DynFlags dfs{ hscLang = l }
332 setVerbosityAtLeast n =
333 updDynFlags (\dfs -> if verbosity dfs < n
334 then dfs{ verbosity = n }
337 setVerbosity "" = updDynFlags (\dfs -> dfs{ verbosity = 2 })
339 | all isDigit n = updDynFlags (\dfs -> dfs{ verbosity = read n })
340 | otherwise = throwDyn (OtherError "can't parse verbosity flag (-v<n>)")
343 verb <- dynFlag verbosity
344 if verb >= 3 then return "-v" else return ""
348 ( "cpp", NoArg (updateState (\s -> s{ cpp_flag = True })) )
349 , ( "#include", HasArg (addCmdlineHCInclude) )
351 , ( "v", OptPrefix (setVerbosity) )
353 , ( "optL", HasArg (addOpt_L) )
354 , ( "optP", HasArg (addOpt_P) )
355 , ( "optc", HasArg (addOpt_c) )
356 , ( "optm", HasArg (addOpt_m) )
357 , ( "opta", HasArg (addOpt_a) )
359 ------ HsCpp opts ---------------------------------------------------
360 , ( "D", Prefix (\s -> addOpt_P ("-D'"++s++"'") ) )
361 , ( "U", Prefix (\s -> addOpt_P ("-U'"++s++"'") ) )
363 ------ Debugging ----------------------------------------------------
364 , ( "dstg-stats", NoArg (writeIORef v_StgStats True) )
366 , ( "ddump-absC", NoArg (setDynFlag Opt_D_dump_absC) )
367 , ( "ddump-asm", NoArg (setDynFlag Opt_D_dump_asm) )
368 , ( "ddump-cpranal", NoArg (setDynFlag Opt_D_dump_cpranal) )
369 , ( "ddump-deriv", NoArg (setDynFlag Opt_D_dump_deriv) )
370 , ( "ddump-ds", NoArg (setDynFlag Opt_D_dump_ds) )
371 , ( "ddump-flatC", NoArg (setDynFlag Opt_D_dump_flatC) )
372 , ( "ddump-foreign", NoArg (setDynFlag Opt_D_dump_foreign) )
373 , ( "ddump-inlinings", NoArg (setDynFlag Opt_D_dump_inlinings) )
374 , ( "ddump-occur-anal", NoArg (setDynFlag Opt_D_dump_occur_anal) )
375 , ( "ddump-parsed", NoArg (setDynFlag Opt_D_dump_parsed) )
376 , ( "ddump-realC", NoArg (setDynFlag Opt_D_dump_realC) )
377 , ( "ddump-rn", NoArg (setDynFlag Opt_D_dump_rn) )
378 , ( "ddump-simpl", NoArg (setDynFlag Opt_D_dump_simpl) )
379 , ( "ddump-simpl-iterations", NoArg (setDynFlag Opt_D_dump_simpl_iterations) )
380 , ( "ddump-spec", NoArg (setDynFlag Opt_D_dump_spec) )
381 , ( "ddump-stg", NoArg (setDynFlag Opt_D_dump_stg) )
382 , ( "ddump-stranal", NoArg (setDynFlag Opt_D_dump_stranal) )
383 , ( "ddump-tc", NoArg (setDynFlag Opt_D_dump_tc) )
384 , ( "ddump-types", NoArg (setDynFlag Opt_D_dump_types) )
385 , ( "ddump-rules", NoArg (setDynFlag Opt_D_dump_rules) )
386 , ( "ddump-usagesp", NoArg (setDynFlag Opt_D_dump_usagesp) )
387 , ( "ddump-cse", NoArg (setDynFlag Opt_D_dump_cse) )
388 , ( "ddump-worker-wrapper", NoArg (setDynFlag Opt_D_dump_worker_wrapper) )
389 , ( "dshow-passes", NoArg (setVerbosity "2") )
390 , ( "ddump-rn-trace", NoArg (setDynFlag Opt_D_dump_rn_trace) )
391 , ( "ddump-rn-stats", NoArg (setDynFlag Opt_D_dump_rn_stats) )
392 , ( "ddump-stix", NoArg (setDynFlag Opt_D_dump_stix) )
393 , ( "ddump-simpl-stats", NoArg (setDynFlag Opt_D_dump_simpl_stats) )
394 , ( "ddump-interpsyn", NoArg (setDynFlag Opt_D_dump_InterpSyn) )
395 , ( "dsource-stats", NoArg (setDynFlag Opt_D_source_stats) )
396 , ( "dverbose-core2core", NoArg (setDynFlag Opt_D_verbose_core2core) )
397 , ( "dverbose-stg2stg", NoArg (setDynFlag Opt_D_verbose_stg2stg) )
398 , ( "ddump-hi-diffs", NoArg (setDynFlag Opt_D_dump_hi_diffs) )
399 , ( "ddump-hi", NoArg (setDynFlag Opt_D_dump_hi) )
400 , ( "ddump-minimal-imports", NoArg (setDynFlag Opt_D_dump_minimal_imports) )
401 , ( "dcore-lint", NoArg (setDynFlag Opt_DoCoreLinting) )
402 , ( "dstg-lint", NoArg (setDynFlag Opt_DoStgLinting) )
403 , ( "dusagesp-lint", NoArg (setDynFlag Opt_DoUSPLinting) )
405 ------ Warnings ----------------------------------------------------
407 , ( "fwarn-duplicate-exports", NoArg (setDynFlag Opt_WarnDuplicateExports) )
408 , ( "fwarn-hi-shadowing", NoArg (setDynFlag Opt_WarnHiShadows) )
409 , ( "fwarn-incomplete-patterns", NoArg (setDynFlag Opt_WarnIncompletePatterns) )
410 , ( "fwarn-missing-fields", NoArg (setDynFlag Opt_WarnMissingFields) )
411 , ( "fwarn-missing-methods", NoArg (setDynFlag Opt_WarnMissingMethods))
412 , ( "fwarn-missing-signatures", NoArg (setDynFlag Opt_WarnMissingSigs) )
413 , ( "fwarn-name-shadowing", NoArg (setDynFlag Opt_WarnNameShadowing) )
414 , ( "fwarn-overlapping-patterns", NoArg (setDynFlag Opt_WarnOverlappingPatterns ) )
415 , ( "fwarn-simple-patterns", NoArg (setDynFlag Opt_WarnSimplePatterns))
416 , ( "fwarn-type-defaults", NoArg (setDynFlag Opt_WarnTypeDefaults) )
417 , ( "fwarn-unused-binds", NoArg (setDynFlag Opt_WarnUnusedBinds) )
418 , ( "fwarn-unused-imports", NoArg (setDynFlag Opt_WarnUnusedImports) )
419 , ( "fwarn-unused-matches", NoArg (setDynFlag Opt_WarnUnusedMatches) )
420 , ( "fwarn-deprecations", NoArg (setDynFlag Opt_WarnDeprecations) )
422 ------ Machine dependant (-m<blah>) stuff ---------------------------
424 , ( "monly-2-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 2}) ))
425 , ( "monly-3-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 3}) ))
426 , ( "monly-4-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 4}) ))
428 ------ Compiler flags -----------------------------------------------
430 , ( "fasm" , AnySuffix (\_ -> setLang HscAsm) )
432 , ( "fvia-c" , NoArg (setLang HscC) )
433 , ( "fvia-C" , NoArg (setLang HscC) )
435 , ( "fglasgow-exts", NoArg (setDynFlag Opt_GlasgowExts) )
436 , ( "fno-implicit-prelude", NoArg (setDynFlag Opt_NoImplicitPrelude) )
438 , ( "fallow-overlapping-instances",
439 NoArg (setDynFlag Opt_AllowOverlappingInstances) )
441 , ( "fallow-undecidable-instances",
442 NoArg (setDynFlag Opt_AllowUndecidableInstances) )
444 , ( "fgenerics", NoArg (setDynFlag Opt_Generics) )
446 , ( "freport-compile", NoArg (setDynFlag Opt_ReportCompile) )
449 -----------------------------------------------------------------------------
450 -- convert sizes like "3.5M" into integers
452 decodeSize :: String -> Integer
454 | c == "" = truncate n
455 | c == "K" || c == "k" = truncate (n * 1000)
456 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
457 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
458 | otherwise = throwDyn (OtherError ("can't decode size: " ++ str))
459 where (m, c) = span pred str
461 pred c = isDigit c || c == '.'
463 floatOpt :: IORef Double -> String -> IO ()
465 = writeIORef ref (read str :: Double)
468 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
471 -----------------------------------------------------------------------------
472 -- Build the Hsc static command line opts
474 buildStaticHscOpts :: IO [String]
475 buildStaticHscOpts = do
477 opt_C_ <- getStaticOpts v_Opt_C -- misc hsc opts from the command line
480 minus_o <- readIORef v_OptLevel
481 let optimisation_opts =
483 0 -> hsc_minusNoO_flags
484 1 -> hsc_minusO_flags
485 2 -> hsc_minusO2_flags
486 _ -> error "unknown opt level"
489 let stg_opts = [ "-flet-no-escape" ]
490 -- let-no-escape always on for now
492 -- take into account -fno-* flags by removing the equivalent -f*
493 -- flag from our list.
494 anti_flags <- getStaticOpts v_Anti_opt_C
495 let basic_opts = opt_C_ ++ optimisation_opts ++ stg_opts
496 filtered_opts = filter (`notElem` anti_flags) basic_opts
498 static <- (do s <- readIORef v_Static; if s then return "-static"
501 return ( static : filtered_opts )
503 -----------------------------------------------------------------------------
504 -- Running an external program
506 -- sigh, here because both DriverMkDepend & DriverPipeline need it.
508 runSomething phase_name cmd
510 verb <- dynFlag verbosity
511 when (verb >= 2) $ putStrLn ("*** " ++ phase_name)
512 when (verb >= 3) $ putStrLn cmd
516 n <- readIORef v_Dry_run
520 #ifndef mingw32_TARGET_OS
521 exit_code <- system cmd `catchAllIO`
522 (\_ -> throwDyn (PhaseFailed phase_name (ExitFailure 1)))
524 tmp <- newTempName "sh"
525 h <- openFile tmp WriteMode
528 exit_code <- system ("sh - " ++ tmp) `catchAllIO`
529 (\e -> throwDyn (PhaseFailed phase_name (ExitFailure 1)))
533 if exit_code /= ExitSuccess
534 then throwDyn (PhaseFailed phase_name exit_code)
535 else do when (verb >= 3) (putStr "\n")