mem.h revision 1425217e5c3a2cbab7f8344e600e0c16047289ff
69fe9aaafdd6a141610e86a777d325db75422070Mark Andrews * Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington * Copyright (C) 1997-2001 Internet Software Consortium.
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.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * PERFORMANCE OF THIS SOFTWARE.
1425217e5c3a2cbab7f8344e600e0c16047289ffMark Andrews/* $Id: mem.h,v 1.66 2005/10/26 04:35:55 marka Exp $ */
3a34b87c878990c6303358efd22265c2c5980c65Mark Andrewstypedef void (*isc_mem_water_t)(void *, int);
ac70da9a2710aa9f343d2f720eb1bdd4191a79caBob Halleytypedef void (*isc_memfree_t)(void *, void *);
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * Define ISC_MEM_DEBUG=1 to make all functions that free memory
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * set the pointer being freed to NULL after being freed.
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * This is the default; set ISC_MEM_DEBUG=0 to disable it.
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * Define ISC_MEM_TRACKLINES=1 to turn on detailed tracing of memory
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * allocation and freeing by file and line number.
c52e5c8ed1e2a3a90b912d3e4cb5da9dc32d85f7Andreas Gustafsson * Define ISC_MEM_CHECKOVERRUN=1 to turn on checks for using memory outside
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff * the requested space. This will increase the size of each allocation.
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * Define ISC_MEM_FILL=1 to fill each block of memory returned to the system
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff * with the byte string '0xbe'. This helps track down uninitialized pointers
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff * and the like. On freeing memory, the space is filled with '0xde' for
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff * the same reasons.
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * Define ISC_MEMPOOL_NAMES=1 to make memory pools store a symbolic
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * name so that the leaking pool can be more readily identified in
18159f6f6053de21e433f2194ca4f89b96926c09Andreas Gustafsson * case of a memory leak.
c4958494a98a59ce25e9fecad76a9ab0e36cc59fDanny MayerLIBISC_EXTERNAL_DATA extern unsigned int isc_mem_debugging;
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * The variable isc_mem_debugging holds a set of flags for
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * turning certain memory debugging options on or off at
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * runtime. Its is intialized to the value ISC_MEM_DEGBUGGING,
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * which is 0 by default but may be overridden at compile time.
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * The following flags can be specified:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_MEM_DEBUGTRACE
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * Log each allocation and free to isc_lctx.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_MEM_DEBUGRECORD
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * Remember each allocation, and match them up on free.
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * Crash if a free doesn't match an allocation.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_MEM_DEBUGUSAGE
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * If a hi_water mark is set, print the maximium inuse memory
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson * every time it is raised once it exceeds the hi_water mark.
d4d68515d23668cfe804ab2a174a7e427decedd8Mark Andrews * \li #ISC_MEM_DEBUGSIZE
1425217e5c3a2cbab7f8344e600e0c16047289ffMark Andrews * Check the size argument being passed to isc_mem_put() matches
d4d68515d23668cfe804ab2a174a7e427decedd8Mark Andrews * that passed to isc_mem_get().
d4d68515d23668cfe804ab2a174a7e427decedd8Mark Andrews * \li #ISC_MEM_DEBUGCTX
1425217e5c3a2cbab7f8344e600e0c16047289ffMark Andrews * Check the mctx argument being passed to isc_mem_put() matches
d4d68515d23668cfe804ab2a174a7e427decedd8Mark Andrews * that passed to isc_mem_get().
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define _ISC_MEM_FLARG , const char *, int
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * Define ISC_MEM_USE_INTERNAL_MALLOC=1 to use the internal malloc()
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * implementation in preference to the system one. The internal malloc()
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * is very space-efficient, and quite fast on uniprocessor systems. It
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * performs poorly on multiprocessor machines.
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * JT: we can overcome the performance issue on multiprocessor machines
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * by carefully separating memory contexts.
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 * Flags for isc_mem_create2()calls.
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉#define ISC_MEMFLAG_NOLOCK 0x00000001 /* no lock is necessary */
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews#define ISC_MEMFLAG_INTERNAL 0x00000002 /* use internal malloc */
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews#define ISC_MEMFLAG_DEFAULT ISC_MEMFLAG_INTERNAL
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mem_get(c, s) isc__mem_get((c), (s) _ISC_MEM_FILELINE)
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mem_allocate(c, s) isc__mem_allocate((c), (s) _ISC_MEM_FILELINE)
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mem_strdup(c, p) isc__mem_strdup((c), (p) _ISC_MEM_FILELINE)
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mempool_get(c) isc__mempool_get((c) _ISC_MEM_FILELINE)
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_putanddetach() is a convienence function for use where you
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * have a structure with an attached memory context.
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_t *mctx;
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_t *mctx;
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_putanddetach(&ptr->mctx, ptr, sizeof(*ptr));
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * is the equivalent of:
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * mctx = NULL;
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_attach(ptr->mctx, &mctx);
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_detach(&ptr->mctx);
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_put(mctx, ptr, sizeof(*ptr));
6c6bed90cb5b51a90530b7d488b2696626a8fafcMark Andrews * isc_mem_detach(&mctx);
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mem_put(c, p, s) \
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff isc__mem_put((c), (p), (s) _ISC_MEM_FILELINE); \
1162a4e02a6594dbb4f57fd288a5d20ab467e4d7Mark Andrews#define isc_mem_putanddetach(c, p, s) \
1162a4e02a6594dbb4f57fd288a5d20ab467e4d7Mark Andrews isc__mem_putanddetach((c), (p), (s) _ISC_MEM_FILELINE); \
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff isc__mempool_put((c), (p) _ISC_MEM_FILELINE); \
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mem_put(c, p, s) isc__mem_put((c), (p), (s) _ISC_MEM_FILELINE)
1162a4e02a6594dbb4f57fd288a5d20ab467e4d7Mark Andrews#define isc_mem_putanddetach(c, p, s) \
1162a4e02a6594dbb4f57fd288a5d20ab467e4d7Mark Andrews isc__mem_putanddetach((c), (p), (s) _ISC_MEM_FILELINE)
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mem_free(c, p) isc__mem_free((c), (p) _ISC_MEM_FILELINE)
bfab56849df65a2d4295b256808a66985cfa9d98Michael Graff#define isc_mempool_put(c, p) isc__mempool_put((c), (p) _ISC_MEM_FILELINE)
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc_mem_create(size_t max_size, size_t target_size,
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉isc_mem_create2(size_t max_size, size_t target_size,
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc_mem_createx(size_t max_size, size_t target_size,
6d858e75d4f411e89485ec702ce1e118e1ead53cAndreas Gustafsson isc_memalloc_t memalloc, isc_memfree_t memfree,
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉isc_mem_createx2(size_t max_size, size_t target_size,
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 isc_memalloc_t memalloc, isc_memfree_t memfree,
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 void *arg, isc_mem_t **mctxp, unsigned int flags);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \brief Create a memory context.
1d625775ee265ec4d5237ae3a315789ad0957bd5Andreas Gustafsson * 'max_size' and 'target_size' are tuning parameters. When
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * ISC_MEMFLAG_INTERNAL is set, allocations smaller than 'max_size'
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * will be satisfied by getting blocks of size 'target_size' from the
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * system allocator and breaking them up into pieces; larger allocations
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * will use the system allocator directly. If 'max_size' and/or
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * 'target_size' are zero, default values will be * used. When
016c0a82f1ce3fe4d362d7c9cf8de4377ffaf5a9Mark Andrews * ISC_MEMFLAG_INTERNAL is not set, 'target_size' is ignored.
e0806ab5eda9add79044ccf17e55c49bae35d2e2Mark Andrews * 'max_size' is also used to size the statistics arrays and the array
e0806ab5eda9add79044ccf17e55c49bae35d2e2Mark Andrews * used to record active memory when ISC_MEM_DEBUGRECORD is set. Settin
e0806ab5eda9add79044ccf17e55c49bae35d2e2Mark Andrews * 'max_size' too low can have detrimental effects on performance.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * A memory context created using isc_mem_createx() will obtain
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * memory from the system by calling 'memalloc' and 'memfree',
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * passing them the argument 'arg'. A memory context created
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * using isc_mem_create() will use the standard library malloc()
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 * If ISC_MEMFLAG_NOLOCK is set in 'flags', the corresponding memory context
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 * will be accessed without locking. The user who creates the context must
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 * ensure there be no race. Since this can be a source of bug, it is generally
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 * inadvisable to use this flag unless the user is very sure about the race
5597be9bb88de138dfec9fa9176708443813925eTatuya JINMEI 神明達哉 * condition and the access to the object is highly performance sensitive.
1d625775ee265ec4d5237ae3a315789ad0957bd5Andreas Gustafsson * mctxp != NULL && *mctxp == NULL */
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \brief Attach to / detach from a memory context.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * This is intended for applications that use multiple memory contexts
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * in such a way that it is not obvious when the last allocations from
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * a given context has been freed and destroying the context is safe.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Most applications do not need to call these functions as they can
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * simply create a single memory context at the beginning of main()
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * and destroy it at the end of main(), thereby guaranteeing that it
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * is not destroyed while there are outstanding allocations.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Destroy a memory context.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Request to be notified with an event when a memory context has
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * been successfully destroyed.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Print memory usage statistics for 'mctx' on the stream 'out'.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * If 'on' is ISC_TRUE, 'mctx' will check for memory leaks when
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * destroyed and abort the program if any are present.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Set/get the memory quota of 'mctx'. This is a hard limit
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * on the amount of memory that may be allocated from mctx;
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * if it is exceeded, allocations will fail.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Get an estimate of the number of memory in use in 'mctx', in bytes.
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * This includes quantization overhead, but does not include memory
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * allocated from the system but not yet used.
3a34b87c878990c6303358efd22265c2c5980c65Mark Andrewsisc_mem_setwater(isc_mem_t *mctx, isc_mem_water_t water, void *water_arg,
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * Set high and low water marks for this memory context.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * When the memory
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * usage of 'mctx' exceeds 'hiwater', '(water)(water_arg, #ISC_MEM_HIWATER)'
3a34b87c878990c6303358efd22265c2c5980c65Mark Andrews * will be called. When the usage drops below 'lowater', 'water' will
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * again be called, this time with #ISC_MEM_LOWATER.
65640f401a22971de16c01e9a9547d95c55ed45eDavid Lawrence * If 'water' is NULL then 'water_arg', 'hi_water' and 'lo_water' are
65640f401a22971de16c01e9a9547d95c55ed45eDavid Lawrence * ignored and the state is reset.
65640f401a22971de16c01e9a9547d95c55ed45eDavid Lawrence * 'water' is not NULL.
65640f401a22971de16c01e9a9547d95c55ed45eDavid Lawrence * hi_water >= lo_water
eb7ef395d27b1104f684e21836f200c052736d07Michael Graff * Memory pools
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffisc_mempool_create(isc_mem_t *mctx, size_t size, isc_mempool_t **mpctxp);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Create a memory pool.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li mctx is a valid memory context.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li size > 0
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li mpctxp != NULL and *mpctxp == NULL
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li maxalloc = UINT_MAX
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li freemax = 1
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li fillcount = 1
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li #ISC_R_NOMEMORY -- not enough memory to create pool
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li #ISC_R_SUCCESS -- all is well.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Destroy a memory pool.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li mpctxp != NULL && *mpctxp is a valid pool.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li The pool has no un"put" allocations outstanding
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrenceisc_mempool_setname(isc_mempool_t *mpctx, const char *name);
78b2f25c9afee0d16f2e75882d9763abcb0872e5Michael Graff * Associate a name with a memory pool. At most 15 characters may be used.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li mpctx is a valid pool.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li name != NULL;
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graffisc_mempool_associatelock(isc_mempool_t *mpctx, isc_mutex_t *lock);
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * Associate a lock with this memory pool.
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 * 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.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li mpctpx is a valid pool.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li lock != NULL.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li No previous lock is assigned to this pool.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li The lock is initialized before calling this function via the normal
50dfb7ee4ada4c9aa30bd18c1b5d9b04be765669Michael Graff * means of doing that.
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 * 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 * All functions require (in addition to other requirements):
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * mpctx is a valid memory pool
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the maximum allowed size of the free list.
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_setfreemax(isc_mempool_t *mpctx, unsigned int limit);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Sets the maximum allowed size of the free list.
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getfreecount(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns current size of the free list.
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getmaxalloc(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the maximum allowed number of allocations.
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_setmaxalloc(isc_mempool_t *mpctx, unsigned int limit);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Sets the maximum allowed number of allocations.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Additional requirements:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li limit > 0
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getallocated(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the number of items allocated from this pool.
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_getfillcount(isc_mempool_t *mpctx);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Returns the number of items allocated as a block from the parent memory
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * context when the free list is empty.
c7f22f83aac9e61dafee191cad040e9c42652cc8David Lawrenceisc_mempool_setfillcount(isc_mempool_t *mpctx, unsigned int limit);
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Sets the fillcount.
f28a94af2179ff7592d732e409d006582e9af7c3Michael Graff * Additional requirements:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *\li limit > 0
c674a8d5e7d202ada2bb617e5bb98b1859dc5a62Andreas Gustafsson * Pseudo-private functions for use via macros. Do not call directly.
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mem_get(isc_mem_t *, size_t _ISC_MEM_FLARG);
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mem_put(isc_mem_t *, void *, size_t _ISC_MEM_FLARG);
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mem_allocate(isc_mem_t *, size_t _ISC_MEM_FLARG);
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mem_free(isc_mem_t *, void * _ISC_MEM_FLARG);
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mem_strdup(isc_mem_t *, const char *_ISC_MEM_FLARG);
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mempool_get(isc_mempool_t * _ISC_MEM_FLARG);
8096fe1df5abfef957b934a1d1c5e97eaa246434Danny Mayerisc__mempool_put(isc_mempool_t *, void * _ISC_MEM_FLARG);
54a2e7e8a21ee765f41bd995101995613bff9e8cDavid Lawrence#endif /* ISC_MEM_H */