subr_pool.c revision 1.111.4.2 1 /* $NetBSD: subr_pool.c,v 1.111.4.2 2006/04/22 11:39:59 simonb Exp $ */
2
3 /*-
4 * Copyright (c) 1997, 1999, 2000 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Paul Kranenburg; by Jason R. Thorpe of the Numerical Aerospace
9 * Simulation Facility, NASA Ames Research Center.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 #include <sys/cdefs.h>
41 __KERNEL_RCSID(0, "$NetBSD: subr_pool.c,v 1.111.4.2 2006/04/22 11:39:59 simonb Exp $");
42
43 #include "opt_pool.h"
44 #include "opt_poollog.h"
45 #include "opt_lockdebug.h"
46
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/proc.h>
50 #include <sys/errno.h>
51 #include <sys/kernel.h>
52 #include <sys/malloc.h>
53 #include <sys/lock.h>
54 #include <sys/pool.h>
55 #include <sys/syslog.h>
56
57 #include <uvm/uvm.h>
58
59 /*
60 * Pool resource management utility.
61 *
62 * Memory is allocated in pages which are split into pieces according to
63 * the pool item size. Each page is kept on one of three lists in the
64 * pool structure: `pr_emptypages', `pr_fullpages' and `pr_partpages',
65 * for empty, full and partially-full pages respectively. The individual
66 * pool items are on a linked list headed by `ph_itemlist' in each page
67 * header. The memory for building the page list is either taken from
68 * the allocated pages themselves (for small pool items) or taken from
69 * an internal pool of page headers (`phpool').
70 */
71
72 /* List of all pools */
73 LIST_HEAD(,pool) pool_head = LIST_HEAD_INITIALIZER(pool_head);
74
75 /* Private pool for page header structures */
76 #define PHPOOL_MAX 8
77 static struct pool phpool[PHPOOL_MAX];
78 #define PHPOOL_FREELIST_NELEM(idx) (((idx) == 0) ? 0 : (1 << (idx)))
79
80 #ifdef POOL_SUBPAGE
81 /* Pool of subpages for use by normal pools. */
82 static struct pool psppool;
83 #endif
84
85 static void *pool_page_alloc_meta(struct pool *, int);
86 static void pool_page_free_meta(struct pool *, void *);
87
88 /* allocator for pool metadata */
89 static struct pool_allocator pool_allocator_meta = {
90 pool_page_alloc_meta, pool_page_free_meta
91 };
92
93 /* # of seconds to retain page after last use */
94 int pool_inactive_time = 10;
95
96 /* Next candidate for drainage (see pool_drain()) */
97 static struct pool *drainpp;
98
99 /* This spin lock protects both pool_head and drainpp. */
100 struct simplelock pool_head_slock = SIMPLELOCK_INITIALIZER;
101
102 typedef uint8_t pool_item_freelist_t;
103
104 struct pool_item_header {
105 /* Page headers */
106 LIST_ENTRY(pool_item_header)
107 ph_pagelist; /* pool page list */
108 SPLAY_ENTRY(pool_item_header)
109 ph_node; /* Off-page page headers */
110 caddr_t ph_page; /* this page's address */
111 struct timeval ph_time; /* last referenced */
112 union {
113 /* !PR_NOTOUCH */
114 struct {
115 LIST_HEAD(, pool_item)
116 phu_itemlist; /* chunk list for this page */
117 } phu_normal;
118 /* PR_NOTOUCH */
119 struct {
120 uint16_t
121 phu_off; /* start offset in page */
122 pool_item_freelist_t
123 phu_firstfree; /* first free item */
124 /*
125 * XXX it might be better to use
126 * a simple bitmap and ffs(3)
127 */
128 } phu_notouch;
129 } ph_u;
130 uint16_t ph_nmissing; /* # of chunks in use */
131 };
132 #define ph_itemlist ph_u.phu_normal.phu_itemlist
133 #define ph_off ph_u.phu_notouch.phu_off
134 #define ph_firstfree ph_u.phu_notouch.phu_firstfree
135
136 struct pool_item {
137 #ifdef DIAGNOSTIC
138 u_int pi_magic;
139 #endif
140 #define PI_MAGIC 0xdeadbeefU
141 /* Other entries use only this list entry */
142 LIST_ENTRY(pool_item) pi_list;
143 };
144
145 #define POOL_NEEDS_CATCHUP(pp) \
146 ((pp)->pr_nitems < (pp)->pr_minitems)
147
148 /*
149 * Pool cache management.
150 *
151 * Pool caches provide a way for constructed objects to be cached by the
152 * pool subsystem. This can lead to performance improvements by avoiding
153 * needless object construction/destruction; it is deferred until absolutely
154 * necessary.
155 *
156 * Caches are grouped into cache groups. Each cache group references
157 * up to 16 constructed objects. When a cache allocates an object
158 * from the pool, it calls the object's constructor and places it into
159 * a cache group. When a cache group frees an object back to the pool,
160 * it first calls the object's destructor. This allows the object to
161 * persist in constructed form while freed to the cache.
162 *
163 * Multiple caches may exist for each pool. This allows a single
164 * object type to have multiple constructed forms. The pool references
165 * each cache, so that when a pool is drained by the pagedaemon, it can
166 * drain each individual cache as well. Each time a cache is drained,
167 * the most idle cache group is freed to the pool in its entirety.
168 *
169 * Pool caches are layed on top of pools. By layering them, we can avoid
170 * the complexity of cache management for pools which would not benefit
171 * from it.
172 */
173
174 /* The cache group pool. */
175 static struct pool pcgpool;
176
177 static void pool_cache_reclaim(struct pool_cache *, struct pool_pagelist *,
178 struct pool_cache_grouplist *);
179 static void pcg_grouplist_free(struct pool_cache_grouplist *);
180
181 static int pool_catchup(struct pool *);
182 static void pool_prime_page(struct pool *, caddr_t,
183 struct pool_item_header *);
184 static void pool_update_curpage(struct pool *);
185
186 static int pool_grow(struct pool *, int);
187 void *pool_allocator_alloc(struct pool *, int);
188 void pool_allocator_free(struct pool *, void *);
189
190 static void pool_print_pagelist(struct pool *, struct pool_pagelist *,
191 void (*)(const char *, ...));
192 static void pool_print1(struct pool *, const char *,
193 void (*)(const char *, ...));
194
195 static int pool_chk_page(struct pool *, const char *,
196 struct pool_item_header *);
197
198 /*
199 * Pool log entry. An array of these is allocated in pool_init().
200 */
201 struct pool_log {
202 const char *pl_file;
203 long pl_line;
204 int pl_action;
205 #define PRLOG_GET 1
206 #define PRLOG_PUT 2
207 void *pl_addr;
208 };
209
210 #ifdef POOL_DIAGNOSTIC
211 /* Number of entries in pool log buffers */
212 #ifndef POOL_LOGSIZE
213 #define POOL_LOGSIZE 10
214 #endif
215
216 int pool_logsize = POOL_LOGSIZE;
217
218 static inline void
219 pr_log(struct pool *pp, void *v, int action, const char *file, long line)
220 {
221 int n = pp->pr_curlogentry;
222 struct pool_log *pl;
223
224 if ((pp->pr_roflags & PR_LOGGING) == 0)
225 return;
226
227 /*
228 * Fill in the current entry. Wrap around and overwrite
229 * the oldest entry if necessary.
230 */
231 pl = &pp->pr_log[n];
232 pl->pl_file = file;
233 pl->pl_line = line;
234 pl->pl_action = action;
235 pl->pl_addr = v;
236 if (++n >= pp->pr_logsize)
237 n = 0;
238 pp->pr_curlogentry = n;
239 }
240
241 static void
242 pr_printlog(struct pool *pp, struct pool_item *pi,
243 void (*pr)(const char *, ...))
244 {
245 int i = pp->pr_logsize;
246 int n = pp->pr_curlogentry;
247
248 if ((pp->pr_roflags & PR_LOGGING) == 0)
249 return;
250
251 /*
252 * Print all entries in this pool's log.
253 */
254 while (i-- > 0) {
255 struct pool_log *pl = &pp->pr_log[n];
256 if (pl->pl_action != 0) {
257 if (pi == NULL || pi == pl->pl_addr) {
258 (*pr)("\tlog entry %d:\n", i);
259 (*pr)("\t\taction = %s, addr = %p\n",
260 pl->pl_action == PRLOG_GET ? "get" : "put",
261 pl->pl_addr);
262 (*pr)("\t\tfile: %s at line %lu\n",
263 pl->pl_file, pl->pl_line);
264 }
265 }
266 if (++n >= pp->pr_logsize)
267 n = 0;
268 }
269 }
270
271 static inline void
272 pr_enter(struct pool *pp, const char *file, long line)
273 {
274
275 if (__predict_false(pp->pr_entered_file != NULL)) {
276 printf("pool %s: reentrancy at file %s line %ld\n",
277 pp->pr_wchan, file, line);
278 printf(" previous entry at file %s line %ld\n",
279 pp->pr_entered_file, pp->pr_entered_line);
280 panic("pr_enter");
281 }
282
283 pp->pr_entered_file = file;
284 pp->pr_entered_line = line;
285 }
286
287 static inline void
288 pr_leave(struct pool *pp)
289 {
290
291 if (__predict_false(pp->pr_entered_file == NULL)) {
292 printf("pool %s not entered?\n", pp->pr_wchan);
293 panic("pr_leave");
294 }
295
296 pp->pr_entered_file = NULL;
297 pp->pr_entered_line = 0;
298 }
299
300 static inline void
301 pr_enter_check(struct pool *pp, void (*pr)(const char *, ...))
302 {
303
304 if (pp->pr_entered_file != NULL)
305 (*pr)("\n\tcurrently entered from file %s line %ld\n",
306 pp->pr_entered_file, pp->pr_entered_line);
307 }
308 #else
309 #define pr_log(pp, v, action, file, line)
310 #define pr_printlog(pp, pi, pr)
311 #define pr_enter(pp, file, line)
312 #define pr_leave(pp)
313 #define pr_enter_check(pp, pr)
314 #endif /* POOL_DIAGNOSTIC */
315
316 static inline int
317 pr_item_notouch_index(const struct pool *pp, const struct pool_item_header *ph,
318 const void *v)
319 {
320 const char *cp = v;
321 int idx;
322
323 KASSERT(pp->pr_roflags & PR_NOTOUCH);
324 idx = (cp - ph->ph_page - ph->ph_off) / pp->pr_size;
325 KASSERT(idx < pp->pr_itemsperpage);
326 return idx;
327 }
328
329 #define PR_FREELIST_ALIGN(p) \
330 roundup((uintptr_t)(p), sizeof(pool_item_freelist_t))
331 #define PR_FREELIST(ph) ((pool_item_freelist_t *)PR_FREELIST_ALIGN((ph) + 1))
332 #define PR_INDEX_USED ((pool_item_freelist_t)-1)
333 #define PR_INDEX_EOL ((pool_item_freelist_t)-2)
334
335 static inline void
336 pr_item_notouch_put(const struct pool *pp, struct pool_item_header *ph,
337 void *obj)
338 {
339 int idx = pr_item_notouch_index(pp, ph, obj);
340 pool_item_freelist_t *freelist = PR_FREELIST(ph);
341
342 KASSERT(freelist[idx] == PR_INDEX_USED);
343 freelist[idx] = ph->ph_firstfree;
344 ph->ph_firstfree = idx;
345 }
346
347 static inline void *
348 pr_item_notouch_get(const struct pool *pp, struct pool_item_header *ph)
349 {
350 int idx = ph->ph_firstfree;
351 pool_item_freelist_t *freelist = PR_FREELIST(ph);
352
353 KASSERT(freelist[idx] != PR_INDEX_USED);
354 ph->ph_firstfree = freelist[idx];
355 freelist[idx] = PR_INDEX_USED;
356
357 return ph->ph_page + ph->ph_off + idx * pp->pr_size;
358 }
359
360 static inline int
361 phtree_compare(struct pool_item_header *a, struct pool_item_header *b)
362 {
363 if (a->ph_page < b->ph_page)
364 return (-1);
365 else if (a->ph_page > b->ph_page)
366 return (1);
367 else
368 return (0);
369 }
370
371 SPLAY_PROTOTYPE(phtree, pool_item_header, ph_node, phtree_compare);
372 SPLAY_GENERATE(phtree, pool_item_header, ph_node, phtree_compare);
373
374 /*
375 * Return the pool page header based on page address.
376 */
377 static inline struct pool_item_header *
378 pr_find_pagehead(struct pool *pp, caddr_t page)
379 {
380 struct pool_item_header *ph, tmp;
381
382 if ((pp->pr_roflags & PR_PHINPAGE) != 0)
383 return ((struct pool_item_header *)(page + pp->pr_phoffset));
384
385 tmp.ph_page = page;
386 ph = SPLAY_FIND(phtree, &pp->pr_phtree, &tmp);
387 return ph;
388 }
389
390 static void
391 pr_pagelist_free(struct pool *pp, struct pool_pagelist *pq)
392 {
393 struct pool_item_header *ph;
394 int s;
395
396 while ((ph = LIST_FIRST(pq)) != NULL) {
397 LIST_REMOVE(ph, ph_pagelist);
398 pool_allocator_free(pp, ph->ph_page);
399 if ((pp->pr_roflags & PR_PHINPAGE) == 0) {
400 s = splvm();
401 pool_put(pp->pr_phpool, ph);
402 splx(s);
403 }
404 }
405 }
406
407 /*
408 * Remove a page from the pool.
409 */
410 static inline void
411 pr_rmpage(struct pool *pp, struct pool_item_header *ph,
412 struct pool_pagelist *pq)
413 {
414
415 LOCK_ASSERT(simple_lock_held(&pp->pr_slock));
416
417 /*
418 * If the page was idle, decrement the idle page count.
419 */
420 if (ph->ph_nmissing == 0) {
421 #ifdef DIAGNOSTIC
422 if (pp->pr_nidle == 0)
423 panic("pr_rmpage: nidle inconsistent");
424 if (pp->pr_nitems < pp->pr_itemsperpage)
425 panic("pr_rmpage: nitems inconsistent");
426 #endif
427 pp->pr_nidle--;
428 }
429
430 pp->pr_nitems -= pp->pr_itemsperpage;
431
432 /*
433 * Unlink the page from the pool and queue it for release.
434 */
435 LIST_REMOVE(ph, ph_pagelist);
436 if ((pp->pr_roflags & PR_PHINPAGE) == 0)
437 SPLAY_REMOVE(phtree, &pp->pr_phtree, ph);
438 LIST_INSERT_HEAD(pq, ph, ph_pagelist);
439
440 pp->pr_npages--;
441 pp->pr_npagefree++;
442
443 pool_update_curpage(pp);
444 }
445
446 /*
447 * Initialize all the pools listed in the "pools" link set.
448 */
449 void
450 link_pool_init(void)
451 {
452 __link_set_decl(pools, struct link_pool_init);
453 struct link_pool_init * const *pi;
454
455 __link_set_foreach(pi, pools)
456 pool_init((*pi)->pp, (*pi)->size, (*pi)->align,
457 (*pi)->align_offset, (*pi)->flags, (*pi)->wchan,
458 (*pi)->palloc);
459 }
460
461 /*
462 * Initialize the given pool resource structure.
463 *
464 * We export this routine to allow other kernel parts to declare
465 * static pools that must be initialized before malloc() is available.
466 */
467 void
468 pool_init(struct pool *pp, size_t size, u_int align, u_int ioff, int flags,
469 const char *wchan, struct pool_allocator *palloc)
470 {
471 #ifdef DEBUG
472 struct pool *pp1;
473 #endif
474 size_t trysize, phsize;
475 int off, slack, s;
476
477 KASSERT((1UL << (CHAR_BIT * sizeof(pool_item_freelist_t))) - 2 >=
478 PHPOOL_FREELIST_NELEM(PHPOOL_MAX - 1));
479
480 #ifdef DEBUG
481 /*
482 * Check that the pool hasn't already been initialised and
483 * added to the list of all pools.
484 */
485 LIST_FOREACH(pp1, &pool_head, pr_poollist) {
486 if (pp == pp1)
487 panic("pool_init: pool %s already initialised",
488 wchan);
489 }
490 #endif
491
492 #ifdef POOL_DIAGNOSTIC
493 /*
494 * Always log if POOL_DIAGNOSTIC is defined.
495 */
496 if (pool_logsize != 0)
497 flags |= PR_LOGGING;
498 #endif
499
500 if (palloc == NULL)
501 palloc = &pool_allocator_kmem;
502 #ifdef POOL_SUBPAGE
503 if (size > palloc->pa_pagesz) {
504 if (palloc == &pool_allocator_kmem)
505 palloc = &pool_allocator_kmem_fullpage;
506 else if (palloc == &pool_allocator_nointr)
507 palloc = &pool_allocator_nointr_fullpage;
508 }
509 #endif /* POOL_SUBPAGE */
510 if ((palloc->pa_flags & PA_INITIALIZED) == 0) {
511 if (palloc->pa_pagesz == 0)
512 palloc->pa_pagesz = PAGE_SIZE;
513
514 TAILQ_INIT(&palloc->pa_list);
515
516 simple_lock_init(&palloc->pa_slock);
517 palloc->pa_pagemask = ~(palloc->pa_pagesz - 1);
518 palloc->pa_pageshift = ffs(palloc->pa_pagesz) - 1;
519 palloc->pa_flags |= PA_INITIALIZED;
520 }
521
522 if (align == 0)
523 align = ALIGN(1);
524
525 if (size < sizeof(struct pool_item))
526 size = sizeof(struct pool_item);
527
528 size = roundup(size, align);
529 #ifdef DIAGNOSTIC
530 if (size > palloc->pa_pagesz)
531 panic("pool_init: pool item size (%lu) too large",
532 (u_long)size);
533 #endif
534
535 /*
536 * Initialize the pool structure.
537 */
538 LIST_INIT(&pp->pr_emptypages);
539 LIST_INIT(&pp->pr_fullpages);
540 LIST_INIT(&pp->pr_partpages);
541 LIST_INIT(&pp->pr_cachelist);
542 pp->pr_curpage = NULL;
543 pp->pr_npages = 0;
544 pp->pr_minitems = 0;
545 pp->pr_minpages = 0;
546 pp->pr_maxpages = UINT_MAX;
547 pp->pr_roflags = flags;
548 pp->pr_flags = 0;
549 pp->pr_size = size;
550 pp->pr_align = align;
551 pp->pr_wchan = wchan;
552 pp->pr_alloc = palloc;
553 pp->pr_nitems = 0;
554 pp->pr_nout = 0;
555 pp->pr_hardlimit = UINT_MAX;
556 pp->pr_hardlimit_warning = NULL;
557 pp->pr_hardlimit_ratecap.tv_sec = 0;
558 pp->pr_hardlimit_ratecap.tv_usec = 0;
559 pp->pr_hardlimit_warning_last.tv_sec = 0;
560 pp->pr_hardlimit_warning_last.tv_usec = 0;
561 pp->pr_drain_hook = NULL;
562 pp->pr_drain_hook_arg = NULL;
563
564 /*
565 * Decide whether to put the page header off page to avoid
566 * wasting too large a part of the page or too big item.
567 * Off-page page headers go on a hash table, so we can match
568 * a returned item with its header based on the page address.
569 * We use 1/16 of the page size and about 8 times of the item
570 * size as the threshold (XXX: tune)
571 *
572 * However, we'll put the header into the page if we can put
573 * it without wasting any items.
574 *
575 * Silently enforce `0 <= ioff < align'.
576 */
577 pp->pr_itemoffset = ioff %= align;
578 /* See the comment below about reserved bytes. */
579 trysize = palloc->pa_pagesz - ((align - ioff) % align);
580 phsize = ALIGN(sizeof(struct pool_item_header));
581 if ((pp->pr_roflags & PR_NOTOUCH) == 0 &&
582 (pp->pr_size < MIN(palloc->pa_pagesz / 16, phsize << 3) ||
583 trysize / pp->pr_size == (trysize - phsize) / pp->pr_size)) {
584 /* Use the end of the page for the page header */
585 pp->pr_roflags |= PR_PHINPAGE;
586 pp->pr_phoffset = off = palloc->pa_pagesz - phsize;
587 } else {
588 /* The page header will be taken from our page header pool */
589 pp->pr_phoffset = 0;
590 off = palloc->pa_pagesz;
591 SPLAY_INIT(&pp->pr_phtree);
592 }
593
594 /*
595 * Alignment is to take place at `ioff' within the item. This means
596 * we must reserve up to `align - 1' bytes on the page to allow
597 * appropriate positioning of each item.
598 */
599 pp->pr_itemsperpage = (off - ((align - ioff) % align)) / pp->pr_size;
600 KASSERT(pp->pr_itemsperpage != 0);
601 if ((pp->pr_roflags & PR_NOTOUCH)) {
602 int idx;
603
604 for (idx = 0; pp->pr_itemsperpage > PHPOOL_FREELIST_NELEM(idx);
605 idx++) {
606 /* nothing */
607 }
608 if (idx >= PHPOOL_MAX) {
609 /*
610 * if you see this panic, consider to tweak
611 * PHPOOL_MAX and PHPOOL_FREELIST_NELEM.
612 */
613 panic("%s: too large itemsperpage(%d) for PR_NOTOUCH",
614 pp->pr_wchan, pp->pr_itemsperpage);
615 }
616 pp->pr_phpool = &phpool[idx];
617 } else if ((pp->pr_roflags & PR_PHINPAGE) == 0) {
618 pp->pr_phpool = &phpool[0];
619 }
620 #if defined(DIAGNOSTIC)
621 else {
622 pp->pr_phpool = NULL;
623 }
624 #endif
625
626 /*
627 * Use the slack between the chunks and the page header
628 * for "cache coloring".
629 */
630 slack = off - pp->pr_itemsperpage * pp->pr_size;
631 pp->pr_maxcolor = (slack / align) * align;
632 pp->pr_curcolor = 0;
633
634 pp->pr_nget = 0;
635 pp->pr_nfail = 0;
636 pp->pr_nput = 0;
637 pp->pr_npagealloc = 0;
638 pp->pr_npagefree = 0;
639 pp->pr_hiwat = 0;
640 pp->pr_nidle = 0;
641
642 #ifdef POOL_DIAGNOSTIC
643 if (flags & PR_LOGGING) {
644 if (kmem_map == NULL ||
645 (pp->pr_log = malloc(pool_logsize * sizeof(struct pool_log),
646 M_TEMP, M_NOWAIT)) == NULL)
647 pp->pr_roflags &= ~PR_LOGGING;
648 pp->pr_curlogentry = 0;
649 pp->pr_logsize = pool_logsize;
650 }
651 #endif
652
653 pp->pr_entered_file = NULL;
654 pp->pr_entered_line = 0;
655
656 simple_lock_init(&pp->pr_slock);
657
658 /*
659 * Initialize private page header pool and cache magazine pool if we
660 * haven't done so yet.
661 * XXX LOCKING.
662 */
663 if (phpool[0].pr_size == 0) {
664 int idx;
665 for (idx = 0; idx < PHPOOL_MAX; idx++) {
666 static char phpool_names[PHPOOL_MAX][6+1+6+1];
667 int nelem;
668 size_t sz;
669
670 nelem = PHPOOL_FREELIST_NELEM(idx);
671 snprintf(phpool_names[idx], sizeof(phpool_names[idx]),
672 "phpool-%d", nelem);
673 sz = sizeof(struct pool_item_header);
674 if (nelem) {
675 sz = PR_FREELIST_ALIGN(sz)
676 + nelem * sizeof(pool_item_freelist_t);
677 }
678 pool_init(&phpool[idx], sz, 0, 0, 0,
679 phpool_names[idx], &pool_allocator_meta);
680 }
681 #ifdef POOL_SUBPAGE
682 pool_init(&psppool, POOL_SUBPAGE, POOL_SUBPAGE, 0,
683 PR_RECURSIVE, "psppool", &pool_allocator_meta);
684 #endif
685 pool_init(&pcgpool, sizeof(struct pool_cache_group), 0, 0,
686 0, "pcgpool", &pool_allocator_meta);
687 }
688
689 /* Insert into the list of all pools. */
690 simple_lock(&pool_head_slock);
691 LIST_INSERT_HEAD(&pool_head, pp, pr_poollist);
692 simple_unlock(&pool_head_slock);
693
694 /* Insert this into the list of pools using this allocator. */
695 s = splvm();
696 simple_lock(&palloc->pa_slock);
697 TAILQ_INSERT_TAIL(&palloc->pa_list, pp, pr_alloc_list);
698 simple_unlock(&palloc->pa_slock);
699 splx(s);
700 }
701
702 /*
703 * De-commision a pool resource.
704 */
705 void
706 pool_destroy(struct pool *pp)
707 {
708 struct pool_pagelist pq;
709 struct pool_item_header *ph;
710 int s;
711
712 /* Remove from global pool list */
713 simple_lock(&pool_head_slock);
714 LIST_REMOVE(pp, pr_poollist);
715 if (drainpp == pp)
716 drainpp = NULL;
717 simple_unlock(&pool_head_slock);
718
719 /* Remove this pool from its allocator's list of pools. */
720 s = splvm();
721 simple_lock(&pp->pr_alloc->pa_slock);
722 TAILQ_REMOVE(&pp->pr_alloc->pa_list, pp, pr_alloc_list);
723 simple_unlock(&pp->pr_alloc->pa_slock);
724 splx(s);
725
726 s = splvm();
727 simple_lock(&pp->pr_slock);
728
729 KASSERT(LIST_EMPTY(&pp->pr_cachelist));
730
731 #ifdef DIAGNOSTIC
732 if (pp->pr_nout != 0) {
733 pr_printlog(pp, NULL, printf);
734 panic("pool_destroy: pool busy: still out: %u",
735 pp->pr_nout);
736 }
737 #endif
738
739 KASSERT(LIST_EMPTY(&pp->pr_fullpages));
740 KASSERT(LIST_EMPTY(&pp->pr_partpages));
741
742 /* Remove all pages */
743 LIST_INIT(&pq);
744 while ((ph = LIST_FIRST(&pp->pr_emptypages)) != NULL)
745 pr_rmpage(pp, ph, &pq);
746
747 simple_unlock(&pp->pr_slock);
748 splx(s);
749
750 pr_pagelist_free(pp, &pq);
751
752 #ifdef POOL_DIAGNOSTIC
753 if ((pp->pr_roflags & PR_LOGGING) != 0)
754 free(pp->pr_log, M_TEMP);
755 #endif
756 }
757
758 void
759 pool_set_drain_hook(struct pool *pp, void (*fn)(void *, int), void *arg)
760 {
761
762 /* XXX no locking -- must be used just after pool_init() */
763 #ifdef DIAGNOSTIC
764 if (pp->pr_drain_hook != NULL)
765 panic("pool_set_drain_hook(%s): already set", pp->pr_wchan);
766 #endif
767 pp->pr_drain_hook = fn;
768 pp->pr_drain_hook_arg = arg;
769 }
770
771 static struct pool_item_header *
772 pool_alloc_item_header(struct pool *pp, caddr_t storage, int flags)
773 {
774 struct pool_item_header *ph;
775 int s;
776
777 LOCK_ASSERT(simple_lock_held(&pp->pr_slock) == 0);
778
779 if ((pp->pr_roflags & PR_PHINPAGE) != 0)
780 ph = (struct pool_item_header *) (storage + pp->pr_phoffset);
781 else {
782 s = splvm();
783 ph = pool_get(pp->pr_phpool, flags);
784 splx(s);
785 }
786
787 return (ph);
788 }
789
790 /*
791 * Grab an item from the pool; must be called at appropriate spl level
792 */
793 void *
794 #ifdef POOL_DIAGNOSTIC
795 _pool_get(struct pool *pp, int flags, const char *file, long line)
796 #else
797 pool_get(struct pool *pp, int flags)
798 #endif
799 {
800 struct pool_item *pi;
801 struct pool_item_header *ph;
802 void *v;
803
804 #ifdef DIAGNOSTIC
805 if (__predict_false(pp->pr_itemsperpage == 0))
806 panic("pool_get: pool %p: pr_itemsperpage is zero, "
807 "pool not initialized?", pp);
808 if (__predict_false(curlwp == NULL && doing_shutdown == 0 &&
809 (flags & PR_WAITOK) != 0))
810 panic("pool_get: %s: must have NOWAIT", pp->pr_wchan);
811
812 #endif /* DIAGNOSTIC */
813 #ifdef LOCKDEBUG
814 if (flags & PR_WAITOK)
815 simple_lock_only_held(NULL, "pool_get(PR_WAITOK)");
816 SCHED_ASSERT_UNLOCKED();
817 #endif
818
819 simple_lock(&pp->pr_slock);
820 pr_enter(pp, file, line);
821
822 startover:
823 /*
824 * Check to see if we've reached the hard limit. If we have,
825 * and we can wait, then wait until an item has been returned to
826 * the pool.
827 */
828 #ifdef DIAGNOSTIC
829 if (__predict_false(pp->pr_nout > pp->pr_hardlimit)) {
830 pr_leave(pp);
831 simple_unlock(&pp->pr_slock);
832 panic("pool_get: %s: crossed hard limit", pp->pr_wchan);
833 }
834 #endif
835 if (__predict_false(pp->pr_nout == pp->pr_hardlimit)) {
836 if (pp->pr_drain_hook != NULL) {
837 /*
838 * Since the drain hook is going to free things
839 * back to the pool, unlock, call the hook, re-lock,
840 * and check the hardlimit condition again.
841 */
842 pr_leave(pp);
843 simple_unlock(&pp->pr_slock);
844 (*pp->pr_drain_hook)(pp->pr_drain_hook_arg, flags);
845 simple_lock(&pp->pr_slock);
846 pr_enter(pp, file, line);
847 if (pp->pr_nout < pp->pr_hardlimit)
848 goto startover;
849 }
850
851 if ((flags & PR_WAITOK) && !(flags & PR_LIMITFAIL)) {
852 /*
853 * XXX: A warning isn't logged in this case. Should
854 * it be?
855 */
856 pp->pr_flags |= PR_WANTED;
857 pr_leave(pp);
858 ltsleep(pp, PSWP, pp->pr_wchan, 0, &pp->pr_slock);
859 pr_enter(pp, file, line);
860 goto startover;
861 }
862
863 /*
864 * Log a message that the hard limit has been hit.
865 */
866 if (pp->pr_hardlimit_warning != NULL &&
867 ratecheck(&pp->pr_hardlimit_warning_last,
868 &pp->pr_hardlimit_ratecap))
869 log(LOG_ERR, "%s\n", pp->pr_hardlimit_warning);
870
871 pp->pr_nfail++;
872
873 pr_leave(pp);
874 simple_unlock(&pp->pr_slock);
875 return (NULL);
876 }
877
878 /*
879 * The convention we use is that if `curpage' is not NULL, then
880 * it points at a non-empty bucket. In particular, `curpage'
881 * never points at a page header which has PR_PHINPAGE set and
882 * has no items in its bucket.
883 */
884 if ((ph = pp->pr_curpage) == NULL) {
885 int error;
886
887 #ifdef DIAGNOSTIC
888 if (pp->pr_nitems != 0) {
889 simple_unlock(&pp->pr_slock);
890 printf("pool_get: %s: curpage NULL, nitems %u\n",
891 pp->pr_wchan, pp->pr_nitems);
892 panic("pool_get: nitems inconsistent");
893 }
894 #endif
895
896 /*
897 * Call the back-end page allocator for more memory.
898 * Release the pool lock, as the back-end page allocator
899 * may block.
900 */
901 pr_leave(pp);
902 error = pool_grow(pp, flags);
903 pr_enter(pp, file, line);
904 if (error != 0) {
905 /*
906 * We were unable to allocate a page or item
907 * header, but we released the lock during
908 * allocation, so perhaps items were freed
909 * back to the pool. Check for this case.
910 */
911 if (pp->pr_curpage != NULL)
912 goto startover;
913
914 if ((flags & PR_WAITOK) == 0) {
915 pp->pr_nfail++;
916 pr_leave(pp);
917 simple_unlock(&pp->pr_slock);
918 return (NULL);
919 }
920
921 /*
922 * Wait for items to be returned to this pool.
923 *
924 * wake up once a second and try again,
925 * as the check in pool_cache_put_paddr() is racy.
926 */
927 pp->pr_flags |= PR_WANTED;
928 /* PA_WANTED is already set on the allocator. */
929 pr_leave(pp);
930 ltsleep(pp, PSWP, pp->pr_wchan, hz, &pp->pr_slock);
931 pr_enter(pp, file, line);
932 }
933
934 /* Start the allocation process over. */
935 goto startover;
936 }
937 if (pp->pr_roflags & PR_NOTOUCH) {
938 #ifdef DIAGNOSTIC
939 if (__predict_false(ph->ph_nmissing == pp->pr_itemsperpage)) {
940 pr_leave(pp);
941 simple_unlock(&pp->pr_slock);
942 panic("pool_get: %s: page empty", pp->pr_wchan);
943 }
944 #endif
945 v = pr_item_notouch_get(pp, ph);
946 #ifdef POOL_DIAGNOSTIC
947 pr_log(pp, v, PRLOG_GET, file, line);
948 #endif
949 } else {
950 v = pi = LIST_FIRST(&ph->ph_itemlist);
951 if (__predict_false(v == NULL)) {
952 pr_leave(pp);
953 simple_unlock(&pp->pr_slock);
954 panic("pool_get: %s: page empty", pp->pr_wchan);
955 }
956 #ifdef DIAGNOSTIC
957 if (__predict_false(pp->pr_nitems == 0)) {
958 pr_leave(pp);
959 simple_unlock(&pp->pr_slock);
960 printf("pool_get: %s: items on itemlist, nitems %u\n",
961 pp->pr_wchan, pp->pr_nitems);
962 panic("pool_get: nitems inconsistent");
963 }
964 #endif
965
966 #ifdef POOL_DIAGNOSTIC
967 pr_log(pp, v, PRLOG_GET, file, line);
968 #endif
969
970 #ifdef DIAGNOSTIC
971 if (__predict_false(pi->pi_magic != PI_MAGIC)) {
972 pr_printlog(pp, pi, printf);
973 panic("pool_get(%s): free list modified: "
974 "magic=%x; page %p; item addr %p\n",
975 pp->pr_wchan, pi->pi_magic, ph->ph_page, pi);
976 }
977 #endif
978
979 /*
980 * Remove from item list.
981 */
982 LIST_REMOVE(pi, pi_list);
983 }
984 pp->pr_nitems--;
985 pp->pr_nout++;
986 if (ph->ph_nmissing == 0) {
987 #ifdef DIAGNOSTIC
988 if (__predict_false(pp->pr_nidle == 0))
989 panic("pool_get: nidle inconsistent");
990 #endif
991 pp->pr_nidle--;
992
993 /*
994 * This page was previously empty. Move it to the list of
995 * partially-full pages. This page is already curpage.
996 */
997 LIST_REMOVE(ph, ph_pagelist);
998 LIST_INSERT_HEAD(&pp->pr_partpages, ph, ph_pagelist);
999 }
1000 ph->ph_nmissing++;
1001 if (ph->ph_nmissing == pp->pr_itemsperpage) {
1002 #ifdef DIAGNOSTIC
1003 if (__predict_false((pp->pr_roflags & PR_NOTOUCH) == 0 &&
1004 !LIST_EMPTY(&ph->ph_itemlist))) {
1005 pr_leave(pp);
1006 simple_unlock(&pp->pr_slock);
1007 panic("pool_get: %s: nmissing inconsistent",
1008 pp->pr_wchan);
1009 }
1010 #endif
1011 /*
1012 * This page is now full. Move it to the full list
1013 * and select a new current page.
1014 */
1015 LIST_REMOVE(ph, ph_pagelist);
1016 LIST_INSERT_HEAD(&pp->pr_fullpages, ph, ph_pagelist);
1017 pool_update_curpage(pp);
1018 }
1019
1020 pp->pr_nget++;
1021 pr_leave(pp);
1022
1023 /*
1024 * If we have a low water mark and we are now below that low
1025 * water mark, add more items to the pool.
1026 */
1027 if (POOL_NEEDS_CATCHUP(pp) && pool_catchup(pp) != 0) {
1028 /*
1029 * XXX: Should we log a warning? Should we set up a timeout
1030 * to try again in a second or so? The latter could break
1031 * a caller's assumptions about interrupt protection, etc.
1032 */
1033 }
1034
1035 simple_unlock(&pp->pr_slock);
1036 return (v);
1037 }
1038
1039 /*
1040 * Internal version of pool_put(). Pool is already locked/entered.
1041 */
1042 static void
1043 pool_do_put(struct pool *pp, void *v, struct pool_pagelist *pq)
1044 {
1045 struct pool_item *pi = v;
1046 struct pool_item_header *ph;
1047 caddr_t page;
1048
1049 LOCK_ASSERT(simple_lock_held(&pp->pr_slock));
1050 SCHED_ASSERT_UNLOCKED();
1051
1052 page = (caddr_t)((u_long)v & pp->pr_alloc->pa_pagemask);
1053
1054 #ifdef DIAGNOSTIC
1055 if (__predict_false(pp->pr_nout == 0)) {
1056 printf("pool %s: putting with none out\n",
1057 pp->pr_wchan);
1058 panic("pool_put");
1059 }
1060 #endif
1061
1062 if (__predict_false((ph = pr_find_pagehead(pp, page)) == NULL)) {
1063 pr_printlog(pp, NULL, printf);
1064 panic("pool_put: %s: page header missing", pp->pr_wchan);
1065 }
1066
1067 #ifdef LOCKDEBUG
1068 /*
1069 * Check if we're freeing a locked simple lock.
1070 */
1071 simple_lock_freecheck((caddr_t)pi, ((caddr_t)pi) + pp->pr_size);
1072 #endif
1073
1074 /*
1075 * Return to item list.
1076 */
1077 if (pp->pr_roflags & PR_NOTOUCH) {
1078 pr_item_notouch_put(pp, ph, v);
1079 } else {
1080 #ifdef DIAGNOSTIC
1081 pi->pi_magic = PI_MAGIC;
1082 #endif
1083 #ifdef DEBUG
1084 {
1085 int i, *ip = v;
1086
1087 for (i = 0; i < pp->pr_size / sizeof(int); i++) {
1088 *ip++ = PI_MAGIC;
1089 }
1090 }
1091 #endif
1092
1093 LIST_INSERT_HEAD(&ph->ph_itemlist, pi, pi_list);
1094 }
1095 KDASSERT(ph->ph_nmissing != 0);
1096 ph->ph_nmissing--;
1097 pp->pr_nput++;
1098 pp->pr_nitems++;
1099 pp->pr_nout--;
1100
1101 /* Cancel "pool empty" condition if it exists */
1102 if (pp->pr_curpage == NULL)
1103 pp->pr_curpage = ph;
1104
1105 if (pp->pr_flags & PR_WANTED) {
1106 pp->pr_flags &= ~PR_WANTED;
1107 if (ph->ph_nmissing == 0)
1108 pp->pr_nidle++;
1109 wakeup((caddr_t)pp);
1110 return;
1111 }
1112
1113 /*
1114 * If this page is now empty, do one of two things:
1115 *
1116 * (1) If we have more pages than the page high water mark,
1117 * free the page back to the system. ONLY CONSIDER
1118 * FREEING BACK A PAGE IF WE HAVE MORE THAN OUR MINIMUM PAGE
1119 * CLAIM.
1120 *
1121 * (2) Otherwise, move the page to the empty page list.
1122 *
1123 * Either way, select a new current page (so we use a partially-full
1124 * page if one is available).
1125 */
1126 if (ph->ph_nmissing == 0) {
1127 pp->pr_nidle++;
1128 if (pp->pr_npages > pp->pr_minpages &&
1129 (pp->pr_npages > pp->pr_maxpages ||
1130 (pp->pr_alloc->pa_flags & PA_WANT) != 0)) {
1131 pr_rmpage(pp, ph, pq);
1132 } else {
1133 LIST_REMOVE(ph, ph_pagelist);
1134 LIST_INSERT_HEAD(&pp->pr_emptypages, ph, ph_pagelist);
1135
1136 /*
1137 * Update the timestamp on the page. A page must
1138 * be idle for some period of time before it can
1139 * be reclaimed by the pagedaemon. This minimizes
1140 * ping-pong'ing for memory.
1141 */
1142 getmicrotime(&ph->ph_time);
1143 }
1144 pool_update_curpage(pp);
1145 }
1146
1147 /*
1148 * If the page was previously completely full, move it to the
1149 * partially-full list and make it the current page. The next
1150 * allocation will get the item from this page, instead of
1151 * further fragmenting the pool.
1152 */
1153 else if (ph->ph_nmissing == (pp->pr_itemsperpage - 1)) {
1154 LIST_REMOVE(ph, ph_pagelist);
1155 LIST_INSERT_HEAD(&pp->pr_partpages, ph, ph_pagelist);
1156 pp->pr_curpage = ph;
1157 }
1158 }
1159
1160 /*
1161 * Return resource to the pool; must be called at appropriate spl level
1162 */
1163 #ifdef POOL_DIAGNOSTIC
1164 void
1165 _pool_put(struct pool *pp, void *v, const char *file, long line)
1166 {
1167 struct pool_pagelist pq;
1168
1169 LIST_INIT(&pq);
1170
1171 simple_lock(&pp->pr_slock);
1172 pr_enter(pp, file, line);
1173
1174 pr_log(pp, v, PRLOG_PUT, file, line);
1175
1176 pool_do_put(pp, v, &pq);
1177
1178 pr_leave(pp);
1179 simple_unlock(&pp->pr_slock);
1180
1181 pr_pagelist_free(pp, &pq);
1182 }
1183 #undef pool_put
1184 #endif /* POOL_DIAGNOSTIC */
1185
1186 void
1187 pool_put(struct pool *pp, void *v)
1188 {
1189 struct pool_pagelist pq;
1190
1191 LIST_INIT(&pq);
1192
1193 simple_lock(&pp->pr_slock);
1194 pool_do_put(pp, v, &pq);
1195 simple_unlock(&pp->pr_slock);
1196
1197 pr_pagelist_free(pp, &pq);
1198 }
1199
1200 #ifdef POOL_DIAGNOSTIC
1201 #define pool_put(h, v) _pool_put((h), (v), __FILE__, __LINE__)
1202 #endif
1203
1204 /*
1205 * pool_grow: grow a pool by a page.
1206 *
1207 * => called with pool locked.
1208 * => unlock and relock the pool.
1209 * => return with pool locked.
1210 */
1211
1212 static int
1213 pool_grow(struct pool *pp, int flags)
1214 {
1215 struct pool_item_header *ph = NULL;
1216 char *cp;
1217
1218 simple_unlock(&pp->pr_slock);
1219 cp = pool_allocator_alloc(pp, flags);
1220 if (__predict_true(cp != NULL)) {
1221 ph = pool_alloc_item_header(pp, cp, flags);
1222 }
1223 if (__predict_false(cp == NULL || ph == NULL)) {
1224 if (cp != NULL) {
1225 pool_allocator_free(pp, cp);
1226 }
1227 simple_lock(&pp->pr_slock);
1228 return ENOMEM;
1229 }
1230
1231 simple_lock(&pp->pr_slock);
1232 pool_prime_page(pp, cp, ph);
1233 pp->pr_npagealloc++;
1234 return 0;
1235 }
1236
1237 /*
1238 * Add N items to the pool.
1239 */
1240 int
1241 pool_prime(struct pool *pp, int n)
1242 {
1243 int newpages;
1244 int error = 0;
1245
1246 simple_lock(&pp->pr_slock);
1247
1248 newpages = roundup(n, pp->pr_itemsperpage) / pp->pr_itemsperpage;
1249
1250 while (newpages-- > 0) {
1251 error = pool_grow(pp, PR_NOWAIT);
1252 if (error) {
1253 break;
1254 }
1255 pp->pr_minpages++;
1256 }
1257
1258 if (pp->pr_minpages >= pp->pr_maxpages)
1259 pp->pr_maxpages = pp->pr_minpages + 1; /* XXX */
1260
1261 simple_unlock(&pp->pr_slock);
1262 return error;
1263 }
1264
1265 /*
1266 * Add a page worth of items to the pool.
1267 *
1268 * Note, we must be called with the pool descriptor LOCKED.
1269 */
1270 static void
1271 pool_prime_page(struct pool *pp, caddr_t storage, struct pool_item_header *ph)
1272 {
1273 struct pool_item *pi;
1274 caddr_t cp = storage;
1275 unsigned int align = pp->pr_align;
1276 unsigned int ioff = pp->pr_itemoffset;
1277 int n;
1278
1279 LOCK_ASSERT(simple_lock_held(&pp->pr_slock));
1280
1281 #ifdef DIAGNOSTIC
1282 if (((u_long)cp & (pp->pr_alloc->pa_pagesz - 1)) != 0)
1283 panic("pool_prime_page: %s: unaligned page", pp->pr_wchan);
1284 #endif
1285
1286 /*
1287 * Insert page header.
1288 */
1289 LIST_INSERT_HEAD(&pp->pr_emptypages, ph, ph_pagelist);
1290 LIST_INIT(&ph->ph_itemlist);
1291 ph->ph_page = storage;
1292 ph->ph_nmissing = 0;
1293 getmicrotime(&ph->ph_time);
1294 if ((pp->pr_roflags & PR_PHINPAGE) == 0)
1295 SPLAY_INSERT(phtree, &pp->pr_phtree, ph);
1296
1297 pp->pr_nidle++;
1298
1299 /*
1300 * Color this page.
1301 */
1302 cp = (caddr_t)(cp + pp->pr_curcolor);
1303 if ((pp->pr_curcolor += align) > pp->pr_maxcolor)
1304 pp->pr_curcolor = 0;
1305
1306 /*
1307 * Adjust storage to apply aligment to `pr_itemoffset' in each item.
1308 */
1309 if (ioff != 0)
1310 cp = (caddr_t)(cp + (align - ioff));
1311
1312 /*
1313 * Insert remaining chunks on the bucket list.
1314 */
1315 n = pp->pr_itemsperpage;
1316 pp->pr_nitems += n;
1317
1318 if (pp->pr_roflags & PR_NOTOUCH) {
1319 pool_item_freelist_t *freelist = PR_FREELIST(ph);
1320 int i;
1321
1322 ph->ph_off = cp - storage;
1323 ph->ph_firstfree = 0;
1324 for (i = 0; i < n - 1; i++)
1325 freelist[i] = i + 1;
1326 freelist[n - 1] = PR_INDEX_EOL;
1327 } else {
1328 while (n--) {
1329 pi = (struct pool_item *)cp;
1330
1331 KASSERT(((((vaddr_t)pi) + ioff) & (align - 1)) == 0);
1332
1333 /* Insert on page list */
1334 LIST_INSERT_HEAD(&ph->ph_itemlist, pi, pi_list);
1335 #ifdef DIAGNOSTIC
1336 pi->pi_magic = PI_MAGIC;
1337 #endif
1338 cp = (caddr_t)(cp + pp->pr_size);
1339 }
1340 }
1341
1342 /*
1343 * If the pool was depleted, point at the new page.
1344 */
1345 if (pp->pr_curpage == NULL)
1346 pp->pr_curpage = ph;
1347
1348 if (++pp->pr_npages > pp->pr_hiwat)
1349 pp->pr_hiwat = pp->pr_npages;
1350 }
1351
1352 /*
1353 * Used by pool_get() when nitems drops below the low water mark. This
1354 * is used to catch up pr_nitems with the low water mark.
1355 *
1356 * Note 1, we never wait for memory here, we let the caller decide what to do.
1357 *
1358 * Note 2, we must be called with the pool already locked, and we return
1359 * with it locked.
1360 */
1361 static int
1362 pool_catchup(struct pool *pp)
1363 {
1364 int error = 0;
1365
1366 while (POOL_NEEDS_CATCHUP(pp)) {
1367 error = pool_grow(pp, PR_NOWAIT);
1368 if (error) {
1369 break;
1370 }
1371 }
1372 return error;
1373 }
1374
1375 static void
1376 pool_update_curpage(struct pool *pp)
1377 {
1378
1379 pp->pr_curpage = LIST_FIRST(&pp->pr_partpages);
1380 if (pp->pr_curpage == NULL) {
1381 pp->pr_curpage = LIST_FIRST(&pp->pr_emptypages);
1382 }
1383 }
1384
1385 void
1386 pool_setlowat(struct pool *pp, int n)
1387 {
1388
1389 simple_lock(&pp->pr_slock);
1390
1391 pp->pr_minitems = n;
1392 pp->pr_minpages = (n == 0)
1393 ? 0
1394 : roundup(n, pp->pr_itemsperpage) / pp->pr_itemsperpage;
1395
1396 /* Make sure we're caught up with the newly-set low water mark. */
1397 if (POOL_NEEDS_CATCHUP(pp) && pool_catchup(pp) != 0) {
1398 /*
1399 * XXX: Should we log a warning? Should we set up a timeout
1400 * to try again in a second or so? The latter could break
1401 * a caller's assumptions about interrupt protection, etc.
1402 */
1403 }
1404
1405 simple_unlock(&pp->pr_slock);
1406 }
1407
1408 void
1409 pool_sethiwat(struct pool *pp, int n)
1410 {
1411
1412 simple_lock(&pp->pr_slock);
1413
1414 pp->pr_maxpages = (n == 0)
1415 ? 0
1416 : roundup(n, pp->pr_itemsperpage) / pp->pr_itemsperpage;
1417
1418 simple_unlock(&pp->pr_slock);
1419 }
1420
1421 void
1422 pool_sethardlimit(struct pool *pp, int n, const char *warnmess, int ratecap)
1423 {
1424
1425 simple_lock(&pp->pr_slock);
1426
1427 pp->pr_hardlimit = n;
1428 pp->pr_hardlimit_warning = warnmess;
1429 pp->pr_hardlimit_ratecap.tv_sec = ratecap;
1430 pp->pr_hardlimit_warning_last.tv_sec = 0;
1431 pp->pr_hardlimit_warning_last.tv_usec = 0;
1432
1433 /*
1434 * In-line version of pool_sethiwat(), because we don't want to
1435 * release the lock.
1436 */
1437 pp->pr_maxpages = (n == 0)
1438 ? 0
1439 : roundup(n, pp->pr_itemsperpage) / pp->pr_itemsperpage;
1440
1441 simple_unlock(&pp->pr_slock);
1442 }
1443
1444 /*
1445 * Release all complete pages that have not been used recently.
1446 */
1447 int
1448 #ifdef POOL_DIAGNOSTIC
1449 _pool_reclaim(struct pool *pp, const char *file, long line)
1450 #else
1451 pool_reclaim(struct pool *pp)
1452 #endif
1453 {
1454 struct pool_item_header *ph, *phnext;
1455 struct pool_cache *pc;
1456 struct pool_pagelist pq;
1457 struct pool_cache_grouplist pcgl;
1458 struct timeval curtime, diff;
1459
1460 if (pp->pr_drain_hook != NULL) {
1461 /*
1462 * The drain hook must be called with the pool unlocked.
1463 */
1464 (*pp->pr_drain_hook)(pp->pr_drain_hook_arg, PR_NOWAIT);
1465 }
1466
1467 if (simple_lock_try(&pp->pr_slock) == 0)
1468 return (0);
1469 pr_enter(pp, file, line);
1470
1471 LIST_INIT(&pq);
1472 LIST_INIT(&pcgl);
1473
1474 /*
1475 * Reclaim items from the pool's caches.
1476 */
1477 LIST_FOREACH(pc, &pp->pr_cachelist, pc_poollist)
1478 pool_cache_reclaim(pc, &pq, &pcgl);
1479
1480 getmicrotime(&curtime);
1481
1482 for (ph = LIST_FIRST(&pp->pr_emptypages); ph != NULL; ph = phnext) {
1483 phnext = LIST_NEXT(ph, ph_pagelist);
1484
1485 /* Check our minimum page claim */
1486 if (pp->pr_npages <= pp->pr_minpages)
1487 break;
1488
1489 KASSERT(ph->ph_nmissing == 0);
1490 timersub(&curtime, &ph->ph_time, &diff);
1491 if (diff.tv_sec < pool_inactive_time)
1492 continue;
1493
1494 /*
1495 * If freeing this page would put us below
1496 * the low water mark, stop now.
1497 */
1498 if ((pp->pr_nitems - pp->pr_itemsperpage) <
1499 pp->pr_minitems)
1500 break;
1501
1502 pr_rmpage(pp, ph, &pq);
1503 }
1504
1505 pr_leave(pp);
1506 simple_unlock(&pp->pr_slock);
1507 if (LIST_EMPTY(&pq) && LIST_EMPTY(&pcgl))
1508 return 0;
1509
1510 pr_pagelist_free(pp, &pq);
1511 pcg_grouplist_free(&pcgl);
1512 return (1);
1513 }
1514
1515 /*
1516 * Drain pools, one at a time.
1517 *
1518 * Note, we must never be called from an interrupt context.
1519 */
1520 void
1521 pool_drain(void *arg)
1522 {
1523 struct pool *pp;
1524 int s;
1525
1526 pp = NULL;
1527 s = splvm();
1528 simple_lock(&pool_head_slock);
1529 if (drainpp == NULL) {
1530 drainpp = LIST_FIRST(&pool_head);
1531 }
1532 if (drainpp) {
1533 pp = drainpp;
1534 drainpp = LIST_NEXT(pp, pr_poollist);
1535 }
1536 simple_unlock(&pool_head_slock);
1537 if (pp)
1538 pool_reclaim(pp);
1539 splx(s);
1540 }
1541
1542 /*
1543 * Diagnostic helpers.
1544 */
1545 void
1546 pool_print(struct pool *pp, const char *modif)
1547 {
1548 int s;
1549
1550 s = splvm();
1551 if (simple_lock_try(&pp->pr_slock) == 0) {
1552 printf("pool %s is locked; try again later\n",
1553 pp->pr_wchan);
1554 splx(s);
1555 return;
1556 }
1557 pool_print1(pp, modif, printf);
1558 simple_unlock(&pp->pr_slock);
1559 splx(s);
1560 }
1561
1562 void
1563 pool_printall(const char *modif, void (*pr)(const char *, ...))
1564 {
1565 struct pool *pp;
1566
1567 if (simple_lock_try(&pool_head_slock) == 0) {
1568 (*pr)("WARNING: pool_head_slock is locked\n");
1569 } else {
1570 simple_unlock(&pool_head_slock);
1571 }
1572
1573 LIST_FOREACH(pp, &pool_head, pr_poollist) {
1574 pool_printit(pp, modif, pr);
1575 }
1576 }
1577
1578 void
1579 pool_printit(struct pool *pp, const char *modif, void (*pr)(const char *, ...))
1580 {
1581
1582 if (pp == NULL) {
1583 (*pr)("Must specify a pool to print.\n");
1584 return;
1585 }
1586
1587 /*
1588 * Called from DDB; interrupts should be blocked, and all
1589 * other processors should be paused. We can skip locking
1590 * the pool in this case.
1591 *
1592 * We do a simple_lock_try() just to print the lock
1593 * status, however.
1594 */
1595
1596 if (simple_lock_try(&pp->pr_slock) == 0)
1597 (*pr)("WARNING: pool %s is locked\n", pp->pr_wchan);
1598 else
1599 simple_unlock(&pp->pr_slock);
1600
1601 pool_print1(pp, modif, pr);
1602 }
1603
1604 static void
1605 pool_print_pagelist(struct pool *pp, struct pool_pagelist *pl,
1606 void (*pr)(const char *, ...))
1607 {
1608 struct pool_item_header *ph;
1609 #ifdef DIAGNOSTIC
1610 struct pool_item *pi;
1611 #endif
1612
1613 LIST_FOREACH(ph, pl, ph_pagelist) {
1614 (*pr)("\t\tpage %p, nmissing %d, time %lu,%lu\n",
1615 ph->ph_page, ph->ph_nmissing,
1616 (u_long)ph->ph_time.tv_sec,
1617 (u_long)ph->ph_time.tv_usec);
1618 #ifdef DIAGNOSTIC
1619 if (!(pp->pr_roflags & PR_NOTOUCH)) {
1620 LIST_FOREACH(pi, &ph->ph_itemlist, pi_list) {
1621 if (pi->pi_magic != PI_MAGIC) {
1622 (*pr)("\t\t\titem %p, magic 0x%x\n",
1623 pi, pi->pi_magic);
1624 }
1625 }
1626 }
1627 #endif
1628 }
1629 }
1630
1631 static void
1632 pool_print1(struct pool *pp, const char *modif, void (*pr)(const char *, ...))
1633 {
1634 struct pool_item_header *ph;
1635 struct pool_cache *pc;
1636 struct pool_cache_group *pcg;
1637 int i, print_log = 0, print_pagelist = 0, print_cache = 0;
1638 char c;
1639
1640 while ((c = *modif++) != '\0') {
1641 if (c == 'l')
1642 print_log = 1;
1643 if (c == 'p')
1644 print_pagelist = 1;
1645 if (c == 'c')
1646 print_cache = 1;
1647 }
1648
1649 (*pr)("POOL %s: size %u, align %u, ioff %u, roflags 0x%08x\n",
1650 pp->pr_wchan, pp->pr_size, pp->pr_align, pp->pr_itemoffset,
1651 pp->pr_roflags);
1652 (*pr)("\talloc %p\n", pp->pr_alloc);
1653 (*pr)("\tminitems %u, minpages %u, maxpages %u, npages %u\n",
1654 pp->pr_minitems, pp->pr_minpages, pp->pr_maxpages, pp->pr_npages);
1655 (*pr)("\titemsperpage %u, nitems %u, nout %u, hardlimit %u\n",
1656 pp->pr_itemsperpage, pp->pr_nitems, pp->pr_nout, pp->pr_hardlimit);
1657
1658 (*pr)("\n\tnget %lu, nfail %lu, nput %lu\n",
1659 pp->pr_nget, pp->pr_nfail, pp->pr_nput);
1660 (*pr)("\tnpagealloc %lu, npagefree %lu, hiwat %u, nidle %lu\n",
1661 pp->pr_npagealloc, pp->pr_npagefree, pp->pr_hiwat, pp->pr_nidle);
1662
1663 if (print_pagelist == 0)
1664 goto skip_pagelist;
1665
1666 if ((ph = LIST_FIRST(&pp->pr_emptypages)) != NULL)
1667 (*pr)("\n\tempty page list:\n");
1668 pool_print_pagelist(pp, &pp->pr_emptypages, pr);
1669 if ((ph = LIST_FIRST(&pp->pr_fullpages)) != NULL)
1670 (*pr)("\n\tfull page list:\n");
1671 pool_print_pagelist(pp, &pp->pr_fullpages, pr);
1672 if ((ph = LIST_FIRST(&pp->pr_partpages)) != NULL)
1673 (*pr)("\n\tpartial-page list:\n");
1674 pool_print_pagelist(pp, &pp->pr_partpages, pr);
1675
1676 if (pp->pr_curpage == NULL)
1677 (*pr)("\tno current page\n");
1678 else
1679 (*pr)("\tcurpage %p\n", pp->pr_curpage->ph_page);
1680
1681 skip_pagelist:
1682 if (print_log == 0)
1683 goto skip_log;
1684
1685 (*pr)("\n");
1686 if ((pp->pr_roflags & PR_LOGGING) == 0)
1687 (*pr)("\tno log\n");
1688 else
1689 pr_printlog(pp, NULL, pr);
1690
1691 skip_log:
1692 if (print_cache == 0)
1693 goto skip_cache;
1694
1695 #define PR_GROUPLIST(pcg) \
1696 (*pr)("\t\tgroup %p: avail %d\n", pcg, pcg->pcg_avail); \
1697 for (i = 0; i < PCG_NOBJECTS; i++) { \
1698 if (pcg->pcg_objects[i].pcgo_pa != \
1699 POOL_PADDR_INVALID) { \
1700 (*pr)("\t\t\t%p, 0x%llx\n", \
1701 pcg->pcg_objects[i].pcgo_va, \
1702 (unsigned long long) \
1703 pcg->pcg_objects[i].pcgo_pa); \
1704 } else { \
1705 (*pr)("\t\t\t%p\n", \
1706 pcg->pcg_objects[i].pcgo_va); \
1707 } \
1708 }
1709
1710 LIST_FOREACH(pc, &pp->pr_cachelist, pc_poollist) {
1711 (*pr)("\tcache %p\n", pc);
1712 (*pr)("\t hits %lu misses %lu ngroups %lu nitems %lu\n",
1713 pc->pc_hits, pc->pc_misses, pc->pc_ngroups, pc->pc_nitems);
1714 (*pr)("\t full groups:\n");
1715 LIST_FOREACH(pcg, &pc->pc_fullgroups, pcg_list) {
1716 PR_GROUPLIST(pcg);
1717 }
1718 (*pr)("\t partial groups:\n");
1719 LIST_FOREACH(pcg, &pc->pc_partgroups, pcg_list) {
1720 PR_GROUPLIST(pcg);
1721 }
1722 (*pr)("\t empty groups:\n");
1723 LIST_FOREACH(pcg, &pc->pc_emptygroups, pcg_list) {
1724 PR_GROUPLIST(pcg);
1725 }
1726 }
1727 #undef PR_GROUPLIST
1728
1729 skip_cache:
1730 pr_enter_check(pp, pr);
1731 }
1732
1733 static int
1734 pool_chk_page(struct pool *pp, const char *label, struct pool_item_header *ph)
1735 {
1736 struct pool_item *pi;
1737 caddr_t page;
1738 int n;
1739
1740 page = (caddr_t)((u_long)ph & pp->pr_alloc->pa_pagemask);
1741 if (page != ph->ph_page &&
1742 (pp->pr_roflags & PR_PHINPAGE) != 0) {
1743 if (label != NULL)
1744 printf("%s: ", label);
1745 printf("pool(%p:%s): page inconsistency: page %p;"
1746 " at page head addr %p (p %p)\n", pp,
1747 pp->pr_wchan, ph->ph_page,
1748 ph, page);
1749 return 1;
1750 }
1751
1752 if ((pp->pr_roflags & PR_NOTOUCH) != 0)
1753 return 0;
1754
1755 for (pi = LIST_FIRST(&ph->ph_itemlist), n = 0;
1756 pi != NULL;
1757 pi = LIST_NEXT(pi,pi_list), n++) {
1758
1759 #ifdef DIAGNOSTIC
1760 if (pi->pi_magic != PI_MAGIC) {
1761 if (label != NULL)
1762 printf("%s: ", label);
1763 printf("pool(%s): free list modified: magic=%x;"
1764 " page %p; item ordinal %d;"
1765 " addr %p (p %p)\n",
1766 pp->pr_wchan, pi->pi_magic, ph->ph_page,
1767 n, pi, page);
1768 panic("pool");
1769 }
1770 #endif
1771 page =
1772 (caddr_t)((u_long)pi & pp->pr_alloc->pa_pagemask);
1773 if (page == ph->ph_page)
1774 continue;
1775
1776 if (label != NULL)
1777 printf("%s: ", label);
1778 printf("pool(%p:%s): page inconsistency: page %p;"
1779 " item ordinal %d; addr %p (p %p)\n", pp,
1780 pp->pr_wchan, ph->ph_page,
1781 n, pi, page);
1782 return 1;
1783 }
1784 return 0;
1785 }
1786
1787
1788 int
1789 pool_chk(struct pool *pp, const char *label)
1790 {
1791 struct pool_item_header *ph;
1792 int r = 0;
1793
1794 simple_lock(&pp->pr_slock);
1795 LIST_FOREACH(ph, &pp->pr_emptypages, ph_pagelist) {
1796 r = pool_chk_page(pp, label, ph);
1797 if (r) {
1798 goto out;
1799 }
1800 }
1801 LIST_FOREACH(ph, &pp->pr_fullpages, ph_pagelist) {
1802 r = pool_chk_page(pp, label, ph);
1803 if (r) {
1804 goto out;
1805 }
1806 }
1807 LIST_FOREACH(ph, &pp->pr_partpages, ph_pagelist) {
1808 r = pool_chk_page(pp, label, ph);
1809 if (r) {
1810 goto out;
1811 }
1812 }
1813
1814 out:
1815 simple_unlock(&pp->pr_slock);
1816 return (r);
1817 }
1818
1819 /*
1820 * pool_cache_init:
1821 *
1822 * Initialize a pool cache.
1823 *
1824 * NOTE: If the pool must be protected from interrupts, we expect
1825 * to be called at the appropriate interrupt priority level.
1826 */
1827 void
1828 pool_cache_init(struct pool_cache *pc, struct pool *pp,
1829 int (*ctor)(void *, void *, int),
1830 void (*dtor)(void *, void *),
1831 void *arg)
1832 {
1833
1834 LIST_INIT(&pc->pc_emptygroups);
1835 LIST_INIT(&pc->pc_fullgroups);
1836 LIST_INIT(&pc->pc_partgroups);
1837 simple_lock_init(&pc->pc_slock);
1838
1839 pc->pc_pool = pp;
1840
1841 pc->pc_ctor = ctor;
1842 pc->pc_dtor = dtor;
1843 pc->pc_arg = arg;
1844
1845 pc->pc_hits = 0;
1846 pc->pc_misses = 0;
1847
1848 pc->pc_ngroups = 0;
1849
1850 pc->pc_nitems = 0;
1851
1852 simple_lock(&pp->pr_slock);
1853 LIST_INSERT_HEAD(&pp->pr_cachelist, pc, pc_poollist);
1854 simple_unlock(&pp->pr_slock);
1855 }
1856
1857 /*
1858 * pool_cache_destroy:
1859 *
1860 * Destroy a pool cache.
1861 */
1862 void
1863 pool_cache_destroy(struct pool_cache *pc)
1864 {
1865 struct pool *pp = pc->pc_pool;
1866
1867 /* First, invalidate the entire cache. */
1868 pool_cache_invalidate(pc);
1869
1870 /* ...and remove it from the pool's cache list. */
1871 simple_lock(&pp->pr_slock);
1872 LIST_REMOVE(pc, pc_poollist);
1873 simple_unlock(&pp->pr_slock);
1874 }
1875
1876 static inline void *
1877 pcg_get(struct pool_cache_group *pcg, paddr_t *pap)
1878 {
1879 void *object;
1880 u_int idx;
1881
1882 KASSERT(pcg->pcg_avail <= PCG_NOBJECTS);
1883 KASSERT(pcg->pcg_avail != 0);
1884 idx = --pcg->pcg_avail;
1885
1886 KASSERT(pcg->pcg_objects[idx].pcgo_va != NULL);
1887 object = pcg->pcg_objects[idx].pcgo_va;
1888 if (pap != NULL)
1889 *pap = pcg->pcg_objects[idx].pcgo_pa;
1890 pcg->pcg_objects[idx].pcgo_va = NULL;
1891
1892 return (object);
1893 }
1894
1895 static inline void
1896 pcg_put(struct pool_cache_group *pcg, void *object, paddr_t pa)
1897 {
1898 u_int idx;
1899
1900 KASSERT(pcg->pcg_avail < PCG_NOBJECTS);
1901 idx = pcg->pcg_avail++;
1902
1903 KASSERT(pcg->pcg_objects[idx].pcgo_va == NULL);
1904 pcg->pcg_objects[idx].pcgo_va = object;
1905 pcg->pcg_objects[idx].pcgo_pa = pa;
1906 }
1907
1908 static void
1909 pcg_grouplist_free(struct pool_cache_grouplist *pcgl)
1910 {
1911 struct pool_cache_group *pcg;
1912 int s;
1913
1914 s = splvm();
1915 while ((pcg = LIST_FIRST(pcgl)) != NULL) {
1916 LIST_REMOVE(pcg, pcg_list);
1917 pool_put(&pcgpool, pcg);
1918 }
1919 splx(s);
1920 }
1921
1922 /*
1923 * pool_cache_get{,_paddr}:
1924 *
1925 * Get an object from a pool cache (optionally returning
1926 * the physical address of the object).
1927 */
1928 void *
1929 pool_cache_get_paddr(struct pool_cache *pc, int flags, paddr_t *pap)
1930 {
1931 struct pool_cache_group *pcg;
1932 void *object;
1933
1934 #ifdef LOCKDEBUG
1935 if (flags & PR_WAITOK)
1936 simple_lock_only_held(NULL, "pool_cache_get(PR_WAITOK)");
1937 #endif
1938
1939 simple_lock(&pc->pc_slock);
1940
1941 pcg = LIST_FIRST(&pc->pc_partgroups);
1942 if (pcg == NULL) {
1943 pcg = LIST_FIRST(&pc->pc_fullgroups);
1944 if (pcg != NULL) {
1945 LIST_REMOVE(pcg, pcg_list);
1946 LIST_INSERT_HEAD(&pc->pc_partgroups, pcg, pcg_list);
1947 }
1948 }
1949 if (pcg == NULL) {
1950
1951 /*
1952 * No groups with any available objects. Allocate
1953 * a new object, construct it, and return it to
1954 * the caller. We will allocate a group, if necessary,
1955 * when the object is freed back to the cache.
1956 */
1957 pc->pc_misses++;
1958 simple_unlock(&pc->pc_slock);
1959 object = pool_get(pc->pc_pool, flags);
1960 if (object != NULL && pc->pc_ctor != NULL) {
1961 if ((*pc->pc_ctor)(pc->pc_arg, object, flags) != 0) {
1962 pool_put(pc->pc_pool, object);
1963 return (NULL);
1964 }
1965 }
1966 if (object != NULL && pap != NULL) {
1967 #ifdef POOL_VTOPHYS
1968 *pap = POOL_VTOPHYS(object);
1969 #else
1970 *pap = POOL_PADDR_INVALID;
1971 #endif
1972 }
1973 return (object);
1974 }
1975
1976 pc->pc_hits++;
1977 pc->pc_nitems--;
1978 object = pcg_get(pcg, pap);
1979
1980 if (pcg->pcg_avail == 0) {
1981 LIST_REMOVE(pcg, pcg_list);
1982 LIST_INSERT_HEAD(&pc->pc_emptygroups, pcg, pcg_list);
1983 }
1984 simple_unlock(&pc->pc_slock);
1985
1986 return (object);
1987 }
1988
1989 /*
1990 * pool_cache_put{,_paddr}:
1991 *
1992 * Put an object back to the pool cache (optionally caching the
1993 * physical address of the object).
1994 */
1995 void
1996 pool_cache_put_paddr(struct pool_cache *pc, void *object, paddr_t pa)
1997 {
1998 struct pool_cache_group *pcg;
1999 int s;
2000
2001 if (__predict_false((pc->pc_pool->pr_flags & PR_WANTED) != 0)) {
2002 goto destruct;
2003 }
2004
2005 simple_lock(&pc->pc_slock);
2006
2007 pcg = LIST_FIRST(&pc->pc_partgroups);
2008 if (pcg == NULL) {
2009 pcg = LIST_FIRST(&pc->pc_emptygroups);
2010 if (pcg != NULL) {
2011 LIST_REMOVE(pcg, pcg_list);
2012 LIST_INSERT_HEAD(&pc->pc_partgroups, pcg, pcg_list);
2013 }
2014 }
2015 if (pcg == NULL) {
2016
2017 /*
2018 * No empty groups to free the object to. Attempt to
2019 * allocate one.
2020 */
2021 simple_unlock(&pc->pc_slock);
2022 s = splvm();
2023 pcg = pool_get(&pcgpool, PR_NOWAIT);
2024 splx(s);
2025 if (pcg == NULL) {
2026 destruct:
2027
2028 /*
2029 * Unable to allocate a cache group; destruct the object
2030 * and free it back to the pool.
2031 */
2032 pool_cache_destruct_object(pc, object);
2033 return;
2034 }
2035 memset(pcg, 0, sizeof(*pcg));
2036 simple_lock(&pc->pc_slock);
2037 pc->pc_ngroups++;
2038 LIST_INSERT_HEAD(&pc->pc_partgroups, pcg, pcg_list);
2039 }
2040
2041 pc->pc_nitems++;
2042 pcg_put(pcg, object, pa);
2043
2044 if (pcg->pcg_avail == PCG_NOBJECTS) {
2045 LIST_REMOVE(pcg, pcg_list);
2046 LIST_INSERT_HEAD(&pc->pc_fullgroups, pcg, pcg_list);
2047 }
2048 simple_unlock(&pc->pc_slock);
2049 }
2050
2051 /*
2052 * pool_cache_destruct_object:
2053 *
2054 * Force destruction of an object and its release back into
2055 * the pool.
2056 */
2057 void
2058 pool_cache_destruct_object(struct pool_cache *pc, void *object)
2059 {
2060
2061 if (pc->pc_dtor != NULL)
2062 (*pc->pc_dtor)(pc->pc_arg, object);
2063 pool_put(pc->pc_pool, object);
2064 }
2065
2066 static void
2067 pool_do_cache_invalidate_grouplist(struct pool_cache_grouplist *pcgsl,
2068 struct pool_cache *pc, struct pool_pagelist *pq,
2069 struct pool_cache_grouplist *pcgdl)
2070 {
2071 struct pool_cache_group *pcg, *npcg;
2072 void *object;
2073
2074 for (pcg = LIST_FIRST(pcgsl); pcg != NULL; pcg = npcg) {
2075 npcg = LIST_NEXT(pcg, pcg_list);
2076 while (pcg->pcg_avail != 0) {
2077 pc->pc_nitems--;
2078 object = pcg_get(pcg, NULL);
2079 if (pc->pc_dtor != NULL)
2080 (*pc->pc_dtor)(pc->pc_arg, object);
2081 pool_do_put(pc->pc_pool, object, pq);
2082 }
2083 pc->pc_ngroups--;
2084 LIST_REMOVE(pcg, pcg_list);
2085 LIST_INSERT_HEAD(pcgdl, pcg, pcg_list);
2086 }
2087 }
2088
2089 static void
2090 pool_do_cache_invalidate(struct pool_cache *pc, struct pool_pagelist *pq,
2091 struct pool_cache_grouplist *pcgl)
2092 {
2093
2094 LOCK_ASSERT(simple_lock_held(&pc->pc_slock));
2095 LOCK_ASSERT(simple_lock_held(&pc->pc_pool->pr_slock));
2096
2097 pool_do_cache_invalidate_grouplist(&pc->pc_fullgroups, pc, pq, pcgl);
2098 pool_do_cache_invalidate_grouplist(&pc->pc_partgroups, pc, pq, pcgl);
2099
2100 KASSERT(LIST_EMPTY(&pc->pc_partgroups));
2101 KASSERT(LIST_EMPTY(&pc->pc_fullgroups));
2102 KASSERT(pc->pc_nitems == 0);
2103 }
2104
2105 /*
2106 * pool_cache_invalidate:
2107 *
2108 * Invalidate a pool cache (destruct and release all of the
2109 * cached objects).
2110 */
2111 void
2112 pool_cache_invalidate(struct pool_cache *pc)
2113 {
2114 struct pool_pagelist pq;
2115 struct pool_cache_grouplist pcgl;
2116
2117 LIST_INIT(&pq);
2118 LIST_INIT(&pcgl);
2119
2120 simple_lock(&pc->pc_slock);
2121 simple_lock(&pc->pc_pool->pr_slock);
2122
2123 pool_do_cache_invalidate(pc, &pq, &pcgl);
2124
2125 simple_unlock(&pc->pc_pool->pr_slock);
2126 simple_unlock(&pc->pc_slock);
2127
2128 pr_pagelist_free(pc->pc_pool, &pq);
2129 pcg_grouplist_free(&pcgl);
2130 }
2131
2132 /*
2133 * pool_cache_reclaim:
2134 *
2135 * Reclaim a pool cache for pool_reclaim().
2136 */
2137 static void
2138 pool_cache_reclaim(struct pool_cache *pc, struct pool_pagelist *pq,
2139 struct pool_cache_grouplist *pcgl)
2140 {
2141
2142 /*
2143 * We're locking in the wrong order (normally pool_cache -> pool,
2144 * but the pool is already locked when we get here), so we have
2145 * to use trylock. If we can't lock the pool_cache, it's not really
2146 * a big deal here.
2147 */
2148 if (simple_lock_try(&pc->pc_slock) == 0)
2149 return;
2150
2151 pool_do_cache_invalidate(pc, pq, pcgl);
2152
2153 simple_unlock(&pc->pc_slock);
2154 }
2155
2156 /*
2157 * Pool backend allocators.
2158 *
2159 * Each pool has a backend allocator that handles allocation, deallocation,
2160 * and any additional draining that might be needed.
2161 *
2162 * We provide two standard allocators:
2163 *
2164 * pool_allocator_kmem - the default when no allocator is specified
2165 *
2166 * pool_allocator_nointr - used for pools that will not be accessed
2167 * in interrupt context.
2168 */
2169 void *pool_page_alloc(struct pool *, int);
2170 void pool_page_free(struct pool *, void *);
2171
2172 #ifdef POOL_SUBPAGE
2173 struct pool_allocator pool_allocator_kmem_fullpage = {
2174 pool_page_alloc, pool_page_free, 0,
2175 };
2176 #else
2177 struct pool_allocator pool_allocator_kmem = {
2178 pool_page_alloc, pool_page_free, 0,
2179 };
2180 #endif
2181
2182 void *pool_page_alloc_nointr(struct pool *, int);
2183 void pool_page_free_nointr(struct pool *, void *);
2184
2185 #ifdef POOL_SUBPAGE
2186 struct pool_allocator pool_allocator_nointr_fullpage = {
2187 pool_page_alloc_nointr, pool_page_free_nointr, 0,
2188 };
2189 #else
2190 struct pool_allocator pool_allocator_nointr = {
2191 pool_page_alloc_nointr, pool_page_free_nointr, 0,
2192 };
2193 #endif
2194
2195 #ifdef POOL_SUBPAGE
2196 void *pool_subpage_alloc(struct pool *, int);
2197 void pool_subpage_free(struct pool *, void *);
2198
2199 struct pool_allocator pool_allocator_kmem = {
2200 pool_subpage_alloc, pool_subpage_free, POOL_SUBPAGE,
2201 };
2202
2203 void *pool_subpage_alloc_nointr(struct pool *, int);
2204 void pool_subpage_free_nointr(struct pool *, void *);
2205
2206 struct pool_allocator pool_allocator_nointr = {
2207 pool_subpage_alloc, pool_subpage_free, POOL_SUBPAGE,
2208 };
2209 #endif /* POOL_SUBPAGE */
2210
2211 /*
2212 * We have at least three different resources for the same allocation and
2213 * each resource can be depleted. First, we have the ready elements in the
2214 * pool. Then we have the resource (typically a vm_map) for this allocator.
2215 * Finally, we have physical memory. Waiting for any of these can be
2216 * unnecessary when any other is freed, but the kernel doesn't support
2217 * sleeping on multiple wait channels, so we have to employ another strategy.
2218 *
2219 * The caller sleeps on the pool (so that it can be awakened when an item
2220 * is returned to the pool), but we set PA_WANT on the allocator. When a
2221 * page is returned to the allocator and PA_WANT is set, pool_allocator_free
2222 * will wake up all sleeping pools belonging to this allocator.
2223 *
2224 * XXX Thundering herd.
2225 */
2226 void *
2227 pool_allocator_alloc(struct pool *org, int flags)
2228 {
2229 struct pool_allocator *pa = org->pr_alloc;
2230 struct pool *pp, *start;
2231 int s, freed;
2232 void *res;
2233
2234 LOCK_ASSERT(!simple_lock_held(&org->pr_slock));
2235
2236 do {
2237 if ((res = (*pa->pa_alloc)(org, flags)) != NULL)
2238 return (res);
2239 if ((flags & PR_WAITOK) == 0) {
2240 /*
2241 * We only run the drain hookhere if PR_NOWAIT.
2242 * In other cases, the hook will be run in
2243 * pool_reclaim().
2244 */
2245 if (org->pr_drain_hook != NULL) {
2246 (*org->pr_drain_hook)(org->pr_drain_hook_arg,
2247 flags);
2248 if ((res = (*pa->pa_alloc)(org, flags)) != NULL)
2249 return (res);
2250 }
2251 break;
2252 }
2253
2254 /*
2255 * Drain all pools, that use this allocator.
2256 * We do this to reclaim VA space.
2257 * pa_alloc is responsible for waiting for
2258 * physical memory.
2259 *
2260 * XXX We risk looping forever if start if someone
2261 * calls pool_destroy on "start". But there is no
2262 * other way to have potentially sleeping pool_reclaim,
2263 * non-sleeping locks on pool_allocator, and some
2264 * stirring of drained pools in the allocator.
2265 *
2266 * XXX Maybe we should use pool_head_slock for locking
2267 * the allocators?
2268 */
2269 freed = 0;
2270
2271 s = splvm();
2272 simple_lock(&pa->pa_slock);
2273 pp = start = TAILQ_FIRST(&pa->pa_list);
2274 do {
2275 TAILQ_REMOVE(&pa->pa_list, pp, pr_alloc_list);
2276 TAILQ_INSERT_TAIL(&pa->pa_list, pp, pr_alloc_list);
2277 simple_unlock(&pa->pa_slock);
2278 freed = pool_reclaim(pp);
2279 simple_lock(&pa->pa_slock);
2280 } while ((pp = TAILQ_FIRST(&pa->pa_list)) != start &&
2281 freed == 0);
2282
2283 if (freed == 0) {
2284 /*
2285 * We set PA_WANT here, the caller will most likely
2286 * sleep waiting for pages (if not, this won't hurt
2287 * that much), and there is no way to set this in
2288 * the caller without violating locking order.
2289 */
2290 pa->pa_flags |= PA_WANT;
2291 }
2292 simple_unlock(&pa->pa_slock);
2293 splx(s);
2294 } while (freed);
2295 return (NULL);
2296 }
2297
2298 void
2299 pool_allocator_free(struct pool *pp, void *v)
2300 {
2301 struct pool_allocator *pa = pp->pr_alloc;
2302 int s;
2303
2304 LOCK_ASSERT(!simple_lock_held(&pp->pr_slock));
2305
2306 (*pa->pa_free)(pp, v);
2307
2308 s = splvm();
2309 simple_lock(&pa->pa_slock);
2310 if ((pa->pa_flags & PA_WANT) == 0) {
2311 simple_unlock(&pa->pa_slock);
2312 splx(s);
2313 return;
2314 }
2315
2316 TAILQ_FOREACH(pp, &pa->pa_list, pr_alloc_list) {
2317 simple_lock(&pp->pr_slock);
2318 if ((pp->pr_flags & PR_WANTED) != 0) {
2319 pp->pr_flags &= ~PR_WANTED;
2320 wakeup(pp);
2321 }
2322 simple_unlock(&pp->pr_slock);
2323 }
2324 pa->pa_flags &= ~PA_WANT;
2325 simple_unlock(&pa->pa_slock);
2326 splx(s);
2327 }
2328
2329 void *
2330 pool_page_alloc(struct pool *pp, int flags)
2331 {
2332 boolean_t waitok = (flags & PR_WAITOK) ? TRUE : FALSE;
2333
2334 return ((void *) uvm_km_alloc_poolpage_cache(kmem_map, waitok));
2335 }
2336
2337 void
2338 pool_page_free(struct pool *pp, void *v)
2339 {
2340
2341 uvm_km_free_poolpage_cache(kmem_map, (vaddr_t) v);
2342 }
2343
2344 static void *
2345 pool_page_alloc_meta(struct pool *pp, int flags)
2346 {
2347 boolean_t waitok = (flags & PR_WAITOK) ? TRUE : FALSE;
2348
2349 return ((void *) uvm_km_alloc_poolpage(kmem_map, waitok));
2350 }
2351
2352 static void
2353 pool_page_free_meta(struct pool *pp, void *v)
2354 {
2355
2356 uvm_km_free_poolpage(kmem_map, (vaddr_t) v);
2357 }
2358
2359 #ifdef POOL_SUBPAGE
2360 /* Sub-page allocator, for machines with large hardware pages. */
2361 void *
2362 pool_subpage_alloc(struct pool *pp, int flags)
2363 {
2364 void *v;
2365 int s;
2366 s = splvm();
2367 v = pool_get(&psppool, flags);
2368 splx(s);
2369 return v;
2370 }
2371
2372 void
2373 pool_subpage_free(struct pool *pp, void *v)
2374 {
2375 int s;
2376 s = splvm();
2377 pool_put(&psppool, v);
2378 splx(s);
2379 }
2380
2381 /* We don't provide a real nointr allocator. Maybe later. */
2382 void *
2383 pool_subpage_alloc_nointr(struct pool *pp, int flags)
2384 {
2385
2386 return (pool_subpage_alloc(pp, flags));
2387 }
2388
2389 void
2390 pool_subpage_free_nointr(struct pool *pp, void *v)
2391 {
2392
2393 pool_subpage_free(pp, v);
2394 }
2395 #endif /* POOL_SUBPAGE */
2396 void *
2397 pool_page_alloc_nointr(struct pool *pp, int flags)
2398 {
2399 boolean_t waitok = (flags & PR_WAITOK) ? TRUE : FALSE;
2400
2401 return ((void *) uvm_km_alloc_poolpage_cache(kernel_map, waitok));
2402 }
2403
2404 void
2405 pool_page_free_nointr(struct pool *pp, void *v)
2406 {
2407
2408 uvm_km_free_poolpage_cache(kernel_map, (vaddr_t) v);
2409 }
2410