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