Re: [PATCH v17 6/8] media: v4l2: Add DELETE_BUFS ioctl
From: Hans Verkuil
Date: Wed Jan 24 2024 - 10:47:45 EST
On 24/01/2024 16:35, Benjamin Gaignard wrote:
>
> Le 24/01/2024 à 13:33, Hans Verkuil a écrit :
>> On 19/01/2024 10:49, Benjamin Gaignard wrote:
>>> VIDIOC_DELETE_BUFS ioctl allows to delete buffers from a queue.
>>> The number of buffers to delete in given by count field of
>>> struct v4l2_delete_buffers and the range start at the index
>>> specified in the same structure.
>>>
>>> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@xxxxxxxxxxxxx>
>>> ---
>>> version 17:
>>> - rework DELETE_BUFS documentation
>>>
>>> .../userspace-api/media/v4l/user-func.rst | 1 +
>>> .../media/v4l/vidioc-delete-bufs.rst | 80 +++++++++++++++++++
>>> .../media/v4l/vidioc-reqbufs.rst | 1 +
>>> .../media/common/videobuf2/videobuf2-core.c | 42 ++++++++++
>>> .../media/common/videobuf2/videobuf2-v4l2.c | 20 +++++
>>> drivers/media/v4l2-core/v4l2-dev.c | 1 +
>>> drivers/media/v4l2-core/v4l2-ioctl.c | 20 +++++
>>> include/media/v4l2-ioctl.h | 4 +
>>> include/media/videobuf2-core.h | 12 +++
>>> include/media/videobuf2-v4l2.h | 13 +++
>>> include/uapi/linux/videodev2.h | 17 ++++
>>> 11 files changed, 211 insertions(+)
>>> create mode 100644 Documentation/userspace-api/media/v4l/vidioc-delete-bufs.rst
>>>
>>> diff --git a/Documentation/userspace-api/media/v4l/user-func.rst b/Documentation/userspace-api/media/v4l/user-func.rst
>>> index 15ff0bf7bbe6..3fd567695477 100644
>>> --- a/Documentation/userspace-api/media/v4l/user-func.rst
>>> +++ b/Documentation/userspace-api/media/v4l/user-func.rst
>>> @@ -17,6 +17,7 @@ Function Reference
>>> vidioc-dbg-g-chip-info
>>> vidioc-dbg-g-register
>>> vidioc-decoder-cmd
>>> + vidioc-delete-bufs
>>> vidioc-dqevent
>>> vidioc-dv-timings-cap
>>> vidioc-encoder-cmd
>>> diff --git a/Documentation/userspace-api/media/v4l/vidioc-delete-bufs.rst b/Documentation/userspace-api/media/v4l/vidioc-delete-bufs.rst
>>> new file mode 100644
>>> index 000000000000..d409063ceb3f
>>> --- /dev/null
>>> +++ b/Documentation/userspace-api/media/v4l/vidioc-delete-bufs.rst
>>> @@ -0,0 +1,80 @@
>>> +.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
>>> +.. c:namespace:: V4L
>>> +
>>> +.. _VIDIOC_DELETE_BUFS:
>>> +
>>> +************************
>>> +ioctl VIDIOC_DELETE_BUFS
>>> +************************
>>> +
>>> +Name
>>> +====
>>> +
>>> +VIDIOC_DELETE_BUFS - Deletes buffers from a queue
>>> +
>>> +Synopsis
>>> +========
>>> +
>>> +.. c:macro:: VIDIOC_DELETE_BUFs
>>> +
>>> +``int ioctl(int fd, VIDIOC_DELETE_BUFs, struct v4l2_delete_buffers *argp)``
>>> +
>>> +Arguments
>>> +=========
>>> +
>>> +``fd``
>>> + File descriptor returned by :c:func:`open()`.
>>> +
>>> +``argp``
>>> + Pointer to struct :c:type:`v4l2_delete_buffers`.
>>> +
>>> +Description
>>> +===========
>>> +
>>> +Applications can optionally call the :ref:`VIDIOC_DELETE_BUFS` ioctl to
>>> +delete buffers from a queue.
>>> +This ioctl is available if the ``V4L2_BUF_CAP_SUPPORTS_DELETE_BUFS`` capability
>>> +is set on the queue when :c:func:`VIDIOC_REQBUFS` or :c:func:`VIDIOC_CREATE_BUFS`
>>> +are invoked.
>>> +
>>> +.. c:type:: v4l2_delete_buffers
>>> +
>>> +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.5cm}|
>>> +
>>> +.. flat-table:: struct v4l2_delete_buffers
>>> + :header-rows: 0
>>> + :stub-columns: 0
>>> + :widths: 1 1 2
>>> +
>>> + * - __u32
>>> + - ``index``
>>> + - The starting buffer index to delete.
>>> + * - __u32
>>> + - ``count``
>>> + - The number of buffers to be deleted with indices 'index' until 'index + count - 1'.
>>> + All buffers in this range must be valid and in DEQUEUED state.
>>> + If count is set to 0 :ref:`VIDIOC_DELETE_BUFS` will do nothing and return 0.
>>> + * - __u32
>>> + - ``type``
>>> + - Type of the stream or buffers, this is the same as the struct
>>> + :c:type:`v4l2_format` ``type`` field. See
>>> + :c:type:`v4l2_buf_type` for valid values.
>>> + * - __u32
>>> + - ``reserved``\ [13]
>>> + - A place holder for future extensions. Drivers and applications
>>> + must set the array to zero.
>>> +
>>> +Return Value
>>> +============
>>> +
>>> +On success 0 is returned, on error -1 and the ``errno`` variable is set
>>> +appropriately. The generic error codes are described at the
>>> +:ref:`Generic Error Codes <gen-errors>` chapter.
>>> +
>>> +EBUSY
>>> + File I/O is in progress.
>>> + Any buffer in range ``index`` to ``index + count - 1`` is not in
>>> + DEQUEUED state.
>>> +
>>> +EINVAL
>>> + Any buffer in range ``index`` to ``index + count - 1`` doesn't exist in the queue.
>>> diff --git a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
>>> index 0b3a41a45d05..14d4a49c2945 100644
>>> --- a/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
>>> +++ b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst
>>> @@ -121,6 +121,7 @@ aborting or finishing any DMA in progress, an implicit
>>> .. _V4L2-BUF-CAP-SUPPORTS-M2M-HOLD-CAPTURE-BUF:
>>> .. _V4L2-BUF-CAP-SUPPORTS-MMAP-CACHE-HINTS:
>>> .. _V4L2-BUF-CAP-SUPPORTS-MAX-NUM-BUFFERS:
>>> +.. _V4L2-BUF-CAP-SUPPORTS-DELETE-BUFS:
>>> .. raw:: latex
>>> diff --git a/drivers/media/common/videobuf2/videobuf2-core.c b/drivers/media/common/videobuf2/videobuf2-core.c
>>> index 010505ed92e8..99e631233a54 100644
>>> --- a/drivers/media/common/videobuf2/videobuf2-core.c
>>> +++ b/drivers/media/common/videobuf2/videobuf2-core.c
>>> @@ -1688,6 +1688,48 @@ int vb2_core_prepare_buf(struct vb2_queue *q, struct vb2_buffer *vb, void *pb)
>>> }
>>> EXPORT_SYMBOL_GPL(vb2_core_prepare_buf);
>>> +int vb2_core_delete_bufs(struct vb2_queue *q, unsigned int start, unsigned int count)
>>> +{
>>> + unsigned int i, ret = 0;
>>> + unsigned int q_num_bufs = vb2_get_num_buffers(q);
>>> +
>>> + if (count == 0)
>>> + return 0;
>>> +
>>> + if (count > q_num_bufs)
>>> + return -EINVAL;
>>> +
>>> + if (start + count > q->max_num_buffers)
>> Change this to:
>>
>> if (start > q->max_num_buffers - count)
>>
>> This avoids the corner case where 'start + count' overflows the unsigned int.
>>
>>> + return -EINVAL;
>>> +
>>> + /* If streaming keep at least min_queued_buffers + 1 buffers */
>>> + if (q->streaming && (q_num_bufs - count < q->min_queued_buffers + 1))
>>> + return -EINVAL;
>> I would drop this. This will be caught automatically by the next check
>> since if a driver needs q->min_queued_buffers to start the DMA, then
>> once the DMA stated there will always be that amount of buffers in a
>> non-DEQUEUED state.
>>
>>> +
>>> + mutex_lock(&q->mmap_lock);
>>> +
>>> + /* Check that all buffers in the range exist */
>>> + for (i = start; i < start + count; i++) {
>>> + struct vb2_buffer *vb = vb2_get_buffer(q, i);
>>> +
>>> + if (!vb) {
>>> + ret = -EINVAL;
>>> + goto unlock;
>>> + }
>>> + if (vb->state != VB2_BUF_STATE_DEQUEUED) {
>>> + ret = -EBUSY;
>>> + goto unlock;
>>> + }
>>> + }
>>> + __vb2_queue_free(q, start, count);
>>> + dprintk(q, 2, "%u buffers deleted\n", count);
>>> +
>>> +unlock:
>>> + mutex_unlock(&q->mmap_lock);
>>> + return ret;
>>> +}
>>> +EXPORT_SYMBOL_GPL(vb2_core_delete_bufs);
>> There is one specific corner case here that needs attention: if ALL buffers
>> are deleted (something that is possible if STREAMON was called, but no
>> buffers are queued), then vb2_is_busy will suddenly return false.
>>
>> This can have all sorts of subtle consequences since it is now possible
>> to, for example, change the format.
>>
>> There are two options here:
>>
>> 1) vb2_is_busy() shouldn't check if there are buffers allocated, instead it
>> should check if buffers were allocated at least once. So calling REQBUFS
>> or CREATE_BUFS for the first time will set a flag to 1, until you call
>> REQBUFS with count 0, or close the filehandle. Deleting all buffers with
>> DELETE_BUFS will not change that.
>
> I will go for this option and add a patch at the beginning of the series.
>
>>
>> 2) We treat deleting all buffers with DELETE_BUFS the same as calling REQBUFS(0),
>> in which case the code above needs to change.
>>
>> I lean towards option 1. My reasoning is that REQBUFS does an implicit STREAMOFF,
>> and DELETE_BUFS does not and I do not think DELETE_BUFS should allow vb2_is_busy()
>> to become false. It would still be nice if it can delete all buffers, but we
>> would have to check if there are no other places where the number of allocated
>> buffers is checked, when perhaps it really should use vb2_is_busy() instead.
>>
>>> +
>>> /*
>>> * vb2_start_streaming() - Attempt to start streaming.
>>> * @q: videobuf2 queue
>>> diff --git a/drivers/media/common/videobuf2/videobuf2-v4l2.c b/drivers/media/common/videobuf2/videobuf2-v4l2.c
>>> index 03e8080a68a8..626b5283dfdb 100644
>>> --- a/drivers/media/common/videobuf2/videobuf2-v4l2.c
>>> +++ b/drivers/media/common/videobuf2/videobuf2-v4l2.c
>>> @@ -698,6 +698,8 @@ static void vb2_set_flags_and_caps(struct vb2_queue *q, u32 memory,
>>> *caps |= V4L2_BUF_CAP_SUPPORTS_MMAP_CACHE_HINTS;
>>> if (q->supports_requests)
>>> *caps |= V4L2_BUF_CAP_SUPPORTS_REQUESTS;
>>> + if (q->supports_delete_bufs)
>>> + *caps |= V4L2_BUF_CAP_SUPPORTS_DELETE_BUFS;
>>> if (max_num_bufs) {
>>> *max_num_bufs = q->max_num_buffers;
>>> *caps |= V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS;
>>> @@ -743,6 +745,12 @@ int vb2_prepare_buf(struct vb2_queue *q, struct media_device *mdev,
>>> }
>>> EXPORT_SYMBOL_GPL(vb2_prepare_buf);
>>> +int vb2_delete_bufs(struct vb2_queue *q, struct v4l2_delete_buffers *d)
>>> +{
>>> + return vb2_core_delete_bufs(q, d->index, d->count);
>>> +}
>>> +EXPORT_SYMBOL_GPL(vb2_delete_bufs);
>>> +
>> I would not add this. Drivers that want to support this should implement
>> vb2_ioctl_delete_bufs(). Eventually I want to get away from these non-vb2_ioctl_
>> functions.
>
> I need it for v4l2_m2m_ioctl_delete_bufs() implementation because the targeted
> queue depends of the context.
I would prefer that v4l2_m2m_ioctl_delete_bufs() calls vb2_core_delete_bufs()
directly. vb2_delete_bufs is really just a wrapper around that anyway.
Regards,
Hans