msbuild icon indicating copy to clipboard operation
msbuild copied to clipboard

Eliminate project string cache under a change wave.

Open AR-May opened this issue 2 years ago • 4 comments

Fixes #5444

Context The ProjectStringCache does seem to have a memory leak problem when used from VS. The reason of the leak is that it clears memory on the event from ProjectRootElementCache, which is raised when project is moved out of the strong cache. The unproper use of ProjectRootElementCache might lead to ProjectStringCache not freeing memory.

Also, there were doubts if this cache adds anything at all to performance. Experiments does not show significant difference for the two cases.

We decided to remove ProjectStringCache under a change wave.

Changes Made

  • Put usage of ProjectStringCache under change waves below 17.4.

Testing Unit tests Experimental insertion

Notes

  • The previous PR (that eliminates the ProjectStringCache altogether with the related code): #7952.
  • Another option is to use string interning from StringTools instead.

AR-May avatar Sep 13 '22 12:09 AR-May

Would it be cleaner to put this check in the cache rather than all its callers?

danmoseley avatar Sep 13 '22 14:09 danmoseley

Ah, yes, nice idea, I will move the check.

AR-May avatar Sep 13 '22 15:09 AR-May

About avoiding taking the lock. I wonder what happens if somebody would mix calls with and without disabling the change wave 17.4. It then may lead to errors and memory leaks. If we should care about that case, I would prefer to keep it as it is. I do not expect Clear to be called too often, since the capacity of strong ProjectRootElementCache is bigger now and there are not so many rotations in it, which triggers the clear.

AR-May avatar Sep 14 '22 15:09 AR-May

About avoiding taking the lock. I wonder what happens if somebody would mix calls with and without disabling the change wave 17.4. It then may lead to errors and memory leaks. If we should care about that case, I would prefer to keep it as it is. I do not expect Clear to be called too often, since the capacity of strong ProjectRootElementCache is bigger now and there are not so many rotations in it, which triggers the clear.

I think it would be ok. First, I think most people set it via environment variable, so you'll often either run builds with it enabled or disabled but not mixed. Second, getting an early out for clear would mean the disabled version would just not touch the cache the whole time, and the enabled version would touch then eventually clear the cache by itself, so they shouldn't interfere with each other. I don't think it matters too much, though.

Forgind avatar Sep 14 '22 19:09 Forgind

I changed the ChangeWave version in this PR from 17.4 to 17.6, since this PR did not get into 17.4.

AR-May avatar Oct 14 '22 12:10 AR-May