diff options
| author | Stefani Seibold <stefani@seibold.net> | 2013-11-14 17:32:17 -0500 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2013-11-14 19:32:23 -0500 |
| commit | 498d319bb512992ef0784c278fa03679f2f5649d (patch) | |
| tree | 2793b41c3a98b858d24aa833ccc2bfb2f6d60974 | |
| parent | a019e48cfbfb358786326db3dbc1c565b8f14a56 (diff) | |
kfifo API type safety
This patch enhances the type safety for the kfifo API. It is now safe
to put const data into a non const FIFO and the API will now generate a
compiler warning when reading from the fifo where the destination
address is pointing to a const variable.
As a side effect the kfifo_put() does now expect the value of an element
instead a pointer to the element. This was suggested Russell King. It
make the handling of the kfifo_put easier since there is no need to
create a helper variable for getting the address of a pointer or to pass
integers of different sizes.
IMHO the API break is okay, since there are currently only six users of
kfifo_put().
The code is also cleaner by kicking out the "if (0)" expressions.
[akpm@linux-foundation.org: coding-style fixes]
Signed-off-by: Stefani Seibold <stefani@seibold.net>
Cc: Russell King <rmk@arm.linux.org.uk>
Cc: Hauke Mehrtens <hauke@hauke-m.de>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
| -rw-r--r-- | drivers/gpu/drm/drm_flip_work.c | 2 | ||||
| -rw-r--r-- | drivers/iio/industrialio-event.c | 2 | ||||
| -rw-r--r-- | drivers/net/wireless/rt2x00/rt2800mmio.c | 2 | ||||
| -rw-r--r-- | drivers/net/wireless/rt2x00/rt2800usb.c | 2 | ||||
| -rw-r--r-- | drivers/pci/pcie/aer/aerdrv_core.c | 2 | ||||
| -rw-r--r-- | include/linux/kfifo.h | 47 | ||||
| -rw-r--r-- | mm/memory-failure.c | 2 | ||||
| -rw-r--r-- | samples/kfifo/bytestream-example.c | 4 | ||||
| -rw-r--r-- | samples/kfifo/dma-example.c | 2 | ||||
| -rw-r--r-- | samples/kfifo/inttype-example.c | 4 |
10 files changed, 25 insertions, 44 deletions
diff --git a/drivers/gpu/drm/drm_flip_work.c b/drivers/gpu/drm/drm_flip_work.c index e788882d9021..f9c7fa3d0012 100644 --- a/drivers/gpu/drm/drm_flip_work.c +++ b/drivers/gpu/drm/drm_flip_work.c | |||
| @@ -34,7 +34,7 @@ | |||
| 34 | */ | 34 | */ |
| 35 | void drm_flip_work_queue(struct drm_flip_work *work, void *val) | 35 | void drm_flip_work_queue(struct drm_flip_work *work, void *val) |
| 36 | { | 36 | { |
| 37 | if (kfifo_put(&work->fifo, (const void **)&val)) { | 37 | if (kfifo_put(&work->fifo, val)) { |
| 38 | atomic_inc(&work->pending); | 38 | atomic_inc(&work->pending); |
| 39 | } else { | 39 | } else { |
| 40 | DRM_ERROR("%s fifo full!\n", work->name); | 40 | DRM_ERROR("%s fifo full!\n", work->name); |
diff --git a/drivers/iio/industrialio-event.c b/drivers/iio/industrialio-event.c index dac15b9f9df8..c10eab64bc05 100644 --- a/drivers/iio/industrialio-event.c +++ b/drivers/iio/industrialio-event.c | |||
| @@ -56,7 +56,7 @@ int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp) | |||
| 56 | ev.id = ev_code; | 56 | ev.id = ev_code; |
| 57 | ev.timestamp = timestamp; | 57 | ev.timestamp = timestamp; |
| 58 | 58 | ||
| 59 | copied = kfifo_put(&ev_int->det_events, &ev); | 59 | copied = kfifo_put(&ev_int->det_events, ev); |
| 60 | if (copied != 0) | 60 | if (copied != 0) |
| 61 | wake_up_locked_poll(&ev_int->wait, POLLIN); | 61 | wake_up_locked_poll(&ev_int->wait, POLLIN); |
| 62 | } | 62 | } |
diff --git a/drivers/net/wireless/rt2x00/rt2800mmio.c b/drivers/net/wireless/rt2x00/rt2800mmio.c index ae152280e071..a8cc736b5063 100644 --- a/drivers/net/wireless/rt2x00/rt2800mmio.c +++ b/drivers/net/wireless/rt2x00/rt2800mmio.c | |||
| @@ -446,7 +446,7 @@ static void rt2800mmio_txstatus_interrupt(struct rt2x00_dev *rt2x00dev) | |||
| 446 | if (!rt2x00_get_field32(status, TX_STA_FIFO_VALID)) | 446 | if (!rt2x00_get_field32(status, TX_STA_FIFO_VALID)) |
| 447 | break; | 447 | break; |
| 448 | 448 | ||
| 449 | if (!kfifo_put(&rt2x00dev->txstatus_fifo, &status)) { | 449 | if (!kfifo_put(&rt2x00dev->txstatus_fifo, status)) { |
| 450 | rt2x00_warn(rt2x00dev, "TX status FIFO overrun, drop tx status report\n"); | 450 | rt2x00_warn(rt2x00dev, "TX status FIFO overrun, drop tx status report\n"); |
| 451 | break; | 451 | break; |
| 452 | } | 452 | } |
diff --git a/drivers/net/wireless/rt2x00/rt2800usb.c b/drivers/net/wireless/rt2x00/rt2800usb.c index 997df03a0c2e..a81ceb61d746 100644 --- a/drivers/net/wireless/rt2x00/rt2800usb.c +++ b/drivers/net/wireless/rt2x00/rt2800usb.c | |||
| @@ -164,7 +164,7 @@ static bool rt2800usb_tx_sta_fifo_read_completed(struct rt2x00_dev *rt2x00dev, | |||
| 164 | 164 | ||
| 165 | valid = rt2x00_get_field32(tx_status, TX_STA_FIFO_VALID); | 165 | valid = rt2x00_get_field32(tx_status, TX_STA_FIFO_VALID); |
| 166 | if (valid) { | 166 | if (valid) { |
| 167 | if (!kfifo_put(&rt2x00dev->txstatus_fifo, &tx_status)) | 167 | if (!kfifo_put(&rt2x00dev->txstatus_fifo, tx_status)) |
| 168 | rt2x00_warn(rt2x00dev, "TX status FIFO overrun\n"); | 168 | rt2x00_warn(rt2x00dev, "TX status FIFO overrun\n"); |
| 169 | 169 | ||
| 170 | queue_work(rt2x00dev->workqueue, &rt2x00dev->txdone_work); | 170 | queue_work(rt2x00dev->workqueue, &rt2x00dev->txdone_work); |
diff --git a/drivers/pci/pcie/aer/aerdrv_core.c b/drivers/pci/pcie/aer/aerdrv_core.c index 85ca36f2136d..6b3a958e1be6 100644 --- a/drivers/pci/pcie/aer/aerdrv_core.c +++ b/drivers/pci/pcie/aer/aerdrv_core.c | |||
| @@ -574,7 +574,7 @@ void aer_recover_queue(int domain, unsigned int bus, unsigned int devfn, | |||
| 574 | }; | 574 | }; |
| 575 | 575 | ||
| 576 | spin_lock_irqsave(&aer_recover_ring_lock, flags); | 576 | spin_lock_irqsave(&aer_recover_ring_lock, flags); |
| 577 | if (kfifo_put(&aer_recover_ring, &entry)) | 577 | if (kfifo_put(&aer_recover_ring, entry)) |
| 578 | schedule_work(&aer_recover_work); | 578 | schedule_work(&aer_recover_work); |
| 579 | else | 579 | else |
| 580 | pr_err("AER recover: Buffer overflow when recovering AER for %04x:%02x:%02x:%x\n", | 580 | pr_err("AER recover: Buffer overflow when recovering AER for %04x:%02x:%02x:%x\n", |
diff --git a/include/linux/kfifo.h b/include/linux/kfifo.h index 10308c6a3d1c..552d51efb429 100644 --- a/include/linux/kfifo.h +++ b/include/linux/kfifo.h | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | /* | 1 | /* |
| 2 | * A generic kernel FIFO implementation | 2 | * A generic kernel FIFO implementation |
| 3 | * | 3 | * |
| 4 | * Copyright (C) 2009/2010 Stefani Seibold <stefani@seibold.net> | 4 | * Copyright (C) 2013 Stefani Seibold <stefani@seibold.net> |
| 5 | * | 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify | 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by | 7 | * it under the terms of the GNU General Public License as published by |
| @@ -67,9 +67,10 @@ struct __kfifo { | |||
| 67 | union { \ | 67 | union { \ |
| 68 | struct __kfifo kfifo; \ | 68 | struct __kfifo kfifo; \ |
| 69 | datatype *type; \ | 69 | datatype *type; \ |
| 70 | const datatype *const_type; \ | ||
| 70 | char (*rectype)[recsize]; \ | 71 | char (*rectype)[recsize]; \ |
| 71 | ptrtype *ptr; \ | 72 | ptrtype *ptr; \ |
| 72 | const ptrtype *ptr_const; \ | 73 | ptrtype const *ptr_const; \ |
| 73 | } | 74 | } |
| 74 | 75 | ||
| 75 | #define __STRUCT_KFIFO(type, size, recsize, ptrtype) \ | 76 | #define __STRUCT_KFIFO(type, size, recsize, ptrtype) \ |
| @@ -386,16 +387,12 @@ __kfifo_int_must_check_helper( \ | |||
| 386 | #define kfifo_put(fifo, val) \ | 387 | #define kfifo_put(fifo, val) \ |
| 387 | ({ \ | 388 | ({ \ |
| 388 | typeof((fifo) + 1) __tmp = (fifo); \ | 389 | typeof((fifo) + 1) __tmp = (fifo); \ |
| 389 | typeof((val) + 1) __val = (val); \ | 390 | typeof(*__tmp->const_type) __val = (val); \ |
| 390 | unsigned int __ret; \ | 391 | unsigned int __ret; \ |
| 391 | const size_t __recsize = sizeof(*__tmp->rectype); \ | 392 | size_t __recsize = sizeof(*__tmp->rectype); \ |
| 392 | struct __kfifo *__kfifo = &__tmp->kfifo; \ | 393 | struct __kfifo *__kfifo = &__tmp->kfifo; \ |
| 393 | if (0) { \ | ||
| 394 | typeof(__tmp->ptr_const) __dummy __attribute__ ((unused)); \ | ||
| 395 | __dummy = (typeof(__val))NULL; \ | ||
| 396 | } \ | ||
| 397 | if (__recsize) \ | 394 | if (__recsize) \ |
| 398 | __ret = __kfifo_in_r(__kfifo, __val, sizeof(*__val), \ | 395 | __ret = __kfifo_in_r(__kfifo, &__val, sizeof(__val), \ |
| 399 | __recsize); \ | 396 | __recsize); \ |
| 400 | else { \ | 397 | else { \ |
| 401 | __ret = !kfifo_is_full(__tmp); \ | 398 | __ret = !kfifo_is_full(__tmp); \ |
| @@ -404,7 +401,7 @@ __kfifo_int_must_check_helper( \ | |||
| 404 | ((typeof(__tmp->type))__kfifo->data) : \ | 401 | ((typeof(__tmp->type))__kfifo->data) : \ |
| 405 | (__tmp->buf) \ | 402 | (__tmp->buf) \ |
| 406 | )[__kfifo->in & __tmp->kfifo.mask] = \ | 403 | )[__kfifo->in & __tmp->kfifo.mask] = \ |
| 407 | *(typeof(__tmp->type))__val; \ | 404 | (typeof(*__tmp->type))__val; \ |
| 408 | smp_wmb(); \ | 405 | smp_wmb(); \ |
| 409 | __kfifo->in++; \ | 406 | __kfifo->in++; \ |
| 410 | } \ | 407 | } \ |
| @@ -415,7 +412,7 @@ __kfifo_int_must_check_helper( \ | |||
| 415 | /** | 412 | /** |
| 416 | * kfifo_get - get data from the fifo | 413 | * kfifo_get - get data from the fifo |
| 417 | * @fifo: address of the fifo to be used | 414 | * @fifo: address of the fifo to be used |
| 418 | * @val: the var where to store the data to be added | 415 | * @val: address where to store the data |
| 419 | * | 416 | * |
| 420 | * This macro reads the data from the fifo. | 417 | * This macro reads the data from the fifo. |
| 421 | * It returns 0 if the fifo was empty. Otherwise it returns the number | 418 | * It returns 0 if the fifo was empty. Otherwise it returns the number |
| @@ -428,12 +425,10 @@ __kfifo_int_must_check_helper( \ | |||
| 428 | __kfifo_uint_must_check_helper( \ | 425 | __kfifo_uint_must_check_helper( \ |
| 429 | ({ \ | 426 | ({ \ |
| 430 | typeof((fifo) + 1) __tmp = (fifo); \ | 427 | typeof((fifo) + 1) __tmp = (fifo); \ |
| 431 | typeof((val) + 1) __val = (val); \ | 428 | typeof(__tmp->ptr) __val = (val); \ |
| 432 | unsigned int __ret; \ | 429 | unsigned int __ret; \ |
| 433 | const size_t __recsize = sizeof(*__tmp->rectype); \ | 430 | const size_t __recsize = sizeof(*__tmp->rectype); \ |
| 434 | struct __kfifo *__kfifo = &__tmp->kfifo; \ | 431 | struct __kfifo *__kfifo = &__tmp->kfifo; \ |
| 435 | if (0) \ | ||
| 436 | __val = (typeof(__tmp->ptr))0; \ | ||
| 437 | if (__recsize) \ | 432 | if (__recsize) \ |
| 438 | __ret = __kfifo_out_r(__kfifo, __val, sizeof(*__val), \ | 433 | __ret = __kfifo_out_r(__kfifo, __val, sizeof(*__val), \ |
| 439 | __recsize); \ | 434 | __recsize); \ |
| @@ -456,7 +451,7 @@ __kfifo_uint_must_check_helper( \ | |||
| 456 | /** | 451 | /** |
| 457 | * kfifo_peek - get data from the fifo without removing | 452 | * kfifo_peek - get data from the fifo without removing |
| 458 | * @fifo: address of the fifo to be used | 453 | * @fifo: address of the fifo to be used |
| 459 | * @val: the var where to store the data to be added | 454 | * @val: address where to store the data |
| 460 | * | 455 | * |
| 461 | * This reads the data from the fifo without removing it from the fifo. | 456 | * This reads the data from the fifo without removing it from the fifo. |
| 462 | * It returns 0 if the fifo was empty. Otherwise it returns the number | ||
