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