diff mbox series

lib: sbi: fix missing '\r' for console

Message ID 20230211125200.10381-1-wxjstz@126.com
State Superseded
Headers show
Series lib: sbi: fix missing '\r' for console | expand

Commit Message

Xiang W Feb. 11, 2023, 12:52 p.m. UTC
print is finally implemented by sbi_putc or console_dev->puts. sbi_putc
will add a \r before the output \n. This patch adds missing \r when
outputting characters via console_dev->puts.

Signed-off-by: Xiang W <wxjstz@126.com>
---
 lib/sbi/sbi_console.c | 46 +++++++++++++++++++++++++++++--------------
 1 file changed, 31 insertions(+), 15 deletions(-)

Comments

Samuel Holland Feb. 12, 2023, 6:49 p.m. UTC | #1
On 2/11/23 06:52, Xiang W wrote:
> print is finally implemented by sbi_putc or console_dev->puts. sbi_putc
> will add a \r before the output \n. This patch adds missing \r when
> outputting characters via console_dev->puts.
> 
> Signed-off-by: Xiang W <wxjstz@126.com>
> ---
>  lib/sbi/sbi_console.c | 46 +++++++++++++++++++++++++++++--------------
>  1 file changed, 31 insertions(+), 15 deletions(-)
> 
> diff --git a/lib/sbi/sbi_console.c b/lib/sbi/sbi_console.c
> index f3ac003..7dc053a 100644
> --- a/lib/sbi/sbi_console.c
> +++ b/lib/sbi/sbi_console.c
> @@ -46,27 +46,43 @@ void sbi_putc(char ch)
>  	}
>  }
>  
> +static unsigned long console_puts_all(const char *str, unsigned long len)
> +{
> +	const char *s = str;
> +	const char *e = s + len;
> +	while (s < e)
> +		s += console_dev->console_puts(s, e - s);
> +	return len;
> +}
> +
> +static unsigned long console_puts(const char *str, unsigned long len)
> +{
> +	const char *s, *p, *e;
> +	s = str;
> +	e = str + len;
> +	while (s < e) {
> +		p = sbi_strchr(s, '\n');
> +		p = p ? p : e;
> +		console_puts_all(s, p - s);
> +		if (*p == '\n')

If p == e, it is past the end of the initialized data, so you cannot
dereference it. A better check would be:

	if (p != e)

Regards,
Samuel

> +			console_puts_all("\r\n", 2);
> +		s = p + 1;
> +	}
> +	return len;
> +}
> +
>  static unsigned long nputs(const char *str, unsigned long len)
>  {
> -	unsigned long i, ret;
> +	unsigned long i;
>  
>  	if (console_dev && console_dev->console_puts) {
> -		ret = console_dev->console_puts(str, len);
> +		console_puts(str, len);
>  	} else {
>  		for (i = 0; i < len; i++)
>  			sbi_putc(str[i]);
> -		ret = len;
>  	}
>  
> -	return ret;
> -}
> -
> -static void nputs_all(const char *str, unsigned long len)
> -{
> -	unsigned long p = 0;
> -
> -	while (p < len)
> -		p += nputs(&str[p], len - p);
> +	return len;
>  }
>  
>  void sbi_puts(const char *str)
> @@ -74,7 +90,7 @@ void sbi_puts(const char *str)
>  	unsigned long len = sbi_strlen(str);
>  
>  	spin_lock(&console_out_lock);
> -	nputs_all(str, len);
> +	nputs(str, len);
>  	spin_unlock(&console_out_lock);
>  }
>  
> @@ -255,7 +271,7 @@ static int print(char **out, u32 *out_len, const char *format, va_list args)
>  
>  	for (; *format != 0; ++format) {
>  		if (use_tbuf && !console_tbuf_len) {
> -			nputs_all(console_tbuf, CONSOLE_TBUF_MAX);
> +			nputs(console_tbuf, CONSOLE_TBUF_MAX);
>  			console_tbuf_len = CONSOLE_TBUF_MAX;
>  			tout = console_tbuf;
>  		}
> @@ -386,7 +402,7 @@ literal:
>  	}
>  
>  	if (use_tbuf && console_tbuf_len < CONSOLE_TBUF_MAX)
> -		nputs_all(console_tbuf, CONSOLE_TBUF_MAX - console_tbuf_len);
> +		nputs(console_tbuf, CONSOLE_TBUF_MAX - console_tbuf_len);
>  
>  	return pc;
>  }
Xiang W Feb. 13, 2023, 2:11 a.m. UTC | #2
在 2023-02-12星期日的 12:49 -0600,Samuel Holland写道:
> On 2/11/23 06:52, Xiang W wrote:
> > print is finally implemented by sbi_putc or console_dev->puts. sbi_putc
> > will add a \r before the output \n. This patch adds missing \r when
> > outputting characters via console_dev->puts.
> > 
> > Signed-off-by: Xiang W <wxjstz@126.com>
> > ---
> >  lib/sbi/sbi_console.c | 46 +++++++++++++++++++++++++++++--------------
> >  1 file changed, 31 insertions(+), 15 deletions(-)
> > 
> > diff --git a/lib/sbi/sbi_console.c b/lib/sbi/sbi_console.c
> > index f3ac003..7dc053a 100644
> > --- a/lib/sbi/sbi_console.c
> > +++ b/lib/sbi/sbi_console.c
> > @@ -46,27 +46,43 @@ void sbi_putc(char ch)
> >         }
> >  }
> >  
> > +static unsigned long console_puts_all(const char *str, unsigned long len)
> > +{
> > +       const char *s = str;
> > +       const char *e = s + len;
> > +       while (s < e)
> > +               s += console_dev->console_puts(s, e - s);
> > +       return len;
> > +}
> > +
> > +static unsigned long console_puts(const char *str, unsigned long len)
> > +{
> > +       const char *s, *p, *e;
> > +       s = str;
> > +       e = str + len;
> > +       while (s < e) {
> > +               p = sbi_strchr(s, '\n');
> > +               p = p ? p : e;
> > +               console_puts_all(s, p - s);
> > +               if (*p == '\n')
> 
> If p == e, it is past the end of the initialized data, so you cannot
> dereference it. A better check would be:
> 
>         if (p != e)
> 
> Regards,
> Samuel
Thank you! Good catch!

Regards,
Xiang W
> 
> > +                       console_puts_all("\r\n", 2);
> > +               s = p + 1;
> > +       }
> > +       return len;
> > +}
> > +
> >  static unsigned long nputs(const char *str, unsigned long len)
> >  {
> > -       unsigned long i, ret;
> > +       unsigned long i;
> >  
> >         if (console_dev && console_dev->console_puts) {
> > -               ret = console_dev->console_puts(str, len);
> > +               console_puts(str, len);
> >         } else {
> >                 for (i = 0; i < len; i++)
> >                         sbi_putc(str[i]);
> > -               ret = len;
> >         }
> >  
> > -       return ret;
> > -}
> > -
> > -static void nputs_all(const char *str, unsigned long len)
> > -{
> > -       unsigned long p = 0;
> > -
> > -       while (p < len)
> > -               p += nputs(&str[p], len - p);
> > +       return len;
> >  }
> >  
> >  void sbi_puts(const char *str)
> > @@ -74,7 +90,7 @@ void sbi_puts(const char *str)
> >         unsigned long len = sbi_strlen(str);
> >  
> >         spin_lock(&console_out_lock);
> > -       nputs_all(str, len);
> > +       nputs(str, len);
> >         spin_unlock(&console_out_lock);
> >  }
> >  
> > @@ -255,7 +271,7 @@ static int print(char **out, u32 *out_len, const char *format, va_list args)
> >  
> >         for (; *format != 0; ++format) {
> >                 if (use_tbuf && !console_tbuf_len) {
> > -                       nputs_all(console_tbuf, CONSOLE_TBUF_MAX);
> > +                       nputs(console_tbuf, CONSOLE_TBUF_MAX);
> >                         console_tbuf_len = CONSOLE_TBUF_MAX;
> >                         tout = console_tbuf;
> >                 }
> > @@ -386,7 +402,7 @@ literal:
> >         }
> >  
> >         if (use_tbuf && console_tbuf_len < CONSOLE_TBUF_MAX)
> > -               nputs_all(console_tbuf, CONSOLE_TBUF_MAX - console_tbuf_len);
> > +               nputs(console_tbuf, CONSOLE_TBUF_MAX - console_tbuf_len);
> >  
> >         return pc;
> >  }
diff mbox series

