mem.h revision 49dbdb0186eb23d87d685b96eaefa9ec3c71d9b8
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley/*
49dbdb0186eb23d87d685b96eaefa9ec3c71d9b8David Lawrence * Copyright (C) 1997-2000 Internet Software Consortium.
1633838b8255282d10af15c5c84cee5a51466712Bob Halley *
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * Permission to use, copy, modify, and distribute this software for any
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * purpose with or without fee is hereby granted, provided that the above
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * copyright notice and this permission notice appear in all copies.
1633838b8255282d10af15c5c84cee5a51466712Bob Halley *
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * SOFTWARE.
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley */
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
4cafb28abcaa2a485c7aac1696213435538b92edBob Halley#ifndef ISC_MEM_H
4cafb28abcaa2a485c7aac1696213435538b92edBob Halley#define ISC_MEM_H 1
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley#include <stdio.h>
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff#include <isc/lang.h>
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff#include <isc/mutex.h>
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff#include <isc/types.h>
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
7aacbd685b2107670e4179689abec9cb82d972abBob HalleyISC_LANG_BEGINDECLS
7aacbd685b2107670e4179689abec9cb82d972abBob Halley
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halleytypedef void * (*isc_memalloc_t)(void *, size_t);
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halleytypedef void (*isc_memfree_t)(void *, void *);
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halley
54ef500660da1f4e8d4e14e737fa81c4c881ac0aBrian Wellington#define ISC_MEM_DEBUG
54ef500660da1f4e8d4e14e737fa81c4c881ac0aBrian Wellingtonextern isc_boolean_t isc_mem_debugging;
54ef500660da1f4e8d4e14e737fa81c4c881ac0aBrian Wellington
4cafb28abcaa2a485c7aac1696213435538b92edBob Halley#ifdef ISC_MEM_DEBUG
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_get(c, s) isc__mem_getdebug(c, s, __FILE__, __LINE__)
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_put(c, p, s) isc__mem_putdebug(c, p, s, __FILE__, __LINE__)
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_allocate(c, s) isc__mem_allocatedebug(c, s, \
5f89718b7d354cb4ceb99d0dd952a4faf4597ab8David Lawrence __FILE__, __LINE__)
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_free(c, p) isc__mem_freedebug(c, p, __FILE__, __LINE__)
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_strdup(c, p) isc__mem_strdupdebug(c, p, \
5f89718b7d354cb4ceb99d0dd952a4faf4597ab8David Lawrence __FILE__, __LINE__)
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mempool_get(c) isc__mempool_getdebug(c, __FILE__, __LINE__)
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mempool_put(c, p) isc__mempool_putdebug(c, p, \
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff __FILE__, __LINE__)
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley#else
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_get isc__mem_get
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_put isc__mem_put
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_allocate isc__mem_allocate
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_free isc__mem_free
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mem_strdup isc__mem_strdup
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mempool_get isc__mempool_get
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley#define isc_mempool_put isc__mempool_put
4cafb28abcaa2a485c7aac1696213435538b92edBob Halley#endif /* ISC_MEM_DEBUG */
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
4cafb28abcaa2a485c7aac1696213435538b92edBob Halleyisc_result_t isc_mem_create(size_t, size_t, isc_mem_t **);
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halleyvoid isc_mem_attach(isc_mem_t *, isc_mem_t **);
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halleyvoid isc_mem_detach(isc_mem_t **);
4cafb28abcaa2a485c7aac1696213435538b92edBob Halleyvoid isc_mem_destroy(isc_mem_t **);
80d19f35232dfcb37a38d80fd7c0a9f755c91320James Bristerisc_result_t isc_mem_ondestroy(isc_mem_t *ctx,
80d19f35232dfcb37a38d80fd7c0a9f755c91320James Brister isc_task_t *task,
80d19f35232dfcb37a38d80fd7c0a9f755c91320James Brister isc_event_t **event);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid * isc__mem_get(isc_mem_t *, size_t);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid isc__mem_put(isc_mem_t *, void *, size_t);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid * isc__mem_getdebug(isc_mem_t *, size_t,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley const char *, int);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid isc__mem_putdebug(isc_mem_t *, void *,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley size_t, const char *, int);
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halleyisc_result_t isc_mem_preallocate(isc_mem_t *);
4cafb28abcaa2a485c7aac1696213435538b92edBob Halleyvoid isc_mem_stats(isc_mem_t *, FILE *);
4cafb28abcaa2a485c7aac1696213435538b92edBob Halleyisc_boolean_t isc_mem_valid(isc_mem_t *, void *);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid * isc__mem_allocate(isc_mem_t *, size_t);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid * isc__mem_allocatedebug(isc_mem_t *, size_t,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley const char *, int);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid isc__mem_free(isc_mem_t *, void *);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid isc__mem_freedebug(isc_mem_t *, void *,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley const char *, int);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleychar * isc__mem_strdup(isc_mem_t *, const char *);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleychar * isc__mem_strdupdebug(isc_mem_t *,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley const char *,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley const char *, int);
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halleyvoid isc_mem_setdestroycheck(isc_mem_t *,
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halley isc_boolean_t);
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halleyvoid isc_mem_setsplit(isc_mem_t *, isc_boolean_t);
e7ba6034178292131d208b279b9481ab3249aa86Bob Halleyvoid isc_mem_setquota(isc_mem_t *, size_t);
e7ba6034178292131d208b279b9481ab3249aa86Bob Halleysize_t isc_mem_getquota(isc_mem_t *);
fd3271152c6a2ff54348ae9f5369f0962fcc89b6Bob Halleysize_t isc_mem_inuse(isc_mem_t *);
de9282a1eaa50764fdc2e88046f8ff3522e3092eBob Halley
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halleyisc_result_t isc_mem_createx(size_t, size_t,
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halley isc_memalloc_t memalloc,
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halley isc_memfree_t memfree,
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halley void *arg, isc_mem_t **);
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halleyisc_result_t isc_mem_restore(isc_mem_t *);
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halley
de9282a1eaa50764fdc2e88046f8ff3522e3092eBob Halley#ifdef ISC_MEMCLUSTER_LEGACY
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley/*
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley * Legacy.
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley */
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define meminit isc__legacy_meminit
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define mem_default_context isc__legacy_mem_default_context
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley#ifdef MEMCLUSTER_DEBUG
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define memget(s) isc__legacy_memget_debug(s, __FILE__, __LINE__)
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define memput(p, s) isc__legacy_memput_debug(p, s, \
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence __FILE__, __LINE__)
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley#else
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define memget isc__legacy_memget
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define memput isc__legacy_memput
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley#endif
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define memvalid isc__legacy_memvalid
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence#define memstats isc__legacy_memstats
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halleyint meminit(size_t, size_t);
4cafb28abcaa2a485c7aac1696213435538b92edBob Halleyisc_mem_t * mem_default_context(void);
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrencevoid * isc__legacy_memget(size_t);
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrencevoid isc__legacy_memput(void *, size_t);
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrencevoid * isc__legacy_memget_debug(size_t, const char *,
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence int);
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrencevoid isc__legacy_memput_debug(void *, size_t,
6d8cdbaff46ea186ddc83ba9484f453a34645d8bDavid Lawrence const char *, int);
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halleyint memvalid(void *);
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halleyvoid memstats(FILE *);
138d22b316c7cd10eaa9df2ee0e3ec712a077153Bob Halley
de9282a1eaa50764fdc2e88046f8ff3522e3092eBob Halley#endif /* ISC_MEMCLUSTER_LEGACY */
de9282a1eaa50764fdc2e88046f8ff3522e3092eBob Halley
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff/*
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff * Memory pools
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Internal (but public) functions. Don't call these from application
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * code. Use isc_mempool_get() and isc_mempool_put() instead.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid * isc__mempool_get(isc_mempool_t *);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid isc__mempool_put(isc_mempool_t *, void *);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid * isc__mempool_getdebug(isc_mempool_t *, const char *, int);
669940866360b2e50eed04f18f58ca7fe302c8baBob Halleyvoid isc__mempool_putdebug(isc_mempool_t *, void *,
669940866360b2e50eed04f18f58ca7fe302c8baBob Halley const char *, int);
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffisc_result_t
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffisc_mempool_create(isc_mem_t *mctx, size_t size, isc_mempool_t **mpctxp);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Create a memory pool.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Requires:
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * mctx is a valid memory context.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * size > 0
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * mpctxp != NULL and *mpctxp == NULL
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Defaults:
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * maxalloc = UINT_MAX
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * freemax = 1
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * fillcount = 1
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns:
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * ISC_R_NOMEMORY -- not enough memory to create pool
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * ISC_R_SUCCESS -- all is well.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffvoid
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffisc_mempool_destroy(isc_mempool_t **mpctxp);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Destroy a memory pool.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Requires:
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff * mpctxp != NULL && *mpctxp is a valid pool.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * The pool has no un"put" allocations outstanding
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graffvoid
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrenceisc_mempool_setname(isc_mempool_t *mpctx, const char *name);
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff/*
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff * Associate a name with a memory pool. At most 15 characters may be used.
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff *
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff * Requires:
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff * mpctx is a valid pool.
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff * name != NULL;
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff */
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffvoid
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffisc_mempool_associatelock(isc_mempool_t *mpctx, isc_mutex_t *lock);
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff/*
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * Associate a lock with this memory pool.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * This lock is used when getting or putting items using this memory pool,
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * and it is also used to set or get internal state via the isc_mempool_get*()
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * and isc_mempool_set*() set of functions.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * Mutiple pools can each share a single lock. For instance, if "manager"
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * type object contained pools for various sizes of events, and each of
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * these pools used a common lock. Note that this lock must NEVER be used
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * by other than mempool routines once it is given to a pool, since that can
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * easily cause double locking.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * Requires:
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * mpctpx is a valid pool.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * lock != NULL.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * No previous lock is assigned to this pool.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff *
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * The lock is initialized before calling this function via the normal
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * means of doing that.
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * The following functions get/set various parameters. Note that due to
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * the unlocked nature of pools these are potentially random values unless
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * the imposed externally provided locking protocols are followed.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Also note that the quota limits will not always take immediate effect.
0fd03d2a66102f8d9bd7acea4e7db73ecaa0cb52Michael Graff * For instance, setting "maxalloc" to a number smaller than the currently
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * allocated count is permitted. New allocations will be refused until
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * the count drops below this threshold.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * All functions require (in addition to other requirements):
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * mpctx is a valid memory pool
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceunsigned int
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getfreemax(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the maximum allowed size of the free list.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrencevoid
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_setfreemax(isc_mempool_t *mpctx, unsigned int limit);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Sets the maximum allowed size of the free list.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceunsigned int
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getfreecount(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns current size of the free list.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceunsigned int
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getmaxalloc(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the maximum allowed number of allocations.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrencevoid
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_setmaxalloc(isc_mempool_t *mpctx, unsigned int limit);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Sets the maximum allowed number of allocations.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Additional requirements:
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * limit > 0
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceunsigned int
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getallocated(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the number of items allocated from this pool.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceunsigned int
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getfillcount(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the number of items allocated as a block from the parent memory
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * context when the free list is empty.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrencevoid
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_setfillcount(isc_mempool_t *mpctx, unsigned int limit);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff/*
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Sets the fillcount.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff *
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Additional requirements:
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * limit > 0
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff */
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff
7aacbd685b2107670e4179689abec9cb82d972abBob HalleyISC_LANG_ENDDECLS
7aacbd685b2107670e4179689abec9cb82d972abBob Halley
54a2e7e8a21ee765f41bd995101995613bff9e8cDavid Lawrence#endif /* ISC_MEM_H */