Blogs

The Case of the Temporary Registry Profiles

  • Comments 70
  • Likes

Microsoft Customer Support Services (CSS) is one of the biggest customers of the Sysinternals tools and they often send me interesting cases they’ve solved with them. This particular case is especially interesting because it affected a large number of users and the troubleshooting process made use of one of Process Monitor’s lesser-known features. The case opened when a customer contacted Microsoft support reporting that several of their users would occasionally get this error message when loggging on to their systems:

image

This caused Windows to create a temporary profile for the user’s logon session. A user profile consists of a directory, %UserProfile%, into which applications save user-specific configuration and data files, as well as a registry hive file stored in that directory, %UserProfile%\Ntuser.dat, that the Winlogon process loads when the user logs in. Applications store user settings in the registry hive by calling registry functions that refer to the HKEY_CURRENT_USER (HKCU) root key. The user’s loss of access to their profile made the problem critical, because whenever that happened, the user would apparently lose all their settings and access to files stored in their profile directory. In most cases, users contacted the company’s support desk, which would ask the user to try rebooting and logging in until the problem resolved itself.

As with all cases, Microsoft support began by asking about the system configuration, inventory of installed software, and about any recent changes the company had made to their systems. In this case, the fact that stood out was that all the systems on which the problem had occurred had recently been upgraded to a new version of Citrix Corporation's ICA client, a remote desktop application. Microsoft contacted Citrix support to see if they knew of any issues with the new client. They didn’t, but said they would investigate.

Unsure whether the ICA client upgrade was responsible for the profile problem, Microsoft support instructed the customer to enable profile logging, which you can do by configuring a registry key as per this Knowledge Base article: How to enable user environment debug logging in retail builds of Windows. The customer pushed a script out to their systems to make the required registry changes and shortly after got another call from a user with the profile problem. They grabbed a copy of the profile log off the system from %SystemRoot%\Debug\UserMode\Userenv.log and sent it into Microsoft. The log was inconclusive, but did provide an important clue: it indicated that the user’s profile had failed to load because of error 32, which is ERROR_SHARING_VIOLATION:

image

When a process opens a file, it specifies what kinds of sharing it allows for the file. If it is writing to the file it may allow other processes to read from the file, for example, but not to also write to the file. The sharing violation in the log file meant that another process had opened the user’s registry hive in a way that was incompatible with the way that the logon process wanted to open the file.

In the meantime, more customers around the world began contacting Microsoft and Citrix with the same issue, all had also deployed the new ICA client. Citrix support then reported that they suspected that the sharing violation might be caused by one of the ICA client’s processes, Ssonvr.exe. During installation, the ICA client registers a Network Provider DLL (Pnsson.dll) that the Windows Multiple Provider Notification Application (%SystemRoot%\System32\Mpnotify.exe) calls when the system boots. Mpnotify.exe is itself launched at logon by the Winlogon process.The Citrix notification DLL launches the Ssonvr.exe process asynchronous to the user’s logon:

image

The only problem with the theory was that Citrix developers insisted that the process did not attempt to load any user registry profile or even read any keys or values from one. Both Microsoft and Citrix were stumped.

Microsoft created a version of Winlogon and the kernel with additional diagnostic information and tried to reproduce the problem on lab systems configured identically to the client’s, but without success. The customer couldn’t even reproduce the problem with the modified Windows images, presumably because the images changed the timing of the system enough to avoid the problem. At this point a Microsoft support engineer suggested that the customer capture a trace of logon activity with Process Monitor.

There are a couple of ways to configure Process Monitor to record logon operations: one is to use Sysinternals PsExec to launch it in the session 0 so that it survives the logoff and subsequent logon and another is to use the boot logging feature to capture activity from early in the boot, including the logon. The engineer chose the latter, so he told the customer to run Process Monitor on one of the system’s that persistently exhibited the problem, select Enable Boot Logging from the Process Monitor Options menu, and reboot, repeating the steps until the problem reproduced. This procedure configures the Process Monitor driver to load early in the boot process and log activity to %SystemRoot%\Procmon.pmb. Once the user logged encountered the issue, they were to run Process Monitor again, at which point the driver would stop logging and Process Monitor would offer to convert the boot log into a standard Process Monitor log file.

After a couple of attempts the user captured a boot log file that they submitted to Microsoft. Microsoft support engineers scanned through the log and came across the sharing violation error when Winlogon tried to load the user’s registry hive:

image

It was obvious from operations immediately preceding the error that Ssonsvr.exe was the process that had the hive opened. The question was, why was Ssonsvr.exe opening the registry hive? To answer that question the engineers turned to Process Monitor’s stack trace functionality. Process Monitor captures a call stack for every operation, which represents the function call nesting responsible for the operation. By looking at a call stack you can often determine an operation’s root cause when it might not be obvious just from the process that executed it. For example, the stack shows you if a DLL loaded into the process executed the operation and, if you have symbols configured and the call originates in a Windows image or other image for which you have symbols, it will even show you the names of the responsible functions.

The stack for Ssonsvr.exe’s open of the Ntuser.dat file showed that Ssonsvr.exe wasn’t actually responsible for the operation, the Windows Logical Prefetcher was:

