ghc/compiler/absCSyn/PprAbsC.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
   3 %
   4 %************************************************************************
   5 %*                                                                      *
   6 \section[PprAbsC]{Pretty-printing Abstract~C}
   7 %*                                                                      *
   8 %************************************************************************
   9
  10 \begin{code}
  11 #include "HsVersions.h"
  12
  13 module PprAbsC (
  14         writeRealC,
  15         dumpRealC
  16 #ifdef DEBUG
  17         , pprAmode -- otherwise, not exported
  18 #endif
  19     ) where
  20
  21 IMP_Ubiq(){-uitous-}
  22 IMPORT_DELOOPER(AbsCLoop)               -- break its dependence on ClosureInfo
  23 IMPORT_1_3(IO(Handle))
  24 IMPORT_1_3(Char(isDigit,isPrint))
  25 IMPORT_1_3(GHCbase(Addr(..)) ) -- to see innards
  26
  27 import AbsCSyn
  28
  29 import AbsCUtils        ( getAmodeRep, nonemptyAbsC,
  30                           mixedPtrLocn, mixedTypeLocn
  31                         )
  32 import Constants        ( spARelToInt, spBRelToInt, mIN_UPD_SIZE )
  33 import CLabel           ( externallyVisibleCLabel, mkErrorStdEntryLabel,
  34                           isReadOnly, needsCDecl, pprCLabel,
  35                           CLabel{-instance Ord-}
  36                         )
  37 import CmdLineOpts      ( opt_SccProfilingOn )
  38 import CostCentre       ( uppCostCentre, uppCostCentreDecl )
  39 import Costs            ( costs, addrModeCosts, CostRes(..), Side(..) )
  40 import CStrings         ( stringToC )
  41 import FiniteMap        ( addToFM, emptyFM, lookupFM, FiniteMap )
  42 import HeapOffs         ( isZeroOff, subOff, pprHeapOffset )
  43 import Literal          ( showLiteral, Literal(..) )
  44 import Maybes           ( maybeToBool, catMaybes )
  45 import PprStyle         ( PprStyle(..) )
  46 import Pretty           ( prettyToUn )
  47 import PrimOp           ( primOpNeedsWrapper, pprPrimOp, PrimOp(..) )
  48 import PrimRep          ( isFloatingRep, showPrimRep, PrimRep(..) )
  49 import SMRep            ( getSMInfoStr, getSMInitHdrStr, getSMUpdInplaceHdrStr,
  50                           isConstantRep, isSpecRep, isPhantomRep
  51                         )
  52 import Unique           ( pprUnique, Unique{-instance NamedThing-} )
  53 import UniqSet          ( emptyUniqSet, elementOfUniqSet,
  54                           addOneToUniqSet, SYN_IE(UniqSet)
  55                         )
  56 import Unpretty         -- ********** NOTE **********
  57 import Util             ( nOfThem, panic, assertPanic )
  58
  59 infixr 9 `thenTE`
  60 \end{code}
  61
  62 For spitting out the costs of an abstract~C expression, @writeRealC@
  63 now not only prints the C~code of the @absC@ arg but also adds a macro
  64 call to a cost evaluation function @GRAN_EXEC@. For that,
  65 @pprAbsC@ has a new ``costs'' argument.  %% HWL
  66
  67 \begin{code}
  68 writeRealC :: Handle -> AbstractC -> IO ()
  69
  70 writeRealC handle absC
  71   = uppPutStr handle 80 (
  72       uppAbove (pprAbsC PprForC absC (costs absC)) (uppChar '\n')
  73     )
  74
  75 dumpRealC :: AbstractC -> String
  76
  77 dumpRealC absC
  78   = uppShow 80 (
  79       uppAbove (pprAbsC PprForC absC (costs absC)) (uppChar '\n')
  80     )
  81 \end{code}
  82
  83 This emits the macro,  which is used in GrAnSim  to compute the total costs
  84 from a cost 5 tuple. %%  HWL
  85
  86 \begin{code}
  87 emitMacro :: CostRes -> Unpretty
  88
  89 -- ToDo: Check a compile time flag to decide whether a macro should be emitted
  90 emitMacro (Cost (i,b,l,s,f))
  91   = uppBesides [ uppStr "GRAN_EXEC(",
  92                           uppInt i, uppComma, uppInt b, uppComma, uppInt l, uppComma,
  93                           uppInt s, uppComma, uppInt f, pp_paren_semi ]
  94 \end{code}
  95
  96 \begin{code}
  97 pp_paren_semi = uppStr ");"
  98
  99 -- ---------------------------------------------------------------------------
 100 -- New type: Now pprAbsC also takes the costs for evaluating the Abstract C
 101 -- code as an argument (that's needed when spitting out the GRAN_EXEC macro
 102 -- which must be done before the return i.e. inside absC code)   HWL
 103 -- ---------------------------------------------------------------------------
 104
 105 pprAbsC :: PprStyle -> AbstractC -> CostRes -> Unpretty
 106
 107 pprAbsC sty AbsCNop _ = uppNil
 108 pprAbsC sty (AbsCStmts s1 s2) c = uppAbove (pprAbsC sty s1 c) (pprAbsC sty s2 c)
 109
 110 pprAbsC sty (CClosureUpdInfo info) c
 111   = pprAbsC sty info c
 112
 113 pprAbsC sty (CAssign dest src) _ = pprAssign sty (getAmodeRep dest) dest src
 114
 115 pprAbsC sty (CJump target) c
 116   = uppAbove (uppBesides [emitMacro c {-WDP:, uppStr "/* <--++  CJump */"-} ])
 117              (uppBesides [ uppStr "JMP_(", pprAmode sty target, pp_paren_semi ])
 118
 119 pprAbsC sty (CFallThrough target) c
 120   = uppAbove (uppBesides [emitMacro c {-WDP:, uppStr "/* <--++  CFallThrough */"-} ])
 121              (uppBesides [ uppStr "JMP_(", pprAmode sty target, pp_paren_semi ])
 122
 123 -- --------------------------------------------------------------------------
 124 -- Spit out GRAN_EXEC macro immediately before the return                 HWL
 125
 126 pprAbsC sty (CReturn am return_info)  c
 127   = uppAbove (uppBesides [emitMacro c {-WDP:, uppStr "/* <----  CReturn */"-} ])
 128              (uppBesides [uppStr "JMP_(", target, pp_paren_semi ])
 129   where
 130    target = case return_info of
 131         DirectReturn -> uppBesides [uppStr "DIRECT(", pprAmode sty am, uppRparen]
 132         DynamicVectoredReturn am' -> mk_vector (pprAmode sty am')
 133         StaticVectoredReturn n -> mk_vector (uppInt n)  -- Always positive
 134    mk_vector x = uppBesides [uppLparen, pprAmode sty am, uppStr ")[RVREL(", x, uppStr ")]"]
 135
 136 pprAbsC sty (CSplitMarker) _ = uppPStr SLIT("/* SPLIT */")
 137
 138 -- we optimise various degenerate cases of CSwitches.
 139
 140 -- --------------------------------------------------------------------------
 141 -- Assume: CSwitch is also end of basic block
 142 --         costs function yields nullCosts for whole switch
 143 --         ==> inherited costs c are those of basic block up to switch
 144 --         ==> inherit c + costs for the corresponding branch
 145 --                                                                       HWL
 146 -- --------------------------------------------------------------------------
 147
 148 pprAbsC sty (CSwitch discrim [] deflt) c
 149   = pprAbsC sty deflt (c + costs deflt)
 150     -- Empty alternative list => no costs for discrim as nothing cond. here HWL
 151
 152 pprAbsC sty (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
 153   = case (nonemptyAbsC deflt) of
 154       Nothing ->                -- one alt and no default
 155                  pprAbsC sty alt_code (c + costs alt_code)
 156                  -- Nothing conditional in here either  HWL
 157
 158       Just dc ->                -- make it an "if"
 159                  do_if_stmt sty discrim tag alt_code dc c
 160
 161 pprAbsC sty (CSwitch discrim [(tag1@(MachInt i1 _), alt_code1),
 162                               (tag2@(MachInt i2 _), alt_code2)] deflt) c
 163   | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
 164   = if (i1 == 0) then
 165         do_if_stmt sty discrim tag1 alt_code1 alt_code2 c
 166     else
 167         do_if_stmt sty discrim tag2 alt_code2 alt_code1 c
 168   where
 169     empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
 170
 171 pprAbsC sty (CSwitch discrim alts deflt) c -- general case
 172   | isFloatingRep (getAmodeRep discrim)
 173     = pprAbsC sty (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
 174   | otherwise
 175     = uppAboves [
 176         uppBesides [uppStr "switch (", pp_discrim, uppStr ") {"],
 177         uppNest 2 (uppAboves (map (ppr_alt sty) alts)),
 178         (case (nonemptyAbsC deflt) of
 179            Nothing -> uppNil
 180            Just dc ->
 181             uppNest 2 (uppAboves [uppPStr SLIT("default:"),
 182                                   pprAbsC sty dc (c + switch_head_cost
 183                                                     + costs dc),
 184                                   uppPStr SLIT("break;")])),
 185         uppChar '}' ]
 186   where
 187     pp_discrim
 188       = pprAmode sty discrim
 189
 190     ppr_alt sty (lit, absC)
 191       = uppAboves [ uppBesides [uppPStr SLIT("case "), pprBasicLit sty lit, uppChar ':'],
 192                    uppNest 2 (uppAbove (pprAbsC sty absC (c + switch_head_cost + costs absC))
 193                                        (uppPStr SLIT("break;"))) ]
 194
 195     -- Costs for addressing header of switch and cond. branching        -- HWL
 196     switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
 197
 198 pprAbsC sty stmt@(COpStmt results op@(CCallOp _ _ _ _ _) args liveness_mask vol_regs) _
 199   = pprCCall sty op args results liveness_mask vol_regs
 200
 201 pprAbsC sty stmt@(COpStmt results op args liveness_mask vol_regs) _
 202   = let
 203         non_void_args = grab_non_void_amodes args
 204         non_void_results = grab_non_void_amodes results
 205         -- if just one result, we print in the obvious "assignment" style;
 206         -- if 0 or many results, we emit a macro call, w/ the results
 207         -- followed by the arguments.  The macro presumably knows which
 208         -- are which :-)
 209
 210         the_op = ppr_op_call non_void_results non_void_args
 211                 -- liveness mask is *in* the non_void_args
 212     in
 213     case (ppr_vol_regs sty vol_regs) of { (pp_saves, pp_restores) ->
 214     if primOpNeedsWrapper op then
 215         uppAboves [  pp_saves,
 216                     the_op,
 217                     pp_restores
 218                  ]
 219     else
 220         the_op
 221     }
 222   where
 223     ppr_op_call results args
 224       = uppBesides [ prettyToUn (pprPrimOp sty op), uppLparen,
 225         uppIntersperse uppComma (map ppr_op_result results),
 226         if null results || null args then uppNil else uppComma,
 227         uppIntersperse uppComma (map (pprAmode sty) args),
 228         pp_paren_semi ]
 229
 230     ppr_op_result r = ppr_amode sty r
 231       -- primop macros do their own casting of result;
 232       -- hence we can toss the provided cast...
 233
 234 pprAbsC sty (CSimultaneous abs_c) c
 235   = uppBesides [uppStr "{{", pprAbsC sty abs_c c, uppStr "}}"]
 236
 237 pprAbsC sty stmt@(CMacroStmt macro as) _
 238   = uppBesides [uppStr (show macro), uppLparen,
 239         uppIntersperse uppComma (map (ppr_amode sty) as),pp_paren_semi] -- no casting
 240 pprAbsC sty stmt@(CCallProfCtrMacro op as) _
 241   = uppBesides [uppPStr op, uppLparen,
 242         uppIntersperse uppComma (map (ppr_amode sty) as),pp_paren_semi]
 243 pprAbsC sty stmt@(CCallProfCCMacro op as) _
 244   = uppBesides [uppPStr op, uppLparen,
 245         uppIntersperse uppComma (map (ppr_amode sty) as),pp_paren_semi]
 246
 247 pprAbsC sty (CCodeBlock label abs_C) _
 248   = ASSERT( maybeToBool(nonemptyAbsC abs_C) )
 249     case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
 250     uppAboves [
 251         uppBesides [uppStr (if (externallyVisibleCLabel label)
 252                           then "FN_("   -- abbreviations to save on output
 253                           else "IFN_("),
 254                    pprCLabel sty label, uppStr ") {"],
 255         case sty of
 256           PprForC -> uppAbove pp_exts pp_temps
 257           _ -> uppNil,
 258         uppNest 8 (uppPStr SLIT("FB_")),
 259         uppNest 8 (pprAbsC sty abs_C (costs abs_C)),
 260         uppNest 8 (uppPStr SLIT("FE_")),
 261         uppChar '}' ]
 262     }
 263
 264 pprAbsC sty (CInitHdr cl_info reg_rel cost_centre inplace_upd) _
 265   = uppBesides [ pp_init_hdr, uppStr "_HDR(",
 266                 ppr_amode sty (CAddr reg_rel), uppComma,
 267                 pprCLabel sty info_lbl, uppComma,
 268                 if_profiling sty (pprAmode sty cost_centre), uppComma,
 269                 pprHeapOffset sty size, uppComma, uppInt ptr_wds, pp_paren_semi ]
 270   where
 271     info_lbl    = infoTableLabelFromCI cl_info
 272     sm_rep      = closureSMRep     cl_info
 273     size        = closureSizeWithoutFixedHdr cl_info
 274     ptr_wds     = closurePtrsSize  cl_info
 275
 276     pp_init_hdr = uppStr (if inplace_upd then
 277                             getSMUpdInplaceHdrStr sm_rep
 278                         else
 279                             getSMInitHdrStr sm_rep)
 280
 281 pprAbsC sty stmt@(CStaticClosure closure_lbl cl_info cost_centre amodes) _
 282   = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
 283     uppAboves [
 284         case sty of
 285           PprForC -> pp_exts
 286           _ -> uppNil,
 287         uppBesides [
 288                 uppStr "SET_STATIC_HDR(",
 289                 pprCLabel sty closure_lbl,                      uppComma,
 290                 pprCLabel sty info_lbl,                         uppComma,
 291                 if_profiling sty (pprAmode sty cost_centre),    uppComma,
 292                 ppLocalness closure_lbl,                        uppComma,
 293                 ppLocalnessMacro False{-for data-} info_lbl,
 294                 uppChar ')'
 295                 ],
 296         uppNest 2 (uppBesides (map (ppr_item sty) amodes)),
 297         uppNest 2 (uppBesides (map (ppr_item sty) padding_wds)),
 298         uppStr "};" ]
 299     }
 300   where
 301     info_lbl = infoTableLabelFromCI cl_info
 302
 303     ppr_item sty item
 304       = if getAmodeRep item == VoidRep
 305         then uppStr ", (W_) 0" -- might not even need this...
 306         else uppBeside (uppStr ", (W_)") (ppr_amode sty item)
 307
 308     padding_wds =
 309         if not (closureUpdReqd cl_info) then
 310             []
 311         else
 312             case (max 0 (mIN_UPD_SIZE - length amodes)) of { still_needed ->
 313             nOfThem still_needed (mkIntCLit 0) } -- a bunch of 0s
 314
 315 {-
 316    STATIC_INIT_HDR(c,i,localness) blows into:
 317         localness W_ c_closure [] = { i_info, extra_fixed_wd<1..n>
 318
 319    then *NO VarHdr STUFF FOR STATIC*...
 320
 321    then the amodes are dropped in...
 322         ,a1 ,a2 ... ,aN
 323    then a close brace:
 324         };
 325 -}
 326
 327 pprAbsC sty stmt@(CClosureInfoAndCode cl_info slow maybe_fast upd cl_descr liveness) _
 328   = uppAboves [
 329         uppBesides [
 330             pp_info_rep,
 331             uppStr "_ITBL(",
 332             pprCLabel sty info_lbl,                     uppComma,
 333
 334                 -- CONST_ITBL needs an extra label for
 335                 -- the static version of the object.
 336             if isConstantRep sm_rep
 337             then uppBeside (pprCLabel sty (closureLabelFromCI cl_info)) uppComma
 338             else uppNil,
 339
 340             pprCLabel sty slow_lbl,     uppComma,
 341             pprAmode sty upd,           uppComma,
 342             uppInt liveness,            uppComma,
 343
 344             pp_tag,                     uppComma,
 345             pp_size,                    uppComma,
 346             pp_ptr_wds,                 uppComma,
 347
 348             ppLocalness info_lbl,                               uppComma,
 349             ppLocalnessMacro True{-function-} slow_lbl,         uppComma,
 350
 351             if is_selector
 352             then uppBeside (uppInt select_word_i) uppComma
 353             else uppNil,
 354
 355             if_profiling sty pp_kind, uppComma,
 356             if_profiling sty pp_descr, uppComma,
 357             if_profiling sty pp_type,
 358             uppStr ");"
 359         ],
 360         pp_slow,
 361         case maybe_fast of
 362             Nothing -> uppNil
 363             Just fast -> let stuff = CCodeBlock fast_lbl fast in
 364                          pprAbsC sty stuff (costs stuff)
 365     ]
 366   where
 367     info_lbl    = infoTableLabelFromCI cl_info
 368     fast_lbl    = fastLabelFromCI cl_info
 369     sm_rep      = closureSMRep    cl_info
 370
 371     (slow_lbl, pp_slow)
 372       = case (nonemptyAbsC slow) of
 373           Nothing -> (mkErrorStdEntryLabel, uppNil)
 374           Just xx -> (entryLabelFromCI cl_info,
 375                        let stuff = CCodeBlock slow_lbl xx in
 376                        pprAbsC sty stuff (costs stuff))
 377
 378     maybe_selector = maybeSelectorInfo cl_info
 379     is_selector = maybeToBool maybe_selector
 380     (Just (_, select_word_i)) = maybe_selector
 381
 382     pp_info_rep     -- special stuff if it's a selector; otherwise, just the SMrep
 383       = uppStr (if is_selector then "SELECT" else (getSMInfoStr sm_rep))
 384
 385     pp_tag = uppInt (closureSemiTag cl_info)
 386
 387     is_phantom = isPhantomRep sm_rep
 388
 389     pp_size = if isSpecRep sm_rep then  -- exploiting: SPEC_VHS == 0 (always)
 390                  uppInt (closureNonHdrSize cl_info)
 391
 392               else if is_phantom then   -- do not have sizes for these
 393                  uppNil
 394               else
 395                  pprHeapOffset sty (closureSizeWithoutFixedHdr cl_info)
 396
 397     pp_ptr_wds  = if is_phantom then
 398                      uppNil
 399                   else
 400                      uppInt (closurePtrsSize cl_info)
 401
 402     pp_kind  = uppStr (closureKind cl_info)
 403     pp_descr = uppBesides [uppChar '"', uppStr (stringToC cl_descr), uppChar '"']
 404     pp_type  = uppBesides [uppChar '"', uppStr (stringToC (closureTypeDescr cl_info)), uppChar '"']
 405
 406 pprAbsC sty (CRetVector lbl maybes deflt) c
 407   = uppAboves [ uppStr "{ // CRetVector (lbl????)",
 408                uppNest 8 (uppSep (map (ppr_maybe_amode sty) maybes)),
 409                uppStr "} /*default=*/ {", pprAbsC sty deflt c,
 410                uppStr "}"]
 411   where
 412     ppr_maybe_amode sty Nothing  = uppPStr SLIT("/*default*/")
 413     ppr_maybe_amode sty (Just a) = pprAmode sty a
 414
 415 pprAbsC sty stmt@(CRetUnVector label amode) _
 416   = uppBesides [uppStr "UNVECTBL(", pp_static, uppComma, pprCLabel sty label, uppComma,
 417             pprAmode sty amode, uppRparen]
 418   where
 419     pp_static = if externallyVisibleCLabel label then uppNil else uppPStr SLIT("static")
 420
 421 pprAbsC sty stmt@(CFlatRetVector label amodes) _
 422   =     case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
 423         uppAboves [
 424             case sty of
 425               PprForC -> pp_exts
 426               _ -> uppNil,
 427             uppBesides [ppLocalness label, uppPStr SLIT(" W_ "),
 428                        pprCLabel sty label, uppStr "[] = {"],
 429             uppNest 2 (uppInterleave uppComma (map (ppr_item sty) amodes)),
 430             uppStr "};" ] }
 431   where
 432     ppr_item sty item = uppBeside (uppStr "(W_) ") (ppr_amode sty item)
 433
 434 pprAbsC sty (CCostCentreDecl is_local cc) _ = uppCostCentreDecl sty is_local cc
 435 \end{code}
 436
 437 \begin{code}
 438 ppLocalness label
 439   = uppBeside static const
 440   where
 441     static = if (externallyVisibleCLabel label) then uppNil else uppPStr SLIT("static ")
 442     const  = if not (isReadOnly label)          then uppNil else uppPStr SLIT("const")
 443
 444 ppLocalnessMacro for_fun{-vs data-} clabel
 445   = case (if externallyVisibleCLabel clabel then "E" else "I") of { prefix ->
 446     case (if isReadOnly clabel then "RO_" else "")            of { suffix ->
 447     if for_fun
 448        then uppStr (prefix ++ "F_")
 449        else uppStr (prefix ++ "D_" ++ suffix)
 450     } }
 451 \end{code}
 452
 453 \begin{code}
 454 grab_non_void_amodes amodes
 455   = filter non_void amodes
 456
 457 non_void amode
 458   = case (getAmodeRep amode) of
 459       VoidRep -> False
 460       k -> True
 461 \end{code}
 462
 463 \begin{code}
 464 ppr_vol_regs :: PprStyle -> [MagicId] -> (Unpretty, Unpretty)
 465
 466 ppr_vol_regs sty [] = (uppNil, uppNil)
 467 ppr_vol_regs sty (VoidReg:rs) = ppr_vol_regs sty rs
 468 ppr_vol_regs sty (r:rs)
 469   = let pp_reg = case r of
 470                     VanillaReg pk n -> pprVanillaReg n
 471                     _ -> pprMagicId sty r
 472         (more_saves, more_restores) = ppr_vol_regs sty rs
 473     in
 474     (uppAbove (uppBeside (uppPStr SLIT("CALLER_SAVE_"))    pp_reg) more_saves,
 475      uppAbove (uppBeside (uppPStr SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
 476
 477 -- pp_basic_{saves,restores}: The BaseReg, SpA, SuA, SpB, SuB, Hp and
 478 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
 479 -- depending on the platform.  (The "volatile regs" stuff handles all
 480 -- other registers.)  Just be *sure* BaseReg is OK before trying to do
 481 -- anything else.
 482 pp_basic_saves
 483   = uppAboves [
 484         uppPStr SLIT("CALLER_SAVE_Base"),
 485         uppPStr SLIT("CALLER_SAVE_SpA"),
 486         uppPStr SLIT("CALLER_SAVE_SuA"),
 487         uppPStr SLIT("CALLER_SAVE_SpB"),
 488         uppPStr SLIT("CALLER_SAVE_SuB"),
 489         uppPStr SLIT("CALLER_SAVE_Ret"),
 490 --      uppPStr SLIT("CALLER_SAVE_Activity"),
 491         uppPStr SLIT("CALLER_SAVE_Hp"),
 492         uppPStr SLIT("CALLER_SAVE_HpLim") ]
 493
 494 pp_basic_restores
 495   = uppAboves [
 496         uppPStr SLIT("CALLER_RESTORE_Base"), -- must be first!
 497         uppPStr SLIT("CALLER_RESTORE_SpA"),
 498         uppPStr SLIT("CALLER_RESTORE_SuA"),
 499         uppPStr SLIT("CALLER_RESTORE_SpB"),
 500         uppPStr SLIT("CALLER_RESTORE_SuB"),
 501         uppPStr SLIT("CALLER_RESTORE_Ret"),
 502 --      uppPStr SLIT("CALLER_RESTORE_Activity"),
 503         uppPStr SLIT("CALLER_RESTORE_Hp"),
 504         uppPStr SLIT("CALLER_RESTORE_HpLim"),
 505         uppPStr SLIT("CALLER_RESTORE_StdUpdRetVec"),
 506         uppPStr SLIT("CALLER_RESTORE_StkStub") ]
 507 \end{code}
 508
 509 \begin{code}
 510 if_profiling sty pretty
 511   = case sty of
 512       PprForC -> if  opt_SccProfilingOn
 513                  then pretty
 514                  else uppChar '0' -- leave it out!
 515
 516       _ -> {-print it anyway-} pretty
 517
 518 -- ---------------------------------------------------------------------------
 519 -- Changes for GrAnSim:
 520 --  draw costs for computation in head of if into both branches;
 521 --  as no abstractC data structure is given for the head, one is constructed
 522 --  guessing unknown values and fed into the costs function
 523 -- ---------------------------------------------------------------------------
 524
 525 do_if_stmt sty discrim tag alt_code deflt c
 526   = case tag of
 527       -- This special case happens when testing the result of a comparison.
 528       -- We can just avoid some redundant clutter in the output.
 529       MachInt n _ | n==0 -> ppr_if_stmt sty (pprAmode sty discrim)
 530                                       deflt alt_code
 531                                       (addrModeCosts discrim Rhs) c
 532       other              -> let
 533                                cond = uppBesides [ pprAmode sty discrim,
 534                                           uppPStr SLIT(" == "),
 535                                           pprAmode sty (CLit tag) ]
 536                             in
 537                             ppr_if_stmt sty cond
 538                                          alt_code deflt
 539                                          (addrModeCosts discrim Rhs) c
 540
 541 ppr_if_stmt sty pp_pred then_part else_part discrim_costs c
 542   = uppAboves [
 543       uppBesides [uppStr "if (", pp_pred, uppStr ") {"],
 544       uppNest 8 (pprAbsC sty then_part  (c + discrim_costs +
 545                                         (Cost (0, 2, 0, 0, 0)) +
 546                                         costs then_part)),
 547       (case nonemptyAbsC else_part of Nothing -> uppNil; Just _ -> uppStr "} else {"),
 548       uppNest 8 (pprAbsC sty else_part  (c + discrim_costs +
 549                                         (Cost (0, 1, 0, 0, 0)) +
 550                                         costs else_part)),
 551       uppChar '}' ]
 552     {- Total costs = inherited costs (before if) + costs for accessing discrim
 553                      + costs for cond branch ( = (0, 1, 0, 0, 0) )
 554                      + costs for that alternative
 555     -}
 556 \end{code}
 557
 558 Historical note: this used to be two separate cases -- one for `ccall'
 559 and one for `casm'.  To get round a potential limitation to only 10
 560 arguments, the numbering of arguments in @process_casm@ was beefed up a
 561 bit. ADR
 562
 563 Some rough notes on generating code for @CCallOp@:
 564
 565 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
 566 2) Save any essential registers (heap, stack, etc).
 567
 568    ToDo: If stable pointers are in use, these must be saved in a place
 569    where the runtime system can get at them so that the Stg world can
 570    be restarted during the call.
 571
 572 3) Save any temporary registers that are currently in use.
 573 4) Do the call putting result into a local variable
 574 5) Restore essential registers
 575 6) Restore temporaries
 576
 577    (This happens after restoration of essential registers because we
 578    might need the @Base@ register to access all the others correctly.)
 579
 580 {- Doesn't apply anymore with ForeignObj, structure create via primop.
 581    makeForeignObj (ForeignObj is not CReturnable)
 582 7) If returning Malloc Pointer, build a closure containing the
 583    appropriate value.
 584 -}
 585    Otherwise, copy local variable into result register.
 586
 587 8) If ccall (not casm), declare the function being called as extern so
 588    that C knows if it returns anything other than an int.
 589
 590 \begin{pseudocode}
 591 { ResultType _ccall_result;
 592   basic_saves;
 593   saves;
 594   _ccall_result = f( args );
 595   basic_restores;
 596   restores;
 597
 598   return_reg = _ccall_result;
 599 }
 600 \end{pseudocode}
 601
 602 Amendment to the above: if we can GC, we have to:
 603
 604 * make sure we save all our registers away where the garbage collector
 605   can get at them.
 606 * be sure that there are no live registers or we're in trouble.
 607   (This can cause problems if you try something foolish like passing
 608    an array or foreign obj to a _ccall_GC_ thing.)
 609 * increment/decrement the @inCCallGC@ counter before/after the call so
 610   that the runtime check that PerformGC is being used sensibly will work.
 611
 612 \begin{code}
 613 pprCCall sty op@(CCallOp op_str is_asm may_gc _ _) args results liveness_mask vol_regs
 614   = if (may_gc && liveness_mask /= noLiveRegsMask)
 615     then panic ("Live register in _casm_GC_ \"" ++ casm_str ++ "\" " ++ (uppShow 80 (uppCat pp_non_void_args)) ++ "\n")
 616     else
 617     uppAboves [
 618       uppChar '{',
 619       declare_local_vars,   -- local var for *result*
 620       uppAboves local_arg_decls,
 621       -- if is_asm then uppNil else declareExtern,
 622       pp_save_context,
 623       process_casm local_vars pp_non_void_args casm_str,
 624       pp_restore_context,
 625       assign_results,
 626       uppChar '}'
 627     ]
 628   where
 629     (pp_saves, pp_restores) = ppr_vol_regs sty vol_regs
 630     (pp_save_context, pp_restore_context) =
 631         if may_gc
 632         then (  uppStr "extern StgInt inCCallGC; SaveAllStgRegs(); inCCallGC++;",
 633                 uppStr "inCCallGC--; RestoreAllStgRegs();")
 634         else (  pp_basic_saves `uppAbove` pp_saves,
 635                 pp_basic_restores `uppAbove` pp_restores)
 636
 637     non_void_args =
 638         let nvas = tail args
 639         in ASSERT (all non_void nvas) nvas
 640     -- the first argument will be the "I/O world" token (a VoidRep)
 641     -- all others should be non-void
 642
 643     non_void_results =
 644         let nvrs = grab_non_void_amodes results
 645         in ASSERT (length nvrs <= 1) nvrs
 646     -- there will usually be two results: a (void) state which we
 647     -- should ignore and a (possibly void) result.
 648
 649     (local_arg_decls, pp_non_void_args)
 650       = unzip [ ppr_casm_arg sty a i | (a,i) <- non_void_args `zip` [1..] ]
 651
 652     pp_liveness = pprAmode sty (mkIntCLit liveness_mask)
 653
 654     (declare_local_vars, local_vars, assign_results)
 655       = ppr_casm_results sty non_void_results pp_liveness
 656
 657     casm_str = if is_asm then _UNPK_ op_str else ccall_str
 658
 659     -- Remainder only used for ccall
 660
 661     ccall_str = uppShow 80
 662         (uppBesides [
 663                 if null non_void_results
 664                   then uppNil
 665                   else uppPStr SLIT("%r = "),
 666                 uppLparen, uppPStr op_str, uppLparen,
 667                   uppIntersperse uppComma ccall_args,
 668                 uppStr "));"
 669         ])
 670     num_args = length non_void_args
 671     ccall_args = take num_args [ uppBeside (uppChar '%') (uppInt i) | i <- [0..] ]
 672 \end{code}
 673
 674 If the argument is a heap object, we need to reach inside and pull out
 675 the bit the C world wants to see.  The only heap objects which can be
 676 passed are @Array@s, @ByteArray@s and @ForeignObj@s.
 677
 678 \begin{code}
 679 ppr_casm_arg :: PprStyle -> CAddrMode -> Int -> (Unpretty, Unpretty)
 680     -- (a) decl and assignment, (b) local var to be used later
 681
 682 ppr_casm_arg sty amode a_num
 683   = let
 684         a_kind   = getAmodeRep amode
 685         pp_amode = pprAmode sty amode
 686         pp_kind  = pprPrimKind sty a_kind
 687
 688         local_var  = uppBeside (uppPStr SLIT("_ccall_arg")) (uppInt a_num)
 689
 690         (arg_type, pp_amode2)
 691           = case a_kind of
 692
 693               -- for array arguments, pass a pointer to the body of the array
 694               -- (PTRS_ARR_CTS skips over all the header nonsense)
 695               ArrayRep      -> (pp_kind,
 696                                 uppBesides [uppStr "PTRS_ARR_CTS(", pp_amode, uppRparen])
 697               ByteArrayRep -> (pp_kind,
 698                                 uppBesides [uppStr "BYTE_ARR_CTS(", pp_amode, uppRparen])
 699
 700               -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
 701               ForeignObjRep -> (uppPStr SLIT("StgForeignObj"),
 702                                 uppBesides [uppStr "ForeignObj_CLOSURE_DATA(", pp_amode, uppStr")"])
 703               other         -> (pp_kind, pp_amode)
 704
 705         declare_local_var
 706           = uppBesides [ arg_type, uppSP, local_var, uppEquals, pp_amode2, uppSemi ]
 707     in
 708     (declare_local_var, local_var)
 709 \end{code}
 710
 711 For l-values, the critical questions are:
 712
 713 1) Are there any results at all?
 714
 715    We only allow zero or one results.
 716
 717 {- With the introduction of ForeignObj (MallocPtr++), no longer necess.
 718 2) Is the result is a foreign obj?
 719
 720    The mallocptr must be encapsulated immediately in a heap object.
 721 -}
 722 \begin{code}
 723 ppr_casm_results ::
 724         PprStyle        -- style
 725         -> [CAddrMode]  -- list of results (length <= 1)
 726         -> Unpretty     -- liveness mask
 727         ->
 728         ( Unpretty,     -- declaration of any local vars
 729           [Unpretty],   -- list of result vars (same length as results)
 730           Unpretty )    -- assignment (if any) of results in local var to registers
 731
 732 ppr_casm_results sty [] liveness
 733   = (uppNil, [], uppNil)        -- no results
 734
 735 ppr_casm_results sty [r] liveness
 736   = let
 737         result_reg = ppr_amode sty r
 738         r_kind     = getAmodeRep r
 739
 740         local_var  = uppPStr SLIT("_ccall_result")
 741
 742         (result_type, assign_result)
 743           = case r_kind of
 744 {- @ForeignObj@s replaces MallocPtrs and are *not* CReturnable.
 745    Instead, external references have to be turned into ForeignObjs
 746    using the primop makeForeignObj#. Benefit: Multiple finalisation
 747    routines can be accommodated and the below special case is not needed.
 748    Price is, of course, that you have to explicitly wrap `foreign objects'
 749    with makeForeignObj#.
 750 +
 751               ForeignObjRep ->
 752                 (uppPStr SLIT("StgForeignObj"),
 753                  uppBesides [ uppStr "constructForeignObj(",
 754                                 liveness, uppComma,
 755                                 result_reg, uppComma,
 756                                 local_var,
 757                              pp_paren_semi ]) -}
 758               _ ->
 759                 (pprPrimKind sty r_kind,
 760                  uppBesides [ result_reg, uppEquals, local_var, uppSemi ])
 761
 762         declare_local_var = uppBesides [ result_type, uppSP, local_var, uppSemi ]
 763     in
 764     (declare_local_var, [local_var], assign_result)
 765
 766 ppr_casm_results sty rs liveness
 767   = panic "ppr_casm_results: ccall/casm with many results"
 768 \end{code}
 769
 770
 771 Note the sneaky way _the_ result is represented by a list so that we
 772 can complain if it's used twice.
 773
 774 ToDo: Any chance of giving line numbers when process-casm fails?
 775       Or maybe we should do a check _much earlier_ in compiler. ADR
 776
 777 \begin{code}
 778 process_casm ::
 779         [Unpretty]              -- results (length <= 1)
 780         -> [Unpretty]           -- arguments
 781         -> String               -- format string (with embedded %'s)
 782         ->
 783         Unpretty                        -- code being generated
 784
 785 process_casm results args string = process results args string
 786  where
 787   process []    _ "" = uppNil
 788   process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++ string ++ "\"\n(Try changing result type to PrimIO ()\n")
 789
 790   process ress args ('%':cs)
 791     = case cs of
 792         [] ->
 793             error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
 794
 795         ('%':css) ->
 796             uppBeside (uppChar '%') (process ress args css)
 797
 798         ('r':css)  ->
 799           case ress of
 800             []  -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
 801             [r] -> uppBeside r (process [] args css)
 802             _   -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
 803
 804         other ->
 805           let
 806                 read_int :: ReadS Int
 807                 read_int = reads
 808           in
 809           case (read_int other) of
 810             [(num,css)] ->
 811                   if 0 <= num && num < length args
 812                   then uppBeside (uppParens (args !! num))
 813                                  (process ress args css)
 814                     else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
 815             _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
 816
 817   process ress args (other_c:cs)
 818     = uppBeside (uppChar other_c) (process ress args cs)
 819 \end{code}
 820
 821 %************************************************************************
 822 %*                                                                      *
 823 \subsection[a2r-assignments]{Assignments}
 824 %*                                                                      *
 825 %************************************************************************
 826
 827 Printing assignments is a little tricky because of type coercion.
 828
 829 First of all, the kind of the thing being assigned can be gotten from
 830 the destination addressing mode.  (It should be the same as the kind
 831 of the source addressing mode.)  If the kind of the assignment is of
 832 @VoidRep@, then don't generate any code at all.
 833
 834 \begin{code}
 835 pprAssign :: PprStyle -> PrimRep -> CAddrMode -> CAddrMode -> Unpretty
 836
 837 pprAssign sty VoidRep dest src = uppNil
 838 \end{code}
 839
 840 Special treatment for floats and doubles, to avoid unwanted conversions.
 841
 842 \begin{code}
 843 pprAssign sty FloatRep dest@(CVal reg_rel _) src
 844   = uppBesides [ uppStr "ASSIGN_FLT(", ppr_amode sty (CAddr reg_rel), uppComma, pprAmode sty src, pp_paren_semi ]
 845
 846 pprAssign sty DoubleRep dest@(CVal reg_rel _) src
 847   = uppBesides [ uppStr "ASSIGN_DBL(", ppr_amode sty (CAddr reg_rel), uppComma, pprAmode sty src, pp_paren_semi ]
 848 \end{code}
 849
 850 Lastly, the question is: will the C compiler think the types of the
 851 two sides of the assignment match?
 852
 853         We assume that the types will match
 854         if neither side is a @CVal@ addressing mode for any register
 855         which can point into the heap or B stack.
 856
 857 Why?  Because the heap and B stack are used to store miscellaneous things,
 858 whereas the A stack, temporaries, registers, etc., are only used for things
 859 of fixed type.
 860
 861 \begin{code}
 862 pprAssign sty kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
 863   = uppBesides [ pprVanillaReg dest, uppEquals,
 864                 pprVanillaReg src, uppSemi ]
 865
 866 pprAssign sty kind dest src
 867   | mixedTypeLocn dest
 868     -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
 869   = uppBesides [ ppr_amode sty dest, uppEquals,
 870                 uppStr "(W_)(", -- Here is the cast
 871                 ppr_amode sty src, pp_paren_semi ]
 872
 873 pprAssign sty kind dest src
 874   | mixedPtrLocn dest && getAmodeRep src /= PtrRep
 875     -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
 876   = uppBesides [ ppr_amode sty dest, uppEquals,
 877                 uppStr "(P_)(", -- Here is the cast
 878                 ppr_amode sty src, pp_paren_semi ]
 879
 880 pprAssign sty ByteArrayRep dest src
 881   | mixedPtrLocn src
 882     -- Add in a cast to StgPtr (a.k.a. B_) iff the source is mixed
 883   = uppBesides [ ppr_amode sty dest, uppEquals,
 884                 uppStr "(B_)(", -- Here is the cast
 885                 ppr_amode sty src, pp_paren_semi ]
 886
 887 pprAssign sty kind other_dest src
 888   = uppBesides [ ppr_amode sty other_dest, uppEquals,
 889                 pprAmode  sty src, uppSemi ]
 890 \end{code}
 891
 892
 893 %************************************************************************
 894 %*                                                                      *
 895 \subsection[a2r-CAddrModes]{Addressing modes}
 896 %*                                                                      *
 897 %************************************************************************
 898
 899 @pprAmode@ is used to print r-values (which may need casts), whereas
 900 @ppr_amode@ is used for l-values {\em and} as a help function for
 901 @pprAmode@.
 902
 903 \begin{code}
 904 pprAmode, ppr_amode :: PprStyle -> CAddrMode -> Unpretty
 905 \end{code}
 906
 907 For reasons discussed above under assignments, @CVal@ modes need
 908 to be treated carefully.  First come special cases for floats and doubles,
 909 similar to those in @pprAssign@:
 910
 911 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
 912 question.)
 913
 914 \begin{code}
 915 pprAmode sty (CVal reg_rel FloatRep)
 916   = uppBesides [ uppStr "PK_FLT(", ppr_amode sty (CAddr reg_rel), uppRparen ]
 917 pprAmode sty (CVal reg_rel DoubleRep)
 918   = uppBesides [ uppStr "PK_DBL(", ppr_amode sty (CAddr reg_rel), uppRparen ]
 919 \end{code}
 920
 921 Next comes the case where there is some other cast need, and the
 922 no-cast case:
 923
 924 \begin{code}
 925 pprAmode sty amode
 926   | mixedTypeLocn amode
 927   = uppParens (uppBesides [ pprPrimKind sty (getAmodeRep amode), uppStr ")(",
 928                 ppr_amode sty amode ])
 929   | otherwise   -- No cast needed
 930   = ppr_amode sty amode
 931 \end{code}
 932
 933 Now the rest of the cases for ``workhorse'' @ppr_amode@:
 934
 935 \begin{code}
 936 ppr_amode sty (CVal reg_rel _)
 937   = case (pprRegRelative sty False{-no sign wanted-} reg_rel) of
 938         (pp_reg, Nothing)     -> uppBeside  (uppChar '*') pp_reg
 939         (pp_reg, Just offset) -> uppBesides [ pp_reg, uppBracket offset ]
 940
 941 ppr_amode sty (CAddr reg_rel)
 942   = case (pprRegRelative sty True{-sign wanted-} reg_rel) of
 943         (pp_reg, Nothing)     -> pp_reg
 944         (pp_reg, Just offset) -> uppBeside pp_reg offset
 945
 946 ppr_amode sty (CReg magic_id) = pprMagicId sty magic_id
 947
 948 ppr_amode sty (CTemp uniq kind) = prettyToUn (pprUnique uniq)
 949
 950 ppr_amode sty (CLbl label kind) = pprCLabel sty label
 951
 952 ppr_amode sty (CUnVecLbl direct vectored)
 953   = uppBesides [uppStr "(StgRetAddr) UNVEC(", pprCLabel sty direct, uppComma,
 954                pprCLabel sty vectored, uppRparen]
 955
 956 ppr_amode sty (CCharLike char)
 957   = uppBesides [uppStr "CHARLIKE_CLOSURE(", pprAmode sty char, uppRparen ]
 958 ppr_amode sty (CIntLike int)
 959   = uppBesides [uppStr "INTLIKE_CLOSURE(", pprAmode sty int, uppRparen ]
 960
 961 ppr_amode sty (CString str) = uppBesides [uppChar '"', uppStr (stringToC (_UNPK_ str)), uppChar '"']
 962   -- ToDo: are these *used* for anything?
 963
 964 ppr_amode sty (CLit lit) = pprBasicLit sty lit
 965
 966 ppr_amode sty (CLitLit str _) = uppPStr str
 967
 968 ppr_amode sty (COffset off) = pprHeapOffset sty off
 969
 970 ppr_amode sty (CCode abs_C)
 971   = uppAboves [ uppStr "{ -- CCode", uppNest 8 (pprAbsC sty abs_C (costs abs_C)), uppChar '}' ]
 972
 973 ppr_amode sty (CLabelledCode label abs_C)
 974   = uppAboves [ uppBesides [pprCLabel sty label, uppStr " = { -- CLabelledCode"],
 975                uppNest 8 (pprAbsC sty abs_C (costs abs_C)), uppChar '}' ]
 976
 977 ppr_amode sty (CJoinPoint _ _)
 978   = panic "ppr_amode: CJoinPoint"
 979
 980 ppr_amode sty (CTableEntry base index kind)
 981   = uppBesides [uppStr "((", pprPrimKind sty kind, uppStr " *)(",
 982                ppr_amode sty base, uppStr "))[(I_)(", ppr_amode sty index,
 983                uppStr ")]"]
 984
 985 ppr_amode sty (CMacroExpr pk macro as)
 986   = uppBesides [uppLparen, pprPrimKind sty pk, uppStr ")(", uppStr (show macro), uppLparen,
 987                uppIntersperse uppComma (map (pprAmode sty) as), uppStr "))"]
 988
 989 ppr_amode sty (CCostCentre cc print_as_string)
 990   = uppCostCentre sty print_as_string cc
 991 \end{code}
 992
 993 %************************************************************************
 994 %*                                                                      *
 995 \subsection[a2r-MagicIds]{Magic ids}
 996 %*                                                                      *
 997 %************************************************************************
 998
 999 @pprRegRelative@ returns a pair of the @Unpretty@ for the register
1000 (some casting may be required), and a @Maybe Unpretty@ for the offset
1001 (zero offset gives a @Nothing@).
1002
1003 \begin{code}
1004 addPlusSign :: Bool -> Unpretty -> Unpretty
1005 addPlusSign False p = p
1006 addPlusSign True  p = uppBeside (uppChar '+') p
1007
1008 pprSignedInt :: Bool -> Int -> Maybe Unpretty   -- Nothing => 0
1009 pprSignedInt sign_wanted n
1010  = if n == 0 then Nothing else
1011    if n > 0  then Just (addPlusSign sign_wanted (uppInt n))
1012    else           Just (uppInt n)
1013
1014 pprRegRelative :: PprStyle
1015                -> Bool          -- True <=> Print leading plus sign (if +ve)
1016                -> RegRelative
1017                -> (Unpretty, Maybe Unpretty)
1018
1019 pprRegRelative sty sign_wanted (SpARel spA off)
1020   = (pprMagicId sty SpA, pprSignedInt sign_wanted (spARelToInt spA off))
1021
1022 pprRegRelative sty sign_wanted (SpBRel spB off)
1023   = (pprMagicId sty SpB, pprSignedInt sign_wanted (spBRelToInt spB off))
1024
1025 pprRegRelative sty sign_wanted r@(HpRel hp off)
1026   = let to_print = hp `subOff` off
1027         pp_Hp    = pprMagicId sty Hp
1028     in
1029     if isZeroOff to_print then
1030         (pp_Hp, Nothing)
1031     else
1032         (pp_Hp, Just (uppBeside (uppChar '-') (pprHeapOffset sty to_print)))
1033                                 -- No parens needed because pprHeapOffset
1034                                 -- does them when necessary
1035
1036 pprRegRelative sty sign_wanted (NodeRel off)
1037   = let pp_Node = pprMagicId sty node
1038     in
1039     if isZeroOff off then
1040         (pp_Node, Nothing)
1041     else
1042         (pp_Node, Just (addPlusSign sign_wanted (pprHeapOffset sty off)))
1043
1044 \end{code}
1045
1046 @pprMagicId@ just prints the register name.  @VanillaReg@ registers are
1047 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1048 to select the union tag.
1049
1050 \begin{code}
1051 pprMagicId :: PprStyle -> MagicId -> Unpretty
1052
1053 pprMagicId sty BaseReg              = uppPStr SLIT("BaseReg")
1054 pprMagicId sty StkOReg              = uppPStr SLIT("StkOReg")
1055 pprMagicId sty (VanillaReg pk n)
1056                                     = uppBesides [ pprVanillaReg n, uppChar '.',
1057                                                   pprUnionTag pk ]
1058 pprMagicId sty (FloatReg  n)        = uppBeside (uppPStr SLIT("FltReg")) (uppInt IBOX(n))
1059 pprMagicId sty (DoubleReg n)        = uppBeside (uppPStr SLIT("DblReg")) (uppInt IBOX(n))
1060 pprMagicId sty TagReg               = uppPStr SLIT("TagReg")
1061 pprMagicId sty RetReg               = uppPStr SLIT("RetReg")
1062 pprMagicId sty SpA                  = uppPStr SLIT("SpA")
1063 pprMagicId sty SuA                  = uppPStr SLIT("SuA")
1064 pprMagicId sty SpB                  = uppPStr SLIT("SpB")
1065 pprMagicId sty SuB                  = uppPStr SLIT("SuB")
1066 pprMagicId sty Hp                   = uppPStr SLIT("Hp")
1067 pprMagicId sty HpLim                = uppPStr SLIT("HpLim")
1068 pprMagicId sty LivenessReg          = uppPStr SLIT("LivenessReg")
1069 pprMagicId sty StdUpdRetVecReg      = uppPStr SLIT("StdUpdRetVecReg")
1070 pprMagicId sty StkStubReg           = uppPStr SLIT("StkStubReg")
1071 pprMagicId sty CurCostCentre        = uppPStr SLIT("CCC")
1072 pprMagicId sty VoidReg              = panic "pprMagicId:VoidReg!"
1073
1074 pprVanillaReg :: FAST_INT -> Unpretty
1075
1076 pprVanillaReg n = uppBeside (uppChar 'R') (uppInt IBOX(n))
1077
1078 pprUnionTag :: PrimRep -> Unpretty
1079
1080 pprUnionTag PtrRep              = uppChar 'p'
1081 pprUnionTag CodePtrRep          = uppPStr SLIT("fp")
1082 pprUnionTag DataPtrRep          = uppChar 'd'
1083 pprUnionTag RetRep              = uppChar 'r'
1084 pprUnionTag CostCentreRep       = panic "pprUnionTag:CostCentre?"
1085
1086 pprUnionTag CharRep             = uppChar 'c'
1087 pprUnionTag IntRep              = uppChar 'i'
1088 pprUnionTag WordRep             = uppChar 'w'
1089 pprUnionTag AddrRep             = uppChar 'v'
1090 pprUnionTag FloatRep            = uppChar 'f'
1091 pprUnionTag DoubleRep           = panic "pprUnionTag:Double?"
1092
1093 pprUnionTag StablePtrRep        = uppChar 'i'
1094 pprUnionTag ForeignObjRep       = uppChar 'p'
1095
1096 pprUnionTag ArrayRep            = uppChar 'p'
1097 pprUnionTag ByteArrayRep        = uppChar 'b'
1098
1099 pprUnionTag _                   = panic "pprUnionTag:Odd kind"
1100 \end{code}
1101
1102
1103 Find and print local and external declarations for a list of
1104 Abstract~C statements.
1105 \begin{code}
1106 pprTempAndExternDecls :: AbstractC -> (Unpretty{-temps-}, Unpretty{-externs-})
1107 pprTempAndExternDecls AbsCNop = (uppNil, uppNil)
1108
1109 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1110   = initTE (ppr_decls_AbsC stmt1        `thenTE` \ (t_p1, e_p1) ->
1111             ppr_decls_AbsC stmt2        `thenTE` \ (t_p2, e_p2) ->
1112             case (catMaybes [t_p1, t_p2])        of { real_temps ->
1113             case (catMaybes [e_p1, e_p2])        of { real_exts ->
1114             returnTE (uppAboves real_temps, uppAboves real_exts) }}
1115            )
1116
1117 pprTempAndExternDecls other_stmt
1118   = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1119             returnTE (
1120                 case maybe_t of
1121                   Nothing -> uppNil
1122                   Just pp -> pp,
1123
1124                 case maybe_e of
1125                   Nothing -> uppNil
1126                   Just pp -> pp )
1127            )
1128
1129 pprBasicLit :: PprStyle -> Literal -> Unpretty
1130 pprPrimKind :: PprStyle -> PrimRep -> Unpretty
1131
1132 pprBasicLit  sty lit = uppStr (showLiteral  sty lit)
1133 pprPrimKind  sty k   = uppStr (showPrimRep k)
1134 \end{code}
1135
1136
1137 %************************************************************************
1138 %*                                                                      *
1139 \subsection[a2r-monad]{Monadery}
1140 %*                                                                      *
1141 %************************************************************************
1142
1143 We need some monadery to keep track of temps and externs we have already
1144 printed.  This info must be threaded right through the Abstract~C, so
1145 it's most convenient to hide it in this monad.
1146
1147 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1148 \tr{(UniqSet, CLabelSet)}.  Allegedly for efficiency.
1149
1150 \begin{code}
1151 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1152 emptyCLabelSet = emptyFM
1153 x `elementOfCLabelSet` labs
1154   = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1155 addToCLabelSet set x = addToFM set x ()
1156
1157 type TEenv = (UniqSet Unique, CLabelSet)
1158
1159 type TeM result =  TEenv -> (TEenv, result)
1160
1161 initTE :: TeM a -> a
1162 initTE sa
1163   = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1164     result }
1165
1166 {-# INLINE thenTE #-}
1167 {-# INLINE returnTE #-}
1168
1169 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1170 thenTE a b u
1171   = case a u        of { (u_1, result_of_a) ->
1172     b result_of_a u_1 }
1173
1174 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1175 mapTE f []     = returnTE []
1176 mapTE f (x:xs)
1177   = f x         `thenTE` \ r  ->
1178     mapTE f xs  `thenTE` \ rs ->
1179     returnTE (r : rs)
1180
1181 returnTE :: a -> TeM a
1182 returnTE result env = (env, result)
1183
1184 -- these next two check whether the thing is already
1185 -- recorded, and THEN THEY RECORD IT
1186 -- (subsequent calls will return False for the same uniq/label)
1187
1188 tempSeenTE :: Unique -> TeM Bool
1189 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1190   = if (uniq `elementOfUniqSet` seen_uniqs)
1191     then (env, True)
1192     else ((addOneToUniqSet seen_uniqs uniq,
1193           seen_labels),
1194           False)
1195
1196 labelSeenTE :: CLabel -> TeM Bool
1197 labelSeenTE label env@(seen_uniqs, seen_labels)
1198   = if (label `elementOfCLabelSet` seen_labels)
1199     then (env, True)
1200     else ((seen_uniqs,
1201           addToCLabelSet seen_labels label),
1202           False)
1203 \end{code}
1204
1205 \begin{code}
1206 pprTempDecl :: Unique -> PrimRep -> Unpretty
1207 pprTempDecl uniq kind
1208   = uppBesides [ pprPrimKind PprDebug kind, uppSP, prettyToUn (pprUnique uniq), uppSemi ]
1209
1210 pprExternDecl :: CLabel -> PrimRep -> Unpretty
1211
1212 pprExternDecl clabel kind
1213   = if not (needsCDecl clabel) then
1214         uppNil -- do not print anything for "known external" things (e.g., < PreludeCore)
1215     else
1216         case (
1217             case kind of
1218               CodePtrRep -> ppLocalnessMacro True{-function-} clabel
1219               _          -> ppLocalnessMacro False{-data-}    clabel
1220         ) of { pp_macro_str ->
1221
1222         uppBesides [ pp_macro_str, uppLparen, pprCLabel PprForC clabel, pp_paren_semi ]
1223         }
1224 \end{code}
1225
1226 \begin{code}
1227 ppr_decls_AbsC :: AbstractC -> TeM (Maybe Unpretty{-temps-}, Maybe Unpretty{-externs-})
1228
1229 ppr_decls_AbsC AbsCNop          = returnTE (Nothing, Nothing)
1230
1231 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1232   = ppr_decls_AbsC stmts_1  `thenTE` \ p1 ->
1233     ppr_decls_AbsC stmts_2  `thenTE` \ p2 ->
1234     returnTE (maybe_uppAboves [p1, p2])
1235
1236 ppr_decls_AbsC (CClosureUpdInfo info)
1237   = ppr_decls_AbsC info
1238
1239 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1240
1241 ppr_decls_AbsC (CAssign dest source)
1242   = ppr_decls_Amode dest    `thenTE` \ p1 ->
1243     ppr_decls_Amode source  `thenTE` \ p2 ->
1244     returnTE (maybe_uppAboves [p1, p2])
1245
1246 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1247
1248 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1249
1250 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1251
1252 ppr_decls_AbsC (CSwitch discrim alts deflt)
1253   = ppr_decls_Amode discrim     `thenTE` \ pdisc ->
1254     mapTE ppr_alt_stuff alts    `thenTE` \ palts  ->
1255     ppr_decls_AbsC deflt        `thenTE` \ pdeflt ->
1256     returnTE (maybe_uppAboves (pdisc:pdeflt:palts))
1257   where
1258     ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1259
1260 ppr_decls_AbsC (CCodeBlock label absC)
1261   = ppr_decls_AbsC absC
1262
1263 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre inplace_upd)
1264         -- ToDo: strictly speaking, should chk "cost_centre" amode
1265   = labelSeenTE info_lbl     `thenTE` \  label_seen ->
1266     returnTE (Nothing,
1267               if label_seen then
1268                   Nothing
1269               else
1270                   Just (pprExternDecl info_lbl PtrRep))
1271   where
1272     info_lbl = infoTableLabelFromCI cl_info
1273
1274 ppr_decls_AbsC (COpStmt results _ args _ _) = ppr_decls_Amodes (results ++ args)
1275 ppr_decls_AbsC (CSimultaneous abc)          = ppr_decls_AbsC abc
1276
1277 ppr_decls_AbsC (CMacroStmt          _ amodes)   = ppr_decls_Amodes amodes
1278
1279 ppr_decls_AbsC (CCallProfCtrMacro   _ amodes)   = ppr_decls_Amodes [] -- *****!!!
1280   -- you get some nasty re-decls of stdio.h if you compile
1281   -- the prelude while looking inside those amodes;
1282   -- no real reason to, anyway.
1283 ppr_decls_AbsC (CCallProfCCMacro    _ amodes)   = ppr_decls_Amodes amodes
1284
1285 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1286         -- ToDo: strictly speaking, should chk "cost_centre" amode
1287   = ppr_decls_Amodes amodes
1288
1289 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast upd_lbl _ _)
1290   = ppr_decls_Amodes [entry_lbl, upd_lbl]       `thenTE` \ p1 ->
1291     ppr_decls_AbsC slow                         `thenTE` \ p2 ->
1292     (case maybe_fast of
1293         Nothing   -> returnTE (Nothing, Nothing)
1294         Just fast -> ppr_decls_AbsC fast)       `thenTE` \ p3 ->
1295     returnTE (maybe_uppAboves [p1, p2, p3])
1296   where
1297     entry_lbl = CLbl slow_lbl CodePtrRep
1298     slow_lbl    = case (nonemptyAbsC slow) of
1299                     Nothing -> mkErrorStdEntryLabel
1300                     Just _  -> entryLabelFromCI cl_info
1301
1302 ppr_decls_AbsC (CRetVector label maybe_amodes absC)
1303   = ppr_decls_Amodes (catMaybes maybe_amodes)   `thenTE` \ p1 ->
1304     ppr_decls_AbsC   absC                       `thenTE` \ p2 ->
1305     returnTE (maybe_uppAboves [p1, p2])
1306
1307 ppr_decls_AbsC (CRetUnVector   _ amode)  = ppr_decls_Amode amode
1308 ppr_decls_AbsC (CFlatRetVector _ amodes) = ppr_decls_Amodes amodes
1309 \end{code}
1310
1311 \begin{code}
1312 ppr_decls_Amode :: CAddrMode -> TeM (Maybe Unpretty, Maybe Unpretty)
1313 ppr_decls_Amode (CVal _ _)      = returnTE (Nothing, Nothing)
1314 ppr_decls_Amode (CAddr _)       = returnTE (Nothing, Nothing)
1315 ppr_decls_Amode (CReg _)        = returnTE (Nothing, Nothing)
1316 ppr_decls_Amode (CString _)     = returnTE (Nothing, Nothing)
1317 ppr_decls_Amode (CLit _)        = returnTE (Nothing, Nothing)
1318 ppr_decls_Amode (CLitLit _ _)   = returnTE (Nothing, Nothing)
1319 ppr_decls_Amode (COffset _)     = returnTE (Nothing, Nothing)
1320
1321 -- CIntLike must be a literal -- no decls
1322 ppr_decls_Amode (CIntLike int)  = returnTE (Nothing, Nothing)
1323
1324 -- CCharLike may have be arbitrary value -- may have decls
1325 ppr_decls_Amode (CCharLike char)
1326   = ppr_decls_Amode char
1327
1328 -- now, the only place where we actually print temps/externs...
1329 ppr_decls_Amode (CTemp uniq kind)
1330   = case kind of
1331       VoidRep -> returnTE (Nothing, Nothing)
1332       other ->
1333         tempSeenTE uniq `thenTE` \ temp_seen ->
1334         returnTE
1335           (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1336
1337 ppr_decls_Amode (CLbl label VoidRep)
1338   = returnTE (Nothing, Nothing)
1339
1340 ppr_decls_Amode (CLbl label kind)
1341   = labelSeenTE label `thenTE` \ label_seen ->
1342     returnTE (Nothing,
1343               if label_seen then Nothing else Just (pprExternDecl label kind))
1344
1345 {- WRONG:
1346 ppr_decls_Amode (CUnVecLbl direct vectored)
1347   = labelSeenTE direct   `thenTE` \ dlbl_seen ->
1348     labelSeenTE vectored `thenTE` \ vlbl_seen ->
1349     let
1350         ddcl = if dlbl_seen then uppNil else pprExternDecl direct CodePtrRep
1351         vdcl = if vlbl_seen then uppNil else pprExternDecl vectored DataPtrRep
1352     in
1353     returnTE (Nothing,
1354                 if (dlbl_seen || not (needsCDecl direct)) &&
1355                    (vlbl_seen || not (needsCDecl vectored)) then Nothing
1356                 else Just (uppBesides [uppStr "UNVEC(", ddcl, uppComma, vdcl, uppRparen]))
1357 -}
1358
1359 ppr_decls_Amode (CUnVecLbl direct vectored)
1360   = -- We don't mark either label as "seen", because
1361     -- we don't know which one will be used and which one tossed
1362     -- by the C macro...
1363     --labelSeenTE direct   `thenTE` \ dlbl_seen ->
1364     --labelSeenTE vectored `thenTE` \ vlbl_seen ->
1365     let
1366         ddcl = {-if dlbl_seen then uppNil else-} pprExternDecl direct CodePtrRep
1367         vdcl = {-if vlbl_seen then uppNil else-} pprExternDecl vectored DataPtrRep
1368     in
1369     returnTE (Nothing,
1370                 if ({-dlbl_seen ||-} not (needsCDecl direct)) &&
1371                    ({-vlbl_seen ||-} not (needsCDecl vectored)) then Nothing
1372                 else Just (uppBesides [uppStr "UNVEC(", ddcl, uppComma, vdcl, uppRparen]))
1373
1374 ppr_decls_Amode (CTableEntry base index _)
1375   = ppr_decls_Amode base    `thenTE` \ p1 ->
1376     ppr_decls_Amode index   `thenTE` \ p2 ->
1377     returnTE (maybe_uppAboves [p1, p2])
1378
1379 ppr_decls_Amode (CMacroExpr _ _ amodes)
1380   = ppr_decls_Amodes amodes
1381
1382 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1383
1384
1385 maybe_uppAboves :: [(Maybe Unpretty, Maybe Unpretty)] -> (Maybe Unpretty, Maybe Unpretty)
1386 maybe_uppAboves ps
1387   = case (unzip ps)     of { (ts, es) ->
1388     case (catMaybes ts) of { real_ts  ->
1389     case (catMaybes es) of { real_es  ->
1390     (if (null real_ts) then Nothing else Just (uppAboves real_ts),
1391      if (null real_es) then Nothing else Just (uppAboves real_es))
1392     } } }
1393 \end{code}
1394
1395 \begin{code}
1396 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe Unpretty, Maybe Unpretty)
1397 ppr_decls_Amodes amodes
1398   = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1399     returnTE ( maybe_uppAboves ps )
1400 \end{code}