File: CopyOnWriteList.cs

package info (click to toggle)
dlr-languages 20090805%2Bgit.e6b28d27%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 51,484 kB
  • ctags: 59,257
  • sloc: cs: 298,829; ruby: 159,643; xml: 19,872; python: 2,820; yacc: 1,960; makefile: 96; sh: 65
file content (159 lines) | stat: -rw-r--r-- 5,252 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* ****************************************************************************
 *
 * Copyright (c) Microsoft Corporation. 
 *
 * This source code is subject to terms and conditions of the Microsoft Public License. A 
 * copy of the license can be found in the License.html file at the root of this distribution. If 
 * you cannot locate the  Microsoft Public License, please send an email to 
 * dlr@microsoft.com. By using this source code in any fashion, you are agreeing to be bound 
 * by the terms of the Microsoft Public License.
 *
 * You must not remove this notice, or any other, from this software.
 *
 *
 * ***************************************************************************/

using System.Collections.Generic;
using System.Threading;
using Microsoft.Contracts;

namespace Microsoft.Scripting.Utils {
    /// <summary>
    /// List optimized for few writes and multiple reads. It provides thread-safe read and write access. 
    /// Iteration is not thread-safe by default, but GetCopyForRead allows for iteration 
    /// without taking a lock.
    /// </summary>
    public class CopyOnWriteList<T> : IList<T> {
        List<T> _list = new List<T>();

        List<T> GetNewListForWrite() {
            List<T> oldList = _list;
            List<T> newList = new List<T>(oldList.Count + 1);
            newList.AddRange(oldList);
            return newList;
        }

        /// <summary>
        /// Gets a copy of the contents of the list. The copy will not change even if the original
        /// CopyOnWriteList object is modified. This method should be used to iterate the list in
        /// a thread-safe way if no lock is taken. Iterating on the original list is not guaranteed 
        /// to be thread-safe.
        /// </summary>
        /// <returns>The returned copy should not be modified by the caller.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")] // TODO: fix
        public List<T> GetCopyForRead() {
            // Just return the underlying list
            return _list;
        }

        #region IList<T> Members

        public int IndexOf(T item) {
            return _list.IndexOf(item);
        }

        public void Insert(int index, T item) {
            List<T> oldList, replacedList;
            do {
                oldList = _list;
                List<T> newList = GetNewListForWrite();
                newList.Insert(index, item);
                replacedList = Interlocked.CompareExchange(ref _list, newList, oldList);
            } while (replacedList != oldList);
        }

        public void RemoveAt(int index) {
            List<T> oldList, replacedList;
            do {
                oldList = _list;
                List<T> newList = GetNewListForWrite();
                newList.RemoveAt(index);
                replacedList = Interlocked.CompareExchange(ref _list, newList, oldList);
            } while (replacedList != oldList);
        }

        public T this[int index] {
            get {
                return _list[index];
            }

            set {
                List<T> oldList, replacedList;
                do {
                    oldList = _list;
                    List<T> newList = GetNewListForWrite();
                    newList[index] = value;
                    replacedList = Interlocked.CompareExchange(ref _list, newList, oldList);
                } while (replacedList != oldList);
            }
        }

        #endregion

        #region ICollection<T> Members

        public void Add(T item) {
            List<T> oldList, replacedList;
            do {
                oldList = _list;
                List<T> newList = GetNewListForWrite();
                newList.Add(item);
                replacedList = Interlocked.CompareExchange(ref _list, newList, oldList);
            } while (replacedList != oldList);
        }

        public void Clear() {
            _list = new List<T>();
        }

        [Confined]
        public bool Contains(T item) {
            return _list.Contains(item);
        }

        public void CopyTo(T[] array, int arrayIndex) {
            _list.CopyTo(array, arrayIndex);
        }

        public int Count {
            get { return _list.Count; }
        }

        public bool IsReadOnly {
            get { return false; }
        }

        public bool Remove(T item) {
            List<T> oldList, replacedList;
            bool ret;
            do {
                oldList = _list;
                List<T> newList = GetNewListForWrite();
                ret = newList.Remove(item);
                replacedList = Interlocked.CompareExchange(ref _list, newList, oldList);
            } while (replacedList != oldList);

            return ret;
        }

        #endregion

        #region IEnumerable<T> Members

        [Pure]
        public IEnumerator<T> GetEnumerator() {
            return _list.GetEnumerator();
        }

        #endregion

        #region IEnumerable Members

        [Pure]
        System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() {
            return ((System.Collections.IEnumerable)_list).GetEnumerator();
        }

        #endregion
    }
}