xref: /OK3568_Linux_fs/kernel/scripts/coccinelle/api/device_attr_show.cocci (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun// SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun///
3*4882a593Smuzhiyun/// From Documentation/filesystems/sysfs.rst:
4*4882a593Smuzhiyun///  show() must not use snprintf() when formatting the value to be
5*4882a593Smuzhiyun///  returned to user space. If you can guarantee that an overflow
6*4882a593Smuzhiyun///  will never happen you can use sprintf() otherwise you must use
7*4882a593Smuzhiyun///  scnprintf().
8*4882a593Smuzhiyun///
9*4882a593Smuzhiyun// Confidence: High
10*4882a593Smuzhiyun// Copyright: (C) 2020 Denis Efremov ISPRAS
11*4882a593Smuzhiyun// Options: --no-includes --include-headers
12*4882a593Smuzhiyun//
13*4882a593Smuzhiyun
14*4882a593Smuzhiyunvirtual report
15*4882a593Smuzhiyunvirtual org
16*4882a593Smuzhiyunvirtual context
17*4882a593Smuzhiyunvirtual patch
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun@r depends on !patch@
20*4882a593Smuzhiyunidentifier show, dev, attr, buf;
21*4882a593Smuzhiyunposition p;
22*4882a593Smuzhiyun@@
23*4882a593Smuzhiyun
24*4882a593Smuzhiyunssize_t show(struct device *dev, struct device_attribute *attr, char *buf)
25*4882a593Smuzhiyun{
26*4882a593Smuzhiyun	<...
27*4882a593Smuzhiyun*	return snprintf@p(...);
28*4882a593Smuzhiyun	...>
29*4882a593Smuzhiyun}
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun@rp depends on patch@
32*4882a593Smuzhiyunidentifier show, dev, attr, buf;
33*4882a593Smuzhiyun@@
34*4882a593Smuzhiyun
35*4882a593Smuzhiyunssize_t show(struct device *dev, struct device_attribute *attr, char *buf)
36*4882a593Smuzhiyun{
37*4882a593Smuzhiyun	<...
38*4882a593Smuzhiyun	return
39*4882a593Smuzhiyun-		snprintf
40*4882a593Smuzhiyun+		scnprintf
41*4882a593Smuzhiyun			(...);
42*4882a593Smuzhiyun	...>
43*4882a593Smuzhiyun}
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun@script: python depends on report@
46*4882a593Smuzhiyunp << r.p;
47*4882a593Smuzhiyun@@
48*4882a593Smuzhiyun
49*4882a593Smuzhiyuncoccilib.report.print_report(p[0], "WARNING: use scnprintf or sprintf")
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun@script: python depends on org@
52*4882a593Smuzhiyunp << r.p;
53*4882a593Smuzhiyun@@
54*4882a593Smuzhiyun
55*4882a593Smuzhiyuncoccilib.org.print_todo(p[0], "WARNING: use scnprintf or sprintf")
56