ghc/compiler/codeGen/CgTailCall.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 % $Id: CgTailCall.lhs,v 1.17 1998/12/18 17:40:53 simonpj Exp $
   5 %
   6 %********************************************************
   7 %*                                                      *
   8 \section[CgTailCall]{Tail calls: converting @StgApps@}
   9 %*                                                      *
  10 %********************************************************
  11
  12 \begin{code}
  13 module CgTailCall (
  14         cgTailCall,
  15         performReturn, performPrimReturn,
  16         mkStaticAlgReturnCode, mkDynamicAlgReturnCode,
  17         mkUnboxedTupleReturnCode, returnUnboxedTuple,
  18         mkPrimReturnCode,
  19
  20         tailCallFun,
  21         tailCallPrimOp,
  22         doTailCall,
  23
  24         pushReturnAddress
  25     ) where
  26
  27 #include "HsVersions.h"
  28
  29 import CgMonad
  30 import AbsCSyn
  31
  32 import AbsCUtils        ( mkAbstractCs, mkAbsCStmts, getAmodeRep )
  33 import CgBindery        ( getArgAmodes, getCAddrMode, getCAddrModeAndInfo )
  34 import CgRetConv        ( dataReturnConvPrim,
  35                           ctrlReturnConvAlg, CtrlReturnConvention(..),
  36                           assignAllRegs, assignRegs
  37                         )
  38 import CgStackery       ( adjustRealSp, mkTaggedStkAmodes, adjustStackHW )
  39 import CgUsages         ( getSpRelOffset )
  40 import CgUpdate         ( pushSeqFrame )
  41 import CLabel           ( mkUpdEntryLabel, mkRtsPrimOpLabel )
  42 import ClosureInfo      ( nodeMustPointToIt,
  43                           getEntryConvention, EntryConvention(..),
  44                           LambdaFormInfo
  45                         )
  46 import CmdLineOpts      ( opt_DoSemiTagging )
  47 import Id               ( Id, idType, idName )
  48 import DataCon          ( DataCon, dataConTyCon, dataConTag, fIRST_TAG )
  49 import Const            ( mkMachInt )
  50 import Maybes           ( assocMaybe )
  51 import PrimRep          ( PrimRep(..) )
  52 import StgSyn           ( StgArg, GenStgArg(..) )
  53 import Type             ( isUnLiftedType )
  54 import TyCon            ( TyCon )
  55 import PrimOp           ( PrimOp )
  56 import Util             ( zipWithEqual )
  57 import Outputable
  58 import Panic            ( panic, assertPanic )
  59 \end{code}
  60
  61 %************************************************************************
  62 %*                                                                      *
  63 \subsection[tailcall-doc]{Documentation}
  64 %*                                                                      *
  65 %************************************************************************
  66
  67 \begin{code}
  68 cgTailCall :: Id -> [StgArg] -> Code
  69 \end{code}
  70
  71 Here's the code we generate for a tail call.  (NB there may be no
  72 arguments, in which case this boils down to just entering a variable.)
  73
  74 \begin{itemize}
  75 \item   Adjust the stack ptr to \tr{tailSp + #args}.
  76 \item   Put args in the top locations of the resulting stack.
  77 \item   Make Node point to the function closure.
  78 \item   Enter the function closure.
  79 \end{itemize}
  80
  81 Things to be careful about:
  82 \begin{itemize}
  83 \item   Don't overwrite stack locations before you have finished with
  84         them (remember you need the function and the as-yet-unmoved
  85         arguments).
  86 \item   Preferably, generate no code to replace x by x on the stack (a
  87         common situation in tail-recursion).
  88 \item   Adjust the stack high water mark appropriately.
  89 \end{itemize}
  90
  91 Treat unboxed locals exactly like literals (above) except use the addr
  92 mode for the local instead of (CLit lit) in the assignment.
  93
  94 Case for unboxed @Ids@ first:
  95 \begin{code}
  96 cgTailCall fun []
  97   | isUnLiftedType (idType fun)
  98   = getCAddrMode fun            `thenFC` \ amode ->
  99     performPrimReturn (ppr fun) amode
 100 \end{code}
 101
 102 The general case (@fun@ is boxed):
 103 \begin{code}
 104 cgTailCall fun args = performTailCall fun args
 105 \end{code}
 106
 107 %************************************************************************
 108 %*                                                                      *
 109 \subsection[return-and-tail-call]{Return and tail call}
 110 %*                                                                      *
 111 %************************************************************************
 112
 113 \begin{code}
 114 performPrimReturn :: SDoc       -- Just for debugging (sigh)
 115                   -> CAddrMode  -- The thing to return
 116                   -> Code
 117
 118 performPrimReturn doc amode
 119   = let
 120         kind = getAmodeRep amode
 121         ret_reg = dataReturnConvPrim kind
 122
 123         assign_possibly = case kind of
 124           VoidRep -> AbsCNop
 125           kind -> (CAssign (CReg ret_reg) amode)
 126     in
 127     performReturn assign_possibly (mkPrimReturnCode doc)
 128
 129 mkPrimReturnCode :: SDoc                -- Debugging only
 130                  -> Sequel
 131                  -> Code
 132 mkPrimReturnCode doc UpdateCode = pprPanic "mkPrimReturnCode: Upd" doc
 133 mkPrimReturnCode doc sequel     = sequelToAmode sequel  `thenFC` \ dest_amode ->
 134                                   absC (CReturn dest_amode DirectReturn)
 135                                   -- Direct, no vectoring
 136
 137 -- Constructor is built on the heap; Node is set.
 138 -- All that remains is
 139 --      (a) to set TagReg, if necessary
 140 --      (c) to do the right sort of jump.
 141
 142 mkStaticAlgReturnCode :: DataCon        -- The constructor
 143                       -> Sequel         -- where to return to
 144                       -> Code
 145
 146 mkStaticAlgReturnCode con sequel
 147   =     -- Generate profiling code if necessary
 148     (case return_convention of
 149         VectoredReturn sz -> profCtrC SLIT("TICK_VEC_RETURN") [mkIntCLit sz]
 150         other             -> nopC
 151     )                                   `thenC`
 152
 153         -- Set tag if necessary
 154         -- This is done by a macro, because if we are short of registers
 155         -- we don't set TagReg; instead the continuation gets the tag
 156         -- by indexing off the info ptr
 157     (case return_convention of
 158
 159         UnvectoredReturn no_of_constrs
 160          | no_of_constrs > 1
 161                 -> absC (CMacroStmt SET_TAG [mkIntCLit zero_indexed_tag])
 162
 163         other   -> nopC
 164     )                                   `thenC`
 165
 166         -- Generate the right jump or return
 167     (case sequel of
 168         UpdateCode ->   -- Ha!  We can go direct to the update code,
 169                         -- (making sure to jump to the *correct* update
 170                         --  code.)
 171                         absC (CReturn (CLbl mkUpdEntryLabel CodePtrRep)
 172                                       return_info)
 173
 174         CaseAlts _ (Just (alts, _)) ->  -- Ho! We know the constructor so
 175                                         -- we can go right to the alternative
 176
 177                 case assocMaybe alts tag of
 178                    Just (alt_absC, join_lbl) ->
 179                         absC (CJump (CLbl join_lbl CodePtrRep))
 180                    Nothing -> panic "mkStaticAlgReturnCode: default"
 181                                 -- The Nothing case should never happen;
 182                                 -- it's the subject of a wad of special-case
 183                                 -- code in cgReturnCon
 184
 185         -- can't be a SeqFrame, because we're returning a constructor
 186
 187         other ->        -- OnStack, or (CaseAlts ret_amode Nothing)
 188                     sequelToAmode sequel        `thenFC` \ ret_amode ->
 189                     absC (CReturn ret_amode return_info)
 190     )
 191
 192   where
 193     tag               = dataConTag   con
 194     tycon             = dataConTyCon con
 195     return_convention = ctrlReturnConvAlg tycon
 196     zero_indexed_tag  = tag - fIRST_TAG       -- Adjust tag to be zero-indexed
 197                                               -- cf AbsCUtils.mkAlgAltsCSwitch
 198
 199     return_info =
 200        case return_convention of
 201                 UnvectoredReturn _ -> DirectReturn
 202                 VectoredReturn _   -> StaticVectoredReturn zero_indexed_tag
 203
 204 mkUnboxedTupleReturnCode :: Sequel -> Code
 205 mkUnboxedTupleReturnCode sequel
 206     = case sequel of
 207         -- can't update with an unboxed tuple!
 208         UpdateCode -> panic "mkUnboxedTupleReturnCode"
 209
 210         CaseAlts _ (Just ([(_,(alt_absC,join_lbl))], _)) ->
 211                         absC (CJump (CLbl join_lbl CodePtrRep))
 212
 213         -- can't be a SeqFrame
 214
 215         other ->        -- OnStack, or (CaseAlts ret_amode something)
 216                     sequelToAmode sequel        `thenFC` \ ret_amode ->
 217                     absC (CReturn ret_amode DirectReturn)
 218
 219 -- This function is used by PrimOps that return enumerated types (i.e.
 220 -- all the comparison operators).
 221
 222 mkDynamicAlgReturnCode :: TyCon -> CAddrMode -> Sequel -> Code
 223
 224 mkDynamicAlgReturnCode tycon dyn_tag sequel
 225   = case ctrlReturnConvAlg tycon of
 226         VectoredReturn sz ->
 227
 228                 profCtrC SLIT("TICK_VEC_RETURN") [mkIntCLit sz] `thenC`
 229                 sequelToAmode sequel            `thenFC` \ ret_addr ->
 230                 absC (CReturn ret_addr (DynamicVectoredReturn dyn_tag))
 231
 232         UnvectoredReturn no_of_constrs ->
 233
 234                 -- Set tag if necessary
 235                 -- This is done by a macro, because if we are short of registers
 236                 -- we don't set TagReg; instead the continuation gets the tag
 237                 -- by indexing off the info ptr
 238                 (if no_of_constrs > 1 then
 239                         absC (CMacroStmt SET_TAG [dyn_tag])
 240                 else
 241                         nopC
 242                 )                       `thenC`
 243
 244
 245                 sequelToAmode sequel            `thenFC` \ ret_addr ->
 246                 -- Generate the right jump or return
 247                 absC (CReturn ret_addr DirectReturn)
 248 \end{code}
 249
 250 \begin{code}
 251 performReturn :: AbstractC          -- Simultaneous assignments to perform
 252               -> (Sequel -> Code)   -- The code to execute to actually do
 253                                     -- the return, given an addressing mode
 254                                     -- for the return address
 255               -> Code
 256
 257 -- this is just a special case of doTailCall, later.
 258 performReturn sim_assts finish_code
 259   = getEndOfBlockInfo   `thenFC` \ eob@(EndOfBlockInfo args_sp sequel) ->
 260
 261         -- Do the simultaneous assignments,
 262     doSimAssts sim_assts                `thenC`
 263
 264         -- push a return address if necessary
 265         -- (after the assignments above, in case we clobber a live
 266         --  stack location)
 267     pushReturnAddress eob               `thenC`
 268
 269         -- Adjust stack pointer
 270     adjustRealSp args_sp                `thenC`
 271
 272         -- Do the return
 273     finish_code sequel          -- "sequel" is `robust' in that it doesn't
 274                                 -- depend on stk-ptr values
 275 \end{code}
 276
 277 Returning unboxed tuples.  This is mainly to support _ccall_GC_, where
 278 we want to do things in a slightly different order to normal:
 279
 280                 - push return address
 281                 - adjust stack pointer
 282                 - r = call(args...)
 283                 - assign regs for unboxed tuple (usually just R1 = r)
 284                 - return to continuation
 285
 286 The return address (i.e. stack frame) must be on the stack before
 287 doing the call in case the call ends up in the garbage collector.
 288
 289 Sadly, the information about the continuation is lost after we push it
 290 (in order to avoid pushing it again), so we end up doing a needless
 291 indirect jump (ToDo).
 292
 293 \begin{code}
 294 returnUnboxedTuple :: [CAddrMode] -> Code -> Code
 295 returnUnboxedTuple amodes before_jump
 296   = getEndOfBlockInfo   `thenFC` \ eob@(EndOfBlockInfo args_sp sequel) ->
 297
 298         -- push a return address if necessary
 299     pushReturnAddress eob               `thenC`
 300     setEndOfBlockInfo (EndOfBlockInfo args_sp (OnStack args_sp)) (
 301
 302         -- Adjust stack pointer
 303     adjustRealSp args_sp                `thenC`
 304
 305     before_jump                         `thenC`
 306
 307     let (ret_regs, leftovers) = assignRegs [] (map getAmodeRep amodes)
 308     in
 309
 310     doTailCall amodes ret_regs
 311                 mkUnboxedTupleReturnCode
 312                 (length leftovers)  {- fast args arity -}
 313                 AbsCNop {-no pending assigments-}
 314                 Nothing {-not a let-no-escape-}
 315                 False   {-node doesn't point-}
 316      )
 317 \end{code}
 318
 319 \begin{code}
 320 performTailCall :: Id           -- Function
 321                 -> [StgArg]     -- Args
 322                 -> Code
 323
 324 performTailCall fun args
 325   =     -- Get all the info we have about the function and args and go on to
 326         -- the business end
 327     getCAddrModeAndInfo fun     `thenFC` \ (fun_amode, lf_info) ->
 328     getArgAmodes args           `thenFC` \ arg_amodes ->
 329
 330     tailCallFun
 331                 fun fun_amode lf_info arg_amodes
 332                 AbsCNop {- No pending assignments -}
 333
 334
 335 -- generating code for a tail call to a function (or closure)
 336
 337 tailCallFun :: Id -> CAddrMode  -- Function and its amode
 338                  -> LambdaFormInfo      -- Info about the function
 339                  -> [CAddrMode]         -- Arguments
 340
 341                  -> AbstractC           -- Pending simultaneous assignments
 342                                         -- *** GUARANTEED to contain only stack
 343                                         -- assignments.
 344
 345                                         -- In ptic, we don't need to look in
 346                                         -- here to discover all live regs
 347
 348                  -> Code
 349
 350 tailCallFun fun fun_amode lf_info arg_amodes pending_assts
 351   = nodeMustPointToIt lf_info                   `thenFC` \ node_points ->
 352     getEntryConvention (idName fun) lf_info
 353         (map getAmodeRep arg_amodes)            `thenFC` \ entry_conv ->
 354     let
 355         node_asst
 356           = if node_points then
 357                 CAssign (CReg node) fun_amode
 358             else
 359                 AbsCNop
 360
 361         (arg_regs, finish_code, arity)
 362           = case entry_conv of
 363               ViaNode ->
 364                 ([],
 365                      profCtrC SLIT("TICK_ENT_VIA_NODE") [] `thenC`
 366                      absC (CJump (CMacroExpr CodePtrRep ENTRY_CODE
 367                                 [CVal (nodeRel 0) DataPtrRep]))
 368                      , 0)
 369               StdEntry lbl -> ([], absC (CJump (CLbl lbl CodePtrRep)), 0)
 370               DirectEntry lbl arity regs  ->
 371                 (regs,   absC (CJump (CLbl lbl CodePtrRep)),
 372                  arity - length regs)
 373
 374         -- set up for a let-no-escape if necessary
 375         join_sp = case fun_amode of
 376                         CJoinPoint sp -> Just sp
 377                         other         -> Nothing
 378     in
 379     doTailCall arg_amodes arg_regs (const finish_code) arity
 380                 (mkAbstractCs [node_asst,pending_assts]) join_sp node_points
 381
 382
 383 -- this generic tail call code is used for both function calls and returns.
 384
 385 doTailCall
 386         :: [CAddrMode]                  -- args to pass to function
 387         -> [MagicId]                    -- registers to use
 388         -> (Sequel->Code)               -- code to perform jump
 389         -> Int                          -- number of "fast" stack arguments
 390         -> AbstractC                    -- pending assignments
 391         -> Maybe VirtualSpOffset        -- sp offset to trim stack to
 392         -> Bool                         -- node points to the closure to enter
 393         -> Code
 394
 395 doTailCall arg_amodes arg_regs finish_code arity pending_assts
 396                 maybe_join_sp node_points
 397   = getEndOfBlockInfo   `thenFC` \ eob@(EndOfBlockInfo args_sp sequel) ->
 398
 399     let
 400         no_of_args = length arg_amodes
 401
 402         (reg_arg_amodes, stk_arg_amodes) = splitAt (length arg_regs) arg_amodes
 403             -- We get some stk_arg_amodes if (a) no regs, or
 404             --                               (b) args beyond arity
 405
 406         reg_arg_assts
 407           = mkAbstractCs (zipWithEqual "assign_to_reg2"
 408                                 assign_to_reg arg_regs reg_arg_amodes)
 409
 410         assign_to_reg reg_id amode = CAssign (CReg reg_id) amode
 411
 412         join_sp = case maybe_join_sp of
 413                         Just sp -> ASSERT(not (args_sp > sp)) sp
 414               -- If ASSERTion fails: Oops: the join point has *lower*
 415               -- stack ptrs than the continuation Note that we take
 416               -- the Sp point without the return address here.   The
 417               -- return address is put on by the let-no-escapey thing
 418               -- when it finishes.
 419                         Nothing -> args_sp
 420
 421         (fast_stk_amodes, tagged_stk_amodes) =
 422                 splitAt arity stk_arg_amodes
 423     in
 424         -- We can omit tags on the arguments passed to the fast entry point,
 425         -- but we have to be careful to fill in the tags on any *extra*
 426         -- arguments we're about to push on the stack.
 427
 428         mkTaggedStkAmodes join_sp tagged_stk_amodes `thenFC`
 429                             \ (fast_sp, tagged_arg_assts, tag_assts) ->
 430
 431         mkTaggedStkAmodes fast_sp fast_stk_amodes `thenFC`
 432                             \ (final_sp, fast_arg_assts, _) ->
 433
 434         -- adjust the high-water mark if necessary
 435         adjustStackHW final_sp  `thenC`
 436
 437                 -- The stack space for the pushed return addess,
 438                 -- with any args pushed on top, is recorded in final_sp.
 439
 440                 -- Do the simultaneous assignments,
 441         doSimAssts (mkAbstractCs [pending_assts,
 442                                   reg_arg_assts,
 443                                   fast_arg_assts,
 444                                   tagged_arg_assts,
 445                                   tag_assts])   `thenC`
 446
 447                 -- push a return address if necessary
 448                 -- (after the assignments above, in case we clobber a live
 449                 --  stack location)
 450         pushReturnAddress eob           `thenC`
 451
 452                 -- Final adjustment of stack pointer
 453         adjustRealSp final_sp           `thenC`
 454
 455                 -- Now decide about semi-tagging
 456         let
 457                 semi_tagging_on = opt_DoSemiTagging
 458         in
 459         case (semi_tagging_on, arg_amodes, node_points, sequel) of
 460
 461         --
 462         -- *************** The semi-tagging case ***************
 463         --
 464         {- XXX leave this out for now.
 465               (   True,            [],          True,        CaseAlts _ (Just (st_alts, maybe_deflt_join_details))) ->
 466
 467                 -- Whoppee!  Semi-tagging rules OK!
 468                 -- (a) semi-tagging is switched on
 469                 -- (b) there are no arguments,
 470                 -- (c) Node points to the closure
 471                 -- (d) we have a case-alternative sequel with
 472                 --      some visible alternatives
 473
 474                 -- Why is test (c) necessary?
 475                 -- Usually Node will point to it at this point, because we're
 476                 -- scrutinsing something which is either a thunk or a
 477                 -- constructor.
 478                 -- But not always!  The example I came across is when we have
 479                 -- a top-level Double:
 480                 --      lit.3 = D# 3.000
 481                 --      ... (case lit.3 of ...) ...
 482                 -- Here, lit.3 is built as a re-entrant thing, which you must enter.
 483                 -- (OK, the simplifier should have eliminated this, but it's
 484                 --  easy to deal with the case anyway.)
 485                 let
 486                     join_details_to_code (load_regs_and_profiling_code, join_lbl)
 487                         = load_regs_and_profiling_code          `mkAbsCStmts`
 488                           CJump (CLbl join_lbl CodePtrRep)
 489
 490                     semi_tagged_alts = [ (mkMachInt (fromInt (tag - fIRST_TAG)),
 491                                           join_details_to_code join_details)
 492                                        | (tag, join_details) <- st_alts
 493                                        ]
 494
 495                     enter_jump
 496                       -- Enter Node (we know infoptr will have the info ptr in it)!
 497                       = mkAbstractCs [
 498                         CCallProfCtrMacro SLIT("RET_SEMI_FAILED")
 499                                         [CMacroExpr IntRep INFO_TAG [CReg infoptr]],
 500                         CJump (CMacroExpr CodePtrRep ENTRY_CODE [CReg infoptr]) ]
 501                 in
 502                         -- Final switch
 503                 absC (mkAbstractCs [
 504                             CAssign (CReg infoptr)
 505                                     (CVal (NodeRel zeroOff) DataPtrRep),
 506
 507                             case maybe_deflt_join_details of
 508                                 Nothing ->
 509                                     CSwitch (CMacroExpr IntRep INFO_TAG [CReg infoptr])
 510                                         (semi_tagged_alts)
 511                                         (enter_jump)
 512                                 Just (_, details) ->
 513                                     CSwitch (CMacroExpr IntRep EVAL_TAG [CReg infoptr])
 514                                      [(mkMachInt 0, enter_jump)]
 515                                      (CSwitch
 516                                          (CMacroExpr IntRep INFO_TAG [CReg infoptr])
 517                                          (semi_tagged_alts)
 518                                          (join_details_to_code details))
 519                 ])
 520                 -}
 521
 522         --
 523         -- *************** The non-semi-tagging case ***************
 524         --
 525               other -> finish_code sequel
 526 \end{code}
 527
 528 %************************************************************************
 529 %*                                                                      *
 530 \subsection[tailCallPrimOp]{@tailCallPrimOp@}
 531 %*                                                                      *
 532 %************************************************************************
 533
 534 \begin{code}
 535 tailCallPrimOp :: PrimOp -> [StgArg] -> Code
 536 tailCallPrimOp op args =
 537     -- we're going to perform a normal-looking tail call,
 538     -- except that *all* the arguments will be in registers.
 539     getArgAmodes args           `thenFC` \ arg_amodes ->
 540     let (arg_regs, leftovers) = assignAllRegs [] (map getAmodeRep arg_amodes)
 541     in
 542     ASSERT(null leftovers) -- no stack-resident args
 543     doTailCall arg_amodes arg_regs
 544         (const (absC (CJump (CLbl (mkRtsPrimOpLabel op) CodePtrRep))))
 545         0       {- arity shouldn't matter, all args in regs -}
 546         AbsCNop {- no pending assignments -}
 547         Nothing {- not a let-no-escape -}
 548         False   {- node doesn't point -}
 549 \end{code}
 550
 551 %************************************************************************
 552 %*                                                                      *
 553 \subsection[doSimAssts]{@doSimAssts@}
 554 %*                                                                      *
 555 %************************************************************************
 556
 557 @doSimAssts@ happens at the end of every block of code.
 558 They are separate because we sometimes do some jiggery-pokery in between.
 559
 560 \begin{code}
 561 doSimAssts :: AbstractC -> Code
 562
 563 doSimAssts sim_assts
 564   = absC (CSimultaneous sim_assts)
 565 \end{code}
 566
 567 %************************************************************************
 568 %*                                                                      *
 569 \subsection[retAddr]{@Return Addresses@}
 570 %*                                                                      *
 571 %************************************************************************
 572
 573 We always push the return address just before performing a tail call
 574 or return.  The reason we leave it until then is because the stack
 575 slot that the return address is to go into might contain something
 576 useful.
 577
 578 If the end of block info is CaseAlts, then we're in the scrutinee of a
 579 case expression and the return address is still to be pushed.
 580
 581 There are cases where it doesn't look necessary to push the return
 582 address: for example, just before doing a return to a known
 583 continuation.  However, the continuation will expect to find the
 584 return address on the stack in case it needs to do a heap check.
 585
 586 \begin{code}
 587 pushReturnAddress :: EndOfBlockInfo -> Code
 588 pushReturnAddress (EndOfBlockInfo args_sp sequel@(CaseAlts amode _)) =
 589     getSpRelOffset args_sp                       `thenFC` \ sp_rel ->
 590     absC (CAssign (CVal sp_rel RetRep) amode)
 591 pushReturnAddress (EndOfBlockInfo args_sp sequel@(SeqFrame amode _)) =
 592     pushSeqFrame args_sp                         `thenFC` \ ret_sp ->
 593     getSpRelOffset ret_sp                        `thenFC` \ sp_rel ->
 594     absC (CAssign (CVal sp_rel RetRep) amode)
 595 pushReturnAddress _ = nopC
 596 \end{code}