How do you enable “Enable .NET Framework source stepping”?

120
votes

Update 22nd Feb 2013: The Microsoft Connect entry has note from Alok Shriram (Program Manager, Base Class Libraries, .NET Framework) that the issue should now be resolved. The Connect entry is marked as Resolved (Fixed):

This issue should now be fixed. We published an update to reference sources. Please let us know in case your issue is still not fixed.

Year and a half.

Bonus Links

Original Question

How do I enable .NET framework source stepping in Visual Studio 2010?

Note: This question is one piece of a larger whole:

Visual Studio 2010 comes with a new feature:

  • Tools, Options, Debugging, General, Enable .NET Framework source stepping

Screenshot of options menu

Following the instructions on the MSDN page How to: Debug .NET Framework Source:

To enable .NET Framework source debugging

  1. On the Tools menu, click Options.

  2. In the Options dialog box, click the Debugging category.

  3. In the General box, select the following check boxes:

    • Enable .NET Framework source stepping
    • Enable source server support

I do this:

Screenshot of options menu, highlighting the relevant options selected

Note: You will note, as the MSDN page notes, and as I noticed, that checking Enable .NET Framework source stepping will automatically uncheck **Enable Just My Code (Managed only). I also enabled the diagnostic messages of source server support.

Enabling those options automatically set a symbol cache download location for me:

Screenshot of options menu, showing cache directory (highlighted)

Note: The Microsoft Symbol Server entry is already present (and cannot be removed).

The MSDN page says to load the symbols:

To load Framework symbols using the Modules window

  1. In the Modules window, right-click a module for which symbols are not loaded. You can tell if symbols are loaded or not by looking at the Symbols Status column.

  2. Point to Load Symbols From and click Microsoft Symbol Servers to download symbols from the Microsoft public symbols server or Symbol Path to load from a directory where you have previously stored symbols.

I try this:

enter image description here

and then all the symbols are loaded:

Screenshot of modules window, as described above

I’ve been sitting on a breakpoint, which is about to call into .NET framework code:

Screenshot of code, transcribed below

protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
{
    base.ScaleControl(factor, specified);

Pushing F11 causes the debugger to simply skip to the next line:

Screenshot of code, transcribed below

protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
{
    base.ScaleControl(factor, specified);

    //Record the running scale factor used
    this.scaleFactor = new SizeF(
            this.scaleFactor.Width * factor.Width,
            this.scaleFactor.Height * factor.Height);

How do I enable .NET Framework source stepping in Visual Studio 2010?

I am sitting at a breakpoint in my code. I try double-clicking on a function further up in the call stack. This would, I hope, allow me to jump to the .NET code:

enter image description here

Except that it doesn’t work: Visual Studio tells me that there’s no source available:

Screenshot of error message saying No Source Available

How do I enable .NET Framework source stepping in Visual Studio 2010?

If I switch to disassembly view before trying to step into .NET code (Debug -> Windows -> Disassembly), I can see a call into the .NET code:

Screenshot of code

And when I do, I end up debugging a disassembly of System.Windows.Forms.ScaleControl:

Screenshot of disassembly window

Which isn’t the same as, or as useful as, being able to step into the .NET Framework source.

How do I enable .NET Framework source stepping in Visual Studio 2010?

The configured symbol cache path on my computer does contain symbol cache files:

Screenshot of folder listing

So it is downloading pdb symbol files, but refusing to use them.

How do I enable .NET Framework source stepping in Visual Studio 2010?

Leppie suggested that I check the Debug log (with the debug log window open; otherwise it doesn’t log anything):

Step into: Stepping over method without symbols 'System.Windows.Forms.Form.ScaleControl'

Earlier in the log I see it loading symbols for System.Windows.Forms.dll:

Loaded 'C:\Windows\assembly\GAC_MSIL\System.Windows.Forms\2.0.0.0__b77a5c561934e089\System.Windows.Forms.dll', Symbols loaded.

enter image description here

So it is finding my symbols, but claiming that it couldn’t find them.

How do I enable .NET Framework source stepping in Visual Studio 2010?

A guy from Microsoft Italy suggests turning off Require source files to exactly match original version:

Screenshot of options window

That didn’t fix it.

How do I enable .NET Framework source stepping in Visual Studio 2010?

It has been suggested that there’s a bug with Microsoft’s source server for .NET Framework 4.0. Following that suggestion, I switched the project to target .NET Framework 3.5:

enter image description here

That didn’t fix it.

How do I enable .NET Framework source stepping in Visual Studio 2010?

Someone somewhere idly wondered whether another person experiencing the same problem was using the 64-bit version of the debugger. Now, there’s no such thing as a 64-bit version of Visual Studio, but I tried switching my project from AnyCPU to x86 (it was being JITed to x64), in case Microsoft doesn’t support 64-bit processors:

enter image description here

That didn’t fix it:

Step into: Stepping over method without symbols 'System.Windows.Forms.Form.ScaleControl'

How do I enable .NET Framework source stepping in Visual Studio 2010?

See also

8
.netvisual-studio-2010visual-studio
Have you checked the source code 'cache' ? – leppie
@leppie What do you mean by the "source code 'cache'"? If you mean the folder that caches the source code in, it is being populated (See Update 4) – Ian Boyd
Yes. Is it possible to open that source file, and set a breakpoint? – leppie
excellent write up of the issue! – andersonbd1
It doesn't work in VS2012 either. It worked for a day, after I configured everything and just stopped working. Two days, dozens of coffes, hundreds of web pages later it just doesn't work. In the same time, sources published by symbolsource.org just do work like a charm. – Wiktor Zychla

8 Answers

35
votes

The PDBs for stepping through the source code are only posted for RTM and Service Packs. As such, when security update comes out and it modifies the dll you are trying to debug, it will cause source stepping to not work (that is, you'll get the "No source Available" with a greyed out "Browse to find Source").

However, once you've made all the appropriate settings, you can use the following workaround. The workaround is essentially to find the security updates that caused the dll to change, and then remove them. This has the obvious downside of having those security updates removed on your machine.

Workaround

  1. Identify which dll you want to debug into (e.g. System.Windows.Forms.dll)
  2. While debugging, open the Modules window in Visual studio, find the Version column. If the version is not the RTM or Service pack version, then you'll need to do the workflow. Typically the RTM dll will say "built by: RTMRel". While a dll that was part of a security update will say "built by: RTMGDR". Note the version number (for example 4.0.30319.269 built by: RTMGDR)
  3. Now, we want to find the update that created this version. Do this by searching for the dll and version number at support.microsoft.com/kb/ For example, I did the following google search: site:support.microsoft.com/kb System.Windows.Forms.dll 4.0.30319.269
  4. The search should turn up information about an update. Note the KB number in the address bar. In my example the address was http://support.microsoft.com/kb/2604121, so KB2604121, is what we're interested in.
  5. Go to Control Panel->Programs and Features, and click "View Installed Updates"
  6. Find an update which lists the KB number (you can use the search in the upper right box).
  7. Uninstall that update.
  8. Repeat this process for this same dll until the dll is back to its RTMRel version or SP version. For example, for System.Windows.Forms.dll, I had to remove KB2686827, KB2604121, KB2518870 before it was back to the RTMRel version.

You'll need to do this for each dll within the .NET framework that you care about debugging into.

Once that's done, set a breakpoint within the .net source (for example, go to the Breakpoints tab, say New->Break at Function, and enter System.Windows.Forms.Form.Form) or step into one of the .net methods in that dll.

6
votes

While unfortunately there is a problem with a Microsoft, as Leppie pointed out (and I got the same result see

it should be noted that your attempt would fail anyway, since you referenced:

  • Microsoft Symbol Server

instead of:

  • referencesource.microsoft.com/symbols

See the FAQ/Troubleshooting section of Configuring Visual Studio to Debug .NET Framework Source Code

4
votes

I have found the answer, I think.

I traced what was happening on Fiddler. It seems only the symbols are currently available, and no source.

When VS tries to load the symbols from the 'referencesource' server it fails (404). As this fails, I think it cannot map to source files on that server.

http://referencesource.microsoft.com/symbols/mscorlib.pdb/ED96A7F38A2940F39B9CA7AD9BC5CB671/mscorlib.pdb

After the above failure, it tries some server called 'msdl' where it finds the actual PDB (but it appears this one have no source code info).

http://msdl.microsoft.com/download/symbols/mscorlib.pdb/ED96A7F38A2940F39B9CA7AD9BC5CB671/mscorlib.pd_

All in all, it appears to be a (temporary) Microsoft issue with their servers.

I am sure I had some source code a while back. But now it is not working.

Edit:

I tried it with various .NET versions, all the same result. :(

1
votes

For now it is not working if you have SP1 installed. Here are some comment about problem form MS: http://social.msdn.microsoft.com/Forums/en-US/refsourceserver/thread/41388c7b-582b-4e3f-8178-3d38a3c99639

1
votes

In my case, I was debugging an old .NET 2.0 WinForms application and I got the "Source Not Available" message. I tried all the recommended settings.

Ultimately, I rebuilt the app to temporarily target .NET 4.5 and was able to get the source stepping to work. Perhaps my app was just too old for source stepping. Kind of defeats the purpose, I know, but for quick and dirty testing it works. The bug I have is still present in .NET 4.5. :)

Target Framework

0
votes

You can find the reference source here, available for download:

.NET Framework 4.0 Reference source

The sources for WCF, WF, and even the 4.5 Beta / RC and many more can be found there, too:

Microsoft Referencesource NetFramework

0
votes

Here are the official instructions https://referencesource.microsoft.com/setup.html

Configure Visual Studio 2013 for debugging .NET framework

In order to configure Visual Studio 2013 do the following in the Tools -> Options -> Debugging -> General menu:

  • Disable just my code
  • Disable step over properties and operators
  • Disable require source files to exactly match the original version
  • Enable .NET framework source stepping
  • Enable source server support
-2
votes

if you want to debug open source code (such as nuget package), you can add this url to your symbol server list

http://srv.symbolsource.org/pdb/Public

http://www.symbolsource.org/Public/Home/VisualStudio