image

Introduced in Windows XP, the Logical Prefetcher is a kernel component that monitors the first ten seconds of a process launch, recording the directories and portions of files accessed by the process during that time to a file it stores in %SystemRoot%\Prefetch. So that multiple executables with the same name but in different directories get their own prefetch file, the Logical Prefetcher gives the file a name that’s a concatenation of the executable image name and the hash of the path in which the image is stored e.g. NOTEPAD.EXE-D8414F97.pf. You can actually see the files and directories the Logical Prefetcher saw an application reference the last time it launched by using the Sysinternals Strings utility to scan a prefetch file like this:

strings <prefetch file>

The next time the application launches, the Logical Prefetcher, executing in the context of the process’s first thread, looks for a prefetch file. If one exists, it opens each directory it lists to bring the directory’s metadata into memory if not already present. The Logical Prefetcher then maps each file listed in the prefetch file and references the portions accessed the last time the application ran so that they also get brought into memory. The Logical Prefetcher can speed up an application launch because it generates large, sequential I/Os instead of issuing small random accesses to file data as the application would typically do during startup.

The implication of the Logical Prefetcher in the profile problem only raised more questions, however. Why was it prefetching the user’s hive file in the context of Ssonsvr.exe when Ssonsvr.exe itself never accesses registry profiles? Microsoft support contacted the Logical Prefetcher’s development team for the answer. The developers first noted that the registry on Windows XP is read into memory using cached file I/O operations, which means that the Cache Manager’s read-ahead thread will proactively read portions of the hive. Since the read-ahead thread executes in the System process, and the Logical Prefetcher associates System process activity with the currently launching process, that a specific timing sequence of process launches and activity during the boot and log on could cause hive accesses to be seen by the Logical Prefetcher as being part of the Ssonsvr.exe launch. If the order was slightly different the next boot and log on, Winlogon might collide with the Logical Prefetcher, as seen in the captured boot log.

The Logical Prefetcher is supposed to execute transparently to other activity on a system, but its file references can lead to sharing violations like this on Windows XP systems (on server systems the Logical Prefetcher only prefetches boot activity, and it does so synchronously before the boot process proceeds). For that reason, on Windows Vista and Windows 7 systems, the Logical Prefetcher makes use of a file system minifilter driver, Fileinfo (%SystemRoot%\System32\Drivers\Fileinfo.sys), to watch for potential sharing violation collisions and prevent them by stalling a second open operation on a file being accessed by the Logical Prefetcher until the Logical Prefetcher closes the file.

Now that the problem was understood, Microsoft and Citrix brainstormed on workarounds customers could apply while Citrix worked on an update to the ICA Client that would prevent the sharing violation. One workaround was to disable application prefetching and another was to write a logoff script that deletes the Ssonsvr.exe prefetch files. Citrix published the workarounds in this Citrix Knowledge Base article and Microsoft in this Microsoft Knowledge Base article. The update to the ICA Client, which was made available a few days later, changed the network provider DLL to 10 seconds after Ssonsvr.exe launches before returning control to Mpnotify.exe. Because Winlogon waits for Mpnotify to exit before logging on a user, the Logical Prefetcher won’t associate Winlogon’s accesses of the user’s hive with Ssonsvr.exe’s startup.

As I said in the introduction, I find this case particularly interesting because it demonstrates a little known Process Monitor feature, boot logging, and the power of stack traces for root cause analysis, two key tools for everyone’s troubleshooting arsenal. It also shows how successful troubleshooting sometimes means coming up with a workaround when there’s no fix or you must wait until a vendor provides one. Another case successfully closed with Process Monitor! Please keep sending me screen shots and log files of the cases you solve.

