Hi all,
This series mainly aims to introduce atomic support for SCMI transports
that can support it.
In [01/11], as a closely related addition, it is introduced a common way
for a transport to signal to the SCMI core that it does not offer
completion interrupts, so that the usual polling behaviour will be
required: this can be done enabling statically a global polling behaviour
for the whole transport with flag scmi_desc.force_polling OR dynamically
enabling at runtime such polling behaviour on a per-channel basis using
the flag scmi_chan_info.no_completion_irq, typically during .chan_setup().
The usual per-command polling selection behaviour based on
hdr.poll_completion is preserved as before.
Patch [02/11], ports SMC transport to use the common core completions when
completion interrupt is available or otherwise revert to use common core
polling mechanism above introduced: this avoids the improper call of
scmi_rx_callback directly in smc_send_message.
With [03/11] I introduce a flag to allow a transport to signal to the core
that upon return of a .send_message() the requested command execution can
be assumed by the core to have been fully completed by the platform, so
that the response payload (if any) can be immediately fetched without the
need to effectively poll the channel.
In [04/11] and [05/11] I enable such flag for SMC amd OPTEE transports.
With [06/11] a transport that supports atomic operations on its TX
path can now declare itself as .atomic_enabled and, if the platform has
been also configured to use such atomic operation mode via Kconfig, the
SCMI core will refrain itself too from sleeping on the RX path and instead
rely on polling on the correspondent when such atomic behaviour is
requested from the upper layers. (like the Clock framework)
Then in [07/11] SMC is converted to be .atomic_enabled by substituting
the mutexes with busy-waiting to keep the channel 'locked' ONLY IF the
SMC transport is configured to operate in atomic mode.
(CONFIG_ARM_SCMI_TRANSPORT_SMC_ATOMIC_ENABLE=y)
In [08/11] a new parameter is added to mark_txdone transport operation;
this will be needed to support polling/atomic support in SCMI virtio.
[09/11] adds polling and configurable atomic mode support to SCMI virtio.
(CONFIG_ARM_SCMI_TRANSPORT_VIRTIO_ATOMIC_ENABLE=y)
Finally [10/11] adds support for atomic clock enable/disable requests to
the SCMI Clock protocol layer, while in [11/11] the SCMI Clock driver is
modified to gain optional support for atomic operations when operating on
an atomically capable and configured SCMI transport.
NOTE THAT once atomic mode is available and configured on the underlying
SCMI transport, selected SCMI operations can be performed in atomic mode:
in this series this is done only for Clock enable operations; moreover
ALL the known clock devices are currently moved to atomic operations if
supported by transport: later a more fine grained control to avoid atomic
operations on 'slow' clock domains will be introduced, but this latter
solution requires an SCMI Spec change which is still underway.
Atomic support has been tested against the virtio transport in regards to
the above mentioned Clock enable/disable operations.
(echo 1 > /sys/kernel/debug/clk/myclock/clk_prepare_enable)
Pure polling has been tested on mailbox transport.
The series is based on sudeep/for-next/scmi [1] on top of:
commit f872af09094c ("firmware: arm_scmi: Use new trace event
scmi_xfer_response_wait")
Any feedback welcome.
Thanks,
Cristian
[1]: https://git.kernel.org/pub/scm/linux/kernel/git/sudeep.holla/linux.git/log/?h=for-next/scmi
---
V7 --> V8
- rebased on top sudeep/for-next/scmi
- removed clock prepare/unprepare for atomic transports
- removed ifdeffery in SCMI virtio atomic/polling support
- added SCMI virtio polling deferred worker
- simplified SCMI virtio spinlocking around free list
- removed ifdeffery in SMC atomic support
- removed polling_capable/polling_enabled internal flags, using macros
- renaming to sync_cmds_completed_on_ret
V6 --> V7
- rebased on lates sudeep/for-next/scmi
- fixed missing list_del() in vio_complete while processing pre-fetched buffers
- added proper spilocking while accessing pending_cmds_list
- reduced unneeded spinlocked region in virtio_poll_done
- using __unused macro in optional mark_txdone param
V5 --> V6
- changed default polling timeout
- refactored SCMI RX path
- added timeout_ms to traces in RX-path
- added OPTEE support for sync_cmds_atomic_replies
- reworked the whole atomic support in SCMI core removing any reliance
on IRQs. (using pure polling)
- added new parameter to mark_txdone
- added new SCMI VirtIO polling/atomic support
- reviewed Clock SCMI Driver atomic support: now supporting both
clk_prepare and clk_enable when atomic transport is detected
- added CCs
V4 --> V5
- removed RFCs tags
- added scmi_desc.atomic_enabled flags and a few Kconfig options to set
atomic mode for SMC and VirtIO transports. Default disabled.
- added Kconfig option to enable forced polling as a whole on the Mailbox
transport
- removed .poll_done callback from SMC transport since no real polling is
needed once sync_cmds_atomic_replies is set
- made atomic_capable changes on SMC transport dependent on Kconfig
CONFIG_ARM_SCMI_TRANSPORT_SMC_ATOMIC_ENABLE: so no change and no busy waiting
if atomic mode is NOT enabled in Kconfig.
- made const: force_polling/atomic_capable/atomic_enabled/sync_cmds_atomic_replies
V3 --> V4
- rebased on linux-next/master next-20210824
- renamed .needs_polling to .no_completion_irq
- added .sync_cmds_atomic_replies
- make SMC use .sync_cmd_atomic_replies
V2 --> v3
- rebased on SCMI VirtIO V6 which in turn is based on v5.14-rc1
Cristian Marussi (11):
firmware: arm_scmi: Add configurable polling mode for transports
firmware: arm_scmi: Make smc transport use common completions
firmware: arm_scmi: Add sync_cmds_completed_on_ret transport flag
firmware: arm_scmi: Make smc support sync_cmds_completed_on_ret
firmware: arm_scmi: Make optee support sync_cmds_completed_on_ret
firmware: arm_scmi: Add support for atomic transports
firmware: arm_scmi: Add atomic mode support to smc transport
firmware: arm_scmi: Add new parameter to mark_txdone
firmware: arm_scmi: Add atomic mode support to virtio transport
firmware: arm_scmi: Add atomic support to clock protocol
clk: scmi: Support atomic clock enable/disable API
drivers/clk/clk-scmi.c | 54 +++++-
drivers/firmware/arm_scmi/Kconfig | 29 +++
drivers/firmware/arm_scmi/clock.c | 22 ++-
drivers/firmware/arm_scmi/common.h | 23 ++-
drivers/firmware/arm_scmi/driver.c | 123 ++++++++++--
drivers/firmware/arm_scmi/mailbox.c | 3 +-
drivers/firmware/arm_scmi/optee.c | 18 +-
drivers/firmware/arm_scmi/smc.c | 98 +++++++---
drivers/firmware/arm_scmi/virtio.c | 291 +++++++++++++++++++++++++---
include/linux/scmi_protocol.h | 11 ++
10 files changed, 586 insertions(+), 86 deletions(-)
--
2.17.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
SCMI communications along TX channels can optionally be provided of a
completion interrupt; when such interrupt is not available, command
transactions should rely on polling, where the SCMI core takes care to
repeatedly evaluate the transport-specific .poll_done() function, if
available, to determine if and when a request was fully completed or
timed out.
Such mechanism is already present and working on a single transfer base:
SCMI protocols can indeed enable hdr.poll_completion on specific commands
ahead of each transfer and cause that transaction to be handled with
polling.
Introduce a couple of flags to be able to enforce such polling behaviour
globally at will:
- scmi_desc.force_polling: to statically switch the whole transport to
polling mode.
- scmi_chan_info.no_completion_irq: to switch a single channel dynamically
to polling mode if, at runtime, is determined that no completion
interrupt was available for such channel.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- removed internal poling_enabled flag, using macros
v5 --> v6
- removed check on replies received by IRQs when xfer was requested
as poll_completion (not all transport can suppress IRQs on an xfer basis)
v4 --> v5
- make force_polling const
- introduce polling_enabled flag to simplify checks on do_xfer
v3 --> v4:
- renamed .needs_polling flag to .no_completion_irq
- refactored error path when polling needed but not supported
---
drivers/firmware/arm_scmi/common.h | 8 ++++++++
drivers/firmware/arm_scmi/driver.c | 32 ++++++++++++++++++++++++++++++
2 files changed, 40 insertions(+)
@@ -817,6 +834,7 @@ static int do_xfer(const struct scmi_protocol_handle *ph,structdevice*dev=info->dev;structscmi_chan_info*cinfo;+/* Check for polling request on custom command xfers at first */if(xfer->hdr.poll_completion&&!info->desc->ops->poll_done){dev_warn_once(dev,"Polling mode is not supported by transport.\n");
@@ -827,6 +845,10 @@ static int do_xfer(const struct scmi_protocol_handle *ph,if(unlikely(!cinfo))return-EINVAL;+/* True ONLY if also supported by transport. */+if(IS_POLLING_ENABLED(cinfo,info))+xfer->hdr.poll_completion=true;+/**Initialiseprotocolidnowfromprotocolhandletoavoiditbeing*overriddenbymistake(ormalice)bytheprotocolcodemanglingwith
@@ -1527,6 +1549,16 @@ static int scmi_chan_setup(struct scmi_info *info, struct device *dev,if(ret)returnret;+if(tx&&IS_POLLING_REQUIRED(cinfo,info)){+if(IS_TRANSPORT_POLLING_CAPABLE(info))+dev_info(dev,+"Enabled polling mode TX channel - prot_id:%d\n",+prot_id);+else+dev_warn(dev,+"Polling mode NOT supported by transport.\n");+}+idr_alloc:ret=idr_alloc(idr,cinfo,prot_id,prot_id+1,GFP_KERNEL);if(ret!=prot_id){
--
2.17.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
SCMI communications along TX channels can optionally be provided of a
completion interrupt; when such interrupt is not available, command
transactions should rely on polling, where the SCMI core takes care to
repeatedly evaluate the transport-specific .poll_done() function, if
available, to determine if and when a request was fully completed or
timed out.
Such mechanism is already present and working on a single transfer base:
SCMI protocols can indeed enable hdr.poll_completion on specific commands
ahead of each transfer and cause that transaction to be handled with
polling.
Introduce a couple of flags to be able to enforce such polling behaviour
globally at will:
- scmi_desc.force_polling: to statically switch the whole transport to
polling mode.
- scmi_chan_info.no_completion_irq: to switch a single channel dynamically
to polling mode if, at runtime, is determined that no completion
interrupt was available for such channel.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
This patch breaks linux-next build for me with LLVM.
drivers/firmware/arm_scmi/driver.c:869:6: error: variable 'i_' is uninitialized when used within its own initialization [-Werror,-Wuninitialized]
if (IS_POLLING_ENABLED(cinfo, info))
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/firmware/arm_scmi/driver.c:59:33: note: expanded from macro 'IS_POLLING_ENABLED'
IS_TRANSPORT_POLLING_CAPABLE(i_)); \
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~~
drivers/firmware/arm_scmi/driver.c:45:19: note: expanded from macro 'IS_TRANSPORT_POLLING_CAPABLE'
typeof(__i) i_ = __i; \
~~ ^~~
1 error generated.
--
Regards,
Pratyush Yadav
Texas Instruments Inc.
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
On Wed, Dec 22, 2021 at 01:08:54AM +0530, Pratyush Yadav wrote:
Hi,
On 20/12/21 07:56PM, Cristian Marussi wrote:
quoted
SCMI communications along TX channels can optionally be provided of a
completion interrupt; when such interrupt is not available, command
transactions should rely on polling, where the SCMI core takes care to
repeatedly evaluate the transport-specific .poll_done() function, if
available, to determine if and when a request was fully completed or
timed out.
Such mechanism is already present and working on a single transfer base:
SCMI protocols can indeed enable hdr.poll_completion on specific commands
ahead of each transfer and cause that transaction to be handled with
polling.
Introduce a couple of flags to be able to enforce such polling behaviour
globally at will:
- scmi_desc.force_polling: to statically switch the whole transport to
polling mode.
- scmi_chan_info.no_completion_irq: to switch a single channel dynamically
to polling mode if, at runtime, is determined that no completion
interrupt was available for such channel.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
This patch breaks linux-next build for me with LLVM.
drivers/firmware/arm_scmi/driver.c:869:6: error: variable 'i_' is uninitialized when used within its own initialization [-Werror,-Wuninitialized]
if (IS_POLLING_ENABLED(cinfo, info))
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/firmware/arm_scmi/driver.c:59:33: note: expanded from macro 'IS_POLLING_ENABLED'
IS_TRANSPORT_POLLING_CAPABLE(i_)); \
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~~
drivers/firmware/arm_scmi/driver.c:45:19: note: expanded from macro 'IS_TRANSPORT_POLLING_CAPABLE'
typeof(__i) i_ = __i; \
~~ ^~~
1 error generated.
Thanks for the report. The bot complained last night and I have pushed
the update though not in time for linux-next today, must make it to
tomorrow's cut.
--
Regards,
Sudeep
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
When a completion irq is available use it and delegate command completion
handling to the core SCMI completion mechanism.
If no completion irq is available revert to polling, using the core common
polling machinery.
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v6 --> v7
- removed spurios blank line removal
v4 --> v5
- removed RFC tag
v3 --> v4
- renamed usage of .needs_polling to .no_completion_irq
---
drivers/firmware/arm_scmi/smc.c | 39 +++++++++++++++++----------------
1 file changed, 20 insertions(+), 19 deletions(-)
Add a flag to let the transport signal to the core if its handling of sync
command implies that, after .send_message has returned successfully, the
requested command can be assumed to be fully and completely executed on
SCMI platform side so that any possible response value is already
immediately available to be retrieved by a .fetch_response: in other words
the polling phase can be skipped in such a case and the response values
accessed straight away.
Note that all of the above applies only when polling mode of operation was
selected by the core: if instead a completion IRQ was found to be available
the normal response processing path based on completions will still be
followed.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- renaming to sync_cmds_completed_on_ret
- removed poling_capable flag, using macros
v5 --> v6
- added polling_capable helper flag
v4 --> v5
- removed RFC tag
- consider sync_cmds_atomic_replies flag when deciding if polling is to be
supported and .poll_done() is not provided.
- reviewed commit message
---
drivers/firmware/arm_scmi/common.h | 8 ++++++
drivers/firmware/arm_scmi/driver.c | 40 ++++++++++++++++++++++--------
2 files changed, 38 insertions(+), 10 deletions(-)
@@ -780,10 +787,28 @@ static int scmi_wait_for_message_response(struct scmi_chan_info *cinfo,xfer->hdr.poll_completion);if(xfer->hdr.poll_completion){-ktime_tstop=ktime_add_ms(ktime_get(),timeout_ms);+/*+*RealpollingisneededonlyiftransporthasNOTdeclared+*itselftosupportsynchronouscommandsreplies.+*/+if(!info->desc->sync_cmds_completed_on_ret){+/*+*Pollonxferusingtransportprovided.poll_done();+*assumesnocompletioninterruptwasavailable.+*/+ktime_tstop=ktime_add_ms(ktime_get(),timeout_ms);++spin_until_cond(scmi_xfer_done_no_timeout(cinfo,+xfer,stop));+if(ktime_after(ktime_get(),stop)){+dev_err(dev,+"timed out in resp(caller: %pS) - polling\n",+(void*)_RET_IP_);+ret=-ETIMEDOUT;+}+}-spin_until_cond(scmi_xfer_done_no_timeout(cinfo,xfer,stop));-if(ktime_before(ktime_get(),stop)){+if(!ret){unsignedlongflags;/*
@@ -796,11 +821,6 @@ static int scmi_wait_for_message_response(struct scmi_chan_info *cinfo,xfer->state=SCMI_XFER_RESP_OK;}spin_unlock_irqrestore(&xfer->lock,flags);-}else{-dev_err(dev,-"timed out in resp(caller: %pS) - polling\n",-(void*)_RET_IP_);-ret=-ETIMEDOUT;}}else{/* And we wait for the response. */
@@ -835,7 +855,7 @@ static int do_xfer(const struct scmi_protocol_handle *ph,structscmi_chan_info*cinfo;/* Check for polling request on custom command xfers at first */-if(xfer->hdr.poll_completion&&!info->desc->ops->poll_done){+if(xfer->hdr.poll_completion&&!IS_TRANSPORT_POLLING_CAPABLE(info)){dev_warn_once(dev,"Polling mode is not supported by transport.\n");return-EINVAL;
--
2.17.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Enable sync_cmds_completed_on_ret in the SMC transport descriptor and
remove SMC specific .poll_done callback support since polling is bypassed
when sync_cmds_completed_on_ret is set.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- renaming to sync_cmds_completed_on_ret
v4 --> v5
- removed RFC tag
- added comment on setting flag
- remove smc_poll_done
---
drivers/firmware/arm_scmi/smc.c | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
Add a Kernel configuration option to enable SCMI SMC transport atomic
mode operation for selected SCMI transactions and leave it as default
disabled.
Substitute mutex usages with busy-waiting and declare smc transport as
.atomic_enabled if such Kernel configuration option is enabled.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- removed ifdeffery, using IS_ENABLED
v5 --> v6
- remove usage of atomic_capable
- removed needless union
- reviewed Kconfig help
v4 --> v5
- removed RFC tag
- add CONFIG_ARM_SCMI_TRANSPORT_SMC_ATOMIC_ENABLE option
- add .atomic_enable support
- make atomic_capable dependent on
CONFIG_ARM_SCMI_TRANSPORT_SMC_ATOMIC_ENABLE
- make also usage of mutexes vs busy-waiting dependent on
CONFIG_ARM_SCMI_TRANSPORT_SMC_ATOMIC_ENABLE
---
drivers/firmware/arm_scmi/Kconfig | 14 ++++++++
drivers/firmware/arm_scmi/smc.c | 56 +++++++++++++++++++++++++++----
2 files changed, 64 insertions(+), 6 deletions(-)
@@ -78,6 +78,20 @@ config ARM_SCMI_TRANSPORT_SMCIfyouwanttheARMSCMIPROTOCOLstacktoincludesupportforatransportbasedonSMC,answerY.+configARM_SCMI_TRANSPORT_SMC_ATOMIC_ENABLE+bool"Enable atomic mode support for SCMI SMC transport"+depends onARM_SCMI_TRANSPORT_SMC+help+EnablesupportofatomicoperationforSCMISMCbasedtransport.++IfyouwanttheSCMISMCbasedtransporttooperateinatomic+mode,avoidinganykindofsleepingbehaviourforselected+transactionsontheTXpath,answerY.+EnablingatomicmodeoperationsallowsanySCMIdriverusingthis+transporttooptionallyaskforatomicSCMItransactionsandoperate+inatomiccontexttoo,atthepriceofusinganumberofbusy-waiting+primitivesalloverinstead.IfunsuresayN.+configARM_SCMI_TRANSPORT_VIRTIObool"SCMI transport based on VirtIO"depends onVIRTIO=y||VIRTIO=ARM_SCMI_PROTOCOL
Add a new xfer parameter to mark_txdone transport operation which enables
the SCMI core to optionally pass back into the transport layer a reference
to the xfer descriptor that is being handled.
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v6 --> v7
- use __unused macro for new param in existing transports
---
drivers/firmware/arm_scmi/common.h | 3 ++-
drivers/firmware/arm_scmi/driver.c | 2 +-
drivers/firmware/arm_scmi/mailbox.c | 3 ++-
drivers/firmware/arm_scmi/optee.c | 3 ++-
drivers/firmware/arm_scmi/smc.c | 3 ++-
5 files changed, 9 insertions(+), 5 deletions(-)
An SCMI transport can be configured as .atomic_enabled in order to signal
to the SCMI core that all its TX path is executed in atomic context and
that, when requested, polling mode should be used while waiting for command
responses.
When a specific platform configuration had properly configured such a
transport as .atomic_enabled, the SCMI core will also take care not to
sleep in the corresponding RX path while waiting for a response if that
specific command transaction was requested as atomic using polling mode.
Asynchronous commands should not be used in an atomic context and so a
warning is emitted if polling was requested for an asynchronous command.
Add also a method to check, from the SCMI drivers, if the underlying SCMI
transport is currently configured to support atomic transactions: this will
be used by upper layers to determine if atomic requests can be supported at
all on this SCMI instance.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- removed usage of poling_capable, use macros
v6 --> v7
- reviewed commit message
- converted async WARN_ON to WARN_ON_ONCE
v5 --> v6
- removed atomic_capable
- fully relying on transport polling capabilities
- removed polling/atomic support for delayed_reponse and WARN
- merged with is_transport_atomic() patch
- is_transport_atomic() now considers polling_capable and
atomic_enabled flags
v4 --> v5
- added .atomic_enabled flag to decide wheter to enable atomic mode or not
for atomic_capable transports
- reviewed commit message
---
drivers/firmware/arm_scmi/common.h | 4 +++
drivers/firmware/arm_scmi/driver.c | 51 ++++++++++++++++++++++++++++--
include/linux/scmi_protocol.h | 8 +++++
3 files changed, 61 insertions(+), 2 deletions(-)
@@ -939,12 +953,24 @@ static int do_xfer_with_response(const struct scmi_protocol_handle *ph,xfer->async_done=&async_response;+/*+*Delayedresponsesshouldnotbepolled,soanasynccommandshould+*nothavebeenusedwhenrequiringanatomic/pollcontext;WARNand+*performinsteadasleepingwait.+*(NoteAsync+IgnoreDelayedResponsesaresentviado_xfer)+*/+WARN_ON_ONCE(xfer->hdr.poll_completion);+ret=do_xfer(ph,xfer);if(!ret){-if(!wait_for_completion_timeout(xfer->async_done,timeout))+if(!wait_for_completion_timeout(xfer->async_done,timeout)){+dev_err(ph->dev,+"timed out in delayed resp(caller: %pS)\n",+(void*)_RET_IP_);ret=-ETIMEDOUT;-elseif(xfer->hdr.status)+}elseif(xfer->hdr.status){ret=scmi_to_linux_errno(xfer->hdr.status);+}}xfer->async_done=NULL;
@@ -1915,6 +1957,7 @@ static int scmi_probe(struct platform_device *pdev)handle->version=&info->version;handle->devm_protocol_get=scmi_devm_protocol_get;handle->devm_protocol_put=scmi_devm_protocol_put;+handle->is_transport_atomic=scmi_is_transport_atomic;if(desc->ops->link_supplier){ret=desc->ops->link_supplier(dev);
@@ -1933,6 +1976,10 @@ static int scmi_probe(struct platform_device *pdev)if(scmi_notification_init(handle))dev_err(dev,"SCMI Notifications NOT available.\n");+if(info->desc->atomic_enabled&&!IS_TRANSPORT_POLLING_CAPABLE(info))+dev_err(dev,+"Transport is not polling capable. Atomic mode not supported.\n");+/**TriggerSCMIBaseprotocolinitialization.*It'smandatoryandwon'tbeeverreleased/deinituntilthe
Declare each OPTEE SCMI channel as not having a completion_irq so as to
enable polling mode and then enable also .sync_cmds_completed_on_ret flag
in the OPTEE transport descriptor so that real polling is itself
effectively bypassed on the rx path: once the optee command invocation has
successfully returned the core will directly fetch the response from the
shared memory area.
Remove OPTEE SCMI transport specific .poll_done callback support since
real polling is effectively bypassed when .sync_cmds_completed_on_ret is
set.
Add OPTEE SCMI transport specific .mark_txdone callback support in order to
properly handle channel locking along the tx path.
Cc: Etienne Carriere <redacted>
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 -> v8
- renaming to sync_cmds_completed_on_ret
v6 --> v7
- reviewed commit message
---
drivers/firmware/arm_scmi/optee.c | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Igor Skalkin <redacted>
Cc: Peter Hilber <redacted>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- removed ifdeffery
- reviewed comments
- simplified spinlocking aroung scmi_feed_vq_tx/rx
- added deferred worker for TX replies to aid while polling mode is active
V6 --> V7
- added a few comments about virtio polling internals
- fixed missing list_del on pending_cmds_list processing
- shrinked spinlocked areas in virtio_poll_done
- added proper spinlocking to scmi_vio_complete_cb while scanning list
of pending cmds
---
drivers/firmware/arm_scmi/Kconfig | 15 ++
drivers/firmware/arm_scmi/virtio.c | 291 ++++++++++++++++++++++++++---
2 files changed, 280 insertions(+), 26 deletions(-)
@@ -65,12 +71,22 @@ struct scmi_vio_channel {*@input:SDUusedfor(delayed)responsesandnotifications*@list:Listwhichscmi_vio_msgmaybepartof*@rx_len:InputSDUsizeinbytes,onceinputhasbeenreceived+*@poll_idx:Lastusedindexregisteredforpollingpurposesifthismessage+*transactionreplywasconfiguredforpolling.+*Notethatsincevirtqueueusedindexisanunsigned16-bitwecan+*usesomeout-of-scalevaluestosignifyparticularconditions.+*@poll_lock:Protectaccessto@poll_idx.*/structscmi_vio_msg{structscmi_msg_payld*request;structscmi_msg_payld*input;structlist_headlist;unsignedintrx_len;+#define VIO_MSG_NOT_POLLED 0xeeeeeeeeUL+#define VIO_MSG_POLL_DONE 0xffffffffUL+unsignedintpoll_idx;+/* lock to protect access to poll_idx. */+spinlock_tpoll_lock;};/* Only one SCMI VirtIO device can possibly exist */
@@ -81,40 +97,43 @@ static bool scmi_vio_have_vq_rx(struct virtio_device *vdev)returnvirtio_has_feature(vdev,VIRTIO_SCMI_F_P2A_CHANNELS);}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */staticintscmi_vio_feed_vq_rx(structscmi_vio_channel*vioch,structscmi_vio_msg*msg,structdevice*dev){structscatterlistsg_in;intrc;-unsignedlongflags;sg_init_one(&sg_in,msg->input,VIRTIO_SCMI_MAX_PDU_SIZE);-spin_lock_irqsave(&vioch->lock,flags);-rc=virtqueue_add_inbuf(vioch->vqueue,&sg_in,1,msg,GFP_ATOMIC);if(rc)dev_err(dev,"failed to add to RX virtqueue (%d)\n",rc);elsevirtqueue_kick(vioch->vqueue);-spin_unlock_irqrestore(&vioch->lock,flags);-returnrc;}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */+staticinlinevoidscmi_vio_feed_vq_tx(structscmi_vio_channel*vioch,+structscmi_vio_msg*msg)+{+spin_lock(&msg->poll_lock);+msg->poll_idx=VIO_MSG_NOT_POLLED;+spin_unlock(&msg->poll_lock);++list_add(&msg->list,&vioch->free_list);+}+staticvoidscmi_finalize_message(structscmi_vio_channel*vioch,structscmi_vio_msg*msg){-if(vioch->is_rx){+if(vioch->is_rx)scmi_vio_feed_vq_rx(vioch,msg,vioch->cinfo->dev);-}else{-/* Here IRQs are assumed to be already disabled by the caller */-spin_lock(&vioch->lock);-list_add(&msg->list,&vioch->free_list);-spin_unlock(&vioch->lock);-}+else+scmi_vio_feed_vq_tx(vioch,msg);}staticvoidscmi_vio_complete_cb(structvirtqueue*vqueue)
@@ -176,6 +198,34 @@ static void scmi_vio_complete_cb(struct virtqueue *vqueue)spin_unlock_irqrestore(&vioch->ready_lock,ready_flags);}+staticvoidscmi_vio_deferred_tx_worker(structwork_struct*work)+{+unsignedlongflags;+structscmi_vio_channel*vioch;+structscmi_vio_msg*msg,*tmp;++vioch=container_of(work,structscmi_vio_channel,deferred_tx_work);++/* Process pre-fetched messages */+spin_lock_irqsave(&vioch->lock,flags);++/* Scan the list of possibly pre-fetched messages during polling. */+list_for_each_entry_safe(msg,tmp,&vioch->pending_cmds_list,list){+list_del(&msg->list);++scmi_rx_callback(vioch->cinfo,+msg_read_header(msg->input),msg);++/* Free the processed message once done */+scmi_vio_feed_vq_tx(vioch,msg);+}++spin_unlock_irqrestore(&vioch->lock,flags);++/* Process possibly still pending messages */+scmi_vio_complete_cb(vioch->vqueue);+}+staticconstchar*constscmi_vio_vqueue_names[]={"tx","rx"};staticvq_callback_t*scmi_vio_complete_callbacks[]={
@@ -244,6 +294,19 @@ static int virtio_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,vioch=&((structscmi_vio_channel*)scmi_vdev->priv)[index];+/* Setup a deferred worker for polling. */+if(tx&&!vioch->deferred_tx_wq){+vioch->deferred_tx_wq=+alloc_workqueue(dev_name(&scmi_vdev->dev),+WQ_UNBOUND|WQ_FREEZABLE|WQ_SYSFS,+0);+if(!vioch->deferred_tx_wq)+return-ENOMEM;++INIT_WORK(&vioch->deferred_tx_work,+scmi_vio_deferred_tx_worker);+}+for(i=0;i<vioch->max_msg;i++){structscmi_vio_msg*msg;
@@ -324,7 +392,8 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,}msg=list_first_entry(&vioch->free_list,typeof(*msg),list);-list_del(&msg->list);+/* Re-init element so we can discern anytime if it is still in-flight */+list_del_init(&msg->list);msg_tx_prepare(msg->request,xfer);
@@ -337,6 +406,19 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,dev_err(vioch->cinfo->dev,"failed to add to TX virtqueue (%d)\n",rc);}else{+/*+*Ifpollingwasrequestedforthistransaction:+*-retrievelastusedindex(willbeusedaspollingreference)+*-bindthepolledmessagetothexfervia.priv+*/+if(xfer->hdr.poll_completion){+spin_lock(&msg->poll_lock);+msg->poll_idx=+virtqueue_enable_cb_prepare(vioch->vqueue);+spin_unlock(&msg->poll_lock);+/* Ensure initialized msg is visibly bound to xfer */+smp_store_mb(xfer->priv,msg);+}virtqueue_kick(vioch->vqueue);}
@@ -361,10 +441,165 @@ static void virtio_fetch_notification(struct scmi_chan_info *cinfo,{structscmi_vio_msg*msg=xfer->priv;-if(msg){+if(msg)msg_fetch_notification(msg->input,msg->rx_len,max_len,xfer);-xfer->priv=NULL;+}++/**+*virtio_mark_txdone-Marktransmissiondone+*+*Freeonlysuccessfullycompletedpollingtransfermessages.+*+*NotethatintheSCMIVirtIOtransportweneverexplicitlyreleasetimed-out+*messagesbyforciblyre-addingthemtothefree-list,evenontimeout,inside+*theTXcodepath;weinsteadletIRQ/RXcallbackseventuallycleanupsuch+*messagesonce,finally,alatereplyisreceivedanddiscarded(ifever).+*+*Thisapproachwasdeemedpreferablesincethosependingtimed-outbuffersare+*stilleffectivelyownedbytheSCMIplatformVirtIOdeviceevenaftertimeout+*expiration:forciblyfreeingandreusingthembeforetheyhadbeenreturned+*explicitlybytheSCMIplatformcouldleadtosubtlebugsduetomessage+*corruption.+*AnSCMIplatformVirtIOdevicewhichneverreturnsmessagebuffersis+*anywaybrokenanditwillquicklyleadtoexhaustionofavailablemessages.+*+*Forthissamereason,here,wetakecaretofreeonlythesuccessfully+*completedpolledmessages,sincetheywon'tbefreedelsewhere;latereplies+*totimed-outpolledmessageswouldbeanywayfreedbyRXcallbacksinstead.+*+*@cinfo:SCMIchannelinfo+*@ret:Transmissionreturncode+*@xfer:Transferdescriptor+*/+staticvoidvirtio_mark_txdone(structscmi_chan_info*cinfo,intret,+structscmi_xfer*xfer)+{+unsignedlongflags;+structscmi_vio_channel*vioch=cinfo->transport_info;+structscmi_vio_msg*msg=xfer->priv;++if(!msg)+return;++/* Ensure msg is unbound from xfer before pushing onto the free list */+smp_store_mb(xfer->priv,NULL);++/* Is a successfully completed polled message still to be finalized ? */+spin_lock_irqsave(&vioch->lock,flags);+if(!ret&&xfer->hdr.poll_completion&&list_empty(&msg->list))+scmi_vio_feed_vq_tx(vioch,msg);+spin_unlock_irqrestore(&vioch->lock,flags);+}++/**+*virtio_poll_done-ProvidepollingsupportforVirtIOtransport+*+*@cinfo:SCMIchannelinfo+*@xfer:Referencetothetransferbeingpollfor.+*+*VirtIOcoreprovidesapollingmechanismbasedonlyonlastusedindexes:+*thismeansthatitispossibletopollthevirtqueueswaitingforsomething+*newtoarrivefromthehostsidebuttheonlywaytocheckifthefreshly+*arrivedbufferwaswhatwewerewaitingforistocomparethenewlyarrived+*messagedescriptorswiththeonewearepollingon.+*+*Asaconsequenceitcanhappentodequeuesomethingdifferentfromthebuffer+*wewerepoll-waitingfor:ifthatisthecasesuchearlyfetchedbuffersare+*thenaddedtoathe@pending_cmds_listlistforlaterprocessingbya+*dedicateddeferredworker.+*+*So,basically,oncesomethingnewisspottedweproceedtode-queueallthe+*freshlyreceivedusedbuffersuntilwefoundtheonewewerepollingon,or,+*wehave'seemingly'emptiedthevirtqueue;ifsomebuffersarestillpending+*inthevqueueattheendofthepollingloop(possibleduetoinherentraces+*invirtqueueshandlingmechanisms),wesimilarlykickthedeferredworker+*andletitprocessthose,toavoidindefinitelyloopinginthe.poll_done+*helper.+*+*NotethatwedoNOTsuppressnotificationwithVIRTQ_USED_F_NO_NOTIFYeven+*whenpollingsincesuchflagisper-virtqueuesandwedonotwantto+*suppressnotificationsasawhole:so,ifthemessagewearepollingforis+*deliveredviausualIRQscallbacks,onanothercorewhichareIRQs-on,it+*willbehandledassuchbyscmi_rx_callback()andthepollingloopinthe+*SCMICoreTXpathwillbetransparentlyterminatedanyway.+*+*Return:Trueoncepollinghassuccessfullycompleted.+*/+staticboolvirtio_poll_done(structscmi_chan_info*cinfo,+structscmi_xfer*xfer)+{+boolpending,ret=false;+unsignedintlength,any_prefetched=0;+unsignedlongflags;+structscmi_vio_msg*next_msg,*msg=xfer->priv;+structscmi_vio_channel*vioch=cinfo->transport_info;++if(!msg)+returntrue;++spin_lock_irqsave(&msg->poll_lock,flags);+/* Processed already by other polling loop on another CPU ? */+if(msg->poll_idx==VIO_MSG_POLL_DONE){+spin_unlock_irqrestore(&msg->poll_lock,flags);+returntrue;}++/* Has cmdq index moved at all ? */+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock_irqrestore(&msg->poll_lock,flags);+if(!pending)+returnfalse;++spin_lock_irqsave(&vioch->lock,flags);+virtqueue_disable_cb(vioch->vqueue);++/*+*Ifsomethingarrivedwecannotbesure,withoutdequeueing,ifit+*wasthereplytothexferwearepollingfor,or,toother,even+*possiblynon-polling,pendingxfers:processallnewmessages+*tillthepolled-formessageisfoundORthevqueueisempty.+*/+while((next_msg=virtqueue_get_buf(vioch->vqueue,&length))){+next_msg->rx_len=length;+/* Is the message we were polling for ? */+if(next_msg==msg){+ret=true;+break;+}++spin_lock(&next_msg->poll_lock);+if(next_msg->poll_idx==VIO_MSG_NOT_POLLED){+any_prefetched++;+list_add_tail(&next_msg->list,+&vioch->pending_cmds_list);+}else{+next_msg->poll_idx=VIO_MSG_POLL_DONE;+}+spin_unlock(&next_msg->poll_lock);+}++/*+*Whenthepollingloophassuccessfullyterminatedifsomething+*elsewasqueuedinthemeantime,itwillbeservedbyadeferred+*workerORbythenormalIRQ/callbackORbyotherpollloops.+*+*Ifwearestilllookingforthepolledreply,thepollingindexhas+*tobeupdatedtothecurrentvqueuelastusedindex.+*/+if(ret){+pending=!virtqueue_enable_cb(vioch->vqueue);+}else{+spin_lock(&msg->poll_lock);+msg->poll_idx=virtqueue_enable_cb_prepare(vioch->vqueue);+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock(&msg->poll_lock);+}+spin_unlock_irqrestore(&vioch->lock,flags);++if(any_prefetched||pending)+queue_work(vioch->deferred_tx_wq,&vioch->deferred_tx_work);++returnret;}staticconststructscmi_transport_opsscmi_virtio_ops={
From: "Michael S. Tsirkin" <mst@redhat.com> Date: 2021-12-20 23:17:13
On Mon, Dec 20, 2021 at 07:56:44PM +0000, Cristian Marussi wrote:
quoted hunk
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Igor Skalkin <redacted>
Cc: Peter Hilber <redacted>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- removed ifdeffery
- reviewed comments
- simplified spinlocking aroung scmi_feed_vq_tx/rx
- added deferred worker for TX replies to aid while polling mode is active
V6 --> V7
- added a few comments about virtio polling internals
- fixed missing list_del on pending_cmds_list processing
- shrinked spinlocked areas in virtio_poll_done
- added proper spinlocking to scmi_vio_complete_cb while scanning list
of pending cmds
---
drivers/firmware/arm_scmi/Kconfig | 15 ++
drivers/firmware/arm_scmi/virtio.c | 291 ++++++++++++++++++++++++++---
2 files changed, 280 insertions(+), 26 deletions(-)
@@ -65,12 +71,22 @@ struct scmi_vio_channel {*@input:SDUusedfor(delayed)responsesandnotifications*@list:Listwhichscmi_vio_msgmaybepartof*@rx_len:InputSDUsizeinbytes,onceinputhasbeenreceived+*@poll_idx:Lastusedindexregisteredforpollingpurposesifthismessage+*transactionreplywasconfiguredforpolling.+*Notethatsincevirtqueueusedindexisanunsigned16-bitwecan+*usesomeout-of-scalevaluestosignifyparticularconditions.+*@poll_lock:Protectaccessto@poll_idx.*/structscmi_vio_msg{structscmi_msg_payld*request;structscmi_msg_payld*input;structlist_headlist;unsignedintrx_len;+#define VIO_MSG_NOT_POLLED 0xeeeeeeeeUL+#define VIO_MSG_POLL_DONE 0xffffffffUL+unsignedintpoll_idx;+/* lock to protect access to poll_idx. */+spinlock_tpoll_lock;};/* Only one SCMI VirtIO device can possibly exist */
@@ -81,40 +97,43 @@ static bool scmi_vio_have_vq_rx(struct virtio_device *vdev)returnvirtio_has_feature(vdev,VIRTIO_SCMI_F_P2A_CHANNELS);}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */staticintscmi_vio_feed_vq_rx(structscmi_vio_channel*vioch,structscmi_vio_msg*msg,structdevice*dev){structscatterlistsg_in;intrc;-unsignedlongflags;sg_init_one(&sg_in,msg->input,VIRTIO_SCMI_MAX_PDU_SIZE);-spin_lock_irqsave(&vioch->lock,flags);-rc=virtqueue_add_inbuf(vioch->vqueue,&sg_in,1,msg,GFP_ATOMIC);if(rc)dev_err(dev,"failed to add to RX virtqueue (%d)\n",rc);elsevirtqueue_kick(vioch->vqueue);-spin_unlock_irqrestore(&vioch->lock,flags);-returnrc;}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */+staticinlinevoidscmi_vio_feed_vq_tx(structscmi_vio_channel*vioch,+structscmi_vio_msg*msg)+{+spin_lock(&msg->poll_lock);+msg->poll_idx=VIO_MSG_NOT_POLLED;+spin_unlock(&msg->poll_lock);++list_add(&msg->list,&vioch->free_list);+}+staticvoidscmi_finalize_message(structscmi_vio_channel*vioch,structscmi_vio_msg*msg){-if(vioch->is_rx){+if(vioch->is_rx)scmi_vio_feed_vq_rx(vioch,msg,vioch->cinfo->dev);-}else{-/* Here IRQs are assumed to be already disabled by the caller */-spin_lock(&vioch->lock);-list_add(&msg->list,&vioch->free_list);-spin_unlock(&vioch->lock);-}+else+scmi_vio_feed_vq_tx(vioch,msg);}staticvoidscmi_vio_complete_cb(structvirtqueue*vqueue)
@@ -176,6 +198,34 @@ static void scmi_vio_complete_cb(struct virtqueue *vqueue)spin_unlock_irqrestore(&vioch->ready_lock,ready_flags);}+staticvoidscmi_vio_deferred_tx_worker(structwork_struct*work)+{+unsignedlongflags;+structscmi_vio_channel*vioch;+structscmi_vio_msg*msg,*tmp;++vioch=container_of(work,structscmi_vio_channel,deferred_tx_work);++/* Process pre-fetched messages */+spin_lock_irqsave(&vioch->lock,flags);++/* Scan the list of possibly pre-fetched messages during polling. */+list_for_each_entry_safe(msg,tmp,&vioch->pending_cmds_list,list){+list_del(&msg->list);++scmi_rx_callback(vioch->cinfo,+msg_read_header(msg->input),msg);++/* Free the processed message once done */+scmi_vio_feed_vq_tx(vioch,msg);+}++spin_unlock_irqrestore(&vioch->lock,flags);++/* Process possibly still pending messages */+scmi_vio_complete_cb(vioch->vqueue);+}+staticconstchar*constscmi_vio_vqueue_names[]={"tx","rx"};staticvq_callback_t*scmi_vio_complete_callbacks[]={
@@ -244,6 +294,19 @@ static int virtio_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,vioch=&((structscmi_vio_channel*)scmi_vdev->priv)[index];+/* Setup a deferred worker for polling. */+if(tx&&!vioch->deferred_tx_wq){+vioch->deferred_tx_wq=+alloc_workqueue(dev_name(&scmi_vdev->dev),+WQ_UNBOUND|WQ_FREEZABLE|WQ_SYSFS,+0);+if(!vioch->deferred_tx_wq)+return-ENOMEM;++INIT_WORK(&vioch->deferred_tx_work,+scmi_vio_deferred_tx_worker);+}+for(i=0;i<vioch->max_msg;i++){structscmi_vio_msg*msg;
@@ -324,7 +392,8 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,}msg=list_first_entry(&vioch->free_list,typeof(*msg),list);-list_del(&msg->list);+/* Re-init element so we can discern anytime if it is still in-flight */+list_del_init(&msg->list);msg_tx_prepare(msg->request,xfer);
@@ -337,6 +406,19 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,dev_err(vioch->cinfo->dev,"failed to add to TX virtqueue (%d)\n",rc);}else{+/*+*Ifpollingwasrequestedforthistransaction:+*-retrievelastusedindex(willbeusedaspollingreference)+*-bindthepolledmessagetothexfervia.priv+*/+if(xfer->hdr.poll_completion){+spin_lock(&msg->poll_lock);+msg->poll_idx=+virtqueue_enable_cb_prepare(vioch->vqueue);+spin_unlock(&msg->poll_lock);+/* Ensure initialized msg is visibly bound to xfer */+smp_store_mb(xfer->priv,msg);+}virtqueue_kick(vioch->vqueue);}
@@ -361,10 +441,165 @@ static void virtio_fetch_notification(struct scmi_chan_info *cinfo,{structscmi_vio_msg*msg=xfer->priv;-if(msg){+if(msg)msg_fetch_notification(msg->input,msg->rx_len,max_len,xfer);-xfer->priv=NULL;+}++/**+*virtio_mark_txdone-Marktransmissiondone+*+*Freeonlysuccessfullycompletedpollingtransfermessages.+*+*NotethatintheSCMIVirtIOtransportweneverexplicitlyreleasetimed-out+*messagesbyforciblyre-addingthemtothefree-list,evenontimeout,inside+*theTXcodepath;weinsteadletIRQ/RXcallbackseventuallycleanupsuch+*messagesonce,finally,alatereplyisreceivedanddiscarded(ifever).+*+*Thisapproachwasdeemedpreferablesincethosependingtimed-outbuffersare+*stilleffectivelyownedbytheSCMIplatformVirtIOdeviceevenaftertimeout+*expiration:forciblyfreeingandreusingthembeforetheyhadbeenreturned+*explicitlybytheSCMIplatformcouldleadtosubtlebugsduetomessage+*corruption.+*AnSCMIplatformVirtIOdevicewhichneverreturnsmessagebuffersis+*anywaybrokenanditwillquicklyleadtoexhaustionofavailablemessages.+*+*Forthissamereason,here,wetakecaretofreeonlythesuccessfully+*completedpolledmessages,sincetheywon'tbefreedelsewhere;latereplies+*totimed-outpolledmessageswouldbeanywayfreedbyRXcallbacksinstead.+*+*@cinfo:SCMIchannelinfo+*@ret:Transmissionreturncode+*@xfer:Transferdescriptor+*/+staticvoidvirtio_mark_txdone(structscmi_chan_info*cinfo,intret,+structscmi_xfer*xfer)+{+unsignedlongflags;+structscmi_vio_channel*vioch=cinfo->transport_info;+structscmi_vio_msg*msg=xfer->priv;++if(!msg)+return;++/* Ensure msg is unbound from xfer before pushing onto the free list */+smp_store_mb(xfer->priv,NULL);++/* Is a successfully completed polled message still to be finalized ? */+spin_lock_irqsave(&vioch->lock,flags);+if(!ret&&xfer->hdr.poll_completion&&list_empty(&msg->list))+scmi_vio_feed_vq_tx(vioch,msg);+spin_unlock_irqrestore(&vioch->lock,flags);+}++/**+*virtio_poll_done-ProvidepollingsupportforVirtIOtransport+*+*@cinfo:SCMIchannelinfo+*@xfer:Referencetothetransferbeingpollfor.+*+*VirtIOcoreprovidesapollingmechanismbasedonlyonlastusedindexes:+*thismeansthatitispossibletopollthevirtqueueswaitingforsomething+*newtoarrivefromthehostsidebuttheonlywaytocheckifthefreshly+*arrivedbufferwaswhatwewerewaitingforistocomparethenewlyarrived+*messagedescriptorswiththeonewearepollingon.+*+*Asaconsequenceitcanhappentodequeuesomethingdifferentfromthebuffer+*wewerepoll-waitingfor:ifthatisthecasesuchearlyfetchedbuffersare+*thenaddedtoathe@pending_cmds_listlistforlaterprocessingbya+*dedicateddeferredworker.+*+*So,basically,oncesomethingnewisspottedweproceedtode-queueallthe+*freshlyreceivedusedbuffersuntilwefoundtheonewewerepollingon,or,+*wehave'seemingly'emptiedthevirtqueue;ifsomebuffersarestillpending+*inthevqueueattheendofthepollingloop(possibleduetoinherentraces+*invirtqueueshandlingmechanisms),wesimilarlykickthedeferredworker+*andletitprocessthose,toavoidindefinitelyloopinginthe.poll_done+*helper.+*+*NotethatwedoNOTsuppressnotificationwithVIRTQ_USED_F_NO_NOTIFYeven+*whenpollingsincesuchflagisper-virtqueuesandwedonotwantto+*suppressnotificationsasawhole:so,ifthemessagewearepollingforis+*deliveredviausualIRQscallbacks,onanothercorewhichareIRQs-on,it+*willbehandledassuchbyscmi_rx_callback()andthepollingloopinthe+*SCMICoreTXpathwillbetransparentlyterminatedanyway.+*+*Return:Trueoncepollinghassuccessfullycompleted.+*/+staticboolvirtio_poll_done(structscmi_chan_info*cinfo,+structscmi_xfer*xfer)+{+boolpending,ret=false;+unsignedintlength,any_prefetched=0;+unsignedlongflags;+structscmi_vio_msg*next_msg,*msg=xfer->priv;+structscmi_vio_channel*vioch=cinfo->transport_info;++if(!msg)+returntrue;++spin_lock_irqsave(&msg->poll_lock,flags);+/* Processed already by other polling loop on another CPU ? */+if(msg->poll_idx==VIO_MSG_POLL_DONE){+spin_unlock_irqrestore(&msg->poll_lock,flags);+returntrue;}++/* Has cmdq index moved at all ? */+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock_irqrestore(&msg->poll_lock,flags);+if(!pending)+returnfalse;++spin_lock_irqsave(&vioch->lock,flags);+virtqueue_disable_cb(vioch->vqueue);++/*+*Ifsomethingarrivedwecannotbesure,withoutdequeueing,ifit+*wasthereplytothexferwearepollingfor,or,toother,even+*possiblynon-polling,pendingxfers:processallnewmessages+*tillthepolled-formessageisfoundORthevqueueisempty.+*/+while((next_msg=virtqueue_get_buf(vioch->vqueue,&length))){+next_msg->rx_len=length;+/* Is the message we were polling for ? */+if(next_msg==msg){+ret=true;+break;+}++spin_lock(&next_msg->poll_lock);+if(next_msg->poll_idx==VIO_MSG_NOT_POLLED){+any_prefetched++;+list_add_tail(&next_msg->list,+&vioch->pending_cmds_list);+}else{+next_msg->poll_idx=VIO_MSG_POLL_DONE;+}+spin_unlock(&next_msg->poll_lock);+}++/*+*Whenthepollingloophassuccessfullyterminatedifsomething+*elsewasqueuedinthemeantime,itwillbeservedbyadeferred+*workerORbythenormalIRQ/callbackORbyotherpollloops.+*+*Ifwearestilllookingforthepolledreply,thepollingindexhas+*tobeupdatedtothecurrentvqueuelastusedindex.+*/+if(ret){+pending=!virtqueue_enable_cb(vioch->vqueue);+}else{+spin_lock(&msg->poll_lock);+msg->poll_idx=virtqueue_enable_cb_prepare(vioch->vqueue);+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock(&msg->poll_lock);+}+spin_unlock_irqrestore(&vioch->lock,flags);++if(any_prefetched||pending)+queue_work(vioch->deferred_tx_wq,&vioch->deferred_tx_work);
I don't see any attempt to make sure the queued work is no longer
running on e.g. device or driver removal.
On Mon, Dec 20, 2021 at 06:17:03PM -0500, Michael S. Tsirkin wrote:
On Mon, Dec 20, 2021 at 07:56:44PM +0000, Cristian Marussi wrote:
quoted
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Hi Michael,
thanks for your review.
quoted
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Igor Skalkin <redacted>
Cc: Peter Hilber <redacted>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v7 --> v8
- removed ifdeffery
- reviewed comments
- simplified spinlocking aroung scmi_feed_vq_tx/rx
- added deferred worker for TX replies to aid while polling mode is active
V6 --> V7
- added a few comments about virtio polling internals
- fixed missing list_del on pending_cmds_list processing
- shrinked spinlocked areas in virtio_poll_done
- added proper spinlocking to scmi_vio_complete_cb while scanning list
of pending cmds
---
drivers/firmware/arm_scmi/Kconfig | 15 ++
drivers/firmware/arm_scmi/virtio.c | 291 ++++++++++++++++++++++++++---
2 files changed, 280 insertions(+), 26 deletions(-)
@@ -65,12 +71,22 @@ struct scmi_vio_channel {*@input:SDUusedfor(delayed)responsesandnotifications*@list:Listwhichscmi_vio_msgmaybepartof*@rx_len:InputSDUsizeinbytes,onceinputhasbeenreceived+*@poll_idx:Lastusedindexregisteredforpollingpurposesifthismessage+*transactionreplywasconfiguredforpolling.+*Notethatsincevirtqueueusedindexisanunsigned16-bitwecan+*usesomeout-of-scalevaluestosignifyparticularconditions.+*@poll_lock:Protectaccessto@poll_idx.*/structscmi_vio_msg{structscmi_msg_payld*request;structscmi_msg_payld*input;structlist_headlist;unsignedintrx_len;+#define VIO_MSG_NOT_POLLED 0xeeeeeeeeUL+#define VIO_MSG_POLL_DONE 0xffffffffUL+unsignedintpoll_idx;+/* lock to protect access to poll_idx. */+spinlock_tpoll_lock;};/* Only one SCMI VirtIO device can possibly exist */
@@ -81,40 +97,43 @@ static bool scmi_vio_have_vq_rx(struct virtio_device *vdev)returnvirtio_has_feature(vdev,VIRTIO_SCMI_F_P2A_CHANNELS);}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */staticintscmi_vio_feed_vq_rx(structscmi_vio_channel*vioch,structscmi_vio_msg*msg,structdevice*dev){structscatterlistsg_in;intrc;-unsignedlongflags;sg_init_one(&sg_in,msg->input,VIRTIO_SCMI_MAX_PDU_SIZE);-spin_lock_irqsave(&vioch->lock,flags);-rc=virtqueue_add_inbuf(vioch->vqueue,&sg_in,1,msg,GFP_ATOMIC);if(rc)dev_err(dev,"failed to add to RX virtqueue (%d)\n",rc);elsevirtqueue_kick(vioch->vqueue);-spin_unlock_irqrestore(&vioch->lock,flags);-returnrc;}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */+staticinlinevoidscmi_vio_feed_vq_tx(structscmi_vio_channel*vioch,+structscmi_vio_msg*msg)+{+spin_lock(&msg->poll_lock);+msg->poll_idx=VIO_MSG_NOT_POLLED;+spin_unlock(&msg->poll_lock);++list_add(&msg->list,&vioch->free_list);+}+staticvoidscmi_finalize_message(structscmi_vio_channel*vioch,structscmi_vio_msg*msg){-if(vioch->is_rx){+if(vioch->is_rx)scmi_vio_feed_vq_rx(vioch,msg,vioch->cinfo->dev);-}else{-/* Here IRQs are assumed to be already disabled by the caller */-spin_lock(&vioch->lock);-list_add(&msg->list,&vioch->free_list);-spin_unlock(&vioch->lock);-}+else+scmi_vio_feed_vq_tx(vioch,msg);}staticvoidscmi_vio_complete_cb(structvirtqueue*vqueue)
@@ -176,6 +198,34 @@ static void scmi_vio_complete_cb(struct virtqueue *vqueue)spin_unlock_irqrestore(&vioch->ready_lock,ready_flags);}+staticvoidscmi_vio_deferred_tx_worker(structwork_struct*work)+{+unsignedlongflags;+structscmi_vio_channel*vioch;+structscmi_vio_msg*msg,*tmp;++vioch=container_of(work,structscmi_vio_channel,deferred_tx_work);++/* Process pre-fetched messages */+spin_lock_irqsave(&vioch->lock,flags);++/* Scan the list of possibly pre-fetched messages during polling. */+list_for_each_entry_safe(msg,tmp,&vioch->pending_cmds_list,list){+list_del(&msg->list);++scmi_rx_callback(vioch->cinfo,+msg_read_header(msg->input),msg);++/* Free the processed message once done */+scmi_vio_feed_vq_tx(vioch,msg);+}++spin_unlock_irqrestore(&vioch->lock,flags);++/* Process possibly still pending messages */+scmi_vio_complete_cb(vioch->vqueue);+}+staticconstchar*constscmi_vio_vqueue_names[]={"tx","rx"};staticvq_callback_t*scmi_vio_complete_callbacks[]={
@@ -244,6 +294,19 @@ static int virtio_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,vioch=&((structscmi_vio_channel*)scmi_vdev->priv)[index];+/* Setup a deferred worker for polling. */+if(tx&&!vioch->deferred_tx_wq){+vioch->deferred_tx_wq=+alloc_workqueue(dev_name(&scmi_vdev->dev),+WQ_UNBOUND|WQ_FREEZABLE|WQ_SYSFS,+0);+if(!vioch->deferred_tx_wq)+return-ENOMEM;++INIT_WORK(&vioch->deferred_tx_work,+scmi_vio_deferred_tx_worker);+}+for(i=0;i<vioch->max_msg;i++){structscmi_vio_msg*msg;
@@ -324,7 +392,8 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,}msg=list_first_entry(&vioch->free_list,typeof(*msg),list);-list_del(&msg->list);+/* Re-init element so we can discern anytime if it is still in-flight */+list_del_init(&msg->list);msg_tx_prepare(msg->request,xfer);
@@ -337,6 +406,19 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,dev_err(vioch->cinfo->dev,"failed to add to TX virtqueue (%d)\n",rc);}else{+/*+*Ifpollingwasrequestedforthistransaction:+*-retrievelastusedindex(willbeusedaspollingreference)+*-bindthepolledmessagetothexfervia.priv+*/+if(xfer->hdr.poll_completion){+spin_lock(&msg->poll_lock);+msg->poll_idx=+virtqueue_enable_cb_prepare(vioch->vqueue);+spin_unlock(&msg->poll_lock);+/* Ensure initialized msg is visibly bound to xfer */+smp_store_mb(xfer->priv,msg);+}virtqueue_kick(vioch->vqueue);}
@@ -361,10 +441,165 @@ static void virtio_fetch_notification(struct scmi_chan_info *cinfo,{structscmi_vio_msg*msg=xfer->priv;-if(msg){+if(msg)msg_fetch_notification(msg->input,msg->rx_len,max_len,xfer);-xfer->priv=NULL;+}++/**+*virtio_mark_txdone-Marktransmissiondone+*+*Freeonlysuccessfullycompletedpollingtransfermessages.+*+*NotethatintheSCMIVirtIOtransportweneverexplicitlyreleasetimed-out+*messagesbyforciblyre-addingthemtothefree-list,evenontimeout,inside+*theTXcodepath;weinsteadletIRQ/RXcallbackseventuallycleanupsuch+*messagesonce,finally,alatereplyisreceivedanddiscarded(ifever).+*+*Thisapproachwasdeemedpreferablesincethosependingtimed-outbuffersare+*stilleffectivelyownedbytheSCMIplatformVirtIOdeviceevenaftertimeout+*expiration:forciblyfreeingandreusingthembeforetheyhadbeenreturned+*explicitlybytheSCMIplatformcouldleadtosubtlebugsduetomessage+*corruption.+*AnSCMIplatformVirtIOdevicewhichneverreturnsmessagebuffersis+*anywaybrokenanditwillquicklyleadtoexhaustionofavailablemessages.+*+*Forthissamereason,here,wetakecaretofreeonlythesuccessfully+*completedpolledmessages,sincetheywon'tbefreedelsewhere;latereplies+*totimed-outpolledmessageswouldbeanywayfreedbyRXcallbacksinstead.+*+*@cinfo:SCMIchannelinfo+*@ret:Transmissionreturncode+*@xfer:Transferdescriptor+*/+staticvoidvirtio_mark_txdone(structscmi_chan_info*cinfo,intret,+structscmi_xfer*xfer)+{+unsignedlongflags;+structscmi_vio_channel*vioch=cinfo->transport_info;+structscmi_vio_msg*msg=xfer->priv;++if(!msg)+return;++/* Ensure msg is unbound from xfer before pushing onto the free list */+smp_store_mb(xfer->priv,NULL);++/* Is a successfully completed polled message still to be finalized ? */+spin_lock_irqsave(&vioch->lock,flags);+if(!ret&&xfer->hdr.poll_completion&&list_empty(&msg->list))+scmi_vio_feed_vq_tx(vioch,msg);+spin_unlock_irqrestore(&vioch->lock,flags);+}++/**+*virtio_poll_done-ProvidepollingsupportforVirtIOtransport+*+*@cinfo:SCMIchannelinfo+*@xfer:Referencetothetransferbeingpollfor.+*+*VirtIOcoreprovidesapollingmechanismbasedonlyonlastusedindexes:+*thismeansthatitispossibletopollthevirtqueueswaitingforsomething+*newtoarrivefromthehostsidebuttheonlywaytocheckifthefreshly+*arrivedbufferwaswhatwewerewaitingforistocomparethenewlyarrived+*messagedescriptorswiththeonewearepollingon.+*+*Asaconsequenceitcanhappentodequeuesomethingdifferentfromthebuffer+*wewerepoll-waitingfor:ifthatisthecasesuchearlyfetchedbuffersare+*thenaddedtoathe@pending_cmds_listlistforlaterprocessingbya+*dedicateddeferredworker.+*+*So,basically,oncesomethingnewisspottedweproceedtode-queueallthe+*freshlyreceivedusedbuffersuntilwefoundtheonewewerepollingon,or,+*wehave'seemingly'emptiedthevirtqueue;ifsomebuffersarestillpending+*inthevqueueattheendofthepollingloop(possibleduetoinherentraces+*invirtqueueshandlingmechanisms),wesimilarlykickthedeferredworker+*andletitprocessthose,toavoidindefinitelyloopinginthe.poll_done+*helper.+*+*NotethatwedoNOTsuppressnotificationwithVIRTQ_USED_F_NO_NOTIFYeven+*whenpollingsincesuchflagisper-virtqueuesandwedonotwantto+*suppressnotificationsasawhole:so,ifthemessagewearepollingforis+*deliveredviausualIRQscallbacks,onanothercorewhichareIRQs-on,it+*willbehandledassuchbyscmi_rx_callback()andthepollingloopinthe+*SCMICoreTXpathwillbetransparentlyterminatedanyway.+*+*Return:Trueoncepollinghassuccessfullycompleted.+*/+staticboolvirtio_poll_done(structscmi_chan_info*cinfo,+structscmi_xfer*xfer)+{+boolpending,ret=false;+unsignedintlength,any_prefetched=0;+unsignedlongflags;+structscmi_vio_msg*next_msg,*msg=xfer->priv;+structscmi_vio_channel*vioch=cinfo->transport_info;++if(!msg)+returntrue;++spin_lock_irqsave(&msg->poll_lock,flags);+/* Processed already by other polling loop on another CPU ? */+if(msg->poll_idx==VIO_MSG_POLL_DONE){+spin_unlock_irqrestore(&msg->poll_lock,flags);+returntrue;}++/* Has cmdq index moved at all ? */+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock_irqrestore(&msg->poll_lock,flags);+if(!pending)+returnfalse;++spin_lock_irqsave(&vioch->lock,flags);+virtqueue_disable_cb(vioch->vqueue);++/*+*Ifsomethingarrivedwecannotbesure,withoutdequeueing,ifit+*wasthereplytothexferwearepollingfor,or,toother,even+*possiblynon-polling,pendingxfers:processallnewmessages+*tillthepolled-formessageisfoundORthevqueueisempty.+*/+while((next_msg=virtqueue_get_buf(vioch->vqueue,&length))){+next_msg->rx_len=length;+/* Is the message we were polling for ? */+if(next_msg==msg){+ret=true;+break;+}++spin_lock(&next_msg->poll_lock);+if(next_msg->poll_idx==VIO_MSG_NOT_POLLED){+any_prefetched++;+list_add_tail(&next_msg->list,+&vioch->pending_cmds_list);+}else{+next_msg->poll_idx=VIO_MSG_POLL_DONE;+}+spin_unlock(&next_msg->poll_lock);+}++/*+*Whenthepollingloophassuccessfullyterminatedifsomething+*elsewasqueuedinthemeantime,itwillbeservedbyadeferred+*workerORbythenormalIRQ/callbackORbyotherpollloops.+*+*Ifwearestilllookingforthepolledreply,thepollingindexhas+*tobeupdatedtothecurrentvqueuelastusedindex.+*/+if(ret){+pending=!virtqueue_enable_cb(vioch->vqueue);+}else{+spin_lock(&msg->poll_lock);+msg->poll_idx=virtqueue_enable_cb_prepare(vioch->vqueue);+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock(&msg->poll_lock);+}+spin_unlock_irqrestore(&vioch->lock,flags);++if(any_prefetched||pending)+queue_work(vioch->deferred_tx_wq,&vioch->deferred_tx_work);
I don't see any attempt to make sure the queued work is no longer
running on e.g. device or driver removal.
Right, I destroy the workqueue and nullify the deferred_tx_wq pointer in
chan_free, I'll add a check here within the spinlocking area to avoid the
race with the destroy in chan_free.
Thanks,
Cristian
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Igor Skalkin <redacted>
Cc: Peter Hilber <redacted>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v8 --> v9
- check for deferred_wq existence before queueing work to avoid
race at driver removal time
---
drivers/firmware/arm_scmi/Kconfig | 15 ++
drivers/firmware/arm_scmi/virtio.c | 298 ++++++++++++++++++++++++++---
2 files changed, 287 insertions(+), 26 deletions(-)
@@ -65,12 +71,22 @@ struct scmi_vio_channel {*@input:SDUusedfor(delayed)responsesandnotifications*@list:Listwhichscmi_vio_msgmaybepartof*@rx_len:InputSDUsizeinbytes,onceinputhasbeenreceived+*@poll_idx:Lastusedindexregisteredforpollingpurposesifthismessage+*transactionreplywasconfiguredforpolling.+*Notethatsincevirtqueueusedindexisanunsigned16-bitwecan+*usesomeout-of-scalevaluestosignifyparticularconditions.+*@poll_lock:Protectaccessto@poll_idx.*/structscmi_vio_msg{structscmi_msg_payld*request;structscmi_msg_payld*input;structlist_headlist;unsignedintrx_len;+#define VIO_MSG_NOT_POLLED 0xeeeeeeeeUL+#define VIO_MSG_POLL_DONE 0xffffffffUL+unsignedintpoll_idx;+/* lock to protect access to poll_idx. */+spinlock_tpoll_lock;};/* Only one SCMI VirtIO device can possibly exist */
@@ -81,40 +97,43 @@ static bool scmi_vio_have_vq_rx(struct virtio_device *vdev)returnvirtio_has_feature(vdev,VIRTIO_SCMI_F_P2A_CHANNELS);}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */staticintscmi_vio_feed_vq_rx(structscmi_vio_channel*vioch,structscmi_vio_msg*msg,structdevice*dev){structscatterlistsg_in;intrc;-unsignedlongflags;sg_init_one(&sg_in,msg->input,VIRTIO_SCMI_MAX_PDU_SIZE);-spin_lock_irqsave(&vioch->lock,flags);-rc=virtqueue_add_inbuf(vioch->vqueue,&sg_in,1,msg,GFP_ATOMIC);if(rc)dev_err(dev,"failed to add to RX virtqueue (%d)\n",rc);elsevirtqueue_kick(vioch->vqueue);-spin_unlock_irqrestore(&vioch->lock,flags);-returnrc;}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */+staticinlinevoidscmi_vio_feed_vq_tx(structscmi_vio_channel*vioch,+structscmi_vio_msg*msg)+{+spin_lock(&msg->poll_lock);+msg->poll_idx=VIO_MSG_NOT_POLLED;+spin_unlock(&msg->poll_lock);++list_add(&msg->list,&vioch->free_list);+}+staticvoidscmi_finalize_message(structscmi_vio_channel*vioch,structscmi_vio_msg*msg){-if(vioch->is_rx){+if(vioch->is_rx)scmi_vio_feed_vq_rx(vioch,msg,vioch->cinfo->dev);-}else{-/* Here IRQs are assumed to be already disabled by the caller */-spin_lock(&vioch->lock);-list_add(&msg->list,&vioch->free_list);-spin_unlock(&vioch->lock);-}+else+scmi_vio_feed_vq_tx(vioch,msg);}staticvoidscmi_vio_complete_cb(structvirtqueue*vqueue)
@@ -176,6 +198,34 @@ static void scmi_vio_complete_cb(struct virtqueue *vqueue)spin_unlock_irqrestore(&vioch->ready_lock,ready_flags);}+staticvoidscmi_vio_deferred_tx_worker(structwork_struct*work)+{+unsignedlongflags;+structscmi_vio_channel*vioch;+structscmi_vio_msg*msg,*tmp;++vioch=container_of(work,structscmi_vio_channel,deferred_tx_work);++/* Process pre-fetched messages */+spin_lock_irqsave(&vioch->lock,flags);++/* Scan the list of possibly pre-fetched messages during polling. */+list_for_each_entry_safe(msg,tmp,&vioch->pending_cmds_list,list){+list_del(&msg->list);++scmi_rx_callback(vioch->cinfo,+msg_read_header(msg->input),msg);++/* Free the processed message once done */+scmi_vio_feed_vq_tx(vioch,msg);+}++spin_unlock_irqrestore(&vioch->lock,flags);++/* Process possibly still pending messages */+scmi_vio_complete_cb(vioch->vqueue);+}+staticconstchar*constscmi_vio_vqueue_names[]={"tx","rx"};staticvq_callback_t*scmi_vio_complete_callbacks[]={
@@ -244,6 +294,19 @@ static int virtio_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,vioch=&((structscmi_vio_channel*)scmi_vdev->priv)[index];+/* Setup a deferred worker for polling. */+if(tx&&!vioch->deferred_tx_wq){+vioch->deferred_tx_wq=+alloc_workqueue(dev_name(&scmi_vdev->dev),+WQ_UNBOUND|WQ_FREEZABLE|WQ_SYSFS,+0);+if(!vioch->deferred_tx_wq)+return-ENOMEM;++INIT_WORK(&vioch->deferred_tx_work,+scmi_vio_deferred_tx_worker);+}+for(i=0;i<vioch->max_msg;i++){structscmi_vio_msg*msg;
@@ -324,7 +398,8 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,}msg=list_first_entry(&vioch->free_list,typeof(*msg),list);-list_del(&msg->list);+/* Re-init element so we can discern anytime if it is still in-flight */+list_del_init(&msg->list);msg_tx_prepare(msg->request,xfer);
@@ -337,6 +412,19 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,dev_err(vioch->cinfo->dev,"failed to add to TX virtqueue (%d)\n",rc);}else{+/*+*Ifpollingwasrequestedforthistransaction:+*-retrievelastusedindex(willbeusedaspollingreference)+*-bindthepolledmessagetothexfervia.priv+*/+if(xfer->hdr.poll_completion){+spin_lock(&msg->poll_lock);+msg->poll_idx=+virtqueue_enable_cb_prepare(vioch->vqueue);+spin_unlock(&msg->poll_lock);+/* Ensure initialized msg is visibly bound to xfer */+smp_store_mb(xfer->priv,msg);+}virtqueue_kick(vioch->vqueue);}
@@ -361,10 +447,166 @@ static void virtio_fetch_notification(struct scmi_chan_info *cinfo,{structscmi_vio_msg*msg=xfer->priv;-if(msg){+if(msg)msg_fetch_notification(msg->input,msg->rx_len,max_len,xfer);-xfer->priv=NULL;+}++/**+*virtio_mark_txdone-Marktransmissiondone+*+*Freeonlysuccessfullycompletedpollingtransfermessages.+*+*NotethatintheSCMIVirtIOtransportweneverexplicitlyreleasetimed-out+*messagesbyforciblyre-addingthemtothefree-list,evenontimeout,inside+*theTXcodepath;weinsteadletIRQ/RXcallbackseventuallycleanupsuch+*messagesonce,finally,alatereplyisreceivedanddiscarded(ifever).+*+*Thisapproachwasdeemedpreferablesincethosependingtimed-outbuffersare+*stilleffectivelyownedbytheSCMIplatformVirtIOdeviceevenaftertimeout+*expiration:forciblyfreeingandreusingthembeforetheyhadbeenreturned+*explicitlybytheSCMIplatformcouldleadtosubtlebugsduetomessage+*corruption.+*AnSCMIplatformVirtIOdevicewhichneverreturnsmessagebuffersis+*anywaybrokenanditwillquicklyleadtoexhaustionofavailablemessages.+*+*Forthissamereason,here,wetakecaretofreeonlythesuccessfully+*completedpolledmessages,sincetheywon'tbefreedelsewhere;latereplies+*totimed-outpolledmessageswouldbeanywayfreedbyRXcallbacksinstead.+*+*@cinfo:SCMIchannelinfo+*@ret:Transmissionreturncode+*@xfer:Transferdescriptor+*/+staticvoidvirtio_mark_txdone(structscmi_chan_info*cinfo,intret,+structscmi_xfer*xfer)+{+unsignedlongflags;+structscmi_vio_channel*vioch=cinfo->transport_info;+structscmi_vio_msg*msg=xfer->priv;++if(!msg)+return;++/* Ensure msg is unbound from xfer before pushing onto the free list */+smp_store_mb(xfer->priv,NULL);++/* Is a successfully completed polled message still to be finalized ? */+spin_lock_irqsave(&vioch->lock,flags);+if(!ret&&xfer->hdr.poll_completion&&list_empty(&msg->list))+scmi_vio_feed_vq_tx(vioch,msg);+spin_unlock_irqrestore(&vioch->lock,flags);+}++/**+*virtio_poll_done-ProvidepollingsupportforVirtIOtransport+*+*@cinfo:SCMIchannelinfo+*@xfer:Referencetothetransferbeingpollfor.+*+*VirtIOcoreprovidesapollingmechanismbasedonlyonlastusedindexes:+*thismeansthatitispossibletopollthevirtqueueswaitingforsomething+*newtoarrivefromthehostsidebuttheonlywaytocheckifthefreshly+*arrivedbufferwaswhatwewerewaitingforistocomparethenewlyarrived+*messagedescriptorswiththeonewearepollingon.+*+*Asaconsequenceitcanhappentodequeuesomethingdifferentfromthebuffer+*wewerepoll-waitingfor:ifthatisthecasesuchearlyfetchedbuffersare+*thenaddedtoathe@pending_cmds_listlistforlaterprocessingbya+*dedicateddeferredworker.+*+*So,basically,oncesomethingnewisspottedweproceedtode-queueallthe+*freshlyreceivedusedbuffersuntilwefoundtheonewewerepollingon,or,+*wehave'seemingly'emptiedthevirtqueue;ifsomebuffersarestillpending+*inthevqueueattheendofthepollingloop(possibleduetoinherentraces+*invirtqueueshandlingmechanisms),wesimilarlykickthedeferredworker+*andletitprocessthose,toavoidindefinitelyloopinginthe.poll_done+*helper.+*+*NotethatwedoNOTsuppressnotificationwithVIRTQ_USED_F_NO_NOTIFYeven+*whenpollingsincesuchflagisper-virtqueuesandwedonotwantto+*suppressnotificationsasawhole:so,ifthemessagewearepollingforis+*deliveredviausualIRQscallbacks,onanothercorewhichareIRQs-on,it+*willbehandledassuchbyscmi_rx_callback()andthepollingloopinthe+*SCMICoreTXpathwillbetransparentlyterminatedanyway.+*+*Return:Trueoncepollinghassuccessfullycompleted.+*/+staticboolvirtio_poll_done(structscmi_chan_info*cinfo,+structscmi_xfer*xfer)+{+boolpending,ret=false;+unsignedintlength,any_prefetched=0;+unsignedlongflags;+structscmi_vio_msg*next_msg,*msg=xfer->priv;+structscmi_vio_channel*vioch=cinfo->transport_info;++if(!msg)+returntrue;++spin_lock_irqsave(&msg->poll_lock,flags);+/* Processed already by other polling loop on another CPU ? */+if(msg->poll_idx==VIO_MSG_POLL_DONE){+spin_unlock_irqrestore(&msg->poll_lock,flags);+returntrue;+}++/* Has cmdq index moved at all ? */+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock_irqrestore(&msg->poll_lock,flags);+if(!pending)+returnfalse;++spin_lock_irqsave(&vioch->lock,flags);+virtqueue_disable_cb(vioch->vqueue);++/*+*Ifsomethingarrivedwecannotbesure,withoutdequeueing,ifit+*wasthereplytothexferwearepollingfor,or,toother,even+*possiblynon-polling,pendingxfers:processallnewmessages+*tillthepolled-formessageisfoundORthevqueueisempty.+*/+while((next_msg=virtqueue_get_buf(vioch->vqueue,&length))){+next_msg->rx_len=length;+/* Is the message we were polling for ? */+if(next_msg==msg){+ret=true;+break;+}++spin_lock(&next_msg->poll_lock);+if(next_msg->poll_idx==VIO_MSG_NOT_POLLED){+any_prefetched++;+list_add_tail(&next_msg->list,+&vioch->pending_cmds_list);+}else{+next_msg->poll_idx=VIO_MSG_POLL_DONE;+}+spin_unlock(&next_msg->poll_lock);}++/*+*Whenthepollingloophassuccessfullyterminatedifsomething+*elsewasqueuedinthemeantime,itwillbeservedbyadeferred+*workerORbythenormalIRQ/callbackORbyotherpollloops.+*+*Ifwearestilllookingforthepolledreply,thepollingindexhas+*tobeupdatedtothecurrentvqueuelastusedindex.+*/+if(ret){+pending=!virtqueue_enable_cb(vioch->vqueue);+}else{+spin_lock(&msg->poll_lock);+msg->poll_idx=virtqueue_enable_cb_prepare(vioch->vqueue);+pending=virtqueue_poll(vioch->vqueue,msg->poll_idx);+spin_unlock(&msg->poll_lock);+}++if(vioch->deferred_tx_wq&&(any_prefetched||pending))+queue_work(vioch->deferred_tx_wq,&vioch->deferred_tx_work);++spin_unlock_irqrestore(&vioch->lock,flags);++returnret;}staticconststructscmi_transport_opsscmi_virtio_ops={
From: Peter Hilber <hidden> Date: 2022-01-18 14:28:37
On 21.12.21 15:00, Cristian Marussi wrote:
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Hi Cristian,
thanks for the update. I have some more remarks inline below.
My impression is that the virtio core does not expose helper functions suitable
to busy-poll for used buffers. But changing this might not be difficult. Maybe
more_used() from virtio_ring.c could be exposed via a wrapper?
Best regards,
Peter
quoted hunk
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Igor Skalkin <redacted>
Cc: Peter Hilber <redacted>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v8 --> v9
- check for deferred_wq existence before queueing work to avoid
race at driver removal time
---
drivers/firmware/arm_scmi/Kconfig | 15 ++
drivers/firmware/arm_scmi/virtio.c | 298 ++++++++++++++++++++++++++---
2 files changed, 287 insertions(+), 26 deletions(-)
@@ -65,12 +71,22 @@ struct scmi_vio_channel {*@input:SDUusedfor(delayed)responsesandnotifications*@list:Listwhichscmi_vio_msgmaybepartof*@rx_len:InputSDUsizeinbytes,onceinputhasbeenreceived+*@poll_idx:Lastusedindexregisteredforpollingpurposesifthismessage+*transactionreplywasconfiguredforpolling.+*Notethatsincevirtqueueusedindexisanunsigned16-bitwecan+*usesomeout-of-scalevaluestosignifyparticularconditions.+*@poll_lock:Protectaccessto@poll_idx.*/structscmi_vio_msg{structscmi_msg_payld*request;structscmi_msg_payld*input;structlist_headlist;unsignedintrx_len;+#define VIO_MSG_NOT_POLLED 0xeeeeeeeeUL+#define VIO_MSG_POLL_DONE 0xffffffffUL+unsignedintpoll_idx;+/* lock to protect access to poll_idx. */+spinlock_tpoll_lock;};/* Only one SCMI VirtIO device can possibly exist */
@@ -81,40 +97,43 @@ static bool scmi_vio_have_vq_rx(struct virtio_device *vdev)returnvirtio_has_feature(vdev,VIRTIO_SCMI_F_P2A_CHANNELS);}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */staticintscmi_vio_feed_vq_rx(structscmi_vio_channel*vioch,structscmi_vio_msg*msg,structdevice*dev){structscatterlistsg_in;intrc;-unsignedlongflags;sg_init_one(&sg_in,msg->input,VIRTIO_SCMI_MAX_PDU_SIZE);-spin_lock_irqsave(&vioch->lock,flags);-rc=virtqueue_add_inbuf(vioch->vqueue,&sg_in,1,msg,GFP_ATOMIC);if(rc)dev_err(dev,"failed to add to RX virtqueue (%d)\n",rc);elsevirtqueue_kick(vioch->vqueue);-spin_unlock_irqrestore(&vioch->lock,flags);-returnrc;}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */+staticinlinevoidscmi_vio_feed_vq_tx(structscmi_vio_channel*vioch,+structscmi_vio_msg*msg)+{+spin_lock(&msg->poll_lock);+msg->poll_idx=VIO_MSG_NOT_POLLED;+spin_unlock(&msg->poll_lock);++list_add(&msg->list,&vioch->free_list);+}+staticvoidscmi_finalize_message(structscmi_vio_channel*vioch,structscmi_vio_msg*msg){-if(vioch->is_rx){+if(vioch->is_rx)scmi_vio_feed_vq_rx(vioch,msg,vioch->cinfo->dev);-}else{-/* Here IRQs are assumed to be already disabled by the caller */-spin_lock(&vioch->lock);-list_add(&msg->list,&vioch->free_list);-spin_unlock(&vioch->lock);-}+else+scmi_vio_feed_vq_tx(vioch,msg);}staticvoidscmi_vio_complete_cb(structvirtqueue*vqueue)
@@ -176,6 +198,34 @@ static void scmi_vio_complete_cb(struct virtqueue *vqueue)spin_unlock_irqrestore(&vioch->ready_lock,ready_flags);}+staticvoidscmi_vio_deferred_tx_worker(structwork_struct*work)+{+unsignedlongflags;+structscmi_vio_channel*vioch;+structscmi_vio_msg*msg,*tmp;++vioch=container_of(work,structscmi_vio_channel,deferred_tx_work);++/* Process pre-fetched messages */+spin_lock_irqsave(&vioch->lock,flags);++/* Scan the list of possibly pre-fetched messages during polling. */+list_for_each_entry_safe(msg,tmp,&vioch->pending_cmds_list,list){+list_del(&msg->list);++scmi_rx_callback(vioch->cinfo,+msg_read_header(msg->input),msg);++/* Free the processed message once done */+scmi_vio_feed_vq_tx(vioch,msg);+}++spin_unlock_irqrestore(&vioch->lock,flags);++/* Process possibly still pending messages */+scmi_vio_complete_cb(vioch->vqueue);+}+staticconstchar*constscmi_vio_vqueue_names[]={"tx","rx"};staticvq_callback_t*scmi_vio_complete_callbacks[]={
@@ -244,6 +294,19 @@ static int virtio_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,vioch=&((structscmi_vio_channel*)scmi_vdev->priv)[index];+/* Setup a deferred worker for polling. */+if(tx&&!vioch->deferred_tx_wq){+vioch->deferred_tx_wq=+alloc_workqueue(dev_name(&scmi_vdev->dev),+WQ_UNBOUND|WQ_FREEZABLE|WQ_SYSFS,+0);+if(!vioch->deferred_tx_wq)+return-ENOMEM;++INIT_WORK(&vioch->deferred_tx_work,+scmi_vio_deferred_tx_worker);+}+for(i=0;i<vioch->max_msg;i++){structscmi_vio_msg*msg;
@@ -324,7 +398,8 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,}msg=list_first_entry(&vioch->free_list,typeof(*msg),list);-list_del(&msg->list);+/* Re-init element so we can discern anytime if it is still in-flight */+list_del_init(&msg->list);msg_tx_prepare(msg->request,xfer);
@@ -337,6 +412,19 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,dev_err(vioch->cinfo->dev,"failed to add to TX virtqueue (%d)\n",rc);}else{+/*+*Ifpollingwasrequestedforthistransaction:+*-retrievelastusedindex(willbeusedaspollingreference)
The virtqueue_add_sgs() called before already exposed the message to the virtio
device, so a fast response might have arrived already, so the reference value
might unexpectedly correspond to the current message.
quoted hunk
+ * - bind the polled message to the xfer via .priv
+ */
+ if (xfer->hdr.poll_completion) {
+ spin_lock(&msg->poll_lock);
+ msg->poll_idx =
+ virtqueue_enable_cb_prepare(vioch->vqueue);
+ spin_unlock(&msg->poll_lock);
+ /* Ensure initialized msg is visibly bound to xfer */
+ smp_store_mb(xfer->priv, msg);
+ }
virtqueue_kick(vioch->vqueue);
}
@@ -361,10 +447,166 @@ static void virtio_fetch_notification(struct scmi_chan_info *cinfo, { struct scmi_vio_msg *msg = xfer->priv;- if (msg) {+ if (msg) msg_fetch_notification(msg->input, msg->rx_len, max_len, xfer);- xfer->priv = NULL;+}++/**+ * virtio_mark_txdone - Mark transmission done+ *+ * Free only successfully completed polling transfer messages.+ *+ * Note that in the SCMI VirtIO transport we never explicitly release timed-out+ * messages by forcibly re-adding them to the free-list, even on timeout, inside+ * the TX code path; we instead let IRQ/RX callbacks eventually clean up such+ * messages once, finally, a late reply is received and discarded (if ever).+ *+ * This approach was deemed preferable since those pending timed-out buffers are+ * still effectively owned by the SCMI platform VirtIO device even after timeout+ * expiration: forcibly freeing and reusing them before they had been returned+ * explicitly by the SCMI platform could lead to subtle bugs due to message+ * corruption.+ * An SCMI platform VirtIO device which never returns message buffers is+ * anyway broken and it will quickly lead to exhaustion of available messages.+ *+ * For this same reason, here, we take care to free only the successfully+ * completed polled messages, since they won't be freed elsewhere; late replies+ * to timed-out polled messages would be anyway freed by RX callbacks instead.+ *+ * @cinfo: SCMI channel info+ * @ret: Transmission return code+ * @xfer: Transfer descriptor+ */+static void virtio_mark_txdone(struct scmi_chan_info *cinfo, int ret,+ struct scmi_xfer *xfer)+{+ unsigned long flags;+ struct scmi_vio_channel *vioch = cinfo->transport_info;+ struct scmi_vio_msg *msg = xfer->priv;++ if (!msg)+ return;++ /* Ensure msg is unbound from xfer before pushing onto the free list */+ smp_store_mb(xfer->priv, NULL);++ /* Is a successfully completed polled message still to be finalized ? */+ spin_lock_irqsave(&vioch->lock, flags);+ if (!ret && xfer->hdr.poll_completion && list_empty(&msg->list))
Could this not also be a message which was already finalized and then
immediately reused for another polling xfer?
+ scmi_vio_feed_vq_tx(vioch, msg);
+ spin_unlock_irqrestore(&vioch->lock, flags);
+}
+
+/**
+ * virtio_poll_done - Provide polling support for VirtIO transport
+ *
+ * @cinfo: SCMI channel info
+ * @xfer: Reference to the transfer being poll for.
+ *
+ * VirtIO core provides a polling mechanism based only on last used indexes:
+ * this means that it is possible to poll the virtqueues waiting for something
+ * new to arrive from the host side but the only way to check if the freshly
+ * arrived buffer was what we were waiting for is to compare the newly arrived
+ * message descriptors with the one we are polling on.
+ *
+ * As a consequence it can happen to dequeue something different from the buffer
+ * we were poll-waiting for: if that is the case such early fetched buffers are
+ * then added to a the @pending_cmds_list list for later processing by a
+ * dedicated deferred worker.
+ *
+ * So, basically, once something new is spotted we proceed to de-queue all the
+ * freshly received used buffers until we found the one we were polling on, or,
+ * we have 'seemingly' emptied the virtqueue; if some buffers are still pending
+ * in the vqueue at the end of the polling loop (possible due to inherent races
+ * in virtqueues handling mechanisms), we similarly kick the deferred worker
+ * and let it process those, to avoid indefinitely looping in the .poll_done
+ * helper.
+ *
+ * Note that we do NOT suppress notification with VIRTQ_USED_F_NO_NOTIFY even
+ * when polling since such flag is per-virtqueues and we do not want to
+ * suppress notifications as a whole: so, if the message we are polling for is
+ * delivered via usual IRQs callbacks, on another core which are IRQs-on, it
+ * will be handled as such by scmi_rx_callback() and the polling loop in the
+ * SCMI Core TX path will be transparently terminated anyway.
Why is VIRTQ_USED_F_NO_NOTIFY mentioned? It is a flag associated with only one
of two buffer notification suppression methods, which are transparently handled
by the virtio core. Cf. `Driver Requirements: Used Buffer Notification
Suppression' in the virtio spec.
+ *
+ * Return: True once polling has successfully completed.
+ */
+static bool virtio_poll_done(struct scmi_chan_info *cinfo,
+ struct scmi_xfer *xfer)
+{
+ bool pending, ret = false;
+ unsigned int length, any_prefetched = 0;
+ unsigned long flags;
+ struct scmi_vio_msg *next_msg, *msg = xfer->priv;
+ struct scmi_vio_channel *vioch = cinfo->transport_info;
+
+ if (!msg)
+ return true;
+
+ spin_lock_irqsave(&msg->poll_lock, flags);
+ /* Processed already by other polling loop on another CPU ? */
+ if (msg->poll_idx == VIO_MSG_POLL_DONE) {
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ return true;
+ }
+
+ /* Has cmdq index moved at all ? */
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
In my understanding, the polling comparison could still be subject to the ABA
problem when exactly 2**16 messages have been marked as used since
msg->poll_idx was set (unlikely scenario, granted).
I think this would be a lot simpler if the virtio core exported some
concurrency-safe helper function for such polling (similar to more_used() from
virtio_ring.c), as discussed at the top.
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ if (!pending)
+ return false;
+
+ spin_lock_irqsave(&vioch->lock, flags);
+ virtqueue_disable_cb(vioch->vqueue);
+
+ /*
+ * If something arrived we cannot be sure, without dequeueing, if it
+ * was the reply to the xfer we are polling for, or, to other, even
+ * possibly non-polling, pending xfers: process all new messages
+ * till the polled-for message is found OR the vqueue is empty.
+ */
+ while ((next_msg = virtqueue_get_buf(vioch->vqueue, &length))) {
+ next_msg->rx_len = length;
+ /* Is the message we were polling for ? */
+ if (next_msg == msg) {
+ ret = true;
+ break;
+ }
+
+ spin_lock(&next_msg->poll_lock);
+ if (next_msg->poll_idx == VIO_MSG_NOT_POLLED) {
+ any_prefetched++;
+ list_add_tail(&next_msg->list,
+ &vioch->pending_cmds_list);
+ } else {
+ next_msg->poll_idx = VIO_MSG_POLL_DONE;
+ }
+ spin_unlock(&next_msg->poll_lock);
}
+
+ /*
+ * When the polling loop has successfully terminated if something
+ * else was queued in the meantime, it will be served by a deferred
+ * worker OR by the normal IRQ/callback OR by other poll loops.
+ *
+ * If we are still looking for the polled reply, the polling index has
+ * to be updated to the current vqueue last used index.
+ */
+ if (ret) {
+ pending = !virtqueue_enable_cb(vioch->vqueue);
+ } else {
+ spin_lock(&msg->poll_lock);
+ msg->poll_idx = virtqueue_enable_cb_prepare(vioch->vqueue);
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
+ spin_unlock(&msg->poll_lock);
+ }
+
+ if (vioch->deferred_tx_wq && (any_prefetched || pending))
+ queue_work(vioch->deferred_tx_wq, &vioch->deferred_tx_work);
What if queue_work() returns false because the single work item for the channel
was already pending? Couldn't it then happen that the worker CPU will not yet
see the updates implied by `any_prefetched || pending'?
On Tue, Jan 18, 2022 at 03:21:03PM +0100, Peter Hilber wrote:
On 21.12.21 15:00, Cristian Marussi wrote:
quoted
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Hi Cristian,
thanks for the update. I have some more remarks inline below.
Hi Peter,
thanks for your review, much appreciated, please see my replies online.
My impression is that the virtio core does not expose helper functions suitable
to busy-poll for used buffers. But changing this might not be difficult. Maybe
more_used() from virtio_ring.c could be exposed via a wrapper?
While I definitely agree that the virtio core support for polling is far from
ideal, some support is provided and my point was at first to try implement SCMI
virtio polling leveraging what we have now in the core and see if it was attainable
(indeed I tried early in this series to avoid as a whole to have to support polling
at the SCMI transport layer to attain SCMI cmds atomicity..but that was an ill
attempt that led nowhere good...)
Btw, I was planning to post a new series next week (after merge-windows) with some
fixes I did already, at this point I'll include also some fixes derived
from some of your remarks.
Best regards,
Peter
quoted
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Igor Skalkin <redacted>
Cc: Peter Hilber <redacted>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
v8 --> v9
- check for deferred_wq existence before queueing work to avoid
race at driver removal time
---
drivers/firmware/arm_scmi/Kconfig | 15 ++
drivers/firmware/arm_scmi/virtio.c | 298 ++++++++++++++++++++++++++---
2 files changed, 287 insertions(+), 26 deletions(-)
@@ -65,12 +71,22 @@ struct scmi_vio_channel {*@input:SDUusedfor(delayed)responsesandnotifications*@list:Listwhichscmi_vio_msgmaybepartof*@rx_len:InputSDUsizeinbytes,onceinputhasbeenreceived+*@poll_idx:Lastusedindexregisteredforpollingpurposesifthismessage+*transactionreplywasconfiguredforpolling.+*Notethatsincevirtqueueusedindexisanunsigned16-bitwecan+*usesomeout-of-scalevaluestosignifyparticularconditions.+*@poll_lock:Protectaccessto@poll_idx.*/structscmi_vio_msg{structscmi_msg_payld*request;structscmi_msg_payld*input;structlist_headlist;unsignedintrx_len;+#define VIO_MSG_NOT_POLLED 0xeeeeeeeeUL+#define VIO_MSG_POLL_DONE 0xffffffffUL+unsignedintpoll_idx;+/* lock to protect access to poll_idx. */+spinlock_tpoll_lock;};/* Only one SCMI VirtIO device can possibly exist */
@@ -81,40 +97,43 @@ static bool scmi_vio_have_vq_rx(struct virtio_device *vdev)returnvirtio_has_feature(vdev,VIRTIO_SCMI_F_P2A_CHANNELS);}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */staticintscmi_vio_feed_vq_rx(structscmi_vio_channel*vioch,structscmi_vio_msg*msg,structdevice*dev){structscatterlistsg_in;intrc;-unsignedlongflags;sg_init_one(&sg_in,msg->input,VIRTIO_SCMI_MAX_PDU_SIZE);-spin_lock_irqsave(&vioch->lock,flags);-rc=virtqueue_add_inbuf(vioch->vqueue,&sg_in,1,msg,GFP_ATOMIC);if(rc)dev_err(dev,"failed to add to RX virtqueue (%d)\n",rc);elsevirtqueue_kick(vioch->vqueue);-spin_unlock_irqrestore(&vioch->lock,flags);-returnrc;}+/* Expect to be called with vioch->lock acquired by the caller and IRQs off */+staticinlinevoidscmi_vio_feed_vq_tx(structscmi_vio_channel*vioch,+structscmi_vio_msg*msg)+{+spin_lock(&msg->poll_lock);+msg->poll_idx=VIO_MSG_NOT_POLLED;+spin_unlock(&msg->poll_lock);++list_add(&msg->list,&vioch->free_list);+}+staticvoidscmi_finalize_message(structscmi_vio_channel*vioch,structscmi_vio_msg*msg){-if(vioch->is_rx){+if(vioch->is_rx)scmi_vio_feed_vq_rx(vioch,msg,vioch->cinfo->dev);-}else{-/* Here IRQs are assumed to be already disabled by the caller */-spin_lock(&vioch->lock);-list_add(&msg->list,&vioch->free_list);-spin_unlock(&vioch->lock);-}+else+scmi_vio_feed_vq_tx(vioch,msg);}staticvoidscmi_vio_complete_cb(structvirtqueue*vqueue)
@@ -176,6 +198,34 @@ static void scmi_vio_complete_cb(struct virtqueue *vqueue)spin_unlock_irqrestore(&vioch->ready_lock,ready_flags);}+staticvoidscmi_vio_deferred_tx_worker(structwork_struct*work)+{+unsignedlongflags;+structscmi_vio_channel*vioch;+structscmi_vio_msg*msg,*tmp;++vioch=container_of(work,structscmi_vio_channel,deferred_tx_work);++/* Process pre-fetched messages */+spin_lock_irqsave(&vioch->lock,flags);++/* Scan the list of possibly pre-fetched messages during polling. */+list_for_each_entry_safe(msg,tmp,&vioch->pending_cmds_list,list){+list_del(&msg->list);++scmi_rx_callback(vioch->cinfo,+msg_read_header(msg->input),msg);++/* Free the processed message once done */+scmi_vio_feed_vq_tx(vioch,msg);+}++spin_unlock_irqrestore(&vioch->lock,flags);++/* Process possibly still pending messages */+scmi_vio_complete_cb(vioch->vqueue);+}+staticconstchar*constscmi_vio_vqueue_names[]={"tx","rx"};staticvq_callback_t*scmi_vio_complete_callbacks[]={
@@ -244,6 +294,19 @@ static int virtio_chan_setup(struct scmi_chan_info *cinfo, struct device *dev,vioch=&((structscmi_vio_channel*)scmi_vdev->priv)[index];+/* Setup a deferred worker for polling. */+if(tx&&!vioch->deferred_tx_wq){+vioch->deferred_tx_wq=+alloc_workqueue(dev_name(&scmi_vdev->dev),+WQ_UNBOUND|WQ_FREEZABLE|WQ_SYSFS,+0);+if(!vioch->deferred_tx_wq)+return-ENOMEM;++INIT_WORK(&vioch->deferred_tx_work,+scmi_vio_deferred_tx_worker);+}+for(i=0;i<vioch->max_msg;i++){structscmi_vio_msg*msg;
@@ -324,7 +398,8 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,}msg=list_first_entry(&vioch->free_list,typeof(*msg),list);-list_del(&msg->list);+/* Re-init element so we can discern anytime if it is still in-flight */+list_del_init(&msg->list);msg_tx_prepare(msg->request,xfer);
@@ -337,6 +412,19 @@ static int virtio_send_message(struct scmi_chan_info *cinfo,dev_err(vioch->cinfo->dev,"failed to add to TX virtqueue (%d)\n",rc);}else{+/*+*Ifpollingwasrequestedforthistransaction:+*-retrievelastusedindex(willbeusedaspollingreference)
The virtqueue_add_sgs() called before already exposed the message to the virtio
device, so a fast response might have arrived already, so the reference value
might unexpectedly correspond to the current message.
Good point I have wrongly considered the kick as the only trigger but if
indeed the device was already kicked and processing the queues the scenario
you depicted is possible. I'll move this logic earlier.
quoted
+ * - bind the polled message to the xfer via .priv
+ */
+ if (xfer->hdr.poll_completion) {
+ spin_lock(&msg->poll_lock);
+ msg->poll_idx =
+ virtqueue_enable_cb_prepare(vioch->vqueue);
+ spin_unlock(&msg->poll_lock);
+ /* Ensure initialized msg is visibly bound to xfer */
+ smp_store_mb(xfer->priv, msg);
+ }
virtqueue_kick(vioch->vqueue);
}
@@ -361,10 +447,166 @@ static void virtio_fetch_notification(struct scmi_chan_info *cinfo, { struct scmi_vio_msg *msg = xfer->priv;- if (msg) {+ if (msg) msg_fetch_notification(msg->input, msg->rx_len, max_len, xfer);- xfer->priv = NULL;+}++/**+ * virtio_mark_txdone - Mark transmission done+ *+ * Free only successfully completed polling transfer messages.+ *+ * Note that in the SCMI VirtIO transport we never explicitly release timed-out+ * messages by forcibly re-adding them to the free-list, even on timeout, inside+ * the TX code path; we instead let IRQ/RX callbacks eventually clean up such+ * messages once, finally, a late reply is received and discarded (if ever).+ *+ * This approach was deemed preferable since those pending timed-out buffers are+ * still effectively owned by the SCMI platform VirtIO device even after timeout+ * expiration: forcibly freeing and reusing them before they had been returned+ * explicitly by the SCMI platform could lead to subtle bugs due to message+ * corruption.+ * An SCMI platform VirtIO device which never returns message buffers is+ * anyway broken and it will quickly lead to exhaustion of available messages.+ *+ * For this same reason, here, we take care to free only the successfully+ * completed polled messages, since they won't be freed elsewhere; late replies+ * to timed-out polled messages would be anyway freed by RX callbacks instead.+ *+ * @cinfo: SCMI channel info+ * @ret: Transmission return code+ * @xfer: Transfer descriptor+ */+static void virtio_mark_txdone(struct scmi_chan_info *cinfo, int ret,+ struct scmi_xfer *xfer)+{+ unsigned long flags;+ struct scmi_vio_channel *vioch = cinfo->transport_info;+ struct scmi_vio_msg *msg = xfer->priv;++ if (!msg)+ return;++ /* Ensure msg is unbound from xfer before pushing onto the free list */+ smp_store_mb(xfer->priv, NULL);++ /* Is a successfully completed polled message still to be finalized ? */+ spin_lock_irqsave(&vioch->lock, flags);+ if (!ret && xfer->hdr.poll_completion && list_empty(&msg->list))
Could this not also be a message which was already finalized and then
immediately reused for another polling xfer?
Fist of all, in the upcoming series there is already a fix here, because I do
not want (as in non-polling mode and as stated in the comment above) to forcibly
release -ETIMEOUT xfer here. New check being like:
if (ret != -ETIMEDOUT && xfer->hdr.poll_completion && list_empty(&msg->list))
BUT, if I understood correctly what you meant you are talking about a polled
message which had been received by chance on the IRQ path and there finalized
already, and so subsequently happily picked up from the free list for another
polled transfer....I think you are right, even if remote, this is a possibility
to account for (and the list_empty() check fails at this): I'll take care to clear
xfer->priv after a command is fetched BUT only if received across the IRQ path,
and drop the list_empty() check above which at this point is redundant: in this
way mark_tx_done will be skip even for polled cmds that have already been
finalized on the IRQ path. (notifications/delayed responses are unaffected
since not handled on this path...)
Thanks for spotting this.
quoted
+ scmi_vio_feed_vq_tx(vioch, msg);
+ spin_unlock_irqrestore(&vioch->lock, flags);
+}
+
+/**
+ * virtio_poll_done - Provide polling support for VirtIO transport
+ *
+ * @cinfo: SCMI channel info
+ * @xfer: Reference to the transfer being poll for.
+ *
+ * VirtIO core provides a polling mechanism based only on last used indexes:
+ * this means that it is possible to poll the virtqueues waiting for something
+ * new to arrive from the host side but the only way to check if the freshly
+ * arrived buffer was what we were waiting for is to compare the newly arrived
+ * message descriptors with the one we are polling on.
+ *
+ * As a consequence it can happen to dequeue something different from the buffer
+ * we were poll-waiting for: if that is the case such early fetched buffers are
+ * then added to a the @pending_cmds_list list for later processing by a
+ * dedicated deferred worker.
+ *
+ * So, basically, once something new is spotted we proceed to de-queue all the
+ * freshly received used buffers until we found the one we were polling on, or,
+ * we have 'seemingly' emptied the virtqueue; if some buffers are still pending
+ * in the vqueue at the end of the polling loop (possible due to inherent races
+ * in virtqueues handling mechanisms), we similarly kick the deferred worker
+ * and let it process those, to avoid indefinitely looping in the .poll_done
+ * helper.
+ *
+ * Note that we do NOT suppress notification with VIRTQ_USED_F_NO_NOTIFY even
+ * when polling since such flag is per-virtqueues and we do not want to
+ * suppress notifications as a whole: so, if the message we are polling for is
+ * delivered via usual IRQs callbacks, on another core which are IRQs-on, it
+ * will be handled as such by scmi_rx_callback() and the polling loop in the
+ * SCMI Core TX path will be transparently terminated anyway.
Why is VIRTQ_USED_F_NO_NOTIFY mentioned? It is a flag associated with only one
of two buffer notification suppression methods, which are transparently handled
by the virtio core. Cf. `Driver Requirements: Used Buffer Notification
Suppression' in the virtio spec.
I saw that paragraph on the spec, what I wanted to stress was that we have no
way to implement a per-message notification suppression (and probably neither a
per-channel one since VIRTQ_USED_F_NO_NOTIFY is not really exposed), so that
a polled message could be indeed received instead through the usual IRQ based
callbacks if it happens to be delivered on a different core or if the
current polling core is not running such loops with IRQs off, but such
behaviour is supported and handled.
Anyway it is probably confusing mentioning the presence of the
VIRTQ_USED_F_NO_NOTIFY flag, so I'll drop that mention.
quoted
+ *
+ * Return: True once polling has successfully completed.
+ */
+static bool virtio_poll_done(struct scmi_chan_info *cinfo,
+ struct scmi_xfer *xfer)
+{
+ bool pending, ret = false;
+ unsigned int length, any_prefetched = 0;
+ unsigned long flags;
+ struct scmi_vio_msg *next_msg, *msg = xfer->priv;
+ struct scmi_vio_channel *vioch = cinfo->transport_info;
+
+ if (!msg)
+ return true;
+
+ spin_lock_irqsave(&msg->poll_lock, flags);
+ /* Processed already by other polling loop on another CPU ? */
+ if (msg->poll_idx == VIO_MSG_POLL_DONE) {
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ return true;
+ }
+
+ /* Has cmdq index moved at all ? */
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
In my understanding, the polling comparison could still be subject to the ABA
problem when exactly 2**16 messages have been marked as used since
msg->poll_idx was set (unlikely scenario, granted).
I think this would be a lot simpler if the virtio core exported some
concurrency-safe helper function for such polling (similar to more_used() from
virtio_ring.c), as discussed at the top.
So this is the main limitation indeed of the current implementation, I
cannot distinguish if there was an exact full wrap and I'm reading the same
last_idx as before but a whoppying 2**16 messages have instead gone through...
The tricky part seems to me here that even introducing dedicated helpers
for polling in order to account for such wrapping (similar to more_used())
those would be based by current VirtIO spec on a single bit wrap counter,
so how do you discern if 2 whole wraps have happened (even more unlikely..) ?
Maybe I'm missing something though...
I'll have a though about this, but in my opinion this seems something so
unlikely that we could live with it, for the moment at least...
quoted
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ if (!pending)
+ return false;
+
+ spin_lock_irqsave(&vioch->lock, flags);
+ virtqueue_disable_cb(vioch->vqueue);
+
+ /*
+ * If something arrived we cannot be sure, without dequeueing, if it
+ * was the reply to the xfer we are polling for, or, to other, even
+ * possibly non-polling, pending xfers: process all new messages
+ * till the polled-for message is found OR the vqueue is empty.
+ */
+ while ((next_msg = virtqueue_get_buf(vioch->vqueue, &length))) {
+ next_msg->rx_len = length;
+ /* Is the message we were polling for ? */
+ if (next_msg == msg) {
+ ret = true;
+ break;
+ }
+
+ spin_lock(&next_msg->poll_lock);
+ if (next_msg->poll_idx == VIO_MSG_NOT_POLLED) {
+ any_prefetched++;
+ list_add_tail(&next_msg->list,
+ &vioch->pending_cmds_list);
+ } else {
+ next_msg->poll_idx = VIO_MSG_POLL_DONE;
+ }
+ spin_unlock(&next_msg->poll_lock);
}
+
+ /*
+ * When the polling loop has successfully terminated if something
+ * else was queued in the meantime, it will be served by a deferred
+ * worker OR by the normal IRQ/callback OR by other poll loops.
+ *
+ * If we are still looking for the polled reply, the polling index has
+ * to be updated to the current vqueue last used index.
+ */
+ if (ret) {
+ pending = !virtqueue_enable_cb(vioch->vqueue);
+ } else {
+ spin_lock(&msg->poll_lock);
+ msg->poll_idx = virtqueue_enable_cb_prepare(vioch->vqueue);
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
+ spin_unlock(&msg->poll_lock);
+ }
+
+ if (vioch->deferred_tx_wq && (any_prefetched || pending))
+ queue_work(vioch->deferred_tx_wq, &vioch->deferred_tx_work);
What if queue_work() returns false because the single work item for the channel
was already pending? Couldn't it then happen that the worker CPU will not yet
see the updates implied by `any_prefetched || pending'?
The short asnwer is, no this can't happen: I had an extensive discussion in the
past around similar concerns about this about SCMI notifs dispatching (which use
workqueues:
https://lore.kernel.org/linux-arm-kernel/0234c256-2e29-69f8-99ae-2599f982961e@arm.com/).
In a nutshell all bails down to how the Kenrel cmwq susbsystem works
internally.
queue_work() does fail if the same work item was already queued recently
and suck work is still marked as WORK_PENDING, BUT that flag happens to be set
only if such queued work is still fully pending in the sense that the worker
thread has still not even being waken by the Kernel cmwq subsystem.
The above flag is indeed cleared right before the related worker
thread is started, roughly:
So queue_work() return false only if a previous work was pending AND the
worker thread was still dormient; it is not possible that the worker
thread was running and, say, had already emptied the above @pending_cmds_list
but was still marked pending since it still has to terminate (that would be
indeed a problem and you would end up with this new work items not seen
till the next worker run is kicked)
Moreover, here the work items are really contained in a spinlocked list
whose spinlock is hold here while filling up the list and in the worker
thread while emptying it, so that it is neither possible to
modify/corrupt the list while the worker is consuming it, in case you
successfully queue more work while the worker is running.
Thanks again for your feedback,
Cristian
P.S: .. from the other thread..
... it seems to me that is exactly how I'm using it, and moreover I
don't see any other way via the VirtIO API to grab that last_used_idx
that I need for virtqueu_poll.
quoted
I meant to say that the VIO_MSG_POLL_DONE special value should best not be put
into the .poll_idx (since the special value might in theory overlap with an
opaque value). Another variable could hold the special states VIO_MSG_POLL_DONE
and VIO_MSG_NOT_POLLED.
Yes indeed, I was trying to avoid to keep one more variable ignoring indeed
the opaqueness :D ... I'll find a better way.
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
From: Peter Hilber <hidden> Date: 2022-01-20 19:10:18
On 19.01.22 13:23, Cristian Marussi wrote:
On Tue, Jan 18, 2022 at 03:21:03PM +0100, Peter Hilber wrote:
quoted
On 21.12.21 15:00, Cristian Marussi wrote:
quoted
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Hi Cristian,
thanks for the update. I have some more remarks inline below.
Hi Peter,
thanks for your review, much appreciated, please see my replies online.
quoted
My impression is that the virtio core does not expose helper functions suitable
to busy-poll for used buffers. But changing this might not be difficult. Maybe
more_used() from virtio_ring.c could be exposed via a wrapper?
While I definitely agree that the virtio core support for polling is far from
ideal, some support is provided and my point was at first to try implement SCMI
virtio polling leveraging what we have now in the core and see if it was attainable
(indeed I tried early in this series to avoid as a whole to have to support polling
at the SCMI transport layer to attain SCMI cmds atomicity..but that was an ill
attempt that led nowhere good...)
Btw, I was planning to post a new series next week (after merge-windows) with some
fixes I did already, at this point I'll include also some fixes derived
from some of your remarks.
quoted
Best regards,
Peter
[snip]>>> + *
quoted
quoted
+ * Return: True once polling has successfully completed.
+ */
+static bool virtio_poll_done(struct scmi_chan_info *cinfo,
+ struct scmi_xfer *xfer)
+{
+ bool pending, ret = false;
+ unsigned int length, any_prefetched = 0;
+ unsigned long flags;
+ struct scmi_vio_msg *next_msg, *msg = xfer->priv;
+ struct scmi_vio_channel *vioch = cinfo->transport_info;
+
+ if (!msg)
+ return true;
+
+ spin_lock_irqsave(&msg->poll_lock, flags);
+ /* Processed already by other polling loop on another CPU ? */
+ if (msg->poll_idx == VIO_MSG_POLL_DONE) {
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ return true;
+ }
+
+ /* Has cmdq index moved at all ? */
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
In my understanding, the polling comparison could still be subject to the ABA
problem when exactly 2**16 messages have been marked as used since
msg->poll_idx was set (unlikely scenario, granted).
I think this would be a lot simpler if the virtio core exported some
concurrency-safe helper function for such polling (similar to more_used() from
virtio_ring.c), as discussed at the top.
So this is the main limitation indeed of the current implementation, I
cannot distinguish if there was an exact full wrap and I'm reading the same
last_idx as before but a whoppying 2**16 messages have instead gone through...
The tricky part seems to me here that even introducing dedicated helpers
for polling in order to account for such wrapping (similar to more_used())
those would be based by current VirtIO spec on a single bit wrap counter,
so how do you discern if 2 whole wraps have happened (even more unlikely..) ?
Maybe I'm missing something though...
In my understanding, there is no need to keep track of the old state. We
actually only want to check whether the device has marked any buffers as `used'
which we did not retrieve yet via virtqueue_get_buf_ctx().
This is what more_used() checks in my understanding. One would just need to
translate the external `struct virtqueue' param to the virtio_ring.c internal
representation `struct vring_virtqueue' and then call `more_used()'.
There would be no need to keep `poll_idx` then.
Best regards,
Peter
I'll have a though about this, but in my opinion this seems something so
unlikely that we could live with it, for the moment at least...
[snip]
From: "Michael S. Tsirkin" <mst@redhat.com> Date: 2022-01-20 20:39:28
On Thu, Jan 20, 2022 at 08:09:56PM +0100, Peter Hilber wrote:
On 19.01.22 13:23, Cristian Marussi wrote:
quoted
On Tue, Jan 18, 2022 at 03:21:03PM +0100, Peter Hilber wrote:
quoted
On 21.12.21 15:00, Cristian Marussi wrote:
quoted
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Hi Cristian,
thanks for the update. I have some more remarks inline below.
Hi Peter,
thanks for your review, much appreciated, please see my replies online.
quoted
My impression is that the virtio core does not expose helper functions suitable
to busy-poll for used buffers. But changing this might not be difficult. Maybe
more_used() from virtio_ring.c could be exposed via a wrapper?
While I definitely agree that the virtio core support for polling is far from
ideal, some support is provided and my point was at first to try implement SCMI
virtio polling leveraging what we have now in the core and see if it was attainable
(indeed I tried early in this series to avoid as a whole to have to support polling
at the SCMI transport layer to attain SCMI cmds atomicity..but that was an ill
attempt that led nowhere good...)
Btw, I was planning to post a new series next week (after merge-windows) with some
fixes I did already, at this point I'll include also some fixes derived
from some of your remarks.
quoted
Best regards,
Peter
[snip]>>> + *
quoted
quoted
quoted
+ * Return: True once polling has successfully completed.
+ */
+static bool virtio_poll_done(struct scmi_chan_info *cinfo,
+ struct scmi_xfer *xfer)
+{
+ bool pending, ret = false;
+ unsigned int length, any_prefetched = 0;
+ unsigned long flags;
+ struct scmi_vio_msg *next_msg, *msg = xfer->priv;
+ struct scmi_vio_channel *vioch = cinfo->transport_info;
+
+ if (!msg)
+ return true;
+
+ spin_lock_irqsave(&msg->poll_lock, flags);
+ /* Processed already by other polling loop on another CPU ? */
+ if (msg->poll_idx == VIO_MSG_POLL_DONE) {
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ return true;
+ }
+
+ /* Has cmdq index moved at all ? */
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
In my understanding, the polling comparison could still be subject to the ABA
problem when exactly 2**16 messages have been marked as used since
msg->poll_idx was set (unlikely scenario, granted).
I think this would be a lot simpler if the virtio core exported some
concurrency-safe helper function for such polling (similar to more_used() from
virtio_ring.c), as discussed at the top.
So this is the main limitation indeed of the current implementation, I
cannot distinguish if there was an exact full wrap and I'm reading the same
last_idx as before but a whoppying 2**16 messages have instead gone through...
The tricky part seems to me here that even introducing dedicated helpers
for polling in order to account for such wrapping (similar to more_used())
those would be based by current VirtIO spec on a single bit wrap counter,
so how do you discern if 2 whole wraps have happened (even more unlikely..) ?
Maybe I'm missing something though...
In my understanding, there is no need to keep track of the old state. We
actually only want to check whether the device has marked any buffers as `used'
which we did not retrieve yet via virtqueue_get_buf_ctx().
This is what more_used() checks in my understanding. One would just need to
translate the external `struct virtqueue' param to the virtio_ring.c internal
representation `struct vring_virtqueue' and then call `more_used()'.
There would be no need to keep `poll_idx` then.
Best regards,
Peter
Not really, I don't think so.
There's no magic in more_used. No synchronization happens.
more_used is exactly like virtqueue_poll except
you get to maintain your own index.
As it is, it is quite possible to read the cached index,
then another thread makes 2^16 bufs available, then device
uses them all, and presto you get a false positive.
I guess we can play with memory barriers such that cache
read happens after the index read - but it seems that
will just lead to the same wrap around problem
in reverse. So IIUC it's quite a bit more involved than
just translating structures.
And yes, a more_used like API would remove the need to pass
the index around, but it will also obscure the fact that
there's internal state here and that it's inherently racy
wrt wrap arounds. Whereas I'm happy to see that virtqueue_poll
seems to have made it clear enough that people get it.
It's not hard to handle wrap around in the driver if you like though:
just have a 32 bit atomic counter and increment it each time you are
going to make 2^16 buffers available. That gets you to 2^48 with an
overhead of an atomic read and that should be enough short term. Make
sure the cache line where you put the counter is not needed elsewhere -
checking it in a tight loop with an atomic will force it to the local
CPU. And if you are doing that virtqueue_poll will be enough.
quoted
I'll have a though about this, but in my opinion this seems something so
unlikely that we could live with it, for the moment at least...
[snip]
On Thu, Jan 20, 2022 at 03:39:12PM -0500, Michael S. Tsirkin wrote:
On Thu, Jan 20, 2022 at 08:09:56PM +0100, Peter Hilber wrote:
quoted
On 19.01.22 13:23, Cristian Marussi wrote:
quoted
On Tue, Jan 18, 2022 at 03:21:03PM +0100, Peter Hilber wrote:
quoted
On 21.12.21 15:00, Cristian Marussi wrote:
quoted
Add support for .mark_txdone and .poll_done transport operations to SCMI
VirtIO transport as pre-requisites to enable atomic operations.
Add a Kernel configuration option to enable SCMI VirtIO transport polling
and atomic mode for selected SCMI transactions while leaving it default
disabled.
Hi Cristian,
thanks for the update. I have some more remarks inline below.
Hi Peter,
thanks for your review, much appreciated, please see my replies online.
quoted
My impression is that the virtio core does not expose helper functions suitable
to busy-poll for used buffers. But changing this might not be difficult. Maybe
more_used() from virtio_ring.c could be exposed via a wrapper?
While I definitely agree that the virtio core support for polling is far from
ideal, some support is provided and my point was at first to try implement SCMI
virtio polling leveraging what we have now in the core and see if it was attainable
(indeed I tried early in this series to avoid as a whole to have to support polling
at the SCMI transport layer to attain SCMI cmds atomicity..but that was an ill
attempt that led nowhere good...)
Btw, I was planning to post a new series next week (after merge-windows) with some
fixes I did already, at this point I'll include also some fixes derived
from some of your remarks.
quoted
Best regards,
Peter
[snip]>>> + *
Hi Michael, Peter
I'm gonna post another iteration of this (and some other dependent
patches) with a few fixes as pointed out by Peter but still without addressing
the ABA style race/issue we are talkig about.
A few comments iand a proposal on this ABA race below, though.
quoted
quoted
quoted
quoted
+ * Return: True once polling has successfully completed.
+ */
+static bool virtio_poll_done(struct scmi_chan_info *cinfo,
+ struct scmi_xfer *xfer)
+{
+ bool pending, ret = false;
+ unsigned int length, any_prefetched = 0;
+ unsigned long flags;
+ struct scmi_vio_msg *next_msg, *msg = xfer->priv;
+ struct scmi_vio_channel *vioch = cinfo->transport_info;
+
+ if (!msg)
+ return true;
+
+ spin_lock_irqsave(&msg->poll_lock, flags);
+ /* Processed already by other polling loop on another CPU ? */
+ if (msg->poll_idx == VIO_MSG_POLL_DONE) {
+ spin_unlock_irqrestore(&msg->poll_lock, flags);
+ return true;
+ }
+
+ /* Has cmdq index moved at all ? */
+ pending = virtqueue_poll(vioch->vqueue, msg->poll_idx);
In my understanding, the polling comparison could still be subject to the ABA
problem when exactly 2**16 messages have been marked as used since
msg->poll_idx was set (unlikely scenario, granted).
I think this would be a lot simpler if the virtio core exported some
concurrency-safe helper function for such polling (similar to more_used() from
virtio_ring.c), as discussed at the top.
So this is the main limitation indeed of the current implementation, I
cannot distinguish if there was an exact full wrap and I'm reading the same
last_idx as before but a whoppying 2**16 messages have instead gone through...
The tricky part seems to me here that even introducing dedicated helpers
for polling in order to account for such wrapping (similar to more_used())
those would be based by current VirtIO spec on a single bit wrap counter,
so how do you discern if 2 whole wraps have happened (even more unlikely..) ?
Maybe I'm missing something though...
In my understanding, there is no need to keep track of the old state. We
actually only want to check whether the device has marked any buffers as `used'
which we did not retrieve yet via virtqueue_get_buf_ctx().
This is what more_used() checks in my understanding. One would just need to
translate the external `struct virtqueue' param to the virtio_ring.c internal
representation `struct vring_virtqueue' and then call `more_used()'.
There would be no need to keep `poll_idx` then.
Best regards,
Peter
Not really, I don't think so.
There's no magic in more_used. No synchronization happens.
more_used is exactly like virtqueue_poll except
you get to maintain your own index.
As it is, it is quite possible to read the cached index,
then another thread makes 2^16 bufs available, then device
uses them all, and presto you get a false positive.
I guess we can play with memory barriers such that cache
read happens after the index read - but it seems that
will just lead to the same wrap around problem
in reverse. So IIUC it's quite a bit more involved than
just translating structures.
And yes, a more_used like API would remove the need to pass
the index around, but it will also obscure the fact that
there's internal state here and that it's inherently racy
wrt wrap arounds. Whereas I'm happy to see that virtqueue_poll
seems to have made it clear enough that people get it.
It's not hard to handle wrap around in the driver if you like though:
just have a 32 bit atomic counter and increment it each time you are
going to make 2^16 buffers available. That gets you to 2^48 with an
overhead of an atomic read and that should be enough short term. Make
sure the cache line where you put the counter is not needed elsewhere -
checking it in a tight loop with an atomic will force it to the local
CPU. And if you are doing that virtqueue_poll will be enough.
I was thinking...keeping the current virtqueue_poll interface, since our
possible issue arises from the used_index wrapping around exactly on top
of the same polled index and given that currently the API returns an
unsigned "opaque" value really carrying just the 16-bit index (and possibly
the wrap bit as bit15 for packed vq) that is supposed to be fed back as
it is to the virtqueue_poll() function....
...why don't we just keep an internal full fledged per-virtqueue wrap-counter
and return that as the MSB 16-bit of the opaque value returned by
virtqueue_prepare_enable_cb and then check it back in virtqueue_poll when the
opaque is fed back ? (filtering it out from the internal helpers machinery)
As in the example below the scissors.
I mean if the internal wrap count is at that point different from the
one provided to virtqueue_poll() via the opaque poll_idx value previously
provided, certainly there is something new to fetch without even looking
at the indexes: at the same time, exposing an opaque index built as
(wraps << 16 | idx) implicitly 'binds' each index to a specific
wrap-iteration, so they can be distiguished (..ok until the wrap-count
upper 16bit wraps too....but...)
I am not really extremely familiar with the internals of virtio so I
could be missing something obvious...feel free to insult me :P
(..and I have not made any perf measurements or consideration at this
point....nor considered the redundancy of the existent packed
used_wrap_counter bit...)
Thanks,
Cristian
----
@@ -117,6 +117,8 @@ struct vring_virtqueue {/* Last used index we've seen. */u16last_used_idx;+u16wraps;+/* Hint for event idx: already triggered no need to disable. */boolevent_triggered;
@@ -806,6 +808,8 @@ static void *virtqueue_get_buf_ctx_split(struct virtqueue *_vq,ret=vq->split.desc_state[i].data;detach_buf_split(vq,i,ctx);vq->last_used_idx++;+if(unlikely(!vq->last_used_idx))+vq->wraps++;/* If we expect an interrupt for the next entry, tell host*bywritingeventindexandflushoutthewritebefore*thereadinthenextget_bufcall.*/
From: "Michael S. Tsirkin" <mst@redhat.com> Date: 2022-01-23 22:40:21
On Sun, Jan 23, 2022 at 08:02:54PM +0000, Cristian Marussi wrote:
quoted hunk
I was thinking...keeping the current virtqueue_poll interface, since our
possible issue arises from the used_index wrapping around exactly on top
of the same polled index and given that currently the API returns an
unsigned "opaque" value really carrying just the 16-bit index (and possibly
the wrap bit as bit15 for packed vq) that is supposed to be fed back as
it is to the virtqueue_poll() function....
...why don't we just keep an internal full fledged per-virtqueue wrap-counter
and return that as the MSB 16-bit of the opaque value returned by
virtqueue_prepare_enable_cb and then check it back in virtqueue_poll when the
opaque is fed back ? (filtering it out from the internal helpers machinery)
As in the example below the scissors.
I mean if the internal wrap count is at that point different from the
one provided to virtqueue_poll() via the opaque poll_idx value previously
provided, certainly there is something new to fetch without even looking
at the indexes: at the same time, exposing an opaque index built as
(wraps << 16 | idx) implicitly 'binds' each index to a specific
wrap-iteration, so they can be distiguished (..ok until the wrap-count
upper 16bit wraps too....but...)
I am not really extremely familiar with the internals of virtio so I
could be missing something obvious...feel free to insult me :P
(..and I have not made any perf measurements or consideration at this
point....nor considered the redundancy of the existent packed
used_wrap_counter bit...)
Thanks,
Cristian
----
@@ -117,6 +117,8 @@ struct vring_virtqueue {/* Last used index we've seen. */u16last_used_idx;+u16wraps;+/* Hint for event idx: already triggered no need to disable. */boolevent_triggered;
I wonder whether
vq->wraps += !vq->last_used_idx;
is faster or slower. No branch but OTOH a dependency.
quoted hunk
/* If we expect an interrupt for the next entry, tell host
* by writing event index and flush out the write before
* the read in the next get_buf call. */
Yea I think this patch increases the time it takes to wrap around from
2^16 to 2^32 which seems good enough.
Need some comments to explain the logic.
Would be interesting to see perf data.
--
MST
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
On Sun, Jan 23, 2022 at 05:40:08PM -0500, Michael S. Tsirkin wrote:
On Sun, Jan 23, 2022 at 08:02:54PM +0000, Cristian Marussi wrote:
quoted
I was thinking...keeping the current virtqueue_poll interface, since our
possible issue arises from the used_index wrapping around exactly on top
of the same polled index and given that currently the API returns an
unsigned "opaque" value really carrying just the 16-bit index (and possibly
the wrap bit as bit15 for packed vq) that is supposed to be fed back as
it is to the virtqueue_poll() function....
...why don't we just keep an internal full fledged per-virtqueue wrap-counter
and return that as the MSB 16-bit of the opaque value returned by
virtqueue_prepare_enable_cb and then check it back in virtqueue_poll when the
opaque is fed back ? (filtering it out from the internal helpers machinery)
As in the example below the scissors.
I mean if the internal wrap count is at that point different from the
one provided to virtqueue_poll() via the opaque poll_idx value previously
provided, certainly there is something new to fetch without even looking
at the indexes: at the same time, exposing an opaque index built as
(wraps << 16 | idx) implicitly 'binds' each index to a specific
wrap-iteration, so they can be distiguished (..ok until the wrap-count
upper 16bit wraps too....but...)
I am not really extremely familiar with the internals of virtio so I
could be missing something obvious...feel free to insult me :P
(..and I have not made any perf measurements or consideration at this
point....nor considered the redundancy of the existent packed
used_wrap_counter bit...)
Thanks,
Cristian
----
@@ -117,6 +117,8 @@ struct vring_virtqueue {/* Last used index we've seen. */u16last_used_idx;+u16wraps;+/* Hint for event idx: already triggered no need to disable. */boolevent_triggered;
I wonder whether
vq->wraps += !vq->last_used_idx;
is faster or slower. No branch but OTOH a dependency.
quoted
/* If we expect an interrupt for the next entry, tell host
* by writing event index and flush out the write before
* the read in the next get_buf call. */
Yea I think this patch increases the time it takes to wrap around from
2^16 to 2^32 which seems good enough.
Need some comments to explain the logic.
Would be interesting to see perf data.
Thanks for your feedback !
I'll try to gather some perf data around it next days.
(and eventually cleanup and adding comments if it is god enough...)
Thanks,
Cristian
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Introduce new _atomic variant for SCMI clock protocol operations related
to enable disable operations: when an atomic operation is required the xfer
poll_completion flag is set for that transaction.
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
drivers/firmware/arm_scmi/clock.c | 22 +++++++++++++++++++---
include/linux/scmi_protocol.h | 3 +++
2 files changed, 22 insertions(+), 3 deletions(-)
Support also atomic enable/disable clk_ops beside the bare non-atomic one
(prepare/unprepare) when the underlying SCMI transport is configured to
support atomic transactions for synchronous commands.
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
NOTE THAT STILL THERE'S NO FINE GRAIN CONTROL OVER SELECTION
OF WHICH CLOCK DEVICES CAN SUPPORT ATOMIC AND WHICH SHOULD NOT
BASED ON CLOCK DEVICES ENABLE LATENCY.
THIS HAS STILL TO BE ADDED IN SCMI PROTOCOL SPEC.
v7 --> v8
- provide prepare/unprepare only on non-atomic transports
V5 --> V6
- add concurrent availability of atomic and non atomic reqs
---
drivers/clk/clk-scmi.c | 54 +++++++++++++++++++++++++++++++++++-------
1 file changed, 45 insertions(+), 9 deletions(-)
From: Stephen Boyd <sboyd@kernel.org> Date: 2022-01-14 23:08:46
Quoting Cristian Marussi (2021-12-20 11:56:46)
Support also atomic enable/disable clk_ops beside the bare non-atomic one
(prepare/unprepare) when the underlying SCMI transport is configured to
support atomic transactions for synchronous commands.
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
NOTE THAT STILL THERE'S NO FINE GRAIN CONTROL OVER SELECTION
OF WHICH CLOCK DEVICES CAN SUPPORT ATOMIC AND WHICH SHOULD NOT
BASED ON CLOCK DEVICES ENABLE LATENCY.
THIS HAS STILL TO BE ADDED IN SCMI PROTOCOL SPEC.
Why are you yelling on the internet? :-) I guess I need to ack this.
Acked-by: Stephen Boyd <sboyd@kernel.org>
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
On Fri, Jan 14, 2022 at 03:08:37PM -0800, Stephen Boyd wrote:
Quoting Cristian Marussi (2021-12-20 11:56:46)
quoted
Support also atomic enable/disable clk_ops beside the bare non-atomic one
(prepare/unprepare) when the underlying SCMI transport is configured to
support atomic transactions for synchronous commands.
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
NOTE THAT STILL THERE'S NO FINE GRAIN CONTROL OVER SELECTION
OF WHICH CLOCK DEVICES CAN SUPPORT ATOMIC AND WHICH SHOULD NOT
BASED ON CLOCK DEVICES ENABLE LATENCY.
THIS HAS STILL TO BE ADDED IN SCMI PROTOCOL SPEC.
Why are you yelling on the internet? :-) I guess I need to ack this.
It is for the partners who request such changes. We are trying to prototype
and share the code and ask for feedback before we finalise the specification.
In fact it is other way around for you 😁. Not to ack as it is not yet final
😉. At least I need to wait until the spec contents are finalised before I
can merge with your ack 😁. But I agree RFC would have indicated that along
with the above background instead of *yelling*. Cristian assumed everyone
is aware of the content as quite a few are involved in offline discussions.
Acked-by: Stephen Boyd <sboyd@kernel.org>
Thanks anyways, will use it if nothing changes.
--
Regards,
Sudeep
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
On Mon, Jan 17, 2022 at 10:31:00AM +0000, Sudeep Holla wrote:
On Fri, Jan 14, 2022 at 03:08:37PM -0800, Stephen Boyd wrote:
quoted
Quoting Cristian Marussi (2021-12-20 11:56:46)
quoted
Support also atomic enable/disable clk_ops beside the bare non-atomic one
(prepare/unprepare) when the underlying SCMI transport is configured to
support atomic transactions for synchronous commands.
Hi,
quoted
quoted
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
NOTE THAT STILL THERE'S NO FINE GRAIN CONTROL OVER SELECTION
OF WHICH CLOCK DEVICES CAN SUPPORT ATOMIC AND WHICH SHOULD NOT
BASED ON CLOCK DEVICES ENABLE LATENCY.
THIS HAS STILL TO BE ADDED IN SCMI PROTOCOL SPEC.
Why are you yelling on the internet? :-) I guess I need to ack this.
Sorry I did not mean to yell really, just to warn partners using this.
It is for the partners who request such changes. We are trying to prototype
and share the code and ask for feedback before we finalise the specification.
In fact it is other way around for you 😁. Not to ack as it is not yet final
😉. At least I need to wait until the spec contents are finalised before I
can merge with your ack 😁. But I agree RFC would have indicated that along
with the above background instead of *yelling*. Cristian assumed everyone
is aware of the content as quite a few are involved in offline discussions.
quoted
Acked-by: Stephen Boyd <sboyd@kernel.org>
Thanks anyways, will use it if nothing changes.
As Sudeep said, V8 it is indeed not the final version which is going to
be posted soon after the merge-windows (without yelling :D) and which it
will be indeed still marked as RFC since it does include a new protocol
feature which is still under review and not published.
Sorry for the noise.
Thanks,
Cristian
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
On Mon, 20 Dec 2021 19:56:35 +0000, Cristian Marussi wrote:
This series mainly aims to introduce atomic support for SCMI transports
that can support it.
In [01/11], as a closely related addition, it is introduced a common way
for a transport to signal to the SCMI core that it does not offer
completion interrupts, so that the usual polling behaviour will be
required: this can be done enabling statically a global polling behaviour
for the whole transport with flag scmi_desc.force_polling OR dynamically
enabling at runtime such polling behaviour on a per-channel basis using
the flag scmi_chan_info.no_completion_irq, typically during .chan_setup().
The usual per-command polling selection behaviour based on
hdr.poll_completion is preserved as before.
[...]
On Mon, Dec 20, 2021 at 07:56:35PM +0000, Cristian Marussi wrote:
Hi all,
Hi
this series has now been partially queued (01-->08), the remaining
patches on virtio polling and SCMI CLK atomic support will be posted as
a new small patchset in the next cycle.
Thanks,
Cristian
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel