Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) client-ip=2620:137:e000::3:3;
MIME-Version: 1.0
References: <20230927184158.243575-1-mirsad.todorovac@alu.unizg.hr>
 <0a201a6f-90dd-403c-97d0-94372be1e3e6@gmail.com> <CANpmjNP=jY2NzrXX4mgY5cL5tqZeLb18gQkzVhg1OofNtJ1VSw@mail.gmail.com>
 <250140d1-d592-45f4-aa27-691c1d68a528@alu.unizg.hr>
In-Reply-To: <250140d1-d592-45f4-aa27-691c1d68a528@alu.unizg.hr>
From:   Marco Elver <elver@google.com>
Date:   Fri, 13 Oct 2023 09:21:05 +0200
Message-ID: <CANpmjNNnkv1UH=RLaeejFicicRZFn4D2sChmppoFdOfJYY_0hw@mail.gmail.com>
Subject: Re: [PATCH RFC v1 1/3] r8169: fix the KCSAN reported data-race in
 rtl_tx() while reading tp->cur_tx
To:     Mirsad Goran Todorovac <mirsad.todorovac@alu.unizg.hr>
Cc:     Heiner Kallweit <hkallweit1@gmail.com>, netdev@vger.kernel.org,
        linux-kernel@vger.kernel.org, nic_swsd@realtek.com,
        "David S. Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On Fri, 13 Oct 2023 at 07:01, Mirsad Goran Todorovac
