2 * Copyright (C) 2012 Red Hat. All rights reserved.
4 * This file is released under the GPL.
7 #ifndef DM_CACHE_POLICY_INTERNAL_H
8 #define DM_CACHE_POLICY_INTERNAL_H
10 #include <linux/vmalloc.h>
11 #include "dm-cache-policy.h"
13 /*----------------------------------------------------------------*/
15 static inline int policy_lookup(struct dm_cache_policy *p, dm_oblock_t oblock, dm_cblock_t *cblock,
16 int data_dir, bool fast_copy, bool *background_queued)
18 return p->lookup(p, oblock, cblock, data_dir, fast_copy, background_queued);
21 static inline int policy_lookup_with_work(struct dm_cache_policy *p,
22 dm_oblock_t oblock, dm_cblock_t *cblock,
23 int data_dir, bool fast_copy,
24 struct policy_work **work)
26 if (!p->lookup_with_work) {
28 return p->lookup(p, oblock, cblock, data_dir, fast_copy, NULL);
31 return p->lookup_with_work(p, oblock, cblock, data_dir, fast_copy, work);
34 static inline int policy_get_background_work(struct dm_cache_policy *p,
35 bool idle, struct policy_work **result)
37 return p->get_background_work(p, idle, result);
40 static inline void policy_complete_background_work(struct dm_cache_policy *p,
41 struct policy_work *work,
44 return p->complete_background_work(p, work, success);
47 static inline void policy_set_dirty(struct dm_cache_policy *p, dm_cblock_t cblock)
49 p->set_dirty(p, cblock);
52 static inline void policy_clear_dirty(struct dm_cache_policy *p, dm_cblock_t cblock)
54 p->clear_dirty(p, cblock);
57 static inline int policy_load_mapping(struct dm_cache_policy *p,
58 dm_oblock_t oblock, dm_cblock_t cblock,
59 bool dirty, uint32_t hint, bool hint_valid)
61 return p->load_mapping(p, oblock, cblock, dirty, hint, hint_valid);
64 static inline int policy_invalidate_mapping(struct dm_cache_policy *p,
67 return p->invalidate_mapping(p, cblock);
70 static inline uint32_t policy_get_hint(struct dm_cache_policy *p,
73 return p->get_hint ? p->get_hint(p, cblock) : 0;
76 static inline dm_cblock_t policy_residency(struct dm_cache_policy *p)
78 return p->residency(p);
81 static inline void policy_tick(struct dm_cache_policy *p, bool can_block)
84 return p->tick(p, can_block);
87 static inline int policy_emit_config_values(struct dm_cache_policy *p, char *result,
88 unsigned maxlen, ssize_t *sz_ptr)
91 if (p->emit_config_values)
92 return p->emit_config_values(p, result, maxlen, sz_ptr);
99 static inline int policy_set_config_value(struct dm_cache_policy *p,
100 const char *key, const char *value)
102 return p->set_config_value ? p->set_config_value(p, key, value) : -EINVAL;
105 static inline void policy_allow_migrations(struct dm_cache_policy *p, bool allow)
107 return p->allow_migrations(p, allow);
110 /*----------------------------------------------------------------*/
113 * Some utility functions commonly used by policies and the core target.
115 static inline size_t bitset_size_in_bytes(unsigned nr_entries)
117 return sizeof(unsigned long) * dm_div_up(nr_entries, BITS_PER_LONG);
120 static inline unsigned long *alloc_bitset(unsigned nr_entries)
122 size_t s = bitset_size_in_bytes(nr_entries);
126 static inline void clear_bitset(void *bitset, unsigned nr_entries)
128 size_t s = bitset_size_in_bytes(nr_entries);
129 memset(bitset, 0, s);
132 static inline void free_bitset(unsigned long *bits)
137 /*----------------------------------------------------------------*/
140 * Creates a new cache policy given a policy name, a cache size, an origin size and the block size.
142 struct dm_cache_policy *dm_cache_policy_create(const char *name, dm_cblock_t cache_size,
143 sector_t origin_size, sector_t block_size);
146 * Destroys the policy. This drops references to the policy module as well
147 * as calling it's destroy method. So always use this rather than calling
148 * the policy->destroy method directly.
150 void dm_cache_policy_destroy(struct dm_cache_policy *p);
153 * In case we've forgotten.
155 const char *dm_cache_policy_get_name(struct dm_cache_policy *p);
157 const unsigned *dm_cache_policy_get_version(struct dm_cache_policy *p);
159 size_t dm_cache_policy_get_hint_size(struct dm_cache_policy *p);
161 /*----------------------------------------------------------------*/
163 #endif /* DM_CACHE_POLICY_INTERNAL_H */