<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  </head>
  <body>
    <p>Hi ghc-devs,</p>
    <p>After a discussion today about `keepAlive#`, I think Option E [1]
      is even more appealing.</p>
    <p>To recap the idea was to have keep-alive variable sets attached
      to case-expressions in Core. E.g. `case {k} x of ...`<br>
    </p>
    <p><br>
    </p>
    <p>1. One of the issue was the semantics of `keepAlive#`.
      `keepAlive#` is very intricate with evaluation. As Simon mentioned
      we want a semantics like:</p>
    <pre><tt> keepAlive# k x ==> x `seq` touch# k `seq` x</tt></pre>
    <p>with potentially a special `seq` to deal with diverging `x`.</p>
    <p>With `case {k} x of ...` we have this semantics. Even if we throw
      the case alternatives if `x` diverges, we don't throw the
      keep-alive set so we're good.<br>
    </p>
    <p><br>
    </p>
    <p>2. Simon wanted to push `keepAlive#` into case-expressions. With
      this approach we should only have to fix case-of-case to take
      keep-alive sets into account.</p>
    <pre class="code highlight" lang="haskell"><span id="LC1" class="line" lang="haskell"><span class="kr">case</span> <span class="p">{</span><span class="n">k</span><span class="p">}</span> <span class="p">(</span><span class="kr">case</span> <span class="p">{</span><span class="n">k2</span><span class="p">}</span> <span class="n">x</span> <span class="kr">of</span> <span class="o">..</span> <span class="o">-></span> <span class="n">a</span><span class="p">;</span> <span class="o">...</span> <span class="o">-></span> <span class="n">b</span><span class="p">)</span> <span class="kr">of</span></span>
<span id="LC2" class="line" lang="haskell">  <span class="kt">C0</span> <span class="o">..</span> <span class="o">-></span> <span class="n">e1</span></span>
<span id="LC3" class="line" lang="haskell">  <span class="kt">C1</span> <span class="o">..</span> <span class="o">-></span> <span class="n">e2</span></span>
<span id="LC4" class="line" lang="haskell"></span>
<span id="LC5" class="line" lang="haskell"><span class="o">===></span></span>
<span id="LC6" class="line" lang="haskell"></span>
<span id="LC7" class="line" lang="haskell"><span class="kr">case</span> <span class="p">{</span><span class="n">k</span><span class="p">,</span><span class="n">k2</span><span class="p">}</span> <span class="n">x</span> <span class="kr">of</span></span>
<span id="LC8" class="line" lang="haskell">   <span class="o">...</span> <span class="o">-></span> <span class="kr">case</span> <span class="p">{</span><span class="n">k</span><span class="p">}</span> <span class="n">a</span> <span class="kr">of</span> <span class="p">{</span> <span class="kt">C0</span> <span class="o">..</span> <span class="o">-></span> <span class="n">e1</span><span class="p">;</span> <span class="kt">C1</span> <span class="o">...</span> <span class="o">-></span> <span class="n">e2</span> <span class="p">}</span></span>
<span id="LC9" class="line" lang="haskell">   <span class="o">...</span> <span class="o">-></span> <span class="kr">case</span> <span class="p">{</span><span class="n">k</span><span class="p">}</span> <span class="n">b</span> <span class="kr">of</span> <span class="p">{</span> <span class="kt">C0</span> <span class="o">..</span> <span class="o">-></span> <span class="n">e1</span><span class="p">;</span> <span class="kt">C1</span> <span class="o">...</span> <span class="o">-></span> <span class="n">e2</span> <span class="p">}</span></span>


</pre>
    <p>3. Compared to other approaches: we don't have to use stack
      frames (good for performance) and we don't have to deal with a
      continuation (good for Core optimizations, hence perf).</p>
    <p>4. Implementing this approach is quite straightforward even if it
      modifies Core. I did it last month in [2]. This patch doesn't
      fully work yet with `-O` because some transformation (related to
      join points IIRC) doesn't take keep-alive sets into account but it
      should be pretty easy to fix if we want to use this approach.<br>
    </p>
    <p><br>
    </p>
    <p>Given how hard it is to come up with a good design/implementation
      of other approaches, this one strikes me as probably the more
      principled we have and yet it is relatively easy to implement.
      What do you think?</p>
    <p>Cheers,<br>
      Sylvain<br>
    </p>
    <p><br>
    </p>
    <p>[1]
