1 -----------------------------------------------------------------------------
2 -- $Id: DriverFlags.hs,v 1.24 2000/11/24 09:51:39 simonpj Exp $
6 -- (c) Simon Marlow 2000
8 -----------------------------------------------------------------------------
10 module DriverFlags where
12 #include "HsVersions.h"
14 import PackageMaintenance
17 import TmpFiles ( v_TmpDir )
21 import TmpFiles ( newTempName )
22 import Directory ( removeFile )
30 -----------------------------------------------------------------------------
33 -- Flag parsing is now done in stages:
35 -- * parse the initial list of flags and remove any flags understood
36 -- by the driver only. Determine whether we're in multi-compilation
37 -- or single-compilation mode.
39 -- * gather the list of "static" hsc flags, and assign them to the global
40 -- static hsc flags variable.
42 -- * build the inital DynFlags from the remaining flags.
44 -- * complain if we've got any flags left over.
46 -- * for each source file: grab the OPTIONS, and build a new DynFlags
47 -- to pass to the compiler.
49 -----------------------------------------------------------------------------
50 -- Process command-line
53 = NoArg (IO ()) -- flag with no argument
54 | HasArg (String -> IO ()) -- flag has an argument (maybe prefix)
55 | SepArg (String -> IO ()) -- flag has a separate argument
56 | Prefix (String -> IO ()) -- flag is a prefix only
57 | OptPrefix (String -> IO ()) -- flag may be a prefix
58 | AnySuffix (String -> IO ()) -- flag is a prefix, pass whole arg to fn
59 | PassFlag (String -> IO ()) -- flag with no arg, pass flag to fn
60 | PrefixPred (String -> Bool) (String -> IO ())
61 | AnySuffixPred (String -> Bool) (String -> IO ())
63 processArgs :: [(String,OptKind)] -> [String] -> [String]
64 -> IO [String] -- returns spare args
65 processArgs _spec [] spare = return (reverse spare)
66 processArgs spec args@(('-':arg):args') spare = do
67 case findArg spec arg of
69 do args' <- processOneArg action rest args
70 processArgs spec args' spare
72 processArgs spec args' (('-':arg):spare)
73 processArgs spec (arg:args) spare =
74 processArgs spec args (arg:spare)
76 processOneArg :: OptKind -> String -> [String] -> IO [String]
77 processOneArg action rest (dash_arg@('-':arg):args) =
81 then io >> return args
82 else unknownFlagErr dash_arg
86 then fio rest >> return args
88 [] -> unknownFlagErr dash_arg
89 (arg1:args1) -> fio arg1 >> return args1
93 [] -> unknownFlagErr dash_arg
94 (arg1:args1) -> fio arg1 >> return args1
98 then fio rest >> return args
99 else unknownFlagErr dash_arg
103 then fio rest >> return args
104 else unknownFlagErr dash_arg
106 OptPrefix fio -> fio rest >> return args
108 AnySuffix fio -> fio dash_arg >> return args
110 AnySuffixPred p fio -> fio dash_arg >> return args
114 then unknownFlagErr dash_arg
115 else fio dash_arg >> return args
117 findArg :: [(String,OptKind)] -> String -> Maybe (String,OptKind)
119 = case [ (remove_spaces rest, k)
120 | (pat,k) <- spec, Just rest <- [my_prefix_match pat arg],
126 arg_ok (NoArg _) rest arg = null rest
127 arg_ok (HasArg _) rest arg = True
128 arg_ok (SepArg _) rest arg = null rest
129 arg_ok (Prefix _) rest arg = not (null rest)
130 arg_ok (PrefixPred p _) rest arg = not (null rest) && p rest
131 arg_ok (OptPrefix _) rest arg = True
132 arg_ok (PassFlag _) rest arg = null rest
133 arg_ok (AnySuffix _) rest arg = True
134 arg_ok (AnySuffixPred p _) rest arg = p arg
136 -----------------------------------------------------------------------------
139 -- note that ordering is important in the following list: any flag which
140 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
141 -- flags further down the list with the same prefix.
144 [ ------- help -------------------------------------------------------
145 ( "?" , NoArg long_usage)
146 , ( "-help" , NoArg long_usage)
149 ------- version ----------------------------------------------------
150 , ( "-version" , NoArg (do hPutStrLn stdout (cProjectName
151 ++ ", version " ++ cProjectVersion)
152 exitWith ExitSuccess))
153 , ( "-numeric-version", NoArg (do hPutStrLn stdout cProjectVersion
154 exitWith ExitSuccess))
156 ------- verbosity ----------------------------------------------------
157 , ( "n" , NoArg (writeIORef v_Dry_run True) )
159 ------- recompilation checker --------------------------------------
160 , ( "recomp" , NoArg (writeIORef v_Recomp True) )
161 , ( "no-recomp" , NoArg (writeIORef v_Recomp False) )
163 ------- ways --------------------------------------------------------
164 , ( "prof" , NoArg (addNoDups v_Ways WayProf) )
165 , ( "unreg" , NoArg (addNoDups v_Ways WayUnreg) )
166 , ( "ticky" , NoArg (addNoDups v_Ways WayTicky) )
167 , ( "parallel" , NoArg (addNoDups v_Ways WayPar) )
168 , ( "gransim" , NoArg (addNoDups v_Ways WayGran) )
169 , ( "smp" , NoArg (addNoDups v_Ways WaySMP) )
170 , ( "debug" , NoArg (addNoDups v_Ways WayDebug) )
173 ------ Debugging ----------------------------------------------------
174 , ( "dppr-noprags", PassFlag (add v_Opt_C) )
175 , ( "dppr-debug", PassFlag (add v_Opt_C) )
176 , ( "dppr-user-length", AnySuffix (add v_Opt_C) )
177 -- rest of the debugging flags are dynamic
179 ------- Interface files ---------------------------------------------
180 , ( "hi" , NoArg (writeIORef v_ProduceHi True) )
181 , ( "nohi" , NoArg (writeIORef v_ProduceHi False) )
183 --------- Profiling --------------------------------------------------
184 , ( "auto-dicts" , NoArg (add v_Opt_C "-fauto-sccs-on-dicts") )
185 , ( "auto-all" , NoArg (add v_Opt_C "-fauto-sccs-on-all-toplevs") )
186 , ( "auto" , NoArg (add v_Opt_C "-fauto-sccs-on-exported-toplevs") )
187 , ( "caf-all" , NoArg (add v_Opt_C "-fauto-sccs-on-individual-cafs") )
188 -- "ignore-sccs" doesn't work (ToDo)
190 , ( "no-auto-dicts" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-dicts") )
191 , ( "no-auto-all" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-all-toplevs") )
192 , ( "no-auto" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-exported-toplevs") )
193 , ( "no-caf-all" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-individual-cafs") )
195 ------- Miscellaneous -----------------------------------------------
196 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
198 ------- Output Redirection ------------------------------------------
199 , ( "odir" , HasArg (writeIORef v_Output_dir . Just) )
200 , ( "o" , SepArg (writeIORef v_Output_file . Just) )
201 , ( "osuf" , HasArg (writeIORef v_Object_suf . Just) )
202 , ( "hisuf" , HasArg (writeIORef v_Hi_suf) )
203 , ( "tmpdir" , HasArg (writeIORef v_TmpDir . (++ "/")) )
204 , ( "ohi" , HasArg (\s -> case s of
205 "-" -> writeIORef v_Hi_on_stdout True
206 _ -> writeIORef v_Output_hi (Just s)) )
209 , ( "keep-hc-file" , AnySuffix (\_ -> writeIORef v_Keep_hc_files True) )
210 , ( "keep-s-file" , AnySuffix (\_ -> writeIORef v_Keep_s_files True) )
211 , ( "keep-raw-s-file", AnySuffix (\_ -> writeIORef v_Keep_raw_s_files True) )
212 , ( "keep-tmp-files" , AnySuffix (\_ -> writeIORef v_Keep_tmp_files True) )
214 , ( "split-objs" , NoArg (if can_split
215 then do writeIORef v_Split_object_files True
216 add v_Opt_C "-fglobalise-toplev-names"
217 else hPutStrLn stderr
218 "warning: don't know how to split \
219 \object files on this architecture"
222 ------- Include/Import Paths ----------------------------------------
223 , ( "i" , OptPrefix (addToDirList v_Import_paths) )
224 , ( "I" , Prefix (addToDirList v_Include_paths) )
226 ------- Libraries ---------------------------------------------------
227 , ( "L" , Prefix (addToDirList v_Library_paths) )
228 , ( "l" , Prefix (add v_Cmdline_libraries) )
230 ------- Packages ----------------------------------------------------
231 , ( "package-name" , HasArg (\s -> add v_Opt_C ("-inpackage="++s)) )
233 , ( "package" , HasArg (addPackage) )
234 , ( "syslib" , HasArg (addPackage) ) -- for compatibility w/ old vsns
236 , ( "-list-packages" , NoArg (listPackages) )
237 , ( "-add-package" , NoArg (newPackage) )
238 , ( "-delete-package" , SepArg (deletePackage) )
240 ------- Specific phases --------------------------------------------
241 , ( "pgmL" , HasArg (writeIORef v_Pgm_L) )
242 , ( "pgmP" , HasArg (writeIORef v_Pgm_P) )
243 , ( "pgmc" , HasArg (writeIORef v_Pgm_c) )
244 , ( "pgmm" , HasArg (writeIORef v_Pgm_m) )
245 , ( "pgms" , HasArg (writeIORef v_Pgm_s) )
246 , ( "pgma" , HasArg (writeIORef v_Pgm_a) )
247 , ( "pgml" , HasArg (writeIORef v_Pgm_l) )
249 , ( "optdep" , HasArg (add v_Opt_dep) )
250 , ( "optl" , HasArg (add v_Opt_l) )
251 , ( "optdll" , HasArg (add v_Opt_dll) )
253 ------ Warning opts -------------------------------------------------
254 , ( "W" , NoArg (writeIORef v_Warning_opt W_) )
255 , ( "Wall" , NoArg (writeIORef v_Warning_opt W_all) )
256 , ( "Wnot" , NoArg (writeIORef v_Warning_opt W_not) )
257 , ( "w" , NoArg (writeIORef v_Warning_opt W_not) )
259 ----- Linker --------------------------------------------------------
260 , ( "static" , NoArg (writeIORef v_Static True) )
262 ----- RTS opts ------------------------------------------------------
264 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
267 ------ Compiler flags -----------------------------------------------
268 , ( "O2-for-C" , NoArg (writeIORef v_minus_o2_for_C True) )
269 , ( "O" , OptPrefix (setOptLevel) )
271 , ( "fno-asm-mangling" , NoArg (writeIORef v_Do_asm_mangling False) )
273 , ( "fmax-simplifier-iterations",
274 Prefix (writeIORef v_MaxSimplifierIterations . read) )
276 , ( "fusagesp" , NoArg (do writeIORef v_UsageSPInf True
277 add v_Opt_C "-fusagesp-on") )
279 , ( "fexcess-precision" , NoArg (do writeIORef v_Excess_precision True
280 add v_Opt_C "-fexcess-precision"))
282 -- flags that are "active negatives"
283 , ( "fno-implicit-prelude" , PassFlag (add v_Opt_C) )
284 , ( "fno-prune-tydecls" , PassFlag (add v_Opt_C) )
285 , ( "fno-prune-instdecls" , PassFlag (add v_Opt_C) )
286 , ( "fno-pre-inlining" , PassFlag (add v_Opt_C) )
288 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
289 , ( "fno-", PrefixPred (\s -> isStaticHscFlag ("f"++s))
290 (\s -> add v_Anti_opt_C ("-f"++s)) )
292 -- Pass all remaining "-f<blah>" options to hsc
293 , ( "f", AnySuffixPred (isStaticHscFlag) (add v_Opt_C) )
296 -----------------------------------------------------------------------------
297 -- parse the dynamic arguments
300 -- is the "baseline" dynamic flags, initialised from
301 -- the defaults and command line options.
304 -- is the dynamic flags for the current compilation. It is reset
305 -- to the value of v_InitDynFlags before each compilation, then
306 -- updated by reading any OPTIONS pragma in the current module.
308 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
309 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
312 dfs <- readIORef v_DynFlags
313 writeIORef v_DynFlags (f dfs)
315 getDynFlags :: IO DynFlags
316 getDynFlags = readIORef v_DynFlags
318 dynFlag :: (DynFlags -> a) -> IO a
319 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
321 setDynFlag f = updDynFlags (\dfs -> dfs{ flags = f : flags dfs })
322 unSetDynFlag f = updDynFlags (\dfs -> dfs{ flags = filter (/= f) (flags dfs) })
324 -- we can only change HscC to HscAsm and vice-versa with dynamic flags
325 -- (-fvia-C and -fasm).
327 dfs <- readIORef v_DynFlags
329 HscC -> writeIORef v_DynFlags dfs{ hscLang = l }
330 HscAsm -> writeIORef v_DynFlags dfs{ hscLang = l }
333 setVerbosityAtLeast n =
334 updDynFlags (\dfs -> if verbosity dfs < n
335 then dfs{ verbosity = n }
338 setVerbosity "" = updDynFlags (\dfs -> dfs{ verbosity = 2 })
340 | all isDigit n = updDynFlags (\dfs -> dfs{ verbosity = read n })
341 | otherwise = throwDyn (OtherError "can't parse verbosity flag (-v<n>)")
344 verb <- dynFlag verbosity
345 if verb >= 3 then return "-v" else return ""
349 ( "cpp", NoArg (updateState (\s -> s{ cpp_flag = True })) )
350 , ( "#include", HasArg (addCmdlineHCInclude) )
352 , ( "v", OptPrefix (setVerbosity) )
354 , ( "optL", HasArg (addOpt_L) )
355 , ( "optP", HasArg (addOpt_P) )
356 , ( "optc", HasArg (addOpt_c) )
357 , ( "optm", HasArg (addOpt_m) )
358 , ( "opta", HasArg (addOpt_a) )
360 ------ HsCpp opts ---------------------------------------------------
361 , ( "D", Prefix (\s -> addOpt_P ("-D'"++s++"'") ) )
362 , ( "U", Prefix (\s -> addOpt_P ("-U'"++s++"'") ) )
364 ------ Debugging ----------------------------------------------------
365 , ( "dstg-stats", NoArg (writeIORef v_StgStats True) )
367 , ( "ddump-absC", NoArg (setDynFlag Opt_D_dump_absC) )
368 , ( "ddump-asm", NoArg (setDynFlag Opt_D_dump_asm) )
369 , ( "ddump-cpranal", NoArg (setDynFlag Opt_D_dump_cpranal) )
370 , ( "ddump-deriv", NoArg (setDynFlag Opt_D_dump_deriv) )
371 , ( "ddump-ds", NoArg (setDynFlag Opt_D_dump_ds) )
372 , ( "ddump-flatC", NoArg (setDynFlag Opt_D_dump_flatC) )
373 , ( "ddump-foreign", NoArg (setDynFlag Opt_D_dump_foreign) )
374 , ( "ddump-inlinings", NoArg (setDynFlag Opt_D_dump_inlinings) )
375 , ( "ddump-occur-anal", NoArg (setDynFlag Opt_D_dump_occur_anal) )
376 , ( "ddump-parsed", NoArg (setDynFlag Opt_D_dump_parsed) )
377 , ( "ddump-realC", NoArg (setDynFlag Opt_D_dump_realC) )
378 , ( "ddump-rn", NoArg (setDynFlag Opt_D_dump_rn) )
379 , ( "ddump-simpl", NoArg (setDynFlag Opt_D_dump_simpl) )
380 , ( "ddump-simpl-iterations", NoArg (setDynFlag Opt_D_dump_simpl_iterations) )
381 , ( "ddump-spec", NoArg (setDynFlag Opt_D_dump_spec) )
382 , ( "ddump-stg", NoArg (setDynFlag Opt_D_dump_stg) )
383 , ( "ddump-stranal", NoArg (setDynFlag Opt_D_dump_stranal) )
384 , ( "ddump-tc", NoArg (setDynFlag Opt_D_dump_tc) )
385 , ( "ddump-types", NoArg (setDynFlag Opt_D_dump_types) )
386 , ( "ddump-rules", NoArg (setDynFlag Opt_D_dump_rules) )
387 , ( "ddump-usagesp", NoArg (setDynFlag Opt_D_dump_usagesp) )
388 , ( "ddump-cse", NoArg (setDynFlag Opt_D_dump_cse) )
389 , ( "ddump-worker-wrapper", NoArg (setDynFlag Opt_D_dump_worker_wrapper) )
390 , ( "dshow-passes", NoArg (setVerbosity "2") )
391 , ( "ddump-rn-trace", NoArg (setDynFlag Opt_D_dump_rn_trace) )
392 , ( "ddump-rn-stats", NoArg (setDynFlag Opt_D_dump_rn_stats) )
393 , ( "ddump-stix", NoArg (setDynFlag Opt_D_dump_stix) )
394 , ( "ddump-simpl-stats", NoArg (setDynFlag Opt_D_dump_simpl_stats) )
395 , ( "ddump-interpsyn", NoArg (setDynFlag Opt_D_dump_InterpSyn) )
396 , ( "dsource-stats", NoArg (setDynFlag Opt_D_source_stats) )
397 , ( "dverbose-core2core", NoArg (setDynFlag Opt_D_verbose_core2core) )
398 , ( "dverbose-stg2stg", NoArg (setDynFlag Opt_D_verbose_stg2stg) )
399 , ( "ddump-hi-diffs", NoArg (setDynFlag Opt_D_dump_hi_diffs) )
400 , ( "ddump-hi", NoArg (setDynFlag Opt_D_dump_hi) )
401 , ( "ddump-minimal-imports", NoArg (setDynFlag Opt_D_dump_minimal_imports) )
402 , ( "dcore-lint", NoArg (setDynFlag Opt_DoCoreLinting) )
403 , ( "dstg-lint", NoArg (setDynFlag Opt_DoStgLinting) )
404 , ( "dusagesp-lint", NoArg (setDynFlag Opt_DoUSPLinting) )
406 ------ Warnings ----------------------------------------------------
408 , ( "fwarn-duplicate-exports", NoArg (setDynFlag Opt_WarnDuplicateExports) )
409 , ( "fwarn-hi-shadowing", NoArg (setDynFlag Opt_WarnHiShadows) )
410 , ( "fwarn-incomplete-patterns", NoArg (setDynFlag Opt_WarnIncompletePatterns) )
411 , ( "fwarn-missing-fields", NoArg (setDynFlag Opt_WarnMissingFields) )
412 , ( "fwarn-missing-methods", NoArg (setDynFlag Opt_WarnMissingMethods))
413 , ( "fwarn-missing-signatures", NoArg (setDynFlag Opt_WarnMissingSigs) )
414 , ( "fwarn-name-shadowing", NoArg (setDynFlag Opt_WarnNameShadowing) )
415 , ( "fwarn-overlapping-patterns", NoArg (setDynFlag Opt_WarnOverlappingPatterns ) )
416 , ( "fwarn-simple-patterns", NoArg (setDynFlag Opt_WarnSimplePatterns))
417 , ( "fwarn-type-defaults", NoArg (setDynFlag Opt_WarnTypeDefaults) )
418 , ( "fwarn-unused-binds", NoArg (setDynFlag Opt_WarnUnusedBinds) )
419 , ( "fwarn-unused-imports", NoArg (setDynFlag Opt_WarnUnusedImports) )
420 , ( "fwarn-unused-matches", NoArg (setDynFlag Opt_WarnUnusedMatches) )
421 , ( "fwarn-deprecations", NoArg (setDynFlag Opt_WarnDeprecations) )
423 ------ Machine dependant (-m<blah>) stuff ---------------------------
425 , ( "monly-2-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 2}) ))
426 , ( "monly-3-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 3}) ))
427 , ( "monly-4-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 4}) ))
429 ------ Compiler flags -----------------------------------------------
431 , ( "fasm" , AnySuffix (\_ -> setLang HscAsm) )
433 , ( "fvia-c" , NoArg (setLang HscC) )
434 , ( "fvia-C" , NoArg (setLang HscC) )
436 , ( "fglasgow-exts", NoArg (setDynFlag Opt_GlasgowExts) )
437 , ( "fno-implicit-prelude", NoArg (setDynFlag Opt_NoImplicitPrelude) )
439 , ( "fallow-overlapping-instances",
440 NoArg (setDynFlag Opt_AllowOverlappingInstances) )
442 , ( "fallow-undecidable-instances",
443 NoArg (setDynFlag Opt_AllowUndecidableInstances) )
445 , ( "fgenerics", NoArg (setDynFlag Opt_Generics) )
447 , ( "freport-compile", NoArg (setDynFlag Opt_ReportCompile) )
450 -----------------------------------------------------------------------------
451 -- convert sizes like "3.5M" into integers
453 decodeSize :: String -> Integer
455 | c == "" = truncate n
456 | c == "K" || c == "k" = truncate (n * 1000)
457 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
458 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
459 | otherwise = throwDyn (OtherError ("can't decode size: " ++ str))
460 where (m, c) = span pred str
462 pred c = isDigit c || c == '.'
464 floatOpt :: IORef Double -> String -> IO ()
466 = writeIORef ref (read str :: Double)
469 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
472 -----------------------------------------------------------------------------
473 -- Build the Hsc static command line opts
475 buildStaticHscOpts :: IO [String]
476 buildStaticHscOpts = do
478 opt_C_ <- getStaticOpts v_Opt_C -- misc hsc opts from the command line
481 minus_o <- readIORef v_OptLevel
482 let optimisation_opts =
484 0 -> hsc_minusNoO_flags
485 1 -> hsc_minusO_flags
486 2 -> hsc_minusO2_flags
487 _ -> error "unknown opt level"
490 let stg_opts = [ "-flet-no-escape" ]
491 -- let-no-escape always on for now
493 -- take into account -fno-* flags by removing the equivalent -f*
494 -- flag from our list.
495 anti_flags <- getStaticOpts v_Anti_opt_C
496 let basic_opts = opt_C_ ++ optimisation_opts ++ stg_opts
497 filtered_opts = filter (`notElem` anti_flags) basic_opts
499 static <- (do s <- readIORef v_Static; if s then return "-static"
502 return ( static : filtered_opts )
504 -----------------------------------------------------------------------------
505 -- Running an external program
507 -- sigh, here because both DriverMkDepend & DriverPipeline need it.
509 runSomething phase_name cmd
511 verb <- dynFlag verbosity
512 when (verb >= 2) $ putStrLn ("*** " ++ phase_name)
513 when (verb >= 3) $ putStrLn cmd
517 n <- readIORef v_Dry_run
521 #ifndef mingw32_TARGET_OS
522 exit_code <- system cmd `catchAllIO`
523 (\_ -> throwDyn (PhaseFailed phase_name (ExitFailure 1)))
525 tmp <- newTempName "sh"
526 h <- openFile tmp WriteMode
529 exit_code <- system ("sh - " ++ tmp) `catchAllIO`
530 (\e -> throwDyn (PhaseFailed phase_name (ExitFailure 1)))
534 if exit_code /= ExitSuccess
535 then throwDyn (PhaseFailed phase_name exit_code)
536 else do when (verb >= 3) (putStr "\n")