Blame view
include/linux/kfifo.h
24.8 KB
1da177e4c Linux-2.6.12-rc2 |
1 |
/* |
2e956fb32 kfifo: replace th... |
2 |
* A generic kernel FIFO implementation |
1da177e4c Linux-2.6.12-rc2 |
3 |
* |
498d319bb kfifo API type sa... |
4 |
* Copyright (C) 2013 Stefani Seibold <stefani@seibold.net> |
1da177e4c Linux-2.6.12-rc2 |
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. * */ |
7acd72eb8 kfifo: rename kfi... |
21 |
|
2e956fb32 kfifo: replace th... |
22 23 |
#ifndef _LINUX_KFIFO_H #define _LINUX_KFIFO_H |
7acd72eb8 kfifo: rename kfi... |
24 |
/* |
2e956fb32 kfifo: replace th... |
25 |
* How to porting drivers to the new generic FIFO API: |
7acd72eb8 kfifo: rename kfi... |
26 27 28 29 30 31 32 33 |
* * - Modify the declaration of the "struct kfifo *" object into a * in-place "struct kfifo" object * - Init the in-place object with kfifo_alloc() or kfifo_init() * Note: The address of the in-place "struct kfifo" object must be * passed as the first argument to this functions * - Replace the use of __kfifo_put into kfifo_in and __kfifo_get * into kfifo_out |
2e956fb32 kfifo: replace th... |
34 35 |
* - Replace the use of kfifo_put into kfifo_in_spinlocked and kfifo_get * into kfifo_out_spinlocked |
7acd72eb8 kfifo: rename kfi... |
36 |
* Note: the spinlock pointer formerly passed to kfifo_init/kfifo_alloc |
2e956fb32 kfifo: replace th... |
37 38 39 |
* must be passed now to the kfifo_in_spinlocked and kfifo_out_spinlocked * as the last parameter * - The formerly __kfifo_* functions are renamed into kfifo_* |
7acd72eb8 kfifo: rename kfi... |
40 |
*/ |
2e956fb32 kfifo: replace th... |
41 42 43 44 45 46 47 48 49 |
/* * Note about locking : There is no locking required until only * one reader * and one writer is using the fifo and no kfifo_reset() will be * called * kfifo_reset_out() can be safely used, until it will be only called * in the reader thread. * For multiple writer and one reader there is only a need to lock the writer. * And vice versa for only one writer and multiple reader there is only a need * to lock the reader. */ |
1da177e4c Linux-2.6.12-rc2 |
50 |
|
1da177e4c Linux-2.6.12-rc2 |
51 52 |
#include <linux/kernel.h> #include <linux/spinlock.h> |
2e956fb32 kfifo: replace th... |
53 54 55 56 57 58 59 60 61 |
#include <linux/stddef.h> #include <linux/scatterlist.h> struct __kfifo { unsigned int in; unsigned int out; unsigned int mask; unsigned int esize; void *data; |
1da177e4c Linux-2.6.12-rc2 |
62 |
}; |
2e956fb32 kfifo: replace th... |
63 64 65 66 |
#define __STRUCT_KFIFO_COMMON(datatype, recsize, ptrtype) \ union { \ struct __kfifo kfifo; \ datatype *type; \ |
498d319bb kfifo API type sa... |
67 |
const datatype *const_type; \ |
2e956fb32 kfifo: replace th... |
68 69 |
char (*rectype)[recsize]; \ ptrtype *ptr; \ |
498d319bb kfifo API type sa... |
70 |
ptrtype const *ptr_const; \ |
37bdfbbfa kfifo: add DEFINE... |
71 |
} |
2e956fb32 kfifo: replace th... |
72 73 74 75 |
#define __STRUCT_KFIFO(type, size, recsize, ptrtype) \ { \ __STRUCT_KFIFO_COMMON(type, recsize, ptrtype); \ type buf[((size < 2) || (size & (size - 1))) ? -1 : size]; \ |
37bdfbbfa kfifo: add DEFINE... |
76 |
} |
2e956fb32 kfifo: replace th... |
77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
#define STRUCT_KFIFO(type, size) \ struct __STRUCT_KFIFO(type, size, 0, type) #define __STRUCT_KFIFO_PTR(type, recsize, ptrtype) \ { \ __STRUCT_KFIFO_COMMON(type, recsize, ptrtype); \ type buf[0]; \ } #define STRUCT_KFIFO_PTR(type) \ struct __STRUCT_KFIFO_PTR(type, 0, type) /* * define compatibility "struct kfifo" for dynamic allocated fifos |
37bdfbbfa kfifo: add DEFINE... |
91 |
*/ |
2e956fb32 kfifo: replace th... |
92 |
struct kfifo __STRUCT_KFIFO_PTR(unsigned char, 0, void); |
37bdfbbfa kfifo: add DEFINE... |
93 |
|
2e956fb32 kfifo: replace th... |
94 95 96 97 98 99 100 101 |
#define STRUCT_KFIFO_REC_1(size) \ struct __STRUCT_KFIFO(unsigned char, size, 1, void) #define STRUCT_KFIFO_REC_2(size) \ struct __STRUCT_KFIFO(unsigned char, size, 2, void) /* * define kfifo_rec types |
37bdfbbfa kfifo: add DEFINE... |
102 |
*/ |
2e956fb32 kfifo: replace th... |
103 104 |
struct kfifo_rec_ptr_1 __STRUCT_KFIFO_PTR(unsigned char, 1, void); struct kfifo_rec_ptr_2 __STRUCT_KFIFO_PTR(unsigned char, 2, void); |
37bdfbbfa kfifo: add DEFINE... |
105 |
|
2e956fb32 kfifo: replace th... |
106 107 108 109 110 111 |
/* * helper macro to distinguish between real in place fifo where the fifo * array is a part of the structure and the fifo type where the array is * outside of the fifo structure. */ #define __is_kfifo_ptr(fifo) (sizeof(*fifo) == sizeof(struct __kfifo)) |
a5b9e2c10 kfifo: add kfifo_... |
112 |
|
d994ffc24 kfifo: add kfifo_... |
113 |
/** |
2e956fb32 kfifo: replace th... |
114 115 116 |
* DECLARE_KFIFO_PTR - macro to declare a fifo pointer object * @fifo: name of the declared fifo * @type: type of the fifo elements |
d994ffc24 kfifo: add kfifo_... |
117 |
*/ |
2e956fb32 kfifo: replace th... |
118 |
#define DECLARE_KFIFO_PTR(fifo, type) STRUCT_KFIFO_PTR(type) fifo |
1da177e4c Linux-2.6.12-rc2 |
119 120 |
/** |
2e956fb32 kfifo: replace th... |
121 122 123 124 |
* DECLARE_KFIFO - macro to declare a fifo object * @fifo: name of the declared fifo * @type: type of the fifo elements * @size: the number of elements in the fifo, this must be a power of 2 |
1da177e4c Linux-2.6.12-rc2 |
125 |
*/ |
2e956fb32 kfifo: replace th... |
126 |
#define DECLARE_KFIFO(fifo, type, size) STRUCT_KFIFO(type, size) fifo |
c1e13f256 kfifo: move out s... |
127 128 |
/** |
2e956fb32 kfifo: replace th... |
129 130 131 132 133 134 135 136 137 138 139 140 141 |
* INIT_KFIFO - Initialize a fifo declared by DECLARE_KFIFO * @fifo: name of the declared fifo datatype */ #define INIT_KFIFO(fifo) \ (void)({ \ typeof(&(fifo)) __tmp = &(fifo); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ __kfifo->in = 0; \ __kfifo->out = 0; \ __kfifo->mask = __is_kfifo_ptr(__tmp) ? 0 : ARRAY_SIZE(__tmp->buf) - 1;\ __kfifo->esize = sizeof(*__tmp->buf); \ __kfifo->data = __is_kfifo_ptr(__tmp) ? NULL : __tmp->buf; \ }) |
a121f24ac kfifo: add kfifo_... |
142 143 |
/** |
2e956fb32 kfifo: replace th... |
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
* DEFINE_KFIFO - macro to define and initialize a fifo * @fifo: name of the declared fifo datatype * @type: type of the fifo elements * @size: the number of elements in the fifo, this must be a power of 2 * * Note: the macro can be used for global and local fifo data type variables. */ #define DEFINE_KFIFO(fifo, type, size) \ DECLARE_KFIFO(fifo, type, size) = \ (typeof(fifo)) { \ { \ { \ .in = 0, \ .out = 0, \ .mask = __is_kfifo_ptr(&(fifo)) ? \ 0 : \ ARRAY_SIZE((fifo).buf) - 1, \ .esize = sizeof(*(fifo).buf), \ .data = __is_kfifo_ptr(&(fifo)) ? \ NULL : \ (fifo).buf, \ } \ } \ } |
144ecf310 kfifo: fix kfifo_... |
168 169 170 171 172 173 174 175 176 177 178 |
static inline unsigned int __must_check __kfifo_uint_must_check_helper(unsigned int val) { return val; } static inline int __must_check __kfifo_int_must_check_helper(int val) { return val; } |
37bdfbbfa kfifo: add DEFINE... |
179 180 |
/** |
2e956fb32 kfifo: replace th... |
181 182 183 184 185 |
* kfifo_initialized - Check if the fifo is initialized * @fifo: address of the fifo to check * * Return %true if fifo is initialized, otherwise %false. * Assumes the fifo was 0 before. |
c1e13f256 kfifo: move out s... |
186 |
*/ |
2e956fb32 kfifo: replace th... |
187 |
#define kfifo_initialized(fifo) ((fifo)->kfifo.mask) |
1da177e4c Linux-2.6.12-rc2 |
188 189 |
/** |
2e956fb32 kfifo: replace th... |
190 191 |
* kfifo_esize - returns the size of the element managed by the fifo * @fifo: address of the fifo to be used |
37bdfbbfa kfifo: add DEFINE... |
192 |
*/ |
2e956fb32 kfifo: replace th... |
193 |
#define kfifo_esize(fifo) ((fifo)->kfifo.esize) |
37bdfbbfa kfifo: add DEFINE... |
194 195 |
/** |
2e956fb32 kfifo: replace th... |
196 197 |
* kfifo_recsize - returns the size of the record length field * @fifo: address of the fifo to be used |
37bdfbbfa kfifo: add DEFINE... |
198 |
*/ |
2e956fb32 kfifo: replace th... |
199 |
#define kfifo_recsize(fifo) (sizeof(*(fifo)->rectype)) |
37bdfbbfa kfifo: add DEFINE... |
200 201 |
/** |
2e956fb32 kfifo: replace th... |
202 203 |
* kfifo_size - returns the size of the fifo in elements * @fifo: address of the fifo to be used |
37bdfbbfa kfifo: add DEFINE... |
204 |
*/ |
2e956fb32 kfifo: replace th... |
205 |
#define kfifo_size(fifo) ((fifo)->kfifo.mask + 1) |
37bdfbbfa kfifo: add DEFINE... |
206 207 |
/** |
2e956fb32 kfifo: replace th... |
208 209 |
* kfifo_reset - removes the entire fifo content * @fifo: address of the fifo to be used |
1da177e4c Linux-2.6.12-rc2 |
210 |
* |
2e956fb32 kfifo: replace th... |
211 212 213 |
* Note: usage of kfifo_reset() is dangerous. It should be only called when the * fifo is exclusived locked or when it is secured that no other thread is * accessing the fifo. |
1da177e4c Linux-2.6.12-rc2 |
214 |
*/ |
2e956fb32 kfifo: replace th... |
215 216 |
#define kfifo_reset(fifo) \ (void)({ \ |
e0bf1024b kfifo: add parent... |
217 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
218 219 |
__tmp->kfifo.in = __tmp->kfifo.out = 0; \ }) |
1da177e4c Linux-2.6.12-rc2 |
220 221 |
/** |
2e956fb32 kfifo: replace th... |
222 223 |
* kfifo_reset_out - skip fifo content * @fifo: address of the fifo to be used |
1da177e4c Linux-2.6.12-rc2 |
224 |
* |
2e956fb32 kfifo: replace th... |
225 226 227 |
* Note: The usage of kfifo_reset_out() is safe until it will be only called * from the reader thread and there is only one concurrent reader. Otherwise * it is dangerous and must be handled in the same way as kfifo_reset(). |
a121f24ac kfifo: add kfifo_... |
228 |
*/ |
2e956fb32 kfifo: replace th... |
229 230 |
#define kfifo_reset_out(fifo) \ (void)({ \ |
e0bf1024b kfifo: add parent... |
231 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
232 233 |
__tmp->kfifo.out = __tmp->kfifo.in; \ }) |
a121f24ac kfifo: add kfifo_... |
234 |
|
2e956fb32 kfifo: replace th... |
235 236 237 |
/** * kfifo_len - returns the number of used elements in the fifo * @fifo: address of the fifo to be used |
a121f24ac kfifo: add kfifo_... |
238 |
*/ |
2e956fb32 kfifo: replace th... |
239 240 |
#define kfifo_len(fifo) \ ({ \ |
e0bf1024b kfifo: add parent... |
241 |
typeof((fifo) + 1) __tmpl = (fifo); \ |
2e956fb32 kfifo: replace th... |
242 243 |
__tmpl->kfifo.in - __tmpl->kfifo.out; \ }) |
a121f24ac kfifo: add kfifo_... |
244 |
|
2e956fb32 kfifo: replace th... |
245 246 247 |
/** * kfifo_is_empty - returns true if the fifo is empty * @fifo: address of the fifo to be used |
a121f24ac kfifo: add kfifo_... |
248 |
*/ |
2e956fb32 kfifo: replace th... |
249 250 |
#define kfifo_is_empty(fifo) \ ({ \ |
e0bf1024b kfifo: add parent... |
251 |
typeof((fifo) + 1) __tmpq = (fifo); \ |
2e956fb32 kfifo: replace th... |
252 253 |
__tmpq->kfifo.in == __tmpq->kfifo.out; \ }) |
a121f24ac kfifo: add kfifo_... |
254 |
|
2e956fb32 kfifo: replace th... |
255 256 257 |
/** * kfifo_is_full - returns true if the fifo is full * @fifo: address of the fifo to be used |
86d488031 kfifo: add record... |
258 |
*/ |
2e956fb32 kfifo: replace th... |
259 260 |
#define kfifo_is_full(fifo) \ ({ \ |
e0bf1024b kfifo: add parent... |
261 |
typeof((fifo) + 1) __tmpq = (fifo); \ |
2e956fb32 kfifo: replace th... |
262 263 |
kfifo_len(__tmpq) > __tmpq->kfifo.mask; \ }) |
86d488031 kfifo: add record... |
264 |
|
2e956fb32 kfifo: replace th... |
265 266 267 268 269 |
/** * kfifo_avail - returns the number of unused elements in the fifo * @fifo: address of the fifo to be used */ #define kfifo_avail(fifo) \ |
144ecf310 kfifo: fix kfifo_... |
270 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
271 |
({ \ |
e0bf1024b kfifo: add parent... |
272 |
typeof((fifo) + 1) __tmpq = (fifo); \ |
2e956fb32 kfifo: replace th... |
273 274 275 276 277 278 279 |
const size_t __recsize = sizeof(*__tmpq->rectype); \ unsigned int __avail = kfifo_size(__tmpq) - kfifo_len(__tmpq); \ (__recsize) ? ((__avail <= __recsize) ? 0 : \ __kfifo_max_r(__avail - __recsize, __recsize)) : \ __avail; \ }) \ ) |
86d488031 kfifo: add record... |
280 |
|
2e956fb32 kfifo: replace th... |
281 282 283 284 285 286 |
/** * kfifo_skip - skip output data * @fifo: address of the fifo to be used */ #define kfifo_skip(fifo) \ (void)({ \ |
e0bf1024b kfifo: add parent... |
287 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
288 289 290 291 292 293 294 |
const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ if (__recsize) \ __kfifo_skip_r(__kfifo, __recsize); \ else \ __kfifo->out++; \ }) |
86d488031 kfifo: add record... |
295 |
|
2e956fb32 kfifo: replace th... |
296 297 298 299 300 301 302 |
/** * kfifo_peek_len - gets the size of the next fifo record * @fifo: address of the fifo to be used * * This function returns the size of the next fifo record in number of bytes. */ #define kfifo_peek_len(fifo) \ |
144ecf310 kfifo: fix kfifo_... |
303 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
304 |
({ \ |
e0bf1024b kfifo: add parent... |
305 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
306 307 308 309 310 311 |
const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ (!__recsize) ? kfifo_len(__tmp) * sizeof(*__tmp->type) : \ __kfifo_len_r(__kfifo, __recsize); \ }) \ ) |
86d488031 kfifo: add record... |
312 |
|
2e956fb32 kfifo: replace th... |
313 314 315 316 317 318 319 320 321 322 323 324 325 |
/** * kfifo_alloc - dynamically allocates a new fifo buffer * @fifo: pointer to the fifo * @size: the number of elements in the fifo, this must be a power of 2 * @gfp_mask: get_free_pages mask, passed to kmalloc() * * This macro dynamically allocates a new fifo buffer. * * The numer of elements will be rounded-up to a power of 2. * The fifo will be release with kfifo_free(). * Return 0 if no error, otherwise an error code. */ #define kfifo_alloc(fifo, size, gfp_mask) \ |
144ecf310 kfifo: fix kfifo_... |
326 |
__kfifo_int_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
327 |
({ \ |
e0bf1024b kfifo: add parent... |
328 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
329 330 331 332 333 334 |
struct __kfifo *__kfifo = &__tmp->kfifo; \ __is_kfifo_ptr(__tmp) ? \ __kfifo_alloc(__kfifo, size, sizeof(*__tmp->type), gfp_mask) : \ -EINVAL; \ }) \ ) |
86d488031 kfifo: add record... |
335 |
|
2e956fb32 kfifo: replace th... |
336 337 338 |
/** * kfifo_free - frees the fifo * @fifo: the fifo to be freed |
86d488031 kfifo: add record... |
339 |
*/ |
2e956fb32 kfifo: replace th... |
340 341 |
#define kfifo_free(fifo) \ ({ \ |
e0bf1024b kfifo: add parent... |
342 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
343 344 345 346 |
struct __kfifo *__kfifo = &__tmp->kfifo; \ if (__is_kfifo_ptr(__tmp)) \ __kfifo_free(__kfifo); \ }) |
86d488031 kfifo: add record... |
347 |
|
2e956fb32 kfifo: replace th... |
348 349 350 351 352 353 354 355 356 357 358 359 360 |
/** * kfifo_init - initialize a fifo using a preallocated buffer * @fifo: the fifo to assign the buffer * @buffer: the preallocated buffer to be used * @size: the size of the internal buffer, this have to be a power of 2 * * This macro initialize a fifo using a preallocated buffer. * * The numer of elements will be rounded-up to a power of 2. * Return 0 if no error, otherwise an error code. */ #define kfifo_init(fifo, buffer, size) \ ({ \ |
e0bf1024b kfifo: add parent... |
361 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
362 363 364 365 366 |
struct __kfifo *__kfifo = &__tmp->kfifo; \ __is_kfifo_ptr(__tmp) ? \ __kfifo_init(__kfifo, buffer, size, sizeof(*__tmp->type)) : \ -EINVAL; \ }) |
86d488031 kfifo: add record... |
367 |
|
2e956fb32 kfifo: replace th... |
368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
/** * kfifo_put - put data into the fifo * @fifo: address of the fifo to be used * @val: the data to be added * * This macro copies the given value into the fifo. * It returns 0 if the fifo was full. Otherwise it returns the number * processed elements. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macro. */ #define kfifo_put(fifo, val) \ ({ \ |
e0bf1024b kfifo: add parent... |
382 |
typeof((fifo) + 1) __tmp = (fifo); \ |
498d319bb kfifo API type sa... |
383 |
typeof(*__tmp->const_type) __val = (val); \ |
2e956fb32 kfifo: replace th... |
384 |
unsigned int __ret; \ |
498d319bb kfifo API type sa... |
385 |
size_t __recsize = sizeof(*__tmp->rectype); \ |
2e956fb32 kfifo: replace th... |
386 |
struct __kfifo *__kfifo = &__tmp->kfifo; \ |
2e956fb32 kfifo: replace th... |
387 |
if (__recsize) \ |
498d319bb kfifo API type sa... |
388 |
__ret = __kfifo_in_r(__kfifo, &__val, sizeof(__val), \ |
2e956fb32 kfifo: replace th... |
389 390 391 392 393 394 395 396 |
__recsize); \ else { \ __ret = !kfifo_is_full(__tmp); \ if (__ret) { \ (__is_kfifo_ptr(__tmp) ? \ ((typeof(__tmp->type))__kfifo->data) : \ (__tmp->buf) \ )[__kfifo->in & __tmp->kfifo.mask] = \ |
21b2f4431 kfifo: fix sparse... |
397 |
*(typeof(__tmp->type))&__val; \ |
2e956fb32 kfifo: replace th... |
398 399 400 401 402 403 |
smp_wmb(); \ __kfifo->in++; \ } \ } \ __ret; \ }) |
86d488031 kfifo: add record... |
404 |
|
2e956fb32 kfifo: replace th... |
405 406 407 |
/** * kfifo_get - get data from the fifo * @fifo: address of the fifo to be used |
498d319bb kfifo API type sa... |
408 |
* @val: address where to store the data |
2e956fb32 kfifo: replace th... |
409 410 411 412 413 414 415 416 417 |
* * This macro reads the data from the fifo. * It returns 0 if the fifo was empty. Otherwise it returns the number * processed elements. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macro. */ #define kfifo_get(fifo, val) \ |
144ecf310 kfifo: fix kfifo_... |
418 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
419 |
({ \ |
e0bf1024b kfifo: add parent... |
420 |
typeof((fifo) + 1) __tmp = (fifo); \ |
498d319bb kfifo API type sa... |
421 |
typeof(__tmp->ptr) __val = (val); \ |
2e956fb32 kfifo: replace th... |
422 423 424 |
unsigned int __ret; \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ |
2e956fb32 kfifo: replace th... |
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
if (__recsize) \ __ret = __kfifo_out_r(__kfifo, __val, sizeof(*__val), \ __recsize); \ else { \ __ret = !kfifo_is_empty(__tmp); \ if (__ret) { \ *(typeof(__tmp->type))__val = \ (__is_kfifo_ptr(__tmp) ? \ ((typeof(__tmp->type))__kfifo->data) : \ (__tmp->buf) \ )[__kfifo->out & __tmp->kfifo.mask]; \ smp_wmb(); \ __kfifo->out++; \ } \ } \ __ret; \ }) \ ) |
86d488031 kfifo: add record... |
443 |
|
2e956fb32 kfifo: replace th... |
444 445 446 |
/** * kfifo_peek - get data from the fifo without removing * @fifo: address of the fifo to be used |
498d319bb kfifo API type sa... |
447 |
* @val: address where to store the data |
2e956fb32 kfifo: replace th... |
448 449 450 451 452 453 454 455 456 |
* * This reads the data from the fifo without removing it from the fifo. * It returns 0 if the fifo was empty. Otherwise it returns the number * processed elements. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macro. */ #define kfifo_peek(fifo, val) \ |
144ecf310 kfifo: fix kfifo_... |
457 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
458 |
({ \ |
e0bf1024b kfifo: add parent... |
459 |
typeof((fifo) + 1) __tmp = (fifo); \ |
498d319bb kfifo API type sa... |
460 |
typeof(__tmp->ptr) __val = (val); \ |
2e956fb32 kfifo: replace th... |
461 462 463 |
unsigned int __ret; \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ |
2e956fb32 kfifo: replace th... |
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
if (__recsize) \ __ret = __kfifo_out_peek_r(__kfifo, __val, sizeof(*__val), \ __recsize); \ else { \ __ret = !kfifo_is_empty(__tmp); \ if (__ret) { \ *(typeof(__tmp->type))__val = \ (__is_kfifo_ptr(__tmp) ? \ ((typeof(__tmp->type))__kfifo->data) : \ (__tmp->buf) \ )[__kfifo->out & __tmp->kfifo.mask]; \ smp_wmb(); \ } \ } \ __ret; \ }) \ ) |
86d488031 kfifo: add record... |
481 |
|
2e956fb32 kfifo: replace th... |
482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
/** * kfifo_in - put data into the fifo * @fifo: address of the fifo to be used * @buf: the data to be added * @n: number of elements to be added * * This macro copies the given buffer into the fifo and returns the * number of copied elements. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macro. */ #define kfifo_in(fifo, buf, n) \ ({ \ |
e0bf1024b kfifo: add parent... |
496 |
typeof((fifo) + 1) __tmp = (fifo); \ |
498d319bb kfifo API type sa... |
497 |
typeof(__tmp->ptr_const) __buf = (buf); \ |
2e956fb32 kfifo: replace th... |
498 499 500 |
unsigned long __n = (n); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ |
2e956fb32 kfifo: replace th... |
501 502 503 504 |
(__recsize) ?\ __kfifo_in_r(__kfifo, __buf, __n, __recsize) : \ __kfifo_in(__kfifo, __buf, __n); \ }) |
86d488031 kfifo: add record... |
505 |
|
2e956fb32 kfifo: replace th... |
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
/** * kfifo_in_spinlocked - put data into the fifo using a spinlock for locking * @fifo: address of the fifo to be used * @buf: the data to be added * @n: number of elements to be added * @lock: pointer to the spinlock to use for locking * * This macro copies the given values buffer into the fifo and returns the * number of copied elements. */ #define kfifo_in_spinlocked(fifo, buf, n, lock) \ ({ \ unsigned long __flags; \ unsigned int __ret; \ spin_lock_irqsave(lock, __flags); \ __ret = kfifo_in(fifo, buf, n); \ spin_unlock_irqrestore(lock, __flags); \ __ret; \ }) /* alias for kfifo_in_spinlocked, will be removed in a future release */ #define kfifo_in_locked(fifo, buf, n, lock) \ kfifo_in_spinlocked(fifo, buf, n, lock) |
86d488031 kfifo: add record... |
529 |
|
2e956fb32 kfifo: replace th... |
530 531 532 533 534 535 536 537 538 539 540 541 542 |
/** * kfifo_out - get data from the fifo * @fifo: address of the fifo to be used * @buf: pointer to the storage buffer * @n: max. number of elements to get * * This macro get some data from the fifo and return the numbers of elements * copied. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macro. */ #define kfifo_out(fifo, buf, n) \ |
144ecf310 kfifo: fix kfifo_... |
543 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
544 |
({ \ |
e0bf1024b kfifo: add parent... |
545 |
typeof((fifo) + 1) __tmp = (fifo); \ |
498d319bb kfifo API type sa... |
546 |
typeof(__tmp->ptr) __buf = (buf); \ |
2e956fb32 kfifo: replace th... |
547 548 549 |
unsigned long __n = (n); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ |
2e956fb32 kfifo: replace th... |
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 |
(__recsize) ?\ __kfifo_out_r(__kfifo, __buf, __n, __recsize) : \ __kfifo_out(__kfifo, __buf, __n); \ }) \ ) /** * kfifo_out_spinlocked - get data from the fifo using a spinlock for locking * @fifo: address of the fifo to be used * @buf: pointer to the storage buffer * @n: max. number of elements to get * @lock: pointer to the spinlock to use for locking * * This macro get the data from the fifo and return the numbers of elements * copied. */ #define kfifo_out_spinlocked(fifo, buf, n, lock) \ |
144ecf310 kfifo: fix kfifo_... |
567 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
568 569 570 571 572 573 574 575 576 577 578 579 580 |
({ \ unsigned long __flags; \ unsigned int __ret; \ spin_lock_irqsave(lock, __flags); \ __ret = kfifo_out(fifo, buf, n); \ spin_unlock_irqrestore(lock, __flags); \ __ret; \ }) \ ) /* alias for kfifo_out_spinlocked, will be removed in a future release */ #define kfifo_out_locked(fifo, buf, n, lock) \ kfifo_out_spinlocked(fifo, buf, n, lock) |
86d488031 kfifo: add record... |
581 582 |
/** |
2e956fb32 kfifo: replace th... |
583 584 585 586 587 |
* kfifo_from_user - puts some data from user space into the fifo * @fifo: address of the fifo to be used * @from: pointer to the data to be added * @len: the length of the data to be added * @copied: pointer to output variable to store the number of copied bytes |
86d488031 kfifo: add record... |
588 |
* |
2e956fb32 kfifo: replace th... |
589 590 |
* This macro copies at most @len bytes from the @from into the * fifo, depending of the available space and returns -EFAULT/0. |
86d488031 kfifo: add record... |
591 592 |
* * Note that with only one concurrent reader and one concurrent |
2e956fb32 kfifo: replace th... |
593 594 595 |
* writer, you don't need extra locking to use these macro. */ #define kfifo_from_user(fifo, from, len, copied) \ |
144ecf310 kfifo: fix kfifo_... |
596 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
597 |
({ \ |
e0bf1024b kfifo: add parent... |
598 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
599 600 601 602 603 604 605 606 607 608 |
const void __user *__from = (from); \ unsigned int __len = (len); \ unsigned int *__copied = (copied); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ (__recsize) ? \ __kfifo_from_user_r(__kfifo, __from, __len, __copied, __recsize) : \ __kfifo_from_user(__kfifo, __from, __len, __copied); \ }) \ ) |
86d488031 kfifo: add record... |
609 |
|
2e956fb32 kfifo: replace th... |
610 611 612 613 614 615 616 617 618 619 620 621 622 623 |
/** * kfifo_to_user - copies data from the fifo into user space * @fifo: address of the fifo to be used * @to: where the data must be copied * @len: the size of the destination buffer * @copied: pointer to output variable to store the number of copied bytes * * This macro copies at most @len bytes from the fifo into the * @to buffer and returns -EFAULT/0. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macro. */ #define kfifo_to_user(fifo, to, len, copied) \ |
144ecf310 kfifo: fix kfifo_... |
624 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
625 |
({ \ |
e0bf1024b kfifo: add parent... |
626 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 |
void __user *__to = (to); \ unsigned int __len = (len); \ unsigned int *__copied = (copied); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ (__recsize) ? \ __kfifo_to_user_r(__kfifo, __to, __len, __copied, __recsize) : \ __kfifo_to_user(__kfifo, __to, __len, __copied); \ }) \ ) /** * kfifo_dma_in_prepare - setup a scatterlist for DMA input * @fifo: address of the fifo to be used * @sgl: pointer to the scatterlist array * @nents: number of entries in the scatterlist array * @len: number of elements to transfer * * This macro fills a scatterlist for DMA input. * It returns the number entries in the scatterlist array. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macros. */ #define kfifo_dma_in_prepare(fifo, sgl, nents, len) \ ({ \ |
e0bf1024b kfifo: add parent... |
653 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
654 655 656 657 658 659 660 661 662 |
struct scatterlist *__sgl = (sgl); \ int __nents = (nents); \ unsigned int __len = (len); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ (__recsize) ? \ __kfifo_dma_in_prepare_r(__kfifo, __sgl, __nents, __len, __recsize) : \ __kfifo_dma_in_prepare(__kfifo, __sgl, __nents, __len); \ }) |
86d488031 kfifo: add record... |
663 |
|
2e956fb32 kfifo: replace th... |
664 665 666 667 668 669 670 671 672 673 674 675 676 |
/** * kfifo_dma_in_finish - finish a DMA IN operation * @fifo: address of the fifo to be used * @len: number of bytes to received * * This macro finish a DMA IN operation. The in counter will be updated by * the len parameter. No error checking will be done. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macros. */ #define kfifo_dma_in_finish(fifo, len) \ (void)({ \ |
e0bf1024b kfifo: add parent... |
677 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
678 679 680 681 682 683 684 685 |
unsigned int __len = (len); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ if (__recsize) \ __kfifo_dma_in_finish_r(__kfifo, __len, __recsize); \ else \ __kfifo->in += __len / sizeof(*__tmp->type); \ }) |
86d488031 kfifo: add record... |
686 |
|
2e956fb32 kfifo: replace th... |
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 |
/** * kfifo_dma_out_prepare - setup a scatterlist for DMA output * @fifo: address of the fifo to be used * @sgl: pointer to the scatterlist array * @nents: number of entries in the scatterlist array * @len: number of elements to transfer * * This macro fills a scatterlist for DMA output which at most @len bytes * to transfer. * It returns the number entries in the scatterlist array. * A zero means there is no space available and the scatterlist is not filled. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macros. */ #define kfifo_dma_out_prepare(fifo, sgl, nents, len) \ ({ \ |
e0bf1024b kfifo: add parent... |
704 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
705 706 707 708 709 710 711 712 713 |
struct scatterlist *__sgl = (sgl); \ int __nents = (nents); \ unsigned int __len = (len); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ (__recsize) ? \ __kfifo_dma_out_prepare_r(__kfifo, __sgl, __nents, __len, __recsize) : \ __kfifo_dma_out_prepare(__kfifo, __sgl, __nents, __len); \ }) |
86d488031 kfifo: add record... |
714 |
|
2e956fb32 kfifo: replace th... |
715 716 717 |
/** * kfifo_dma_out_finish - finish a DMA OUT operation * @fifo: address of the fifo to be used |
da3dae54e Documentation: Do... |
718 |
* @len: number of bytes transferred |
2e956fb32 kfifo: replace th... |
719 720 721 722 723 724 725 726 727 |
* * This macro finish a DMA OUT operation. The out counter will be updated by * the len parameter. No error checking will be done. * * Note that with only one concurrent reader and one concurrent * writer, you don't need extra locking to use these macros. */ #define kfifo_dma_out_finish(fifo, len) \ (void)({ \ |
e0bf1024b kfifo: add parent... |
728 |
typeof((fifo) + 1) __tmp = (fifo); \ |
2e956fb32 kfifo: replace th... |
729 730 731 732 733 734 735 736 |
unsigned int __len = (len); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ if (__recsize) \ __kfifo_dma_out_finish_r(__kfifo, __recsize); \ else \ __kfifo->out += __len / sizeof(*__tmp->type); \ }) |
86d488031 kfifo: add record... |
737 738 |
/** |
2e956fb32 kfifo: replace th... |
739 740 741 742 |
* kfifo_out_peek - gets some data from the fifo * @fifo: address of the fifo to be used * @buf: pointer to the storage buffer * @n: max. number of elements to get |
86d488031 kfifo: add record... |
743 |
* |
2e956fb32 kfifo: replace th... |
744 745 |
* This macro get the data from the fifo and return the numbers of elements * copied. The data is not removed from the fifo. |
86d488031 kfifo: add record... |
746 747 |
* * Note that with only one concurrent reader and one concurrent |
2e956fb32 kfifo: replace th... |
748 |
* writer, you don't need extra locking to use these macro. |
86d488031 kfifo: add record... |
749 |
*/ |
2e956fb32 kfifo: replace th... |
750 |
#define kfifo_out_peek(fifo, buf, n) \ |
144ecf310 kfifo: fix kfifo_... |
751 |
__kfifo_uint_must_check_helper( \ |
2e956fb32 kfifo: replace th... |
752 |
({ \ |
e0bf1024b kfifo: add parent... |
753 |
typeof((fifo) + 1) __tmp = (fifo); \ |
498d319bb kfifo API type sa... |
754 |
typeof(__tmp->ptr) __buf = (buf); \ |
2e956fb32 kfifo: replace th... |
755 756 757 |
unsigned long __n = (n); \ const size_t __recsize = sizeof(*__tmp->rectype); \ struct __kfifo *__kfifo = &__tmp->kfifo; \ |
2e956fb32 kfifo: replace th... |
758 759 760 761 762 |
(__recsize) ? \ __kfifo_out_peek_r(__kfifo, __buf, __n, __recsize) : \ __kfifo_out_peek(__kfifo, __buf, __n); \ }) \ ) |
86d488031 kfifo: add record... |
763 |
|
2e956fb32 kfifo: replace th... |
764 765 |
extern int __kfifo_alloc(struct __kfifo *fifo, unsigned int size, size_t esize, gfp_t gfp_mask); |
86d488031 kfifo: add record... |
766 |
|
2e956fb32 kfifo: replace th... |
767 |
extern void __kfifo_free(struct __kfifo *fifo); |
86d488031 kfifo: add record... |
768 |
|
2e956fb32 kfifo: replace th... |
769 770 |
extern int __kfifo_init(struct __kfifo *fifo, void *buffer, unsigned int size, size_t esize); |
86d488031 kfifo: add record... |
771 |
|
2e956fb32 kfifo: replace th... |
772 773 |
extern unsigned int __kfifo_in(struct __kfifo *fifo, const void *buf, unsigned int len); |
86d488031 kfifo: add record... |
774 |
|
2e956fb32 kfifo: replace th... |
775 776 |
extern unsigned int __kfifo_out(struct __kfifo *fifo, void *buf, unsigned int len); |
86d488031 kfifo: add record... |
777 |
|
2e956fb32 kfifo: replace th... |
778 779 |
extern int __kfifo_from_user(struct __kfifo *fifo, const void __user *from, unsigned long len, unsigned int *copied); |
86d488031 kfifo: add record... |
780 |
|
2e956fb32 kfifo: replace th... |
781 782 |
extern int __kfifo_to_user(struct __kfifo *fifo, void __user *to, unsigned long len, unsigned int *copied); |
86d488031 kfifo: add record... |
783 |
|
2e956fb32 kfifo: replace th... |
784 785 |
extern unsigned int __kfifo_dma_in_prepare(struct __kfifo *fifo, struct scatterlist *sgl, int nents, unsigned int len); |
86d488031 kfifo: add record... |
786 |
|
2e956fb32 kfifo: replace th... |
787 788 |
extern unsigned int __kfifo_dma_out_prepare(struct __kfifo *fifo, struct scatterlist *sgl, int nents, unsigned int len); |
86d488031 kfifo: add record... |
789 |
|
2e956fb32 kfifo: replace th... |
790 791 |
extern unsigned int __kfifo_out_peek(struct __kfifo *fifo, void *buf, unsigned int len); |
86d488031 kfifo: add record... |
792 |
|
2e956fb32 kfifo: replace th... |
793 794 |
extern unsigned int __kfifo_in_r(struct __kfifo *fifo, const void *buf, unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
795 |
|
2e956fb32 kfifo: replace th... |
796 797 |
extern unsigned int __kfifo_out_r(struct __kfifo *fifo, void *buf, unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
798 |
|
2e956fb32 kfifo: replace th... |
799 800 801 |
extern int __kfifo_from_user_r(struct __kfifo *fifo, const void __user *from, unsigned long len, unsigned int *copied, size_t recsize); |
86d488031 kfifo: add record... |
802 |
|
2e956fb32 kfifo: replace th... |
803 804 |
extern int __kfifo_to_user_r(struct __kfifo *fifo, void __user *to, unsigned long len, unsigned int *copied, size_t recsize); |
86d488031 kfifo: add record... |
805 |
|
2e956fb32 kfifo: replace th... |
806 807 |
extern unsigned int __kfifo_dma_in_prepare_r(struct __kfifo *fifo, struct scatterlist *sgl, int nents, unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
808 |
|
2e956fb32 kfifo: replace th... |
809 810 |
extern void __kfifo_dma_in_finish_r(struct __kfifo *fifo, unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
811 |
|
2e956fb32 kfifo: replace th... |
812 813 |
extern unsigned int __kfifo_dma_out_prepare_r(struct __kfifo *fifo, struct scatterlist *sgl, int nents, unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
814 |
|
2e956fb32 kfifo: replace th... |
815 |
extern void __kfifo_dma_out_finish_r(struct __kfifo *fifo, size_t recsize); |
86d488031 kfifo: add record... |
816 |
|
2e956fb32 kfifo: replace th... |
817 |
extern unsigned int __kfifo_len_r(struct __kfifo *fifo, size_t recsize); |
86d488031 kfifo: add record... |
818 |
|
b35de43b3 kfifo: implement ... |
819 |
extern void __kfifo_skip_r(struct __kfifo *fifo, size_t recsize); |
2e956fb32 kfifo: replace th... |
820 821 |
extern unsigned int __kfifo_out_peek_r(struct __kfifo *fifo, void *buf, unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
822 |
|
2e956fb32 kfifo: replace th... |
823 |
extern unsigned int __kfifo_max_r(unsigned int len, size_t recsize); |
86d488031 kfifo: add record... |
824 |
|
1da177e4c Linux-2.6.12-rc2 |
825 |
#endif |