Skip to content
  • Simon Peyton Jones's avatar
    Completely new treatment of INLINE pragmas (big patch) · d95ce839
    Simon Peyton Jones authored
    This is a major patch, which changes the way INLINE pragmas work.
    Although lots of files are touched, the net is only +21 lines of
    code -- and I bet that most of those are comments!
    
    HEADS UP: interface file format has changed, so you'll need to
    recompile everything.
    
    There is not much effect on overall performance for nofib, 
    probably because those programs don't make heavy use of INLINE pragmas.
    
            Program           Size    Allocs   Runtime   Elapsed
                Min         -11.3%     -6.9%     -9.2%     -8.2%
                Max          -0.1%     +4.6%     +7.5%     +8.9%
     Geometric Mean          -2.2%     -0.2%     -1.0%     -0.8%
    
    (The +4.6% for on allocs is cichelli; see other patch relating to
    -fpass-case-bndr-to-join-points.)
    
    The old INLINE system
    ~~~~~~~~~~~~~~~~~~~~~
    The old system worked like this. A function with an INLINE pragam
    got a right-hand side which looked like
         f = __inline_me__ (\xy. e)
    The __inline_me__ part was an InlineNote, and was treated specially
    in various ways.  Notably, the simplifier didn't inline inside an
    __inline_me__ note.  
    
    As a result, the code for f itself was pretty crappy. That matters
    if you say (map f xs), because then you execute the code for f,
    rather than inlining a copy at the call site.
    
    The new story: InlineRules
    ~~~~~~~~~~~~~~~~~~~~~~~~~~
    The new system removes the InlineMe Note altogether.  Instead there
    is a new constructor InlineRule in CoreSyn.Unfolding.  This is a 
    bit like a RULE, in that it remembers the template to be inlined inside
    the InlineRule.  No simplification or inlining is done on an InlineRule,
    just like RULEs.  
    
    An Id can have an InlineRule *or* a CoreUnfolding (since these are two
    constructors from Unfolding). The simplifier treats them differently:
    
      - An InlineRule is has the substitution applied (like RULES) but 
        is otherwise left undisturbed.
    
      - A CoreUnfolding is updated with the new RHS of the definition,
        on each iteration of the simplifier.
    
    An InlineRule fires regardless of size, but *only* when the function
    is applied to enough arguments.  The "arity" of the rule is specified
    (by the programmer) as the number of args on the LHS of the "=".  So
    it makes a difference whether you say
      	{-# INLINE f #-}
    	f x = \y -> e     or     f x y = e
    This is one of the big new features that InlineRule gives us, and it
    is one that Roman really wanted.
    
    In contrast, a CoreUnfolding can fire when it is applied to fewer
    args than than the function has lambdas, provided the result is small
    enough.
    
    
    Consequential stuff
    ~~~~~~~~~~~~~~~~~~~
    * A 'wrapper' no longer has a WrapperInfo in the IdInfo.  Instead,
      the InlineRule has a field identifying wrappers.
    
    * Of course, IfaceSyn and interface serialisation changes appropriately.
    
    * Making implication constraints inline nicely was a bit fiddly. In
      the end I added a var_inline field to HsBInd.VarBind, which is why
      this patch affects the type checker slightly
    
    * I made some changes to the way in which eta expansion happens in
      CorePrep, mainly to ensure that *arguments* that become let-bound
      are also eta-expanded.  I'm still not too happy with the clarity
      and robustness fo the result.
    
    * We now complain if the programmer gives an INLINE pragma for
      a recursive function (prevsiously we just ignored it).  Reason for
      change: we don't want an InlineRule on a LoopBreaker, because then
      we'd have to check for loop-breaker-hood at occurrence sites (which
      isn't currenlty done).  Some tests need changing as a result.
    
    This patch has been in my tree for quite a while, so there are
    probably some other minor changes.
    d95ce839