sys/arm/arm/physmem.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2014 Ian Lepore <ian@freebsd.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include "opt_ddb.h"
  33
  34 /*
  35  * Routines for describing and initializing anything related to physical memory.
  36  */
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <vm/vm.h>
  41 #include <machine/md_var.h>
  42 #include <arm/include/physmem.h>
  43
  44 /*
  45  * These structures are used internally to keep track of regions of physical
  46  * ram, and regions within the physical ram that need to be excluded.  An
  47  * exclusion region can be excluded from crash dumps, from the vm pool of pages
  48  * that can be allocated, or both, depending on the exclusion flags associated
  49  * with the region.
  50  */
  51 #define MAX_HWCNT       10
  52 #define MAX_EXCNT       10
  53
  54 #if defined(__arm__)
  55 #define MAX_PHYS_ADDR   0xFFFFFFFFull
  56 #define pm_btop(x)      arm32_btop(x)
  57 #elif defined(__aarch64__)
  58 #define MAX_PHYS_ADDR   0xFFFFFFFFFFFFFFFFull
  59 #define pm_btop(x)      arm64_btop(x)
  60 #endif
  61
  62 struct region {
  63         vm_paddr_t      addr;
  64         vm_size_t       size;
  65         uint32_t        flags;
  66 };
  67
  68 static struct region hwregions[MAX_HWCNT];
  69 static struct region exregions[MAX_EXCNT];
  70
  71 static size_t hwcnt;
  72 static size_t excnt;
  73
  74 /*
  75  * These "avail lists" are globals used to communicate physical memory layout to
  76  * other parts of the kernel.  Within the arrays, each value is the starting
  77  * address of a contiguous area of physical address space.  The values at even
  78  * indexes are areas that contain usable memory and the values at odd indexes
  79  * are areas that aren't usable.  Each list is terminated by a pair of zero
  80  * entries.
  81  *
  82  * dump_avail tells the dump code what regions to include in a crash dump, and
  83  * phys_avail is the way we hand all the remaining physical ram we haven't used
  84  * in early kernel init over to the vm system for allocation management.
  85  *
  86  * We size these arrays to hold twice as many available regions as we allow for
  87  * hardware memory regions, to allow for the fact that exclusions can split a
  88  * hardware region into two or more available regions.  In the real world there
  89  * will typically be one or two hardware regions and two or three exclusions.
  90  *
  91  * Each available region in this list occupies two array slots (the start of the
  92  * available region and the start of the unavailable region that follows it).
  93  */
  94 #define MAX_AVAIL_REGIONS       (MAX_HWCNT * 2)
  95 #define MAX_AVAIL_ENTRIES       (MAX_AVAIL_REGIONS * 2)
  96
  97 vm_paddr_t phys_avail[MAX_AVAIL_ENTRIES + 2]; /* +2 to allow for a pair  */
  98 vm_paddr_t dump_avail[MAX_AVAIL_ENTRIES + 2]; /* of zeroes to terminate. */
  99
 100 /*
 101  * realmem is the total number of hardware pages, excluded or not.
 102  * Maxmem is one greater than the last physical page number.
 103  */
 104 long realmem;
 105 long Maxmem;
 106
 107 /* The address at which the kernel was loaded.  Set early in initarm(). */
 108 vm_paddr_t arm_physmem_kernaddr;
 109
 110 /*
 111  * Print the contents of the physical and excluded region tables using the
 112  * provided printf-like output function (which will be either printf or
 113  * db_printf).
 114  */
 115 static void
 116 physmem_dump_tables(int (*prfunc)(const char *, ...))
 117 {
 118         int flags, i;
 119         uintmax_t addr, size;
 120         const unsigned int mbyte = 1024 * 1024;
 121
 122         prfunc("Physical memory chunk(s):\n");
 123         for (i = 0; i < hwcnt; ++i) {
 124                 addr = hwregions[i].addr;
 125                 size = hwregions[i].size;
 126                 prfunc("  0x%08jx - 0x%08jx, %5ju MB (%7ju pages)\n", addr,
 127                     addr + size - 1, size / mbyte, size / PAGE_SIZE);
 128         }
 129
 130         prfunc("Excluded memory regions:\n");
 131         for (i = 0; i < excnt; ++i) {
 132                 addr  = exregions[i].addr;
 133                 size  = exregions[i].size;
 134                 flags = exregions[i].flags;
 135                 prfunc("  0x%08jx - 0x%08jx, %5ju MB (%7ju pages) %s %s\n",
 136                     addr, addr + size - 1, size / mbyte, size / PAGE_SIZE,
 137                     (flags & EXFLAG_NOALLOC) ? "NoAlloc" : "",
 138                     (flags & EXFLAG_NODUMP)  ? "NoDump" : "");
 139         }
 140
 141 #ifdef DEBUG
 142         prfunc("Avail lists:\n");
 143         for (i = 0; phys_avail[i] != 0; ++i) {
 144                 prfunc("  phys_avail[%d] 0x%08x\n", i, phys_avail[i]);
 145         }
 146         for (i = 0; dump_avail[i] != 0; ++i) {
 147                 prfunc("  dump_avail[%d] 0x%08x\n", i, dump_avail[i]);
 148         }
 149 #endif
 150 }
 151
 152 /*
 153  * Print the contents of the static mapping table.  Used for bootverbose.
 154  */
 155 void
 156 arm_physmem_print_tables(void)
 157 {
 158
 159         physmem_dump_tables(printf);
 160 }
 161
 162 /*
 163  * Walk the list of hardware regions, processing it against the list of
 164  * exclusions that contain the given exflags, and generating an "avail list".
 165  *
 166  * Updates the value at *pavail with the sum of all pages in all hw regions.
 167  *
 168  * Returns the number of pages of non-excluded memory added to the avail list.
 169  */
 170 static size_t
 171 regions_to_avail(vm_paddr_t *avail, uint32_t exflags, size_t maxavail,
 172     long *pavail, long *prealmem)
 173 {
 174         size_t acnt, exi, hwi;
 175         uint64_t end, start, xend, xstart;
 176         long availmem, totalmem;
 177         const struct region *exp, *hwp;
 178
 179         totalmem = 0;
 180         availmem = 0;
 181         acnt = 0;
 182         for (hwi = 0, hwp = hwregions; hwi < hwcnt; ++hwi, ++hwp) {
 183                 start = hwp->addr;
 184                 end   = hwp->size + start;
 185                 totalmem += pm_btop((vm_offset_t)(end - start));
 186                 for (exi = 0, exp = exregions; exi < excnt; ++exi, ++exp) {
 187                         /*
 188                          * If the excluded region does not match given flags,
 189                          * continue checking with the next excluded region.
 190                          */
 191                         if ((exp->flags & exflags) == 0)
 192                                 continue;
 193                         xstart = exp->addr;
 194                         xend   = exp->size + xstart;
 195                         /*
 196                          * If the excluded region ends before this hw region,
 197                          * continue checking with the next excluded region.
 198                          */
 199                         if (xend <= start)
 200                                 continue;
 201                         /*
 202                          * If the excluded region begins after this hw region
 203                          * we're done because both lists are sorted.
 204                          */
 205                         if (xstart >= end)
 206                                 break;
 207                         /*
 208                          * If the excluded region completely covers this hw
 209                          * region, shrink this hw region to zero size.
 210                          */
 211                         if ((start >= xstart) && (end <= xend)) {
 212                                 start = xend;
 213                                 end = xend;
 214                                 break;
 215                         }
 216                         /*
 217                          * If the excluded region falls wholly within this hw
 218                          * region without abutting or overlapping the beginning
 219                          * or end, create an available entry from the leading
 220                          * fragment, then adjust the start of this hw region to
 221                          * the end of the excluded region, and continue checking
 222                          * the next excluded region because another exclusion
 223                          * could affect the remainder of this hw region.
 224                          */
 225                         if ((xstart > start) && (xend < end)) {
 226                                 if (acnt > 0 &&
 227                                     avail[acnt - 1] == (vm_paddr_t)start) {
 228                                         avail[acnt - 1] = (vm_paddr_t)xstart;
 229                                 } else {
 230                                         avail[acnt++] = (vm_paddr_t)start;
 231                                         avail[acnt++] = (vm_paddr_t)xstart;
 232                                 }
 233                                 availmem +=
 234                                     pm_btop((vm_offset_t)(xstart - start));
 235                                 start = xend;
 236                                 continue;
 237                         }
 238                         /*
 239                          * We know the excluded region overlaps either the start
 240                          * or end of this hardware region (but not both), trim
 241                          * the excluded portion off the appropriate end.
 242                          */
 243                         if (xstart <= start)
 244                                 start = xend;
 245                         else
 246                                 end = xstart;
 247                 }
 248                 /*
 249                  * If the trimming actions above left a non-zero size, create an
 250                  * available entry for it.
 251                  */
 252                 if (end > start) {
 253                         if (acnt > 0 && avail[acnt - 1] == (vm_paddr_t)start) {
 254                                 avail[acnt - 1] = (vm_paddr_t)end;
 255                         } else {
 256                                 avail[acnt++] = (vm_paddr_t)start;
 257                                 avail[acnt++] = (vm_paddr_t)end;
 258                         }
 259                         availmem += pm_btop((vm_offset_t)(end - start));
 260                 }
 261                 if (acnt >= maxavail)
 262                         panic("Not enough space in the dump/phys_avail arrays");
 263         }
 264
 265         if (pavail != NULL)
 266                 *pavail = availmem;
 267         if (prealmem != NULL)
 268                 *prealmem = realmem;
 269         return (acnt);
 270 }
 271
 272 /*
 273  * Insertion-sort a new entry into a regions list; sorted by start address.
 274  */
 275 static size_t
 276 insert_region(struct region *regions, size_t rcnt, vm_paddr_t addr,
 277     vm_size_t size, uint32_t flags)
 278 {
 279         size_t i;
 280         struct region *ep, *rp;
 281
 282         ep = regions + rcnt;
 283         for (i = 0, rp = regions; i < rcnt; ++i, ++rp) {
 284                 if (flags == rp->flags) {
 285                         if (addr + size == rp->addr) {
 286                                 rp->addr = addr;
 287                                 rp->size += size;
 288                                 return (rcnt);
 289                         } else if (rp->addr + rp->size == addr) {
 290                                 rp->size += size;
 291                                 return (rcnt);
 292                         }
 293                 }
 294                 if (addr < rp->addr) {
 295                         bcopy(rp, rp + 1, (ep - rp) * sizeof(*rp));
 296                         break;
 297                 }
 298         }
 299         rp->addr  = addr;
 300         rp->size  = size;
 301         rp->flags = flags;
 302         rcnt++;
 303
 304         return (rcnt);
 305 }
 306
 307 /*
 308  * Add a hardware memory region.
 309  */
 310 void
 311 arm_physmem_hardware_region(uint64_t pa, uint64_t sz)
 312 {
 313         vm_offset_t adj;
 314
 315         /*
 316          * Filter out the page at PA 0x00000000.  The VM can't handle it, as
 317          * pmap_extract() == 0 means failure.
 318          */
 319         if (pa == 0) {
 320                 if (sz <= PAGE_SIZE)
 321                         return;
 322                 pa  = PAGE_SIZE;
 323                 sz -= PAGE_SIZE;
 324         } else if (pa > MAX_PHYS_ADDR) {
 325                 /* This range is past usable memory, ignore it */
 326                 return;
 327         }
 328
 329         /*
 330          * Also filter out the page at the end of the physical address space --
 331          * if addr is non-zero and addr+size is zero we wrapped to the next byte
 332          * beyond what vm_paddr_t can express.  That leads to a NULL pointer
 333          * deref early in startup; work around it by leaving the last page out.
 334          *
 335          * XXX This just in:  subtract out a whole megabyte, not just 1 page.
 336          * Reducing the size by anything less than 1MB results in the NULL
 337          * pointer deref in _vm_map_lock_read().  Better to give up a megabyte
 338          * than leave some folks with an unusable system while we investigate.
 339          */
 340         if ((pa + sz) > (MAX_PHYS_ADDR - 1024 * 1024)) {
 341                 sz = MAX_PHYS_ADDR - pa + 1;
 342                 if (sz <= 1024 * 1024)
 343                         return;
 344                 sz -= 1024 * 1024;
 345         }
 346
 347         /*
 348          * Round the starting address up to a page boundary, and truncate the
 349          * ending page down to a page boundary.
 350          */
 351         adj = round_page(pa) - pa;
 352         pa  = round_page(pa);
 353         sz  = trunc_page(sz - adj);
 354
 355         if (sz > 0 && hwcnt < nitems(hwregions))
 356                 hwcnt = insert_region(hwregions, hwcnt, pa, sz, 0);
 357 }
 358
 359 /*
 360  * Add an exclusion region.
 361  */
 362 void arm_physmem_exclude_region(vm_paddr_t pa, vm_size_t sz, uint32_t exflags)
 363 {
 364         vm_offset_t adj;
 365
 366         /*
 367          * Truncate the starting address down to a page boundary, and round the
 368          * ending page up to a page boundary.
 369          */
 370         adj = pa - trunc_page(pa);
 371         pa  = trunc_page(pa);
 372         sz  = round_page(sz + adj);
 373
 374         if (excnt < nitems(exregions))
 375                 excnt = insert_region(exregions, excnt, pa, sz, exflags);
 376 }
 377
 378 size_t
 379 arm_physmem_avail(vm_paddr_t *avail, size_t maxavail)
 380 {
 381
 382         return (regions_to_avail(avail, EXFLAG_NOALLOC, maxavail, NULL, NULL));
 383 }
 384
 385 /*
 386  * Process all the regions added earlier into the global avail lists.
 387  *
 388  * Updates the kernel global 'physmem' with the number of physical pages
 389  * available for use (all pages not in any exclusion region).
 390  *
 391  * Updates the kernel global 'Maxmem' with the page number one greater then the
 392  * last page of physical memory in the system.
 393  */
 394 void
 395 arm_physmem_init_kernel_globals(void)
 396 {
 397         size_t nextidx;
 398
 399         regions_to_avail(dump_avail, EXFLAG_NODUMP, MAX_AVAIL_ENTRIES, NULL,
 400             NULL);
 401         nextidx = regions_to_avail(phys_avail, EXFLAG_NOALLOC,
 402             MAX_AVAIL_ENTRIES, &physmem, &realmem);
 403         if (nextidx == 0)
 404                 panic("No memory entries in phys_avail");
 405         Maxmem = atop(phys_avail[nextidx - 1]);
 406 }
 407
 408 #ifdef DDB
 409 #include <ddb/ddb.h>
 410
 411 DB_SHOW_COMMAND(physmem, db_show_physmem)
 412 {
 413
 414         physmem_dump_tables(db_printf);
 415 }
 416
 417 #endif /* DDB */
 418