]> CyberLeo.Net >> Repos - FreeBSD/stable/8.git/blob - contrib/bind9/lib/isc/include/isc/mem.h
Update to version 9.6-ESV-R6, the latest from ISC, which contains numerous
[FreeBSD/stable/8.git] / contrib / bind9 / lib / isc / include / isc / mem.h
1 /*
2  * Copyright (C) 2004-2010, 2012  Internet Systems Consortium, Inc. ("ISC")
3  * Copyright (C) 1997-2001  Internet Software Consortium.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15  * PERFORMANCE OF THIS SOFTWARE.
16  */
17
18 /* $Id$ */
19
20 #ifndef ISC_MEM_H
21 #define ISC_MEM_H 1
22
23 /*! \file isc/mem.h */
24
25 #include <stdio.h>
26
27 #include <isc/lang.h>
28 #include <isc/mutex.h>
29 #include <isc/platform.h>
30 #include <isc/types.h>
31 #include <isc/xml.h>
32
33 ISC_LANG_BEGINDECLS
34
35 #define ISC_MEM_LOWATER 0
36 #define ISC_MEM_HIWATER 1
37 typedef void (*isc_mem_water_t)(void *, int);
38
39 typedef void * (*isc_memalloc_t)(void *, size_t);
40 typedef void (*isc_memfree_t)(void *, void *);
41
42 /*%
43  * Define ISC_MEM_DEBUG=1 to make all functions that free memory
44  * set the pointer being freed to NULL after being freed.
45  * This is the default; set ISC_MEM_DEBUG=0 to disable it.
46  */
47 #ifndef ISC_MEM_DEBUG
48 #define ISC_MEM_DEBUG 1
49 #endif
50
51 /*%
52  * Define ISC_MEM_TRACKLINES=1 to turn on detailed tracing of memory
53  * allocation and freeing by file and line number.
54  */
55 #ifndef ISC_MEM_TRACKLINES
56 #define ISC_MEM_TRACKLINES 1
57 #endif
58
59 /*%
60  * Define ISC_MEM_CHECKOVERRUN=1 to turn on checks for using memory outside
61  * the requested space.  This will increase the size of each allocation.
62  */
63 #ifndef ISC_MEM_CHECKOVERRUN
64 #define ISC_MEM_CHECKOVERRUN 1
65 #endif
66
67 /*%
68  * Define ISC_MEM_FILL=1 to fill each block of memory returned to the system
69  * with the byte string '0xbe'.  This helps track down uninitialized pointers
70  * and the like.  On freeing memory, the space is filled with '0xde' for
71  * the same reasons.
72  */
73 #ifndef ISC_MEM_FILL
74 #define ISC_MEM_FILL 1
75 #endif
76
77 /*%
78  * Define ISC_MEMPOOL_NAMES=1 to make memory pools store a symbolic
79  * name so that the leaking pool can be more readily identified in
80  * case of a memory leak.
81  */
82 #ifndef ISC_MEMPOOL_NAMES
83 #define ISC_MEMPOOL_NAMES 1
84 #endif
85
86 LIBISC_EXTERNAL_DATA extern unsigned int isc_mem_debugging;
87 /*@{*/
88 #define ISC_MEM_DEBUGTRACE              0x00000001U
89 #define ISC_MEM_DEBUGRECORD             0x00000002U
90 #define ISC_MEM_DEBUGUSAGE              0x00000004U
91 #define ISC_MEM_DEBUGSIZE               0x00000008U
92 #define ISC_MEM_DEBUGCTX                0x00000010U
93 #define ISC_MEM_DEBUGALL                0x0000001FU
94 /*!<
95  * The variable isc_mem_debugging holds a set of flags for
96  * turning certain memory debugging options on or off at
97  * runtime.  It is initialized to the value ISC_MEM_DEGBUGGING,
98  * which is 0 by default but may be overridden at compile time.
99  * The following flags can be specified:
100  *
101  * \li #ISC_MEM_DEBUGTRACE
102  *      Log each allocation and free to isc_lctx.
103  *
104  * \li #ISC_MEM_DEBUGRECORD
105  *      Remember each allocation, and match them up on free.
106  *      Crash if a free doesn't match an allocation.
107  *
108  * \li #ISC_MEM_DEBUGUSAGE
109  *      If a hi_water mark is set, print the maximum inuse memory
110  *      every time it is raised once it exceeds the hi_water mark.
111  *
112  * \li #ISC_MEM_DEBUGSIZE
113  *      Check the size argument being passed to isc_mem_put() matches
114  *      that passed to isc_mem_get().
115  *
116  * \li #ISC_MEM_DEBUGCTX
117  *      Check the mctx argument being passed to isc_mem_put() matches
118  *      that passed to isc_mem_get().
119  */
120 /*@}*/
121
122 #if ISC_MEM_TRACKLINES
123 #define _ISC_MEM_FILELINE       , __FILE__, __LINE__
124 #define _ISC_MEM_FLARG          , const char *, unsigned int
125 #else
126 #define _ISC_MEM_FILELINE
127 #define _ISC_MEM_FLARG
128 #endif
129
130 /*!
131  * Define ISC_MEM_USE_INTERNAL_MALLOC=1 to use the internal malloc()
132  * implementation in preference to the system one.  The internal malloc()
133  * is very space-efficient, and quite fast on uniprocessor systems.  It
134  * performs poorly on multiprocessor machines.
135  * JT: we can overcome the performance issue on multiprocessor machines
136  * by carefully separating memory contexts.
137  */
138
139 #ifndef ISC_MEM_USE_INTERNAL_MALLOC
140 #define ISC_MEM_USE_INTERNAL_MALLOC 1
141 #endif
142
143 /*
144  * Flags for isc_mem_create2()calls.
145  */
146 #define ISC_MEMFLAG_NOLOCK      0x00000001       /* no lock is necessary */
147 #define ISC_MEMFLAG_INTERNAL    0x00000002       /* use internal malloc */
148 #if ISC_MEM_USE_INTERNAL_MALLOC
149 #define ISC_MEMFLAG_DEFAULT     ISC_MEMFLAG_INTERNAL
150 #else
151 #define ISC_MEMFLAG_DEFAULT     0
152 #endif
153
154
155 #define isc_mem_get(c, s)       isc__mem_get((c), (s) _ISC_MEM_FILELINE)
156 #define isc_mem_allocate(c, s)  isc__mem_allocate((c), (s) _ISC_MEM_FILELINE)
157 #define isc_mem_reallocate(c, p, s) isc__mem_reallocate((c), (p), (s) _ISC_MEM_FILELINE)
158 #define isc_mem_strdup(c, p)    isc__mem_strdup((c), (p) _ISC_MEM_FILELINE)
159 #define isc_mempool_get(c)      isc__mempool_get((c) _ISC_MEM_FILELINE)
160
161 /*%
162  * isc_mem_putanddetach() is a convenience function for use where you
163  * have a structure with an attached memory context.
164  *
165  * Given:
166  *
167  * \code
168  * struct {
169  *      ...
170  *      isc_mem_t *mctx;
171  *      ...
172  * } *ptr;
173  *
174  * isc_mem_t *mctx;
175  *
176  * isc_mem_putanddetach(&ptr->mctx, ptr, sizeof(*ptr));
177  * \endcode
178  *
179  * is the equivalent of:
180  *
181  * \code
182  * mctx = NULL;
183  * isc_mem_attach(ptr->mctx, &mctx);
184  * isc_mem_detach(&ptr->mctx);
185  * isc_mem_put(mctx, ptr, sizeof(*ptr));
186  * isc_mem_detach(&mctx);
187  * \endcode
188  */
189
190 #if ISC_MEM_DEBUG
191 #define isc_mem_put(c, p, s) \
192         do { \
193                 isc__mem_put((c), (p), (s) _ISC_MEM_FILELINE); \
194                 (p) = NULL; \
195         } while (0)
196 #define isc_mem_putanddetach(c, p, s) \
197         do { \
198                 isc__mem_putanddetach((c), (p), (s) _ISC_MEM_FILELINE); \
199                 (p) = NULL; \
200         } while (0)
201 #define isc_mem_free(c, p) \
202         do { \
203                 isc__mem_free((c), (p) _ISC_MEM_FILELINE); \
204                 (p) = NULL; \
205         } while (0)
206 #define isc_mempool_put(c, p) \
207         do { \
208                 isc__mempool_put((c), (p) _ISC_MEM_FILELINE); \
209                 (p) = NULL; \
210         } while (0)
211 #else
212 #define isc_mem_put(c, p, s)    isc__mem_put((c), (p), (s) _ISC_MEM_FILELINE)
213 #define isc_mem_putanddetach(c, p, s) \
214         isc__mem_putanddetach((c), (p), (s) _ISC_MEM_FILELINE)
215 #define isc_mem_free(c, p)      isc__mem_free((c), (p) _ISC_MEM_FILELINE)
216 #define isc_mempool_put(c, p)   isc__mempool_put((c), (p) _ISC_MEM_FILELINE)
217 #endif
218
219 /*@{*/
220 isc_result_t
221 isc_mem_create(size_t max_size, size_t target_size,
222                isc_mem_t **mctxp);
223
224 isc_result_t
225 isc_mem_create2(size_t max_size, size_t target_size,
226                 isc_mem_t **mctxp, unsigned int flags);
227
228 isc_result_t
229 isc_mem_createx(size_t max_size, size_t target_size,
230                 isc_memalloc_t memalloc, isc_memfree_t memfree,
231                 void *arg, isc_mem_t **mctxp);
232
233 isc_result_t
234 isc_mem_createx2(size_t max_size, size_t target_size,
235                  isc_memalloc_t memalloc, isc_memfree_t memfree,
236                  void *arg, isc_mem_t **mctxp, unsigned int flags);
237
238 /*!<
239  * \brief Create a memory context.
240  *
241  * 'max_size' and 'target_size' are tuning parameters.  When
242  * ISC_MEMFLAG_INTERNAL is set, allocations smaller than 'max_size'
243  * will be satisfied by getting blocks of size 'target_size' from the
244  * system allocator and breaking them up into pieces; larger allocations
245  * will use the system allocator directly. If 'max_size' and/or
246  * 'target_size' are zero, default values will be * used.  When
247  * ISC_MEMFLAG_INTERNAL is not set, 'target_size' is ignored.
248  *
249  * 'max_size' is also used to size the statistics arrays and the array
250  * used to record active memory when ISC_MEM_DEBUGRECORD is set.  Settin
251  * 'max_size' too low can have detrimental effects on performance.
252  *
253  * A memory context created using isc_mem_createx() will obtain
254  * memory from the system by calling 'memalloc' and 'memfree',
255  * passing them the argument 'arg'.  A memory context created
256  * using isc_mem_create() will use the standard library malloc()
257  * and free().
258  *
259  * If ISC_MEMFLAG_NOLOCK is set in 'flags', the corresponding memory context
260  * will be accessed without locking.  The user who creates the context must
261  * ensure there be no race.  Since this can be a source of bug, it is generally
262  * inadvisable to use this flag unless the user is very sure about the race
263  * condition and the access to the object is highly performance sensitive.
264  *
265  * Requires:
266  * mctxp != NULL && *mctxp == NULL */
267 /*@}*/
268
269 /*@{*/
270 void
271 isc_mem_attach(isc_mem_t *, isc_mem_t **);
272 void
273 isc_mem_detach(isc_mem_t **);
274 /*!<
275  * \brief Attach to / detach from a memory context.
276  *
277  * This is intended for applications that use multiple memory contexts
278  * in such a way that it is not obvious when the last allocations from
279  * a given context has been freed and destroying the context is safe.
280  *
281  * Most applications do not need to call these functions as they can
282  * simply create a single memory context at the beginning of main()
283  * and destroy it at the end of main(), thereby guaranteeing that it
284  * is not destroyed while there are outstanding allocations.
285  */
286 /*@}*/
287
288 void
289 isc_mem_destroy(isc_mem_t **);
290 /*%<
291  * Destroy a memory context.
292  */
293
294 isc_result_t
295 isc_mem_ondestroy(isc_mem_t *ctx,
296                   isc_task_t *task,
297                   isc_event_t **event);
298 /*%<
299  * Request to be notified with an event when a memory context has
300  * been successfully destroyed.
301  */
302
303 void
304 isc_mem_stats(isc_mem_t *mctx, FILE *out);
305 /*%<
306  * Print memory usage statistics for 'mctx' on the stream 'out'.
307  */
308
309 void
310 isc_mem_setdestroycheck(isc_mem_t *mctx,
311                         isc_boolean_t on);
312 /*%<
313  * If 'on' is ISC_TRUE, 'mctx' will check for memory leaks when
314  * destroyed and abort the program if any are present.
315  */
316
317 /*@{*/
318 void
319 isc_mem_setquota(isc_mem_t *, size_t);
320 size_t
321 isc_mem_getquota(isc_mem_t *);
322 /*%<
323  * Set/get the memory quota of 'mctx'.  This is a hard limit
324  * on the amount of memory that may be allocated from mctx;
325  * if it is exceeded, allocations will fail.
326  */
327 /*@}*/
328
329 size_t
330 isc_mem_inuse(isc_mem_t *mctx);
331 /*%<
332  * Get an estimate of the number of memory in use in 'mctx', in bytes.
333  * This includes quantization overhead, but does not include memory
334  * allocated from the system but not yet used.
335  */
336
337 isc_boolean_t
338 isc_mem_isovermem(isc_mem_t *mctx);
339 /*%<
340  * Return true iff the memory context is in "over memory" state, i.e.,
341  * a hiwater mark has been set and the used amount of memory has exceeds
342  * the mark.
343  */
344
345 void
346 isc_mem_setwater(isc_mem_t *mctx, isc_mem_water_t water, void *water_arg,
347                  size_t hiwater, size_t lowater);
348 /*%<
349  * Set high and low water marks for this memory context.
350  *
351  * When the memory usage of 'mctx' exceeds 'hiwater',
352  * '(water)(water_arg, #ISC_MEM_HIWATER)' will be called.  'water' needs to
353  * call isc_mem_waterack() with #ISC_MEM_HIWATER to acknowledge the state
354  * change.  'water' may be called multiple times.
355  *
356  * When the usage drops below 'lowater', 'water' will again be called, this
357  * time with #ISC_MEM_LOWATER.  'water' need to calls isc_mem_waterack() with
358  * #ISC_MEM_LOWATER to acknowledge the change.
359  *
360  *      static void
361  *      water(void *arg, int mark) {
362  *              struct foo *foo = arg;
363  *
364  *              LOCK(&foo->marklock);
365  *              if (foo->mark != mark) {
366  *                      foo->mark = mark;
367  *                      ....
368  *                      isc_mem_waterack(foo->mctx, mark);
369  *              }
370  *              UNLOCK(&foo->marklock);
371  *      }
372  *
373  * If 'water' is NULL then 'water_arg', 'hi_water' and 'lo_water' are
374  * ignored and the state is reset.
375  *
376  * Requires:
377  *
378  *      'water' is not NULL.
379  *      hi_water >= lo_water
380  */
381
382 void
383 isc_mem_waterack(isc_mem_t *ctx, int mark);
384 /*%<
385  * Called to acknowledge changes in signaled by calls to 'water'.
386  */
387
388 void
389 isc_mem_printactive(isc_mem_t *mctx, FILE *file);
390 /*%<
391  * Print to 'file' all active memory in 'mctx'.
392  *
393  * Requires ISC_MEM_DEBUGRECORD to have been set.
394  */
395
396 void
397 isc_mem_printallactive(FILE *file);
398 /*%<
399  * Print to 'file' all active memory in all contexts.
400  *
401  * Requires ISC_MEM_DEBUGRECORD to have been set.
402  */
403
404 void
405 isc_mem_checkdestroyed(FILE *file);
406 /*%<
407  * Check that all memory contexts have been destroyed.
408  * Prints out those that have not been.
409  * Fatally fails if there are still active contexts.
410  */
411
412 unsigned int
413 isc_mem_references(isc_mem_t *ctx);
414 /*%<
415  * Return the current reference count.
416  */
417
418 void
419 isc_mem_setname(isc_mem_t *ctx, const char *name, void *tag);
420 /*%<
421  * Name 'ctx'.
422  *
423  * Notes:
424  *
425  *\li   Only the first 15 characters of 'name' will be copied.
426  *
427  *\li   'tag' is for debugging purposes only.
428  *
429  * Requires:
430  *
431  *\li   'ctx' is a valid ctx.
432  */
433
434 const char *
435 isc_mem_getname(isc_mem_t *ctx);
436 /*%<
437  * Get the name of 'ctx', as previously set using isc_mem_setname().
438  *
439  * Requires:
440  *\li   'ctx' is a valid ctx.
441  *
442  * Returns:
443  *\li   A non-NULL pointer to a null-terminated string.
444  *      If the ctx has not been named, the string is
445  *      empty.
446  */
447
448 void *
449 isc_mem_gettag(isc_mem_t *ctx);
450 /*%<
451  * Get the tag value for  'task', as previously set using isc_mem_setname().
452  *
453  * Requires:
454  *\li   'ctx' is a valid ctx.
455  *
456  * Notes:
457  *\li   This function is for debugging purposes only.
458  *
459  * Requires:
460  *\li   'ctx' is a valid task.
461  */
462
463 #ifdef HAVE_LIBXML2
464 void
465 isc_mem_renderxml(xmlTextWriterPtr writer);
466 /*%<
467  * Render all contexts' statistics and status in XML for writer.
468  */
469 #endif /* HAVE_LIBXML2 */
470
471 /*
472  * Memory pools
473  */
474
475 isc_result_t
476 isc_mempool_create(isc_mem_t *mctx, size_t size, isc_mempool_t **mpctxp);
477 /*%<
478  * Create a memory pool.
479  *
480  * Requires:
481  *\li   mctx is a valid memory context.
482  *\li   size > 0
483  *\li   mpctxp != NULL and *mpctxp == NULL
484  *
485  * Defaults:
486  *\li   maxalloc = UINT_MAX
487  *\li   freemax = 1
488  *\li   fillcount = 1
489  *
490  * Returns:
491  *\li   #ISC_R_NOMEMORY         -- not enough memory to create pool
492  *\li   #ISC_R_SUCCESS          -- all is well.
493  */
494
495 void
496 isc_mempool_destroy(isc_mempool_t **mpctxp);
497 /*%<
498  * Destroy a memory pool.
499  *
500  * Requires:
501  *\li   mpctxp != NULL && *mpctxp is a valid pool.
502  *\li   The pool has no un"put" allocations outstanding
503  */
504
505 void
506 isc_mempool_setname(isc_mempool_t *mpctx, const char *name);
507 /*%<
508  * Associate a name with a memory pool.  At most 15 characters may be used.
509  *
510  * Requires:
511  *\li   mpctx is a valid pool.
512  *\li   name != NULL;
513  */
514
515 void
516 isc_mempool_associatelock(isc_mempool_t *mpctx, isc_mutex_t *lock);
517 /*%<
518  * Associate a lock with this memory pool.
519  *
520  * This lock is used when getting or putting items using this memory pool,
521  * and it is also used to set or get internal state via the isc_mempool_get*()
522  * and isc_mempool_set*() set of functions.
523  *
524  * Multiple pools can each share a single lock.  For instance, if "manager"
525  * type object contained pools for various sizes of events, and each of
526  * these pools used a common lock.  Note that this lock must NEVER be used
527  * by other than mempool routines once it is given to a pool, since that can
528  * easily cause double locking.
529  *
530  * Requires:
531  *
532  *\li   mpctpx is a valid pool.
533  *
534  *\li   lock != NULL.
535  *
536  *\li   No previous lock is assigned to this pool.
537  *
538  *\li   The lock is initialized before calling this function via the normal
539  *      means of doing that.
540  */
541
542 /*
543  * The following functions get/set various parameters.  Note that due to
544  * the unlocked nature of pools these are potentially random values unless
545  * the imposed externally provided locking protocols are followed.
546  *
547  * Also note that the quota limits will not always take immediate effect.
548  * For instance, setting "maxalloc" to a number smaller than the currently
549  * allocated count is permitted.  New allocations will be refused until
550  * the count drops below this threshold.
551  *
552  * All functions require (in addition to other requirements):
553  *      mpctx is a valid memory pool
554  */
555
556 unsigned int
557 isc_mempool_getfreemax(isc_mempool_t *mpctx);
558 /*%<
559  * Returns the maximum allowed size of the free list.
560  */
561
562 void
563 isc_mempool_setfreemax(isc_mempool_t *mpctx, unsigned int limit);
564 /*%<
565  * Sets the maximum allowed size of the free list.
566  */
567
568 unsigned int
569 isc_mempool_getfreecount(isc_mempool_t *mpctx);
570 /*%<
571  * Returns current size of the free list.
572  */
573
574 unsigned int
575 isc_mempool_getmaxalloc(isc_mempool_t *mpctx);
576 /*!<
577  * Returns the maximum allowed number of allocations.
578  */
579
580 void
581 isc_mempool_setmaxalloc(isc_mempool_t *mpctx, unsigned int limit);
582 /*%<
583  * Sets the maximum allowed number of allocations.
584  *
585  * Additional requirements:
586  *\li   limit > 0
587  */
588
589 unsigned int
590 isc_mempool_getallocated(isc_mempool_t *mpctx);
591 /*%<
592  * Returns the number of items allocated from this pool.
593  */
594
595 unsigned int
596 isc_mempool_getfillcount(isc_mempool_t *mpctx);
597 /*%<
598  * Returns the number of items allocated as a block from the parent memory
599  * context when the free list is empty.
600  */
601
602 void
603 isc_mempool_setfillcount(isc_mempool_t *mpctx, unsigned int limit);
604 /*%<
605  * Sets the fillcount.
606  *
607  * Additional requirements:
608  *\li   limit > 0
609  */
610
611
612 /*
613  * Pseudo-private functions for use via macros.  Do not call directly.
614  */
615 void *
616 isc__mem_get(isc_mem_t *, size_t _ISC_MEM_FLARG);
617 void
618 isc__mem_putanddetach(isc_mem_t **, void *,
619                                       size_t _ISC_MEM_FLARG);
620 void
621 isc__mem_put(isc_mem_t *, void *, size_t _ISC_MEM_FLARG);
622 void *
623 isc__mem_allocate(isc_mem_t *, size_t _ISC_MEM_FLARG);
624 void *
625 isc__mem_reallocate(isc_mem_t *, void *, size_t _ISC_MEM_FLARG);
626 void
627 isc__mem_free(isc_mem_t *, void * _ISC_MEM_FLARG);
628 char *
629 isc__mem_strdup(isc_mem_t *, const char *_ISC_MEM_FLARG);
630 void *
631 isc__mempool_get(isc_mempool_t * _ISC_MEM_FLARG);
632 void
633 isc__mempool_put(isc_mempool_t *, void * _ISC_MEM_FLARG);
634
635 ISC_LANG_ENDDECLS
636
637 #endif /* ISC_MEM_H */