lib/lmb.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Procedures for maintaining information about logical memory blocks.
   4  *
   5  * Peter Bergner, IBM Corp.     June 2001.
   6  * Copyright (C) 2001 Peter Bergner.
   7  */
   8
   9 #include <common.h>
  10 #include <lmb.h>
  11
  12 #define LMB_ALLOC_ANYWHERE      0
  13
  14 void lmb_dump_all(struct lmb *lmb)
  15 {
  16 #ifdef DEBUG
  17         unsigned long i;
  18
  19         debug("lmb_dump_all:\n");
  20         debug("    memory.cnt              = 0x%lx\n", lmb->memory.cnt);
  21         debug("    memory.size             = 0x%llx\n",
  22               (unsigned long long)lmb->memory.size);
  23         for (i=0; i < lmb->memory.cnt ;i++) {
  24                 debug("    memory.reg[0x%lx].base   = 0x%llx\n", i,
  25                         (long long unsigned)lmb->memory.region[i].base);
  26                 debug("            .size   = 0x%llx\n",
  27                         (long long unsigned)lmb->memory.region[i].size);
  28         }
  29
  30         debug("\n    reserved.cnt          = 0x%lx\n",
  31                 lmb->reserved.cnt);
  32         debug("    reserved.size           = 0x%llx\n",
  33                 (long long unsigned)lmb->reserved.size);
  34         for (i=0; i < lmb->reserved.cnt ;i++) {
  35                 debug("    reserved.reg[0x%lx].base = 0x%llx\n", i,
  36                         (long long unsigned)lmb->reserved.region[i].base);
  37                 debug("              .size = 0x%llx\n",
  38                         (long long unsigned)lmb->reserved.region[i].size);
  39         }
  40 #endif /* DEBUG */
  41 }
  42
  43 static long lmb_addrs_overlap(phys_addr_t base1,
  44                 phys_size_t size1, phys_addr_t base2, phys_size_t size2)
  45 {
  46         const phys_addr_t base1_end = base1 + size1 - 1;
  47         const phys_addr_t base2_end = base2 + size2 - 1;
  48
  49         return ((base1 <= base2_end) && (base2 <= base1_end));
  50 }
  51
  52 static long lmb_addrs_adjacent(phys_addr_t base1, phys_size_t size1,
  53                 phys_addr_t base2, phys_size_t size2)
  54 {
  55         if (base2 == base1 + size1)
  56                 return 1;
  57         else if (base1 == base2 + size2)
  58                 return -1;
  59
  60         return 0;
  61 }
  62
  63 static long lmb_regions_adjacent(struct lmb_region *rgn,
  64                 unsigned long r1, unsigned long r2)
  65 {
  66         phys_addr_t base1 = rgn->region[r1].base;
  67         phys_size_t size1 = rgn->region[r1].size;
  68         phys_addr_t base2 = rgn->region[r2].base;
  69         phys_size_t size2 = rgn->region[r2].size;
  70
  71         return lmb_addrs_adjacent(base1, size1, base2, size2);
  72 }
  73
  74 static void lmb_remove_region(struct lmb_region *rgn, unsigned long r)
  75 {
  76         unsigned long i;
  77
  78         for (i = r; i < rgn->cnt - 1; i++) {
  79                 rgn->region[i].base = rgn->region[i + 1].base;
  80                 rgn->region[i].size = rgn->region[i + 1].size;
  81         }
  82         rgn->cnt--;
  83 }
  84
  85 /* Assumption: base addr of region 1 < base addr of region 2 */
  86 static void lmb_coalesce_regions(struct lmb_region *rgn,
  87                 unsigned long r1, unsigned long r2)
  88 {
  89         rgn->region[r1].size += rgn->region[r2].size;
  90         lmb_remove_region(rgn, r2);
  91 }
  92
  93 void lmb_init(struct lmb *lmb)
  94 {
  95         lmb->memory.cnt = 0;
  96         lmb->memory.size = 0;
  97         lmb->reserved.cnt = 0;
  98         lmb->reserved.size = 0;
  99 }
 100
 101 /* This routine called with relocation disabled. */
 102 static long lmb_add_region(struct lmb_region *rgn, phys_addr_t base, phys_size_t size)
 103 {
 104         unsigned long coalesced = 0;
 105         long adjacent, i;
 106
 107         if (rgn->cnt == 0) {
 108                 rgn->region[0].base = base;
 109                 rgn->region[0].size = size;
 110                 rgn->cnt = 1;
 111                 return 0;
 112         }
 113
 114         /* First try and coalesce this LMB with another. */
 115         for (i=0; i < rgn->cnt; i++) {
 116                 phys_addr_t rgnbase = rgn->region[i].base;
 117                 phys_size_t rgnsize = rgn->region[i].size;
 118
 119                 if ((rgnbase == base) && (rgnsize == size))
 120                         /* Already have this region, so we're done */
 121                         return 0;
 122
 123                 adjacent = lmb_addrs_adjacent(base,size,rgnbase,rgnsize);
 124                 if ( adjacent > 0 ) {
 125                         rgn->region[i].base -= size;
 126                         rgn->region[i].size += size;
 127                         coalesced++;
 128                         break;
 129                 }
 130                 else if ( adjacent < 0 ) {
 131                         rgn->region[i].size += size;
 132                         coalesced++;
 133                         break;
 134                 } else if (lmb_addrs_overlap(base, size, rgnbase, rgnsize)) {
 135                         /* regions overlap */
 136                         return -1;
 137                 }
 138         }
 139
 140         if ((i < rgn->cnt-1) && lmb_regions_adjacent(rgn, i, i+1) ) {
 141                 lmb_coalesce_regions(rgn, i, i+1);
 142                 coalesced++;
 143         }
 144
 145         if (coalesced)
 146                 return coalesced;
 147         if (rgn->cnt >= MAX_LMB_REGIONS)
 148                 return -1;
 149
 150         /* Couldn't coalesce the LMB, so add it to the sorted table. */
 151         for (i = rgn->cnt-1; i >= 0; i--) {
 152                 if (base < rgn->region[i].base) {
 153                         rgn->region[i+1].base = rgn->region[i].base;
 154                         rgn->region[i+1].size = rgn->region[i].size;
 155                 } else {
 156                         rgn->region[i+1].base = base;
 157                         rgn->region[i+1].size = size;
 158                         break;
 159                 }
 160         }
 161
 162         if (base < rgn->region[0].base) {
 163                 rgn->region[0].base = base;
 164                 rgn->region[0].size = size;
 165         }
 166
 167         rgn->cnt++;
 168
 169         return 0;
 170 }
 171
 172 /* This routine may be called with relocation disabled. */
 173 long lmb_add(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 174 {
 175         struct lmb_region *_rgn = &(lmb->memory);
 176
 177         return lmb_add_region(_rgn, base, size);
 178 }
 179
 180 long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 181 {
 182         struct lmb_region *rgn = &(lmb->reserved);
 183         phys_addr_t rgnbegin, rgnend;
 184         phys_addr_t end = base + size - 1;
 185         int i;
 186
 187         rgnbegin = rgnend = 0; /* supress gcc warnings */
 188
 189         /* Find the region where (base, size) belongs to */
 190         for (i=0; i < rgn->cnt; i++) {
 191                 rgnbegin = rgn->region[i].base;
 192                 rgnend = rgnbegin + rgn->region[i].size - 1;
 193
 194                 if ((rgnbegin <= base) && (end <= rgnend))
 195                         break;
 196         }
 197
 198         /* Didn't find the region */
 199         if (i == rgn->cnt)
 200                 return -1;
 201
 202         /* Check to see if we are removing entire region */
 203         if ((rgnbegin == base) && (rgnend == end)) {
 204                 lmb_remove_region(rgn, i);
 205                 return 0;
 206         }
 207
 208         /* Check to see if region is matching at the front */
 209         if (rgnbegin == base) {
 210                 rgn->region[i].base = end + 1;
 211                 rgn->region[i].size -= size;
 212                 return 0;
 213         }
 214
 215         /* Check to see if the region is matching at the end */
 216         if (rgnend == end) {
 217                 rgn->region[i].size -= size;
 218                 return 0;
 219         }
 220
 221         /*
 222          * We need to split the entry -  adjust the current one to the
 223          * beginging of the hole and add the region after hole.
 224          */
 225         rgn->region[i].size = base - rgn->region[i].base;
 226         return lmb_add_region(rgn, end + 1, rgnend - end);
 227 }
 228
 229 long lmb_reserve(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 230 {
 231         struct lmb_region *_rgn = &(lmb->reserved);
 232
 233         return lmb_add_region(_rgn, base, size);
 234 }
 235
 236 static long lmb_overlaps_region(struct lmb_region *rgn, phys_addr_t base,
 237                                 phys_size_t size)
 238 {
 239         unsigned long i;
 240
 241         for (i=0; i < rgn->cnt; i++) {
 242                 phys_addr_t rgnbase = rgn->region[i].base;
 243                 phys_size_t rgnsize = rgn->region[i].size;
 244                 if ( lmb_addrs_overlap(base,size,rgnbase,rgnsize) ) {
 245                         break;
 246                 }
 247         }
 248
 249         return (i < rgn->cnt) ? i : -1;
 250 }
 251
 252 phys_addr_t lmb_alloc(struct lmb *lmb, phys_size_t size, ulong align)
 253 {
 254         return lmb_alloc_base(lmb, size, align, LMB_ALLOC_ANYWHERE);
 255 }
 256
 257 phys_addr_t lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align, phys_addr_t max_addr)
 258 {
 259         phys_addr_t alloc;
 260
 261         alloc = __lmb_alloc_base(lmb, size, align, max_addr);
 262
 263         if (alloc == 0)
 264                 printf("ERROR: Failed to allocate 0x%lx bytes below 0x%lx.\n",
 265                       (ulong)size, (ulong)max_addr);
 266
 267         return alloc;
 268 }
 269
 270 static phys_addr_t lmb_align_down(phys_addr_t addr, phys_size_t size)
 271 {
 272         return addr & ~(size - 1);
 273 }
 274
 275 phys_addr_t __lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align, phys_addr_t max_addr)
 276 {
 277         long i, j;
 278         phys_addr_t base = 0;
 279         phys_addr_t res_base;
 280
 281         for (i = lmb->memory.cnt-1; i >= 0; i--) {
 282                 phys_addr_t lmbbase = lmb->memory.region[i].base;
 283                 phys_size_t lmbsize = lmb->memory.region[i].size;
 284
 285                 if (lmbsize < size)
 286                         continue;
 287                 if (max_addr == LMB_ALLOC_ANYWHERE)
 288                         base = lmb_align_down(lmbbase + lmbsize - size, align);
 289                 else if (lmbbase < max_addr) {
 290                         base = lmbbase + lmbsize;
 291                         if (base < lmbbase)
 292                                 base = -1;
 293                         base = min(base, max_addr);
 294                         base = lmb_align_down(base - size, align);
 295                 } else
 296                         continue;
 297
 298                 while (base && lmbbase <= base) {
 299                         j = lmb_overlaps_region(&lmb->reserved, base, size);
 300                         if (j < 0) {
 301                                 /* This area isn't reserved, take it */
 302                                 if (lmb_add_region(&lmb->reserved, base,
 303                                                    size) < 0)
 304                                         return 0;
 305                                 return base;
 306                         }
 307                         res_base = lmb->reserved.region[j].base;
 308                         if (res_base < size)
 309                                 break;
 310                         base = lmb_align_down(res_base - size, align);
 311                 }
 312         }
 313         return 0;
 314 }
 315
 316 int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr)
 317 {
 318         int i;
 319
 320         for (i = 0; i < lmb->reserved.cnt; i++) {
 321                 phys_addr_t upper = lmb->reserved.region[i].base +
 322                         lmb->reserved.region[i].size - 1;
 323                 if ((addr >= lmb->reserved.region[i].base) && (addr <= upper))
 324                         return 1;
 325         }
 326         return 0;
 327 }
 328
 329 __weak void board_lmb_reserve(struct lmb *lmb)
 330 {
 331         /* please define platform specific board_lmb_reserve() */
 332 }
 333
 334 __weak void arch_lmb_reserve(struct lmb *lmb)
 335 {
 336         /* please define platform specific arch_lmb_reserve() */
 337 }