3 -- We always optimise this, otherwise performance of a non-optimised
4 -- compiler is severely affected
7 -- (c) The University of Glasgow 2002-2006
9 -- Binary interface file support.
11 module BinIface ( writeBinIface, readBinIface,
12 CheckHiWay(..), TraceBinIFaceReading(..) ) where
14 #include "HsVersions.h"
48 data CheckHiWay = CheckHiWay | IgnoreHiWay
51 data TraceBinIFaceReading = TraceBinIFaceReading | QuietBinIFaceReading
54 -- ---------------------------------------------------------------------------
55 -- Reading and writing binary interface files
57 readBinIface :: CheckHiWay -> TraceBinIFaceReading -> FilePath
58 -> TcRnIf a b ModIface
59 readBinIface checkHiWay traceBinIFaceReading hi_path = do
60 update_nc <- mkNameCacheUpdater
62 liftIO $ readBinIface_ dflags checkHiWay traceBinIFaceReading hi_path update_nc
64 readBinIface_ :: DynFlags -> CheckHiWay -> TraceBinIFaceReading -> FilePath
65 -> NameCacheUpdater (Array Int Name)
67 readBinIface_ dflags checkHiWay traceBinIFaceReading hi_path update_nc = do
68 let printer :: SDoc -> IO ()
69 printer = case traceBinIFaceReading of
70 TraceBinIFaceReading -> \sd -> printSDoc sd defaultDumpStyle
71 QuietBinIFaceReading -> \_ -> return ()
72 wantedGot :: Outputable a => String -> a -> a -> IO ()
73 wantedGot what wanted got
74 = printer (text what <> text ": " <>
75 vcat [text "Wanted " <> ppr wanted <> text ",",
76 text "got " <> ppr got])
78 errorOnMismatch :: (Eq a, Show a) => String -> a -> a -> IO ()
79 errorOnMismatch what wanted got
80 -- This will be caught by readIface which will emit an error
81 -- msg containing the iface module name.
82 = when (wanted /= got) $ ghcError $ ProgramError
83 (what ++ " (wanted " ++ show wanted
84 ++ ", got " ++ show got ++ ")")
85 bh <- Binary.readBinMem hi_path
87 -- Read the magic number to check that this really is a GHC .hi file
88 -- (This magic number does not change when we change
89 -- GHC interface file format)
91 wantedGot "Magic" binaryInterfaceMagic magic
92 errorOnMismatch "magic number mismatch: old/corrupt interface file?"
93 binaryInterfaceMagic magic
95 -- Note [dummy iface field]
96 -- read a dummy 32/64 bit value. This field used to hold the
97 -- dictionary pointer in old interface file formats, but now
98 -- the dictionary pointer is after the version (where it
99 -- should be). Also, the serialisation of value of type "Bin
100 -- a" used to depend on the word size of the machine, now they
101 -- are always 32 bits.
104 then do _ <- Binary.get bh :: IO Word32; return ()
105 else do _ <- Binary.get bh :: IO Word64; return ()
107 -- Check the interface file version and ways.
109 let our_ver = show opt_HiVersion
110 wantedGot "Version" our_ver check_ver
111 errorOnMismatch "mismatched interface file versions" our_ver check_ver
114 let way_descr = getWayDescr dflags
115 wantedGot "Way" way_descr check_way
116 when (checkHiWay == CheckHiWay) $
117 errorOnMismatch "mismatched interface file ways" way_descr check_way
119 -- Read the dictionary
120 -- The next word in the file is a pointer to where the dictionary is
121 -- (probably at the end of the file)
122 dict_p <- Binary.get bh
123 data_p <- tellBin bh -- Remember where we are now
125 dict <- getDictionary bh
126 seekBin bh data_p -- Back to where we were before
128 -- Initialise the user-data field of bh
129 ud <- newReadState dict
130 bh <- return (setUserData bh ud)
132 symtab_p <- Binary.get bh -- Get the symtab ptr
133 data_p <- tellBin bh -- Remember where we are now
135 symtab <- getSymbolTable bh update_nc
136 seekBin bh data_p -- Back to where we were before
137 let ud = getUserData bh
138 bh <- return $! setUserData bh ud{ud_symtab = symtab}
143 writeBinIface :: DynFlags -> FilePath -> ModIface -> IO ()
144 writeBinIface dflags hi_path mod_iface = do
145 bh <- openBinMem initBinMemSize
146 put_ bh binaryInterfaceMagic
148 -- dummy 32/64-bit field before the version/way for
149 -- compatibility with older interface file formats.
150 -- See Note [dummy iface field] above.
152 then Binary.put_ bh (0 :: Word32)
153 else Binary.put_ bh (0 :: Word64)
155 -- The version and way descriptor go next
156 put_ bh (show opt_HiVersion)
157 let way_descr = getWayDescr dflags
160 -- Remember where the dictionary pointer will go
161 dict_p_p <- tellBin bh
162 put_ bh dict_p_p -- Placeholder for ptr to dictionary
164 -- Remember where the symbol table pointer will go
165 symtab_p_p <- tellBin bh
168 -- Make some intial state
169 symtab_next <- newFastMutInt
170 writeFastMutInt symtab_next 0
171 symtab_map <- newIORef emptyUFM
172 let bin_symtab = BinSymbolTable {
173 bin_symtab_next = symtab_next,
174 bin_symtab_map = symtab_map }
175 dict_next_ref <- newFastMutInt
176 writeFastMutInt dict_next_ref 0
177 dict_map_ref <- newIORef emptyUFM
178 let bin_dict = BinDictionary {
179 bin_dict_next = dict_next_ref,
180 bin_dict_map = dict_map_ref }
181 ud <- newWriteState (putName bin_symtab) (putFastString bin_dict)
183 -- Put the main thing,
184 bh <- return $ setUserData bh ud
187 -- Write the symtab pointer at the fornt of the file
188 symtab_p <- tellBin bh -- This is where the symtab will start
189 putAt bh symtab_p_p symtab_p -- Fill in the placeholder
190 seekBin bh symtab_p -- Seek back to the end of the file
192 -- Write the symbol table itself
193 symtab_next <- readFastMutInt symtab_next
194 symtab_map <- readIORef symtab_map
195 putSymbolTable bh symtab_next symtab_map
196 debugTraceMsg dflags 3 (text "writeBinIface:" <+> int symtab_next
199 -- NB. write the dictionary after the symbol table, because
200 -- writing the symbol table may create more dictionary entries.
202 -- Write the dictionary pointer at the fornt of the file
203 dict_p <- tellBin bh -- This is where the dictionary will start
204 putAt bh dict_p_p dict_p -- Fill in the placeholder
205 seekBin bh dict_p -- Seek back to the end of the file
207 -- Write the dictionary itself
208 dict_next <- readFastMutInt dict_next_ref
209 dict_map <- readIORef dict_map_ref
210 putDictionary bh dict_next dict_map
211 debugTraceMsg dflags 3 (text "writeBinIface:" <+> int dict_next
212 <+> text "dict entries")
214 -- And send the result to the file
215 writeBinMem bh hi_path
217 initBinMemSize :: Int
218 initBinMemSize = 1024 * 1024
220 -- The *host* architecture version:
221 #include "../includes/MachDeps.h"
223 binaryInterfaceMagic :: Word32
224 #if WORD_SIZE_IN_BITS == 32
225 binaryInterfaceMagic = 0x1face
226 #elif WORD_SIZE_IN_BITS == 64
227 binaryInterfaceMagic = 0x1face64
230 -- -----------------------------------------------------------------------------
233 putSymbolTable :: BinHandle -> Int -> UniqFM (Int,Name) -> IO ()
234 putSymbolTable bh next_off symtab = do
236 let names = elems (array (0,next_off-1) (eltsUFM symtab))
237 mapM_ (\n -> serialiseName bh n symtab) names
239 getSymbolTable :: BinHandle -> NameCacheUpdater (Array Int Name)
240 -> IO (Array Int Name)
241 getSymbolTable bh update_namecache = do
243 od_names <- sequence (replicate sz (get bh))
244 update_namecache $ \namecache ->
246 arr = listArray (0,sz-1) names
247 (namecache', names) =
248 mapAccumR (fromOnDiskName arr) namecache od_names
251 type OnDiskName = (PackageId, ModuleName, OccName)
258 fromOnDiskName _ nc (pid, mod_name, occ) =
260 mod = mkModule pid mod_name
263 case lookupOrigNameCache cache mod occ of
264 Just name -> (nc, name)
268 uniq = uniqFromSupply us
269 name = mkExternalName uniq mod occ noSrcSpan
270 new_cache = extendNameCache cache mod occ name
272 case splitUniqSupply us of { (us',_) ->
273 ( nc{ nsUniqs = us', nsNames = new_cache }, name )
276 serialiseName :: BinHandle -> Name -> UniqFM (Int,Name) -> IO ()
277 serialiseName bh name _ = do
278 let mod = ASSERT2( isExternalName name, ppr name ) nameModule name
279 put_ bh (modulePackageId mod, moduleName mod, nameOccName name)
282 putName :: BinSymbolTable -> BinHandle -> Name -> IO ()
283 putName BinSymbolTable{
284 bin_symtab_map = symtab_map_ref,
285 bin_symtab_next = symtab_next } bh name
287 symtab_map <- readIORef symtab_map_ref
288 case lookupUFM symtab_map name of
289 Just (off,_) -> put_ bh (fromIntegral off :: Word32)
291 off <- readFastMutInt symtab_next
292 writeFastMutInt symtab_next (off+1)
293 writeIORef symtab_map_ref
294 $! addToUFM symtab_map name (off,name)
295 put_ bh (fromIntegral off :: Word32)
298 data BinSymbolTable = BinSymbolTable {
299 bin_symtab_next :: !FastMutInt, -- The next index to use
300 bin_symtab_map :: !(IORef (UniqFM (Int,Name)))
305 putFastString :: BinDictionary -> BinHandle -> FastString -> IO ()
306 putFastString BinDictionary { bin_dict_next = j_r,
307 bin_dict_map = out_r} bh f
309 out <- readIORef out_r
310 let uniq = getUnique f
311 case lookupUFM out uniq of
312 Just (j, _) -> put_ bh (fromIntegral j :: Word32)
314 j <- readFastMutInt j_r
315 put_ bh (fromIntegral j :: Word32)
316 writeFastMutInt j_r (j + 1)
317 writeIORef out_r $! addToUFM out uniq (j, f)
320 data BinDictionary = BinDictionary {
321 bin_dict_next :: !FastMutInt, -- The next index to use
322 bin_dict_map :: !(IORef (UniqFM (Int,FastString)))
323 -- indexed by FastString
326 -- -----------------------------------------------------------------------------
327 -- All the binary instances
330 {-! for IPName derive: Binary !-}
331 {-! for Fixity derive: Binary !-}
332 {-! for FixityDirection derive: Binary !-}
333 {-! for Boxity derive: Binary !-}
334 {-! for StrictnessMark derive: Binary !-}
335 {-! for Activation derive: Binary !-}
338 {-! for Demand derive: Binary !-}
339 {-! for Demands derive: Binary !-}
340 {-! for DmdResult derive: Binary !-}
341 {-! for StrictSig derive: Binary !-}
344 {-! for DefMeth derive: Binary !-}
347 {-! for HsPred derive: Binary !-}
348 {-! for HsType derive: Binary !-}
349 {-! for TupCon derive: Binary !-}
350 {-! for HsTyVarBndr derive: Binary !-}
353 {-! for UfExpr derive: Binary !-}
354 {-! for UfConAlt derive: Binary !-}
355 {-! for UfBinding derive: Binary !-}
356 {-! for UfBinder derive: Binary !-}
357 {-! for HsIdInfo derive: Binary !-}
358 {-! for UfNote derive: Binary !-}
361 {-! for ConDetails derive: Binary !-}
362 {-! for BangType derive: Binary !-}
365 {-! for IsCafCC derive: Binary !-}
366 {-! for IsDupdCC derive: Binary !-}
367 {-! for CostCentre derive: Binary !-}
371 -- ---------------------------------------------------------------------------
372 -- Reading a binary interface into ParsedIface
374 instance Binary ModIface where
378 mi_iface_hash= iface_hash,
379 mi_mod_hash = mod_hash,
381 mi_finsts = hasFamInsts,
384 mi_exports = exports,
385 mi_exp_hash = exp_hash,
386 mi_fixities = fixities,
391 mi_fam_insts = fam_insts,
393 mi_orphan_hash = orphan_hash,
394 mi_vect_info = vect_info,
395 mi_hpc = hpc_info }) = do
423 hasFamInsts <- get bh
425 usages <- {-# SCC "bin_usages" #-} lazyGet bh
426 exports <- {-# SCC "bin_exports" #-} get bh
428 fixities <- {-# SCC "bin_fixities" #-} get bh
429 warns <- {-# SCC "bin_warns" #-} lazyGet bh
430 anns <- {-# SCC "bin_anns" #-} lazyGet bh
431 decls <- {-# SCC "bin_tycldecls" #-} get bh
432 insts <- {-# SCC "bin_insts" #-} get bh
433 fam_insts <- {-# SCC "bin_fam_insts" #-} get bh
434 rules <- {-# SCC "bin_rules" #-} lazyGet bh
435 orphan_hash <- get bh
439 mi_module = mod_name,
441 mi_iface_hash = iface_hash,
442 mi_mod_hash = mod_hash,
444 mi_finsts = hasFamInsts,
447 mi_exports = exports,
448 mi_exp_hash = exp_hash,
450 mi_fixities = fixities,
453 mi_globals = Nothing,
455 mi_fam_insts = fam_insts,
457 mi_orphan_hash = orphan_hash,
458 mi_vect_info = vect_info,
460 -- And build the cached values
461 mi_warn_fn = mkIfaceWarnCache warns,
462 mi_fix_fn = mkIfaceFixCache fixities,
463 mi_hash_fn = mkIfaceHashCache decls })
465 getWayDescr :: DynFlags -> String
467 | cGhcUnregisterised == "YES" = 'u':tag
469 where tag = buildTag dflags
470 -- if this is an unregisterised build, make sure our interfaces
471 -- can't be used by a registerised build.
473 -------------------------------------------------------------------------
474 -- Types from: HscTypes
475 -------------------------------------------------------------------------
477 instance Binary Dependencies where
478 put_ bh deps = do put_ bh (dep_mods deps)
479 put_ bh (dep_pkgs deps)
480 put_ bh (dep_orphs deps)
481 put_ bh (dep_finsts deps)
483 get bh = do ms <- get bh
487 return (Deps { dep_mods = ms, dep_pkgs = ps, dep_orphs = os,
490 instance (Binary name) => Binary (GenAvailInfo name) where
491 put_ bh (Avail aa) = do
494 put_ bh (AvailTC ab ac) = do
505 return (AvailTC ab ac)
507 instance Binary Usage where
508 put_ bh usg@UsagePackageModule{} = do
510 put_ bh (usg_mod usg)
511 put_ bh (usg_mod_hash usg)
512 put_ bh usg@UsageHomeModule{} = do
514 put_ bh (usg_mod_name usg)
515 put_ bh (usg_mod_hash usg)
516 put_ bh (usg_exports usg)
517 put_ bh (usg_entities usg)
525 return UsagePackageModule { usg_mod = nm, usg_mod_hash = mod }
531 return UsageHomeModule { usg_mod_name = nm, usg_mod_hash = mod,
532 usg_exports = exps, usg_entities = ents }
534 instance Binary Warnings where
535 put_ bh NoWarnings = putByte bh 0
536 put_ bh (WarnAll t) = do
539 put_ bh (WarnSome ts) = do
546 0 -> return NoWarnings
552 instance Binary WarningTxt where
553 put_ bh (WarningTxt w) = do
556 put_ bh (DeprecatedTxt d) = do
564 return (WarningTxt w)
566 return (DeprecatedTxt d)
568 -------------------------------------------------------------------------
569 -- Types from: BasicTypes
570 -------------------------------------------------------------------------
572 instance Binary Activation where
573 put_ bh NeverActive = do
575 put_ bh AlwaysActive = do
577 put_ bh (ActiveBefore aa) = do
580 put_ bh (ActiveAfter ab) = do
586 0 -> do return NeverActive
587 1 -> do return AlwaysActive
589 return (ActiveBefore aa)
591 return (ActiveAfter ab)
593 instance Binary RuleMatchInfo where
594 put_ bh FunLike = putByte bh 0
595 put_ bh ConLike = putByte bh 1
598 if h == 1 then return ConLike
601 instance Binary InlinePragma where
602 put_ bh (InlinePragma a b c d) = do
613 return (InlinePragma a b c d)
615 instance Binary HsBang where
616 put_ bh HsNoBang = putByte bh 0
617 put_ bh HsStrict = putByte bh 1
618 put_ bh HsUnpack = putByte bh 2
619 put_ bh HsUnpackFailed = putByte bh 3
623 0 -> do return HsNoBang
624 1 -> do return HsStrict
625 2 -> do return HsUnpack
626 _ -> do return HsUnpackFailed
628 instance Binary Boxity where
629 put_ bh Boxed = putByte bh 0
630 put_ bh Unboxed = putByte bh 1
635 _ -> do return Unboxed
637 instance Binary TupCon where
638 put_ bh (TupCon ab ac) = do
644 return (TupCon ab ac)
646 instance Binary RecFlag where
647 put_ bh Recursive = do
649 put_ bh NonRecursive = do
654 0 -> do return Recursive
655 _ -> do return NonRecursive
657 instance Binary DefMethSpec where
658 put_ bh NoDM = putByte bh 0
659 put_ bh VanillaDM = putByte bh 1
660 put_ bh GenericDM = putByte bh 2
665 1 -> return VanillaDM
666 _ -> return GenericDM
668 instance Binary FixityDirection where
678 0 -> do return InfixL
679 1 -> do return InfixR
680 _ -> do return InfixN
682 instance Binary Fixity where
683 put_ bh (Fixity aa ab) = do
689 return (Fixity aa ab)
691 instance (Binary name) => Binary (IPName name) where
692 put_ bh (IPName aa) = put_ bh aa
693 get bh = do aa <- get bh
696 -------------------------------------------------------------------------
697 -- Types from: Demand
698 -------------------------------------------------------------------------
700 instance Binary DmdType where
701 -- Ignore DmdEnv when spitting out the DmdType
702 put bh (DmdType _ ds dr) = do p <- put bh ds; put_ bh dr; return (castBin p)
703 get bh = do ds <- get bh; dr <- get bh; return (DmdType emptyVarEnv ds dr)
705 instance Binary Demand where
710 put_ bh (Call aa) = do
713 put_ bh (Eval ab) = do
716 put_ bh (Defer ac) = do
719 put_ bh (Box ad) = do
739 instance Binary Demands where
740 put_ bh (Poly aa) = do
743 put_ bh (Prod ab) = do
754 instance Binary DmdResult where
764 0 -> do return TopRes
765 1 -> do return RetCPR -- Really use RetCPR even if -fcpr-off
766 -- The wrapper was generated for CPR in
767 -- the imported module!
768 _ -> do return BotRes
770 instance Binary StrictSig where
771 put_ bh (StrictSig aa) = do
775 return (StrictSig aa)
778 -------------------------------------------------------------------------
779 -- Types from: CostCentre
780 -------------------------------------------------------------------------
782 instance Binary IsCafCC where
785 put_ bh NotCafCC = do
791 _ -> do return NotCafCC
793 instance Binary IsDupdCC where
794 put_ bh OriginalCC = do
801 0 -> do return OriginalCC
802 _ -> do return DupdCC
804 instance Binary CostCentre where
805 put_ bh NoCostCentre = do
807 put_ bh (NormalCC aa ab ac ad) = do
813 put_ bh (AllCafsCC ae) = do
819 0 -> do return NoCostCentre
824 return (NormalCC aa ab ac ad)
826 return (AllCafsCC ae)
828 -------------------------------------------------------------------------
829 -- IfaceTypes and friends
830 -------------------------------------------------------------------------
832 instance Binary IfaceBndr where
833 put_ bh (IfaceIdBndr aa) = do
836 put_ bh (IfaceTvBndr ab) = do
843 return (IfaceIdBndr aa)
845 return (IfaceTvBndr ab)
847 instance Binary IfaceLetBndr where
848 put_ bh (IfLetBndr a b c) = do
852 get bh = do a <- get bh
855 return (IfLetBndr a b c)
857 instance Binary IfaceType where
858 put_ bh (IfaceForAllTy aa ab) = do
862 put_ bh (IfaceTyVar ad) = do
865 put_ bh (IfaceAppTy ae af) = do
869 put_ bh (IfaceFunTy ag ah) = do
873 put_ bh (IfacePredTy aq) = do
877 -- Simple compression for common cases of TyConApp
878 put_ bh (IfaceTyConApp IfaceIntTc []) = putByte bh 6
879 put_ bh (IfaceTyConApp IfaceCharTc []) = putByte bh 7
880 put_ bh (IfaceTyConApp IfaceBoolTc []) = putByte bh 8
881 put_ bh (IfaceTyConApp IfaceListTc [ty]) = do { putByte bh 9; put_ bh ty }
882 -- Unit tuple and pairs
883 put_ bh (IfaceTyConApp (IfaceTupTc Boxed 0) []) = putByte bh 10
884 put_ bh (IfaceTyConApp (IfaceTupTc Boxed 2) [t1,t2]) = do { putByte bh 11; put_ bh t1; put_ bh t2 }
886 put_ bh (IfaceTyConApp IfaceLiftedTypeKindTc []) = putByte bh 12
887 put_ bh (IfaceTyConApp IfaceOpenTypeKindTc []) = putByte bh 13
888 put_ bh (IfaceTyConApp IfaceUnliftedTypeKindTc []) = putByte bh 14
889 put_ bh (IfaceTyConApp IfaceUbxTupleKindTc []) = putByte bh 15
890 put_ bh (IfaceTyConApp IfaceArgTypeKindTc []) = putByte bh 16
891 put_ bh (IfaceTyConApp (IfaceAnyTc k) []) = do { putByte bh 17; put_ bh k }
895 put_ bh (IfaceTyConApp (IfaceTc tc) tys) = do { putByte bh 18; put_ bh tc; put_ bh tys }
896 put_ bh (IfaceTyConApp tc tys) = do { putByte bh 19; put_ bh tc; put_ bh tys }
903 return (IfaceForAllTy aa ab)
905 return (IfaceTyVar ad)
908 return (IfaceAppTy ae af)
911 return (IfaceFunTy ag ah)
913 return (IfacePredTy ap)
915 -- Now the special cases for TyConApp
916 6 -> return (IfaceTyConApp IfaceIntTc [])
917 7 -> return (IfaceTyConApp IfaceCharTc [])
918 8 -> return (IfaceTyConApp IfaceBoolTc [])
919 9 -> do { ty <- get bh; return (IfaceTyConApp IfaceListTc [ty]) }
920 10 -> return (IfaceTyConApp (IfaceTupTc Boxed 0) [])
921 11 -> do { t1 <- get bh; t2 <- get bh; return (IfaceTyConApp (IfaceTupTc Boxed 2) [t1,t2]) }
922 12 -> return (IfaceTyConApp IfaceLiftedTypeKindTc [])
923 13 -> return (IfaceTyConApp IfaceOpenTypeKindTc [])
924 14 -> return (IfaceTyConApp IfaceUnliftedTypeKindTc [])
925 15 -> return (IfaceTyConApp IfaceUbxTupleKindTc [])
926 16 -> return (IfaceTyConApp IfaceArgTypeKindTc [])
927 17 -> do { k <- get bh; return (IfaceTyConApp (IfaceAnyTc k) []) }
929 18 -> do { tc <- get bh; tys <- get bh; return (IfaceTyConApp (IfaceTc tc) tys) }
930 _ -> do { tc <- get bh; tys <- get bh; return (IfaceTyConApp tc tys) }
932 instance Binary IfaceTyCon where
933 -- Int,Char,Bool can't show up here because they can't not be saturated
935 put_ bh IfaceIntTc = putByte bh 1
936 put_ bh IfaceBoolTc = putByte bh 2
937 put_ bh IfaceCharTc = putByte bh 3
938 put_ bh IfaceListTc = putByte bh 4
939 put_ bh IfacePArrTc = putByte bh 5
940 put_ bh IfaceLiftedTypeKindTc = putByte bh 6
941 put_ bh IfaceOpenTypeKindTc = putByte bh 7
942 put_ bh IfaceUnliftedTypeKindTc = putByte bh 8
943 put_ bh IfaceUbxTupleKindTc = putByte bh 9
944 put_ bh IfaceArgTypeKindTc = putByte bh 10
945 put_ bh (IfaceTupTc bx ar) = do { putByte bh 11; put_ bh bx; put_ bh ar }
946 put_ bh (IfaceTc ext) = do { putByte bh 12; put_ bh ext }
947 put_ bh (IfaceAnyTc k) = do { putByte bh 13; put_ bh k }
952 1 -> return IfaceIntTc
953 2 -> return IfaceBoolTc
954 3 -> return IfaceCharTc
955 4 -> return IfaceListTc
956 5 -> return IfacePArrTc
957 6 -> return IfaceLiftedTypeKindTc
958 7 -> return IfaceOpenTypeKindTc
959 8 -> return IfaceUnliftedTypeKindTc
960 9 -> return IfaceUbxTupleKindTc
961 10 -> return IfaceArgTypeKindTc
962 11 -> do { bx <- get bh; ar <- get bh; return (IfaceTupTc bx ar) }
963 12 -> do { ext <- get bh; return (IfaceTc ext) }
964 _ -> do { k <- get bh; return (IfaceAnyTc k) }
966 instance Binary IfacePredType where
967 put_ bh (IfaceClassP aa ab) = do
971 put_ bh (IfaceIParam ac ad) = do
975 put_ bh (IfaceEqPred ac ad) = do
984 return (IfaceClassP aa ab)
987 return (IfaceIParam ac ad)
990 return (IfaceEqPred ac ad)
991 _ -> panic ("get IfacePredType " ++ show h)
993 -------------------------------------------------------------------------
994 -- IfaceExpr and friends
995 -------------------------------------------------------------------------
997 instance Binary IfaceExpr where
998 put_ bh (IfaceLcl aa) = do
1001 put_ bh (IfaceType ab) = do
1004 put_ bh (IfaceTuple ac ad) = do
1008 put_ bh (IfaceLam ae af) = do
1012 put_ bh (IfaceApp ag ah) = do
1017 put_ bh (IfaceCase ai aj al ak) = do
1024 put_ bh (IfaceLet al am) = do
1028 put_ bh (IfaceNote an ao) = do
1032 put_ bh (IfaceLit ap) = do
1035 put_ bh (IfaceFCall as at) = do
1039 put_ bh (IfaceExt aa) = do
1042 put_ bh (IfaceCast ie ico) = do
1046 put_ bh (IfaceTick m ix) = do
1053 0 -> do aa <- get bh
1054 return (IfaceLcl aa)
1055 1 -> do ab <- get bh
1056 return (IfaceType ab)
1057 2 -> do ac <- get bh
1059 return (IfaceTuple ac ad)
1060 3 -> do ae <- get bh
1062 return (IfaceLam ae af)
1063 4 -> do ag <- get bh
1065 return (IfaceApp ag ah)
1066 5 -> do ai <- get bh
1072 return (IfaceCase ai aj al ak)
1073 6 -> do al <- get bh
1075 return (IfaceLet al am)
1076 7 -> do an <- get bh
1078 return (IfaceNote an ao)
1079 8 -> do ap <- get bh
1080 return (IfaceLit ap)
1081 9 -> do as <- get bh
1083 return (IfaceFCall as at)
1084 10 -> do aa <- get bh
1085 return (IfaceExt aa)
1086 11 -> do ie <- get bh
1088 return (IfaceCast ie ico)
1089 12 -> do m <- get bh
1091 return (IfaceTick m ix)
1092 _ -> panic ("get IfaceExpr " ++ show h)
1094 instance Binary IfaceConAlt where
1095 put_ bh IfaceDefault = do
1097 put_ bh (IfaceDataAlt aa) = do
1100 put_ bh (IfaceTupleAlt ab) = do
1103 put_ bh (IfaceLitAlt ac) = do
1109 0 -> do return IfaceDefault
1110 1 -> do aa <- get bh
1111 return (IfaceDataAlt aa)
1112 2 -> do ab <- get bh
1113 return (IfaceTupleAlt ab)
1114 _ -> do ac <- get bh
1115 return (IfaceLitAlt ac)
1117 instance Binary IfaceBinding where
1118 put_ bh (IfaceNonRec aa ab) = do
1122 put_ bh (IfaceRec ac) = do
1128 0 -> do aa <- get bh
1130 return (IfaceNonRec aa ab)
1131 _ -> do ac <- get bh
1132 return (IfaceRec ac)
1134 instance Binary IfaceIdDetails where
1135 put_ bh IfVanillaId = putByte bh 0
1136 put_ bh (IfRecSelId a b) = do { putByte bh 1; put_ bh a; put_ bh b }
1137 put_ bh IfDFunId = putByte bh 2
1141 0 -> return IfVanillaId
1144 return (IfRecSelId a b)
1145 _ -> return IfDFunId
1147 instance Binary IfaceIdInfo where
1148 put_ bh NoInfo = putByte bh 0
1149 put_ bh (HasInfo i) = do
1151 lazyPut bh i -- NB lazyPut
1157 _ -> do info <- lazyGet bh -- NB lazyGet
1158 return (HasInfo info)
1160 instance Binary IfaceInfoItem where
1161 put_ bh (HsArity aa) = do
1164 put_ bh (HsStrictness ab) = do
1167 put_ bh (HsUnfold lb ad) = do
1171 put_ bh (HsInline ad) = do
1174 put_ bh HsNoCafRefs = do
1179 0 -> do aa <- get bh
1181 1 -> do ab <- get bh
1182 return (HsStrictness ab)
1183 2 -> do lb <- get bh
1185 return (HsUnfold lb ad)
1186 3 -> do ad <- get bh
1187 return (HsInline ad)
1188 _ -> do return HsNoCafRefs
1190 instance Binary IfaceUnfolding where
1191 put_ bh (IfCoreUnfold e) = do
1194 put_ bh (IfInlineRule a b c d) = do
1200 put_ bh (IfWrapper a n) = do
1204 put_ bh (IfDFunUnfold as) = do
1207 put_ bh (IfCompulsory e) = do
1214 return (IfCoreUnfold e)
1219 return (IfInlineRule a b c d)
1222 return (IfWrapper a n)
1223 3 -> do as <- get bh
1224 return (IfDFunUnfold as)
1226 return (IfCompulsory e)
1228 instance Binary IfaceNote where
1229 put_ bh (IfaceSCC aa) = do
1232 put_ bh (IfaceCoreNote s) = do
1238 0 -> do aa <- get bh
1239 return (IfaceSCC aa)
1240 4 -> do ac <- get bh
1241 return (IfaceCoreNote ac)
1242 _ -> panic ("get IfaceNote " ++ show h)
1244 -------------------------------------------------------------------------
1245 -- IfaceDecl and friends
1246 -------------------------------------------------------------------------
1248 -- A bit of magic going on here: there's no need to store the OccName
1249 -- for a decl on the disk, since we can infer the namespace from the
1250 -- context; however it is useful to have the OccName in the IfaceDecl
1251 -- to avoid re-building it in various places. So we build the OccName
1252 -- when de-serialising.
1254 instance Binary IfaceDecl where
1255 put_ bh (IfaceId name ty details idinfo) = do
1257 put_ bh (occNameFS name)
1261 put_ _ (IfaceForeign _ _) =
1262 error "Binary.put_(IfaceDecl): IfaceForeign"
1263 put_ bh (IfaceData a1 a2 a3 a4 a5 a6 a7 a8) = do
1265 put_ bh (occNameFS a1)
1273 put_ bh (IfaceSyn a1 a2 a3 a4 a5) = do
1275 put_ bh (occNameFS a1)
1280 put_ bh (IfaceClass a1 a2 a3 a4 a5 a6 a7) = do
1283 put_ bh (occNameFS a2)
1292 0 -> do name <- get bh
1296 occ <- return $! mkOccNameFS varName name
1297 return (IfaceId occ ty details idinfo)
1298 1 -> error "Binary.get(TyClDecl): ForeignType"
1308 occ <- return $! mkOccNameFS tcName a1
1309 return (IfaceData occ a2 a3 a4 a5 a6 a7 a8)
1316 occ <- return $! mkOccNameFS tcName a1
1317 return (IfaceSyn occ a2 a3 a4 a5)
1326 occ <- return $! mkOccNameFS clsName a2
1327 return (IfaceClass a1 occ a3 a4 a5 a6 a7)
1329 instance Binary IfaceInst where
1330 put_ bh (IfaceInst cls tys dfun flag orph) = do
1336 get bh = do cls <- get bh
1341 return (IfaceInst cls tys dfun flag orph)
1343 instance Binary IfaceFamInst where
1344 put_ bh (IfaceFamInst fam tys tycon) = do
1348 get bh = do fam <- get bh
1351 return (IfaceFamInst fam tys tycon)
1353 instance Binary OverlapFlag where
1354 put_ bh NoOverlap = putByte bh 0
1355 put_ bh OverlapOk = putByte bh 1
1356 put_ bh Incoherent = putByte bh 2
1357 get bh = do h <- getByte bh
1359 0 -> return NoOverlap
1360 1 -> return OverlapOk
1361 2 -> return Incoherent
1362 _ -> panic ("get OverlapFlag " ++ show h)
1364 instance Binary IfaceConDecls where
1365 put_ bh IfAbstractTyCon = putByte bh 0
1366 put_ bh IfOpenDataTyCon = putByte bh 1
1367 put_ bh (IfDataTyCon cs) = do { putByte bh 2
1369 put_ bh (IfNewTyCon c) = do { putByte bh 3
1374 0 -> return IfAbstractTyCon
1375 1 -> return IfOpenDataTyCon
1376 2 -> do cs <- get bh
1377 return (IfDataTyCon cs)
1378 _ -> do aa <- get bh
1379 return (IfNewTyCon aa)
1381 instance Binary IfaceConDecl where
1382 put_ bh (IfCon a1 a2 a3 a4 a5 a6 a7 a8 a9 a10) = do
1393 get bh = do a1 <- get bh
1403 return (IfCon a1 a2 a3 a4 a5 a6 a7 a8 a9 a10)
1405 instance Binary IfaceClassOp where
1406 put_ bh (IfaceClassOp n def ty) = do
1407 put_ bh (occNameFS n)
1414 occ <- return $! mkOccNameFS varName n
1415 return (IfaceClassOp occ def ty)
1417 instance Binary IfaceRule where
1418 put_ bh (IfaceRule a1 a2 a3 a4 a5 a6 a7) = do
1434 return (IfaceRule a1 a2 a3 a4 a5 a6 a7)
1436 instance Binary IfaceAnnotation where
1437 put_ bh (IfaceAnnotation a1 a2) = do
1443 return (IfaceAnnotation a1 a2)
1445 instance Binary name => Binary (AnnTarget name) where
1446 put_ bh (NamedTarget a) = do
1449 put_ bh (ModuleTarget a) = do
1456 return (NamedTarget a)
1458 return (ModuleTarget a)
1460 instance Binary IfaceVectInfo where
1461 put_ bh (IfaceVectInfo a1 a2 a3) = do
1469 return (IfaceVectInfo a1 a2 a3)