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