How to debug/break in codedom compiled code

Question

I have an application which loads up c# source files dynamically and runs them as plugins. When I am running the main application in debug mode, is it possible to debug into the dynamic assembly? Obviously setting breakpoints is problematic, since the source is not part of the original project, but should I be able to step into, or break on exceptions for the code?

Is there a way to get codedom to generate PDBs for this or something?

Here is the code I am using for dynamic compliation.

CSharpCodeProvider codeProvider = new CSharpCodeProvider(new Dictionary<string, string>() { { "CompilerVersion", "v3.5" } });
//codeProvider.
ICodeCompiler icc = codeProvider.CreateCompiler();

CompilerParameters parameters = new CompilerParameters();
parameters.GenerateExecutable = false;
parameters.GenerateInMemory = true;
parameters.CompilerOptions = string.Format("/lib:\"{0}\"", Application.StartupPath);
parameters.ReferencedAssemblies.Add("System.dll");
parameters.ReferencedAssemblies.Add("System.Core.dll");


CompilerResults results = icc.CompileAssemblyFromSource(parameters, Source);
DLL.CreateInstance(t.FullName, false, BindingFlags.Default, null, new object[] { engine }, null, null);

Out of curiosity (I've never really messed with the CodeDom stuff) what happens if you try to put a System.Diagnostics.Debugger.Break(); somewhere in your code? Can you then step into it? — BFree
– BFree, Commented May 17, 2009 at 23:36
this worked, but only with the options in the accepted answer. — Jason Coyne
– Jason Coyne, Commented Jun 4, 2009 at 15:46
I duplicated this question per inadvertence (codedom was not the keywork I looked for). stackoverflow.com/questions/1593920/…. I added a solution involving an interface. Hope it helps... — jdehaan
– jdehaan, Commented Oct 20, 2009 at 14:16

bbmud · Accepted Answer · 2009-05-18 00:06:11Z

40

Try the following options:

parameters.GenerateInMemory = false; //default
parameters.TempFiles = new TempFileCollection(Environment.GetEnvironmentVariable("TEMP"), true);
parameters.IncludeDebugInformation = true;

I am not sure if this works OK in your case, but if it does, you can surround this parameters with conditional compilation directive, so that it dumps the generated assembly only in debug mode.

answered May 18, 2009 at 0:06

bbmud

2,68821 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Philip Over a year ago

It's 2.42 years later, but you sir, are AWESOME!

superachu Over a year ago

It saved my time to find out the issue :)

Vlad Isoc Over a year ago

It's 11 years later, and this information is still pure gold. Thanks!

Community · Accepted Answer · 2017-05-23 11:54:05Z

11

The answer by @bbmud is correct, though it misses one bug fix. The CSharpCodeGenerator (the class in .NET the compiles C# code to IL) is set to remove pdb files immediately after they are created, UNLESS you add /debug:pdbonly to the CompilerOptions string. However, if you do that, the IncludeDebugInformation flag is ignored and the compiler generates optimised code which is hard to debug. To avoid this you must explicitly tell the Code Generator to keep all files.

Here is the complete recipe:

parameters.GenerateInMemory = false; //default
parameters.TempFiles = new TempFileCollection(Environment.GetEnvironmentVariable("TEMP"), true);
parameters.IncludeDebugInformation = true;
parameters.TempFiles.KeepFiles = true

Here is the culprit part of the code of CSharpCodeGenerator:

  string fileExtension = "pdb";
    if ((options.CompilerOptions != null) && (CultureInfo.InvariantCulture.CompareInfo.IndexOf(options.CompilerOptions, "/debug:pdbonly", CompareOptions.IgnoreCase) != -1))
    {
        results.TempFiles.AddExtension(fileExtension, true);
    }
    else
    {
        results.TempFiles.AddExtension(fileExtension);
    }

The TempFiles.AddExtension(fileExtension, true) tells the compile to keep the pdb files. The else option of results.TempFiles.AddExtension(fileExtension); tells it to treat pdb as all temporary files which by default means delete them.

edited May 23, 2017 at 11:54

CommunityBot

11 silver badge

answered Nov 25, 2009 at 14:09

Boaz

26.3k22 gold badges72 silver badges78 bronze badges

1 Comment

Jean Hominal Over a year ago

The second argument in TempFileCollection (named "keepFiles") already sets the KeepFiles property to true. (or at least it does so in .NET 4.0)

Collectives™ on Stack Overflow

How to debug/break in codedom compiled code

2 Answers 2

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related