I hope you’ve all had a pleasant Christmas; I sure did, though once again I was unable to return to Waterloo region to visit my family. Hopefully I’ll make it for Easter this coming year.
Last time on FAIC I described why calling GetValueOrDefault()
instead of Value
allows the jitter to generate smaller, faster code. Of course this optimization is first, tiny, and second, only a valid optimization in the case where you are certain that the nullable value is not actually null. Over the next few episodes I’ll describe how the C# compiler uses that fact to generate better code for you, but in order to do that, I first need to talk a bit about lifted arithmetic.
Back in 2007 I described what mathematicians mean by “lifted arithmetic”, and how the C# specification uses this term in a subtly wrong way. It’s been a long time, so here’s a quick refresher. Mathematically, by “lifted” we mean that if there is a function f : S → S
, and we make a new set S' = S ∪ { null }
, then the lifted function f' : S' → S'
is defined as f'(null) → null, f'(s ∈ S) → f(s)
. Or, in English, the lifted function gives null when given null, and agrees with the unlifted function otherwise.
We then extend the definition of “lifted” to functions of the form f : S → T
in the obvious manner: the lifted function is f' : S' → T'
. Similarly for functions of two, three or more parameters: the lifted function is null if any argument is null, and agrees with the unlifted function otherwise.
Lifted arithmetic operators in C# work similarly. In C#, if there is an operator, let’s say the unary ~
operator that takes an int
and produces an int
, then there is also a lifted ~
operator that takes an int?
and produces an int?
. The lifted operator produces null if given null, and otherwise agrees with the unlifted operator.
Some so-called “lifted” operators do not follow this pattern, but for the purposes of this series we’ll mostly be talking about the ones that do.
I want to make a brief aside here to discuss how the C# compiler knows to use a lifted operator in the first place. The answer is straightforward: it uses overload resolution.
Continuing our example, when you say ~x
, the compiler pretends that you did a method call operator~(x)
and creates a candidate set that consists of “methods” corresponding to the signatures of the user-defined and built-in ~
operators. If overload resolution produces a unique best applicable operator then it is chosen and the operand is implicitly converted to the “parameter type” of the chosen “operator method”, otherwise the compiler produces an error. That’s an oversimplification; consult the specification for the exact details.
Unfortunately, the specification sections on operator overload resolution are not strictly speaking entirely accurate: there are some known discrepancies between the compiler and the specification. In some of these cases the compiler is wrong and in some the specification is wrong. The areas with small discrepancies include (1) precisely when a user-defined operator is considered to be “liftable” and what the resulting semantics are, (2) how the candidate set for operators on enumerated and delegate types are determined, and (3) how the “betterness” rules treat lifted operators.
Mads and I have a number of times attempted to come up with better spec language but I don’t think the proposed changes made it into the latest revision. I might choose to do blog articles on these interesting and difficult corner cases in the future.
The important fact that will come into play later in this series is that if overload resolution chooses a lifted operator then the operand is implicitly converted to the nullable type. Just like how when normal overload resolution chooses a method, the arguments are implicitly converted to the corresponding formal parameter types.
Returning now to the subject at hand: how does the C# compiler generate code for a lifted operator? When you say:
int? y = ~x;
what happens? Let’s suppose that x
is a legal expression of type int?
, just to keep it easy. Overload resolution determines that the lifted ~
operator that takes an int?
and produces an int?
is the unique best applicable operator. The expression is already of the correct type. Now, you might naively think that the compiler would pretend that you’d typed:
int? y = x.HasValue ? ~x.Value : null;
but of course that code is wrong in two ways.
First, it doesn’t compile because the type of the conditional operator expression cannot be determined.
Astonishingly, I’ve never written a blog article about this specific aspect of the conditional operator, though it has certainly come up on StackOverflow a lot. This is probably the blog article that came the closest to describing this common problem.
And second, what if the expression x
has a side effect? We would not want to generate
int? y = ~M(++i);
as:
int? y = M(++i).HasValue ? ~M(++i).Value : null;
because then the variable gets incremented twice and the method gets called twice if the result of the first call is not null. And of course the value returned the second time might be different! We can fix these two problems easily enough:
int? y;
int? temp = x;
y = temp.HasValue ? new int?(~temp.Value) : new int?();
And now we’re good.
At this point the C# compiler can say “but wait a moment! if we are on the “consequence” branch of the conditional operator then we know for sure that temp.HasValue
is true. Therefore the compiler can generate the more optimal code:
int? y;
int? temp = x;
y = temp.HasValue ? new int?(~temp.GetValueOrDefault()) : new int?();
Which is in fact what both the “original recipe” and the “extra crispy Roslyn” compilers do. The savings is tiny, but it is real, and these savings add up as the expressions get more and more complicated, as we’ll see.
Next time on FAIC: Is that the only optimization a C# compiler can perform when generating code for lifted arithmetic? Of course not! In the next few episodes we’ll look at some ways the compiler can be more clever, and compare the Roslyn compiler’s heuristics to the previous compiler’s heuristics. Happy New Year all, and we’ll see you in 2013 for more fabulous adventures.