summaryrefslogtreecommitdiffstats
path: root/kernel/cache.c
blob: b47e32b78593a1730cbe82112f1af013b811ac8d (plain) (blame)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/*
 * cache.c - block cache with red-black trees
 * Copyright (C) 2006 Thorsten Zitterell <thorsten@zitterell.de>
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/highmem.h>
#include <linux/fs.h>
#include <linux/file.h>
/* use red-black library of kernel */
#include <linux/rbtree.h>
#include <linux/version.h>
#include <asm/uaccess.h>

#include "../common/dnbd-cliserv.h"
#include "cache.h"

/* empty node */
#define rb_entry_cn(node)	rb_entry((node), struct cache_node, rb_node)

/* dummy operations of no cache is used */
int dnbd_cache_dummy_search(dnbd_cache_t * cache, struct request *req)
{
	return 0;
}

int dnbd_cache_dummy_insert(dnbd_cache_t * cache, sector_t block,
			    void *buf)
{
	return 0;
}

void dnbd_cache_dummy_clean(dnbd_cache_t * cache)
{
	return;
}

int dnbd_cache_search(dnbd_cache_t * cache, struct request *req)
{
	/* hold segment as we copy from user space */
	mm_segment_t old_fs = get_fs();
	size_t blksize;
	void *kaddr;

	#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24))
		int i;
		struct bio *bio;
	#else
		struct req_iterator iter;
	#endif
	struct bio_vec *bvec;

	int result = 0, rbytes;
	struct rb_node *n;
	struct cache_node *cn;
	loff_t offset;
	char *buf;

	down(&cache->sema);
	n = cache->root.rb_node;
	blksize = cache->blksize;

	/* search for block */
	while (n) {
		cn = rb_entry_cn(n);

		if (req->sector < cn->rb_key)
			n = n->rb_left;
		else if (req->sector > cn->rb_key)
			n = n->rb_right;
		else
			goto found;
	}
	/* block is not cached */
	cache->miss++;
	goto out;

	/* cached block was found */
      found:
	cache->hits++;
	offset = cn->rb_data * blksize;
	#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24))
	rq_for_each_bio(bio, req) {
		bio_for_each_segment(bvec, bio, i) {
	#else
	rq_for_each_segment(bvec, req, iter) {
	#endif
			if (bvec->bv_len > blksize) {
				printk(KERN_WARNING
				       "bvec->bv_len greater than cache block size\n");
				goto out;
			}
			/* copy cached block from cache file */
			set_fs(get_ds());
			buf = req->buffer;
			kaddr = kmap(bvec->bv_page);
			rbytes =
			    vfs_read(cache->filp, kaddr + bvec->bv_offset,
				     bvec->bv_len, &offset);
			kunmap(bvec->bv_page);
			set_fs(old_fs);

			/* error on reading? */
			if (rbytes != bio_iovec(req->bio)->bv_len) {
				printk
				    ("dnbd: ERROR reading from cache!\n");
				result = 0;
				goto out;
			}

			result += rbytes;
			if (result == blksize)
				goto out;
	#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24))
		}
	#endif
	}

      out:
	up(&cache->sema);

	/* return number of copied sectors */
	return result >> 9;
}

int dnbd_cache_insert(dnbd_cache_t * cache, sector_t sector, void *buf)
{
	mm_segment_t old_fs = get_fs();
	int result = 0;
	struct rb_node **p;
	struct rb_node *parent = NULL;
	cache_node_t *__cn, *cn;
	sector_t act_block;

	loff_t offset;

	down(&cache->sema);
	p = &cache->root.rb_node;

	/* red-black tree search and replacement in O(log n) */
	
	/* check if node was already inserted to cache and,
	   if necessary, do LRU replacement */
	
	while (*p) {
		parent = *p;
		__cn = rb_entry_cn(parent);
		if (sector < __cn->rb_key)
			p = &(*p)->rb_left;
		else if (sector > __cn->rb_key)
			p = &(*p)->rb_right;
		else {
			/* the sector was already added to cache */

			/* LRU replacement policy */
			if (__cn->prev)
				__cn->prev->next = __cn->next;
			else
				/* __cn is head - do nothing */
				goto no_lru;

			if (__cn->next)
				__cn->next->prev = __cn->prev;
			else
				/* __cn is tail - so set new one */
				cache->tail =
				    (__cn->prev ? __cn->prev : __cn);

			/* insert new node to head:
			   head of list has no predecessor, 
			   set previous node to NULL and next 
			   node to old head and set new head */

			__cn->prev = NULL;
			__cn->next = cache->head;

			if (cache->head)
				cache->head->prev = __cn;

			cache->head = __cn;

			cache->lru++;
		      no_lru:
			result = 1;
			goto out;
		}
	}

	/* check if cache is full */
	if (cache->used_blocks == cache->max_blocks) {
		/* 
		   remove LRU node (cn), but keep reserved 
		   data structure in memory 
		*/
		cn = cache->tail;
		cache->tail->prev->next = NULL;
		cache->tail = cache->tail->prev;

		/*
		   Node (which is tail of LRU list) will be erased from tree 
		   which is then rebalanced. 
		   Re-finding a parent for the a node is mandatory.
		 */
		act_block = cn->rb_data;
		rb_erase(&cn->rb_node, &cache->root);
		p = &cache->root.rb_node;
		while (*p) {
			parent = *p;
			__cn = rb_entry_cn(parent);
			if (sector < __cn->rb_key)
				p = &(*p)->rb_left;
			else
				p = &(*p)->rb_right;
		}
	} else {
		/* cache is not full, so reserve memory for red-black tree node */
		if (!
		    (cn =
		     (cache_node_t *) kmalloc(sizeof(cache_node_t),
					      GFP_KERNEL))) {
			result = -ENOMEM;
			goto out;
		}
		act_block = cache->used_blocks;
		/* cn = &cache->nodes[act_block]; */
		cache->used_blocks++;
	}
	
	/* write block to cache file */	
	offset = act_block * cache->blksize;
	set_fs(get_ds());
	result = vfs_write(cache->filp, buf, cache->blksize, &offset);
	set_fs(old_fs);

	if (result != cache->blksize) {
		printk("dnbd: ERROR writing to cache!\n");
		cache->used_blocks--;
		kfree(cn);
		goto out;
	}
	
	/* cn (current node) points to an empty node, now */
	cn->rb_key = sector;
	cn->rb_data = act_block;

	/* current node (which will become the new head) has no predecessor */
	cn->prev = NULL;
	cn->next = cache->head;

	/* adapt head element - if it exists */
	if (cache->head)
		cache->head->prev = cn;

	/* set new head */
	cache->head = cn;

	/* set new tail */
	if (!cache->tail)
		cache->tail = cn;

	/* call kernel helpers for red-black trees */
	rb_link_node(&cn->rb_node, parent, p);
	rb_insert_color(&cn->rb_node, &cache->root);

      out:
	up(&cache->sema);
	return result;
}

int dnbd_cache_init(dnbd_cache_t * cache)
{
	int result = -EINVAL;

	/* initialize cache */
	cache->active = 0;
	
	/* set dummy function, if no cache is used */
	cache->insert = &dnbd_cache_dummy_insert;
	cache->search = &dnbd_cache_dummy_search;
	cache->clean = &dnbd_cache_dummy_clean;

	cache->root.rb_node = NULL;

	cache->max_blocks = 0;
	cache->used_blocks = 0;
	cache->blksize = 0;

	cache->hits = 0;
	cache->miss = 0;
	cache->lru = 0;

	cache->filp = NULL;
	cache->fname = NULL;

	cache->head = NULL;
	cache->tail = NULL;
	spin_lock_init(&cache->lock);
	init_MUTEX(&cache->sema);

	result = 0;
	return result;
}

void dnbd_cache_clean(dnbd_cache_t * cache)
{
	cache_node_t *node;
	cache_node_t *tmp;
	int cnt = 0;

	spin_lock(&cache->lock);
	node = cache->head;

	cache->head = NULL;
	cache->tail = NULL;

	if (cache->fname)
		kfree(cache->fname);

	/* free memory of all nodes; start with head */
	while (node) {
		tmp = node;
		node = node->next;
		kfree(tmp);
		cnt++;
	}
	printk(KERN_INFO "dnbd: freed %i cache nodes\n", cnt);

	cache->active = 0;
	spin_unlock(&cache->lock);

}

int dnbd_cache_set(dnbd_cache_t * cache, struct dnbd_file __user * arg,
		   size_t blksize)
{
	int result = -EINVAL;
	struct dnbd_file cfile;
	struct kstat stat;
	loff_t div1;
	size_t div2;

	if (cache->active) {
		printk(KERN_ERR "dnbd: cachefile is already set!\n");
		return -EFAULT;
	}

	/* open, verify and set cache file */
	if (copy_from_user(&cfile, arg, sizeof(cfile)))
		return -EFAULT;

	if (!(cache->fname = (char *) kmalloc(cfile.len + 1, GFP_KERNEL)))
		return -ENOMEM;

	if (copy_from_user
	    (cache->fname, (void __user *) cfile.name, cfile.len)) {
		result = -EFAULT;
		goto out_free;
	}
	*(cache->fname + cfile.len) = 0;

	printk(KERN_INFO "dnbd: setting cachefile to %s\n", cache->fname);

	cache->filp = filp_open(cache->fname, O_RDWR | O_LARGEFILE, 0);

	if (cache->filp == NULL || IS_ERR(cache->filp)) {
		printk(KERN_ERR "dnbd: ERROR opening cache file!\n");
		result = -EINVAL;
		goto out_free;
	}

	generic_fillattr(cache->filp->f_dentry->d_inode, &stat);

	div1 = stat.size;
	div2 = blksize;
	do_div(div1, div2);

	printk(KERN_INFO
	       "dnbd: cachefile size %llu KB using %llu blocks a %i bytes for caching.\n",
	       stat.size >> 10, div1, blksize);

	cache->max_blocks = div1;
	cache->blksize = blksize;

	/* activate cache and adapt function for insert, search and clean up */
	cache->active = 1;
	cache->insert = &dnbd_cache_insert;
	cache->search = &dnbd_cache_search;
	cache->clean = &dnbd_cache_clean;

	result = 0;
	goto out;

      out_free:
	kfree(cache->fname);
      out:
	if (result < 0 && cache->filp)
		fput(cache->filp);
	return result;
}