Line data Source code
1 : // SPDX-License-Identifier: GPL-2.0-or-later
2 : #include "cache.h"
3 : #include "backing_dev.h"
4 : #include "cache_dev.h"
5 : #include "dm_pcache.h"
6 :
7 : /**
8 : * cache_key_gc - Releases the reference of a cache key segment.
9 : * @cache: Pointer to the pcache_cache structure.
10 : * @key: Pointer to the cache key to be garbage collected.
11 : *
12 : * This function decrements the reference count of the cache segment
13 : * associated with the given key. If the reference count drops to zero,
14 : * the segment may be invalidated and reused.
15 : */
16 38367825 : static void cache_key_gc(struct pcache_cache *cache, struct pcache_cache_key *key)
17 : {
18 38367825 : cache_seg_put(key->cache_pos.cache_seg);
19 : }
20 :
21 4963453 : static bool need_gc(struct pcache_cache *cache, struct pcache_cache_pos *dirty_tail, struct pcache_cache_pos *key_tail)
22 : {
23 4963453 : struct dm_pcache *pcache = CACHE_TO_PCACHE(cache);
24 4963453 : struct pcache_cache_kset_onmedia *kset_onmedia;
25 4963453 : void *dirty_addr, *key_addr;
26 4963453 : u32 segs_used, segs_gc_threshold, to_copy;
27 4963453 : int ret;
28 :
29 4963453 : dirty_addr = cache_pos_addr(dirty_tail);
30 4963453 : key_addr = cache_pos_addr(key_tail);
31 4963453 : if (dirty_addr == key_addr) {
32 2305 : pcache_dev_debug(pcache, "key tail is equal to dirty tail: %u:%u\n",
33 : dirty_tail->cache_seg->cache_seg_id,
34 : dirty_tail->seg_off);
35 2305 : return false;
36 : }
37 :
38 4961148 : kset_onmedia = (struct pcache_cache_kset_onmedia *)cache->gc_kset_onmedia_buf;
39 :
40 4961148 : to_copy = min(PCACHE_KSET_ONMEDIA_SIZE_MAX, PCACHE_SEG_SIZE - key_tail->seg_off);
41 4961148 : ret = copy_mc_to_kernel(kset_onmedia, key_addr, to_copy);
42 4961054 : if (ret) {
43 0 : pcache_dev_err(pcache, "error to read kset: %d", ret);
44 0 : return false;
45 : }
46 :
47 : /* Check if kset_onmedia is corrupted */
48 4961054 : if (kset_onmedia->magic != PCACHE_KSET_MAGIC) {
49 0 : pcache_dev_debug(pcache, "gc error: magic is not as expected. key_tail: %u:%u magic: %llx, expected: %llx\n",
50 : key_tail->cache_seg->cache_seg_id, key_tail->seg_off,
51 : kset_onmedia->magic, PCACHE_KSET_MAGIC);
52 0 : return false;
53 : }
54 :
55 : /* Verify the CRC of the kset_onmedia */
56 4961054 : if (kset_onmedia->crc != cache_kset_crc(kset_onmedia)) {
57 0 : pcache_dev_debug(pcache, "gc error: crc is not as expected. crc: %x, expected: %x\n",
58 : cache_kset_crc(kset_onmedia), kset_onmedia->crc);
59 0 : return false;
60 : }
61 :
62 4961056 : segs_used = bitmap_weight(cache->seg_map, cache->n_segs);
63 4961046 : segs_gc_threshold = cache->n_segs * pcache_cache_get_gc_percent(cache) / 100;
64 4961046 : if (segs_used < segs_gc_threshold) {
65 1978 : pcache_dev_debug(pcache, "segs_used: %u, segs_gc_threshold: %u\n", segs_used, segs_gc_threshold);
66 1978 : return false;
67 : }
68 :
69 : return true;
70 : }
71 :
72 : /**
73 : * last_kset_gc - Advances the garbage collection for the last kset.
74 : * @cache: Pointer to the pcache_cache structure.
75 : * @kset_onmedia: Pointer to the kset_onmedia structure for the last kset.
76 : */
77 88 : static void last_kset_gc(struct pcache_cache *cache, struct pcache_cache_kset_onmedia *kset_onmedia)
78 : {
79 88 : struct dm_pcache *pcache = CACHE_TO_PCACHE(cache);
80 88 : struct pcache_cache_segment *cur_seg, *next_seg;
81 :
82 88 : cur_seg = cache->key_tail.cache_seg;
83 :
84 88 : next_seg = &cache->segments[kset_onmedia->next_cache_seg_id];
85 :
86 88 : mutex_lock(&cache->key_tail_lock);
87 88 : cache->key_tail.cache_seg = next_seg;
88 88 : cache->key_tail.seg_off = 0;
89 88 : cache_encode_key_tail(cache);
90 88 : mutex_unlock(&cache->key_tail_lock);
91 :
92 88 : pcache_dev_debug(pcache, "gc advance kset seg: %u\n", cur_seg->cache_seg_id);
93 :
94 88 : spin_lock(&cache->seg_map_lock);
95 88 : __clear_bit(cur_seg->cache_seg_id, cache->seg_map);
96 88 : spin_unlock(&cache->seg_map_lock);
97 88 : }
98 :
99 4282 : void pcache_cache_gc_fn(struct work_struct *work)
100 : {
101 4282 : struct pcache_cache *cache = container_of(work, struct pcache_cache, gc_work.work);
102 4282 : struct dm_pcache *pcache = CACHE_TO_PCACHE(cache);
103 4282 : struct pcache_cache_pos dirty_tail, key_tail;
104 4282 : struct pcache_cache_kset_onmedia *kset_onmedia;
105 4282 : struct pcache_cache_key_onmedia *key_onmedia;
106 4282 : struct pcache_cache_key *key;
107 4282 : int ret;
108 4282 : int i;
109 :
110 4282 : kset_onmedia = (struct pcache_cache_kset_onmedia *)cache->gc_kset_onmedia_buf;
111 :
112 4963463 : while (true) {
113 4963463 : if (pcache_is_stopping(pcache) || atomic_read(&cache->gc_errors))
114 0 : return;
115 :
116 : /* Get new tail positions */
117 4963463 : mutex_lock(&cache->dirty_tail_lock);
118 4963439 : cache_pos_copy(&dirty_tail, &cache->dirty_tail);
119 4963385 : mutex_unlock(&cache->dirty_tail_lock);
120 :
121 4963468 : mutex_lock(&cache->key_tail_lock);
122 4963463 : cache_pos_copy(&key_tail, &cache->key_tail);
123 4963404 : mutex_unlock(&cache->key_tail_lock);
124 :
125 4963463 : if (!need_gc(cache, &dirty_tail, &key_tail))
126 : break;
127 :
128 4959053 : if (kset_onmedia->flags & PCACHE_KSET_FLAGS_LAST) {
129 : /* Don't move to the next segment if dirty_tail has not moved */
130 88 : if (dirty_tail.cache_seg == key_tail.cache_seg)
131 : break;
132 :
133 88 : last_kset_gc(cache, kset_onmedia);
134 88 : continue;
135 : }
136 :
137 43327433 : for (i = 0; i < kset_onmedia->key_num; i++) {
138 38368386 : struct pcache_cache_key key_tmp = { 0 };
139 :
140 38368386 : key_onmedia = &kset_onmedia->data[i];
141 :
142 38368386 : key = &key_tmp;
143 38368386 : cache_key_init(&cache->req_key_tree, key);
144 :
145 38367992 : ret = cache_key_decode(cache, key_onmedia, key);
146 38367825 : if (ret) {
147 : /* return without re-arm gc work, and prevent future
148 : * gc, because we can't retry the partial-gc-ed kset
149 : */
150 0 : atomic_inc(&cache->gc_errors);
151 0 : pcache_dev_err(pcache, "failed to decode cache key in gc\n");
152 0 : return;
153 : }
154 :
155 38367825 : cache_key_gc(cache, key);
156 : }
157 :
158 4959047 : pcache_dev_debug(pcache, "gc advance: %u:%u %u\n",
159 : key_tail.cache_seg->cache_seg_id,
160 : key_tail.seg_off,
161 : get_kset_onmedia_size(kset_onmedia));
162 :
163 4959051 : mutex_lock(&cache->key_tail_lock);
164 4959081 : cache_pos_advance(&cache->key_tail, get_kset_onmedia_size(kset_onmedia));
165 4959004 : cache_encode_key_tail(cache);
166 4957944 : mutex_unlock(&cache->key_tail_lock);
167 : }
168 :
169 4283 : queue_delayed_work(cache_get_wq(cache), &cache->gc_work, PCACHE_CACHE_GC_INTERVAL);
170 : }
|
