{"id":3179,"date":"2010-11-05T12:54:00","date_gmt":"2010-11-05T12:54:00","guid":{"rendered":"https:\/\/test.simple-talk.com\/uncategorized\/subterranean-il-callvirt-and-virtual-methods\/"},"modified":"2021-04-29T15:30:56","modified_gmt":"2021-04-29T15:30:56","slug":"subterranean-il-callvirt-and-virtual-methods","status":"publish","type":"post","link":"https:\/\/www.red-gate.com\/simple-talk\/blogs\/subterranean-il-callvirt-and-virtual-methods\/","title":{"rendered":"Subterranean IL: Callvirt and virtual methods"},"content":{"rendered":"

Next up is a look at the details of callvirt<\/code> and what happens when you call a virtual method. However, in order to do that, we first need to understand some of the low-level CLR datastructures, and what exactly an object instance is.<\/p>\n

Object instances<\/b><\/p>\n

Object instances are actually suprisingly small and lightweight things – they comprise of a sync block index used for locking on the object, a pointer to an internal MethodTable<\/code> structure corresponding to the type that this object is an instance of, and the instance fields. That’s it. Everything else – method implementations, interfaces, supertype information – is part of the MethodTable<\/code> structure for the type (this is the structure pointed to by Type.TypeHandle<\/code><\/a>). And, most importantly, within the MethodTable<\/code> structure is stored all the method and interface information used for dynamic method dispatch through callvirt<\/code>.<\/p>\n

MethodTable<\/b><\/p>\n

Within each MethodTable<\/code> structure is a list of all the methods on the type, including inherited methods, in inheritance order. The first entries are always the four virtual methods on System.Object<\/code> (ToString<\/code>, Equals<\/code>, GetHashCode<\/code> and Finalize<\/code>), followed by the virtual methods on the next supertype, and so on, finishing off with virtual and non-virtual methods declared on the type itself. Each entry in the table points to its IL implementation, which can either be its own overriding implementation or the same implementation as its supertype. For example, the following class definitions: <\/p>\n

public class ClassA {\n    public virtual void Method1() { \/* ... *\/ }\n}\npublic class ClassB : ClassA {\n    public virtual void Method2() { \/* ... *\/ }\n}<\/pre>\n
 will result in MethodTable<\/code> method lists looking something like this: <\/p>\n
|-----------|     |-----------|     |-----------|\n| Object    |     | ClassA    |     | ClassB    |\n|-----------|     |-----------|     |-----------|\n|ToString   |     |ToString   |     |ToString   |\n|Equals     |     |Equals     |     |Equals     |\n|GetHashCode|     |GetHashCode|     |GetHashCode|\n|Finalize   |     |Finalize   |     |Finalize   |\n|-----------|     |Method1    |     |Method1    |\n                  |-----------|     |Method2    |\n                                    |-----------|<\/pre>\n<\/p>\n
This means that to callvirt<\/code> ClassA.Method1<\/code> on an object the CLR simply has to follow the method table pointer in the object instance, go to the 5th method table entry, and execute the method pointed to by that entry. This will execute the corresponding implementation for the run-time type of the object.<\/p>\n
Calling interface methods<\/b><\/p>\n
When you implement an interface on a class, the implementing methods are all declared as virtual sealed<\/code>, and therefore will have entries in the MethodTable<\/code> vtable. Mapping an interface method onto it’s implementation requires a secondary structure called an IVMap<\/code> for each type. This has an entry for each interface known by the system, and each entry points at the implementing methods in the type’s vtable. Needless to say, the details are quite complicated, change in each version of the CLR, and involve quite a bit of optimization, so I won’t go into them here. For more details you can read Sasha’s blog post<\/a> about how the 2.0 CLR does it.<\/p>\n
Whence callvirt<\/code>?<\/b><\/p>\n
 It follows that in order to call a method virtually, the this<\/code> pointer on the stack when you call the method has to be of type O<\/code> (heap object reference), as that is the only stack entry type that is guarenteed to have a MethodTable<\/code> pointer through which this dynamic dispatch mechanism can work. Managed pointers (&<\/code>) that call<\/code> can use don’t have the necessary information to perform the dynamic dispatch.<\/p>\n
There is another difference between call<\/code> and callvirt<\/code> – callvirt<\/code> always checks if the this<\/code> is a null reference, and throws NullReferenceException<\/code> if it is, before calling the method, whereas call<\/code> won’t thrown a NullReferenceException<\/code> until the this<\/code> pointer is actually accessed using ldarg.0<\/code> within the method. The reason for this should be clear – if this<\/code> is null, there’s no MethodTable<\/code> pointer to use to work out the correct run-time method to call!<\/p>\n
Value types and callvirt<\/code><\/b><\/p>\n
An unboxed value type is stored as the concatenation of all its fields, with no sync block index or MethodTable<\/code> pointer. This isn’t a problem when using call<\/code> as the CLR knows statically which method it should call, so it can simply jump directly to the method implementation. However, you can’t call a method on a value type using callvirt<\/code> as there’s no MethodTable<\/code> pointer it can use to figure out the correct method implementation. This is where value type boxing comes in.<\/p>\n
To help demonstrate this, I’m going to use the types from my previous blog post<\/a>, but with an additional interface: <\/p>\n
public interface IIncrementable {\n    void Increment(int incrementBy);\n}\n\npublic class IncrementableClass : IIncrementable {\n    public int Value;\n    \n    public void Increment(int incrementBy) {\n        Value += incrementBy;\n    }\n}\n\npublic struct IncrementableStruct : IIncrementable {\n    public int Value;\n     \n    public void Increment(int incrementBy) {\n        Value += incrementBy;\n    }\n}<\/pre>\n<\/p>\n
If you recall, call<\/code>ing a method on a value type requires a this<\/code> pointer of type &<\/code>. What happens if we simply substitute callvirt<\/code> for the call to IncrementableStruct::Increment<\/code>? <\/p>\n
ldarga 0\nldc.i4.5\ncallvirt instance void IncrementableStruct::Increment(int32)\nret<\/pre>\n
 As expected, PEVerify doesn’t like it: <\/p>\n
[offset 0x00000005] Callvirt on a value type method.<\/pre>\n
  What about if we call the Increment<\/code> method through the IIncrementable<\/code> interface instead? <\/p>\n
ldarga 0\nldc.i4.5\ncallvirt instance void IIncrementable::Increment(int32)\nret<\/pre>\n
 Again, PEVerify fails it: <\/p>\n
[offset 0x00000005]\n    [found address of value 'IncrementableStruct']\n    [expected ref 'IIncrementable'] Unexpected type on the stack.\n[offset 0x00000005] Call to base type of valuetype.<\/pre>\n
 This is all as expected.<\/p>\n
To be able to use callvirt<\/code> to call a method on a value type through an interface requires the box<\/code> instruction. This takes a value type from the stack, generates an object instance complete with sync block index and MethodTable<\/code> pointer, and copies the value type bytes into that object. However, the box<\/code> instruction requires the actual value type to be on the stack, rather than the address of the value type, like so (annotated with the stack state): <\/p>\n
.method public static void CallIncrement(        valuetype IncrementableStruct obj) {\nldarg.0                  \/\/ IncrementableStruct\nbox IncrementableStruct  \/\/ O[IncrementableStruct]\nldc.i4.5                 \/\/ O[IncrementableStruct],int32\ncallvirt instance void IIncrementable::Increment(int32)\nret<\/pre>\n<\/p>\n
So?<\/b><\/p>\n
As we’ve seen, due to how dynamic method dispatch works on .NET, callvirt<\/code> only works when the this<\/code> pointer is of type O<\/code>. To call an interface method on a value type requires the value type to be boxed first, which provides all the necessary information for dynamic dispatch to work. As my next post will detail, this complicates things for generic methods, where the generic type could be a reference or value type at runtime.<\/p>\n
Next time<\/a>: finally, generic methods!<\/p>\n","protected":false},"excerpt":{"rendered":"
Next up is a look at the details of callvirt and what happens when you call a virtual method. However, in order to do that, we first need to understand some of the low-level CLR datastructures, and what exactly an object instance is. Object instances Object instances are actually suprisingly small and lightweight things –……<\/p>\n","protected":false},"author":186659,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[143538,2],"tags":[],"coauthors":[],"class_list":["post-3179","post","type-post","status-publish","format-standard","hentry","category-dotnet-development","category-blogs"],"acf":[],"_links":{"self":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/3179","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/users\/186659"}],"replies":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/comments?post=3179"}],"version-history":[{"count":2,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/3179\/revisions"}],"predecessor-version":[{"id":75613,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/3179\/revisions\/75613"}],"wp:attachment":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/media?parent=3179"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/categories?post=3179"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/tags?post=3179"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/coauthors?post=3179"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}