drivers/nvdimm/dimm_devs.c

   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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  14 #include <linux/vmalloc.h>
  15 #include <linux/device.h>
  16 #include <linux/ndctl.h>
  17 #include <linux/slab.h>
  18 #include <linux/io.h>
  19 #include <linux/fs.h>
  20 #include <linux/mm.h>
  21 #include "nd-core.h"
  22 #include "label.h"
  23 #include "nd.h"
  24
  25 static DEFINE_IDA(dimm_ida);
  26
  27 /*
  28  * Retrieve bus and dimm handle and return if this bus supports
  29  * get_config_data commands
  30  */
  31 static int __validate_dimm(struct nvdimm_drvdata *ndd)
  32 {
  33         struct nvdimm *nvdimm;
  34
  35         if (!ndd)
  36                 return -EINVAL;
  37
  38         nvdimm = to_nvdimm(ndd->dev);
  39
  40         if (!nvdimm->cmd_mask)
  41                 return -ENXIO;
  42         if (!test_bit(ND_CMD_GET_CONFIG_DATA, &nvdimm->cmd_mask))
  43                 return -ENXIO;
  44
  45         return 0;
  46 }
  47
  48 static int validate_dimm(struct nvdimm_drvdata *ndd)
  49 {
  50         int rc = __validate_dimm(ndd);
  51
  52         if (rc && ndd)
  53                 dev_dbg(ndd->dev, "%pf: %s error: %d\n",
  54                                 __builtin_return_address(0), __func__, rc);
  55         return rc;
  56 }
  57
  58 /**
  59  * nvdimm_init_nsarea - determine the geometry of a dimm's namespace area
  60  * @nvdimm: dimm to initialize
  61  */
  62 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd)
  63 {
  64         struct nd_cmd_get_config_size *cmd = &ndd->nsarea;
  65         struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(ndd->dev);
  66         struct nvdimm_bus_descriptor *nd_desc;
  67         int rc = validate_dimm(ndd);
  68
  69         if (rc)
  70                 return rc;
  71
  72         if (cmd->config_size)
  73                 return 0; /* already valid */
  74
  75         memset(cmd, 0, sizeof(*cmd));
  76         nd_desc = nvdimm_bus->nd_desc;
  77         return nd_desc->ndctl(nd_desc, to_nvdimm(ndd->dev),
  78                         ND_CMD_GET_CONFIG_SIZE, cmd, sizeof(*cmd), NULL);
  79 }
  80
  81 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd)
  82 {
  83         struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(ndd->dev);
  84         struct nd_cmd_get_config_data_hdr *cmd;
  85         struct nvdimm_bus_descriptor *nd_desc;
  86         int rc = validate_dimm(ndd);
  87         u32 max_cmd_size, config_size;
  88         size_t offset;
  89
  90         if (rc)
  91                 return rc;
  92
  93         if (ndd->data)
  94                 return 0;
  95
  96         if (ndd->nsarea.status || ndd->nsarea.max_xfer == 0
  97                         || ndd->nsarea.config_size < ND_LABEL_MIN_SIZE) {
  98                 dev_dbg(ndd->dev, "failed to init config data area: (%d:%d)\n",
  99                                 ndd->nsarea.max_xfer, ndd->nsarea.config_size);
 100                 return -ENXIO;
 101         }
 102
 103         ndd->data = kmalloc(ndd->nsarea.config_size, GFP_KERNEL);
 104         if (!ndd->data)
 105                 ndd->data = vmalloc(ndd->nsarea.config_size);
 106
 107         if (!ndd->data)
 108                 return -ENOMEM;
 109
 110         max_cmd_size = min_t(u32, PAGE_SIZE, ndd->nsarea.max_xfer);
 111         cmd = kzalloc(max_cmd_size + sizeof(*cmd), GFP_KERNEL);
 112         if (!cmd)
 113                 return -ENOMEM;
 114
 115         nd_desc = nvdimm_bus->nd_desc;
 116         for (config_size = ndd->nsarea.config_size, offset = 0;
 117                         config_size; config_size -= cmd->in_length,
 118                         offset += cmd->in_length) {
 119                 cmd->in_length = min(config_size, max_cmd_size);
 120                 cmd->in_offset = offset;
 121                 rc = nd_desc->ndctl(nd_desc, to_nvdimm(ndd->dev),
 122                                 ND_CMD_GET_CONFIG_DATA, cmd,
 123                                 cmd->in_length + sizeof(*cmd), NULL);
 124                 if (rc || cmd->status) {
 125                         rc = -ENXIO;
 126                         break;
 127                 }
 128                 memcpy(ndd->data + offset, cmd->out_buf, cmd->in_length);
 129         }
 130         dev_dbg(ndd->dev, "%s: len: %zu rc: %d\n", __func__, offset, rc);
 131         kfree(cmd);
 132
 133         return rc;
 134 }
 135
 136 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
 137                 void *buf, size_t len)
 138 {
 139         int rc = validate_dimm(ndd);
 140         size_t max_cmd_size, buf_offset;
 141         struct nd_cmd_set_config_hdr *cmd;
 142         struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(ndd->dev);
 143         struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
 144
 145         if (rc)
 146                 return rc;
 147
 148         if (!ndd->data)
 149                 return -ENXIO;
 150
 151         if (offset + len > ndd->nsarea.config_size)
 152                 return -ENXIO;
 153
 154         max_cmd_size = min_t(u32, PAGE_SIZE, len);
 155         max_cmd_size = min_t(u32, max_cmd_size, ndd->nsarea.max_xfer);
 156         cmd = kzalloc(max_cmd_size + sizeof(*cmd) + sizeof(u32), GFP_KERNEL);
 157         if (!cmd)
 158                 return -ENOMEM;
 159
 160         for (buf_offset = 0; len; len -= cmd->in_length,
 161                         buf_offset += cmd->in_length) {
 162                 size_t cmd_size;
 163                 u32 *status;
 164
 165                 cmd->in_offset = offset + buf_offset;
 166                 cmd->in_length = min(max_cmd_size, len);
 167                 memcpy(cmd->in_buf, buf + buf_offset, cmd->in_length);
 168
 169                 /* status is output in the last 4-bytes of the command buffer */
 170                 cmd_size = sizeof(*cmd) + cmd->in_length + sizeof(u32);
 171                 status = ((void *) cmd) + cmd_size - sizeof(u32);
 172
 173                 rc = nd_desc->ndctl(nd_desc, to_nvdimm(ndd->dev),
 174                                 ND_CMD_SET_CONFIG_DATA, cmd, cmd_size, NULL);
 175                 if (rc || *status) {
 176                         rc = rc ? rc : -ENXIO;
 177                         break;
 178                 }
 179         }
 180         kfree(cmd);
 181
 182         return rc;
 183 }
 184
 185 static void nvdimm_release(struct device *dev)
 186 {
 187         struct nvdimm *nvdimm = to_nvdimm(dev);
 188
 189         ida_simple_remove(&dimm_ida, nvdimm->id);
 190         kfree(nvdimm);
 191 }
 192
 193 static struct device_type nvdimm_device_type = {
 194         .name = "nvdimm",
 195         .release = nvdimm_release,
 196 };
 197
 198 bool is_nvdimm(struct device *dev)
 199 {
 200         return dev->type == &nvdimm_device_type;
 201 }
 202
 203 struct nvdimm *to_nvdimm(struct device *dev)
 204 {
 205         struct nvdimm *nvdimm = container_of(dev, struct nvdimm, dev);
 206
 207         WARN_ON(!is_nvdimm(dev));
 208         return nvdimm;
 209 }
 210 EXPORT_SYMBOL_GPL(to_nvdimm);
 211
 212 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr)
 213 {
 214         struct nd_region *nd_region = &ndbr->nd_region;
 215         struct nd_mapping *nd_mapping = &nd_region->mapping[0];
 216
 217         return nd_mapping->nvdimm;
 218 }
 219 EXPORT_SYMBOL_GPL(nd_blk_region_to_dimm);
 220
 221 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping)
 222 {
 223         struct nvdimm *nvdimm = nd_mapping->nvdimm;
 224
 225         WARN_ON_ONCE(!is_nvdimm_bus_locked(&nvdimm->dev));
 226
 227         return dev_get_drvdata(&nvdimm->dev);
 228 }
 229 EXPORT_SYMBOL(to_ndd);
 230
 231 void nvdimm_drvdata_release(struct kref *kref)
 232 {
 233         struct nvdimm_drvdata *ndd = container_of(kref, typeof(*ndd), kref);
 234         struct device *dev = ndd->dev;
 235         struct resource *res, *_r;
 236
 237         dev_dbg(dev, "%s\n", __func__);
 238
 239         nvdimm_bus_lock(dev);
 240         for_each_dpa_resource_safe(ndd, res, _r)
 241                 nvdimm_free_dpa(ndd, res);
 242         nvdimm_bus_unlock(dev);
 243
 244         kvfree(ndd->data);
 245         kfree(ndd);
 246         put_device(dev);
 247 }
 248
 249 void get_ndd(struct nvdimm_drvdata *ndd)
 250 {
 251         kref_get(&ndd->kref);
 252 }
 253
 254 void put_ndd(struct nvdimm_drvdata *ndd)
 255 {
 256         if (ndd)
 257                 kref_put(&ndd->kref, nvdimm_drvdata_release);
 258 }
 259
 260 const char *nvdimm_name(struct nvdimm *nvdimm)
 261 {
 262         return dev_name(&nvdimm->dev);
 263 }
 264 EXPORT_SYMBOL_GPL(nvdimm_name);
 265
 266 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm)
 267 {
 268         return nvdimm->cmd_mask;
 269 }
 270 EXPORT_SYMBOL_GPL(nvdimm_cmd_mask);
 271
 272 void *nvdimm_provider_data(struct nvdimm *nvdimm)
 273 {
 274         if (nvdimm)
 275                 return nvdimm->provider_data;
 276         return NULL;
 277 }
 278 EXPORT_SYMBOL_GPL(nvdimm_provider_data);
 279
 280 static ssize_t commands_show(struct device *dev,
 281                 struct device_attribute *attr, char *buf)
 282 {
 283         struct nvdimm *nvdimm = to_nvdimm(dev);
 284         int cmd, len = 0;
 285
 286         if (!nvdimm->cmd_mask)
 287                 return sprintf(buf, "\n");
 288
 289         for_each_set_bit(cmd, &nvdimm->cmd_mask, BITS_PER_LONG)
 290                 len += sprintf(buf + len, "%s ", nvdimm_cmd_name(cmd));
 291         len += sprintf(buf + len, "\n");
 292         return len;
 293 }
 294 static DEVICE_ATTR_RO(commands);
 295
 296 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
 297                 char *buf)
 298 {
 299         struct nvdimm *nvdimm = to_nvdimm(dev);
 300
 301         /*
 302          * The state may be in the process of changing, userspace should
 303          * quiesce probing if it wants a static answer
 304          */
 305         nvdimm_bus_lock(dev);
 306         nvdimm_bus_unlock(dev);
 307         return sprintf(buf, "%s\n", atomic_read(&nvdimm->busy)
 308                         ? "active" : "idle");
 309 }
 310 static DEVICE_ATTR_RO(state);
 311
 312 static ssize_t available_slots_show(struct device *dev,
 313                 struct device_attribute *attr, char *buf)
 314 {
 315         struct nvdimm_drvdata *ndd = dev_get_drvdata(dev);
 316         ssize_t rc;
 317         u32 nfree;
 318
 319         if (!ndd)
 320                 return -ENXIO;
 321
 322         nvdimm_bus_lock(dev);
 323         nfree = nd_label_nfree(ndd);
 324         if (nfree - 1 > nfree) {
 325                 dev_WARN_ONCE(dev, 1, "we ate our last label?\n");
 326                 nfree = 0;
 327         } else
 328                 nfree--;
 329         rc = sprintf(buf, "%d\n", nfree);
 330         nvdimm_bus_unlock(dev);
 331         return rc;
 332 }
 333 static DEVICE_ATTR_RO(available_slots);
 334
 335 static struct attribute *nvdimm_attributes[] = {
 336         &dev_attr_state.attr,
 337         &dev_attr_commands.attr,
 338         &dev_attr_available_slots.attr,
 339         NULL,
 340 };
 341
 342 struct attribute_group nvdimm_attribute_group = {
 343         .attrs = nvdimm_attributes,
 344 };
 345 EXPORT_SYMBOL_GPL(nvdimm_attribute_group);
 346
 347 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
 348                 const struct attribute_group **groups, unsigned long flags,
 349                 unsigned long cmd_mask, int num_flush,
 350                 struct resource *flush_wpq)
 351 {
 352         struct nvdimm *nvdimm = kzalloc(sizeof(*nvdimm), GFP_KERNEL);
 353         struct device *dev;
 354
 355         if (!nvdimm)
 356                 return NULL;
 357
 358         nvdimm->id = ida_simple_get(&dimm_ida, 0, 0, GFP_KERNEL);
 359         if (nvdimm->id < 0) {
 360                 kfree(nvdimm);
 361                 return NULL;
 362         }
 363         nvdimm->provider_data = provider_data;
 364         nvdimm->flags = flags;
 365         nvdimm->cmd_mask = cmd_mask;
 366         nvdimm->num_flush = num_flush;
 367         nvdimm->flush_wpq = flush_wpq;
 368         atomic_set(&nvdimm->busy, 0);
 369         dev = &nvdimm->dev;
 370         dev_set_name(dev, "nmem%d", nvdimm->id);
 371         dev->parent = &nvdimm_bus->dev;
 372         dev->type = &nvdimm_device_type;
 373         dev->devt = MKDEV(nvdimm_major, nvdimm->id);
 374         dev->groups = groups;
 375         nd_device_register(dev);
 376
 377         return nvdimm;
 378 }
 379 EXPORT_SYMBOL_GPL(nvdimm_create);
 380
 381 /**
 382  * nd_blk_available_dpa - account the unused dpa of BLK region
 383  * @nd_mapping: container of dpa-resource-root + labels
 384  *
 385  * Unlike PMEM, BLK namespaces can occupy discontiguous DPA ranges.
 386  */
 387 resource_size_t nd_blk_available_dpa(struct nd_mapping *nd_mapping)
 388 {
 389         struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
 390         resource_size_t map_end, busy = 0, available;
 391         struct resource *res;
 392
 393         if (!ndd)
 394                 return 0;
 395
 396         map_end = nd_mapping->start + nd_mapping->size - 1;
 397         for_each_dpa_resource(ndd, res)
 398                 if (res->start >= nd_mapping->start && res->start < map_end) {
 399                         resource_size_t end = min(map_end, res->end);
 400
 401                         busy += end - res->start + 1;
 402                 } else if (res->end >= nd_mapping->start
 403                                 && res->end <= map_end) {
 404                         busy += res->end - nd_mapping->start;
 405                 } else if (nd_mapping->start > res->start
 406                                 && nd_mapping->start < res->end) {
 407                         /* total eclipse of the BLK region mapping */
 408                         busy += nd_mapping->size;
 409                 }
 410
 411         available = map_end - nd_mapping->start + 1;
 412         if (busy < available)
 413                 return available - busy;
 414         return 0;
 415 }
 416
 417 /**
 418  * nd_pmem_available_dpa - for the given dimm+region account unallocated dpa
 419  * @nd_mapping: container of dpa-resource-root + labels
 420  * @nd_region: constrain available space check to this reference region
 421  * @overlap: calculate available space assuming this level of overlap
 422  *
 423  * Validate that a PMEM label, if present, aligns with the start of an
 424  * interleave set and truncate the available size at the lowest BLK
 425  * overlap point.
 426  *
 427  * The expectation is that this routine is called multiple times as it
 428  * probes for the largest BLK encroachment for any single member DIMM of
 429  * the interleave set.  Once that value is determined the PMEM-limit for
 430  * the set can be established.
 431  */
 432 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
 433                 struct nd_mapping *nd_mapping, resource_size_t *overlap)
 434 {
 435         resource_size_t map_start, map_end, busy = 0, available, blk_start;
 436         struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
 437         struct resource *res;
 438         const char *reason;
 439
 440         if (!ndd)
 441                 return 0;
 442
 443         map_start = nd_mapping->start;
 444         map_end = map_start + nd_mapping->size - 1;
 445         blk_start = max(map_start, map_end + 1 - *overlap);
 446         for_each_dpa_resource(ndd, res)
 447                 if (res->start >= map_start && res->start < map_end) {
 448                         if (strncmp(res->name, "blk", 3) == 0)
 449                                 blk_start = min(blk_start, res->start);
 450                         else if (res->start != map_start) {
 451                                 reason = "misaligned to iset";
 452                                 goto err;
 453                         } else {
 454                                 if (busy) {
 455                                         reason = "duplicate overlapping PMEM reservations?";
 456                                         goto err;
 457                                 }
 458                                 busy += resource_size(res);
 459                                 continue;
 460                         }
 461                 } else if (res->end >= map_start && res->end <= map_end) {
 462                         if (strncmp(res->name, "blk", 3) == 0) {
 463                                 /*
 464                                  * If a BLK allocation overlaps the start of
 465                                  * PMEM the entire interleave set may now only
 466                                  * be used for BLK.
 467                                  */
 468                                 blk_start = map_start;
 469                         } else {
 470                                 reason = "misaligned to iset";
 471                                 goto err;
 472                         }
 473                 } else if (map_start > res->start && map_start < res->end) {
 474                         /* total eclipse of the mapping */
 475                         busy += nd_mapping->size;
 476                         blk_start = map_start;
 477                 }
 478
 479         *overlap = map_end + 1 - blk_start;
 480         available = blk_start - map_start;
 481         if (busy < available)
 482                 return available - busy;
 483         return 0;
 484
 485  err:
 486         /*
 487          * Something is wrong, PMEM must align with the start of the
 488          * interleave set, and there can only be one allocation per set.
 489          */
 490         nd_dbg_dpa(nd_region, ndd, res, "%s\n", reason);
 491         return 0;
 492 }
 493
 494 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res)
 495 {
 496         WARN_ON_ONCE(!is_nvdimm_bus_locked(ndd->dev));
 497         kfree(res->name);
 498         __release_region(&ndd->dpa, res->start, resource_size(res));
 499 }
 500
 501 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
 502                 struct nd_label_id *label_id, resource_size_t start,
 503                 resource_size_t n)
 504 {
 505         char *name = kmemdup(label_id, sizeof(*label_id), GFP_KERNEL);
 506         struct resource *res;
 507
 508         if (!name)
 509                 return NULL;
 510
 511         WARN_ON_ONCE(!is_nvdimm_bus_locked(ndd->dev));
 512         res = __request_region(&ndd->dpa, start, n, name, 0);
 513         if (!res)
 514                 kfree(name);
 515         return res;
 516 }
 517
 518 /**
 519  * nvdimm_allocated_dpa - sum up the dpa currently allocated to this label_id
 520  * @nvdimm: container of dpa-resource-root + labels
 521  * @label_id: dpa resource name of the form {pmem|blk}-<human readable uuid>
 522  */
 523 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
 524                 struct nd_label_id *label_id)
 525 {
 526         resource_size_t allocated = 0;
 527         struct resource *res;
 528
 529         for_each_dpa_resource(ndd, res)
 530                 if (strcmp(res->name, label_id->id) == 0)
 531                         allocated += resource_size(res);
 532
 533         return allocated;
 534 }
 535
 536 static int count_dimms(struct device *dev, void *c)
 537 {
 538         int *count = c;
 539
 540         if (is_nvdimm(dev))
 541                 (*count)++;
 542         return 0;
 543 }
 544
 545 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count)
 546 {
 547         int count = 0;
 548         /* Flush any possible dimm registration failures */
 549         nd_synchronize();
 550
 551         device_for_each_child(&nvdimm_bus->dev, &count, count_dimms);
 552         dev_dbg(&nvdimm_bus->dev, "%s: count: %d\n", __func__, count);
 553         if (count != dimm_count)
 554                 return -ENXIO;
 555         return 0;
 556 }
 557 EXPORT_SYMBOL_GPL(nvdimm_bus_check_dimm_count);
 558
 559 void __exit nvdimm_devs_exit(void)
 560 {
 561         ida_destroy(&dimm_ida);
 562 }