ghc/compiler/codeGen/CgCon.lhs

   1 %
   2 % (c) The GRASP Project, Glasgow University, 1992-1998
   3 %
   4 \section[CgCon]{Code generation for constructors}
   5
   6 This module provides the support code for @StgToAbstractC@ to deal
   7 with {\em constructors} on the RHSs of let(rec)s.  See also
   8 @CgClosure@, which deals with closures.
   9
  10 \begin{code}
  11 module CgCon (
  12         cgTopRhsCon, buildDynCon,
  13         bindConArgs, bindUnboxedTupleComponents,
  14         cgReturnDataCon
  15     ) where
  16
  17 #include "HsVersions.h"
  18
  19 import CgMonad
  20 import AbsCSyn
  21 import StgSyn
  22
  23 import AbsCUtils        ( getAmodeRep )
  24 import CgBindery        ( getArgAmodes, bindNewToNode,
  25                           bindArgsToRegs, newTempAmodeAndIdInfo,
  26                           idInfoToAmode, stableAmodeIdInfo,
  27                           heapIdInfo, CgIdInfo, bindNewToStack
  28                         )
  29 import CgStackery       ( mkTaggedVirtStkOffsets, freeStackSlots,
  30                           updateFrameSize
  31                         )
  32 import CgUsages         ( getRealSp, getVirtSp, setRealAndVirtualSp,
  33                           getSpRelOffset )
  34 import CgClosure        ( cgTopRhsClosure )
  35 import CgRetConv        ( assignRegs )
  36 import Constants        ( mAX_INTLIKE, mIN_INTLIKE, mIN_UPD_SIZE )
  37 import CgHeapery        ( allocDynClosure, inPlaceAllocDynClosure )
  38 import CgTailCall       ( performReturn, mkStaticAlgReturnCode, doTailCall,
  39                           mkUnboxedTupleReturnCode )
  40 import CLabel           ( mkClosureLabel )
  41 import ClosureInfo      ( mkClosureLFInfo, mkConLFInfo, mkLFArgument,
  42                           layOutDynCon, layOutDynClosure,
  43                           layOutStaticClosure, closureSize
  44                         )
  45 import CostCentre       ( currentOrSubsumedCCS, dontCareCCS, CostCentreStack,
  46                           currentCCS )
  47 import DataCon          ( DataCon, dataConName, dataConTag, dataConTyCon,
  48                           isUnboxedTupleCon, isNullaryDataCon, dataConId, dataConWrapId
  49                         )
  50 import Id               ( Id, idName, idType, idPrimRep )
  51 import Name             ( nameModule, isLocallyDefinedName )
  52 import Literal          ( Literal(..) )
  53 import PrelInfo         ( maybeCharLikeCon, maybeIntLikeCon )
  54 import PrimRep          ( PrimRep(..), isFollowableRep )
  55 import Unique           ( Uniquable(..) )
  56 import Util
  57 import Panic            ( assertPanic, trace )
  58 \end{code}
  59
  60 %************************************************************************
  61 %*                                                                      *
  62 \subsection[toplevel-constructors]{Top-level constructors}
  63 %*                                                                      *
  64 %************************************************************************
  65
  66 \begin{code}
  67 cgTopRhsCon :: Id               -- Name of thing bound to this RHS
  68             -> DataCon          -- Id
  69             -> [StgArg]         -- Args
  70             -> FCode (Id, CgIdInfo)
  71 cgTopRhsCon id con args
  72   = ASSERT(not dynamic_con_or_args)     -- checks for litlit args too
  73     (
  74         -- LAY IT OUT
  75     getArgAmodes args           `thenFC` \ amodes ->
  76
  77     let
  78         (closure_info, amodes_w_offsets)
  79           = layOutStaticClosure name getAmodeRep amodes lf_info
  80     in
  81
  82         -- BUILD THE OBJECT
  83     absC (CStaticClosure
  84             closure_label               -- Labelled with the name on lhs of defn
  85             closure_info                -- Closure is static
  86             top_ccc
  87             (map fst amodes_w_offsets)) -- Sorted into ptrs first, then nonptrs
  88
  89     ) `thenC`
  90
  91         -- RETURN
  92     returnFC (id, stableAmodeIdInfo id (CLbl closure_label PtrRep) lf_info)
  93   where
  94     con_tycon       = dataConTyCon   con
  95     lf_info         = mkConLFInfo    con
  96     closure_label   = mkClosureLabel name
  97     name            = idName id
  98
  99     top_ccc = mkCCostCentreStack dontCareCCS -- because it's static data
 100
 101     -- stuff needed by the assert pred only.
 102     dynamic_con_or_args = isDllConApp con args
 103 \end{code}
 104
 105 %************************************************************************
 106 %*                                                                      *
 107 %* non-top-level constructors                                           *
 108 %*                                                                      *
 109 %************************************************************************
 110 \subsection[code-for-constructors]{The code for constructors}
 111
 112 \begin{code}
 113 buildDynCon :: Id               -- Name of the thing to which this constr will
 114                                 -- be bound
 115             -> CostCentreStack  -- Where to grab cost centre from;
 116                                 -- current CCS if currentOrSubsumedCCS
 117             -> DataCon          -- The data constructor
 118             -> [CAddrMode]      -- Its args
 119             -> FCode CgIdInfo   -- Return details about how to find it
 120
 121 -- We used to pass a boolean indicating whether all the
 122 -- args were of size zero, so we could use a static
 123 -- construtor; but I concluded that it just isn't worth it.
 124 -- Now I/O uses unboxed tuples there just aren't any constructors
 125 -- with all size-zero args.
 126 --
 127 -- The reason for having a separate argument, rather than looking at
 128 -- the addr modes of the args is that we may be in a "knot", and
 129 -- premature looking at the args will cause the compiler to black-hole!
 130 \end{code}
 131
 132 First we deal with the case of zero-arity constructors.  Now, they
 133 will probably be unfolded, so we don't expect to see this case much,
 134 if at all, but it does no harm, and sets the scene for characters.
 135
 136 In the case of zero-arity constructors, or, more accurately, those
 137 which have exclusively size-zero (VoidRep) args, we generate no code
 138 at all.
 139
 140 \begin{code}
 141 buildDynCon binder cc con []
 142   = returnFC (stableAmodeIdInfo binder
 143                                 (CLbl (mkClosureLabel (idName (dataConWrapId con))) PtrRep)
 144                                 (mkConLFInfo con))
 145 \end{code}
 146
 147 Now for @Char@-like closures.  We generate an assignment of the
 148 address of the closure to a temporary.  It would be possible simply to
 149 generate no code, and record the addressing mode in the environment,
 150 but we'd have to be careful if the argument wasn't a constant --- so
 151 for simplicity we just always asssign to a temporary.
 152
 153 Last special case: @Int@-like closures.  We only special-case the
 154 situation in which the argument is a literal in the range
 155 @mIN_INTLIKE@..@mAX_INTLILKE@.  NB: for @Char@-like closures we can
 156 work with any old argument, but for @Int@-like ones the argument has
 157 to be a literal.  Reason: @Char@ like closures have an argument type
 158 which is guaranteed in range.
 159
 160 Because of this, we use can safely return an addressing mode.
 161
 162 \begin{code}
 163 buildDynCon binder cc con [arg_amode]
 164
 165   | maybeCharLikeCon con
 166   = absC (CAssign temp_amode (CCharLike arg_amode))     `thenC`
 167     returnFC temp_id_info
 168
 169   | maybeIntLikeCon con && in_range_int_lit arg_amode
 170   = returnFC (stableAmodeIdInfo binder (CIntLike arg_amode) (mkConLFInfo con))
 171   where
 172     (temp_amode, temp_id_info) = newTempAmodeAndIdInfo binder (mkConLFInfo con)
 173
 174     in_range_int_lit (CLit (MachInt val)) = val <= mAX_INTLIKE && val >= mIN_INTLIKE
 175     in_range_int_lit other_amode          = False
 176
 177     tycon = dataConTyCon con
 178 \end{code}
 179
 180 Now the general case.
 181
 182 \begin{code}
 183 buildDynCon binder ccs con args
 184   = allocDynClosure closure_info use_cc blame_cc amodes_w_offsets `thenFC` \ hp_off ->
 185     returnFC (heapIdInfo binder hp_off lf_info)
 186   where
 187     (closure_info, amodes_w_offsets)
 188       = layOutDynClosure (idName binder) getAmodeRep args lf_info
 189     lf_info = mkConLFInfo con
 190
 191     use_cc      -- cost-centre to stick in the object
 192       = if currentOrSubsumedCCS ccs
 193         then CReg CurCostCentre
 194         else mkCCostCentreStack ccs
 195
 196     blame_cc = use_cc -- cost-centre on which to blame the alloc (same)
 197 \end{code}
 198
 199
 200 %************************************************************************
 201 %*                                                                      *
 202 %* constructor-related utility function:                                *
 203 %*              bindConArgs is called from cgAlt of a case              *
 204 %*                                                                      *
 205 %************************************************************************
 206 \subsection[constructor-utilities]{@bindConArgs@: constructor-related utility}
 207
 208 @bindConArgs@ $con args$ augments the environment with bindings for the
 209 binders $args$, assuming that we have just returned from a @case@ which
 210 found a $con$.
 211
 212 \begin{code}
 213 bindConArgs
 214         :: DataCon -> [Id]              -- Constructor and args
 215         -> Code
 216
 217 bindConArgs con args
 218   = ASSERT(not (isUnboxedTupleCon con))
 219     mapCs bind_arg args_w_offsets
 220    where
 221      bind_arg (arg, offset) = bindNewToNode arg offset mkLFArgument
 222      (_, args_w_offsets) = layOutDynCon con idPrimRep args
 223 \end{code}
 224
 225 Unboxed tuples are handled slightly differently - the object is
 226 returned in registers and on the stack instead of the heap.
 227
 228 \begin{code}
 229 bindUnboxedTupleComponents
 230         :: [Id]                                 -- args
 231         -> FCode ([MagicId],                    -- regs assigned
 232                   [(VirtualSpOffset,Int)],      -- tag slots
 233                   Bool)                         -- any components on stack?
 234
 235 bindUnboxedTupleComponents args
 236  =  -- Assign as many components as possible to registers
 237     let (arg_regs, leftovers) = assignRegs [] (map idPrimRep args)
 238         (reg_args, stk_args) = splitAt (length arg_regs) args
 239     in
 240
 241     -- Allocate the rest on the stack (ToDo: separate out pointers)
 242     getVirtSp `thenFC` \ vsp ->
 243     getRealSp `thenFC` \ rsp ->
 244     let (top_sp, stk_offsets, tags) =
 245                 mkTaggedVirtStkOffsets rsp idPrimRep stk_args
 246     in
 247
 248     -- The stack pointer points to the last stack-allocated component
 249     setRealAndVirtualSp top_sp                  `thenC`
 250
 251     -- need to explicitly free any empty slots we just jumped over
 252     (if vsp < rsp then freeStackSlots [vsp+1 .. rsp] else nopC) `thenC`
 253
 254     bindArgsToRegs reg_args arg_regs            `thenC`
 255     mapCs bindNewToStack stk_offsets            `thenC`
 256     returnFC (arg_regs,tags, not (null stk_offsets))
 257 \end{code}
 258
 259 %************************************************************************
 260 %*                                                                      *
 261 \subsubsection[CgRetConv-cgReturnDataCon]{Actually generate code for a constructor return}
 262 %*                                                                      *
 263 %************************************************************************
 264
 265
 266 Note: it's the responsibility of the @cgReturnDataCon@ caller to be
 267 sure the @amodes@ passed don't conflict with each other.
 268 \begin{code}
 269 cgReturnDataCon :: DataCon -> [CAddrMode] -> Code
 270
 271 cgReturnDataCon con amodes
 272   = getEndOfBlockInfo   `thenFC` \ (EndOfBlockInfo args_sp sequel) ->
 273
 274     case sequel of
 275
 276       CaseAlts _ (Just (alts, Just (maybe_deflt, (_,deflt_lbl))))
 277         | not (dataConTag con `is_elem` map fst alts)
 278         ->
 279                 -- Special case!  We're returning a constructor to the default case
 280                 -- of an enclosing case.  For example:
 281                 --
 282                 --      case (case e of (a,b) -> C a b) of
 283                 --        D x -> ...
 284                 --        y   -> ...<returning here!>...
 285                 --
 286                 -- In this case,
 287                 --      if the default is a non-bind-default (ie does not use y),
 288                 --      then we should simply jump to the default join point;
 289
 290                 case maybe_deflt of
 291                     Nothing -> performReturn AbsCNop {- No reg assts -} jump_to_join_point
 292                     Just _  -> build_it_then jump_to_join_point
 293         where
 294           is_elem = isIn "cgReturnDataCon"
 295           jump_to_join_point sequel = absC (CJump (CLbl deflt_lbl CodePtrRep))
 296                 -- Ignore the sequel: we've already looked at it above
 297
 298         -- If the sequel is an update frame, we might be able to
 299         -- do update in place...
 300       UpdateCode
 301         |  not (isNullaryDataCon con)  -- no nullary constructors, please
 302         && not (maybeCharLikeCon con)  -- no chars please (these are all static)
 303         && not (any isFollowableRep (map getAmodeRep amodes))
 304                                         -- no ptrs please (generational gc...)
 305         && closureSize closure_info <= mIN_UPD_SIZE
 306                                         -- don't know the real size of the
 307                                         -- thunk, so assume mIN_UPD_SIZE
 308
 309         ->      -- get a new temporary and make it point to the updatee
 310            let
 311                 uniq = getUnique con
 312                 temp = CTemp uniq PtrRep
 313            in
 314
 315            profCtrC SLIT("TICK_UPD_CON_IN_PLACE")
 316                         [mkIntCLit (length amodes)] `thenC`
 317
 318            getSpRelOffset args_sp                       `thenFC` \ sp_rel ->
 319            absC (CAssign temp
 320                     (CMacroExpr PtrRep UPD_FRAME_UPDATEE [CAddr sp_rel]))
 321                 `thenC`
 322
 323                 -- stomp all over it with the new constructor
 324            inPlaceAllocDynClosure closure_info temp (CReg CurCostCentre) stuff
 325                 `thenC`
 326
 327                 -- don't forget to update Su from the update frame
 328            absC (CMacroStmt UPDATE_SU_FROM_UPD_FRAME [CAddr sp_rel])  `thenC`
 329
 330                 -- set Node to point to the closure being returned
 331                 -- (can't be done earlier: node might conflict with amodes)
 332            absC (CAssign (CReg node) temp) `thenC`
 333
 334                 -- pop the update frame off the stack, and do the proper
 335                 -- return.
 336            let new_sp = args_sp - updateFrameSize in
 337            setEndOfBlockInfo (EndOfBlockInfo new_sp (OnStack new_sp)) $
 338            performReturn (AbsCNop) (mkStaticAlgReturnCode con)
 339
 340         where (closure_info, stuff)
 341                   = layOutDynClosure (dataConName con)
 342                         getAmodeRep amodes lf_info
 343
 344               lf_info = mkConLFInfo con
 345
 346       other_sequel      -- The usual case
 347
 348           | isUnboxedTupleCon con ->
 349                         -- Return unboxed tuple in registers
 350                   let (ret_regs, leftovers) =
 351                          assignRegs [] (map getAmodeRep amodes)
 352                   in
 353                   profCtrC SLIT("TICK_RET_UNBOXED_TUP")
 354                                 [mkIntCLit (length amodes)] `thenC`
 355
 356                   doTailCall amodes ret_regs
 357                         mkUnboxedTupleReturnCode
 358                         (length leftovers)  {- fast args arity -}
 359                         AbsCNop {-no pending assigments-}
 360                         Nothing {-not a let-no-escape-}
 361                         False   {-node doesn't point-}
 362
 363           | otherwise ->
 364                 build_it_then (mkStaticAlgReturnCode con)
 365
 366   where
 367     con_name = dataConName con
 368
 369     move_to_reg :: CAddrMode -> MagicId -> AbstractC
 370     move_to_reg src_amode dest_reg = CAssign (CReg dest_reg) src_amode
 371
 372     build_it_then return =
 373                 -- BUILD THE OBJECT IN THE HEAP
 374                 -- The first "con" says that the name bound to this
 375                 -- closure is "con", which is a bit of a fudge, but it only
 376                 -- affects profiling
 377
 378                 -- This Id is also used to get a unique for a
 379                 -- temporary variable, if the closure is a CHARLIKE.
 380                 -- funnily enough, this makes the unique always come
 381                 -- out as '54' :-)
 382           buildDynCon (dataConId con) currentCCS con amodes     `thenFC` \ idinfo ->
 383           idInfoToAmode PtrRep idinfo                           `thenFC` \ amode ->
 384
 385
 386                 -- RETURN
 387           profCtrC SLIT("TICK_RET_NEW") [mkIntCLit (length amodes)] `thenC`
 388           -- could use doTailCall here.
 389           performReturn (move_to_reg amode node) return
 390 \end{code}