n_tty: Don't wrap input buffer indices at buffer size

Wrap read_buf indices (read_head, read_tail, canon_head) at
max representable value, instead of at the N_TTY_BUF_SIZE. This step
is necessary to allow lockless reads of these shared variables
(by updating the variables atomically).

Signed-off-by: Peter Hurley <peter@hurleysoftware.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Peter Hurley 2013-06-15 09:14:21 -04:00 committed by Greg Kroah-Hartman
parent ce74117a18
commit bc5a5e3f45

View file

@ -96,8 +96,8 @@ struct n_tty_data {
DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE); DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
char *read_buf; char *read_buf;
int read_head; size_t read_head;
int read_tail; size_t read_tail;
int read_cnt; int read_cnt;
int minimum_to_wake; int minimum_to_wake;
@ -106,7 +106,7 @@ struct n_tty_data {
unsigned int echo_cnt; unsigned int echo_cnt;
int canon_data; int canon_data;
unsigned long canon_head; size_t canon_head;
unsigned int canon_column; unsigned int canon_column;
struct mutex atomic_read_lock; struct mutex atomic_read_lock;
@ -120,6 +120,16 @@ static inline size_t read_cnt(struct n_tty_data *ldata)
return ldata->read_cnt; return ldata->read_cnt;
} }
static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
{
return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
}
static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
{
return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
}
static inline int tty_put_user(struct tty_struct *tty, unsigned char x, static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
unsigned char __user *ptr) unsigned char __user *ptr)
{ {
@ -186,8 +196,8 @@ static void n_tty_set_room(struct tty_struct *tty)
static void put_tty_queue_nolock(unsigned char c, struct n_tty_data *ldata) static void put_tty_queue_nolock(unsigned char c, struct n_tty_data *ldata)
{ {
if (read_cnt(ldata) < N_TTY_BUF_SIZE) { if (read_cnt(ldata) < N_TTY_BUF_SIZE) {
ldata->read_buf[ldata->read_head] = c; *read_buf_addr(ldata, ldata->read_head) = c;
ldata->read_head = (ldata->read_head + 1) & (N_TTY_BUF_SIZE-1); ldata->read_head++;
ldata->read_cnt++; ldata->read_cnt++;
} }
} }
@ -289,13 +299,10 @@ static ssize_t chars_in_buffer(struct tty_struct *tty)
ssize_t n = 0; ssize_t n = 0;
raw_spin_lock_irqsave(&ldata->read_lock, flags); raw_spin_lock_irqsave(&ldata->read_lock, flags);
if (!ldata->icanon) { if (!ldata->icanon)
n = read_cnt(ldata); n = read_cnt(ldata);
} else if (ldata->canon_data) { else
n = (ldata->canon_head > ldata->read_tail) ? n = ldata->canon_head - ldata->read_tail;
ldata->canon_head - ldata->read_tail :
ldata->canon_head + (N_TTY_BUF_SIZE - ldata->read_tail);
}
raw_spin_unlock_irqrestore(&ldata->read_lock, flags); raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
return n; return n;
} }
@ -918,7 +925,9 @@ static void eraser(unsigned char c, struct tty_struct *tty)
{ {
struct n_tty_data *ldata = tty->disc_data; struct n_tty_data *ldata = tty->disc_data;
enum { ERASE, WERASE, KILL } kill_type; enum { ERASE, WERASE, KILL } kill_type;
int head, seen_alnums, cnt; size_t head;
size_t cnt;
int seen_alnums;
unsigned long flags; unsigned long flags;
/* FIXME: locking needed ? */ /* FIXME: locking needed ? */
@ -962,8 +971,8 @@ static void eraser(unsigned char c, struct tty_struct *tty)
/* erase a single possibly multibyte character */ /* erase a single possibly multibyte character */
do { do {
head = (head - 1) & (N_TTY_BUF_SIZE-1); head--;
c = ldata->read_buf[head]; c = read_buf(ldata, head);
} while (is_continuation(c, tty) && head != ldata->canon_head); } while (is_continuation(c, tty) && head != ldata->canon_head);
/* do not partially erase */ /* do not partially erase */
@ -977,7 +986,7 @@ static void eraser(unsigned char c, struct tty_struct *tty)
else if (seen_alnums) else if (seen_alnums)
break; break;
} }
cnt = (ldata->read_head - head) & (N_TTY_BUF_SIZE-1); cnt = ldata->read_head - head;
raw_spin_lock_irqsave(&ldata->read_lock, flags); raw_spin_lock_irqsave(&ldata->read_lock, flags);
ldata->read_head = head; ldata->read_head = head;
ldata->read_cnt -= cnt; ldata->read_cnt -= cnt;
@ -991,9 +1000,8 @@ static void eraser(unsigned char c, struct tty_struct *tty)
/* if cnt > 1, output a multi-byte character */ /* if cnt > 1, output a multi-byte character */
echo_char(c, tty); echo_char(c, tty);
while (--cnt > 0) { while (--cnt > 0) {
head = (head+1) & (N_TTY_BUF_SIZE-1); head++;
echo_char_raw(ldata->read_buf[head], echo_char_raw(read_buf(ldata, head), ldata);
ldata);
echo_move_back_col(ldata); echo_move_back_col(ldata);
} }
} else if (kill_type == ERASE && !L_ECHOE(tty)) { } else if (kill_type == ERASE && !L_ECHOE(tty)) {
@ -1001,7 +1009,7 @@ static void eraser(unsigned char c, struct tty_struct *tty)
} else if (c == '\t') { } else if (c == '\t') {
unsigned int num_chars = 0; unsigned int num_chars = 0;
int after_tab = 0; int after_tab = 0;
unsigned long tail = ldata->read_head; size_t tail = ldata->read_head;
/* /*
* Count the columns used for characters * Count the columns used for characters
@ -1011,8 +1019,8 @@ static void eraser(unsigned char c, struct tty_struct *tty)
* number of columns. * number of columns.
*/ */
while (tail != ldata->canon_head) { while (tail != ldata->canon_head) {
tail = (tail-1) & (N_TTY_BUF_SIZE-1); tail--;
c = ldata->read_buf[tail]; c = read_buf(ldata, tail);
if (c == '\t') { if (c == '\t') {
after_tab = 1; after_tab = 1;
break; break;
@ -1296,14 +1304,14 @@ static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
} }
if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && if (c == REPRINT_CHAR(tty) && L_ECHO(tty) &&
L_IEXTEN(tty)) { L_IEXTEN(tty)) {
unsigned long tail = ldata->canon_head; size_t tail = ldata->canon_head;
finish_erasing(ldata); finish_erasing(ldata);
echo_char(c, tty); echo_char(c, tty);
echo_char_raw('\n', ldata); echo_char_raw('\n', ldata);
while (tail != ldata->read_head) { while (tail != ldata->read_head) {
echo_char(ldata->read_buf[tail], tty); echo_char(read_buf(ldata, tail), tty);
tail = (tail+1) & (N_TTY_BUF_SIZE-1); tail++;
} }
process_echoes(tty); process_echoes(tty);
return; return;
@ -1356,7 +1364,7 @@ static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
handle_newline: handle_newline:
raw_spin_lock_irqsave(&ldata->read_lock, flags); raw_spin_lock_irqsave(&ldata->read_lock, flags);
set_bit(ldata->read_head, ldata->read_flags); set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
put_tty_queue_nolock(c, ldata); put_tty_queue_nolock(c, ldata);
ldata->canon_head = ldata->read_head; ldata->canon_head = ldata->read_head;
ldata->canon_data++; ldata->canon_data++;
@ -1436,19 +1444,19 @@ static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
if (ldata->real_raw) { if (ldata->real_raw) {
raw_spin_lock_irqsave(&ldata->read_lock, cpuflags); raw_spin_lock_irqsave(&ldata->read_lock, cpuflags);
i = min(N_TTY_BUF_SIZE - read_cnt(ldata), i = min(N_TTY_BUF_SIZE - read_cnt(ldata),
N_TTY_BUF_SIZE - ldata->read_head); N_TTY_BUF_SIZE - (ldata->read_head & (N_TTY_BUF_SIZE - 1)));
i = min(count, i); i = min(count, i);
memcpy(ldata->read_buf + ldata->read_head, cp, i); memcpy(read_buf_addr(ldata, ldata->read_head), cp, i);
ldata->read_head = (ldata->read_head + i) & (N_TTY_BUF_SIZE-1); ldata->read_head += i;
ldata->read_cnt += i; ldata->read_cnt += i;
cp += i; cp += i;
count -= i; count -= i;
i = min(N_TTY_BUF_SIZE - read_cnt(ldata), i = min(N_TTY_BUF_SIZE - read_cnt(ldata),
N_TTY_BUF_SIZE - ldata->read_head); N_TTY_BUF_SIZE - (ldata->read_head & (N_TTY_BUF_SIZE - 1)));
i = min(count, i); i = min(count, i);
memcpy(ldata->read_buf + ldata->read_head, cp, i); memcpy(read_buf_addr(ldata, ldata->read_head), cp, i);
ldata->read_head = (ldata->read_head + i) & (N_TTY_BUF_SIZE-1); ldata->read_head += i;
ldata->read_cnt += i; ldata->read_cnt += i;
raw_spin_unlock_irqrestore(&ldata->read_lock, cpuflags); raw_spin_unlock_irqrestore(&ldata->read_lock, cpuflags);
} else { } else {
@ -1739,21 +1747,21 @@ static int copy_from_read_buf(struct tty_struct *tty,
size_t n; size_t n;
unsigned long flags; unsigned long flags;
bool is_eof; bool is_eof;
size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
retval = 0; retval = 0;
raw_spin_lock_irqsave(&ldata->read_lock, flags); raw_spin_lock_irqsave(&ldata->read_lock, flags);
n = min(read_cnt(ldata), N_TTY_BUF_SIZE - ldata->read_tail); n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
n = min(*nr, n); n = min(*nr, n);
raw_spin_unlock_irqrestore(&ldata->read_lock, flags); raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
if (n) { if (n) {
retval = copy_to_user(*b, &ldata->read_buf[ldata->read_tail], n); retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
n -= retval; n -= retval;
is_eof = n == 1 && is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
ldata->read_buf[ldata->read_tail] == EOF_CHAR(tty); tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
tty_audit_add_data(tty, &ldata->read_buf[ldata->read_tail], n,
ldata->icanon); ldata->icanon);
raw_spin_lock_irqsave(&ldata->read_lock, flags); raw_spin_lock_irqsave(&ldata->read_lock, flags);
ldata->read_tail = (ldata->read_tail + n) & (N_TTY_BUF_SIZE-1); ldata->read_tail += n;
ldata->read_cnt -= n; ldata->read_cnt -= n;
/* Turn single EOF into zero-length read */ /* Turn single EOF into zero-length read */
if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata)) if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
@ -1785,8 +1793,9 @@ static int canon_copy_from_read_buf(struct tty_struct *tty,
struct n_tty_data *ldata = tty->disc_data; struct n_tty_data *ldata = tty->disc_data;
unsigned long flags; unsigned long flags;
size_t n, size, more, c; size_t n, size, more, c;
unsigned long eol; size_t eol;
int ret, tail, found = 0; size_t tail;
int ret, found = 0;
/* N.B. avoid overrun if nr == 0 */ /* N.B. avoid overrun if nr == 0 */
@ -1798,10 +1807,10 @@ static int canon_copy_from_read_buf(struct tty_struct *tty,
return 0; return 0;
} }
tail = ldata->read_tail; tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
size = min_t(size_t, tail + n, N_TTY_BUF_SIZE); size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
n_tty_trace("%s: nr:%zu tail:%d n:%zu size:%zu\n", n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
__func__, *nr, tail, n, size); __func__, *nr, tail, n, size);
eol = find_next_bit(ldata->read_flags, size, tail); eol = find_next_bit(ldata->read_flags, size, tail);
@ -1818,21 +1827,21 @@ static int canon_copy_from_read_buf(struct tty_struct *tty,
n = (found + eol + size) & (N_TTY_BUF_SIZE - 1); n = (found + eol + size) & (N_TTY_BUF_SIZE - 1);
c = n; c = n;
if (found && ldata->read_buf[eol] == __DISABLED_CHAR) if (found && read_buf(ldata, eol) == __DISABLED_CHAR)
n--; n--;
n_tty_trace("%s: eol:%lu found:%d n:%zu c:%zu size:%zu more:%zu\n", n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
__func__, eol, found, n, c, size, more); __func__, eol, found, n, c, size, more);
raw_spin_unlock_irqrestore(&ldata->read_lock, flags); raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
if (n > size) { if (n > size) {
ret = copy_to_user(*b, &ldata->read_buf[tail], size); ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
if (ret) if (ret)
return -EFAULT; return -EFAULT;
ret = copy_to_user(*b + size, ldata->read_buf, n - size); ret = copy_to_user(*b + size, ldata->read_buf, n - size);
} else } else
ret = copy_to_user(*b, &ldata->read_buf[tail], n); ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
if (ret) if (ret)
return -EFAULT; return -EFAULT;
@ -1840,7 +1849,7 @@ static int canon_copy_from_read_buf(struct tty_struct *tty,
*nr -= n; *nr -= n;
raw_spin_lock_irqsave(&ldata->read_lock, flags); raw_spin_lock_irqsave(&ldata->read_lock, flags);
ldata->read_tail = (ldata->read_tail + c) & (N_TTY_BUF_SIZE - 1); ldata->read_tail += c;
ldata->read_cnt -= c; ldata->read_cnt -= c;
if (found) { if (found) {
__clear_bit(eol, ldata->read_flags); __clear_bit(eol, ldata->read_flags);
@ -2230,19 +2239,19 @@ static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
static unsigned long inq_canon(struct n_tty_data *ldata) static unsigned long inq_canon(struct n_tty_data *ldata)
{ {
int nr, head, tail; size_t nr, head, tail;
if (!ldata->canon_data) if (!ldata->canon_data)
return 0; return 0;
head = ldata->canon_head; head = ldata->canon_head;
tail = ldata->read_tail; tail = ldata->read_tail;
nr = (head - tail) & (N_TTY_BUF_SIZE-1); nr = head - tail;
/* Skip EOF-chars.. */ /* Skip EOF-chars.. */
while (head != tail) { while (head != tail) {
if (test_bit(tail, ldata->read_flags) && if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
ldata->read_buf[tail] == __DISABLED_CHAR) read_buf(ldata, tail) == __DISABLED_CHAR)
nr--; nr--;
tail = (tail+1) & (N_TTY_BUF_SIZE-1); tail++;
} }
return nr; return nr;
} }