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