From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.8 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,NICE_REPLY_A,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C93FCC43461 for ; Fri, 11 Sep 2020 07:28:26 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 596F221D81 for ; Fri, 11 Sep 2020 07:28:26 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Vq0dfp5I" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725562AbgIKH2Z (ORCPT ); Fri, 11 Sep 2020 03:28:25 -0400 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:59131 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725535AbgIKH2Y (ORCPT ); Fri, 11 Sep 2020 03:28:24 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1599809301; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=JjKafxUPP45f5IT06o5f0VT+vHA02CW8qJlagtnzvDY=; b=Vq0dfp5IOcnBfFeUKHREkWFefYRdCWWOKBUgH+SK6AGKy+M8jB5ov8++MIOXivPUCbUBPV VxOBs5GG3yIBoabvsnRzSsZcHeeSH2r3IQhLKPMON4TjMFWW/w8w3bYEKPDRMI5lYEQ3ra O3Z7MeGnS1tZJdI7VLCXq3GDi5ekp08= Received: from mail-ed1-f70.google.com (mail-ed1-f70.google.com [209.85.208.70]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-36-Ua02Gw0lNlSZhFFgTJMF0Q-1; Fri, 11 Sep 2020 03:28:19 -0400 X-MC-Unique: Ua02Gw0lNlSZhFFgTJMF0Q-1 Received: by mail-ed1-f70.google.com with SMTP id g16so3852552edy.22 for ; Fri, 11 Sep 2020 00:28:19 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=JjKafxUPP45f5IT06o5f0VT+vHA02CW8qJlagtnzvDY=; b=Kpx1SkvfYnxmV1hjcHGftOyV+r87RUoeZtxzyrlJp+Q68nkm9m1boAp2MJaXUMtvYw SfzDB2awlcHRBBtMw5zYqtZYke1CVcWWRxbRx8YVGcao1YJAZ+4H5RxWDazUNuDPrsh3 FI1nYJFW62EaoyRJCw2KZ9QT9nzjTrfWHHOeTSucT+3LOmKkRADh8Xiaomz/K9R/1BkR 7QGKcJkghNAQpxZ8OcOx0sMHNLgZrzo8dAyqvM3PiiW1vooVRWMY8YcFO8c9VaQpgNed 4Iuk4GoB4QIf2BN9helqVLGZcgKesppTvPEiiXfQe7QtpsBIUesI9uLeWhHHZB7k4Vo2 oscA== X-Gm-Message-State: AOAM531t3Cgz2eA9PCWbovJI2PIR6RK3UhnotDmc9NjS+aQmZVno5TQE XdzvqKwh6DLU22DrLMJTT/4+KfTxF9BtdEV137ED7qhmENgLhLGgTzZvDGIc83E3v5izDexliKE wORxysdL4i6L6 X-Received: by 2002:a05:6402:1d93:: with SMTP id dk19mr665038edb.198.1599809297932; Fri, 11 Sep 2020 00:28:17 -0700 (PDT) X-Google-Smtp-Source: ABdhPJybOvGiwAG9mRFsi8+QvQMXQb6gMEHSfqo4oLlVeUIIWocKMrXJyNLqpm4hH0dG+VWdf5A9BA== X-Received: by 2002:a05:6402:1d93:: with SMTP id dk19mr665006edb.198.1599809297513; Fri, 11 Sep 2020 00:28:17 -0700 (PDT) Received: from ?IPv6:2001:b07:6468:f312:6689:90a2:a29f:8336? ([2001:b07:6468:f312:6689:90a2:a29f:8336]) by smtp.gmail.com with ESMTPSA id m6sm962793ejb.85.2020.09.11.00.28.16 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 11 Sep 2020 00:28:16 -0700 (PDT) Subject: Re: [PATCH 2/6] hw/core/stream: Rename StreamSlave as StreamSink To: =?UTF-8?Q?Philippe_Mathieu-Daud=c3=a9?= , qemu-devel@nongnu.org Cc: =?UTF-8?Q?Alex_Benn=c3=a9e?= , kvm@vger.kernel.org, qemu-arm@nongnu.org, Marcelo Tosatti , "Edgar E. Iglesias" , "Michael S. Tsirkin" , =?UTF-8?Q?C=c3=a9dric_Le_Goater?= , Marcel Apfelbaum , Laurent Vivier , Peter Maydell , Andrew Jeffery , Jason Wang , Thomas Huth , Alistair Francis , qemu-trivial@nongnu.org, Eduardo Habkost , Richard Henderson , Joel Stanley References: <20200910070131.435543-1-philmd@redhat.com> <20200910070131.435543-3-philmd@redhat.com> From: Paolo Bonzini Message-ID: Date: Fri, 11 Sep 2020 09:28:16 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: <20200910070131.435543-3-philmd@redhat.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 8bit Sender: kvm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org On 10/09/20 09:01, Philippe Mathieu-Daudé wrote: > In order to use inclusive terminology, rename 'slave stream' > as 'sink stream'. > > Signed-off-by: Philippe Mathieu-Daudé >From Edgar Iglesias: Regarding streams, our stream module can be used to model a stream channel such as AXI stream but also other similar stream protocols. We actually don't use the AXI stream terminology [in hw/core/stream.c]. E.g, we use buf instead of DATA, EOP (end-of-packet) instead of LAST and have a flow-control mechanism that doesn't refer to valid/ready. IMO, since we're not matching specific protocol names, it would be fine to switch to generic terms like Source and Sink. Therefore, Acked-by: Paolo Bonzini Paolo > --- > include/hw/ssi/xilinx_spips.h | 2 +- > include/hw/stream.h | 46 +++++++++++++++++------------------ > hw/core/stream.c | 20 +++++++-------- > hw/dma/xilinx_axidma.c | 32 ++++++++++++------------ > hw/net/xilinx_axienet.c | 20 +++++++-------- > hw/ssi/xilinx_spips.c | 2 +- > 6 files changed, 61 insertions(+), 61 deletions(-) > > diff --git a/include/hw/ssi/xilinx_spips.h b/include/hw/ssi/xilinx_spips.h > index 6a39b55a7bd..fde8a3ebda6 100644 > --- a/include/hw/ssi/xilinx_spips.h > +++ b/include/hw/ssi/xilinx_spips.h > @@ -97,7 +97,7 @@ typedef struct { > typedef struct { > XilinxQSPIPS parent_obj; > > - StreamSlave *dma; > + StreamSink *dma; > int gqspi_irqline; > > uint32_t regs[XLNX_ZYNQMP_SPIPS_R_MAX]; > diff --git a/include/hw/stream.h b/include/hw/stream.h > index ed09e83683d..8ca161991ca 100644 > --- a/include/hw/stream.h > +++ b/include/hw/stream.h > @@ -3,52 +3,52 @@ > > #include "qom/object.h" > > -/* stream slave. Used until qdev provides a generic way. */ > -#define TYPE_STREAM_SLAVE "stream-slave" > +/* stream sink. Used until qdev provides a generic way. */ > +#define TYPE_STREAM_SINK "stream-slave" > > -#define STREAM_SLAVE_CLASS(klass) \ > - OBJECT_CLASS_CHECK(StreamSlaveClass, (klass), TYPE_STREAM_SLAVE) > -#define STREAM_SLAVE_GET_CLASS(obj) \ > - OBJECT_GET_CLASS(StreamSlaveClass, (obj), TYPE_STREAM_SLAVE) > -#define STREAM_SLAVE(obj) \ > - INTERFACE_CHECK(StreamSlave, (obj), TYPE_STREAM_SLAVE) > +#define STREAM_SINK_CLASS(klass) \ > + OBJECT_CLASS_CHECK(StreamSinkClass, (klass), TYPE_STREAM_SINK) > +#define STREAM_SINK_GET_CLASS(obj) \ > + OBJECT_GET_CLASS(StreamSinkClass, (obj), TYPE_STREAM_SINK) > +#define STREAM_SINK(obj) \ > + INTERFACE_CHECK(StreamSink, (obj), TYPE_STREAM_SINK) > > -typedef struct StreamSlave StreamSlave; > +typedef struct StreamSink StreamSink; > > typedef void (*StreamCanPushNotifyFn)(void *opaque); > > -typedef struct StreamSlaveClass { > +typedef struct StreamSinkClass { > InterfaceClass parent; > /** > - * can push - determine if a stream slave is capable of accepting at least > + * can push - determine if a stream sink is capable of accepting at least > * one byte of data. Returns false if cannot accept. If not implemented, the > - * slave is assumed to always be capable of receiving. > - * @notify: Optional callback that the slave will call when the slave is > + * sink is assumed to always be capable of receiving. > + * @notify: Optional callback that the sink will call when the sink is > * capable of receiving again. Only called if false is returned. > * @notify_opaque: opaque data to pass to notify call. > */ > - bool (*can_push)(StreamSlave *obj, StreamCanPushNotifyFn notify, > + bool (*can_push)(StreamSink *obj, StreamCanPushNotifyFn notify, > void *notify_opaque); > /** > - * push - push data to a Stream slave. The number of bytes pushed is > - * returned. If the slave short returns, the master must wait before trying > - * again, the slave may continue to just return 0 waiting for the vm time to > + * push - push data to a Stream sink. The number of bytes pushed is > + * returned. If the sink short returns, the master must wait before trying > + * again, the sink may continue to just return 0 waiting for the vm time to > * advance. The can_push() function can be used to trap the point in time > - * where the slave is ready to receive again, otherwise polling on a QEMU > + * where the sink is ready to receive again, otherwise polling on a QEMU > * timer will work. > - * @obj: Stream slave to push to > + * @obj: Stream sink to push to > * @buf: Data to write > * @len: Maximum number of bytes to write > * @eop: End of packet flag > */ > - size_t (*push)(StreamSlave *obj, unsigned char *buf, size_t len, bool eop); > -} StreamSlaveClass; > + size_t (*push)(StreamSink *obj, unsigned char *buf, size_t len, bool eop); > +} StreamSinkClass; > > size_t > -stream_push(StreamSlave *sink, uint8_t *buf, size_t len, bool eop); > +stream_push(StreamSink *sink, uint8_t *buf, size_t len, bool eop); > > bool > -stream_can_push(StreamSlave *sink, StreamCanPushNotifyFn notify, > +stream_can_push(StreamSink *sink, StreamCanPushNotifyFn notify, > void *notify_opaque); > > > diff --git a/hw/core/stream.c b/hw/core/stream.c > index a65ad1208d8..19477d0f2df 100644 > --- a/hw/core/stream.c > +++ b/hw/core/stream.c > @@ -3,32 +3,32 @@ > #include "qemu/module.h" > > size_t > -stream_push(StreamSlave *sink, uint8_t *buf, size_t len, bool eop) > +stream_push(StreamSink *sink, uint8_t *buf, size_t len, bool eop) > { > - StreamSlaveClass *k = STREAM_SLAVE_GET_CLASS(sink); > + StreamSinkClass *k = STREAM_SINK_GET_CLASS(sink); > > return k->push(sink, buf, len, eop); > } > > bool > -stream_can_push(StreamSlave *sink, StreamCanPushNotifyFn notify, > +stream_can_push(StreamSink *sink, StreamCanPushNotifyFn notify, > void *notify_opaque) > { > - StreamSlaveClass *k = STREAM_SLAVE_GET_CLASS(sink); > + StreamSinkClass *k = STREAM_SINK_GET_CLASS(sink); > > return k->can_push ? k->can_push(sink, notify, notify_opaque) : true; > } > > -static const TypeInfo stream_slave_info = { > - .name = TYPE_STREAM_SLAVE, > +static const TypeInfo stream_sink_info = { > + .name = TYPE_STREAM_SINK, > .parent = TYPE_INTERFACE, > - .class_size = sizeof(StreamSlaveClass), > + .class_size = sizeof(StreamSinkClass), > }; > > > -static void stream_slave_register_types(void) > +static void stream_sink_register_types(void) > { > - type_register_static(&stream_slave_info); > + type_register_static(&stream_sink_info); > } > > -type_init(stream_slave_register_types) > +type_init(stream_sink_register_types) > diff --git a/hw/dma/xilinx_axidma.c b/hw/dma/xilinx_axidma.c > index a4812e480a0..cf12a852ea1 100644 > --- a/hw/dma/xilinx_axidma.c > +++ b/hw/dma/xilinx_axidma.c > @@ -131,8 +131,8 @@ struct XilinxAXIDMA { > AddressSpace as; > > uint32_t freqhz; > - StreamSlave *tx_data_dev; > - StreamSlave *tx_control_dev; > + StreamSink *tx_data_dev; > + StreamSink *tx_control_dev; > XilinxAXIDMAStreamSlave rx_data_dev; > XilinxAXIDMAStreamSlave rx_control_dev; > > @@ -264,8 +264,8 @@ static void stream_complete(struct Stream *s) > ptimer_transaction_commit(s->ptimer); > } > > -static void stream_process_mem2s(struct Stream *s, StreamSlave *tx_data_dev, > - StreamSlave *tx_control_dev) > +static void stream_process_mem2s(struct Stream *s, StreamSink *tx_data_dev, > + StreamSink *tx_control_dev) > { > uint32_t prev_d; > uint32_t txlen; > @@ -387,7 +387,7 @@ static void xilinx_axidma_reset(DeviceState *dev) > } > > static size_t > -xilinx_axidma_control_stream_push(StreamSlave *obj, unsigned char *buf, > +xilinx_axidma_control_stream_push(StreamSink *obj, unsigned char *buf, > size_t len, bool eop) > { > XilinxAXIDMAStreamSlave *cs = XILINX_AXI_DMA_CONTROL_STREAM(obj); > @@ -403,7 +403,7 @@ xilinx_axidma_control_stream_push(StreamSlave *obj, unsigned char *buf, > } > > static bool > -xilinx_axidma_data_stream_can_push(StreamSlave *obj, > +xilinx_axidma_data_stream_can_push(StreamSink *obj, > StreamCanPushNotifyFn notify, > void *notify_opaque) > { > @@ -420,7 +420,7 @@ xilinx_axidma_data_stream_can_push(StreamSlave *obj, > } > > static size_t > -xilinx_axidma_data_stream_push(StreamSlave *obj, unsigned char *buf, size_t len, > +xilinx_axidma_data_stream_push(StreamSink *obj, unsigned char *buf, size_t len, > bool eop) > { > XilinxAXIDMAStreamSlave *ds = XILINX_AXI_DMA_DATA_STREAM(obj); > @@ -591,9 +591,9 @@ static void xilinx_axidma_init(Object *obj) > static Property axidma_properties[] = { > DEFINE_PROP_UINT32("freqhz", XilinxAXIDMA, freqhz, 50000000), > DEFINE_PROP_LINK("axistream-connected", XilinxAXIDMA, > - tx_data_dev, TYPE_STREAM_SLAVE, StreamSlave *), > + tx_data_dev, TYPE_STREAM_SINK, StreamSink *), > DEFINE_PROP_LINK("axistream-control-connected", XilinxAXIDMA, > - tx_control_dev, TYPE_STREAM_SLAVE, StreamSlave *), > + tx_control_dev, TYPE_STREAM_SINK, StreamSink *), > DEFINE_PROP_END_OF_LIST(), > }; > > @@ -606,21 +606,21 @@ static void axidma_class_init(ObjectClass *klass, void *data) > device_class_set_props(dc, axidma_properties); > } > > -static StreamSlaveClass xilinx_axidma_data_stream_class = { > +static StreamSinkClass xilinx_axidma_data_stream_class = { > .push = xilinx_axidma_data_stream_push, > .can_push = xilinx_axidma_data_stream_can_push, > }; > > -static StreamSlaveClass xilinx_axidma_control_stream_class = { > +static StreamSinkClass xilinx_axidma_control_stream_class = { > .push = xilinx_axidma_control_stream_push, > }; > > static void xilinx_axidma_stream_class_init(ObjectClass *klass, void *data) > { > - StreamSlaveClass *ssc = STREAM_SLAVE_CLASS(klass); > + StreamSinkClass *ssc = STREAM_SINK_CLASS(klass); > > - ssc->push = ((StreamSlaveClass *)data)->push; > - ssc->can_push = ((StreamSlaveClass *)data)->can_push; > + ssc->push = ((StreamSinkClass *)data)->push; > + ssc->can_push = ((StreamSinkClass *)data)->can_push; > } > > static const TypeInfo axidma_info = { > @@ -638,7 +638,7 @@ static const TypeInfo xilinx_axidma_data_stream_info = { > .class_init = xilinx_axidma_stream_class_init, > .class_data = &xilinx_axidma_data_stream_class, > .interfaces = (InterfaceInfo[]) { > - { TYPE_STREAM_SLAVE }, > + { TYPE_STREAM_SINK }, > { } > } > }; > @@ -650,7 +650,7 @@ static const TypeInfo xilinx_axidma_control_stream_info = { > .class_init = xilinx_axidma_stream_class_init, > .class_data = &xilinx_axidma_control_stream_class, > .interfaces = (InterfaceInfo[]) { > - { TYPE_STREAM_SLAVE }, > + { TYPE_STREAM_SINK }, > { } > } > }; > diff --git a/hw/net/xilinx_axienet.c b/hw/net/xilinx_axienet.c > index 2e89f236b4a..0c4ac727207 100644 > --- a/hw/net/xilinx_axienet.c > +++ b/hw/net/xilinx_axienet.c > @@ -323,8 +323,8 @@ struct XilinxAXIEnet { > SysBusDevice busdev; > MemoryRegion iomem; > qemu_irq irq; > - StreamSlave *tx_data_dev; > - StreamSlave *tx_control_dev; > + StreamSink *tx_data_dev; > + StreamSink *tx_control_dev; > XilinxAXIEnetStreamSlave rx_data_dev; > XilinxAXIEnetStreamSlave rx_control_dev; > NICState *nic; > @@ -855,7 +855,7 @@ static ssize_t eth_rx(NetClientState *nc, const uint8_t *buf, size_t size) > } > > static size_t > -xilinx_axienet_control_stream_push(StreamSlave *obj, uint8_t *buf, size_t len, > +xilinx_axienet_control_stream_push(StreamSink *obj, uint8_t *buf, size_t len, > bool eop) > { > int i; > @@ -877,7 +877,7 @@ xilinx_axienet_control_stream_push(StreamSlave *obj, uint8_t *buf, size_t len, > } > > static size_t > -xilinx_axienet_data_stream_push(StreamSlave *obj, uint8_t *buf, size_t size, > +xilinx_axienet_data_stream_push(StreamSink *obj, uint8_t *buf, size_t size, > bool eop) > { > XilinxAXIEnetStreamSlave *ds = XILINX_AXI_ENET_DATA_STREAM(obj); > @@ -1005,9 +1005,9 @@ static Property xilinx_enet_properties[] = { > DEFINE_PROP_UINT32("txmem", XilinxAXIEnet, c_txmem, 0x1000), > DEFINE_NIC_PROPERTIES(XilinxAXIEnet, conf), > DEFINE_PROP_LINK("axistream-connected", XilinxAXIEnet, > - tx_data_dev, TYPE_STREAM_SLAVE, StreamSlave *), > + tx_data_dev, TYPE_STREAM_SINK, StreamSink *), > DEFINE_PROP_LINK("axistream-control-connected", XilinxAXIEnet, > - tx_control_dev, TYPE_STREAM_SLAVE, StreamSlave *), > + tx_control_dev, TYPE_STREAM_SINK, StreamSink *), > DEFINE_PROP_END_OF_LIST(), > }; > > @@ -1023,14 +1023,14 @@ static void xilinx_enet_class_init(ObjectClass *klass, void *data) > static void xilinx_enet_control_stream_class_init(ObjectClass *klass, > void *data) > { > - StreamSlaveClass *ssc = STREAM_SLAVE_CLASS(klass); > + StreamSinkClass *ssc = STREAM_SINK_CLASS(klass); > > ssc->push = xilinx_axienet_control_stream_push; > } > > static void xilinx_enet_data_stream_class_init(ObjectClass *klass, void *data) > { > - StreamSlaveClass *ssc = STREAM_SLAVE_CLASS(klass); > + StreamSinkClass *ssc = STREAM_SINK_CLASS(klass); > > ssc->push = xilinx_axienet_data_stream_push; > } > @@ -1049,7 +1049,7 @@ static const TypeInfo xilinx_enet_data_stream_info = { > .instance_size = sizeof(struct XilinxAXIEnetStreamSlave), > .class_init = xilinx_enet_data_stream_class_init, > .interfaces = (InterfaceInfo[]) { > - { TYPE_STREAM_SLAVE }, > + { TYPE_STREAM_SINK }, > { } > } > }; > @@ -1060,7 +1060,7 @@ static const TypeInfo xilinx_enet_control_stream_info = { > .instance_size = sizeof(struct XilinxAXIEnetStreamSlave), > .class_init = xilinx_enet_control_stream_class_init, > .interfaces = (InterfaceInfo[]) { > - { TYPE_STREAM_SLAVE }, > + { TYPE_STREAM_SINK }, > { } > } > }; > diff --git a/hw/ssi/xilinx_spips.c b/hw/ssi/xilinx_spips.c > index b9371dbf8d7..6109ba55107 100644 > --- a/hw/ssi/xilinx_spips.c > +++ b/hw/ssi/xilinx_spips.c > @@ -1353,7 +1353,7 @@ static void xlnx_zynqmp_qspips_init(Object *obj) > { > XlnxZynqMPQSPIPS *rq = XLNX_ZYNQMP_QSPIPS(obj); > > - object_property_add_link(obj, "stream-connected-dma", TYPE_STREAM_SLAVE, > + object_property_add_link(obj, "stream-connected-dma", TYPE_STREAM_SINK, > (Object **)&rq->dma, > object_property_allow_set_link, > OBJ_PROP_LINK_STRONG); >