2 * Copyright 1998 Massachusetts Institute of Technology
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
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
29 * $FreeBSD: src/sys/kern/subr_rman.c,v 1.10.2.1 2001/06/05 08:06:08 imp Exp $
30 * $DragonFly: src/sys/kern/subr_rman.c,v 1.2 2003/06/17 04:28:41 dillon Exp $
34 * The kernel resource manager. This code is responsible for keeping track
35 * of hardware resources which are apportioned out to various drivers.
36 * It does not actually assign those resources, and it is not expected
37 * that end-device drivers will call into this code directly. Rather,
38 * the code which implements the buses that those devices are attached to,
39 * and the code which manages CPU resources, will call this code, and the
40 * end-device drivers will make upcalls to that code to actually perform
43 * There are two sorts of resources managed by this code. The first is
44 * the more familiar array (RMAN_ARRAY) type; resources in this class
45 * consist of a sequence of individually-allocatable objects which have
46 * been numbered in some well-defined order. Most of the resources
47 * are of this type, as it is the most familiar. The second type is
48 * called a gauge (RMAN_GAUGE), and models fungible resources (i.e.,
49 * resources in which each instance is indistinguishable from every
50 * other instance). The principal anticipated application of gauges
51 * is in the context of power consumption, where a bus may have a specific
52 * power budget which all attached devices share. RMAN_GAUGE is not
55 * For array resources, we make one simplifying assumption: two clients
56 * sharing the same resource must use the same range of indices. That
57 * is to say, sharing of overlapping-but-not-identical regions is not
61 #include <sys/param.h>
62 #include <sys/systm.h>
63 #include <sys/kernel.h>
65 #include <sys/malloc.h>
66 #include <sys/bus.h> /* XXX debugging */
67 #include <machine/bus.h>
70 static MALLOC_DEFINE(M_RMAN, "rman", "Resource manager");
72 struct rman_head rman_head;
73 #ifndef NULL_SIMPLELOCKS
74 static struct simplelock rman_lock; /* mutex to protect rman_head */
76 static int int_rman_activate_resource(struct rman *rm, struct resource *r,
77 struct resource **whohas);
78 static int int_rman_deactivate_resource(struct resource *r);
79 static int int_rman_release_resource(struct rman *rm, struct resource *r);
81 #define CIRCLEQ_TERMCOND(var, head) (var == (void *)&(head))
84 rman_init(struct rman *rm)
90 TAILQ_INIT(&rman_head);
91 simple_lock_init(&rman_lock);
94 if (rm->rm_type == RMAN_UNINIT)
96 if (rm->rm_type == RMAN_GAUGE)
97 panic("implement RMAN_GAUGE");
99 CIRCLEQ_INIT(&rm->rm_list);
100 rm->rm_slock = malloc(sizeof *rm->rm_slock, M_RMAN, M_NOWAIT);
101 if (rm->rm_slock == 0)
103 simple_lock_init(rm->rm_slock);
105 simple_lock(&rman_lock);
106 TAILQ_INSERT_TAIL(&rman_head, rm, rm_link);
107 simple_unlock(&rman_lock);
112 * NB: this interface is not robust against programming errors which
113 * add multiple copies of the same region.
116 rman_manage_region(struct rman *rm, u_long start, u_long end)
118 struct resource *r, *s;
120 r = malloc(sizeof *r, M_RMAN, M_NOWAIT);
131 simple_lock(rm->rm_slock);
132 for (s = CIRCLEQ_FIRST(&rm->rm_list);
133 !CIRCLEQ_TERMCOND(s, rm->rm_list) && s->r_end < r->r_start;
134 s = CIRCLEQ_NEXT(s, r_link))
137 if (CIRCLEQ_TERMCOND(s, rm->rm_list)) {
138 CIRCLEQ_INSERT_TAIL(&rm->rm_list, r, r_link);
140 CIRCLEQ_INSERT_BEFORE(&rm->rm_list, s, r, r_link);
143 simple_unlock(rm->rm_slock);
148 rman_fini(struct rman *rm)
152 simple_lock(rm->rm_slock);
153 CIRCLEQ_FOREACH(r, &rm->rm_list, r_link) {
154 if (r->r_flags & RF_ALLOCATED) {
155 simple_unlock(rm->rm_slock);
161 * There really should only be one of these if we are in this
162 * state and the code is working properly, but it can't hurt.
164 while (!CIRCLEQ_EMPTY(&rm->rm_list)) {
165 r = CIRCLEQ_FIRST(&rm->rm_list);
166 CIRCLEQ_REMOVE(&rm->rm_list, r, r_link);
169 simple_unlock(rm->rm_slock);
170 simple_lock(&rman_lock);
171 TAILQ_REMOVE(&rman_head, rm, rm_link);
172 simple_unlock(&rman_lock);
173 free(rm->rm_slock, M_RMAN);
179 rman_reserve_resource(struct rman *rm, u_long start, u_long end, u_long count,
180 u_int flags, struct device *dev)
183 struct resource *r, *s, *rv;
189 printf("rman_reserve_resource: <%s> request: [%#lx, %#lx], length "
190 "%#lx, flags %u, device %s%d\n", rm->rm_descr, start, end,
191 count, flags, device_get_name(dev), device_get_unit(dev));
192 #endif /* RMAN_DEBUG */
193 want_activate = (flags & RF_ACTIVE);
196 simple_lock(rm->rm_slock);
198 for (r = CIRCLEQ_FIRST(&rm->rm_list);
199 !CIRCLEQ_TERMCOND(r, rm->rm_list) && r->r_end < start;
200 r = CIRCLEQ_NEXT(r, r_link))
203 if (CIRCLEQ_TERMCOND(r, rm->rm_list)) {
205 printf("could not find a region\n");
211 * First try to find an acceptable totally-unshared region.
213 for (s = r; !CIRCLEQ_TERMCOND(s, rm->rm_list);
214 s = CIRCLEQ_NEXT(s, r_link)) {
216 printf("considering [%#lx, %#lx]\n", s->r_start, s->r_end);
217 #endif /* RMAN_DEBUG */
218 if (s->r_start > end) {
220 printf("s->r_start (%#lx) > end (%#lx)\n", s->r_start, end);
221 #endif /* RMAN_DEBUG */
224 if (s->r_flags & RF_ALLOCATED) {
226 printf("region is allocated\n");
227 #endif /* RMAN_DEBUG */
230 rstart = max(s->r_start, start);
231 rstart = (rstart + ((1ul << RF_ALIGNMENT(flags))) - 1) &
232 ~((1ul << RF_ALIGNMENT(flags)) - 1);
233 rend = min(s->r_end, max(start + count, end));
235 printf("truncated region: [%#lx, %#lx]; size %#lx (requested %#lx)\n",
236 rstart, rend, (rend - rstart + 1), count);
237 #endif /* RMAN_DEBUG */
239 if ((rend - rstart + 1) >= count) {
241 printf("candidate region: [%#lx, %#lx], size %#lx\n",
242 rend, rstart, (rend - rstart + 1));
243 #endif /* RMAN_DEBUG */
244 if ((s->r_end - s->r_start + 1) == count) {
246 printf("candidate region is entire chunk\n");
247 #endif /* RMAN_DEBUG */
249 rv->r_flags |= RF_ALLOCATED | flags;
255 * If s->r_start < rstart and
256 * s->r_end > rstart + count - 1, then
257 * we need to split the region into three pieces
258 * (the middle one will get returned to the user).
259 * Otherwise, we are allocating at either the
260 * beginning or the end of s, so we only need to
261 * split it in two. The first case requires
262 * two new allocations; the second requires but one.
264 rv = malloc(sizeof *rv, M_RMAN, M_NOWAIT);
267 bzero(rv, sizeof *rv);
268 rv->r_start = rstart;
269 rv->r_end = rstart + count - 1;
270 rv->r_flags = flags | RF_ALLOCATED;
275 if (s->r_start < rv->r_start && s->r_end > rv->r_end) {
277 printf("splitting region in three parts: "
278 "[%#lx, %#lx]; [%#lx, %#lx]; [%#lx, %#lx]\n",
279 s->r_start, rv->r_start - 1,
280 rv->r_start, rv->r_end,
281 rv->r_end + 1, s->r_end);
282 #endif /* RMAN_DEBUG */
284 * We are allocating in the middle.
286 r = malloc(sizeof *r, M_RMAN, M_NOWAIT);
293 r->r_start = rv->r_end + 1;
295 r->r_flags = s->r_flags;
299 s->r_end = rv->r_start - 1;
300 CIRCLEQ_INSERT_AFTER(&rm->rm_list, s, rv,
302 CIRCLEQ_INSERT_AFTER(&rm->rm_list, rv, r,
304 } else if (s->r_start == rv->r_start) {
306 printf("allocating from the beginning\n");
307 #endif /* RMAN_DEBUG */
309 * We are allocating at the beginning.
311 s->r_start = rv->r_end + 1;
312 CIRCLEQ_INSERT_BEFORE(&rm->rm_list, s, rv,
316 printf("allocating at the end\n");
317 #endif /* RMAN_DEBUG */
319 * We are allocating at the end.
321 s->r_end = rv->r_start - 1;
322 CIRCLEQ_INSERT_AFTER(&rm->rm_list, s, rv,
330 * Now find an acceptable shared region, if the client's requirements
331 * allow sharing. By our implementation restriction, a candidate
332 * region must match exactly by both size and sharing type in order
333 * to be considered compatible with the client's request. (The
334 * former restriction could probably be lifted without too much
335 * additional work, but this does not seem warranted.)
338 printf("no unshared regions found\n");
339 #endif /* RMAN_DEBUG */
340 if ((flags & (RF_SHAREABLE | RF_TIMESHARE)) == 0)
343 for (s = r; !CIRCLEQ_TERMCOND(s, rm->rm_list);
344 s = CIRCLEQ_NEXT(s, r_link)) {
345 if (s->r_start > end)
347 if ((s->r_flags & flags) != flags)
349 rstart = max(s->r_start, start);
350 rend = min(s->r_end, max(start + count, end));
351 if (s->r_start >= start && s->r_end <= end
352 && (s->r_end - s->r_start + 1) == count) {
353 rv = malloc(sizeof *rv, M_RMAN, M_NOWAIT);
356 bzero(rv, sizeof *rv);
357 rv->r_start = s->r_start;
358 rv->r_end = s->r_end;
359 rv->r_flags = s->r_flags &
360 (RF_ALLOCATED | RF_SHAREABLE | RF_TIMESHARE);
363 if (s->r_sharehead == 0) {
364 s->r_sharehead = malloc(sizeof *s->r_sharehead,
366 if (s->r_sharehead == 0) {
371 bzero(s->r_sharehead, sizeof *s->r_sharehead);
372 LIST_INIT(s->r_sharehead);
373 LIST_INSERT_HEAD(s->r_sharehead, s,
375 s->r_flags |= RF_FIRSTSHARE;
377 rv->r_sharehead = s->r_sharehead;
378 LIST_INSERT_HEAD(s->r_sharehead, rv, r_sharelink);
384 * We couldn't find anything.
388 * If the user specified RF_ACTIVE in the initial flags,
389 * which is reflected in `want_activate', we attempt to atomically
390 * activate the resource. If this fails, we release the resource
391 * and indicate overall failure. (This behavior probably doesn't
392 * make sense for RF_TIMESHARE-type resources.)
394 if (rv && want_activate) {
395 struct resource *whohas;
396 if (int_rman_activate_resource(rm, rv, &whohas)) {
397 int_rman_release_resource(rm, rv);
402 simple_unlock(rm->rm_slock);
407 int_rman_activate_resource(struct rman *rm, struct resource *r,
408 struct resource **whohas)
414 * If we are not timesharing, then there is nothing much to do.
415 * If we already have the resource, then there is nothing at all to do.
416 * If we are not on a sharing list with anybody else, then there is
419 if ((r->r_flags & RF_TIMESHARE) == 0
420 || (r->r_flags & RF_ACTIVE) != 0
421 || r->r_sharehead == 0) {
422 r->r_flags |= RF_ACTIVE;
427 for (s = LIST_FIRST(r->r_sharehead); s && ok;
428 s = LIST_NEXT(s, r_sharelink)) {
429 if ((s->r_flags & RF_ACTIVE) != 0) {
435 r->r_flags |= RF_ACTIVE;
442 rman_activate_resource(struct resource *r)
445 struct resource *whohas;
449 simple_lock(rm->rm_slock);
450 rv = int_rman_activate_resource(rm, r, &whohas);
451 simple_unlock(rm->rm_slock);
456 rman_await_resource(struct resource *r, int pri, int timo)
459 struct resource *whohas;
464 simple_lock(rm->rm_slock);
465 rv = int_rman_activate_resource(rm, r, &whohas);
467 return (rv); /* returns with simplelock */
469 if (r->r_sharehead == 0)
470 panic("rman_await_resource");
472 * splhigh hopefully will prevent a race between
473 * simple_unlock and tsleep where a process
474 * could conceivably get in and release the resource
475 * before we have a chance to sleep on it.
478 whohas->r_flags |= RF_WANTED;
479 simple_unlock(rm->rm_slock);
480 rv = tsleep(r->r_sharehead, pri, "rmwait", timo);
485 simple_lock(rm->rm_slock);
491 int_rman_deactivate_resource(struct resource *r)
496 r->r_flags &= ~RF_ACTIVE;
497 if (r->r_flags & RF_WANTED) {
498 r->r_flags &= ~RF_WANTED;
499 wakeup(r->r_sharehead);
505 rman_deactivate_resource(struct resource *r)
510 simple_lock(rm->rm_slock);
511 int_rman_deactivate_resource(r);
512 simple_unlock(rm->rm_slock);
517 int_rman_release_resource(struct rman *rm, struct resource *r)
519 struct resource *s, *t;
521 if (r->r_flags & RF_ACTIVE)
522 int_rman_deactivate_resource(r);
525 * Check for a sharing list first. If there is one, then we don't
526 * have to think as hard.
528 if (r->r_sharehead) {
530 * If a sharing list exists, then we know there are at
533 * If we are in the main circleq, appoint someone else.
535 LIST_REMOVE(r, r_sharelink);
536 s = LIST_FIRST(r->r_sharehead);
537 if (r->r_flags & RF_FIRSTSHARE) {
538 s->r_flags |= RF_FIRSTSHARE;
539 CIRCLEQ_INSERT_BEFORE(&rm->rm_list, r, s, r_link);
540 CIRCLEQ_REMOVE(&rm->rm_list, r, r_link);
544 * Make sure that the sharing list goes away completely
545 * if the resource is no longer being shared at all.
547 if (LIST_NEXT(s, r_sharelink) == 0) {
548 free(s->r_sharehead, M_RMAN);
550 s->r_flags &= ~RF_FIRSTSHARE;
556 * Look at the adjacent resources in the list and see if our
557 * segment can be merged with any of them.
559 s = CIRCLEQ_PREV(r, r_link);
560 t = CIRCLEQ_NEXT(r, r_link);
562 if (s != (void *)&rm->rm_list && (s->r_flags & RF_ALLOCATED) == 0
563 && t != (void *)&rm->rm_list && (t->r_flags & RF_ALLOCATED) == 0) {
565 * Merge all three segments.
568 CIRCLEQ_REMOVE(&rm->rm_list, r, r_link);
569 CIRCLEQ_REMOVE(&rm->rm_list, t, r_link);
571 } else if (s != (void *)&rm->rm_list
572 && (s->r_flags & RF_ALLOCATED) == 0) {
574 * Merge previous segment with ours.
577 CIRCLEQ_REMOVE(&rm->rm_list, r, r_link);
578 } else if (t != (void *)&rm->rm_list
579 && (t->r_flags & RF_ALLOCATED) == 0) {
581 * Merge next segment with ours.
583 t->r_start = r->r_start;
584 CIRCLEQ_REMOVE(&rm->rm_list, r, r_link);
587 * At this point, we know there is nothing we
588 * can potentially merge with, because on each
589 * side, there is either nothing there or what is
590 * there is still allocated. In that case, we don't
591 * want to remove r from the list; we simply want to
592 * change it to an unallocated region and return
593 * without freeing anything.
595 r->r_flags &= ~RF_ALLOCATED;
605 rman_release_resource(struct resource *r)
608 struct rman *rm = r->r_rm;
610 simple_lock(rm->rm_slock);
611 rv = int_rman_release_resource(rm, r);
612 simple_unlock(rm->rm_slock);
617 rman_make_alignment_flags(uint32_t size)
622 * Find the hightest bit set, and add one if more than one bit
623 * set. We're effectively computing the ceil(log2(size)) here.
625 for (i = 32; i > 0; i--)
628 if (~(1 << i) & size)
631 return(RF_ALIGNMENT_LOG2(i));