sys/kern/subr_rman.c

   1 /*-
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * The kernel resource manager.  This code is responsible for keeping track
  32  * of hardware resources which are apportioned out to various drivers.
  33  * It does not actually assign those resources, and it is not expected
  34  * that end-device drivers will call into this code directly.  Rather,
  35  * the code which implements the buses that those devices are attached to,
  36  * and the code which manages CPU resources, will call this code, and the
  37  * end-device drivers will make upcalls to that code to actually perform
  38  * the allocation.
  39  *
  40  * There are two sorts of resources managed by this code.  The first is
  41  * the more familiar array (RMAN_ARRAY) type; resources in this class
  42  * consist of a sequence of individually-allocatable objects which have
  43  * been numbered in some well-defined order.  Most of the resources
  44  * are of this type, as it is the most familiar.  The second type is
  45  * called a gauge (RMAN_GAUGE), and models fungible resources (i.e.,
  46  * resources in which each instance is indistinguishable from every
  47  * other instance).  The principal anticipated application of gauges
  48  * is in the context of power consumption, where a bus may have a specific
  49  * power budget which all attached devices share.  RMAN_GAUGE is not
  50  * implemented yet.
  51  *
  52  * For array resources, we make one simplifying assumption: two clients
  53  * sharing the same resource must use the same range of indices.  That
  54  * is to say, sharing of overlapping-but-not-identical regions is not
  55  * permitted.
  56  */
  57
  58 #include "opt_ddb.h"
  59
  60 #include <sys/cdefs.h>
  61 __FBSDID("$FreeBSD$");
  62
  63 #include <sys/param.h>
  64 #include <sys/systm.h>
  65 #include <sys/kernel.h>
  66 #include <sys/limits.h>
  67 #include <sys/lock.h>
  68 #include <sys/malloc.h>
  69 #include <sys/mutex.h>
  70 #include <sys/bus.h>            /* XXX debugging */
  71 #include <machine/bus.h>
  72 #include <sys/rman.h>
  73 #include <sys/sysctl.h>
  74
  75 #ifdef DDB
  76 #include <ddb/ddb.h>
  77 #endif
  78
  79 /*
  80  * We use a linked list rather than a bitmap because we need to be able to
  81  * represent potentially huge objects (like all of a processor's physical
  82  * address space).  That is also why the indices are defined to have type
  83  * `unsigned long' -- that being the largest integral type in ISO C (1990).
  84  * The 1999 version of C allows `long long'; we may need to switch to that
  85  * at some point in the future, particularly if we want to support 36-bit
  86  * addresses on IA32 hardware.
  87  */
  88 struct resource_i {
  89         struct resource         r_r;
  90         TAILQ_ENTRY(resource_i) r_link;
  91         LIST_ENTRY(resource_i)  r_sharelink;
  92         LIST_HEAD(, resource_i) *r_sharehead;
  93         u_long  r_start;        /* index of the first entry in this resource */
  94         u_long  r_end;          /* index of the last entry (inclusive) */
  95         u_int   r_flags;
  96         void    *r_virtual;     /* virtual address of this resource */
  97         struct  device *r_dev;  /* device which has allocated this resource */
  98         struct  rman *r_rm;     /* resource manager from whence this came */
  99         int     r_rid;          /* optional rid for this resource. */
 100 };
 101
 102 static int     rman_debug = 0;
 103 TUNABLE_INT("debug.rman_debug", &rman_debug);
 104 SYSCTL_INT(_debug, OID_AUTO, rman_debug, CTLFLAG_RW,
 105     &rman_debug, 0, "rman debug");
 106
 107 #define DPRINTF(params) if (rman_debug) printf params
 108
 109 static MALLOC_DEFINE(M_RMAN, "rman", "Resource manager");
 110
 111 struct  rman_head rman_head;
 112 static  struct mtx rman_mtx; /* mutex to protect rman_head */
 113 static  int int_rman_activate_resource(struct rman *rm, struct resource_i *r,
 114                                        struct resource_i **whohas);
 115 static  int int_rman_deactivate_resource(struct resource_i *r);
 116 static  int int_rman_release_resource(struct rman *rm, struct resource_i *r);
 117
 118 static __inline struct resource_i *
 119 int_alloc_resource(int malloc_flag)
 120 {
 121         struct resource_i *r;
 122
 123         r = malloc(sizeof *r, M_RMAN, malloc_flag | M_ZERO);
 124         if (r != NULL) {
 125                 r->r_r.__r_i = r;
 126         }
 127         return (r);
 128 }
 129
 130 int
 131 rman_init(struct rman *rm)
 132 {
 133         static int once = 0;
 134
 135         if (once == 0) {
 136                 once = 1;
 137                 TAILQ_INIT(&rman_head);
 138                 mtx_init(&rman_mtx, "rman head", NULL, MTX_DEF);
 139         }
 140
 141         if (rm->rm_start == 0 && rm->rm_end == 0)
 142                 rm->rm_end = ~0ul;
 143         if (rm->rm_type == RMAN_UNINIT)
 144                 panic("rman_init");
 145         if (rm->rm_type == RMAN_GAUGE)
 146                 panic("implement RMAN_GAUGE");
 147
 148         TAILQ_INIT(&rm->rm_list);
 149         rm->rm_mtx = malloc(sizeof *rm->rm_mtx, M_RMAN, M_NOWAIT | M_ZERO);
 150         if (rm->rm_mtx == NULL)
 151                 return ENOMEM;
 152         mtx_init(rm->rm_mtx, "rman", NULL, MTX_DEF);
 153
 154         mtx_lock(&rman_mtx);
 155         TAILQ_INSERT_TAIL(&rman_head, rm, rm_link);
 156         mtx_unlock(&rman_mtx);
 157         return 0;
 158 }
 159
 160 int
 161 rman_manage_region(struct rman *rm, u_long start, u_long end)
 162 {
 163         struct resource_i *r, *s, *t;
 164
 165         DPRINTF(("rman_manage_region: <%s> request: start %#lx, end %#lx\n",
 166             rm->rm_descr, start, end));
 167         if (start < rm->rm_start || end > rm->rm_end)
 168                 return EINVAL;
 169         r = int_alloc_resource(M_NOWAIT);
 170         if (r == NULL)
 171                 return ENOMEM;
 172         r->r_start = start;
 173         r->r_end = end;
 174         r->r_rm = rm;
 175
 176         mtx_lock(rm->rm_mtx);
 177
 178         /* Skip entries before us. */
 179         TAILQ_FOREACH(s, &rm->rm_list, r_link) {
 180                 if (s->r_end == ULONG_MAX)
 181                         break;
 182                 if (s->r_end + 1 >= r->r_start)
 183                         break;
 184         }
 185
 186         /* If we ran off the end of the list, insert at the tail. */
 187         if (s == NULL) {
 188                 TAILQ_INSERT_TAIL(&rm->rm_list, r, r_link);
 189         } else {
 190                 /* Check for any overlap with the current region. */
 191                 if (r->r_start <= s->r_end && r->r_end >= s->r_start)
 192                         return EBUSY;
 193
 194                 /* Check for any overlap with the next region. */
 195                 t = TAILQ_NEXT(s, r_link);
 196                 if (t && r->r_start <= t->r_end && r->r_end >= t->r_start)
 197                         return EBUSY;
 198
 199                 /*
 200                  * See if this region can be merged with the next region.  If
 201                  * not, clear the pointer.
 202                  */
 203                 if (t && (r->r_end + 1 != t->r_start || t->r_flags != 0))
 204                         t = NULL;
 205
 206                 /* See if we can merge with the current region. */
 207                 if (s->r_end + 1 == r->r_start && s->r_flags == 0) {
 208                         /* Can we merge all 3 regions? */
 209                         if (t != NULL) {
 210                                 s->r_end = t->r_end;
 211                                 TAILQ_REMOVE(&rm->rm_list, t, r_link);
 212                                 free(r, M_RMAN);
 213                                 free(t, M_RMAN);
 214                         } else {
 215                                 s->r_end = r->r_end;
 216                                 free(r, M_RMAN);
 217                         }
 218                 } else if (t != NULL) {
 219                         /* Can we merge with just the next region? */
 220                         t->r_start = r->r_start;
 221                         free(r, M_RMAN);
 222                 } else if (s->r_end < r->r_start) {
 223                         TAILQ_INSERT_AFTER(&rm->rm_list, s, r, r_link);
 224                 } else {
 225                         TAILQ_INSERT_BEFORE(s, r, r_link);
 226                 }
 227         }
 228
 229         mtx_unlock(rm->rm_mtx);
 230         return 0;
 231 }
 232
 233 int
 234 rman_init_from_resource(struct rman *rm, struct resource *r)
 235 {
 236         int rv;
 237
 238         if ((rv = rman_init(rm)) != 0)
 239                 return (rv);
 240         return (rman_manage_region(rm, r->__r_i->r_start, r->__r_i->r_end));
 241 }
 242
 243 int
 244 rman_fini(struct rman *rm)
 245 {
 246         struct resource_i *r;
 247
 248         mtx_lock(rm->rm_mtx);
 249         TAILQ_FOREACH(r, &rm->rm_list, r_link) {
 250                 if (r->r_flags & RF_ALLOCATED) {
 251                         mtx_unlock(rm->rm_mtx);
 252                         return EBUSY;
 253                 }
 254         }
 255
 256         /*
 257          * There really should only be one of these if we are in this
 258          * state and the code is working properly, but it can't hurt.
 259          */
 260         while (!TAILQ_EMPTY(&rm->rm_list)) {
 261                 r = TAILQ_FIRST(&rm->rm_list);
 262                 TAILQ_REMOVE(&rm->rm_list, r, r_link);
 263                 free(r, M_RMAN);
 264         }
 265         mtx_unlock(rm->rm_mtx);
 266         mtx_lock(&rman_mtx);
 267         TAILQ_REMOVE(&rman_head, rm, rm_link);
 268         mtx_unlock(&rman_mtx);
 269         mtx_destroy(rm->rm_mtx);
 270         free(rm->rm_mtx, M_RMAN);
 271
 272         return 0;
 273 }
 274
 275 int
 276 rman_first_free_region(struct rman *rm, u_long *start, u_long *end)
 277 {
 278         struct resource_i *r;
 279
 280         mtx_lock(rm->rm_mtx);
 281         TAILQ_FOREACH(r, &rm->rm_list, r_link) {
 282                 if (!(r->r_flags & RF_ALLOCATED)) {
 283                         *start = r->r_start;
 284                         *end = r->r_end;
 285                         mtx_unlock(rm->rm_mtx);
 286                         return (0);
 287                 }
 288         }
 289         mtx_unlock(rm->rm_mtx);
 290         return (ENOENT);
 291 }
 292
 293 int
 294 rman_last_free_region(struct rman *rm, u_long *start, u_long *end)
 295 {
 296         struct resource_i *r;
 297
 298         mtx_lock(rm->rm_mtx);
 299         TAILQ_FOREACH_REVERSE(r, &rm->rm_list, resource_head, r_link) {
 300                 if (!(r->r_flags & RF_ALLOCATED)) {
 301                         *start = r->r_start;
 302                         *end = r->r_end;
 303                         mtx_unlock(rm->rm_mtx);
 304                         return (0);
 305                 }
 306         }
 307         mtx_unlock(rm->rm_mtx);
 308         return (ENOENT);
 309 }
 310
 311 /* Shrink or extend one or both ends of an allocated resource. */
 312 int
 313 rman_adjust_resource(struct resource *rr, u_long start, u_long end)
 314 {
 315         struct  resource_i *r, *s, *t, *new;
 316         struct  rman *rm;
 317
 318         /* Not supported for shared resources. */
 319         r = rr->__r_i;
 320         if (r->r_flags & (RF_TIMESHARE | RF_SHAREABLE))
 321                 return (EINVAL);
 322
 323         /*
 324          * This does not support wholesale moving of a resource.  At
 325          * least part of the desired new range must overlap with the
 326          * existing resource.
 327          */
 328         if (end < r->r_start || r->r_end < start)
 329                 return (EINVAL);
 330
 331         /*
 332          * Find the two resource regions immediately adjacent to the
 333          * allocated resource.
 334          */
 335         rm = r->r_rm;
 336         mtx_lock(rm->rm_mtx);
 337 #ifdef INVARIANTS
 338         TAILQ_FOREACH(s, &rm->rm_list, r_link) {
 339                 if (s == r)
 340                         break;
 341         }
 342         if (s == NULL)
 343                 panic("resource not in list");
 344 #endif
 345         s = TAILQ_PREV(r, resource_head, r_link);
 346         t = TAILQ_NEXT(r, r_link);
 347         KASSERT(s == NULL || s->r_end + 1 == r->r_start,
 348             ("prev resource mismatch"));
 349         KASSERT(t == NULL || r->r_end + 1 == t->r_start,
 350             ("next resource mismatch"));
 351
 352         /*
 353          * See if the changes are permitted.  Shrinking is always allowed,
 354          * but growing requires sufficient room in the adjacent region.
 355          */
 356         if (start < r->r_start && (s == NULL || (s->r_flags & RF_ALLOCATED) ||
 357             s->r_start > start)) {
 358                 mtx_unlock(rm->rm_mtx);
 359                 return (EBUSY);
 360         }
 361         if (end > r->r_end && (t == NULL || (t->r_flags & RF_ALLOCATED) ||
 362             t->r_end < end)) {
 363                 mtx_unlock(rm->rm_mtx);
 364                 return (EBUSY);
 365         }
 366
 367         /*
 368          * While holding the lock, grow either end of the resource as
 369          * needed and shrink either end if the shrinking does not require
 370          * allocating a new resource.  We can safely drop the lock and then
 371          * insert a new range to handle the shrinking case afterwards.
 372          */
 373         if (start < r->r_start ||
 374             (start > r->r_start && s != NULL && !(s->r_flags & RF_ALLOCATED))) {
 375                 KASSERT(s->r_flags == 0, ("prev is busy"));
 376                 r->r_start = start;
 377                 if (s->r_start == start) {
 378                         TAILQ_REMOVE(&rm->rm_list, s, r_link);
 379                         free(s, M_RMAN);
 380                 } else
 381                         s->r_end = start - 1;
 382         }
 383         if (end > r->r_end ||
 384             (end < r->r_end && t != NULL && !(t->r_flags & RF_ALLOCATED))) {
 385                 KASSERT(t->r_flags == 0, ("next is busy"));
 386                 r->r_end = end;
 387                 if (t->r_end == end) {
 388                         TAILQ_REMOVE(&rm->rm_list, t, r_link);
 389                         free(t, M_RMAN);
 390                 } else
 391                         t->r_start = end + 1;
 392         }
 393         mtx_unlock(rm->rm_mtx);
 394
 395         /*
 396          * Handle the shrinking cases that require allocating a new
 397          * resource to hold the newly-free region.  We have to recheck
 398          * if we still need this new region after acquiring the lock.
 399          */
 400         if (start > r->r_start) {
 401                 new = int_alloc_resource(M_WAITOK);
 402                 new->r_start = r->r_start;
 403                 new->r_end = start - 1;
 404                 new->r_rm = rm;
 405                 mtx_lock(rm->rm_mtx);
 406                 r->r_start = start;
 407                 s = TAILQ_PREV(r, resource_head, r_link);
 408                 if (s != NULL && !(s->r_flags & RF_ALLOCATED)) {
 409                         s->r_end = start - 1;
 410                         free(new, M_RMAN);
 411                 } else
 412                         TAILQ_INSERT_BEFORE(r, new, r_link);
 413                 mtx_unlock(rm->rm_mtx);
 414         }
 415         if (end < r->r_end) {
 416                 new = int_alloc_resource(M_WAITOK);
 417                 new->r_start = end + 1;
 418                 new->r_end = r->r_end;
 419                 new->r_rm = rm;
 420                 mtx_lock(rm->rm_mtx);
 421                 r->r_end = end;
 422                 t = TAILQ_NEXT(r, r_link);
 423                 if (t != NULL && !(t->r_flags & RF_ALLOCATED)) {
 424                         t->r_start = end + 1;
 425                         free(new, M_RMAN);
 426                 } else
 427                         TAILQ_INSERT_AFTER(&rm->rm_list, r, new, r_link);
 428                 mtx_unlock(rm->rm_mtx);
 429         }
 430         return (0);
 431 }
 432
 433 struct resource *
 434 rman_reserve_resource_bound(struct rman *rm, u_long start, u_long end,
 435                       u_long count, u_long bound,  u_int flags,
 436                       struct device *dev)
 437 {
 438         u_int   want_activate;
 439         struct  resource_i *r, *s, *rv;
 440         u_long  rstart, rend, amask, bmask;
 441
 442         rv = NULL;
 443
 444         DPRINTF(("rman_reserve_resource_bound: <%s> request: [%#lx, %#lx], "
 445                "length %#lx, flags %u, device %s\n", rm->rm_descr, start, end,
 446                count, flags,
 447                dev == NULL ? "<null>" : device_get_nameunit(dev)));
 448         want_activate = (flags & RF_ACTIVE);
 449         flags &= ~RF_ACTIVE;
 450
 451         mtx_lock(rm->rm_mtx);
 452
 453         for (r = TAILQ_FIRST(&rm->rm_list);
 454              r && r->r_end < start + count - 1;
 455              r = TAILQ_NEXT(r, r_link))
 456                 ;
 457
 458         if (r == NULL) {
 459                 DPRINTF(("could not find a region\n"));
 460                 goto out;
 461         }
 462
 463         amask = (1ul << RF_ALIGNMENT(flags)) - 1;
 464         if (start + amask < start) {
 465                 DPRINTF(("start+amask wrapped around\n"));
 466                 goto out;
 467         }
 468
 469         /* If bound is 0, bmask will also be 0 */
 470         bmask = ~(bound - 1);
 471         /*
 472          * First try to find an acceptable totally-unshared region.
 473          */
 474         for (s = r; s; s = TAILQ_NEXT(s, r_link)) {
 475                 DPRINTF(("considering [%#lx, %#lx]\n", s->r_start, s->r_end));
 476                 /*
 477                  * The resource list is sorted, so there is no point in
 478                  * searching further once r_start is too large.
 479                  */
 480                 if (s->r_start > end - (count - 1)) {
 481                         DPRINTF(("s->r_start (%#lx) + count - 1> end (%#lx)\n",
 482                             s->r_start, end));
 483                         break;
 484                 }
 485                 if (s->r_start + amask < s->r_start) {
 486                         DPRINTF(("s->r_start (%#lx) + amask (%#lx) wrapped\n",
 487                             s->r_start, amask));
 488                         break;
 489                 }
 490                 if (s->r_flags & RF_ALLOCATED) {
 491                         DPRINTF(("region is allocated\n"));
 492                         continue;
 493                 }
 494                 rstart = ulmax(s->r_start, start);
 495                 /*
 496                  * Try to find a region by adjusting to boundary and alignment
 497                  * until both conditions are satisfied. This is not an optimal
 498                  * algorithm, but in most cases it isn't really bad, either.
 499                  */
 500                 do {
 501                         rstart = (rstart + amask) & ~amask;
 502                         if (((rstart ^ (rstart + count - 1)) & bmask) != 0)
 503                                 rstart += bound - (rstart & ~bmask);
 504                 } while ((rstart & amask) != 0 && rstart < end &&
 505                     rstart < s->r_end);
 506                 rend = ulmin(s->r_end, ulmax(rstart + count - 1, end));
 507                 if (rstart > rend) {
 508                         DPRINTF(("adjusted start exceeds end\n"));
 509                         continue;
 510                 }
 511                 DPRINTF(("truncated region: [%#lx, %#lx]; size %#lx (requested %#lx)\n",
 512                        rstart, rend, (rend - rstart + 1), count));
 513
 514                 if ((rend - rstart + 1) >= count) {
 515                         DPRINTF(("candidate region: [%#lx, %#lx], size %#lx\n",
 516                                rstart, rend, (rend - rstart + 1)));
 517                         if ((s->r_end - s->r_start + 1) == count) {
 518                                 DPRINTF(("candidate region is entire chunk\n"));
 519                                 rv = s;
 520                                 rv->r_flags |= RF_ALLOCATED | flags;
 521                                 rv->r_dev = dev;
 522                                 goto out;
 523                         }
 524
 525                         /*
 526                          * If s->r_start < rstart and
 527                          *    s->r_end > rstart + count - 1, then
 528                          * we need to split the region into three pieces
 529                          * (the middle one will get returned to the user).
 530                          * Otherwise, we are allocating at either the
 531                          * beginning or the end of s, so we only need to
 532                          * split it in two.  The first case requires
 533                          * two new allocations; the second requires but one.
 534                          */
 535                         rv = int_alloc_resource(M_NOWAIT);
 536                         if (rv == NULL)
 537                                 goto out;
 538                         rv->r_start = rstart;
 539                         rv->r_end = rstart + count - 1;
 540                         rv->r_flags = flags | RF_ALLOCATED;
 541                         rv->r_dev = dev;
 542                         rv->r_rm = rm;
 543
 544                         if (s->r_start < rv->r_start && s->r_end > rv->r_end) {
 545                                 DPRINTF(("splitting region in three parts: "
 546                                        "[%#lx, %#lx]; [%#lx, %#lx]; [%#lx, %#lx]\n",
 547                                        s->r_start, rv->r_start - 1,
 548                                        rv->r_start, rv->r_end,
 549                                        rv->r_end + 1, s->r_end));
 550                                 /*
 551                                  * We are allocating in the middle.
 552                                  */
 553                                 r = int_alloc_resource(M_NOWAIT);
 554                                 if (r == NULL) {
 555                                         free(rv, M_RMAN);
 556                                         rv = NULL;
 557                                         goto out;
 558                                 }
 559                                 r->r_start = rv->r_end + 1;
 560                                 r->r_end = s->r_end;
 561                                 r->r_flags = s->r_flags;
 562                                 r->r_rm = rm;
 563                                 s->r_end = rv->r_start - 1;
 564                                 TAILQ_INSERT_AFTER(&rm->rm_list, s, rv,
 565                                                      r_link);
 566                                 TAILQ_INSERT_AFTER(&rm->rm_list, rv, r,
 567                                                      r_link);
 568                         } else if (s->r_start == rv->r_start) {
 569                                 DPRINTF(("allocating from the beginning\n"));
 570                                 /*
 571                                  * We are allocating at the beginning.
 572                                  */
 573                                 s->r_start = rv->r_end + 1;
 574                                 TAILQ_INSERT_BEFORE(s, rv, r_link);
 575                         } else {
 576                                 DPRINTF(("allocating at the end\n"));
 577                                 /*
 578                                  * We are allocating at the end.
 579                                  */
 580                                 s->r_end = rv->r_start - 1;
 581                                 TAILQ_INSERT_AFTER(&rm->rm_list, s, rv,
 582                                                      r_link);
 583                         }
 584                         goto out;
 585                 }
 586         }
 587
 588         /*
 589          * Now find an acceptable shared region, if the client's requirements
 590          * allow sharing.  By our implementation restriction, a candidate
 591          * region must match exactly by both size and sharing type in order
 592          * to be considered compatible with the client's request.  (The
 593          * former restriction could probably be lifted without too much
 594          * additional work, but this does not seem warranted.)
 595          */
 596         DPRINTF(("no unshared regions found\n"));
 597         if ((flags & (RF_SHAREABLE | RF_TIMESHARE)) == 0)
 598                 goto out;
 599
 600         for (s = r; s; s = TAILQ_NEXT(s, r_link)) {
 601                 if (s->r_start > end)
 602                         break;
 603                 if ((s->r_flags & flags) != flags)
 604                         continue;
 605                 if (s->r_start >= start && s->r_end <= end
 606                     && (s->r_end - s->r_start + 1) == count &&
 607                     (s->r_start & amask) == 0 &&
 608                     ((s->r_start ^ s->r_end) & bmask) == 0) {
 609                         rv = int_alloc_resource(M_NOWAIT);
 610                         if (rv == NULL)
 611                                 goto out;
 612                         rv->r_start = s->r_start;
 613                         rv->r_end = s->r_end;
 614                         rv->r_flags = s->r_flags &
 615                                 (RF_ALLOCATED | RF_SHAREABLE | RF_TIMESHARE);
 616                         rv->r_dev = dev;
 617                         rv->r_rm = rm;
 618                         if (s->r_sharehead == NULL) {
 619                                 s->r_sharehead = malloc(sizeof *s->r_sharehead,
 620                                                 M_RMAN, M_NOWAIT | M_ZERO);
 621                                 if (s->r_sharehead == NULL) {
 622                                         free(rv, M_RMAN);
 623                                         rv = NULL;
 624                                         goto out;
 625                                 }
 626                                 LIST_INIT(s->r_sharehead);
 627                                 LIST_INSERT_HEAD(s->r_sharehead, s,
 628                                                  r_sharelink);
 629                                 s->r_flags |= RF_FIRSTSHARE;
 630                         }
 631                         rv->r_sharehead = s->r_sharehead;
 632                         LIST_INSERT_HEAD(s->r_sharehead, rv, r_sharelink);
 633                         goto out;
 634                 }
 635         }
 636
 637         /*
 638          * We couldn't find anything.
 639          */
 640 out:
 641         /*
 642          * If the user specified RF_ACTIVE in the initial flags,
 643          * which is reflected in `want_activate', we attempt to atomically
 644          * activate the resource.  If this fails, we release the resource
 645          * and indicate overall failure.  (This behavior probably doesn't
 646          * make sense for RF_TIMESHARE-type resources.)
 647          */
 648         if (rv && want_activate) {
 649                 struct resource_i *whohas;
 650                 if (int_rman_activate_resource(rm, rv, &whohas)) {
 651                         int_rman_release_resource(rm, rv);
 652                         rv = NULL;
 653                 }
 654         }
 655
 656         mtx_unlock(rm->rm_mtx);
 657         return (rv == NULL ? NULL : &rv->r_r);
 658 }
 659
 660 struct resource *
 661 rman_reserve_resource(struct rman *rm, u_long start, u_long end, u_long count,
 662                       u_int flags, struct device *dev)
 663 {
 664
 665         return (rman_reserve_resource_bound(rm, start, end, count, 0, flags,
 666             dev));
 667 }
 668
 669 static int
 670 int_rman_activate_resource(struct rman *rm, struct resource_i *r,
 671                            struct resource_i **whohas)
 672 {
 673         struct resource_i *s;
 674         int ok;
 675
 676         /*
 677          * If we are not timesharing, then there is nothing much to do.
 678          * If we already have the resource, then there is nothing at all to do.
 679          * If we are not on a sharing list with anybody else, then there is
 680          * little to do.
 681          */
 682         if ((r->r_flags & RF_TIMESHARE) == 0
 683             || (r->r_flags & RF_ACTIVE) != 0
 684             || r->r_sharehead == NULL) {
 685                 r->r_flags |= RF_ACTIVE;
 686                 return 0;
 687         }
 688
 689         ok = 1;
 690         for (s = LIST_FIRST(r->r_sharehead); s && ok;
 691              s = LIST_NEXT(s, r_sharelink)) {
 692                 if ((s->r_flags & RF_ACTIVE) != 0) {
 693                         ok = 0;
 694                         *whohas = s;
 695                 }
 696         }
 697         if (ok) {
 698                 r->r_flags |= RF_ACTIVE;
 699                 return 0;
 700         }
 701         return EBUSY;
 702 }
 703
 704 int
 705 rman_activate_resource(struct resource *re)
 706 {
 707         int rv;
 708         struct resource_i *r, *whohas;
 709         struct rman *rm;
 710
 711         r = re->__r_i;
 712         rm = r->r_rm;
 713         mtx_lock(rm->rm_mtx);
 714         rv = int_rman_activate_resource(rm, r, &whohas);
 715         mtx_unlock(rm->rm_mtx);
 716         return rv;
 717 }
 718
 719 int
 720 rman_await_resource(struct resource *re, int pri, int timo)
 721 {
 722         int     rv;
 723         struct  resource_i *r, *whohas;
 724         struct  rman *rm;
 725
 726         r = re->__r_i;
 727         rm = r->r_rm;
 728         mtx_lock(rm->rm_mtx);
 729         for (;;) {
 730                 rv = int_rman_activate_resource(rm, r, &whohas);
 731                 if (rv != EBUSY)
 732                         return (rv);    /* returns with mutex held */
 733
 734                 if (r->r_sharehead == NULL)
 735                         panic("rman_await_resource");
 736                 whohas->r_flags |= RF_WANTED;
 737                 rv = msleep(r->r_sharehead, rm->rm_mtx, pri, "rmwait", timo);
 738                 if (rv) {
 739                         mtx_unlock(rm->rm_mtx);
 740                         return (rv);
 741                 }
 742         }
 743 }
 744
 745 static int
 746 int_rman_deactivate_resource(struct resource_i *r)
 747 {
 748
 749         r->r_flags &= ~RF_ACTIVE;
 750         if (r->r_flags & RF_WANTED) {
 751                 r->r_flags &= ~RF_WANTED;
 752                 wakeup(r->r_sharehead);
 753         }
 754         return 0;
 755 }
 756
 757 int
 758 rman_deactivate_resource(struct resource *r)
 759 {
 760         struct  rman *rm;
 761
 762         rm = r->__r_i->r_rm;
 763         mtx_lock(rm->rm_mtx);
 764         int_rman_deactivate_resource(r->__r_i);
 765         mtx_unlock(rm->rm_mtx);
 766         return 0;
 767 }
 768
 769 static int
 770 int_rman_release_resource(struct rman *rm, struct resource_i *r)
 771 {
 772         struct  resource_i *s, *t;
 773
 774         if (r->r_flags & RF_ACTIVE)
 775                 int_rman_deactivate_resource(r);
 776
 777         /*
 778          * Check for a sharing list first.  If there is one, then we don't
 779          * have to think as hard.
 780          */
 781         if (r->r_sharehead) {
 782                 /*
 783                  * If a sharing list exists, then we know there are at
 784                  * least two sharers.
 785                  *
 786                  * If we are in the main circleq, appoint someone else.
 787                  */
 788                 LIST_REMOVE(r, r_sharelink);
 789                 s = LIST_FIRST(r->r_sharehead);
 790                 if (r->r_flags & RF_FIRSTSHARE) {
 791                         s->r_flags |= RF_FIRSTSHARE;
 792                         TAILQ_INSERT_BEFORE(r, s, r_link);
 793                         TAILQ_REMOVE(&rm->rm_list, r, r_link);
 794                 }
 795
 796                 /*
 797                  * Make sure that the sharing list goes away completely
 798                  * if the resource is no longer being shared at all.
 799                  */
 800                 if (LIST_NEXT(s, r_sharelink) == NULL) {
 801                         free(s->r_sharehead, M_RMAN);
 802                         s->r_sharehead = NULL;
 803                         s->r_flags &= ~RF_FIRSTSHARE;
 804                 }
 805                 goto out;
 806         }
 807
 808         /*
 809          * Look at the adjacent resources in the list and see if our
 810          * segment can be merged with any of them.  If either of the
 811          * resources is allocated or is not exactly adjacent then they
 812          * cannot be merged with our segment.
 813          */
 814         s = TAILQ_PREV(r, resource_head, r_link);
 815         if (s != NULL && ((s->r_flags & RF_ALLOCATED) != 0 ||
 816             s->r_end + 1 != r->r_start))
 817                 s = NULL;
 818         t = TAILQ_NEXT(r, r_link);
 819         if (t != NULL && ((t->r_flags & RF_ALLOCATED) != 0 ||
 820             r->r_end + 1 != t->r_start))
 821                 t = NULL;
 822
 823         if (s != NULL && t != NULL) {
 824                 /*
 825                  * Merge all three segments.
 826                  */
 827                 s->r_end = t->r_end;
 828                 TAILQ_REMOVE(&rm->rm_list, r, r_link);
 829                 TAILQ_REMOVE(&rm->rm_list, t, r_link);
 830                 free(t, M_RMAN);
 831         } else if (s != NULL) {
 832                 /*
 833                  * Merge previous segment with ours.
 834                  */
 835                 s->r_end = r->r_end;
 836                 TAILQ_REMOVE(&rm->rm_list, r, r_link);
 837         } else if (t != NULL) {
 838                 /*
 839                  * Merge next segment with ours.
 840                  */
 841                 t->r_start = r->r_start;
 842                 TAILQ_REMOVE(&rm->rm_list, r, r_link);
 843         } else {
 844                 /*
 845                  * At this point, we know there is nothing we
 846                  * can potentially merge with, because on each
 847                  * side, there is either nothing there or what is
 848                  * there is still allocated.  In that case, we don't
 849                  * want to remove r from the list; we simply want to
 850                  * change it to an unallocated region and return
 851                  * without freeing anything.
 852                  */
 853                 r->r_flags &= ~RF_ALLOCATED;
 854                 r->r_dev = NULL;
 855                 return 0;
 856         }
 857
 858 out:
 859         free(r, M_RMAN);
 860         return 0;
 861 }
 862
 863 int
 864 rman_release_resource(struct resource *re)
 865 {
 866         int     rv;
 867         struct  resource_i *r;
 868         struct  rman *rm;
 869
 870         r = re->__r_i;
 871         rm = r->r_rm;
 872         mtx_lock(rm->rm_mtx);
 873         rv = int_rman_release_resource(rm, r);
 874         mtx_unlock(rm->rm_mtx);
 875         return (rv);
 876 }
 877
 878 uint32_t
 879 rman_make_alignment_flags(uint32_t size)
 880 {
 881         int     i;
 882
 883         /*
 884          * Find the hightest bit set, and add one if more than one bit
 885          * set.  We're effectively computing the ceil(log2(size)) here.
 886          */
 887         for (i = 31; i > 0; i--)
 888                 if ((1 << i) & size)
 889                         break;
 890         if (~(1 << i) & size)
 891                 i++;
 892
 893         return(RF_ALIGNMENT_LOG2(i));
 894 }
 895
 896 void
 897 rman_set_start(struct resource *r, u_long start)
 898 {
 899         r->__r_i->r_start = start;
 900 }
 901
 902 u_long
 903 rman_get_start(struct resource *r)
 904 {
 905         return (r->__r_i->r_start);
 906 }
 907
 908 void
 909 rman_set_end(struct resource *r, u_long end)
 910 {
 911         r->__r_i->r_end = end;
 912 }
 913
 914 u_long
 915 rman_get_end(struct resource *r)
 916 {
 917         return (r->__r_i->r_end);
 918 }
 919
 920 u_long
 921 rman_get_size(struct resource *r)
 922 {
 923         return (r->__r_i->r_end - r->__r_i->r_start + 1);
 924 }
 925
 926 u_int
 927 rman_get_flags(struct resource *r)
 928 {
 929         return (r->__r_i->r_flags);
 930 }
 931
 932 void
 933 rman_set_virtual(struct resource *r, void *v)
 934 {
 935         r->__r_i->r_virtual = v;
 936 }
 937
 938 void *
 939 rman_get_virtual(struct resource *r)
 940 {
 941         return (r->__r_i->r_virtual);
 942 }
 943
 944 void
 945 rman_set_bustag(struct resource *r, bus_space_tag_t t)
 946 {
 947         r->r_bustag = t;
 948 }
 949
 950 bus_space_tag_t
 951 rman_get_bustag(struct resource *r)
 952 {
 953         return (r->r_bustag);
 954 }
 955
 956 void
 957 rman_set_bushandle(struct resource *r, bus_space_handle_t h)
 958 {
 959         r->r_bushandle = h;
 960 }
 961
 962 bus_space_handle_t
 963 rman_get_bushandle(struct resource *r)
 964 {
 965         return (r->r_bushandle);
 966 }
 967
 968 void
 969 rman_set_rid(struct resource *r, int rid)
 970 {
 971         r->__r_i->r_rid = rid;
 972 }
 973
 974 int
 975 rman_get_rid(struct resource *r)
 976 {
 977         return (r->__r_i->r_rid);
 978 }
 979
 980 void
 981 rman_set_device(struct resource *r, struct device *dev)
 982 {
 983         r->__r_i->r_dev = dev;
 984 }
 985
 986 struct device *
 987 rman_get_device(struct resource *r)
 988 {
 989         return (r->__r_i->r_dev);
 990 }
 991
 992 int
 993 rman_is_region_manager(struct resource *r, struct rman *rm)
 994 {
 995
 996         return (r->__r_i->r_rm == rm);
 997 }
 998
 999 /*
1000  * Sysctl interface for scanning the resource lists.
1001  *
1002  * We take two input parameters; the index into the list of resource
1003  * managers, and the resource offset into the list.
1004  */
1005 static int
1006 sysctl_rman(SYSCTL_HANDLER_ARGS)
1007 {
1008         int                     *name = (int *)arg1;
1009         u_int                   namelen = arg2;
1010         int                     rman_idx, res_idx;
1011         struct rman             *rm;
1012         struct resource_i       *res;
1013         struct resource_i       *sres;
1014         struct u_rman           urm;
1015         struct u_resource       ures;
1016         int                     error;
1017
1018         if (namelen != 3)
1019                 return (EINVAL);
1020
1021         if (bus_data_generation_check(name[0]))
1022                 return (EINVAL);
1023         rman_idx = name[1];
1024         res_idx = name[2];
1025
1026         /*
1027          * Find the indexed resource manager
1028          */
1029         mtx_lock(&rman_mtx);
1030         TAILQ_FOREACH(rm, &rman_head, rm_link) {
1031                 if (rman_idx-- == 0)
1032                         break;
1033         }
1034         mtx_unlock(&rman_mtx);
1035         if (rm == NULL)
1036                 return (ENOENT);
1037
1038         /*
1039          * If the resource index is -1, we want details on the
1040          * resource manager.
1041          */
1042         if (res_idx == -1) {
1043                 bzero(&urm, sizeof(urm));
1044                 urm.rm_handle = (uintptr_t)rm;
1045                 if (rm->rm_descr != NULL)
1046                         strlcpy(urm.rm_descr, rm->rm_descr, RM_TEXTLEN);
1047                 urm.rm_start = rm->rm_start;
1048                 urm.rm_size = rm->rm_end - rm->rm_start + 1;
1049                 urm.rm_type = rm->rm_type;
1050
1051                 error = SYSCTL_OUT(req, &urm, sizeof(urm));
1052                 return (error);
1053         }
1054
1055         /*
1056          * Find the indexed resource and return it.
1057          */
1058         mtx_lock(rm->rm_mtx);
1059         TAILQ_FOREACH(res, &rm->rm_list, r_link) {
1060                 if (res->r_sharehead != NULL) {
1061                         LIST_FOREACH(sres, res->r_sharehead, r_sharelink)
1062                                 if (res_idx-- == 0) {
1063                                         res = sres;
1064                                         goto found;
1065                                 }
1066                 }
1067                 else if (res_idx-- == 0)
1068                                 goto found;
1069         }
1070         mtx_unlock(rm->rm_mtx);
1071         return (ENOENT);
1072
1073 found:
1074         bzero(&ures, sizeof(ures));
1075         ures.r_handle = (uintptr_t)res;
1076         ures.r_parent = (uintptr_t)res->r_rm;
1077         ures.r_device = (uintptr_t)res->r_dev;
1078         if (res->r_dev != NULL) {
1079                 if (device_get_name(res->r_dev) != NULL) {
1080                         snprintf(ures.r_devname, RM_TEXTLEN,
1081                             "%s%d",
1082                             device_get_name(res->r_dev),
1083                             device_get_unit(res->r_dev));
1084                 } else {
1085                         strlcpy(ures.r_devname, "nomatch",
1086                             RM_TEXTLEN);
1087                 }
1088         } else {
1089                 ures.r_devname[0] = '\0';
1090         }
1091         ures.r_start = res->r_start;
1092         ures.r_size = res->r_end - res->r_start + 1;
1093         ures.r_flags = res->r_flags;
1094
1095         mtx_unlock(rm->rm_mtx);
1096         error = SYSCTL_OUT(req, &ures, sizeof(ures));
1097         return (error);
1098 }
1099
1100 SYSCTL_NODE(_hw_bus, OID_AUTO, rman, CTLFLAG_RD, sysctl_rman,
1101     "kernel resource manager");
1102
1103 #ifdef DDB
1104 static void
1105 dump_rman(struct rman *rm)
1106 {
1107         struct resource_i *r;
1108         const char *devname;
1109
1110         if (db_pager_quit)
1111                 return;
1112         db_printf("rman: %s\n", rm->rm_descr);
1113         db_printf("    0x%lx-0x%lx (full range)\n", rm->rm_start, rm->rm_end);
1114         TAILQ_FOREACH(r, &rm->rm_list, r_link) {
1115                 if (r->r_dev != NULL) {
1116                         devname = device_get_nameunit(r->r_dev);
1117                         if (devname == NULL)
1118                                 devname = "nomatch";
1119                 } else
1120                         devname = NULL;
1121                 db_printf("    0x%lx-0x%lx ", r->r_start, r->r_end);
1122                 if (devname != NULL)
1123                         db_printf("(%s)\n", devname);
1124                 else
1125                         db_printf("----\n");
1126                 if (db_pager_quit)
1127                         return;
1128         }
1129 }
1130
1131 DB_SHOW_COMMAND(rman, db_show_rman)
1132 {
1133
1134         if (have_addr)
1135                 dump_rman((struct rman *)addr);
1136 }
1137
1138 DB_SHOW_ALL_COMMAND(rman, db_show_all_rman)
1139 {
1140         struct rman *rm;
1141
1142         TAILQ_FOREACH(rm, &rman_head, rm_link)
1143                 dump_rman(rm);
1144 }
1145 DB_SHOW_ALIAS(allrman, db_show_all_rman);
1146 #endif