<mirsad.todorovac@alu.unizg.hr> wrote:
>
> On 9/28/2023 8:02 AM, Marco Elver wrote:
> > On Wed, 27 Sept 2023 at 21:52, Heiner Kallweit <hkallweit1@gmail.com> w=
rote:
> >>
> >> On 27.09.2023 20:41, Mirsad Goran Todorovac wrote:
> >>> KCSAN reported the following data-race:
> >>>
> >>> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> >>> BUG: KCSAN: data-race in rtl8169_poll [r8169] / rtl8169_start_xmit [r=
8169]
> >>>
> >>> write (marked) to 0xffff888102474b74 of 4 bytes by task 5358 on cpu 2=
9:
> >>> rtl8169_start_xmit (drivers/net/ethernet/realtek/r8169_main.c:4254) r=
8169
> >>> dev_hard_start_xmit (./include/linux/netdevice.h:4889 ./include/linux=
/netdevice.h:4903 net/core/dev.c:3544 net/core/dev.c:3560)
> >>> sch_direct_xmit (net/sched/sch_generic.c:342)
> >>> __dev_queue_xmit (net/core/dev.c:3817 net/core/dev.c:4306)
> >>> ip_finish_output2 (./include/linux/netdevice.h:3082 ./include/net/nei=
ghbour.h:526 ./include/net/neighbour.h:540 net/ipv4/ip_output.c:233)
> >>> __ip_finish_output (net/ipv4/ip_output.c:311 net/ipv4/ip_output.c:293=
)
> >>> ip_finish_output (net/ipv4/ip_output.c:328)
> >>> ip_output (net/ipv4/ip_output.c:435)
> >>> ip_send_skb (./include/net/dst.h:458 net/ipv4/ip_output.c:127 net/ipv=
4/ip_output.c:1486)
> >>> udp_send_skb (net/ipv4/udp.c:963)
> >>> udp_sendmsg (net/ipv4/udp.c:1246)
> >>> inet_sendmsg (net/ipv4/af_inet.c:840 (discriminator 4))
> >>> sock_sendmsg (net/socket.c:730 net/socket.c:753)
> >>> __sys_sendto (net/socket.c:2177)
> >>> __x64_sys_sendto (net/socket.c:2185)
> >>> do_syscall_64 (arch/x86/entry/common.c:50 arch/x86/entry/common.c:80)
> >>> entry_SYSCALL_64_after_hwframe (arch/x86/entry/entry_64.S:120)
> >>>
> >>> read to 0xffff888102474b74 of 4 bytes by interrupt on cpu 21:
> >>> rtl8169_poll (drivers/net/ethernet/realtek/r8169_main.c:4397 drivers/=
net/ethernet/realtek/r8169_main.c:4581) r8169
> >>> __napi_poll (net/core/dev.c:6527)
> >>> net_rx_action (net/core/dev.c:6596 net/core/dev.c:6727)
> >>> __do_softirq (kernel/softirq.c:553)
> >>> __irq_exit_rcu (kernel/softirq.c:427 kernel/softirq.c:632)
> >>> irq_exit_rcu (kernel/softirq.c:647)
> >>> common_interrupt (arch/x86/kernel/irq.c:247 (discriminator 14))
> >>> asm_common_interrupt (./arch/x86/include/asm/idtentry.h:636)
> >>> cpuidle_enter_state (drivers/cpuidle/cpuidle.c:291)
> >>> cpuidle_enter (drivers/cpuidle/cpuidle.c:390)
> >>> call_cpuidle (kernel/sched/idle.c:135)
> >>> do_idle (kernel/sched/idle.c:219 kernel/sched/idle.c:282)
> >>> cpu_startup_entry (kernel/sched/idle.c:378 (discriminator 1))
> >>> start_secondary (arch/x86/kernel/smpboot.c:210 arch/x86/kernel/smpboo=
t.c:294)
> >>> secondary_startup_64_no_verify (arch/x86/kernel/head_64.S:433)
> >>>
> >>> value changed: 0x002f4815 -> 0x002f4816
> >>>
> >>> Reported by Kernel Concurrency Sanitizer on:
> >>> CPU: 21 PID: 0 Comm: swapper/21 Tainted: G             L     6.6.0-rc=
2-kcsan-00143-gb5cbe7c00aa0 #41
> >>> Hardware name: ASRock X670E PG Lightning/X670E PG Lightning, BIOS 1.2=
1 04/26/2023
> >>> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> >>>
> >>> The write side of drivers/net/ethernet/realtek/r8169_main.c is:
> >>> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> >>>     4251         /* rtl_tx needs to see descriptor changes before upd=
ated tp->cur_tx */
> >>>     4252         smp_wmb();
> >>>     4253
> >>>   =E2=86=92 4254         WRITE_ONCE(tp->cur_tx, tp->cur_tx + frags + =
1);
> >>>     4255
> >>>     4256         stop_queue =3D !netif_subqueue_maybe_stop(dev, 0, rt=
l_tx_slots_avail(tp),
> >>>     4257                                                 R8169_TX_STO=
P_THRS,
> >>>     4258                                                 R8169_TX_STA=
RT_THRS);
> >>>
> >>> The read side is the function rtl_tx():
> >>>
> >>>     4355 static void rtl_tx(struct net_device *dev, struct rtl8169_pr=
ivate *tp,
> >>>     4356                    int budget)
> >>>     4357 {
> >>>     4358         unsigned int dirty_tx, bytes_compl =3D 0, pkts_compl=
 =3D 0;
> >>>     4359         struct sk_buff *skb;
> >>>     4360
> >>>     4361         dirty_tx =3D tp->dirty_tx;
> >>>     4362
> >>>     4363         while (READ_ONCE(tp->cur_tx) !=3D dirty_tx) {
> >>>     4364                 unsigned int entry =3D dirty_tx % NUM_TX_DES=
C;
> >>>     4365                 u32 status;
> >>>     4366
> >>>     4367                 status =3D le32_to_cpu(tp->TxDescArray[entry=
].opts1);
> >>>     4368                 if (status & DescOwn)
> >>>     4369                         break;
> >>>     4370
> >>>     4371                 skb =3D tp->tx_skb[entry].skb;
> >>>     4372                 rtl8169_unmap_tx_skb(tp, entry);
> >>>     4373
> >>>     4374                 if (skb) {
> >>>     4375                         pkts_compl++;
> >>>     4376                         bytes_compl +=3D skb->len;
> >>>     4377                         napi_consume_skb(skb, budget);
> >>>     4378                 }
> >>>     4379                 dirty_tx++;
> >>>     4380         }
> >>>     4381
> >>>     4382         if (tp->dirty_tx !=3D dirty_tx) {
> >>>     4383                 dev_sw_netstats_tx_add(dev, pkts_compl, byte=
s_compl);
> >>>     4384                 WRITE_ONCE(tp->dirty_tx, dirty_tx);
> >>>     4385
> >>>     4386                 netif_subqueue_completed_wake(dev, 0, pkts_c=
ompl, bytes_compl,
> >>>     4387                                               rtl_tx_slots_a=
vail(tp),
> >>>     4388                                               R8169_TX_START=
_THRS);
> >>>     4389                 /*
> >>>     4390                  * 8168 hack: TxPoll requests are lost when =
the Tx packets are
> >>>     4391                  * too close. Let's kick an extra TxPoll req=
uest when a burst
> >>>     4392                  * of start_xmit activity is detected (if it=
 is not detected,
> >>>     4393                  * it is slow enough). -- FR
> >>>     4394                  * If skb is NULL then we come here again on=
ce a tx irq is
> >>>     4395                  * triggered after the last fragment is mark=
ed transmitted.
> >>>     4396                  */
> >>>   =E2=86=92 4397                 if (tp->cur_tx !=3D dirty_tx && skb)
> >>>     4398                         rtl8169_doorbell(tp);
> >>>     4399         }
> >>>     4400 }
> >>>
> >>> Obviously from the code, an earlier detected data-race for tp->cur_tx=
 was fixed in the
