blob: 3f60db41b2f0fdce0f6944cf527b3594f2ff8e8e [file] [log] [blame]
Nick Piggin095975d2006-01-08 01:02:19 -08001Refcounter design for elements of lists/arrays protected by RCU.
Dipankar Sarmac0dfb292005-09-09 13:04:09 -07002
3Refcounting on elements of lists which are protected by traditional
4reader/writer spinlocks or semaphores are straight forward as in:
5
Nick Piggin095975d2006-01-08 01:02:19 -080061. 2.
7add() search_and_reference()
8{ {
9 alloc_object read_lock(&list_lock);
10 ... search_for_element
11 atomic_set(&el->rc, 1); atomic_inc(&el->rc);
12 write_lock(&list_lock); ...
13 add_element read_unlock(&list_lock);
14 ... ...
15 write_unlock(&list_lock); }
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070016}
17
183. 4.
19release_referenced() delete()
20{ {
Nick Piggin095975d2006-01-08 01:02:19 -080021 ... write_lock(&list_lock);
22 atomic_dec(&el->rc, relfunc) ...
23 ... delete_element
24} write_unlock(&list_lock);
25 ...
26 if (atomic_dec_and_test(&el->rc))
27 kfree(el);
28 ...
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070029 }
30
31If this list/array is made lock free using rcu as in changing the
32write_lock in add() and delete() to spin_lock and changing read_lock
Nick Piggin095975d2006-01-08 01:02:19 -080033in search_and_reference to rcu_read_lock(), the atomic_get in
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070034search_and_reference could potentially hold reference to an element which
Nick Piggin095975d2006-01-08 01:02:19 -080035has already been deleted from the list/array. atomic_inc_not_zero takes
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070036care of this scenario. search_and_reference should look as;
37
381. 2.
39add() search_and_reference()
40{ {
Nick Piggin095975d2006-01-08 01:02:19 -080041 alloc_object rcu_read_lock();
42 ... search_for_element
43 atomic_set(&el->rc, 1); if (atomic_inc_not_zero(&el->rc)) {
44 write_lock(&list_lock); rcu_read_unlock();
45 return FAIL;
46 add_element }
47 ... ...
48 write_unlock(&list_lock); rcu_read_unlock();
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070049} }
503. 4.
51release_referenced() delete()
52{ {
Nick Piggin095975d2006-01-08 01:02:19 -080053 ... write_lock(&list_lock);
54 atomic_dec(&el->rc, relfunc) ...
55 ... delete_element
56} write_unlock(&list_lock);
57 ...
58 if (atomic_dec_and_test(&el->rc))
59 call_rcu(&el->head, el_free);
60 ...
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070061 }
62
63Sometimes, reference to the element need to be obtained in the
Nick Piggin095975d2006-01-08 01:02:19 -080064update (write) stream. In such cases, atomic_inc_not_zero might be an
65overkill since the spinlock serialising list updates are held. atomic_inc
Dipankar Sarmac0dfb292005-09-09 13:04:09 -070066is to be used in such cases.
Nick Piggin095975d2006-01-08 01:02:19 -080067