Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20220613100433-mutt-send-email-mst@kernel.org> <20220614053737.82453-1-huangjie.albert@bytedance.com>
In-Reply-To: <20220614053737.82453-1-huangjie.albert@bytedance.com>
From:   Jason Wang <jasowang@redhat.com>
Date:   Tue, 14 Jun 2022 15:45:17 +0800
Message-ID: <CACGkMEsnvj3MR8oRu-M2D9gTD2sDUJSWkMdjdm6GPum_KUY47w@mail.gmail.com>
Subject: Re: [PATCH] virtio_ring : keep used_wrap_counter in vq->last_used_idx
To:     Albert Huang <huangjie.albert@bytedance.com>
Cc:     mst <mst@redhat.com>, yuanzhu@bytedance.com,
        virtualization <virtualization@lists.linux-foundation.org>,
        linux-kernel <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On Tue, Jun 14, 2022 at 1:38 PM Albert Huang
<huangjie.albert@bytedance.com> wrote:
>
> From: "huangjie.albert" <huangjie.albert@bytedance.com>
>
> the used_wrap_counter and the vq->last_used_idx may get
> out of sync if they are separate assignment=EF=BC=8Cand interrupt
> might use an incorrect value to check for the used index.
>
> for example:OOB access
> ksoftirqd may consume the packet and it will call:
> virtnet_poll
>         -->virtnet_receive
>                 -->virtqueue_get_buf_ctx
>                         -->virtqueue_get_buf_ctx_packed
> and in virtqueue_get_buf_ctx_packed:
>
> vq->last_used_idx +=3D vq->packed.desc_state[id].num;
> if (unlikely(vq->last_used_idx >=3D vq->packed.vring.num)) {
>          vq->last_used_idx -=3D vq->packed.vring.num;
>          vq->packed.used_wrap_counter ^=3D 1;
> }
>
> if at the same time, there comes a vring interrupt=EF=BC=8Cin vring_inter=
rupt:
> we will call:
> vring_interrupt
>         -->more_used
>                 -->more_used_packed
>                         -->is_used_desc_packed
> in is_used_desc_packed, the last_used_idx maybe >=3D vq->packed.vring.num=
.
> so this could case a memory out of bounds bug.
>
> this patch is to keep the used_wrap_counter in vq->last_used_idx
> so we can get the correct value to check for used index in interrupt.
>
> Signed-off-by: huangjie.albert <huangjie.albert@bytedance.com>
> ---
>  drivers/virtio/virtio_ring.c     | 60 ++++++++++++++++++--------------
>  include/uapi/linux/virtio_ring.h |  6 ++++
>  2 files changed, 40 insertions(+), 26 deletions(-)
>
> diff --git a/drivers/virtio/virtio_ring.c b/drivers/virtio/virtio_ring.c
> index 13a7348cedff..35c3750e89e1 100644
> --- a/drivers/virtio/virtio_ring.c
> +++ b/drivers/virtio/virtio_ring.c
> @@ -111,7 +111,12 @@ struct vring_virtqueue {
>         /* Number we've added since last sync. */
>         unsigned int num_added;
>
> -       /* Last used index we've seen. */
> +       /* Last used index  we've seen.
> +        * for split ring, it just contains last used index
> +        * for packed ring, it not only contains last used index, but als=
o
> +        * used_wrap_counter, the VRING_PACKED_USED_INDEX_F_WRAP_CTR is
> +        * the bit shift in last_used_idx
> +        */
>         u16 last_used_idx;
>
>         /* Hint for event idx: already triggered no need to disable. */
> @@ -154,9 +159,6 @@ struct vring_virtqueue {
>                         /* Driver ring wrap counter. */
>                         bool avail_wrap_counter;
>
> -                       /* Device ring wrap counter. */
> -                       bool used_wrap_counter;
> -
>                         /* Avail used flags. */
>                         u16 avail_used_flags;
>
> @@ -1397,6 +1399,9 @@ static inline bool is_used_desc_packed(const struct=
 vring_virtqueue *vq,
>         bool avail, used;
>         u16 flags;
>
> +       if (idx >=3D vq->packed.vring.num)
> +               return false;

I wonder if we can avoid this trick, more below.

> +
>         flags =3D le16_to_cpu(vq->packed.vring.desc[idx].flags);
>         avail =3D !!(flags & (1 << VRING_PACKED_DESC_F_AVAIL));
>         used =3D !!(flags & (1 << VRING_PACKED_DESC_F_USED));
> @@ -1406,8 +1411,12 @@ static inline bool is_used_desc_packed(const struc=
t vring_virtqueue *vq,
>
>  static inline bool more_used_packed(const struct vring_virtqueue *vq)
>  {
> -       return is_used_desc_packed(vq, vq->last_used_idx,
> -                       vq->packed.used_wrap_counter);
> +       u16 last_used;
> +       bool used_wrap_counter;
> +
> +       last_used =3D vq->last_used_idx & ~(1 << VRING_PACKED_USED_INDEX_=
F_WRAP_CTR);
> +       used_wrap_counter =3D !!((vq->last_used_idx) >> VRING_PACKED_USED=
_INDEX_F_WRAP_CTR);
> +       return is_used_desc_packed(vq, last_used, used_wrap_counter);
>  }
>
>  static void *virtqueue_get_buf_ctx_packed(struct virtqueue *_vq,
> @@ -1416,6 +1425,7 @@ static void *virtqueue_get_buf_ctx_packed(struct vi=
rtqueue *_vq,
>  {
>         struct vring_virtqueue *vq =3D to_vvq(_vq);
>         u16 last_used, id;
> +       bool used_wrap_counter;
>         void *ret;
>
>         START_USE(vq);
> @@ -1434,7 +1444,8 @@ static void *virtqueue_get_buf_ctx_packed(struct vi=
rtqueue *_vq,
>         /* Only get used elements after they have been exposed by host. *=
/
>         virtio_rmb(vq->weak_barriers);
>
> -       last_used =3D vq->last_used_idx;
> +       used_wrap_counter =3D !!((vq->last_used_idx >> VRING_PACKED_USED_=
INDEX_F_WRAP_CTR));
> +       last_used =3D (vq->last_used_idx) & (~(1 << VRING_PACKED_USED_IND=
EX_F_WRAP_CTR));
>         id =3D le16_to_cpu(vq->packed.vring.desc[last_used].id);
>         *len =3D le32_to_cpu(vq->packed.vring.desc[last_used].len);
>
> @@ -1451,12 +1462,15 @@ static void *virtqueue_get_buf_ctx_packed(struct =
virtqueue *_vq,
>         ret =3D vq->packed.desc_state[id].data;
>         detach_buf_packed(vq, id, ctx);
>
> -       vq->last_used_idx +=3D vq->packed.desc_state[id].num;
> -       if (unlikely(vq->last_used_idx >=3D vq->packed.vring.num)) {
> -               vq->last_used_idx -=3D vq->packed.vring.num;
> -               vq->packed.used_wrap_counter ^=3D 1;
> +       last_used +=3D vq->packed.desc_state[id].num;
> +       if (unlikely(last_used >=3D vq->packed.vring.num)) {

Can we tweak the math here to avoid the out of bound result?

> +               last_used -=3D vq->packed.vring.num;
> +               used_wrap_counter ^=3D 1;
>         }
>
> +       last_used =3D (last_used | (used_wrap_counter << VRING_PACKED_DES=
C_F_USED));
> +       vq->last_used_idx =3D last_used;
> +
>         /*
>          * If we expect an interrupt for the next entry, tell host
>          * by writing event index and flush out the write before
> @@ -1465,9 +1479,7 @@ static void *virtqueue_get_buf_ctx_packed(struct vi=
rtqueue *_vq,
>         if (vq->packed.event_flags_shadow =3D=3D VRING_PACKED_EVENT_FLAG_=
DESC)
>                 virtio_store_mb(vq->weak_barriers,
>                                 &vq->packed.vring.driver->off_wrap,
> -                               cpu_to_le16(vq->last_used_idx |
> -                                       (vq->packed.used_wrap_counter <<
> -                                        VRING_PACKED_EVENT_F_WRAP_CTR)))=
;
> +                               cpu_to_le16(vq->last_used_idx));
>
>         LAST_ADD_TIME_INVALID(vq);
>
> @@ -1499,9 +1511,7 @@ static unsigned int virtqueue_enable_cb_prepare_pac=
ked(struct virtqueue *_vq)
>
>         if (vq->event) {
>                 vq->packed.vring.driver->off_wrap =3D
> -                       cpu_to_le16(vq->last_used_idx |
> -                               (vq->packed.used_wrap_counter <<
> -                                VRING_PACKED_EVENT_F_WRAP_CTR));
> +                       cpu_to_le16(vq->last_used_idx);
>                 /*
>                  * We need to update event offset and event wrap
>                  * counter first before updating event flags.
> @@ -1518,8 +1528,7 @@ static unsigned int virtqueue_enable_cb_prepare_pac=
ked(struct virtqueue *_vq)
>         }
>
>         END_USE(vq);
> -       return vq->last_used_idx | ((u16)vq->packed.used_wrap_counter <<
> -                       VRING_PACKED_EVENT_F_WRAP_CTR);
> +       return vq->last_used_idx;
>  }
>
>  static bool virtqueue_poll_packed(struct virtqueue *_vq, u16 off_wrap)
> @@ -1550,9 +1559,9 @@ static bool virtqueue_enable_cb_delayed_packed(stru=
ct virtqueue *_vq)
>         if (vq->event) {
>                 /* TODO: tune this threshold */
>                 bufs =3D (vq->packed.vring.num - vq->vq.num_free) * 3 / 4=
;
> -               wrap_counter =3D vq->packed.used_wrap_counter;
> +               wrap_counter =3D !!(vq->last_used_idx >> VRING_PACKED_USE=
D_INDEX_F_WRAP_CTR);
>
> -               used_idx =3D vq->last_used_idx + bufs;
> +               used_idx =3D (vq->last_used_idx & ~(1 << VRING_PACKED_USE=
D_INDEX_F_WRAP_CTR)) + bufs;
>                 if (used_idx >=3D vq->packed.vring.num) {
>                         used_idx -=3D vq->packed.vring.num;
>                         wrap_counter ^=3D 1;
> @@ -1582,9 +1591,9 @@ static bool virtqueue_enable_cb_delayed_packed(stru=
ct virtqueue *_vq)
>          */
>         virtio_mb(vq->weak_barriers);
>
> -       if (is_used_desc_packed(vq,
> -                               vq->last_used_idx,
> -                               vq->packed.used_wrap_counter)) {
> +       wrap_counter =3D !!(vq->last_used_idx >> VRING_PACKED_USED_INDEX_=
F_WRAP_CTR);
> +       used_idx =3D (vq->last_used_idx & ~(1 << VRING_PACKED_USED_INDEX_=
F_WRAP_CTR));
> +       if (is_used_desc_packed(vq, used_idx, wrap_counter)) {
>                 END_USE(vq);
>                 return false;
>         }
> @@ -1689,7 +1698,7 @@ static struct virtqueue *vring_create_virtqueue_pac=
ked(
>         vq->notify =3D notify;
>         vq->weak_barriers =3D weak_barriers;
>         vq->broken =3D true;
> -       vq->last_used_idx =3D 0;
> +       vq->last_used_idx =3D 0 | (1 << VRING_PACKED_USED_INDEX_F_WRAP_CT=
R);
>         vq->event_triggered =3D false;
>         vq->num_added =3D 0;
>         vq->packed_ring =3D true;
> @@ -1720,7 +1729,6 @@ static struct virtqueue *vring_create_virtqueue_pac=
ked(
>
>         vq->packed.next_avail_idx =3D 0;
>         vq->packed.avail_wrap_counter =3D 1;
> -       vq->packed.used_wrap_counter =3D 1;
>         vq->packed.event_flags_shadow =3D 0;
>         vq->packed.avail_used_flags =3D 1 << VRING_PACKED_DESC_F_AVAIL;
>
> diff --git a/include/uapi/linux/virtio_ring.h b/include/uapi/linux/virtio=
_ring.h
> index 476d3e5c0fe7..96bcc4d52fce 100644
> --- a/include/uapi/linux/virtio_ring.h
> +++ b/include/uapi/linux/virtio_ring.h
> @@ -77,6 +77,12 @@
>   */
>  #define VRING_PACKED_EVENT_F_WRAP_CTR  15
>
> +
> +/*
> + * used wrap Counter bit shift in vq->last_used_idx for packed ring
> + */
> +#define VRING_PACKED_USED_INDEX_F_WRAP_CTR  15

Let's simply reuse VRING_PACKED_EVENT_F_WRAP_CTR ?

Thanks

> +
>  /* We support indirect buffer descriptors */
>  #define VIRTIO_RING_F_INDIRECT_DESC    28
>
> --
> 2.31.1
>