flex_array: fix flex_array_free_parts comment
[linux-2.6.git] / lib / flex_array.c
1 /*
2  * Flexible array managed in PAGE_SIZE parts
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  *
18  * Copyright IBM Corporation, 2009
19  *
20  * Author: Dave Hansen <dave@linux.vnet.ibm.com>
21  */
22
23 #include <linux/flex_array.h>
24 #include <linux/slab.h>
25 #include <linux/stddef.h>
26
27 struct flex_array_part {
28         char elements[FLEX_ARRAY_PART_SIZE];
29 };
30
31 static inline int __elements_per_part(int element_size)
32 {
33         return FLEX_ARRAY_PART_SIZE / element_size;
34 }
35
36 static inline int bytes_left_in_base(void)
37 {
38         int element_offset = offsetof(struct flex_array, parts);
39         int bytes_left = FLEX_ARRAY_BASE_SIZE - element_offset;
40         return bytes_left;
41 }
42
43 static inline int nr_base_part_ptrs(void)
44 {
45         return bytes_left_in_base() / sizeof(struct flex_array_part *);
46 }
47
48 /*
49  * If a user requests an allocation which is small
50  * enough, we may simply use the space in the
51  * flex_array->parts[] array to store the user
52  * data.
53  */
54 static inline int elements_fit_in_base(struct flex_array *fa)
55 {
56         int data_size = fa->element_size * fa->total_nr_elements;
57         if (data_size <= bytes_left_in_base())
58                 return 1;
59         return 0;
60 }
61
62 /**
63  * flex_array_alloc - allocate a new flexible array
64  * @element_size:       the size of individual elements in the array
65  * @total:              total number of elements that this should hold
66  *
67  * Note: all locking must be provided by the caller.
68  *
69  * @total is used to size internal structures.  If the user ever
70  * accesses any array indexes >=@total, it will produce errors.
71  *
72  * The maximum number of elements is defined as: the number of
73  * elements that can be stored in a page times the number of
74  * page pointers that we can fit in the base structure or (using
75  * integer math):
76  *
77  *      (PAGE_SIZE/element_size) * (PAGE_SIZE-8)/sizeof(void *)
78  *
79  * Here's a table showing example capacities.  Note that the maximum
80  * index that the get/put() functions is just nr_objects-1.   This
81  * basically means that you get 4MB of storage on 32-bit and 2MB on
82  * 64-bit.
83  *
84  *
85  * Element size | Objects | Objects |
86  * PAGE_SIZE=4k |  32-bit |  64-bit |
87  * ---------------------------------|
88  *      1 bytes | 4186112 | 2093056 |
89  *      2 bytes | 2093056 | 1046528 |
90  *      3 bytes | 1395030 |  697515 |
91  *      4 bytes | 1046528 |  523264 |
92  *     32 bytes |  130816 |   65408 |
93  *     33 bytes |  126728 |   63364 |
94  *   2048 bytes |    2044 |    1022 |
95  *   2049 bytes |    1022 |     511 |
96  *       void * | 1046528 |  261632 |
97  *
98  * Since 64-bit pointers are twice the size, we lose half the
99  * capacity in the base structure.  Also note that no effort is made
100  * to efficiently pack objects across page boundaries.
101  */
102 struct flex_array *flex_array_alloc(int element_size, int total, gfp_t flags)
103 {
104         struct flex_array *ret;
105         int max_size = nr_base_part_ptrs() * __elements_per_part(element_size);
106
107         /* max_size will end up 0 if element_size > PAGE_SIZE */
108         if (total > max_size)
109                 return NULL;
110         ret = kzalloc(sizeof(struct flex_array), flags);
111         if (!ret)
112                 return NULL;
113         ret->element_size = element_size;
114         ret->total_nr_elements = total;
115         return ret;
116 }
117
118 static int fa_element_to_part_nr(struct flex_array *fa, int element_nr)
119 {
120         return element_nr / __elements_per_part(fa->element_size);
121 }
122
123 /**
124  * flex_array_free_parts - just free the second-level pages
125  *
126  * This is to be used in cases where the base 'struct flex_array'
127  * has been statically allocated and should not be free.
128  */
129 void flex_array_free_parts(struct flex_array *fa)
130 {
131         int part_nr;
132         int max_part = nr_base_part_ptrs();
133
134         if (elements_fit_in_base(fa))
135                 return;
136         for (part_nr = 0; part_nr < max_part; part_nr++)
137                 kfree(fa->parts[part_nr]);
138 }
139
140 void flex_array_free(struct flex_array *fa)
141 {
142         flex_array_free_parts(fa);
143         kfree(fa);
144 }
145
146 static int fa_index_inside_part(struct flex_array *fa, int element_nr)
147 {
148         return element_nr % __elements_per_part(fa->element_size);
149 }
150
151 static int index_inside_part(struct flex_array *fa, int element_nr)
152 {
153         int part_offset = fa_index_inside_part(fa, element_nr);
154         return part_offset * fa->element_size;
155 }
156
157 static struct flex_array_part *
158 __fa_get_part(struct flex_array *fa, int part_nr, gfp_t flags)
159 {
160         struct flex_array_part *part = fa->parts[part_nr];
161         if (!part) {
162                 /*
163                  * This leaves the part pages uninitialized
164                  * and with potentially random data, just
165                  * as if the user had kmalloc()'d the whole.
166                  * __GFP_ZERO can be used to zero it.
167                  */
168                 part = kmalloc(FLEX_ARRAY_PART_SIZE, flags);
169                 if (!part)
170                         return NULL;
171                 fa->parts[part_nr] = part;
172         }
173         return part;
174 }
175
176 /**
177  * flex_array_put - copy data into the array at @element_nr
178  * @src:        address of data to copy into the array
179  * @element_nr: index of the position in which to insert
180  *              the new element.
181  *
182  * Note that this *copies* the contents of @src into
183  * the array.  If you are trying to store an array of
184  * pointers, make sure to pass in &ptr instead of ptr.
185  *
186  * Locking must be provided by the caller.
187  */
188 int flex_array_put(struct flex_array *fa, int element_nr, void *src, gfp_t flags)
189 {
190         int part_nr = fa_element_to_part_nr(fa, element_nr);
191         struct flex_array_part *part;
192         void *dst;
193
194         if (element_nr >= fa->total_nr_elements)
195                 return -ENOSPC;
196         if (elements_fit_in_base(fa))
197                 part = (struct flex_array_part *)&fa->parts[0];
198         else {
199                 part = __fa_get_part(fa, part_nr, flags);
200                 if (!part)
201                         return -ENOMEM;
202         }
203         dst = &part->elements[index_inside_part(fa, element_nr)];
204         memcpy(dst, src, fa->element_size);
205         return 0;
206 }
207
208 /**
209  * flex_array_prealloc - guarantee that array space exists
210  * @start:      index of first array element for which space is allocated
211  * @end:        index of last (inclusive) element for which space is allocated
212  *
213  * This will guarantee that no future calls to flex_array_put()
214  * will allocate memory.  It can be used if you are expecting to
215  * be holding a lock or in some atomic context while writing
216  * data into the array.
217  *
218  * Locking must be provided by the caller.
219  */
220 int flex_array_prealloc(struct flex_array *fa, int start, int end, gfp_t flags)
221 {
222         int start_part;
223         int end_part;
224         int part_nr;
225         struct flex_array_part *part;
226
227         if (start >= fa->total_nr_elements || end >= fa->total_nr_elements)
228                 return -ENOSPC;
229         if (elements_fit_in_base(fa))
230                 return 0;
231         start_part = fa_element_to_part_nr(fa, start);
232         end_part = fa_element_to_part_nr(fa, end);
233         for (part_nr = start_part; part_nr <= end_part; part_nr++) {
234                 part = __fa_get_part(fa, part_nr, flags);
235                 if (!part)
236                         return -ENOMEM;
237         }
238         return 0;
239 }
240
241 /**
242  * flex_array_get - pull data back out of the array
243  * @element_nr: index of the element to fetch from the array
244  *
245  * Returns a pointer to the data at index @element_nr.  Note
246  * that this is a copy of the data that was passed in.  If you
247  * are using this to store pointers, you'll get back &ptr.
248  *
249  * Locking must be provided by the caller.
250  */
251 void *flex_array_get(struct flex_array *fa, int element_nr)
252 {
253         int part_nr = fa_element_to_part_nr(fa, element_nr);
254         struct flex_array_part *part;
255
256         if (element_nr >= fa->total_nr_elements)
257                 return NULL;
258         if (elements_fit_in_base(fa))
259                 part = (struct flex_array_part *)&fa->parts[0];
260         else {
261                 part = fa->parts[part_nr];
262                 if (!part)
263                         return NULL;
264         }
265         return &part->elements[index_inside_part(fa, element_nr)];
266 }