Patch

diff --git a/lib/sbi/sbi_console.c b/lib/sbi/sbi_console.c
index f3ac003..7dc053a 100644
--- a/lib/sbi/sbi_console.c
+++ b/lib/sbi/sbi_console.c
@@ -46,27 +46,43 @@  void sbi_putc(char ch)
 	}
 }
 
+static unsigned long console_puts_all(const char *str, unsigned long len)
+{
+	const char *s = str;
+	const char *e = s + len;
+	while (s < e)
+		s += console_dev->console_puts(s, e - s);
+	return len;
+}
+
+static unsigned long console_puts(const char *str, unsigned long len)
+{
+	const char *s, *p, *e;
+	s = str;
+	e = str + len;
+	while (s < e) {
+		p = sbi_strchr(s, '\n');
+		p = p ? p : e;
+		console_puts_all(s, p - s);
+		if (*p == '\n')
+			console_puts_all("\r\n", 2);
+		s = p + 1;
+	}
+	return len;
+}
+
 static unsigned long nputs(const char *str, unsigned long len)
 {
-	unsigned long i, ret;
+	unsigned long i;
 
 	if (console_dev && console_dev->console_puts) {
-		ret = console_dev->console_puts(str, len);
+		console_puts(str, len);
 	} else {
 		for (i = 0; i < len; i++)
 			sbi_putc(str[i]);
-		ret = len;
 	}
 
-	return ret;
-}
-
-static void nputs_all(const char *str, unsigned long len)
-{
-	unsigned long p = 0;
-
-	while (p < len)
-		p += nputs(&str[p], len - p);
+	return len;
 }
 
 void sbi_puts(const char *str)
@@ -74,7 +90,7 @@  void sbi_puts(const char *str)
 	unsigned long len = sbi_strlen(str);
 
 	spin_lock(&console_out_lock);
-	nputs_all(str, len);
+	nputs(str, len);
 	spin_unlock(&console_out_lock);
 }
 
@@ -255,7 +271,7 @@  static int print(char **out, u32 *out_len, const char *format, va_list args)
 
 	for (; *format != 0; ++format) {
 		if (use_tbuf && !console_tbuf_len) {
-			nputs_all(console_tbuf, CONSOLE_TBUF_MAX);
+			nputs(console_tbuf, CONSOLE_TBUF_MAX);
 			console_tbuf_len = CONSOLE_TBUF_MAX;
 			tout = console_tbuf;
 		}
@@ -386,7 +402,7 @@  literal:
 	}
 
 	if (use_tbuf && console_tbuf_len < CONSOLE_TBUF_MAX)
-		nputs_all(console_tbuf, CONSOLE_TBUF_MAX - console_tbuf_len);
+		nputs(console_tbuf, CONSOLE_TBUF_MAX - console_tbuf_len);
 
 	return pc;
 }