drivers/nvdimm/nd.h

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