![Kees Cook](/assets/img/avatar_default.png)
This converts all remaining cases of the old setup_timer() API into using timer_setup(), where the callback argument is the structure already holding the struct timer_list. These should have no behavioral changes, since they just change which pointer is passed into the callback with the same available pointers after conversion. It handles the following examples, in addition to some other variations. Casting from unsigned long: void my_callback(unsigned long data) { struct something *ptr = (struct something *)data; ... } ... setup_timer(&ptr->my_timer, my_callback, ptr); and forced object casts: void my_callback(struct something *ptr) { ... } ... setup_timer(&ptr->my_timer, my_callback, (unsigned long)ptr); become: void my_callback(struct timer_list *t) { struct something *ptr = from_timer(ptr, t, my_timer); ... } ... timer_setup(&ptr->my_timer, my_callback, 0); Direct function assignments: void my_callback(unsigned long data) { struct something *ptr = (struct something *)data; ... } ... ptr->my_timer.function = my_callback; have a temporary cast added, along with converting the args: void my_callback(struct timer_list *t) { struct something *ptr = from_timer(ptr, t, my_timer); ... } ... ptr->my_timer.function = (TIMER_FUNC_TYPE)my_callback; And finally, callbacks without a data assignment: void my_callback(unsigned long data) { ... } ... setup_timer(&ptr->my_timer, my_callback, 0); have their argument renamed to verify they're unused during conversion: void my_callback(struct timer_list *unused) { ... } ... timer_setup(&ptr->my_timer, my_callback, 0); The conversion is done with the following Coccinelle script: spatch --very-quiet --all-includes --include-headers \ -I ./arch/x86/include -I ./arch/x86/include/generated \ -I ./include -I ./arch/x86/include/uapi \ -I ./arch/x86/include/generated/uapi -I ./include/uapi \ -I ./include/generated/uapi --include ./include/linux/kconfig.h \ --dir . \ --cocci-file ~/src/data/timer_setup.cocci @fix_address_of@ expression e; @@ setup_timer( -&(e) +&e , ...) // Update any raw setup_timer() usages that have a NULL callback, but // would otherwise match change_timer_function_usage, since the latter // will update all function assignments done in the face of a NULL // function initialization in setup_timer(). @change_timer_function_usage_NULL@ expression _E; identifier _timer; type _cast_data; @@ ( -setup_timer(&_E->_timer, NULL, _E); +timer_setup(&_E->_timer, NULL, 0); | -setup_timer(&_E->_timer, NULL, (_cast_data)_E); +timer_setup(&_E->_timer, NULL, 0); | -setup_timer(&_E._timer, NULL, &_E); +timer_setup(&_E._timer, NULL, 0); | -setup_timer(&_E._timer, NULL, (_cast_data)&_E); +timer_setup(&_E._timer, NULL, 0); ) @change_timer_function_usage@ expression _E; identifier _timer; struct timer_list _stl; identifier _callback; type _cast_func, _cast_data; @@ ( -setup_timer(&_E->_timer, _callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, &_callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, _callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, &_callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)_callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)&_callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)_callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)&_callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E._timer, _callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, _callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, &_callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, &_callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)_callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)_callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)&_callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)&_callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | _E->_timer@_stl.function = _callback; | _E->_timer@_stl.function = &_callback; | _E->_timer@_stl.function = (_cast_func)_callback; | _E->_timer@_stl.function = (_cast_func)&_callback; | _E._timer@_stl.function = _callback; | _E._timer@_stl.function = &_callback; | _E._timer@_stl.function = (_cast_func)_callback; | _E._timer@_stl.function = (_cast_func)&_callback; ) // callback(unsigned long arg) @change_callback_handle_cast depends on change_timer_function_usage@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _origtype; identifier _origarg; type _handletype; identifier _handle; @@ void _callback( -_origtype _origarg +struct timer_list *t ) { ( ... when != _origarg _handletype *_handle = -(_handletype *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg | ... when != _origarg _handletype *_handle = -(void *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg | ... when != _origarg _handletype *_handle; ... when != _handle _handle = -(_handletype *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg | ... when != _origarg _handletype *_handle; ... when != _handle _handle = -(void *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg ) } // callback(unsigned long arg) without existing variable @change_callback_handle_cast_no_arg depends on change_timer_function_usage && !change_callback_handle_cast@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _origtype; identifier _origarg; type _handletype; @@ void _callback( -_origtype _origarg +struct timer_list *t ) { + _handletype *_origarg = from_timer(_origarg, t, _timer); + ... when != _origarg - (_handletype *)_origarg + _origarg ... when != _origarg } // Avoid already converted callbacks. @match_callback_converted depends on change_timer_function_usage && !change_callback_handle_cast && !change_callback_handle_cast_no_arg@ identifier change_timer_function_usage._callback; identifier t; @@ void _callback(struct timer_list *t) { ... } // callback(struct something *handle) @change_callback_handle_arg depends on change_timer_function_usage && !match_callback_converted && !change_callback_handle_cast && !change_callback_handle_cast_no_arg@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _handletype; identifier _handle; @@ void _callback( -_handletype *_handle +struct timer_list *t ) { + _handletype *_handle = from_timer(_handle, t, _timer); ... } // If change_callback_handle_arg ran on an empty function, remove // the added handler. @unchange_callback_handle_arg depends on change_timer_function_usage && change_callback_handle_arg@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _handletype; identifier _handle; identifier t; @@ void _callback(struct timer_list *t) { - _handletype *_handle = from_timer(_handle, t, _timer); } // We only want to refactor the setup_timer() data argument if we've found // the matching callback. This undoes changes in change_timer_function_usage. @unchange_timer_function_usage depends on change_timer_function_usage && !change_callback_handle_cast && !change_callback_handle_cast_no_arg && !change_callback_handle_arg@ expression change_timer_function_usage._E; identifier change_timer_function_usage._timer; identifier change_timer_function_usage._callback; type change_timer_function_usage._cast_data; @@ ( -timer_setup(&_E->_timer, _callback, 0); +setup_timer(&_E->_timer, _callback, (_cast_data)_E); | -timer_setup(&_E._timer, _callback, 0); +setup_timer(&_E._timer, _callback, (_cast_data)&_E); ) // If we fixed a callback from a .function assignment, fix the // assignment cast now. @change_timer_function_assignment depends on change_timer_function_usage && (change_callback_handle_cast || change_callback_handle_cast_no_arg || change_callback_handle_arg)@ expression change_timer_function_usage._E; identifier change_timer_function_usage._timer; identifier change_timer_function_usage._callback; type _cast_func; typedef TIMER_FUNC_TYPE; @@ ( _E->_timer.function = -_callback +(TIMER_FUNC_TYPE)_callback ; | _E->_timer.function = -&_callback +(TIMER_FUNC_TYPE)_callback ; | _E->_timer.function = -(_cast_func)_callback; +(TIMER_FUNC_TYPE)_callback ; | _E->_timer.function = -(_cast_func)&_callback +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -_callback +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -&_callback; +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -(_cast_func)_callback +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -(_cast_func)&_callback +(TIMER_FUNC_TYPE)_callback ; ) // Sometimes timer functions are called directly. Replace matched args. @change_timer_function_calls depends on change_timer_function_usage && (change_callback_handle_cast || change_callback_handle_cast_no_arg || change_callback_handle_arg)@ expression _E; identifier change_timer_function_usage._timer; identifier change_timer_function_usage._callback; type _cast_data; @@ _callback( ( -(_cast_data)_E +&_E->_timer | -(_cast_data)&_E +&_E._timer | -_E +&_E->_timer ) ) // If a timer has been configured without a data argument, it can be // converted without regard to the callback argument, since it is unused. @match_timer_function_unused_data@ expression _E; identifier _timer; identifier _callback; @@ ( -setup_timer(&_E->_timer, _callback, 0); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, _callback, 0L); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, _callback, 0UL); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E._timer, _callback, 0); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, _callback, 0L); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, _callback, 0UL); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_timer, _callback, 0); +timer_setup(&_timer, _callback, 0); | -setup_timer(&_timer, _callback, 0L); +timer_setup(&_timer, _callback, 0); | -setup_timer(&_timer, _callback, 0UL); +timer_setup(&_timer, _callback, 0); | -setup_timer(_timer, _callback, 0); +timer_setup(_timer, _callback, 0); | -setup_timer(_timer, _callback, 0L); +timer_setup(_timer, _callback, 0); | -setup_timer(_timer, _callback, 0UL); +timer_setup(_timer, _callback, 0); ) @change_callback_unused_data depends on match_timer_function_unused_data@ identifier match_timer_function_unused_data._callback; type _origtype; identifier _origarg; @@ void _callback( -_origtype _origarg +struct timer_list *unused ) { ... when != _origarg } Signed-off-by: Kees Cook <keescook@chromium.org>
297 lines
6.1 KiB
C
297 lines
6.1 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
||
/*
|
||
* linux/arch/alpha/kernel/srmcons.c
|
||
*
|
||
* Callback based driver for SRM Console console device.
|
||
* (TTY driver and console driver)
|
||
*/
|
||
|
||
#include <linux/kernel.h>
|
||
#include <linux/init.h>
|
||
#include <linux/console.h>
|
||
#include <linux/delay.h>
|
||
#include <linux/mm.h>
|
||
#include <linux/slab.h>
|
||
#include <linux/spinlock.h>
|
||
#include <linux/timer.h>
|
||
#include <linux/tty.h>
|
||
#include <linux/tty_driver.h>
|
||
#include <linux/tty_flip.h>
|
||
|
||
#include <asm/console.h>
|
||
#include <linux/uaccess.h>
|
||
|
||
|
||
static DEFINE_SPINLOCK(srmcons_callback_lock);
|
||
static int srm_is_registered_console = 0;
|
||
|
||
/*
|
||
* The TTY driver
|
||
*/
|
||
#define MAX_SRM_CONSOLE_DEVICES 1 /* only support 1 console device */
|
||
|
||
struct srmcons_private {
|
||
struct tty_port port;
|
||
struct timer_list timer;
|
||
} srmcons_singleton;
|
||
|
||
typedef union _srmcons_result {
|
||
struct {
|
||
unsigned long c :61;
|
||
unsigned long status :3;
|
||
} bits;
|
||
long as_long;
|
||
} srmcons_result;
|
||
|
||
/* called with callback_lock held */
|
||
static int
|
||
srmcons_do_receive_chars(struct tty_port *port)
|
||
{
|
||
srmcons_result result;
|
||
int count = 0, loops = 0;
|
||
|
||
do {
|
||
result.as_long = callback_getc(0);
|
||
if (result.bits.status < 2) {
|
||
tty_insert_flip_char(port, (char)result.bits.c, 0);
|
||
count++;
|
||
}
|
||
} while((result.bits.status & 1) && (++loops < 10));
|
||
|
||
if (count)
|
||
tty_schedule_flip(port);
|
||
|
||
return count;
|
||
}
|
||
|
||
static void
|
||
srmcons_receive_chars(struct timer_list *t)
|
||
{
|
||
struct srmcons_private *srmconsp = from_timer(srmconsp, t, timer);
|
||
struct tty_port *port = &srmconsp->port;
|
||
unsigned long flags;
|
||
int incr = 10;
|
||
|
||
local_irq_save(flags);
|
||
if (spin_trylock(&srmcons_callback_lock)) {
|
||
if (!srmcons_do_receive_chars(port))
|
||
incr = 100;
|
||
spin_unlock(&srmcons_callback_lock);
|
||
}
|
||
|
||
spin_lock(&port->lock);
|
||
if (port->tty)
|
||
mod_timer(&srmconsp->timer, jiffies + incr);
|
||
spin_unlock(&port->lock);
|
||
|
||
local_irq_restore(flags);
|
||
}
|
||
|
||
/* called with callback_lock held */
|
||
static int
|
||
srmcons_do_write(struct tty_port *port, const char *buf, int count)
|
||
{
|
||
static char str_cr[1] = "\r";
|
||
long c, remaining = count;
|
||
srmcons_result result;
|
||
char *cur;
|
||
int need_cr;
|
||
|
||
for (cur = (char *)buf; remaining > 0; ) {
|
||
need_cr = 0;
|
||
/*
|
||
* Break it up into reasonable size chunks to allow a chance
|
||
* for input to get in
|
||
*/
|
||
for (c = 0; c < min_t(long, 128L, remaining) && !need_cr; c++)
|
||
if (cur[c] == '\n')
|
||
need_cr = 1;
|
||
|
||
while (c > 0) {
|
||
result.as_long = callback_puts(0, cur, c);
|
||
c -= result.bits.c;
|
||
remaining -= result.bits.c;
|
||
cur += result.bits.c;
|
||
|
||
/*
|
||
* Check for pending input iff a tty port was provided
|
||
*/
|
||
if (port)
|
||
srmcons_do_receive_chars(port);
|
||
}
|
||
|
||
while (need_cr) {
|
||
result.as_long = callback_puts(0, str_cr, 1);
|
||
if (result.bits.c > 0)
|
||
need_cr = 0;
|
||
}
|
||
}
|
||
return count;
|
||
}
|
||
|
||
static int
|
||
srmcons_write(struct tty_struct *tty,
|
||
const unsigned char *buf, int count)
|
||
{
|
||
unsigned long flags;
|
||
|
||
spin_lock_irqsave(&srmcons_callback_lock, flags);
|
||
srmcons_do_write(tty->port, (const char *) buf, count);
|
||
spin_unlock_irqrestore(&srmcons_callback_lock, flags);
|
||
|
||
return count;
|
||
}
|
||
|
||
static int
|
||
srmcons_write_room(struct tty_struct *tty)
|
||
{
|
||
return 512;
|
||
}
|
||
|
||
static int
|
||
srmcons_chars_in_buffer(struct tty_struct *tty)
|
||
{
|
||
return 0;
|
||
}
|
||
|
||
static int
|
||
srmcons_open(struct tty_struct *tty, struct file *filp)
|
||
{
|
||
struct srmcons_private *srmconsp = &srmcons_singleton;
|
||
struct tty_port *port = &srmconsp->port;
|
||
unsigned long flags;
|
||
|
||
spin_lock_irqsave(&port->lock, flags);
|
||
|
||
if (!port->tty) {
|
||
tty->driver_data = srmconsp;
|
||
tty->port = port;
|
||
port->tty = tty; /* XXX proper refcounting */
|
||
mod_timer(&srmconsp->timer, jiffies + 10);
|
||
}
|
||
|
||
spin_unlock_irqrestore(&port->lock, flags);
|
||
|
||
return 0;
|
||
}
|
||
|
||
static void
|
||
srmcons_close(struct tty_struct *tty, struct file *filp)
|
||
{
|
||
struct srmcons_private *srmconsp = tty->driver_data;
|
||
struct tty_port *port = &srmconsp->port;
|
||
unsigned long flags;
|
||
|
||
spin_lock_irqsave(&port->lock, flags);
|
||
|
||
if (tty->count == 1) {
|
||
port->tty = NULL;
|
||
del_timer(&srmconsp->timer);
|
||
}
|
||
|
||
spin_unlock_irqrestore(&port->lock, flags);
|
||
}
|
||
|
||
|
||
static struct tty_driver *srmcons_driver;
|
||
|
||
static const struct tty_operations srmcons_ops = {
|
||
.open = srmcons_open,
|
||
.close = srmcons_close,
|
||
.write = srmcons_write,
|
||
.write_room = srmcons_write_room,
|
||
.chars_in_buffer= srmcons_chars_in_buffer,
|
||
};
|
||
|
||
static int __init
|
||
srmcons_init(void)
|
||
{
|
||
timer_setup(&srmcons_singleton.timer, srmcons_receive_chars, 0);
|
||
if (srm_is_registered_console) {
|
||
struct tty_driver *driver;
|
||
int err;
|
||
|
||
driver = alloc_tty_driver(MAX_SRM_CONSOLE_DEVICES);
|
||
if (!driver)
|
||
return -ENOMEM;
|
||
|
||
tty_port_init(&srmcons_singleton.port);
|
||
|
||
driver->driver_name = "srm";
|
||
driver->name = "srm";
|
||
driver->major = 0; /* dynamic */
|
||
driver->minor_start = 0;
|
||
driver->type = TTY_DRIVER_TYPE_SYSTEM;
|
||
driver->subtype = SYSTEM_TYPE_SYSCONS;
|
||
driver->init_termios = tty_std_termios;
|
||
tty_set_operations(driver, &srmcons_ops);
|
||
tty_port_link_device(&srmcons_singleton.port, driver, 0);
|
||
err = tty_register_driver(driver);
|
||
if (err) {
|
||
put_tty_driver(driver);
|
||
tty_port_destroy(&srmcons_singleton.port);
|
||
return err;
|
||
}
|
||
srmcons_driver = driver;
|
||
}
|
||
|
||
return -ENODEV;
|
||
}
|
||
device_initcall(srmcons_init);
|
||
|
||
|
||
/*
|
||
* The console driver
|
||
*/
|
||
static void
|
||
srm_console_write(struct console *co, const char *s, unsigned count)
|
||
{
|
||
unsigned long flags;
|
||
|
||
spin_lock_irqsave(&srmcons_callback_lock, flags);
|
||
srmcons_do_write(NULL, s, count);
|
||
spin_unlock_irqrestore(&srmcons_callback_lock, flags);
|
||
}
|
||
|
||
static struct tty_driver *
|
||
srm_console_device(struct console *co, int *index)
|
||
{
|
||
*index = co->index;
|
||
return srmcons_driver;
|
||
}
|
||
|
||
static int
|
||
srm_console_setup(struct console *co, char *options)
|
||
{
|
||
return 0;
|
||
}
|
||
|
||
static struct console srmcons = {
|
||
.name = "srm",
|
||
.write = srm_console_write,
|
||
.device = srm_console_device,
|
||
.setup = srm_console_setup,
|
||
.flags = CON_PRINTBUFFER | CON_BOOT,
|
||
.index = -1,
|
||
};
|
||
|
||
void __init
|
||
register_srm_console(void)
|
||
{
|
||
if (!srm_is_registered_console) {
|
||
callback_open_console();
|
||
register_console(&srmcons);
|
||
srm_is_registered_console = 1;
|
||
}
|
||
}
|
||
|
||
void __init
|
||
unregister_srm_console(void)
|
||
{
|
||
if (srm_is_registered_console) {
|
||
callback_close_console();
|
||
unregister_console(&srmcons);
|
||
srm_is_registered_console = 0;
|
||
}
|
||
}
|