Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Song Liu <songliubraving@fb.com>
To:     Joe Perches <joe@perches.com>
CC:     "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "bpf@vger.kernel.org" <bpf@vger.kernel.org>,
        Andy Whitcroft <apw@canonical.com>
Subject: Re: [PATCH] checkpatch: do not apply "initialise globals to 0" check
 to BPF progs
Thread-Topic: [PATCH] checkpatch: do not apply "initialise globals to 0" check
 to BPF progs
Thread-Index: AQHW/nPGy4icMgAVSk6JfHOFnzEOp6pPXQgAgACsnAA=
Date:   Tue, 9 Feb 2021 16:47:38 +0000
Message-ID: <A8E7D663-AD18-49CE-BC3A-E0D7AC9049FD@fb.com>
References: <20210208234002.3294265-1-songliubraving@fb.com>
 <87ec5ac2e1a41000da9a7158491a22f83295c1a6.camel@perches.com>
In-Reply-To: <87ec5ac2e1a41000da9a7158491a22f83295c1a6.camel@perches.com>
Accept-Language: en-US
Content-Language: en-US
Content-Type: text/plain; charset="us-ascii"
Content-ID: <B333D02D89FCC345BC7AD1B8D38F1CA5@namprd15.prod.outlook.com>
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: cf4f1e5b-9142-4579-09f1-08d8cd1a693d
X-MS-Exchange-CrossTenant-originalarrivaltime: 09 Feb 2021 16:47:38.9917
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 8ae927fe-1255-47a7-a2af-5f3a069daaa2
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: 76YVnxlKWTMlABuLRnOyF5fI8LKl+0nUN5yGCG1/V3tQ5lftj10zdPqawBcNaMqOapnadiw5h/f16pwrNwi0vg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR15MB2327
X-OriginatorOrg: fb.com
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.369,18.0.737
 definitions=2021-02-09_05:2021-02-09,2021-02-09 signatures=0
X-Proofpoint-Spam-Details: rule=fb_default_notspam policy=fb_default score=0 priorityscore=1501
 malwarescore=0 mlxscore=0 phishscore=0 mlxlogscore=999 clxscore=1015
 impostorscore=0 lowpriorityscore=0 suspectscore=0 spamscore=0 bulkscore=0
 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2009150000 definitions=main-2102090082
X-FB-Internal: deliver
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


> On Feb 8, 2021, at 10:29 PM, Joe Perches <joe@perches.com> wrote:
>=20
> On Mon, 2021-02-08 at 15:40 -0800, Song Liu wrote:
>> BPF programs explicitly initialise global variables to 0 to make sure
>> clang (v10 or older) do not put the variables in the common section.
>> Skip "initialise globals to 0" check for BPF programs to elimiate error
>> messages like:
>>=20
>>     ERROR: do not initialise globals to 0
>>     #19: FILE: samples/bpf/tracex1_kern.c:21:
> []
>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
>> @@ -4323,7 +4323,11 @@ sub process {
>>  		}
>> =20
>>=20
>>  # check for global initialisers.
>> -		if ($line =3D~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=3D\s*($zero_ini=
tializer)\s*;/) {
>> +# Do not apply to BPF programs (tools/testing/selftests/bpf/progs/*.c, =
samples/bpf/*_kern.c, *.bpf.c).
>> +		if ($line =3D~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=3D\s*($zero_ini=
tializer)\s*;/ &&
>> +		    $realfile !~ /^tools\/testing\/selftests\/bpf\/progs\/.*\.c/ &&
>> +		    $realfile !~ /^samples\/bpf\/.*_kern.c/ &&
>> +		    $realfile !~ /.bpf.c$/) {
>=20
> probably better to make this a function so when additional files are
> added it'd be easier to update this and it will not look as complex.
>=20
> 		if ($line =3D~ /.../ &&
> 		    !exclude_global_initialisers($realfile))

Good point! I will make this a function in v2.=20

--ignore is not ideal, because it is common for a BPF test/sample patch
to have both BPF code and user space code. Adding --ignore will skip the
check for user space code.=20

Thanks,
Song