Ayende @ Rahien

Hi!
My name is Oren Eini
Founder of Hibernating Rhinos LTD and RavenDB.
You can reach me by phone or email:

ayende@ayende.com

+972 52-548-6969

, @ Q c

Posts: 5,953 | Comments: 44,409

filter by tags archive

ChallengeStop the leaks


Given the following API, can you think of a way that would prevent memory leaks?

public interface IBufferPool
{
    byte[] TakeBuffer(int size);
    void ReturnBuffer(byte[] buffer);
}

The problem with having something like this is that forgetting to return the buffer is going to cause a memory leak. Instead of having that I would like to have the application stop if a buffer is leaked. Leaked means that no one is referencing this buffer but it wasn’t returned to the pool.

What I would really like is that when running in debug mode, leaking a buffer would stop the entire application and tell me:

  • That a buffer was leaked.
  • What was the stack trace that allocated that buffer.

A solution will be posted tomorrow.

More posts in "Challenge" series:

  1. (28 Apr 2015) What is the meaning of this change?
  2. (26 Sep 2013) Spot the bug
  3. (27 May 2013) The problem of locking down tasks…
  4. (17 Oct 2011) Minimum number of round trips
  5. (23 Aug 2011) Recent Comments with Future Posts
  6. (02 Aug 2011) Modifying execution approaches
  7. (29 Apr 2011) Stop the leaks
  8. (23 Dec 2010) This code should never hit production
  9. (17 Dec 2010) Your own ThreadLocal
  10. (03 Dec 2010) Querying relative information with RavenDB
  11. (29 Jun 2010) Find the bug
  12. (23 Jun 2010) Dynamically dynamic
  13. (28 Apr 2010) What killed the application?
  14. (19 Mar 2010) What does this code do?
  15. (04 Mar 2010) Robust enumeration over external code
  16. (16 Feb 2010) Premature optimization, and all of that…
  17. (12 Feb 2010) Efficient querying
  18. (10 Feb 2010) Find the resource leak
  19. (21 Oct 2009) Can you spot the bug?
  20. (18 Oct 2009) Why is this wrong?
  21. (17 Oct 2009) Write the check in comment
  22. (15 Sep 2009) NH Prof Exporting Reports
  23. (02 Sep 2009) The lazy loaded inheritance many to one association OR/M conundrum
  24. (01 Sep 2009) Why isn’t select broken?
  25. (06 Aug 2009) Find the bug fixes
  26. (26 May 2009) Find the bug
  27. (14 May 2009) multi threaded test failure
  28. (11 May 2009) The regex that doesn’t match
  29. (24 Mar 2009) probability based selection
  30. (13 Mar 2009) C# Rewriting
  31. (18 Feb 2009) write a self extracting program
  32. (04 Sep 2008) Don't stop with the first DSL abstraction
  33. (02 Aug 2008) What is the problem?
  34. (28 Jul 2008) What does this code do?
  35. (26 Jul 2008) Find the bug fix
  36. (05 Jul 2008) Find the deadlock
  37. (03 Jul 2008) Find the bug
  38. (02 Jul 2008) What is wrong with this code
  39. (05 Jun 2008) why did the tests fail?
  40. (27 May 2008) Striving for better syntax
  41. (13 Apr 2008) calling generics without the generic type
  42. (12 Apr 2008) The directory tree
  43. (24 Mar 2008) Find the version
  44. (21 Jan 2008) Strongly typing weakly typed code
  45. (28 Jun 2007) Windsor Null Object Dependency Facility

Comments

Paul Stovell

Inside your implementation, have a List <tuple<weakreference,>

. In TakeBuffer, wrap the list you return in a weak reference, and store the stack trace. In ReturnBuffer, remove it from the list. Have a timer (or another trigger) and periodically go through the list. If any of the WeakReferences have a null target, the buffer has been leaked.

Paul Stovell

That was a List<Tuple<WeakReference, StackTrace>> - you need a better blog engine :)

Nathan Evans

Standard IDisposable pattern (with finalizer hook) and some #IF DEBUG conditional blocks.

The only uncertainty would be relying upon a GC to occur in order for the finalizer to be run. But your tests can simulate that.

Nathan Evans

Forgot to say, the StackTrace can be captured in the constructor (wrapped in #IF DEBUG of course) and stored in a private field. Then when the finalizer is called, maybe use Environment.FailFast to print a nice message with that stack trace info.

Ayende Rahien

Paul,

We are writing one right now.

Ayende Rahien

Paul,

That makes it a pretty complex system, and you are doing a lot that you probably shouldn't.

There is also the issue of concurrent updates of timer & buffer takes/ returns.

Linkgoron

Paul if I remember correctly you'd still be tied to the GC.

According to the docs using a ConditionalWeakTable and maybe another list with the keys would be better.

Nathan Evans

Something like this is what I had in mind:

http://pastebin.com/ULNYap6u

Obviously you'd use using {} blocks, where appropriate, when dealing with the IBufferContext's.

Ayende Rahien

This means that you now have to track IBufferContext, rather than just byte[]

There are better ways to do this.

Nathan Evans

In that case, I look forward to seeing the solution.

Duarte Nunes

Maybe you could have a ConditionalWeakTable<byte[], T>, where T is a type that defines a finalizer and has a StackTrace. If you throw an exception on the finalizer thread, the process dies. When a buffer is returned to the pool, you remove it from the table.

Ayende Rahien

Duarte,

Nice, and similar to how I decided to do this.

Alex Simkin

@Duarte

Could you please explain the solution. BufferPoolWithLeakDetection throws when system tries to garbage collect MemoryLeakException because buffer was already garbage collected. But if buffer was already garbage collected, where is the memory leak? No, it wasn't returned to the pool, but that's not what was asked.

Alex Simkin

Oh, sorry, didn't read carefully enough. That's exactly what was asked.

Comment preview

Comments have been closed on this topic.

FUTURE POSTS

No future posts left, oh my!

RECENT SERIES

  1. The RavenDB Comic Strip (3):
    28 May 2015 - Part III – High availability & sleeping soundly
  2. Special Offer (2):
    27 May 2015 - 29% discount for all our products
  3. RavenDB Sharding (3):
    22 May 2015 - Adding a new shard to an existing cluster, splitting the shard
  4. Challenge (45):
    28 Apr 2015 - What is the meaning of this change?
  5. Interview question (2):
    30 Mar 2015 - fix the index
View all series

Syndication

Main feed Feed Stats
Comments feed   Comments Feed Stats