3Description : Coordinates the compilation process.
6Maintainer : The Idris Community.
8{-# LANGUAGE CPP, FlexibleContexts, PatternGuards, TypeSynonymInstances #-}
10module IRTS.Compiler(compile, generate) where
14import Idris.Core.CaseTree
15import Idris.Core.Evaluate
22import IRTS.CodegenCommon
23import IRTS.Defunctionalise
31import Prelude hiding (id, (.))
33import Control.Category
34import Control.Monad.State
36import qualified Data.Map as M
38import qualified Data.Set as S
39import System.Directory
44-- | Compile to simplified forms and return CodegenInfo
45compile :: Codegen -> FilePath -> Maybe Term -> Idris CodegenInfo
46compile codegen f mtm = do
47 logCodeGen 1 "Compiling Output."
48 iReport 2 "Compiling Output."
49 checkMVs -- check for undefined metavariables
50 checkTotality -- refuse to compile if there are totality problems
51 exports <- findExports
52 let rootNames = case mtm of
56 logCodeGen 1 "Running Erasure Analysis"
57 iReport 3 "Running Erasure Analysis"
58 reachableNames <- performUsageAnalysis
59 (rootNames ++ getExpNames exports)
60 maindef <- case mtm of
62 Just tm -> do md <- irMain tm
63 logCodeGen 1 $ "MAIN: " ++ show md
64 return [(sMN 0 "runMain", md)]
65 objs <- getObjectFiles codegen
66 libs <- getLibs codegen
67 flags <- getFlags codegen
68 hdrs <- getHdrs codegen
69 impdirs <- rankedImportDirs f
70 ttDeclarations <- getDeclarations reachableNames
71 defsIn <- mkDecls reachableNames
72 -- if no 'main term' given, generate interface files
73 let iface = case mtm of
77 let defs = defsIn ++ maindef
79 -- Inlined top level LDecl made here
80 let defsInlined = inlineAll defs
81 let defsUniq = map (allocUnique (addAlist defsInlined emptyContext))
84 logCodeGen 1 "Inlining"
86 dumpCases <- getDumpCases
89 Just f -> runIO $ writeFile f (showCaseTrees defsUniq)
91 let (nexttag, tagged) = addTags 65536 (liftAll defsInlined)
92 let ctxtIn = addAlist tagged emptyContext
94 logCodeGen 1 "Defunctionalising"
95 iReport 3 "Defunctionalising"
96 let defuns_in = defunctionalise nexttag ctxtIn
97 logCodeGen 5 $ show defuns_in
98 logCodeGen 1 "Inlining"
100 let defuns = inline defuns_in
101 logCodeGen 5 $ show defuns
102 logCodeGen 1 "Resolving variables for CG"
104 let checked = simplifyDefs defuns (toAlist defuns)
106 dumpDefun <- getDumpDefun
109 Just f -> runIO $ writeFile f (dumpDefuns defuns)
110 triple <- Idris.AbsSyntax.targetTriple
111 cpu <- Idris.AbsSyntax.targetCPU
112 logCodeGen 1 "Generating Code."
113 iReport 2 "Generating Code."
115 OK c -> do return $ CodegenInfo f outty triple cpu
116 hdrs impdirs objs libs flags
117 NONE c (toAlist defuns)
121 where checkMVs = do i <- getIState
122 case map fst (idris_metavars i) \\ primDefs of
124 ms -> do iputStrLn $ "WARNING: There are incomplete holes:\n " ++ show ms
125 iputStrLn "\nEvaluation of any of these will crash at run time."
127 checkTotality = do i <- getIState
128 case idris_totcheckfail i of
130 ((fc, msg):fs) -> ierror . At fc . Msg $ "Cannot compile:\n " ++ msg
132generate :: Codegen -> FilePath -> CodegenInfo -> IO ()
133generate codegen mainmod ir
135 -- Built-in code generators (FIXME: lift these out!)
136 Via _ "c" -> codegenC ir
137 -- Any external code generator
138 Via fm cg -> do input <- case fm of
139 IBCFormat -> return mainmod
141 tempdir <- getTemporaryDirectory
142 (fn, h) <- openTempFile tempdir "idris-cg.json"
146 let cmd = "idris-codegen-" ++ cg
147 args = [input, "-o", outputFile ir] ++ compilerFlags ir
148 exit <- rawSystem cmd (if interfaces ir then "--interface" : args else args)
149 when (exit /= ExitSuccess) $
150 putStrLn ("FAILURE: " ++ show cmd ++ " " ++ show args)
151 Bytecode -> dumpBC (simpleDecls ir) (outputFile ir)
153irMain :: TT Name -> Idris LDecl
155 i <- irTerm (sMN 0 "runMain") M.empty [] tm
156 return $ LFun [] (sMN 0 "runMain") [] (LForce i)
158mkDecls :: [Name] -> Idris [(Name, LDecl)]
161 let ds = filter (\(n, d) -> n `elem` used || isCon d) $ ctxtAlist (tt_ctxt i)
162 decls <- mapM build ds
165getDeclarations :: [Name] -> Idris ([(Name, TTDecl)])
168 let ds = filter (\(n, (d,_,_,_,_,_)) -> n `elem` used || isCon d) $ ((toAlist . definitions . tt_ctxt) i)
171showCaseTrees :: [(Name, LDecl)] -> String
172showCaseTrees = showSep "\n\n" . map showCT . sortBy (comparing defnRank)
174 showCT (n, LFun opts f args lexp)
176 show n ++ " " ++ showSep " " (map show args) ++ " =\n\t"
179 showOpts | Inline `elem` opts = "%inline "
181 showCT (n, LConstructor c t a) = "data " ++ show n ++ " " ++ show a
183 defnRank :: (Name, LDecl) -> String
184 defnRank (n, LFun _ _ _ _) = "1" ++ nameRank n
185 defnRank (n, LConstructor _ _ _) = "2" ++ nameRank n
187 nameRank :: Name -> String
188 nameRank (UN s) = "1" ++ show s
189 nameRank (MN i s) = "2" ++ show s ++ show i
190 nameRank (NS n ns) = "3" ++ concatMap show (reverse ns) ++ nameRank n
191 nameRank (SN sn) = "4" ++ snRank sn
192 nameRank n = "5" ++ show n
194 snRank :: SpecialName -> String
195 snRank (WhereN i n n') = "1" ++ nameRank n' ++ nameRank n ++ show i
196 snRank (ImplementationN n args) = "2" ++ nameRank n ++ concatMap show args
197 snRank (ParentN n s) = "3" ++ nameRank n ++ show s
198 snRank (MethodN n) = "4" ++ nameRank n
199 snRank (CaseN _ n) = "5" ++ nameRank n
200 snRank (ElimN n) = "6" ++ nameRank n
201 snRank (ImplementationCtorN n) = "7" ++ nameRank n
202 snRank (WithN i n) = "8" ++ nameRank n ++ show i
204isCon (TyDecl _ _) = True
207build :: (Name, Def) -> Idris (Name, LDecl)
212 let args = map (\x -> sMN x "op") [0..] in
213 return (n, (LFun [] n (take ar args)
214 (LOp op (map LV (take ar args)))))
215 _ -> do def <- mkLDecl n d
216 logCodeGen 3 $ "Compiled " ++ show n ++ " =\n\t" ++ show def
219 | Just (ar, op) <- lookup n (idris_scprims i)
221 | Just ar <- lookup n (S.toList (idris_externs i))
222 = Just (ar, LExternal n)
223 getPrim n i = Nothing
225declArgs args inl n (LLam xs x) = declArgs (args ++ xs) inl n x
226declArgs args inl n x = LFun (if inl then [Inline] else []) n args x
228mkLDecl n (Function tm _)
229 = declArgs [] True n <$> irTerm n M.empty [] tm
231mkLDecl n (CaseOp ci _ _ _ pats cd)
232 = declArgs [] (case_inlinable ci || caseName n) n <$> irTree n args sc
234 (args, sc) = cases_runtime cd
236 -- Always attempt to inline functions arising from 'case' expressions
237 caseName (SN (CaseN _ _)) = True
238 caseName (SN (WithN _ _)) = True
239 caseName (NS n _) = caseName n
242mkLDecl n (TyDecl (DCon tag arity _) _) =
243 LConstructor n tag . length <$> fgetState (cg_usedpos . ist_callgraph n)
245mkLDecl n (TyDecl (TCon t a) _) = return $ LConstructor n (-1) a
246mkLDecl n _ = return $ (declArgs [] True n LNothing) -- postulate, never run
249 { viMethod :: Maybe Name
253type Vars = M.Map Name VarInfo
255irTerm :: Name -> Vars -> [Name] -> Term -> Idris LExp
256irTerm top vs env tm@(App _ f a) = do
260 | n `elem` map fst (idris_metavars ist) \\ primDefs
261 -> return $ LError $ "ABORT: Attempt to evaluate hole " ++ show n
263 | m == txt "mkForeignPrim"
264 -> doForeign vs env (reverse (drop 4 args)) -- drop implicits
266 (P _ (UN u) _, [_, arg])
267 | u == txt "unsafePerformPrimIO"
268 -> irTerm top vs env arg
271 | u == txt "assert_unreachable"
272 -> return $ LError $ "ABORT: Reached an unreachable case in " ++ show top
274 (P _ (UN u) _, [_, msg])
275 | u == txt "idris_crash"
276 -> do msg' <- irTerm top vs env msg
277 return $ LOp LCrash [msg']
279 -- TMP HACK - until we get inlining.
280 (P _ (UN r) _, [_, _, _, _, _, arg])
282 -> irTerm top vs env arg
284 -- 'void' doesn't have any pattern clauses and only gets called on
285 -- erased things in higher order contexts (also a TMP HACK...)
290 -- Laziness, the old way
291 (P _ (UN l) _, [_, arg])
293 -> error "lazy has crept in somehow"
295 (P _ (UN l) _, [_, arg])
297 -> LForce <$> irTerm top vs env arg
299 -- Laziness, the new way
300 (P _ (UN l) _, [_, _, arg])
302 -> LLazyExp <$> irTerm top vs env arg
304 (P _ (UN l) _, [_, _, arg])
306 -> LForce <$> irTerm top vs env arg
308 (P _ (UN a) _, [_, _, _, arg])
309 | a == txt "assert_smaller"
310 -> irTerm top vs env arg
312 (P _ (UN a) _, [_, arg])
313 | a == txt "assert_total"
314 -> irTerm top vs env arg
316 (P _ (UN p) _, [_, arg])
318 -> do arg' <- irTerm top vs env arg
319 return $ LOp LPar [LLazyExp arg']
321 (P _ (UN pf) _, [arg])
322 | pf == txt "prim_fork"
323 -> do arg' <- irTerm top vs env arg
324 return $ LOp LFork [LLazyExp arg']
326 (P _ (UN m) _, [_,size,t])
328 -> irTerm top vs env t
330 (P _ (UN tm) _, [_,t])
331 | tm == txt "trace_malloc"
332 -> irTerm top vs env t -- TODO
334 -- This case is here until we get more general inlining. It's just
335 -- a really common case, and the laziness hurts...
336 (P _ (NS (UN be) [b,p]) _, [_,x,(App _ (App _ (App _ (P _ (UN d) _) _) _) t),
337 (App _ (App _ (App _ (P _ (UN d') _) _) _) e)])
338 | be == txt "ifThenElse"
344 x' <- irTerm top vs env x
345 t' <- irTerm top vs env t
346 e' <- irTerm top vs env e
347 return (LCase Shared x'
348 [LConCase 0 (sNS (sUN "False") ["Bool","Prelude"]) [] e'
349 ,LConCase 1 (sNS (sUN "True" ) ["Bool","Prelude"]) [] t'
353 (P (DCon t arity _) n _, args) -> do
354 detag <- fgetState (opt_detaggable . ist_optimisation n)
355 used <- map fst <$> fgetState (cg_usedpos . ist_callgraph n)
357 let isNewtype = length used == 1 && detag
358 let argsPruned = [a | (i,a) <- zip [0..] args, i `elem` used]
360 -- The following code removes fields from data constructors
361 -- and performs the newtype optimisation.
363 -- The general rule here is:
364 -- Everything we get as input is not touched by erasure,
365 -- so it conforms to the official arities and types
366 -- and we can reason about it like it's plain TT.
368 -- It's only the data that leaves this point that's erased
369 -- and possibly no longer typed as the original TT version.
371 -- Especially, underapplied constructors must yield functions
372 -- even if all the remaining arguments are erased
373 -- (the resulting function *will* be applied, to NULLs).
375 -- This will probably need rethinking when we get erasure from functions.
377 -- "padLams" will wrap our term in LLam-bdas and give us
378 -- the "list of future unerased args" coming from these lambdas.
380 -- We can do whatever we like with the list of unerased args,
381 -- hence it takes a lambda: \unerased_argname_list -> resulting_LExp.
382 let padLams = padLambdas used (length args) arity
384 case compare (length args) arity of
387 GT -> ifail ("overapplied data constructor: " ++ show tm ++
389 "Arity: " ++ show arity ++ "\n" ++
390 "Arguments: " ++ show args ++ "\n" ++
391 "Pruned arguments: " ++ show argsPruned)
395 -> irTerm top vs env (head argsPruned)
397 | otherwise -- not newtype, plain data ctor
398 -> buildApp (LV n) argsPruned
400 -- not saturated, underapplied
401 LT | isNewtype -- newtype
402 , length argsPruned == 1 -- and we already have the value
403 -> padLams . (\tm [] -> tm) -- the [] asserts there are no unerased args
404 <$> irTerm top vs env (head argsPruned)
406 | isNewtype -- newtype but the value is not among args yet
407 -> return . padLams $ \[vn] -> LApp False (LV n) [LV vn]
409 -- not a newtype, just apply to a constructor
411 -> padLams . applyToNames <$> buildApp (LV n) argsPruned
414 (P (TCon t a) n _, args) -> return LNothing
416 -- an external name applied to arguments
417 (P _ n _, args) | S.member (n, length args) (idris_externs ist) -> do
418 LOp (LExternal n) <$> mapM (irTerm top vs env) args
420 -- a name applied to arguments
421 (P _ n _, args) -> do
422 case lookup n (idris_scprims ist) of
423 -- if it's a primitive that is already saturated,
424 -- compile to the corresponding op here already to save work
425 Just (arity, op) | length args == arity
426 -> LOp op <$> mapM (irTerm top vs env) args
428 -- otherwise, just apply the name
429 _ -> applyName n ist args
431 -- turn de bruijn vars into regular named references and try again
432 (V i, args) -> irTerm top vs env $ mkApp (P Bound (env !! i) Erased) args
436 <$> irTerm top vs env f
437 <*> mapM (irTerm top vs env) args
440 buildApp :: LExp -> [Term] -> Idris LExp
441 buildApp e [] = return e
442 buildApp e xs = LApp False e <$> mapM (irTerm top vs env) xs
444 applyToNames :: LExp -> [Name] -> LExp
445 applyToNames tm [] = tm
446 applyToNames tm ns = LApp False tm $ map LV ns
448 padLambdas :: [Int] -> Int -> Int -> ([Name] -> LExp) -> LExp
449 padLambdas used startIdx endSIdx mkTerm
450 = LLam allNames $ mkTerm nonerasedNames
452 allNames = [sMN i "sat" | i <- [startIdx .. endSIdx-1]]
453 nonerasedNames = [sMN i "sat" | i <- [startIdx .. endSIdx-1], i `elem` used]
455 applyName :: Name -> IState -> [Term] -> Idris LExp
456 applyName n ist args =
457 LApp False (LV n) <$> mapM (irTerm top vs env . erase) (zip [0..] args)
460 | i >= arity || i `elem` used = x
463 arity = case fst4 <$> lookupCtxtExact n (definitions . tt_ctxt $ ist) of
464 Just (CaseOp ci ty tys def tot cdefs) -> length tys
465 Just (TyDecl (DCon tag ar _) _) -> ar
466 Just (TyDecl Ref ty) -> length $ getArgTys ty
467 Just (Operator ty ar op) -> ar
468 Just def -> error $ "unknown arity: " ++ show (n, def)
469 Nothing -> 0 -- no definition, probably local name => can't erase anything
471 -- name for purposes of usage info lookup
473 | Just n' <- viMethod =<< M.lookup n vs = n'
476 used = maybe [] (map fst . usedpos) $ lookupCtxtExact uName (idris_callgraph ist)
477 fst4 (x,_,_,_,_,_) = x
479irTerm top vs env (P _ n _) = return $ LV n
480irTerm top vs env (V i)
481 | i >= 0 && i < length env = return $ LV (env!!i)
482 | otherwise = ifail $ "bad de bruijn index: " ++ show i
484irTerm top vs env (Bind n (Lam _ _) sc) = LLam [n'] <$> irTerm top vs (n':env) sc
486 n' = uniqueName n env
488irTerm top vs env (Bind n (Let _ _ v) sc)
489 = LLet n <$> irTerm top vs env v <*> irTerm top vs (n : env) sc
491irTerm top vs env (Bind _ _ _) = return $ LNothing
493irTerm top vs env (Proj t (-1)) = do
494 t' <- irTerm top vs env t
495 return $ LOp (LMinus (ATInt ITBig))
498irTerm top vs env (Proj t i) = LProj <$> irTerm top vs env t <*> pure i
499irTerm top vs env (Constant TheWorld) = return LNothing
500irTerm top vs env (Constant c) = return (LConst c)
501irTerm top vs env (TType _) = return LNothing
502irTerm top vs env Erased = return LNothing
503irTerm top vs env Impossible = return LNothing
505doForeign :: Vars -> [Name] -> [Term] -> Idris LExp
506doForeign vs env (ret : fname : world : args)
507 = do args' <- mapM splitArg args
508 let fname' = toFDesc fname
509 let ret' = toFDesc ret
510 return $ LForeign ret' fname' args'
512 splitArg tm | (_, [_,_,l,r]) <- unApply tm -- pair, two implicits
513 = do let l' = toFDesc l
514 r' <- irTerm (sMN 0 "__foreignCall") vs env r
516 splitArg _ = ifail $ "Badly formed foreign function call: " ++
517 show (ret : fname : world : args)
520 toFDesc (Constant (Str str)) = FStr str
522 | (P _ n _, []) <- unApply tm = FCon (deNS n)
523 | (P _ n _, as) <- unApply tm = FApp (deNS n) (map toFDesc as)
528doForeign vs env xs = ifail "Badly formed foreign function call"
530irTree :: Name -> [Name] -> SC -> Idris LExp
531irTree top args tree = do
532 logCodeGen 3 $ "Compiling " ++ show args ++ "\n" ++ show tree
533 LLam args <$> irSC top M.empty tree
535irSC :: Name -> Vars -> SC -> Idris LExp
536irSC top vs (STerm t) = irTerm top vs [] t
537irSC top vs (UnmatchedCase str) = return $ LLazyExp $ LError str
539irSC top vs (ProjCase tm alts) = do
540 tm' <- irTerm top vs [] tm
541 alts' <- mapM (irAlt top vs tm') alts
542 return $ LCase Shared tm' alts'
544-- Transform matching on Delay to applications of Force.
545irSC top vs (Case up n [ConCase (UN delay) i [_, _, n'] sc])
546 | delay == txt "Delay"
547 = do sc' <- irSC top vs sc -- mkForce n' n sc
548 return $ lsubst n' (LForce (LV n)) sc'
550-- There are two transformations in this case:
552-- 1. Newtype-case elimination:
554-- wrap({e1}) -> P({e1}) ==> P({e0})
556-- This is important because newtyped constructors are compiled away entirely
557-- and we need to do that everywhere.
559-- 2. Unused-case elimination (only valid for singleton branches):
561-- C(x,y) -> P[... x,y not used ...]
563-- This is important for runtime because sometimes we case on irrelevant data:
565-- In the example above, {e0} will most probably have been erased
566-- so this vain projection would make the resulting program segfault
567-- because the code generator still emits a PROJECT(...) G-machine instruction.
569-- Hence, we check whether the variables are used at all
570-- and erase the casesplit if they are not.
572irSC top vs (Case up n [alt]) = do
573 replacement <- case alt of
574 ConCase cn a ns sc -> do
575 detag <- fgetState (opt_detaggable . ist_optimisation cn)
576 used <- map fst <$> fgetState (cg_usedpos . ist_callgraph cn)
577 if detag && length used == 1
578 then return . Just $ substSC (ns !! head used) n sc
583 Just sc -> irSC top vs sc
585 alt' <- irAlt top vs (LV n) alt
586 return $ case namesBoundIn alt' `usedIn` subexpr alt' of
587 [] -> subexpr alt' -- strip the unused top-most case
588 _ -> LCase up (LV n) [alt']
590 namesBoundIn :: LAlt -> [Name]
591 namesBoundIn (LConCase cn i ns sc) = ns
592 namesBoundIn (LConstCase c sc) = []
593 namesBoundIn (LDefaultCase sc) = []
595 subexpr :: LAlt -> LExp
596 subexpr (LConCase _ _ _ e) = e
597 subexpr (LConstCase _ e) = e
598 subexpr (LDefaultCase e) = e
600-- FIXME: When we have a non-singleton case-tree of the form
606-- and C is detaggable (the only constructor of the family), we can be sure
607-- that the first branch will be always taken -- so we add special handling
608-- to remove the dead default branch.
610-- If we don't do so and C is newtype-optimisable, we will miss this newtype
611-- transformation and the resulting code will probably segfault.
613-- This work-around is not entirely optimal; the best approach would be
614-- to ensure that such case trees don't arise in the first place.
616irSC top vs (Case up n alts@[ConCase cn a ns sc, DefaultCase sc']) = do
617 detag <- fgetState (opt_detaggable . ist_optimisation cn)
619 then irSC top vs (Case up n [ConCase cn a ns sc])
620 else LCase up (LV n) <$> mapM (irAlt top vs (LV n)) alts
622irSC top vs sc@(Case up n alts) = do
623 -- check that neither alternative needs the newtype optimisation,
625 goneWrong <- or <$> mapM isDetaggable alts
627 $ ifail ("irSC: non-trivial case-match on detaggable data: " ++ show sc)
630 LCase up (LV n) <$> mapM (irAlt top vs (LV n)) alts
632 isDetaggable (ConCase cn _ _ _) = fgetState $ opt_detaggable . ist_optimisation cn
633 isDetaggable _ = return False
635irSC top vs ImpossibleCase = return LNothing
637irAlt :: Name -> Vars -> LExp -> CaseAlt -> Idris LAlt
639-- this leaves out all unused arguments of the constructor
640irAlt top vs _ (ConCase n t args sc) = do
641 used <- map fst <$> fgetState (cg_usedpos . ist_callgraph n)
642 let usedArgs = [a | (i,a) <- zip [0..] args, i `elem` used]
643 LConCase (-1) n usedArgs <$> irSC top (methodVars `M.union` vs) sc
645 methodVars = case n of
646 SN (ImplementationCtorN interfaceName)
647 -> M.fromList [(v, VI
648 { viMethod = Just $ mkFieldName n i
649 }) | (v,i) <- zip args [0..]]
651 -> M.empty -- not an implementation constructor
653irAlt top vs _ (ConstCase x rhs)
654 | matchable x = LConstCase x <$> irSC top vs rhs
655 | matchableTy x = LDefaultCase <$> irSC top vs rhs
657 matchable (I _) = True
658 matchable (BI _) = True
659 matchable (Ch _) = True
660 matchable (Str _) = True
661 matchable (B8 _) = True
662 matchable (B16 _) = True
663 matchable (B32 _) = True
664 matchable (B64 _) = True
667 matchableTy (AType (ATInt ITNative)) = True
668 matchableTy (AType (ATInt ITBig)) = True
669 matchableTy (AType (ATInt ITChar)) = True
670 matchableTy StrType = True
672 matchableTy (AType (ATInt (ITFixed IT8))) = True
673 matchableTy (AType (ATInt (ITFixed IT16))) = True
674 matchableTy (AType (ATInt (ITFixed IT32))) = True
675 matchableTy (AType (ATInt (ITFixed IT64))) = True
677 matchableTy _ = False
679irAlt top vs tm (SucCase n rhs) = do
680 rhs' <- irSC top vs rhs
681 return $ LDefaultCase (LLet n (LOp (LMinus (ATInt ITBig))
683 LConst (BI 1)]) rhs')
685irAlt top vs _ (ConstCase c rhs)
686 = ifail $ "Can't match on (" ++ show c ++ ")"
688irAlt top vs _ (DefaultCase rhs)
689 = LDefaultCase <$> irSC top vs rhs
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list