Reflection Only Assembly Loading

Article
08/24/2004

.Net Framework 2.0 introduces several new assembly loading APIs.

Assembly.ReflectionOnlyLoadFrom(String assemblyFile)

Assembly.ReflectionOnlyLoad(byte[] rawAssembly)

Assembly.ReflectionOnlyLoad(String assemblyName)

And Assembly class now has ReflectionOnly property to tell you if an assembly is loaded as reflection only or not.

As you can infer from the name of those APIs, Assembly returned from those APIs can only be used for reflection. Any intention to create an instance of types in those assemblies will result in InvalidOperationException.

There are a few scenarios those APIs address:

Being able to confidently inspection any given assembly.
Being able to inspect exactly the given bits.

The normal assembly loading APIs can’t satisfy those scenarios, for the following reasons:

Assembly may be delay-signed.
Assembly may be prohibited by CAS policy.
Assembly may have a different processor architecture that can not be loaded in the running process.
Code in the target assembly may be executed during assembly loading. (For example, module constructor)
Binding Policy may be applied, and you may not get the exact same assembly as you specified.

For those reasons, Reflection Only Assembly Load APIs will:

Skip assembly strong name verifications
Skip CAS policy check
Skip processor architecture loading rule
Not execute any code in the target assembly, including module constructor
Not apply any binding policy.

Reflection Only Assembly Load APIs behave quite differently from the execution assembly load APIs.

There is one inspection context per AppDomain. All the reflection only assemblies live in that context.
Reflection only assemblies will be unloaded only when the AppDomain is unloaded, same as execution assemblies.
CLR will not probe for dependencies. The user of those APIs is responsible to provide all the necessary assemblies using Reflection Only Assembly Load APIs. The reason of this decision is that by probing dependencies, CLR may return a different assembly than the one you want. And it will be very difficult to overwrite CLR’s decision. However, if an assembly with the same idemtity is already loaded in the inspection context, CLR will use it to satisfy the dependency.
All reflection only assemblies will be cached. Only one assembly per identity is allowed in the inspection context. It does not matter how that assembly was loaded – the first one loaded always wins. This means:
1. If someone attempts to load a second one using ReflectionOnlyLoadFrom(), it will fail with a FileLoadException. The decision is based on 3). If multiple assemblies are allowed to be loaded in inspection context, CLR will not know which assembly to be used when looking for dependencies.
2. If ReflectionOnlyLoad() is called on an assembly when another assembly with that identity was already loaded, the already-loaded assembly will be returned.
ReflectionOnlyAssemblyResolve event will be fired, instead of AssemblyResolve event.
You have to return a reflection only assembly in ReflectionOnlyAssemblyResolve event handler.
CLR will not return instances of custom attributes, since that means executing code of the target assembly. Instead, a new class CustomAttributeData will be used to return information about the custom attributes.

In .Net framework 2.0 ReflectionOnly APIs cannot be used to reflect other mscorlib.dll (for example, v1.0/v1.1/NetCF). The reason is that mscorlib.dll is being special cased by CLR Loader all over the code base. It will be a major work to make it work. This may be possible in future version of .Net framework.

</Update>

So how will you use the Reflection Only Assembly Load APIs?

You will likely start with Assembly.ReflectionOnlyLoadFrom
You will need to subscribe to ReflectionOnlyAssemblyResolve
You probably want to check if the dependency exists in the same directory as the target assembly (or any other directories defined by you). If no assembly matches there, you will resort to Assembly.ReflectionOnlyLoad.

I recommend using Assembly.ReflectionOnlyLoadFrom whenever possible, and only use Assembly.ReflectionOnlyLoad for assemblies in GAC. The reason is the same as CLR not probing dependencies --- when CLR starts probing application base, it may return something you don’t want.

Here is a very simple sample application showing using Reflection Only Assembly Load APIs.

C:\ >more test.cs

using System;

using System.IO;

using System.Reflection;

public class ReflectionOnlyLoadTest

{

public ReflectionOnlyLoadTest(String rootAssembly)

{

m_rootAssembly = rootAssembly;

}

public static void Main(String[] args)

{

if (args.Length != 1) {

Console.WriteLine("Usage: Test assemblyPath");

return;

}

try {

ReflectionOnlyLoadTest rolt = new ReflectionOnlyLoadTest(args[0]);

rolt.Run();

}

catch (Exception e) {

Console.WriteLine("Exception: {0}!!!", e.Message);

}

internal void Run()

{

AppDomain curDomain = AppDomain.CurrentDomain;

curDomain.ReflectionOnlyPreBindAssemblyResolve += new ResolveEventHandler(MyReflectionOnlyResolveEventHandler);

Assembly asm = Assembly.ReflectionOnlyLoadFrom(m_rootAssembly);

// force loading all the dependencies

Type[] types = asm.GetTypes();

// show reflection only assemblies in current appdomain

Console.WriteLine("------------- Inspection Context --------------");

foreach (Assembly a in curDomain.ReflectionOnlyGetAssemblies())

{

Console.WriteLine("Assembly Location: {0}", a.Location);

Console.WriteLine("Assembly Name: {0}", a.FullName);

Console.WriteLine();

}

private Assembly MyReflectionOnlyResolveEventHandler(object sender, ResolveEventArgs args)

{

AssemblyName name = new AssemblyName(args.Name);

String asmToCheck = Path.GetDirectoryName(m_rootAssembly) + "\\" + name.Name + ".dll";

if (File.Exists(asmToCheck)) {

return Assembly.ReflectionOnlyLoadFrom(asmToCheck);

}

return Assembly.ReflectionOnlyLoad(args.Name);

}

private String m_rootAssembly;

}

C:\ >test c:\windows\Microsoft.NET\Framework\v2.0.40607\system.dll

------------- Inspection Context --------------

Assembly Location: c:\windows\Microsoft.NET\Framework\v2.0.40607\system.dll

Assembly Name: System, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5

c561934e089

Assembly Location: c:\windows\Microsoft.NET\Framework\v2.0.40607\Microsoft.Vsa.d

Assembly Name: Microsoft.Vsa, Version=8.0.1200.0, Culture=neutral, PublicKeyToke

n=b03f5f7f11d50a3a

Assembly Location: c:\windows\Microsoft.NET\Framework\v2.0.40607\System.Xml.dll

Assembly Name: System.Xml, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b

77a5c561934e089

Comments

Anonymous
May 02, 2005
I discussed ReflectionOnlyAssemblyLoad in detail here:
http://blogs.msdn.com/junfeng/archive/2004/08/24/219691.aspx...
Anonymous
September 14, 2005
I saw Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context. Apart from the...
Anonymous
September 14, 2005
I saw Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context. Apart from the...
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 14, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
September 16, 2005
I&nbsp;was reading&nbsp;Joel's blog about new stuff in Reflection and he mentioned ReflectionOnly context....
Anonymous
February 23, 2006
PingBack from http://word.leoagricola.net/?p=4
Anonymous
February 23, 2006
PingBack from http://word.leoagricola.net/?p=7
Anonymous
February 24, 2006
PingBack from http://word.leoagricola.net/?p=10
Anonymous
September 08, 2007
PingBack from http://chrisweber.wordpress.com/2007/09/08/reflection-only-assembly-loading/

Share via

Reflection Only Assembly Loading

Comments

Additional resources