Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wsfalloc.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  *
59  * wsfalloc.h
60  *
61  * Author: Markku Rossi <mtr@iki.fi>
62  *
63  * Copyright (c) 1999-2000 WAPIT OY LTD.
64  * All rights reserved.
65  *
66  * Fast memory allocation routines with easy cleanup.
67  *
68  */
69 
70 #ifndef WSFALLOC_H
71 #define WSFALLOC_H
72 
73 /********************* Types and definitions ****************************/
74 
76 {
78  /* The data follows immediately here. */
79 };
80 
82 
84 {
86 
87  /* The default block size of this pool. */
88  size_t block_size;
89 
90  /* The number of bytes allocates for user blocks. */
92 
93  /* The next allocation can be done from this position. */
94  unsigned char *ptr;
95 
96  /* And it has this much space. */
97  size_t size;
98 };
99 
101 
102 /********************* Prototypes for global functions ******************/
103 
104 /* Create a new fast memory allocator with internal block size of
105  `block_size' bytes. The function returns NULL if the creation
106  failed. */
108 
109 /* Destroy the fast allocator `pool' and free all resources it has
110  allocated. All memory chunks, allocated from this pool will be
111  invalidated with this call. */
112 void ws_f_destroy(WsFastMalloc *pool);
113 
114 /* Allocate `size' bytes of memory from the pool `pool'. The function
115  returns NULL if the allocation fails. */
116 void *ws_f_malloc(WsFastMalloc *pool, size_t size);
117 
118 /* Allocate `num' items of size `size' from the pool `pool'. The
119  returned memory block is initialized with zero. The function
120  returns NULL if the allocation fails. */
121 void *ws_f_calloc(WsFastMalloc *pool, size_t num, size_t size);
122 
123 /* Take a copy of the memory buffer `ptr' which has `size' bytes of
124  data. The copy is allocated from the pool `pool'. The function
125  returns NULL if the allocation fails. */
126 void *ws_f_memdup(WsFastMalloc *pool, const void *ptr, size_t size);
127 
128 /* Take a copy of the C-string `str'. The copy is allocated from the
129  pool `pool'. The function returns NULL if the allocation fails. */
130 void *ws_f_strdup(WsFastMalloc *pool, const char *str);
131 
132 #endif /* not WSFALLOC_H */
size_t block_size
Definition: wsfalloc.h:88
int size
Definition: wsasm.c:84
void * ws_f_malloc(WsFastMalloc *pool, size_t size)
Definition: wsfalloc.c:102
void * ws_f_strdup(WsFastMalloc *pool, const char *str)
Definition: wsfalloc.c:177
size_t size
Definition: wsfalloc.h:97
void * ws_f_calloc(WsFastMalloc *pool, size_t num, size_t size)
Definition: wsfalloc.c:150
WsFastMalloc * ws_f_create(size_t block_size)
Definition: wsfalloc.c:74
unsigned char * ptr
Definition: wsfalloc.h:94
size_t user_bytes_allocated
Definition: wsfalloc.h:91
struct WsFastMallocBlockRec * next
Definition: wsfalloc.h:77
void ws_f_destroy(WsFastMalloc *pool)
Definition: wsfalloc.c:87
void * ws_f_memdup(WsFastMalloc *pool, const void *ptr, size_t size)
Definition: wsfalloc.c:163
WsFastMallocBlock * blocks
Definition: wsfalloc.h:85
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.