1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
5 #include <linux/device.h>
6 #include <linux/ndctl.h>
7 #include <linux/uuid.h>
8 #include <linux/slab.h>
15 static guid_t nvdimm_btt_guid;
16 static guid_t nvdimm_btt2_guid;
17 static guid_t nvdimm_pfn_guid;
18 static guid_t nvdimm_dax_guid;
20 static const char NSINDEX_SIGNATURE[] = "NAMESPACE_INDEX\0";
22 static u32 best_seq(u32 a, u32 b)
24 a &= NSINDEX_SEQ_MASK;
25 b &= NSINDEX_SEQ_MASK;
31 else if (nd_inc_seq(a) == b)
37 unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd)
39 return ndd->nslabel_size;
42 static size_t __sizeof_namespace_index(u32 nslot)
44 return ALIGN(sizeof(struct nd_namespace_index) + DIV_ROUND_UP(nslot, 8),
48 static int __nvdimm_num_label_slots(struct nvdimm_drvdata *ndd,
51 return (ndd->nsarea.config_size - index_size * 2) /
52 sizeof_namespace_label(ndd);
55 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd)
59 tmp_nslot = ndd->nsarea.config_size / sizeof_namespace_label(ndd);
60 n = __sizeof_namespace_index(tmp_nslot) / NSINDEX_ALIGN;
62 return __nvdimm_num_label_slots(ndd, NSINDEX_ALIGN * n);
65 size_t sizeof_namespace_index(struct nvdimm_drvdata *ndd)
67 u32 nslot, space, size;
70 * Per UEFI 2.7, the minimum size of the Label Storage Area is large
71 * enough to hold 2 index blocks and 2 labels. The minimum index
72 * block size is 256 bytes. The label size is 128 for namespaces
73 * prior to version 1.2 and at minimum 256 for version 1.2 and later.
75 nslot = nvdimm_num_label_slots(ndd);
76 space = ndd->nsarea.config_size - nslot * sizeof_namespace_label(ndd);
77 size = __sizeof_namespace_index(nslot) * 2;
78 if (size <= space && nslot >= 2)
81 dev_err(ndd->dev, "label area (%d) too small to host (%d byte) labels\n",
82 ndd->nsarea.config_size, sizeof_namespace_label(ndd));
86 static int __nd_label_validate(struct nvdimm_drvdata *ndd)
89 * On media label format consists of two index blocks followed
90 * by an array of labels. None of these structures are ever
91 * updated in place. A sequence number tracks the current
92 * active index and the next one to write, while labels are
93 * written to free slots.
115 struct nd_namespace_index *nsindex[] = {
116 to_namespace_index(ndd, 0),
117 to_namespace_index(ndd, 1),
119 const int num_index = ARRAY_SIZE(nsindex);
120 struct device *dev = ndd->dev;
121 bool valid[2] = { 0 };
122 int i, num_valid = 0;
125 for (i = 0; i < num_index; i++) {
127 u8 sig[NSINDEX_SIG_LEN];
128 u64 sum_save, sum, size;
129 unsigned int version, labelsize;
131 memcpy(sig, nsindex[i]->sig, NSINDEX_SIG_LEN);
132 if (memcmp(sig, NSINDEX_SIGNATURE, NSINDEX_SIG_LEN) != 0) {
133 dev_dbg(dev, "nsindex%d signature invalid\n", i);
137 /* label sizes larger than 128 arrived with v1.2 */
138 version = __le16_to_cpu(nsindex[i]->major) * 100
139 + __le16_to_cpu(nsindex[i]->minor);
141 labelsize = 1 << (7 + nsindex[i]->labelsize);
145 if (labelsize != sizeof_namespace_label(ndd)) {
146 dev_dbg(dev, "nsindex%d labelsize %d invalid\n",
147 i, nsindex[i]->labelsize);
151 sum_save = __le64_to_cpu(nsindex[i]->checksum);
152 nsindex[i]->checksum = __cpu_to_le64(0);
153 sum = nd_fletcher64(nsindex[i], sizeof_namespace_index(ndd), 1);
154 nsindex[i]->checksum = __cpu_to_le64(sum_save);
155 if (sum != sum_save) {
156 dev_dbg(dev, "nsindex%d checksum invalid\n", i);
160 seq = __le32_to_cpu(nsindex[i]->seq);
161 if ((seq & NSINDEX_SEQ_MASK) == 0) {
162 dev_dbg(dev, "nsindex%d sequence: %#x invalid\n", i, seq);
166 /* sanity check the index against expected values */
167 if (__le64_to_cpu(nsindex[i]->myoff)
168 != i * sizeof_namespace_index(ndd)) {
169 dev_dbg(dev, "nsindex%d myoff: %#llx invalid\n",
170 i, (unsigned long long)
171 __le64_to_cpu(nsindex[i]->myoff));
174 if (__le64_to_cpu(nsindex[i]->otheroff)
175 != (!i) * sizeof_namespace_index(ndd)) {
176 dev_dbg(dev, "nsindex%d otheroff: %#llx invalid\n",
177 i, (unsigned long long)
178 __le64_to_cpu(nsindex[i]->otheroff));
181 if (__le64_to_cpu(nsindex[i]->labeloff)
182 != 2 * sizeof_namespace_index(ndd)) {
183 dev_dbg(dev, "nsindex%d labeloff: %#llx invalid\n",
184 i, (unsigned long long)
185 __le64_to_cpu(nsindex[i]->labeloff));
189 size = __le64_to_cpu(nsindex[i]->mysize);
190 if (size > sizeof_namespace_index(ndd)
191 || size < sizeof(struct nd_namespace_index)) {
192 dev_dbg(dev, "nsindex%d mysize: %#llx invalid\n", i, size);
196 nslot = __le32_to_cpu(nsindex[i]->nslot);
197 if (nslot * sizeof_namespace_label(ndd)
198 + 2 * sizeof_namespace_index(ndd)
199 > ndd->nsarea.config_size) {
200 dev_dbg(dev, "nsindex%d nslot: %u invalid, config_size: %#x\n",
201 i, nslot, ndd->nsarea.config_size);
212 for (i = 0; i < num_index; i++)
215 /* can't have num_valid > 0 but valid[] = { false, false } */
219 /* pick the best index... */
220 seq = best_seq(__le32_to_cpu(nsindex[0]->seq),
221 __le32_to_cpu(nsindex[1]->seq));
222 if (seq == (__le32_to_cpu(nsindex[1]->seq) & NSINDEX_SEQ_MASK))
232 static int nd_label_validate(struct nvdimm_drvdata *ndd)
235 * In order to probe for and validate namespace index blocks we
236 * need to know the size of the labels, and we can't trust the
237 * size of the labels until we validate the index blocks.
238 * Resolve this dependency loop by probing for known label
239 * sizes, but default to v1.2 256-byte namespace labels if
242 int label_size[] = { 128, 256 };
245 for (i = 0; i < ARRAY_SIZE(label_size); i++) {
246 ndd->nslabel_size = label_size[i];
247 rc = __nd_label_validate(ndd);
255 static void nd_label_copy(struct nvdimm_drvdata *ndd,
256 struct nd_namespace_index *dst,
257 struct nd_namespace_index *src)
259 /* just exit if either destination or source is NULL */
263 memcpy(dst, src, sizeof_namespace_index(ndd));
266 static struct nd_namespace_label *nd_label_base(struct nvdimm_drvdata *ndd)
268 void *base = to_namespace_index(ndd, 0);
270 return base + 2 * sizeof_namespace_index(ndd);
273 static int to_slot(struct nvdimm_drvdata *ndd,
274 struct nd_namespace_label *nd_label)
276 unsigned long label, base;
278 label = (unsigned long) nd_label;
279 base = (unsigned long) nd_label_base(ndd);
281 return (label - base) / sizeof_namespace_label(ndd);
284 static struct nd_namespace_label *to_label(struct nvdimm_drvdata *ndd, int slot)
286 unsigned long label, base;
288 base = (unsigned long) nd_label_base(ndd);
289 label = base + sizeof_namespace_label(ndd) * slot;
291 return (struct nd_namespace_label *) label;
294 #define for_each_clear_bit_le(bit, addr, size) \
295 for ((bit) = find_next_zero_bit_le((addr), (size), 0); \
297 (bit) = find_next_zero_bit_le((addr), (size), (bit) + 1))
300 * preamble_index - common variable initialization for nd_label_* routines
301 * @ndd: dimm container for the relevant label set
302 * @idx: namespace_index index
303 * @nsindex_out: on return set to the currently active namespace index
304 * @free: on return set to the free label bitmap in the index
305 * @nslot: on return set to the number of slots in the label space
307 static bool preamble_index(struct nvdimm_drvdata *ndd, int idx,
308 struct nd_namespace_index **nsindex_out,
309 unsigned long **free, u32 *nslot)
311 struct nd_namespace_index *nsindex;
313 nsindex = to_namespace_index(ndd, idx);
317 *free = (unsigned long *) nsindex->free;
318 *nslot = __le32_to_cpu(nsindex->nslot);
319 *nsindex_out = nsindex;
324 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags)
326 if (!label_id || !uuid)
328 snprintf(label_id->id, ND_LABEL_ID_SIZE, "%s-%pUb",
329 flags & NSLABEL_FLAG_LOCAL ? "blk" : "pmem", uuid);
333 static bool preamble_current(struct nvdimm_drvdata *ndd,
334 struct nd_namespace_index **nsindex,
335 unsigned long **free, u32 *nslot)
337 return preamble_index(ndd, ndd->ns_current, nsindex,
341 static bool preamble_next(struct nvdimm_drvdata *ndd,
342 struct nd_namespace_index **nsindex,
343 unsigned long **free, u32 *nslot)
345 return preamble_index(ndd, ndd->ns_next, nsindex,
349 static bool slot_valid(struct nvdimm_drvdata *ndd,
350 struct nd_namespace_label *nd_label, u32 slot)
352 /* check that we are written where we expect to be written */
353 if (slot != __le32_to_cpu(nd_label->slot))
356 /* check that DPA allocations are page aligned */
357 if ((__le64_to_cpu(nd_label->dpa)
358 | __le64_to_cpu(nd_label->rawsize)) % SZ_4K)
362 if (namespace_label_has(ndd, checksum)) {
365 sum_save = __le64_to_cpu(nd_label->checksum);
366 nd_label->checksum = __cpu_to_le64(0);
367 sum = nd_fletcher64(nd_label, sizeof_namespace_label(ndd), 1);
368 nd_label->checksum = __cpu_to_le64(sum_save);
369 if (sum != sum_save) {
370 dev_dbg(ndd->dev, "fail checksum. slot: %d expect: %#llx\n",
379 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd)
381 struct nd_namespace_index *nsindex;
385 if (!preamble_current(ndd, &nsindex, &free, &nslot))
386 return 0; /* no label, nothing to reserve */
388 for_each_clear_bit_le(slot, free, nslot) {
389 struct nvdimm *nvdimm = to_nvdimm(ndd->dev);
390 struct nd_namespace_label *nd_label;
391 struct nd_region *nd_region = NULL;
392 u8 label_uuid[NSLABEL_UUID_LEN];
393 struct nd_label_id label_id;
394 struct resource *res;
397 nd_label = to_label(ndd, slot);
399 if (!slot_valid(ndd, nd_label, slot))
402 memcpy(label_uuid, nd_label->uuid, NSLABEL_UUID_LEN);
403 flags = __le32_to_cpu(nd_label->flags);
404 if (test_bit(NDD_NOBLK, &nvdimm->flags))
405 flags &= ~NSLABEL_FLAG_LOCAL;
406 nd_label_gen_id(&label_id, label_uuid, flags);
407 res = nvdimm_allocate_dpa(ndd, &label_id,
408 __le64_to_cpu(nd_label->dpa),
409 __le64_to_cpu(nd_label->rawsize));
410 nd_dbg_dpa(nd_region, ndd, res, "reserve\n");
418 int nd_label_data_init(struct nvdimm_drvdata *ndd)
420 size_t config_size, read_size, max_xfer, offset;
421 struct nd_namespace_index *nsindex;
429 if (ndd->nsarea.status || ndd->nsarea.max_xfer == 0) {
430 dev_dbg(ndd->dev, "failed to init config data area: (%u:%u)\n",
431 ndd->nsarea.max_xfer, ndd->nsarea.config_size);
436 * We need to determine the maximum index area as this is the section
437 * we must read and validate before we can start processing labels.
439 * If the area is too small to contain the two indexes and 2 labels
442 * Start at a label size of 128 as this should result in the largest
443 * possible namespace index size.
445 ndd->nslabel_size = 128;
446 read_size = sizeof_namespace_index(ndd) * 2;
450 /* Allocate config data */
451 config_size = ndd->nsarea.config_size;
452 ndd->data = kvzalloc(config_size, GFP_KERNEL);
457 * We want to guarantee as few reads as possible while conserving
458 * memory. To do that we figure out how much unused space will be left
459 * in the last read, divide that by the total number of reads it is
460 * going to take given our maximum transfer size, and then reduce our
461 * maximum transfer size based on that result.
463 max_xfer = min_t(size_t, ndd->nsarea.max_xfer, config_size);
464 if (read_size < max_xfer) {
466 max_xfer -= ((max_xfer - 1) - (config_size - 1) % max_xfer) /
467 DIV_ROUND_UP(config_size, max_xfer);
468 /* make certain we read indexes in exactly 1 read */
469 if (max_xfer < read_size)
470 max_xfer = read_size;
473 /* Make our initial read size a multiple of max_xfer size */
474 read_size = min(DIV_ROUND_UP(read_size, max_xfer) * max_xfer,
477 /* Read the index data */
478 rc = nvdimm_get_config_data(ndd, ndd->data, 0, read_size);
482 /* Validate index data, if not valid assume all labels are invalid */
483 ndd->ns_current = nd_label_validate(ndd);
484 if (ndd->ns_current < 0)
487 /* Record our index values */
488 ndd->ns_next = nd_label_next_nsindex(ndd->ns_current);
490 /* Copy "current" index on top of the "next" index */
491 nsindex = to_current_namespace_index(ndd);
492 nd_label_copy(ndd, to_next_namespace_index(ndd), nsindex);
494 /* Determine starting offset for label data */
495 offset = __le64_to_cpu(nsindex->labeloff);
496 nslot = __le32_to_cpu(nsindex->nslot);
498 /* Loop through the free list pulling in any active labels */
499 for (i = 0; i < nslot; i++, offset += ndd->nslabel_size) {
500 size_t label_read_size;
502 /* zero out the unused labels */
503 if (test_bit_le(i, nsindex->free)) {
504 memset(ndd->data + offset, 0, ndd->nslabel_size);
508 /* if we already read past here then just continue */
509 if (offset + ndd->nslabel_size <= read_size)
512 /* if we haven't read in a while reset our read_size offset */
513 if (read_size < offset)
516 /* determine how much more will be read after this next call. */
517 label_read_size = offset + ndd->nslabel_size - read_size;
518 label_read_size = DIV_ROUND_UP(label_read_size, max_xfer) *
521 /* truncate last read if needed */
522 if (read_size + label_read_size > config_size)
523 label_read_size = config_size - read_size;
525 /* Read the label data */
526 rc = nvdimm_get_config_data(ndd, ndd->data + read_size,
527 read_size, label_read_size);
531 /* push read_size to next read offset */
532 read_size += label_read_size;
535 dev_dbg(ndd->dev, "len: %zu rc: %d\n", offset, rc);
540 int nd_label_active_count(struct nvdimm_drvdata *ndd)
542 struct nd_namespace_index *nsindex;
547 if (!preamble_current(ndd, &nsindex, &free, &nslot))
550 for_each_clear_bit_le(slot, free, nslot) {
551 struct nd_namespace_label *nd_label;
553 nd_label = to_label(ndd, slot);
555 if (!slot_valid(ndd, nd_label, slot)) {
556 u32 label_slot = __le32_to_cpu(nd_label->slot);
557 u64 size = __le64_to_cpu(nd_label->rawsize);
558 u64 dpa = __le64_to_cpu(nd_label->dpa);
561 "slot%d invalid slot: %d dpa: %llx size: %llx\n",
562 slot, label_slot, dpa, size);
570 struct nd_namespace_label *nd_label_active(struct nvdimm_drvdata *ndd, int n)
572 struct nd_namespace_index *nsindex;
576 if (!preamble_current(ndd, &nsindex, &free, &nslot))
579 for_each_clear_bit_le(slot, free, nslot) {
580 struct nd_namespace_label *nd_label;
582 nd_label = to_label(ndd, slot);
583 if (!slot_valid(ndd, nd_label, slot))
587 return to_label(ndd, slot);
593 u32 nd_label_alloc_slot(struct nvdimm_drvdata *ndd)
595 struct nd_namespace_index *nsindex;
599 if (!preamble_next(ndd, &nsindex, &free, &nslot))
602 WARN_ON(!is_nvdimm_bus_locked(ndd->dev));
604 slot = find_next_bit_le(free, nslot, 0);
608 clear_bit_le(slot, free);
613 bool nd_label_free_slot(struct nvdimm_drvdata *ndd, u32 slot)
615 struct nd_namespace_index *nsindex;
619 if (!preamble_next(ndd, &nsindex, &free, &nslot))
622 WARN_ON(!is_nvdimm_bus_locked(ndd->dev));
625 return !test_and_set_bit_le(slot, free);
629 u32 nd_label_nfree(struct nvdimm_drvdata *ndd)
631 struct nd_namespace_index *nsindex;
635 WARN_ON(!is_nvdimm_bus_locked(ndd->dev));
637 if (!preamble_next(ndd, &nsindex, &free, &nslot))
638 return nvdimm_num_label_slots(ndd);
640 return bitmap_weight(free, nslot);
643 static int nd_label_write_index(struct nvdimm_drvdata *ndd, int index, u32 seq,
646 struct nd_namespace_index *nsindex;
647 unsigned long offset;
652 nsindex = to_namespace_index(ndd, index);
653 if (flags & ND_NSINDEX_INIT)
654 nslot = nvdimm_num_label_slots(ndd);
656 nslot = __le32_to_cpu(nsindex->nslot);
658 memcpy(nsindex->sig, NSINDEX_SIGNATURE, NSINDEX_SIG_LEN);
659 memset(&nsindex->flags, 0, 3);
660 nsindex->labelsize = sizeof_namespace_label(ndd) >> 8;
661 nsindex->seq = __cpu_to_le32(seq);
662 offset = (unsigned long) nsindex
663 - (unsigned long) to_namespace_index(ndd, 0);
664 nsindex->myoff = __cpu_to_le64(offset);
665 nsindex->mysize = __cpu_to_le64(sizeof_namespace_index(ndd));
666 offset = (unsigned long) to_namespace_index(ndd,
667 nd_label_next_nsindex(index))
668 - (unsigned long) to_namespace_index(ndd, 0);
669 nsindex->otheroff = __cpu_to_le64(offset);
670 offset = (unsigned long) nd_label_base(ndd)
671 - (unsigned long) to_namespace_index(ndd, 0);
672 nsindex->labeloff = __cpu_to_le64(offset);
673 nsindex->nslot = __cpu_to_le32(nslot);
674 nsindex->major = __cpu_to_le16(1);
675 if (sizeof_namespace_label(ndd) < 256)
676 nsindex->minor = __cpu_to_le16(1);
678 nsindex->minor = __cpu_to_le16(2);
679 nsindex->checksum = __cpu_to_le64(0);
680 if (flags & ND_NSINDEX_INIT) {
681 unsigned long *free = (unsigned long *) nsindex->free;
682 u32 nfree = ALIGN(nslot, BITS_PER_LONG);
685 memset(nsindex->free, 0xff, nfree / 8);
686 for (i = 0, last_bits = nfree - nslot; i < last_bits; i++)
687 clear_bit_le(nslot + i, free);
689 checksum = nd_fletcher64(nsindex, sizeof_namespace_index(ndd), 1);
690 nsindex->checksum = __cpu_to_le64(checksum);
691 rc = nvdimm_set_config_data(ndd, __le64_to_cpu(nsindex->myoff),
692 nsindex, sizeof_namespace_index(ndd));
696 if (flags & ND_NSINDEX_INIT)
699 /* copy the index we just wrote to the new 'next' */
700 WARN_ON(index != ndd->ns_next);
701 nd_label_copy(ndd, to_current_namespace_index(ndd), nsindex);
702 ndd->ns_current = nd_label_next_nsindex(ndd->ns_current);
703 ndd->ns_next = nd_label_next_nsindex(ndd->ns_next);
704 WARN_ON(ndd->ns_current == ndd->ns_next);
709 static unsigned long nd_label_offset(struct nvdimm_drvdata *ndd,
710 struct nd_namespace_label *nd_label)
712 return (unsigned long) nd_label
713 - (unsigned long) to_namespace_index(ndd, 0);
716 enum nvdimm_claim_class to_nvdimm_cclass(guid_t *guid)
718 if (guid_equal(guid, &nvdimm_btt_guid))
719 return NVDIMM_CCLASS_BTT;
720 else if (guid_equal(guid, &nvdimm_btt2_guid))
721 return NVDIMM_CCLASS_BTT2;
722 else if (guid_equal(guid, &nvdimm_pfn_guid))
723 return NVDIMM_CCLASS_PFN;
724 else if (guid_equal(guid, &nvdimm_dax_guid))
725 return NVDIMM_CCLASS_DAX;
726 else if (guid_equal(guid, &guid_null))
727 return NVDIMM_CCLASS_NONE;
729 return NVDIMM_CCLASS_UNKNOWN;
732 static const guid_t *to_abstraction_guid(enum nvdimm_claim_class claim_class,
735 if (claim_class == NVDIMM_CCLASS_BTT)
736 return &nvdimm_btt_guid;
737 else if (claim_class == NVDIMM_CCLASS_BTT2)
738 return &nvdimm_btt2_guid;
739 else if (claim_class == NVDIMM_CCLASS_PFN)
740 return &nvdimm_pfn_guid;
741 else if (claim_class == NVDIMM_CCLASS_DAX)
742 return &nvdimm_dax_guid;
743 else if (claim_class == NVDIMM_CCLASS_UNKNOWN) {
745 * If we're modifying a namespace for which we don't
746 * know the claim_class, don't touch the existing guid.
753 static void reap_victim(struct nd_mapping *nd_mapping,
754 struct nd_label_ent *victim)
756 struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
757 u32 slot = to_slot(ndd, victim->label);
759 dev_dbg(ndd->dev, "free: %d\n", slot);
760 nd_label_free_slot(ndd, slot);
761 victim->label = NULL;
764 static int __pmem_label_update(struct nd_region *nd_region,
765 struct nd_mapping *nd_mapping, struct nd_namespace_pmem *nspm,
766 int pos, unsigned long flags)
768 struct nd_namespace_common *ndns = &nspm->nsio.common;
769 struct nd_interleave_set *nd_set = nd_region->nd_set;
770 struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
771 struct nd_namespace_label *nd_label;
772 struct nd_namespace_index *nsindex;
773 struct nd_label_ent *label_ent;
774 struct nd_label_id label_id;
775 struct resource *res;
782 if (!preamble_next(ndd, &nsindex, &free, &nslot))
785 cookie = nd_region_interleave_set_cookie(nd_region, nsindex);
786 nd_label_gen_id(&label_id, nspm->uuid, 0);
787 for_each_dpa_resource(ndd, res)
788 if (strcmp(res->name, label_id.id) == 0)
796 /* allocate and write the label to the staging (next) index */
797 slot = nd_label_alloc_slot(ndd);
798 if (slot == UINT_MAX)
800 dev_dbg(ndd->dev, "allocated: %d\n", slot);
802 nd_label = to_label(ndd, slot);
803 memset(nd_label, 0, sizeof_namespace_label(ndd));
804 memcpy(nd_label->uuid, nspm->uuid, NSLABEL_UUID_LEN);
806 memcpy(nd_label->name, nspm->alt_name, NSLABEL_NAME_LEN);
807 nd_label->flags = __cpu_to_le32(flags);
808 nd_label->nlabel = __cpu_to_le16(nd_region->ndr_mappings);
809 nd_label->position = __cpu_to_le16(pos);
810 nd_label->isetcookie = __cpu_to_le64(cookie);
811 nd_label->rawsize = __cpu_to_le64(resource_size(res));
812 nd_label->lbasize = __cpu_to_le64(nspm->lbasize);
813 nd_label->dpa = __cpu_to_le64(res->start);
814 nd_label->slot = __cpu_to_le32(slot);
815 if (namespace_label_has(ndd, type_guid))
816 guid_copy(&nd_label->type_guid, &nd_set->type_guid);
817 if (namespace_label_has(ndd, abstraction_guid))
818 guid_copy(&nd_label->abstraction_guid,
819 to_abstraction_guid(ndns->claim_class,
820 &nd_label->abstraction_guid));
821 if (namespace_label_has(ndd, checksum)) {
824 nd_label->checksum = __cpu_to_le64(0);
825 sum = nd_fletcher64(nd_label, sizeof_namespace_label(ndd), 1);
826 nd_label->checksum = __cpu_to_le64(sum);
828 nd_dbg_dpa(nd_region, ndd, res, "\n");
831 offset = nd_label_offset(ndd, nd_label);
832 rc = nvdimm_set_config_data(ndd, offset, nd_label,
833 sizeof_namespace_label(ndd));
837 /* Garbage collect the previous label */
838 mutex_lock(&nd_mapping->lock);
839 list_for_each_entry(label_ent, &nd_mapping->labels, list) {
840 if (!label_ent->label)
842 if (test_and_clear_bit(ND_LABEL_REAP, &label_ent->flags)
843 || memcmp(nspm->uuid, label_ent->label->uuid,
844 NSLABEL_UUID_LEN) == 0)
845 reap_victim(nd_mapping, label_ent);
849 rc = nd_label_write_index(ndd, ndd->ns_next,
850 nd_inc_seq(__le32_to_cpu(nsindex->seq)), 0);
852 list_for_each_entry(label_ent, &nd_mapping->labels, list)
853 if (!label_ent->label) {
854 label_ent->label = nd_label;
858 dev_WARN_ONCE(&nspm->nsio.common.dev, nd_label,
859 "failed to track label: %d\n",
860 to_slot(ndd, nd_label));
864 mutex_unlock(&nd_mapping->lock);
869 static bool is_old_resource(struct resource *res, struct resource **list, int n)
873 if (res->flags & DPA_RESOURCE_ADJUSTED)
875 for (i = 0; i < n; i++)
881 static struct resource *to_resource(struct nvdimm_drvdata *ndd,
882 struct nd_namespace_label *nd_label)
884 struct resource *res;
886 for_each_dpa_resource(ndd, res) {
887 if (res->start != __le64_to_cpu(nd_label->dpa))
889 if (resource_size(res) != __le64_to_cpu(nd_label->rawsize))
898 * 1/ Account all the labels that can be freed after this update
899 * 2/ Allocate and write the label to the staging (next) index
900 * 3/ Record the resources in the namespace device
902 static int __blk_label_update(struct nd_region *nd_region,
903 struct nd_mapping *nd_mapping, struct nd_namespace_blk *nsblk,
906 int i, alloc, victims, nfree, old_num_resources, nlabel, rc = -ENXIO;
907 struct nd_interleave_set *nd_set = nd_region->nd_set;
908 struct nd_namespace_common *ndns = &nsblk->common;
909 struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
910 struct nd_namespace_label *nd_label;
911 struct nd_label_ent *label_ent, *e;
912 struct nd_namespace_index *nsindex;
913 unsigned long *free, *victim_map = NULL;
914 struct resource *res, **old_res_list;
915 struct nd_label_id label_id;
916 u8 uuid[NSLABEL_UUID_LEN];
921 if (!preamble_next(ndd, &nsindex, &free, &nslot))
924 old_res_list = nsblk->res;
925 nfree = nd_label_nfree(ndd);
926 old_num_resources = nsblk->num_resources;
927 nd_label_gen_id(&label_id, nsblk->uuid, NSLABEL_FLAG_LOCAL);
930 * We need to loop over the old resources a few times, which seems a
931 * bit inefficient, but we need to know that we have the label
932 * space before we start mutating the tracking structures.
933 * Otherwise the recovery method of last resort for userspace is
934 * disable and re-enable the parent region.
937 for_each_dpa_resource(ndd, res) {
938 if (strcmp(res->name, label_id.id) != 0)
940 if (!is_old_resource(res, old_res_list, old_num_resources))
945 if (old_num_resources) {
946 /* convert old local-label-map to dimm-slot victim-map */
947 victim_map = bitmap_zalloc(nslot, GFP_KERNEL);
951 /* mark unused labels for garbage collection */
952 for_each_clear_bit_le(slot, free, nslot) {
953 nd_label = to_label(ndd, slot);
954 memcpy(uuid, nd_label->uuid, NSLABEL_UUID_LEN);
955 if (memcmp(uuid, nsblk->uuid, NSLABEL_UUID_LEN) != 0)
957 res = to_resource(ndd, nd_label);
958 if (res && is_old_resource(res, old_res_list,
961 slot = to_slot(ndd, nd_label);
962 set_bit(slot, victim_map);
967 /* don't allow updates that consume the last label */
968 if (nfree - alloc < 0 || nfree - alloc + victims < 1) {
969 dev_info(&nsblk->common.dev, "insufficient label space\n");
970 bitmap_free(victim_map);
973 /* from here on we need to abort on error */
976 /* assign all resources to the namespace before writing the labels */
978 nsblk->num_resources = 0;
979 for_each_dpa_resource(ndd, res) {
980 if (strcmp(res->name, label_id.id) != 0)
982 if (!nsblk_add_resource(nd_region, ndd, nsblk, res->start)) {
989 * Find the resource associated with the first label in the set
990 * per the v1.2 namespace specification.
992 for (i = 0; i < nsblk->num_resources; i++) {
993 struct resource *min = nsblk->res[min_dpa_idx];
996 if (res->start < min->start)
1000 for (i = 0; i < nsblk->num_resources; i++) {
1003 res = nsblk->res[i];
1004 if (is_old_resource(res, old_res_list, old_num_resources))
1005 continue; /* carry-over */
1006 slot = nd_label_alloc_slot(ndd);
1007 if (slot == UINT_MAX)
1009 dev_dbg(ndd->dev, "allocated: %d\n", slot);
1011 nd_label = to_label(ndd, slot);
1012 memset(nd_label, 0, sizeof_namespace_label(ndd));
1013 memcpy(nd_label->uuid, nsblk->uuid, NSLABEL_UUID_LEN);
1014 if (nsblk->alt_name)
1015 memcpy(nd_label->name, nsblk->alt_name,
1017 nd_label->flags = __cpu_to_le32(NSLABEL_FLAG_LOCAL);
1020 * Use the presence of the type_guid as a flag to
1021 * determine isetcookie usage and nlabel + position
1022 * policy for blk-aperture namespaces.
1024 if (namespace_label_has(ndd, type_guid)) {
1025 if (i == min_dpa_idx) {
1026 nd_label->nlabel = __cpu_to_le16(nsblk->num_resources);
1027 nd_label->position = __cpu_to_le16(0);
1029 nd_label->nlabel = __cpu_to_le16(0xffff);
1030 nd_label->position = __cpu_to_le16(0xffff);
1032 nd_label->isetcookie = __cpu_to_le64(nd_set->cookie2);
1034 nd_label->nlabel = __cpu_to_le16(0); /* N/A */
1035 nd_label->position = __cpu_to_le16(0); /* N/A */
1036 nd_label->isetcookie = __cpu_to_le64(0); /* N/A */
1039 nd_label->dpa = __cpu_to_le64(res->start);
1040 nd_label->rawsize = __cpu_to_le64(resource_size(res));
1041 nd_label->lbasize = __cpu_to_le64(nsblk->lbasize);
1042 nd_label->slot = __cpu_to_le32(slot);
1043 if (namespace_label_has(ndd, type_guid))
1044 guid_copy(&nd_label->type_guid, &nd_set->type_guid);
1045 if (namespace_label_has(ndd, abstraction_guid))
1046 guid_copy(&nd_label->abstraction_guid,
1047 to_abstraction_guid(ndns->claim_class,
1048 &nd_label->abstraction_guid));
1050 if (namespace_label_has(ndd, checksum)) {
1053 nd_label->checksum = __cpu_to_le64(0);
1054 sum = nd_fletcher64(nd_label,
1055 sizeof_namespace_label(ndd), 1);
1056 nd_label->checksum = __cpu_to_le64(sum);
1060 offset = nd_label_offset(ndd, nd_label);
1061 rc = nvdimm_set_config_data(ndd, offset, nd_label,
1062 sizeof_namespace_label(ndd));
1067 /* free up now unused slots in the new index */
1068 for_each_set_bit(slot, victim_map, victim_map ? nslot : 0) {
1069 dev_dbg(ndd->dev, "free: %d\n", slot);
1070 nd_label_free_slot(ndd, slot);
1074 rc = nd_label_write_index(ndd, ndd->ns_next,
1075 nd_inc_seq(__le32_to_cpu(nsindex->seq)), 0);
1080 * Now that the on-dimm labels are up to date, fix up the tracking
1081 * entries in nd_mapping->labels
1084 mutex_lock(&nd_mapping->lock);
1085 list_for_each_entry_safe(label_ent, e, &nd_mapping->labels, list) {
1086 nd_label = label_ent->label;
1090 memcpy(uuid, nd_label->uuid, NSLABEL_UUID_LEN);
1091 if (memcmp(uuid, nsblk->uuid, NSLABEL_UUID_LEN) != 0)
1094 list_move(&label_ent->list, &list);
1095 label_ent->label = NULL;
1097 list_splice_tail_init(&list, &nd_mapping->labels);
1098 mutex_unlock(&nd_mapping->lock);
1100 if (nlabel + nsblk->num_resources > num_labels) {
1102 * Bug, we can't end up with more resources than
1110 mutex_lock(&nd_mapping->lock);
1111 label_ent = list_first_entry_or_null(&nd_mapping->labels,
1112 typeof(*label_ent), list);
1115 mutex_unlock(&nd_mapping->lock);
1119 for_each_clear_bit_le(slot, free, nslot) {
1120 nd_label = to_label(ndd, slot);
1121 memcpy(uuid, nd_label->uuid, NSLABEL_UUID_LEN);
1122 if (memcmp(uuid, nsblk->uuid, NSLABEL_UUID_LEN) != 0)
1124 res = to_resource(ndd, nd_label);
1125 res->flags &= ~DPA_RESOURCE_ADJUSTED;
1126 dev_vdbg(&nsblk->common.dev, "assign label slot: %d\n", slot);
1127 list_for_each_entry_from(label_ent, &nd_mapping->labels, list) {
1128 if (label_ent->label)
1130 label_ent->label = nd_label;
1135 dev_WARN(&nsblk->common.dev,
1136 "failed to track label slot%d\n", slot);
1138 mutex_unlock(&nd_mapping->lock);
1141 kfree(old_res_list);
1142 bitmap_free(victim_map);
1147 * 1/ repair the allocated label bitmap in the index
1148 * 2/ restore the resource list
1150 nd_label_copy(ndd, nsindex, to_current_namespace_index(ndd));
1152 nsblk->res = old_res_list;
1153 nsblk->num_resources = old_num_resources;
1154 old_res_list = NULL;
1158 static int init_labels(struct nd_mapping *nd_mapping, int num_labels)
1160 int i, old_num_labels = 0;
1161 struct nd_label_ent *label_ent;
1162 struct nd_namespace_index *nsindex;
1163 struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
1165 mutex_lock(&nd_mapping->lock);
1166 list_for_each_entry(label_ent, &nd_mapping->labels, list)
1168 mutex_unlock(&nd_mapping->lock);
1171 * We need to preserve all the old labels for the mapping so
1172 * they can be garbage collected after writing the new labels.
1174 for (i = old_num_labels; i < num_labels; i++) {
1175 label_ent = kzalloc(sizeof(*label_ent), GFP_KERNEL);
1178 mutex_lock(&nd_mapping->lock);
1179 list_add_tail(&label_ent->list, &nd_mapping->labels);
1180 mutex_unlock(&nd_mapping->lock);
1183 if (ndd->ns_current == -1 || ndd->ns_next == -1)
1186 return max(num_labels, old_num_labels);
1188 nsindex = to_namespace_index(ndd, 0);
1189 memset(nsindex, 0, ndd->nsarea.config_size);
1190 for (i = 0; i < 2; i++) {
1191 int rc = nd_label_write_index(ndd, i, 3 - i, ND_NSINDEX_INIT);
1197 ndd->ns_current = 0;
1199 return max(num_labels, old_num_labels);
1202 static int del_labels(struct nd_mapping *nd_mapping, u8 *uuid)
1204 struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
1205 struct nd_label_ent *label_ent, *e;
1206 struct nd_namespace_index *nsindex;
1207 u8 label_uuid[NSLABEL_UUID_LEN];
1208 unsigned long *free;
1216 /* no index || no labels == nothing to delete */
1217 if (!preamble_next(ndd, &nsindex, &free, &nslot))
1220 mutex_lock(&nd_mapping->lock);
1221 list_for_each_entry_safe(label_ent, e, &nd_mapping->labels, list) {
1222 struct nd_namespace_label *nd_label = label_ent->label;
1227 memcpy(label_uuid, nd_label->uuid, NSLABEL_UUID_LEN);
1228 if (memcmp(label_uuid, uuid, NSLABEL_UUID_LEN) != 0)
1231 slot = to_slot(ndd, nd_label);
1232 nd_label_free_slot(ndd, slot);
1233 dev_dbg(ndd->dev, "free: %d\n", slot);
1234 list_move_tail(&label_ent->list, &list);
1235 label_ent->label = NULL;
1237 list_splice_tail_init(&list, &nd_mapping->labels);
1240 nd_mapping_free_labels(nd_mapping);
1241 dev_dbg(ndd->dev, "no more active labels\n");
1243 mutex_unlock(&nd_mapping->lock);
1245 return nd_label_write_index(ndd, ndd->ns_next,
1246 nd_inc_seq(__le32_to_cpu(nsindex->seq)), 0);
1249 int nd_pmem_namespace_label_update(struct nd_region *nd_region,
1250 struct nd_namespace_pmem *nspm, resource_size_t size)
1254 for (i = 0; i < nd_region->ndr_mappings; i++) {
1255 struct nd_mapping *nd_mapping = &nd_region->mapping[i];
1256 struct nvdimm_drvdata *ndd = to_ndd(nd_mapping);
1257 struct resource *res;
1261 rc = del_labels(nd_mapping, nspm->uuid);
1267 for_each_dpa_resource(ndd, res)
1268 if (strncmp(res->name, "pmem", 4) == 0)
1270 WARN_ON_ONCE(!count);
1272 rc = init_labels(nd_mapping, count);
1276 rc = __pmem_label_update(nd_region, nd_mapping, nspm, i,
1277 NSLABEL_FLAG_UPDATING);
1285 /* Clear the UPDATING flag per UEFI 2.7 expectations */
1286 for (i = 0; i < nd_region->ndr_mappings; i++) {
1287 struct nd_mapping *nd_mapping = &nd_region->mapping[i];
1289 rc = __pmem_label_update(nd_region, nd_mapping, nspm, i, 0);
1297 int nd_blk_namespace_label_update(struct nd_region *nd_region,
1298 struct nd_namespace_blk *nsblk, resource_size_t size)
1300 struct nd_mapping *nd_mapping = &nd_region->mapping[0];
1301 struct resource *res;
1305 return del_labels(nd_mapping, nsblk->uuid);
1307 for_each_dpa_resource(to_ndd(nd_mapping), res)
1310 count = init_labels(nd_mapping, count);
1314 return __blk_label_update(nd_region, nd_mapping, nsblk, count);
1317 int __init nd_label_init(void)
1319 WARN_ON(guid_parse(NVDIMM_BTT_GUID, &nvdimm_btt_guid));
1320 WARN_ON(guid_parse(NVDIMM_BTT2_GUID, &nvdimm_btt2_guid));
1321 WARN_ON(guid_parse(NVDIMM_PFN_GUID, &nvdimm_pfn_guid));
1322 WARN_ON(guid_parse(NVDIMM_DAX_GUID, &nvdimm_dax_guid));