Add concurrent implementation of an ObjectPool to reuse small objects like Node instances
[mono.git] / mcs / class / corlib / System.Collections.Concurrent / ObjectPool.cs
1 // ObjectPool.cs
2 //
3 // Copyright (c) 2011 Novell
4 //
5 // Authors: 
6 //      Jérémie "garuma" Laval
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 // THE SOFTWARE.
25 //
26 //
27
28 #if NET_4_0 || MOBILE
29
30 using System;
31 using System.Threading;
32 using System.Collections;
33 using System.Collections.Generic;
34 using System.Runtime.Serialization;
35
36 namespace System.Collections.Concurrent
37 {
38         internal abstract class ObjectPool<T> where T : class
39         {
40                 const int capacity = 20;
41                 const int bit = 0x8000000;
42
43                 readonly T[] buffer;
44                 int addIndex;
45                 int removeIndex;
46
47                 public ObjectPool ()
48                 {
49                         buffer = new T[capacity];
50                         for (int i = 0; i < capacity; i++)
51                                 buffer[i] = Creator ();
52                         addIndex = capacity - 1;
53                 }
54
55                 protected abstract T Creator ();
56
57                 public T Take ()
58                 {
59                         if ((addIndex & ~bit) - 1 == removeIndex)
60                                 return Creator ();
61
62                         int i;
63                         T result;
64
65                         do {
66                                 i = removeIndex;
67                                 if ((addIndex & ~bit) - 1 == i)
68                                         return Creator ();
69                                 result = buffer[i % capacity];
70                         } while (Interlocked.CompareExchange (ref removeIndex, i + 1, i) != i);
71
72                         return result;
73                 }
74
75                 public void Release (T obj)
76                 {
77                         if (obj == null || addIndex - removeIndex >= capacity - 1)
78                                 return;
79
80                         int i;
81                         int tries = 3;
82                         do {
83                                 do {
84                                         i = addIndex;
85                                 } while ((i & bit) > 0);
86                                 if (i - removeIndex >= capacity - 1)
87                                         return;
88                         } while (Interlocked.CompareExchange (ref addIndex, i + 1 + bit, i) != i && --tries > 0);
89
90                         buffer[i % capacity] = obj;
91                         addIndex = addIndex - bit;
92                 }
93         }
94 }
95
96 #endif