> >>> line 4363:
> >>>
> >>>     4363         while (READ_ONCE(tp->cur_tx) !=3D dirty_tx) {
> >>>
> >>> but the same solution is required for protecting the other access to =
tp->cur_tx:
> >>>
> >>>   =E2=86=92 4397                 if (READ_ONCE(tp->cur_tx) !=3D dirty=
_tx && skb)
> >>>     4398                         rtl8169_doorbell(tp);
> >>>
> >>> The write in the line 4254 is protected with WRITE_ONCE(), but the re=
ad in the line 4397
> >>> might have suffered read tearing under some compiler optimisations.
> >>>
> >>> The fix eliminated the KCSAN data-race report for this bug.
> >>>
> >>> It is yet to be evaluated what happens if tp->cur_tx changes between =
the test in line 4363
> >>> and line 4397. This test should certainly not be cached by the compil=
er in some register
> >>> for such a long time, while asynchronous writes to tp->cur_tx might h=
ave occurred in line
> >>> 4254 in the meantime.
> >>>
> >>
> >> netif_subqueue_completed_wake() has barriers ensuring that no cached v=
alue for tp->cur_tx
> >> is used in line 4397. I'm not aware of any reported issues with an obv=
ious link to the
> >> potentential issue you describe.
> >> I don't have a strong opinion on these patches. They shouldn't hurt, a=
nd if they make
> >> KCSAN happy, why not.
> >
> > Barries don't protect unmarked accesses from being miscompiled. So the
> > use of barriers and marked accesses like READ_ONCE() is correct:
> > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree=
/tools/memory-model/Documentation/access-marking.txt
> > That said, actually encountering a miscompilation depends on
> > architecture and compiler. Using the right marked accesses just
> > ensures things don't suddenly break because the compiler decided to be
> > a little more clever.
> >
> >>> Fixes: 94d8a98e6235c ("r8169: reduce number of workaround doorbell ri=
ngs")
> >>> Cc: Heiner Kallweit <hkallweit1@gmail.com>
> >>> Cc: nic_swsd@realtek.com
> >>> Cc: "David S. Miller" <davem@davemloft.net>
> >>> Cc: Eric Dumazet <edumazet@google.com>
> >>> Cc: Jakub Kicinski <kuba@kernel.org>
> >>> Cc: Paolo Abeni <pabeni@redhat.com>
> >>> Cc: Marco Elver <elver@google.com>
> >>> Cc: netdev@vger.kernel.org
> >>> Link: https://lore.kernel.org/lkml/dc7fc8fa-4ea4-e9a9-30a6-7c83e6b531=
88@alu.unizg.hr/
> >>> Signed-off-by: Mirsad Goran Todorovac <mirsad.todorovac@alu.unizg.hr>
> >
> > Acked-by: Marco Elver <elver@google.com>
>
> Hi, Marco,
>
> Does this Acked-by: cover all of the [123]/3 in the patch series?

Technically, no. (Only if this was the cover lettter i.e. 0/n)

Send the non-RFC separately and I'll ack them.