<a class="moz-txt-link-freetext" href="https://gitlab.haskell.org/ghc/ghc/-/wikis/proposal/with-combinator#option-e-tag-core-case-expression-with-kept-alive-variables">https://gitlab.haskell.org/ghc/ghc/-/wikis/proposal/with-combinator#option-e-tag-core-case-expression-with-kept-alive-variables</a></p>
    <p>[2]
      <a class="moz-txt-link-freetext" href="https://gitlab.haskell.org/hsyl20/ghc/-/commits/hsyl20-keepalive">https://gitlab.haskell.org/hsyl20/ghc/-/commits/hsyl20-keepalive</a><br>
    </p>
    <p><br>
    </p>
    <p><br>
    </p>
    <div class="moz-cite-prefix">On 13/04/2020 19:51, Ben Gamari wrote:<br>
    </div>
    <blockquote type="cite" cite="mid:875ze39suw.fsf@smart-cactus.org">
      <pre class="moz-quote-pre" wrap="">
Ccing ghc-devs@ since this discussion is something of general interest
to the community.


Sylvain Henry <a class="moz-txt-link-rfc2396E" href="mailto:sylvain@haskus.fr"><sylvain@haskus.fr></a> writes:

</pre>
      <blockquote type="cite">
        <pre class="moz-quote-pre" wrap="">Simon, Ben,

I've been reading and thinking about `readRW#` issues which are very 
related to issues we have with `keepAlive#` primop.

To recap, the problem is that we want some transformations (that Simon 
has listed in [1]) to consider:

```
case runRW# f of ...

case keepAlive# k a of ...
```

as if they were really:

```
case f realWorld# of ...

case a of ...
```

BUT without breaking the semantics of runRW# and keepAlive#.

I have been thinking about a solution that I have described on the wiki: 
<a class="moz-txt-link-freetext" href="https://gitlab.haskell.org/ghc/ghc/-/wikis/proposal/with-combinator#option-e-tag-core-case-expression-with-kept-alive-variables">https://gitlab.haskell.org/ghc/ghc/-/wikis/proposal/with-combinator#option-e-tag-core-case-expression-with-kept-alive-variables</a>

The idea is to keep a set of variable names in each Core case-expression 
that are kept alive during the evaluation of the scrutinee.

I think it would work very nicely with your `newState#` primop described 
in [2], both for `runST` and for `unsafeDupablePerformIO` (details on 
the wiki).

It requires a little more upfront work to adapt the code involving 
case-expressions. But it will force us to review all transformations to 
check if they are sound when keep-alive sets are not empty, which we 
would have to do anyway if we implemented another option. We could start 
by disabling transformations involving non-empty keep-alive sets and 
iterate to enable the sound ones.

I would like your opinions on the approach. I may have totally missed 
something.
</pre>
      </blockquote>
      <pre class="moz-quote-pre" wrap="">
Thanks for writing this down!

Indeed it is an interesting idea. However, as expressed on IRC, I
wonder whether this problem rises to the level where it warrants an
adaptation to our Core representation. It feels a bit like the
tail is wagging the dog here, especially given how the "tail" here
merely exists to support FFI.

That being said, this is one of the few options which remain on the
table that doesn't require changes to user code. Moreover, the
applicability to runRW# is quite intriguing.

Another (admittedly, more ad-hoc) option that would avoid modifying Core
would be to teach the simplifier about the class of
"continuation-passing" primops (e.g. `keepAlive#` and `runRW#`), allowing it
to push case analyses into the continuation argument. That is,

    case keepAlive# x expr of pat -> rhs

            ~>

    keepAlive# x (case expr of pat -> rhs)

Of course, doing this is a bit tricky since one must rewrite the
application of keepAlive# to ensure that the resulting application is
well-typed. Admittedly, this doesn't help the runRW# case (although this
could presumably be accommodated by touch#'ing the final state token in
the runRW# desugaring emitted by CorePrep).

On the whole, I'm not a fan of this ad-hoc option. It increases the
complexity of the simplifier all to support a single operation. By
comparison, the Core extension looks somewhat appealing.

Cheers,

- Ben


[1] <a class="moz-txt-link-freetext" href="https://gitlab.haskell.org/ghc/ghc/-/wikis/proposal/with-combinator#option-e-tag-core-case-expression-with-kept-alive-variables">https://gitlab.haskell.org/ghc/ghc/-/wikis/proposal/with-combinator#option-e-tag-core-case-expression-with-kept-alive-variables</a>

P.S. A minor note: the keepAlive# "pseudo-instruction" mentioned on the
Wiki [1] is precisely the touch# operation we have today.
</pre>
    </blockquote>
  </body>
</html>