* Refactor CLabel.RtsLabel to CLabel.CmmLabel
[ghc-hetmet.git] / compiler / cmm / CLabel.hs
index 181071f..7dde9f9 100644 (file)
@@ -73,13 +73,13 @@ module CLabel (
        mkSelectorInfoLabel,
        mkSelectorEntryLabel,
 
-       mkRtsInfoLabel,
-       mkRtsEntryLabel,
-       mkRtsRetInfoLabel,
-       mkRtsRetLabel,
-       mkRtsCodeLabel,
-       mkRtsDataLabel,
-       mkRtsGcPtrLabel,
+       mkCmmInfoLabel,
+       mkCmmEntryLabel,
+       mkCmmRetInfoLabel,
+       mkCmmRetLabel,
+       mkCmmCodeLabel,
+       mkCmmDataLabel,
+       mkCmmGcPtrLabel,
 
        mkRtsApFastLabel,
 
@@ -134,7 +134,7 @@ import UniqSet
 -- The CLabel type
 
 {-
-CLabel is an abstract type that supports the following operations:
+  | CLabel is an abstract type that supports the following operations:
 
   - Pretty printing
 
@@ -156,13 +156,35 @@ CLabel is an abstract type that supports the following operations:
 -}
 
 data CLabel
-  = IdLabel                    -- A family of labels related to the
-       Name                    -- definition of a particular Id or Con
+  = -- | A label related to the definition of a particular Id or Con in a .hs file.
+    IdLabel                    
+       Name                    
         CafInfo
-       IdLabelInfo
+       IdLabelInfo             -- encodes the suffix of the label
+  
+  -- | A label from a .cmm file that is not associated with a .hs level Id.
+  | CmmLabel                   
+       PackageId               -- what package the label belongs to.
+       FastString              -- identifier giving the prefix of the label
+       CmmLabelInfo            -- encodes the suffix of the label
+
+  -- | A label with a baked-in \/ algorithmically generated name that definitely
+  --    comes from the RTS. The code for it must compile into libHSrts.a \/ libHSrts.so
+  --    If it doesn't have an algorithmically generated name then use a CmmLabel 
+  --    instead and give it an appropriate Module argument.
+  | RtsLabel                   
+       RtsLabelInfo
+
+  -- | A 'C' (or otherwise foreign) label
+  | ForeignLabel FastString     
+        (Maybe Int)            -- possible '@n' suffix for stdcall functions
+                               -- When generating C, the '@n' suffix is omitted, but when
+                               -- generating assembler we must add it to the label.
+        Bool                    -- True <=> is dynamic
+        FunctionOrData
 
-  | CaseLabel                  -- A family of labels related to a particular
-                               -- case expression.
+  -- | A family of labels related to a particular case expression.
+  | CaseLabel                  
        {-# UNPACK #-} !Unique  -- Unique says which case expression
        CaseLabelInfo
 
@@ -189,62 +211,57 @@ data CLabel
 
   | ModuleRegdLabel
 
-  | RtsLabel RtsLabelInfo
-
-  | ForeignLabel FastString     -- a 'C' (or otherwise foreign) label
-        (Maybe Int)             -- possible '@n' suffix for stdcall functions
-                -- When generating C, the '@n' suffix is omitted, but when
-                -- generating assembler we must add it to the label.
-        Bool                    -- True <=> is dynamic
-        FunctionOrData
-
   | CC_Label  CostCentre
   | CCS_Label CostCentreStack
 
-      -- Dynamic Linking in the NCG:
-      -- generated and used inside the NCG only,
-      -- see module PositionIndependentCode for details.
-      
+    
+  -- | These labels are generated and used inside the NCG only. 
+  --   They are special variants of a label used for dynamic linking
+  --    see module PositionIndependentCode for details.
   | DynamicLinkerLabel DynamicLinkerLabelInfo CLabel
-        -- special variants of a label used for dynamic linking
+  -- | This label is generated and used inside the NCG only. 
+  --   It is used as a base for PIC calculations on some platforms.
+  --    It takes the form of a local numeric assembler label '1'; and 
+  --    is pretty-printed as 1b, referring to the previous definition
+  --    of 1: in the assembler source file.
+  | PicBaseLabel                
+  -- | A label before an info table to prevent excessive dead-stripping on darwin
+  | DeadStripPreventer CLabel
 
-  | PicBaseLabel                -- a label used as a base for PIC calculations
-                                -- on some platforms.
-                                -- It takes the form of a local numeric
-                                -- assembler label '1'; it is pretty-printed
-                                -- as 1b, referring to the previous definition
-                                -- of 1: in the assembler source file.
 
-  | DeadStripPreventer CLabel
-    -- label before an info table to prevent excessive dead-stripping on darwin
+  -- | Per-module table of tick locations
+  | HpcTicksLabel Module
 
-  | HpcTicksLabel Module       -- Per-module table of tick locations
-  | HpcModuleNameLabel         -- Per-module name of the module for Hpc
+  -- | Per-module name of the module for Hpc
+  | HpcModuleNameLabel
 
-  | LargeSRTLabel           -- Label of an StgLargeSRT
+  -- | Label of an StgLargeSRT
+  | LargeSRTLabel
         {-# UNPACK #-} !Unique
 
-  | LargeBitmapLabel        -- A bitmap (function or case return)
+  -- | A bitmap (function or case return)
+  | LargeBitmapLabel
         {-# UNPACK #-} !Unique
 
   deriving (Eq, Ord)
 
 data IdLabelInfo
-  = Closure            -- Label for closure
-  | SRT                 -- Static reference table
-  | InfoTable          -- Info tables for closures; always read-only
-  | Entry              -- entry point
-  | Slow               -- slow entry point
+  = Closure            -- ^ Label for closure
+  | SRT                 -- ^ Static reference table
+  | InfoTable          -- ^ Info tables for closures; always read-only
+  | Entry              -- ^ Entry point
+  | Slow               -- ^ Slow entry point
 
-  | RednCounts         -- Label of place to keep Ticky-ticky  info for 
-                       -- this Id
+  | RednCounts         -- ^ Label of place to keep Ticky-ticky  info for this Id
 
-  | ConEntry           -- constructor entry point
-  | ConInfoTable               -- corresponding info table
-  | StaticConEntry     -- static constructor entry point
-  | StaticInfoTable    -- corresponding info table
+  | ConEntry           -- ^ Constructor entry point
+  | ConInfoTable       -- ^ Corresponding info table
+  | StaticConEntry     -- ^ Static constructor entry point
+  | StaticInfoTable    -- ^ Corresponding info table
 
-  | ClosureTable       -- table of closures for Enum tycons
+  | ClosureTable       -- ^ Table of closures for Enum tycons
 
   deriving (Eq, Ord)
 
@@ -258,43 +275,50 @@ data CaseLabelInfo
 
 
 data RtsLabelInfo
-  = RtsSelectorInfoTable Bool{-updatable-} Int{-offset-}       -- Selector thunks
-  | RtsSelectorEntry   Bool{-updatable-} Int{-offset-}
+  = RtsSelectorInfoTable Bool{-updatable-} Int{-offset-}  -- ^ Selector thunks
+  | RtsSelectorEntry     Bool{-updatable-} Int{-offset-}
 
-  | RtsApInfoTable Bool{-updatable-} Int{-arity-}              -- AP thunks
-  | RtsApEntry   Bool{-updatable-} Int{-arity-}
+  | RtsApInfoTable       Bool{-updatable-} Int{-arity-}    -- ^ AP thunks
+  | RtsApEntry           Bool{-updatable-} Int{-arity-}
 
   | RtsPrimOp PrimOp
-
-  | RtsInfo       FastString   -- misc rts info tables
-  | RtsEntry      FastString   -- misc rts entry points
-  | RtsRetInfo    FastString   -- misc rts ret info tables
-  | RtsRet        FastString   -- misc rts return points
-  | RtsData       FastString   -- misc rts data bits, eg CHARLIKE_closure
-  | RtsCode       FastString   -- misc rts code
-  | RtsGcPtr      FastString    -- GcPtrs eg CHARLIKE_closure  
-
-  | RtsApFast    FastString    -- _fast versions of generic apply
-
+  | RtsApFast    FastString    -- ^ _fast versions of generic apply
   | RtsSlowTickyCtr String
 
   deriving (Eq, Ord)
-       -- NOTE: Eq on LitString compares the pointer only, so this isn't
-       -- a real equality.
+  -- NOTE: Eq on LitString compares the pointer only, so this isn't
+  -- a real equality.
+
+
+-- | What type of Cmm label we're dealing with.
+--     Determines the suffix appended to the name when a CLabel.CmmLabel
+--     is pretty printed.
+data CmmLabelInfo
+  = CmmInfo                    -- ^ misc rts info tabless,     suffix _info
+  | CmmEntry                   -- ^ misc rts entry points,     suffix _entry
+  | CmmRetInfo                 -- ^ misc rts ret info tables,  suffix _info
+  | CmmRet                     -- ^ misc rts return points,    suffix _ret
+  | CmmData                    -- ^ misc rts data bits, eg CHARLIKE_closure
+  | CmmCode                    -- ^ misc rts code
+  | CmmGcPtr                   -- ^ GcPtrs eg CHARLIKE_closure  
+  deriving (Eq, Ord)
 
 data DynamicLinkerLabelInfo
-  = CodeStub            -- MachO: Lfoo$stub, ELF: foo@plt
-  | SymbolPtr           -- MachO: Lfoo$non_lazy_ptr, Windows: __imp_foo
-  | GotSymbolPtr        -- ELF: foo@got
-  | GotSymbolOffset     -- ELF: foo@gotoff
+  = CodeStub                   -- MachO: Lfoo$stub, ELF: foo@plt
+  | SymbolPtr                  -- MachO: Lfoo$non_lazy_ptr, Windows: __imp_foo
+  | GotSymbolPtr               -- ELF: foo@got
+  | GotSymbolOffset            -- ELF: foo@gotoff
   
   deriving (Eq, Ord)
-  
+
 -- -----------------------------------------------------------------------------
 -- Constructing CLabels
+-- -----------------------------------------------------------------------------
 
+-- Constructing IdLabels 
 -- These are always local:
-mkSRTLabel             name c  = IdLabel name  c SRT
+mkSRTLabel             name c  = IdLabel name  c SRT
 mkSlowEntryLabel       name c  = IdLabel name  c Slow
 mkRednCountsLabel      name c  = IdLabel name  c RednCounts
 
@@ -318,144 +342,164 @@ mkStaticInfoTableLabel name c     = IdLabel    name c StaticInfoTable
 mkConEntryLabel name        c     = IdLabel name c ConEntry
 mkStaticConEntryLabel name  c     = IdLabel name c StaticConEntry
 
-mkLargeSRTLabel        uniq    = LargeSRTLabel uniq
-mkBitmapLabel  uniq    = LargeBitmapLabel uniq
-
-mkReturnPtLabel uniq           = CaseLabel uniq CaseReturnPt
-mkReturnInfoLabel uniq         = CaseLabel uniq CaseReturnInfo
-mkAltLabel      uniq tag       = CaseLabel uniq (CaseAlt tag)
-mkDefaultLabel  uniq           = CaseLabel uniq CaseDefault
-
-mkStringLitLabel               = StringLitLabel
-mkAsmTempLabel :: Uniquable a => a -> CLabel
-mkAsmTempLabel a               = AsmTempLabel (getUnique a)
-
-mkModuleInitLabel :: Module -> String -> CLabel
-mkModuleInitLabel mod way        = ModuleInitLabel mod way
-
-mkPlainModuleInitLabel :: Module -> CLabel
-mkPlainModuleInitLabel mod       = PlainModuleInitLabel mod
-
-mkModuleInitTableLabel :: Module -> CLabel
-mkModuleInitTableLabel mod       = ModuleInitTableLabel mod
-
-       -- Some fixed runtime system labels
-
-mkSplitMarkerLabel             = RtsLabel (RtsCode (fsLit "__stg_split_marker"))
-mkDirty_MUT_VAR_Label          = RtsLabel (RtsCode (fsLit "dirty_MUT_VAR"))
-mkUpdInfoLabel                 = RtsLabel (RtsInfo (fsLit "stg_upd_frame"))
-mkIndStaticInfoLabel           = RtsLabel (RtsInfo (fsLit "stg_IND_STATIC"))
-mkMainCapabilityLabel          = RtsLabel (RtsData (fsLit "MainCapability"))
-mkMAP_FROZEN_infoLabel         = RtsLabel (RtsInfo (fsLit "stg_MUT_ARR_PTRS_FROZEN0"))
-mkMAP_DIRTY_infoLabel          = RtsLabel (RtsInfo (fsLit "stg_MUT_ARR_PTRS_DIRTY"))
-mkEMPTY_MVAR_infoLabel         = RtsLabel (RtsInfo (fsLit "stg_EMPTY_MVAR"))
-
-mkTopTickyCtrLabel             = RtsLabel (RtsData (fsLit "top_ct"))
-mkCAFBlackHoleInfoTableLabel   = RtsLabel (RtsInfo (fsLit "stg_CAF_BLACKHOLE"))
+-- Constructing Cmm Labels
+mkSplitMarkerLabel             = CmmLabel rtsPackageId (fsLit "__stg_split_marker")    CmmCode
+mkDirty_MUT_VAR_Label          = CmmLabel rtsPackageId (fsLit "dirty_MUT_VAR")         CmmCode
+mkUpdInfoLabel                 = CmmLabel rtsPackageId (fsLit "stg_upd_frame")         CmmInfo
+mkIndStaticInfoLabel           = CmmLabel rtsPackageId (fsLit "stg_IND_STATIC")        CmmInfo
+mkMainCapabilityLabel          = CmmLabel rtsPackageId (fsLit "MainCapability")        CmmData
+mkMAP_FROZEN_infoLabel         = CmmLabel rtsPackageId (fsLit "stg_MUT_ARR_PTRS_FROZEN0") CmmInfo
+mkMAP_DIRTY_infoLabel          = CmmLabel rtsPackageId (fsLit "stg_MUT_ARR_PTRS_DIRTY") CmmInfo
+mkEMPTY_MVAR_infoLabel         = CmmLabel rtsPackageId (fsLit "stg_EMPTY_MVAR")        CmmInfo
+mkTopTickyCtrLabel             = CmmLabel rtsPackageId (fsLit "top_ct")                CmmData
+mkCAFBlackHoleInfoTableLabel   = CmmLabel rtsPackageId (fsLit "stg_CAF_BLACKHOLE")     CmmInfo
+
+-----
+mkCmmInfoLabel,   mkCmmEntryLabel, mkCmmRetInfoLabel, mkCmmRetLabel,
+  mkCmmCodeLabel, mkCmmDataLabel,  mkCmmGcPtrLabel
+       :: PackageId -> FastString -> CLabel
+
+mkCmmInfoLabel      pkg str    = CmmLabel pkg str CmmInfo
+mkCmmEntryLabel     pkg str    = CmmLabel pkg str CmmEntry
+mkCmmRetInfoLabel   pkg str    = CmmLabel pkg str CmmRetInfo
+mkCmmRetLabel       pkg str    = CmmLabel pkg str CmmRet
+mkCmmCodeLabel      pkg str    = CmmLabel pkg str CmmCode
+mkCmmDataLabel      pkg str    = CmmLabel pkg str CmmData
+mkCmmGcPtrLabel     pkg str    = CmmLabel pkg str CmmGcPtr
+
+
+-- Constructing RtsLabels
 mkRtsPrimOpLabel primop                = RtsLabel (RtsPrimOp primop)
 
-moduleRegdLabel                        = ModuleRegdLabel
-moduleRegTableLabel             = ModuleInitTableLabel 
-
 mkSelectorInfoLabel  upd off   = RtsLabel (RtsSelectorInfoTable upd off)
-mkSelectorEntryLabel upd off   = RtsLabel (RtsSelectorEntry   upd off)
+mkSelectorEntryLabel upd off   = RtsLabel (RtsSelectorEntry     upd off)
 
-mkApInfoTableLabel  upd off    = RtsLabel (RtsApInfoTable upd off)
-mkApEntryLabel upd off         = RtsLabel (RtsApEntry   upd off)
+mkApInfoTableLabel   upd off   = RtsLabel (RtsApInfoTable       upd off)
+mkApEntryLabel       upd off   = RtsLabel (RtsApEntry           upd off)
 
-        -- Primitive / cmm call labels
 
+-- Constructing ForeignLabels
+-- Primitive / cmm call labels
 mkPrimCallLabel :: PrimCall -> CLabel
 mkPrimCallLabel (PrimCall str)  = ForeignLabel str Nothing False IsFunction
 
-       -- Foreign labels
-
+-- Foreign labels
 mkForeignLabel :: FastString -> Maybe Int -> Bool -> FunctionOrData -> CLabel
 mkForeignLabel str mb_sz is_dynamic fod
     = ForeignLabel str mb_sz is_dynamic fod
 
 addLabelSize :: CLabel -> Int -> CLabel
 addLabelSize (ForeignLabel str _ is_dynamic fod) sz
-  = ForeignLabel str (Just sz) is_dynamic fod
+    = ForeignLabel str (Just sz) is_dynamic fod
 addLabelSize label _
-  = label
+    = label
 
 foreignLabelStdcallInfo :: CLabel -> Maybe Int
 foreignLabelStdcallInfo (ForeignLabel _ info _ _) = info
 foreignLabelStdcallInfo _lbl = Nothing
 
-       -- Cost centres etc.
 
-mkCCLabel      cc              = CC_Label cc
-mkCCSLabel     ccs             = CCS_Label ccs
+-- Constructing Large*Labels
+mkLargeSRTLabel        uniq            = LargeSRTLabel uniq
+mkBitmapLabel  uniq            = LargeBitmapLabel uniq
+
+
+-- Constructin CaseLabels
+mkReturnPtLabel uniq           = CaseLabel uniq CaseReturnPt
+mkReturnInfoLabel uniq         = CaseLabel uniq CaseReturnInfo
+mkAltLabel      uniq tag       = CaseLabel uniq (CaseAlt tag)
+mkDefaultLabel  uniq           = CaseLabel uniq CaseDefault
 
-mkRtsInfoLabel      str = RtsLabel (RtsInfo      str)
-mkRtsEntryLabel     str = RtsLabel (RtsEntry     str)
-mkRtsRetInfoLabel   str = RtsLabel (RtsRetInfo   str)
-mkRtsRetLabel       str = RtsLabel (RtsRet       str)
-mkRtsCodeLabel      str = RtsLabel (RtsCode      str)
-mkRtsDataLabel      str = RtsLabel (RtsData      str)
-mkRtsGcPtrLabel     str = RtsLabel (RtsGcPtr     str)
+-- Constructing Cost Center Labels
+mkCCLabel          cc          = CC_Label cc
+mkCCSLabel         ccs         = CCS_Label ccs
 
 mkRtsApFastLabel str = RtsLabel (RtsApFast str)
 
 mkRtsSlowTickyCtrLabel :: String -> CLabel
 mkRtsSlowTickyCtrLabel pat = RtsLabel (RtsSlowTickyCtr pat)
 
-        -- Coverage
 
+-- Constructing Code Coverage Labels
 mkHpcTicksLabel                = HpcTicksLabel
 mkHpcModuleNameLabel           = HpcModuleNameLabel
 
-        -- Dynamic linking
-        
+
+-- Constructing labels used for dynamic linking
 mkDynamicLinkerLabel :: DynamicLinkerLabelInfo -> CLabel -> CLabel
-mkDynamicLinkerLabel = DynamicLinkerLabel
+mkDynamicLinkerLabel           = DynamicLinkerLabel
 
 dynamicLinkerLabelInfo :: CLabel -> Maybe (DynamicLinkerLabelInfo, CLabel)
 dynamicLinkerLabelInfo (DynamicLinkerLabel info lbl) = Just (info, lbl)
-dynamicLinkerLabelInfo _ = Nothing
-
-        -- Position independent code
-        
+dynamicLinkerLabelInfo _       = Nothing
+    
 mkPicBaseLabel :: CLabel
-mkPicBaseLabel = PicBaseLabel
+mkPicBaseLabel                         = PicBaseLabel
+
 
+-- Constructing miscellaneous other labels
 mkDeadStripPreventer :: CLabel -> CLabel
-mkDeadStripPreventer lbl = DeadStripPreventer lbl
+mkDeadStripPreventer lbl       = DeadStripPreventer lbl
+
+mkStringLitLabel :: Unique -> CLabel
+mkStringLitLabel               = StringLitLabel
+
+mkAsmTempLabel :: Uniquable a => a -> CLabel
+mkAsmTempLabel a               = AsmTempLabel (getUnique a)
+
+mkModuleInitLabel :: Module -> String -> CLabel
+mkModuleInitLabel mod way      = ModuleInitLabel mod way
+
+mkPlainModuleInitLabel :: Module -> CLabel
+mkPlainModuleInitLabel mod     = PlainModuleInitLabel mod
+
+mkModuleInitTableLabel :: Module -> CLabel
+mkModuleInitTableLabel mod     = ModuleInitTableLabel mod
+
+moduleRegdLabel                        = ModuleRegdLabel
+moduleRegTableLabel            = ModuleInitTableLabel  
+
 
 -- -----------------------------------------------------------------------------
 -- Converting between info labels and entry/ret labels.
 
 infoLblToEntryLbl :: CLabel -> CLabel 
-infoLblToEntryLbl (IdLabel n c InfoTable)       = IdLabel n c Entry
-infoLblToEntryLbl (IdLabel n c ConInfoTable)    = IdLabel n c ConEntry
-infoLblToEntryLbl (IdLabel n c StaticInfoTable) = IdLabel n c StaticConEntry
-infoLblToEntryLbl (CaseLabel n CaseReturnInfo)  = CaseLabel n CaseReturnPt
-infoLblToEntryLbl (RtsLabel (RtsInfo s))      = RtsLabel (RtsEntry s)
-infoLblToEntryLbl (RtsLabel (RtsRetInfo s))   = RtsLabel (RtsRet s)
-infoLblToEntryLbl _ = panic "CLabel.infoLblToEntryLbl"
+infoLblToEntryLbl (IdLabel n c InfoTable)      = IdLabel n c Entry
+infoLblToEntryLbl (IdLabel n c ConInfoTable)   = IdLabel n c ConEntry
+infoLblToEntryLbl (IdLabel n c StaticInfoTable)        = IdLabel n c StaticConEntry
+infoLblToEntryLbl (CaseLabel n CaseReturnInfo) = CaseLabel n CaseReturnPt
+infoLblToEntryLbl (CmmLabel m str CmmInfo)     = CmmLabel m str CmmEntry
+infoLblToEntryLbl (CmmLabel m str CmmRetInfo)  = CmmLabel m str CmmRet
+infoLblToEntryLbl _
+       = panic "CLabel.infoLblToEntryLbl"
+
 
 entryLblToInfoLbl :: CLabel -> CLabel 
-entryLblToInfoLbl (IdLabel n c Entry)           = IdLabel n c InfoTable
-entryLblToInfoLbl (IdLabel n c ConEntry)        = IdLabel n c ConInfoTable
-entryLblToInfoLbl (IdLabel n c StaticConEntry)  = IdLabel n c StaticInfoTable
-entryLblToInfoLbl (CaseLabel n CaseReturnPt)    = CaseLabel n CaseReturnInfo
-entryLblToInfoLbl (RtsLabel (RtsEntry s))     = RtsLabel (RtsInfo s)
-entryLblToInfoLbl (RtsLabel (RtsRet s))       = RtsLabel (RtsRetInfo s)
-entryLblToInfoLbl l = pprPanic "CLabel.entryLblToInfoLbl" (pprCLabel l)
-
-cvtToClosureLbl   (IdLabel n c InfoTable) = IdLabel n c Closure
-cvtToClosureLbl   (IdLabel n c Entry)     = IdLabel n c Closure
-cvtToClosureLbl   (IdLabel n c ConEntry)  = IdLabel n c Closure
-cvtToClosureLbl l@(IdLabel n c Closure)   = l
-cvtToClosureLbl l = pprPanic "cvtToClosureLbl" (pprCLabel l)
-
-cvtToSRTLbl   (IdLabel n c InfoTable) = mkSRTLabel n c
-cvtToSRTLbl   (IdLabel n c Entry)     = mkSRTLabel n c
-cvtToSRTLbl   (IdLabel n c ConEntry)  = mkSRTLabel n c
-cvtToSRTLbl l@(IdLabel n c Closure)   = mkSRTLabel n c
-cvtToSRTLbl l = pprPanic "cvtToSRTLbl" (pprCLabel l)
+entryLblToInfoLbl (IdLabel n c Entry)          = IdLabel n c InfoTable
+entryLblToInfoLbl (IdLabel n c ConEntry)       = IdLabel n c ConInfoTable
+entryLblToInfoLbl (IdLabel n c StaticConEntry) = IdLabel n c StaticInfoTable
+entryLblToInfoLbl (CaseLabel n CaseReturnPt)   = CaseLabel n CaseReturnInfo
+entryLblToInfoLbl (CmmLabel m str CmmEntry)    = CmmLabel m str CmmInfo
+entryLblToInfoLbl (CmmLabel m str CmmRet)      = CmmLabel m str CmmRetInfo
+entryLblToInfoLbl l                            
+       = pprPanic "CLabel.entryLblToInfoLbl" (pprCLabel l)
+
+
+cvtToClosureLbl   (IdLabel n c InfoTable)      = IdLabel n c Closure
+cvtToClosureLbl   (IdLabel n c Entry)          = IdLabel n c Closure
+cvtToClosureLbl   (IdLabel n c ConEntry)       = IdLabel n c Closure
+cvtToClosureLbl l@(IdLabel n c Closure)                = l
+cvtToClosureLbl l 
+       = pprPanic "cvtToClosureLbl" (pprCLabel l)
+
+
+cvtToSRTLbl   (IdLabel n c InfoTable)          = mkSRTLabel n c
+cvtToSRTLbl   (IdLabel n c Entry)              = mkSRTLabel n c
+cvtToSRTLbl   (IdLabel n c ConEntry)           = mkSRTLabel n c
+cvtToSRTLbl l@(IdLabel n c Closure)            = mkSRTLabel n c
+cvtToSRTLbl l 
+       = pprPanic "cvtToSRTLbl" (pprCLabel l)
+
 
 -- -----------------------------------------------------------------------------
 -- Does a CLabel refer to a CAF?
@@ -463,6 +507,7 @@ hasCAF :: CLabel -> Bool
 hasCAF (IdLabel _ MayHaveCafRefs _) = True
 hasCAF _                            = False
 
+
 -- -----------------------------------------------------------------------------
 -- Does a CLabel need declaring before use or not?
 --
@@ -491,19 +536,24 @@ needsCDecl (CCS_Label _)          = True
 needsCDecl (HpcTicksLabel _)            = True
 needsCDecl HpcModuleNameLabel           = False
 
--- Whether the label is an assembler temporary:
 
-isAsmTemp  :: CLabel -> Bool    -- is a local temporary for native code generation
-isAsmTemp (AsmTempLabel _) = True
-isAsmTemp _               = False
+-- | Check whether a label is a local temporary for native code generation
+isAsmTemp  :: CLabel -> Bool    
+isAsmTemp (AsmTempLabel _)             = True
+isAsmTemp _                            = False
+
 
+-- | If a label is a local temporary used for native code generation
+--      then return just its unique, otherwise nothing.
 maybeAsmTemp :: CLabel -> Maybe Unique
-maybeAsmTemp (AsmTempLabel uq) = Just uq
-maybeAsmTemp _                        = Nothing
+maybeAsmTemp (AsmTempLabel uq)                 = Just uq
+maybeAsmTemp _                                 = Nothing
 
--- some labels have C prototypes in scope when compiling via C, because
--- they are builtin to the C compiler.  For these labels we avoid
--- generating our own C prototypes.
+
+-- Check whether a label corresponds to a C function that has 
+--      a prototype in a system header somehere, or is built-in
+--      to the C compiler. For these labels we abovoid generating our
+--      own C prototypes.
 isMathFun :: CLabel -> Bool
 isMathFun (ForeignLabel fs _ _ _) = fs `elementOfUniqSet` math_funs
 isMathFun _ = False
@@ -596,23 +646,24 @@ math_funs = mkUniqSet [
 -- in the .o file's symbol table; that is, made non-static.
 
 externallyVisibleCLabel :: CLabel -> Bool -- not C "static"
-externallyVisibleCLabel (CaseLabel _ _)           = False
-externallyVisibleCLabel (StringLitLabel _) = False
-externallyVisibleCLabel (AsmTempLabel _)   = False
-externallyVisibleCLabel (ModuleInitLabel _ _) = True
+externallyVisibleCLabel (CaseLabel _ _)                = False
+externallyVisibleCLabel (StringLitLabel _)     = False
+externallyVisibleCLabel (AsmTempLabel _)       = False
+externallyVisibleCLabel (ModuleInitLabel _ _)  = True
 externallyVisibleCLabel (PlainModuleInitLabel _)= True
 externallyVisibleCLabel (ModuleInitTableLabel _)= False
-externallyVisibleCLabel ModuleRegdLabel    = False
-externallyVisibleCLabel (RtsLabel _)      = True
-externallyVisibleCLabel (ForeignLabel _ _ _ _) = True
-externallyVisibleCLabel (IdLabel name _ _)     = isExternalName name
-externallyVisibleCLabel (CC_Label _)      = True
-externallyVisibleCLabel (CCS_Label _)     = True
+externallyVisibleCLabel ModuleRegdLabel                = False
+externallyVisibleCLabel (RtsLabel _)           = True
+externallyVisibleCLabel (CmmLabel _ _ _)       = True
+externallyVisibleCLabel (ForeignLabel _ _ _ _) = True
+externallyVisibleCLabel (IdLabel name _ _)     = isExternalName name
+externallyVisibleCLabel (CC_Label _)           = True
+externallyVisibleCLabel (CCS_Label _)          = True
 externallyVisibleCLabel (DynamicLinkerLabel _ _)  = False
-externallyVisibleCLabel (HpcTicksLabel _)   = True
-externallyVisibleCLabel HpcModuleNameLabel      = False
-externallyVisibleCLabel (LargeBitmapLabel _) = False
-externallyVisibleCLabel (LargeSRTLabel _) = False
+externallyVisibleCLabel (HpcTicksLabel _)      = True
+externallyVisibleCLabel HpcModuleNameLabel     = False
+externallyVisibleCLabel (LargeBitmapLabel _)   = False
+externallyVisibleCLabel (LargeSRTLabel _)      = False
 
 -- -----------------------------------------------------------------------------
 -- Finding the "type" of a CLabel 
@@ -634,16 +685,19 @@ isGcPtrLabel lbl = case labelType lbl of
                        GcPtrLabel -> True
                        _other     -> False
 
+
+-- | Work out the general type of data at the address of this label
+--    whether it be code, data, or static GC object.
 labelType :: CLabel -> CLabelType
+labelType (CmmLabel _ _ CmmData)               = DataLabel
+labelType (CmmLabel _ _ CmmGcPtr)              = GcPtrLabel
+labelType (CmmLabel _ _ CmmCode)               = CodeLabel
+labelType (CmmLabel _ _ CmmInfo)               = DataLabel
+labelType (CmmLabel _ _ CmmEntry)              = CodeLabel
+labelType (CmmLabel _ _ CmmRetInfo)            = DataLabel
+labelType (CmmLabel _ _ CmmRet)                        = CodeLabel
 labelType (RtsLabel (RtsSelectorInfoTable _ _)) = DataLabel
 labelType (RtsLabel (RtsApInfoTable _ _))       = DataLabel
-labelType (RtsLabel (RtsData _))              = DataLabel
-labelType (RtsLabel (RtsGcPtr _))             = GcPtrLabel
-labelType (RtsLabel (RtsCode _))              = CodeLabel
-labelType (RtsLabel (RtsInfo _))              = DataLabel
-labelType (RtsLabel (RtsEntry _))             = CodeLabel
-labelType (RtsLabel (RtsRetInfo _))           = DataLabel
-labelType (RtsLabel (RtsRet _))               = CodeLabel
 labelType (RtsLabel (RtsApFast _))              = CodeLabel
 labelType (CaseLabel _ CaseReturnInfo)          = DataLabel
 labelType (CaseLabel _ _)                      = CodeLabel
@@ -678,8 +732,9 @@ idInfoLabelType info =
 labelDynamic :: PackageId -> CLabel -> Bool
 labelDynamic this_pkg lbl =
   case lbl of
-   RtsLabel _               -> not opt_Static && (this_pkg /= rtsPackageId) -- i.e., is the RTS in a DLL or not?
-   IdLabel n _ k       -> isDllName this_pkg n
+   RtsLabel _                  -> not opt_Static && (this_pkg /= rtsPackageId) -- i.e., is the RTS in a DLL or not?
+   CmmLabel pkg _ _    -> not opt_Static && (this_pkg /= pkg)
+   IdLabel n _ k       -> isDllName this_pkg n
 #if mingw32_TARGET_OS
    ForeignLabel _ _ d _ -> d
 #else
@@ -805,9 +860,9 @@ pprCLbl (LargeBitmapLabel u)  = text "b" <> pprUnique u <> pp_cSEP <> ptext (sLi
 -- with a letter so the label will be legal assmbly code.
         
 
-pprCLbl (RtsLabel (RtsCode str))   = ftext str
-pprCLbl (RtsLabel (RtsData str))   = ftext str
-pprCLbl (RtsLabel (RtsGcPtr str))  = ftext str
+pprCLbl (CmmLabel _ str CmmCode)       = ftext str
+pprCLbl (CmmLabel _ str CmmData)       = ftext str
+pprCLbl (CmmLabel _ str CmmGcPtr)      = ftext str
 
 pprCLbl (RtsLabel (RtsApFast str))   = ftext str <> ptext (sLit "_fast")
 
@@ -839,16 +894,16 @@ pprCLbl (RtsLabel (RtsApEntry upd_reqd arity))
                        else (sLit "_noupd_entry"))
        ]
 
-pprCLbl (RtsLabel (RtsInfo fs))
+pprCLbl (CmmLabel _ fs CmmInfo)
   = ftext fs <> ptext (sLit "_info")
 
-pprCLbl (RtsLabel (RtsEntry fs))
+pprCLbl (CmmLabel _ fs CmmEntry)
   = ftext fs <> ptext (sLit "_entry")
 
-pprCLbl (RtsLabel (RtsRetInfo fs))
+pprCLbl (CmmLabel _ fs CmmRetInfo)
   = ftext fs <> ptext (sLit "_info")
 
-pprCLbl (RtsLabel (RtsRet fs))
+pprCLbl (CmmLabel _ fs CmmRet)
   = ftext fs <> ptext (sLit "_ret")
 
 pprCLbl (RtsLabel (RtsPrimOp primop)) 
@@ -871,8 +926,10 @@ pprCLbl (CCS_Label ccs)    = ppr ccs
 pprCLbl (ModuleInitLabel mod way)
    = ptext (sLit "__stginit_") <> ppr mod
        <> char '_' <> text way
+
 pprCLbl (PlainModuleInitLabel mod)
    = ptext (sLit "__stginit_") <> ppr mod
+
 pprCLbl (ModuleInitTableLabel mod)
    = ptext (sLit "__stginittable_") <> ppr mod
 
@@ -934,6 +991,7 @@ pprDynamicLinkerAsmLabel GotSymbolOffset lbl
   = pprCLabel lbl
 pprDynamicLinkerAsmLabel _ _
   = panic "pprDynamicLinkerAsmLabel"
+
 #elif darwin_TARGET_OS
 pprDynamicLinkerAsmLabel CodeStub lbl
   = char 'L' <> pprCLabel lbl <> text "$stub"
@@ -941,6 +999,7 @@ pprDynamicLinkerAsmLabel SymbolPtr lbl
   = char 'L' <> pprCLabel lbl <> text "$non_lazy_ptr"
 pprDynamicLinkerAsmLabel _ _
   = panic "pprDynamicLinkerAsmLabel"
+
 #elif powerpc_TARGET_ARCH && linux_TARGET_OS
 pprDynamicLinkerAsmLabel CodeStub lbl
   = pprCLabel lbl <> text "@plt"
@@ -948,6 +1007,7 @@ pprDynamicLinkerAsmLabel SymbolPtr lbl
   = text ".LC_" <> pprCLabel lbl
 pprDynamicLinkerAsmLabel _ _
   = panic "pprDynamicLinkerAsmLabel"
+
 #elif x86_64_TARGET_ARCH && linux_TARGET_OS
 pprDynamicLinkerAsmLabel CodeStub lbl
   = pprCLabel lbl <> text "@plt"
@@ -957,6 +1017,7 @@ pprDynamicLinkerAsmLabel GotSymbolOffset lbl
   = pprCLabel lbl
 pprDynamicLinkerAsmLabel SymbolPtr lbl
   = text ".LC_" <> pprCLabel lbl
+
 #elif linux_TARGET_OS
 pprDynamicLinkerAsmLabel CodeStub lbl
   = pprCLabel lbl <> text "@plt"
@@ -966,11 +1027,13 @@ pprDynamicLinkerAsmLabel GotSymbolPtr lbl
   = pprCLabel lbl <> text "@got"
 pprDynamicLinkerAsmLabel GotSymbolOffset lbl
   = pprCLabel lbl <> text "@gotoff"
+
 #elif mingw32_TARGET_OS
 pprDynamicLinkerAsmLabel SymbolPtr lbl
   = text "__imp_" <> pprCLabel lbl
 pprDynamicLinkerAsmLabel _ _
   = panic "pprDynamicLinkerAsmLabel"
+
 #else
 pprDynamicLinkerAsmLabel _ _
   = panic "pprDynamicLinkerAsmLabel"