1 /*
2 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 */
13 #ifndef __ND_H__
14 #define __ND_H__
15 #include <linux/libnvdimm.h>
16 #include <linux/badblocks.h>
17 #include <linux/blkdev.h>
18 #include <linux/device.h>
19 #include <linux/mutex.h>
20 #include <linux/ndctl.h>
21 #include <linux/types.h>
22 #include <linux/nd.h>
23 #include "label.h"
24
25 enum {
26 /*
27 * Limits the maximum number of block apertures a dimm can
28 * support and is an input to the geometry/on-disk-format of a
29 * BTT instance
30 */
31 ND_MAX_LANES = 256,
32 SECTOR_SHIFT = 9,
33 INT_LBASIZE_ALIGNMENT = 64,
34 NVDIMM_IO_ATOMIC = 1,
35 };
36
37 struct nd_poison {
38 u64 start;
39 u64 length;
40 struct list_head list;
41 };
42
43 struct nvdimm_drvdata {
44 struct device *dev;
45 int nslabel_size;
46 struct nd_cmd_get_config_size nsarea;
47 void *data;
48 int ns_current, ns_next;
49 struct resource dpa;
50 struct kref kref;
51 };
52
53 struct nd_region_data {
54 int ns_count;
55 int ns_active;
56 unsigned int hints_shift;
57 void __iomem *flush_wpq[0];
58 };
59
ndrd_get_flush_wpq(struct nd_region_data * ndrd,int dimm,int hint)60 static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
61 int dimm, int hint)
62 {
63 unsigned int num = 1 << ndrd->hints_shift;
64 unsigned int mask = num - 1;
65
66 return ndrd->flush_wpq[dimm * num + (hint & mask)];
67 }
68
ndrd_set_flush_wpq(struct nd_region_data * ndrd,int dimm,int hint,void __iomem * flush)69 static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
70 int hint, void __iomem *flush)
71 {
72 unsigned int num = 1 << ndrd->hints_shift;
73 unsigned int mask = num - 1;
74
75 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
76 }
77
to_namespace_index(struct nvdimm_drvdata * ndd,int i)78 static inline struct nd_namespace_index *to_namespace_index(
79 struct nvdimm_drvdata *ndd, int i)
80 {
81 if (i < 0)
82 return NULL;
83
84 return ndd->data + sizeof_namespace_index(ndd) * i;
85 }
86
to_current_namespace_index(struct nvdimm_drvdata * ndd)87 static inline struct nd_namespace_index *to_current_namespace_index(
88 struct nvdimm_drvdata *ndd)
89 {
90 return to_namespace_index(ndd, ndd->ns_current);
91 }
92
to_next_namespace_index(struct nvdimm_drvdata * ndd)93 static inline struct nd_namespace_index *to_next_namespace_index(
94 struct nvdimm_drvdata *ndd)
95 {
96 return to_namespace_index(ndd, ndd->ns_next);
97 }
98
99 unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);
100
101 #define namespace_label_has(ndd, field) \
102 (offsetof(struct nd_namespace_label, field) \
103 < sizeof_namespace_label(ndd))
104
105 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
106 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
107 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
108 (unsigned long long) (res ? resource_size(res) : 0), \
109 (unsigned long long) (res ? res->start : 0), ##arg)
110
111 #define for_each_dpa_resource(ndd, res) \
112 for (res = (ndd)->dpa.child; res; res = res->sibling)
113
114 #define for_each_dpa_resource_safe(ndd, res, next) \
115 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
116 res; res = next, next = next ? next->sibling : NULL)
117
118 struct nd_percpu_lane {
119 int count;
120 spinlock_t lock;
121 };
122
123 enum nd_label_flags {
124 ND_LABEL_REAP,
125 };
126 struct nd_label_ent {
127 struct list_head list;
128 unsigned long flags;
129 struct nd_namespace_label *label;
130 };
131
132 enum nd_mapping_lock_class {
133 ND_MAPPING_CLASS0,
134 ND_MAPPING_UUID_SCAN,
135 };
136
137 struct nd_mapping {
138 struct nvdimm *nvdimm;
139 u64 start;
140 u64 size;
141 int position;
142 struct list_head labels;
143 struct mutex lock;
144 /*
145 * @ndd is for private use at region enable / disable time for
146 * get_ndd() + put_ndd(), all other nd_mapping to ndd
147 * conversions use to_ndd() which respects enabled state of the
148 * nvdimm.
149 */
150 struct nvdimm_drvdata *ndd;
151 };
152
153 struct nd_region {
154 struct device dev;
155 struct ida ns_ida;
156 struct ida btt_ida;
157 struct ida pfn_ida;
158 struct ida dax_ida;
159 unsigned long flags;
160 struct device *ns_seed;
161 struct device *btt_seed;
162 struct device *pfn_seed;
163 struct device *dax_seed;
164 u16 ndr_mappings;
165 u64 ndr_size;
166 u64 ndr_start;
167 int id, num_lanes, ro, numa_node;
168 void *provider_data;
169 struct kernfs_node *bb_state;
170 struct badblocks bb;
171 struct nd_interleave_set *nd_set;
172 struct nd_percpu_lane __percpu *lane;
173 struct nd_mapping mapping[0];
174 };
175
176 struct nd_blk_region {
177 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
178 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
179 void *iobuf, u64 len, int rw);
180 void *blk_provider_data;
181 struct nd_region nd_region;
182 };
183
184 /*
185 * Lookup next in the repeating sequence of 01, 10, and 11.
186 */
nd_inc_seq(unsigned seq)187 static inline unsigned nd_inc_seq(unsigned seq)
188 {
189 static const unsigned next[] = { 0, 2, 3, 1 };
190
191 return next[seq & 3];
192 }
193
194 struct btt;
195 struct nd_btt {
196 struct device dev;
197 struct nd_namespace_common *ndns;
198 struct btt *btt;
199 unsigned long lbasize;
200 u64 size;
201 u8 *uuid;
202 int id;
203 int initial_offset;
204 u16 version_major;
205 u16 version_minor;
206 };
207
208 enum nd_pfn_mode {
209 PFN_MODE_NONE,
210 PFN_MODE_RAM,
211 PFN_MODE_PMEM,
212 };
213
214 struct nd_pfn {
215 int id;
216 u8 *uuid;
217 struct device dev;
218 unsigned long align;
219 unsigned long npfns;
220 enum nd_pfn_mode mode;
221 struct nd_pfn_sb *pfn_sb;
222 struct nd_namespace_common *ndns;
223 };
224
225 struct nd_dax {
226 struct nd_pfn nd_pfn;
227 };
228
229 enum nd_async_mode {
230 ND_SYNC,
231 ND_ASYNC,
232 };
233
234 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
235 void wait_nvdimm_bus_probe_idle(struct device *dev);
236 void nd_device_register(struct device *dev);
237 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
238 void nd_device_notify(struct device *dev, enum nvdimm_event event);
239 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
240 size_t len);
241 ssize_t nd_size_select_show(unsigned long current_size,
242 const unsigned long *supported, char *buf);
243 ssize_t nd_size_select_store(struct device *dev, const char *buf,
244 unsigned long *current_size, const unsigned long *supported);
245 int __init nvdimm_init(void);
246 int __init nd_region_init(void);
247 int __init nd_label_init(void);
248 void nvdimm_exit(void);
249 void nd_region_exit(void);
250 struct nvdimm;
251 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
252 int nvdimm_check_config_data(struct device *dev);
253 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
254 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
255 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
256 void *buf, size_t len);
257 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
258 unsigned int len);
259 void nvdimm_set_aliasing(struct device *dev);
260 void nvdimm_set_locked(struct device *dev);
261 void nvdimm_clear_locked(struct device *dev);
262 struct nd_btt *to_nd_btt(struct device *dev);
263
264 struct nd_gen_sb {
265 char reserved[SZ_4K - 8];
266 __le64 checksum;
267 };
268
269 u64 nd_sb_checksum(struct nd_gen_sb *sb);
270 #if IS_ENABLED(CONFIG_BTT)
271 int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
272 bool is_nd_btt(struct device *dev);
273 struct device *nd_btt_create(struct nd_region *nd_region);
274 #else
nd_btt_probe(struct device * dev,struct nd_namespace_common * ndns)275 static inline int nd_btt_probe(struct device *dev,
276 struct nd_namespace_common *ndns)
277 {
278 return -ENODEV;
279 }
280
is_nd_btt(struct device * dev)281 static inline bool is_nd_btt(struct device *dev)
282 {
283 return false;
284 }
285
nd_btt_create(struct nd_region * nd_region)286 static inline struct device *nd_btt_create(struct nd_region *nd_region)
287 {
288 return NULL;
289 }
290 #endif
291
292 struct nd_pfn *to_nd_pfn(struct device *dev);
293 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
294
295 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
296 #define PFN_DEFAULT_ALIGNMENT HPAGE_PMD_SIZE
297 #else
298 #define PFN_DEFAULT_ALIGNMENT PAGE_SIZE
299 #endif
300
301 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
302 bool is_nd_pfn(struct device *dev);
303 struct device *nd_pfn_create(struct nd_region *nd_region);
304 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
305 struct nd_namespace_common *ndns);
306 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
307 extern struct attribute_group nd_pfn_attribute_group;
308 #else
nd_pfn_probe(struct device * dev,struct nd_namespace_common * ndns)309 static inline int nd_pfn_probe(struct device *dev,
310 struct nd_namespace_common *ndns)
311 {
312 return -ENODEV;
313 }
314
is_nd_pfn(struct device * dev)315 static inline bool is_nd_pfn(struct device *dev)
316 {
317 return false;
318 }
319
nd_pfn_create(struct nd_region * nd_region)320 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
321 {
322 return NULL;
323 }
324
nd_pfn_validate(struct nd_pfn * nd_pfn,const char * sig)325 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
326 {
327 return -ENODEV;
328 }
329 #endif
330
331 struct nd_dax *to_nd_dax(struct device *dev);
332 #if IS_ENABLED(CONFIG_NVDIMM_DAX)
333 int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
334 bool is_nd_dax(struct device *dev);
335 struct device *nd_dax_create(struct nd_region *nd_region);
336 #else
nd_dax_probe(struct device * dev,struct nd_namespace_common * ndns)337 static inline int nd_dax_probe(struct device *dev,
338 struct nd_namespace_common *ndns)
339 {
340 return -ENODEV;
341 }
342
is_nd_dax(struct device * dev)343 static inline bool is_nd_dax(struct device *dev)
344 {
345 return false;
346 }
347
nd_dax_create(struct nd_region * nd_region)348 static inline struct device *nd_dax_create(struct nd_region *nd_region)
349 {
350 return NULL;
351 }
352 #endif
353
354 struct nd_region *to_nd_region(struct device *dev);
355 int nd_region_to_nstype(struct nd_region *nd_region);
356 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
357 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
358 struct nd_namespace_index *nsindex);
359 u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
360 void nvdimm_bus_lock(struct device *dev);
361 void nvdimm_bus_unlock(struct device *dev);
362 bool is_nvdimm_bus_locked(struct device *dev);
363 int nvdimm_revalidate_disk(struct gendisk *disk);
364 void nvdimm_drvdata_release(struct kref *kref);
365 void put_ndd(struct nvdimm_drvdata *ndd);
366 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
367 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
368 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
369 struct nd_label_id *label_id, resource_size_t start,
370 resource_size_t n);
371 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
372 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
373 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
374 int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
375 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
376 char *name);
377 unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
378 void nvdimm_badblocks_populate(struct nd_region *nd_region,
379 struct badblocks *bb, const struct resource *res);
380 #if IS_ENABLED(CONFIG_ND_CLAIM)
381 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
382 struct resource *res, struct vmem_altmap *altmap);
383 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
384 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
385 #else
nvdimm_setup_pfn(struct nd_pfn * nd_pfn,struct resource * res,struct vmem_altmap * altmap)386 static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
387 struct resource *res, struct vmem_altmap *altmap)
388 {
389 return ERR_PTR(-ENXIO);
390 }
devm_nsio_enable(struct device * dev,struct nd_namespace_io * nsio)391 static inline int devm_nsio_enable(struct device *dev,
392 struct nd_namespace_io *nsio)
393 {
394 return -ENXIO;
395 }
devm_nsio_disable(struct device * dev,struct nd_namespace_io * nsio)396 static inline void devm_nsio_disable(struct device *dev,
397 struct nd_namespace_io *nsio)
398 {
399 }
400 #endif
401 int nd_blk_region_init(struct nd_region *nd_region);
402 int nd_region_activate(struct nd_region *nd_region);
403 void __nd_iostat_start(struct bio *bio, unsigned long *start);
nd_iostat_start(struct bio * bio,unsigned long * start)404 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
405 {
406 struct gendisk *disk = bio->bi_disk;
407
408 if (!blk_queue_io_stat(disk->queue))
409 return false;
410
411 *start = jiffies;
412 generic_start_io_acct(disk->queue, bio_data_dir(bio),
413 bio_sectors(bio), &disk->part0);
414 return true;
415 }
nd_iostat_end(struct bio * bio,unsigned long start)416 static inline void nd_iostat_end(struct bio *bio, unsigned long start)
417 {
418 struct gendisk *disk = bio->bi_disk;
419
420 generic_end_io_acct(disk->queue, bio_data_dir(bio), &disk->part0,
421 start);
422 }
is_bad_pmem(struct badblocks * bb,sector_t sector,unsigned int len)423 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
424 unsigned int len)
425 {
426 if (bb->count) {
427 sector_t first_bad;
428 int num_bad;
429
430 return !!badblocks_check(bb, sector, len / 512, &first_bad,
431 &num_bad);
432 }
433
434 return false;
435 }
436 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
437 const u8 *nd_dev_to_uuid(struct device *dev);
438 bool pmem_should_map_pages(struct device *dev);
439 #endif /* __ND_H__ */
440