e0af4d70f769592b341e4955f1cb8fa318acb318
[folly.git] / folly / experimental / RCUUtils.h
1 /*
2  * Copyright 2017 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17
18 #include <urcu.h> // @manual
19
20 namespace folly {
21
22 /**
23  * This must be called at least once from any thread, which uses RCUReadLock.
24  * First call should happen before RCUReadLock is used for the first time. Can
25  * be safely called more that once.
26  *
27  * Returns true when called for the first time from current thread.
28  */
29 bool RCURegisterThread();
30
31 class RCUReadLock {
32  public:
33   static RCUReadLock& instance();
34
35   static void lock() {
36     assert(RCURegisterThread() == false);
37     rcu_read_lock();
38   }
39
40   static void unlock() {
41     rcu_read_unlock();
42   }
43
44  private:
45   RCUReadLock() {}
46 };
47
48 }