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                 }
 135         }
 136
 137         if ((i < rgn->cnt-1) && lmb_regions_adjacent(rgn, i, i+1) ) {
 138                 lmb_coalesce_regions(rgn, i, i+1);
 139                 coalesced++;
 140         }
 141
 142         if (coalesced)
 143                 return coalesced;
 144         if (rgn->cnt >= MAX_LMB_REGIONS)
 145                 return -1;
 146
 147         /* Couldn't coalesce the LMB, so add it to the sorted table. */
 148         for (i = rgn->cnt-1; i >= 0; i--) {
 149                 if (base < rgn->region[i].base) {
 150                         rgn->region[i+1].base = rgn->region[i].base;
 151                         rgn->region[i+1].size = rgn->region[i].size;
 152                 } else {
 153                         rgn->region[i+1].base = base;
 154                         rgn->region[i+1].size = size;
 155                         break;
 156                 }
 157         }
 158
 159         if (base < rgn->region[0].base) {
 160                 rgn->region[0].base = base;
 161                 rgn->region[0].size = size;
 162         }
 163
 164         rgn->cnt++;
 165
 166         return 0;
 167 }
 168
 169 /* This routine may be called with relocation disabled. */
 170 long lmb_add(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 171 {
 172         struct lmb_region *_rgn = &(lmb->memory);
 173
 174         return lmb_add_region(_rgn, base, size);
 175 }
 176
 177 long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 178 {
 179         struct lmb_region *rgn = &(lmb->reserved);
 180         phys_addr_t rgnbegin, rgnend;
 181         phys_addr_t end = base + size - 1;
 182         int i;
 183
 184         rgnbegin = rgnend = 0; /* supress gcc warnings */
 185
 186         /* Find the region where (base, size) belongs to */
 187         for (i=0; i < rgn->cnt; i++) {
 188                 rgnbegin = rgn->region[i].base;
 189                 rgnend = rgnbegin + rgn->region[i].size - 1;
 190
 191                 if ((rgnbegin <= base) && (end <= rgnend))
 192                         break;
 193         }
 194
 195         /* Didn't find the region */
 196         if (i == rgn->cnt)
 197                 return -1;
 198
 199         /* Check to see if we are removing entire region */
 200         if ((rgnbegin == base) && (rgnend == end)) {
 201                 lmb_remove_region(rgn, i);
 202                 return 0;
 203         }
 204
 205         /* Check to see if region is matching at the front */
 206         if (rgnbegin == base) {
 207                 rgn->region[i].base = end + 1;
 208                 rgn->region[i].size -= size;
 209                 return 0;
 210         }
 211
 212         /* Check to see if the region is matching at the end */
 213         if (rgnend == end) {
 214                 rgn->region[i].size -= size;
 215                 return 0;
 216         }
 217
 218         /*
 219          * We need to split the entry -  adjust the current one to the
 220          * beginging of the hole and add the region after hole.
 221          */
 222         rgn->region[i].size = base - rgn->region[i].base;
 223         return lmb_add_region(rgn, end + 1, rgnend - end);
 224 }
 225
 226 long lmb_reserve(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 227 {
 228         struct lmb_region *_rgn = &(lmb->reserved);
 229
 230         return lmb_add_region(_rgn, base, size);
 231 }
 232
 233 static long lmb_overlaps_region(struct lmb_region *rgn, phys_addr_t base,
 234                                 phys_size_t size)
 235 {
 236         unsigned long i;
 237
 238         for (i=0; i < rgn->cnt; i++) {
 239                 phys_addr_t rgnbase = rgn->region[i].base;
 240                 phys_size_t rgnsize = rgn->region[i].size;
 241                 if ( lmb_addrs_overlap(base,size,rgnbase,rgnsize) ) {
 242                         break;
 243                 }
 244         }
 245
 246         return (i < rgn->cnt) ? i : -1;
 247 }
 248
 249 phys_addr_t lmb_alloc(struct lmb *lmb, phys_size_t size, ulong align)
 250 {
 251         return lmb_alloc_base(lmb, size, align, LMB_ALLOC_ANYWHERE);
 252 }
 253
 254 phys_addr_t lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align, phys_addr_t max_addr)
 255 {
 256         phys_addr_t alloc;
 257
 258         alloc = __lmb_alloc_base(lmb, size, align, max_addr);
 259
 260         if (alloc == 0)
 261                 printf("ERROR: Failed to allocate 0x%lx bytes below 0x%lx.\n",
 262                       (ulong)size, (ulong)max_addr);
 263
 264         return alloc;
 265 }
 266
 267 static phys_addr_t lmb_align_down(phys_addr_t addr, phys_size_t size)
 268 {
 269         return addr & ~(size - 1);
 270 }
 271
 272 static phys_addr_t lmb_align_up(phys_addr_t addr, ulong size)
 273 {
 274         return (addr + (size - 1)) & ~(size - 1);
 275 }
 276
 277 phys_addr_t __lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align, phys_addr_t max_addr)
 278 {
 279         long i, j;
 280         phys_addr_t base = 0;
 281         phys_addr_t res_base;
 282
 283         for (i = lmb->memory.cnt-1; i >= 0; i--) {
 284                 phys_addr_t lmbbase = lmb->memory.region[i].base;
 285                 phys_size_t lmbsize = lmb->memory.region[i].size;
 286
 287                 if (lmbsize < size)
 288                         continue;
 289                 if (max_addr == LMB_ALLOC_ANYWHERE)
 290                         base = lmb_align_down(lmbbase + lmbsize - size, align);
 291                 else if (lmbbase < max_addr) {
 292                         base = lmbbase + lmbsize;
 293                         if (base < lmbbase)
 294                                 base = -1;
 295                         base = min(base, max_addr);
 296                         base = lmb_align_down(base - size, align);
 297                 } else
 298                         continue;
 299
 300                 while (base && lmbbase <= base) {
 301                         j = lmb_overlaps_region(&lmb->reserved, base, size);
 302                         if (j < 0) {
 303                                 /* This area isn't reserved, take it */
 304                                 if (lmb_add_region(&lmb->reserved, base,
 305                                                         lmb_align_up(size,
 306                                                                 align)) < 0)
 307                                         return 0;
 308                                 return base;
 309                         }
 310                         res_base = lmb->reserved.region[j].base;
 311                         if (res_base < size)
 312                                 break;
 313                         base = lmb_align_down(res_base - size, align);
 314                 }
 315         }
 316         return 0;
 317 }
 318
 319 int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr)
 320 {
 321         int i;
 322
 323         for (i = 0; i < lmb->reserved.cnt; i++) {
 324                 phys_addr_t upper = lmb->reserved.region[i].base +
 325                         lmb->reserved.region[i].size - 1;
 326                 if ((addr >= lmb->reserved.region[i].base) && (addr <= upper))
 327                         return 1;
 328         }
 329         return 0;
 330 }
 331
 332 __weak void board_lmb_reserve(struct lmb *lmb)
 333 {
 334         /* please define platform specific board_lmb_reserve() */
 335 }
 336
 337 __weak void arch_lmb_reserve(struct lmb *lmb)
 338 {
 339         /* please define platform specific arch_lmb_reserve() */
 340 }