Your comment has been posted.   Close
Thank you, your comment requires moderation so it may take a while to appear.   Close
Leave a Comment
  • Mark, a small typo in this excellent article - "could cause hive accesses to been by the Logical Prefetcher as being part". Been -> be seen

    Interesting investigation, thanks :)

  • Thanks for an excellent article. It demonstrates what I've always believed about much of the Windows OS- It is WAY more complex than it should be: Its like the wild west in there with only a few general guidelines and no regulation.

    MS does have a lot of great ideas, but many of the ideas and their implementations make me _shudder_. The registry is one idea that was poorly done. Prefetch may be a good idea for some systems, but not any pc's that I have used. The fact that prefetch gets bitten by registry only shows the severe limitations on the registry implementation, like so many other parts of the OS.

    OT: My wish is that the Windows OS only had a single file called "WINDOWS.SYS" that only MS can update (or developers who want to dare take the chance). I've been stung too many times by DLL hell and application updates that messed around with the OS system files.

  • > Microsoft and Citrix brainstormed on workarounds customers could apply while Citrix worked on an update to the ICA Client that would prevent the sharing violation.

    What I don't understand is why Citrix should solve  a problem which is obviously created by Microsoft Windows? This is MS team who should introduce the patch, not Citrix.

  • Hi,Mark,

    It's intersting.

    And I always use Process Monitor and Process Explorer to slove my problem.

    Those sysinternals tools make my life easy.

    Thank you very much!

  • Great article, and it is also one of the most detailed descriptions of the "prefetch" feature I've seen so far.

  • Mark,

    Very interesting article, thank you! I actually had this error message a little while ago too but it turned out to be something not related to the Citrix ICA software at all. I never did figure out what the problem was because at the time I had never heard about Process Monitor, but this information might help me troubleshoot it better in the future.

    Thanks!

    David

  • @Michael Fitzpatrick - [Tuesday, August 11, 2009 2:25 AM]

    > Thanks for an excellent article. It demonstrates what I've always believed about much of the Windows OS- It is WAY more complex than it should be: Its like the wild west in there with only a few general guidelines and no regulation.

    Really? How? What would make it simpler? Do you think the combination of the X window system and Linux/BSD kernel is more elegant/simpler?

    >  The registry is one idea that was poorly done.

    Why is it poorly done? Are INI files better? Or maybe move to OS X's version of the registry called PList's? They all have their pitfalls.

    > The fact that prefetch gets bitten by registry only shows the severe limitations on the registry implementation, like so many other parts of the OS.

    I thought the problem was due to pre-fetch, not the registry. They fixed the issue in Vista/7 by fixing pre-fetch. Read the article again.

    > OT: My wish is that the Windows OS only had a single file called "WINDOWS.SYS" that only MS can update (or developers who want to dare take the chance). I've been stung too many times by DLL hell and application updates that messed around with the OS system files.

    Did you write this response in 1998? Yes, I also wish that every necessary dependency was in A SINGLE FILE!! Then, every time I needed to patch a bug in the networking code, I'd also have to patch the kernel, the filesystem, the wlan, the HAL, etc.

  • I have occasionally run into this very issue.  Good to know the reason!

  • I agree with Alexei; this is a Microsoft problem.  And I don't see how this is specific to Citrix at all; this issue could have shown up in any application.

  • @Alexei: A patch that changes an OS component requires much more exhaustive QA. There's a trade-off between the number of problems you solve and the number of problems you potentially introduce.

    Even if Microsoft had said "yes, it's an OS problem and we're going to patch it too" (which they may very well have said or may still say, the story is silent on that), Citrix still would have said "that's great, now please advise us on how to patch *our* software since we can do it quicker and our customers are waiting".

    When your customers are in trouble, you don't ask "who's responsible for this and when are they planning to do something about it", you ask "what can we (all people willing to contribute) do to fix this problem as quickly as possible". In that sense, whether Microsoft decided or ever will decide to patch it is utterly irrelevant to both Citrix and their customers (except insofar as it might impact their current solution). All the people who *might* experience the same problem in some other form aren't in the picture yet.

    @John: that's probably why they changed it for Vista and Windows 7. But that still doesn't mean you automatically go back and patch your existing OS. The fact that this bug was so hard to reproduce in the first place is probably a sign this behavior rarely causes trouble, at least not of the magnitude seen here.

  • On Windows Vista some issue with Windows Media Player sharing service. If it loads and opens user profile before system :).

  • “The developers first noted that the registry on Windows XP is read into memory using cached file I/O operations, which means that the Cache Manager’s read-ahead thread will proactively read portions of the hive proactively. Since the read-ahead thread executes in the System process, and the Logical Prefetcher associates System process activity with the currently launching process”

    Excuse my ability of understanding. I'm still having trouble understand the root cause of the problem. The above sentence to be specific.

    So the cache mgr will read the ntuser.dat when the system boots, and Logical Prefetcher will record cache mgr's access pattern, but why it has anything to do with Ssonsvr.exe shouldn't it be running in the context of the System process?

    Thanks,

  • @liys: the Prefetcher associates the activities of the System process with the user process that's currently launching. It does this because much activity is indirectly done by the system on behalf of the process, especially during process startup -- capturing this activity makes for better prefetching. Keeping this activity separate only makes sense at boot time, when the System process is the only thing running (this is not literally true, by the way, but a good enough approximation).

    The fact that Prefetcher can't distinguish between System process activity on behalf of the process being prefetched and system activity that's unrelated is what causes the problem. Simply not recording System process activity at all would make prefetching much less effective.

  • The discussion above makes an interesting point: Citrix is a responsible company that cares about its customers.  Whoever was at fault, they put in the workaround so their customers won't run into the problem.

    I've seen plenty of companies that tracked an issue outside of their code and then said, "Nyah nyah, it's their fault, don't try to get us to do anything."  Gets even worse in the case of conflicting interpretations of a spec.  "No, we're right and they're wrong."

    It's also pretty common in the open-source community.  The calling app considers the problem to be in the dependency, while the dependency thinks that it's a corner case that's not worth the time to investigate.  Meanwhile, you just want the problem to be fixed.

  • Nice write up. Our company ran into this issue a few months back. At that time, I captured the same Userenv.log error you have posted. That info helped isolate the problem with the Citrix client. Our company is on a older version 9.2 of the ICA client. Our user base is over 100K. All the machines work off a common XP build with same version of Citrix. The problem was only occuring with a single business unit. This was the part that has us baffled. Do you have any details on what could spur the problem for some users and not others with same desktop build? Thanks.