ghc/compiler/absCSyn/PprAbsC.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 %************************************************************************
   5 %*                                                                      *
   6 \section[PprAbsC]{Pretty-printing Abstract~C}
   7 %*                                                                      *
   8 %************************************************************************
   9
  10 \begin{code}
  11 module PprAbsC (
  12         writeRealC,
  13         dumpRealC,
  14         pprAmode,
  15         pprMagicId
  16     ) where
  17
  18 #include "HsVersions.h"
  19
  20 import IO       ( Handle )
  21
  22 import AbsCSyn
  23 import ClosureInfo
  24 import AbsCUtils        ( getAmodeRep, nonemptyAbsC,
  25                           mixedPtrLocn, mixedTypeLocn
  26                         )
  27
  28 import Constants        ( mIN_UPD_SIZE )
  29 import CallConv         ( CallConv, callConvAttribute, cCallConv )
  30 import CLabel           ( externallyVisibleCLabel, mkErrorStdEntryLabel,
  31                           needsCDecl, pprCLabel,
  32                           mkReturnInfoLabel, mkReturnPtLabel, mkClosureTblLabel,
  33                           mkStaticClosureLabel,
  34                           CLabel, CLabelType(..), labelType, labelDynamic
  35                         )
  36
  37 import CmdLineOpts      ( opt_SccProfilingOn, opt_EmitCExternDecls, opt_GranMacros )
  38 import CostCentre       ( pprCostCentreDecl, pprCostCentreStackDecl )
  39
  40 import Costs            ( costs, addrModeCosts, CostRes(..), Side(..) )
  41 import CStrings         ( stringToC )
  42 import FiniteMap        ( addToFM, emptyFM, lookupFM, FiniteMap )
  43 import Const            ( Literal(..) )
  44 import TyCon            ( tyConDataCons )
  45 import Name             ( NamedThing(..) )
  46 import DataCon          ( DataCon{-instance NamedThing-} )
  47 import Maybes           ( maybeToBool, catMaybes )
  48 import PrimOp           ( primOpNeedsWrapper, pprPrimOp, PrimOp(..) )
  49 import PrimRep          ( isFloatingRep, PrimRep(..), getPrimRepSize, showPrimRep )
  50 import SMRep            ( pprSMRep )
  51 import Unique           ( pprUnique, Unique{-instance NamedThing-} )
  52 import UniqSet          ( emptyUniqSet, elementOfUniqSet,
  53                           addOneToUniqSet, UniqSet
  54                         )
  55 import StgSyn           ( SRT(..) )
  56 import BitSet           ( intBS )
  57 import Outputable
  58 import Util             ( nOfThem )
  59 import Addr             ( Addr )
  60
  61 import ST
  62 import MutableArray
  63
  64 infixr 9 `thenTE`
  65 \end{code}
  66
  67 For spitting out the costs of an abstract~C expression, @writeRealC@
  68 now not only prints the C~code of the @absC@ arg but also adds a macro
  69 call to a cost evaluation function @GRAN_EXEC@. For that,
  70 @pprAbsC@ has a new ``costs'' argument.  %% HWL
  71
  72 \begin{code}
  73 {-
  74 writeRealC :: Handle -> AbstractC -> IO ()
  75 writeRealC handle absC
  76      -- avoid holding on to the whole of absC in the !Gransim case.
  77      if opt_GranMacros
  78         then printForCFast fp (pprAbsC absC (costs absC))
  79         else printForCFast fp (pprAbsC absC (panic "costs"))
  80              --printForC handle (pprAbsC absC (panic "costs"))
  81 dumpRealC :: AbstractC -> SDoc
  82 dumpRealC absC = pprAbsC absC (costs absC)
  83 -}
  84
  85 writeRealC :: Handle -> AbstractC -> IO ()
  86 --writeRealC handle absC =
  87 -- _scc_ "writeRealC"
  88 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
  89
  90 writeRealC handle absC
  91  | opt_GranMacros = _scc_ "writeRealC" printForC handle $
  92                                        pprCode CStyle (pprAbsC absC (costs absC))
  93  | otherwise      = _scc_ "writeRealC" printForC handle $
  94                                        pprCode CStyle (pprAbsC absC (panic "costs"))
  95
  96 dumpRealC :: AbstractC -> SDoc
  97 dumpRealC absC
  98  | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
  99  | otherwise      = pprCode CStyle (pprAbsC absC (panic "costs"))
 100
 101 \end{code}
 102
 103 This emits the macro,  which is used in GrAnSim  to compute the total costs
 104 from a cost 5 tuple. %%  HWL
 105
 106 \begin{code}
 107 emitMacro :: CostRes -> SDoc
 108
 109 emitMacro _ | not opt_GranMacros = empty
 110
 111 emitMacro (Cost (i,b,l,s,f))
 112   = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
 113                           int i, comma, int b, comma, int l, comma,
 114                           int s, comma, int f, pp_paren_semi ]
 115
 116 pp_paren_semi = text ");"
 117 \end{code}
 118
 119 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
 120 code as an argument (that's needed when spitting out the GRAN_EXEC macro
 121 which must be done before the return i.e. inside absC code)   HWL
 122
 123 \begin{code}
 124 pprAbsC :: AbstractC -> CostRes -> SDoc
 125 pprAbsC AbsCNop _ = empty
 126 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
 127
 128 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
 129
 130 pprAbsC (CJump target) c
 131   = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++  CJump */"-} ])
 132              (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
 133
 134 pprAbsC (CFallThrough target) c
 135   = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++  CFallThrough */"-} ])
 136              (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
 137
 138 -- --------------------------------------------------------------------------
 139 -- Spit out GRAN_EXEC macro immediately before the return                 HWL
 140
 141 pprAbsC (CReturn am return_info)  c
 142   = ($$) (hcat [emitMacro c {-WDP:, text "/* <----  CReturn */"-} ])
 143              (hcat [text jmp_lit, target, pp_paren_semi ])
 144   where
 145    target = case return_info of
 146         DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
 147                               pprAmode am, rparen]
 148         DynamicVectoredReturn am' -> mk_vector (pprAmode am')
 149         StaticVectoredReturn n -> mk_vector (int n)     -- Always positive
 150    mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
 151                        x, rparen ]
 152
 153 pprAbsC (CSplitMarker) _ = ptext SLIT("/* SPLIT */")
 154
 155 -- we optimise various degenerate cases of CSwitches.
 156
 157 -- --------------------------------------------------------------------------
 158 -- Assume: CSwitch is also end of basic block
 159 --         costs function yields nullCosts for whole switch
 160 --         ==> inherited costs c are those of basic block up to switch
 161 --         ==> inherit c + costs for the corresponding branch
 162 --                                                                       HWL
 163 -- --------------------------------------------------------------------------
 164
 165 pprAbsC (CSwitch discrim [] deflt) c
 166   = pprAbsC deflt (c + costs deflt)
 167     -- Empty alternative list => no costs for discrim as nothing cond. here HWL
 168
 169 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
 170   = case (nonemptyAbsC deflt) of
 171       Nothing ->                -- one alt and no default
 172                  pprAbsC alt_code (c + costs alt_code)
 173                  -- Nothing conditional in here either  HWL
 174
 175       Just dc ->                -- make it an "if"
 176                  do_if_stmt discrim tag alt_code dc c
 177
 178 -- What problem is the re-ordering trying to solve ?
 179 pprAbsC (CSwitch discrim [(tag1@(MachInt i1 _), alt_code1),
 180                               (tag2@(MachInt i2 _), alt_code2)] deflt) c
 181   | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
 182   = if (i1 == 0) then
 183         do_if_stmt discrim tag1 alt_code1 alt_code2 c
 184     else
 185         do_if_stmt discrim tag2 alt_code2 alt_code1 c
 186   where
 187     empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
 188
 189 pprAbsC (CSwitch discrim alts deflt) c -- general case
 190   | isFloatingRep (getAmodeRep discrim)
 191     = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
 192   | otherwise
 193     = vcat [
 194         hcat [text "switch (", pp_discrim, text ") {"],
 195         nest 2 (vcat (map ppr_alt alts)),
 196         (case (nonemptyAbsC deflt) of
 197            Nothing -> empty
 198            Just dc ->
 199             nest 2 (vcat [ptext SLIT("default:"),
 200                                   pprAbsC dc (c + switch_head_cost
 201                                                     + costs dc),
 202                                   ptext SLIT("break;")])),
 203         char '}' ]
 204   where
 205     pp_discrim
 206       = pprAmode discrim
 207
 208     ppr_alt (lit, absC)
 209       = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
 210                    nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
 211                                        (ptext SLIT("break;"))) ]
 212
 213     -- Costs for addressing header of switch and cond. branching        -- HWL
 214     switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
 215
 216 pprAbsC stmt@(COpStmt results op@(CCallOp _ _ _ _) args vol_regs) _
 217   = pprCCall op args results vol_regs
 218
 219 pprAbsC stmt@(COpStmt results op args vol_regs) _
 220   = let
 221         non_void_args = grab_non_void_amodes args
 222         non_void_results = grab_non_void_amodes results
 223         -- if just one result, we print in the obvious "assignment" style;
 224         -- if 0 or many results, we emit a macro call, w/ the results
 225         -- followed by the arguments.  The macro presumably knows which
 226         -- are which :-)
 227
 228         the_op = ppr_op_call non_void_results non_void_args
 229                 -- liveness mask is *in* the non_void_args
 230     in
 231     if primOpNeedsWrapper op then
 232         case (ppr_vol_regs vol_regs) of { (pp_saves, pp_restores) ->
 233         vcat [  pp_saves,
 234                 the_op,
 235                 pp_restores
 236              ]
 237         }
 238     else
 239         the_op
 240   where
 241     ppr_op_call results args
 242       = hcat [ pprPrimOp op, lparen,
 243         hcat (punctuate comma (map ppr_op_result results)),
 244         if null results || null args then empty else comma,
 245         hcat (punctuate comma (map pprAmode args)),
 246         pp_paren_semi ]
 247
 248     ppr_op_result r = ppr_amode r
 249       -- primop macros do their own casting of result;
 250       -- hence we can toss the provided cast...
 251
 252 pprAbsC stmt@(CSRT lbl closures) c
 253   = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
 254          pp_exts
 255       $$ ptext SLIT("SRT") <> lparen <> pprCLabel lbl <> rparen
 256       $$ nest 2 (hcat (punctuate comma (map pp_closure_lbl closures)))
 257          <> ptext SLIT("};")
 258   }
 259
 260 pprAbsC stmt@(CBitmap lbl mask) c
 261   = vcat [
 262         hcat [ ptext SLIT("BITMAP"), lparen,
 263                         pprCLabel lbl, comma,
 264                         int (length mask),
 265                rparen ],
 266         hcat (punctuate comma (map (int.intBS) mask)),
 267         ptext SLIT("}};")
 268     ]
 269
 270 pprAbsC (CSimultaneous abs_c) c
 271   = hcat [ptext SLIT("{{"), pprAbsC abs_c c, ptext SLIT("}}")]
 272
 273 pprAbsC (CCheck macro as code) c
 274   = hcat [ptext (cCheckMacroText macro), lparen,
 275        hcat (punctuate comma (map ppr_amode as)), comma,
 276        pprAbsC code c, pp_paren_semi
 277     ]
 278 pprAbsC (CMacroStmt macro as) _
 279   = hcat [ptext (cStmtMacroText macro), lparen,
 280         hcat (punctuate comma (map ppr_amode as)),pp_paren_semi] -- no casting
 281 pprAbsC (CCallProfCtrMacro op as) _
 282   = hcat [ptext op, lparen,
 283         hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
 284 pprAbsC (CCallProfCCMacro op as) _
 285   = hcat [ptext op, lparen,
 286         hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
 287 pprAbsC stmt@(CCallTypedef is_tdef op@(CCallOp op_str is_asm may_gc cconv) results args) _
 288   =  hsep [ ptext (if is_tdef then SLIT("typedef") else SLIT("extern"))
 289           , ccall_res_ty
 290           , fun_nm
 291           , parens (hsep (punctuate comma ccall_decl_ty_args))
 292           ] <> semi
 293     where
 294     {-
 295       In the non-casm case, to ensure that we're entering the given external
 296       entry point using the correct calling convention, we have to do the following:
 297
 298         - When entering via a function pointer (the `dynamic' case) using the specified
 299           calling convention, we emit a typedefn declaration attributed with the
 300           calling convention to use together with the result and parameter types we're
 301           assuming. Coerce the function pointer to this type and go.
 302
 303         - to enter the function at a given code label, we emit an extern declaration
 304           for the label here, stating the calling convention together with result and
 305           argument types we're assuming.
 306
 307           The C compiler will hopefully use this extern declaration to good effect,
 308           reporting any discrepancies between our extern decl and any other that
 309           may be in scope.
 310
 311           Re: calling convention, notice that gcc (2.8.1 and egcs-1.0.2) will for
 312           the external function `foo' use the calling convention of the first `foo'
 313           prototype it encounters (nor does it complain about conflicting attribute
 314           declarations). The consequence of this is that you cannot override the
 315           calling convention of `foo' using an extern declaration (you'd have to use
 316           a typedef), but why you would want to do such a thing in the first place
 317           is totally beyond me.
 318
 319           ToDo: petition the gcc folks to add code to warn about conflicting attribute
 320           declarations.
 321
 322     -}
 323
 324      fun_nm
 325        | is_tdef   = parens (text (callConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
 326        | otherwise = text (callConvAttribute cconv) <+> ccall_fun_ty
 327
 328      ccall_fun_ty =
 329         case op_str of
 330           Right u -> ptext SLIT("_ccall_fun_ty") <> ppr u
 331           Left x  -> ptext x
 332
 333      ccall_res_ty =
 334        case non_void_results of
 335           []       -> ptext SLIT("void")
 336           [amode]  -> text (showPrimRep (getAmodeRep amode))
 337           _        -> panic "pprAbsC{CCallTypedef}: ccall_res_ty"
 338
 339      ccall_decl_ty_args
 340        | is_tdef   = tail ccall_arg_tys
 341        | otherwise = ccall_arg_tys
 342
 343      ccall_arg_tys      = map (text.showPrimRep.getAmodeRep) non_void_args
 344
 345       -- the first argument will be the "I/O world" token (a VoidRep)
 346       -- all others should be non-void
 347      non_void_args =
 348         let nvas = tail args
 349         in ASSERT (all non_void nvas) nvas
 350
 351       -- there will usually be two results: a (void) state which we
 352       -- should ignore and a (possibly void) result.
 353      non_void_results =
 354         let nvrs = grab_non_void_amodes results
 355         in ASSERT (length nvrs <= 1) nvrs
 356
 357 pprAbsC (CCodeBlock lbl abs_C) _
 358   = if not (maybeToBool(nonemptyAbsC abs_C)) then
 359         pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
 360     else
 361     case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
 362     vcat [
 363         char ' ',
 364         hcat [text (if (externallyVisibleCLabel lbl)
 365                           then "FN_("   -- abbreviations to save on output
 366                           else "IFN_("),
 367                    pprCLabel lbl, text ") {"],
 368
 369         pp_exts, pp_temps,
 370
 371         nest 8 (ptext SLIT("FB_")),
 372         nest 8 (pprAbsC abs_C (costs abs_C)),
 373         nest 8 (ptext SLIT("FE_")),
 374         char '}',
 375         char ' ' ]
 376     }
 377
 378
 379 pprAbsC (CInitHdr cl_info amode cost_centre) _
 380   = hcat [ ptext SLIT("SET_HDR_"), char '(',
 381                 ppr_amode amode, comma,
 382                 pprCLabelAddr info_lbl, comma,
 383                 if_profiling (pprAmode cost_centre),
 384                 pp_paren_semi ]
 385   where
 386     info_lbl    = infoTableLabelFromCI cl_info
 387
 388 pprAbsC stmt@(CStaticClosure closure_lbl cl_info cost_centre amodes) _
 389   = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
 390     vcat [
 391         pp_exts,
 392         hcat [
 393                 ptext SLIT("SET_STATIC_HDR"), char '(',
 394                 pprCLabel closure_lbl,                          comma,
 395                 pprCLabel info_lbl,                             comma,
 396                 if_profiling (pprAmode cost_centre),            comma,
 397                 ppLocalness closure_lbl,                        comma,
 398                 ppLocalnessMacro True{-include dyn-} info_lbl,
 399                 char ')'
 400                 ],
 401         nest 2 (ppr_payload (amodes ++ padding_wds ++ static_link_field)),
 402         ptext SLIT("};") ]
 403     }
 404   where
 405     info_lbl = infoTableLabelFromCI cl_info
 406
 407     ppr_payload [] = empty
 408     ppr_payload ls = comma <+>
 409                      braces (hsep (punctuate comma (map ((text "(L_)" <>).ppr_item) ls)))
 410
 411     ppr_item item
 412       | rep == VoidRep   = text "0" -- might not even need this...
 413       | rep == FloatRep  = ppr_amode (floatToWord item)
 414       | rep == DoubleRep = hcat (punctuate (text ", (L_)")
 415                                  (map ppr_amode (doubleToWords item)))
 416       | otherwise        = ppr_amode item
 417       where
 418         rep = getAmodeRep item
 419
 420     padding_wds =
 421         if not (closureUpdReqd cl_info) then
 422             []
 423         else
 424             case max 0 (mIN_UPD_SIZE - length amodes) of { still_needed ->
 425             nOfThem still_needed (mkIntCLit 0) } -- a bunch of 0s
 426
 427     static_link_field
 428         | staticClosureNeedsLink cl_info = [mkIntCLit 0]
 429         | otherwise                      = []
 430
 431 pprAbsC stmt@(CClosureInfoAndCode cl_info slow maybe_fast cl_descr) _
 432   = vcat [
 433         hcat [
 434              ptext SLIT("INFO_TABLE"),
 435              ( if is_selector then
 436                  ptext SLIT("_SELECTOR")
 437                else if is_constr then
 438                  ptext SLIT("_CONSTR")
 439                else if needs_srt then
 440                  ptext SLIT("_SRT")
 441                else empty ), char '(',
 442
 443             pprCLabel info_lbl,                         comma,
 444             pprCLabel slow_lbl,                         comma,
 445             pp_rest, {- ptrs,nptrs,[srt,]type,-}        comma,
 446
 447             ppLocalness info_lbl,                          comma,
 448             ppLocalnessMacro True{-include dyn-} slow_lbl, comma,
 449
 450             if_profiling pp_descr, comma,
 451             if_profiling pp_type,
 452             text ");"
 453              ],
 454         pp_slow,
 455         case maybe_fast of
 456             Nothing -> empty
 457             Just fast -> let stuff = CCodeBlock fast_lbl fast in
 458                          pprAbsC stuff (costs stuff)
 459     ]
 460   where
 461     info_lbl    = infoTableLabelFromCI cl_info
 462     fast_lbl    = fastLabelFromCI cl_info
 463
 464     (slow_lbl, pp_slow)
 465       = case (nonemptyAbsC slow) of
 466           Nothing -> (mkErrorStdEntryLabel, empty)
 467           Just xx -> (entryLabelFromCI cl_info,
 468                        let stuff = CCodeBlock slow_lbl xx in
 469                        pprAbsC stuff (costs stuff))
 470
 471     maybe_selector = maybeSelectorInfo cl_info
 472     is_selector = maybeToBool maybe_selector
 473     (Just select_word_i) = maybe_selector
 474
 475     maybe_tag = closureSemiTag cl_info
 476     is_constr = maybeToBool maybe_tag
 477     (Just tag) = maybe_tag
 478
 479     needs_srt = infoTblNeedsSRT cl_info
 480     srt = getSRTInfo cl_info
 481
 482     size = closureNonHdrSize cl_info
 483
 484     ptrs        = closurePtrsSize cl_info
 485     nptrs       = size - ptrs
 486
 487     pp_rest | is_selector      = int select_word_i
 488             | otherwise        = hcat [
 489                   int ptrs,             comma,
 490                   int nptrs,            comma,
 491                   if is_constr then
 492                         hcat [ int tag, comma ]
 493                   else if needs_srt then
 494                         pp_srt_info srt
 495                   else empty,
 496                   type_str ]
 497
 498     type_str = pprSMRep (closureSMRep cl_info)
 499
 500     pp_descr = hcat [char '"', text (stringToC cl_descr), char '"']
 501     pp_type  = hcat [char '"', text (stringToC (closureTypeDescr cl_info)), char '"']
 502
 503 pprAbsC stmt@(CClosureTbl tycon) _
 504   = vcat (
 505         ptext SLIT("CLOSURE_TBL") <>
 506            lparen <> pprCLabel (mkClosureTblLabel tycon) <> rparen :
 507         punctuate comma (
 508            map (pp_closure_lbl . mkStaticClosureLabel . getName) (tyConDataCons tycon)
 509         )
 510    ) $$ ptext SLIT("};")
 511
 512 pprAbsC stmt@(CRetDirect uniq code srt liveness) _
 513   = vcat [
 514       hcat [
 515           ptext SLIT("INFO_TABLE_SRT_BITMAP"), lparen,
 516           pprCLabel info_lbl,           comma,
 517           pprCLabel entry_lbl,          comma,
 518           pp_liveness liveness,         comma,    -- bitmap
 519           pp_srt_info srt,                        -- SRT
 520           ptext type_str,               comma,    -- closure type
 521           ppLocalness info_lbl,         comma,    -- info table storage class
 522           ppLocalnessMacro True{-include dyn-} entry_lbl,       comma,    -- entry pt storage class
 523           int 0, comma,
 524           int 0, text ");"
 525       ],
 526       pp_code
 527     ]
 528   where
 529      info_lbl  = mkReturnInfoLabel uniq
 530      entry_lbl = mkReturnPtLabel uniq
 531
 532      pp_code   = let stuff = CCodeBlock entry_lbl code in
 533                  pprAbsC stuff (costs stuff)
 534
 535      type_str = case liveness of
 536                    LvSmall _ -> SLIT("RET_SMALL")
 537                    LvLarge _ -> SLIT("RET_BIG")
 538
 539 pprAbsC stmt@(CRetVector lbl amodes srt liveness) _
 540   = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
 541     vcat [
 542         pp_exts,
 543         hcat [
 544           ptext SLIT("VEC_INFO_") <> int size,
 545           lparen,
 546           pprCLabel lbl, comma,
 547           pp_liveness liveness, comma,  -- bitmap liveness mask
 548           pp_srt_info srt,              -- SRT
 549           ptext type_str, comma,
 550           ppLocalness lbl, comma
 551         ],
 552         nest 2 (sep (punctuate comma (map ppr_item amodes))),
 553         text ");"
 554     ]
 555     }
 556
 557   where
 558     ppr_item item = (<>) (text "(F_) ") (ppr_amode item)
 559     size = length amodes
 560
 561     type_str = case liveness of
 562                    LvSmall _ -> SLIT("RET_VEC_SMALL")
 563                    LvLarge _ -> SLIT("RET_VEC_BIG")
 564
 565
 566 pprAbsC (CCostCentreDecl is_local cc) _ = pprCostCentreDecl is_local cc
 567 pprAbsC (CCostCentreStackDecl ccs)    _ = pprCostCentreStackDecl ccs
 568 \end{code}
 569
 570 \begin{code}
 571 ppLocalness lbl
 572   = if (externallyVisibleCLabel lbl)
 573                 then empty
 574                 else ptext SLIT("static ")
 575
 576 -- Horrible macros for declaring the types and locality of labels (see
 577 -- StgMacros.h).
 578
 579 ppLocalnessMacro include_dyn_prefix clabel =
 580      hcat [
 581         visiblity_prefix,
 582         dyn_prefix,
 583         case label_type of
 584           ClosureType    -> ptext SLIT("C_")
 585           CodeType       -> ptext SLIT("F_")
 586           InfoTblType    -> ptext SLIT("I_")
 587           ClosureTblType -> ptext SLIT("CP_")
 588           DataType       -> ptext SLIT("D_")
 589      ]
 590   where
 591    is_visible = externallyVisibleCLabel clabel
 592    label_type = labelType clabel
 593    is_dynamic = labelDynamic clabel
 594
 595    visiblity_prefix
 596      | is_visible = char 'E'
 597      | otherwise  = char 'I'
 598
 599    dyn_prefix
 600      | not include_dyn_prefix = empty
 601      | is_dynamic             = char 'D'
 602      | otherwise              = empty
 603
 604 \end{code}
 605
 606 \begin{code}
 607 jmp_lit = "JMP_("
 608
 609 grab_non_void_amodes amodes
 610   = filter non_void amodes
 611
 612 non_void amode
 613   = case (getAmodeRep amode) of
 614       VoidRep -> False
 615       k -> True
 616 \end{code}
 617
 618 \begin{code}
 619 ppr_vol_regs :: [MagicId] -> (SDoc, SDoc)
 620
 621 ppr_vol_regs [] = (empty, empty)
 622 ppr_vol_regs (VoidReg:rs) = ppr_vol_regs rs
 623 ppr_vol_regs (r:rs)
 624   = let pp_reg = case r of
 625                     VanillaReg pk n -> pprVanillaReg n
 626                     _ -> pprMagicId r
 627         (more_saves, more_restores) = ppr_vol_regs rs
 628     in
 629     (($$) ((<>) (ptext SLIT("CALLER_SAVE_"))    pp_reg) more_saves,
 630      ($$) ((<>) (ptext SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
 631
 632 -- pp_basic_{saves,restores}: The BaseReg, SpA, SuA, SpB, SuB, Hp and
 633 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
 634 -- depending on the platform.  (The "volatile regs" stuff handles all
 635 -- other registers.)  Just be *sure* BaseReg is OK before trying to do
 636 -- anything else. The correct sequence of saves&restores are
 637 -- encoded by the CALLER_*_SYSTEM macros.
 638 pp_basic_saves
 639   = vcat
 640        [ ptext SLIT("CALLER_SAVE_Base")
 641        , ptext SLIT("CALLER_SAVE_SYSTEM")
 642        ]
 643
 644 pp_basic_restores = ptext SLIT("CALLER_RESTORE_SYSTEM")
 645 \end{code}
 646
 647 \begin{code}
 648 has_srt (_, NoSRT) = False
 649 has_srt _ = True
 650
 651 pp_srt_info srt =
 652     case srt of
 653         (lbl, NoSRT) ->
 654                 hcat [  int 0, comma,
 655                         int 0, comma,
 656                         int 0, comma ]
 657         (lbl, SRT off len) ->
 658                 hcat [  pprCLabel lbl, comma,
 659                         int off, comma,
 660                         int len, comma ]
 661 \end{code}
 662
 663 \begin{code}
 664 pp_closure_lbl lbl
 665       | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
 666       | otherwise        = char '&' <> pprCLabel lbl
 667 \end{code}
 668
 669 \begin{code}
 670 if_profiling pretty
 671   = if  opt_SccProfilingOn
 672     then pretty
 673     else char '0' -- leave it out!
 674 -- ---------------------------------------------------------------------------
 675 -- Changes for GrAnSim:
 676 --  draw costs for computation in head of if into both branches;
 677 --  as no abstractC data structure is given for the head, one is constructed
 678 --  guessing unknown values and fed into the costs function
 679 -- ---------------------------------------------------------------------------
 680
 681 do_if_stmt discrim tag alt_code deflt c
 682   = case tag of
 683       -- This special case happens when testing the result of a comparison.
 684       -- We can just avoid some redundant clutter in the output.
 685       MachInt n _ | n==0 -> ppr_if_stmt (pprAmode discrim)
 686                                       deflt alt_code
 687                                       (addrModeCosts discrim Rhs) c
 688       other              -> let
 689                                cond = hcat [ pprAmode discrim
 690                                            , ptext SLIT(" == ")
 691                                            , tcast
 692                                            , pprAmode (CLit tag)
 693                                            ]
 694                                 -- to be absolutely sure that none of the
 695                                 -- conversion rules hit, e.g.,
 696                                 --
 697                                 --     minInt is different to (int)minInt
 698                                 --
 699                                 -- in C (when minInt is a number not a constant
 700                                 --  expression which evaluates to it.)
 701                                 --
 702                                tcast =
 703                                  case other of
 704                                    MachInt _ signed | signed    -> ptext SLIT("(I_)")
 705                                    _ -> empty
 706                             in
 707                             ppr_if_stmt cond
 708                                          alt_code deflt
 709                                          (addrModeCosts discrim Rhs) c
 710
 711 ppr_if_stmt pp_pred then_part else_part discrim_costs c
 712   = vcat [
 713       hcat [text "if (", pp_pred, text ") {"],
 714       nest 8 (pprAbsC then_part         (c + discrim_costs +
 715                                         (Cost (0, 2, 0, 0, 0)) +
 716                                         costs then_part)),
 717       (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
 718       nest 8 (pprAbsC else_part  (c + discrim_costs +
 719                                         (Cost (0, 1, 0, 0, 0)) +
 720                                         costs else_part)),
 721       char '}' ]
 722     {- Total costs = inherited costs (before if) + costs for accessing discrim
 723                      + costs for cond branch ( = (0, 1, 0, 0, 0) )
 724                      + costs for that alternative
 725     -}
 726 \end{code}
 727
 728 Historical note: this used to be two separate cases -- one for `ccall'
 729 and one for `casm'.  To get round a potential limitation to only 10
 730 arguments, the numbering of arguments in @process_casm@ was beefed up a
 731 bit. ADR
 732
 733 Some rough notes on generating code for @CCallOp@:
 734
 735 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
 736 2) Save any essential registers (heap, stack, etc).
 737
 738    ToDo: If stable pointers are in use, these must be saved in a place
 739    where the runtime system can get at them so that the Stg world can
 740    be restarted during the call.
 741
 742 3) Save any temporary registers that are currently in use.
 743 4) Do the call, putting result into a local variable
 744 5) Restore essential registers
 745 6) Restore temporaries
 746
 747    (This happens after restoration of essential registers because we
 748    might need the @Base@ register to access all the others correctly.)
 749
 750    Otherwise, copy local variable into result register.
 751
 752 8) If ccall (not casm), declare the function being called as extern so
 753    that C knows if it returns anything other than an int.
 754
 755 \begin{pseudocode}
 756 { ResultType _ccall_result;
 757   basic_saves;
 758   saves;
 759   _ccall_result = f( args );
 760   basic_restores;
 761   restores;
 762
 763   return_reg = _ccall_result;
 764 }
 765 \end{pseudocode}
 766
 767 Amendment to the above: if we can GC, we have to:
 768
 769 * make sure we save all our registers away where the garbage collector
 770   can get at them.
 771 * be sure that there are no live registers or we're in trouble.
 772   (This can cause problems if you try something foolish like passing
 773    an array or a foreign obj to a _ccall_GC_ thing.)
 774 * increment/decrement the @inCCallGC@ counter before/after the call so
 775   that the runtime check that PerformGC is being used sensibly will work.
 776
 777 \begin{code}
 778 pprCCall op@(CCallOp op_str is_asm may_gc cconv) args results vol_regs
 779   = vcat [
 780       char '{',
 781       declare_local_vars,   -- local var for *result*
 782       vcat local_arg_decls,
 783       pp_save_context,
 784         process_casm local_vars pp_non_void_args casm_str,
 785       pp_restore_context,
 786       assign_results,
 787       char '}'
 788     ]
 789   where
 790     (pp_saves, pp_restores) = ppr_vol_regs vol_regs
 791     (pp_save_context, pp_restore_context)
 792         | may_gc  = ( text "{ I_ id; SUSPEND_THREAD(id);"
 793                     , text "RESUME_THREAD(id);}"
 794                     )
 795         | otherwise = ( pp_basic_saves $$ pp_saves,
 796                         pp_basic_restores $$ pp_restores)
 797
 798     non_void_args =
 799         let nvas = tail args
 800         in ASSERT (all non_void nvas) nvas
 801     -- the first argument will be the "I/O world" token (a VoidRep)
 802     -- all others should be non-void
 803
 804     non_void_results =
 805         let nvrs = grab_non_void_amodes results
 806         in ASSERT (length nvrs <= 1) nvrs
 807     -- there will usually be two results: a (void) state which we
 808     -- should ignore and a (possibly void) result.
 809
 810     (local_arg_decls, pp_non_void_args)
 811       = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
 812
 813     ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
 814
 815     ccall_res_ty =
 816        case non_void_results of
 817           []       -> ptext SLIT("void")
 818           [amode]  -> text (showPrimRep (getAmodeRep amode))
 819           _        -> panic "pprCCall: ccall_res_ty"
 820
 821     ccall_fun_ty =
 822        ptext SLIT("_ccall_fun_ty") <>
 823        case op_str of
 824          Right u -> ppr u
 825          _       -> empty
 826
 827     (declare_local_vars, local_vars, assign_results)
 828       = ppr_casm_results non_void_results
 829
 830     (Left asm_str) = op_str
 831     is_dynamic =
 832        case op_str of
 833          Left _ -> False
 834          _      -> True
 835
 836     casm_str = if is_asm then _UNPK_ asm_str else ccall_str
 837
 838     -- Remainder only used for ccall
 839
 840     fun_name
 841       | is_dynamic = parens (parens (ccall_fun_ty) <> text "%0")
 842       | otherwise  = ptext asm_str
 843
 844     ccall_str = showSDoc
 845         (hcat [
 846                 if null non_void_results
 847                   then empty
 848                   else text "%r = ",
 849                 lparen, fun_name, lparen,
 850                   hcat (punctuate comma ccall_fun_args),
 851                 text "));"
 852         ])
 853
 854     ccall_fun_args
 855      | is_dynamic = tail ccall_args
 856      | otherwise  = ccall_args
 857
 858     ccall_args    = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
 859
 860 \end{code}
 861
 862 If the argument is a heap object, we need to reach inside and pull out
 863 the bit the C world wants to see.  The only heap objects which can be
 864 passed are @Array@s and @ByteArray@s.
 865
 866 \begin{code}
 867 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
 868     -- (a) decl and assignment, (b) local var to be used later
 869
 870 ppr_casm_arg amode a_num
 871   = let
 872         a_kind   = getAmodeRep amode
 873         pp_amode = pprAmode amode
 874         pp_kind  = pprPrimKind a_kind
 875
 876         local_var  = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
 877
 878         (arg_type, pp_amode2)
 879           = case a_kind of
 880
 881               -- for array arguments, pass a pointer to the body of the array
 882               -- (PTRS_ARR_CTS skips over all the header nonsense)
 883               ArrayRep      -> (pp_kind,
 884                                 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
 885               ByteArrayRep -> (pp_kind,
 886                                 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
 887
 888               -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
 889               ForeignObjRep -> (pp_kind,
 890                                 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
 891                                       char '(', pp_amode, char ')'])
 892
 893               other         -> (pp_kind, pp_amode)
 894
 895         declare_local_var
 896           = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
 897     in
 898     (declare_local_var, local_var)
 899 \end{code}
 900
 901 For l-values, the critical questions are:
 902
 903 1) Are there any results at all?
 904
 905    We only allow zero or one results.
 906
 907 \begin{code}
 908 ppr_casm_results
 909         :: [CAddrMode]  -- list of results (length <= 1)
 910         ->
 911         ( SDoc,         -- declaration of any local vars
 912           [SDoc],       -- list of result vars (same length as results)
 913           SDoc )        -- assignment (if any) of results in local var to registers
 914
 915 ppr_casm_results []
 916   = (empty, [], empty)  -- no results
 917
 918 ppr_casm_results [r]
 919   = let
 920         result_reg = ppr_amode r
 921         r_kind     = getAmodeRep r
 922
 923         local_var  = ptext SLIT("_ccall_result")
 924
 925         (result_type, assign_result)
 926           = (pprPrimKind r_kind,
 927              hcat [ result_reg, equals, local_var, semi ])
 928
 929         declare_local_var = hcat [ result_type, space, local_var, semi ]
 930     in
 931     (declare_local_var, [local_var], assign_result)
 932
 933 ppr_casm_results rs
 934   = panic "ppr_casm_results: ccall/casm with many results"
 935 \end{code}
 936
 937
 938 Note the sneaky way _the_ result is represented by a list so that we
 939 can complain if it's used twice.
 940
 941 ToDo: Any chance of giving line numbers when process-casm fails?
 942       Or maybe we should do a check _much earlier_ in compiler. ADR
 943
 944 \begin{code}
 945 process_casm :: [SDoc]          -- results (length <= 1)
 946              -> [SDoc]          -- arguments
 947              -> String          -- format string (with embedded %'s)
 948              -> SDoc            -- code being generated
 949
 950 process_casm results args string = process results args string
 951  where
 952   process []    _ "" = empty
 953   process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
 954                               string ++
 955                               "\"\n(Try changing result type to PrimIO ()\n")
 956
 957   process ress args ('%':cs)
 958     = case cs of
 959         [] ->
 960             error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
 961
 962         ('%':css) ->
 963             char '%' <> process ress args css
 964
 965         ('r':css)  ->
 966           case ress of
 967             []  -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
 968             [r] -> r <> (process [] args css)
 969             _   -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
 970
 971         other ->
 972           let
 973                 read_int :: ReadS Int
 974                 read_int = reads
 975           in
 976           case (read_int other) of
 977             [(num,css)] ->
 978                   if 0 <= num && num < length args
 979                   then parens (args !! num) <> process ress args css
 980                   else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
 981             _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
 982
 983   process ress args (other_c:cs)
 984     = char other_c <> process ress args cs
 985 \end{code}
 986
 987 %************************************************************************
 988 %*                                                                      *
 989 \subsection[a2r-assignments]{Assignments}
 990 %*                                                                      *
 991 %************************************************************************
 992
 993 Printing assignments is a little tricky because of type coercion.
 994
 995 First of all, the kind of the thing being assigned can be gotten from
 996 the destination addressing mode.  (It should be the same as the kind
 997 of the source addressing mode.)  If the kind of the assignment is of
 998 @VoidRep@, then don't generate any code at all.
 999
1000 \begin{code}
1001 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
1002
1003 pprAssign VoidRep dest src = empty
1004 \end{code}
1005
1006 Special treatment for floats and doubles, to avoid unwanted conversions.
1007
1008 \begin{code}
1009 pprAssign FloatRep dest@(CVal reg_rel _) src
1010   = hcat [ ptext SLIT("ASSIGN_FLT"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1011
1012 pprAssign DoubleRep dest@(CVal reg_rel _) src
1013   = hcat [ ptext SLIT("ASSIGN_DBL"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1014
1015 pprAssign Int64Rep dest@(CVal reg_rel _) src
1016   = hcat [ ptext SLIT("ASSIGN_Int64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1017 pprAssign Word64Rep dest@(CVal reg_rel _) src
1018   = hcat [ ptext SLIT("ASSIGN_Word64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1019 \end{code}
1020
1021 Lastly, the question is: will the C compiler think the types of the
1022 two sides of the assignment match?
1023
1024         We assume that the types will match if neither side is a
1025         @CVal@ addressing mode for any register which can point into
1026         the heap or stack.
1027
1028 Why?  Because the heap and stack are used to store miscellaneous
1029 things, whereas the temporaries, registers, etc., are only used for
1030 things of fixed type.
1031
1032 \begin{code}
1033 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1034   = hcat [ pprVanillaReg dest, equals,
1035                 pprVanillaReg src, semi ]
1036
1037 pprAssign kind dest src
1038   | mixedTypeLocn dest
1039     -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1040   = hcat [ ppr_amode dest, equals,
1041                 text "(W_)(",   -- Here is the cast
1042                 ppr_amode src, pp_paren_semi ]
1043
1044 pprAssign kind dest src
1045   | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1046     -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1047   = hcat [ ppr_amode dest, equals,
1048                 text "(P_)(",   -- Here is the cast
1049                 ppr_amode src, pp_paren_semi ]
1050
1051 pprAssign ByteArrayRep dest src
1052   | mixedPtrLocn src
1053     -- Add in a cast iff the source is mixed
1054   = hcat [ ppr_amode dest, equals,
1055                 text "(StgByteArray)(", -- Here is the cast
1056                 ppr_amode src, pp_paren_semi ]
1057
1058 pprAssign kind other_dest src
1059   = hcat [ ppr_amode other_dest, equals,
1060                 pprAmode  src, semi ]
1061 \end{code}
1062
1063
1064 %************************************************************************
1065 %*                                                                      *
1066 \subsection[a2r-CAddrModes]{Addressing modes}
1067 %*                                                                      *
1068 %************************************************************************
1069
1070 @pprAmode@ is used to print r-values (which may need casts), whereas
1071 @ppr_amode@ is used for l-values {\em and} as a help function for
1072 @pprAmode@.
1073
1074 \begin{code}
1075 pprAmode, ppr_amode :: CAddrMode -> SDoc
1076 \end{code}
1077
1078 For reasons discussed above under assignments, @CVal@ modes need
1079 to be treated carefully.  First come special cases for floats and doubles,
1080 similar to those in @pprAssign@:
1081
1082 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1083 question.)
1084
1085 \begin{code}
1086 pprAmode (CVal reg_rel FloatRep)
1087   = hcat [ text "PK_FLT(", ppr_amode (CAddr reg_rel), rparen ]
1088 pprAmode (CVal reg_rel DoubleRep)
1089   = hcat [ text "PK_DBL(", ppr_amode (CAddr reg_rel), rparen ]
1090 pprAmode (CVal reg_rel Int64Rep)
1091   = hcat [ text "PK_Int64(", ppr_amode (CAddr reg_rel), rparen ]
1092 pprAmode (CVal reg_rel Word64Rep)
1093   = hcat [ text "PK_Word64(", ppr_amode (CAddr reg_rel), rparen ]
1094 \end{code}
1095
1096 Next comes the case where there is some other cast need, and the
1097 no-cast case:
1098
1099 \begin{code}
1100 pprAmode amode
1101   | mixedTypeLocn amode
1102   = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1103                 ppr_amode amode ])
1104   | otherwise   -- No cast needed
1105   = ppr_amode amode
1106 \end{code}
1107
1108 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1109
1110 \begin{code}
1111 ppr_amode (CVal reg_rel _)
1112   = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1113         (pp_reg, Nothing)     -> (<>)  (char '*') pp_reg
1114         (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1115
1116 ppr_amode (CAddr reg_rel)
1117   = case (pprRegRelative True{-sign wanted-} reg_rel) of
1118         (pp_reg, Nothing)     -> pp_reg
1119         (pp_reg, Just offset) -> (<>) pp_reg offset
1120
1121 ppr_amode (CReg magic_id) = pprMagicId magic_id
1122
1123 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1124
1125 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1126
1127 ppr_amode (CCharLike ch)
1128   = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1129 ppr_amode (CIntLike int)
1130   = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1131
1132 ppr_amode (CLit lit) = pprBasicLit lit
1133
1134 ppr_amode (CLitLit str _) = ptext str
1135
1136 ppr_amode (CJoinPoint _)
1137   = panic "ppr_amode: CJoinPoint"
1138
1139 ppr_amode (CMacroExpr pk macro as)
1140   = parens (pprPrimKind pk) <>
1141     parens (ptext (cExprMacroText macro) <>
1142             parens (hcat (punctuate comma (map pprAmode as))))
1143 \end{code}
1144
1145 \begin{code}
1146 cExprMacroText ENTRY_CODE               = SLIT("ENTRY_CODE")
1147 cExprMacroText ARG_TAG                  = SLIT("ARG_TAG")
1148 cExprMacroText GET_TAG                  = SLIT("GET_TAG")
1149 cExprMacroText UPD_FRAME_UPDATEE        = SLIT("UPD_FRAME_UPDATEE")
1150
1151 cStmtMacroText ARGS_CHK                 = SLIT("ARGS_CHK")
1152 cStmtMacroText ARGS_CHK_LOAD_NODE       = SLIT("ARGS_CHK_LOAD_NODE")
1153 cStmtMacroText UPD_CAF                  = SLIT("UPD_CAF")
1154 cStmtMacroText UPD_BH_UPDATABLE         = SLIT("UPD_BH_UPDATABLE")
1155 cStmtMacroText UPD_BH_SINGLE_ENTRY      = SLIT("UPD_BH_SINGLE_ENTRY")
1156 cStmtMacroText PUSH_UPD_FRAME           = SLIT("PUSH_UPD_FRAME")
1157 cStmtMacroText PUSH_SEQ_FRAME           = SLIT("PUSH_SEQ_FRAME")
1158 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1159 cStmtMacroText SET_TAG                  = SLIT("SET_TAG")
1160 cStmtMacroText GRAN_FETCH               = SLIT("GRAN_FETCH")
1161 cStmtMacroText GRAN_RESCHEDULE          = SLIT("GRAN_RESCHEDULE")
1162 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1163 cStmtMacroText THREAD_CONTEXT_SWITCH    = SLIT("THREAD_CONTEXT_SWITCH")
1164 cStmtMacroText GRAN_YIELD               = SLIT("GRAN_YIELD")
1165
1166 cCheckMacroText HP_CHK_NP               = SLIT("HP_CHK_NP")
1167 cCheckMacroText STK_CHK_NP              = SLIT("STK_CHK_NP")
1168 cCheckMacroText HP_STK_CHK_NP           = SLIT("HP_STK_CHK_NP")
1169 cCheckMacroText HP_CHK_SEQ_NP           = SLIT("HP_CHK_SEQ_NP")
1170 cCheckMacroText HP_CHK                  = SLIT("HP_CHK")
1171 cCheckMacroText STK_CHK                 = SLIT("STK_CHK")
1172 cCheckMacroText HP_STK_CHK              = SLIT("HP_STK_CHK")
1173 cCheckMacroText HP_CHK_NOREGS           = SLIT("HP_CHK_NOREGS")
1174 cCheckMacroText HP_CHK_UNPT_R1          = SLIT("HP_CHK_UNPT_R1")
1175 cCheckMacroText HP_CHK_UNBX_R1          = SLIT("HP_CHK_UNBX_R1")
1176 cCheckMacroText HP_CHK_F1               = SLIT("HP_CHK_F1")
1177 cCheckMacroText HP_CHK_D1               = SLIT("HP_CHK_D1")
1178 cCheckMacroText HP_CHK_L1               = SLIT("HP_CHK_L1")
1179 cCheckMacroText HP_CHK_UT_ALT           = SLIT("HP_CHK_UT_ALT")
1180 cCheckMacroText HP_CHK_GEN              = SLIT("HP_CHK_GEN")
1181 \end{code}
1182
1183 %************************************************************************
1184 %*                                                                      *
1185 \subsection[ppr-liveness-masks]{Liveness Masks}
1186 %*                                                                      *
1187 %************************************************************************
1188
1189 \begin{code}
1190 pp_liveness :: Liveness -> SDoc
1191 pp_liveness lv =
1192    case lv of
1193         LvLarge lbl  -> char '&' <> pprCLabel lbl
1194         LvSmall mask
1195            | bitmap_int == (minBound :: Int) -> int (bitmap_int+1) <> text "-1"
1196            | otherwise -> int bitmap_int
1197          where
1198            bitmap_int = intBS mask
1199 \end{code}
1200
1201 %************************************************************************
1202 %*                                                                      *
1203 \subsection[a2r-MagicIds]{Magic ids}
1204 %*                                                                      *
1205 %************************************************************************
1206
1207 @pprRegRelative@ returns a pair of the @Doc@ for the register
1208 (some casting may be required), and a @Maybe Doc@ for the offset
1209 (zero offset gives a @Nothing@).
1210
1211 \begin{code}
1212 addPlusSign :: Bool -> SDoc -> SDoc
1213 addPlusSign False p = p
1214 addPlusSign True  p = (<>) (char '+') p
1215
1216 pprSignedInt :: Bool -> Int -> Maybe SDoc       -- Nothing => 0
1217 pprSignedInt sign_wanted n
1218  = if n == 0 then Nothing else
1219    if n > 0  then Just (addPlusSign sign_wanted (int n))
1220    else           Just (int n)
1221
1222 pprRegRelative :: Bool          -- True <=> Print leading plus sign (if +ve)
1223                -> RegRelative
1224                -> (SDoc, Maybe SDoc)
1225
1226 pprRegRelative sign_wanted (SpRel off)
1227   = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1228
1229 pprRegRelative sign_wanted r@(HpRel o)
1230   = let pp_Hp    = pprMagicId Hp; off = I# o
1231     in
1232     if off == 0 then
1233         (pp_Hp, Nothing)
1234     else
1235         (pp_Hp, Just ((<>) (char '-') (int off)))
1236
1237 pprRegRelative sign_wanted (NodeRel o)
1238   = let pp_Node = pprMagicId node; off = I# o
1239     in
1240     if off == 0 then
1241         (pp_Node, Nothing)
1242     else
1243         (pp_Node, Just (addPlusSign sign_wanted (int off)))
1244
1245 pprRegRelative sign_wanted (CIndex base offset kind)
1246   = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1247     , Just (hcat [if sign_wanted then char '+' else empty,
1248             text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1249     )
1250 \end{code}
1251
1252 @pprMagicId@ just prints the register name.  @VanillaReg@ registers are
1253 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1254 to select the union tag.
1255
1256 \begin{code}
1257 pprMagicId :: MagicId -> SDoc
1258
1259 pprMagicId BaseReg                  = ptext SLIT("BaseReg")
1260 pprMagicId (VanillaReg pk n)
1261                                     = hcat [ pprVanillaReg n, char '.',
1262                                                   pprUnionTag pk ]
1263 pprMagicId (FloatReg  n)            = (<>) (ptext SLIT("F")) (int IBOX(n))
1264 pprMagicId (DoubleReg n)            = (<>) (ptext SLIT("D")) (int IBOX(n))
1265 pprMagicId (LongReg _ n)            = (<>) (ptext SLIT("L")) (int IBOX(n))
1266 pprMagicId Sp                       = ptext SLIT("Sp")
1267 pprMagicId Su                       = ptext SLIT("Su")
1268 pprMagicId SpLim                    = ptext SLIT("SpLim")
1269 pprMagicId Hp                       = ptext SLIT("Hp")
1270 pprMagicId HpLim                    = ptext SLIT("HpLim")
1271 pprMagicId CurCostCentre            = ptext SLIT("CCCS")
1272 pprMagicId VoidReg                  = panic "pprMagicId:VoidReg!"
1273
1274 pprVanillaReg :: FAST_INT -> SDoc
1275 pprVanillaReg n = (<>) (char 'R') (int IBOX(n))
1276
1277 pprUnionTag :: PrimRep -> SDoc
1278
1279 pprUnionTag PtrRep              = char 'p'
1280 pprUnionTag CodePtrRep          = ptext SLIT("fp")
1281 pprUnionTag DataPtrRep          = char 'd'
1282 pprUnionTag RetRep              = char 'p'
1283 pprUnionTag CostCentreRep       = panic "pprUnionTag:CostCentre?"
1284
1285 pprUnionTag CharRep             = char 'c'
1286 pprUnionTag IntRep              = char 'i'
1287 pprUnionTag WordRep             = char 'w'
1288 pprUnionTag AddrRep             = char 'a'
1289 pprUnionTag FloatRep            = char 'f'
1290 pprUnionTag DoubleRep           = panic "pprUnionTag:Double?"
1291
1292 pprUnionTag StablePtrRep        = char 'i'
1293 pprUnionTag StableNameRep       = char 'p'
1294 pprUnionTag WeakPtrRep          = char 'p'
1295 pprUnionTag ForeignObjRep       = char 'p'
1296
1297 pprUnionTag ThreadIdRep         = char 't'
1298
1299 pprUnionTag ArrayRep            = char 'p'
1300 pprUnionTag ByteArrayRep        = char 'b'
1301
1302 pprUnionTag _                   = panic "pprUnionTag:Odd kind"
1303 \end{code}
1304
1305
1306 Find and print local and external declarations for a list of
1307 Abstract~C statements.
1308 \begin{code}
1309 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1310 pprTempAndExternDecls AbsCNop = (empty, empty)
1311
1312 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1313   = initTE (ppr_decls_AbsC stmt1        `thenTE` \ (t_p1, e_p1) ->
1314             ppr_decls_AbsC stmt2        `thenTE` \ (t_p2, e_p2) ->
1315             case (catMaybes [t_p1, t_p2])        of { real_temps ->
1316             case (catMaybes [e_p1, e_p2])        of { real_exts ->
1317             returnTE (vcat real_temps, vcat real_exts) }}
1318            )
1319
1320 pprTempAndExternDecls other_stmt
1321   = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1322             returnTE (
1323                 case maybe_t of
1324                   Nothing -> empty
1325                   Just pp -> pp,
1326
1327                 case maybe_e of
1328                   Nothing -> empty
1329                   Just pp -> pp )
1330            )
1331
1332 pprBasicLit :: Literal -> SDoc
1333 pprPrimKind :: PrimRep -> SDoc
1334
1335 pprBasicLit  lit = ppr lit
1336 pprPrimKind  k   = ppr k
1337 \end{code}
1338
1339
1340 %************************************************************************
1341 %*                                                                      *
1342 \subsection[a2r-monad]{Monadery}
1343 %*                                                                      *
1344 %************************************************************************
1345
1346 We need some monadery to keep track of temps and externs we have already
1347 printed.  This info must be threaded right through the Abstract~C, so
1348 it's most convenient to hide it in this monad.
1349
1350 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1351 \tr{(UniqSet, CLabelSet)}.  Allegedly for efficiency.
1352
1353 \begin{code}
1354 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1355 emptyCLabelSet = emptyFM
1356 x `elementOfCLabelSet` labs
1357   = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1358
1359 addToCLabelSet set x = addToFM set x ()
1360
1361 type TEenv = (UniqSet Unique, CLabelSet)
1362
1363 type TeM result =  TEenv -> (TEenv, result)
1364
1365 initTE :: TeM a -> a
1366 initTE sa
1367   = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1368     result }
1369
1370 {-# INLINE thenTE #-}
1371 {-# INLINE returnTE #-}
1372
1373 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1374 thenTE a b u
1375   = case a u        of { (u_1, result_of_a) ->
1376     b result_of_a u_1 }
1377
1378 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1379 mapTE f []     = returnTE []
1380 mapTE f (x:xs)
1381   = f x         `thenTE` \ r  ->
1382     mapTE f xs  `thenTE` \ rs ->
1383     returnTE (r : rs)
1384
1385 returnTE :: a -> TeM a
1386 returnTE result env = (env, result)
1387
1388 -- these next two check whether the thing is already
1389 -- recorded, and THEN THEY RECORD IT
1390 -- (subsequent calls will return False for the same uniq/label)
1391
1392 tempSeenTE :: Unique -> TeM Bool
1393 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1394   = if (uniq `elementOfUniqSet` seen_uniqs)
1395     then (env, True)
1396     else ((addOneToUniqSet seen_uniqs uniq,
1397           seen_labels),
1398           False)
1399
1400 labelSeenTE :: CLabel -> TeM Bool
1401 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1402   = if (lbl `elementOfCLabelSet` seen_labels)
1403     then (env, True)
1404     else ((seen_uniqs,
1405           addToCLabelSet seen_labels lbl),
1406           False)
1407 \end{code}
1408
1409 \begin{code}
1410 pprTempDecl :: Unique -> PrimRep -> SDoc
1411 pprTempDecl uniq kind
1412   = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1413
1414 pprExternDecl :: Bool -> CLabel -> SDoc
1415 pprExternDecl in_srt clabel
1416   | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1417   | otherwise               =
1418         hcat [ ppLocalnessMacro (not in_srt) clabel,
1419                lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1420  where
1421   dyn_wrapper d
1422     | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1423     | otherwise                     = d
1424
1425 \end{code}
1426
1427 \begin{code}
1428 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1429
1430 ppr_decls_AbsC AbsCNop          = returnTE (Nothing, Nothing)
1431
1432 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1433   = ppr_decls_AbsC stmts_1  `thenTE` \ p1 ->
1434     ppr_decls_AbsC stmts_2  `thenTE` \ p2 ->
1435     returnTE (maybe_vcat [p1, p2])
1436
1437 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1438
1439 ppr_decls_AbsC (CAssign dest source)
1440   = ppr_decls_Amode dest    `thenTE` \ p1 ->
1441     ppr_decls_Amode source  `thenTE` \ p2 ->
1442     returnTE (maybe_vcat [p1, p2])
1443
1444 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1445
1446 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1447
1448 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1449
1450 ppr_decls_AbsC (CSwitch discrim alts deflt)
1451   = ppr_decls_Amode discrim     `thenTE` \ pdisc ->
1452     mapTE ppr_alt_stuff alts    `thenTE` \ palts  ->
1453     ppr_decls_AbsC deflt        `thenTE` \ pdeflt ->
1454     returnTE (maybe_vcat (pdisc:pdeflt:palts))
1455   where
1456     ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1457
1458 ppr_decls_AbsC (CCodeBlock lbl absC)
1459   = ppr_decls_AbsC absC
1460
1461 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre)
1462         -- ToDo: strictly speaking, should chk "cost_centre" amode
1463   = labelSeenTE info_lbl     `thenTE` \  label_seen ->
1464     returnTE (Nothing,
1465               if label_seen then
1466                   Nothing
1467               else
1468                   Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1469   where
1470     info_lbl = infoTableLabelFromCI cl_info
1471
1472 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1473 ppr_decls_AbsC (CSimultaneous abc)          = ppr_decls_AbsC abc
1474
1475 ppr_decls_AbsC (CCheck              _ amodes code) =
1476      ppr_decls_Amodes amodes `thenTE` \p1 ->
1477      ppr_decls_AbsC code     `thenTE` \p2 ->
1478      returnTE (maybe_vcat [p1,p2])
1479
1480 ppr_decls_AbsC (CMacroStmt          _ amodes)   = ppr_decls_Amodes amodes
1481
1482 ppr_decls_AbsC (CCallProfCtrMacro   _ amodes)   = ppr_decls_Amodes [] -- *****!!!
1483   -- you get some nasty re-decls of stdio.h if you compile
1484   -- the prelude while looking inside those amodes;
1485   -- no real reason to, anyway.
1486 ppr_decls_AbsC (CCallProfCCMacro    _ amodes)   = ppr_decls_Amodes amodes
1487
1488 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1489         -- ToDo: strictly speaking, should chk "cost_centre" amode
1490   = ppr_decls_Amodes amodes
1491
1492 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1493   = ppr_decls_Amodes [entry_lbl]                `thenTE` \ p1 ->
1494     ppr_decls_AbsC slow                         `thenTE` \ p2 ->
1495     (case maybe_fast of
1496         Nothing   -> returnTE (Nothing, Nothing)
1497         Just fast -> ppr_decls_AbsC fast)       `thenTE` \ p3 ->
1498     returnTE (maybe_vcat [p1, p2, p3])
1499   where
1500     entry_lbl = CLbl slow_lbl CodePtrRep
1501     slow_lbl    = case (nonemptyAbsC slow) of
1502                     Nothing -> mkErrorStdEntryLabel
1503                     Just _  -> entryLabelFromCI cl_info
1504
1505 ppr_decls_AbsC (CSRT lbl closure_lbls)
1506   = mapTE labelSeenTE closure_lbls              `thenTE` \ seen ->
1507     returnTE (Nothing,
1508               if and seen then Nothing
1509                 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1510                                 | (l,False) <- zip closure_lbls seen ]))
1511
1512 ppr_decls_AbsC (CRetDirect     _ code _ _)   = ppr_decls_AbsC code
1513 ppr_decls_AbsC (CRetVector _ amodes _ _)     = ppr_decls_Amodes amodes
1514 \end{code}
1515
1516 \begin{code}
1517 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1518 ppr_decls_Amode (CVal  (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1519 ppr_decls_Amode (CAddr (CIndex base offset _))   = ppr_decls_Amodes [base,offset]
1520 ppr_decls_Amode (CVal _ _)      = returnTE (Nothing, Nothing)
1521 ppr_decls_Amode (CAddr _)       = returnTE (Nothing, Nothing)
1522 ppr_decls_Amode (CReg _)        = returnTE (Nothing, Nothing)
1523 ppr_decls_Amode (CLit _)        = returnTE (Nothing, Nothing)
1524 ppr_decls_Amode (CLitLit _ _)   = returnTE (Nothing, Nothing)
1525
1526 -- CIntLike must be a literal -- no decls
1527 ppr_decls_Amode (CIntLike int)  = returnTE (Nothing, Nothing)
1528
1529 -- CCharLike may have be arbitrary value -- may have decls
1530 ppr_decls_Amode (CCharLike char)
1531   = ppr_decls_Amode char
1532
1533 -- now, the only place where we actually print temps/externs...
1534 ppr_decls_Amode (CTemp uniq kind)
1535   = case kind of
1536       VoidRep -> returnTE (Nothing, Nothing)
1537       other ->
1538         tempSeenTE uniq `thenTE` \ temp_seen ->
1539         returnTE
1540           (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1541
1542 ppr_decls_Amode (CLbl lbl VoidRep)
1543   = returnTE (Nothing, Nothing)
1544
1545 ppr_decls_Amode (CLbl lbl kind)
1546   = labelSeenTE lbl `thenTE` \ label_seen ->
1547     returnTE (Nothing,
1548               if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1549
1550 ppr_decls_Amode (CMacroExpr _ _ amodes)
1551   = ppr_decls_Amodes amodes
1552
1553 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1554
1555
1556 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1557 maybe_vcat ps
1558   = case (unzip ps)     of { (ts, es) ->
1559     case (catMaybes ts) of { real_ts  ->
1560     case (catMaybes es) of { real_es  ->
1561     (if (null real_ts) then Nothing else Just (vcat real_ts),
1562      if (null real_es) then Nothing else Just (vcat real_es))
1563     } } }
1564 \end{code}
1565
1566 \begin{code}
1567 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1568 ppr_decls_Amodes amodes
1569   = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1570     returnTE ( maybe_vcat ps )
1571 \end{code}
1572
1573 Print out a C Label where you want the *address* of the label, not the
1574 object it refers to.  The distinction is important when the label may
1575 refer to a C structure (info tables and closures, for instance).
1576
1577 When just generating a declaration for the label, use pprCLabel.
1578
1579 \begin{code}
1580 pprCLabelAddr :: CLabel -> SDoc
1581 pprCLabelAddr clabel =
1582   case labelType clabel of
1583      InfoTblType -> addr_of_label
1584      ClosureType -> addr_of_label
1585      VecTblType  -> addr_of_label
1586      _           -> pp_label
1587   where
1588     addr_of_label = ptext SLIT("(P_)&") <> pp_label
1589     pp_label = pprCLabel clabel
1590
1591 \end{code}
1592
1593 -----------------------------------------------------------------------------
1594 Initialising static objects with floating-point numbers.  We can't
1595 just emit the floating point number, because C will cast it to an int
1596 by rounding it.  We want the actual bit-representation of the float.
1597
1598 This is a hack to turn the floating point numbers into ints that we
1599 can safely initialise to static locations.
1600
1601 \begin{code}
1602 big_doubles = (getPrimRepSize DoubleRep) /= 1
1603
1604 -- floatss are always 1 word
1605 floatToWord :: CAddrMode -> CAddrMode
1606 floatToWord (CLit (MachFloat r))
1607   = runST (do
1608         arr <- newFloatArray ((0::Int),0)
1609         writeFloatArray arr 0 (fromRational r)
1610         i <- readIntArray arr 0
1611         return (CLit (MachInt (toInteger i) True))
1612     )
1613
1614 doubleToWords :: CAddrMode -> [CAddrMode]
1615 doubleToWords (CLit (MachDouble r))
1616   | big_doubles                         -- doubles are 2 words
1617   = runST (do
1618         arr <- newDoubleArray ((0::Int),1)
1619         writeDoubleArray arr 0 (fromRational r)
1620         i1 <- readIntArray arr 0
1621         i2 <- readIntArray arr 1
1622         return [ CLit (MachInt (toInteger i1) True)
1623                , CLit (MachInt (toInteger i2) True)
1624                ]
1625     )
1626   | otherwise                           -- doubles are 1 word
1627   = runST (do
1628         arr <- newDoubleArray ((0::Int),0)
1629         writeDoubleArray arr 0 (fromRational r)
1630         i <- readIntArray arr 0
1631         return [ CLit (MachInt (toInteger i) True) ]
1632     )
1633 \end{code}