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 nvdimm_drvdata {
  37         struct device *dev;
  38         int nslabel_size;
  39         struct nd_cmd_get_config_size nsarea;
  40         void *data;
  41         int ns_current, ns_next;
  42         struct resource dpa;
  43         struct kref kref;
  44 };
  45
  46 struct nd_region_data {
  47         int ns_count;
  48         int ns_active;
  49         unsigned int hints_shift;
  50         void __iomem *flush_wpq[0];
  51 };
  52
  53 static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
  54                 int dimm, int hint)
  55 {
  56         unsigned int num = 1 << ndrd->hints_shift;
  57         unsigned int mask = num - 1;
  58
  59         return ndrd->flush_wpq[dimm * num + (hint & mask)];
  60 }
  61
  62 static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
  63                 int hint, void __iomem *flush)
  64 {
  65         unsigned int num = 1 << ndrd->hints_shift;
  66         unsigned int mask = num - 1;
  67
  68         ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
  69 }
  70
  71 static inline struct nd_namespace_index *to_namespace_index(
  72                 struct nvdimm_drvdata *ndd, int i)
  73 {
  74         if (i < 0)
  75                 return NULL;
  76
  77         return ndd->data + sizeof_namespace_index(ndd) * i;
  78 }
  79
  80 static inline struct nd_namespace_index *to_current_namespace_index(
  81                 struct nvdimm_drvdata *ndd)
  82 {
  83         return to_namespace_index(ndd, ndd->ns_current);
  84 }
  85
  86 static inline struct nd_namespace_index *to_next_namespace_index(
  87                 struct nvdimm_drvdata *ndd)
  88 {
  89         return to_namespace_index(ndd, ndd->ns_next);
  90 }
  91
  92 unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);
  93
  94 #define namespace_label_has(ndd, field) \
  95         (offsetof(struct nd_namespace_label, field) \
  96                 < sizeof_namespace_label(ndd))
  97
  98 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
  99         dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
 100                 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
 101                 (unsigned long long) (res ? resource_size(res) : 0), \
 102                 (unsigned long long) (res ? res->start : 0), ##arg)
 103
 104 #define for_each_dpa_resource(ndd, res) \
 105         for (res = (ndd)->dpa.child; res; res = res->sibling)
 106
 107 #define for_each_dpa_resource_safe(ndd, res, next) \
 108         for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
 109                         res; res = next, next = next ? next->sibling : NULL)
 110
 111 struct nd_percpu_lane {
 112         int count;
 113         spinlock_t lock;
 114 };
 115
 116 struct nd_label_ent {
 117         struct list_head list;
 118         struct nd_namespace_label *label;
 119 };
 120
 121 enum nd_mapping_lock_class {
 122         ND_MAPPING_CLASS0,
 123         ND_MAPPING_UUID_SCAN,
 124 };
 125
 126 struct nd_mapping {
 127         struct nvdimm *nvdimm;
 128         u64 start;
 129         u64 size;
 130         int position;
 131         struct list_head labels;
 132         struct mutex lock;
 133         /*
 134          * @ndd is for private use at region enable / disable time for
 135          * get_ndd() + put_ndd(), all other nd_mapping to ndd
 136          * conversions use to_ndd() which respects enabled state of the
 137          * nvdimm.
 138          */
 139         struct nvdimm_drvdata *ndd;
 140 };
 141
 142 struct nd_region {
 143         struct device dev;
 144         struct ida ns_ida;
 145         struct ida btt_ida;
 146         struct ida pfn_ida;
 147         struct ida dax_ida;
 148         unsigned long flags;
 149         struct device *ns_seed;
 150         struct device *btt_seed;
 151         struct device *pfn_seed;
 152         struct device *dax_seed;
 153         u16 ndr_mappings;
 154         u64 ndr_size;
 155         u64 ndr_start;
 156         int id, num_lanes, ro, numa_node;
 157         void *provider_data;
 158         struct kernfs_node *bb_state;
 159         struct badblocks bb;
 160         struct nd_interleave_set *nd_set;
 161         struct nd_percpu_lane __percpu *lane;
 162         struct nd_mapping mapping[0];
 163 };
 164
 165 struct nd_blk_region {
 166         int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 167         int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 168                         void *iobuf, u64 len, int rw);
 169         void *blk_provider_data;
 170         struct nd_region nd_region;
 171 };
 172
 173 /*
 174  * Lookup next in the repeating sequence of 01, 10, and 11.
 175  */
 176 static inline unsigned nd_inc_seq(unsigned seq)
 177 {
 178         static const unsigned next[] = { 0, 2, 3, 1 };
 179
 180         return next[seq & 3];
 181 }
 182
 183 struct btt;
 184 struct nd_btt {
 185         struct device dev;
 186         struct nd_namespace_common *ndns;
 187         struct btt *btt;
 188         unsigned long lbasize;
 189         u64 size;
 190         u8 *uuid;
 191         int id;
 192         int initial_offset;
 193         u16 version_major;
 194         u16 version_minor;
 195 };
 196
 197 enum nd_pfn_mode {
 198         PFN_MODE_NONE,
 199         PFN_MODE_RAM,
 200         PFN_MODE_PMEM,
 201 };
 202
 203 struct nd_pfn {
 204         int id;
 205         u8 *uuid;
 206         struct device dev;
 207         unsigned long align;
 208         unsigned long npfns;
 209         enum nd_pfn_mode mode;
 210         struct nd_pfn_sb *pfn_sb;
 211         struct nd_namespace_common *ndns;
 212 };
 213
 214 struct nd_dax {
 215         struct nd_pfn nd_pfn;
 216 };
 217
 218 enum nd_async_mode {
 219         ND_SYNC,
 220         ND_ASYNC,
 221 };
 222
 223 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
 224 void wait_nvdimm_bus_probe_idle(struct device *dev);
 225 void nd_device_register(struct device *dev);
 226 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
 227 void nd_device_notify(struct device *dev, enum nvdimm_event event);
 228 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
 229                 size_t len);
 230 ssize_t nd_size_select_show(unsigned long current_size,
 231                 const unsigned long *supported, char *buf);
 232 ssize_t nd_size_select_store(struct device *dev, const char *buf,
 233                 unsigned long *current_size, const unsigned long *supported);
 234 int __init nvdimm_init(void);
 235 int __init nd_region_init(void);
 236 int __init nd_label_init(void);
 237 void nvdimm_exit(void);
 238 void nd_region_exit(void);
 239 struct nvdimm;
 240 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
 241 int nvdimm_check_config_data(struct device *dev);
 242 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
 243 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
 244 int nvdimm_get_config_data(struct nvdimm_drvdata *ndd, void *buf,
 245                            size_t offset, size_t len);
 246 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
 247                 void *buf, size_t len);
 248 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
 249                 unsigned int len);
 250 void nvdimm_set_aliasing(struct device *dev);
 251 void nvdimm_set_locked(struct device *dev);
 252 void nvdimm_clear_locked(struct device *dev);
 253 #if IS_ENABLED(CONFIG_NVDIMM_KEYS)
 254 int nvdimm_security_unlock(struct device *dev);
 255 #else
 256 static inline int nvdimm_security_unlock(struct device *dev)
 257 {
 258         return 0;
 259 }
 260 #endif
 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 int nd_region_to_nstype(struct nd_region *nd_region);
 354 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
 355 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
 356                 struct nd_namespace_index *nsindex);
 357 u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
 358 void nvdimm_bus_lock(struct device *dev);
 359 void nvdimm_bus_unlock(struct device *dev);
 360 bool is_nvdimm_bus_locked(struct device *dev);
 361 int nvdimm_revalidate_disk(struct gendisk *disk);
 362 void nvdimm_drvdata_release(struct kref *kref);
 363 void put_ndd(struct nvdimm_drvdata *ndd);
 364 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
 365 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
 366 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
 367                 struct nd_label_id *label_id, resource_size_t start,
 368                 resource_size_t n);
 369 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
 370 bool nvdimm_namespace_locked(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 int nvdimm_setup_pfn(struct nd_pfn *nd_pfn, struct dev_pagemap *pgmap);
 381 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
 382 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
 383 #else
 384 static inline int nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
 385                                    struct dev_pagemap *pgmap)
 386 {
 387         return -ENXIO;
 388 }
 389 static inline int devm_nsio_enable(struct device *dev,
 390                 struct nd_namespace_io *nsio)
 391 {
 392         return -ENXIO;
 393 }
 394 static inline void devm_nsio_disable(struct device *dev,
 395                 struct nd_namespace_io *nsio)
 396 {
 397 }
 398 #endif
 399 int nd_blk_region_init(struct nd_region *nd_region);
 400 int nd_region_activate(struct nd_region *nd_region);
 401 void __nd_iostat_start(struct bio *bio, unsigned long *start);
 402 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
 403 {
 404         struct gendisk *disk = bio->bi_disk;
 405
 406         if (!blk_queue_io_stat(disk->queue))
 407                 return false;
 408
 409         *start = jiffies;
 410         generic_start_io_acct(disk->queue, bio_op(bio), bio_sectors(bio),
 411                               &disk->part0);
 412         return true;
 413 }
 414 static inline void nd_iostat_end(struct bio *bio, unsigned long start)
 415 {
 416         struct gendisk *disk = bio->bi_disk;
 417
 418         generic_end_io_acct(disk->queue, bio_op(bio), &disk->part0, start);
 419 }
 420 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
 421                 unsigned int len)
 422 {
 423         if (bb->count) {
 424                 sector_t first_bad;
 425                 int num_bad;
 426
 427                 return !!badblocks_check(bb, sector, len / 512, &first_bad,
 428                                 &num_bad);
 429         }
 430
 431         return false;
 432 }
 433 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
 434 const u8 *nd_dev_to_uuid(struct device *dev);
 435 bool pmem_should_map_pages(struct device *dev);
 436 #endif /* __ND_H__ */