ALSA: Use scnprintf() instead of snprintf()
PATCH 1/1 ALSA: Use scnprintf() instead of snprintf()
The show() method should use scnprintf() not snprintf() because snprintf() may returns a value that exceeds its second argument.
--- sound/core/init.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
sound/core/init.c +2 -2
@@ -670,7 +670,7 @@ card_id_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%s\n" , card->id); +return scnprintf (buf,PAGE_SIZE ,"%s\n" , card->id); } static ssize_t
@@ -710,7 +710,7 @@ card_number_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%i\n" , card->number); +return scnprintf (buf,PAGE_SIZE ,"%i\n" , card->number); } static DEVICE_ATTR(number, S_IRUGO, card_number_show_attr, NULL);
Signature · 1 line
2.7.4
Hi,
Quoted 22 lines · Jaejoong Kim
The
show()method should usescnprintf()notsnprintf()becausesnprintf()may returns a value that exceeds its second argument.Signed-off-by Jaejoong Kim <[email protected]>--- sound/core/init.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)sound/core/init.c +1
-1@@ -670,7 +670,7 @@ card_id_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%s\n" , card->id); +return scnprintf (buf,PAGE_SIZE ,"%s\n" , card->id); } static ssize_t
sound/core/init.c card_number_show_attr(struct device *dev, · line 716
Quoted 8 lines
sound/core/init.c +1
-1@@ -710,7 +710,7 @@ card_number_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%i\n" , card->number); +return scnprintf (buf,PAGE_SIZE ,"%i\n" , card->number); } static DEVICE_ATTR(number, S_IRUGO, card_number_show_attr, NULL);
In my opinion, original codes are good because it has a trailing '\n' instead of '\0'.
We can see below explanation in 'Documentation/filesystems /sysfs.txt'[1]:
``` - show() methods should return the number of bytes printed into the buffer. This is the return value of scnprintf(). - show() must not use snprintf() when formatting the value to be returned to user space. If you can guarantee that an overflow will never happen you can use sprintf() otherwise you must use scnprintf(). ```
Actually, 'snprintf()' returns written bytes excluding trailing _null_ byte for end output to strings and we need to use 'scnprintf()'.
However, for our cases, the trailing letter is '\n' and 'snprintf()' counts correctly including it.
Let's test:
```
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
int main(int argc, char **argv)
{
int fd;
char buf[8];
ssize_t len;
if (argc < 2) {
printf("At least, one argument is required for path to sysfs
node.\n");
return EXIT_FAILURE;
}
fd = open(*(argv + 1), O_RDONLY);
if (fd < 0) {
printf("open(2): %s\n", strerror(errno));
return EXIT_FAILURE;
}
// 'C' is a canary.
memset(buf, 'C', sizeof(buf));
len = read(fd, buf, sizeof(buf));
if (len < 0) {
printf("read(2): %s\n", strerror(errno));
close(fd);
return EXIT_FAILURE;
}
printf("len = %zd\n", len);
for (int i = 0; i < sizeof(buf); ++i) {
printf("%02x\n", buf[i]);
}
close(fd);
return EXIT_SUCCESS;
}
`````` $ cat /proc/asound/version Advanced Linux Sound Architecture Driver Version k4.13.0-36-generic. $ /tmp/test '/sys/devices/pci0000:00/0000:00:01.0/0000:01:00.0/0000:02:00.0/fw1/fw1.0/sound/card2/number' len = 2 32 0a 43 43 43 43 43 43 $ /tmp/test '/sys/devices/pci0000:00/0000:00:01.0/0000:01:00.0/0000:02:00.0/fw1/fw1.0/sound/card2/id' len = 5 53 6f 6c 6f 0a 43 43 43 ```
Looks good.
Thanks
Takashi Sakamoto
Hi, Takashi
Thanks for your reviewing.
2018-02-27 12:40 GMT+09:00 Takashi Sakamoto <[email protected]>:
Quoted 30 lines
Hi,
Quoted 27 lines · Jaejoong Kim
The
show()method should usescnprintf()notsnprintf()becausesnprintf()may returns a value that exceeds its second argument.Signed-off-by Jaejoong Kim <[email protected]>--- sound/core/init.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)sound/core/init.c +1
-1@@ -670,7 +670,7 @@ card_id_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%s\n" , card->id); +return scnprintf (buf,PAGE_SIZE ,"%s\n" , card->id); } static ssize_t@@ -710,7 +710,7 @@ card_number_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev);
Quoted 8 lines
sound/core/init.c card_number_show_attr(struct device *dev, · line 716
Quoted 4 lines
sound/core/init.c +1
-1-return snprintf (buf,PAGE_SIZE ,"%i\n" , card->number); +return scnprintf (buf,PAGE_SIZE ,"%i\n" , card->number); } static DEVICE_ATTR(number, S_IRUGO, card_number_show_attr, NULL);In my opinion, original codes are good because it has a trailing '\n' instead of '\0'.
I agree with you.
Quoted 14 lines
We can see below explanation in '
Documentation/filesystems/sysfs.txt'[1]:``` - show() methods should return the number of bytes printed into the buffer. This is the return value of scnprintf(). - show() must not use snprintf() when formatting the value to be returned to user space. If you can guarantee that an overflow will never happen you can use sprintf() otherwise you must use scnprintf(). ```
Quoted 2 lines
Actually, '
snprintf()' returns written bytes excluding trailing _null_ byte for end output to strings and we need to use 'scnprintf()'.
Strictly speaking, that is half the truth.
snprintf() does not return the length actually written to the buffer, but rather to
return the length that it was intended to be written to. So, in case of the formated
buffer size is much bigger, 'snprintf()' will return formated buffer size not written bytes.
Please refer to the LWN about snprintf
https://lwn.net/Articles/69419/
I do NOT think the original codes will happen if snprintf() return a number larger than PAGE_SIZE.
Nevertheless, it is better to use scnprintf () for the show method because of the snprintf () behavior.
Thanks,
Jaejoong
Quoted 95 lines
However, for our cases, the trailing letter is '\n' and '
snprintf()' counts correctly including it.Let's test:
``` #include <stdio.h> #include <stdlib.h> #include <sys/types.h> #include <sys/stat.h> #include <fcntl.h> #include <unistd.h> #include <string.h> #include <errno.h> int main(int argc, char **argv) { int fd; char buf[8]; ssize_t len; if (argc < 2) { printf("At least, one argument is required for path to sysfs node.\n"); return EXIT_FAILURE; } fd = open(*(argv + 1), O_RDONLY); if (fd < 0) { printf("open(2): %s\n", strerror(errno)); return EXIT_FAILURE; } // 'C' is a canary. memset(buf, 'C', sizeof(buf)); len = read(fd, buf, sizeof(buf)); if (len < 0) { printf("read(2): %s\n", strerror(errno)); close(fd); return EXIT_FAILURE; } printf("len = %zd\n", len); for (int i = 0; i < sizeof(buf); ++i) { printf("%02x\n", buf[i]); } close(fd); return EXIT_SUCCESS; } `````` $ cat /proc/asound/version Advanced Linux Sound Architecture Driver Version k4.13.0-36-generic. $ /tmp/test '/sys/devices/pci0000:00/0000:00:01.0/0000:01:00.0/0000:02:00.0/fw1/fw1.0/sound/card2/number' len = 2 32 0a 43 43 43 43 43 43 $ /tmp/test '/sys/devices/pci0000:00/0000:00:01.0/0000:01:00.0/0000:02:00.0/fw1/fw1.0/sound/card2/id' len = 5 53 6f 6c 6f 0a 43 43 43 ```Looks good.
Thanks
Takashi Sakamoto
Hi,
Quoted 25 lines · Jaejoong Kim
Quoted 13 lines
We can see below explanation in '
Documentation/filesystems/sysfs.txt'[1]:``` - show() methods should return the number of bytes printed into the buffer. This is the return value of scnprintf(). - show() must not use snprintf() when formatting the value to be returned to user space. If you can guarantee that an overflow will never happen you can use sprintf() otherwise you must use scnprintf(). ```Quoted 2 lines
Actually, '
snprintf()' returns written bytes excluding trailing _null_ byte for end output to strings and we need to use 'scnprintf()'.Strictly speaking, that is half the truth.
snprintf()does not return the length actually written to the buffer, but rather to
return the length that it was intended to be written to. So, in case of the formated
buffer size is much bigger, 'snprintf()' will return formated buffer size not written bytes.
Quoted 7 lines
Please refer to the LWN about snprintf
https://lwn.net/Articles/69419/I do NOT think the original codes will happen if
snprintf()return a number larger thanPAGE_SIZE.
Nevertheless, it is better to use scnprintf () for the show method because of the snprintf () behavior.
Ah... Exactly. I failed to get your intention, sorry... (I should have read your commit comment carefully...)
Thanks
Takashi Sakamoto
Takashi Iwai
AppliedQuoted 5 lines · Jaejoong Kim
The
show()method should usescnprintf()notsnprintf()becausesnprintf()may returns a value that exceeds its second argument.Signed-off-by Jaejoong Kim <[email protected]>
Thanks, applied now. Although it shouldn't matter in these cases as they are very short strings, it's better to keep consistency.
Takashi
Quoted 30 lines
--- sound/core/init.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)sound/core/init.c +2
-2@@ -670,7 +670,7 @@ card_id_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%s\n" , card->id); +return scnprintf (buf,PAGE_SIZE ,"%s\n" , card->id); } static ssize_t@@ -710,7 +710,7 @@ card_number_show_attr(struct device *dev, struct device_attribute *attr, char *buf) { struct snd_card *card = container_of(dev, struct snd_card, card_dev); -return snprintf (buf,PAGE_SIZE ,"%i\n" , card->number); +return scnprintf (buf,PAGE_SIZE ,"%i\n" , card->number); } static DEVICE_ATTR(number, S_IRUGO, card_number_show_attr, NULL);Signature · 1 line
2.7.4