dm-cache-policy-internal.h 4.36 KB
Newer Older
Joe Thornber's avatar
Joe Thornber committed
1 2 3 4 5 6 7 8 9
/*
 * Copyright (C) 2012 Red Hat. All rights reserved.
 *
 * This file is released under the GPL.
 */

#ifndef DM_CACHE_POLICY_INTERNAL_H
#define DM_CACHE_POLICY_INTERNAL_H

10
#include <linux/vmalloc.h>
Joe Thornber's avatar
Joe Thornber committed
11 12 13 14
#include "dm-cache-policy.h"

/*----------------------------------------------------------------*/

15 16
static inline int policy_lookup(struct dm_cache_policy *p, dm_oblock_t oblock, dm_cblock_t *cblock,
				int data_dir, bool fast_copy, bool *background_queued)
Joe Thornber's avatar
Joe Thornber committed
17
{
18
	return p->lookup(p, oblock, cblock, data_dir, fast_copy, background_queued);
Joe Thornber's avatar
Joe Thornber committed
19 20
}

21 22 23 24
static inline int policy_lookup_with_work(struct dm_cache_policy *p,
					  dm_oblock_t oblock, dm_cblock_t *cblock,
					  int data_dir, bool fast_copy,
					  struct policy_work **work)
Joe Thornber's avatar
Joe Thornber committed
25
{
26 27 28 29
	if (!p->lookup_with_work) {
		*work = NULL;
		return p->lookup(p, oblock, cblock, data_dir, fast_copy, NULL);
	}
Joe Thornber's avatar
Joe Thornber committed
30

31
	return p->lookup_with_work(p, oblock, cblock, data_dir, fast_copy, work);
Joe Thornber's avatar
Joe Thornber committed
32 33
}

34 35
static inline int policy_get_background_work(struct dm_cache_policy *p,
					     bool idle, struct policy_work **result)
Joe Thornber's avatar
Joe Thornber committed
36
{
37
	return p->get_background_work(p, idle, result);
Joe Thornber's avatar
Joe Thornber committed
38 39
}

40 41 42
static inline void policy_complete_background_work(struct dm_cache_policy *p,
						   struct policy_work *work,
						   bool success)
Joe Thornber's avatar
Joe Thornber committed
43
{
44
	return p->complete_background_work(p, work, success);
Joe Thornber's avatar
Joe Thornber committed
45 46
}

47
static inline void policy_set_dirty(struct dm_cache_policy *p, dm_cblock_t cblock)
Joe Thornber's avatar
Joe Thornber committed
48
{
49
	p->set_dirty(p, cblock);
Joe Thornber's avatar
Joe Thornber committed
50 51
}

52
static inline void policy_clear_dirty(struct dm_cache_policy *p, dm_cblock_t cblock)
Joe Thornber's avatar
Joe Thornber committed
53
{
54
	p->clear_dirty(p, cblock);
Joe Thornber's avatar
Joe Thornber committed
55 56
}

57 58 59
static inline int policy_load_mapping(struct dm_cache_policy *p,
				      dm_oblock_t oblock, dm_cblock_t cblock,
				      bool dirty, uint32_t hint, bool hint_valid)
Joe Thornber's avatar
Joe Thornber committed
60
{
61
	return p->load_mapping(p, oblock, cblock, dirty, hint, hint_valid);
Joe Thornber's avatar
Joe Thornber committed
62 63
}

64 65
static inline int policy_invalidate_mapping(struct dm_cache_policy *p,
					    dm_cblock_t cblock)
66
{
67
	return p->invalidate_mapping(p, cblock);
68 69
}

70 71
static inline uint32_t policy_get_hint(struct dm_cache_policy *p,
				       dm_cblock_t cblock)
Joe Thornber's avatar
Joe Thornber committed
72
{
73
	return p->get_hint ? p->get_hint(p, cblock) : 0;
Joe Thornber's avatar
Joe Thornber committed
74 75 76 77 78 79 80
}

static inline dm_cblock_t policy_residency(struct dm_cache_policy *p)
{
	return p->residency(p);
}

81
static inline void policy_tick(struct dm_cache_policy *p, bool can_block)
Joe Thornber's avatar
Joe Thornber committed
82 83
{
	if (p->tick)
84
		return p->tick(p, can_block);
Joe Thornber's avatar
Joe Thornber committed
85 86
}

87 88
static inline int policy_emit_config_values(struct dm_cache_policy *p, char *result,
					    unsigned maxlen, ssize_t *sz_ptr)
Joe Thornber's avatar
Joe Thornber committed
89
{
90
	ssize_t sz = *sz_ptr;
Joe Thornber's avatar
Joe Thornber committed
91
	if (p->emit_config_values)
92
		return p->emit_config_values(p, result, maxlen, sz_ptr);
Joe Thornber's avatar
Joe Thornber committed
93

94 95
	DMEMIT("0 ");
	*sz_ptr = sz;
Joe Thornber's avatar
Joe Thornber committed
96 97 98 99 100 101 102 103 104
	return 0;
}

static inline int policy_set_config_value(struct dm_cache_policy *p,
					  const char *key, const char *value)
{
	return p->set_config_value ? p->set_config_value(p, key, value) : -EINVAL;
}

105 106 107 108 109
static inline void policy_allow_migrations(struct dm_cache_policy *p, bool allow)
{
	return p->allow_migrations(p, allow);
}

Joe Thornber's avatar
Joe Thornber committed
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
/*
 * Some utility functions commonly used by policies and the core target.
 */
static inline size_t bitset_size_in_bytes(unsigned nr_entries)
{
	return sizeof(unsigned long) * dm_div_up(nr_entries, BITS_PER_LONG);
}

static inline unsigned long *alloc_bitset(unsigned nr_entries)
{
	size_t s = bitset_size_in_bytes(nr_entries);
	return vzalloc(s);
}

static inline void clear_bitset(void *bitset, unsigned nr_entries)
{
	size_t s = bitset_size_in_bytes(nr_entries);
	memset(bitset, 0, s);
}

static inline void free_bitset(unsigned long *bits)
{
	vfree(bits);
}

/*----------------------------------------------------------------*/

Joe Thornber's avatar
Joe Thornber committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
/*
 * Creates a new cache policy given a policy name, a cache size, an origin size and the block size.
 */
struct dm_cache_policy *dm_cache_policy_create(const char *name, dm_cblock_t cache_size,
					       sector_t origin_size, sector_t block_size);

/*
 * Destroys the policy.  This drops references to the policy module as well
 * as calling it's destroy method.  So always use this rather than calling
 * the policy->destroy method directly.
 */
void dm_cache_policy_destroy(struct dm_cache_policy *p);

/*
 * In case we've forgotten.
 */
const char *dm_cache_policy_get_name(struct dm_cache_policy *p);

157 158
const unsigned *dm_cache_policy_get_version(struct dm_cache_policy *p);

Joe Thornber's avatar
Joe Thornber committed
159 160 161 162 163
size_t dm_cache_policy_get_hint_size(struct dm_cache_policy *p);

/*----------------------------------------------------------------*/

#endif /* DM_CACHE_POLICY_INTERNAL_H */