trunk/include/mempool.h

/*
 * Copyright (c) 2007-2012, The Tor Project, Inc.
 * Copyright (c) 2012-2014 ircd-hybrid development team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following disclaimer
 *     in the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright owners nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*! \file mempool.h
 * \brief Pooling allocator
 * \version $Id$
 */

#ifndef TOR_MEMPOOL_H
#define TOR_MEMPOOL_H

/** A memory pool is a context in which a large number of fixed-sized
* objects can be allocated efficiently.  See mempool.c for implementation
* details. */
typedef struct mp_pool_t mp_pool_t;

extern void mp_pool_init(void);
extern void *mp_pool_get(mp_pool_t *);
extern void mp_pool_release(void *);
extern mp_pool_t *mp_pool_new(size_t, size_t);
extern void mp_pool_clean(mp_pool_t *, int, int);
extern void mp_pool_destroy(mp_pool_t *);
extern void mp_pool_assert_ok(mp_pool_t *);
extern void mp_pool_log_status(mp_pool_t *);
extern void mp_pool_garbage_collect(void *);

#define MEMPOOL_STATS

struct mp_pool_t
{
  /** Next pool. A pool is usually linked into the mp_allocated_pools list. */
  mp_pool_t *next;

  /** Doubly-linked list of chunks in which no items have been allocated.
   * The front of the list is the most recently emptied chunk. */
  struct mp_chunk_t *empty_chunks;

  /** Doubly-linked list of chunks in which some items have been allocated,
   * but which are not yet full. The front of the list is the chunk that has
   * most recently been modified. */
  struct mp_chunk_t *used_chunks;

  /** Doubly-linked list of chunks in which no more items can be allocated.
   * The front of the list is the chunk that has most recently become full. */
  struct mp_chunk_t *full_chunks;

  /** Length of <b>empty_chunks</b>. */
  int n_empty_chunks;

  /** Lowest value of <b>empty_chunks</b> since last call to
   * mp_pool_clean(-1). */
  int min_empty_chunks;

  /** Size of each chunk (in items). */
  int new_chunk_capacity;

  /** Size to allocate for each item, including overhead and alignment
   * padding. */
  size_t item_alloc_size;
#ifdef MEMPOOL_STATS
  /** Total number of items allocated ever. */
  uint64_t total_items_allocated;

  /** Total number of chunks allocated ever. */
  uint64_t total_chunks_allocated;

  /** Total number of chunks freed ever. */
  uint64_t total_chunks_freed;
#endif
};
#endif
Revision:	2916
Committed:	Sat Jan 25 21:09:18 2014 UTC (11 years, 7 months ago) by michael
Content type:	text/x-chdr
File size:	3709 byte(s)
Log Message:	- Clean up all files in include/ (fixed indentation, removed whitespaces/tabs) - Fixed copyright years
#	Content
1	/*
2	* Copyright (c) 2007-2012, The Tor Project, Inc.
3	* Copyright (c) 2012-2014 ircd-hybrid development team
4	*
5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions are
7	* met:
8	*
9	* * Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* * Redistributions in binary form must reproduce the above
13	* copyright notice, this list of conditions and the following disclaimer
14	* in the documentation and/or other materials provided with the
15	* distribution.
16	*
17	* * Neither the names of the copyright owners nor the names of its
18	* contributors may be used to endorse or promote products derived from
19	* this software without specific prior written permission.
20	*
21	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32	*/
33
34	/*! \file mempool.h
35	* \brief Pooling allocator
36	* \version $Id$
37	*/
38
39	#ifndef TOR_MEMPOOL_H
40	#define TOR_MEMPOOL_H
41
42	/** A memory pool is a context in which a large number of fixed-sized
43	* objects can be allocated efficiently. See mempool.c for implementation
44	* details. */
45	typedef struct mp_pool_t mp_pool_t;
46
47	extern void mp_pool_init(void);
48	extern void mp_pool_get(mp_pool_t );
49	extern void mp_pool_release(void *);
50	extern mp_pool_t *mp_pool_new(size_t, size_t);
51	extern void mp_pool_clean(mp_pool_t *, int, int);
52	extern void mp_pool_destroy(mp_pool_t *);
53	extern void mp_pool_assert_ok(mp_pool_t *);
54	extern void mp_pool_log_status(mp_pool_t *);
55	extern void mp_pool_garbage_collect(void *);
56
57	#define MEMPOOL_STATS
58
59	struct mp_pool_t
60	{
61	/** Next pool. A pool is usually linked into the mp_allocated_pools list. */
62	mp_pool_t *next;
63
64	/** Doubly-linked list of chunks in which no items have been allocated.
65	* The front of the list is the most recently emptied chunk. */
66	struct mp_chunk_t *empty_chunks;
67
68	/** Doubly-linked list of chunks in which some items have been allocated,
69	* but which are not yet full. The front of the list is the chunk that has
70	* most recently been modified. */
71	struct mp_chunk_t *used_chunks;
72
73	/** Doubly-linked list of chunks in which no more items can be allocated.
74	* The front of the list is the chunk that has most recently become full. */
75	struct mp_chunk_t *full_chunks;
76
77	/** Length of <b>empty_chunks</b>. */
78	int n_empty_chunks;
79
80	/** Lowest value of <b>empty_chunks</b> since last call to
81	* mp_pool_clean(-1). */
82	int min_empty_chunks;
83
84	/** Size of each chunk (in items). */
85	int new_chunk_capacity;
86
87	/** Size to allocate for each item, including overhead and alignment
88	* padding. */
89	size_t item_alloc_size;
90	#ifdef MEMPOOL_STATS
91	/** Total number of items allocated ever. */
92	uint64_t total_items_allocated;
93
94	/** Total number of chunks allocated ever. */
95	uint64_t total_chunks_allocated;
96
97	/** Total number of chunks freed ever. */
98	uint64_t total_chunks_freed;
99	#endif
100	};
101	#endif