OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CONTENT_COMMON_ONE_WRITER_SEQLOCK_H_ | 5 #ifndef DEVICE_BASE_SYNCHRONIZATION_ONE_WRITER_SEQLOCK_H_ |
6 #define CONTENT_COMMON_ONE_WRITER_SEQLOCK_H_ | 6 #define DEVICE_BASE_SYNCHRONIZATION_ONE_WRITER_SEQLOCK_H_ |
7 | 7 |
8 #include "base/atomicops.h" | 8 #include "base/atomicops.h" |
9 #include "base/macros.h" | 9 #include "base/macros.h" |
10 #include "base/threading/platform_thread.h" | 10 #include "base/threading/platform_thread.h" |
11 #include "content/common/content_export.h" | |
12 | 11 |
13 namespace content { | 12 namespace device { |
14 | 13 |
15 // This SeqLock handles only *one* writer and multiple readers. It may be | 14 // This SeqLock handles only *one* writer and multiple readers. It may be |
16 // suitable for low-contention with relatively infrequent writes, and many | 15 // suitable for low-contention with relatively infrequent writes, and many |
17 // readers. See: | 16 // readers. See: |
18 // http://en.wikipedia.org/wiki/Seqlock | 17 // http://en.wikipedia.org/wiki/Seqlock |
19 // http://www.concurrencykit.org/doc/ck_sequence.html | 18 // http://www.concurrencykit.org/doc/ck_sequence.html |
20 // This implementation is based on ck_sequence.h from http://concurrencykit.org. | 19 // This implementation is based on ck_sequence.h from http://concurrencykit.org. |
21 // | 20 // |
22 // Currently this type of lock is used in two implementations (gamepad and | 21 // Currently this type of lock is used in two implementations (gamepad and |
23 // device motion, in particular see e.g. shared_memory_seqlock_buffer.h). | 22 // device motion, in particular see e.g. shared_memory_seqlock_buffer.h). |
24 // It may make sense to generalize this lock to multiple writers. | 23 // It may make sense to generalize this lock to multiple writers. |
25 // | 24 // |
26 // You must be very careful not to operate on potentially inconsistent read | 25 // You must be very careful not to operate on potentially inconsistent read |
27 // buffers. If the read must be retry'd, the data in the read buffer could | 26 // buffers. If the read must be retry'd, the data in the read buffer could |
28 // contain any random garbage. e.g., contained pointers might be | 27 // contain any random garbage. e.g., contained pointers might be |
29 // garbage, or indices could be out of range. Probably the only suitable thing | 28 // garbage, or indices could be out of range. Probably the only suitable thing |
30 // to do during the read loop is to make a copy of the data, and operate on it | 29 // to do during the read loop is to make a copy of the data, and operate on it |
31 // only after the read was found to be consistent. | 30 // only after the read was found to be consistent. |
32 class CONTENT_EXPORT OneWriterSeqLock { | 31 class OneWriterSeqLock { |
33 public: | 32 public: |
34 OneWriterSeqLock(); | 33 OneWriterSeqLock(); |
35 base::subtle::Atomic32 ReadBegin(); | 34 base::subtle::Atomic32 ReadBegin(); |
36 bool ReadRetry(base::subtle::Atomic32 version); | 35 bool ReadRetry(base::subtle::Atomic32 version); |
37 void WriteBegin(); | 36 void WriteBegin(); |
38 void WriteEnd(); | 37 void WriteEnd(); |
39 | 38 |
40 private: | 39 private: |
41 base::subtle::Atomic32 sequence_; | 40 base::subtle::Atomic32 sequence_; |
42 DISALLOW_COPY_AND_ASSIGN(OneWriterSeqLock); | 41 DISALLOW_COPY_AND_ASSIGN(OneWriterSeqLock); |
43 }; | 42 }; |
44 | 43 |
45 } // namespace content | 44 } // namespace device |
46 | 45 |
47 #endif // CONTENT_COMMON_ONE_WRITER_SEQLOCK_H_ | 46 #endif // DEVICE_BASE_SYNCHRONIZATION_ONE_WRITER_SEQLOCK_H_ |
OLD | NEW |