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"
49 data CheckHiWay = CheckHiWay | IgnoreHiWay
52 data TraceBinIFaceReading = TraceBinIFaceReading | QuietBinIFaceReading
55 -- ---------------------------------------------------------------------------
56 -- Reading and writing binary interface files
58 readBinIface :: CheckHiWay -> TraceBinIFaceReading -> FilePath
59 -> TcRnIf a b ModIface
60 readBinIface checkHiWay traceBinIFaceReading hi_path = do
61 update_nc <- mkNameCacheUpdater
63 liftIO $ readBinIface_ dflags checkHiWay traceBinIFaceReading hi_path update_nc
65 readBinIface_ :: DynFlags -> CheckHiWay -> TraceBinIFaceReading -> FilePath
66 -> NameCacheUpdater (Array Int Name)
68 readBinIface_ dflags checkHiWay traceBinIFaceReading hi_path update_nc = do
69 let printer :: SDoc -> IO ()
70 printer = case traceBinIFaceReading of
71 TraceBinIFaceReading -> \sd -> printSDoc sd defaultDumpStyle
72 QuietBinIFaceReading -> \_ -> return ()
73 wantedGot :: Outputable a => String -> a -> a -> IO ()
74 wantedGot what wanted got
75 = printer (text what <> text ": " <>
76 vcat [text "Wanted " <> ppr wanted <> text ",",
77 text "got " <> ppr got])
79 errorOnMismatch :: (Eq a, Show a) => String -> a -> a -> IO ()
80 errorOnMismatch what wanted got
81 -- This will be caught by readIface which will emit an error
82 -- msg containing the iface module name.
83 = when (wanted /= got) $ ghcError $ ProgramError
84 (what ++ " (wanted " ++ show wanted
85 ++ ", got " ++ show got ++ ")")
86 bh <- Binary.readBinMem hi_path
88 -- Read the magic number to check that this really is a GHC .hi file
89 -- (This magic number does not change when we change
90 -- GHC interface file format)
92 wantedGot "Magic" binaryInterfaceMagic magic
93 errorOnMismatch "magic number mismatch: old/corrupt interface file?"
94 binaryInterfaceMagic magic
96 -- Note [dummy iface field]
97 -- read a dummy 32/64 bit value. This field used to hold the
98 -- dictionary pointer in old interface file formats, but now
99 -- the dictionary pointer is after the version (where it
100 -- should be). Also, the serialisation of value of type "Bin
101 -- a" used to depend on the word size of the machine, now they
102 -- are always 32 bits.
105 then do _ <- Binary.get bh :: IO Word32; return ()
106 else do _ <- Binary.get bh :: IO Word64; return ()
108 -- Check the interface file version and ways.
110 let our_ver = show opt_HiVersion
111 wantedGot "Version" our_ver check_ver
112 errorOnMismatch "mismatched interface file versions" our_ver check_ver
115 let way_descr = getWayDescr dflags
116 wantedGot "Way" way_descr check_way
117 when (checkHiWay == CheckHiWay) $
118 errorOnMismatch "mismatched interface file ways" way_descr check_way
120 -- Read the dictionary
121 -- The next word in the file is a pointer to where the dictionary is
122 -- (probably at the end of the file)
123 dict_p <- Binary.get bh
124 data_p <- tellBin bh -- Remember where we are now
126 dict <- getDictionary bh
127 seekBin bh data_p -- Back to where we were before
129 -- Initialise the user-data field of bh
130 ud <- newReadState dict
131 bh <- return (setUserData bh ud)
133 symtab_p <- Binary.get bh -- Get the symtab ptr
134 data_p <- tellBin bh -- Remember where we are now
136 symtab <- getSymbolTable bh update_nc
137 seekBin bh data_p -- Back to where we were before
138 let ud = getUserData bh
139 bh <- return $! setUserData bh ud{ud_symtab = symtab}
144 writeBinIface :: DynFlags -> FilePath -> ModIface -> IO ()
145 writeBinIface dflags hi_path mod_iface = do
146 bh <- openBinMem initBinMemSize
147 put_ bh binaryInterfaceMagic
149 -- dummy 32/64-bit field before the version/way for
150 -- compatibility with older interface file formats.
151 -- See Note [dummy iface field] above.
153 then Binary.put_ bh (0 :: Word32)
154 else Binary.put_ bh (0 :: Word64)
156 -- The version and way descriptor go next
157 put_ bh (show opt_HiVersion)
158 let way_descr = getWayDescr dflags
161 -- Remember where the dictionary pointer will go
162 dict_p_p <- tellBin bh
163 put_ bh dict_p_p -- Placeholder for ptr to dictionary
165 -- Remember where the symbol table pointer will go
166 symtab_p_p <- tellBin bh
169 -- Make some intial state
170 symtab_next <- newFastMutInt
171 writeFastMutInt symtab_next 0
172 symtab_map <- newIORef emptyUFM
173 let bin_symtab = BinSymbolTable {
174 bin_symtab_next = symtab_next,
175 bin_symtab_map = symtab_map }
176 dict_next_ref <- newFastMutInt
177 writeFastMutInt dict_next_ref 0
178 dict_map_ref <- newIORef emptyUFM
179 let bin_dict = BinDictionary {
180 bin_dict_next = dict_next_ref,
181 bin_dict_map = dict_map_ref }
182 ud <- newWriteState (putName bin_symtab) (putFastString bin_dict)
184 -- Put the main thing,
185 bh <- return $ setUserData bh ud
188 -- Write the symtab pointer at the fornt of the file
189 symtab_p <- tellBin bh -- This is where the symtab will start
190 putAt bh symtab_p_p symtab_p -- Fill in the placeholder
191 seekBin bh symtab_p -- Seek back to the end of the file
193 -- Write the symbol table itself
194 symtab_next <- readFastMutInt symtab_next
195 symtab_map <- readIORef symtab_map
196 putSymbolTable bh symtab_next symtab_map
197 debugTraceMsg dflags 3 (text "writeBinIface:" <+> int symtab_next
200 -- NB. write the dictionary after the symbol table, because
201 -- writing the symbol table may create more dictionary entries.
203 -- Write the dictionary pointer at the fornt of the file
204 dict_p <- tellBin bh -- This is where the dictionary will start
205 putAt bh dict_p_p dict_p -- Fill in the placeholder
206 seekBin bh dict_p -- Seek back to the end of the file
208 -- Write the dictionary itself
209 dict_next <- readFastMutInt dict_next_ref
210 dict_map <- readIORef dict_map_ref
211 putDictionary bh dict_next dict_map
212 debugTraceMsg dflags 3 (text "writeBinIface:" <+> int dict_next
213 <+> text "dict entries")
215 -- And send the result to the file
216 writeBinMem bh hi_path
218 initBinMemSize :: Int
219 initBinMemSize = 1024 * 1024
221 -- The *host* architecture version:
222 #include "../includes/MachDeps.h"
224 binaryInterfaceMagic :: Word32
225 #if WORD_SIZE_IN_BITS == 32
226 binaryInterfaceMagic = 0x1face
227 #elif WORD_SIZE_IN_BITS == 64
228 binaryInterfaceMagic = 0x1face64
231 -- -----------------------------------------------------------------------------
234 putSymbolTable :: BinHandle -> Int -> UniqFM (Int,Name) -> IO ()
235 putSymbolTable bh next_off symtab = do
237 let names = elems (array (0,next_off-1) (eltsUFM symtab))
238 mapM_ (\n -> serialiseName bh n symtab) names
240 getSymbolTable :: BinHandle -> NameCacheUpdater (Array Int Name)
241 -> IO (Array Int Name)
242 getSymbolTable bh update_namecache = do
244 od_names <- sequence (replicate sz (get bh))
245 update_namecache $ \namecache ->
247 arr = listArray (0,sz-1) names
248 (namecache', names) =
249 mapAccumR (fromOnDiskName arr) namecache od_names
252 type OnDiskName = (PackageId, ModuleName, OccName)
259 fromOnDiskName _ nc (pid, mod_name, occ) =
261 mod = mkModule pid mod_name
264 case lookupOrigNameCache cache mod occ of
265 Just name -> (nc, name)
269 uniq = uniqFromSupply us
270 name = mkExternalName uniq mod occ noSrcSpan
271 new_cache = extendNameCache cache mod occ name
273 case splitUniqSupply us of { (us',_) ->
274 ( nc{ nsUniqs = us', nsNames = new_cache }, name )
277 serialiseName :: BinHandle -> Name -> UniqFM (Int,Name) -> IO ()
278 serialiseName bh name _ = do
279 let mod = ASSERT2( isExternalName name, ppr name ) nameModule name
280 put_ bh (modulePackageId mod, moduleName mod, nameOccName name)
283 putName :: BinSymbolTable -> BinHandle -> Name -> IO ()
284 putName BinSymbolTable{
285 bin_symtab_map = symtab_map_ref,
286 bin_symtab_next = symtab_next } bh name
288 symtab_map <- readIORef symtab_map_ref
289 case lookupUFM symtab_map name of
290 Just (off,_) -> put_ bh (fromIntegral off :: Word32)
292 off <- readFastMutInt symtab_next
293 writeFastMutInt symtab_next (off+1)
294 writeIORef symtab_map_ref
295 $! addToUFM symtab_map name (off,name)
296 put_ bh (fromIntegral off :: Word32)
299 data BinSymbolTable = BinSymbolTable {
300 bin_symtab_next :: !FastMutInt, -- The next index to use
301 bin_symtab_map :: !(IORef (UniqFM (Int,Name)))
306 putFastString :: BinDictionary -> BinHandle -> FastString -> IO ()
307 putFastString BinDictionary { bin_dict_next = j_r,
308 bin_dict_map = out_r} bh f
310 out <- readIORef out_r
311 let uniq = getUnique f
312 case lookupUFM out uniq of
313 Just (j, _) -> put_ bh (fromIntegral j :: Word32)
315 j <- readFastMutInt j_r
316 put_ bh (fromIntegral j :: Word32)
317 writeFastMutInt j_r (j + 1)
318 writeIORef out_r $! addToUFM out uniq (j, f)
321 data BinDictionary = BinDictionary {
322 bin_dict_next :: !FastMutInt, -- The next index to use
323 bin_dict_map :: !(IORef (UniqFM (Int,FastString)))
324 -- indexed by FastString
327 -- -----------------------------------------------------------------------------
328 -- All the binary instances
331 {-! for IPName derive: Binary !-}
332 {-! for Fixity derive: Binary !-}
333 {-! for FixityDirection derive: Binary !-}
334 {-! for Boxity derive: Binary !-}
335 {-! for StrictnessMark derive: Binary !-}
336 {-! for Activation derive: Binary !-}
339 {-! for Demand derive: Binary !-}
340 {-! for Demands derive: Binary !-}
341 {-! for DmdResult derive: Binary !-}
342 {-! for StrictSig derive: Binary !-}
345 {-! for DefMeth derive: Binary !-}
348 {-! for HsPred derive: Binary !-}
349 {-! for HsType derive: Binary !-}
350 {-! for TupCon derive: Binary !-}
351 {-! for HsTyVarBndr derive: Binary !-}
354 {-! for UfExpr derive: Binary !-}
355 {-! for UfConAlt derive: Binary !-}
356 {-! for UfBinding derive: Binary !-}
357 {-! for UfBinder derive: Binary !-}
358 {-! for HsIdInfo derive: Binary !-}
359 {-! for UfNote derive: Binary !-}
362 {-! for ConDetails derive: Binary !-}
363 {-! for BangType derive: Binary !-}
366 {-! for IsCafCC derive: Binary !-}
367 {-! for IsDupdCC derive: Binary !-}
368 {-! for CostCentre derive: Binary !-}
372 -- ---------------------------------------------------------------------------
373 -- Reading a binary interface into ParsedIface
375 instance Binary ModIface where
379 mi_iface_hash= iface_hash,
380 mi_mod_hash = mod_hash,
382 mi_finsts = hasFamInsts,
385 mi_exports = exports,
386 mi_exp_hash = exp_hash,
387 mi_fixities = fixities,
392 mi_fam_insts = fam_insts,
394 mi_orphan_hash = orphan_hash,
395 mi_vect_info = vect_info,
396 mi_hpc = hpc_info }) = do
424 hasFamInsts <- get bh
426 usages <- {-# SCC "bin_usages" #-} lazyGet bh
427 exports <- {-# SCC "bin_exports" #-} get bh
429 fixities <- {-# SCC "bin_fixities" #-} get bh
430 warns <- {-# SCC "bin_warns" #-} lazyGet bh
431 anns <- {-# SCC "bin_anns" #-} lazyGet bh
432 decls <- {-# SCC "bin_tycldecls" #-} get bh
433 insts <- {-# SCC "bin_insts" #-} get bh
434 fam_insts <- {-# SCC "bin_fam_insts" #-} get bh
435 rules <- {-# SCC "bin_rules" #-} lazyGet bh
436 orphan_hash <- get bh
440 mi_module = mod_name,
442 mi_iface_hash = iface_hash,
443 mi_mod_hash = mod_hash,
445 mi_finsts = hasFamInsts,
448 mi_exports = exports,
449 mi_exp_hash = exp_hash,
451 mi_fixities = fixities,
454 mi_globals = Nothing,
456 mi_fam_insts = fam_insts,
458 mi_orphan_hash = orphan_hash,
459 mi_vect_info = vect_info,
461 -- And build the cached values
462 mi_warn_fn = mkIfaceWarnCache warns,
463 mi_fix_fn = mkIfaceFixCache fixities,
464 mi_hash_fn = mkIfaceHashCache decls })
466 getWayDescr :: DynFlags -> String
468 | cGhcUnregisterised == "YES" = 'u':tag
470 where tag = buildTag dflags
471 -- if this is an unregisterised build, make sure our interfaces
472 -- can't be used by a registerised build.
474 -------------------------------------------------------------------------
475 -- Types from: HscTypes
476 -------------------------------------------------------------------------
478 instance Binary Dependencies where
479 put_ bh deps = do put_ bh (dep_mods deps)
480 put_ bh (dep_pkgs deps)
481 put_ bh (dep_orphs deps)
482 put_ bh (dep_finsts deps)
484 get bh = do ms <- get bh
488 return (Deps { dep_mods = ms, dep_pkgs = ps, dep_orphs = os,
491 instance (Binary name) => Binary (GenAvailInfo name) where
492 put_ bh (Avail aa) = do
495 put_ bh (AvailTC ab ac) = do
506 return (AvailTC ab ac)
508 instance Binary Usage where
509 put_ bh usg@UsagePackageModule{} = do
511 put_ bh (usg_mod usg)
512 put_ bh (usg_mod_hash usg)
513 put_ bh usg@UsageHomeModule{} = do
515 put_ bh (usg_mod_name usg)
516 put_ bh (usg_mod_hash usg)
517 put_ bh (usg_exports usg)
518 put_ bh (usg_entities usg)
526 return UsagePackageModule { usg_mod = nm, usg_mod_hash = mod }
532 return UsageHomeModule { usg_mod_name = nm, usg_mod_hash = mod,
533 usg_exports = exps, usg_entities = ents }
535 instance Binary Warnings where
536 put_ bh NoWarnings = putByte bh 0
537 put_ bh (WarnAll t) = do
540 put_ bh (WarnSome ts) = do
547 0 -> return NoWarnings
553 instance Binary WarningTxt where
554 put_ bh (WarningTxt w) = do
557 put_ bh (DeprecatedTxt d) = do
565 return (WarningTxt w)
567 return (DeprecatedTxt d)
569 -------------------------------------------------------------------------
570 -- Types from: BasicTypes
571 -------------------------------------------------------------------------
573 instance Binary Activation where
574 put_ bh NeverActive = do
576 put_ bh AlwaysActive = do
578 put_ bh (ActiveBefore aa) = do
581 put_ bh (ActiveAfter ab) = do
587 0 -> do return NeverActive
588 1 -> do return AlwaysActive
590 return (ActiveBefore aa)
592 return (ActiveAfter ab)
594 instance Binary RuleMatchInfo where
595 put_ bh FunLike = putByte bh 0
596 put_ bh ConLike = putByte bh 1
599 if h == 1 then return ConLike
602 instance Binary InlinePragma where
603 put_ bh (InlinePragma a b c) = do
612 return (InlinePragma a b c)
614 instance Binary StrictnessMark where
615 put_ bh MarkedStrict = putByte bh 0
616 put_ bh MarkedUnboxed = putByte bh 1
617 put_ bh NotMarkedStrict = putByte bh 2
621 0 -> do return MarkedStrict
622 1 -> do return MarkedUnboxed
623 _ -> do return NotMarkedStrict
625 instance Binary Boxity where
626 put_ bh Boxed = putByte bh 0
627 put_ bh Unboxed = putByte bh 1
632 _ -> do return Unboxed
634 instance Binary TupCon where
635 put_ bh (TupCon ab ac) = do
641 return (TupCon ab ac)
643 instance Binary RecFlag where
644 put_ bh Recursive = do
646 put_ bh NonRecursive = do
651 0 -> do return Recursive
652 _ -> do return NonRecursive
654 instance Binary DefMeth where
655 put_ bh NoDefMeth = putByte bh 0
656 put_ bh DefMeth = putByte bh 1
657 put_ bh GenDefMeth = putByte bh 2
661 0 -> return NoDefMeth
663 _ -> return GenDefMeth
665 instance Binary FixityDirection where
675 0 -> do return InfixL
676 1 -> do return InfixR
677 _ -> do return InfixN
679 instance Binary Fixity where
680 put_ bh (Fixity aa ab) = do
686 return (Fixity aa ab)
688 instance (Binary name) => Binary (IPName name) where
689 put_ bh (IPName aa) = put_ bh aa
690 get bh = do aa <- get bh
693 -------------------------------------------------------------------------
694 -- Types from: Demand
695 -------------------------------------------------------------------------
697 instance Binary DmdType where
698 -- Ignore DmdEnv when spitting out the DmdType
699 put bh (DmdType _ ds dr) = do p <- put bh ds; put_ bh dr; return (castBin p)
700 get bh = do ds <- get bh; dr <- get bh; return (DmdType emptyVarEnv ds dr)
702 instance Binary Demand where
707 put_ bh (Call aa) = do
710 put_ bh (Eval ab) = do
713 put_ bh (Defer ac) = do
716 put_ bh (Box ad) = do
736 instance Binary Demands where
737 put_ bh (Poly aa) = do
740 put_ bh (Prod ab) = do
751 instance Binary DmdResult where
761 0 -> do return TopRes
762 1 -> do return RetCPR -- Really use RetCPR even if -fcpr-off
763 -- The wrapper was generated for CPR in
764 -- the imported module!
765 _ -> do return BotRes
767 instance Binary StrictSig where
768 put_ bh (StrictSig aa) = do
772 return (StrictSig aa)
775 -------------------------------------------------------------------------
776 -- Types from: CostCentre
777 -------------------------------------------------------------------------
779 instance Binary IsCafCC where
782 put_ bh NotCafCC = do
788 _ -> do return NotCafCC
790 instance Binary IsDupdCC where
791 put_ bh OriginalCC = do
798 0 -> do return OriginalCC
799 _ -> do return DupdCC
801 instance Binary CostCentre where
802 put_ bh NoCostCentre = do
804 put_ bh (NormalCC aa ab ac ad) = do
810 put_ bh (AllCafsCC ae) = do
816 0 -> do return NoCostCentre
821 return (NormalCC aa ab ac ad)
823 return (AllCafsCC ae)
825 -------------------------------------------------------------------------
826 -- IfaceTypes and friends
827 -------------------------------------------------------------------------
829 instance Binary IfaceBndr where
830 put_ bh (IfaceIdBndr aa) = do
833 put_ bh (IfaceTvBndr ab) = do
840 return (IfaceIdBndr aa)
842 return (IfaceTvBndr ab)
844 instance Binary IfaceLetBndr where
845 put_ bh (IfLetBndr a b c) = do
849 get bh = do a <- get bh
852 return (IfLetBndr a b c)
854 instance Binary IfaceType where
855 put_ bh (IfaceForAllTy aa ab) = do
859 put_ bh (IfaceTyVar ad) = do
862 put_ bh (IfaceAppTy ae af) = do
866 put_ bh (IfaceFunTy ag ah) = do
870 put_ bh (IfacePredTy aq) = do
874 -- Simple compression for common cases of TyConApp
875 put_ bh (IfaceTyConApp IfaceIntTc []) = putByte bh 6
876 put_ bh (IfaceTyConApp IfaceCharTc []) = putByte bh 7
877 put_ bh (IfaceTyConApp IfaceBoolTc []) = putByte bh 8
878 put_ bh (IfaceTyConApp IfaceListTc [ty]) = do { putByte bh 9; put_ bh ty }
879 -- Unit tuple and pairs
880 put_ bh (IfaceTyConApp (IfaceTupTc Boxed 0) []) = putByte bh 10
881 put_ bh (IfaceTyConApp (IfaceTupTc Boxed 2) [t1,t2]) = do { putByte bh 11; put_ bh t1; put_ bh t2 }
883 put_ bh (IfaceTyConApp IfaceLiftedTypeKindTc []) = putByte bh 12
884 put_ bh (IfaceTyConApp IfaceOpenTypeKindTc []) = putByte bh 13
885 put_ bh (IfaceTyConApp IfaceUnliftedTypeKindTc []) = putByte bh 14
886 put_ bh (IfaceTyConApp IfaceUbxTupleKindTc []) = putByte bh 15
887 put_ bh (IfaceTyConApp IfaceArgTypeKindTc []) = putByte bh 16
888 put_ bh (IfaceTyConApp (IfaceAnyTc k) []) = do { putByte bh 17; put_ bh k }
892 put_ bh (IfaceTyConApp (IfaceTc tc) tys) = do { putByte bh 18; put_ bh tc; put_ bh tys }
893 put_ bh (IfaceTyConApp tc tys) = do { putByte bh 19; put_ bh tc; put_ bh tys }
900 return (IfaceForAllTy aa ab)
902 return (IfaceTyVar ad)
905 return (IfaceAppTy ae af)
908 return (IfaceFunTy ag ah)
910 return (IfacePredTy ap)
912 -- Now the special cases for TyConApp
913 6 -> return (IfaceTyConApp IfaceIntTc [])
914 7 -> return (IfaceTyConApp IfaceCharTc [])
915 8 -> return (IfaceTyConApp IfaceBoolTc [])
916 9 -> do { ty <- get bh; return (IfaceTyConApp IfaceListTc [ty]) }
917 10 -> return (IfaceTyConApp (IfaceTupTc Boxed 0) [])
918 11 -> do { t1 <- get bh; t2 <- get bh; return (IfaceTyConApp (IfaceTupTc Boxed 2) [t1,t2]) }
919 12 -> return (IfaceTyConApp IfaceLiftedTypeKindTc [])
920 13 -> return (IfaceTyConApp IfaceOpenTypeKindTc [])
921 14 -> return (IfaceTyConApp IfaceUnliftedTypeKindTc [])
922 15 -> return (IfaceTyConApp IfaceUbxTupleKindTc [])
923 16 -> return (IfaceTyConApp IfaceArgTypeKindTc [])
924 17 -> do { k <- get bh; return (IfaceTyConApp (IfaceAnyTc k) []) }
926 18 -> do { tc <- get bh; tys <- get bh; return (IfaceTyConApp (IfaceTc tc) tys) }
927 _ -> do { tc <- get bh; tys <- get bh; return (IfaceTyConApp tc tys) }
929 instance Binary IfaceTyCon where
930 -- Int,Char,Bool can't show up here because they can't not be saturated
932 put_ bh IfaceIntTc = putByte bh 1
933 put_ bh IfaceBoolTc = putByte bh 2
934 put_ bh IfaceCharTc = putByte bh 3
935 put_ bh IfaceListTc = putByte bh 4
936 put_ bh IfacePArrTc = putByte bh 5
937 put_ bh IfaceLiftedTypeKindTc = putByte bh 6
938 put_ bh IfaceOpenTypeKindTc = putByte bh 7
939 put_ bh IfaceUnliftedTypeKindTc = putByte bh 8
940 put_ bh IfaceUbxTupleKindTc = putByte bh 9
941 put_ bh IfaceArgTypeKindTc = putByte bh 10
942 put_ bh (IfaceTupTc bx ar) = do { putByte bh 11; put_ bh bx; put_ bh ar }
943 put_ bh (IfaceTc ext) = do { putByte bh 12; put_ bh ext }
944 put_ bh (IfaceAnyTc k) = do { putByte bh 13; put_ bh k }
949 1 -> return IfaceIntTc
950 2 -> return IfaceBoolTc
951 3 -> return IfaceCharTc
952 4 -> return IfaceListTc
953 5 -> return IfacePArrTc
954 6 -> return IfaceLiftedTypeKindTc
955 7 -> return IfaceOpenTypeKindTc
956 8 -> return IfaceUnliftedTypeKindTc
957 9 -> return IfaceUbxTupleKindTc
958 10 -> return IfaceArgTypeKindTc
959 11 -> do { bx <- get bh; ar <- get bh; return (IfaceTupTc bx ar) }
960 12 -> do { ext <- get bh; return (IfaceTc ext) }
961 _ -> do { k <- get bh; return (IfaceAnyTc k) }
963 instance Binary IfacePredType where
964 put_ bh (IfaceClassP aa ab) = do
968 put_ bh (IfaceIParam ac ad) = do
972 put_ bh (IfaceEqPred ac ad) = do
981 return (IfaceClassP aa ab)
984 return (IfaceIParam ac ad)
987 return (IfaceEqPred ac ad)
988 _ -> panic ("get IfacePredType " ++ show h)
990 -------------------------------------------------------------------------
991 -- IfaceExpr and friends
992 -------------------------------------------------------------------------
994 instance Binary IfaceExpr where
995 put_ bh (IfaceLcl aa) = do
998 put_ bh (IfaceType ab) = do
1001 put_ bh (IfaceTuple ac ad) = do
1005 put_ bh (IfaceLam ae af) = do
1009 put_ bh (IfaceApp ag ah) = do
1014 put_ bh (IfaceCase ai aj al ak) = do
1021 put_ bh (IfaceLet al am) = do
1025 put_ bh (IfaceNote an ao) = do
1029 put_ bh (IfaceLit ap) = do
1032 put_ bh (IfaceFCall as at) = do
1036 put_ bh (IfaceExt aa) = do
1039 put_ bh (IfaceCast ie ico) = do
1043 put_ bh (IfaceTick m ix) = do
1050 0 -> do aa <- get bh
1051 return (IfaceLcl aa)
1052 1 -> do ab <- get bh
1053 return (IfaceType ab)
1054 2 -> do ac <- get bh
1056 return (IfaceTuple ac ad)
1057 3 -> do ae <- get bh
1059 return (IfaceLam ae af)
1060 4 -> do ag <- get bh
1062 return (IfaceApp ag ah)
1063 5 -> do ai <- get bh
1069 return (IfaceCase ai aj al ak)
1070 6 -> do al <- get bh
1072 return (IfaceLet al am)
1073 7 -> do an <- get bh
1075 return (IfaceNote an ao)
1076 8 -> do ap <- get bh
1077 return (IfaceLit ap)
1078 9 -> do as <- get bh
1080 return (IfaceFCall as at)
1081 10 -> do aa <- get bh
1082 return (IfaceExt aa)
1083 11 -> do ie <- get bh
1085 return (IfaceCast ie ico)
1086 12 -> do m <- get bh
1088 return (IfaceTick m ix)
1089 _ -> panic ("get IfaceExpr " ++ show h)
1091 instance Binary IfaceConAlt where
1092 put_ bh IfaceDefault = do
1094 put_ bh (IfaceDataAlt aa) = do
1097 put_ bh (IfaceTupleAlt ab) = do
1100 put_ bh (IfaceLitAlt ac) = do
1106 0 -> do return IfaceDefault
1107 1 -> do aa <- get bh
1108 return (IfaceDataAlt aa)
1109 2 -> do ab <- get bh
1110 return (IfaceTupleAlt ab)
1111 _ -> do ac <- get bh
1112 return (IfaceLitAlt ac)
1114 instance Binary IfaceBinding where
1115 put_ bh (IfaceNonRec aa ab) = do
1119 put_ bh (IfaceRec ac) = do
1125 0 -> do aa <- get bh
1127 return (IfaceNonRec aa ab)
1128 _ -> do ac <- get bh
1129 return (IfaceRec ac)
1131 instance Binary IfaceIdDetails where
1132 put_ bh IfVanillaId = putByte bh 0
1133 put_ bh (IfRecSelId a b) = do { putByte bh 1; put_ bh a; put_ bh b }
1134 put_ bh IfDFunId = putByte bh 2
1138 0 -> return IfVanillaId
1141 return (IfRecSelId a b)
1142 _ -> return IfDFunId
1144 instance Binary IfaceIdInfo where
1145 put_ bh NoInfo = putByte bh 0
1146 put_ bh (HasInfo i) = do
1148 lazyPut bh i -- NB lazyPut
1154 _ -> do info <- lazyGet bh -- NB lazyGet
1155 return (HasInfo info)
1157 instance Binary IfaceInfoItem where
1158 put_ bh (HsArity aa) = do
1161 put_ bh (HsStrictness ab) = do
1164 put_ bh (HsUnfold ad) = do
1167 put_ bh (HsInline ad) = do
1170 put_ bh HsNoCafRefs = do
1175 0 -> do aa <- get bh
1177 1 -> do ab <- get bh
1178 return (HsStrictness ab)
1179 2 -> do ad <- get bh
1180 return (HsUnfold ad)
1181 3 -> do ad <- get bh
1182 return (HsInline ad)
1183 _ -> do return HsNoCafRefs
1185 instance Binary IfaceUnfolding where
1186 put_ bh (IfCoreUnfold e) = do
1189 put_ bh (IfInlineRule a b e) = do
1194 put_ bh (IfWrapper a n) = do
1198 put_ bh (IfDFunUnfold as) = do
1205 return (IfCoreUnfold e)
1209 return (IfInlineRule a b e)
1212 return (IfWrapper a n)
1213 _ -> do as <- get bh
1214 return (IfDFunUnfold as)
1216 instance Binary IfaceNote where
1217 put_ bh (IfaceSCC aa) = do
1220 put_ bh (IfaceCoreNote s) = do
1226 0 -> do aa <- get bh
1227 return (IfaceSCC aa)
1228 4 -> do ac <- get bh
1229 return (IfaceCoreNote ac)
1230 _ -> panic ("get IfaceNote " ++ show h)
1232 -------------------------------------------------------------------------
1233 -- IfaceDecl and friends
1234 -------------------------------------------------------------------------
1236 -- A bit of magic going on here: there's no need to store the OccName
1237 -- for a decl on the disk, since we can infer the namespace from the
1238 -- context; however it is useful to have the OccName in the IfaceDecl
1239 -- to avoid re-building it in various places. So we build the OccName
1240 -- when de-serialising.
1242 instance Binary IfaceDecl where
1243 put_ bh (IfaceId name ty details idinfo) = do
1245 put_ bh (occNameFS name)
1249 put_ _ (IfaceForeign _ _) =
1250 error "Binary.put_(IfaceDecl): IfaceForeign"
1251 put_ bh (IfaceData a1 a2 a3 a4 a5 a6 a7 a8) = do
1253 put_ bh (occNameFS a1)
1261 put_ bh (IfaceSyn a1 a2 a3 a4 a5) = do
1263 put_ bh (occNameFS a1)
1268 put_ bh (IfaceClass a1 a2 a3 a4 a5 a6 a7) = do
1271 put_ bh (occNameFS a2)
1280 0 -> do name <- get bh
1284 occ <- return $! mkOccNameFS varName name
1285 return (IfaceId occ ty details idinfo)
1286 1 -> error "Binary.get(TyClDecl): ForeignType"
1296 occ <- return $! mkOccNameFS tcName a1
1297 return (IfaceData occ a2 a3 a4 a5 a6 a7 a8)
1304 occ <- return $! mkOccNameFS tcName a1
1305 return (IfaceSyn occ a2 a3 a4 a5)
1314 occ <- return $! mkOccNameFS clsName a2
1315 return (IfaceClass a1 occ a3 a4 a5 a6 a7)
1317 instance Binary IfaceInst where
1318 put_ bh (IfaceInst cls tys dfun flag orph) = do
1324 get bh = do cls <- get bh
1329 return (IfaceInst cls tys dfun flag orph)
1331 instance Binary IfaceFamInst where
1332 put_ bh (IfaceFamInst fam tys tycon) = do
1336 get bh = do fam <- get bh
1339 return (IfaceFamInst fam tys tycon)
1341 instance Binary OverlapFlag where
1342 put_ bh NoOverlap = putByte bh 0
1343 put_ bh OverlapOk = putByte bh 1
1344 put_ bh Incoherent = putByte bh 2
1345 get bh = do h <- getByte bh
1347 0 -> return NoOverlap
1348 1 -> return OverlapOk
1349 2 -> return Incoherent
1350 _ -> panic ("get OverlapFlag " ++ show h)
1352 instance Binary IfaceConDecls where
1353 put_ bh IfAbstractTyCon = putByte bh 0
1354 put_ bh IfOpenDataTyCon = putByte bh 1
1355 put_ bh (IfDataTyCon cs) = do { putByte bh 2
1357 put_ bh (IfNewTyCon c) = do { putByte bh 3
1362 0 -> return IfAbstractTyCon
1363 1 -> return IfOpenDataTyCon
1364 2 -> do cs <- get bh
1365 return (IfDataTyCon cs)
1366 _ -> do aa <- get bh
1367 return (IfNewTyCon aa)
1369 instance Binary IfaceConDecl where
1370 put_ bh (IfCon a1 a2 a3 a4 a5 a6 a7 a8 a9 a10) = do
1381 get bh = do a1 <- get bh
1391 return (IfCon a1 a2 a3 a4 a5 a6 a7 a8 a9 a10)
1393 instance Binary IfaceClassOp where
1394 put_ bh (IfaceClassOp n def ty) = do
1395 put_ bh (occNameFS n)
1402 occ <- return $! mkOccNameFS varName n
1403 return (IfaceClassOp occ def ty)
1405 instance Binary IfaceRule where
1406 put_ bh (IfaceRule a1 a2 a3 a4 a5 a6 a7) = do
1422 return (IfaceRule a1 a2 a3 a4 a5 a6 a7)
1424 instance Binary IfaceAnnotation where
1425 put_ bh (IfaceAnnotation a1 a2) = do
1431 return (IfaceAnnotation a1 a2)
1433 instance Binary name => Binary (AnnTarget name) where
1434 put_ bh (NamedTarget a) = do
1437 put_ bh (ModuleTarget a) = do
1444 return (NamedTarget a)
1446 return (ModuleTarget a)
1448 instance Binary IfaceVectInfo where
1449 put_ bh (IfaceVectInfo a1 a2 a3) = do
1457 return (IfaceVectInfo a1 a2 a3)